Move the docs folder

This commit is contained in:
LINxiansheng
2022-02-10 14:51:49 +08:00
committed by LINxiansheng
parent 7c6dcc6712
commit d42f317422
1160 changed files with 0 additions and 3 deletions

View File

@ -0,0 +1,35 @@
系统变量概述
===========================
OceanBase 数据库的系统变量主要分为全局变量和 Session 变量:
* 全局变量:表示 Global 级别的修改,数据库同一租户内的不同用户共享全局变量。全局变量的修改不会随会话的退出而失效。此外,全局变量修改后,对当前已打开的 Session 不生效,需要重新建立 Session 才能生效。
* Session 变量:表示 Session 级别的修改。当客户端连接到数据库后,数据库会复制全局变量来自动生成 Session 变量。Session 变量的修改仅对当前 Session 生效。
与系统配置项对比
-----------------------------
| 对比项 | 系统配置项 | 系统变量 |
|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 生效范围 | 分为集群、Zone、机器和租户。 | 分为租户的 Global 或 Session 级别。 |
| 生效方式 | * 动态生效:`edit_level` 为`dynamic_effective`。 * 重启生效:`edit_level``static_effective` 。 | * 设置 Session 级别的变量仅对当前 Session 有效,对其他 Session 无效。 * 设置 Global 级别的变量对当前 Session 无效,需要重新登录建立新的 Session 才会生效。 |
| 修改方式 | * 支持通过 SQL 语句修改,示例如下: ```sql obclient> Alter SYSTEM SET schema_history_expire_time='1h' ``` <!-- --> * 支持通过启动参数修改,示例如下: ```sql cd /home/admin && ./bin/observer -o "schema_history_expire_time='1h'" ``` | 仅支持通过 SQL 语句修改,示例如下: * MySQL 模式 ```sql obclient> SET ob_query_timeout = 20000000; obclient> SET GLOBAL ob_query_timeout = 20000000; ``` * Oracle 模式 ```sql obclient> SET ob_query_timeout = 20000000; obclient> ALTER SYSTEM SET ob_query_timeout = 20000000; ``` |
| 持久化 | 持久化到内部表与配置文件,可以在 `/home/admin/oceanbase/etc/observer.config.bin` 与 `/home/admin/oceanbase/etc/observer.config.bin.history` 文件中查询该配置项。 | 仅 GLOBAL 级别的变量会持久化,SESSION 级别的变量不会进行持久化。 |
| 生命周期 | 长,从进程启动到退出。 | 短,需要租户的 Schema 创建成功以后才生效。 |
| 查询方式 | 可以使用 `SHOW PARAMETERS` 语句查询。 | 可以使用 `SHOW [GLOBAL] VARIABLES` 语句查询。 |
本章主要介绍 OceanBase 数据库中的所有系统变量及其缺省值说明(包括参数含义、取值范围和使用说明等)。系统变量的查看和设置相关操作,请参见 [租户管理变量](../../6.administrator-guide/3.basic-database-management/5.tenants/9.tenant-management-variables.md)章节。

View File

@ -0,0 +1,15 @@
character_set_system
=========================================
character_set_system 设置服务器使用的字符集。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4 |
| 取值范围 | utf8mb4 |
| 生效范围 | * GLOBAL * SESSION |
| 是否可以修改 | 否 |

View File

@ -0,0 +1,14 @@
parallel_servers_target
============================================
parallel_servers_target 用于设置每个 Server 上的大查询排队条件。当并行执行(Parallel eXecution,PX)线程池中有指定的空闲线程数时才调度新查询。
| **属性** | **描述** |
|--------|----------------------------|
| 参数类型 | int |
| 默认值 | 0 |
| 取值范围 | \[0, 9223372036854775807\] |
| 生效范围 | GLOBAL |

View File

@ -0,0 +1,16 @@
ob_trx_idle_timeout
========================================
ob_trx_idle_timeout 用于设置事务空闲超时时间,即事务中两条语句之间的执行间隔超过该值时超时,单位为微秒。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 120000000 |
| 取值范围 | \[100000000,+∞) |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
block_encryption_mode
==========================================
block_encryption_mode 用于指定在函数 aes_encrypt 和 aes_decrypt 中使用的加密算法。
| **属性** | **描述** |
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | enum |
| 默认值 | aes-128-ecb |
| 取值范围 | * aes-128-ecb * aes-192-ecb * aes-256-ecb * aes-128-cbc * aes-192-cbc * aes-256-cbc * aes-128-cfb1 * aes-192-cfb1 * aes-256-cfb1 * aes-128-cfb8 * aes-192-cfb8 * aes-256-cfb8 * aes-128-cfb128 * aes-192-cfb128 * aes-256-cfb128 * aes-128-ofb * aes-192-ofb * aes-256-ofb |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
ob_reserved_meta_memory_percentage
=======================================================
ob_reserved_meta_memory_percentage 用于设置租户预留内存的比例,主要存储 Meta 相关的结构信息。
| **属性** | **描述** |
|---------|----------|
| 参数类型 | int |
| 默认值 | 10 |
| 取值范围 | \[1,100) |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,21 @@
ob_check_sys_variable
==========================================
**说明**
该变量暂未使用。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 0 * 1 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,17 @@
tracefile_identifier
=========================================
tracefile_identifier 用于在日志中增加指定内容,便于筛选行迭代跟踪日志。
| **属性** | **描述** |
|---------|---------|
| 参数类型 | varchar |
| 默认值 | 空字符串 |
| 取值范围 | NULL |
| 生效范围 | SESSION |
| 是否参与序列化 | 是 |
使用 TRACING、STAT 两个 HINT 能够指示执行器在算子执行过程中打印每一行内容,为了让这些内容易于搜索识别,可以使用 tracefile_identifier 指定一个字符串,例如 `XXXYYYZZZ``MY_TRACE` 等和行内容一起输出到日志中,易于搜索。

