Getting Started

Getting Started

Prepare Your Database Connection String

We currently support four types of databases: MySQL, PostgreSQL, MongoDB, and SQL Server.

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; or Server=host;Database=database;User Id=user;Password=password;.

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 ChatGPT Plugin)

You need to whitelist our server IP to allow the ChatGPT plugin 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.

Connect to Your Database

For plugin users, simply send a prompt like this to connect to your database:

"mysql://user:password@host:port/database what's inside my db?"

ChatGPT will then establish a connection to your database.

For desktop users, just input your URL and click the connect button.

If you encounter any connection errors, you can refer to This Doc (opens in a new tab) to find a solution.

Query Your Database

Start asking questions to your database, such as "How many users are there?" or "What is the average age of users?".

ChatGPT will retrieve the corresponding data from your database.

Learn more

We highly recommend you to read Get Better Answer and Training for Better Answers to train your ChatGPT to give you much better SQL results.