Overview|V4.2.5|OceanBase Database| docs|Distributed Database

Parameter	Description
mysql_port	The port number for the SQL service protocol.
rpc_port	The port number for the remote access protocol.
sql_protocol_min_tls_version	The minimum SSL/TLS protocol version for SSL connections.
ssl_client_authentication	Specifies whether to enable the SSL connection feature.
ssl_external_kms_info	Records information required for the SSL feature of OceanBase Database to run. It records related configurations for different SSL usage modes in a JSON string. The JSON string must contain the `ssl_mode` field.
enable_sql_audit	Specifies whether to enable the SQL audit feature.

Parameter	Description
backup_backup_dest	The destination for backup data.
backup_backup_dest_option	Controls parameters related to backup backup.
backup_dest_option	Controls parameters related to backup.
backup_concurrency	The number of concurrent writes to the file system during backup.
backup_dest	The path for baseline backup and log archiving.
backup_log_archive_option	Defines the archiving options for backup logs.
backup_net_limit	The total bandwidth for cluster backup.
backup_recovery_window	The time window for restoring backup data.
backup_region	The Region where backup is executed.
backup_zone	The Zone where backup is executed.
log_archive_batch_buffer_limit	Controls the maximum memory usage for log archiving.
log_archive_checkpoint_interval	The time interval for cold data log archiving checkpoints.
restore_concurrency	The maximum concurrency for restoring tenant data from backup.
ob_storage_s3_url_encode_type	Specifies whether the URL encoding method for S3 requests is compatible with the RFC 3986 standard.

Parameter	Description
enable_cgroup	Controls whether to enable the Cgroup feature on OBServer nodes.

Parameter	Description
cpu_count	Specifies the total number of CPU cores. If you set this parameter to 0, the system automatically detects the number of CPU cores.
server_balance_cpu_mem_tolerance_percent	Specifies the tolerance of CPU and memory resource imbalance in the node load balancing strategy.
server_cpu_quota_max	Specifies the maximum CPU quota that can be used by the system.
server_cpu_quota_min	Specifies the minimum CPU quota that can be used by the system. The system automatically reserves the quota.
token_reserved_percentage	Specifies the percentage of idle tokens reserved for each tenant in CPU scheduling.
workers_per_cpu_quota	Specifies the number of worker threads allocated to each CPU quota.
cpu_reserved	Specifies the number of CPU cores reserved for the system. The remaining CPU cores are exclusively used by OceanBase Database.
sys_cpu_limit_trigger	Specifies the CPU utilization threshold. If the CPU utilization exceeds this threshold, the execution of system background tasks is paused.
system_cpu_quota	Specifies the CPU quota available to the system tenant.
tenant_cpu_variation_per_server	Specifies the allowed deviation in CPU quota scheduling between multiple units of a tenant.

Parameter	Description
enable_dblink	Specifies whether to enable the DBLink feature.

Parameter	Description
weak_read_version_refresh_interval	Specifies the refresh cycle of the weak-consistency read version number, which affects the delay of weak-consistency read data.
large_query_worker_percentage	Specifies the percentage of worker threads reserved for processing large queries.
large_query_threshold	Specifies the threshold for query execution time.
trace_log_slow_query_watermark	Specifies the query execution time threshold. If the query execution time exceeds this threshold, the query is considered a slow query, and the trace log of the slow query is printed to the system log.

Parameter	Description
tablet_meta_table_check_interval	Specifies the interval at which the background thread of the DBA_OB_TABLET_REPLICAS/CDB_OB_TABLET_REPLICAS view performs inspections.
tablet_meta_table_scan_batch_count	Specifies the number of tablets cached in memory by the tablet meta table iterator.
tablet_size	Specifies the size of each tablet during parallel processing (such as major compactions and queries) within a partition.
auto_broadcast_location_cache_rate_limit	Specifies the maximum number of partitions whose location information changes per second that can be broadcast by each OBServer node.
auto_refresh_location_cache_rate_limit	Specifies the maximum number of partitions that can be automatically refreshed per second on each OBServer node.
enable_pg	Specifies whether to enable the partition group feature.
gc_wait_archive	Specifies whether to wait for all logs of a partition to be archived before garbage collecting the partition.
partition_table_check_interval	Specifies the interval at which an OBServer node removes non-existent replicas from a partition table.

