Skip to main content
To connect TextQL with your Amazon Redshift database, you will need to gather the following connection details from your Redshift cluster:
  • Host URL and Port (default: 5439)
  • Database name and Schema
  • Username and Password with appropriate permissions (for password auth)
  • SSL configuration (if required)

​
Creating the Connector in TextQL

Navigate to the TextQL Connectors Page and click Create New Connector. Select Redshift from the available connectors to open the configuration form.

​
Password Authentication

The default authentication method uses a database username and password:
  • Connector Name: A descriptive name to identify this specific Redshift connection in TextQL.
  • Host URL: The endpoint URL of your Redshift cluster.
  • Port: The port number for your Redshift connection (default is 5439).
  • User: Your Redshift username with appropriate query permissions.
  • Password: The corresponding password for your Redshift user.
  • Database: The name of your target Redshift database.
  • Schema: The schema name within your database.
  • Dialect: Choose between “Redshift” for native Redshift SQL or “Postgres” for PostgreSQL-compatible queries.

​
IAM Role Authentication

For enhanced security, Redshift connectors support IAM Role authentication. Select IAM Role as the auth type to configure the following fields:
  • Role ARN: The ARN of the IAM role to assume for authenticating to Redshift.
  • AWS Region: The AWS region where your Redshift cluster is located.
  • Cluster ID: The identifier of your provisioned Redshift cluster.
  • AWS Access Key ID (optional): If omitted, the service’s own IAM credentials are used to assume the role.
  • AWS Secret Access Key (optional): Must be provided together with the Access Key ID, or both omitted.
If you omit both the AWS Access Key ID and Secret Access Key, TextQL will use its own IAM credentials to assume the specified role. You must provide both keys together or neither.

​
Database User (provisioned clusters only)

When using IAM Role auth with a provisioned Redshift cluster and Group Federation disabled, you must also provide:
  • Database User: The Redshift database user to authenticate as (e.g. redshift_db_user). This is passed to the GetClusterCredentials API call.
This field is hidden in two cases:
  • Serverless Redshift — credentials are fetched automatically from the workgroup.
  • Group Federation enabled — the GetClusterCredentialsWithIAM API is used instead, which does not require a database user.

​
Group Federation

Enable Group Federation to use GetClusterCredentialsWithIAM instead of GetClusterCredentials. This is appropriate when your Redshift cluster is configured to map IAM roles to database groups. Group Federation is not available for Redshift Serverless.

​
Testing the Connection

After entering your credentials, click Create to establish the connection. TextQL will validate your credentials and create the connector.
Having trouble connecting? See the Network Configuration Guide for firewall and IP whitelisting setup.

​
Next Steps

Once connected, you can use TextQL to query your Redshift data. The connector supports both Redshift’s native SQL dialect and PostgreSQL-compatible queries, allowing you to leverage the full capabilities of your Redshift cluster through TextQL’s interface. For enhanced security and performance:
  • Use a dedicated Redshift user for TextQL connections
  • Configure appropriate resource limits in your Redshift cluster
  • Consider using SSL encryption for sensitive data