Metadata|V4.2.5| docs|Distributed Database

After the binlog service is deployed, the deployment script creates metadata tables in the specified database in the MetaDB. Generally, you only need to modify the config_template table.

Table name	Stored data
binlog_instances	The information about binlog instances.
config_template	The parameters of the binlog service.
instances_gtid_seq	The global transaction ID (GTID) records of binlog instances.
nodes	The nodes where the binlog service resides.
primary_instance	The information about the primary instance of the binlog service.
tasks	The records of operations on binlog instances. Valid values: `0` (create), `1` (delete), `2` (stop), `3` (start), and `4` (restore).
user	The account username and account password for module authentication in the binlog service.

Cluster parameters

The config_template table stores the following parameters of the current binlog cluster.

Note

For parameters whose values are inconsistent in config_template and conf/conf.json, the values in config_template prevail.
For attributes of the Boolean type in the following table, the value 0 indicates false and the value 1 indicates true.

Attribute	Default value	Description
binlog_expire_logs_seconds	259200	The validity period of binlog files. Unit: seconds.
binlog_expire_logs_size	53687091200	The size of binlog files that triggers purging. Unit: bytes.
auto_start_obcdc	1	Specifies whether to automatically start obcdc for log pulling after the binlog instance is started.
active_state_after_boot	0	Specifies whether the binlog instance is active to provide services after it is started.
failover	1	Specifies whether to enable fault recovery for the binlog instance. If this parameter is set to `true`, the binlog instance is automatically recovered after it fails on a normal node.
remote_failover	0	Specifies whether cross-node failover is supported. The cross-node failover feature is jointly controlled by `remote_failover` and `failover`: When `failover` is set to `0`, both local and cross-node failover are disabled. When `failover` is set to `1` and `remote_failover` is set to `0`, local node failover is enabled and cross-node failover is disabled (default behavior). When `failover` is set to `1` and `remote_failover` is set to `1`, both local and cross-node failover are enabled.
binlog_gtid_display	true	Specifies whether to display the GTID information.
binlog_ddl_convert	true	Specifies whether to enable DDL statement conversion. If this parameter is set to `true`, the superset syntax of OceanBase Database is discarded.
binlog_memory_limit	4G	The threshold of memory usage for obcdc, which corresponds to `memory_limit` in obcdc.
binlog_working_mode	storage	The obcdc working mode, which corresponds to the `working_mode` parameter in obcdc.
binlog_recover_backup	true	Specifies whether to enable binlog backup and restore.
gtid_seq_compressed_interval_s	10	The compression interval of the GTID sequence.
gtid_seq_compressed_trx_size	100000	The transaction size in the GTID sequence.
gtid_marking_step_size	100000	The step size for generating GTIDs.
gtid_inspector_s	900	The GTID consistency inspection interval. Unit: seconds.
gtid_memory_cache_seconds	7200	The cache duration for GTIDs in memory. Unit: seconds.
gtid_heartbeat_duration_s	3600	The heartbeat interval for GTIDs. Unit: seconds.
recovery_point_strategy	fast	The restore strategy used when a binlog instance fails over to a different binlog server node.
max\binlog_size	536870912	The maximum size of a single binlog file. Unit: bytes.
binlog_log_heartbeat_interval_times	10	The number of heartbeat events between binlog heartbeat entries. A heartbeat entry is written to the binlog after this many heartbeat events occur.
verbose_record_read	false	Specifies whether to print record reading details.
binlog_ignore_unsupported_event	true	Specifies whether to ignore events that do not support conversion.
binlog_max_event_buffer_bytes	67108864	The buffer size for binlog event conversion.
binlog_convert_timeout_us	10000	The timeout period for binlog conversion. Unit: microseconds.
enable_resource_check	true	Specifies whether to enable resource check.
node_cpu_limit_threshold_percent	80	The threshold of CPU utilization. Unit: percentage.
node_mem_limit_threshold_percent	85	The threshold of memory usage. Unit: percentage.
node_disk_limit_threshold_percent	70	The threshold of disk usage. Unit: percentage.
enable_dumper_interception	false	Specifies whether to enable subscription interception.
max_dumper_num	128	The maximum number of subscriptions for a binlog instance.
default_instance_replicate_num	1	The default number of replicas when a binlog instance is created.
max_task_execution_time_s	600	The maximum execution time of a task. Unit: seconds.
default_defer_drop_sec	0	The latency of an asynchronous delete operation.
binlog_ddl_convert_ignore_unsupported_ddl	true	Specifies whether to ignore DDL statements that do not support conversion.
prometheus_unused_metric_clear_interval_s	900	The interval for purging unused metrics. Unit: seconds.
enable_auth	false	Specifies whether to enable authentication between the OceanBase Binlog Manager (OBM) and the binlog instance.
read_wait_num	20000	The maximum batch size of clog events.
storage_wait_num	20000	The maximum batch size of binlog events.
read_timeout_us	10000	The time to wait before sending a batch of clog events. Unit: microseconds.
storage_timeout_us	10000	The time to wait before sending a batch of binlog events. Unit: microseconds.
binlog_convert_ring_buffer_size	1024	The ring buffer size for the conversion queue. The value of this parameter must be a power of 2.
binlog_convert_thread_size	16	The size of the conversion thread pool. The value of this parameter must be greater than that of `binlog_convert_number_of_concurrences`.
binlog_convert_number_of_concurrences	12	The concurrency for conversion.
binlog_serialize_ring_buffer_size	1024	The ring buffer size for parallel serialization. The value of this parameter must be a power of 2.
binlog_serialize_thread_size	10	The size of the serialization thread pool. The value of this parameter must be greater than that of `binlog_serialize_parallel_size`.
binlog_serialize_parallel_size	8	The concurrency for serialization.
binlog_release_ring_buffer_size	1024	The ring buffer size for binlog event release. The value of this parameter must be a power of 2.
binlog_release_thread_size	4	The size of the release thread pool. The value of this parameter must be greater than that of `binlog_release_parallel_size`.
binlog_release_parallel_size	2	The concurrency for release.
preallocated_memory_bytes	2097152	The memory size preallocated for serializing each batch of binlog events. Unit: bytes.
preallocated_expansion_memory_bytes	8192	The step size for increasing the memory size preallocated for serializing each batch of binlog events. Unit: bytes.
binlog_purge_binlog_threads	2	The number of threads for asynchronously purging binlog files in the thread pool.

You can execute an SQL statement to modify the preceding parameters. For example, you can execute the following statement to disable enable_resource_check:

UPDATE config_template SET value='false' WHERE key_name='enable_resource_check';

After you modify the parameter, restart the binlog server node for the new configurations to take effect.

Restart by using supervisord

In a scenario where the binlog server is started by using the env/deploy.sh deployment script and supervise_start is set to true, the script will install supervisord and use it to start the program. In this case, you can run the following command to restart the binlog server:
```
[admin@test001 oblogproxy]$ supervisorctl restart binlog
```
Restart without using supervisord

In other scenarios, you can run the following commands to restart the binlog server:
```
[admin@test001 oblogproxy]$ sudo ./run.sh stop
[admin@test001 oblogproxy]$ sudo ./run.sh start
```

Note

The preceding operation does not modify the running binlog instances. We recommend that you create a new binlog instance instead of updating an existing one.

References

For more information about the parameters of the conf.json file in the conf/ directory, see Local configurations.
For more information about how to deploy the binlog service, see the Step 2: Configure and start the binlog server section in the Deployment Guide topic.