Nav

Database Connector Documentation Reference

Connector for connecting to relation Databases through the JDBC API

Configurations


Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Data Source Reference Connection

ConnectionProvider implementation which creates DB connections from a referenced DataSource

Parameters
Name Type Description Default Value Required

Pooling Profile

Provides a way to configure database connection pooling.

 

Column Types

Array of Column Type

Specifies non-standard column types

 

Data Source Ref

Any

Reference to a JDBC DataSource object. This object is typically created using Spring. When using XA transactions, an XADataSource object must be provided.

x 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Derby Connection

Creates connections to a Derby database

Parameters
Name Type Description Default Value Required

Pooling Profile

Provides a way to configure database connection pooling.

 

Column Types

Array of Column Type

Specifies non-standard column types

 

Transaction Isolation

Enumeration, one of:

  • NONE

  • READ_COMMITTED

  • READ_UNCOMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

  • NOT_CONFIGURED

The transaction isolation level to set on the driver when connecting the database.

NOT_CONFIGURED

 

Use XA Transactions

Boolean

Indicates whether or not the created datasource has to support XA transactions. Default is false.

false

 

Database

String

Name of the database

 

Subsub Protocol

String

Specifies the type of SubsubProtocol to be used by Derby. The available options are: 'directory', 'memory', 'classpath' and 'jar'.

directory

 

Create

Boolean

Indicates if the database should be created if it this not exist.

false

 

Connection Properties

Object

Specifies a list of custom key-value connectionProperties for the config.

 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Generic Connection

ConnectionProvider that creates connections for any kind of database using a JDBC URL and the required JDBC Driver Class

Parameters
Name Type Description Default Value Required

Pooling Profile

Provides a way to configure database connection pooling.

 

Column Types

Array of Column Type

Specifies non-standard column types

 

Transaction Isolation

Enumeration, one of:

  • NONE

  • READ_COMMITTED

  • READ_UNCOMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

  • NOT_CONFIGURED

The transaction isolation level to set on the driver when connecting the database.

NOT_CONFIGURED

 

Use XA Transactions

Boolean

Indicates whether or not the created datasource has to support XA transactions. Default is false.

false

 

URL

String

JDBC URL to be used to connect to the database.

x 

Driver Class Name

String

Fully-qualified name of the database driver class.

x 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Microsoft SQL Server Connection

DbConnectionProvider implementation for Microsoft SQL Server Databases

Parameters
Name Type Description Default Value Required

Pooling Profile

Provides a way to configure database connection pooling.

 

Column Types

Array of Column Type

Specifies non-standard column types

 

Transaction Isolation

Enumeration, one of:

  • NONE

  • READ_COMMITTED

  • READ_UNCOMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

  • NOT_CONFIGURED

The transaction isolation level to set on the driver when connecting the database.

NOT_CONFIGURED

 

Use XA Transactions

Boolean

Indicates whether or not the created datasource has to support XA transactions. Default is false.

false

 

Host

String

Configures the host of the database

x 

Port

Number

Configures the port of the database

1433

 

User

String

The user that is used for authentication against the database

 

Password

String

The password that is used for authentication against the database

 

Database Name

String

Name of the default database to work with

 

Connection Properties

Object

Specifies a list of custom key-value connectionProperties for the config.

 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

MySQL Connection

Creates connections to a MySQL database.

Parameters
Name Type Description Default Value Required

Pooling Profile

Provides a way to configure database connection pooling.

 

Column Types

Array of Column Type

Specifies non-standard column types

 

Transaction Isolation

Enumeration, one of:

  • NONE

  • READ_COMMITTED

  • READ_UNCOMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

  • NOT_CONFIGURED

The transaction isolation level to set on the driver when connecting the database.

NOT_CONFIGURED

 

Use XA Transactions

Boolean

Indicates whether or not the created datasource has to support XA transactions. Default is false.

false

 

Host

String

Configures the host of the database

x 

Port

Number

Configures the port of the database

x 

User

String

The user that is used for authentication against the database

 

Password

String

The password that is used for authentication against the database

 

Database

String

The name of the database

 

Connection Properties

Object

Specifies a list of custom key-value connectionProperties for the config.

 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Oracle Connection

Creates connections to a Oracle database

Parameters
Name Type Description Default Value Required

Pooling Profile

Provides a way to configure database connection pooling.

 

Column Types

Array of Column Type

Specifies non-standard column types

 

Transaction Isolation

Enumeration, one of:

  • NONE

  • READ_COMMITTED

  • READ_UNCOMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

  • NOT_CONFIGURED

The transaction isolation level to set on the driver when connecting the database.

NOT_CONFIGURED

 

Use XA Transactions

Boolean

Indicates whether or not the created datasource has to support XA transactions. Default is false.

false

 

Host

String

Configures the host of the database

x 

Port

Number

Configures the port of the database

1521

 

User

String

The user that is used for authentication against the database

 

Password

String

The password that is used for authentication against the database

 

Instance

String

The name of the database instance

 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Associated Sources

Operations

Bulk Delete

<db:bulk-delete>

Allows executing one delete statement various times using different parameter bindings. This happens using one single Database statement, which has performance advantages compared to executing one single delete operation various times.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Input Parameters

Array of Object

A List of Maps in which every list item represents a row to be inserted, and the map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Number

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Bulk Insert

<db:bulk-insert>

Allows executing one insert statement various times using different parameter bindings. This happens using one single Database statement, which has performance advantages compared to executing one single update operation various times.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Input Parameters

Array of Object

A List of Maps in which every list item represents a row to be inserted, and the map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Number

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Bulk Update

<db:bulk-update>

