Quick Start

📖 Introduction

Chat2DB is an AI first data management, development, and analysis tool. Its core is AIGC (Artificial Intelligence Generation Code) capability. It can convert natural language into SQL, convert SQL into natural language, and can also automatically generate Reports greatly improve personnel efficiency. Through one product, the capabilities of data management, data development, and data analysis can be realized. Even those who do not understand SQL can use the ability to quickly query business data and generate reports.

🚀 Quick Start

This quick start guide will introduce you to the key concepts and help you with your first steps in Chat2DB.

Our products provide two ways of use: web page and client. The web page can be used out of the box, and the client provides a smoother user experience. At the same time, when some private databases or local data cannot be accessed from the public network, the client can connect to your database locally and use it directly without the need for a proxy. It is simple and convenient, and you can flexibly switch between using the web page or the client according to your scenario. Below we explain how to use our products.

WEB access address: https://app.chat2db.ai (opens in a new tab), Client download address: https://chat2db.ai/download (opens in a new tab)

Step 1: Client download

If you use the web version, you can ignore this step and directly visit Application Address (opens in a new tab).

Client download address: Client download address (opens in a new tab) Just select the corresponding system to download and install. We support Windows (opens in a new tab)、Mac (opens in a new tab) 、Linux (opens in a new tab).

Step 2: Register and log in

You can try Chat2DB for free for up to 30 days, with 200 free AI trials and can connect to multiple databases at the same time.

After the PRO trial expires, you need to purchase a membership to continue using Chat2DB. Please refer to Subscription Plan (opens in a new tab) for details.

You can get the verification code directly through your email and log in directly, or you can use a third party to log in.

Chat2DB currently supports 4 login methods:

1. Google login
2. GitHub login
3. Log in with email verification code
4. Log in with email and password

Step 3: Create a database connection

Database connection is the first step for us to use Chat2DB. We need to connect to your database to perform subsequent operations. Click the database connection on the left, then click New Connection in the lower left corner, select the database you use, fill in the database connection information, and click Save. Currently we support Mysql, Postgresql, SQLServer, DB2, Oracle, SQLServer, Oceanbase, Clickhouse, Redis, H2, SQLite, Dameng, Renmin University of Finance and many other databases.

1. Create a new connection

Click the Database button on the left, select New Connection, select the database type you need, fill in the database connection information, and click Save.

2. Fill in the database connection information

• Name: The connection name can be customized to facilitate memory.
• Env: Select the connection environment, testing, production, etc. to distinguish connections in different environments
• Host: Mysql server address, which can be IP or domain name
• Port: Mysql server port, default 3306
• Authentication: Mysql authentication method, username and password or no authentication required
• User: Mysql username
• Password: Mysql password
• Database: Mysql database name, optional, if not filled in, it will connect to the default database
• URL: Mysql connection URL, optional, if not filled in, it will be automatically generated based on the above information
• Driver: Mysql driver, optional. If not filled in, it will be automatically identified based on the URL. You can also select it manually. After manual selection, the driver configuration items will be displayed.
• SSH: Whether to use SSH connection, optional. If not filled in, it will be disabled by default. SSH configuration items will be displayed after selection.
• Advanced Configuration: Advanced configuration, optional, not used by default if not filled in, advanced configuration items will be displayed after selection

Different databases on the client need to download different drivers. If you need SSH connection, you need to fill in the SSH information.

Step 4: Test connection

Click the test button in the lower left corner to test whether the connection is normal. If the connection is normal, the connection will be successful. Otherwise, the connection will be failed. You can adjust the connection information according to the error message. Finally click Save.

Step 5: Use Chat2DB database development

After the connection is successful, you can double-click the connection or right-click to enter the connection. Then you can add, delete, modify, and query the database in Chat2DB. You can also use our AIGC capability to directly query the database using natural language, or use SQL to convert to natural language.

Database management

Double-click the newly created connection to enter the database management interface, where you can add, delete, modify, and query the database.

Query Data with AI Copilot

Click the AI ​​copilot button on the right, or press Ctrl/Cmd+K to activate your AI copilot:

1. Select your data source

2. Select your favorite model

3. Input the natural language to query data.

Run SQL and get result in AI Copilot

You can run the generated SQL directly in ai copilot to view the results directly:

Paste SQL into the console

You can also click the button next to Run to paste the SQL into the console on the left for secondary editing.

Invoke AI in the console

You can press '/' in the editor to invoke AI and easily generate SQL through natural language:

Format SQL

After selecting SQL, click the format button above or right-click Format SQL to format and beautify your SQL.

Fix SQL Error with AI

If an error occurs after SQL running, you can directly click ‘fix in chat’ to get the correct sql result:

Data table management

You can choose to create database tables manually, or use AI to build tables with one click.

Create tables with AI

Click Table Copilot, enter the customized table name and column name in turn and enter to execute.

Click Run to execute the sql statement and complete the creation.

Create tables manually

Fill in basic information:

• Table Name: table name
• Comment: table comment
• Character set: character set
• Engine: storage engine
• Increment value: self-increment start value

Fill in column information:

• Column Name: column name
• Type: type
• Size: length
• Nullable: whether it is empty
• Key: primary key
• Comment: comment

Fill in index information:

• Index Name: index name
• Column: column name
• Type: index type
• Comment: comment

Data query

Right-click on a database, tables, or a specific table and select Query Console to query the data for the desired condition via SQL.

Type “/” to evoke AI, enter natural language, and select the AI dataset you just created to generate SQL language:

Step 7: Use Chat2DB data analysis

Create new dashboard

Click Dashboard on the left side, click New Dashboard to create a new data dashboard, fill in the report name (required) and report description (optional).

After that, you can choose to create the data report manually or AI generated report.

Create new charts

1. AI generates charts

Click the AI Copilot on the right up corner, enter the chart information you want to generate in natural language in the input box, and select the corresponding data source to generate a visual chart:

You can then add the chart to your dashboard:

2. Creating charts manually

1. New Chart

Click on New Chart to create a new chart.

2. Data Configuration

Click on Data configuration in the above image to configure the data. Select the corresponding database in the upper right corner, and write the corresponding sql statement in the input box, click Run, and see the execution result at the bottom.

Then click on Back to Chart to select the type of chart and determine the corresponding variables (horizontal and vertical axis coordinates, percentages...) according to the selected type.

Once you have made your selection, click save to save it!