OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Binlog Service

V4.0.1

  • Overview
  • Compatibility
  • Deployment guide
  • Parameters
  • Management Command
    • Overview
    • Node management
    • Task management
    • Instance management
    • Session management
    • File management
  • Install obcdc
  • Monitoring and alerting
  • Troubleshooting
  • Release Notes
    • Release notes
    • obbinlog Community Edition V4.0.1

Download PDF

Overview Compatibility Deployment guide Parameters Overview Node management Task management Instance management Session management File management Install obcdc Monitoring and alerting Troubleshooting Release notes obbinlog Community Edition V4.0.1
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Binlog Service
  3. V4.0.1
iconOceanBase Binlog Service
V 4.0.1
  • V 4.2.5
  • V 4.2.0

Overview

Last Updated:2025-03-21 09:41:05  Updated
share
What is on this page
share

The binlog service provides SQL statements for you to manage binlog tasks, instances, and files.

The management statements of the binlog service must be executed on the binlog server and are categorized as follows:

  • Node management statements: At present, only the SHOW BINLOG SERVER statement is supported for you to query information about the node where the primary binlog instance of the specified tenant resides.
  • Task management statements: These statements are used for managing binlog tasks, such as creating, querying, modifying, and releasing tasks. Tenants and binlog tasks are in one-to-one correspondence. In other words, you can create only one binlog task for each tenant.
  • Instance management statements: These statements are used for managing binlog instances, such as creating, querying, modifying, and starting/stopping instances, and switching the primary instance. Binlog tasks and binlog instances are in one-to-many correspondence. In other words, you can create multiple binlog instances in one binlog task.
  • Session management statements: These statements are used for managing binlog sessions, such as querying and deleting sessions.
  • File management statements: At present, only the PURGE BINARY LOGS statement is supported for you to purge binlog files.

The following table describes the management statements provided by the binlog service. Click the name of each statement category to access the relevant documentation.

Category Statement Description
Node management SHOW BINLOG SERVER Queries information about the node where the primary binlog instance of the specified tenant resides. If no primary binlog instance is available, an error message is returned.
Task management CREATE BINLOG Enables the binlog service for the specified OceanBase Database tenant. Then, the binlog server will asynchronously create N binlog instances for the tenant.
SHOW BINLOG STATUS Queries the binlog files and resource metrics of the primary binlog instance in a binlog task. If the primary binlog instance is unavailable, an empty result set is returned.
ALTER BINLOG Modifies the parameter settings for all binlog instances of the specified tenant. The new settings also take effect for binlog instances created later.
DROP BINLOG Stops all binlog instances of the specified tenant and drops generated binlog files.
Instance management CREATE BINLOG INSTANCE Creates a binlog instance for a tenant with the binlog service enabled.
SHOW BINLOG INSTANCES Queries information about one or more binlog instances. If no record meeting the specified conditions exists, an empty result set is returned.
ALTER BINLOG INSTANCE Modifies the parameter settings of the specified binlog instance.
STOP BINLOG INSTANCE Stops the specified binlog instance.
START BINLOG INSTANCE Starts the specified binlog instance.
SWITCH MASTER INSTANCE Switches the primary binlog instance of the specified tenant.
DROP BINLOG INSTANCE Drops the specified binlog instance, as well as its binlog files.
Session management SHOW [FULL] PROCESSLIST Queries the connection sessions on the specified binlog instance.
KILL Terminates a connection session on the specified binlog instance.
File management PURGE BINARY LOGS Purges specified binlog files.

Previous topic

Parameters
Last

Next topic

Node management
Next