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

Parameter	Description
mysql_port	Specifies the port number for the SQL service protocol.
rpc_port	Specifies the port number for remote access.
sql_protocol_min_tls_version	Specifies the minimum version of the SSL/TLS protocol used for SSL connections for SQL statements.
ssl_client_authentication	Specifies whether to enable the SSL connection feature.
ssl_external_kms_info	Records information required for the operation of the SSL feature in OceanBase Database. This information is stored in a JSON string that contains at least the `ssl_mode` field.
enable_sql_audit	Specifies whether to enable the SQL audit feature.

Parameter	Description
backup_backup_dest	Specifies the destination for backing up backup data.
backup_backup_dest_option	Controls parameters related to backup.
backup_dest_option	Controls parameters related to backup.
backup_concurrency	Specifies the number of concurrent writes to the file system during backup.
backup_dest	Specifies the path for baseline backup and log archiving.
backup_log_archive_option	Defines the options for archiving backup logs.
backup_net_limit	Specifies the total bandwidth for cluster backup.
backup_recovery_window	Specifies the time window for restoring backup data.
backup_region	Specifies the region for executing backup.
backup_zone	Specifies the zone for executing backup.
log_archive_batch_buffer_limit	Controls the maximum memory usage for log archiving on a single node.
log_archive_checkpoint_interval	Specifies the time interval for cold data log archiving checkpoints.
restore_concurrency	Specifies the maximum concurrency level for restoring tenant data from a backup.

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

Parameter	Description
cpu_count	Specifies the total number of CPU cores. If you set this parameter to 0, the system automatically detects the number of CPU cores.
server_balance_cpu_mem_tolerance_percent	Specifies the tolerance of CPU and memory resource imbalance in the node load balancing strategy.
server_cpu_quota_max	Specifies the maximum CPU quota that the system can use.
server_cpu_quota_min	Specifies the minimum CPU quota that the system can use. The system automatically reserves this 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. When 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 among multiple units of a tenant.

Parameter	Description
weak_read_version_refresh_interval	Specifies the refresh cycle of the weak-consistency read version number. This parameter affects the delay of weak-consistency read data.
large_query_worker_percentage	Specifies the percentage of worker threads reserved for processing large queries.
large_query_threshold	Specifies the query execution time threshold.
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. The trace logs of slow queries are printed to the system log.

Parameter	Description
balancer_log_interval	The interval at which the statistics logs of the disaster recovery task threads are printed.
balancer_task_timeout	The timeout for background tasks such as load balancing.
balancer_tolerance_percentage	The tolerance for disk imbalance among multiple units of a tenant in the load balancing strategy. If the imbalance is within the range of the mean plus or minus the tolerance, no balancing action is triggered.
server_balance_critical_disk_waterlevel	The waterline for disk space load balancing.
server_balance_disk_tolerance_percent	The tolerance for disk imbalance in the node-level disk load balancing strategy.
resource_hard_limit	The overselling percentage of CPU resources.
enable_sys_unit_standalone	Whether to enable exclusive node mode for the system tenant.
balancer_emergency_percentage	The unit load threshold. When the unit load exceeds this threshold, replica migration is allowed, and load balancing is performed even during major compactions.
balancer_timeout_check_interval	The interval at which the timeout for background tasks such as load balancing is checked.
data_copy_concurrency	The maximum number of concurrent data migration and replication tasks that can be executed in the system.
tenant_groups	The tenant groups used in the load balancing strategy.
unit_balance_resource_weight	The resource weights used in the unit balancing strategy. Generally, you do not need to manually configure these weights.
resource_soft_limit	Whether to enable unit balancing.

