Documentation
Prepare Database Connection String

Prepare Your Database Connection String

We currently support multiple types of databases: MySQL, PostgreSQL, SQL Server, BigQuery, Snowflake, and Vertica.

Here are some examples:

MySQL

mysql://user:password@host:port/database

PostgreSQL

postgresql://user:password@host:port/database

MongoDB

mongodb://user:password@host:port/database

SQL Server

Data Source=host;Initial Catalog=database;User ID=user;Password=password;

We use ADO.NET format connection strings - for more details, please refer to Microsoft's official documentation (opens in a new tab).

BigQuery

For BigQuery, you need to prepare two things:

1. Project ID

  • You can find it in the credentials JSON file as the quota_project_id field
  • Or from Google Cloud Console: look at the project selector at the top of the page
  • The project ID is typically composed of lowercase letters, numbers, and hyphens

2. Credentials JSON

{
  "client_id": "764086051850-xxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
  "client_secret": "xxxxx-xxxxxxxxxxxxx",
  "quota_project_id": "your-project-id",
  "refresh_token": "1//0exxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "type": "authorized_user",
  "universe_domain": "googleapis.com"
}

Make sure your Google Cloud account has the necessary BigQuery permissions to read the datasets you want to query.

Clickhouse

You should input three parameters: url, username, password.

You can find three parameters from your Clickhouse console like this:

Clickhouse Connection String

Vertica

vertica://user:password@host:port/database

If you encounter any issues while preparing your connection string, we recommend using this utility tool (opens in a new tab).

If you don't have a database and just want to test, you can apply for a free PostgreSQL database at Neon DB (opens in a new tab).

Whitelist Our Static IP (Only Required for Website Chatbot)

You need to whitelist our server IP 43.159.146.204 to allow the Website Chatbot to connect to your database successfully.

If you're unsure how to whitelist an IP, please contact your database provider or your database administrator. (Or ask ChatGPT directly).

If you are using the Desktop app, you can skip this step. (The Desktop app connects to your database from your local computer).

If you are curious about how we connect to your database, you can refer to This Blog.