Show TOC

KDB Input AdapterLocate this document in the navigation structure

Adapter type: KDBInput. The KDB Input adapter reads kdb or kdb+tick database tables.

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

This adapter supports schema discovery.

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) Specifies the name or IP address of the database server machine. Default value is localhost.

KDB Port

Property ID: port

Type: range

(Required for adapter operation and schema discovery) Specifies the 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) Specifies the user name for connecting to the Event Stream Processor. Default value is t.

Event Stream Processor Password

Property ID: espPassword

Type: password

(Optional) Specifies the password for the Event Stream Processor user ID. If you are using RSA authentication, you can leave this property blank. Default value is t.

Authentication

Property ID: authentication

Type: choice

(Optional) Specifies the method used to authenticate to the kdb or kdb+tick database tables. Valid values are:

  • value="user_password" label="username/password"
  • value="rsa" label="RSA"
  • 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) Specifies the 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) Specifies the 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) Specifies the 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.

Source Table

Property ID: table

Type: tables

(Advanced) Specifies the name of the source table to retrieve data from. This property supports SQL query statements. 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) Specifies if the adapter should connect to a kdb+tick database and read in streaming data or execute the supplied query and feed the result to Event Stream Processor. Valid value list:

  • value="stream", label ="Stream"
  • value="pull", label="One time pull"
Default value is "stream".
Polling Interval

Property ID: pollInterval

Type: int

(Advanced) Specifies the number of seconds to wait before reexecuting query in pull mode. If set to 0, the query is not reexecuted. Default value is 0.

Block Size

Property ID: blockSize

Type: int

(Advanced) Determines the number of records in each block. Applies to transaction and envelope modes. Default value is 1.

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.

Encrypt Connection

Property ID: encrypt

Type: boolean

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

Print Debug Info

Property ID: debug

Type: boolean

(Advanced) Specifies if the adapter prints additional debugging information to the console. Default value is false.

Use Transaction Blocks

Property ID: useTransaction

Type: boolean

(Advanced) For better performance, use transaction blocks instead of envelopes while sending data to Event Stream Processor. Default value is false.

Connection Retries

Property ID: connectionRetries

Type: int

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

Event Stream Processor Host Name

Property ID: gatewayHost

Type: string

(Advanced) Specifies the explicit gateway host name. No default value.

Parameter File

Property ID: x_paramFile

Type: filename

(Advanced) Specifies the file to write the parameters into, to pass to the external process. No default value.

Parameter File Format

Property ID: x_paramFormat

Type: choice

(Advanced) Specifies the format in which the external process expects the parameters. Valid value list:

  • value = prop, label = "Java properties"
  • value = shell, label = "Unix shell assignments"
  • value = xml, label = "Simple XML"
Default value is "prop".

Known limitations:

  • If the kdb+tick databases are not running when the adapter tries to make a connection, the adapter waits indefinitely until the kdb+tick database is started.
    Note This issue occurs only if the kdb+tick database and Event Stream Processor are running on different machines.
  • If the connection to the database is broken, any updates that happen between the time the connection is broken and reestablished are lost.