Docs

Database Workshop

Operation guide

DB AI assistant (DBCopilot)

Database Workshop DBW provides the database AI assistant DBCopilot, which can assist you in dealing with related issues of databases and database instances. The AI assistant significantly improves the efficiency and security of database management, reduces the workload of administrators, and enhances the management level of database systems.

Function introduction

The AI assistant of DBCopilot plays a crucial role in database management and maintenance, including the following aspects:

Instance diagnostic report: Helps you detect the operational status of database instances, identify potential issues or anomalies, and provides detailed diagnostic reports to help you understand the health status of database instances.

Performance analysis: Analyzes database performance metrics, including query speed, response time, and resource usage. Helps you identify performance bottlenecks in database instances and offers optimization recommendations.

Fault troubleshooting: Locates and troubleshoots database issues, such as connection problems, query anomalies, and data integrity. Provides solutions and repair methods to help you quickly restore normal operation.

Knowledge Q&A: Equipped with powerful knowledge Q&A capabilities, whether it's basic database concepts, data types, operation statements, or features, configuration methods, and optimization strategies of the Volcanic Engine database, the AI assistant can quickly provide clear and easy-to-understand answers with its rich knowledge base and advanced algorithms, helping you better understand and apply related knowledge.

SQL (Text-to-SQL): Automatically converts natural language descriptions into accurate SQL statements. Simply input your data operation requirements, SQL assistant will quickly generate the corresponding executable SQL statements, significantly improving coding efficiency.

SQL error correction and rewriting: Equipped with intelligent detection and correction capabilities for syntax and logical errors in SQL statements. By thoroughly analyzing the input SQL statements, SQL assistant can accurately pinpoint errors and provide detailed error information and correction suggestions, helping you quickly resolve issues.

SQL auto-completion: Intelligently infers and automatically completes unfinished SQL statements based on existing content and database structure. This feature significantly enhances SQL writing efficiency and accuracy, serving as an indispensable aid in modern data development.

SQL result set chart structure: Able to present the structure of the SQL query result set in an intuitive chart form. This allows you to better understand the relationships and distribution of data, helping to identify patterns and trends, and providing strong support for further data analysis and decision-making.

AI Generation: Has the ability to create tables with AI and insert data with AI. Through AI table creation and AI data insertion, you can quickly generate SQL statements to create tables and SQL statements to insert data.

SQL dialect conversion: Supports conversion between MySQL, PostgreSQL, SQL Server, and Oracle syntax.

function configuration: able to enable or disable the database automatic inspection function for instances, initiate inspection for instances, or create SQL audit tickets.

Quick start video demonstration

Category	Video demonstration
Business assistant	DB AI assistants can comprehensively analyze the current running data of the instance and efficiently provide diagnostic plans and suggestions. Regarding questions you expect to know, such as "Is the current instance is abnormal," "Analyze the cause of the current instance is abnormality and how to solve it," and "How should slow SQL be optimized AI assistant performed a quick and accurate analysis, interpretation, and suggestion.
SQL assistant	When it comes to SQL assistant, sometimes the business purpose is clear, but writing and debugging SQL can waste a lot of time, delaying business opportunities. Taking your expectation of "querying the top 10 products with the highest purchase volume" as an example, DBCopilot can select the corresponding ones from numerous tables and write SQL that meets business needs. After executing the results, it can also automatically generate statistical charts, enabling data visualization from a single question with just one sentence.
Knowledge Q&A	In knowledge Q&A, DB AI assistant has powerful knowledge Q&A capabilities. For example, if you want to know about cloud database specifications configuration, read-only node configuration, and how to perform advanced SQL rate limiting operations, you no longer need to spend a lot of time learning; just send natural language questions to DB AI assistant to get customized solutions and suggestions.

Precautions

Suggestions or solutions provided by the DB AI assistant are for reference only. If you need further assistance or confirmation, see product documentation or submit ticket to contact technical personnel.

The current DB AI assistant has strong support capabilities for RDS for MySQL, NDB for MySQL, RDS for PostgreSQL, and Document Database for MongoDB, while its support for Cache for Redis and RDS for SQL Server is relatively weak.

A maximum of 5,000 sessions can be created under one account, including the primary account and all sub-accounts under it.

After deleting a session, the corresponding interaction history in the session will not be retained. Proceed with caution when deleting sessions.

The DB AI assistant feature is currently only available in the China (Beijing), China (Shanghai), and China (Guangzhou) regions. Users in other regions who wish to use this service should submit a ticket to request permission to use it.

Entry

DBCopilot AI assistant plays a significant role in database management and maintenance, helping you diagnose database instance issues, perform performance analysis, and troubleshoot faults; it can also improve the efficiency of writing and debugging SQL statements. There are three entrances to access the DB AI assistant in DBW. You can experience the efficiency, convenience, and surprises that the DB AI assistant brings to you through these three entrances.

tip

Now in the database console, you can also use the capabilities of DBCopilot through the assistant entrance in the floating layer in the upper right or lower right corner.

Navigation bar entry

Observation and diagnosis entry

SQL window entry

Log on to the DBW console.

On the top menu bar, select the region.

In the left navigation bar, click DB AI assistant.

In the left area of the DBCopilot page, click Create session.

tip

The naming rules for sessions are as follows:

Cannot start with digits or hyphen (-).

Can only contain Chinese characters, letters, digits, underscores (_) and hyphens(-).

The length must be between 1 and 128 characters.

In the DBCopilot new session, enter your question to start the intelligent Q&A.

tip

In a create session of DBCopilot diagnosis assistant, type / to select a quick question from the common questions and ask it directly.

When querying instance information within the same session, the default is to retrieve the instance information from the previous question.

Functionality

The table below lists some basic capabilities of the DBCopilot AI assistant. You can refer to the related question examples to ask your questions or requests, and let DBCopilot help you answer or provide suggestions.

Description of fault troubleshooting and intelligent Q&A related capabilities

tip

To obtain more accurate answers, you need to provide key information about the issue, such as the instance ID and time range.

