Overview of parameters|V4.4.2|OceanBase Database| docs|Distributed Database

This topic lists cluster-level and tenant-level parameters in OceanBase Database.

Cluster-level parameters

Security

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 to the database.
ssl_client_authentication	Whether to enable SSL connections.
ssl_external_kms_info	The information required for the SSL feature of OceanBase Database to run. This parameter records the related configurations required for different SSL usage scenarios in a JSON string. The JSON string must contain the `ssl_mode` field.
enable_sql_audit	Whether to enable the SQL audit feature.
enable_clog_encryption	Whether to enable clog encryption for BKMI and obcloud when data transparent encryption is enabled.

Backup and restore

Parameter	Description
backup_backup_dest	The destination for backing up backup data.
backup_backup_dest_option	Controls backup-related parameters.
backup_dest_option	Controls backup-related parameters.
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 options for archiving 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 operations are performed.
backup_zone	The zone where backup operations are performed.
log_archive_batch_buffer_limit	Controls the maximum memory usage for log archiving on a single node.
log_archive_checkpoint_interval	The interval between checkpoints for cold data log archiving.
restore_concurrency	The maximum concurrency level for restoring tenant data from a backup.

cgroup

Parameter	Description
enable_cgroup	Specifies whether to enable the cgroup feature on the OBServer node.

Parameter name	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 for CPU and memory resource imbalance in the node load balancing strategy.
server_cpu_quota_max	Specifies the maximum CPU quota available to the system.
server_cpu_quota_min	Specifies the minimum CPU quota available to the system. The system automatically reserves the quota.
token_reserved_percentage	Specifies the percentage of idle tokens to be 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 name	Description
weak_read_version_refresh_interval	Specifies the refresh cycle for weak-consistency read versions, which affects the latency 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 execution time of a query exceeds this threshold, it is considered a slow query, and the trace logs of slow queries are printed to the system log.

Load balancing

Parameter	Description
balancer_log_interval	Specifies the interval at which the statistics logs of the disaster recovery task threads are printed.
balancer_task_timeout	Specifies the timeout for background tasks such as load balancing.
balancer_tolerance_percentage	Specifies the tolerance for disk imbalance among multiple units of a tenant in the load balancing strategy. If the disk imbalance is within the range of the mean value plus or minus the tolerance, no load balancing action is triggered.
server_balance_critical_disk_waterlevel	Specifies the water level for disk load balancing.
server_balance_disk_tolerance_percent	Specifies the tolerance for disk imbalance in the load balancing strategy between nodes.
resource_hard_limit	Specifies the overprovisioning 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. If 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 for background tasks such as load balancing is checked.
data_copy_concurrency	Specifies the maximum number of concurrent data migration and copy 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. This parameter is generally not manually configured.
resource_soft_limit	Specifies whether to enable unit balancing.

Parameter	Description
unit_gc_wait_time	Specifies the maximum wait time for unit garbage collection. If the wait time exceeds the specified maximum value, garbage collection is forcibly initiated.
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 thread checks the DBA_OB_LS_LOCATIONS and CDB_OB_LS_LOCATIONS views.
sys_bkgd_migration_change_member_list_timeout	Specifies the timeout for changing the Paxos member group 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 replica is added to the blacklist.
balance_blacklist_retry_interval	Specifies the retry interval after a replica is added to the blacklist.
election_cpu_quota	Specifies the CPU quota allocated to background tasks related to replica election.
election_blacklist_interval	Specifies the time interval during which a demoted leader cannot be elected again.
enable_auto_leader_switch	Specifies whether to enable automatic leader switching.
enable_smooth_leader_switch	The switch for enabling smooth leader switching.
global_index_build_single_replica_timeout	Specifies the timeout for building a global index on each replica.
get_leader_candidate_rpc_timeout	Specifies the timeout for internal requests to obtain leader candidates for 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 those of the leader. If the gap exceeds the threshold, a replica rebuild is triggered.
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 trigger 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 cleanup.
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 usage threshold of the execution plan cache. If the threshold is exceeded, the cache is automatically evicted.
plan_cache_low_watermark	Specifies the memory usage threshold of the execution plan cache. If the threshold is exceeded, the cache is automatically evicted.

Parameter	Description
tablet_meta_table_check_interval	Specifies the interval at which the background inspection thread inspects the DBA_OB_TABLET_REPLICAS/CDB_OB_TABLET_REPLICAS views.
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 compaction and query) in 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 performing partition garbage collection (GC).
partition_table_check_interval	Specifies the interval at which an OBServer node deletes non-existent replicas from a partition table.

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

Parameter	Description
sync_io_thread_count	Specifies the number of threads for synchronous I/O requests.
syslog_io_bandwidth_limit	Specifies the maximum disk I/O bandwidth that can be occupied by system logs. System logs exceeding this bandwidth limit will be discarded.
disk_io_thread_count	Specifies the number of disk I/O threads. The number must be an even number.
net_thread_count	Specifies the number of network I/O threads.
data_storage_error_tolerance_time	Specifies the tolerance time for the data disk status to be set to `ERROR`.
sys_bkgd_io_high_percentage	Specifies the maximum percentage of system background I/O.
sys_bkgd_io_low_percentage	Specifies the minimum percentage of system background I/O.
user_iort_up_percentage	Specifies the threshold for 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	Specifies 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	Specifies the timeout period for the obesi process to hold active session resources.
ob_esi_io_concurrency	Specifies the concurrent I/O count for the obesi process.
ob_esi_syslog_level	Specifies the current log recording level for the obesi process.
ob_esi_max_syslog_file_count	Specifies the maximum number of log files that can be accommodated by the obesi process before log files are recycled.
multiblock_read_gap_size	Specifies the maximum capacity of a single I/O aggregation read block cache.
multiblock_read_size	Specifies the I/O aggregation size for reading data.

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	Sets whether to enable the election group policy.
local_ip	The IP address of the server where the ObServer is installed.
observer_id	The unique identifier assigned to the OBServer node by the RS in the cluster.
min_observer_version	Displays the lowest application version of the OBServer nodes in the cluster.

Parameter name	Description
enable_ob_ratelimit	Enables rate limiting between regions in an RPC connection.
ob_ratelimit_stat_period	Sets the interval for the OBServer node to calculate and update the maximum bandwidth.

Parameter name	Description
virtual_table_location_cache_expire_time	Sets the expiration time for the cache of location information of virtual tables.
location_cache_refresh_rpc_timeout	The timeout period for refreshing `location_cache` through an RPC call.
location_cache_refresh_sql_timeout	The timeout period for refreshing `location_cache` through an SQL statement.
location_cache_refresh_min_interval	Sets the minimum interval for location cache refresh requests to prevent excessive refresh requests from causing excessive system pressure.
location_cache_cpu_quota	Sets the CPU quota for the location cache module.
location_fetch_concurrency	Sets the maximum number of concurrent location_cache refreshes on a single server.
location_refresh_thread_count	Sets the number of threads for the OBServer node to obtain partition location information from the Root Service.
enable_auto_refresh_location_cache	Sets whether to enable the automatic refresh of location cache information.

