Database Connector Reference 1.15

String

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

x

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

String

Name of the configuration to use.

x

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]

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

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]

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

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]

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

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.

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

The text of the SQL query to execute

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

String

The text of the SQL query to execute

String

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

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

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.

Boolean

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

false

Array of Number

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

Array of String

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

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

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.

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Configures how Mule processes streams. Repeatable streams are the default behavior.

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

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.

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Configures how Mule processes streams. Repeatable streams are the default behavior.

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

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.

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.

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))

Boolean

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

false

Array of Number

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

Array of String

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

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

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

JOIN_IF_POSSIBLE

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

String

The text of the SQL query to execute

x

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

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.

Boolean

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

false

Array of Number

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

Array of String

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

String

Name of the variable that storesoperation’s output will be placed

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

The name of the table to select from

x

String

The name of the column to use for watermark. Values taken from this column will be used to filter the contents of the next poll, so that only rows with a greater watermark value are processed.

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.

Enumeration, one of:

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

NONE

Enumeration, one of:

The type of transaction to create. Availability depends on Mule version.

LOCAL

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster. When deployed in a clustered environment with multiple workers, this must be enabled to prevent duplicate record processing.

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Number

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

0

Enumeration, one of:

A TimeUnit which qualifies the #queryTimeout

SECONDS

Boolean

When true, uses column numbers (1, 2, 3..) instead of column names as keys in the result metadata. This is useful when the query returns duplicate column names, which would otherwise cause a metadata error.

false

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.

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.

Retry strategy in case of connectivity errors.