Parameter	Description
unit_gc_wait_time	Specifies the maximum wait time for unit GC. If the wait time exceeds the specified maximum wait time, GC is forcibly performed.
enable_rereplication	Specifies whether to enable automatic migration and replication of log stream replicas.
ls_meta_table_check_interval	Specifies the interval at which the background inspection thread inspects the DBA_OB_LS_LOCATIONS and CDB_OB_LS_LOCATIONS views.
sys_bkgd_migration_change_member_list_timeout	Specifies the timeout 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 for background tasks such as replica migration after they are added to the blacklist.
election_cpu_quota	Specifies the CPU quota allocated to background tasks related to replica election.
election_blacklist_interval	Specifies the interval during which a former leader cannot be elected again after it is removed.
enable_auto_leader_switch	Specifies whether to enable automatic leader switching.
enable_smooth_leader_switch	Specifies whether to enable smooth leader switching.
global_index_build_single_replica_timeout	Specifies the timeout for building a global index on each replica.
get_leader_candidate_rpc_timeout	Specifies the timeout for internal requests to obtain a leader candidate during automatic leader switching.
migrate_concurrency	Specifies the maximum number of concurrent internal data migrations.
rebuild_replica_data_lag_threshold	Specifies the threshold for the gap between the transaction logs of a standby replica and those of the leader. If the gap exceeds the threshold, the replica is rebuilt.
server_data_copy_out_concurrency	Specifies the maximum number of concurrent data migrations from a single node.
server_data_copy_in_concurrency	Specifies the maximum number of concurrent data migrations to a single node.
replica_safe_remove_time	Specifies the safe retention period for a deleted replica.

Parameter	Description
bf_cache_miss_count_threshold	Specifies the number of macroblocks that are not hit before a Bloom filter cache is created.
bf_cache_priority	Specifies the priority of the Bloom filter cache.
cache_wash_threshold	Specifies the capacity threshold that triggers cache cleaning.
fuse_row_cache_priority	Specifies the priority of the fused row cache in the cache system.
user_row_cache_priority	Specifies the priority of the baseline data row cache in the cache system.
autoinc_cache_refresh_interval	Specifies the refresh interval of the auto-increment column cache.
plan_cache_evict_interval	Specifies the time interval for evicting execution plans from the 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 threshold of memory occupied by the execution plan cache. If this threshold is exceeded, the cache is automatically evicted.
plan_cache_low_watermark	Specifies the threshold of memory occupied by the execution plan cache. If this threshold is exceeded, the cache is automatically evicted.

Parameter	Description
tablet_meta_table_check_interval	Specifies the interval at which the background thread for checking the DBA_OB_TABLET_REPLICAS and CDB_OB_TABLET_REPLICAS views runs.
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 when the tablet is processed in parallel (such as during a major compaction or query).
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 by 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.
partition_table_check_interval	Specifies the interval at which the 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 value must be an even number.
net_thread_count	Specifies the number of network I/O threads.
data_storage_error_tolerance_time	Specifies the maximum time that a data disk can remain in the `ERROR` state.
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 active session resources held by the obesi process.
ob_esi_io_concurrency	Specifies the number of concurrent I/O operations 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 retained 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 size of I/O aggregation for data reads.

Parameter name	Description
all_server_list	Displays the addresses of all servers in the cluster.
cluster	Specifies the name of the OceanBase cluster.
cluster_id	Specifies the ID of the OceanBase cluster.
rpc_timeout	Specifies the timeout period for internal cluster requests.
all_cluster_list	Displays the list of servers that access the same config_url.
enable_election_group	Specifies whether to enable the election group strategy.
local_ip	Specifies the IP address of the server where you install ObServer.
observer_id	Specifies 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 node in the cluster.

Parameter name	Description
enable_ob_ratelimit	Enables rate limiting between regions in an RPC connection.
ob_ratelimit_stat_period	Specifies the interval at which an OBServer node calculates and updates the maximum bandwidth.

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

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

Parameter	Description
datafile_disk_percentage	The percentage of the total space occupied by the disk where the data_dir directory is located.
data_disk_usage_limit_percentage	The maximum percentage of data files that can be written. If this threshold is exceeded, data migration is prohibited.
enable_sql_operator_dump	Specifies whether to allow the intermediate results of SQL processing to be written to disk to release memory.
global_write_halt_residual_memory	The global remaining memory threshold that triggers the suspension of writes for non-`sys` tenants.
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 relative to the total memory size.
memory_reserved	The amount of memory reserved for KVCache.
memstore_limit_percentage	The percentage of memory used by MemStore relative to the total available memory.
system_memory	The amount of memory reserved for the tenant with tenant ID `500`.
use_large_pages	Manages the use of large pages for database memory.
datafile_maxsize	The maximum size to which disk files can automatically expand.
datafile_next	The increment step 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	The size of data processed by each task of the SQL parallel query engine.
max_px_worker_count	The maximum number of threads used by the SQL parallel query engine.