Parameter	Description
balancer_log_interval	Specifies the interval at which the threads of disaster recovery tasks print statistical logs.
balancer_task_timeout	Specifies the timeout period for background tasks such as load balancing.
balancer_tolerance_percentage	Specifies the tolerance for disk imbalance between multiple Units within a tenant in the load balancing strategy. If the imbalance is within the range of the mean plus or minus the tolerance, no balancing action is triggered.
server_balance_critical_disk_waterlevel	Specifies the water level for disk space load balancing.
server_balance_disk_tolerance_percent	Specifies the tolerance for disk load imbalance in the node-to-node disk load balancing strategy.
resource_hard_limit	Specifies the over-subscription percentage of CPU resources.
enable_sys_unit_standalone	Specifies whether to enable exclusive node allocation for system tenant Units.
balancer_emergency_percentage	Specifies the unit load threshold. When the unit load exceeds this threshold, replica migration is allowed, even during major compactions.
balancer_timeout_check_interval	Specifies the interval at which the timeout period for background tasks such as load balancing is checked.
data_copy_concurrency	Specifies the maximum number of concurrently executed data migration and replication tasks in the system.
tenant_groups	Specifies the tenant groups used in the load balancing strategy.
unit_balance_resource_weight	Specifies the resource weights used in the unit balancing strategy. Generally, you do not need to manually configure these weights.
resource_soft_limit	Specifies whether to enable unit balancing.
unit_gc_wait_time	Specifies the maximum wait time for unit garbage collection (GC). If the maximum wait time is exceeded, GC is forcibly executed.

Parameter	Description
enable_rereplication	Specifies whether to enable automatic migration and replication of log stream replicas.
ls_meta_table_check_interval	Specifies the interval at which the background inspection thread inspects the DBA_OB_LS_LOCATIONS and CDB_OB_LS_LOCATIONS views.
sys_bkgd_migration_change_member_list_timeout	Specifies the timeout period for changing the Paxos member list during replica migration.
sys_bkgd_migration_retry_num	Specifies the maximum number of retries for replica migration.
balance_blacklist_failure_threshold	Specifies the threshold for the number of consecutive failures of background tasks such as replica migration. If the number of consecutive failures exceeds the threshold, the task is added to the blacklist.
balance_blacklist_retry_interval	Specifies the retry interval for background tasks such as replica migration after they are added to the blacklist.
election_cpu_quota	Specifies the CPU quota allocated to background tasks related to replica election.
election_blacklist_interval	Specifies the interval during which a removed leader cannot be elected again.
enable_auto_leader_switch	Specifies whether to enable automatic leader switching.
enable_smooth_leader_switch	Specifies whether to enable smooth leader switching.
global_index_build_single_replica_timeout	Specifies the timeout period for building a global index on each replica.
get_leader_candidate_rpc_timeout	Specifies the timeout period for internal requests to obtain a leader candidate during automatic leader switching.
migrate_concurrency	Specifies the maximum number of concurrent internal data migrations.
rebuild_replica_data_lag_threshold	Specifies the threshold for the gap between the transaction logs of the standby replica and the leader. If the gap exceeds the threshold, the replica is rebuilt.
server_data_copy_out_concurrency	Specifies the maximum number of concurrent data migrations from a single node.
server_data_copy_in_concurrency	Specifies the maximum number of concurrent data migrations to a single node.
replica_safe_remove_time	Specifies the safe retention period for deleted replicas.

Parameter	Description
bf_cache_miss_count_threshold	Specifies the number of macroblock misses that triggers the creation of a Bloom filter cache.
bf_cache_priority	Specifies the priority of the Bloom filter cache.
cache_wash_threshold	Specifies the capacity threshold that triggers cache cleaning.
fuse_row_cache_priority	Specifies the priority of the fused row cache in the cache system.
user_row_cache_priority	Specifies the priority of the baseline data row cache in the cache system.
autoinc_cache_refresh_interval	Specifies the refresh interval of the auto-increment column cache.
plan_cache_evict_interval	Specifies the eviction interval of the execution plan cache.
index_block_cache_priority	Specifies the priority of the metadata index microblock cache.
opt_tab_stat_cache_priority	Specifies the priority of the statistics cache.
tablet_ls_cache_priority	Specifies the priority of the tablet mapping cache.
user_block_cache_priority	Specifies the priority of the data block cache in the cache system.
index_info_block_cache_priority	Specifies the priority of the block index in the cache system.
index_cache_priority	Specifies the priority of the index in the cache system.
user_tab_col_stat_cache_priority	Specifies the priority of the statistics cache in the cache system.
plan_cache_high_watermark	Specifies the memory threshold occupied by the execution plan cache. If the threshold is exceeded, the cache is automatically evicted.
plan_cache_low_watermark	Specifies the memory threshold occupied by the execution plan cache. If the threshold is exceeded, the cache is automatically evicted.
dtl_buffer_size	Specifies the size of the cache used by the SQL data transmission module.

Parameter	Description
sql_net_thread_count	The number of MySQL cluster I/O threads, that is, the number of `global_sql_nio_server` threads. The default value 0 indicates that the value of this parameter is the same as that of the `net_thread_count` parameter.
auto_leader_switch_interval	The working interval of the background thread for automatic leader switch.
switchover_process_thread_count	The size of the thread pool for primary-standby database switch.

