OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Developer Center

V4.4.0

  • Topics Overview
  • Overview
    • What is ODC?
    • Features
    • Architecture
    • Limitations
    • ODC console
  • Quick Start
    • Client ODC
      • Overview
      • Install Client ODC
      • Use Client ODC
    • Web ODC
      • Overview
      • Deploy Web ODC
      • Use Web ODC
  • Data Source Management
    • Create a data source
    • Data sources and project collaboration
    • Database O&M
      • Session management
      • Global variable management
      • Recycle bin management
  • SQL Development
    • Edit and execute SQL statements
    • Perform PL compilation and debugging
    • Use the command-line window
    • Edit and export the result set of an SQL statement
    • Execution analysis
    • Generate test data
    • System settings
    • Database objects
      • Table objects
        • Overview
        • Create a table
      • View objects
        • Overview
        • Create a view
        • Manage views
      • Materialized view objects
        • Overview
        • Create a materialized view
        • Manage materialized views
      • Function objects
        • Overview
        • Create a function
        • Manage functions
      • Stored procedure objects
        • Overview
        • Create a stored procedure
        • Manage stored procedures
      • Sequence objects
        • Overview
        • Create a sequence
        • Manage sequences
      • Package objects
        • Overview
        • Create a program package
        • Manage program packages
      • Trigger objects
        • Overview
        • Create a trigger
        • Manage triggers
      • Type objects
        • Overview
        • Create a type
        • Manage types
      • Synonym objects
        • Overview
        • Create a synonym
        • Manage synonyms
  • Import and Export
    • Import schemas and data
    • Export schemas and data
  • Database Change Management
    • Manage user permissions
      • Users and roles
      • Automatic authorization
      • User permission management
    • Project collaboration management
    • Risk levels, risk identification rules, and approval processes
    • SQL check specifications
    • SQL window specification
    • Database change management
    • Manage changes to logical databases
    • Batch database change management
    • Online schema changes
    • Synchronize shadow tables
    • Schema comparison
  • Data Lifecycle Management
    • Data archiving
    • Data cleanup
    • Manage partitioning plans
      • Manage partitioning plans
      • Set partitioning strategies
      • Examples of partitioning strategies
    • SQL plan task
  • Data Masking and Auditing
    • Desensitize data
    • Operation records
  • Notification Management
    • Overview
    • View notification records
    • Manage notification channels
      • Create a notification channel
      • View, edit, and delete a notification channel
      • Configure a custom channel
    • Manage notification rules
  • System Integration
    • Login integration
    • Approval integration
    • SQL approval integration
    • Bastion host integration
  • Deployment Guide
    • Deployment overview
    • Preparations before deployment
    • Deploy ODC in single-node mode
    • Deploy ODC in high-availability mode
    • Deployment verification
  • Upgrade Guide
    • Upgrade Overview
    • Preparations before upgrade
    • Update single-node ODC
    • Update high-avaliability ODC
    • Upgrade verification
    • Rollback after upgrade failed
  • Best Practices
    • Tips for SQL development
    • Explore ODC team workspaces
    • Understanding real-time SQL diagnostics for OceanBase AP
    • OceanBase historical database solutions
    • ODC SQL check for automatic identification of high-risk operations
    • Integration with ODC enterprise-level account system
    • Manage and modify sharded databases and tables via ODC
    • Data masking and control practices
    • Enterprise-level control and collaboration: Safeguard every database change
  • Troubleshooting
    • ODC troubleshooting process
    • Collect message
      • View the runtime environment and version information
      • View web ODC logs
      • View client ODC logs
      • View end-to-end ODC-related logs
      • View ODC MetaDB data
      • Query the index status in OceanBase Database V4.x
      • Query the index status in OceanBase Database V1.4.x to V3.2.x
      • Collect JVM runtime information
      • Use tcpdump to capture packets
    • FAQ
      • Installation of client ODC
      • Web ODC deployment and startup
      • Connection Information
      • Command-line window
      • DDL statement display
  • Common features
  • Release Notes
    • V4.4
      • ODC V4.4.0
    • V4.3
      • ODC V4.3.4
      • ODC V4.3.3
      • ODC V4.3.2
      • ODC V4.3.1
      • ODC V4.3.0
    • V4.2
      • ODC V4.2.4
      • ODC V4.2.3
      • ODC V4.2.2
      • ODC V4.2.1
      • ODC V4.2.0
    • V4.1
      • ODC V4.1.3
      • ODC V4.1.2
      • ODC V4.1.1
      • ODC V4.1.0
    • V4.0
      • ODC V4.0.2
      • ODC V4.0.0
    • V3.4
      • ODC V3.4.0
    • V3.3
      • ODC V3.3.3
      • ODC V3.3.2
      • ODC V3.3.1
      • ODC V3.3.0
    • V3.2
      • ODC V3.2.3
      • ODC V3.2.2
      • ODC V3.2.1
      • ODC V3.2.0