Parameter name	Description
builtin_db_data_verify_cycle	Specifies the cycle for checking data block errors, in days. A value of 0 indicates that no check 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 for which data migration is paused when a node fails to migrate data due to a full disk.
schema_history_expire_time	Specifies the expiration time for metadata history data.
datafile_size	Specifies the size of the data file. This parameter is usually not set.
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.
ob_enable_utl_tcp	Controls whether to enable the UTL_TCP system package.
high_priority_net_thread_count	Specifies the number of high-priority network threads. A value of `0` indicates that this feature is disabled.
obconfig_url	Specifies the URL address of the OBConfig service.
rpc_port	Specifies the port number for remote access.
stack_size	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 usually not configured.
recyclebin_object_expire_time	Automatically purges expired schema objects in the recycle bin.
default_row_format	The default row format used when creating tables in MySQL mode.
sys_bkgd_net_percentage	The percentage of network bandwidth that can be occupied by background system tasks.
schema_history_recycle_interval	The interval between executions of the `schema` multi-version record recycling task.
enable_asan_for_memory_context	When using ob_asan, specifies whether to allow ObAsanAllocator (default ObAllocator) as the memory context allocator.
ofs_list	The connection URLs of the OFS (OceanBase File System, a distributed storage system designed by OceanBase Database) for each zone. This parameter is mainly used to meet the needs of RootService for cross-zone file access in OFS deployment mode.
async_ps_cursor_max_count	The maximum number of asynchronous PS cursors in a single node.

Parameter name	Description
enable_logservice	Controls whether to enable the log service.
logservice_access_point	Specifies the access point of the log service.

Parameter name	Description
rootservice_async_task_queue_size	Specifies the size of the internal asynchronous task queue of the Root Service.
rootservice_async_task_thread_count	Specifies the size of the internal asynchronous task thread pool of the Root Service.
rootservice_list	Displays the list of Root Service nodes and their replicas.
rootservice_ready_check_interval	Specifies the interval between the Root Service waiting for and checking the cluster status after it is started.
rootservice_memory_limit	Specifies the maximum memory capacity limit of the Root Service.
lease_time	Specifies the heartbeat lease time.
server_check_interval	Specifies the interval between server table consistency checks.
server_permanent_offline_time	Specifies the threshold for node heartbeat interruption. If the heartbeat of a node is interrupted for this duration, the node is considered permanently offline, and 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.
wait_leader_batch_count	Specifies the maximum number of partitions that the RootService sends a leader switch command at a time.

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

Parameter 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 disk space 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 during transaction log replay.
trx_2pc_retry_interval	Specifies the time interval for automatic retries after a two-phase commit fails.
standby_fetch_log_bandwidth_limit	Specifies the maximum bandwidth that can be occupied by the total log synchronization traffic from all servers in the standby tenant's cluster to the primary tenant.
log_storage_warning_tolerance_time	Specifies the time from when log disk I/O fails to when the disk is marked as faulty.
clog_disk_utilization_threshold	Controls the water level for reusing clog or ilog disk space.
clog_expire_days	Controls the expiration time of Clog files. If the last modification time of a Clog file exceeds the expiration time, the file will be deleted.
clog_cache_priority	Specifies the priority of transaction logs in the cache.
clog_disk_usage_limit_percentage	Specifies the maximum percentage of available disk space for transaction logs.
clog_sync_time_warn_threshold	Specifies the threshold for transaction log synchronization time alerts. If the synchronization time exceeds this threshold, a WARN 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 during transaction commit.
ignore_replay_checksum_error	Specifies whether to ignore checksum errors during transaction log replay.
index_clog_cache_priority	Specifies the priority of transaction log indexes in the cache system.
ilog_index_expire_time	Specifies the maximum time for which an OBServer can provide Ilog file read access.
trx_force_kill_threshold	Specifies the maximum waiting time when a transaction must be killed due to freezing or switchover.

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

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

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

Parameter	Description
external_table_disk_cache_max_percentage	Specifies the maximum percentage of the datafile_size value that can be used for disk caching of external tables in SN mode.

Parameter	Description
alert_log_level	Specifies the level of alert logs.
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 OBServer nodes are started. This option is used in conjunction with `max_syslog_file_count` to determine whether the recycling logic considers old log files.
enable_syslog_wf	Specifies whether to print system logs of level WARN or higher to a separate log file.
max_string_print_length	Specifies the maximum length of a single log line when printing system logs.
max_syslog_file_count	Specifies the maximum number of log files that can be retained before log files are recycled.
syslog_level	Specifies the level of system logs.
trace_log_sampling_interval	Specifies the time interval for periodically printing trace log information.
diag_syslog_per_error_limit	Specifies the maximum number of DIAG system logs allowed per second per error code. Logs exceeding this threshold will not be printed.
enable_log_archive	Specifies whether to enable 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 other compression algorithms when creating a table.
default_compress	Specifies the default compression strategy used when creating tables in Oracle mode.
tableapi_transport_compress_func	Specifies the compression algorithm used for transmitting query results from OBKV-Table.
default_transport_compress_func	Specifies the RPC compression algorithm for the entire cluster.

Parameter name	Description
enable_major_freeze	Specifies whether to enable the automatic global freeze feature.
micro_block_merge_verify_level	Specifies the verification level for macroblocks during a major compaction.
row_compaction_update_limit	Specifies the number of modifications that trigger an in-memory row compaction.
enable_global_freeze_trigger	Specifies whether to enable automatic global freeze triggers.
enable_merge_by_turn	Specifies whether to enable the round-robin merge strategy.
enable_manual_merge	Specifies whether to enable manual merges.
global_major_freeze_residual_memory	Specifies the threshold for remaining memory that triggers a global freeze. That is, a global freeze is triggered when the remaining memory is less than this percentage.
minor_deferred_gc_time	Specifies the interval for delayed garbage collection of SSTables after a minor compaction.
zone_merge_concurrency	Specifies the number of zones that can be merged concurrently. When the value is 0, the system automatically selects the optimal concurrency based on deployment.
zone_merge_order	Specifies the order for round-robin merges of zones. If not specified, the system automatically determines the order.
zone_merge_timeout	Specifies the timeout 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.

Parameter name	Description
arbitration_degradation_policy	Specifies the auto-degradation strategy.
ob_startup_mode	Specifies the startup mode of an OBServer node. This parameter can be modified only during the first startup.

Parameter name	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 foreground and background resource isolation.
global_background_cpu_quota	Specifies the CPU quota for background tasks when global foreground and background resource isolation is enabled.

Parameter 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.

Parameter name	Description
default_table_organization	Specifies the default table organization mode for creating tables.
default_table_merge_engine	Specifies the default `merge_engine` for user tenants.
default_delta_format	Specifies the default incremental data storage format for creating tables.

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

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

Parameter	Description
enable_ls_leader_balance	Specifies whether to enable automatic leader balancing for log streams.
enable_gts_standalone	Specifies whether to enable the GTS service to occupy a dedicated unit group for the tenant.
balancer_idle_time	Specifies 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 transfers within a tenant. This parameter is invalid when the `enable_rebalance` parameter is disabled.
partition_balance_schedule_interval	Specifies the partition balancing scheduling cycle.
enable_database_sharding_none	Specifies whether to enable automatic aggregation for user tables when a database is created.

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

Parameter	Description
ls_scale_out_factor	The log stream expansion coefficient, which controls the number of log streams per service node.

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

Parameter name	Description
enable_auto_split	Specifies whether to enable automatic partitioning 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 newly created global indexes. Default value: `DISTRIBUTED`.

Parameter name	Description
px_workers_per_cpu_quota	Specifies the ratio of parallel execution worker threads.
attach_shared_sstable_thread_score	Specifies the number of threads that can be used by the tenant to execute shared data references in shared storage mode.
inc_sstable_upload_thread_score	Specifies the number of threads that can be used by the tenant to execute 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 major compactions.
compaction_high_thread_score	Specifies the number of worker threads for high-priority major compactions.
compaction_mid_thread_score	Specifies the number of worker threads for medium-priority major compactions.
ha_high_thread_score	Specifies the number of worker threads for high-priority high-availability threads.
ha_mid_thread_score	Specifies the number of worker threads for medium-priority high-availability threads.
ha_low_thread_score	Specifies the number of worker threads for low-priority high-availability threads.
ob_compaction_schedule_interval	Specifies the interval for scheduling major compactions.
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 scheduled in each batch during major compaction scheduling.
tenant_sql_login_thread_count	Specifies the number of threads for MySQL 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 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.
ddl_high_thread_score	Specifies the number of DAG threads for executing DDL KV merges.

