Amazon Redshift catalogs #
You can use a Redshift catalog to configure access to an Amazon Redshift cluster.
Configure a catalog #
To create a Redshift catalog, select Catalogs in the main navigation and click Configure a catalog. Click on the Redshift button in the Select a data source screen.
Define catalog name and description #
The Name of the catalog is visible in Query editor and other clients. It is used to identify the catalog when writing SQL or showing the catalog and nested schemas and tables in client applications.
The name is displayed in Query editor, and when running a SHOW
CATALOGS. It is used to fully qualify the
name of any table in SQL queries following the
catalogname.schemaname.tablename syntax. For example, you can run the
following query in the demo cluster without setting any context of catalog or
SELECT * FROM tpch.sf1.nation;
The Description is a short, optional paragraph that provides more details about the catalog than the name alone. It appears in the user interface and can help other users to determine what data can be accessed with the catalog.
Read only #
Toggle the Read only switch as desired to enable only read operations on the data source, or allow data changes such as inserts, updates, and deletes.
Configure the connection #
The connection to the database requires username and password authentication and details to connect to the database server, typically hostname or IP address and port. The following sections detail the setup for the supported cloud providers.
A connection to the database can be established directly, if the Starburst Galaxy IP range/CIDR is allowed to connect.
If the database is only accessible inside the virtual private cloud (VPC) of the cloud provider, you can use an SSH tunnel with a bastion host in the VPC.
Amazon Redshift configuration #
To configure the connection to your Amazon Redshift cluster, you need to provide the following details:
- Redshift endpoint, use the fully qualified domain name for the server
available as Endpoint in the General information tab for the cluster.
The value follows a pattern of
host:port/database, typically like the example
- Database username, use a user with sufficient access rights to allow the desired querying. For example, if you only want to query data for analytics, the user does not have to have write access.
- Database password, use the password for the user.
The Amazon Redshift cluster needs to fulfill the following requirements:
- Configured for Publicly accessible, available in the Amazon console for your cluster in Properties - Network and security settings.
- VPC security group configured to allow Starburst Galaxy access. The specific IP address range/CIDR is dependent on your AWS region, and displayed after a Test connection execution. Add it as an inbound rule to allow the range.
Test the connection #
Once you have configured the connection details, use the Test connection button to confirm data access is working. If the test is successful, you can then save the catalog.
If the test fails, Starburst Galaxy provides detailed diagnostic information that you can use to fix the database configuration in the cloud provider system.
Save the catalog #
Is the information on this page helpful?