The Binlog service collects transaction logs from OceanBase Database and converts them into MySQL binlogs. It is primarily used for real-time data subscription scenarios. For more information about the Binlog service, see the OceanBase Binlog service documentation on the official website.
You can use the -h/--help option in each command to view the help information. Similarly, you can use the -v/--verbose option to view the detailed execution process when a command execution error occurs.
Note
The business tenant mentioned in this topic refers to the tenant in the OceanBase cluster that needs to generate binlog files.
Currently, the
obd binlogcommand is supported only for OceanBase Database V4.2.1 and later. The ODP version must be V4.2.1 or later.The cluster name and deployment name mentioned in this topic are the names obtained by executing the
obd cluster listcommand. If the cluster where the business tenant resides is not managed by obd, you can perform a takeover operation. For more information, see Take over a cluster using obd.
obd binlog create
You can run this command to create a Binlog instance for the specified tenant.
obd binlog create <binlog deploy name> <oceanbase deploy name> <oceanbase tenant> [options]
# example
obd binlog create binlog_1 obdemo ob_mysql --replicate-num=3
The binlog deploy name parameter specifies the deployment name of the Binlog service, the oceanbase deploy name parameter specifies the name of the cluster where the business tenant is located, and the oceanbase tenant parameter specifies the name of the business tenant.
The following table describes the options.
Option |
Required |
Data type |
Default value |
Description |
|---|---|---|---|---|
| --replicate-num | No | int | 1 | Specifies the number of replicas of the Binlog instance of the tenant. When the value is greater than 1, the Binlog service randomly selects one replica as the primary instance. |
| -d/--odp/--obproxy-deployname | No | string | ob_deployname | Specifies the deployment name of the ODP cluster associated with the business tenant. This option is required only when the ODP cluster and the business cluster are not in the same deployment. |
| -p/--cdcro-password | No | string | Empty | Specifies the password of the cdcro user in the sys tenant. This option is required only when the cdcro user is manually created.
NoteIf the |
| --rs/--root-server-list | No | string | Empty | Specifies the list of machines where the Root Service and its replicas are located in the cluster where the business tenant is located. The value is obtained by running the SHOW PARAMETERS LIKE 'rootservice_list'; command. Multiple machines are separated by semicolons (;). The format is observer_ip1:rpc_port:mysql_port;observer_ip2:rpc_port:mysql_port.
NoteThis option is supported only when the deployed obbinlog is of V4.3.5 or later. In the following scenarios, you can omit this option.
|
obd binlog drop
You can run this command to disable all Binlog instances of the specified tenant and delete the generated Binlog files. This command is equivalent to the DROP BINLOG FOR TENANT <cluster>.<tenant>; command in the Binlog service.
obd binlog drop <binlog deploy name> <oceanbase deploy name> <oceanbase tenant> [options]
# example
obd binlog drop binlog_1 obdemo ob_mysql
The binlog deploy name parameter specifies the deployment name of the Binlog service, the oceanbase deploy name parameter specifies the name of the cluster where the business tenant is located, and the oceanbase tenant parameter specifies the name of the business tenant.
obd binlog show
You can run this command to list all Binlog instances. This command is equivalent to the SHOW BINLOG INSTANCES FOR <cluster>.<tenant>; command in the Binlog service.
obd binlog show <deploy name> [options]
# example
obd binlog show binlog_1 -d obdemo -t ob_mysql
The deploy name parameter specifies the deployment name of the Binlog service.
The following table describes the options.
Option |
Required |
Data type |
Default value |
Description |
|---|---|---|---|---|
| -d/--deploy-name | No | string | Empty | The deployment name of the business cluster. |
| -t/-n/--tenant-name | No | string | Empty | The name of the business tenant. |
Note
Both options must be specified or neither can be specified. If only one of the options is specified, an error is returned.
obd binlog start
You can run this command to start all Binlog instances of the specified tenant.
obd binlog start <binlog deploy name> <oceanbase deploy name> <oceanbase tenant> [options]
# example
obd binlog start binlog_1 obdemo ob_mysql
The binlog deploy name parameter specifies the deployment name of the Binlog service, the oceanbase deploy name parameter specifies the name of the cluster where the business tenant is located, and the oceanbase tenant parameter specifies the name of the business tenant.
obd binlog stop
You can run this command to stop all Binlog instances of the specified tenant.
obd binlog stop <binlog deploy name> <oceanbase deploy name> <oceanbase tenant> [options]
# example
obd binlog stop binlog_1 obdemo ob_mysql
The binlog deploy name parameter specifies the deployment name of the Binlog service, the oceanbase deploy name parameter specifies the name of the cluster where the business tenant is located, and the oceanbase tenant parameter specifies the name of the business tenant.