Amazon Redshift
Learn the required and optional properties of creating an Amazon Redshift Connection, Credential, Read Connector, and Write Connector.
Prerequisites
- A Redshift cluster
- A username and password with access to the cluster
- Connectivity through IP whitelisting or a bastion host (please contact [email protected] for support)
Connection Properties
The following table describes the fields available when creating a new Amazon Redshift connection. Create a new connection using the information below and these step-by-step instructions.
| Field | Required | Description |
|---|---|---|
| Access Type | Required | This connection type is Read-Only, Write-Only, or Read-Write. |
| Connection Name | Required | Input your desired name. |
| Field Name | Required | This is a description of the field. |
| Host | Required | The endpoint of the Amazon Redshift cluster that the read connector will be linked to. It should be in the following format: clustername.abc123xyz789.exampleserver.redshift.amazonaws.com.) |
| Port | Optional | the port number that the read connector uses. By default, Ascend.io uses 5439. |
| Database Name | Required | The name of the database that you want to access. |
| Staging Directory | Optional | The staging directory is an option on Redshift but ishighly recommended for better performance as even a couple hundred records inserted to Redshift without the COPY command can make the Redshift cluster busy. Also, for the reading side, the staging directory allows for using the UNLOAD command to first export the records to the blob store and then read in the records from there. |
| Requires Credentials | Optional | Check this box to create a new credential or select an existing credential. |
Credential Properties
The following table describes the fields available when creating a new Amazon Redshift credential.
| Field Name | Required | Description |
|---|---|---|
| Credential Name | Required | The name to identify this credential with. This credential will be available as a selection for future use. |
| Credential Type | Required | This field will automatically populate with Amazon Redshift. |
| User | Required | The Redshift username you need to gain access with this credential. |
| Password | Required | The Redshift password you need for accessing AWS. |
Read Connector Properties
The following table describes the fields available when creating a new Amazon Redshift Read Connector. Create a new Read Connector using the information below and these step-by-step instructions.
| Field Name | Required | Description |
|---|---|---|
| Connector Name | Required | Provide a name for your connector. We recommend using lowercase with underscores in place of spaces. |
| Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
| Table Name | Required | The name of the table used in the read connection. |
| Schema Name | Optional | The name of the schema of the table entered above that you wish to use specifically. |
| Replication Strategy | Optional | Allows for an exact copy of the master instance of the table to be created. Can be done in parallel, if desired. For more information on replication strategies, refer to our Database Read Strategies documentation. |
Write Connector Properties
The following table describes the fields available when creating a new Amazon Redshift Write Connector. Create a new Write Connector using the information below and these step-by-step instructions.
While it is possible to write the Redshift without an S3 staging directory, we strongly recommend using an S3 staging director because it uses Redshift's
COPYcommand and improves write performance.
| Field Name | Required | Description |
|---|---|---|
| Connector Name | Required | Provide a name for your connector. We recommend using lowercase with underscores in place of spaces. |
| Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
| Table Name | Required | The name of the table that will be written to Redshift. |
| Write Strategy | Required | The strategy to copy data into AWS. The Full Load strategy will replace the entire tables contents each time that the upstream transform has changed. If the upstream data set contains multiple Ascend partitions and not all partitions are expected to change on each update, then the Incremental By Partition strategy allows for Ascend to only update/insert/delete the partitions of the Amazon Redshift table that have changed in Ascend. |
| A SQL Statement for Ascend to execute before writing | Optional | Here, the user has the option to execute a pre-processing script before writing to final table. |
| A SQL Statement for Ascend to execute after writing | Optional | Here, the user has the option to execute a pre-processing script after writing to final table. |
Updated about 2 months ago