This topic describes the cluster-level and tenant-level parameters of OceanBase AI Database. The parameters are categorized by their functions.
Cluster-level parameters
Security
Parameter name |
Feature description |
|---|---|
| mysql_port | The port number of the SQL service protocol. |
| rpc_port | Specifies the protocol port number for remote access. |
| sql_protocol_min_tls_version | This parameter specifies the minimum version of the SSL/TLS protocol to be used for SSL connections when executing SQL statements. |
| ssl_client_authentication | Specifies whether to enable the SSL connection feature. |
| ssl_external_kms_info | Used to record information required for the SSL feature of OceanBase AI Database to operate. It records the configuration details of dependencies under different SSL usage modes in a JSON string format. The JSON string must contain at least the type.ssl_modefield. |
| enable_sql_audit | Specifies whether to enable the SQL audit feature. |
cgroup-related
Parameter name |
Feature description |
|---|---|
| enable_cgroup | It is used to control whether to enable the cgroup feature for the OBServer node. |
CPU
Parameter name |
Feature description |
|---|---|
| cpu_count | Specifies the total number of system CPUs. If you set this parameter to 0, the system automatically detects the number of CPUs. |
| server_balance_cpu_mem_tolerance_percent | In the node load balancing strategy, this parameter specifies the tolerance for CPU and memory resource imbalances. |
| server_cpu_quota_max | Sets the maximum CPU quota available for the system. |
| server_cpu_quota_min | Sets the minimum CPU quota available for the system, which is automatically reserved. |
| workers_per_cpu_quota | Specifies the number of worker threads allocated to each CPU. |
Read/write/query related
Parameter name |
Feature description |
|---|---|
| weak_read_version_refresh_interval | Sets the refresh interval for weak-consistency read version numbers, which affects the latency of weak-consistency reads. |
| large_query_worker_percentage | Sets the percentage of worker threads reserved for processing large queries. |
| large_query_threshold | The threshold for setting the query execution time. |
| trace_log_slow_query_watermark | Sets the execution time threshold for queries. If a query's execution time exceeds this threshold, it is considered a slow query, and its trace logs are printed to the system logs. |
Load balancing
Parameter name |
Feature description |
|---|---|
| balancer_log_interval | Sets the interval for statistical log printing by the threads of a disaster recovery task. |
| balancer_task_timeout | This parameter is used to set the timeout period for background tasks such as load balancing. |
| balancer_tolerance_percentage | This parameter specifies the tolerance for disk imbalance among multiple units within a tenant under the load balancing policy. If the disk usage falls within the mean ± tolerance range, no balancing action is triggered. |
| server_balance_critical_disk_waterlevel | Sets the watermarks for the load balancing feature that controls disk space usage. |
| server_balance_disk_tolerance_percent | This parameter specifies the tolerance for imbalance in the disk load balancing strategy among nodes. |
| resource_hard_limit | Specifies the CPU overprovisioning percentage. |
| enable_sys_unit_standalone | Specifies whether the unit of the system tenant is exclusive to a node. |
Replica-related
Parameter name |
Feature description |
|---|---|
| unit_gc_wait_time | Specifies the maximum wait duration for a unit GC. If the wait duration exceeds this limit, a forced GC is performed. |
| enable_rereplication | The master switch for automatic log stream replica migration replication. |
| ls_meta_table_check_interval | This parameter is used to set the check interval for the background inspection thread of the DBA_OB_LS_LOCATIONS or CDB_OB_LS_LOCATIONS view. |
| 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 allowed when a replica migration fails. |
Cache-related
Parameter name |
Feature description |
|---|---|
| bf_cache_miss_count_threshold | Controls the number of times the Bloomfilter cache is triggered. The Bloomfilter cache is created when the number of misses in a macroblock reaches this value. |
| bf_cache_priority | Sets the Bloom filter cache priority. |
| cache_wash_threshold | The capacity threshold for triggering cache cleanup. |
| fuse_row_cache_priority | This parameter specifies the priority of the fused row cache in the caching system. |
| user_row_cache_priority | Sets the priority of baseline data row cache in the caching system. |
| autoinc_cache_refresh_interval | Sets the refresh interval for the auto-increment column cache. |
| plan_cache_evict_interval | Sets the eviction time interval for the plan cache. |
| index_block_cache_priority | Sets the cache priority for metadata index microblocks. |
| opt_tab_stat_cache_priority | Sets the cache priority for statistics. |
| tablet_ls_cache_priority | Sets the tablet mapping cache priority. |
| user_block_cache_priority | Sets the priority of a data block cache in the caching system. |
Partitioning
Parameter name |
Feature description |
|---|---|
| tablet_meta_table_check_interval | This parameter is used to set the check interval for the background inspection thread of the DBA_OB_TABLET_REPLICAS or CDB_OB_TABLET_REPLICAS view. |
| tablet_meta_table_scan_batch_count | Specifies the number of tablets cached in memory during the iteration of a tablet meta table. |
| tablet_size | It specifies the size of each shard during internal parallel processing (such as major compactions and queries) within a partition. |
Backend Execution Threads
Parameter name |
Feature description |
|---|---|
| sql_net_thread_count | It specifies the number of I/O threads in the cluster.global_sql_nio_serverThe number of threads. The default value of 0 indicates that the number of threads is determined by the parameternet_thread_counthave the same value. |
I/O-related
Parameter name |
Feature description |
|---|---|
| sync_io_thread_count | Configures the number of threads for synchronizing I/O requests. |
| syslog_io_bandwidth_limit | This parameter specifies the upper limit of disk I/O bandwidth that system logs can consume. System logs exceeding this bandwidth limit will be discarded. |
| disk_io_thread_count | The number of threads for disk I/O. The value must be an even number. |
| net_thread_count | Sets the number of network I/O threads. |
| data_storage_error_tolerance_time | Used to control the data disk status toERRORThe tolerance time for the status. |
Cluster-related
Parameter name |
Feature description |
|---|---|
| all_server_list | Displays the addresses of all servers in the cluster. |
| cluster | The name of the current OceanBase AI Database cluster. |
| cluster_id | The ID of the OceanBase AI Database cluster. |
| rpc_timeout | Sets the timeout period for internal requests within a cluster. |
| all_cluster_list | Displays the list of servers accessing the same config_url. |
| local_ip | The IP address of the server where the OBServer node is to be installed. |
| observer_id | The unique identifier for assigning RS to an OBServer node in a cluster. |
| min_observer_version | This API is used to view the lowest application version number of the OBServer node in the cluster. |
Bandwidth-related
Parameter name |
Feature description |
|---|---|
| enable_ob_ratelimit | This API is used to enable inter-region rate limiting in an RPC connection. |
| ob_ratelimit_stat_period | The time interval for calculating and updating the maximum bandwidth on an OBServer node. |
Location cache related
Parameter name |
Feature description |
|---|---|
| virtual_table_location_cache_expire_time | Sets the cache expiration time for the location information of virtual tables. |
| location_cache_refresh_rpc_timeout | Refresh via RPClocation_cacheThe timeout period. |
| location_cache_refresh_sql_timeout | Refresh via SQLlocation_cacheThe timeout period. |
| location_cache_refresh_min_interval | Sets the minimum interval for refreshing location cache requests to prevent excessive refresh requests from overwhelming the system. |
| location_cache_cpu_quota | Sets the CPU quota for the location caching module. |
| location_fetch_concurrency | Sets the maximum concurrency for refreshing the local cache on a single node. |
| location_refresh_thread_count | Specifies the number of threads used by an OBServer node to obtain partition location information from the root service. |
Directory path related
Parameter name |
Feature description |
|---|---|
| config_additional_dir | Specifies multiple directories for storing configuration files locally to achieve redundant storage of multiple configuration file copies. |
| data_dir | Specifies the directory for storing data such as SSTables. |
Memory space related
Parameter name |
Feature description |
|---|---|
| datafile_disk_percentage | It indicates the percentage of the total space on the disk where data_dir is located that is occupied. The disk where data_dir resides will be initialized by the OceanBase AI Database system for data storage. |
| data_disk_usage_limit_percentage | It specifies the maximum percentage of data files that can be written. When this threshold is exceeded, data migration in is prohibited. |
| enable_sql_operator_dump | Specifies whether to allow intermediate results of SQL processing to be written to disk to free up memory. |
| leak_mod_to_check | This feature is used for memory leak detection and is an internal debugging tool. |
| memory_chunk_cache_size | Sets the memory block capacity cached by the memory allocator. |
| memory_limit | Indicates the total available memory size. |
| memory_limit_percentage | Sets the percentage of total memory that the system's available memory size occupies. |
| memory_reserved | This parameter specifies the memory size reserved for system underlying modules. |
| memstore_limit_percentage | Sets the percentage of a tenant's total available memory that can be used by the MemStore. |
| system_memory | Used to set the system-reserved ID for the tenant to500The memory capacity of the tenant. |
| use_large_pages | Manages large memory pages used by the database. |
| datafile_maxsize | Specifies the maximum size for automatic disk file expansion. |
| datafile_next | Specifies the growth step for automatic disk file expansion. |
| storage_meta_cache_priority | Used to control the priority of storing Meta Cache in KVCache. |
PX-related
Parameter name |
Feature description |
|---|---|
| px_task_size | This parameter specifies the amount of data processed by each task in the SQL parallel query engine. |
Others
Parameter name |
Feature description |
|---|---|
| builtin_db_data_verify_cycle | Specifies the self-check cycle for bad data blocks, in days. A value of 0 indicates no check. |
| data_storage_warning_tolerance_time | Specifies the tolerance period for setting the data disk status to WARNING. |
| dead_socket_detection_timeout | Specifies the time interval for detecting invalid sockets. |
| migration_disable_time | This parameter specifies the duration for which data migration to a node is paused when the migration fails due to reasons such as full disk space. |
| schema_history_expire_time | Sets the expiration time for historical metadata data. |
| datafile_size | Specifies the size of the data file. This parameter is generally not required. |
| devname | Specifies the name of the network interface card device bound to the service process. |
| enable_perf_event | Specifies whether to enable the performance event collection feature. |
| 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 functions are suspended. |
| enable_ddl | It specifies whether to allow DDL operations. |
| high_priority_net_thread_count | The number of high-priority network threads. Value:0indicates that this feature is disabled. |
| obconfig_url | The URL address of the OBConfig service. |
| rpc_port | Specifies the protocol port number for remote access. |
| stack_size | Sets the size of the program function call stack. |
| tenant_task_queue_size | Sets the request queue size for each tenant. |
| zone | The name of the zone where the node is located. This parameter generally does not need to be configured. |
| recyclebin_object_expire_time | Used to automatically purge expired schema objects from the recycle bin. |
| default_row_format | Sets the default row format used when creating a table. |
| sys_bkgd_net_percentage | Specifies the percentage of network bandwidth that can be occupied by background system tasks. |
| schema_history_recycle_interval | Used to set the internal execution of the system.schemaThe time interval for recycling multi-version records. |
| enable_asan_for_memory_context | When using ob_asan, this parameter specifies whether to allow ObAsanAllocator (the default is ObAllocator as the MemoryContext allocator). |
| async_ps_cursor_max_count | Controls the maximum number of asynchronous PS cursors allowed on a single node. |
Log Service
Parameter name |
Feature description |
|---|---|
| enable_logservice | A switch for controlling the logging service mode. |
| logservice_access_point | Used to persist the log service access point. |
| sys_ckpt_thread_score | It is used to set the worker thread score for cluster-level LS checkpoints, control the task concurrency of the LS checkpoint scheduling queue, and determine the upload concurrency for the Bootstrap checkpoint during the initial cluster creation. |
Root Service
Parameter name |
Feature description |
|---|---|
| rootservice_async_task_queue_size | Sets the size of the internal asynchronous task queue for the Root Service. |
| rootservice_async_task_thread_count | Sets the thread pool size for asynchronous tasks within the Root Service. |
| rootservice_list | Displays the list of servers where the root service and its replicas are located. |
| rootservice_ready_check_interval | Specifies the interval for waiting and checking the cluster status after the root service starts. |
| lease_time | Sets the duration of a heartbeat lease. |
| server_check_interval | Sets the time interval for consistency checks on server tables. |
| server_permanent_offline_time | This parameter specifies the time threshold for detecting a node heartbeat interruption. That is, after a node's heartbeat is interrupted for this duration, it is considered permanently offline, and its data replicas need to be automatically replenished. |
| ob_event_history_recycle_interval | Specifies the interval for reclaiming historical events. |
RPC Authentication
Parameter name |
Feature description |
|---|---|
| rpc_client_authentication_method | Specifies the security authentication method for the RPC client. |
| rpc_server_authentication_method | Sets the security authentication method for the RPC server. |
SQL-related
Parameter name |
Feature description |
|---|---|
| sql_login_thread_count | Sets the number of threads for processing SQL login requests. |
| enable_sys_table_ddl | Specifies whether to allow manual creation of system tables. |
| internal_sql_execute_timeout | Sets the time interval for internal DML requests in the system. |
Transactions and transaction logs
Parameter name |
Feature description |
|---|---|
| log_disk_size | Specifies the disk size for redo logs. |
| log_disk_percentage | Specifies the percentage of total disk space that redo logs can occupy. |
| dtl_buffer_size | Sets the cache size used by the SQL data transmission module. |
| ignore_replay_checksum_error | Specifies whether to ignore checksum errors that occur during the replay of transaction logs. |
| trx_2pc_retry_interval | Specifies the time interval for automatic retries when a two-phase commit fails. |
| standby_fetch_log_bandwidth_limit | It specifies the maximum total bandwidth that can be occupied per second for all servers in the cluster where the standby tenant resides to synchronize logs from the primary tenant. |
| log_storage_warning_tolerance_time | Specifies the time before the disk is marked as bad after failed I/O operations from the log disk trigger a leader switchover. |
| clog_sync_time_warn_threshold | Sets the alert threshold for transaction log synchronization duration. A WARN log is generated when the synchronization duration exceeds this value. |
| ignore_replay_checksum_error | Specifies whether to ignore checksum errors that occur during the replay of transaction logs. |
Debugging
Parameter name |
Feature description |
|---|---|
| debug_sync_timeout | This API is used to enable the debug sync debugging switch and set its timeout period. |
| enable_rich_error_msg | Specifies whether to add debugging information such as the server address, time, and trace ID to client messages. |
TCP-related
Parameter name |
Feature description |
|---|---|
| enable_tcp_keepalive | Enables or disables the keep-alive mechanism for client connections. |
| tcp_keepidle | Specifies the interval, in seconds, after which a Keepalive probe packet is sent if no data is transmitted over the client connection to the server. |
| tcp_keepintvl | Specifies the time interval, in seconds, between two consecutive probes when the keep-alive mechanism for client connections is enabled. |
| tcp_keepcnt | Specifies the maximum number of retries before closing an inactive connection. |
System logs
Parameter name |
Feature description |
|---|---|
| alert_log_level | Sets 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 | This parameter specifies whether to enable the log retention feature for OBServer nodes. The log retention feature retains the logs generated by the OBServer node before it is started.max_syslog_file_countUsed together, they determine whether the recycling logic will consider old log files. |
| enable_syslog_wf | Specifies whether to log system logs of WARN level and above to a separate log file. |
| max_string_print_length | Sets the maximum length of a single line in system logs that can be printed. |
| max_syslog_file_count | Specifies the maximum number of log files that can be retained before log files are recycled. |
| syslog_level | Sets the system log level. |
| diag_syslog_per_error_limit | It specifies the maximum number of DIAG system logs allowed per second for each error code. Logs exceeding this threshold will no longer be printed. |
Compression Algorithms
Parameter name |
Feature description |
|---|---|
| default_compress_func | It is used to set the default compression algorithm for table data. Other compression algorithms can also be specified when creating a table. |
| kv_transport_compress_func | Sets the compression algorithm used for transmitting query results in OBKV-Table. |
Minor compaction and major compaction related
Parameter name |
Feature description |
|---|---|
| enable_major_freeze | Specifies whether to enable automatic global freeze. |
| micro_block_merge_verify_level | Sets the verification level for macroblocks during major compaction. |
| row_compaction_update_limit | Specifies the number of modifications that trigger in-memory minor compactions for row data. |
Resource isolation
Parameter name |
Feature description |
|---|---|
| clog_io_isolation_mode | Determines whether I/O requests to the clog disk are subject to resource isolation based on whether the clog disk and data disk are independent. |
| enable_global_background_resource_isolation | Enables global resource isolation for foreground and background processes. |
| global_background_cpu_quota | Controls the CPU quota for background tasks when global foreground/background resource isolation is enabled. |
Tenant-level parameters
Security
Parameter name |
Feature description |
|---|---|
| sts_credential | Specifies the credentials for accessing the STS service provided by OCP. |
| external_kms_info | Used to store key management information. |
| tde_method | Specifies the method for setting up transparent tablespace encryption. |
| audit_sys_operations | Specifies whether to track the operational behavior of system users. |
| audit_trail | Specifies whether to enable database auditing. |
Storage-related
Parameter name |
Feature description |
|---|---|
| default_table_organization | Specifies the default table organization mode for creating tables. |
| default_table_merge_engine | Used to specify the default table creation parameters for user tenants.merge_engine. |
| default_delta_format | This parameter specifies the default incremental data storage format when a table is created. |
CPU
Parameter name |
Feature description |
|---|---|
| cpu_quota_concurrency | Sets the maximum concurrency allowed for each CPU quota of a tenant. |
Read/write and query
Parameter name |
Feature description |
|---|---|
| enable_monotonic_weak_read | Specifies whether to enable monotonic read. |
| query_response_time_stats | Used to specify whether to enableinformation_schema.QUERY_RESPONSE_TIMEStatistics collection for views. |
| query_response_time_flush | Used to specify whether to refresh.information_schema.QUERY_RESPONSE_TIMEView and rereadquery_response_time_range_base. |
| query_response_time_range_base | Used to setinformation_schema.QUERY_RESPONSE_TIMEThe interval for collecting view time parameters. |
Load balancing
Parameter name |
Feature description |
|---|---|
| enable_ls_leader_balance | Controls whether to enable automatic leader balancing for log streams. |
| enable_gts_standalone | This parameter specifies whether to enable the feature that allows a tenant's GTS service to exclusively use a set of units. |
| balancer_idle_time | This parameter specifies the wake-up interval for idle threads of background tasks, such as those related to load balancing. |
| enable_rebalance | This parameter specifies whether to enable automatic load balancing. |
| enable_transfer | Specifies whether to allow data transfer within a tenant. If this parameter is disabled, data transfer between tenants is not allowed.enable_rebalanceThis parameter is invalid. |
| partition_balance_schedule_interval | The partition balancing scheduling cycle. |
| enable_database_sharding_none | It is used to control whether to enable automatic aggregation for user tables when creating a database. |
Replica-related
Parameter name |
Feature description |
|---|---|
| replica_parallel_migration_mode | Specifies the mode for the parallel migration of log stream replicas. |
| choose_migration_source_policy | Specifies the priority strategy for selecting source replicas during migration. |
Scaling
Parameter name |
Feature description |
|---|---|
| ls_scale_out_factor | The expansion factor of log streams, which controls the number of log streams for a tenant on each service node. |
Backup and Recovery
Parameter name |
Feature 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 | Sets the concurrency for log restore. |
| log_archive_concurrency | Specifies the concurrency for log archiving. |
| backup_data_file_size | Specifies the maximum file size for a single data backup file. |
Partition-related
Parameter name |
Feature description |
|---|---|
| enable_auto_split | Controls whether to enable automatic partitioning for the tenant. |
| auto_split_tablet_size | This parameter specifies the threshold for triggering a split after the auto-partitioning feature is enabled for this tenant. |
| global_index_auto_split_policy | Specifies whether to enable automatic partitioning for the new global index. Default value:DISTRIBUTED. |
Backend Execution Threads
Parameter name |
Feature description |
|---|---|
| px_workers_per_cpu_quota | Sets the proportion of worker threads for parallel execution. |
| attach_shared_sstable_thread_score | Configures the number of threads a tenant can use to compute shared data references on nodes. |
| inc_sstable_upload_thread_score | Configures the number of threads a tenant can use to compute data sharing tasks. |
| shared_gc_executor_thread_score | Specifies the number of threads that can concurrently perform shared data garbage collection tasks. |
| shared_gc_generator_thread_score | Specifies the number of threads that can be used to generate shared data for GC tasks. |
| ddl_thread_score | Specifies the number of threads used by the DDL task. |
| compaction_low_thread_score | Sets the number of worker threads for low-priority compaction. |
| compaction_high_thread_score | Sets the number of worker threads for high-priority compaction. |
| compaction_mid_thread_score | Sets the number of worker threads for medium-priority compaction. |
| ha_high_thread_score | Sets the current number of worker threads for high-priority threads in high-availability mode. |
| ha_mid_thread_score | Sets the number of worker threads for priority threads in high availability mode. |
| ha_low_thread_score | Sets the current number of worker threads for high-availability, low-priority threads. |
| ob_compaction_schedule_interval | The time interval for setting the Compaction scheduling. |
| compaction_dag_cnt_limit | Specifies the maximum number of DAGs allowed in the compaction DAG queue. |
| compaction_schedule_tablet_batch_cnt | Specifies the maximum number of partitions to be scheduled in each batch during compaction scheduling. |
| tenant_sql_login_thread_count | Sets the number of threads for user tenant login, that is,mysql_queueNumber of threads. The default value of 0 indicates to take the maximum number of available threads.unit_min_cpuThe value of . |
| tenant_sql_net_thread_count | It specifies the number of I/O threads for user tenants, that is,sql_nio_serverNumber of threads. The default value of 0 indicates to take the maximum number of threads available.unit_min_cpuThe value of . |
| ddl_high_thread_score | This parameter is used to modify the number of DAG threads for executing DDL KV merges. |
Cache-related
Parameter name |
Feature description |
|---|---|
| default_storage_cache_policy | Configures the default caching strategy. |
| enable_manual_storage_cache_policy | This parameter is used to enable a user-specified hotspot caching strategy. |
| suspend_storage_cache_task | Specifies whether to pause the background caching task. |
| enable_adaptive_plan_cache | This parameter specifies whether to enable adaptive plan cache for a tenant. |
| result_cache_max_size | Used to controlresult cacheThe maximum amount of memory that the module can use. |
| result_cache_max_result | Used to control a singleresult cacheThe maximum number of cache objects that can be used isresult_cache_max_sizeThe memory usage of the process. |
| ob_result_cache_evict_percentage | Used to setresult cacheMemory eviction watermark. |
| ob_deterministic_udf_cache_max_size | Used to mark the statement execution period. AlldeterministicThe maximum total memory that can be used by the cache pool of UDFs. |
Compatibility
Parameter name |
Feature description |
|---|---|
| enable_sql_extension | Specifies whether to enable the SQL extension feature for the tenant. |
| compatible | This parameter is used to control the compatibility behavior of related features under a tenant and cannot be set. |
Routing
Parameter name |
Feature description |
|---|---|
| ob_proxy_readonly_transaction_routing_policy | Controls whether the proxy's routing for transactions is affected by read-only statements. |
LOB Data
Parameter name |
Feature description |
|---|---|
| lob_enable_block_cache_threshold | Sets the threshold for caching LOB queries stored in OUTROW format. |
Memory space
Parameter name |
Feature description |
|---|---|
| ob_vector_memory_limit_percentage | Configures the threshold for memory resource usage by the vector index module, in percentage. |
| range_optimizer_max_mem_size | The memory used by the Query Range module. |
| rpc_memory_limit_percentage | Sets the maximum memory for RPCs in a tenant as a percentage of the tenant's total memory. |
| query_memory_limit_percentage | Specifies the percentage of tenant memory available for a single SQL statement. |
Disk space
Parameter name |
Feature description |
|---|---|
| temporary_file_max_disk_size | Sets the maximum disk space that temporary files on a single node of a tenant can occupy. |
OBKV-related
Parameter name |
Feature description |
|---|---|
| enable_kv_ttl | Controls whether to start the TTL background task. This parameter takes effect for periodic TTL tasks, but user management commands are not restricted by it. Note: The Time-To-Live (TTL) feature is limited to OceanBase Key-Value scenarios and is disabled in SQL scenarios. Otherwise, it may cause unexpected data deletion errors. |
| kv_ttl_duty_duration | You can set the trigger period for the daily scheduled TTL. The TTL task is triggered once within this period. |
| kv_group_commit_batch_size | Specifies the size of the batch operations executed during an OBKV group commit. |
| kv_group_commit_rw_mode | Used to control scenarios where group commits are performed. |
| kv_hbase_client_scanner_timeout_period | Sets the timeout period for OBKV-HBase streaming queries. |
| kv_ttl_history_recycle_interval | Specifies the retention period for historical TTL task records. |
| ttl_thread_score | Sets the number of worker threads used by the TTL task. |
| kv_ttl_delete_max_ops | Specifies the maximum number of operations for which a task can be deleted based on the TTL. |
PL-related
Parameter name |
Feature description |
|---|---|
| plsql_code_type | Specifies the compilation type for PL/SQL code. |
| plsql_debug | Specifies whether to compile the program into a debug version. |
| package_state_sync_max_size | Used to control the serializable length for a single package state. |
| ob_enable_java_udf | This parameter is used to enable or disable the Java UDF feature. |
| enable_pl_rich_error_msg | This parameter specifies whether to enable or disable the feature of appending additional information to exception messages in PL/SQL. |
Direct load related
Parameter name |
Feature description |
|---|---|
| default_load_mode | It is used to control the data import method in data import scenarios. |
| direct_load_allow_fallback | It specifies whether to roll back the data import operation to a normal import method when encountering scenarios not supported by direct load during the specified data import operation. |
| load_data_diagnosis_log_compression | Sets the compression algorithm used for diagnostic logs. |
| load_data_diagnosis_log_max_size | Sets the size of a single diagnostic log file. |
PX-related
Parameter name |
Feature description |
|---|---|
| px_target_high_watermark | The high-watermark percentage threshold for controlling the number of parallel threads. |
| px_target_low_watermark | The low-watermark percentage threshold for setting the number of parallel threads. |
| px_target_workers_per_cpu | It is used to control the desired ratio between the number of parallel execution threads and the number of tenant CPUs. |
Others
Parameter name |
Feature description |
|---|---|
| zone_deploy_mode | Sets the distribution pattern of tenants across zones. |
| enable_early_lock_release | This parameter specifies whether to enable the pre-row unlocking feature. |
| workarea_size_policy | It is used to set the strategy for manually or automatically adjusting the SQL workspace size. |
| open_cursors | Limits the number of cursors that a single session can open at the same time. |
| ob_ssl_invited_common_names | Records the list of application identities running under the current tenant. These identities are derived from the client-side certificates used in SSL mutual authentication.subjectin thecnField (common name). |
| ob_enable_batched_multi_statement | It is used to set whether to enable batch processing for grouped execution optimization. |
| default_auto_increment_mode | Sets the default auto-increment mode for auto-increment columns. |
| ob_query_switch_leader_retry_timeout | The maximum retry time for failed queries, in microseconds (μs). |
| default_enable_extended_rowid | Specifies whether to create the table in extended ROWID mode. |
| dump_data_dictionary_to_log_interval | Controls the persistence cycle of tenant data dictionaries. |
| enable_user_defined_rewrite_rules | A switch to control whether user-defined rules are enabled. |
| storage_rowsets_size | Controls the number of rows processed in a vectorized batch by the columnar storage engine. |
| approx_count_distinct_precision | Used to configureapprox_count_distinctThe result accuracy of the function. |
| default_skip_index_level | Used to specify whether to automatically create a primary key for tables in the tenant when they are created.skip_index_levelThe default value of . |
| sql_func_extension_mode | This function is used to control whether to enable the mainstream compatibility mode function for naming styles that are inconsistent with MySQL. |
| enable_ps_parameterize | It is used to control whether to parameterize PS statements during parsing. |
Transactions and transaction logs
Parameter name |
Feature description |
|---|---|
| log_disk_utilization_limit_threshold | Sets the threshold for the tenant log disk usage limit. When the tenant's log disk usage exceeds the total tenant log disk space multiplied by this value, log writing will be denied. |
| log_disk_utilization_threshold | Sets the threshold for tenant log disk usage. When a tenant's log disk usage exceeds the total tenant log disk space multiplied by this value, log file reuse is triggered. |
| writing_throttling_maximum_duration | The write speed is controlled by managing the memory allocation progress. Specifically, it specifies the time required to allocate the remaining MemStore memory after the write throttling is triggered. |
| writing_throttling_trigger_percentage | The threshold for the percentage of used memory in the MemStore that triggers write throttling relative to the maximum MemStore memory. |
| standby_db_fetch_log_rpc_timeout | Sets the RPC timeout period for log pulling from the standby database, which controls how long the standby database's log transfer service waits before detecting that a primary server is unavailable and switching to another server. |
| log_disk_throttling_percentage | The percentage of unreclaimable log disk space that triggers the log write throttling. |
| log_transport_compress_all | Specifies whether to compress log transmissions. |
| log_transport_compress_func | A compressor used for log transmission. |
Data types
Parameter name |
Feature description |
|---|---|
| json_document_max_depth | Specifies the maximum number of nested levels allowed in a JSON document. |
Lock-related
Parameter name |
Feature description |
|---|---|
| enable_lock_priority | Table lock priority switch. |
External tables
Parameter name |
Feature description |
|---|---|
| external_table_io_hole_size | Sets the maximum distance (in bytes) between two consecutive I/O ranges. |
| external_table_io_range_size | Sets the maximum size of the major compaction range, in bytes. |
| catalog_sync_target | Specifies the target Catalog for data synchronization. It is the HMS-type External Catalog used when synchronizing database and table metadata from an Internal catalog to HMS. If this parameter is empty, synchronization is disabled. |
System logs
Parameter name |
Feature description |
|---|---|
| log_disk_throttling_maximum_duration | This parameter specifies the maximum available time for the log disk after log throttling is triggered. |
| ls_gc_delay_time | Specifies the time after which tenant log streams are deleted. |
| standby_db_preferred_upstream_log_region | Specifies the preferred region for the standby tenant to synchronize upstream logs in a physical standby database scenario. |
| archive_lag_target | Specifies the delay before tenant log archiving starts. |
Materialized view related
Parameter name |
Feature description |
|---|---|
| enable_mlog_auto_maintenance | Controls whether to enable automatic materialized view log management. |
| mlog_trim_interval | It is used to control the scheduling cycle of the automatic mlog pruning task in the background. |
| enable_mv_binlog_minimal_mode | Used to control the incremental refresh scenario of materialized views.binlog minimalThe switch for the mode. |
| mv_refresh_concurrency | It specifies the maximum number of materialized view refresh tasks that can run concurrently within a tenant. |
User login related
Parameter name |
Feature description |
|---|---|
| connection_control_failed_connections_threshold | Specifies the threshold for user incorrect login attempts. |
| connection_control_min_connection_delay | Specifies the minimum duration for which a user account is locked after exceeding the number of failed login attempts. |
| connection_control_max_connection_delay | Specifies the maximum duration for lockout after failed login attempts. Once the duration reaches this maximum, it will no longer increase. |
Compression Algorithms
Parameter name |
Feature description |
|---|---|
| spill_compression_codec | Specifies the compression algorithm type for implementing data-on-disk compression during SQL execution. |
| ob_encoding_granularity | Sets the maximum number of rows for encoding a single microblock. |
Minor compaction and major compaction related
Parameter name |
Feature description |
|---|---|
| enable_window_compaction | Specifies whether the current tenant uses window merging. |
| mds_minor_compact_trigger | It is used to control the number of SSTables that trigger a minor compaction in MDS. |
| mds_compaction_mid_thread_score | Sets the number of DAG (direct acyclic graph) threads for medium-priority MDS compaction. |
| mds_compaction_high_thread_score | Sets the number of DAG (direct acyclic graph) threads for high-priority MDS compaction. |
| default_progressive_merge_num | Specifies the default number of progressive major compactions for a newly created table. |
| major_freeze_duty_time | Sets the trigger time for daily scheduled freeze and major compaction. |
| major_compact_trigger | Specifies how many major compactions are allowed before a minor compaction is triggered. |
| minor_compact_trigger | The threshold for the number of SSTables that triggers a minor compaction. |
| undo_retention | Specifies the duration for which the system retains multi-version data, in seconds. This duration controls the recycling of multi-version data during minor compactions. |
| merger_check_interval | Sets the scheduling interval for the major compaction status-check thread. |
| freeze_trigger_percentage | Sets the memory usage threshold for tenants that triggers a global freeze. |
Arbitration service related
Parameter name |
Feature description |
|---|---|
| arbitration_timeout | Sets the timeout period for triggering automatic downgrade. |
TTL related
Parameter name |
Feature description |
|---|---|
| enable_ttl | This parameter specifies whether to enable the TTL feature in SQL mode. |
| ttl_duty_time | Specifies the time point at which the backend periodically triggers the execution of the TTL task. |
AI Function Service
Parameter name |
Feature description |
|---|---|
| document_ai_file_max_size | Used to limitLOAD_FILEThe maximum file size that can be processed by the function at one time. |
Logical Table
Parameter name |
Feature description |
|---|---|
| enable_agent_db_background_task | Controls whether to enable background deletion tasks for logical tables. |
| agent_db_background_delete_thread_score | Sets the number of threads used to delete data from the logical table in the background. |
| agent_db_hot_namespace_ttl | Sets the lifetime of a hot namespace cache for a logical table. |
Unsupported parameters
Parameter name |
Feature description |
|---|---|
| sql_work_area | Sets the workspace memory for a tenant. |
| max_stale_time_for_weak_consistency | Specifies how old data is allowed to be read during weak-consistency reads. |