Skip to main content

​
Overview

This guide walks you through connecting TextQL to your Amazon Aurora database. Aurora supports both MySQL and PostgreSQL engines, and this guide covers both.

​
Prerequisites

To connect TextQL with your Amazon Aurora database, you will need:
  • Host URL (SQL endpoint) and Port (default: 3306 for MySQL, 5432 for PostgreSQL)
  • Username and Password
  • Database name
  • Dialect (MySQL or PostgreSQL)

​
Gathering Connection Details from AWS

​
Step 1: Get Credentials from AWS Secrets Manager

  1. Navigate to AWS Management Console and search for Secrets Manager
  2. Find your database secret (named like rds!db-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  3. Click the secret and then click Retrieve secret value
  4. Copy the username and password values

​
Step 2: Get Host and Port from RDS Console

  1. Go to AWS RDS Console and click Databases in the left sidebar
  2. Click on your Aurora database instance
  3. Click the Connectivity & security tab
  4. Under Endpoint & port section, copy the endpoint URL and port number

​
Step 3: Identify Database Engine

  1. On the database details page, click the Configuration tab
  2. Note the Engine type (e.g., MySQL Community 8.0.43 or PostgreSQL)
  3. This determines which Dialect to select in TextQL

​
Example Connection Details

Host: your-database.cluster-xxxxx.us-east-1.rds.amazonaws.com
Port: 3306
Username: admin
Password: (from Secrets Manager)
Dialect: MySQL
Database: mydb

​
Creating the Connector in TextQL

​
Step 1: Navigate to Connectors Page

  1. Go to the TextQL Connectors Page
  2. Click New Connector

​
Step 2: Select Amazon Aurora

Select Amazon Aurora from the available connectors to open the configuration form.

​
Step 3: Enter Connection Details

The form requires the following information:
FieldDescriptionExample
Connector NameA descriptive name to identify this connectionMy Aurora Cluster
Host URLThe endpoint URL from RDS consoleaurora-cluster.cluster-xxxxx.us-east-1.rds.amazonaws.com
PortPort number (3306 for MySQL, 5432 for PostgreSQL)3306
DialectSelect MySQL or PostgreSQL based on engine typeMySQL
UsernameYour database usernameadmin
PasswordYour database password from Secrets Manager••••••••
DatabaseThe name of the database to connect toecommerce
Schema(Optional) Specific schema within your databasepublic

​
Step 4: Test and Create

  1. Click Test Connection to verify your credentials and network access
  2. Once the test succeeds, click Create Connector to save the connection

​
Troubleshooting

​
Connection Fails

Verify the following:
  • Credentials are correct and match what’s configured in AWS
  • Aurora cluster is running and accessible
  • Using the correct endpoint (dedicated vs. serverless)
Having trouble connecting? See the Network Configuration Guide for firewall and IP whitelisting setup.

​
Authentication Errors

Check:
  • Username and password from Secrets Manager are correct
  • User has appropriate database permissions
  • Password hasn’t expired

​
Timeout Errors

Possible causes:
  • Security group rules not configured correctly
  • VPC configuration blocking external access
  • Aurora cluster is stopped or paused
  • Network connectivity issues

​
What’s Next

Once your Aurora connector is set up, you can:
  • Ask Ana natural language questions about your data
  • Generate SQL queries and visualizations
  • Create reports and dashboards
  • Share insights with your team