Parameter name	Description
storage_cache_clean_macro_interval	Specifies the execution frequency of the macroblock-level hot macroblock cache cleanup task in Shared-Storage (SS) mode.
default_storage_cache_policy	Specifies the default cache policy.
enable_manual_storage_cache_policy	Enables the user-specified hot cache policy.
suspend_storage_cache_task	Specifies whether to suspend the background cache task.
enable_adaptive_plan_cache	Specifies whether to enable the adaptive plan cache feature.
result_cache_max_size	Specifies the maximum memory that can be used by the `result cache` module.
result_cache_max_result	Specifies 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 by the cache pool for all `deterministic` UDFs during statement execution.

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

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

Parameter name	Description
ob_proxy_readonly_transaction_routing_policy	Specifies whether Proxy routing for 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 of memory resource usage for the vector index module. The unit is a percentage.
range_optimizer_max_mem_size	Specifies the maximum memory size that can be used by the Query Range module.
rpc_memory_limit_percentage	Specifies the maximum memory size that can be used by RPCs in a tenant, as a percentage of the total memory of the tenant.
query_memory_limit_percentage	Specifies the percentage of memory that can be used by a single SQL statement.

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

Parameter name	Description
enable_kv_ttl	Specifies whether to enable the TTL background task. This parameter is effective only for periodic TTL tasks. User control commands are not affected by this parameter.Notice: The TTL feature is only applicable to the OceanBase KV scenario. It is disabled in the SQL scenario to avoid unexpected data deletion.
kv_ttl_duty_duration	Specifies the time period during which the daily scheduled TTL task is triggered. The TTL task is triggered once during this period.
kv_group_commit_batch_size	Specifies the size of batch operations executed in OBKV group commit.
kv_group_commit_rw_mode	Specifies the read/write mode for group commit.
kv_hbase_client_scanner_timeout_period	Specifies the timeout period for OBKV-HBase streaming queries.
kv_ttl_history_recycle_interval	Specifies the period for which the history records of the TTL task are retained.
ttl_thread_score	Specifies the number of worker threads used by the TTL task.

Parameter name	Description
plsql_code_type	Specifies the compilation type of PL/SQL code.
plsql_debug	Specifies whether to compile the code into a debug version.
plsql_optimize_level	Specifies the compilation optimization level.
plsql_v2_compatibility	Specifies the compatibility features of Oracle 8.
package_state_sync_max_size	Specifies the maximum length that can be serialized for a single package state (package state management).
ob_enable_java_udf	Specifies whether to enable the Java UDF feature.
enable_pl_rich_error_msg	Specifies whether to add additional content to the exception information in PLSQL.

Parameter	Description
default_load_mode	Specifies the data import mode for data import operations.
direct_load_allow_fallback	Specifies whether to fall back to the normal import mode when a direct load operation encounters a scenario that is not supported by direct load.
load_data_diagnosis_log_compression	Specifies the compression algorithm for diagnostic logs.
load_data_diagnosis_log_max_size	Specifies the size of a single diagnostic log file.

Parameter	Description
px_target_high_watermark	Specifies the high watermark percentage threshold for the number of parallel threads.
px_target_low_watermark	Specifies the low watermark percentage threshold for the number of parallel threads.
px_target_workers_per_cpu	Specifies the ratio between the expected number of parallel execution threads and the number of CPU cores in the tenant.

Parameter	Description
zone_deploy_mode	Specifies the distribution mode of the tenant in each zone.
enable_early_lock_release	Specifies whether to enable the early lock release feature.
workarea_size_policy	Specifies the strategy for manually or automatically adjusting the size of the SQL work area.
open_cursors	Specifies the maximum number of cursors that can be opened simultaneously by a single session.
ob_ssl_invited_common_names	Records the list of application identities for the current tenant, which are obtained from the `cn` field (common name) of the `subject` field in the client certificate during SSL mutual authentication.
ob_enable_batched_multi_statement	Specifies whether to enable the batched multi-statement execution optimization feature.
job_queue_processes	Specifies the maximum number of tasks that can be run simultaneously for each tenant, to prevent tasks from consuming excessive 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 tenant data dictionary.
enable_user_defined_rewrite_rules	Specifies whether to enable user-defined rewrite rules.
storage_rowsets_size	Specifies the number of rows to be vectorized in a batch for the columnar engine.
default_skip_index_level	Specifies the default value of `skip_index_level` when creating tables in the tenant.