Download PDF

Topics Overview What is ODC? Features Architecture Limitations ODC console Overview Install Client ODC Use Client ODC Overview Deploy Web ODC Use Web ODC Create a data source Data sources and project collaboration Session management Global variable management Recycle bin management Edit and execute SQL statements Perform PL compilation and debugging Use the command-line window Edit and export the result set of an SQL statement Execution analysis Generate test data System settings Import schemas and data Export schemas and data Users and roles Automatic authorization User permission management Project collaboration management Risk levels, risk identification rules, and approval processes SQL check specifications SQL window specification Database change management Manage changes to logical databases Batch database change management Online schema changes Synchronize shadow tables Schema comparison Data archiving Data cleanup Manage partitioning plans Set partitioning strategies Examples of partitioning strategies SQL plan task Desensitize data Operation records Overview View notification records Create a notification channel View, edit, and delete a notification channel Configure a custom channel Manage notification rules Login integration Approval integration SQL approval integration Bastion host integration Deployment overview Preparations before deployment Deploy ODC in single-node mode Deploy ODC in high-availability mode Deployment verification Upgrade Overview Preparations before upgrade Update single-node ODC Update high-avaliability ODC Upgrade verification Rollback after upgrade failed Tips for SQL development Explore ODC team workspaces Understanding real-time SQL diagnostics for OceanBase AP OceanBase historical database solutions ODC SQL check for automatic identification of high-risk operations Integration with ODC enterprise-level account system Manage and modify sharded databases and tables via ODC Data masking and control practices Enterprise-level control and collaboration: Safeguard every database change ODC troubleshooting process View the runtime environment and version information View web ODC logs View client ODC logs View end-to-end ODC-related logs View ODC MetaDB data Query the index status in OceanBase Database V4.x Query the index status in OceanBase Database V1.4.x to V3.2.x Collect JVM runtime information Use tcpdump to capture packets Installation of client ODC Web ODC deployment and startup Connection Information Command-line window DDL statement display Common features ODC V4.4.0 ODC V4.3.4 ODC V4.3.3 ODC V4.3.2 ODC V4.3.1 ODC V4.3.0 ODC V4.2.4
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Developer Center
  3. V4.4.0
iconOceanBase Developer Center
V 4.4.0
  • V 4.4.2
  • V 4.4.1
  • V 4.4.0
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.4
  • V 4.2.3
  • V 4.2.2
  • V 4.2.1
  • V 4.2.0
  • V 4.1.3 and earlier

Common features

Last Updated:2026-04-08 06:00:33  Updated
share
What is on this page
SQL window editing area
Table objects
Manage table properties
Manage table data
View objects
Function objects
Stored procedure Objects
Trigger objects
Types

folded

share

SQL window editing area

The toolbar in the SQL window editing area supports the following features:

0

