Amazon Redshift Connector 1.1 Reference | MuleSoft Documentation
# Amazon Redshift Connector 1.1 Reference
Anypoint Connector for Amazon Redshift (Amazon Redshift Connector) is a bulk-load connector that enables you to connect to the Amazon Redshift database to perform inserts, deletes, updates, and to execute SQL queries.
## Configurations
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Basic Connection
  * 
| The connection types to provide to this configuration.  
The identifier of this element used to reference it in other components  
Expiration Policy |  Expiration Policy | Minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.  
## Connection Types
### Basic Connection
This connection uses database credentials for authentication.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Pooling Profile |  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:
  * READ_COMMITTED
  * READ_UNCOMMITTED
  * REPEATABLE_READ
  * SERIALIZABLE
  * NOT_CONFIGURED

| Transaction isolation level to set on the driver when connecting to the database. | NOT_CONFIGURED  
Use XA Transactions | Indicates whether or not the created datasource must support XA transactions. The default is false.  
Cluster Id | Cluster identifier.  
Region Endpoint | Region to use for authentication against the database. | us-east-1  
Configures the port of the database.  
Database | Database name.  
Database user name.  
Connection Properties | Specifies a list of custom key-value connection properties to configure on the driver when connecting to the database.  
Password | Password to use for authentication against the database.  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
### IAM Connection
This connection uses IAM credentials to retrieve temporary database credentials for authentication.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Pooling Profile |  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:
  * READ_COMMITTED
  * READ_UNCOMMITTED
  * REPEATABLE_READ
  * SERIALIZABLE
  * NOT_CONFIGURED

| Transaction isolation level to set on the driver when connecting to the database. | NOT_CONFIGURED  
Use XA Transactions | Indicates whether or not the created datasource must support XA transactions. The default is false.  
Cluster Id | Cluster identifier.  
Region Endpoint | Region to use for authentication against the database. | us-east-1  
Configures the port of the database.  
Database | Database name.  
Database user name.  
Connection Properties | Specifies a list of custom key-value connection properties to configure on the driver when connecting to the database.  
Access Key | Access key provided by Amazon for retrieving temporary database credentials.  
Secret Key | Secret key provided by Amazon for retrieving temporary database credentials.  
Role configuration.  
Custom STS Endpoint | Sets a custom STS endpoint. Useful when a non-standard service endpoint is required, such as a VPC or FIPS endpoint.  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
## On Table Row
`<redshift:listener>`
Selects from a table at a regular interval and generates one message per row that is obtained. 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 automatically ensures that the same row is not picked twice by concurrent polls.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Name of the table to select from.  
Watermark Column | Name of the column to use for the watermark. Values taken from the watermark column will be used to filter the contents of the next poll, so that only rows with a greater watermark value are processed.  
Id Column | Name of the column to use as the row ID. If provided, this component ensures that the same row is not processed twice by concurrent polls.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_BEGIN

| The type of beginning action that sources can take for transactions.  
Transaction Type |  Enumeration, one of: | The type of transaction to create. Availability depends on Mule version.  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
### For Configurations
  * 

## Operations
  *   *   *   *   * Execute Script
  *   * Stored Procedure


## Bulk Delete
`<redshift:bulk-delete>`
Enables the execution of one delete statement at various times using different parameter bindings. This uses a single database statement, which has performance advantages compared to executing a single delete operation at various times.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Input Parameters |  Array of Object | A `java.util.List` of `java.util.Maps` in which every list item represents a row to be inserted. The map contains the parameter names as keys and the value the parameter is bound to. | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Array of Number  
---  
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Bulk Insert
`<redshift:bulk-insert>`
Enables the execution of one insert statement at various times using different parameter bindings. This uses a single database statement, which has performance advantages compared to executing a single update operation at various times.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Input Parameters |  Array of Object | A java.util.List of java.util.Maps in which every list item represents a row to be inserted. The map contains the parameter names as keys and the value the parameter is bound to. | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
## Bulk Insert
`<redshift:bulk-insert>`
Enables the execution of one insert statement at various times using different parameter bindings. This uses a single database statement, which has performance advantages compared to executing a single update operation at various times.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Input Parameters |  Array of Object | A java.util.List of java.util.Maps in which every list item represents a row to be inserted. The map contains the parameter names as keys and the value the parameter is bound to. | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Array of Number  
---  
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Bulk Update
`<redshift:bulk-update>`
Enables the execution of one update statement at various times using different parameter bindings. This uses a single database statement, which has performance advantages compared to executing a single update operation at various times.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Input Parameters |  Array of Object | A java.util.List of java.util.Maps in which every list item represents a row to be inserted. The map contains the parameter names as keys and the value the parameter is bound to. | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Array of Number  
---  
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Delete
`<redshift:delete>`
Deletes data in a database.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Input Parameters  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Execute DDL
`<redshift:execute-ddl>`
Enables execution of DDL queries against a database.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
SQL Query Text | Text of the SQL query to execute.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Execute Script
`<redshift:execute-script>`
Executes a SQL script in a single database statement. The script is executed as provided by the user, without any parameter binding.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
SQL Query Text | SQL query to execute.  
Script Path  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Array of Number  
---  
### For Configurations
  *
| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
SQL Query Text | SQL query to execute.  
Script Path  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Array of Number  
---  
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Insert
`<redshift:insert>`
Inserts data into a database.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Input Parameters  
Auto Generate Keys | Indicates when to make auto-generated keys available for retrieval.  
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 to make available for retrieval.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Statement Result  
---  
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Query Single
`<redshift:query-single>`
Selects a single result from a database. If the specified SQL query returns more than one record, only the first record is returned. Streaming is not used for this operation, so you must be careful because all selected fields will be loaded to memory.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Input Parameters  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Select
`<redshift:select>`
Selects data from a database. Streaming is automatically applied to avoid performance and memory issues that can be caused by preemptive consumption of results.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configure if repeatable streams should be used and their behavior  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Input Parameters  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Array of Object  
---  
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION


## Stored Procedure
`<redshift:stored-procedure>`
Invokes a Stored Procedure on the database. When the stored procedure returns one or more java.sql.ResultSet instances, streaming is automatically applied to avoid performance and memory issues that can be caused by preemptive consumption of results.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION


## Stored Procedure
`<redshift:stored-procedure>`
Invokes a Stored Procedure on the database. When the stored procedure returns one or more java.sql.ResultSet instances, streaming is automatically applied to avoid performance and memory issues that can be caused by preemptive consumption of results.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Input Parameters  
Input - Output Parameters  
Output Parameters |  Array of Output Parameter  
Auto Generate Keys | Indicates when to make auto-generated keys available for retrieval.  
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 to make available for retrieval.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Update
`<redshift:update>`
Updates data in a database.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take for transactions. | JOIN_IF_POSSIBLE  
Query Timeout | Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.  
Query Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Query Timeout** field.  
Fetch Size | Limit for the number of records to retrieve in a single page.  
Max Rows | Indicates the maximum number of rows to fetch from the result set.  
SQL Query Text | SQL query to execute.  
Parameter Types |  Array of Parameter Type  
Input Parameters  
Auto Generate Keys | Indicates when to make auto-generated keys available for retrieval.  
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 to make available for retrieval.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable**. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Statement Result  
---  
### For Configurations
  * 

### Throws
  * REDSHIFT:BAD_SQL_SYNTAX
  * REDSHIFT:CONNECTIVITY
  * REDSHIFT:QUERY_EXECUTION
  * REDSHIFT:RETRY_EXHAUSTED


## Types
### Pooling Profile
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Pool Size**  
**Min Pool Size**  
**Acquire Increment**  
**Prepared Statement Cache Size**  
**Max Wait Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

  
**Max Idle Time**  
**Additional Properties**  
### Column Type
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
If false, the reconnection strategy will run in a separate, non-blocking thread  
How many reconnection attempts to make.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
If false, the reconnection strategy will run in a separate, non-blocking thread  
### Role
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The Amazon Resource Name (ARN) of the role to assume.  
**External Id** |  A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provides an external ID, then provide that value in this field.  
The duration of the role session.  
**Duration Time Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the Duration value.  
**Referred Policy Arns** |  Array of String |  The Amazon Resource Names (ARNs) of the IAM-managed policies to use as managed session policies. The policies must exist in the same account as the role.  
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
|  Time unit for the Duration value.  
**Referred Policy Arns** |  Array of String |  The Amazon Resource Names (ARNs) of the IAM-managed policies to use as managed session policies. The policies must exist in the same account as the role.  
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Max Idle Time** field.  
### Redelivery Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Redelivery Count** |  The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message  
**Message Digest Algorithm** |  The secure hashing algorithm to use. If not set, the default is SHA-256.  
**Message Identifier** |  Redelivery Policy Message Identifier |  Defines which strategy is used to identify the messages.  
**Object Store** |  ObjectStore |  The object store where the redelivery counter for each message is stored.  
### Redelivery Policy Message Identifier
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Use Secure Hash** |  Whether to use a secure hash algorithm to identify a redelivered message.  
**Id Expression** |  Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if **Use Secure Hash** is false.  
### Parameter Type
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Type Classifier** |  Type Classifier  
### Type Classifier
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * TINYINT
  * SMALLINT
  * INTEGER
  * BIGINT
  * FLOAT
  * DOUBLE
  * NUMERIC
  * DECIMAL
  * VARCHAR
  * LONGVARCHAR
  * TIMESTAMP
  * BINARY
  * VARBINARY
  * LONGVARBINARY
  * OTHER
  * JAVA_OBJECT
  * DISTINCT
  * STRUCT
  * ARRAY
  * DATALINK
  * BOOLEAN
  * ROWID
  * NCHAR
  * NVARCHAR
  * LONGNVARCHAR
  * NCLOB
  * SQLXML
  * UNKNOWN

  
**Custom Type**  
### Statement Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Affected Rows**  
**Generated Keys**  
### Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.  
**Buffer Size Increment** |  This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.  
**Max Buffer Size** |  The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.  
### Repeatable File Store Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**In Memory Objects** |  The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which maxInMemorySize is expressed  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.  
**Buffer Size Increment** |  This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.  
**Max Buffer Size** |  The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which all these attributes are expressed  
### Repeatable File Store Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**In Memory Size** |  Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.  
**Buffer Unit** |  Enumeration, one of: |  The unit in which maxInMemorySize is expressed  
### Output Parameter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Type Classifier** |  Type Classifier  
## See Also
  * MuleSoft Help Center