Parameter	Description
syslog_io_bandwidth_limit	The maximum disk I/O bandwidth that system logs can occupy. System logs exceeding this bandwidth will be discarded.
disk_io_thread_count	The number of disk I/O threads. It must be an even number.
net_thread_count	The number of network I/O threads.
high_priority_net_thread_count	The number of high-priority network threads.
data_storage_error_tolerance_time	The maximum tolerated time for the data disk to be in the `ERROR` state.
sys_bkgd_io_high_percentage	The maximum percentage of system background I/O.
sys_bkgd_io_low_percentage	The minimum percentage of system background I/O.
user_iort_up_percentage	The threshold of user disk I/O latency. If the user disk I/O latency exceeds this threshold, system background I/O tasks will be throttled.
ob_esi_rpc_port	The communication port between the obesi process and the observer process.
enable_ob_esi_process	Specifies whether to enable the obesi (External Storage Interface) process.
ob_esi_session_timeout	The timeout period for the obesi process to hold active session resources.
ob_esi_io_concurrency	The number of concurrent I/O operations for the obesi process.
ob_esi_syslog_level	The current log recording level for the obesi process.
ob_esi_max_syslog_file_count	The maximum number of log files that the obesi process can accommodate before recycling log files.
multiblock_read_gap_size	The maximum capacity of a single I/O aggregation read block cache.
multiblock_read_size	The size of I/O aggregation for data reading.

Parameter name	Description
all_server_list	Displays the addresses of all servers in the cluster.
cluster	Sets the name of the OceanBase cluster.
cluster_id	Sets the ID of the OceanBase cluster.
rpc_timeout	Sets the timeout period for internal cluster requests.
all_cluster_list	Displays the list of servers that access the same config_url.
enable_election_group	Specifies whether to enable the election group strategy.
obconfig_url	Sets the URL address of the OBConfig service.
local_ip	The IP address of the machine on which ObServer is installed.
observer_id	The unique identifier assigned to the OBServer node by the RS in the cluster.
min_observer_version	Sets the minimum application version of the OBServer nodes in the cluster.
zone	Sets the name of the zone where the node is located.

Parameter name	Description
enable_ob_ratelimit	Specifies whether to enable rate limiting in cross-region RPC connections.
ob_ratelimit_stat_period	Sets the time interval for OBServer nodes to calculate and update the maximum bandwidth.
sys_bkgd_net_percentage	Sets the percentage of network bandwidth that can be occupied by background system tasks.
devname	Displays the name of the network interface card (NIC) device bound to the service process.

Parameter name	Description
virtual_table_location_cache_expire_time	Specifies the cache expiration time of the location information of a virtual table.
location_cache_refresh_rpc_timeout	Specifies the RPC timeout period for refreshing the `location_cache`.
location_cache_refresh_sql_timeout	Specifies the SQL timeout period for refreshing the `location_cache`.
location_cache_refresh_min_interval	Specifies the minimum interval for refreshing the location cache to prevent excessive refresh requests from causing excessive system pressure.
location_cache_cpu_quota	Specifies the CPU quota for the location cache module.
location_fetch_concurrency	Specifies the maximum number of concurrent refresh requests for a single location cache.
location_refresh_thread_count	Specifies the number of threads for OBServer nodes to fetch partition location information from the Root Service.
enable_auto_refresh_location_cache	Specifies whether to enable the automatic refresh of location cache information.

Parameter name	Description
config_additional_dir	Specifies multiple directories for storing configuration files to ensure redundancy.
data_dir	Specifies the directory for storing data such as SSTables.

Parameter	Description
datafile_disk_percentage	The percentage of the total space of the disk where the data_dir directory is located.
data_disk_usage_limit_percentage	The maximum percentage of the data file that can be written. If this threshold is exceeded, data migration is prohibited.
enable_sql_operator_dump	Specifies whether to allow the intermediate results of SQL processing to be written to disk to release memory.
global_write_halt_residual_memory	The global remaining memory threshold that triggers the suspension of write operations for non-`sys` tenants.
leak_mod_to_check	The name of the module to check for memory leaks. This is an internal debugging feature.
memory_chunk_cache_size	The size of memory blocks cached by the memory allocator.
memory_limit	The total available memory size.
memory_limit_percentage	The percentage of the total available memory size relative to the total memory size.
memory_reserved	The size of memory reserved for the system's underlying modules.
memstore_limit_percentage	The percentage of memory used by the MemStore relative to the total available memory.
system_memory	The memory size allocated to the tenant with tenant ID `500`.
use_large_pages	Manages the use of large pages for database memory.
datafile_maxsize	The maximum size to which disk files can automatically expand.
datafile_next	The increment size for disk file auto-expansion.
storage_meta_cache_priority	Controls the priority of storage Meta Cache in the kvcache.
stack_size	The size of the program function call stack.
enable_asan_for_memory_context	When `ob_asan` is enabled, specifies whether to use ObAsanAllocator as the MemoryContext allocator (default is ObAllocator).

