OpenMetadata/docs/install/metadata-ingestion/connectors/database-services/redshift.md

description
This guide will help install Redshift connector and run manually

Redshift

{% hint style="info" %} Prerequisites

OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.

1. Python 3.7 or above {% endhint %}

Install from PyPI

pip install 'openmetadata-ingestion[redshift]'

Run Manually

metadata ingest -c ./examples/workflows/redshift.json

Configuration

{% code title="redshift.json" %}

{
  "source": {
    "type": "redshift",
    "config": {
      "host_port": "cluster.name.region.redshift.amazonaws.com:5439",
      "username": "username",
      "password": "strong_password",
      "database": "warehouse",
      "service_name": "aws_redshift",
      "data_profiler_enabled": "true",
      "data_profiler_offset": "0",
      "data_profiler_limit": "50000",
      "filter_pattern": {
        "excludes": ["information_schema.*", "[\\w]*event_vw.*"]
      }
    },
...

{% endcode %}

1. username - pass the Redshift username.
2. password - the password for the Redshift username.
3. service_name - Service Name for this Redshift cluster. If you added the Redshift cluster through OpenMetadata UI, make sure the service name matches the same.
4. filter_pattern - It contains includes, excludes options to choose which pattern of datasets you want to ingest into OpenMetadata.
5. database - Database name from where data is to be fetched.‌
6. data_profiler_enabled - Enable data-profiling (Optional). It will provide you the newly ingested data.
7. data_profiler_offset - Specify offset.
8. data_profiler_limit - Specify limit.

Publish to OpenMetadata

Below is the configuration to publish Redshift data into the OpenMetadata service.‌

Add Optionally pii processor and metadata-rest sink along with metadata-server config

{% code title="redshift.json" %}

{
  "source": {
    "type": "redshift",
    "config": {
      "host_port": "cluster.name.region.redshift.amazonaws.com:5439",
      "username": "username",
      "password": "strong_password",
      "database": "warehouse",
      "service_name": "aws_redshift",
      "data_profiler_enabled": "true",
      "data_profiler_offset": "0",
      "data_profiler_limit": "50000",
      "filter_pattern": {
        "excludes": ["information_schema.*", "[\\w]*event_vw.*"]
      }
    },
  "sink": {
    "type": "metadata-rest",
    "config": {}
  },
  "metadata_server": {
    "type": "metadata-server",
    "config": {
      "api_endpoint": "http://localhost:8585/api",
      "auth_provider_type": "no-auth"
    }
  }
}

{% endcode %}