Configure the JDBC Output adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file.
XML Element | Description |
---|---|
Log4jProperty |
Type: string (Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties. |
The ESP Subscriber module obtains data from an ESP project and passes it along to a transporter or formatter module.
XML Element | Description |
---|---|
Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, espconnector. |
InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
Next |
Type: string (Required) Instance name of the module that follows this one. |
BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
Parameters |
(Required) Element containing the EspSubscriberParameters element. |
EspSubscriberParameters |
(Required) Element containing elements for the ESP subscriber. |
ProjectName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Specifies the unique project tag 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 element within the Event Stream Processor (EspProjects) element. 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 element 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 from which the adapter subscribes to 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 element as the adapter automatically detects the stream name. |
The JDBC Output transporter obtains data from the previous module specified in the adapter configuration file and writes it into a database table using JDBC.
XML Element | Description |
---|---|
Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, transporter. |
InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
Parameters |
(Required) Element containing the JdbcOutputTransporterParameters element. |
JdbcOutputTransporterParameters |
(Required) Element containing the JDBC Output transporter elements. |
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 elements. |
DbName |
Type: string (Required) Specify the database name of the database to which you want to connect. |
DBType |
Type: string (Required) Specify the database type of the database 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 to which you want the adapter to write. |
SqlInsert |
Type: string (Optional) Specify the SQL clause you want the adapter to execute. No default value. Set either the Table or SqlInsert element. If you define both elements, the adapter uses only the SqlInsert element. |
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 element. This element 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 element. This element is required if the password value is encrypted. |
RSAKeyStoreAlias |
Type: string (Dependent required) Specifies the keystore alias. This element is required if the password value is encrypted. |
BatchSize |
Type: integer (Optional) Specify the number of records to process as a batch. |
BatchPeriod |
Type: integer (Optional) Specify the period for processing a batch, in milliseconds. |
Event Stream Processor elements configure communication between Event Stream Processor and the JDBC Output adapter. You can specify multiple ESP projects.
XML Element | Description |
---|---|
EspProjects |
(Required) Element containing elements for connecting to Event Stream Processor. |
EspProject |
(Required) Element containing the Name and Uri elements. 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 ESP project. For example, esp://localhost:19011/ws1/p1. |
Security |
(Required) Element containing all the authentication elements 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. The default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
AuthType |
Type: string (Required) 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. |