Show TOC

KDB Output AdapterLocate this document in the navigation structure

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 Description
KDB Server

Property ID: server

Type: string

(Required for adapter operation and schema discovery) Name or IP address of the database server machine. No default value.

KDB Port

Property ID: port

Type: range

(Required for adapter operation and schema discovery) IP port of the database listener. Default value is 5001. Minimum value is 0, maximum value is 65535.

Event Stream Processor User ID

Property ID: espUser

Type: string

(Optional) User name for connecting to the Event Stream Processor. No default value.

Event Stream Processor Password

Property ID: espPassword

Type: password

(Optional) Password for the Event Stream Processor user ID. Can be empty if using RSA authentication. No default value.

Authentication

Property ID: authentication

Type: 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

Property ID: projectUri

Type: string

(Optional) Specifies the URI to connect to a project in cluster environment. No default value.

RSA Key File

Property ID: rsaKeyFile

Type: filename

(Optional) RSA private-key file name and location. No default value.

KDB User

Property ID: user

Type: string

(Optional for adapter operation; required only for schema discovery) User ID for the database connection. No default value.

KDB Password

Property ID: password

Type: password

(Optional for adapter operation; required only for schema discovery) Password for the database connection. No default value.

PropertySet

Property ID: propertyset

Type: string

(Advanced) Specifies the name of the property set. Property sets are reusable sets of properties that are stored in the project configuration file. Using these sets allows you to move adapter configuration properties out of the CCL file and into the CCR 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

Property ID: table

Type: tables

(Advanced) Name of the target table to update. No default value.

SQL Query

Property ID: query

Type: string

(Advanced) The SQL query to filter incoming data. No default value.

Field Mapping

Property ID: permutation

Type: string

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

<streaming_columnname>=<database_columnname>:<streaming_columnname>=<database_columnname>. No default value.

Streaming Mode

Property ID: mode

Type: choice

(Advanced) Streaming mode. Valid values are:
  • value="stream", label="user.u.upd"
  • value="push", label=”use update"
No default value.
Async Mode

Property ID: async

Type: boolean

(Advanced) If set to true, the adapter does not wait for an acknowledgement from Event Stream Processor that it received the data. Default value is false.

Connection Retries

Property ID: connectionRetries

Type: int

(Advanced) Number of times to retry connection if it breaks. Default value is 1.

KDB Batch size

Property ID: blockSize

Type: int

(Advanced) Maximum number of records in a single KDB write batch. Default value is 5000.

BASE Data Only

Property ID: baseOnly

Type: boolean

(Advanced) If set to true, does not retrieve data existing at connection time. Default value is false.

Lossy Subscriber

Property ID: lossy

Type: boolean

(Advanced) If set to true, the Event Stream Processor drops records if connection slows down. Default value is false.

Pulse Interval

Property ID: pulsed

Type: 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

Property ID: shine

Type: boolean

(Advanced) If set to true, subscribe send data with shine through. Default value is false.

Droppable Subscription

Property ID: droppable

Type: 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

Property ID: originalBlocks

Type: boolean

(Advanced) If set to true, Event Stream Processor preserves transaction boundaries in subscribed data. Default value is false.

Debug

Property ID: debug

Type: 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

Property ID: omitFields

Type: string

(Advanced) Comma-delimited list of KDB fields to omit (not send). No default value.

Ignored Fields

Property ID: ignoreFields

Type: string

(Advanced) Comma-delimited list of KDB fields to ignore, these are set to NULL. No default value.

Quiet Mode

Property ID: quietMode

Type: boolean

(Advanced) If true, a KDB log message is not shown in standard error output. Default value is false.

Encrypt Connection

Property ID: encrypt

Type: boolean

(Advanced) If set to true, the traffic between Event Stream Processor and the KDB adapter is encrypted. Default value is false.

Parameter File

Property ID: x_paramFile

Type: filename

(Advanced) File to write the parameters into, to pass to the external process. Default value is <temp>\PARAMETER_FILE.txt.

Parameter File Format

Property ID: x_paramFormat

Type: 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”.