Skip to main content

A set of parameters for Kinetica.createTableMonitor. More…

Inheritance diagram for kinetica.CreateTableMonitorRequest:
[legend]
Collaboration diagram for kinetica.CreateTableMonitorRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter CreateTableMonitorRequest.options. More…
 

​
Public Member Functions

 CreateTableMonitorRequest ()
 Constructs a CreateTableMonitorRequest object with default parameters.
 
 CreateTableMonitorRequest (string table_name, IDictionary< string, string > options=null)
 Constructs a CreateTableMonitorRequest object with the specified parameters.
 
 CreateTableMonitorRequest ()
 Constructs a CreateTableMonitorRequest object with default parameters.
 
 CreateTableMonitorRequest (string table_name, IDictionary< string, string > options=null)
 Constructs a CreateTableMonitorRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string table_name [get, set]
 Name of the table to monitor, in [schema_name.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.createTableMonitor.

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by CreateTableMonitorRequest.table_name) and forwards event notifications to subscribers via ZMQ. After this call completes, subscribe to the returned topic_id on the ZMQ table monitor port (default 9002). Each time an operation of the given type on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that corresponds to the event and can be decoded using type_schema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with Kinetica.clearTableMonitor.

For more information on table monitors, see Table Monitors.

Definition at line 32 of file CreateTableMonitor.cs.

​
Constructor & Destructor Documentation

​
◆ CreateTableMonitorRequest() [1/4]

kinetica.CreateTableMonitorRequest.CreateTableMonitorRequest ()
 inline

Constructs a CreateTableMonitorRequest object with default parameters.

Definition at line 418 of file CreateTableMonitor.cs.

​
◆ CreateTableMonitorRequest() [2/4]

kinetica.CreateTableMonitorRequest.CreateTableMonitorRequest (stringtable_name,
IDictionary< string, string >options = null )
 inline

Constructs a CreateTableMonitorRequest object with the specified parameters.

Parameters
table_nameName of the table to monitor, in [schema_name.]table_name format, using standard name resolution rules.
optionsOptional parameters.
  • EVENT: Type of modification event on the target table to be monitored by this table monitor. Supported values:
    • INSERT: Get notifications of new record insertions. The new row images are forwarded to the subscribers.
    • UPDATE: Get notifications of update operations. The modified row count information is forwarded to the subscribers.
    • DELETE: Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.
    The default value is INSERT.
  • MONITOR_ID: ID to use for this monitor instead of a randomly generated one.
  • DATASINK_NAME: Name of an existing data sink to send change data notifications to.
  • MAX_CONSECUTIVE_FAILURES: Maximum number of consecutive failed notification attempts before suspending the stream. A value of -1 (default) disables auto-suspend. This value is by rank and not overall.
  • FAILED_NOTIFICATIONS_TABLE_NAME: Name of a table to which failed stream notifications are written when the stream is suspended. The database will attempt to send notifications persisted in this table when the stream is resumed. The table has the following columns: rank (long), job_id (long), uuid (uuid), timestamp (timestamp), error_msg (string), payload (bytes). Leave this option empty to disable persisting failed notification events.
  • DESTINATION: Destination for the output data in format ‘destination_type://path[:port]’. Supported destination types are ‘http’, ‘https’ and ‘kafka’.
  • KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if DESTINATION in options is specified and is a Kafka broker.
  • INCREASING_COLUMN: Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
  • EXPRESSION: Filter expression to limit records for notification.
  • 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.
  • 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.
  • JOIN_EXPRESSIONS: 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.
  • REFRESH_METHOD: Method controlling when the table monitor reports changes to the table_name . Supported values:The default value is ON_CHANGE.
  • REFRESH_PERIOD: When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which changes are reported.
  • 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’.
The default value is an empty Dictionary.

Definition at line 621 of file CreateTableMonitor.cs.

​
◆ CreateTableMonitorRequest() [3/4]

kinetica.CreateTableMonitorRequest.CreateTableMonitorRequest ()
 inline

Constructs a CreateTableMonitorRequest object with default parameters.

Definition at line 418 of file CreateTableMonitor.cs.

​
◆ CreateTableMonitorRequest() [4/4]

kinetica.CreateTableMonitorRequest.CreateTableMonitorRequest (stringtable_name,
IDictionary< string, string >options = null )
 inline

