General obcdc parameters|V4.1.0| docs|Distributed Database

General obcdc parameters

Last Updated：2024-04-19 08:37:43 Updated

This topic describes the commonly used parameters in obcdc. For all parameters, see obcdc parameters.

Parameter	Purpose	Description
log_level	Log	The log level, which can be adjusted based on the module. For example, you can set the log level as `TLOG.FETCHER:DEBUG` and `TLOG:COMMITTER:ERROR`. You can control the log level for the FETCHER, PARSER, FORMATTER, SEQUENCER, and COMMITTER modules. You must add the `TLOG.` prefix to each module.
rootserver_list	Connecting to OceanBase Database	The list of servers where Root Service is running, in the `server_ip:server_rpc_port:server_sql_port` format.
cluster_url	Connecting to OceanBase Database	If OceanBase Database has a cluster URL, obcdc uses this URL to obtain the RootServer information. High availability is supported for servers.
cluster_user	Connecting to OceanBase Database	The user in the sys tenant. This user must have the read privilege on internal tables.
cluster_password	Connecting to OceanBase Database	The password of the preceding user in the sys tenant.
config_fpath	Configuration persistence	All obcdc configuration information will be dumped into this file.
working_mode	The working mode.	The default working mode is the persistence mode.
store_service_path	The working mode.	The path where persistent data is stored. This parameter takes effect only in persistence mode. Relative path: The persistent data is stored in a relative path in the path of the process that calls obcdc. Absolute path: The persistent data is stored in the specified absolute path, such as `store_service_path=/data/1`.
tb_white_list	Synchronization granularity	The allowlist of tables to be synchronized.
tb_black_list	Synchronization granularity	The blocklist of the tables that will not be synchronized.
tablegroup_white_list	Synchronization granularity	The allowlist of table groups to be synchronized.
tablegroup_black_list	Synchronization granularity	The blocklist of table groups that will not be synchronized.
enable_oracle_mode_match_case_sensitive	Synchronization granularity	The case sensitivity of tenants against the blocklist or allowlist in Oracle mode of OceanBase Database.
cluster_id_black_list	cluster_id	The blocklist of cluster IDs for synchronization.
memory_limit	Throttling	The memory threshold for triggering throttling in obcdc.
system_memory_avail_percentage_lower_bound	Throttling	The lower limit of the available system memory, in percentage.
part_trans_task_active_count_upper_bound	Throttling	The maximum number of active partition transactions.
storager_task_count_upper_bound	Throttling	The throttling threshold of the number of tasks to be persisted by the storager module.
part_trans_task_reusable_count_upper_bound	Throttling	The maximum number of partition transactions to reuse.
ready_to_seq_task_upper_bound	Throttling	The maximum number of tasks to be sequenced.
partition_count_upper_limit	Partition management	The maximum number of partitions allowed for synchronization on the obcdc instance. Default value: 2000000.
stream_max_partition_count	Partition management	The maximum number of partitions allowed for a log stream. The default value is 5,000. You can set this parameter to a lower value to significantly improve the synchronization efficiency on hotspot partitions.
enable_output_trans_order_by_sql_operation	LogRecord output	Specifies whether to return data rows in the transaction in the order that the SQL statements are executed.
sort_trans_participants	LogRecord output	Specifies whether to sort statements by the distributed transaction participant. You can maintain a stable row data output sequence by setting this parameter and the `enable_output_trans_order_by_sql_operation` parameter.
enable_output_hidden_primary_key	LogRecord output	Specifies whether to return the hidden primary key columns of tables without primary keys.
enable_convert_timestamp_to_unix_timestamp	LogRecord output	Specifies whether to convert a timestamp to a UNIX integer value. The default format is `YYYY-MM-DD HH:MM:SS`.
enable_output_invisible_column	LogRecord output	Specifies whether to return the hidden columns.
output_heartbeat_interval_sec	LogRecord output	The time interval for generating the information about security timestamps.
timezone	LogRecord output	The time zone of obcdc. The time of the specified time zone is displayed when data of the timestamp_with_local_timezone type is synchronized.