🔗 Amazon Redshift: Setup & Connection Guide
Welcome to the connection guide for Amazon Redshift! Follow the steps below to establish a secure database connection, configure your endpoint details, and successfully import your schema into the repository.
🛠️ Phase 1: Establish the Database Connection
Step 1:
Create New Documentation To begin the connection process, navigate to your dashboard and create new documentation by clicking Add documentation.
Step 2:
Choose the Connection Type. From the available options, choose Database connection.
Step 3:
Select the DBMS On the connection screen, select Amazon Redshift as your Database Management System (DBMS).
⚙️ Phase 2: Configure Connection Details
You will now need to provide your specific database connection details. If you are unsure where to find these, you can locate most of them within your AWS Console under the Redshift Cluster options, specifically within the Endpoint field.
Fill out the following fields:
Host: Provide the address of your Redshift endpoint.
Port: Enter the port number (change the default Amazon Redshift instance port only if required).
User: Provide the username of the user (either root or IAM) that has access to the Redshift database.
Password: Enter the password for the given username.
Note: You can check the Save password option to save it in the repository database for later connections.
SSL mode: * Disable: Do not use SSL.
Require: Connect with SSL.
Note: If the server doesn't support SSL, the connection will not be established.
Database: Type in the exact database name.
📥 Phase 3: Importing Your Schema
Step 1:
Review Found Objects. Once the connection is successful, the system will read your database and display a list of found objects.
Step 2:
Select Objects to Import: Choose which objects you want to import. You can also use the Advanced filter to narrow down the list of objects.
Step 3:
Confirm and Name. Click Next to confirm your selected list. On the following screen, you can change the default name of the documentation under which your schema will be visible in the repository.
Step 4:
Run the Import. Click Import to start the process. Once it is finished, close the import window by clicking the Finish button. Your database schema has now been successfully imported into the new documentation!
🔄 Phase 4: Syncing and Scheduling Updates
Importing Changes (Manual Sync) If you ever make changes to the schema in Redshift and need to reimport the technical metadata, simply choose the Import changes option. You will be asked to connect to Redshift again, and any new changes will be synced directly from the source.
Scheduling Imports (Automated Sync) You can also schedule metadata updates using command-line files. To do this, after creating your documentation, use the Save update command option. The downloaded file can then be run in your command line, which will automatically reimport changes to your documentation on your specified schedule.
❓ Frequently Asked Questions (FAQs)
Where do I find my Redshift connection details?
Most of the details you need (like the Host and Database name) can be found directly within your AWS Console. Simply navigate to your Redshift Cluster options and look at the Endpoint field.
Why is my connection failing when I select "Require" for SSL?
If you choose to require an SSL connection but your specific Amazon Redshift server is not configured to support SSL, the connection will be blocked and cannot be established. Try adjusting your server settings in AWS or switch the SSL mode to "Disable" if a secure connection is not strictly required.
If I add a new table to my database, will it automatically show up in my documentation?
No, it won't appear automatically unless you have configured a scheduled command-line update. For manual updates, you will need to click the Import changes option and reconnect to sync the new tables and metadata from your source.