OceanBase logo

OceanBase

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

Product Overview
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

OceanBase

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

Product Overview
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.2.1

  • Overview
    • What is ODC?
    • Features
    • Architecture
    • Limitations
    • User interface
  • Quick Start
    • Client ODC
      • Overview
      • Install Client ODC
      • Use Client ODC
    • Web ODC
      • Overview
      • Use Web ODC
      • Deploy 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
    • Compile and debug PL objects
    • Command-line window
    • Edit and export results
    • Analyze SQL statements
    • Data mocking
    • Database objects
      • Table objects
        • Overview
        • Create a table
        • Table list
        • Manage table attributes
        • Manage table data
      • View objects
        • Overview
        • Create a view
        • Manage 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 schema and data
    • Export schema and data
  • Database Change Management
    • User Permission Management
      • Users and roles
      • Automatic authorization
    • Collaborative project management
    • Risk levels, risk identification rules, and approval processes
    • SQL check specifications
    • Manage database changes
    • SQL window specification
    • Change lock-free structures
    • Synchronize shadow tables
  • Data Lifecycle Management
    • Archive data
    • Clean up data
    • Manage partitions
    • SQL plan task
  • Data Desensitization and Auditing
    • Data desensitization
    • Operation audit
  • System Integration
    • SSO integration
    • Approval integration
    • SQL approval integration
  • Deployment Guide
    • Deployment overview
    • Preparations before deployment
    • Deploy ODC in single-node mode
    • Load and run an ODC image
    • Deployment verification
  • Upgrade Guide
    • Upgrade Overview
    • Preparations before upgrade
    • Upgrade single-node ODC
    • Update high-avaliability ODC
    • Upgrade verification
    • Rollback after upgrade failed
  • 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
    • Common Troubleshooting
      • Deployment Upgrade
        • Web ODC cannot be accessed after startup
      • Database Connection
        • Access denied in a connection trial or test
        • Connection is refused in a connection trial or test
        • Connection times out
        • `Connection reset` is reported for a time-consuming statement
        • `socket write error` or `closed by server` is reported for a connection
      • SQL Execution
        • Disconnection during SQL execution
        • `Over tenant memory limits` is reported during SQL execution
        • `Unknown thread id` is returned during SQL execution
        • `timeout` errors returned during SQL execution
        • `OutOfMemoryError` is returned during SQL execution
        • Incomplete result columns for the SELECT statement
        • Garbled Chinese characters in the SQL execution result set
        • Garbled Chinese data is returned for query of data in GBK encoding
      • PL Object
        • Debugging is not supported for invalid PL objects
        • `JSONException` is reported during PL debugging
        • Garbled variable values in debugging
        • Failed to view PL objects or garbled characters are returned
        • PL objects cannot be executed or an execution error is returned
        • ODC issues during PL debugging
        • PL anonymous block cannot be debugged
        • Alert information of a PL object is unavailable
      • Import and Export
        • Garbled Chinese characters in an imported file in GBK encoding
        • Invalid ZIP package reported during file import
        • Time-type data exported from an Oracle tenant cannot be imported
        • Mismatched columns reported during the import of a single-table CSV file
        • Failed to export a result set in ODC to an Excel file
        • Incorrect display in Excel for a result set exported in CSV format
        • Incomplete data in batch export of multiple tables
        • `javax.crypto.BadPaddingException: Given final block not properly padded` is returned for a data import or export failure
      • Client ODC Problems
        • Client ODC startup failure / H2 Database corruption: Chuck not found
        • Garbled Chinese characters in the command-line window of ODC
        • Failed to install client ODC
        • Client ODC startup failure or no response
        • `Not a valid secret key` is returned for connection creation in client ODC
        • `User does not exist` returned for connection creation in client ODC
        • High memory usage of client ODC
        • Client ODC fails to be installed or start due to a port conflict
      • Front-end Page Exception
        • JavaScript exception is thrown on the ODC page
        • No response in browser after opening ODC
        • White screen in ODC
      • Account Password Problem
        • Forgot the admin account password in ODC V3.2.0 or later
        • Forgot an account password in ODC V2.4.1 to V3.1.3
        • Forgot an account password in ODC V2.4.0 or earlier
    • FAQ
      • Installation of client ODC
      • Web ODC deployment and startup
      • Connection information
      • Command-line window
      • DDL statement display
  • Release Note
    • 90.odc-rn-4.2
      • ODC V4.2.1
      • ODC V4.2.0
    • V4.1
      • 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