View File

@ -0,0 +1,15 @@
transaction_isolation
==========================================
transaction_isolation 用于设置事务的隔离级别。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | varchar |
| 默认值 | READ-COMMITTED |
| 取值范围 | * READ-UNCOMMITTED * READ-COMMITTED * REPEATABLE-READ * SERIALIZABLE |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
ob_trx_lock_timeout
========================================
ob_trx_lock_timeout 用于设置事务的等锁超时时长,单位为微秒。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | -1 |
| 取值范围 | 有效取值范围:\[0,+∞) |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
validate_password_check_user_name
======================================================
validate_password_check_user_name 用于设置用户密码是否可以和用户名相同。
| **属性** | **描述** |
|---------|-----------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | enum |
| 默认值 | on |
| 取值范围 | * on:表示用户密码可以和用户名相同 * off:表示用户密码不可以和用户名相同 |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
validate_password_length
=============================================
validate_password_length 设置用户密码最小长度。
| **属性** | **描述** |
|---------|------------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0,2147483647\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,18 @@
collation_connection
=========================================
collation_connection 用于设置连接使用的字符集和字符序。
| **属性** | **描述** |
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4_general_ci |
| 取值范围 | * utf8mb4_general_ci * utf8mb4_bin * utf8mb4_unicode_ci * gbk_bin * gbk_chinese_ci * gb18030_bin * gb18030_chinese_ci * utf16_general_ci * utf16_bin * utf16_unicode_ci * binary |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,16 @@
validate_password_mixed_case_count
=======================================================
validate_password_mixed_case_count 用于设置用户密码至少包含的大写字母个数以及至少包含的小写字母个数。
| **属性** | **描述** |
|---------|------------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0,2147483647\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
validate_password_number_count
===================================================
validate_password_number_count 用于设置用户密码至少包含的数字个数。
| **属性** | **描述** |
|---------|------------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0,2147483647\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
validate_password_policy
=============================================
validate_password_policy 用于设置密码检查策略。
| **属性** | **描述** |
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | enum |
| 默认值 | LOW |
| 取值范围 | * LOW:表示仅包含密码常见的检测 * MEDIUM:表示包括密码长度检测、大写字母个数检测、小写字母个数检测、数字个数检测、特殊字符个数检测、用户名密码相同检测 |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
validate_password_special_char_count
=========================================================
validate_password_special_char_count 用于设置用户密码至少包含的特殊字符个数。
| **属性** | **描述** |
|---------|------------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0,2147483647\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
default_password_lifetime
==============================================
default_password_lifetime 用于设置密码的过期时间。
| **属性** | **描述** |
|---------|-------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0,65535\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
ob_trace_info
==================================
ob_trace_info 用于透传 trace 信息,该信息最终可透持久化到 REDO 日志中。
| **属性** | **描述** |
|--------|-------------------|
| 参数类型 | varchar |
| 默认值 | 空字符串 |
| 取值范围 | 字符串长度为\[0, 4096\] |
| 生效范围 | SESSION |

View File

@ -0,0 +1,35 @@
secure_file_priv
=====================================
secure_file_priv 控制导入或导出到文件时可以访问的路径。仅 DBA 可以设置该变量,其他人无法设置。
| **属性** | **描述** |
|-----------|---------|
| 参数类型 | varchar |
| 默认值 | NULL |
| 取值范围 | ALL |
| 生效范围 | GLOBAL |
| 是否影响计划的生成 | 是 |
| 是否可为空 | 是 |
对于该变量的值:
* 如果设置为空串,则表示没有限制,任意路径均可以访问。
* 如果设置为路径名,则仅该路径下的文件可以被导入或导出。
* 如果设置为 `NULL`,则表示导入、导出被禁用。
新建租户时,默认值将被设为 `NULL`,即导入、导出被禁用。

View File

