# Redshift Add a Redshift Source Datastore

Source: https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/how-tos/add-source/

A source datastore is a storage location Qualytics connects to so it can profile, scan, and monitor data. Adding Redshift as a source lets Qualytics read tables through the Redshift JDBC driver and run quality operations on the data they contain.

Before you start, review the [Redshift Permissions](https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/permissions/) and the available [Authentication](https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/authentication/) methods.

> **Tip**
>
> A Redshift datastore can also be used as an enrichment datastore. When linked to a source, the Redshift datastore becomes that source's enrichment destination for anomalies and metadata. Link one during creation via [Link Enrichment on Datastore Creation](https://userguide.qualytics.io/source-datastore/enrichment-datastore/how-tos/link-during-creation/), or afterwards via [Link an Enrichment Destination](https://userguide.qualytics.io/source-datastore/enrichment-datastore/how-tos/link-enrichment/).

## Field reference

The **Add Datastore** page shows the sections below when Redshift is selected. When reusing an existing connection, the **Connection Properties**, **Authentication**, and **Secrets Management** sections come already filled in and read-only: Qualytics has already validated those credentials, so you fill in only the **Location** and the **General** fields. To change a saved connection's credentials, edit the connection through the [Manage Connections](https://userguide.qualytics.io/settings/connections/manage-connections/) page; edits there apply to every datastore that reuses the connection.

### Connection Properties