Directory paths

Parameter	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. The disk where the data_dir directory is located will be initialized by the OceanBase Database system for storing data.
data_disk_usage_limit_percentage	The maximum percentage of space that can be written to data files. 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 pause of write operations for ordinary tenants (`sys` tenants are not affected).
leak_mod_to_check	Used for memory leak checks, it 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 to the total memory size.
memory_reserved	The amount of memory reserved for the KVCache.
memstore_limit_percentage	The percentage of memory used by the MemStore to the total available memory of the tenant.
system_memory	The amount of memory reserved for the tenant with 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 incremental step size for disk file auto-expansion.
storage_meta_cache_priority	The priority of the storage Meta Cache in the KVCache.

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.

Others

Parameter name	Description
builtin_db_data_verify_cycle	Specifies the cycle for data block verification. The unit is days. A value of 0 indicates that no verification is performed.
data_storage_warning_tolerance_time	Specifies the tolerance time for the data disk status to be set to WARNING.
dead_socket_detection_timeout	Specifies the interval for detecting invalid sockets.
migration_disable_time	Specifies the duration to pause data migration when data migration to a node fails due to reasons such as full disks.
datafile_size	Specifies the size of the data file. This parameter is not required.
devname	Specifies the name of the network interface card (NIC) to which the service process is bound.
enable_perf_event	Specifies whether to enable the collection of performance event information.
enable_record_trace_id	Specifies whether to record the trace ID set by the application.
enable_upgrade_mode	Specifies whether to enable upgrade mode. In upgrade mode, some system background features are paused.
enable_ddl	Specifies whether to allow DDL operations.
high_priority_net_thread_count	Specifies the number of high-priority network threads. If the value is `0`, this feature is disabled.
obconfig_url	Specifies the URL of the OBConfig service.
rpc_port	Specifies the port number for remote access.
stack_size	Specifies the size of the program function call stack.
tenant_task_queue_size	The size of the request queue for each tenant.
zone	The name of the zone where the node is located. This parameter is generally not required.
recyclebin_object_expire_time	The time when the system automatically purges expired schema objects in the recycle bin.
default_row_format	The default row format used when creating tables in MySQL-compatible mode.
sys_bkgd_net_percentage	The percentage of network bandwidth that can be occupied by background system tasks.
schema_history_recycle_interval	The time interval for the system to execute `schema` multi-version record recycling tasks.
enable_asan_for_memory_context	When using ob_asan, this parameter specifies whether to allow ObAsanAllocator (default ObAllocator) as the memory context allocator.
ofs_list	The connection URLs of OceanBase File System (OFS) for each zone. OFS is a distributed storage system designed by OceanBase Database. This parameter is mainly used in the OFS deployment mode to allow RootService to access files across zones.
async_ps_cursor_max_count	The maximum number of asynchronous PS cursors in a single node.

Parameter	Description
enable_logservice	Enables or disables the log service.
logservice_access_point	Specifies the access point of the log service.

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 thread pool for internal asynchronous tasks of the Root Service.
rootservice_list	Displays the list of Root Service nodes and their replicas.
rootservice_ready_check_interval	Specifies the time interval between the Root Service and the cluster status check after the Root Service starts.
rootservice_memory_limit	Specifies the maximum memory capacity limit of the Root Service.
lease_time	Specifies the lease time for heartbeats.
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 heartbeat is interrupted for the specified duration, the node is considered permanently offline. Data replicas on permanently offline nodes need to be automatically replenished.
ob_event_history_recycle_interval	Specifies 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	Specifies the number of concurrent fast recovery tasks scheduled by the RootService on the OBServer node.
wait_leader_batch_count	Specifies the maximum number of partitions in each batch of leader transfer commands sent by the RootService.

Parameter	Description
rpc_client_authentication_method	Specifies the security authentication method for an RPC client.
rpc_server_authentication_method	Specifies the security authentication method for an RPC server.

Parameter name	Description
sql_login_thread_count	Specifies the number of threads for processing SQL login requests.
sql_audit_memory_limit	Specifies 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	Specifies the time interval for system internal DML requests.

Parameter	Description
log_disk_size	Specifies the size of the redo log disk.
log_disk_percentage	Specifies the percentage of the total space of the disk occupied by the redo log.
dtl_buffer_size	Specifies the size of the cache used by the SQL data transfer module.
ignore_replay_checksum_error	Specifies whether to ignore checksum errors that occur 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 per second by the total traffic for all servers in the standby tenant cluster to synchronize logs from the primary tenant cluster.
log_storage_warning_tolerance_time	Specifies the time from when log disk I/O fails to when the disk is marked as a bad disk.
clog_disk_utilization_threshold	Specifies the watermark value for reusing the space of the clog or ilog disk.
clog_expire_days	Specifies the expiration time of the clog file. When the last modification time of the clog file exceeds the expiration time, the file is deleted.
clog_cache_priority	Specifies the priority of the transaction log cache.
clog_disk_usage_limit_percentage	Specifies the maximum percentage of the available disk space for transaction logs.
clog_sync_time_warn_threshold	Specifies the threshold for transaction log synchronization time. If the synchronization time exceeds this threshold, a warning log is generated.
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 strategy for writing transaction logs when a transaction is committed.
ignore_replay_checksum_error	Specifies whether to ignore checksum errors that occur during transaction log replay.
index_clog_cache_priority	Specifies the priority of the transaction log index 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 when a transaction is forcibly killed due to freezing or switchover.

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

Debugging

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

TCP

Parameter	Description
enable_tcp_keepalive	Enables or disables the keepalive mechanism for client connections.
tcp_keepidle	Sets the time after which a keepalive probe is sent to a client connection if no data is sent, in seconds.
tcp_keepintvl	Sets the interval between keepalive probes for a client connection, in seconds.
tcp_keepcnt	Sets the maximum number of retries before closing an inactive connection.

External tables

Parameter	Description
external_table_disk_cache_max_percentage	Sets the maximum proportion of datafile_size that can be used for disk caching in SN mode.

Parameter	Description
alert_log_level	Specifies the level of the alert log.
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 enable the option to record old logs before the OBServer node starts. This option is used in conjunction with `max_syslog_file_count` to determine whether to consider old log files in the recycling logic.
enable_syslog_wf	Specifies whether to print system logs of level WARN and above 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 level of system logs.
trace_log_sampling_interval	Specifies the interval at which to periodically print trace log information.
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.
enable_log_archive	Specifies whether to enable the log archiving feature.
system_trace_level	Specifies the log printing level for system trace logs.

Parameter	Description
default_compress_func	Specifies the default compression algorithm for table data. You can also specify a different compression algorithm when creating a table.
default_compress	Specifies the default compression strategy for tables created in Oracle-compatible mode.
tableapi_transport_compress_func	Specifies the compression algorithm used for transmitting query results of OBKV-Table.
default_transport_compress_func	Specifies the RPC compression algorithm for the entire cluster.

Dumps and major compactions

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

Arbitration service

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.

Resource isolation

Parameter	Description
clog_io_isolation_mode	Specifies whether to isolate I/O requests for the clog disk based on whether the clog disk and data disk are independent.
enable_global_background_resource_isolation	Specifies whether to enable global background resource isolation.
global_background_cpu_quota	Specifies the CPU quota for background tasks when global background resource isolation is enabled.

Tenant-level parameters

Security

Parameter name	Description
sts_credential	Specifies the credentials for accessing the STS service provided by OCP.
external_kms_info	Stores key management information.
tde_method	Specifies 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.

Storage

Parameter name	Description
default_table_organization	Specifies the table organization mode for tables created by default.
default_table_merge_engine	Specifies the `merge_engine` for tables created by default in a user tenant.

CPU

Parameter name	Description
cpu_quota_concurrency	Specifies the maximum number of concurrent sessions allowed per CPU quota for a tenant.

Read/Write/Query

Parameter name	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 read the `query_response_time_range_base` parameter.
query_response_time_range_base	Specifies the interval for collecting time parameters in the `information_schema.QUERY_RESPONSE_TIME` view.

Load balancing

Parameter	Description
zone_disk_balance_tolerance_percentage	Specifies the tolerance of the table group disk balancing algorithm for disk imbalance between zones.
enable_ls_leader_balance	Specifies whether to enable automatic load balancing for log stream leaders.
enable_gts_standalone	Specifies whether to enable the GTS service to occupy a dedicated group of units.
balancer_idle_time	The wake-up interval for background task threads, such as the load balancer, when they are idle.
enable_rebalance	Specifies whether to enable automatic load balancing.
enable_transfer	Specifies whether to allow transfer within a tenant. If the `enable_rebalance` parameter is disabled, this parameter is invalid.
partition_balance_schedule_interval	The interval for partition balance scheduling.
enable_database_sharding_none	Specifies whether to enable automatic aggregation when a user table is created in a database.

Replica

Parameter	Description
replica_parallel_migration_mode	Specifies the mode of the parallel migration feature for log stream replicas.
choose_migration_source_policy	Specifies the priority strategy for selecting the source replica during migration.

Scaling

Parameter	Description
ls_scale_out_factor	Specifies the scaling-out factor for log streams, which controls the number of log streams per service node.

Backup and restore

Parameter	Description
recover_table_concurrency	The maximum number of tables that can be restored in parallel in the cross-tenant data import phase of table-level restore.
recover_table_dop	The maximum degree of parallelism (DOP) for restoring a single table in the cross-tenant data import phase of table-level restore.
log_restore_concurrency	The concurrency level for log restore.
log_archive_concurrency	The concurrency level for log archiving.
backup_data_file_size	The maximum size of a single data backup file.

Partitioning

Parameter	Description
enable_auto_split	Specifies whether to enable the automatic partitioning feature for the tenant.
auto_split_tablet_size	Specifies the threshold for triggering automatic partitioning for the tenant.
global_index_auto_split_policy	Specifies whether to enable automatic partitioning for new global indexes. The default value is `DISTRIBUTED`.

Background execution threads

Parameter	Description
px_workers_per_cpu_quota	Specifies the ratio of parallel execution worker threads.
attach_shared_sstable_thread_score	Specifies the number of threads available to the tenant for executing shared data references in shared storage mode.
inc_sstable_upload_thread_score	Specifies the number of threads available to the tenant for executing data sharing tasks in shared storage mode.
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 compactions.
compaction_high_thread_score	Specifies the number of worker threads for high-priority compactions.
compaction_mid_thread_score	Specifies the number of worker threads for medium-priority 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 scheduling.
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 major compaction scheduling.
tenant_sql_login_thread_count	Specifies the number of threads for MySQL-compatible tenant login, i.e., 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-compatible tenants, i.e., the number of `sql_nio_server` threads. The default value of 0 indicates that the value of `unit_min_cpu` is used.

Parameter name	Description
default_storage_cache_policy	Configures the default cache policy.
enable_manual_storage_cache_policy	Enables a user-defined hot cache policy.
suspend_storage_cache_task	Specifies whether to suspend the background cache task.
enable_adaptive_plan_cache	Controls whether to enable the adaptive plan cache feature.
result_cache_max_size	Controls the maximum memory available for the `result cache` module.
result_cache_max_result	Controls the maximum proportion of `result_cache_max_size` that can be used by a single `result cache` cache object.
ob_result_cache_evict_percentage	Specifies the memory evict threshold for `result cache`.
ob_deterministic_udf_cache_max_size	Specifies the maximum memory that can be used for caching all `deterministic` UDFs during statement execution.

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

Note

The parameters in the following table are effective only in MySQL-compatible mode.

| Parameter name | Description |

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

Parameter name	Description
ob_proxy_readonly_transaction_routing_policy	Controls whether Proxy routing of transactions is affected by read-only statements.

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

Parameter name	Description
ob_vector_memory_limit_percentage	Specifies the threshold for memory resource usage by the vector index module (unit: percentage).
range_optimizer_max_mem_size	Limits the memory used by the Query Range module.
rpc_memory_limit_percentage	Specifies the maximum memory for RPC in the tenant, as a percentage of the total memory.
query_memory_limit_percentage	Specifies the percentage of tenant memory available for a single SQL statement.

Parameter	Description
temporary_file_max_disk_size	Specifies the maximum disk space that can be occupied by temporary files on a single node of a tenant.

Parameter	Description
enable_kv_ttl	Controls whether to enable the TTL background task. This parameter applies only to periodic TTL tasks. User control commands are not affected by this parameter.Note: The TTL feature is only applicable to OceanBase Database KV scenarios and is disabled in SQL scenarios to avoid unexpected data deletion.
kv_ttl_duty_duration	Specifies the time period during which the daily scheduled TTL task is triggered.
kv_group_commit_batch_size	Specifies the size of batch operations in OBKV group commit.
kv_group_commit_rw_mode	Controls scenarios where group commit is used.
kv_hbase_client_scanner_timeout_period	Specifies the timeout period for OBKV-HBase streaming queries.
kv_ttl_history_recycle_interval	Specifies the time period for which TTL task history is retained.
ttl_thread_score	Specifies the number of worker threads used for TTL tasks.

Parameter	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	Controls whether to enable the feature of compiling and persisting DDL statements of stored procedures.
package_state_sync_max_size	Controls the maximum length of a package state (package state management) that can be serialized.
ob_enable_java_udf	Controls whether to enable the Java UDF feature.
enable_pl_rich_error_msg	Controls whether to add additional content to exception information in PLSQL.

Parameter name	Description
default_load_mode	Controls the data import method in data import scenarios.
direct_load_allow_fallback	Controls whether to fall back to standard import in direct load scenarios where direct load is not supported.
load_data_diagnosis_log_compression	Specifies the compression algorithm used for diagnostic logs.
load_data_diagnosis_log_max_size	Specifies the size of a single diagnostic log file.

