Connector for connecting to relation Databases through the JDBC API
Configurations
Config
Connector for connecting to relation Databases through the JDBC API
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
The name of this configuration. With this name can be later referenced. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
Connection Types
Data Source Reference Connection
ConnectionProvider implementation which creates DB connections from a referenced
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 Strategy |
A retry strategy in case of connectivity errors |
|
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:
|
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 Strategy |
A retry strategy in case of connectivity errors |
|
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:
|
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 Strategy |
A retry strategy in case of connectivity errors |
|
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:
|
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 Strategy |
A retry strategy in case of connectivity errors |
|
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:
|
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 Strategy |
A retry strategy in case of connectivity errors |
|
Associated Operations
Operations
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. contains the parameter names as keys and the value the parameter is bound to. according to the order in which commands were added to the batch.
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 |
#[payload] |
|
Transactional Action |
Enumeration, one of:
|
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:
|
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 |
|
Output
Type |
Array of Number |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
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. contains the parameter names as keys and the value the parameter is bound to. according to the order in which commands were added to the batch.
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 |
#[payload] |
|
Transactional Action |
Enumeration, one of:
|
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:
|
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 |
|
Output
Type |
Array of Number |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
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. contains the parameter names as keys and the value the parameter is bound to. according to the order in which commands were added to the batch.
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 |
#[payload] |
|
Transactional Action |
Enumeration, one of:
|
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:
|
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 |
|
Output
Type |
Array of Number |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
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:
|
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:
|
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 |
|
Output
Type |
Number |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
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:
|
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:
|
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 |
|
Output
Type |
Number |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
Execute Script
Executes a SQL script in one single Database statement. The script is executed as provided by the user, without any parameter binding. according to the order in which commands were added to the batch.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Transactional Action |
Enumeration, one of:
|
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:
|
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 |
|
Output
Type |
Array of Number |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
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:
|
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:
|
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 |
|
Output
Type |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
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:
|
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 behaviour |
|
||
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:
|
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 |
|
Output
Type |
Array of Object |
For Configurations.
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:
|
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:
|
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 |
|
Output
Type |
Object |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
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:
|
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:
|
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 |
|
Output
Type |
For Configurations.
Throws
-
DB:CONNECTIVITY
-
DB:RETRY_EXHAUSTED
Types
Pooling Profile
Field | Type | Default Value |
---|---|---|
Max Pool Size |
Number |
5 |
Min Pool Size |
Number |
0 |
Acquire Increment |
Number |
1 |
Prepared Statement Cache Size |
Number |
5 |
Max Wait |
Number |
0 |
Max Wait Unit |
Enumeration, one of:
|
SECONDS |
Column Type
Field | Type | Default Value |
---|---|---|
Id |
Number |
|
Type Name |
String |
|
Class Name |
String |
Reconnect
Field | Type | Default Value |
---|---|---|
Frequency |
Number |
|
Count |
Number |
|
Blocking |
Boolean |
Reconnect Forever
Field | Type | Default Value |
---|---|---|
Frequency |
Number |
Parameter Type
Field | Type | Default Value |
---|---|---|
Key |
String |
|
Type Classifier |
Type Classifier
Field | Type | Default Value |
---|---|---|
Type |
Enumeration, one of:
|
|
Custom Type |
String |
Statement Result
Field | Type | Default Value |
---|---|---|
Affected Rows |
Number |
|
Generated Keys |
Object |
Repeatable In Memory Iterable
Field | Type | Default Value |
---|---|---|
Initial Buffer Size |
Number |
|
Buffer Size Increment |
Number |
|
Max Buffer Size |
Number |
Repeatable File Store Iterable
Field | Type | Default Value |
---|---|---|
Max In Memory Size |
Number |
|
Buffer Unit |
Enumeration, one of:
|
Output Parameter
Field | Type | Default Value |
---|---|---|
Key |
String |
|
Type Classifier |