KDB Output Adapter

Adapter type: KDBOutput. The KDB Output adapter publishes stream data from Event Stream Processor to a KDB+tick database table.

By default, the adapter matches the field names (in a case-insensitive manner) to decide the mapping between the source KDB+tick table and the target stream. The KDB Output adapter supports custom field-mapping.

If you use the CCL ATTACH ADAPTER statement to attach an adapter, you must supply the adapter type.

Property Label Property ID Type Description
KDB Server server string (Required) Name or IP address of the database server machine. No default value.
KDB Port port range (Required) IP port of the database listener. Default value is 5001. Minimum value is 0, maximum value is 65535.
Event Stream Processor User ID espUser string (Optional) User name for connecting to the Event Stream Processor. No default value.
Event Stream Processor Password espPassword password (Optional) Password for the Event Stream Processor user ID. Can be empty if using RSA authentication. No default value.
Authentication authentication choice (Optional) Authentication mechanism to use. Valid values are:
  • value="user_password" label="username/password"
  • Value value="rsa" label="RSA"
  • Value value="kerberos" label="Kerberos V5"
No default value.
Project URI projectUri string (Optional) Specifies the URI to connect to a project in cluster environment. No default value.
RSA Key File rsaKeyFile filename (Optional) RSA private-key file name and location. No default value.
KDB User user string (Optional) User ID for the database connection. No default value.
KDB Password password password (Optional) Password for the database connection. No default value.

PropertySet

 propertyset string

(Advanced) Specifies the name of the property set from the project configuration file. If you specify the same properties in the project configuration file and the ATTACH ADAPTER statement, the values in the property set override the values defined in the ATTACH ADAPTER statement. No default value.
Target Table table tables (Advanced) Name of the target table to update. No default value.
SQL Query query string (Advanced) The SQL query to filter incoming data. No default value.
Field Mapping permutation string

Mapping between Event Stream Processor and external fields, for example:

<esp_columnname>=<database_columnname>:<esp_columnname>=<database_columnname>. No default value.
Streaming Mode mode choice (Advanced) Streaming mode. Valid values are:
  • value="stream", label="user.u.upd"
  • value="push", label=”use update"
No default value.
Async Mode async boolean (Advanced) If set to true, the adapter does not wait for an acknowledgement from Event Stream Processor that is received the data. Default value is false.
Connection Retries connectionRetries int (Advanced) Number of times to retry connection if it breaks. Default value is 1.
KDB Batch size blockSize int (Advanced) Maximum number of records in a single KDB write batch. Default value is 5000.
BASE Data Only baseOnly boolean (Advanced) If set to true, does not retrieve data existing at connection time. Default value is false.
Lossy Subscriber lossy boolean (Advanced) If set to true, the Event Stream Processor drops records if connection slows down. Default value is false.
Pulse Interval pulsed int (Advanced) If set as a non-zero value, the subscription is created in pulsed mode with the specified period. Default value is 0.
Shine Through shine boolean (Advanced) If set to true, subscribe send data with shine through. Default value is false.
Droppable Subscription droppable boolean (Advanced) If set to true, Event Stream Processor drops the subscription if data is being backed up. Default value is false.
Preserve Transaction Blocks originalBlocks boolean (Advanced) If set to true, Event Stream Processor preserves transaction boundaries in subscribed data. Default value is false.
Debug debug boolean (Advanced) If set to true, a debug message of connection between KDB database server and Event Stream Processor is shown together with other Event Stream Processor logs. Default value is false.
Omitted Fields omitFields string (Advanced) Comma-delimited list of KDB fields to omit (not send). No default value.
Ignored Fields ignoreFields string (Advanced) Comma-delimited list of KDB fields to ignore, these are set to NULL. No default value.
Quite Mode quietMode boolean (Advanced) If true, a KDB log message is not show in standard error output. Default value is false.
Encrypt Connection encrypt boolean (Advanced) If set to true, the traffic between Event Stream Processor and the KDB adapter is encrypted. Default value is false.
Parameter File x_paramFile filename (Advanced) File to write the parameters into, to pass to the external process. Default value is <temp>\PARAMETER_FILE.txt.
Parameter File Format x_paramFormat choice (Advanced) Format in which the external process expects the parameters. Valid values are:
  • value = prop, label = "Java properties"
  • value = shell, label= "Unix shell assignments"
  • value = xml, label = "Simple XML"
Default value is “prop”.
Parent topic: KDB Input and Output Adapter