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

Parameter	Description
mysql_port	Specifies the port number of the SQL service protocol.
rpc_port	Specifies the port number of the remote access protocol.
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 SSL feature of OceanBase Database to run. The information is recorded 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 period during which backup data can be restored.
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 server.
log_archive_checkpoint_interval	Specifies the interval between checkpoints for cold data log archiving.
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 an 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 for CPU and memory resource imbalance in the node load balancing strategy.
server_cpu_quota_max	Specifies the maximum CPU quota that can be used by the system.
server_cpu_quota_min	Specifies the minimum CPU quota that can be used by the system. The system automatically reserves this quota.
token_reserved_percentage	Specifies the percentage of idle tokens reserved for each tenant in the CPU scheduling of a tenant.
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 between multiple units of a tenant.

Parameter	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 threshold for query execution time. 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.

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 period for background tasks such as load balancing.
balancer_tolerance_percentage	Specifies the tolerance for disk imbalance between 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 node load balancing strategy.
resource_hard_limit	Specifies the over-subscription percentage of CPU resources.
enable_sys_unit_standalone	Specifies whether to enable the exclusive node feature for the system tenant.
balancer_emergency_percentage	Specifies the Unit load threshold. When the load of a Unit exceeds this threshold, the system allows replicas to be migrated out, even during major compactions.
balancer_timeout_check_interval	Specifies the interval at which the timeout period for background tasks such as load balancing is checked.
data_copy_concurrency	Specifies the maximum number of concurrent data migration and replication tasks that can be executed 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 load balancing strategy. This parameter is usually not manually configured.
resource_soft_limit	Specifies whether to enable Unit load balancing.

Parameter	Description
unit_gc_wait_time	Specifies the maximum wait time for unit garbage collection. If the wait time exceeds this threshold, garbage collection is forced.
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 period 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 this 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 for background tasks related to replica election.
election_blacklist_interval	Specifies the interval during which a removed leader cannot be elected again.
enable_auto_leader_switch	Specifies whether to enable automatic leader switching.
enable_smooth_leader_switch	Specifies whether to enable smooth leader switching.
global_index_build_single_replica_timeout	Specifies the timeout period for building a global index on each replica.
get_leader_candidate_rpc_timeout	Specifies the timeout period for internal requests to obtain candidate leaders 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 a standby replica and those of the primary replica. If the gap exceeds this threshold, the replica is rebuilt.
server_data_copy_out_concurrency	Specifies the maximum number of concurrent data migrations from a single node.
server_data_copy_in_concurrency	Specifies the maximum number of concurrent data migrations to a single node.
replica_safe_remove_time	Specifies the safe retention period for deleted replicas.

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

Parameter	Description
tablet_meta_table_check_interval	The interval at which the background thread checks the DBA_OB_TABLET_REPLICAS and CDB_OB_TABLET_REPLICAS views.
tablet_meta_table_scan_batch_count	The number of tablets cached in memory by the tablet meta table iterator.
tablet_size	The size of each tablet during parallel processing (such as major compactions and queries) in a partition.
auto_broadcast_location_cache_rate_limit	The maximum number of partitions for which location information can be broadcasted per second on each OBServer node.
auto_refresh_location_cache_rate_limit	The maximum number of partitions for which the location cache 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 in a partition to be archived before performing partition garbage collection.
partition_table_check_interval	The interval at which an OBServer node deletes non-existent replicas from a partition table.

Parameter	Description
sql_net_thread_count	The number of MySQL cluster I/O threads, that is, the number of `global_sql_nio_server` threads. The default value of 0 indicates that the value of this parameter is the same as that of the `net_thread_count` parameter.
auto_leader_switch_interval	The interval at which the background thread performs automatic leader switching.
switchover_process_thread_count	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 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 be in the `ERROR` state.
sys_bkgd_io_high_percentage	Specifies the maximum percentage of system background I/O resources that can be occupied.
sys_bkgd_io_low_percentage	Specifies the minimum percentage of system background I/O resources that can be occupied.
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 the block cache for a single I/O aggregation read.
multiblock_read_size	Specifies the size of I/O aggregation for data reading.

Parameter name	Description
all_server_list	Displays the addresses of all servers in the cluster.
cluster	Sets the name of the OceanBase cluster.
cluster_id	Sets the ID of the OceanBase cluster.
rpc_timeout	Sets the timeout 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 machine where 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 RPC connections.
ob_ratelimit_stat_period	Sets the interval for OBServer nodes to calculate and update the maximum bandwidth.

