The SQL Console in Data Management (DMS) is a browser-based SQL editor for data query and development. Connect to a database instance, write and run SQL statements, and view results — all without leaving the DMS console.
Prerequisites
Before you begin, ensure that you have:
Query permissions on the database or table you want to access
To apply for permissions, see Manage permissions.
SQL Console interface
The SQL Console page is divided into four sections:
Section | Description |
① Visual operation section | Browse and manage your database instance. View tables, programmable objects, and key-value pairs in the left panel. |
② Extended feature section | Access icons for permissions, table lists, data analysis, Database Autonomy Service (DAS) diagnostics, metadata sync, export, operation audit, sharing, and Super SQL Mode. |
③ Statement execution section | Write and run SQL statements. Format code, generate execution plans, and open multiple SQLConsole tabs. |
④ Execution result section | View query results, inspect individual rows, and add, modify, or delete data. Access execution history from the Execution History tab. |
Visual operation section (①)
The visual operation section lets you explore your database instance without writing SQL:
Table: View all tables in the current database instance, including columns, column types, and indexes. Right-click a table to modify its schema, manage it, import or export data, or perform batch operations.
Programmable Object: Create, view, run, and manage database objects such as views, stored procedures, functions, triggers, and events.
Up to 1,000 entries are displayed.
Key-value pair information: Displayed only for NoSQL database instances.
Extended feature section (②)
The extended feature section provides quick access to the following tools:
Icon | Feature | Description |
| Permissions | Apply for data ownership or change DDL, DML, and SELECT permissions for the current database instance. |
| Table List | View all tables in the current database instance on the Table List page. Click |
| Data Analysis | Create a data analysis ticket. Displayed only for ApsaraDB RDS for MySQL instances. See Create data warehouses. |
| Database Autonomy Service (DAS) | Run one-click diagnostics, monitor real-time performance, manage instance sessions, and perform spatial analysis. See Real-time performance monitoring and Session management. |
| Sync Metadata | Collect the latest metadata for the database instance — tables, fields, indexes, and programmable objects. See Metadata. |
| Export | Export data, table schemas, or table creation statements. Use Version management to view schema version history. See Manage schema versions. |
| Operation audit | View all data query and change records, including SQL type, the user who performed each operation, and timestamps. Also access the risk audit feature to assess database usage risks. See Use the operation audit feature and Generate a risk audit report. |
| Share | Share the SQLConsole tab and its statements with other stakeholders. See Share the SQLConsole tab. |
| Super SQL Mode | Run SQL statements without security rule restrictions. Available to DMS administrators and database administrators (DBAs). See Use the super SQL mode. |
to return to the SQLConsole tab.
Statement execution section (③)
The statement execution section is where you write and run SQL. It provides three controls:
Execute: Run the SQL statements entered in the editor.
Format: Reformat SQL for readability. For example,
SELECT * FROM 'test_table';becomes:SELECT * FROM `test_table`;Execute Plan: View how the system executes the SQL statements that you enter.
Click 
in the upper-right corner to open multiple SQLConsole tabs.
Open the SQL Console
Log on to the DMS console V5.0.
In the top navigation bar, choose SQL Console > SQL Console.
If the console is in Simple mode, click
in the upper-left corner and choose All functions > SQL Console > SQL Console.In the Select Database dialog box, search for a database instance, select it from the results, and click Confirm.
On the SQLConsole tab, enter your SQL statements and click Execute.
Limitations
Keep the following limits in mind when using the SQL Console:
Query row limits: If you are a DMS administrator, you can change the maximum number of rows returned per query. To do so, go to Security and Specifications > Security Rules, edit the applicable security rule, open the SQL Console tab, select Basic Configuration Item as the checkpoint, find the Maximum number of returned rows per query configuration item, and click Edit in the Actions column.
Databases in Flexible Management or Stable Change mode: up to 3,000 rows returned per query by default.
Databases in Security Collaboration mode: 200 rows returned by default, up to 3,000 rows maximum.
To retrieve more rows without changing the limit, export the data instead. If the table contains sensitive fields, apply for export permissions on those fields first. See Manage permissions and Export SQL result sets.
Full table scan threshold: Full table scans are allowed on tables up to 10 GB by default. DMS administrators can change this value in Security and Specifications > Security Rules.
Query timeout: Each SQL statement has a 60-second timeout by default. To change it, go to Data Assets > Instances, find the instance on the Instance List tab, move the pointer over More in the Actions column, and select Edit. In the Edit dialog box, update the Query Timeout(s) parameter in the Advanced Information section.
Sensitive fields: If a table contains sensitive or confidential fields that you don't have access to, those field values appear as
******in query results. See Manage sensitive data.
FAQ
Q: When I log on to a MongoDB instance in DMS and execute an SQL statement, the error message "The instruction is incomplete. Please check." is returned.
A: Some MongoDB instructions require you to enable the new Resolver. Click Open Resolver to switch to the new Resolver. For a complete list of commands supported by the new Resolver, see Supported MongoDB commands.
What's next
After familiarizing yourself with the SQL Console interface, you can create tables, query tables, or modify table data: