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.5.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
    • Execution Analysis
    • Generate test data
    • System settings
    • Intelligent SQL development
    • Common features
    • 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
      • External resource objects
        • External resources
        • Create an external resource
        • Manage external resources
  • Database Change Risk Management
    • Project collaborative management
      • Project management
      • Manage databases
      • Manage logical databases
      • Add object storage files
      • Manage project members
      • Desensitize data
      • 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
    • Manage user permissions
      • Users and roles
      • Automatic authorization
      • Apply for project permissions
      • Apply for database permissions
      • Apply table/view permissions
    • Security standards
      • Environment configuration
        • SQL check specifications
        • SQL window specification
      • Risk Management
        • Overview
        • Manage risk identification rules
        • Manage approval processes
      • Desensitization algorithms
      • Operation audit
  • Ticket Management
    • Import schemas and data
    • Export schemas and data
    • 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
  • System Integration
    • Login integration
    • Approval integration
    • SQL approval integration
    • Bastion host integration
    • Integrate with LLMs
  • 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 for 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
  • Release Notes
    • V4.5
      • ODC V4.5.0
    • V4.4
      • ODC V4.4.0
      • ODC V4.4.1
      • ODC V4.4.2
      • ODC V4.4.3
    • 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

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

Installation of client ODC

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

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

Use tcpdump to capture packets
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