Parameter name	Description
px_task_size	Specifies the amount of data processed by each task of the SQL parallel query engine.
max_px_worker_count	Specifies the maximum number of threads used by the SQL parallel query engine.

Parameter name	Description
bf_cache_miss_count_threshold	Specifies the number of macroblock misses that trigger the creation of a Bloomfilter cache.
bf_cache_priority	Specifies the priority of the Bloom Filter cache.
cache_wash_threshold	Specifies the capacity threshold for triggering cache cleanup.
fuse_row_cache_priority	Specifies the priority of the fused row cache in the cache system.
autoinc_cache_refresh_interval	Specifies the refresh interval for the auto-increment column cache.
index_block_cache_priority	Specifies the priority of the metadata index microblock cache.
tablet_ls_cache_priority	Specifies the priority of the tablet mapping cache.
user_block_cache_priority	Specifies the priority of the data block cache in the cache system.
enable_perf_event	Specifies whether to enable the collection of performance event information.
recyclebin_object_expire_time	Automatically cleans up expired schema objects in the recycle bin.
schema_history_expire_time	Specifies the range of complete metadata history data to be retained, and can also be used to set the retention time for tenants to be lazily deleted.
schema_history_recycle_interval	Specifies the time interval for the system to execute the `schema` multi-version record recycling task.

Parameter	Description
enable_record_trace_log	Specifies whether to record trace logs.
enable_async_syslog	Specifies whether to enable asynchronous system log writing.
enable_syslog_recycle	Specifies whether to record logs generated before the OBServer node starts. This parameter, together with `max_syslog_file_count`, determines whether the recycling logic considers old log files.
enable_syslog_wf	Specifies whether to print system logs of WARN and higher levels to a separate log file.
max_string_print_length	Specifies the maximum length of a single line of system log.
max_syslog_file_count	Specifies the maximum number of log files that can be retained before recycling.
syslog_level	Specifies the system log level.
trace_log_sampling_interval	Specifies the interval at which trace logs are periodically printed.
diag_syslog_per_error_limit	Specifies the maximum number of DIAG system logs allowed per second for each error code. Logs exceeding this threshold will not be printed.
alert_log_level	Specifies the alert log level.
log_storage_warning_trigger_percentage	Specifies the write performance percentage threshold that triggers a log disk failure warning.

Parameter	Description
rootservice_async_task_queue_size	Specifies the size of the internal asynchronous task queue of the Root Service.
rootservice_async_task_thread_count	Specifies the size of the internal asynchronous thread pool of the Root Service.
rootservice_list	Displays the list of machines where the Root Service and its replicas are located.
rootservice_ready_check_interval	Specifies the time interval between the Root Service startup and the check of the cluster status.
rootservice_memory_limit	Specifies the maximum memory capacity limit of the Root Service.
lease_time	Specifies the duration of the heartbeat lease.
server_check_interval	Specifies the time interval for checking the consistency of the Server table.
server_permanent_offline_time	Specifies the threshold for node heartbeat interruption. After the node has been offline for this period, it is considered permanently offline, and the data replicas on this node need to be automatically replenished.
ob_event_history_recycle_interval	Controls the interval for recycling historical events.
enable_rootservice_standalone	Specifies whether to allow the system tenant and RootService to exclusively use the OBServer node.
fast_recovery_concurrency	Controls the number of concurrent fast recovery tasks scheduled by the RootService on the OBServer.
wait_leader_batch_count	Specifies the maximum number of partitions to be switched in each batch by the RootService.

Parameter	Description
rpc_client_authentication_method	Specifies the security authentication method for RPC clients.
rpc_server_authentication_method	Specifies the security authentication method for RPC servers.

Parameter	Description
migration_disable_time	Controls the cooldown period during which new data migration operations are prohibited after a data migration fails due to resource exceptions, such as disk space exhaustion.

Parameter name	Description
sql_login_thread_count	The number of threads for handling SQL login requests.
sql_audit_memory_limit	The maximum memory that can be occupied by SQL audit data.
enable_sys_table_ddl	Specifies whether to allow manual creation of system tables.
internal_sql_execute_timeout	The time interval for system internal DML requests.
enable_ddl	Specifies whether to allow execution of DDL.