@ -0,0 +1,15 @@
ob_pl_block_timeout
========================================
ob_pl_block_timeout 用于设置 PL 的最大超时时间,单位 us。
| 属性 | 描述 |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 3216672000000000 |
| 取值范围 | \[0, 9223372036854775807\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
performance_schema
=======================================
performance_schema 用于向客户端声明是否支持 performance 信息的查询。
| 属性 | 描述 |
|--------|-----------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | OFF |
| 取值范围 | * ON:支持 * OFF:不支持 |
| 生效范围 | GLOBAL |
| 是否重启生效 | 否 |

View File

@ -0,0 +1,23 @@
transaction_read_only
==========================================
transaction_read_only 配置项用于控制是否只允许开启只读事务。
**注意**
当前该变量暂未启用,即设置后不会生效。
| 属性 | 描述 |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | False |
| 取值范围 | * True * False |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是,即远程执行、分布式执行场景下,变量会参与序列化 |
| 是否重启生效 | 否 |
当 transaction_read_only 设置为 `True` 时,不允许执行 DML 语句。

View File

@ -0,0 +1,16 @@
collation_database
=======================================
collation_database 设置创建数据库默认字符集和字符序。
| **属性** | **描述** |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4_general_ci |
| 取值范围 | * utf8mb4_general_ci * utf8mb4_bin * utf8mb4_unicode_ci * gbk_bin * gbk_chinese_ci * gb18030_bin * gb18030_chinese_ci * utf16_general_ci * utf16_bin * utf16_unicode_ci * binary |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,17 @@
resource_manager_plan
==========================================
`resource_manager_plan` 用于激活资源管理计划,以适当的参数限制不同负载使用 CPU 的额度。
| 属性 | 描述 |
|--------|---------------|
| 参数类型 | varchar |
| 默认值 | "" |
| 取值范围 | N/A |
| 生效范围 | GLOBAL |
| 是否重启生效 | 否,设置后 10s 内生效 |
租户内的普通线程和并行执行线程会相互抢占 CPU 资源,通过为租户指定资源隔离计划,可以控制资源抢占策略,限制资源的使用量。

View File

@ -0,0 +1,16 @@
collation_server
=====================================
collation_server 用于设置服务器默认字符集和字符序。
| **属性** | **描述** |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4_general_ci |
| 取值范围 | * utf8mb4_general_ci * utf8mb4_bin * utf8mb4_unicode_ci * gbk_bin * gbk_chinese_ci * gb18030_bin * gb18030_chinese_ci * utf16_general_ci * utf16_bin * utf16_unicode_ci * binary |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,14 @@
interactive_timeout
========================================
interactive_timeout 用于设置服务器关闭交互式连接前等待活动的秒数。交互式客户端定义为在 mysql_real_connect() 中使用 CLIENT_INTERACTIVE 选项的客户端。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 28800 |
| 取值范围 | \[1, 31536000\] |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,14 @@
last_insert_id
===================================
last_insert_id 用于返回本 Session 最后一次插入的自增字段值。
| **属性** | **描述** |
|--------|-----------------------------|
| 参数类型 | unit |
| 默认值 | 0 |
| 取值范围 | \[0, 18446744073709551615\] |
| 生效范围 | SESSION |

View File

@ -0,0 +1,23 @@
max_allowed_packet
=======================================
max_allowed_packet 用于设置最大网络包大小,单位是 Byte。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 4194304 |
| 取值范围 | \[1024,1073741824\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
**说明**
该变量不能通过 `ALTER SESSION SET xxx = yyy; `语句的方式使其仅在当前 Session 生效,只能通过 `SET GLOBAL xxx = yyy` 语句这种全局生效的修改方式。 使用时一般客户端与 Server 端均需要调整。

View File

@ -0,0 +1,14 @@
sql_mode
=============================
sql_mode 用于设置 SQL 模式,不同的 SQL 模式对于插入等行为有很大影响。
| **属性** | **描述** |
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | varchar |
| 默认值 | STRICT_ALL_TABLES |
| 取值范围 | * STRICT_ALL_TABLES * STRICT_TRANS_TABLES * ONLY_FULL_GROUP_BY * PAD_CHAR_TO_FULL_LENGTH |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,15 @@
time_zone
==============================
time_zone 用于设置当前租户会话使用的时区,支持 `'+08:00' `的 offset 形式和 `Asia/Shanghai `的地域形式取值。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | varchar |
| 默认值 | +8:00 |
| 取值范围 | -12:59 \~ +13:00 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
tx_isolation
=================================
tx_isolation 用于设置事务隔离级别。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | varchar |
| 默认值 | READ-COMMITTED |
| 取值范围 | * READ-UNCOMMITTED * READ-COMMITTED * REPEATABLE-READ * SERIALIZABLE |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
auto_increment_increment
=============================================
auto_increment_increment 用于设置自增步长,仅用于 MySQL 客户端登录。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | uint |
| 默认值 | 1 |
| 取值范围 | \[1, 65535\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
version_comment
====================================
version_comment 用于设置 OBServer 的版本信息。
| **属性** | **描述** |
|--------|-----------------|
| 参数类型 | varchar |
| 默认值 | OceanBase 1.0.0 |
| 取值范围 | N/A |
| 生效范围 | GLOBAL |
| 是否可修改 | 否 |

View File

@ -0,0 +1,16 @@
wait_timeout
=================================
wait_timeout 用于设置服务器关闭非交互连接之前等待活动的秒数。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 28800 |
| 取值范围 | \[1, 31536000\] |
| 生效范围 | * GLOBAL * SESSION |
在会话启动时,会根据全局 wait_timeout 的值或全局 interactive_timeout 的值来初始化会话 wait_timeout 的值,具体根据全局 wait_timeout 的值还是全局 interactive_timeout 的值取决于客户端类型。客户端类型由 `mysql_real_connect()` 的连接选项 CLIENT_INTERACTIVE 定义。 interactive_timeout 变量相关信息请参见 **[](gi9a68)** [interactive_timeout](../../14.reference-guide-oracle-mode/2.system-variable-1/13.interactive_timeout-1.md)。

View File

@ -0,0 +1,25 @@
binlog_row_image
=====================================
binlog_row_image 用于控制是否记录全列日志。
全列日志与非全列日志的定义如下:
对于 update/delete 的 DML 语句,如果 OBServer 同时记录了所有列的新值和旧值,则称之为全列日志;如果 OBServer 只记录了新值而没有旧值,则为非全列日志。
| **属性** | **描述** |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | enum |
| 默认值 | FULL |
| 取值范围 | * FULL:表示记录所有列 * MINIMAL:表示只记录 DML 操作中修改的列,提升主从复制吞吐量,减少 binlog 大小、网络资源和服务器内存占用 * NOBLOB:目前暂不支持 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与消息序列化 | 是 |
| 是否影响 SQL 执行计划生成 | 是 |
**说明**
通过 `SET GLOBAL binlog_row_image= 'xxx' `命令修改变量后,不会影响已连接的 Session,包括发起修改的 Session。

View File

@ -0,0 +1,15 @@
character_set_filesystem
=============================================
character_set_filesystem 用于设置文件系统字符集类型。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | BINARY |
| 取值范围 | BINARY |
| 生效范围 | * GLOBAL * SESSION |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,14 @@
connect_timeout
====================================
connect_timeout 用于设置连接超时时间,单位为微妙。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 10 |
| 取值范围 | \[2, 31536000\] |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,20 @@
datadir
============================
datadir 用于设置数据存储的本地磁盘路径。
**说明**
该变量仅用于兼容,OceanBase 数据库当前暂未实现该变量的功能。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | varchar |
| 默认值 | /usr/local/mysql/data/ |
| 取值范围 | N/A |
| 生效范围 | * GLOBAL * SESSION |
| 是否可修改 | 否 |

View File

@ -0,0 +1,21 @@
debug_sync
===============================
debug_sync 用于在 debug 时设置同步点,与 MySQL 兼容。
**说明**
只有 debug_sync_timeout 配置项的值不为 0 时,该变量的设置才有效。
| **属性** | **描述** |
|--------|------------|
| 参数类型 | varchar |
| 默认值 | 空字符串 |
| 取值范围 | 无 |
| 生效范围 | SESSION |
| 是否可见 | 否,所有租户均不可见 |

View File

@ -0,0 +1,17 @@
div_precision_increment
============================================
div_precision_increment 用于设置除法结果精度在被除数精度基础上的增量,是 MySQL 兼容功能。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 4 |
| 取值范围 | \[0, 30\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,17 @@
explicit_defaults_for_timestamp
====================================================
explicit_defaults_for_timestamp 用于指定 timestamp 数据类型在处理默认值和空值时是否启用非标准行为。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | ON |
| 取值范围 | * OFF:不启用 * ON:启用 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,15 @@
group_concat_max_len
=========================================
group_concat_max_len 用于设置允许的 GROUP_CONCAT() 函数结果的最大长度,单位为字节。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | uint |
| 默认值 | 1024 |
| 取值范围 | \[4, 18446744073709551615\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
auto_increment_offset
==========================================
auto_increment_offset 用于确定 AUTO_INCREMENT 列值的起点。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | uint |
| 默认值 | 1 |
| 取值范围 | \[1, 65535\] |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,15 @@
identity
=============================
identity 和变量 last_insert_id 是同义词,可以通过 `select @@identity` 查询。
| **属性** | **描述** |
|--------|-----------------------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0, 18446744073709551615\] |
| 生效范围 | SESSION |

View File

@ -0,0 +1,21 @@
lower_case_table_names
===========================================
lower_case_table_names 用于设置是否对大小写敏感。
| **属性** | **描述** |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 1 |
| 取值范围 | * 0:表示表名将按指定存储,并且比较区分大小写 * 1:表示表名以小写形式存储在磁盘上,并且比较不区分大小写 * 2:表示表名按指定存储,但以小写形式进行比较 |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |
| 是否可修改 | 否,仅在 OBServer 启动的命令行上指定,启动后不能再通过 SQL 语句修改。 |
**说明**
该变量仅在 MySQL 模式下对 DataBase 和 Table 对象名生效。

View File

@ -0,0 +1,32 @@
net_read_timeout
=====================================
net_read_timeout 用于中断读之前等待连接的其它数据的秒数。
**说明**
该变量仅用于兼容,OceanBase 数据库当前暂未实现该变量的功能。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 30 |
| 取值范围 | \[1, 31536000\] |
| 生效范围 | * GLOBAL * SESSION |
其中:
* 当服务器从客户端读数时,net_read_timeout 指控制何时中断的超时值。
* 当服务器向客户端写时,net_write_timeout 指控制何时中断的超时值。

View File

@ -0,0 +1,32 @@
net_write_timeout
======================================
net_write_timeout 用于设置中断写之前等待块写入连接的秒数。
**说明**
该变量仅用于兼容,OceanBase 数据库当前暂未实现该变量的功能。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 60 |
| 取值范围 | \[1, 31536000\] |
| 生效范围 | * GLOBAL * SESSION |
其中:
* 当服务器从客户端读数时,net_read_timeout 指控制何时中断的超时值。
* 当服务器向客户端写时,net_write_timeout 指控制何时中断的超时值。

View File

@ -0,0 +1,19 @@
read_only
==============================
read_only 用于设置租户是否为只读模式。
| **属性** | **描述** |
|--------|-----------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 0 |
| 取值范围 | * 1:租户为只读模式 * 0:租户为读写模式 |
| 生效范围 | GLOBAL |
**说明**
设置后,会影响该租户下的所有普通用户,不影响 root 权限用户。

View File

@ -0,0 +1,28 @@
sql_auto_is_null
=====================================
sql_auto_is_null 会被一些特殊的驱动程序,例如 ODBC 使用,用于获取最后插入行的自增列值。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | OFF |
| 取值范围 | * OFF * ON |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |
当 sql_auto_is_null 为 `ON` 时,与下面两条语句等价:
```sql
// CREATE TABLE t1 (auto_inc_column auto_increment, j int);
obclient> SELECT * FROM t1 WHERE auto_inc_column is null;
obclient> SELECT * FROM t1 WHERE auto_inc_column = last_insert_id();
```

View File

@ -0,0 +1,16 @@
sql_select_limit
=====================================
sql_select_limit 用于设置一个 select 查询允许返回的最大行数。如果一个 select 中包含了 limit 语句,那么 limit 的值比 sql_select_limit 的优先级高,默认不限制 select 返回的行数。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 9223372036854775807 |
| 取值范围 | \[0, 9223372036854775807\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
timestamp
==============================
TIMESTAMP 是时间戳,单位为秒,该变量影响 `select now(6) `的结果。
| **属性** | **描述** |
|--------|--------------------|
| 参数类型 | numeric |
| 默认值 | 0 |
| 取值范围 | \[0, 253402272000) |
| 生效范围 | SESSION |

View File

@ -0,0 +1,20 @@
tx_read_only
=================================
tx_read_only 用于设置是否为只读事务。
| **属性** | **描述** |
|---------|-------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 0 |
| 取值范围 | * 1:只读事务 * 0:不是只读事务 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
**说明**
设置后,仅影响该用户,不影响其他用户。

View File

@ -0,0 +1,16 @@
version
============================
version 用于设置服务器的版本号。
| **属性** | **描述** |
|--------|---------|
| 参数类型 | varchar |
| 默认值 | 5.6.25 |
| 取值范围 | N/A |
| 生效范围 | GLOBAL |
| 是否可修改 | 否 |

View File

@ -0,0 +1,16 @@
autocommit
===============================
autocommit 用于设置是否自动提交事务。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 1:自动提交 * 0:不自动提交 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
sql_warnings
=================================
sql_warnings 用于在出现告警时控制单行 INSERT 语句是否生成信息字符串。
| **属性** | **描述** |
|--------|-----------------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | OFF |
| 取值范围 | * ON:生成一个信息字符串 * OFF:不生成信息字符串 |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,19 @@
max_user_connections
=========================================
max_user_connections 用于指定单个用户可以向 OBServer 建立的连接数,设置为 0 时表示不限制连接数。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0, 4294967295\] |
| 生效范围 | * GLOBAL * SESSION |
**说明**
该变量不能通过 `alter session set xxx = yyy; `语句的方式使其仅在当前 Session 生效,只能通过 `set global xxx = yyy` 语句的方式使全局生效。

View File

@ -0,0 +1,14 @@
init_connect
=================================
init_connect 用于设置服务器为每个连接的客户端执行的字符串,该字符串由一条或多条 SQL 语句组成,用分号分隔。
| **属性** | **描述** |
|--------|---------|
| 参数类型 | varchar |
| 默认值 | N/A |
| 取值范围 | N/A |
| 生效范围 | GLOBAL |

View File

@ -0,0 +1,16 @@
license
============================
license 用于设置 license 的类型。
| **属性** | **描述** |
|--------|---------|
| 参数类型 | varchar |
| 默认值 | 空字符串 |
| 取值范围 | N/A |
| 生效范围 | GLOBAL |
| 是否可修改 | 否 |

View File

@ -0,0 +1,19 @@
net_buffer_length
======================================
net_buffer_length 用于设置 OBServer 能接受的 SQL Query 的大小。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 16384 |
| 取值范围 | \[1024, 1048576\] |
| 生效范围 | * GLOBAL * SESSION |
**说明**
该变量不能通过 `alter session set xxx = yyy; `语句的方式使其仅在当前 Session 生效,只能通过 `set global xxx = yyy` 语句的方式使全局生效。

View File

@ -0,0 +1,17 @@
system_time_zone
=====================================
system_time_zone 用于设置服务器机器系统时区。
| **属性** | **描述** |
|---------|-------------------------------------------|
| 参数类型 | varchar |
| 默认值 | CST |
| 取值范围 | N/A |
| 生效范围 | GLOBAL |
| 是否可修改 | 否,仅在 OBServer 启动的命令行上指定,启动后不能再通过 SQL 语句修改 |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
query_cache_size
=====================================
query_cache_size 用于设置分配给存储历史查询结果的内存,即尚未使用的内存,单位为 Byte。
| **属性** | **描述** |
|--------|-----------------------------|
| 参数类型 | uint |
| 默认值 | 1048576 |
| 取值范围 | \[0, 18446744073709551615\] |
| 生效范围 | GLOBAL |

View File

@ -0,0 +1,15 @@
query_cache_type
=====================================
query_cache_type 用于查询缓存类型。
| **属性** | **描述** |
|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | varchar |
| 默认值 | OFF |
| 取值范围 | * OFF:不缓存或检索结果。 * ON:缓存除了 `SELECT SQL_NO_CACHE ...`查询的所有结果。 * DEMAND:只缓存 `SELECT SQL_CACHE ... `查询的结果。 |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,14 @@
sql_quote_show_create
==========================================
sql_quote_show_create 用于设置是否为 `SHOW CREATE TABLE``SHOW CREATE DATABASE` 语句启动引用标识符。
| **属性** | **描述** |
|--------|---------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | true |
| 取值范围 | * true:启用 * false:不启用 |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,15 @@
max_sp_recursion_depth
===========================================
max_sp_recursion_depth 用于设置可以递归调用任一指定存储过程的最大层次。默认值为 0 ,表示当前存储过程不可递归调用。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 0 |
| 取值范围 | \[0, 255\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,17 @@
character_set_client
=========================================
character_set_client 用于设置客户端发送语句的字符集。
| **属性** | **描述** |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4 |
| 取值范围 | * utf8mb4 * binary * gbk |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,21 @@
sql_safe_updates
=====================================
sql_safe_updates 用于设置是否启用 MySQL 的 SQL 安全模式,默认为关闭。
**说明**
该变量仅用于兼容,OceanBase 数据库当前暂未实现该变量的功能。
| **属性** | **描述** |
|---------|--------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 0 |
| 取值范围 | * 0:表示 FALSE,即关闭 * 1:表示 TRUE,即开启 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,17 @@
ob_proxy_partition_hit
===========================================
ob_proxy_partition_hit 用于设置 OBProxy 是否将 SQL 语句请求的数据发送到这些数据主 Partition 所在的 OBServer 上。
| **属性** | **描述** |
|--------|-----------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 1:是 * 0:否 |
| 生效范围 | SESSION |
| 是否可修改 | 否 |
| 是否可见 | 否,所有租户均不可见 |

View File

@ -0,0 +1,15 @@
ob_log_level
=================================
ob_log_level 用于设置 Session 级的日志级别,如果不指定则使用系统中的日志级别。
| **属性** | **描述** |
|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | varchar |
| 默认值 | disabled |
| 取值范围 | * trace * info * warn * error |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,15 @@
ob_max_parallel_degree
===========================================
ob_max_parallel_degree 用于设置每次请求最大的并发数。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 16 |
| 取值范围 | NULL |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,16 @@
ob_query_timeout
=====================================
ob_query_timeout 用于设置查询超时时间,单位是微秒。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 10000000 |
| 取值范围 | NULL |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,17 @@
ob_read_consistency
========================================
`ob_read_consistency` 用于设置读一致性级别。
| **属性** | **描述** |
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | enum |
| 默认值 | STRONG |
| 取值范围 | * 0:空字符串 * 1:FROZEN * 2:WEAK * 3:STRONG |
| 生效范围 | * Global * Session |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,17 @@
ob_enable_transformation
=============================================
ob_enable_transformation 用于设置是否开启 SQL 优化器的改写功能。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 0:不开启 * 1:开启 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,16 @@
ob_trx_timeout
===================================
ob_trx_timeout 用于设置事务超时时间,单位为微秒。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 100000000 |
| 取值范围 | NULL |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
ob_enable_plan_cache
=========================================
ob_enable_plan_cache 用于设置是否打开 Plan Cache。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 0:关闭 * 1:打开 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,17 @@
ob_enable_index_direct_select
==================================================
ob_enable_index_direct_select 用于设置是否允许用户直接查询索引表。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 0 |
| 取值范围 | * 0:不允许 * 1:允许 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,17 @@
character_set_connection
=============================================
character_set_connection 用于设置收到语句后应转换的字符集。
| **属性** | **描述** |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4 |
| 取值范围 | * utf8mb4 * binary * gbk |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,17 @@
ob_proxy_set_trx_executed
==============================================
ob_proxy_set_trx_executed 用于设置用户是否通过 OBProxy 发送 `START TRANSACTION Syntax` 给 OBServer。
| **属性** | **描述** |
|--------|--------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 0 |
| 取值范围 | * 0:不发送 * 1:发送 |
| 生效范围 | SESSION |
| 是否可修改 | 否 |
| 是否可见 | 否,所有租户均不可见 |

View File

@ -0,0 +1,16 @@
ob_enable_aggregation_pushdown
===================================================
ob_enable_aggregation_pushdown 用于设置是否允许聚合操作下压。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 0:不允许 * 1:允许 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,16 @@
ob_last_schema_version
===========================================
ob_last_schema_version 用于设置该 Session 中最新使用的 Schema 版本号。
当 Proxy 的同一个连接对应到多个 Server 时,需要使用该系统变量进行 Schema 同步,故该变量只在 Session 级别生效。
| **属性** | **描述** |
|--------|----------------------------|
| 参数类型 | int |
| 默认值 | 0 |
| 取值范围 | \[0, 9223372036854775807\] |
| 生效范围 | SESSION |

View File

@ -0,0 +1,15 @@
ob_global_debug_sync
=========================================
ob_global_debug_sync 用于 debug 时设置同步点,与 debug_sync 不同,设置此变量会影响所有 Session。只有 debug_sync_timeout 配置项的值不为 0 时,该设置才有效。
| **属性** | **描述** |
|--------|------------|
| 参数类型 | varchar |
| 默认值 | 空字符串 |
| 取值范围 | 无 |
| 生效范围 | SESSION |
| 是否可见 | 否,所有租户均不可见 |

View File

@ -0,0 +1,18 @@
ob_proxy_global_variables_version
======================================================
ob_proxy_global_variables_version 用于设置 OBServer 返回给 OBproxy 所需的全局变量的最新版本信息。
| **属性** | **描述** |
|--------|-----------------|
| 参数类型 | int |
| 默认值 | 5 |
| 取值范围 | \[0, INT64_MAX) |
| 生效范围 | SESSION |
| 是否可修改 | 否 |
| 是否可见 | 否,所有租户均不可见 |
执行 `select @@ob_proxy_global_variables_version` 语句时将返回当前全局变量的最新版本号。默认值为 0,用户不可修改。

View File

@ -0,0 +1,16 @@
ob_enable_trace_log
========================================
ob_enable_trace_log 用于设置是否使用 trace 日志。
| **属性** | **描述** |
|---------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 0 |
| 取值范围 | * 0:不使用 * 1:使用 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,17 @@
ob_enable_hash_group_by
============================================
ob_enable_hash_group_by 用于设置是否打开 Hash Group by 的路径。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 0:不允许 * 1:允许 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,17 @@
ob_enable_blk_nestedloop_join
==================================================
ob_enable_blk_nestedloop_join 用于设置是否允许打开 block nested loop join。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 0 |
| 取值范围 | * 0:不允许 * 1:允许 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,16 @@
ob_bnl_join_cache_size
===========================================
ob_bnl_join_cache_size 用于设置 batch nest loop join 一次 cache 多少数据做一次 batch。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 10485760 |
| 取值范围 | \[1, 9223372036854775807\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,18 @@
ob_org_cluster_id
======================================
ob_org_cluster_id 用于设置 OceanBase 集群的 CLUSTER_ID。
通常情况下不需要设置 ob_org_cluster_id 变量,OceanBase 数据库生成日志(clog)时会使用缺省值(即每一个 OceanBase 集群的 CLUSTER_ID)。DRC 在复制数据写入目标集群时,需要在 Session 中将该变量设置为日志中所带的 CLUSTER_ID,以免数据被循环复制。
| **属性** | **描述** |
|---------|-------------------|
| 参数类型 | int |
| 默认值 | 0 |
| 取值范围 | \[0, 4294967295\] |
| 生效范围 | SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
character_set_database
===========================================
character_set_database 用于设置默认数据库的字符集。
| **属性** | **描述** |
|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4 |
| 取值范围 | * utf8mb4 * binary * gbk * gb18030 * utf16 |
| 生效范围 | * GLOBAL * SESSION |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,15 @@
ob_plan_cache_percentage
=============================================
ob_plan_cache_percentage 用于设置计划缓存可以使用的租户内存资源的百分比。
| **属性** | **描述** |
|---------|------------|
| 参数类型 | int |
| 默认值 | 5 |
| 取值范围 | \[0, 100\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
ob_plan_cache_evict_high_percentage
========================================================
ob_plan_cache_evict_high_percentage 用于设置触发计划缓存逐出的计划缓存限制的内存使用百分比。
| **属性** | **描述** |
|---------|------------|
| 参数类型 | int |
| 默认值 | 90 |
| 取值范围 | \[0, 100\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,15 @@
ob_plan_cache_evict_low_percentage
=======================================================
ob_plan_cache_evict_low_percentage 用于设置停止计划缓存逐出的计划缓存限制的内存使用百分比。
| **属性** | **描述** |
|---------|------------|
| 参数类型 | int |
| 默认值 | 50 |
| 取值范围 | \[0, 100\] |
| 生效范围 | GLOBAL |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
recyclebin
===============================
recyclebin 用于设置是否开启回收站功能。
| **属性** | **描述** |
|--------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 0 |
| 取值范围 | * 0:不开启 * 1:开启 |
| 生效范围 | * GLOBAL * SESSION |
启用回收站后,删除的表及其依赖对象将放置在回收站中;当禁用回收站时,删除的表及其依赖对象不会放置在回收站中,会直接删除。

View File

@ -0,0 +1,17 @@
ob_capability_flag
=======================================
ob_capability_flag 是 OBServer 能够提供的能力,用于和 Proxy 连接时进行能力协商,告知 Proxy 当前 OBServer 支持哪些功能,不支持哪些功能。
| **属性** | **描述** |
|--------|----------------------------|
| 参数类型 | uint |
| 默认值 | 0 |
| 取值范围 | \[0,18446744073709551615\] |
| 生效范围 | SESSION |
| 是否可修改 | 否 |
| 是否可见 | 否,对所有租户均不可见 |

View File

@ -0,0 +1,22 @@
ob_stmt_parallel_degree
============================================
ob_stmt_parallel_degree 用于设置查询的并行度,即可以并行运行的任务数。
**说明**
该变量已不再使用。
| **属性** | **描述** |
|----------|------------------------------------------------------------------------------------------------------------|
| 参数类型 | int |
| 默认值 | 1 |
| 取值范围 | \[1, 10240\] |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |
| 是否影响计划生成 | 是 |

View File

@ -0,0 +1,16 @@
is_result_accurate
=======================================
当查询带有 topk 提示时,is_result_accurate 表示结果是否正确。
| **属性** | **描述** |
|---------|--------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 0:不正确 * 1:正确 |
| 生效范围 | SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,16 @@
error_on_overlap_time
==========================================
error_on_overlap_time 是动态参数,用于设置夏令时重叠区时间发生歧义时是否作报错处理。
| **属性** | **描述** |
|---------|-------------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | OFF |
| 取值范围 | * ON:进行报错处理 * OFF:不进行报错处理 |
| 生效范围 | * GLOBAL * SESSION |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,17 @@
ob_compatibility_mode
==========================================
ob_compatibility_mode 用于指定租户的兼容模式。该系统变量只能在创建租户时指定,租户创建好之后则无法修改。
| **属性** | **描述** |
|---------|---------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | enum |
| 默认值 | MYSQL |
| 取值范围 | * MYSQL:表示兼容 MYSQL * ORACLE:表示兼容 ORACLE |
| 生效范围 | * GLOBAL * SESSION |
| 是否可修改 | 否 |
| 是否参与序列化 | 是 |

View File

@ -0,0 +1,14 @@
ob_create_table_strict_mode
================================================
`ob_create_table_strict_mode` 是动态变量,用于设置建表的严格模式。
| **属性** | **描述** |
|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | bool |
| 默认值 | 1 |
| 取值范围 | * 1:表示会严格按照 Locality 建立副本,任何副本建立失败,则建表失败。 * 0:表示全类型副本至少有 1 个,Paxos 成员组副本达到多数,则建表成功。 |
| 生效范围 | * GLOBAL * SESSION |

View File

@ -0,0 +1,16 @@
character_set_results
==========================================
character_set_results 用于设置服务器在将结果集或错误消息发送回客户端之前应转换为的字符集。
| **属性** | **描述** |
|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| 参数类型 | string |
| 默认值 | utf8mb4 |
| 取值范围 | * utf8mb4 * binary * gbk |
| 生效范围 | * GLOBAL * SESSION |
| 是否可以为空 | 是 |

View File

@ -0,0 +1,14 @@
ob_sql_work_area_percentage
================================================
ob_sql_work_area_percentage 用于 SQL 执行的租户内存百分比限制。
| **属性** | **描述** |
|--------|------------|
| 参数类型 | int |
| 默认值 | 5 |
| 取值范围 | \[0, 100\] |
| 生效范围 | GLOBAL |

Some files were not shown because too many files have changed in this diff Show More