Allows executing one update statement various times using different parameter bindings. This happens using one single Database statement, which has performance advantages compared to executing one single update operation various times.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Input Parameters

Array of Object

A List of Maps in which every list item represents a row to be inserted, and the map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Number

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Delete

<db:delete>

Deletes data in a database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Input Parameters

Object

A Map which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Execute DDL

<db:execute-ddl>

Enables execution of DDL queries against a database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

SQL Query Text

String

The text of the SQL query to be executed

x 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Execute Script

<db:execute-script>

Executes a SQL script in one single Database statement. The script is executed as provided by the user, without any parameter binding.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

SQL Query Text

String

The text of the SQL query to be executed

 

Script Path

String

The location of a file to load. The file can point to a resource on the classpath or on a disk.

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Number

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Insert

<db:insert>

Inserts data into a Database

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Input Parameters

Object

A Map which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

 

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

 

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

 

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys should be made available for retrieval.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Select

<db:select>

Selects data from a database. Streaming is automatically applied to avoid preemptive consumption of such results, which may lead to performance and memory issues.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Streaming Strategy

Configure if repeatable streams should be used and their behavior

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Input Parameters

Object

A Map which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Object

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:BAD_SQL_SYNTAX  

Stored Procedure

<db:stored-procedure>

Invokes a Stored Procedure on the database.

When the stored procedure returns one or more ResultSet instances, streaming is automatically applied to avoid preemptive consumption of such results, which may lead to performance and memory issues.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Input Parameters

Object

A Map which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

 

Input - Output Parameters

Object

A Map which keys are the name of a parameter to be set on the JDBC prepared statement which is both input and output.

Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

 

Output Parameters

Array of Output Parameter

A list of output parameters to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: call multiply(:value, :result))

 

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

 

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

 

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys should be made available for retrieval.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Object

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Update

<db:update>

Updates data in a database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

SQL Query Text

String

The text of the SQL query to be executed

 

Parameter Types

Array of Parameter Type

Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

 

Input Parameters

Object

A Map which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

 

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

 

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

 

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys should be made available for retrieval.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • DB:QUERY_EXECUTION  

  • DB:CONNECTIVITY  

  • DB:RETRY_EXHAUSTED  

  • DB:BAD_SQL_SYNTAX  

Sources

Listener

<db:listener>

Selects from a table at a regular interval and generates one message per each obtained row.

Optionally, watermark and id columns can be provided. If a watermark column is provided, the values taken from that column will be used to filter the contents of the next poll, so that only rows with a greater watermark value are returned. If an id column is provided, this component will automatically make sure that the same row is not picked twice by concurrent polls

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table

String

The name of the table to select from

x 

Watermark Column

String

The name of the column to use for watermark

 

Id Column

String

The name of the column to consider as row ID. If provided, this component will make sure that the same row is not processed twice by concurrent polls.

 

Transactional Action

Enumeration, one of:

  • ALWAYS_BEGIN

  • NONE

The type of beginning action that sources can take regarding transactions.

NONE

 

Transaction Type

Enumeration, one of:

  • LOCAL

  • XA

The type of transaction to create. Availability will depend on the runtime version.

LOCAL

 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

 

Scheduling Strategy

Configures the scheduler that triggers the polling

x 

Redelivery Policy

Defines a policy for processing the redelivery of the same message

 

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

 

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #queryTimeout

SECONDS

 

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true; in that case a default value (10) is used.

 

Max Rows

Number

Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Object

For Configurations.

Types

Pooling Profile

Field Type Description Default Value Required

Max Pool Size

Number

Maximum number of connections a pool maintains at any given time

5

Min Pool Size

Number

Minimum number of connections a pool maintains at any given time

0

Acquire Increment

Number

Determines how many connections at a time to try to acquire when the pool is exhausted

1

Prepared Statement Cache Size

Number

Determines how many statements are cached per pooled connection. Setting this to zero will disable statement caching

5

Max Wait

Number

The amount of time a client trying to obtain a connection waits for it to be acquired when the pool is exhausted. Zero (default) means wait indefinitely

0

Max Wait Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A #maxWait.

SECONDS

Column Type

Field Type Description Default Value Required

Id

Number

Type identifier used by the JDBC driver.

x

Type Name

String

Name of the data type used by the JDBC driver.

x

Class Name

String

Indicates which Java class must be used to map the DB type.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

The object store where the redelivery counter for each message is going to be stored.

Parameter Type

Field Type Description Default Value Required

Key

String

The name of the input parameter.

x

Type Classifier

x

Type Classifier

Field Type Description Default Value Required

Type

Enumeration, one of:

  • BIT

  • TINYINT

  • SMALLINT

  • INTEGER

  • BIGINT

  • FLOAT

  • REAL

  • DOUBLE

  • NUMERIC

  • DECIMAL

  • CHAR

  • VARCHAR

  • LONGVARCHAR

  • DATE

  • TIME

  • TIMESTAMP

  • BINARY

  • VARBINARY

  • LONGVARBINARY

  • NULL

  • OTHER

  • JAVA_OBJECT

  • DISTINCT

  • STRUCT

  • ARRAY

  • BLOB

  • CLOB

  • REF

  • DATALINK

  • BOOLEAN

  • ROWID

  • NCHAR

  • NVARCHAR

  • LONGNVARCHAR

  • NCLOB

  • SQLXML

  • UNKNOWN

Custom Type

String

Statement Result

Field Type Description Default Value Required

Affected Rows

Number

Generated Keys

Object

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Output Parameter

Field Type Description Default Value Required

Key

String

The name of the input parameter.

x

Type Classifier

x