Parameter name	Description
log_disk_size	Specifies the size of the redo log disk.
log_disk_percentage	Specifies the percentage of the total space occupied by the redo log on the disk.
ignore_replay_checksum_error	Specifies whether to ignore checksum errors during transaction log replay.
trx_2pc_retry_interval	Specifies the time interval for automatic retries after a two-phase commit fails.
standby_fetch_log_bandwidth_limit	Specifies the maximum bandwidth that can be occupied by the total log synchronization traffic from all servers in the standby tenant cluster to the primary tenant cluster.
log_storage_warning_tolerance_time	Specifies the time from when I/O fails on the log disk to when the disk is marked as bad.
clog_disk_utilization_threshold	Specifies the watermark value for reusing clog or ilog disk space.
clog_expire_days	Specifies the expiration time of clog files. When the last modification time of a clog file exceeds the expiration time, the file is deleted.
clog_cache_priority	Specifies the priority of cache space occupied by transaction logs.
clog_disk_usage_limit_percentage	Specifies the maximum percentage of available disk space for transaction logs.
clog_sync_time_warn_threshold	Specifies the transaction log synchronization time threshold for generating a warning log.
clog_transport_compress_func	Specifies the compression algorithm used for internal transaction log transmission.
enable_one_phase_commit	Specifies whether to enable the one-phase commit optimization feature.
enable_separate_sys_clog	Specifies whether to store system transaction logs separately from user transaction logs.
flush_log_at_trx_commit	Specifies the write strategy for transaction logs during transaction commit.
index_clog_cache_priority	Specifies the priority of transaction log indexes in the cache system.
ilog_index_expire_time	Specifies the maximum time for which an OBServer can provide Ilog files for reading.
trx_force_kill_threshold	Specifies the maximum waiting time for killing a transaction due to freezing or switchover.

Parameter name	Description
trx_try_wait_lock_timeout	Specifies the maximum waiting time for row locks during statement execution.

Parameter	Description
debug_sync_timeout	Enables the Debug Sync debugging switch and sets its timeout.
enable_rich_error_msg	Specifies whether to add server address, time, trace ID, and other debugging information to client messages.

Parameter	Description
enable_tcp_keepalive	Enables or disables the keepalive mechanism for client connections.
tcp_keepidle	Specifies how long, in seconds, the system waits before sending a keepalive probe after a client connection is established and no data is sent.
tcp_keepintvl	Specifies the interval, in seconds, between consecutive keepalive probes for a client connection.
tcp_keepcnt	Specifies the maximum number of retries before closing an inactive client connection.

Parameter name	Description
enable_record_trace_log	Specifies whether to record trace logs.
enable_async_syslog	Specifies whether to enable asynchronous writing of system logs.
enable_syslog_recycle	Specifies whether to record logs generated before the OBServer node starts. This parameter, together with `max_syslog_file_count`, determines whether the recycle logic considers old log files.
enable_syslog_wf	Specifies whether to print system logs of WARN and higher levels to a separate log file.
max_string_print_length	Specifies the maximum length of a single line of system logs.
max_syslog_file_count	Specifies the maximum number of log files that can be retained before recycling.
syslog_level	Specifies the system log level.
trace_log_sampling_interval	Specifies the interval at which trace logs are periodically printed.
diag_syslog_per_error_limit	Specifies the maximum number of DIAG system logs allowed per second per error code. Logs exceeding this threshold will not be printed.
enable_log_archive	Specifies whether to enable log archiving.
system_trace_level	Specifies the log printing level for system trace logs.
enable_record_trace_log	Specifies whether to record trace logs.
enable_syslog_recycle	Specifies whether to record logs generated before the OBServer node starts. This parameter, together with `max_syslog_file_count`, determines whether the recycle logic considers old log files.
enable_syslog_wf	Specifies whether to print system logs of WARN and higher levels to a separate log file.
max_string_print_length	Specifies the maximum length of a single line of system logs.
max_syslog_file_count	Specifies the maximum number of log files that can be retained before recycling.
trace_log_sampling_interval	Specifies the interval at which trace logs are periodically printed.
diag_syslog_per_error_limit	Specifies the maximum number of DIAG system logs allowed per second per error code. Logs exceeding this threshold will not be printed.
alert_log_level	Specifies the level of alert logs.
log_storage_warning_trigger_percentage	The write performance percentage threshold that triggers a log disk fault.

Parameter	Description
default_compress_func	Specifies the default compression algorithm for table data. You can also specify other compression algorithms when you create a table.
default_compress	Specifies the default compression strategy for tables created in Oracle mode.
default_transport_compress_func	Specifies the RPC compression algorithm for the entire cluster.

Parameter	Description
enable_major_freeze	Specifies whether to enable the automatic global freeze feature.
micro_block_merge_verify_level	Specifies the verification level for macroblocks during a major compaction.
row_compaction_update_limit	Specifies the number of modifications that trigger an in-memory row compaction.
enable_global_freeze_trigger	Specifies whether to enable automatic global freeze triggers.
enable_merge_by_turn	Specifies whether to enable the round-robin merge strategy.
enable_manual_merge	Specifies whether to enable manual merges.
global_major_freeze_residual_memory	Specifies the residual memory threshold that triggers a global freeze. That is, a global freeze is triggered when the residual memory is less than this percentage.
minor_deferred_gc_time	Specifies the time interval for delayed SSTable garbage collection after a major compaction.
zone_merge_concurrency	Specifies the maximum number of zones that can be merged concurrently. If the value is 0, the system automatically selects the optimal concurrency based on the deployment.
zone_merge_order	Specifies the order of zone merges. If not specified, the system automatically determines the order.
zone_merge_timeout	Specifies the timeout for a single zone merge.
minor_freeze_times	Specifies the number of minor freezes that trigger a major compaction.
minor_merge_concurrency	Specifies the number of concurrent threads during a minor compaction.
minor_warm_up_duration_time	Specifies the pre-warm time for generating new minor compaction files.
row_purge_thread_count	Specifies the maximum number of working threads for in-memory row compactions.

Parameter	Description
arbitration_degradation_policy	Specifies the automatic degradation strategy.
ob_startup_mode	Specifies the startup mode for an OBServer node. This parameter can be modified only during the first startup.

Parameter	Description
enable_global_background_resource_isolation	Enables global foreground and background resource isolation.
global_background_cpu_quota	Specifies the CPU quota for background tasks when global foreground and background resource isolation is enabled.

Parameter	Description
external_kms_info	Stores some key management information.
tde_method	Sets the method for transparent tablespace encryption.
audit_sys_operations	Specifies whether to track the operations of system users.
audit_trail	Specifies whether to enable database auditing.
audit_log_buffer_size	Controls the buffer size during asynchronous log writing.
audit_log_compression	Sets the compression algorithm for audit logs.
audit_log_enable	Controls whether to enable the audit feature.
audit_log_format	Configures the file format for audit logs.
audit_log_max_size	Controls the maximum size of audit logs on a single OBServer node.
audit_log_path	Configures the output directory for audit logs.
audit_log_prune_seconds	Controls the maximum retention period for audit logs.
audit_log_query_sql	Controls how to record SQL statements in audit records.
audit_log_rotate_on_size	Controls the size of individual audit log files.
audit_log_strategy	Controls the file writing strategy for audit records.
sts_credential	Specifies the credentials for accessing the STS service provided by OCP.
ob_ssl_invited_common_names	Records the list of application identities for the current tenant. The identities are obtained from the `cn` field (common name) of the `subject` in the client certificate during SSL mutual authentication.

Parameter	Description
cpu_quota_concurrency	Sets the maximum number of concurrent connections allowed per CPU quota for the tenant.

Parameter	Description
enable_monotonic_weak_read	Specifies whether to enable monotonic reads.
query_response_time_stats	Specifies whether to enable statistics collection for the `information_schema.QUERY_RESPONSE_TIME` view.
query_response_time_flush	Specifies whether to refresh the `information_schema.QUERY_RESPONSE_TIME` view and re-read `query_response_time_range_base`.
query_response_time_range_base	Specifies the time interval base for statistics collection in the `information_schema.QUERY_RESPONSE_TIME` view.
ob_query_switch_leader_retry_timeout	Specifies the maximum retry time for a failed query, in microseconds (us).

Parameter	Description
enable_ls_leader_balance	Specifies whether to enable automatic leader balancing for log streams.
enable_gts_standalone	Specifies whether to enable the feature that allows a tenant to use a dedicated group of units for GTS services.
balancer_idle_time	Specifies the wake-up interval for background task threads, such as load balancing threads, when they are idle.
enable_rebalance	Specifies whether to enable automatic load balancing.
enable_transfer	Specifies whether to allow transfers within a tenant. If the `enable_rebalance` parameter is disabled, this parameter is invalid.
partition_balance_schedule_interval	Specifies the partition balancing scheduling cycle.

Parameter	Description
replica_parallel_migration_mode	Specifies the mode of the log stream replica parallel migration feature.

Parameter	Description
ls_scale_out_factor	The log stream scaling-out factor, which specifies the number of log streams on each service node.

Parameter	Description
log_restore_concurrency	Specifies the concurrency level for log restore.
log_archive_concurrency	Specifies the concurrency level for log archiving.
backup_data_file_size	Specifies the maximum size of a single data backup file.

Parameter	Description
px_workers_per_cpu_quota	Specifies the ratio of parallel execution worker threads.
ddl_thread_score	Specifies the number of threads used for DDL tasks.
compaction_low_thread_score	Specifies the number of worker threads for low-priority major compactions.
compaction_high_thread_score	Specifies the number of worker threads for high-priority major compactions.
compaction_mid_thread_score	Specifies the number of worker threads for medium-priority major compactions.
ha_high_thread_score	Specifies the number of worker threads for high-priority high-availability threads.
ha_mid_thread_score	Specifies the number of worker threads for medium-priority high-availability threads.
ha_low_thread_score	Specifies the number of worker threads for low-priority high-availability threads.
ob_compaction_schedule_interval	Specifies the interval between compaction schedules.
compaction_dag_cnt_limit	Specifies the maximum number of DAGs in the Compaction DAG queue.
compaction_schedule_tablet_batch_cnt	Specifies the maximum number of partitions to be scheduled in each batch during compaction.
tenant_sql_login_thread_count	Specifies the number of threads for MySQL tenant login, that is, the number of `mysql_queue` threads. The default value of 0 indicates that the value of `unit_min_cpu` is used.
tenant_sql_net_thread_count	Specifies the number of I/O threads for MySQL tenants, that is, the number of `sql_nio_server` threads. The default value of 0 indicates that the value of `unit_min_cpu` is used.

Parameter	Description
io_category_config	Specifies the percentage of I/O requests for each category.

Parameter	Description
enable_sql_extension	Specifies whether to enable the SQL extension feature for a tenant.
compatible	Specifies the compatibility behavior of related features in the tenant. This parameter cannot be set.

Parameter	Description
ob_proxy_readonly_transaction_routing_policy	Specifies whether to route transactions based on read-only statements.

Parameter name	Description
lob_enable_block_cache_threshold	Specifies the threshold for LOB query caching in OUTROW storage.

Parameter name	Description
rpc_memory_limit_percentage	Specifies the maximum percentage of memory that can be used for RPC operations in a tenant.
range_optimizer_max_mem_size	Specifies the maximum memory that can be used by the Query Range module.
query_memory_limit_percentage	Specifies the percentage of memory that can be used by a single SQL statement.

Parameter name	Description
temporary_file_max_disk_size	Specifies the maximum disk space that can be occupied by a single temporary file in a tenant.

Parameter name	Description
kv_ttl_duty_duration	Specifies the duration for triggering the daily scheduled TTL task. The TTL task is triggered once during this period.
kv_ttl_history_recycle_interval	Specifies the duration for retaining the history records of the TTL task.
enable_kv_ttl	Specifies whether to enable the TTL background task. This parameter is effective for periodic TTL tasks, but does not affect user control commands.
ttl_thread_score	Specifies the weight value for the thread time slice used by the TTL task.
kv_group_commit_batch_size	Specifies the size of the batch operation in OBKV group commit.
kv_group_commit_rw_mode	Specifies the mode for group commit operations.

Parameter name	Description
plsql_code_type	Specifies the compilation type for PL/SQL code.
plsql_debug	Specifies whether to compile the code into a debug version.
plsql_optimize_level	Specifies the compilation optimization level.
plsql_v2_compatibility	Specifies whether to enable the disk persistence feature during the DDL phase of stored procedures.

Parameter name	Description
zone_deploy_mode	Specifies the distribution mode of a tenant in each zone.
enable_early_lock_release	Specifies whether to enable the early lock release feature.
workarea_size_policy	Specifies the strategy for manually or automatically adjusting the size of the SQL workarea.
open_cursors	Limits the number of cursors that can be opened simultaneously in a single session.
ob_enable_batched_multi_statement	Specifies whether to enable the grouped execution optimization for batch processing.
job_queue_processes	Specifies the maximum number of tasks that can be run simultaneously for each tenant to prevent resource contention.
default_auto_increment_mode	Specifies the default auto-increment mode for auto-increment columns.
default_enable_extended_rowid	Specifies whether to create tables in Extended ROWID mode.
dump_data_dictionary_to_log_interval	Specifies the interval for persisting the tenant data dictionary.
enable_user_defined_rewrite_rules	Specifies whether to enable the rewrite binding feature.
enable_ps_parameterize	Specifies whether to enable parameterization for PS statements during parsing.

