2023-04-17 16:45:47 +02:00
---
title: Redshift
2023-05-04 12:37:18 -07:00
slug: /connectors/database/redshift
2023-04-17 16:45:47 +02:00
---
# Redshift
{% multiTablesWrapper %}
| Feature | Status |
| :----------------- | :--------------------------- |
| Stage | PROD |
| Metadata | {% icon iconName="check" /%} |
| Query Usage | {% icon iconName="check" /%} |
| Data Profiler | {% icon iconName="check" /%} |
| Data Quality | {% icon iconName="check" /%} |
2023-05-19 20:49:27 +05:30
| Lineage | {% icon iconName="check" /%} |
2023-04-17 16:45:47 +02:00
| DBT | {% icon iconName="check" /%} |
| Supported Versions | -- |
| Feature | Status |
| :----------- | :--------------------------- |
2023-05-19 20:49:27 +05:30
| Lineage | {% icon iconName="check" /%} |
2023-04-17 16:45:47 +02:00
| Table-level | {% icon iconName="check" /%} |
| Column-level | {% icon iconName="check" /%} |
{% /multiTablesWrapper %}
In this section, we provide guides and references to use the Redshift connector.
Configure and schedule Redshift metadata and profiler workflows from the OpenMetadata UI:
- [Requirements ](#requirements )
- [Metadata Ingestion ](#metadata-ingestion )
2023-04-28 07:09:12 -07:00
- [Query Usage ](/connectors/ingestion/workflows/usage )
- [Data Profiler ](/connectors/ingestion/workflows/profiler )
- [Data Quality ](/connectors/ingestion/workflows/data-quality )
- [Lineage ](/connectors/ingestion/lineage )
- [dbt Integration ](/connectors/ingestion/workflows/dbt )
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
{% partial file="/v1.1.0/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/redshift/yaml"} /%}
2023-04-17 16:45:47 +02:00
## Requirements
{%inlineCallout icon="description" bold="OpenMetadata 0.12 or later" href="/deployment"%}
To deploy OpenMetadata, check the Deployment guides.
{%/inlineCallout%}
Fixes #10805 - Documentation for Profiler, Nifi, MLflow, Trino, Presto, Redshift, Hive, SingleStore, MariaDB, MySQL (#11135)
* feat: profiler workflow documentation
* feat: Added MySQL connection information
* doc: connector requirements for MySQL, MariaDB, and SingleStore
* doc: added requirements to main documentation for MariaDB, SingleStore and MySQL
* doc: added new profiler metric definitions
* doc: Added new table test documentation
* doc: added connector requirements for Hive
* doc: Added Redshift documentation
* doc: Added Presto & Trino documentation
* doc: added MLflow documentation
* doc: Added Nifi documentation
* Move requirements to H2
* doc: add links/queries to grant permissions
2023-04-19 14:12:47 +02:00
### Metadata
2023-04-17 16:45:47 +02:00
Redshift user must grant `SELECT` privilege on table [SVV_TABLE_INFO ](https://docs.aws.amazon.com/redshift/latest/dg/r_SVV_TABLE_INFO.html ) to fetch the metadata of tables and views. For more information visit [here ](https://docs.aws.amazon.com/redshift/latest/dg/c_visibility-of-data.html ).
```sql
Fixes #10805 - Documentation for Profiler, Nifi, MLflow, Trino, Presto, Redshift, Hive, SingleStore, MariaDB, MySQL (#11135)
* feat: profiler workflow documentation
* feat: Added MySQL connection information
* doc: connector requirements for MySQL, MariaDB, and SingleStore
* doc: added requirements to main documentation for MariaDB, SingleStore and MySQL
* doc: added new profiler metric definitions
* doc: Added new table test documentation
* doc: added connector requirements for Hive
* doc: Added Redshift documentation
* doc: Added Presto & Trino documentation
* doc: added MLflow documentation
* doc: Added Nifi documentation
* Move requirements to H2
* doc: add links/queries to grant permissions
2023-04-19 14:12:47 +02:00
-- Create a new user
-- More details https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html
2023-04-17 16:45:47 +02:00
CREATE USER test_user with PASSWORD 'password';
Fixes #10805 - Documentation for Profiler, Nifi, MLflow, Trino, Presto, Redshift, Hive, SingleStore, MariaDB, MySQL (#11135)
* feat: profiler workflow documentation
* feat: Added MySQL connection information
* doc: connector requirements for MySQL, MariaDB, and SingleStore
* doc: added requirements to main documentation for MariaDB, SingleStore and MySQL
* doc: added new profiler metric definitions
* doc: Added new table test documentation
* doc: added connector requirements for Hive
* doc: Added Redshift documentation
* doc: Added Presto & Trino documentation
* doc: added MLflow documentation
* doc: Added Nifi documentation
* Move requirements to H2
* doc: add links/queries to grant permissions
2023-04-19 14:12:47 +02:00
-- Grant SELECT on table
GRANT SELECT ON TABLE svv_table_info to test_user;
2023-04-17 16:45:47 +02:00
```
Fixes #10805 - Documentation for Profiler, Nifi, MLflow, Trino, Presto, Redshift, Hive, SingleStore, MariaDB, MySQL (#11135)
* feat: profiler workflow documentation
* feat: Added MySQL connection information
* doc: connector requirements for MySQL, MariaDB, and SingleStore
* doc: added requirements to main documentation for MariaDB, SingleStore and MySQL
* doc: added new profiler metric definitions
* doc: Added new table test documentation
* doc: added connector requirements for Hive
* doc: Added Redshift documentation
* doc: Added Presto & Trino documentation
* doc: added MLflow documentation
* doc: Added Nifi documentation
* Move requirements to H2
* doc: add links/queries to grant permissions
2023-04-19 14:12:47 +02:00
### Profiler & Data Quality
2023-07-06 15:11:13 +02:00
Executing the profiler workflow or data quality tests, will require the user to have `SELECT` permission on the tables/schemas where the profiler/tests will be executed. More information on the profiler workflow setup can be found [here ](https://docs.open-metadata.org/connectors/ingestion/workflows/profiler ) and data quality tests [here ](https://docs.open-metadata.org/connectors/ingestion/workflows/data-quality ).
Fixes #10805 - Documentation for Profiler, Nifi, MLflow, Trino, Presto, Redshift, Hive, SingleStore, MariaDB, MySQL (#11135)
* feat: profiler workflow documentation
* feat: Added MySQL connection information
* doc: connector requirements for MySQL, MariaDB, and SingleStore
* doc: added requirements to main documentation for MariaDB, SingleStore and MySQL
* doc: added new profiler metric definitions
* doc: Added new table test documentation
* doc: added connector requirements for Hive
* doc: Added Redshift documentation
* doc: Added Presto & Trino documentation
* doc: added MLflow documentation
* doc: Added Nifi documentation
* Move requirements to H2
* doc: add links/queries to grant permissions
2023-04-19 14:12:47 +02:00
2023-07-06 15:11:13 +02:00
### Usage & Lineage
Fixes #10805 - Documentation for Profiler, Nifi, MLflow, Trino, Presto, Redshift, Hive, SingleStore, MariaDB, MySQL (#11135)
* feat: profiler workflow documentation
* feat: Added MySQL connection information
* doc: connector requirements for MySQL, MariaDB, and SingleStore
* doc: added requirements to main documentation for MariaDB, SingleStore and MySQL
* doc: added new profiler metric definitions
* doc: Added new table test documentation
* doc: added connector requirements for Hive
* doc: Added Redshift documentation
* doc: Added Presto & Trino documentation
* doc: added MLflow documentation
* doc: Added Nifi documentation
* Move requirements to H2
* doc: add links/queries to grant permissions
2023-04-19 14:12:47 +02:00
For the usage and lineage workflow, the user will need `SELECT` privilege on `STL_QUERY` table. You can find more information on the usage workflow [here ](https://docs.open-metadata.org/connectors/ingestion/workflows/usage ) and the lineage workflow [here ](https://docs.open-metadata.org/connectors/ingestion/workflows/lineage ).
2023-04-17 16:45:47 +02:00
## Metadata Ingestion
2023-07-06 15:11:13 +02:00
{% partial
file="/v1.1.0/connectors/metadata-ingestion-ui.md"
variables={
connector: "Redshift",
selectServicePath: "/images/v1.1.0/connectors/redshift/select-service.png",
addNewServicePath: "/images/v1.1.0/connectors/redshift/add-new-service.png",
serviceConnectionPath: "/images/v1.1.0/connectors/redshift/service-connection.png",
}
/%}
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
{% stepsContainer %}
2023-04-17 16:45:47 +02:00
{% extraContent parentTagName="stepsContainer" %}
2023-07-06 15:11:13 +02:00
#### Connection Details
2023-04-17 16:45:47 +02:00
- **Username**: Specify the User to connect to Redshift. It should have enough privileges to read all the metadata.
- **Password**: Password to connect to Redshift.
- **Database (Optional)**: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases.
2023-07-06 15:11:13 +02:00
{% note %}
During the metadata ingestion for redshift, the tables in which the distribution style i.e, `DISTSTYLE` is not `AUTO` will be marked as partitioned tables
{% /note %}
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
**SSL Configuration**
2023-04-17 16:45:47 +02:00
In order to integrate SSL in the Metadata Ingestion Config, the user will have to add the SSL config under connectionArguments which is placed in the source.
2023-07-06 15:11:13 +02:00
**SSL Modes**
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
There are a couple of types of SSL modes that Redshift supports which can be added to ConnectionArguments, they are as follows:
2023-04-17 16:45:47 +02:00
- **disable**: SSL is disabled and the connection is not encrypted.
- **allow**: SSL is used if the server requires it.
- **prefer**: SSL is used if the server supports it. Amazon Redshift supports SSL, so SSL is used when you set sslmode to prefer.
- **require**: SSL is required.
- **verify-ca**: SSL must be used and the server certificate must be verified.
- **verify-full**: SSL must be used. The server certificate must be verified and the server hostname must match the hostname attribute on the certificate.
For more information, you can visit [Redshift SSL documentation ](https://docs.aws.amazon.com/redshift/latest/mgmt/connecting-ssl-support.html )
2023-07-06 15:11:13 +02:00
{% partial file="/v1.1.0/connectors/database/advanced-configuration.md" /%}
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
{% /extraContent %}
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
{% partial file="/v1.1.0/connectors/test-connection.md" /%}
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
{% partial file="/v1.1.0/connectors/database/configure-ingestion.md" /%}
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
{% partial file="/v1.1.0/connectors/ingestion-schedule-and-deploy.md" /%}
2023-04-17 16:45:47 +02:00
{% /stepsContainer %}
2023-07-06 15:11:13 +02:00
{% partial file="/v1.1.0/connectors/troubleshooting.md" /%}
2023-04-17 16:45:47 +02:00
2023-07-06 15:11:13 +02:00
{% partial file="/v1.1.0/connectors/database/related.md" /%}