Adaptive Server Enterprise Output Adapter

Adapter type: sybase_ase_out. The Adaptive Server Enterprise (ASE) Output adapter reads data from an Event Stream Processor stream and writes it to the Adaptive Server.

The adapter uses the bulk insert API from the Open Client™ Bulk-Library to optimally load data into the Adaptive Server database. It supports parallel load for tables that are partitioned using round-robin partitioning, but does not support guaranteed delivery. Under normal operation of the system, all Event Stream Processor messages are stored in the database. In a production environment, the Adaptive Server database server runs on a separate machine than the Event Stream Processor engine. Network bandwidth can affect message flow throughput.

The stream or window attached to the ASE Output adapter might have a schema where the order or names of the columns are different from the order or names of the columns in the target Adaptive Server Enterprise table. In such a case, specify the optional permutation adapter parameter, which describes the mapping between the stream or window columns and the columns in the database. All non-nullable columns that do not have a default value defined in the target Adaptive Server database table must have a mapping in the permutation parameter. For nullable columns that do not have a mapping provided, a default value is used, if one is defined in the database; otherwise a null value is used.

By default, the adapter performs inserts, updates, and deletes. To perform only inserts or to change all updates to inserts, you can use the optional dataWarehouseMode adapter parameter.

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

Property Label Property ID Type Description
DB Service Name service string (Required) The name of the service entry with connection information for the Adaptive Server database into which information is loaded. Specify the DB Service Name in the cluster service.xml file. Only Open Client connections are supported.

No default value.

Target DB Table Name table tables (Optional) The name of the Adaptive Server database table to load data into. This parameter is required if you are not using schema discovery.

No default value.

Include Base Content outputBase boolean (Optional) Determines whether the base data of the window or stream to which this adapter is connected is output. If set to true, the adapter processes the base data of the window or stream to which it is attached. Default value is false.
Only Base Content onlyBase boolean (Advanced) If set to true, the adapter processes only the base data of the window or stream to which it is attached. No further message flow is processed. Default value is false.
Field Mapping permutation permutation (Advanced) The list maps the Event Stream Processor column names to the database schema column names in the specified table. If you do not specify a permutation, ensure that the Event Stream Processor stream or window columns match the database schema of the destination table exactly. For example, it must have the same order, same number of columns, and compatible datatypes.

The format for this property is: <esp_columnname>=<database_columnname>:<esp_columnname>=<database_columnname>

Use a colon to separate mappings.

No default value.

Bulk Batch Size bulkBatchSize int (Advanced) Specifies the number of rows that can be inserted in a table partition before a commit occurs. Value must be a multiple of the bulkInsertArraySize parameter. Default value is 10000.
Bulk Insert Array Size bulkInsertArraySize int (Advanced) Specifies the number of rows that are simultaneously inserted into a table partition. Default value is 1000.
Idle Buffer Write Delay in Msec idleBufferWriteDelayMSec int (Advanced) Specifies the number of milliseconds that a table partition may sit idle with uncommitted data available for insert. Default value is 1000.
Buffer Age Limit in Msec bufferAgeLimitMSec int (Advanced) Forces the loading of any data that has been in existence longer than the time limit. Specify a value in milliseconds between 1 and 65535. Default value is 10000.
Data Warehouse Mode dataWarehouseMode choice
(Advanced) Specifies the type of data warehousing mode the adapter uses. Valid values are:
  • ON-- updates are converted to inserts, and deletes are ignored.
  • INSERTONLY-- only inserts are processed, and updates and deletes are ignored.
  • OFF-- (default) all inserts, updates and deletes are processed as such.
Timestamp Column Name timestampColumnName string (Advanced) If an Adaptive Server table column name is provided, the time at which the record is added to the bulk array is stored in that column of the Adaptive Server record. If this property is empty, there is no timestamp stored.

The timestamp is always in UTC rather than the ESP Server’s local time zone. No default value.

Timezone For Statistics timezoneForStats string (Advanced) Controls the time zone in which midnight statistics for the adapter roll over. For example, if the adapter is left at its default value of GMT, midnight stats reset at midnight GMT. 

This setting does not affect any other dates processed or output by this adapter. Default value is false.

Custom Statistics

The Adaptive Server Enterprise Output adapter maintains custom statistics to show its status and to track its loading activities. Enable the time granularity option in the project configuration (ccr) file to get these statistics reported by the _ESP_Adapter_Statistics metadata stream:

Rows Bytes Average Rows
  • Rows received in the last hour
  • Rows received since midnight
  • Rows loaded in the last hour
  • Rows loaded since midnight
  • Rows skipped in the last hour
  • Rows skipped since midnight
  • Bytes received since midnight
  • Bytes loaded since midnight
  • Bytes skipped since midnight
  • Average rows per second received over the last minute
  • Average rows per second received over the last hour

The "since midnight" statistics reset after midnight in the time zone specified by the timezoneForStats adapter property. If no value is set, the default behavior is reset at midnight GMT.

Related reference
Adapter Support for Schema Discovery