Others

Parameter	Description
schema_history_archive_expire_time	Specifies the retention period of schema history archive data.
schema_history_expire_time	Specifies the expiration time of metadata history data.
zone_deploy_mode	Specifies the distribution mode of the tenant across zones.
enable_early_lock_release	Specifies whether to enable the early row 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_ssl_invited_common_names	Records the list of application identities of the current tenant. The identities are obtained from the `cn` field of the `subject` in the client certificate of the SSL mutual authentication.
ob_enable_batched_multi_statement	Specifies whether to enable the grouped execution optimization of the batch processing feature.
job_queue_processes	Specifies the maximum number of concurrent tasks that can be run on each tenant, to prevent tasks from consuming tenant resources.
default_auto_increment_mode	Specifies the default auto-increment mode for auto-increment columns.
ob_query_switch_leader_retry_timeout	Specifies the maximum retry time for failed queries, in microseconds (us).
default_enable_extended_rowid	Specifies whether to create tables in the Extended ROWID mode.
dump_data_dictionary_to_log_interval	Specifies the interval for persisting the data dictionary of a tenant.
enable_user_defined_rewrite_rules	Specifies whether to enable user-defined rewrite rules.
storage_rowsets_size	Specifies the number of rows to vectorized in one batch for the columnar engine.
approx_count_distinct_precision	Specifies the result precision of the `approx_count_distinct` function.
default_skip_index_level	Specifies the mechanism for generating Skip Indexes in incremental SSTables of a tenant.

Parameter	Description
log_disk_utilization_limit_threshold	Sets the threshold for the utilization of the log disk space of a tenant. When the log disk usage exceeds the total log disk space of the tenant multiplied by this threshold, no more logs can be written.
log_disk_utilization_threshold	Sets the threshold for the utilization of the log disk space of a tenant. When the log disk usage exceeds the total log disk space of the tenant multiplied by this threshold, log files are reused.
writing_throttling_maximum_duration	Controls the write speed by controlling the memory allocation progress. That is, specifies the time required to complete the remaining memory allocation for MemStore after write throttling is triggered.
writing_throttling_trigger_percentage	Sets the threshold for the write speed.
standby_db_fetch_log_rpc_timeout	Sets the RPC timeout for log fetching from the standby database. This parameter is used to control the log transmission service of the standby database to detect that a server in the primary database is unavailable and switch to another server.
log_disk_throttling_percentage	The percentage of unrecoverable log disk space that triggers log write 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	Sets the maximum number of unconfirmed logs in the transaction module.
clog_persistence_compress_func	Sets the compression algorithm for transaction log persistence.
enable_clog_persistence_compress	Specifies whether to enable compression for transaction log persistence.

Parameter	Description
json_document_max_depth	Sets the maximum allowed nesting level in a JSON document.

Parameter	Description
enable_lock_priority	Lock priority switch.

Parameter	Description
external_table_io_hole_size	Sets the maximum distance (in bytes) between two consecutive I/O ranges.
external_table_io_range_size	Sets the maximum size (in bytes) of a merge range.

Parameter	Description
log_disk_throttling_maximum_duration	Adjusts the maximum available time of the log disk after log throttling is triggered.
ls_gc_delay_time	Configures the time for delayed deletion of tenant log streams.
standby_db_preferred_upstream_log_region	Configures the preferred region for synchronizing upstream logs for a standby tenant.
archive_lag_target	Controls the time for tenant log archiving delay.

Materialized views

Parameter	Description
enable_mlog_auto_maintenance	Specifies whether to enable the automatic management feature for materialized view logs.
mlog_trim_interval	Specifies the scheduling cycle for the background automatic trimming task of materialized view logs (mlogs).
enable_mv_binlog_minimal_mode	Specifies whether to enable the `binlog minimal` mode in incremental refresh scenarios of materialized views.

Note

The following parameters are effective only in MySQL-compatible mode.

Parameter	Description
connection_control_failed_connections_threshold	Specifies the threshold for failed login attempts.
connection_control_min_connection_delay	Specifies the minimum duration for locking a user after exceeding the threshold for failed login attempts.
connection_control_max_connection_delay	Specifies the maximum duration for locking a user after exceeding the threshold for failed login attempts. The duration will not increase once it reaches this maximum.

Compression algorithms

Parameter	Description
spill_compression_codec	Specifies the compression algorithm type to compress data during SQL execution.
ob_encoding_granularity	Specifies the maximum number of rows in a microblock for encoding.

Dumps and major compactions

Parameter	Description
mds_minor_compact_trigger	Specifies the number of SSTables that triggers an MDS minor compaction.
mds_compaction_mid_thread_score	Specifies the number of DAG (direct acyclic graph) threads for mid-priority MDS compactions.
mds_compaction_high_thread_score	Specifies the number of DAG (direct acyclic graph) threads for high-priority MDS compactions.
default_progressive_merge_num	Specifies the default number of progressive major compactions for a new table.
major_freeze_duty_time	Specifies the time when daily automatic major compactions and major freezes are triggered.
major_compact_trigger	Specifies the number of major freezes that triggers a major compaction.
minor_compact_trigger	Specifies the threshold for the number of SSTables that triggers a minor compaction.
undo_retention	Specifies the range of data versions to be retained in the system. The unit is seconds. It also specifies the data versions to be recycled during a minor compaction.
merger_check_interval	Specifies the scheduling interval of the merger status check thread.
freeze_trigger_percentage	Specifies the memory usage threshold of a tenant that triggers a global major freeze.
max_kept_major_version_number	Specifies the number of major freeze versions to be retained.
merge_stat_sampling_ratio	Specifies the sampling rate of data column statistics during a major compaction.
merge_thread_count	Specifies the number of threads for daily major compactions.
merger_completion_percentage	Specifies the percentage of replicas that are merged. When the percentage reaches the threshold, the current major compaction is considered complete.
merger_switch_leader_duration_time	Specifies the interval between batch leader switches during daily major compactions.
merger_warm_up_duration_time	Specifies the warm-up time for new baseline data during a major compaction.

Parameter	Description
arbitration_timeout	Specifies the timeout for triggering automatic degradation.

Parameters not supported

Parameter	Description
sql_work_area	Specifies the tenant working memory.
max_stale_time_for_weak_consistency	Specifies the maximum staleness of data that can be read under weak consistency.

This topic lists cluster-level and tenant-level parameters in OceanBase Database.

Cluster-level parameters

Security

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 to the database.
ssl_client_authentication	Whether to enable SSL connections.
ssl_external_kms_info	The information required for the SSL feature of OceanBase Database to run. This parameter records the related configurations required for different SSL usage scenarios in a JSON string. The JSON string must contain the `ssl_mode` field.
enable_sql_audit	Whether to enable the SQL audit feature.
enable_clog_encryption	Whether to enable clog encryption for BKMI and obcloud when data transparent encryption is enabled.

Backup and restore

Parameter	Description
backup_backup_dest	The destination for backing up backup data.
backup_backup_dest_option	Controls backup-related parameters.
backup_dest_option	Controls backup-related parameters.
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 options for archiving 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 operations are performed.
backup_zone	The zone where backup operations are performed.
log_archive_batch_buffer_limit	Controls the maximum memory usage for log archiving on a single node.
log_archive_checkpoint_interval	The interval between checkpoints for cold data log archiving.
restore_concurrency	The maximum concurrency level for restoring tenant data from a backup.

cgroup

Parameter	Description
enable_cgroup	Specifies whether to enable the cgroup feature on the OBServer node.

Parameter name	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 for CPU and memory resource imbalance in the node load balancing strategy.
server_cpu_quota_max	Specifies the maximum CPU quota available to the system.
server_cpu_quota_min	Specifies the minimum CPU quota available to the system. The system automatically reserves the quota.
token_reserved_percentage	Specifies the percentage of idle tokens to be 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 name	Description
weak_read_version_refresh_interval	Specifies the refresh cycle for weak-consistency read versions, which affects the latency 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 execution time of a query exceeds this threshold, it is considered a slow query, and the trace logs of slow queries are printed to the system log.

Load balancing

Parameter	Description
balancer_log_interval	Specifies the interval at which the statistics logs of the disaster recovery task threads are printed.
balancer_task_timeout	Specifies the timeout for background tasks such as load balancing.
balancer_tolerance_percentage	Specifies the tolerance for disk imbalance among multiple units of a tenant in the load balancing strategy. If the disk imbalance is within the range of the mean value plus or minus the tolerance, no load balancing action is triggered.
server_balance_critical_disk_waterlevel	Specifies the water level for disk load balancing.
server_balance_disk_tolerance_percent	Specifies the tolerance for disk imbalance in the load balancing strategy between nodes.
resource_hard_limit	Specifies the overprovisioning 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. If 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 for background tasks such as load balancing is checked.
data_copy_concurrency	Specifies the maximum number of concurrent data migration and copy 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. This parameter is generally not manually configured.
resource_soft_limit	Specifies whether to enable unit balancing.

Parameter	Description
unit_gc_wait_time	Specifies the maximum wait time for unit garbage collection. If the wait time exceeds the specified maximum value, garbage collection is forcibly initiated.
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 thread checks the DBA_OB_LS_LOCATIONS and CDB_OB_LS_LOCATIONS views.
sys_bkgd_migration_change_member_list_timeout	Specifies the timeout for changing the Paxos member group 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 replica is added to the blacklist.
balance_blacklist_retry_interval	Specifies the retry interval after a replica is added to the blacklist.
election_cpu_quota	Specifies the CPU quota allocated to background tasks related to replica election.
election_blacklist_interval	Specifies the time interval during which a demoted leader cannot be elected again.
enable_auto_leader_switch	Specifies whether to enable automatic leader switching.
enable_smooth_leader_switch	The switch for enabling smooth leader switching.
global_index_build_single_replica_timeout	Specifies the timeout for building a global index on each replica.
get_leader_candidate_rpc_timeout	Specifies the timeout for internal requests to obtain leader candidates for 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 those of the leader. If the gap exceeds the threshold, a replica rebuild is triggered.
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 trigger 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 cleanup.
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 usage threshold of the execution plan cache. If the threshold is exceeded, the cache is automatically evicted.
plan_cache_low_watermark	Specifies the memory usage threshold of the execution plan cache. If the threshold is exceeded, the cache is automatically evicted.

Parameter	Description
tablet_meta_table_check_interval	Specifies the interval at which the background inspection thread inspects the DBA_OB_TABLET_REPLICAS/CDB_OB_TABLET_REPLICAS views.
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 compaction and query) in 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 performing partition garbage collection (GC).
partition_table_check_interval	Specifies the interval at which an OBServer node deletes non-existent replicas from a partition table.

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

Parameter	Description
sync_io_thread_count	Specifies the number of threads for synchronous I/O requests.
syslog_io_bandwidth_limit	Specifies the maximum disk I/O bandwidth that can be occupied by system logs. System logs exceeding this bandwidth limit will be discarded.
disk_io_thread_count	Specifies the number of disk I/O threads. The number must be an even number.
net_thread_count	Specifies the number of network I/O threads.
data_storage_error_tolerance_time	Specifies the tolerance time for the data disk status to be set to `ERROR`.
sys_bkgd_io_high_percentage	Specifies the maximum percentage of system background I/O.
sys_bkgd_io_low_percentage	Specifies the minimum percentage of system background I/O.
user_iort_up_percentage	Specifies the threshold for 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	Specifies 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	Specifies the timeout period for the obesi process to hold active session resources.
ob_esi_io_concurrency	Specifies the concurrent I/O count for the obesi process.
ob_esi_syslog_level	Specifies the current log recording level for the obesi process.
ob_esi_max_syslog_file_count	Specifies the maximum number of log files that can be accommodated by the obesi process before log files are recycled.
multiblock_read_gap_size	Specifies the maximum capacity of a single I/O aggregation read block cache.
multiblock_read_size	Specifies the I/O aggregation size for reading data.

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	Sets whether to enable the election group policy.
local_ip	The IP address of the server where the ObServer is installed.
observer_id	The unique identifier assigned to the OBServer node by the RS in the cluster.
min_observer_version	Displays the lowest application version of the OBServer nodes in the cluster.

Parameter name	Description
enable_ob_ratelimit	Enables rate limiting between regions in an RPC connection.
ob_ratelimit_stat_period	Sets the interval for the OBServer node to calculate and update the maximum bandwidth.

Parameter name	Description
virtual_table_location_cache_expire_time	Sets the expiration time for the cache of location information of virtual tables.
location_cache_refresh_rpc_timeout	The timeout period for refreshing `location_cache` through an RPC call.
location_cache_refresh_sql_timeout	The timeout period for refreshing `location_cache` through an SQL statement.
location_cache_refresh_min_interval	Sets the minimum interval for location cache refresh requests to prevent excessive refresh requests from causing excessive system pressure.
location_cache_cpu_quota	Sets the CPU quota for the location cache module.
location_fetch_concurrency	Sets the maximum number of concurrent location_cache refreshes on a single server.
location_refresh_thread_count	Sets the number of threads for the OBServer node to obtain partition location information from the Root Service.
enable_auto_refresh_location_cache	Sets whether to enable the automatic refresh of location cache information.

Directory paths

Parameter	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. The disk where the data_dir directory is located will be initialized by the OceanBase Database system for storing data.
data_disk_usage_limit_percentage	The maximum percentage of space that can be written to data files. 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 pause of write operations for ordinary tenants (`sys` tenants are not affected).
leak_mod_to_check	Used for memory leak checks, it 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 to the total memory size.
memory_reserved	The amount of memory reserved for the KVCache.
memstore_limit_percentage	The percentage of memory used by the MemStore to the total available memory of the tenant.
system_memory	The amount of memory reserved for the tenant with 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 incremental step size for disk file auto-expansion.
storage_meta_cache_priority	The priority of the storage Meta Cache in the KVCache.

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.

Others

Parameter name	Description
builtin_db_data_verify_cycle	Specifies the cycle for data block verification. The unit is days. A value of 0 indicates that no verification is performed.
data_storage_warning_tolerance_time	Specifies the tolerance time for the data disk status to be set to WARNING.
dead_socket_detection_timeout	Specifies the interval for detecting invalid sockets.
migration_disable_time	Specifies the duration to pause data migration when data migration to a node fails due to reasons such as full disks.
datafile_size	Specifies the size of the data file. This parameter is not required.
devname	Specifies the name of the network interface card (NIC) to which the service process is bound.
enable_perf_event	Specifies whether to enable the collection of performance event information.
enable_record_trace_id	Specifies whether to record the trace ID set by the application.
enable_upgrade_mode	Specifies whether to enable upgrade mode. In upgrade mode, some system background features are paused.
enable_ddl	Specifies whether to allow DDL operations.
high_priority_net_thread_count	Specifies the number of high-priority network threads. If the value is `0`, this feature is disabled.
obconfig_url	Specifies the URL of the OBConfig service.
rpc_port	Specifies the port number for remote access.
stack_size	Specifies the size of the program function call stack.
tenant_task_queue_size	The size of the request queue for each tenant.
zone	The name of the zone where the node is located. This parameter is generally not required.
recyclebin_object_expire_time	The time when the system automatically purges expired schema objects in the recycle bin.
default_row_format	The default row format used when creating tables in MySQL-compatible mode.
sys_bkgd_net_percentage	The percentage of network bandwidth that can be occupied by background system tasks.
schema_history_recycle_interval	The time interval for the system to execute `schema` multi-version record recycling tasks.
enable_asan_for_memory_context	When using ob_asan, this parameter specifies whether to allow ObAsanAllocator (default ObAllocator) as the memory context allocator.
ofs_list	The connection URLs of OceanBase File System (OFS) for each zone. OFS is a distributed storage system designed by OceanBase Database. This parameter is mainly used in the OFS deployment mode to allow RootService to access files across zones.
async_ps_cursor_max_count	The maximum number of asynchronous PS cursors in a single node.

Parameter	Description
enable_logservice	Enables or disables the log service.
logservice_access_point	Specifies the access point of the log service.

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 thread pool for internal asynchronous tasks of the Root Service.
rootservice_list	Displays the list of Root Service nodes and their replicas.
rootservice_ready_check_interval	Specifies the time interval between the Root Service and the cluster status check after the Root Service starts.
rootservice_memory_limit	Specifies the maximum memory capacity limit of the Root Service.
lease_time	Specifies the lease time for heartbeats.
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 heartbeat is interrupted for the specified duration, the node is considered permanently offline. Data replicas on permanently offline nodes need to be automatically replenished.
ob_event_history_recycle_interval	Specifies 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	Specifies the number of concurrent fast recovery tasks scheduled by the RootService on the OBServer node.
wait_leader_batch_count	Specifies the maximum number of partitions in each batch of leader transfer commands sent by the RootService.

Parameter	Description
rpc_client_authentication_method	Specifies the security authentication method for an RPC client.
rpc_server_authentication_method	Specifies the security authentication method for an RPC server.

Parameter name	Description
sql_login_thread_count	Specifies the number of threads for processing SQL login requests.
sql_audit_memory_limit	Specifies 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	Specifies the time interval for system internal DML requests.

Parameter	Description
log_disk_size	Specifies the size of the redo log disk.
log_disk_percentage	Specifies the percentage of the total space of the disk occupied by the redo log.
dtl_buffer_size	Specifies the size of the cache used by the SQL data transfer module.
ignore_replay_checksum_error	Specifies whether to ignore checksum errors that occur 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 per second by the total traffic for all servers in the standby tenant cluster to synchronize logs from the primary tenant cluster.
log_storage_warning_tolerance_time	Specifies the time from when log disk I/O fails to when the disk is marked as a bad disk.
clog_disk_utilization_threshold	Specifies the watermark value for reusing the space of the clog or ilog disk.
clog_expire_days	Specifies the expiration time of the clog file. When the last modification time of the clog file exceeds the expiration time, the file is deleted.
clog_cache_priority	Specifies the priority of the transaction log cache.
clog_disk_usage_limit_percentage	Specifies the maximum percentage of the available disk space for transaction logs.
clog_sync_time_warn_threshold	Specifies the threshold for transaction log synchronization time. If the synchronization time exceeds this threshold, a warning log is generated.
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 strategy for writing transaction logs when a transaction is committed.
ignore_replay_checksum_error	Specifies whether to ignore checksum errors that occur during transaction log replay.
index_clog_cache_priority	Specifies the priority of the transaction log index 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 when a transaction is forcibly killed due to freezing or switchover.

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

Debugging

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

TCP

Parameter	Description
enable_tcp_keepalive	Enables or disables the keepalive mechanism for client connections.
tcp_keepidle	Sets the time after which a keepalive probe is sent to a client connection if no data is sent, in seconds.
tcp_keepintvl	Sets the interval between keepalive probes for a client connection, in seconds.
tcp_keepcnt	Sets the maximum number of retries before closing an inactive connection.

External tables

Parameter	Description
external_table_disk_cache_max_percentage	Sets the maximum proportion of datafile_size that can be used for disk caching in SN mode.

Parameter	Description
alert_log_level	Specifies the level of the alert log.
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 enable the option to record old logs before the OBServer node starts. This option is used in conjunction with `max_syslog_file_count` to determine whether to consider old log files in the recycling logic.
enable_syslog_wf	Specifies whether to print system logs of level WARN and above 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 level of system logs.
trace_log_sampling_interval	Specifies the interval at which to periodically print trace log information.
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.
enable_log_archive	Specifies whether to enable the log archiving feature.
system_trace_level	Specifies the log printing level for system trace logs.

Parameter	Description
default_compress_func	Specifies the default compression algorithm for table data. You can also specify a different compression algorithm when creating a table.
default_compress	Specifies the default compression strategy for tables created in Oracle-compatible mode.
tableapi_transport_compress_func	Specifies the compression algorithm used for transmitting query results of OBKV-Table.
default_transport_compress_func	Specifies the RPC compression algorithm for the entire cluster.

Dumps and major compactions

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

Arbitration service

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.

Resource isolation

Parameter	Description
clog_io_isolation_mode	Specifies whether to isolate I/O requests for the clog disk based on whether the clog disk and data disk are independent.
enable_global_background_resource_isolation	Specifies whether to enable global background resource isolation.
global_background_cpu_quota	Specifies the CPU quota for background tasks when global background resource isolation is enabled.

Tenant-level parameters

Security

Parameter name	Description
sts_credential	Specifies the credentials for accessing the STS service provided by OCP.
external_kms_info	Stores key management information.
tde_method	Specifies 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.

Storage

Parameter name	Description
default_table_organization	Specifies the table organization mode for tables created by default.
default_table_merge_engine	Specifies the `merge_engine` for tables created by default in a user tenant.

CPU

Parameter name	Description
cpu_quota_concurrency	Specifies the maximum number of concurrent sessions allowed per CPU quota for a tenant.

Read/Write/Query

Parameter name	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 read the `query_response_time_range_base` parameter.
query_response_time_range_base	Specifies the interval for collecting time parameters in the `information_schema.QUERY_RESPONSE_TIME` view.

Load balancing

Parameter	Description
zone_disk_balance_tolerance_percentage	Specifies the tolerance of the table group disk balancing algorithm for disk imbalance between zones.
enable_ls_leader_balance	Specifies whether to enable automatic load balancing for log stream leaders.
enable_gts_standalone	Specifies whether to enable the GTS service to occupy a dedicated group of units.
balancer_idle_time	The wake-up interval for background task threads, such as the load balancer, when they are idle.
enable_rebalance	Specifies whether to enable automatic load balancing.
enable_transfer	Specifies whether to allow transfer within a tenant. If the `enable_rebalance` parameter is disabled, this parameter is invalid.
partition_balance_schedule_interval	The interval for partition balance scheduling.
enable_database_sharding_none	Specifies whether to enable automatic aggregation when a user table is created in a database.

Replica

Parameter	Description
replica_parallel_migration_mode	Specifies the mode of the parallel migration feature for log stream replicas.
choose_migration_source_policy	Specifies the priority strategy for selecting the source replica during migration.

Scaling

Parameter	Description
ls_scale_out_factor	Specifies the scaling-out factor for log streams, which controls the number of log streams per service node.

Backup and restore

Parameter	Description
recover_table_concurrency	The maximum number of tables that can be restored in parallel in the cross-tenant data import phase of table-level restore.
recover_table_dop	The maximum degree of parallelism (DOP) for restoring a single table in the cross-tenant data import phase of table-level restore.
log_restore_concurrency	The concurrency level for log restore.
log_archive_concurrency	The concurrency level for log archiving.
backup_data_file_size	The maximum size of a single data backup file.

Partitioning

Parameter	Description
enable_auto_split	Specifies whether to enable the automatic partitioning feature for the tenant.
auto_split_tablet_size	Specifies the threshold for triggering automatic partitioning for the tenant.
global_index_auto_split_policy	Specifies whether to enable automatic partitioning for new global indexes. The default value is `DISTRIBUTED`.

Background execution threads

Parameter	Description
px_workers_per_cpu_quota	Specifies the ratio of parallel execution worker threads.
attach_shared_sstable_thread_score	Specifies the number of threads available to the tenant for executing shared data references in shared storage mode.
inc_sstable_upload_thread_score	Specifies the number of threads available to the tenant for executing data sharing tasks in shared storage mode.
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 compactions.
compaction_high_thread_score	Specifies the number of worker threads for high-priority compactions.
compaction_mid_thread_score	Specifies the number of worker threads for medium-priority 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 scheduling.
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 major compaction scheduling.
tenant_sql_login_thread_count	Specifies the number of threads for MySQL-compatible tenant login, i.e., 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-compatible tenants, i.e., the number of `sql_nio_server` threads. The default value of 0 indicates that the value of `unit_min_cpu` is used.

Parameter name	Description
default_storage_cache_policy	Configures the default cache policy.
enable_manual_storage_cache_policy	Enables a user-defined hot cache policy.
suspend_storage_cache_task	Specifies whether to suspend the background cache task.
enable_adaptive_plan_cache	Controls whether to enable the adaptive plan cache feature.
result_cache_max_size	Controls the maximum memory available for the `result cache` module.
result_cache_max_result	Controls the maximum proportion of `result_cache_max_size` that can be used by a single `result cache` cache object.
ob_result_cache_evict_percentage	Specifies the memory evict threshold for `result cache`.
ob_deterministic_udf_cache_max_size	Specifies the maximum memory that can be used for caching all `deterministic` UDFs during statement execution.

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

Note

The parameters in the following table are effective only in MySQL-compatible mode.

| Parameter name | Description |

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

Parameter name	Description
ob_proxy_readonly_transaction_routing_policy	Controls whether Proxy routing of transactions is affected by read-only statements.

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

Parameter name	Description
ob_vector_memory_limit_percentage	Specifies the threshold for memory resource usage by the vector index module (unit: percentage).
range_optimizer_max_mem_size	Limits the memory used by the Query Range module.
rpc_memory_limit_percentage	Specifies the maximum memory for RPC in the tenant, as a percentage of the total memory.
query_memory_limit_percentage	Specifies the percentage of tenant memory available for a single SQL statement.

Parameter	Description
temporary_file_max_disk_size	Specifies the maximum disk space that can be occupied by temporary files on a single node of a tenant.

Parameter	Description
enable_kv_ttl	Controls whether to enable the TTL background task. This parameter applies only to periodic TTL tasks. User control commands are not affected by this parameter.Note: The TTL feature is only applicable to OceanBase Database KV scenarios and is disabled in SQL scenarios to avoid unexpected data deletion.
kv_ttl_duty_duration	Specifies the time period during which the daily scheduled TTL task is triggered.
kv_group_commit_batch_size	Specifies the size of batch operations in OBKV group commit.
kv_group_commit_rw_mode	Controls scenarios where group commit is used.
kv_hbase_client_scanner_timeout_period	Specifies the timeout period for OBKV-HBase streaming queries.
kv_ttl_history_recycle_interval	Specifies the time period for which TTL task history is retained.
ttl_thread_score	Specifies the number of worker threads used for TTL tasks.

Parameter	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	Controls whether to enable the feature of compiling and persisting DDL statements of stored procedures.
package_state_sync_max_size	Controls the maximum length of a package state (package state management) that can be serialized.
ob_enable_java_udf	Controls whether to enable the Java UDF feature.
enable_pl_rich_error_msg	Controls whether to add additional content to exception information in PLSQL.

Parameter name	Description
default_load_mode	Controls the data import method in data import scenarios.
direct_load_allow_fallback	Controls whether to fall back to standard import in direct load scenarios where direct load is not supported.
load_data_diagnosis_log_compression	Specifies the compression algorithm used for diagnostic logs.
load_data_diagnosis_log_max_size	Specifies the size of a single diagnostic log file.

Others

Parameter	Description
schema_history_archive_expire_time	Specifies the retention period of schema history archive data.
schema_history_expire_time	Specifies the expiration time of metadata history data.
zone_deploy_mode	Specifies the distribution mode of the tenant across zones.
enable_early_lock_release	Specifies whether to enable the early row 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_ssl_invited_common_names	Records the list of application identities of the current tenant. The identities are obtained from the `cn` field of the `subject` in the client certificate of the SSL mutual authentication.
ob_enable_batched_multi_statement	Specifies whether to enable the grouped execution optimization of the batch processing feature.
job_queue_processes	Specifies the maximum number of concurrent tasks that can be run on each tenant, to prevent tasks from consuming tenant resources.
default_auto_increment_mode	Specifies the default auto-increment mode for auto-increment columns.
ob_query_switch_leader_retry_timeout	Specifies the maximum retry time for failed queries, in microseconds (us).
default_enable_extended_rowid	Specifies whether to create tables in the Extended ROWID mode.
dump_data_dictionary_to_log_interval	Specifies the interval for persisting the data dictionary of a tenant.
enable_user_defined_rewrite_rules	Specifies whether to enable user-defined rewrite rules.
storage_rowsets_size	Specifies the number of rows to vectorized in one batch for the columnar engine.
approx_count_distinct_precision	Specifies the result precision of the `approx_count_distinct` function.
default_skip_index_level	Specifies the mechanism for generating Skip Indexes in incremental SSTables of a tenant.

Parameter	Description
log_disk_utilization_limit_threshold	Sets the threshold for the utilization of the log disk space of a tenant. When the log disk usage exceeds the total log disk space of the tenant multiplied by this threshold, no more logs can be written.
log_disk_utilization_threshold	Sets the threshold for the utilization of the log disk space of a tenant. When the log disk usage exceeds the total log disk space of the tenant multiplied by this threshold, log files are reused.
writing_throttling_maximum_duration	Controls the write speed by controlling the memory allocation progress. That is, specifies the time required to complete the remaining memory allocation for MemStore after write throttling is triggered.
writing_throttling_trigger_percentage	Sets the threshold for the write speed.
standby_db_fetch_log_rpc_timeout	Sets the RPC timeout for log fetching from the standby database. This parameter is used to control the log transmission service of the standby database to detect that a server in the primary database is unavailable and switch to another server.
log_disk_throttling_percentage	The percentage of unrecoverable log disk space that triggers log write 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	Sets the maximum number of unconfirmed logs in the transaction module.
clog_persistence_compress_func	Sets the compression algorithm for transaction log persistence.
enable_clog_persistence_compress	Specifies whether to enable compression for transaction log persistence.

Parameter	Description
json_document_max_depth	Sets the maximum allowed nesting level in a JSON document.

Parameter	Description
enable_lock_priority	Lock priority switch.

Parameter	Description
external_table_io_hole_size	Sets the maximum distance (in bytes) between two consecutive I/O ranges.
external_table_io_range_size	Sets the maximum size (in bytes) of a merge range.

Parameter	Description
log_disk_throttling_maximum_duration	Adjusts the maximum available time of the log disk after log throttling is triggered.
ls_gc_delay_time	Configures the time for delayed deletion of tenant log streams.
standby_db_preferred_upstream_log_region	Configures the preferred region for synchronizing upstream logs for a standby tenant.
archive_lag_target	Controls the time for tenant log archiving delay.

Materialized views

Parameter	Description
enable_mlog_auto_maintenance	Specifies whether to enable the automatic management feature for materialized view logs.
mlog_trim_interval	Specifies the scheduling cycle for the background automatic trimming task of materialized view logs (mlogs).
enable_mv_binlog_minimal_mode	Specifies whether to enable the `binlog minimal` mode in incremental refresh scenarios of materialized views.

Note

The following parameters are effective only in MySQL-compatible mode.

Parameter	Description
connection_control_failed_connections_threshold	Specifies the threshold for failed login attempts.
connection_control_min_connection_delay	Specifies the minimum duration for locking a user after exceeding the threshold for failed login attempts.
connection_control_max_connection_delay	Specifies the maximum duration for locking a user after exceeding the threshold for failed login attempts. The duration will not increase once it reaches this maximum.

Compression algorithms

Parameter	Description
spill_compression_codec	Specifies the compression algorithm type to compress data during SQL execution.
ob_encoding_granularity	Specifies the maximum number of rows in a microblock for encoding.

Dumps and major compactions

Parameter	Description
mds_minor_compact_trigger	Specifies the number of SSTables that triggers an MDS minor compaction.
mds_compaction_mid_thread_score	Specifies the number of DAG (direct acyclic graph) threads for mid-priority MDS compactions.
mds_compaction_high_thread_score	Specifies the number of DAG (direct acyclic graph) threads for high-priority MDS compactions.
default_progressive_merge_num	Specifies the default number of progressive major compactions for a new table.
major_freeze_duty_time	Specifies the time when daily automatic major compactions and major freezes are triggered.
major_compact_trigger	Specifies the number of major freezes that triggers a major compaction.
minor_compact_trigger	Specifies the threshold for the number of SSTables that triggers a minor compaction.
undo_retention	Specifies the range of data versions to be retained in the system. The unit is seconds. It also specifies the data versions to be recycled during a minor compaction.
merger_check_interval	Specifies the scheduling interval of the merger status check thread.
freeze_trigger_percentage	Specifies the memory usage threshold of a tenant that triggers a global major freeze.
max_kept_major_version_number	Specifies the number of major freeze versions to be retained.
merge_stat_sampling_ratio	Specifies the sampling rate of data column statistics during a major compaction.
merge_thread_count	Specifies the number of threads for daily major compactions.
merger_completion_percentage	Specifies the percentage of replicas that are merged. When the percentage reaches the threshold, the current major compaction is considered complete.
merger_switch_leader_duration_time	Specifies the interval between batch leader switches during daily major compactions.
merger_warm_up_duration_time	Specifies the warm-up time for new baseline data during a major compaction.

Parameter	Description
arbitration_timeout	Specifies the timeout for triggering automatic degradation.

Parameters not supported

Parameter	Description
sql_work_area	Specifies the tenant working memory.
max_stale_time_for_weak_consistency	Specifies the maximum staleness of data that can be read under weak consistency.

OceanBase

Customer Stories

Documentation

Overview of parameters

Cluster-level parameters

Security

Backup and restore

cgroup

CPU related

Read/write and query related

Load balancing

Replica-related

Cache-related parameters

Partition-related

Background thread-related

I/O-related

Cluster-related

Bandwidth-related

Location Cache-related

Directory paths

Memory space related

PX-related parameters

Others

Log service-related

Root Service-related

RPC authentication-related

SQL-related

Transaction and transaction log related

Lock related

Debugging

TCP

External tables

System log-related

Compression algorithm-related

Dumps and major compactions

Arbitration service

Resource isolation

Tenant-level parameters

Security

Storage

CPU

Read/Write/Query

Load balancing

Replica

Scaling

Backup and restore

Partitioning

Background execution threads

Cache-related

I/O-related

Compatibility-related

Note

Routing-related

LOB data-related

Memory space-related

Disk space-related

OBKV-related

PL-related

Direct load-related

Others

Transaction and transaction log related

Data type related

Lock related

External table related

System log related

Materialized views

User login

Note

Compression algorithms

Dumps and major compactions

Parameters related to arbitration

Parameters not supported

Overview of parameters

Cluster-level parameters

Security

Backup and restore

cgroup

CPU related

Read/write and query related

Load balancing