This topic describes the commonly used parameters of obcdc and their descriptions. For more information about all parameters, see obcdc parameters.
Parameter |
Feature |
Default Value |
Value range |
Description |
|---|---|---|---|---|
| log_level | obcdc logs | ALL.*:INFO; PALF.*:WARN; SHARE.SCHEMA:INFO | Not involved | Log level, which can be controlled by module. |
| max_log_file_count | obcdc logs | 40 | [0, +∞) | Maximum number of logs to retain. Each log file size is 256 MB. |
| rootserver_list | Connect to OceanBase Database | | | Not involved | Specify the server information of the root service at startup. The format is as follows:server_ip:server_rpc_port:server_sql_port. |
| cluster_url | Connect to OceanBase Database | | | Not involved | obconfig_url: the entry point for OceanBase cluster RS information. |
| cluster_user | Connect to OceanBase Database | | | Not involved | System tenant username (required)oceanbase(Database Read Permission) |
| cluster_password | Connect to OceanBase Database | | | Not involved | Password for the system tenant username |
| tenant_endpoint | Connect to OceanBase Database | | | Not involved | The server information of the general tenant, in the format ofsvr_ip:sql_port |
| tenant_user | Connect to OceanBase Database | | | Not involved | Tenant User (with Read Permission on System Tables) |
| tenant_password | Connect to OceanBase Database | | | Not involved | Tenant User Password |
| rs_sql_connect_timeout_sec | Connect to OceanBase Database | 40 | [0, +∞) | Connection Timeout Period for RS Machines (System Tenant) (Used by Online Schema Mode for User Schema Acquisition) |
| rs_sql_query_timeout_sec | Connect to OceanBase Database | 30 | [0, +∞) | SQL Request Timeout Period for RS |
| tenant_sql_connect_timeout_sec | Connect to OceanBase Database | 40 | [0, +∞) | Connection Timeout Period for Machines of Ordinary Tenants |
| tenant_sql_query_timeout_sec | Connect to OceanBase Database | 30 | [0, +∞) | SQL Request Timeout Period for User Tenants |
| fetch_log_rpc_timeout_sec | Log Pull | 15 | [0, +∞) | Log Pull Timeout Period |
| cluster_id_black_list | Data filtering | | | Not involved | See Alsoob_org_cluster_idThe value of this parameter is configured. For more information about ob_org_cluster_id, see ob_org_cluster_id |
| tb_white_list | Data filtering | *.*.* | Not involved | Set the table allowlist (Tenant.DB.TB. In tenant mode, specify the tenant to be synchronized). |
| tb_black_list | Data filtering | | | Not involved | Set Table Blocklist |
| working_mode | Operating Mode | storage | {storage, memory} | In storage mode, REDO logs are persisted locally using RocksDB and are cleared upon restart. |
| fetching_log_mode | Operating Mode | integrated | {integrated, direct} | Log Pull Mode. Integrated: Logs are pulled from OBServer nodes via RPC. Direct: Archived files are read directly. |
| archive_dest | Operating Mode | | | Not involved | Whenfetching_log_modeConfigure asdirectThis parameter takes effect only in the OceanBase Database mode and is used to provide the archiving path information of the OceanBase tenant for obcdc (the access key is required in the OSS mode). |
| meta_data_refresh_mode | Operating Mode | online | {online, data_dict} | Metadata source. Online mode indicates that the schema is built by reading internal tables via SQL. Data_dict mode indicates that the schema is built from the data dictionary in logs. When using obcdc to synchronize data from OceanBase Database V4.2 or later, user configurations are ignored and data_dict mode is forcibly used. To use online mode, you need to modify the configuration file.skip_ob_version_compat_checkThe parameter is set to1 |
| skip_ob_version_compat_check | Operating Mode/Version Compatibility | 0 | {0, 1} | Controls whether to ignore version checks. Valid values:1indicates to ignore the version check. This setting is required in scenarios where data from a higher version needs to be synchronized.1(Not recommended) |
| pause_redo_dispatch_task_count_threshold | Traffic control | 80 | [0, 100] | Sets the ratio of the number of tasks to the corresponding queue length for the USER_QUEUE or RESOURCE_COLLECTOR module. When this ratio reaches the set value, it triggers the issuance of REDO log throttling. |
| part_trans_task_active_count_upper_bound | Traffic control | 0 | [0, +∞) | The maximum number of participant transactions expected to be allocated. Value range:0indicates that the OBDC driver automatically adjusts the parameter. In some scenarios, manual modification may be required. It is one of the flow control parameters and is related tomemory_limit(For the obcdc parameter.) Similar to the above, there is no strict limit. Otherwise, the obcdc synchronization will get stuck. |
| part_trans_task_reusable_count_upper_bound | Traffic control | 0 | [0, +∞) | The maximum number of participant transactions expected to be reusable (that is, processed by obcdc and awaiting consumption or recycling). Value range:0indicates that the obcdc driver automatically adjusts the parameters. In some scenarios, manual modification may be required. It is one of the flow control parameters, along withmemory_limit(For the obcdc parameter.) Similar. There is no strict limit. Otherwise, the obcdc synchronization will get stuck. |
| part_trans_task_prealloc_page_count | Traffic control | 20000 | [0, +∞) | The maximum number of participant transactions that can be cached. Increasing this value may lead to higher memory usage by OBDC during idle periods. |
| data_start_schema_version | LogRecord Output | | | Not involved | Specify the schema version to build the schema within obcdc in the format tenant_id:schema_version. Separate multiple tenants with |. |
| timezone | LogRecord Output | +8:00 | Time Offset | This parameter specifies the local time zone for processing time data written in the local time zone. It must match the local time zone of the OBServer node. When a time zone is specified in the writing session for some data, to ensure that the output of obcdc matches the data written by the user, set this parameter to the time zone specified in the session. |
| timezone_info_fpath | LogRecord Output | etc/timezone_info.conf |
Not involved | Path of the timezone file |
| enable_hbase_mode | LogRecord Output | 0 | {0, 1} | This parameter is required when tables to be synchronized include tables in HBase-compatible mode. |
| enable_compatible_charset | LogRecord Output | 0 | {0, 1} | Whether the output charset is compatible with DRC |
| enable_convert_timestamp_to_unix_timestamp | LogRecord Output | 0 | {0, 1} | Controls whether to convert timestamps to Unix timestamps. This parameter takes effect in MySQL-compatible mode. |
| enable_oracle_mode_match_case_sensitive | LogRecord Output | 0 | {0, 1} | Whether to support case-sensitive matching for the allowlist and blocklist of tenants in Oracle-compatible mode |
| enable_output_by_table_def | LogRecord Output | 0 | {0, 1} | Controls whether to output columns in the user-defined column order. |
| enable_output_hidden_primary_key | LogRecord Output | 0 | {0, 1} | Control whether to output hidden primary keys |
| enable_output_invisible_column | LogRecord Output | 0 | {0, 1} | Controls whether to output invisible columns |