OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Developer Center

V4.2.2
  • 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
    • Write and execute SQL statements
    • Perform PL compilation and debugging
    • Use the command-line window
    • Edit and export the result set of an SQL statement
    • Analyze SQL statements
    • Generate test data
    • 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 schemas and data
    • Export schemas 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
    • SQL window specification
    • Database change management
    • Lock-free schema changes
    • Synchronize shadow tables
  • Data Lifecycle Management
    • Archive data
    • Clean up data
    • Manage partitions
    • SQL plan task
  • Data Desensitization and Auditing
    • Desensitize data
    • Operation audit
  • System Integration
    • SSO integration
    • Approval integration
    • SQL approval integration
  • Deployment Guide
    • Overview
    • Preparations before deployment
    • Deploy ODC on a single node
    • Deploy ODC in high-availability mode
    • Deployment verification
  • Upgrade Guide
    • Overview
    • Preparations before upgrade
    • Upgrade single-node ODC
    • Upgrade high-availability 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
      • FAQ
      • Command-line window
      • DDL statement display
  • Release Note
    • 90.odc-rn-4.2
      • ODC V4.2.2
      • ODC V4.2.0
      • ODC V4.2.1
    • 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

Document Feedback
  1. Documentation Center
  2. OceanBase Developer Center
  3. V4.2.2

Overview

Last Updated:2026-09-03 09:11:03

Deployment types of Web ODC
Deployment process
Single-node deployment process
High-availability deployment process

OceanBase Developer Center (ODC) provides two product forms: Web ODC and Client ODC.

  • Client ODC: an efficient and easy-to-use SQL development tool that applies to personal development scenarios. It supports Windows and MacOS.

  • Web ODC: an integrated database development, management, and collaboration platform that applies to collaborative development scenarios. It provides all-round features such as collaborative development, risk control, and data security. It supports multiple installation media such as an RPM package and a Docker image, and supports the x86 and advanced RISC machine (ARM) architectures. Web ODC includes all SQL development features of Client ODC.

This topic describes the deployment process of Web ODC. Client ODC can be directly installed on your desktop without deployment. For more information, see Install Client ODC.

Deployment types of Web ODC

  • Single-node deployment: ODC is deployed on a single node. All user requests are processed by this node. This deployment type is simple and consumes a few resources.

  • High-availability deployment: ODC is deployed on multiple nodes and the Nginx proxy is deployed on one of the nodes to route user requests. In single-node deployment, user requests are directly sent to ODC. In high-availability deployment, user requests are first sent to the node where the Nginx proxy is deployed and then routed to other nodes.

    The benefits of high-availability deployment are as follows: When one node fails, Nginx will automatically route user requests to other nodes to ensure service continuity. In addition, ODC deployed in high-availability mode can accommodate more concurrent users and more requests than ODC deployed in single-node mode.

Deployment process

Single-node deployment process

To deploy ODC on a single node, load and run the ODC image on the node.

When you log on to Web ODC in a browser over HTTP for the first time, you will receive a message indicating that the connection is not secure. To ensure access security, you can configure an SSL certificate and deploy the Nginx image on the node by referring to the high-availability deployment process.

Note

  • The initial username of the Web ODC administrator is admin. When you deploy Web ODC, you can set the initial password of this administrator account by using the environment variable ODC_ADMIN_INITIAL_PASSWORD. For more information, see Load and run an ODC image.
  • For information about how to log on to Web ODC, see Log on to Web ODC.

High-availability deployment process

To deploy ODC in high-availability mode, load and run the ODC image on multiple nodes and then deploy the Nginx image on one of these nodes to distribute user requests among them.

1

To deploy Web ODC in high-availability mode, perform the following four steps:

  1. Load and run the ODC image: Run the ODC image separately on multiple nodes to install ODC.

  2. Deploy the SSL certificate: When you log on to Web ODC in a browser over HTTP for the first time, you will receive a message indicating that the connection is not secure. To ensure access security, you can deploy an SSL certificate to access ODC over HTTPS. If you do not want to access ODC over HTTPS, you can skip this step and directly deploy the Nginx proxy.

  3. Deploy the Nginx proxy: Pull and run the Nginx image on one of the nodes to implement high-availability deployment.

  4. Configure certificate trust: Some browsers do not trust a self-signed certificate. You need to manually configure certificate trust in the browser.

    Note

    The initial username of the administrator account of Web ODC is admin. When you deploy Web ODC, you can set the initial password of the administrator account by using the environment variable ODC_ADMIN_INITIAL_PASSWORD. For more information, see Load and run an ODC image.

Previous topic

SQL approval integration
Last

Next topic

Preparations before deployment
Next
on this page
Deployment types of Web ODC
Deployment process
Single-node deployment process
High-availability deployment process