Constructs a CreateTableMonitorRequest object with the specified parameters.

Parameters
table_nameName of the table to monitor, in [schema_name.]table_name format, using standard name resolution rules.
optionsOptional parameters.
  • EVENT: Type of modification event on the target table to be monitored by this table monitor. Supported values:
    • INSERT: Get notifications of new record insertions. The new row images are forwarded to the subscribers.
    • UPDATE: Get notifications of update operations. The modified row count information is forwarded to the subscribers.
    • DELETE: Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.
    The default value is INSERT.
  • MONITOR_ID: ID to use for this monitor instead of a randomly generated one.
  • DATASINK_NAME: Name of an existing data sink to send change data notifications to.
  • MAX_CONSECUTIVE_FAILURES: Maximum number of consecutive failed notification attempts before suspending the stream. A value of -1 (default) disables auto-suspend. This value is by rank and not overall.
  • FAILED_NOTIFICATIONS_TABLE_NAME: Name of a table to which failed stream notifications are written when the stream is suspended. The database will attempt to send notifications persisted in this table when the stream is resumed. The table has the following columns: rank (long), job_id (long), uuid (uuid), timestamp (timestamp), error_msg (string), payload (bytes). Leave this option empty to disable persisting failed notification events.
  • DESTINATION: Destination for the output data in format ‘destination_type://path[:port]’. Supported destination types are ‘http’, ‘https’ and ‘kafka’.
  • KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if DESTINATION in options is specified and is a Kafka broker.
  • INCREASING_COLUMN: Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
  • EXPRESSION: Filter expression to limit records for notification.
  • 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.
  • 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.
  • JOIN_EXPRESSIONS: 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.
  • REFRESH_METHOD: Method controlling when the table monitor reports changes to the table_name . Supported values:The default value is ON_CHANGE.
  • REFRESH_PERIOD: When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which changes are reported.
  • 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’.
The default value is an empty Dictionary.

Definition at line 621 of file CreateTableMonitor.cs.

​
Property Documentation

​
◆ options

IDictionary< string, string > kinetica.CreateTableMonitorRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • EVENT: Type of modification event on the target table to be monitored by this table monitor. Supported values:
    • INSERT: Get notifications of new record insertions. The new row images are forwarded to the subscribers.
    • UPDATE: Get notifications of update operations. The modified row count information is forwarded to the subscribers.
    • DELETE: Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.
    The default value is INSERT.
  • MONITOR_ID: ID to use for this monitor instead of a randomly generated one.
  • DATASINK_NAME: Name of an existing data sink to send change data notifications to.
  • MAX_CONSECUTIVE_FAILURES: Maximum number of consecutive failed notification attempts before suspending the stream. A value of -1 (default) disables auto-suspend. This value is by rank and not overall.
  • FAILED_NOTIFICATIONS_TABLE_NAME: Name of a table to which failed stream notifications are written when the stream is suspended. The database will attempt to send notifications persisted in this table when the stream is resumed. The table has the following columns: rank (long), job_id (long), uuid (uuid), timestamp (timestamp), error_msg (string), payload (bytes). Leave this option empty to disable persisting failed notification events.
  • DESTINATION: Destination for the output data in format ‘destination_type://path[:port]’. Supported destination types are ‘http’, ‘https’ and ‘kafka’.
  • KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if DESTINATION in CreateTableMonitorRequest.options is specified and is a Kafka broker.
  • INCREASING_COLUMN: Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
  • EXPRESSION: Filter expression to limit records for notification.
  • JOIN_TABLE_NAMES: A comma-separated list of tables (optionally with aliases) to include in the join. The monitored table CreateTableMonitorRequest.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.
  • 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.
  • JOIN_EXPRESSIONS: 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.
  • REFRESH_METHOD: Method controlling when the table monitor reports changes to the CreateTableMonitorRequest.table_name. Supported values:The default value is ON_CHANGE.
  • REFRESH_PERIOD: When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which changes are reported.
  • 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’.

The default value is an empty Dictionary.

Definition at line 414 of file CreateTableMonitor.cs.

​
◆ table_name

string kinetica.CreateTableMonitorRequest.table_name
 getset

Name of the table to monitor, in [schema_name.

]table_name format, using standard name resolution rules.

Definition at line 216 of file CreateTableMonitor.cs.

The documentation for this class was generated from the following files: