SQL Console for VectorDB

Use NineData SQL Console to manage Baidu Cloud Vector Database (VectorDB), generate request bodies for supported VectorDB APIs, execute operations, and inspect returned JSON results.

Background

AI applications rely on vector databases to store and search high-dimensional data such as image embeddings and text embeddings. Many database management tools provide limited support for vector database operations, so teams often need a single workspace for metadata management, API-style operations, and query results.

NineData SQL Console helps address common VectorDB management challenges:

• Operational complexity: Run supported VectorDB operations without switching to CLI or SDK tools.
• Limited visibility: Browse databases, tables, fields, indexes, and related metadata in a visual tree.
• Permission management: Work with user and role operations from the SQL Console.
• Request-body efficiency: Generate JSON request-body samples and adjust them before execution.

Feature overview

For VectorDB data sources, SQL Console covers the workflow from metadata browsing to API request execution.

Feature	Description
Visual object management	Browse and manage VectorDB libraries, tables, columns, indexes, and related objects in a tree view.
Request body generation	Use synchronized VectorDB operation interfaces for table management, index management, data updates, data queries, role management, and user management. After you select an operation, SQL Console generates a JSON request-body sample in the editor.
Editor	Adjust the generated request body and execute the selected VectorDB operation.
Workspace recovery	Reopen the SQL Console after a browser exit or crash and restore previously opened data sources and executed commands. The page state is stored in the cloud, so recovery is not tied to one browser or host.

Before you begin

• Add the target VectorDB data source to NineData. For details, see Manage Data Sources.

• In organization mode (DevOps Enterprise), you must have read-only, DML, or DDL permissions for the target data source.

  tip

  Read-only permissions support query operations only.

• In the commercial versions (DevOps Pro, DevOps Enterprise), make sure your monthly or yearly subscription has not expired. An expired subscription may prevent you from using the Database DevOps service. Check the remaining quota and expiration date in the NineData Console header.

  

Procedure

1. Sign in to the NineData Console.

2. Go to DevOps > SQL Console.

   tip

   If a data source session is still open, NineData redirects you to that data source page.

3. Select the field below SQL Console. In the data source list, select the target data source and click Query to open the SQL Console.

   tip

   • If no Data Source exists yet, the page is empty. Click Create Datasource on the page.

   • If you have multiple data sources, enter all or part of a keyword to search by these fields:

     • Data source name

     • IP address

       

4. After the SQL Console opens, manage the VectorDB data source from the interface. For details, see Interface reference.

Result

The SQL Console opens for the selected VectorDB data source. Browse metadata, generate VectorDB request bodies, execute operations, and review JSON results.

Next steps

• Review Interface reference to understand each area of the SQL Console.
• Use the operation request selector to generate a request-body sample, then adjust the JSON before execution.

Interface reference

No.	Feature	Description
1	SQL Console Tab	Represents the currently opened data source SQL Console. Use tabs to switch between SQL Consoles. Click X on a tab to close it, double-click a tab to rename it, or drag a tab to reorder it. The right-click menu supports these operations: Instance Details: Open the current data source details window. Rename Tab: Change the name of the current tab. Duplicate Query: Open an SQL Console for the current data source. New Query: Open a new data source SQL Console. Close Tab: Close the current SQL Console. Close Others: Close all other SQL Consoles except the current one. Close Tabs to the Left: Close all SQL Consoles to the left of the current SQL Console. Close Tabs to the Right: Close all SQL Consoles to the right of the current SQL Console. Close All: Close all SQL Consoles.
2	Open Data Source	Select and open a new data source SQL Console.
3	Data Source Information	Displays the current SQL Console data source, including environment, IP address, and port number. Right-click menu: Instance Details: View current data source details, including username and connection address. Duplicate Query: Open an SQL Console for the current data source. Refresh: Refresh data source information.
4	Favorite | Refresh	Favorite: Click the favorite icon to add the current data source to My Favorites for quick access when you create a new SQL Console. Refresh: Refresh the data in the current data source.
5	Database Name	Select the target database to perform SQL operations.
6	API Operation Request	Select a VectorDB management operation. SQL Console converts the selected operation into a standard VectorDB native API call and generates a JSON request-body sample in the editor. Adjust the sample before execution. Supported operations include: Table Management: Create Table, Drop Table, Add Field, Add Table Alias, Remove Table Alias Index Management: Create Index, Modify Index, Rebuild Index, Delete Index, View Index Details Data Update: Insert Record, Update Inserted Record, Update Record, Delete Record Data Query: Query Single Record, Scalar Batch Query, Vector Retrieval, Batch Vector Retrieval, Scalar Filter Query, Multi-Vector Retrieval Role Management: Create Role, Delete, Grant Role Privileges, Revoke Role Privileges, Show Role Privileges, Filter Roles by Privileges User Management: Create User, Delete User, Change User Password, Grant Role to User, Revoke User Role, Grant User Privileges, Revoke User Privileges, Show User Privileges, Filter Users by Privileges
7	Function Buttons	: Execute Execute the selected VectorDB operation. VectorDB Documentation Center: Open the official documentation for Baidu Cloud Vector Database VectorDB. : Full Screen Open the SQL Console in full-screen mode. In full-screen mode, click Exit to restore the original size.
8	Object Tree	Displays all libraries, tables, columns, and non-table objects in the current VectorDB in a tree view. Use this area to perform these operations: Create Database: If VectorDB has no libraries, click Create Database on the page. If libraries already exist, right-click any database name and click Create Database. Enter Name in the dialog, then click OK. Delete Database: Right-click the target database name, click Delete Database, and then click OK in the confirmation window. Table Details: Right-click the target table name, click Table Details, and view table details, including Desc (table structure description), Alias (table alias information), and Stats (table statistics). Desc: Describes the complete table metadata, including field definitions, index configurations, partition strategies, and other core attributes. Alias: Displays the table alias mapping, which separates logical table names from physical table names. Stats: Displays real-time table statistics for monitoring and performance analysis. Duplicate Query: Right-click any object and click Duplicate Query to open a new SQL Console tab for the current data source. Refresh: Right-click any object and click Refresh to refresh the index list.
9	Editor Window	Runs VectorDB operations. It supports these features: Execute VectorDB operations: Select an operation type to generate a JSON request-body sample, then adjust the sample before execution. Syntax highlighting Right-click menu: Execute: Execute the VectorDB operation at the cursor position. Common operations: Cut, Copy, Paste, and Select All. Select Current SQL: Select the command at the cursor position.
10	Execution Information, Result Set	Displays command execution information and results. Execution Information: Includes execution time, execution duration, executed command, execution details, and other information. Result Set: Displays returned command results in JSON format. Hover over the target result set tab to view the corresponding command.