Capability name	Functionality	Question example	Supported database types
Single instance comprehensive analysis	Thoroughly analyze the current abnormal situation of an instance, and obtain the capabilities to be used from the provided capabilities according to the description, comprehensively analyze and summarize to form a conclusion.	Are there any abnormalities in my current instance recently? Please summarize the long execution time sessions for my current instance. Check whether there are blocked transactions and locks in the session, and how to resolve the transactions and locks if they exist.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Query instance list	Query the number of related instances according to the instance type and provide key information.	What MySQL instances do I have?	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Instance basic information	Query instance specifications and basic information	List the specifications and availability zone information for the current instance.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Instance abnormal information	Analyze instance abnormalities from the perspectives of performance indicators, space, and running status, and provide root cause analysis and optimization suggestions.	Summarize whether the current instance has any abnormality	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Network connection	Query the network connection information of the current instance.	Query network connection information in the current instance	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Resource configuration	Query the specifications of the current instance.	Query the specification information of the current instance	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Billing information	Query the billing information of the current instance.	Query the current instance's billing information	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Database parameters	Query the runtime parameter configuration information of the current instance.	Query the parameter configuration of the current instance	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Problem analysis report	Displays the basic status of the instance and key problem findings, and provides solutions and follow-up operation suggestions.	Summarize whether there are any abnormalities in the current instance and how to handle them.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
Solutions for abnormal situations	Discover and analyze abnormal disk use, and provide solutions, operation risks, and rollback plans.	Analyze the current instance's disk condition. If there may be an exception with a data table, provide a solution	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
Summary of the day's operations	Analyze the overall operation, business activities, and abnormal situations of the instance today, and provide optimization suggestions.	Summarize the overall running status of the current instance today	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
Active user connection	Show the originating user of the active connections in the current instance.	Summarize the originating user of the current instance's active connections	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
Session query	Query sessions that meet the conditions in the current instance, and provide root cause analysis and optimization suggestions.	Summarize session information where the execution time of the current instance is over 30 seconds	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
CPU usage analysis	Queries and analyzes the CPU usage of the current instance and provides root cause analysis and optimization suggestions.	Summarize whether the CPU usage of the current instance is abnormal in the last day.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis
Memory usage analysis	Query and analyze the current instance's memory usage and provide root cause analysis and optimization suggestions.	Summarize whether the memory usage of the current instance is abnormal in the last day.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis
Disk usage analysis	Query and analyze the current instance's disk usage, and provide key tablespace issues (if any) and optimization suggestions.	Summarize the disk usage data for the current instance in the last week	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis
Disk capacity expansion assessment	Identify and analyze disk capacity and provide scaling evaluation results.	Analyze the disk condition of the current instance and evaluate whether disk scaling is required Summarize the space usage of my instance over the past week. If there are any abnormalities, analyze whether disk scaling is required?	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis
TPS analysis	Query and analyze the current instance's TPS data, and provide root cause analysis and optimization suggestions.	Summarize the TPS of the current instance is for the last day and determine if it is abnormal.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis
QPS analysis	Query and analyze the QPS data of the current instance and provide root cause analysis and optimization suggestions.	Summarize the QPS of the current instance is for the last day and determine whether it is abnormal.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis
Instance space usage	Queries and analyzes the space usage of the current instance, and provides root cause analysis and optimization suggestions.	Analyze the space usage of the current instance for the last day.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
Slow log status analysis	Query and analyze slow log data in the current instance and provide root cause analysis and optimization suggestions.	Summarize the slow log status of the current instance for the last day. My SQL statement executes very slowly in the current instance, now help me analyze the reason.	RDS for MySQL veDB for MySQL RDS for PostgreSQL
Hotspot SQL analysis	Queries and analyzes hot SQL information of the instance, and provides root cause analysis and optimization suggestions.	Query the current instance's hotspot SQL information for the most recent day	RDS for MySQL veDB for MySQL RDS for PostgreSQL
Table spacing details	Query the table spacing information in the current instance, and provide root cause analysis and optimization suggestions.	Query the details of the top 10 tablespaces in the current instance	RDS for MySQL veDB for MySQL RDS for PostgreSQL
Transaction and lock analysis	Query transactions and locks in the current instance, and provide root cause analysis and optimization suggestions.	Query whether there are blocked transactions and locks in the current instance, and how to resolve transactions and locks if they exist.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server
Index optimization suggestions	Based on the business situation, provide index optimization assessment and suggestions for hot SQL queries.	Does the hotspot SQL of the current instance need to be indexed?	RDS for MySQL veDB for MySQL RDS for PostgreSQL
Database fundamentals	Provide help and guidance on SQL basics.	What engines are available for MySQL databases? Ask for the SQL statement to create the table Create a normal table Create a Sequence table Ask for the SQL statement to insert table data Insert data into the table table Insert data into the tbl_vector table	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
Volcano Engine database document	The content is generated based on existing official database documents.	What are the newly added features of DBW? How to create an archive cleanup ticket?	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB Cache for Redis RDS for SQL Server

Description of SQL assistant related capabilities

The DB AI assistant provides comprehensive support when handling SQL-related tasks. Whether in the SQL console or an assisted AI assistant environment, it plays a crucial role. The following uses RDS for MySQL as an example to introduce how to use the SQL assistant feature.

tip

Currently, only the data interaction platforms of RDS for MySQL, veDB for MySQL, RDS for PostgreSQL, and Document Database for MongoDB support the DB AI assistant.

In the data interaction platform of Document Database for MongoDB, the SQL assistant currently only supports natural language to SQL, and does not support using the Text-to-SQL function in the command execution area.

Category	Example	Database type
Natural language to SQL (Text-to-SQL)	Automatically converts natural language descriptions into accurate SQL statements. Simply input your data operation requirements, SQL assistant will quickly generate the corresponding executable SQL statements, significantly improving coding efficiency. You can achieve the Text-to-SQL functionality through the following two methods: Method one: achieve Text-to-SQL through DBCopilot diagnosis assistant Log on to the Data interaction platform. tip Take RDS for MySQL as an example. On the Data interaction platform page, click DB AI assistant in the top right corner. In the DBCopilot SQL assistant section, input your desired goal, such as querying table data. DBCopilot will return an SQL command. You can click Execute now to view the results in the Execution result on the left. tip Before clicking Execute now, ensure the target database in the top menu bar matches the one selected by DBCopilot. In Confirm execution? dialog box, click OK. Method 2: implement Text-to-SQL in the command execution area Log on to the Data interaction platform. tip The following example uses RDS for MySQL. In the top menu bar of the Data interaction platform page, select the target database. In the command execution area, enter the goal you want to achieve as needed, and then press Enter. The format is -- Natural language, as shown in the following example: Example -- 查询数据库的表 Result after pressing Enter: SHOW TABLES; Select the generated SQL statement and click Execute. You can view the result in Execution result.	RDS for MySQL veDB for MySQL RDS for PostgreSQL Document Database for MongoDB
SQL error correction and rewriting	It has the ability to intelligently detect and correct syntax and logic errors in SQL statements. By thoroughly analyzing the input SQL statements, SQL assistant can accurately pinpoint errors and provide detailed error information and correction suggestions, helping you quickly resolve issues. Log on to the Data interaction platform. tip The following example uses RDS for MySQL. In the top menu bar of the Data interaction platform page, select the target database. In the command execution area, enter the SQL command you need to execute. Select the SQL command you need to execute, and click Execute. If the command fails to execute, in the Execution result area, click SQL AI suggestion. In the SQL AI suggestion dialog box, view the accurate command and copy it to the command execution area to re-execute.	RDS for MySQL veDB for MySQL
SQL auto-completion	Intelligently infers and autocompletes unfinished SQL statements based on input content and database structure. This feature significantly enhances SQL writing efficiency and accuracy, serving as an indispensable aid in modern data development. Log on to the Data interaction platform. tip The following example uses RDS for MySQL. In the top menu bar of the Data interaction platform page, select the target database. In the upper-right corner of the SQL execution area on the Data interaction platform page, click the pen icon to enable SQL auto-completion. tip When you do not need to use the SQL auto-completion feature, click the pen icon in the upper-right corner to disable it. In the command execution area, the DB AI assistant provides auto-completion for SQL statements. Press Tab to insert the generated suggestion, or Esc to dismiss it. tip Press the Tab key to complete the statement. Press the ESC key to cancel the completion.	RDS for MySQL veDB for MySQL RDS for PostgreSQL
SQL result set chart structure	Capable of intelligently detecting and correcting syntax and logical errors in SQL statements. By thoroughly analyzing the input SQL statements, SQL assistant can accurately pinpoint errors and provide detailed error information and correction suggestions, helping you quickly resolve issues. Log on to the Data interaction platform. tip The following example uses RDS for MySQL. In the top menu bar of the Data interaction platform page, select the target database. In the command execution area, enter the SQL command you need to execute. Select the SQL command you need to execute, and click Execute. In the Execution result area, click AI chart to view the SQL result set chart structure.	RDS for MySQL veDB for MySQL RDS for PostgreSQL RDS for SQL Server
AI suggestion	The DB AI assistant has the ability to create tables with AI. You can quickly generate SQL statements for creating tables through AI table creation. Log in to the Data interaction platform. tip The following example uses RDS for MySQL. In the top menu bar of the Data interaction platform page, select the target database. In the visual area of the data interaction platform, right-click the function icon after the table and select AI Create table. In the natural language of the command execution area, modify information such as the table name, fields contained in the table, and field types, and then click the Send icon. In the command execution area, the DB AI assistant automatically generates SQL statements for creating tables, then you can generate or cancel generating the statement by pressing the Tab key or ESC key. tip Press the Tab key to generate the SQL statement. Press the ESC key to cancel the generation of the SQL statement. Select the SQL command you need to execute, and click Execute. After the SQL command is completed, you can view the newly created table in the visualization area of the data interaction platform.	RDS for MySQL veDB for MySQL
AI suggestion		DB AI assistant has the ability to insert data using AI. You can quickly generate SQL statements for inserting data by using AI to insert data. Log on to the Data interaction platform. tip The following example uses RDS for MySQL. In the top menu bar of the Data interaction platform page, select the target database. In the visualization area of the data interaction platform, Create table by AI after you expand a table and right-click the function icon after the target table. In the natural language of the command execution area, modify the table name and the number of data entries inserted into the table, and then click the send icon. In the command execution area, the SQL assistant automatically generates the SQL statement for creating the table. You can then press the Tab key or the ESC key to generate or cancel the generation of the SQL statement. tip Press the Tab key to generate the SQL statement. Press the ESC key to cancel the generation of the SQL statement. Select the SQL command you want to execute, and click Execute. After the SQL command is executed, you can query the newly inserted data in the table.	RDS for MySQL veDB for MySQL
SQL dialect conversion	Supports conversion between MySQL, PostgreSQL, SQL Server, and Oracle languages. You can implement SQL dialect conversion in the following two ways: Method 1: Convert SQL dialects through DB AI assistant Log on to the Data interaction platform. tip Take RDS for MySQL as an example. On the Data interaction platform page, click DB AI assistant in the top right corner. In the DBCopilot SQL assistant area, enter the target you want to achieve. For example, "Convert INSERT ALL INTO student (id, NAME, age) VALUES (1, 'John', 20) INTO student (id, NAME, age) VALUES (2, 'Lily', 21) INTO student (id, NAME, age) VALUES (3, 'Sam', 22) SELECT 1 FROM DUAL; to a SQL statement." DBCopilot will return the converted SQL statement. You can click Execute now and then click OK in the confirmation box. You can view the result in Execution result. Description Before clicking Execute now, ensure the target database in the top menu bar matches the one selected by DBCopilot. Method two: Implement SQL dialect conversion in the command execution area Log on to the Data interaction platform. Description The following example uses RDS for MySQL. In the top menu bar of the Data interaction platform page, select the target database. In the command execution area, enter the SQL statement, and then select the SQL statement to be converted, as shown in the following example: Example of SQL statement before conversion CREATE TABLE student (id INT ,name CHAR ,age INT ); d. In the pop-up menu bar, select SQL conversion, and select the target language such as Oracle. It supports converting SQL language to Oracle, PostgreSQL, or SQL Server language. e. A language conversion question will be automatically generated in the SQL assistant, and the converted SQL statement will be given. Example of converted SQL statement CREATE TABLE student (id NUMBER(10),name CHAR(1),age NUMBER(10));	RDS for MySQL veDB for MySQL RDS for PostgreSQL RDS for SQL Server