Parameter	Description
log_disk_utilization_limit_threshold	Specifies the tenant log disk utilization limit threshold. When the tenant log disk usage exceeds the total log disk space of the tenant multiplied by this threshold, log writes are no longer allowed.
log_disk_utilization_threshold	Specifies the tenant log disk utilization threshold. When the tenant 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 allocate the remaining MemStore memory after write throttling is triggered.
writing_throttling_trigger_percentage	Specifies the write speed threshold.
standby_db_fetch_log_rpc_timeout	Specifies the timeout period for log fetching from the standby database. This parameter is used to control the log transmission service of the standby database to detect when a Server of the primary database is unavailable and switch to another Server.
log_disk_throttling_percentage	Specifies the percentage of non-recoverable log disk space that triggers log write throttling.
log_transport_compress_all	Specifies whether to compress logs during log transmission.
log_transport_compress_func	Specifies the compressor for log transmission.
clog_max_unconfirmed_log_count	Specifies the maximum number of unconfirmed logs in the transaction module.
clog_persistence_compress_func	Specifies the compression algorithm for transaction log persistence.
enable_clog_persistence_compress	Specifies whether to enable transaction log persistence compression.

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

Parameter	Description
enable_lock_priority	Lock priority switch.

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

Parameter	Description
log_disk_throttling_maximum_duration	Specifies the maximum available time for the log disk after log throttling is triggered.
ls_gc_delay_time	Specifies the delay period for tenant log stream deletion.
standby_db_preferred_upstream_log_region	Specifies the preferred region for synchronizing upstream logs for a standby tenant.
archive_lag_target	Specifies the delay period for tenant log archiving.

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

Parameter	Description
connection_control_failed_connections_threshold	Specifies the threshold for failed login attempts.
connection_control_min_connection_delay	Specifies the minimum lock duration after the number of failed login attempts exceeds the threshold.
connection_control_max_connection_delay	Specifies the maximum lock duration for failed login attempts. The lock duration does not increase beyond this maximum.

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

Parameter	Description
enable_window_compaction	Specifies whether to enable window compaction for the current tenant.
mds_minor_compact_trigger	Specifies the number of SSTables that triggers MDS minor compaction.
mds_compaction_mid_thread_score	Specifies the number of DAG (direct acyclic graph) threads for MDS compaction with medium priority.
mds_compaction_high_thread_score	Specifies the number of DAG (direct acyclic graph) threads for MDS compaction with high priority.
default_progressive_merge_num	Specifies the default number of progressive major compactions for a new table.
major_freeze_duty_time	Specifies the time when major compactions and freezes are triggered daily.
major_compact_trigger	Specifies the number of major freezes that triggers a major compaction.
minor_compact_trigger	Specifies the number of SSTables that triggers minor compaction.
undo_retention	Specifies the range of multi-version data to be retained, in seconds. This parameter controls the recycling of multi-version data during minor compaction.
merger_check_interval	Specifies the scheduling interval of the thread that checks the status of major compactions.
freeze_trigger_percentage	Specifies the memory usage threshold of the tenant that triggers a global 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 column statistics during major compaction.
merge_thread_count	Specifies the number of threads for daily major compactions.
merger_completion_percentage	Specifies the percentage of replicas that are completed in a major compaction. When this threshold is reached, the current major compaction is considered complete.
merger_switch_leader_duration_time	Specifies the time interval for batch leader switching during daily major compactions.
merger_warm_up_duration_time	Specifies the warm-up time for the new baseline data during major compaction.

Parameter	Description
arbitration_timeout	Specifies the timeout period for automatic downgrade.

Parameter	Description
enable_ttl	Specifies whether to enable the TTL feature in SQL mode.
ttl_duty_time	Specifies the time when the TTL task is triggered periodically.

Parameter name	Description
sql_work_area	Sets the working memory of a tenant.
max_stale_time_for_weak_consistency	Sets the maximum staleness of data that can be read in a weak-consistency read.

OceanBase

Customer Stories

Documentation

Overview

Cluster-level parameters

Security

Backup and restore

cgroup

CPU-related

Read/write/query-related

Load balancing

Replica-related

Cache-related

Partition-related

Background execution thread-related

I/O related

Cluster-related

Bandwidth-related

Location Cache-related

Directory paths

Memory-related

PX-related parameters

Others

Log service

Root Service

RPC authentication

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

Scale-in and scale-out

Backup and restore

Partitioning

Background execution threads

Cache-related

I/O-related

Compatibility-related

Note

Routing-related

LOB data-related

Memory-related

Disk space-related

OBKV-related

PL-related

Direct load

PX

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

Arbitration service

Time-to-live (TTL)

Not supported