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.0
  • Overview
    • What is ODC?
    • Features
    • Architecture
    • Limitations
    • User interface
  • 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 source 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
    • 700.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
    • Data cleanup
    • 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 a single ODC node
      • Deployment process
      • Load and run an ODC image
    • Deploy ODC in high availability mode
      • Deployment process
      • Load and run an ODC image
      • Deploy SSL certificate
      • Deploy the NGINX proxy
      • Configure certificate trust
    • Deployment verification
  • Upgrade Guide
    • Overview
    • Preparations before upgrade
    • Upgrade single-node ODC
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run an ODC image
    • Upgrade high-availability
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run an ODC image
      • Upgrade NGINX image
    • 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.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

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

Installation of client ODC

Last Updated:2026-09-03 09:10:51

How do I download the client ODC installation package?
What items are pre-checked when I install client ODC?
How do I view the logs when the installation or startup of client ODC fails?
Versions later than ODC V3.3.0
ODC V3.3.0 and earlier
What do I do if I fail to install or start client ODC?
What do I do when client ODC fails to be installed or start and prompts that the software package is damaged?
OceanBase Development Center cannot be opened during the installation of ODC on macOS

How do I download the client ODC installation package?

Client ODC supports Windows and macOS. You can download a client ODC installation package in the following way:

  • Method 1: Download the package from the documentation page of ApsaraDB for OceanBase

    Choose Reference Guide > Download Clients and click Download Client ODC. Click the installation package of the desired version.

    1

  • Method 2: Download the package from OceanBase Software Download Center

    Go to OceanBase Download Center and download the installation package of the desired version.

    2

    Note

    You must have an OceanBase account and enabled the allowlist.

What items are pre-checked when I install client ODC?

The following items are checked for the installation of client ODC:

  • Windows operating system (OS) version: Only Windows 7 and later versions are supported.

  • Port: Whether port 8989 is occupied is checked. The port will no longer be checked in ODC V2.3.0 and later versions because dynamic ports are used.

  • Java runtime environment: For ODC versions earlier than V4.1.0, JDK 1.8.0_242 or later is recommended. The installation package of ODC V4.1.0 or later is provided with a JDK installation package. Therefore, you do not need to check the Java runtime environment.

How do I view the logs when the installation or startup of client ODC fails?

Versions later than ODC V3.3.0

You can view the error information in the main.log file. The storage path of the file varies with the OS.

  • Linux: ~/.config/odc/logs

  • macOS: ~/Library/Application Support/Logs/odc/logs

  • Windows: %USERPROFILE%\AppData\Roaming\odc\logs

ODC V3.3.0 and earlier

You can view the error information in the main.log file. The storage path of the file varies with the OS.

  • Linux: ~/.config/odc/logs (client logs); ~/.config/odc/javalog (server logs)

  • macOS: ~/Library/Application Support/Logs/odc/logs (client logs); ~/Library/Application Support/Logs/odc/javalog (server logs)

  • Windows: %USERPROFILE%\AppData\Roaming\odc\logs (client logs); %USERPROFILE%\AppData\Roaming\odc/javalog (server logs)

What do I do if I fail to install or start client ODC?

Run the following command to view the Java runtime environment. JDK 1.8.0_242 or later is required. If the version is earlier than 1.8.0_242, update the JDK and restart the computer before reinstalling or starting ODC.

java -version

What do I do when client ODC fails to be installed or start and prompts that the software package is damaged?

Run the sudo spctl --master-disable command and select any source.

OceanBase Development Center cannot be opened during the installation of ODC on macOS

The macOS does not support direct installation. For more information about how to securely open applications that are not downloaded from the Apple Store, see Securely open applications on macOS.

Previous topic

Forgot an account password in ODC V2.4.0 or earlier
Last

Next topic

Web ODC deployment and startup
Next
on this page
How do I download the client ODC installation package?
What items are pre-checked when I install client ODC?
How do I view the logs when the installation or startup of client ODC fails?
Versions later than ODC V3.3.0
ODC V3.3.0 and earlier
What do I do if I fail to install or start client ODC?
What do I do when client ODC fails to be installed or start and prompts that the software package is damaged?
OceanBase Development Center cannot be opened during the installation of ODC on macOS