Amazon Redshift reverse ETL source

Amazon Redshift is one of the fastest cloud data warehouse services. It lets you handle large analytical workloads with best-in-class performance, speed, and efficiency.

RudderStack supports Amazon Redshift as a source from which you can ingest data and route it to your desired downstream destinations.

Granting permissions

RudderStack requires you to grant certain user permissions on your Amazon Redshift warehouse to successfully access data from it.

Run the queries listed in the following sections on Amazon Redshift Console in the exact order to grant these permissions:

Step 1: Creating a new user in Redshift

1. Create a new user rudder with a password <strong_unique_password>.

CREATE USER rudder WITH PASSWORD '<strong_unique_password>'

Password considerations for Redshift

The password set in the above command must meet the following conditions:

• It should be 8-64 characters in length.
• It must contain atleast one upper case, one lower case, and one number.
• It can contain any ASCII characters with the ASCII codes 33-126, with the exception of ' (single quotation mark), " (double quotation mark), \, /, and @.

For more information on the password rules, refer to the Amazon Redshift documentation.

Step 2: Creating the RudderStack schema and granting permissions

1. Create a dedicated schema _rudderstack.

CREATE SCHEMA "_rudderstack";

The _rudderstack schema is used by RudderStack for storing the state of each data sync. Hence, its name should not be changed.

2. Grant full access to schema _rudderstack for the user rudder.

GRANT ALL ON SCHEMA "_rudderstack" TO rudder;

3. Grant full access to the user rudder over all _rudderstack schema objects.

GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA "_rudderstack" TO rudder;

Step 3: Granting permissions on your schema and table

1. Grant access to the user rudder to look up the objects within your schema:

GRANT USAGE ON SCHEMA "<YOUR_SCHEMA>" TO rudder;

2. Grant access to the user rudder to read data from the required table/view:

GRANT SELECT ON TABLE "<YOUR_SCHEMA>"."<YOUR_TABLE>" TO rudder;

Replace <YOUR_SCHEMA> and <YOUR_TABLE> with the exact names of your Redshift schema and table respectively.

Optional commands

• The following command grants access to the user rudder to view and read data from all the tables present in the schema <YOUR_SCHEMA>:

GRANT SELECT ON ALL TABLES IN SCHEMA "<YOUR_SCHEMA>" TO rudder;

Run the above command only if you’re okay with RudderStack being able to access the data in all tables residing within your specified schema.

• The following command grants access to the user rudder to read data from all future tables created by the user creator in your schema:

ALTER DEFAULT PRIVILEGES for user creator IN SCHEMA "<YOUR_SCHEMA>" GRANT SELECT ON TABLES TO rudder;

Run the above command only if you’re okay with RudderStack being able to access the data in all future tables residing within your specified schema.

Replace <YOUR_SCHEMA> with the exact name of your Redshift schema.

Setting up the Redshift source in RudderStack

To set up Redshift as a source in RudderStack, follow these steps:

Naming the source

1. Log in to your RudderStack dashboard.
2. From the left navigation bar, go to Source > New Source > Reverse ETL. Then, select Redshift:

3. Assign a name to the source.

Configuring the connection credentials

1. Choose from the Table or Model option to sync data from either a warehouse table or a model.

For more information on the Table and Model options, refer to the FAQ section.

If you chose the Model option, skip the next steps and refer to the Schedule settings section directly.

2. Enter the relevant settings in the Connection Credentials section as listed below:

• Host: Enter the host name of your Redshift service.
• Port: Enter the port number associated with the Redshift database instance.
• Database: Enter the database name in your Redshift instance where RudderStack should send the data.
• User: Enter the user name of your Redshift cluster created in Step 5 of this section.
• Password: Enter the password for the above user.
• SSL Mode: Select the SSL mode as disable or require depending on how RudderStack should connect to your Redshift instance.

If you have already configured a destination in RudderStack, choose the Use Existing Destination option which will take you to the Schema tab in the source settings. To add a new destination from scratch, select the Create New Destination option which will take you to the destination configuration page.

Specifying the data to import

While connecting a destination to your Reverse ETL source, you can use the default JSON mapping or the Visual Data Mapping feature.

Based on the option(Table/Model) you chose while setting up the Reverse ETL source, follow the relevant guide for detailed steps:

• Importing Data using Tables
• Importing Data using Models

FAQ

What are the SSL mode options when setting up the Redshift source in RudderStack?

When setting up a Redshift source, RudderStack provides the following two SSL options:

• disable: SSL mode is disabled when you select this option. Use it in cases where security is not an issue and you don’t want any encryption overhead.
• require: When you select this option, your data is encrypted and sent to RudderStack. Use it in cases where security is important and you can deal with the resulting encryption overhead.

What do the three validations under Verifying Credentials imply?

When setting up a Reverse ETL source, once you proceed after entering the connection credentials, you will see the following three validations under the Verifying Credentials option:

These options are explained below:

• Verifying Connection: This option indicates that RudderStack is trying to connect to the warehouse with the information specified in the connection credentials.

If this option gives an error, it means that one or more fields specified in the connection credentials are incorrect. Verify your credentials in this case.

• Able to List Schema: This option checks if RudderStack is able to fetch all schema details using the provided credentials.
• Able to Access RudderStack Schema: This option implies that RudderStack is able to access the _RUDDERSTACK schema you have created by successfully running all commands in the User Permissions section.

If this option gives an error, verify if you have successfully created the _RUDDERSTACK schema and given RudderStack the required permissions to access it. For more information, refer to Creating the RudderStack schema and granting permissions section.

What is the difference between the Table and Model options when creating a Reverse ETL source?

When creating a new Reverse ETL source, you are presented with the following two options from which RudderStack will sync the data:

• When you choose Table, RudderStack imports all data associated with the specified table during the sync.
• When you choose Model, RudderStack imports the data by running the query specified in the connected model, during the sync.

Questions? Contact us by email or on Slack