Skip to main content
Version: 1.4.2

Connect GX Cloud to Redshift

Prerequisites​

Optional. Create a separate Redshift user​

Run all queries in the Amazon Redshift query editor v2.

  1. Create a new role.

    Redshift query editor v2
    CREATE ROLE gx_role;

  2. Create a new user.

    Redshift query editor v2
    CREATE USER gx_user PASSWORD 'your_password';

  3. Grant the new role schema USAGE and table SELECT permissions.

    Redshift query editor v2
    GRANT USAGE ON SCHEMA your_schema TO ROLE gx_role;
    GRANT SELECT ON ALL TABLES IN SCHEMA your_schema TO ROLE gx_role;

  4. Optional. Grant the new role access to future tables in the schema.

    Redshift query editor v2
    ALTER DEFAULT PRIVILEGES IN SCHEMA your_schema
    GRANT SELECT ON TABLES TO ROLE gx_role;

  5. Grant the new user the new role.

    Redshift query editor v2
    GRANT ROLE gx_role TO gx_user;

Connect to a Redshift Data Source and add a Data Asset​

  1. In GX Cloud, click Data Assets > New Data Asset > New Data Source > Redshift.

  2. Enter a meaningful name for the Data Source in the Data Source name field.

  3. Select whether you will enter your connection details as either separate Input parameters or a consolidated Connection string.

  4. Supply your connection details depending on the method you chose in the previous step. If you created a separate Redshift user for your GX Cloud connection as recommended above, use those credentials in your connection details.

    • If you chose Input parameters, complete the following fields:

      • Username: Enter the username you use to access Redshift.

      • Password: Enter the password you use to access Redshift.

      • Host: Enter the host of your Redshift database. The location of this information in Redshift depends on whether you are using a provisioned cluster or Redshift serverless.

        • If you're using a provisioned cluster, go to the Provisioned clusters dashboard, select your Cluster, and find the Endpoint. Copy the endpoint up to the :. The host has a format of cluster-name.abc123.us-east-2.redshift.amazonaws.com.
        • If you're using Redshift serverless, go to the Serverless dashboard, select your Workgroup, and find the Endpoint. Copy the endpoint up to the :. The host has a format of workgroup-name.123.us-east-2.redshift-serverless.amazonaws.com.

      • Port: Enter the port of your Redshift database. The location of this information in Redshift depends on whether you are using a provisioned cluster or Redshift serverless.

        • If you're using a provisioned cluster, go to the Provisioned clusters dashboard, select your Cluster, and find the Endpoint. Copy the number after the :. This is usually the default of 5439.
        • If you're using Redshift serverless, go to the Serverless dashboard, select your Workgroup, and find the Endpoint. Copy the number after the :. This is usually the default of 5439.

      • Database: Enter the name of the Redshift database where the data you want to validate is stored.

      • SSL mode: Select how to handle encryption for client connections and server certificate verification. We recommend selecting require since GX Cloud supports SSL connections. See Redshift's SSL docs for more information on the available options.

    • If you chose Connection string, enter it with a format of:

      Redshift connection string
      redshift+psycopg2://<USER>:<PASSWORD>@<HOST>:<PORT>/<DATABASE>?sslmode=<SSLMODE>

      For guidance on replacing each placeholder in the connection string, see the above input parameter definitions.

  5. Click Connect.

  6. Select one or more tables to import as Data Assets.

  7. Click Add x Asset(s).

  8. Decide which common data quality issues you want to start monitoring. By default, GX Cloud adds Expectations to detect Schema, Volume, and Completeness issues. You can de-select recommendations you'd like to opt out of.

  9. Click Start monitoring or Finish.

Next steps​