Show TOC

JDBC Output Adapter Studio PropertiesLocate this document in the navigation structure

Adapter type: toolkit_jdbc_objlist_output. Configure the adapter properties using the SAP Event Stream Processor Studio. The JDBC Output adapter uses SimpleDateFormat formatting codes.

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

Property Label Description
DB Type

Property ID: dbType

Type: string

(Required) Specify the database type to which you want to connect. Valid values: ORACLE:THIN, ORACLE:OCI8, SQLSERVER, ASE, DB2:APP, DB2:NET, DB2:UN2, HANA, KDB.

Host

Property ID: host

Type: string

(Required) Specify the server name or IP address of the database to which you are connecting.

Port

Property ID: port

Type: int

(Required) Specify the port for the database to which you are connecting.

DB Name

Property ID: dbName

Type: string

(Optional) Specify the database name to which you want to connect.

Username

Property ID: user

Type: string

(Optional) Specify the database username.

Password

Property ID: password

Type: string

(Optional) Specify the database password.

SQL Insert

Property ID: SqlInsert

Type: string

(Advanced) Specify the SQL insert clause you want the adapter to execute. Set either the DB Table or SQL Insert parameter. If you define both parameters, the adapter only uses the SQL Insert parameter.

Table Name

Property ID: table

Type: string

(Optional) Specify the name of the table in the target database from which you want the adapter to write.

Driver Class

Property ID: dbDriver

Type: string

(Advanced) Specify the JDBC driver class to use.

DB Password Encrypted

Property ID: encrypted

Type: boolean

(Advanced) Specify whether the password value is encrypted. If set to true, the password value is decrypted using the RSA Key Store, RSA Key Store Password, and RSA Key Store Alias parameters.

RSA Key Store

Property ID: rsaKeyStore

Type: filename

(Advanced) File path for RSA key store.

RSA Key Store Password

Property ID: rsaKeyStorePassword

Type: string

(Advanced) RSA key store password.

RSA Key Store Alias

Property ID: rsaKeyStoreAlias

Type: string

(Advanced) An alias stored in the RSA key store.

Batch Size

Property ID: BatchSize

Type: int

(Advanced) If the adapter is running in GD (guaranteed delivery) mode, specify the number of message rows after which the adapter issues a commit command to the external data source and a GD commit to the stream to which the adapter is attached.

If the adapter is runing without GD mode, specify the number of message rows after which the adapter issues a commit command to the external data source to which it is attached. The default value is 1.

Increasing this value improves performance at the expense of latency. It also increases memory consumption in the ESP Server because the uncommitted rows need to be preserved for redelivery in case of failure.

If running this adapter in GD mode, set either this or the BatchPeriod property to greater than 0. If neither property is set to greater than 0, a warning is sent and this property is set to 1.

Batch Period

Property ID: BatchPeriod

Type: int

(Advanced) Specify the number of seconds after which the adapter issues a commit command to the external data source and a GD commit to the stream to which the adapter is attached.

If the adapter is running without GD mode, specify the number of seconds after which the adapter issues a commit command to the external data source. The default value is 0.

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.

Include Base Content

Property ID:outputBase

Type: boolean

(Optional) If set to true, the adapter outputs the initial stream contents in addition to stream updates.

If this option is enabled and the adapter is running in GD mode, once the adapter has done a GD commit on the entire base data, the ESP Server does not redeliver the base data on adapter restart and only sends deltas that are saved for delivery. The default value is false.

Only Base Content

Property ID: onlyBase

Type: boolean

(Advanced) Sends a one-time snapshot of initial contents in a stream. Default value is false. If set to true, outputBase automatically becomes true.

Enable GD Mode

Property ID: EnableGdMode

Type: boolean

(Advanced) Specifies whether the adapter runs in guaranteed delivery (GD) mode. GD ensures that data continues to be processed in the case that the ESP Server fails, or the destination (third-party server) fails or does not respond for a long time. See Guaranteed Delivery in the SAP Event Stream Processor: Developer Guide for details on enabling GD for your project.

The default value is false.

Enable GD Cache

Property ID: EnableGdCache

Type: boolean

(Advanced)If set to true, only rows that can be recovered (that is, checkpointed) by the ESP Server on restart are sent to the end source. Other rows are cached internally by the adapter.

The default value is false.

GD Subscriber Name

Property ID: GdSubscriberName

Type: string

(Advanced) If the adapter is running in GD mode (the EnableGDMode property is set to true), specify a unique name to identify the GD subscription client. If this value is empty when running in GD mode, the adapter logs an error and shuts down.