Link Search Menu Expand Document

Connect Soda to Amazon Redshift

Last modified on 31-May-23

For Soda to run quality scans of your data, you must configure it to connect to your data source.

  • For Soda Core, add the connection configurations to your configuration.yml file. Read more.
  • For Soda Cloud, add the connection configurations to step 3 of the New Data Source workflow. Read more.

Configuration

Install package: soda-core-redshift

data_source my_datasource_name:
  type: redshift
  connection:
    host: db
    username:
    password:
    database: 
    access_key_id:
    secret_access_key:
    role_arn:
    region: eu-west-1
  schema: public
Property Required Notes
type required  
host required  
username required If you provide a value for username and password, the connection ignores cluster credentials.
password required As above.
database required  
schema    
access_key_id optional 1 Consider using system variables to retrieve this value securely.
secret_access_key optional 1 Consider using system variables to retrieve this value securely.
role_arn optional The Amazon Resource Name of an IAM role that you want to use.
region optional  

1 Access keys and IAM role are mutually exclusive: if you provide values for access_key_id and secret_access_key, you cannot use Identity and Access Management role; if you provide value for role_arn, then you cannot use the access keys. Refer to Amazon Redshift Authorization parameters for details.

Test the data source connection

To confirm that you have correctly configured the connection details for the data source(s) in your configuration YAML file, use the test-connection command. If you wish, add a -V option to the command to returns results in verbose mode in the CLI.

soda test-connection -d my_datasource -c configuration.yml -V

Supported data types

Category Data type
text CHARACTER VARYING, CHARACTER, CHAR, TEXT, NCHAR, NVARCHAR, BPCHAR
number SMALLINT, INT2, INTEGER, INT, INT4, BIGINT, INT8
time DATE, TIME, TIMETZ, TIMESTAMP, TIMESTAMPTZ




Was this documentation helpful?

What could we do to improve this page?

Last modified on 31-May-23