Configure the JDBC Input adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file.
Parameter | Description |
---|---|
Log4jProperty |
Type: string (Optional) Specify the path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties. |
Parameter | Description |
---|---|
Module |
(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, transporter. |
InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
Next |
Type: string (Required) Specify the instance name of the module that follows this one. |
Parameters |
(Required) Section containing the JdbcInputTransporterParameters element. |
JdbcInputTransporterParameters |
(Required) Section containing parameters for the JDBC Input transporter. |
Host |
Type: string (Required) Specify the server name of the database to which you are connecting the adapter. |
Port |
Type: integer (Required) Specify the port number for connecting to the database server. |
Username |
Type: string (Required) Specify the username you are using to connect to the database server. |
Password |
Type: string (Required) Specify the password for connecting to the database server. Includes an "encrypted" attribute indicating whether the password value is encrypted. If set to true, the password value is decrypted using the RSAKeyStore, RSAKeyStorePassword, and RSAKeyStoreAlias parameters. |
DbName |
Type: string (Required) Specify the database name to which you want to connect. |
DBType |
Type: string (Required) Specify the database type to which you want to connect. |
DbDriver |
Type: string (Required) Specify the JDBC driver class for your JDBC driver. |
Table |
Type: string (Optional) Specify the name of the table in the target database from which you want the adapter to read. |
Query |
Type: string (Optional) Specify which SQL query you want the adapter to execute. No default value. Set either the Table or Query parameter. If you define both parameters, the adapter only uses the Query parameter. |
RSAKeyStore |
Type: string (Dependent required) Specify the location of an RSA keystore file which contains the key used to encrypt or decrypt the password set in the Password parameter. This parameter is required if the password value is encrypted. |
RSAKeyStorePassword |
Type: string (Dependent required) Stores the password to the RSA keystore file specified in the RSAKeyStore parameter. This parameter is required if the password value is encrypted. |
RSAKeyStoreAlias |
Type: string (Dependent required) Specifies the keystore alias. This parameter is required if the password value is encrypted. |
Parameter | Description |
---|---|
Module |
(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter. |
InstanceName |
Type: string (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter. |
Name |
Type: string (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
Parameters |
(Required) Section containing the EspPublisherParameters parameter. |
EspPublisherParameters |
(Required) Section containing parameters for the ESP publisher. |
ProjectName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP project to which the adapter is connected. For example, EspProject2. This is the same project tag that you specify later in the adapter configuration file in the Name parameter of the Event Stream Processor (EspProjects) parameters section. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this property as the adapter automatically detects the project name. |
StreamName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP stream to which the adapter publishes data. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this property as the adapter automatically detects the stream name. |
MaxPubPoolSize |
Type: positive integer (Optional) Specifies the maximum size of the record pool. Record pooling, also referred to as block or batch publishing, allows for faster publication since there is less overall resource cost in publishing multiple records together compared to publishing records individually. Block publishing (record pooling or batch publishing) is disabled if this value is set to 1. The default value is 256. |
MaxPubPoolTime |
Type: positive integer (Optional) Specifies the maximum period of time, in milliseconds, for which records are pooled before being published. If not set, pooling time is unlimited and the pooling strategy is governed by maxPubPoolSize. No default value. |
UseTransactions |
Type: boolean (Optional) If set to true, pooled messages are published to Event Stream Processor in transactions. If set to false, they are published in envelopes. Default value is false. |
SafeOps |
Type: boolean (Advanced) Converts the opcodes INSERT and UPDATE to UPSERT, and converts DELETE to SAFEDELETE. The default value is false. |
SkipDels |
Type: boolean (Advanced) Skips the rows with opcodes DELETE or SAFEDELETE. The default value is false. |
Event Stream Processor parameters configure communication between Event Stream Processor and the JDBC Input adapter. You can specify multiple projects.
Parameter | Description |
---|---|
EspProjects |
Section containing parameters for connecting to Event Stream Processor. |
EspProject |
Section containing the Name and Uri parameters. Specifies information for the ESP project to which the adapter is connected. |
Name |
Type: string (Required) Specifies the unique project tag of the ESP project which the espconnector (publisher/subscriber) module references. |
Uri |
Type: string (Required) Specifies the total project URI to connect to the Event Stream Processor cluster. For example, esp://localhost:19011/ws1/p1. |
Security |
Section containing all the authentication parameters below. Specifies details for the authentication method used for Event Stream Processor. |
User |
Type: string (Required) Specifies the user name required to log in to Event Stream Processor (see AuthType). No default value. |
Password |
Type: string (Required) Specifies the password required to log in to Event Stream Processor (see espAuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
AuthType |
Type: string (Required) Specifies method used to authenticate to the
Event Stream Processor. Valid values are:
If the adapter is operated as a Studio plug-in, AuthType is overridden by the Authentication Mode Studio start-up parameter. |
RSAKeyStore |
Type: string (Dependent required) Specifies the location of the RSA keystore, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both. |
RSAKeyStorePassword |
Type:string (Dependent required) Specifies the keystore password, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both. |
KerberosKDC |
Type: string (Dependent required) Specifies host name of Kerberos key distribution center. Required if AuthType is set to kerberos. |
KerberosRealm |
Type: string (Dependent required) Specifies the Kerberos realm setting. Required if AuthType is set to kerberos. |
KerberosService |
Type: string (Dependent required) Specifies the Kerberos principal name that identifies an Event Stream Processor cluster. Required if AuthType is set to kerberos. |
KerberosTicketCache |
Type: string (Dependent required) Specifies the location of the Kerberos ticket cache file. Required if AuthType is set to kerberos. |
EncryptionAlgorithm |
Type: string (Optional) Used when the encrypted attribute for Password is set to true. If left blank, RSA is used as default. |