Feature Description
2 Run all SQL statements in the current SQL window. You can also run all SQL statements by using the shortcut key Ctrl+Enter.
3 Run all selected SQL statements or the SQL statement on the line where the cursor is located. You can also run the current statement by using the shortcut key Ctrl+Shift+Enter.
4 View the execution plan estimated by the system before executing the selected or the SQL statement on the line where the cursor is located (EXPLAIN operation result). The displayed execution data may be slightly different from the actual execution data. You can use this feature to evaluate the SQL statement.
Click Execution Plan and then click View Formatting Information on the Plan Details tab to switch to the formatting display page.
5 Enter content in the search box to search in the script. After the search, you can enter content in the replace box to replace the searched content.
6 Roll back the script to the result of the previous operation.
7 After you execute the Undo operation, re-execute the operations before the undo.
8 Click this button to uniformly format (indent, line break, and highlight keywords, etc.) the selected SQL statements or all SQL statements in the current SQL window.
9 A batch copy conversion tool that is used to convert copied rows or columns into a specified format when you query data.
After you paste the batch data to the SQL editing area, select the copied data and click Convert IN Values to convert the data into an IN ('A', 'B') format.
  • Column values are separated by line breaks.
  • Row values are separated by spaces or tabs.
10 Provides three effects: All Caps, All Lowercase, and Capitalize First Letter. Convert the selected statements in the script to the corresponding form.
11 Provides two effects: Add Indent and Delete Indent. Add or delete indents included in the selected statements in the script.
12 Provides two effects: Add Comment and Delete Comment. Convert the selected statements in the script to comments or to SQL statements.
13
  • Delimiter: Select a symbol from the drop-down list to set the delimiter. Currently, five types of delimiters are supported: ;, /, //, $, and $$.
  • Query Result Limit: Set the number of returned rows. The default value is 1000.
  • Get Result Set Column Info: Before SQL execution, you can choose whether to get column information. If the table contains many columns, you can disable this option to avoid querying column comments and editable column information, thereby reducing the SQL execution time.
  • Session Variables: Edit, refresh, and search variables.
14 Supports searching for and switching databases based on keywords.

Table objects

Manage table properties

Basic information

table1

On the Properties tab, the basic information page provides the following buttons:

Button Description
Edit Click Edit to modify the basic information.
Refresh Click Refresh to refresh the basic information.
Export Click the export icon in the upper-right corner to export single-table data. For more information, see Export schema and data.

Column information

table2

The toolbar provides the following buttons:

Button Description
New Click + to add a field (column) to the table.
Delete Click Delete to delete the selected field.
Refresh Click Refresh to refresh the field information.
Filter Click Filter (next to Field Name and Type) to filter or search for fields.
Export Click the export icon in the upper-right corner to export single-table data. For more information, see Export schema and data.

Index information

table-attribute3

The toolbar provides the following buttons:

Button Description
New Click + to add an index to the table.
Delete Click delete to delete the selected index.
Refresh Click refresh to refresh the index information.
Filter Click filter (next to Index Name and Scope) to filter or search for fields.
Export Click the export icon in the upper-right corner to export data from a single table. For more information, see Export schema and data.

Constraint information

table4

OceanBase Database supports different types of constraints in MySQL mode and Oracle mode. The required information for each type of constraint varies. Therefore, please specify the required information based on the selected constraint method as shown on the page.

The toolbar provides the following buttons:

Button Description
New Click + to add a constraint to the table.
Delete Click delete to delete the selected constraint.
Refresh Click refresh to refresh the constraint list.
Filter Click filter to filter or search for fields.
Export Click the export icon in the upper-right corner to export data from a single table. For more information, see Export schema and data.

Partitioning rules

table-attribute5

Click Partition in the left-side navigation pane of the attribute tab to view information such as Partition Name, Order, Partition Method, Expression (partitioning key in Oracle mode), Upper Bound Value, or Enumeration Value that is set when the table is created. Different partitioning methods display different partitioning information. The toolbar provides the following buttons:

Button Description
Delete Click delete to delete the selected partition. The data in the partition will also be deleted.
Refresh Click refresh to refresh the list of partitions.
Filter Click filter to filter or search for partition names, order, or upper bound values.
Export Click the export icon in the upper-right corner to export data from a single table. For more information, see Export schema and data.

DDL information

table-attribute6

The toolbar provides the following buttons:

Button Description
Format Click Edit to format the statement for easier viewing.
Download Click Download to download the DDL to a local file.
Refresh Click Refresh to refresh the partition list.
Export Click the export icon in the upper-right corner to export data from a single table. For more information, see Export schema and data.

Manage table data

view2

The toolbar on the Edit Result Set page provides the following buttons:

Feature Description
3 Edit the current result set. In edit mode, you can perform operations such as Add Row, Delete, Copy Current Row, Cancel, and Confirm Modification (when auto-commit is enabled, clicking this button automatically commits the transaction).
4 View the estimated execution plan of the selected or currently highlighted SQL statement before it is executed (EXPLAIN operation results). The displayed execution data may differ slightly from the actual data after execution. You can use this feature to evaluate the SQL statement.
Click Execution Plan to view the execution plan details on the Plan Details tab. Then, click View Formatted Information to switch to the formatted display page.
view4 View the full-chain trace details for the current SQL statement. Full-chain tracing helps quickly identify the execution time of SQL statements or transactions at each node, making it easier to locate anomalies.

Note

Only OceanBase Database V4.1.0 and later versions support viewing full-chain traces.

view5 Enter keywords in the search box to query the desired results.
view6 Filter the columns displayed on the page.
view7 Display the selected data in a table format. On the column mode page, you can switch between rows. For scenarios with a large number of columns, column mode provides a convenient way to view row data. Here are the steps:
  1. Select the data you want to view and click the Column Mode button.
  2. In the Column Mode page that appears, you can use the left and right buttons to navigate through the rows and columns.
  3. Move your mouse over a value field and click the Zoom In button to view the details of that column field.
  4. In the Column Mode list, you can view the column comments by clicking Remarks. To modify the remarks, follow these steps:
    1. In the left-side navigation pane, right-click the target table and select View Table Structure to go to the table attribute management tab.
    2. In the left-side navigation pane of the attributes tab, click the Columns tab.
    3. Select the field name and click the edit icon to open the Edit Field dialog box.
    4. In the Field Comment field, enter the field comment and click OK.
    5. In the SQL Confirmation dialog box, click Execute to complete the remark modification.
    6. The modified remarks will be displayed in the Column Mode view.

View objects

view2

The following buttons are available in the toolbar of the editing page:

Button Description
Format Click this button to uniformly format the selected SQL statements or all SQL statements in the current SQL window (such as indentation, line breaks, and keyword highlighting).
Find/Replace Enter content in the search box to search in the script. After searching, you can enter content in the replacement box to replace the found content.
Undo Reverts the script to the result of the previous operation.
Redo Executes the Undo operation and then re-executes the operation before the undo.
Case Sensitivity Provides three effects: All Caps, All Lowercase, and Capitalize First Letter, which convert the selected statements in the script to the corresponding case.
Indent Provides two effects: Add Indent and Remove Indent, which add or remove indentation from the selected statements in the script.
Comments Provides two effects: Add Comment and Delete Comment, which convert the selected statements in the script to comments or back to SQL statements.
IN Value Conversion Converts values in the format A B to the format ('A', 'B').
Previous Step Returns to the Create View page, where you can continue to edit or modify the specified values on the Basic Info, Base Table Selection, and Field Selection tabs.

Function objects

3

The toolbar on the edit function page provides the following buttons:

Feature Description
Confirm Modification Click this button to update the current modification.
2 Download the SQL file of the function object.
3 Run the current function.
4 Compile the target function.
5 Enter content in the search box to search in the script. After searching, you can enter content in the replacement box to replace the searched content.
6 Roll back the script to the result of the previous operation.
7 After executing the Undo operation, re-execute the operations before the undo.
8 Click this button to uniformly format the selected SQL statements or all SQL statements in the current SQL window (such as indentation, line breaks, and keyword highlighting).
9 Batch copy conversion tool, suitable for converting the copied rows or columns when querying data. After pasting the batch data into the SQL editing area, select the copied data and click the IN Value Conversion button to convert it into the in('A','B') format.
  • The column value separator is a newline character.
  • The row value separator is a space or tab character.