Parameter name	Description
virtual_table_location_cache_expire_time	Sets the expiration time for virtual table location cache.
location_cache_refresh_rpc_timeout	The timeout for refreshing `location_cache` via RPC.
location_cache_refresh_sql_timeout	The timeout for refreshing `location_cache` via SQL.
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 concurrency for single-machine location_cache refresh.
location_refresh_thread_count	Sets the number of threads for OBServer nodes to fetch partition location information from the Root Service.
enable_auto_refresh_location_cache	Sets whether to enable automatic refresh of location cache information.

Parameter name	Description
config_additional_dir	Specifies multiple directories for storing configuration files for 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 (which will be initialized by the OceanBase Database system for data storage).
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 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 a pause in writes for non-`sys` tenants.
leak_mod_to_check	For internal debugging, used to check for memory leaks.
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.
memory_reserved	The amount of memory reserved for KVCache.
memstore_limit_percentage	The percentage of memory used by MemStore relative to the tenant's total available memory.
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 increment size for automatic expansion of disk files.
storage_meta_cache_priority	Controls the priority of storage Meta Cache in kvcache.

Parameter	Description
px_workers_per_cpu_quota	Specifies the ratio of parallel execution worker threads.
px_task_size	Specifies the amount of data processed by each task in the SQL parallel query engine.
max_px_worker_count	Specifies the maximum number of threads used by the SQL parallel query engine.

Parameter name	Description
builtin_db_data_verify_cycle	The data block verification cycle, in days. A value of 0 indicates that no verification is performed.
data_storage_warning_tolerance_time	The time that the data disk can be in the WARNING state.
dead_socket_detection_timeout	The interval for detecting a failed socket.
migration_disable_time	The time that a node is paused when data migration fails due to a full disk.
schema_history_expire_time	The time when metadata history data expires.
datafile_size	The size of a data file. This parameter is not required.
devname	The name of the network interface card (NIC) that the service process is bound to.
enable_perf_event	Whether to enable the collection of performance event information.
enable_record_trace_id	Whether to record the trace ID set by the application.
enable_upgrade_mode	Whether to enable the upgrade mode. In the upgrade mode, some system background features are paused.
enable_ddl	Whether to allow DDL operations.
ob_enable_utl_tcp	Whether to enable the UTL_TCP system package.
high_priority_net_thread_count	The number of high-priority network threads. A value of `0` indicates that this feature is disabled.
obconfig_url	The URL address of the OBConfig service.
rpc_port	The port number of the protocol 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 generally not required.
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 schema multi-version record recycling tasks executed internally by the system.
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 OceanBase File System (OFS) for each zone. OFS is a distributed storage system independently designed by OceanBase Database. These URLs are mainly used for RootService to access files across zones in OFS deployment mode.
async_ps_cursor_max_count	Controls 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 used 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 interval between the Root Service waiting for and checking the cluster status after it starts.
rootservice_memory_limit	Specifies the maximum memory capacity limit of the Root Service.
lease_time	Specifies the lease period for heartbeats.
server_check_interval	Specifies the interval for checking the consistency of the Server table.
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. 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 switch commands sent by the RootService.

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

Parameter 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 interval between 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 of all servers in the standby tenant cluster for synchronizing logs from the primary tenant cluster.
log_storage_warning_tolerance_time	Specifies the time from when I/O fails on the log disk to when the disk is marked as faulty.
clog_disk_utilization_threshold	Specifies the watermark for reusing the space of the clog or ilog disk.
clog_expire_days	Specifies the expiration time of the clog file. If the last modification time of the clog file is more than the expiration time, the file will be deleted.
clog_cache_priority	Specifies the priority of the cache space occupied by the transaction log.
clog_disk_usage_limit_percentage	Specifies the maximum percentage of the available disk space for the transaction log.
clog_sync_time_warn_threshold	Specifies the threshold for transaction log synchronization time. If the synchronization time exceeds this threshold, a warning log will be 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 needs to be killed due to freezing or switchover.

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

