Skip to main content

Documentation Index

Fetch the complete documentation index at: https://oxy.tech/docs/llms.txt

Use this file to discover all available pages before exploring further.

This guide explains how to connect to Amazon Redshift with Oxy. Redshift is a fully managed, petabyte-scale data warehouse service in the cloud.

​
Configuration Options

Add your Redshift configuration to config.yml. Here are all available parameters: 
databases:
  - name: my_redshift_db # Unique identifier for this connection
    type: redshift
    host: "cluster.xxxxx.region.redshift.amazonaws.com" # Redshift endpoint
    port: 5439 # Redshift port (default: 5439)
    user: "awsuser" # Master username
    password_var: "RS_PWD" # Environment variable containing password
    database: "dev" # Database name

​
Example Configurations

1

Prepare password environment variable

Export the environment variable:
export RS_PWD=<your password>
Or put it in .env file:
echo RS_PWD=<your password> >> .env
2

Add Redshift configuration

databases:
  - name: rs_analytics
    type: redshift
    host: "my-cluster.xxxxx.us-east-1.redshift.amazonaws.com"
    port: 5439
    user: "awsuser"
    password_var: "RS_PWD"
    database: "analytics"

​
Troubleshooting

  • Check cluster status in AWS Console
  • View query history in Redshift console
  • Common issues:
    • VPC/Security group misconfiguration
    • IAM permission issues
    • Connection timeout due to workload management
    • Query performance problems