mirror of
				https://github.com/open-metadata/OpenMetadata.git
				synced 2025-10-31 10:39:30 +00:00 
			
		
		
		
	 aec586a5fe
			
		
	
	
		aec586a5fe
		
			
		
	
	
	
	
		
			
			* updated metadata-ingestion and apis documents * minor changes in * addressing maven ci findings Co-authored-by: Parth Panchal <parthpanchal@Parths-MacBook-Air.local>
		
			
				
	
	
	
		
			2.4 KiB
		
	
	
	
	
	
	
	
			
		
		
	
	
			2.4 KiB
		
	
	
	
	
	
	
	
| 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.
- Python 3.7 or above
- OpenMetadata Server up and running
{% 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",
      "filter_pattern": {
        "excludes": ["information_schema.*", "[\\w]*event_vw.*"]
      }
    }
  },
...
{% endcode %}
- username - pass the Redshift username.
- password - the password for the Redshift username.
- 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.
- filter_pattern - It contains includes, excludes options to choose which pattern of datasets you want to ingest into OpenMetadata.
- database - Database name from where data is to be fetched.
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",
      "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 %}