Kinetica C# API
Version 7.2.3.0
|
A set of string constants for the parameter options. More...
Public Attributes | |
const string | EVENT = "event" |
Type of modification event on the target table to be monitored by this table monitor. More... | |
const string | INSERT = "insert" |
Get notifications of new record insertions. More... | |
const string | UPDATE = "update" |
Get notifications of update operations. More... | |
const string | DELETE = "delete" |
Get notifications of delete operations. More... | |
const string | MONITOR_ID = "monitor_id" |
ID to use for this monitor instead of a randomly generated one More... | |
const string | DATASINK_NAME = "datasink_name" |
Name of an existing data sink to send change data notifications to More... | |
const string | DESTINATION = "destination" |
Destination for the output data in format 'destination_type://path[:port]'. More... | |
const string | KAFKA_TOPIC_NAME = "kafka_topic_name" |
Name of the Kafka topic to publish to if DESTINATION in options is specified and is a Kafka broker More... | |
const string | INCREASING_COLUMN = "increasing_column" |
Column on subscribed table that will increase for new records (e.g., TIMESTAMP). More... | |
const string | EXPRESSION = "expression" |
Filter expression to limit records for notification More... | |
const string | JOIN_TABLE_NAMES = "join_table_names" |
A comma-separated list of tables (optionally with aliases) to include in the join. More... | |
const string | JOIN_COLUMN_NAMES = "join_column_names" |
A comma-separated list of columns or expressions to include from the joined tables. More... | |
const string | JOIN_EXPRESSIONS = "join_expressions" |
Optional filter or join expressions to apply when combining the tables. More... | |
const string | REFRESH_METHOD = "refresh_method" |
Method controlling when the table monitor reports changes to the table_name. More... | |
const string | ON_CHANGE = "on_change" |
Report changes as they occur. More... | |
const string | PERIODIC = "periodic" |
Report changes periodically at rate specified by REFRESH_PERIOD. More... | |
const string | REFRESH_PERIOD = "refresh_period" |
When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which changes are reported. More... | |
const string | REFRESH_START_TIME = "refresh_start_time" |
When REFRESH_METHOD is PERIODIC, specifies the first time at which changes are reported. More... | |
A set of string constants for the parameter options.
Optional parameters.
Definition at line 37 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.DATASINK_NAME = "datasink_name" |
Name of an existing data sink to send change data notifications to
Definition at line 88 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.DELETE = "delete" |
Get notifications of delete operations.
The deleted row count information is forwarded to the subscribers.
Definition at line 79 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.DESTINATION = "destination" |
Destination for the output data in format 'destination_type://path[:port]'.
Supported destination types are 'http', 'https' and 'kafka'.
Definition at line 94 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.EVENT = "event" |
Type of modification event on the target table to be monitored by this table monitor.
Supported values:
The default value is INSERT.
Definition at line 64 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.EXPRESSION = "expression" |
Filter expression to limit records for notification
Definition at line 107 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.INCREASING_COLUMN = "increasing_column" |
Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
Definition at line 103 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.INSERT = "insert" |
Get notifications of new record insertions.
The new row images are forwarded to the subscribers.
Definition at line 69 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.JOIN_COLUMN_NAMES = "join_column_names" |
A comma-separated list of columns or expressions to include from the joined tables.
Column references can use table names or aliases defined in 'join_table_names'. Each column can optionally be aliased using 'as'. The selected columns will also appear in the notification output.
Definition at line 124 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.JOIN_EXPRESSIONS = "join_expressions" |
Optional filter or join expressions to apply when combining the tables.
Expressions are standard SQL-style conditions and can reference any table or alias listed in 'join_table_names'. This corresponds to the WHERE clause of the underlying join, and can include conditions to filter the delta rows.
Definition at line 133 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.JOIN_TABLE_NAMES = "join_table_names" |
A comma-separated list of tables (optionally with aliases) to include in the join.
The monitored table table_name must be included, representing only the newly inserted rows (deltas) since the last notification. Other tables can be any existing tables or views. Aliases can be used with the 'table_name as alias' syntax.
Definition at line 116 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.KAFKA_TOPIC_NAME = "kafka_topic_name" |
Name of the Kafka topic to publish to if DESTINATION in options is specified and is a Kafka broker
Definition at line 99 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.MONITOR_ID = "monitor_id" |
ID to use for this monitor instead of a randomly generated one
Definition at line 83 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.ON_CHANGE = "on_change" |
Report changes as they occur.
Definition at line 159 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.PERIODIC = "periodic" |
Report changes periodically at rate specified by REFRESH_PERIOD.
Definition at line 163 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.REFRESH_METHOD = "refresh_method" |
Method controlling when the table monitor reports changes to the table_name.
Supported values:
The default value is ON_CHANGE.
Definition at line 156 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.REFRESH_PERIOD = "refresh_period" |
When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which changes are reported.
Definition at line 169 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.REFRESH_START_TIME = "refresh_start_time" |
When REFRESH_METHOD is PERIODIC, specifies the first time at which changes are reported.
Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
Definition at line 177 of file CreateTableMonitor.cs.
const string kinetica.CreateTableMonitorRequest.Options.UPDATE = "update" |
Get notifications of update operations.
The modified row count information is forwarded to the subscribers.
Definition at line 74 of file CreateTableMonitor.cs.