EventDatabaseInfo

EventDatabaseInfo
EventDatabaseInfo

Information about event database.

JSON Example
{
    "admin_events_count": 2000,
    "classify_events_as_new_for_days": 3,
    "database_name": "eventdb",
    "event_database_configured": true,
    "port": 1443,
    "query_timeout_seconds": 120,
    "server_name": "eventdb.horizon.com",
    "show_events_for_time": "THREE_MONTHS",
    "table_prefix": "tab_",
    "timing_profiler_data_longevity_days": 7,
    "type": "SQL_SERVER",
    "username": "administrator"
}
integer As int32 As int32
admin_events_count
Optional

The number of events administrator can see in the admin console.

integer As int32 As int32
classify_events_as_new_for_days
Optional

Events will be marked as new for a time based on the value.

string
database_name
Optional

Name of the database on the database server to use for storing events. Note that this database must exist on the server or the values cannot be saved.

boolean
event_database_configured
Optional

Indicates if the event database has been configured or not.

integer As int32 As int32
port
Optional

Port number on the database server to which Horizon will send events.

integer As int32 As int32
query_timeout_seconds
Optional

Query execution timeout in seconds.

string
server_name
Optional

The server that hosts the database which will be used to store events.

string
show_events_for_time
Optional

Events will be shown in the Horizon Admin console for a time based on this value.

  • ONE_WEEK: One week.
  • TWO_WEEKS: Two weeks.
  • THREE_WEEKS: Three weeks.
  • ONE_MONTH: One month.
  • TWO_MONTHS: Two months.
  • THREE_MONTHS: Three months.
  • SIX_MONTHS: Six months.
Possible values are : ONE_WEEK, TWO_WEEKS, THREE_WEEKS, ONE_MONTH, TWO_MONTHS, THREE_MONTHS, SIX_MONTHS,
string
table_prefix
Optional

If present, all tables for this instance will start with this prefix. This allows multiple brokers to use the same events database without trampling on other broker data.

integer As int32 As int32
timing_profiler_data_longevity_days
Optional

Timing Profiler data will be kept in database for a time based on the value. Timing Profiler Data will not be stored in Event DB.

string
type
Optional

The type of database to use for the event database.

  • ORACLE: An Oracle database.
  • SQL_SERVER: A SQL server database.
  • POSTGRESQL: A PostgreSQL database.
Possible values are : ORACLE, SQL_SERVER, POSTGRESQL,
string
username
Optional

Username to use for the connection to the event database.