首批通过分布式安全可靠测评,为关键业务系统打造
配置项总览
更新时间:2026-07-10 17:41:49
本文根据配置项的功能,详细地罗列了 OceanBase 数据库的集群级配置项和租户级配置项。
集群级配置项
安全相关
| 配置项名 | 功能描述 |
|---|---|
| mysql_port | 用于设置 SQL 服务协议端口号。 |
| rpc_port | 用于设置远程访问的协议端口号。 |
| sql_protocol_min_tls_version | 用于设置 SQL 语句进行 SSL 连接时所使用的 SSL/TLS 协议的最低版本号。 |
| ssl_client_authentication | 用于设置是否开启 SSL 连接功能。 |
| ssl_external_kms_info | 用于记录 OceanBase 数据库 SSL 功能运行依赖的一些信息,通过 json 字符串方式记录不同 SSL 使用方式下依赖的相关配置,json 中至少包含类型 ssl_mode 字段。 |
| enable_sql_audit | 用于设置是否开启 SQL 审计功能。 |
备份恢复相关
| 配置项名 | 功能描述 |
|---|---|
| backup_backup_dest | 用于设置备份数据备份的目的端。 |
| backup_backup_dest_option | 用于控制备份备份相关的参数。 |
| backup_dest_option | 用于控制备份相关的参数。 |
| backup_concurrency | 用于设置备份时写文件系统的并发数量。 |
| backup_dest | 用于设置基线备份和日志归档的路径。 |
| backup_log_archive_option | 用于定义备份日志的归档选项。 |
| backup_net_limit | 用于设置集群备份的总带宽。 |
| backup_recovery_window | 用于设置备份数据可以恢复的时间。 |
| backup_region | 用于用户指定执行备份的 Region。 |
| backup_zone | 用于用户指定执行备份的 Zone。 |
| log_archive_batch_buffer_limit | 用于控制日志归档单机的最大内存使用量。 |
| log_archive_checkpoint_interval | 用于设置冷数据的日志归档检查点的时间间隔。 |
| restore_concurrency | 用于设置从备份恢复租户数据时的最大并发度。 |
cgroup 相关
| 配置项名 | 功能描述 |
|---|---|
| enable_cgroup | 用于控制 OBServer 节点是否开启 cgroup 功能。 |
CPU 相关
| 配置项名 | 功能描述 |
|---|---|
| cpu_count | 用于设置系统 CPU 总数。如果设置为 0,系统将自动检测 CPU 数量。 |
| server_balance_cpu_mem_tolerance_percent | 在节点负载均衡策略中,用于设置 CPU 和内存资源不均衡的容忍度。 |
| server_cpu_quota_max | 用于设置系统可以使用的最大 CPU 配额。 |
| server_cpu_quota_min | 用于设置系统可以使用的最小 CPU 配额,系统会自动预留。 |
| token_reserved_percentage | 在控制租户 CPU 调度中,用于设置每次预留多少比例的空闲 token 数给租户。 |
| workers_per_cpu_quota | 用于设置分配给每个 CPU 配额的工作线程数量。 |
| cpu_reserved | 用于设置系统预留的 CPU 数量,其余 CPU 将被 OceanBase 数据库独占使用。 |
| sys_cpu_limit_trigger | 用于设置 CPU 利用率阈值,即当 CPU 利用率超过该阈值时,将暂停系统后台任务的执行。 |
| system_cpu_quota | 用于设置系统租户可使用的 CPU 配额。 |
| tenant_cpu_variation_per_server | 用于设置租户多个 Unit 之间 CPU 配额调度允许的偏差。 |
读写/查询相关
| 配置项名 | 功能描述 |
|---|---|
| weak_read_version_refresh_interval | 用于设置弱一致性读版本号的刷新周期,影响弱一致性读数据的延时。 |
| large_query_worker_percentage | 用于设置预留给处理大查询的工作线程百分比。 |
| large_query_threshold | 用于设置查询执行时间的阈值。 |
| trace_log_slow_query_watermark | 用于设置查询的执行时间阈值,如果查询的执行时间超过该阈值,则被认为是慢查询,慢查询的追踪日志会被打印到系统日志中。 |
负载均衡相关
| 配置项名 | 功能描述 |
|---|---|
| balancer_log_interval | 用于设置容灾任务线程打印统计日志的间隔时间。 |
| balancer_task_timeout | 用于设置负载均衡等后台任务的超时时间。 |
| balancer_tolerance_percentage | 用于设置负载均衡策略中,租户内多个 Unit 间磁盘不均衡程度的宽容度,如果在均值 + 或 - 宽容度范围之内,不会触发执行均衡动作。 |
| server_balance_critical_disk_waterlevel | 用于设置磁盘空间的负载均衡功能的水位线。 |
| server_balance_disk_tolerance_percent | 用于设置节点间磁盘负载均衡策略中不均衡程度的容忍度。 |
| resource_hard_limit | 用于定义 CPU 资源的超卖百分比。 |
| enable_sys_unit_standalone | 用于设置系统租户的 Unit 是否独占节点。 |
| balancer_emergency_percentage | 用于设置 Unit 负载阈值,即当 Unit 负载超过该阈值时,允许开启副本向外迁移,即使在合并期间也执行负载均衡。 |
| balancer_timeout_check_interval | 用于设置检查负载均衡等后台任务超时的时间间隔。 |
| data_copy_concurrency | 用于设置系统中并发执行的数据迁移复制任务的最大并发数。 |
| tenant_groups | 用于设置负载均衡策略中使用的租户组。 |
| unit_balance_resource_weight | 用于设置 Unit 均衡策略中使用的资源权重,一般不需要手工配置。 |
| resource_soft_limit | 用于设置是否开启 Unit 均衡。 |
副本相关
| 配置项名 | 功能描述 |
|---|---|
| unit_gc_wait_time | 指定 Unit GC 的最大等待时长,超过最大等待时长则强制 GC。 |
| enable_rereplication | 日志流副本自动迁移复制的总开关。 |
| ls_meta_table_check_interval | 用于设置 DBA_OB_LS_LOCATIONS/CDB_OB_LS_LOCATIONS 视图的后台巡检线程的检查间隔。 |
| sys_bkgd_migration_change_member_list_timeout | 用于设置副本迁移时变更 Paxos 成员组操作的超时时间。 |
| sys_bkgd_migration_retry_num | 用于设置副本迁移失败时最多重试次数。 |
| balance_blacklist_failure_threshold | 用于设置副本迁移等后台任务连续失败次数的阈值。副本迁移等后台任务连续失败次数超过该阈值后,将被放入黑名单。 |
| balance_blacklist_retry_interval | 用于设置副本迁移等后台任务被放入黑名单后的重试时间间隔。 |
| election_cpu_quota | 用于设置给副本选举相关的后台工作分配的 CPU 配额。 |
| election_blacklist_interval | 用于设置主副本被废除后不允许再被选为主的时间间隔。 |
| enable_auto_leader_switch | 用于设置是否开启自动切主。 |
| enable_smooth_leader_switch | 是平滑切主特性的开关。 |
| global_index_build_single_replica_timeout | 用于建全局索引时,设置每个副本构建的超时时间。 |
| get_leader_candidate_rpc_timeout | 用于设置自动切主策略获取切主候选者的内部请求超时时间。 |
| migrate_concurrency | 用于设置内部数据迁移的最大并发数。 |
| rebuild_replica_data_lag_threshold | 用于设置备副本的事务日志和主副本差距的阈值,当超过该阈值时,会触发副本重建。 |
| server_data_copy_out_concurrency | 用于设置单个节点迁出数据的最大并发数。 |
| server_data_copy_in_concurrency | 用于设置单个节点迁入数据的最大并发数。 |
| replica_safe_remove_time | 用于设置已删除副本可以被清理的安全保留时间。 |
缓存相关
| 配置项名 | 功能描述 |
|---|---|
| bf_cache_miss_count_threshold | 用于控制 Bloomfilter Cache 的触发次数,当宏块未命中次数达到该值时,创建 Bloomfilter 缓存。 |
| bf_cache_priority | 用于设置 Bloom Filter 缓存优先级。 |
| cache_wash_threshold | 用于设置触发缓存清理的容量阈值。 |
| fuse_row_cache_priority | 用于设置融合行缓存在缓存系统中的优先级。 |
| user_row_cache_priority | 用于设置基线数据行缓存在缓存系统中的优先级。 |
| autoinc_cache_refresh_interval | 用于设置自增列缓存的刷新间隔。 |
| plan_cache_evict_interval | 用于设置执行计划缓存的淘汰时间间隔。 |
| index_block_cache_priority | 用于设置元数据索引微块缓存优先级。 |
| opt_tab_stat_cache_priority | 用于设置统计信息缓存优先级。 |
| tablet_ls_cache_priority | 用于设置 Tablet 映射缓存优先级。 |
| user_block_cache_priority | 用于设置数据块缓存在缓存系统中的优先级。 |
| index_info_block_cache_priority | 用于设置块索引在缓存系统中的优先级。 |
| index_cache_priority | 用于设置索引在缓存系统中的优先级。 |
| user_tab_col_stat_cache_priority | 用于设置统计数据缓存在缓存系统中的优先级。 |
| plan_cache_high_watermark | 用于设置执行计划缓存占用内存的阈值,如果超过该阈值时将触发自动淘汰。 |
| plan_cache_low_watermark | 用于设置执行计划缓存占用内存的阈值,如果低于该阈值时将停止淘汰。 |
分区相关
| 配置项名 | 功能描述 |
|---|---|
| tablet_meta_table_check_interval | 用于设置 DBA_OB_TABLET_REPLICAS/CDB_OB_TABLET_REPLICAS 视图的后台巡检线程的检查间隔。 |
| tablet_meta_table_scan_batch_count | 用于设置 Tablet meta table 迭代器使用过程中在内存里缓存的 Tablet 数量。 |
| tablet_size | 用于设置分区内部并行处理(合并、查询等)时每个分片的大小。 |
| auto_broadcast_location_cache_rate_limit | 用于设置每个 OBServer 每秒可广播的位置信息变化的分区的最大数量。 |
| auto_refresh_location_cache_rate_limit | 用于设置每个 OBServer 每秒可触发自动刷新的最大分区数目。 |
| enable_pg | 用于设置是否开启分区组功能。 |
| gc_wait_archive | 用于设置分区 GC 时是否需要等待分区上所有日志归档完成。 |
| partition_table_check_interval | 用于设置 OBServer 从分区表中删除不存在的副本的时间间隔。 |
后台执行线程相关
| 配置项名 | 功能描述 |
|---|---|
| sql_net_thread_count | 用于设置 MySQL 集群 IO 线程的个数,即 global_sql_nio_server 线程的个数。默认值为 0 表示与配置项 net_thread_count 的值相同。 |
| auto_leader_switch_interval | 用于设置自动切主后台线程工作间隔时间。 |
| switchover_process_thread_count | 用于设置主备库切换相关线程池的大小。 |
IO 相关
| 配置项名 | 功能描述 |
|---|---|
| sync_io_thread_count | 配置同步 IO 请求的线程数。 |
| syslog_io_bandwidth_limit | 用于设置系统日志所能占用的磁盘 IO 带宽上限,超过带宽上限容量的系统日志将被丢弃。 |
| disk_io_thread_count | 用于设置磁盘 IO 线程数。必须为偶数。 |
| net_thread_count | 用于设置网络 I/O 线程数。 |
| data_storage_error_tolerance_time | 用于控制数据盘状态设为 ERROR 状态的容忍时间。 |
| sys_bkgd_io_high_percentage | 用于设置系统后台 IO 最高占用百分比。 |
| sys_bkgd_io_low_percentage | 用于设置系统后台 IO 最少占用的百分比。 |
| user_iort_up_percentage | 用于设置用户磁盘 IO 时延阈值,即用户磁盘 IO 时延超过该阈值后,系统后台 IO 任务将被限流。 |
| ob_esi_rpc_port | 用于设置 obesi 进程和 observer 进程之间的通信端口。 |
| enable_ob_esi_process | 用于控制是否启用 obesi(外部存储接口)进程。 |
| ob_esi_session_timeout | 用于设置 obesi 进程持有活动会话资源的超时时间。 |
| ob_esi_io_concurrency | 用于设置 obesi 进程的并发 I/O 数。 |
| ob_esi_syslog_level | 用于设置 obesi 进程的当前日志记录级别。 |
| ob_esi_max_syslog_file_count | 用于设置 obesi 进程在回收日志文件之前可以容纳的的最大日志文件数量。 |
| multiblock_read_gap_size | 用于设置一次 IO 聚合读取块缓存的最大容量。 |
| multiblock_read_size | 用于设置读取数据时 IO 聚合大小。 |
集群相关
| 配置项名 | 功能描述 |
|---|---|
| all_server_list | 用于显示群集中的所有服务器地址。 |
| cluster | 用于设置本 OceanBase 集群名。 |
| cluster_id | 用于设置本 OceanBase 集群 ID。 |
| rpc_timeout | 用于设置集群内部请求的超时时间。 |
| all_cluster_list | 用于显示访问相同 config_url 的服务器列表。 |
| enable_election_group | 用于设置是否打开选举组策略。 |
| local_ip | 用于安装 ObServer 机器的 IP 地址。 |
| observer_id | 用于集群中 RS 分配给 OBServer 节点的唯一标识。 |
| min_observer_version | 用于查看本集群最低的 OBServer 节点应用程序版本号。 |
带宽相关
| 配置项名 | 功能描述 |
|---|---|
| enable_ob_ratelimit | 用于在 RPC 连接中,启用区域之间的速率限制。 |
| ob_ratelimit_stat_period | 用于设置 OBServer 节点计算和更新最大带宽的时间间隔。 |
Location Cache 相关
| 配置项名 | 功能描述 |
|---|---|
| virtual_table_location_cache_expire_time | 用于设置虚拟表的位置信息缓存过期时间。 |
| location_cache_refresh_rpc_timeout | 通过 RPC 刷新 location_cache 的超时时间。 |
| location_cache_refresh_sql_timeout | 通过 SQL 刷新 location_cache 的超时时间。 |
| location_cache_refresh_min_interval | 用于设置位置缓存刷新请求的最小间隔,防止产生过多刷新请求造成系统压力过大。 |
| location_cache_cpu_quota | 用于设置位置缓存模块使用的 CPU 配额。 |
| location_fetch_concurrency | 用于设置单机 location_cache 刷新的最大并发数。 |
| location_refresh_thread_count | 用于设置 OBServer 节点从 Root Service 中获取分区位置信息的线程数量。 |
| enable_auto_refresh_location_cache | 用于设置是否开启自动刷新位置缓存信息逻辑。 |
目录路径相关
| 配置项名 | 功能描述 |
|---|---|
| config_additional_dir | 用于设置本地存储配置文件的多个目录,为了冗余存储多份配置文件。 |
| data_dir | 用于设置存储 SSTable 等数据的目录。 |
内存空间相关
| 配置项名 | 功能描述 |
|---|---|
| datafile_disk_percentage | 表示占用 data_dir 所在磁盘(磁盘 data_dir 所在磁盘将被 OceanBase 数据库系统初始化用于存储数据)总空间的百分比。 |
| data_disk_usage_limit_percentage | 用于设置数据文件最大可以写入的百分比,超过这个阈值后,禁止数据迁入。 |
| enable_sql_operator_dump | 用于设置是否允许 SQL 处理过程的中间结果写入磁盘以释放内存。 |
| global_write_halt_residual_memory | 用于设置触发暂停普通租户写入(sys 租户不受影响)的全局剩余内存阈值。 |
| leak_mod_to_check | 用于内存泄露检查,是属于内部调试的功能。 |
| memory_chunk_cache_size | 用于设置内存分配器缓存的内存块容量。 |
| memory_limit | 表示可用的总内存大小。 |
| memory_limit_percentage | 用于设置系统总可用内存大小占总内存大小的百分比。 |
| memory_reserved | 用于设置系统底层模块预留的内存容量大小。 |
| memstore_limit_percentage | 用于设置租户使用 MemStore 的内存占其总可用内存的百分比。 |
| system_memory | 用于设置系统预留给租户 ID 为 500 的租户的内存容量。 |
| use_large_pages | 用于管理数据库使用的内存大页。 |
| datafile_maxsize | 用于设置磁盘文件自动扩容的空间最大值。 |
| datafile_next | 用于设置磁盘文件自动扩容的增长步长。 |
| storage_meta_cache_priority | 用于控制 kvcache 中存储 Meta Cache 的优先级。 |
PX 相关
| 配置项名 | 功能描述 |
|---|---|
| px_task_size | 用于设置 SQL 并行查询引擎每个任务处理的数据量大小。 |
| max_px_worker_count | 用于设置 SQL 并行查询引擎使用的最大线程数。 |
其他
| 配置项名 | 功能描述 |
|---|---|
| builtin_db_data_verify_cycle | 用于设置数据坏块自检周期,单位为天。当值为 0 时表示不检查。 |
| data_storage_warning_tolerance_time | 用于控制数据盘状态设为 WARNING 状态的容忍时间。 |
| dead_socket_detection_timeout | 用于设置检测失效 Socket 的时间间隔。 |
| migration_disable_time | 用于设置因磁盘满等原因导致某个节点数据迁入失败时的暂停迁入时长。 |
| schema_history_expire_time | 用于设置元数据历史数据过期时间。 |
| datafile_size | 用于设置数据文件的大小。一般不需要设置。 |
| devname | 用于设置服务进程绑定的网卡设备名。 |
| enable_perf_event | 用于设置是否开启性能事件的信息收集功能。 |
| enable_record_trace_id | 用于设置是否记录应用端设置的追踪 ID。 |
| enable_upgrade_mode | 用于设置是否开启升级模式。在升级模式中,会暂停部分系统后台功能。 |
| enable_ddl | 用于设置是否允许执行 DDL。 |
| ob_enable_utl_tcp | 用来控制 UTL_TCP 系统包功能是否开启。 |
| high_priority_net_thread_count | 用于设置高优先级网络线程数,值为 0 时,表示关闭该功能。 |
| obconfig_url | 用于设置 OBConfig 服务的 URL 地址。 |
| rpc_port | 用于设置远程访问的协议端口号。 |
| stack_size | 用于设置程序函数调用栈的大小。 |
| tenant_task_queue_size | 用于设置每个租户的请求队列大小。 |
| zone | 用于设置节点所在的 Zone 的名字。该配置项一般不需要配置。 |
| recyclebin_object_expire_time | 用于自动 Purge 回收站中过期的 Schema 对象。 |
| default_row_format | 用于设置在 MySQL 模式下,建表时使用的默认行格式。 |
| sys_bkgd_net_percentage | 用于设置后台系统任务可占用网络带宽百分比。 |
| schema_history_recycle_interval | 用于设置系统内部执行 schema 多版本记录回收任务的时间间隔。 |
| enable_asan_for_memory_context | 在使用 ob_asan 时,用于设置是否允许 ObAsanAllocator(默认 ObAllocator 作为 MemoryContext 的分配器)。 |
| ofs_list | 保存了每个 Zone 的 OFS(OceanBase File System,OceanBase 数据库自主设计的分布式存储系统)连接 URL,主要用于在 OFS 部署模式下,RootService 跨 Zone 访问文件的需求。 |
| async_ps_cursor_max_count | 用于控制单节点中异步 PS cursor 的最大个数。 |
日志服务相关
| 配置项名 | 功能描述 |
|---|---|
| enable_logservice | 用于控制日志服务模式的开关。 |
| logservice_access_point | 用于持久化日志服务访问点。 |
Root Service 相关
| 配置项名 | 功能描述 |
|---|---|
| rootservice_async_task_queue_size | 用于设置 Root Service 内部异步任务队列的大小。 |
| rootservice_async_task_thread_count | 用于设置 Root Service 内部异步任务使用的线程池大小。 |
| rootservice_list | 用于显示 Root Service 及其副本所在的机器列表。 |
| rootservice_ready_check_interval | 用于设置 Root Service 启动后等待和检查集群状态的时间间隔。 |
| rootservice_memory_limit | 用于设置 Root Service 的最大内存容量限制。 |
| lease_time | 用于设置心跳租约时长。 |
| server_check_interval | 用于设置 Server 表一致性检查的时间间隔。 |
| server_permanent_offline_time | 用于设置节点心跳中断的时间阈值,即节点心跳中断多久后认为其被永久下线,永久下线的节点上的数据副本需要被自动补足。 |
| ob_event_history_recycle_interval | 用于控制历史事件的回收间隔。 |
| enable_rootservice_standalone | 用于设置是否让系统租户和 RootService 独占 OBServer 节点。 |
| fast_recovery_concurrency | 用于控制 RootService 调度的快速恢复任务在 OBServer 上执行的并发数。 |
| wait_leader_batch_count | 用于设置 RootService 每次发送切主命令的最大分区个数。 |
RPC 认证相关
| 配置项名 | 功能描述 |
|---|---|
| rpc_client_authentication_method | 用于设置 RPC 客户端的安全认证方式。 |
| rpc_server_authentication_method | 用于设置 RPC 服务端的安全认证方式。 |
SQL 相关
| 配置项名 | 功能描述 |
|---|---|
| sql_login_thread_count | 用于设置处理 SQL 登录请求的线程数量。 |
| sql_audit_memory_limit | 用于设置 SQL 审计数据可占用的最大内存。 |
| enable_sys_table_ddl | 用于指定是否允许手动创建系统表。 |
| internal_sql_execute_timeout | 用于设置系统内部 DML 请求的时间间隔。 |
事务及事务日志相关
| 配置项名 | 功能描述 |
|---|---|
| log_disk_size | 用于设置 Redo 日志磁盘的大小。 |
| log_disk_percentage | 用于设置 Redo 日志占用其所在磁盘总空间的百分比。 |
| dtl_buffer_size | 用于设置 SQL 数据传输模块使用的缓存大小。 |
| ignore_replay_checksum_error | 用于设置是否忽略回放事务日志时发生的校验和错误。 |
| trx_2pc_retry_interval | 用于设置两阶段提交失败时候自动重试的时间间隔。 |
| standby_fetch_log_bandwidth_limit | 用于设置备租户所在集群中的所有 Server 从主租户同步日志的流量总和每秒可占用的最大带宽。 |
| log_storage_warning_tolerance_time | 用于设置从日志盘 IO 失败到磁盘被标记为坏盘时触发切主的时间。 |
| clog_disk_utilization_threshold | 用于控制 clog 或 ilog 磁盘空间复用的水位值。 |
| clog_expire_days | 用于控制 Clog 文件的过期时间。当 Clog 文件最后修改时间距离当前时间超过过期时间时,该文件会被删除。 |
| clog_cache_priority | 用于设置事务日志占用缓存的优先级。 |
| clog_disk_usage_limit_percentage | 用于设置事务日志可用磁盘空间的最大百分比。 |
| clog_sync_time_warn_threshold | 用于设置事务日志同步耗时告警阈值,同步耗时超过该值产生 WARN 日志。 |
| clog_transport_compress_func | 用于设置事务日志内部传输时使用的压缩算法。 |
| enable_one_phase_commit | 用于设置是否开启事务提交一阶段优化的功能。 |
| enable_separate_sys_clog | 用于设置是否把系统事务日志与用户事务日志分开存储。 |
| flush_log_at_trx_commit | 用于设置事务提交时写事务日志策略。 |
| ignore_replay_checksum_error | 用于设置是否忽略回放事务日志时发生的校验和错误。 |
| index_clog_cache_priority | 用于设置事务日志索引在缓存系统中的优先级。 |
| ilog_index_expire_time | 用于设置 OBServer 可提供的 Ilog 文件读取的时间上限。 |
| trx_force_kill_threshold | 用于设置因冻结或切主需要杀事务时的最长等待时间。 |
锁相关
| 配置项名 | 功能描述 |
|---|---|
| trx_try_wait_lock_timeout | 用于设置语句执行过程行锁的等待时长。 |
调试相关
| 配置项名 | 功能描述 |
|---|---|
| debug_sync_timeout | 用于打开 Debug Sync 调试开关,并设置其超时时间。 |
| enable_rich_error_msg | 用于设置是否在客户端消息中添加服务器地址、时间、追踪 ID 等调试信息。 |
TCP 相关
| 配置项名 | 功能描述 |
|---|---|
| enable_tcp_keepalive | 用于开启或关闭客户端连接的探活机制。 |
| tcp_keepidle | 用于设置客户端连接上服务器后,如果没有数据发送,多久后会发送 Keepalive 探测分组,单位为秒。 |
| tcp_keepintvl | 用于设置开启客户端连接的探活机制后,前后两次探测之间的时间间隔,单位为秒。 |
| tcp_keepcnt | 用于设置关闭一个非活跃连接之前的最大重试次数。 |
外表相关
| 配置项名 | 功能描述 |
|---|---|
| external_table_disk_cache_max_percentage | 用于设置 SN 模式下外表磁盘缓存空间占 datafile_size 的最大比例。 |
系统日志相关
| 配置项名 | 功能描述 |
|---|---|
| alert_log_level | 用于设置告警日志的级别。 |
| enable_record_trace_log | 用于设置是否记录追踪日志。 |
| enable_async_syslog | 用于设置是否启用系统日志异步写。 |
| enable_syslog_recycle | 用于设置是否打开记录 OBServer 节点启动前的旧日志的开关,与 max_syslog_file_count 配合使用,决定回收逻辑是否考虑旧的日志文件。 |
| enable_syslog_wf | 用于设置是否把 WARN 以上级别的系统日志打印到一个单独的日志文件中。 |
| max_string_print_length | 用于设置打印系统日志时,单行日志最大长度。 |
| max_syslog_file_count | 用于设置在回收日志文件之前可以容纳的日志文件数量。 |
| syslog_level | 用于设置系统日志级别。 |
| trace_log_sampling_interval | 用于设置定期打印跟踪日志信息的时间。 |
| diag_syslog_per_error_limit | 用于设置每个错误码每秒允许的 DIAG 系统日志数,超过该阈值后,日志将不再打印。 |
| enable_log_archive | 用于设置是否开启日志归档功能。 |
| system_trace_level | 用于设置系统追踪日志的日志打印级别。 |
压缩算法相关
| 配置项名 | 功能描述 |
|---|---|
| default_compress_func | 用于设置表数据的默认压缩算法,也可以在建表的时候指定其他压缩算法。 |
| default_compress | 用于设置在 Oracle 模式下,建表时使用的默认压缩策略。 |
| tableapi_transport_compress_func | 用于设置 OBKV-Table 查询结果传输使用的压缩算法。 |
| default_transport_compress_func | 用于设置整个集群的 RPC 压缩算法。 |
转储与合并相关
| 配置项名 | 功能描述 |
|---|---|
| enable_major_freeze | 用于设置是否开启自动全局冻结的功能。 |
| micro_block_merge_verify_level | 用于设置合并时宏块的校验级别。 |
| row_compaction_update_limit | 用于设置触发内存中行内数据合并的修改次数。 |
| enable_global_freeze_trigger | 用于设置是否开启自动触发全局冻结。 |
| enable_merge_by_turn | 用于设置是否开启轮转合并策略。 |
| enable_manual_merge | 用于设置是否开启手工合并。 |
| global_major_freeze_residual_memory | 用于设置触发全局冻结的剩余内存阈值。即当剩余内存小于这个百分比时,触发全局冻结。 |
| minor_deferred_gc_time | 用于设置合并之后 SSTable 延迟回收的时间间隔。 |
| zone_merge_concurrency | 用于设置在合并时,支持多少个 Zone 并发。当值为 0 时,由系统根据部署情况自动选择最佳并发度。 |
| zone_merge_order | 用于设置 Zone 的轮转合并顺序。不指定时,由系统自动决定。 |
| zone_merge_timeout | 用于设置单个 zone 的合并超时时间。 |
| minor_freeze_times | 用于设置多少次冻结触发一次合并。 |
| minor_merge_concurrency | 用于设置转储时的并发线程数。 |
| minor_warm_up_duration_time | 用于设置转储产生新转储文件的预热时间。 |
| row_purge_thread_count | 用于设置执行内存中行内数据合并的最大工作线程数。 |
仲裁服务相关
| 配置项名 | 功能描述 |
|---|---|
| arbitration_degradation_policy | 用于设置自动降级的策略。 |
| ob_startup_mode | 用于设置 OBServer 节点的启动模式,仅支持在第一次启动时修改。 |
资源隔离相关
| 配置项名 | 功能描述 |
|---|---|
| clog_io_isolation_mode | 用于根据 clog 盘和 data 盘是否独立,来决定 clog 盘的 I/O 请求是否受资源隔离的管控。 |
| enable_global_background_resource_isolation | 用于开启全局前后台资源隔离功能。 |
| global_background_cpu_quota | 用于控制在开启全局前后台资源隔离时后台任务的 CPU 配额。 |
租户级配置项
安全相关
| 配置项名 | 功能描述 |
|---|---|
| sts_credential | 用于指定访问 OCP 提供的 STS 服务的凭证。 |
| external_kms_info | 用于存储一些密钥管理信息。 |
| tde_method | 用于设置透明表空间加密的方式。 |
| audit_sys_operations | 用于设置是否追踪系统用户的操作行为。 |
| audit_trail | 用于设置是否启用数据库审核。 |
存储相关
| 配置项名 | 功能描述 |
|---|---|
| default_table_organization | 用于指定默认创建表的表组织模式。 |
| default_table_merge_engine | 用于指定用户租户默认创建表的 merge_engine。 |
| default_delta_format | 用于设置创建表时默认的增量数据存储格式。 |
CPU 相关
| 配置项名 | 功能描述 |
|---|---|
| cpu_quota_concurrency | 用于设置租户的每个 CPU 配额所允许的最大并发数。 |
读写/查询相关
| 配置项名 | 功能描述 |
|---|---|
| enable_monotonic_weak_read | 用于设置是否开启单调读。 |
| query_response_time_stats | 用于设置是否启用 information_schema.QUERY_RESPONSE_TIME 视图的统计信息收集。 |
| query_response_time_flush | 用于设置是否刷新 information_schema.QUERY_RESPONSE_TIME 视图并重新读取 query_response_time_range_base。 |
| query_response_time_range_base | 用于设置 information_schema.QUERY_RESPONSE_TIME 视图收集时间参数的间隔时间。 |
负载均衡相关
| 配置项名 | 功能描述 |
|---|---|
| enable_ls_leader_balance | 用于控制是否开启日志流 Leader 的自动均衡。 |
| enable_gts_standalone | 用于设置是否开启租户 GTS 服务独占一组 Unit 的功能。 |
| balancer_idle_time | 用于设置负载均衡等后台任务线程空闲时的唤醒间隔时间。 |
| enable_rebalance | 用于设置是否开启自动负载均衡的功能。 |
| enable_transfer | 用于控制是否允许在租户内进行 Transfer。关闭配置项 enable_rebalance 时此配置项无效。 |
| partition_balance_schedule_interval | 用于分区均衡调度周期。 |
| enable_database_sharding_none | 用于控制创建 DataBase 时用户表是否开启自动聚合的开关。 |
副本相关
| 配置项名 | 功能描述 |
|---|---|
| replica_parallel_migration_mode | 用于指定日志流副本并行迁移功能的模式。 |
| choose_migration_source_policy | 用于指定迁移选择源端副本的优先策略。 |
扩缩容相关
| 配置项名 | 功能描述 |
|---|---|
| ls_scale_out_factor | 日志流的扩容系数,用于控制租户在每台服务节点上日志流的个数。 |
备份恢复相关
| 配置项名 | 功能描述 |
|---|---|
| recover_table_concurrency | 设置表级恢复的跨租户导表阶段,多表允许并行恢复的最大表数。 |
| recover_table_dop | 设置表级恢复的跨租户导表阶段,单表允许并行恢复的最大表数。 |
| log_restore_concurrency | 用于设置恢复日志的并发度。 |
| log_archive_concurrency | 用于设置日志归档的并发度。 |
| backup_data_file_size | 用于控制单个数据备份文件的文件大小上限。 |
分区相关
| 配置项名 | 功能描述 |
|---|---|
| enable_auto_split | 用于控制租户是否开启自动分区功能。 |
| auto_split_tablet_size | 用于控制这个租户开启自动分区功能之后触发分裂的阈值。 |
| global_index_auto_split_policy | 用于控制新建的全局索引是否开启自动分区功能,默认值 DISTRIBUTED。 |
后台执行线程相关
| 配置项名 | 功能描述 |
|---|---|
| px_workers_per_cpu_quota | 用于设置并行执行工作线程数的比例。 |
| attach_shared_sstable_thread_score | 用于配置租户可用来执行共享存储模式下计算节点共享数据引用的线程数。 |
| inc_sstable_upload_thread_score | 用于配置租户可用来执行共享存储模式下数据共享类任务的线程数。 |
| ddl_thread_score | 用于设置 DDL 任务使用的线程数。 |
| compaction_low_thread_score | 用于设置低优先级 compaction 的工作线程数。 |
| compaction_high_thread_score | 用于设置高优先级 compaction 的工作线程数。 |
| compaction_mid_thread_score | 用于设置中优先级 compaction 的工作线程数。 |
| ha_high_thread_score | 用于设置高可用高优先级线程的当前工作线程数。 |
| ha_mid_thread_score | 用于设置高可用中优先级线程的当前工作线程数。 |
| ha_low_thread_score | 用于设置高可用低优先级线程的当前工作线程数。 |
| ob_compaction_schedule_interval | 用于设置 Compaction 调度的时间间隔。 |
| compaction_dag_cnt_limit | 用于配置 Compaction DAG 队列上 DAG 数量的上限值。 |
| compaction_schedule_tablet_batch_cnt | 用于配置 Compaction 分批调度时,每个批次调度的分区数的上限值。 |
| tenant_sql_login_thread_count | 用于设置 MySQL 租户登录的线程个数,即 mysql_queue 线程的个数,默认值为 0 表示取 unit_min_cpu 的值。 |
| tenant_sql_net_thread_count | 用于设置 MySQL 租户 IO 线程的个数,即 sql_nio_server 线程的个数,默认值为 0 表示取 unit_min_cpu 的值。 |
| ddl_high_thread_score | 用于修改执行 ddl kv merge 的 DAG 线程数。 |
缓存相关
| 配置项名 | 功能描述 |
|---|---|
| storage_cache_clean_macro_interval | 用于控制共享存储(Shared-Storage,SS)模式下宏块级别的热点宏块缓存清理任务的执行频率。 |
| default_storage_cache_policy | 用于配置默认的缓存策略。 |
| enable_manual_storage_cache_policy | 用于启用用户手动指定的热点缓存策略。 |
| suspend_storage_cache_task | 用于设置是否暂停后台缓存任务。 |
| enable_adaptive_plan_cache | 用于控制租户是否开启计划缓存(Plan Cache)自适应的能力。 |
| result_cache_max_size | 用于控制 result cache 模块能使用的最大内存量。 |
| result_cache_max_result | 用于控制单个 result cache 缓存对象最多能使用 result_cache_max_size 的内存比例。 |
| ob_result_cache_evict_percentage | 用于设置 result cache 内存淘汰水位线。 |
| ob_deterministic_udf_cache_max_size | 用于标记语句执行期,所有 deterministic 的 UDF 的缓存池总共可以使用的最大内存量。 |
IO 相关
| 配置项名 | 功能描述 |
|---|---|
| io_category_config | 用于配置各类别 I/O 请求的百分比。 |
兼容相关
说明
下表中的配置项当前仅在 MySQL 模式下生效。
| 配置项名 | 功能描述 |
|---|---|
| enable_sql_extension | 用于设置是否开启租户的 SQL 扩展功能。 |
| compatible | 用于控制租户下相关功能的兼容行为,此配置项不可设置。 |
路由相关
| 配置项名 | 功能描述 |
|---|---|
| ob_proxy_readonly_transaction_routing_policy | 用于控制 Proxy 对于事务的路由是否受只读语句的影响。 |
LOB 数据相关
| 配置项名 | 功能描述 |
|---|---|
| lob_enable_block_cache_threshold | 用于设置 OUTROW 存储的 LOB 查询缓存的阈值。 |
内存空间相关
| 配置项名 | 功能描述 |
|---|---|
| ob_vector_memory_limit_percentage | 用于配置向量索引模块对内存资源占用的阈值(单位为百分比)。 |
| range_optimizer_max_mem_size | 用于限制 Query Range 模块使用的内存。 |
| rpc_memory_limit_percentage | 用于设置租户中 RPC 的最大内存,占租户总内存的百分比。 |
| query_memory_limit_percentage | 用于指定单条 SQL 可使用的租户内存百分比。 |
磁盘空间相关
| 配置项名 | 功能描述 |
|---|---|
| temporary_file_max_disk_size | 设置租户的单个节点内临时文件最大可占用的磁盘空间大小。 |
OBKV 相关
| 配置项名 | 功能描述 |
|---|---|
| enable_kv_ttl | 用于控制是否启动 TTL 后台任务,该配置项对周期性 TTL 任务有效,用户管控命令不受此配置项限制。注意:过期数据删除(TTL)功能仅限于 OceanBase KV 场景使用,SQL 场景下禁用,否则会导致不可预期的数据误删除问题。 |
| kv_ttl_duty_duration | 于设置每日定时 TTL 的触发时段,TTL 任务会在该时间段内触发一次。 |
| kv_group_commit_batch_size | 用于指定 OBKV 组提交中执行 batch 操作的大小。 |
| kv_group_commit_rw_mode | 用于在控制走组提交的场景。 |
| kv_hbase_client_scanner_timeout_period | 用于设置 OBKV-HBase 流式查询超时时间。 |
| kv_ttl_history_recycle_interval | 用于设置 TTL 任务历史记录保存的时间段。 |
| ttl_thread_score | 用于设置 TTL 任务使用的工作线程数。 |
| kv_ttl_delete_max_ops | 用于设置 TTL 任务删除的最大操作数。 |
PL 相关
| 配置项名 | 功能描述 |
|---|---|
| plsql_code_type | 用于指定 PL/SQL 代码的编译类型。 |
| plsql_debug | 用于指定是否编译成 debug 版本。 |
| plsql_optimize_level | 用于指定编译优化级别。 |
| plsql_v2_compatibility | 用于指定 Oracle 8 的兼容功能。 |
| package_state_sync_max_size | 用于控制单个 package state (包状态管理) 能序列化的长度。 |
| ob_enable_java_udf | 用于开启或关闭 Java UDF 功能。 |
| enable_pl_rich_error_msg | 用于开启或关闭向 PLSQL 内异常信息添加额外内容的功能。 |
旁路导入相关
| 配置项名 | 功能描述 |
|---|---|
| default_load_mode | 用于在导数操作场景中,控制数据的导入方式。 |
| direct_load_allow_fallback | 用于控制在指定旁路导入的导数操作中,如果遇到旁路导入不支持的场景时,导数操作是否回退为普通导入的方式。 |
| load_data_diagnosis_log_compression | 用于设置诊断日志使用的压缩算法。 |
| load_data_diagnosis_log_max_size | 用于设置单个诊断日志文件的大小。 |
PX 相关
| 配置项名 | 功能描述 |
|---|---|
| px_target_high_watermark | 用于控制并行线程数的高水位线百分比阈值。 |
| px_target_low_watermark | 用于设置并行线程数的低水位线百分比阈值。 |
| px_target_workers_per_cpu | 用于控制预期的并行执行线程数和租户 CPU 数的比率。 |
其他
| 配置项名 | 功能描述 |
|---|---|
| zone_deploy_mode | 设置租户在各 Zone 的分布模式。 |
| enable_early_lock_release | 用于设置是否开启提前解行锁的功能。 |
| workarea_size_policy | 用于设置手动或者自动调整 SQL 工作区大小的策略。 |
| open_cursors | 用于限制单个 Session 可以同时打开的游标数量。 |
| ob_ssl_invited_common_names | 用于记录当前租户运行的应用身份列表,该身份来自 SSL 双向认证中 Client 端证书 subject 中的 cn 字段(common name)。 |
| ob_enable_batched_multi_statement | 用于设置是否启用批处理功能的成组执行优化。 |
| job_queue_processes | 用来设定每个租户上可以同时运行的任务数上限,目的是为了控制任务挤占租户的资源。 |
| default_auto_increment_mode | 用于设置默认的自增列自增模式。 |
| ob_query_switch_leader_retry_timeout | 用于设置失败 Query 的最大重试时间,单位为微秒(us)。 |
| default_enable_extended_rowid | 用于设置是否将表创建为 Extended ROWID 模式。 |
| dump_data_dictionary_to_log_interval | 用于控制租户数据字典持久化的周期。 |
| enable_user_defined_rewrite_rules | 用于控制用户自定义规则是否开启的开关。 |
| storage_rowsets_size | 用于控制列存引擎一次向量化批处理行数。 |
| approx_count_distinct_precision | 用于配置 approx_count_distinct 函数的结果精度。 |
| default_skip_index_level | 用于设置租户中创建表时 skip_index_level 的默认值。 |
| sql_func_extension_mode | 用于控制是否启用命名风格与 MySQL 不一致的主流兼容模式函数。 |
| enable_ps_parameterize | 用于控制开启或关闭 PS 语句在解析时是否参数化。 |
事务及事务日志相关
| 配置项名 | 功能描述 |
|---|---|
| log_disk_utilization_limit_threshold | 用于设置租户日志盘利用率限制阈值,当租户日志盘使用量超过租户日志盘空间总量乘以该值时,不再允许日志写入。 |
| log_disk_utilization_threshold | 用于设置租户日志盘利用率阈值,当租户日志盘使用量超过租户日志盘空间总量乘以该值时,进行日志文件重用。 |
| writing_throttling_maximum_duration | 通过控制内存分配进度,控制写入速度。即指定在触发写入限速后,剩余 MemStore 内存分配完所需的时间。 |
| writing_throttling_trigger_percentage | 用于设置触发写入限速的 MemStore 已使用内存占 MemStore 内存上限的百分比阈值。 |
| standby_db_fetch_log_rpc_timeout | 用于设置备库拉取日志 RPC 超时时间,以控制备库日志传输服务检测主库某台 Server 不可用并切换到其他 Server。 |
| log_disk_throttling_percentage | 用于触发日志写入限速的不可回收日志盘空间占比。 |
| log_transport_compress_all | 用于对日志传输是否使用压缩。 |
| log_transport_compress_func | 用于日志传输的压缩器。 |
| clog_max_unconfirmed_log_count | 用于设置事务模块中未确认日志的最大数量。 |
| clog_persistence_compress_func | 用于设置事务日志落盘压缩算法。 |
| enable_clog_persistence_compress | 用于设置是否开启事务日志落盘压缩。 |
数据类型相关
| 配置项名 | 功能描述 |
|---|---|
| json_document_max_depth | 用于设置 JSON 文档中允许的最大嵌套层数。 |
锁相关
| 配置项名 | 功能描述 |
|---|---|
| enable_lock_priority | 表锁优先级开关。 |
外表相关
| 配置项名 | 功能描述 |
|---|---|
| external_table_io_hole_size | 用于设置两个连续 IO 范围之间的最大距离(以字节为单位)。 |
| external_table_io_range_size | 用于设置合并范围的最大大小(以字节为单位)。 |
系统日志相关
| 配置项名 | 功能描述 |
|---|---|
| log_disk_throttling_maximum_duration | 用于调整触发日志限速后,日志盘的最大可用时间。 |
| ls_gc_delay_time | 用于配置租户日志流延迟删除的时间。 |
| standby_db_preferred_upstream_log_region | 用于配置物理备库场景下,备租户同步上游日志的首选 Region。 |
| archive_lag_target | 用于控制租户日志归档延迟的时间。 |
物化视图相关
| 配置项名 | 功能描述 |
|---|---|
| enable_mlog_auto_maintenance | 用于控制是否启用物化视图日志自动管理功能。 |
| mlog_trim_interval | 用于控制物化视图日志(mlog)后台自动裁剪任务的调度周期。 |
| enable_mv_binlog_minimal_mode | 用于控制物化视图增量刷新场景中 binlog minimal 模式的开关。 |
用户登录相关
说明
下表中的配置项当前仅在 MySQL 模式下生效。
| 配置项名 | 功能描述 |
|---|---|
| connection_control_failed_connections_threshold | 用来指定用户错误登录尝试的阀值。 |
| connection_control_min_connection_delay | 指定了超过错误登录次数阈值之后,错误登录锁定的最小时长。 |
| connection_control_max_connection_delay | 指定了错误登录锁定时长的最大值,当时长达到这个最大值之后就不再增长。 |
压缩算法相关
| 配置项名 | 功能描述 |
|---|---|
| spill_compression_codec | 用于指定压缩算法类型以实现 SQL 执行过程中的数据落盘压缩。 |
| ob_encoding_granularity | 用于设定单个微块 Encoding 的行数上限。 |
转储与合并相关
| 配置项名 | 功能描述 |
|---|---|
| enable_window_compaction | 用于指定当前租户是否使用窗口合并。 |
| mds_minor_compact_trigger | 用于控制触发 MDS Minor Compaction 的 SSTable 数量。 |
| mds_compaction_mid_thread_score | 用于设置中优先级 MDS Compaction 的 DAG(Direct Acyclic Graph)线程数。 |
| mds_compaction_high_thread_score | 用于设置高优先级 MDS Compaction 的 DAG(Direct Acyclic Graph)线程数。 |
| default_progressive_merge_num | 用于设置新建一张表时默认的渐进合并次数。 |
| major_freeze_duty_time | 用于设置每日定时冻结和合并的触发时刻。 |
| major_compact_trigger | 用于设置多少次冻结触发一次合并。 |
| minor_compact_trigger | 用于配置触发转储(Minor Compaction)的 SSTable 个数的阈值。 |
| undo_retention | 用于设置系统应保留的多版本数据范围,单位为秒,在转储时控制多版本数据的回收。 |
| merger_check_interval | 用于设置合并状态检查线程的调度间隔。 |
| freeze_trigger_percentage | 用于设置触发全局冻结的租户使用内存阈值。 |
| max_kept_major_version_number | 用于设置数据保留的冻结版本数量。 |
| merge_stat_sampling_ratio | 用于设置合并时候数据列统计信息的采样率。 |
| merge_thread_count | 用于设置每日合并工作的线程数。 |
| merger_completion_percentage | 用于设置合并完成副本数的百分比阈值,达到该阈值则认为本轮合并完成调度。 |
| merger_switch_leader_duration_time | 用于设置每日合并时批量切主的时间间隔。 |
| merger_warm_up_duration_time | 用于设置合并时,新版基线数据的预热时间。 |
仲裁服务相关
| 配置项名 | 功能描述 |
|---|---|
| arbitration_timeout | 用于设置触发自动降级的超时时间。 |
TTL 相关
| 配置项名 | 功能描述 |
|---|---|
| enable_ttl | 用于控制 SQL 模式下是否开启 TTL 功能。 |
| ttl_duty_time | 用于指定 TTL 后台定期触发 TTL 任务的执行时间点。 |
AI 函数服务
| 配置项名 | 功能描述 |
|---|---|
| document_ai_file_max_size | 用于限制 LOAD_FILE 函数一次处理的文件最大大小。 |
暂不支持的配置项
| 配置项名 | 功能描述 |
|---|---|
| sql_work_area | 用于设置租户的工作区内存。 |
| max_stale_time_for_weak_consistency | 用于设置弱一致性读允许读到多旧的数据。 |