Parameter name	Description
log_disk_utilization_limit_threshold	Specifies the tenant log disk utilization limit threshold. When the log disk usage exceeds the total log disk space multiplied by this value, log writing is no longer allowed.
log_disk_utilization_threshold	Specifies the tenant log disk utilization threshold. When the log disk usage exceeds the total log disk space multiplied by this value, log files are reused.
writing_throttling_maximum_duration	Controls the writing speed by controlling the memory allocation progress. That is, specifies the time required to allocate the remaining MemStore memory after triggering write throttling.
writing_throttling_trigger_percentage	Specifies the threshold for the writing speed.
standby_db_fetch_log_rpc_timeout	Specifies the standby database log fetch RPC timeout, to control the standby database log transmission service to detect that a server in the primary database is unavailable and switch to another server.
log_disk_throttling_percentage	Specifies the percentage of unrecoverable log disk space that triggers log writing throttling.
log_transport_compress_all	Specifies whether to use compression for log transmission.
log_transport_compress_func	Specifies the compressor for log transmission.
clog_max_unconfirmed_log_count	Specifies the maximum number of unconfirmed logs in the transaction module.
clog_persistence_compress_func	Specifies the compression algorithm for transaction log persistence.
enable_clog_persistence_compress	Specifies whether to enable transaction log persistence compression.

Parameter name	Description
enable_lock_priority	Lock priority switch.

Parameter name	Description
log_disk_throttling_maximum_duration	Specifies the maximum available time after triggering log throttling.
ls_gc_delay_time	Specifies the time for delayed deletion of tenant log streams.
standby_db_preferred_upstream_log_region	Specifies the preferred upstream log region for a standby tenant in a physical standby database.
archive_lag_target	Specifies the time for tenant log archiving delay.

Parameter name	Description
connection_control_failed_connections_threshold	Specifies the threshold for failed login attempts.
connection_control_min_connection_delay	Specifies the minimum lock duration after the threshold for failed login attempts is exceeded.
connection_control_max_connection_delay	Specifies the maximum lock duration for failed login attempts. The lock duration does not increase after it reaches this maximum value.

Parameter name	Description
default_progressive_merge_num	Specifies the default number of progressive major compactions for a new table.
major_freeze_duty_time	Specifies the time when major compactions and freezes are triggered.
major_compact_trigger	Specifies the number of major compactions that trigger a global major compaction.
minor_compact_trigger	Specifies the threshold for the number of SSTables that trigger a minor compaction.
undo_retention	Specifies the range of multiversion data to be retained in the system, in seconds. The value controls the recycling of multiversion data during compactions.
merger_check_interval	Specifies the scheduling interval for the major compaction status check thread.
freeze_trigger_percentage	Specifies the memory usage threshold for triggering a global freeze.
max_kept_major_version_number	Specifies the number of major compaction versions to be retained.
merge_stat_sampling_ratio	Specifies the sampling ratio for column statistics during major compactions.
merge_thread_count	Specifies the number of threads for daily major compactions.
merger_completion_percentage	Specifies the percentage threshold for the number of replicas completed in a major compaction. If this threshold is reached, the major compaction is considered complete.
merger_switch_leader_duration_time	Specifies the interval for batch leader switching during daily major compactions.
merger_warm_up_duration_time	Specifies the warm-up duration for new baseline data during major compactions.

Parameter name	Description
arbitration_timeout	Specifies the timeout for triggering automatic downgrade.

Parameter name	Description
ob_deterministic_udf_cache_max_size	Specifies the maximum total memory available for the cache pool of all `deterministic` UDFs during statement execution.

Parameter name	Description
sql_work_area	Specifies the tenant's work area memory.
max_stale_time_for_weak_consistency	Specifies the maximum amount of stale data that can be read in weak-consistency reads.

OceanBase

Customer Stories

Documentation

Overview

Cluster-level parameters

Security

Backup and restore

Cgroup

Load balancing

Background execution threads

I/O

Location cache

Directory path

Others

Root Service

RPC authentication

Data migration

Debugging

TCP

Dump and major compaction

Arbitration service

Resource isolation

Tenant-level parameters

Security

CPU

Background execution threads

I/O

Compatibility

Note

Routing

LOB data

Memory space

Disk space

OBKV

PL

Others

Note

Dump and major compaction

Arbitration service

Unsupported parameters

OceanBase

Customer Stories

Documentation

Overview

Cluster-level parameters

Security

Backup and restore

Cgroup

CPU-related parameters

DBLink-related parameters

Read/write/query-related parameters

Partition-related

Load balancing

Replica-related

Cache-related

Background execution threads

I/O

Cluster-related

Bandwidth-related

Location cache

Directory path

Memory-related

PX related

Others

Log-related

Root Service

RPC authentication

Data migration

SQL-related

Transaction and transaction log related

Lock related

Debugging

TCP

System log-related

Compression-related

Dump and major compaction

Arbitration service

Resource isolation

Tenant-level parameters

Security

CPU

Read/write and query-related

Load balancing-related

Replica-related

Scaling-related

Backup and restore-related

Background execution threads

I/O

Compatibility

Note

Routing

LOB data

Memory space

Disk space

OBKV

PL

Others

Transaction and transaction log related

Lock related

System log related

User login

Note

Dump and major compaction

Arbitration service

Cache-related

Unsupported parameters