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.3.6
  • 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
    • Version history
    • obbinlog V4.3.6
    • obbinlog V4.3.5
    • obbinlog V4.3.2
    • obbinlog V4.3.1
    • obbinlog V4.3.0
    • obbinlog V4.2.10
    • obbinlog V4.2.5
    • 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.3.6

Update and upgrade

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

Upgrade Binlog service
Rotational upgrade of Binlog task
Update the configuration of an existing Binlog task

Upgrade Binlog service

You can use the installation deployment script env/deploy.sh to upgrade obbinlog. The operation is as follows:

Note

This example describes how to upgrade the Community Edition Binlog service. If you want to upgrade the Enterprise Edition Binlog service, you need to contact OceanBase Technical Support to obtain the new version of obbinlog and then execute the rpm2cpio command and subsequent operations as described below.

  1. Download and decompress the new version of the obbinlog RPM package. Note that you do not install it directly.

    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
    

    After the execution is complete, the new version of the RPM package will be decompressed to the ./home/ds/oblogproxy directory in the current directory.

  2. Stop the Binlog Server.

    Notice

    This operation will temporarily prevent the node from receiving new client requests, but will not affect the running Binlog instances and clients consuming Binlog logs.

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

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

    In the above operation, the -d parameter specifies the installation directory of the old version of obbinlog. If you deployed it in a different directory, please modify it accordingly.

  4. Start the Binlog Server.

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

    At this point, the Binlog Server node has been updated.

Note

After the Binlog cluster nodes are upgraded, new or started Binlog instances will use the new version of the obbinlog program package. If you want to upgrade existing Binlog instances, please refer to Rotational upgrade of Binlog task for the operation.

Rotational upgrade of Binlog task

You can reduce the impact of the Binlog task upgrade on your business by rotating the upgrade of the Binlog instances.

If your Binlog task has multiple Binlog instance replicas, you can follow the steps below:

  1. Use the SHOW BINLOG STATUS command to determine the primary Binlog instance of the current Binlog task. For more information about this command, see Task management.

  2. Use the SHOW BINLOG INSTANCES command to determine the distribution of all Binlog instances in the current Binlog task. For more information about this command, see Instance management.

  3. Refer to the steps in Upgrade Binlog service to upgrade the nodes hosting the non-primary Binlog instances.

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

  5. Use the SWITCH MASTER INSTANCE command to switch the primary instance of the current tenant to the upgraded Binlog instance. For more information about this command, see Instance management.

  6. Refer to the steps in Upgrade Binlog service to upgrade the remaining Binlog nodes and restart the remaining Binlog instances.

If your Binlog task has only one Binlog instance replica, you can follow the steps below:

  1. Refer to the steps in Upgrade Binlog service to upgrade the Binlog node.

  2. Use the CREATE BINLOG INSTANCE command to create a new Binlog instance. For more information about this command, see Instance management.

  3. Use the SWITCH MASTER INSTANCE command to switch the primary instance of the current tenant to the newly created Binlog instance. For more information about this command, see Instance management.

  4. If you want to retain only one Binlog instance, you can use the DROP BINLOG INSTANCE command to delete the old Binlog instance. For more information about this command, see Instance management.

Update the configuration of an existing Binlog task

After a Binlog instance is created, most configurations cannot be changed. If you need to update the configuration of the Binlog instance, you generally need to rebuild the Binlog instance.

To avoid the rebuilding process from severely impacting production, you can use the relevant management commands in Instance management to gradually rebuild the Binlog task.

  1. Use the CREATE BINLOG INSTANCE command to create a new Binlog instance.

  2. Use the SWITCH MASTER INSTANCE command to switch the primary instance of the current tenant to the newly created Binlog instance.

  3. Use the DROP BINLOG INSTANCE command to delete the old Binlog instance.

Previous topic

Install obcdc
Last

Next topic

Performance tuning
Next
on this page
Upgrade Binlog service
Rotational upgrade of Binlog task
Update the configuration of an existing Binlog task