🔌Add an AWS Redshift connector

How to connect an AWS Redshift in Toucan

Connector features

You can use the Toucan AWS Redshift connector to connect to your AWS Redshift account with a db_credentials or aws_credentiamls and access tables or views with a SQL query or by using our no-code form .

With this connection, you can fetch data from your Snowflake to fill your charts and dashboards.

Changelog

December 23 - This connector is NativeSQL compatible November 2024 - This connector supports hybrid pipelines

Configuring an AWS Redshift connection

Follow the steps described in Add a connector, choose AWS Redshift and fill out the form with the following info:

Field	Format / Type	Description	Example
Name (mandatory)	String	Use it to identify your connection	MyRedshiftConnection
Host (mandatory)	String	The hostname of the Amazon Redshift cluster	example-cluster.1111.us-west-2.redshift.amazonaws.com
Port (mandatory)	Integer	The listening port of your Redshift Database	5439
Cluster identifier (mandatory)	String	The cluster identifier of the Amazon Redshift cluster	example-cluster
Default database (optional)	String	The name of the database instance to connect to	default_db
AuthenticationMethod	Enum	Authentication mechanism that will be used to connect to your Redshift datasource : - db_credentials - aws_credentials (This approach allows users to use AWS credentials and limit the permissions the connected user has. The user should have the right permissions to access the redshift database. To find some examples of rights permissions, see this documentation and this one.) - aws_profile( CAUTION: This authentication method can only work for now with the self-hosted mode. For more details about the profile: AWS CLI Profile, you must fill the db_user and profile fields. To find some examples of rights permissions, see this documentation and this one.)
Username	String	Mandatory for db_credentials The username to use for authentication with the Amazon Redshift cluster	dbuser
Password	String	Mandatory for db_credentials The password that will be used to authenticate to the Redshift cluster	abcD1234
Db user	String	Mandatory for aws_credentials and aws_profile The user ID to use with Amazon Redshift	awsuser
Access Key Id	String	Mandatory for aws_credentials The access key id of your aws account.	AKIAIOSFODNN7EXAMPLE
Secret Access Key	String	Mandatory for aws_credentials Secret access key to access to your redshift	wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Session token	String	Optional for aws_credentials	IQoJb3JpZ2luX2VjEOj//////////wEaCXVzLWVhc3QtMSJGMEQCIGN2...
Profile	String	Mandatory for aws_profile Your AWS profile	myawsprofile
Region	String	The region in which there is your aws account.	eu-west-3
Enable TCP keep-alive	Boolean	Disable TCP keep-alive by unticking this option. Disabling might be " "required for long-running queries or if you are behind a firewall
Connection timeout	Integer	maximum length of time to wait for the server to respond. None by default	30 (default)
Retry Policy (optional)	Boolean	Boolean allows to configure a retry policy if the connection is flaky. max attempts: maximum number of retries before giving up max_delay: in seconds, above the connection is dropped wait_time: time in seconds between each retry
Slow Queries' Cache Expiration Time (optional)	Integer	Slow queries' cache expiration time in seconds

Click on the TEST CONNECTION button then SAVE the connection

After successfully configuring the connector, you will be able to find it in the Connector section of the DataHub "Datasource" tab

To have the graphical database exploration in your connector, you must promote access to the default dev database to your user. This database contains a table pg_database listing all available databases and the pg_table_def listing all available tables in the cluster's databases. Without this access to the dev database, you will face a warning error when testing the connection of your data provider.

Create a dataset from a Redshift connection

To create a dataset from Redshift, click on the "create from icon"; you will then be able to:

• Select the Database

• Select the Schema

• Select Table or Views

• Only keep the columns you need

For more info, see the dedicated section Create a new dataset from a dataset

After selecting data from your connector you will be able to create a dataset thanks to YouPrep using the selection as "source step".