10 Provides three effects: All Uppercase, All Lowercase, and Capitalize First Letter, which convert the selected statements in the script to the corresponding form.
11 Provides two effects: Add Comment and Delete Comment, which convert the selected statements in the script to comments or to SQL statements.
12 Provides two effects: Add Indentation and Delete Indentation, which add or remove the included indentation from the selected statements in the script.

Stored procedure Objects

3

The following buttons are provided in the toolbar on the editing page:

Feature Description
Confirm Modification Click this button to update the current modification.
2 Download the SQL file of the stored procedure object.
3 Run the current stored procedure.
4 Compile the target stored procedure.
5 Enter content in the search box to search in the script, and enter content in the replace box to replace the found content.
6 Revert the script to the result of the previous operation.
7 After executing the Undo operation, re-execute the operations before the undo.
8 Click this button to uniformly format the selected SQL statements or all SQL statements in the current SQL window (such as indentation, line breaks, and keyword highlighting).
9 Batch copy conversion tool for formatting copied rows or column results when querying data. After pasting batch data into the SQL editing area, select the copied data and click the IN Value Conversion button to convert it into the IN ('A', 'B') format.
  • Column value separator is a newline character.
  • Row value separator is a space or tab character.
10 Provides three effects: All Uppercase, All Lowercase, and Capitalize First Letter. These effects convert the selected statements in the script to the corresponding format.
11 Provides two effects: Add Comment and Delete Comment. These effects convert the selected statements in the script to comments or back to SQL statements.
12 Provides two effects: Add Indentation and Delete Indentation. These effects add or remove indentation from the selected statements in the script.

Trigger objects

trigger1

The following buttons are provided in the toolbar of the editing page:

Feature Description
Confirm Modification Click this button to update the current modification.
5 Enter content in the search box to search in the script. After the search, you can enter content in the replace box to replace the searched content.
6 Roll back the script to the result of the previous operation.
7 After you execute the Undo operation, re-execute the operations before the undo.
8 Click this button to uniformly format (indent, line break, and highlight keywords, etc.) the selected SQL statements or all SQL statements in the current SQL window.
9 A batch copy conversion tool that is used to convert copied rows or columns into a specified format when you query data.
After you paste the batch data to the SQL editing area, select the copied data and click Convert IN Values to convert the data into an IN ('A', 'B') format.
  • Column values are separated by line breaks.
  • Row values are separated by spaces or tabs.
10 Provides three effects: All Caps, All Lowercase, and Capitalize First Letter. Convert the selected statements in the script to the corresponding form.
12 Provides two effects: Add Comment and Delete Comment. Convert the selected statements in the script to comments or to SQL statements.
11 Provides two effects: Add Indent and Delete Indent. Add or delete indents included in the selected statements in the script.

Types

3

The toolbar on the Create Type page provides the following buttons:

Feature Description
5 Enter content in the search box to search in the script. After the search, you can enter content in the replace box to replace the searched content.
6 Roll back the script to the result of the previous operation.
7 After you execute the Undo operation, re-execute the operations before the undo.
8 Click this button to uniformly format (indent, line break, and highlight keywords, etc.) the selected SQL statements or all SQL statements in the current SQL window.
9 A batch copy conversion tool that is used to convert copied rows or columns into a specified format when you query data.
After you paste the batch data to the SQL editing area, select the copied data and click Convert IN Values to convert the data into an IN ('A', 'B') format.
  • Column values are separated by line breaks.
  • Row values are separated by spaces or tabs.
10 Provides three effects: All Caps, All Lowercase, and Capitalize First Letter. Convert the selected statements in the script to the corresponding form.
12 Provides two effects: Add Comment and Delete Comment. Convert the selected statements in the script to comments or to SQL statements.
11 Provides two effects: Add Indent and Delete Indent. Add or delete indents included in the selected statements in the script.

Previous topic

DDL statement display
Last

Next topic

ODC V4.4.0
Next
What is on this page
SQL window editing area
Table objects
Manage table properties
Manage table data
View objects
Function objects
Stored procedure Objects
Trigger objects
Types