Function configuration capability description

DB AI assistant can enable or disable the automatic inspection function of the database for instance, initiate inspection for instance, or create a SQL audit ticket.

Capability name	Functionality	Question example	Supported database types
Initiate database inspection	Initiate a manual inspection in the instance.	Initiate an automatic inspection of the xxx instance	RDS for MySQL NDB for MySQL RDS for PostgreSQL Cache for Redis
Enable automatic inspection	Enable automatic inspection for the instance.	Enable automatic inspection for instance xxx	RDS for MySQL NDB for MySQL RDS for PostgreSQL Cache for Redis
Disable automatic inspection	Disable the automatic inspection function for instance.	Disable the automatic inspection for the xxx instance	RDS for MySQL NDB for MySQL RDS for PostgreSQL Cache for Redis
Creating an SQL review ticket	Create an SQL review ticket for instance. tip The instance needs to enable security control.	Create a SQL audit ticket for the mysql-0b81381***** instance.	RDS for MySQL NDB for MySQL RDS for PostgreSQL

Related operation

After the AI assistant's Q&A session, you can also perform the following operations.

Actions	Description
Result feedback	After the answer is generated, if you are satisfied with the result, you can click the Like icon to provide feedback. If you are not satisfied with the result, you can click the Dislike icon to provide feedback.
Submit ticket	If the current Q&A cannot solve your problem, you can click the Create volcano ticket icon to create a ticket.
Configuration-related features	If the answer provides follow-up operation suggestions or involves related function configurations, click the relevant function configuration button to open the configuration page for the relevant function. All configuration suggestions are based on the data analysis scenario at the time of the question and answer, so the recommended configuration parameters have a certain timeliness. It is not recommended that you configure related functions from this function entry after a long interval.
View historical messages	DBW automatically saves history session messages, so you can view history session messages in the session. If the relevant function configuration suggestion is provided in the history session message, and you have configured it according to the relevant suggestion. You can also view the associated configuration tickets or tasks. Click Ticket ID to view more information about the ticket.

Last updated: 2026.03.03 16:23:50