Parameter	Description
debug_sync_timeout	Enables the Debug Sync feature and specifies 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 the system sends a keepalive probe if no data is sent after the client connection is established.
tcp_keepintvl	Specifies the time interval in seconds between two consecutive keepalive probes.
tcp_keepcnt	Specifies the maximum number of retries before a non-active connection is closed.

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

Parameter name	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 during the recycling process.
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 the system log.
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 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 name	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 used when creating tables in Oracle mode.
tableapi_transport_compress_func	Specifies the compression algorithm used for transmitting query results in 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 automatic global major freeze.
micro_block_merge_verify_level	Specifies the verification level for macroblocks during major compactions.
row_compaction_update_limit	Specifies the number of updates that trigger in-memory row compaction.
enable_global_freeze_trigger	Specifies whether to enable automatic global freeze.
enable_merge_by_turn	Specifies whether to enable the turn-based merge strategy.
enable_manual_merge	Specifies whether to enable manual major compactions.
global_major_freeze_residual_memory	Specifies the remaining memory threshold for triggering global major freeze. That is, when the remaining memory is less than this percentage, global major freeze is triggered.
minor_deferred_gc_time	Specifies the interval between major compactions and the delayed garbage collection of SSTables.
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 the deployment.
zone_merge_order	Specifies the order for rotating zone merges. 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 pre-warming time for generating new minor compaction files.
row_purge_thread_count	Specifies the maximum number of worker threads for in-memory row compaction.

Parameter name	Description
arbitration_degradation_policy	Specifies the degradation policy.
ob_startup_mode	Specifies the startup mode of the 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 and data disks are independent.
enable_global_background_resource_isolation	Enables global foreground and background resource isolation.
global_background_cpu_quota	Specifies the CPU quota for background tasks when global foreground and background resource isolation is enabled.

Parameter 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 transparent tablespace encryption method.
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 table organization mode for default table creation.
default_table_merge_engine	Specifies the `merge_engine` for default table creation in a user tenant.
default_delta_format	Specifies the default incremental data storage format for table creation.

Parameter name	Description
cpu_quota_concurrency	Specifies the maximum number of concurrent sessions 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 read `query_response_time_range_base` again.
query_response_time_range_base	Specifies the interval for collecting time parameters for the `information_schema.QUERY_RESPONSE_TIME` view.

Parameter	Description
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 be exclusive to a group of units.
balancer_idle_time	Specifies the interval at which the background task threads for load balancing are awakened 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 `enable_rebalance` is disabled.
partition_balance_schedule_interval	Specifies the partition balancing scheduling cycle.
enable_database_sharding_none	Specifies whether to enable automatic aggregation when creating a database.

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 scaling-out factor for log streams, 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 data 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 data import phase of table-level restore.
log_restore_concurrency	Specifies the concurrency level for log restoration.
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 the auto-partitioning feature for the tenant.
auto_split_tablet_size	Specifies the threshold for triggering auto-partitioning for the tenant.
global_index_auto_split_policy	Specifies whether to enable the auto-partitioning feature for newly created global indexes. The default value is `DISTRIBUTED`.

Parameter name	Description
attach_shared_sstable_thread_score	Specifies the number of threads available to the tenant for executing shared data reference tasks 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 threads for low-priority major compactions.
compaction_high_thread_score	Specifies the number of threads for high-priority major compactions.
compaction_mid_thread_score	Specifies the number of threads for medium-priority major compactions.
ha_high_thread_score	Specifies the number of threads for high-priority high-availability threads.
ha_mid_thread_score	Specifies the number of threads for medium-priority high-availability threads.
ha_low_thread_score	Specifies the number of threads for low-priority high-availability threads.
ob_compaction_schedule_interval	Specifies the time 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 to be scheduled in each batch during major compaction scheduling.
tenant_sql_login_thread_count	Specifies the number of threads for MySQL tenant logins, 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 frequency of hot macroblock cache cleanup tasks at the macroblock level in Shared-Storage (SS) mode.
default_storage_cache_policy	Specifies the default cache strategy.
enable_manual_storage_cache_policy	Specifies whether to enable the user-defined hot cache strategy.
suspend_storage_cache_task	Specifies whether to suspend the background cache task.
enable_adaptive_plan_cache	Specifies whether to enable the adaptive plan cache (Plan Cache) feature for the tenant.
result_cache_max_size	Specifies the maximum memory size 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 eviction watermark for `result cache`.
ob_deterministic_udf_cache_max_size	Specifies the maximum memory size that can be used by all `deterministic` UDFs in the cache pool 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	Specifies the compatibility behavior for related features in the tenant. This parameter cannot be set.

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

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 resources occupied by the vector index module. The unit is a percentage.
range_optimizer_max_mem_size	Specifies the maximum memory used by the Query Range module.
rpc_memory_limit_percentage	Specifies the maximum memory 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 applies only to periodic TTL tasks. User control commands are not affected by this parameter.Notice: The TTL feature is available only in the OceanBase Database 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 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 the group commit of OBKV.
kv_group_commit_rw_mode	Specifies whether to enable the 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 information to the exception messages in PLSQL.

Parameter	Description
default_load_mode	Specifies the import mode for data import scenarios.
direct_load_allow_fallback	Specifies whether to fallback to the standard 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 for the number of parallel threads.
px_target_low_watermark	Specifies the low watermark percentage 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 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 work area.
open_cursors	Specifies the maximum number of cursors that can be opened simultaneously in a single session.
ob_ssl_invited_common_names	Records the list of application identities for the current tenant. The identities are obtained from the `cn` field (common name) in the `subject` of the client certificate in SSL mutual authentication.
ob_enable_batched_multi_statement	Specifies whether to enable the batched multi-statement execution optimization.
job_queue_processes	Specifies the maximum number of tasks that can run simultaneously for each tenant to control resource contention.
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 Extended ROWID mode.
dump_data_dictionary_to_log_interval	Specifies the persistence cycle for 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 single batch for the columnar engine.
default_skip_index_level	Specifies the default value of `skip_index_level` when creating tables in the tenant.

Parameter name	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 multiplied by this value, log writing is 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 multiplied by this value, log file reuse is performed.
writing_throttling_maximum_duration	Controls the writing speed by controlling the memory allocation progress. That is, specifies the time required to allocate the remaining MemStore memory after the writing speed is throttled.
writing_throttling_trigger_percentage	Specifies the writing speed threshold.
standby_db_fetch_log_rpc_timeout	Specifies the timeout period for log fetching RPCs from the standby database. This parameter controls the standby database log transmission service to detect when a server in the primary database is unavailable and switch to another server.
log_disk_throttling_percentage	Specifies the percentage of unrecyclable log disk space that triggers log writing throttling.
log_transport_compress_all	Specifies whether to use compression for log transmission.
log_transport_compress_func	Specifies the compressor for log transmission.
clog_max_unconfirmed_log_count	Specifies the maximum number of unconfirmed logs in the transaction module.
clog_persistence_compress_func	Specifies the compression algorithm for transaction log persistence.
enable_clog_persistence_compress	Specifies whether to enable transaction log persistence compression.

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

Parameter name	Description
enable_lock_priority	Lock priority switch.

Parameter name	Description
external_table_io_hole_size	Specifies the maximum distance between two consecutive I/O ranges, in bytes.
external_table_io_range_size	Specifies the maximum size of a major compaction range, in bytes.

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

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

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 exceeding the threshold for failed login attempts.
connection_control_max_connection_delay	Specifies the maximum lock duration for failed login attempts. The lock duration does not increase after it reaches this maximum.

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 in a microblock Encoding.

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 freeze and major compaction are triggered daily.
major_compact_trigger	Specifies the number of major freezes that triggers a major compaction.
minor_compact_trigger	Specifies the threshold of the number of SSTables that triggers minor compaction.
undo_retention	Specifies the time period for which multiple versions of data are retained. The unit is seconds. During minor compaction, multiple versions of data are recycled.
merger_check_interval	Specifies the scheduling interval of the thread that checks the status of major compaction.
freeze_trigger_percentage	Specifies the memory usage threshold of the tenant that triggers global freeze.
max_kept_major_version_number	Specifies the maximum 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 between batch leader switches during daily major compactions.
merger_warm_up_duration_time	Specifies the warm-up time for 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 amount of working memory for the tenant.
max_stale_time_for_weak_consistency	Sets the maximum staleness allowed for weak-consistency reads.

OceanBase

Customer Stories

Documentation

Overview of parameters

Cluster-level parameters

Security

Backup and restore

cgroup

CPU related

Read/write/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 path related

Memory-related

PX-related

Other

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

Compaction and major freeze

Arbitration service

Time-to-live (TTL)

Parameters not supported