This topic describes the commonly used parameters of obcdc. For more information about all parameters, see obcdc parameters.
Parameter |
Feature |
Description |
|---|---|---|
| log_level | Log | Log level, which can be controlled by module. For example:TLOG.FETCHER:DEBUG、TLOG:COMMITTER:ERROR. Supports controlling FETCHER, PARSER, FORMATTER, SEQUENCER, and COMMITTER. A module name must be preceded by aTLOG.Prefix. |
| rootserver_list | Connect to OceanBase | The format for specifying the server information where the rootservice resides during startup is as follows:server_ip:server_rpc_port:server_sql_port. |
| cluster_url | Connect to OceanBase | When OceanBase has a cluster URL, obcdc is used to obtain rootserver information and supports server high availability. |
| cluster_user | Connect to OceanBase | You must configure a user in the sys tenant with read permission on internal tables (OceanBase databases). |
| cluster_password | Connect to OceanBase | The password corresponding to the user in the sys tenant. |
| tenant_endpoint | Connect to the corresponding tenant | The list of servers where the tenants reside. |
| tenant_user | Connect to the corresponding tenant | Tenant username. |
| tenant_password | Connect to the corresponding tenant | The password corresponding to the tenant username mentioned above. |
| config_fpath | Configure Persistence | All configuration information of obcdc is dumped to this file. |
| working_mode | Working Mode | Working Mode: The default is persistent mode. |
| store_service_path | Working Mode | Persistence data storage path: Effective only in persistent mode. Relative path: The data is stored in a relative path under the directory where the process calling obcdc resides. Absolute path: The data is stored in a specified absolute path, for example,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 tables to be synchronized. |
| tablegroup_white_list | Synchronization Granularity | Whitelist of tablegroups to be synchronized. |
| tablegroup_black_list | Synchronization Granularity | Synchronized TableGroup Blocklist. |
| enable_oracle_mode_match_case_sensitive | Synchronization Granularity | The OceanBase-Oracle mode tenant is case-sensitive when matching allowlists and blocklists. |
| cluster_id_black_list | cluster_id | The synchronized cluster ID blocklist. |
| memory_limit | Traffic control | The memory threshold that triggers flow control for obcdc. |
| system_memory_avail_percentage_lower_bound | Traffic control | The minimum threshold for the system's available memory (in percentage). |
| part_trans_task_active_count_upper_bound | Traffic control | Maximum number of active partition transactions. |
| storager_task_count_upper_bound | Traffic control | The flow control threshold for the number of tasks to be persisted by the storager module. |
| part_trans_task_reusable_count_upper_bound | Traffic control | The maximum number of partition transactions to be reused. |
| ready_to_seq_task_upper_bound | Traffic control | Maximum number of pending tasks. |
| partition_count_upper_limit | Partition Management | The maximum number of partitions allowed for synchronization in an obcdc instance is 2 million by default. |
| stream_max_partition_count | Partition Management | The maximum number of partitions that a log stream can carry. The default value is 5,000. When hot partitions exist, reducing this value can effectively improve synchronization efficiency. |
| enable_output_trans_order_by_sql_operation | LogRecord Output | Whether to output the row data within a transaction in the order of SQL execution. |
| sort_trans_participants | LogRecord Output | Sort by distributed transaction participants (combined withenable_output_trans_order_by_sql_operation(You can obtain a stable output order for row data.) |
| enable_output_hidden_primary_key | LogRecord Output | Whether to output the hidden primary key for tables without a primary key. |
| enable_convert_timestamp_to_unix_timestamp | LogRecord Output | Whether to convert the timestamp to a UNIX integer. Default:YYYY-MM-DD HH:MM:SSformat. |
| enable_output_invisible_column | LogRecord Output | Whether to output hidden columns. |
| output_heartbeat_interval_sec | LogRecord Output | Interval for outputting safe point information. |
| timezone | LogRecord Output | Time zone of obcdc: used to set the output time zone when synchronizing data of the timestamp_with_local_timezone type. |