What is ODC? Features Architecture Limitations User interface Overview Install Client ODC Use Client ODC Overview Use Web ODC Deploy Web ODC Create a data source Data sources and project collaboration Session management Global variable management Recycle bin management Edit and execute SQL statements Compile and debug PL objects Command-line window Edit and export results Analyze SQL statements Data mocking Import schema and data Export schema and data Users and roles Automatic authorization Collaborative project management Risk levels, risk identification rules, and approval processes SQL check specifications Manage database changes SQL window specification Change lock-free structures Synchronize shadow tables Archive data Clean up data Manage partitions SQL plan task Data desensitization Operation audit SSO integration Approval integration SQL approval integration Deployment overviewPreparations before deployment Deploy ODC in single-node modeLoad and run an ODC image Deployment verification Upgrade OverviewPreparations before upgrade Upgrade single-node ODC Update high-avaliability ODCUpgrade verification Rollback after upgrade failed ODC troubleshooting process View the runtime environment and version information View web ODC logsView client ODC logsView end-to-end ODC-related logsView ODC MetaDB dataQuery the index status in OceanBase Database V4.xQuery the index status in OceanBase Database V1.4.x to V3.2.xCollect JVM runtime informationUse tcpdump to capture packetsInstallation of client ODCWeb ODC deployment and startupConnection informationCommand-line windowDDL statement display ODC V4.2.1 ODC V4.2.0 ODC V4.1.2 ODC V4.1.1 ODC V4.1.0 ODC V4.0.2 ODC V4.0.0ODC V3.4.0ODC V3.3.3 ODC V3.3.2 ODC V3.3.1 ODC V3.3.0 ODC V3.2.3 ODC V3.2.2 ODC V3.2.1 ODC V3.2.0
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.2.1
iconOceanBase Developer Center
V 4.2.1
  • 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

Limitations

Last Updated:2026-04-13 07:40:37  Updated
share
What is on this page
Environment requirements for deploying Web ODC
Hardware requirements
Software requirements
Product feature limitations
Supported data sources
Database connections
Workspace
Data import and export
Database objects
Data archiving
Automatic generation of SQL statements for rollback
Dynamic desensitization
SSO integration

folded

share

This topic describes the environment requirements for deploying OceanBase Developer Center (ODC) and the limitations on each feature module.

Environment requirements for deploying Web ODC

Hardware requirements

ODC supports single-node deployment and multi-node high availability deployment. The following table lists the minimum hardware requirements for a single ODC node.

Hardware Requirement
CPU X86 or ARM architecture, 64-bit processor with two or more cores
Memory 4 GB or higher

Note

  • To achieve high availability for Web ODC, you must deploy Web ODC on multiple nodes. For more information, see Deploy ODC in high availability mode.
  • To enable the lightweight deployment, ODC uses a container image. Make sure that Docker is installed on the server so that you can pull and run the image.

Software requirements

Operating system requirements

The following table lists the operating system requirements for the ODC server.

Operating system Supported versions
Linux
  • CentOS 7.2 and later
  • AliOS 7.2 and later
  • Huawei EulerOS 2.0 SP8

Docker version requirements

Container Supported versions
Docker Docker Engine 20.10 and later

Browser requirements

The following table lists browser versions supported by Web ODC.

Browser Supported versions
Chrome Chrome 76 and later
Firefox Firefox 60 and later
Edge Edge 79 and later

Product feature limitations

Supported data sources

The following table lists the data sources supported by ODC.

Database type Supported versions
OceanBase Database
  • OceanBase Database V1.4.x
  • OceanBase Database V2.0.x
  • OceanBase Database V2.1.x
  • OceanBase Database V2.2.x
  • OceanBase Database V3.1.x
  • OceanBase Database V3.2.x
  • OceanBase Database V4.0.0
  • OceanBase Database V4.1.0
  • OceanBase Database V4.2.0
  • OceanBase Database V4.2.1
  • OceanBase Database Community Edition (PL features not supported)
OB Sharding
  • Sofa ODP 1.15.9 and later
  • ODP 3.2.8 and later

The following table describes the PL features that ODC supports for OceanBase Database of different versions.

Feature Supported versions
Compilation of PL functions, stored procedures, and packages, debugging of PL functions and stored procedures, and debugging of anonymous blocks OceanBase Database V2.2.7x, V3.0.0, and later
Running of anonymous blocks and PL functions, stored procedures, and packages OceanBase Database V2.0.x and later

