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 Binlog Service

V4.2.0
  • Overview
  • Compatibility
  • Deployment guide
  • Configuration Information
    • Metadata
    • Local configurations
  • Control Commands
    • Overview
    • Node management
    • Task management
    • Instance management
    • Session management
    • File management
  • Monitoring and alerting
  • Troubleshooting
  • User Manual
    • Install obcdc
    • Update and upgrade
    • Performance tuning
  • Release Notes
    • Release notes
    • obbinlog V4.2.4
    • obbinlog V4.2.3
    • obbinlog V4.2.1
    • obbinlog V4.2.0
    • obbinlog Community Edition V4.0.1

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Binlog Service
  3. V4.2.0

Update and upgrade

Last Updated:2026-09-03 10:36:34

Upgrade the binlog service
Rotating-upgrade binlog instances
Update the configurations of an existing binlog instance

Upgrade the binlog service

You can run the env/deploy.sh script to upgrade obbinlog. To do so, perform the following steps:

Note

This topic uses the upgrade of binlog service Community Edition as an example. To upgrade binlog service Enterprise Edition, contact OceanBase Technical Support to obtain the obbinlog installation package of the target version, and then follow the steps below.

  1. Download the obbinlog RPM package of the target version and decompress it. This operation does not directly install obbinlog.

    wget https://mirrors.aliyun.com/oceanbase/community/stable/el/7/x86_64/obbinlog-ce-4.2.0-100000152024122710.el7.x86_64.rpm
    rpm2cpio obbinlog-ce-4.2.0-100000152024122710.el7.x86_64.rpm | cpio -idv
    

    The decompressed RPM package is stored in the ./home/ds/oblogproxy directory.

  2. Stop the binlog server.

    Notice

    This operation stops the current node from receiving new client requests, but does not affect the running binlog instances or the clients that are consuming binlogs.

    cd /home/ds/oblogproxy
    ./run.sh stop
    
  3. Use the ./home/ds/oblogproxy/env/deploy.sh script in the new package to update the original package.

    cd ./home/ds/oblogproxy/env
    sh deploy.sh -m upgrade -d /home/ds/oblogproxy
    

    In this example, the -d parameter specifies the original installation path of obbinlog. Modify it based on the actual installation path.

  4. Start the binlog server.

    cd /home/ds/oblogproxy
    ./run.sh start
    

    The upgrade of a binlog server node is completed.

Note

After all the binlog server nodes in the cluster are upgraded, binlog instances created or started later will use the new obbinlog package. For information about how to upgrade the existing binlog instances, see the Rotating-upgrade binlog instances section in this topic.

Rotating-upgrade binlog instances

You can upgrade binlog instances of a binlog task in rotating mode to reduce impact on your business.

If your binlog task involves multiple binlog instances, perform the following steps:

  1. Run the SHOW BINLOG STATUS command to query the primary binlog instance of the current binlog task. For more information about the command, see Task management.

  2. Run the SHOW BINLOG INSTANCES command to query all binlog instances of the current binlog task. For more information about the command, see Instance management.

  3. Upgrade the nodes where the binlog instances other than the primary one reside. For more information, see the Upgrade the binlog service section in this topic.

  4. Run the STOP BINLOG INSTANCE and START BINLOG INSTANCE commands to restart the binlog instances on the upgraded nodes. For more information about the commands, see Instance management.

  5. Run the SWITCH MASTER INSTANCE command to switch an upgraded binlog instance to be the primary instance of the current tenant. For more information about the command, see Instance management.

  6. Upgrade the nodes where the remaining binlog instances reside, and restart the binlog instances. For more information, see the Upgrade the binlog service section in this topic.

If your binlog task involves only one binlog instance, perform the following steps:

  1. Upgrade the node where the binlog instance resides. For more information, see Upgrade the binlog service section in this topic.

  2. Run the CREATE BINLOG INSTANCE command to create a binlog instance. For more information about the command, see Instance management.

  3. Run the SWITCH MASTER INSTANCE command to switch the new binlog instance to be the primary instance of the current tenant. For more information about the command, see Instance management.

  4. If you want to retain only one binlog instance, run the DROP BINLOG INSTANCE command to drop the old one. For more information about the command, see Instance management.

Update the configurations of an existing binlog instance

After a binlog instance is created, most of its configurations cannot be modified. If you want to update its configurations, you must rebuild it.

To reduce impact on your business, you can progressively rebuild the binlog instance by using control commands. For more information about the commands, see Instance management.

  1. Run the CREATE BINLOG INSTANCE command to create a binlog instance.

  2. Run the SWITCH MASTER INSTANCE command to switch the new binlog instance to be the primary instance of the current tenant.

  3. Run the DROP BINLOG INSTANCE command to drop the old binlog instance.

Previous topic

Install obcdc
Last

Next topic

Performance tuning
Next
on this page
Upgrade the binlog service
Rotating-upgrade binlog instances
Update the configurations of an existing binlog instance