These fields define the Redshift cluster endpoint Qualytics connects to. They belong to the connection: when reusing an existing connection, they come already filled in and read-only.

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| **Connection Name** | Yes | Text | A label for the saved connection (e.g., `acme_redshift_warehouse`), so other datastores can reuse it later. |
| **Host** | Yes | Text | The cluster endpoint hostname (e.g., `acme-cluster.123456789012.us-east-1.redshift.amazonaws.com`). Redshift Serverless is recognized from the hostname. |
| **Port** | Yes | Number | The port the cluster accepts connections on. Defaults to `5439`. |
| **Max Parallelization** | No | Number | Caps how many queries Qualytics runs at the same time against a datastore reached through this connection, from 1 to 100. Leave it empty for no explicit limit. The cap applies per datastore, so datastores sharing this connection each get their own allowance. Sits in the collapsed **Advanced** section of the form. See [Max Parallelization](https://userguide.qualytics.io/source-datastore/datastore/connection/how-it-works/#max-parallelization). |

### Authentication

Choose how Qualytics authenticates to Redshift. Setting **Type** changes the credential fields shown below it, so pick the tab that matches your choice. These fields also belong to the connection: already filled in and read-only when reusing one. See [Authentication](https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/authentication/) for how each method works.

**Tab: Password**

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| **Type** | No | Option | Set to **Password**, which is the default (`BASIC` in the API). |
| **User** | Yes | Text | The Redshift database user Qualytics connects as. It needs the grants listed in [Permissions](https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/permissions/). |
| **Password** | Yes | Text | The password for that user. |

**Tab: IAM Role**

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| **Type** | No | Option | Set to **IAM Role** (`IAM_ROLE` in the API). Qualytics assumes the role and uses short-lived database credentials that refresh on their own. |
| **Role ARN** | Yes | Text | The ARN of the IAM role to assume (e.g., `arn:aws:iam::123456789012:role/MyRole`). |
| **External ID** | No | Text | Fill this in only when the role's trust policy requires an external ID. |

> **Note: AWS-only**
>
> **IAM Role** appears in **Type** only on AWS and local deployments. On Azure and GCP deployments, only **Password** is offered.

**Tab: Assumed Role**

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| **Type** | No | Option | Set to **Assumed Role** (`ASSUMED_ROLE` in the API). It takes the same fields as **IAM Role** and follows the same assume-role flow. |
| **Role ARN** | Yes | Text | The ARN of the IAM role to assume (e.g., `arn:aws:iam::123456789012:role/MyRole`). |
| **External ID** | No | Text | Fill this in only when the role's trust policy requires an external ID. |

> **Note: AWS-only**
>
> **Assumed Role** appears in **Type** only on AWS and local deployments, the same as **IAM Role**.

### Secrets Management

This group is optional: use it only if you want Qualytics to pull credentials from a secrets manager instead of typing them into the form. Turn on **HashiCorp Vault** to show the fields below. Despite the label, any secrets manager that exposes a compatible REST API works, not only HashiCorp Vault; see [HashiCorp Vault](https://userguide.qualytics.io/source-datastore/datastore/connection/hashicorp-vault/deep-dive/introduction/). It also belongs to the connection: read-only when reusing an existing connection.

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| **Login URL** | Yes | Text | The full URL of the login endpoint (e.g., `https://vault.example.com/v1/auth/approle/login`). With Vault namespaces, add the namespace after `/v1/`, as in `/v1/<namespace>/auth/approle/login`. |
| **Credentials Payload** | Yes | Text | A JSON body containing the credentials Vault expects (e.g., `{"role_id":"...","secret_id":"..."}`). |
| **Token JSONPath** | Yes | Text | The JSONPath that extracts the client token from Vault's response. Defaults to `$.auth.client_token`. |
| **Secret URL** | Yes | Text | The full URL of the secret, including `https://` and the host (e.g., `https://vault.example.com/v1/secret/data/redshift`). With Vault namespaces, add the namespace after `/v1/`. |
| **Token Header Name** | Yes | Text | The HTTP header name used to send the token. Defaults to `X-Vault-Token`. |
| **Data JSONPath** | Yes | Text | The JSONPath that extracts the key/value pairs from Vault's response. Use `$.data.data` for a KV version 2 secret (its API path contains `/data/`) and `$.data` for KV version 1 or the database secrets engine. The form pre-fills `$.data`. |

> **Note**
>
> Once the secrets manager is configured, reference any secret from a **Connection Properties** or **Authentication** field with `${key}`, for example `${password}`. Qualytics resolves it each time the connection is opened, so a changed value takes effect on the next connection. Write the reference with braces (`${key}`, never `$.key`) and match the key name's case. Setup steps, the namespace rule, and a troubleshooting page are on the [HashiCorp Vault](https://userguide.qualytics.io/source-datastore/datastore/connection/hashicorp-vault/deep-dive/introduction/) pages.

### Location

Pick the database and the schema or schemas Qualytics should read from. You fill these in on both flows.

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| **Database** | Yes | Option | The database to read from. Click the refresh icon to load the databases the connection can reach. |
| **Schema** | Yes | Option | One or more schemas inside the selected database, including external schemas backed by Redshift Spectrum or the AWS Glue Data Catalog. Each schema you pick becomes its own Qualytics datastore. Defaults to `public`. |

> **Note: One datastore per schema**
>
> Selecting more than one schema creates one source datastore per schema, named from the **Name Template**. See [Multi-Schema Source Datastore Creation](https://userguide.qualytics.io/source-datastore/datastore/multi-schema/overview/) for details.

> **Note: External schemas**
>
> External schemas, the ones backed by Redshift Spectrum or the AWS Glue Data Catalog, are listed in the picker alongside regular schemas and can be selected. Qualytics reads them over the same connection, so the connection test, the sync, and every scan behave as they do on a regular schema. The connection user still needs `USAGE` on the external schema, exactly as for any other schema.

### General

Common fields for every source datastore, shown below the **Location** section. You fill these in on both flows.

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| **Name Template** | No | Text | Defines the naming pattern for each source datastore being created. Use `{{schema}}` as a placeholder that gets replaced with the actual schema name (e.g., `redshift_{{schema}}` becomes `redshift_public`). Left empty, the datastore is named from the connection name and the schema. |
| **Group** | No | Option | Organizes your datastores under a shared group in the navigation tree. Select an existing group or create a new one with the **Add New Group** toggle. |
| **Teams** | Yes | Option | Select one or more teams to associate with this source datastore. |
| **Initiate Sync** | No | Checkbox | Automatically sync the datastore to detect containers and fields after creation. |

Below the form, an information banner lists the **Public addresses** and **Private addresses** your datastore connections originate from. Allow the ones that match your network setup through your security groups or firewall rules; see [How Connections Work](https://userguide.qualytics.io/source-datastore/datastore/connection/how-it-works/#finding-the-addresses-to-allow) for where the addresses come from.

## Steps

There are two ways to set up the connection: reuse a connection you already saved (**Existing Connection**) or create a new one from scratch (**New Connection**). The tabs below walk through each option; pick the one you want to follow. Each field is described in the [Field reference](https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/how-tos/add-source/#field-reference) above.

**Tab: New Connection**

**Step 1**: Navigate to the **Datastores** page.

**Step 2**: Click the **Add**  button at the top-right corner and choose **Source** .

**Step 3**: The **Add Datastore** page opens.

**Step 4**: Select **New Connection** next to the **Search**  field.

**Step 5**: Select **Redshift** from the connector grid. Use the search field to filter connectors by name.

**Step 6**: Fill in the **Connection Properties**: the **Connection Name**, **Host**, and **Port**.

**Step 7**: Fill in the **Authentication** fields for the **Type** you choose.

**Step 8**: Optionally, expand **Secrets Management** to retrieve credentials from a secrets manager.

**Step 9**: Fill in the **Location** fields (**Database** and **Schema**) and the **General** fields.

**Step 10**: Click **Test connection**. A success message confirms that the connection has been verified.

> **Info**
>
> The **Finish** and **Next** buttons stay disabled until the connection test passes on the current values. If the test fails, see [Troubleshooting](https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/troubleshooting/).

**Step 11**: Click **Finish** to create the datastore.

> **Tip**
>
> To link an enrichment destination so Qualytics can store anomalies and metadata from the first operation, click **Next** instead of **Finish**. See [Link Enrichment on Datastore Creation](https://userguide.qualytics.io/source-datastore/enrichment-datastore/how-tos/link-during-creation/).

**Step 12**: A success dialog confirms that your datastore has been added. Click **Go to your datastore** to open its page.

**Tab: Existing Connection**

**Step 1**: Navigate to the **Datastores** page.

**Step 2**: Click the **Add**  button at the top-right corner and choose **Source** .

**Step 3**: The **Add Datastore** page opens.

**Step 4**: Select **Existing Connection** next to the **Search**  field.

**Step 5**: Select the saved Redshift connection from the grid. Use the search field to filter connections by name. The **Connection Properties**, **Authentication**, and **Secrets Management** sections come already filled in and read-only.

> **Tip: Start a new connection from this one**
>
> To use the selected connection as a starting point for a brand-new connection instead, click the **Duplicate as a new connection**  button on the selected connection. The form switches to **New Connection** mode with the connection's settings already filled in for you to adjust.

**Step 6**: Fill in the **Location** fields (**Database** and **Schema**) and the **General** fields. These are the only fields left to fill in.

**Step 7**: Click **Test connection**. A success message confirms that the connection has been verified.

> **Info**
>
> The **Finish** and **Next** buttons stay disabled until the connection test passes on the current values. If the test fails, see [Troubleshooting](https://userguide.qualytics.io/source-datastore/datastore/jdbc/redshift/troubleshooting/).

**Step 8**: Click **Finish** to create the datastore.

> **Tip**
>
> To link an enrichment destination so Qualytics can store anomalies and metadata from the first operation, click **Next** instead of **Finish**. See [Link Enrichment on Datastore Creation](https://userguide.qualytics.io/source-datastore/enrichment-datastore/how-tos/link-during-creation/).

**Step 9**: A success dialog confirms that your datastore has been added. Click **Go to your datastore** to open its page.

*Last updated: November 3, 2026.*