Database connections

  • Oracle connections are designed to share one session. Whether you commit or roll back a transaction, or trigger a transaction either by creating, modifying, or deleting a database object, or by executing a DDL statement, the transaction takes effect on all windows.

  • In manual-commit mode, make sure to set ob_trx_idle_timeout to a value greater than the timeout value of SQL queries. Otherwise, if two SQL statements in one transaction are executed at an interval longer than the value of ob_trx_idle_timeout, the connection will be terminated. However, if the ob_trx_idle_timeout parameter is set to an excessively large value, the session cannot be released in time, resulting in unnecessary memory consumption. Therefore, you must set this parameter to a proper value.

Workspace

  • The anonymous block window is available only in Oracle mode.

  • The debugging feature is unavailable when you use OBProxy to connect to an instance. Connect to the target instance directly in ODC.

  • You have installed the debugging packages such as DBMS_DEBUG and DBMS_OUTPUT in the connected database.

  • ODC supports debugging of PL objects only for connections to OceanBase Database of V2.2.70, V3.0.00, and later in an x86 environment.

  • In ODC, multiple identical connections share one single session. In ODC V2.3.2 and later, the auto-commit feature is disabled by default in Oracle mode. Therefore, you must manually commit transactions.

Data import and export

  • OceanBase Database V2.2.30 or later supports the following character sets: UTF8, GBK, GB18030, and UTF16. OceanBase Database of a version earlier than V2.2.30 supports only UTF8.

  • In ODC V2.2.0 and later, you can use the import and export feature when the target instance is directly connected to ODC or by using an OBProxy.

  • Web ODC allows you to export at most 2 GB of data (before compression) at a time. To export data of a larger size, use the data export tool OBDUMPER.

  • Web ODC allows you to import files sized at most 2 GB (after compression) at a time. To import data of a larger size, use the data import tool OBLOADER.

  • ODC allows you to run at most three import or export tasks in parallel. Subsequent tasks will wait in the queue.

  • In ODC of a version later than V2.4.1, you can configure the sys tenant account to speed up export and import. If you select objects other than tables and views during export, you must configure the sys tenant account.

Database objects

  • Currently, you cannot modify indexes that are already created in a table.

  • You can create sequence and package objects only in Oracle mode.

  • To view partition information, you must log on as the SYS user that has the read permission on partition information. Therefore, you must configure the SYS user in Advanced Configuration when you create the connection.

Data archiving

  • A cluster instance (specified by the cluster name) must be configured for a data source.

  • A data source must be connected through a proxy. Direct connection is not supported.

  • The sys tenant must be configured in a public cloud environment other than Alibaba Cloud.

  • OceanBase Database V4.1.0 does not support data archiving.

  • Data archiving is supported only for OceanBase Database in MySQL mode.

  • Only tables with a primary key can be archived.

  • Data of the BIT, ENUM, or SET type cannot be archived.

  • Data archiving is not supported if the filter condition contains the LIMIT clause.

  • Tables with a foreign key cannot be archived.

Automatic generation of SQL statements for rollback

  • SQL statements for rollback can be generated only for UPDATE and DELETE operations.

  • In MySQL mode of OceanBase Database, no SQL statement for rollback can be generated for an UPDATE or DELETE operation performed on a table without a primary key or unique key.

  • No SQL statement for rollback can be generated for a change operation performed on a table with LOB fields.

  • If more than 1 million rows are affected in a database change task that requires a backup rollback plan, the plan will fail to be generated.

  • The size of a backup rollback plan file cannot exceed 256 MB, which is same as the maximum size of an SQL script that can be uploaded for a database change task.

  • For OceanBase Database in Oracle mode, ODC cannot execute the DELETE statement that is generated when the UPDATE statement is executed and the fields in the UPDATE SET and WHERE fields are the same.

Dynamic desensitization

  • Groovy supports only the Objects and String classes in Java.

  • Groovy closures and inherent closure functions are not supported.

SSO integration

  • Only the authorization-code mode is supported.

  • After a user logs off, only the logon state in ODC is cleared. The logon state in the single sign-on (SSO) system is not cleared.

  • The name of a mapped column must be of the String type.

Previous topic

Architecture
Last

Next topic

User interface
Next
What is on this page
Environment requirements for deploying Web ODC
Hardware requirements
Software requirements
Product feature limitations
Supported data sources
Database connections
Workspace
Data import and export
Database objects
Data archiving
Automatic generation of SQL statements for rollback
Dynamic desensitization
SSO integration