From 25d022d8d8ba4b94098a8bf016c54860f9900f90 Mon Sep 17 00:00:00 2001 From: spaceoddity91719 Date: Mon, 23 May 2022 18:48:25 +0800 Subject: [PATCH] update(mogdb):guc parameters --- .../1-query-and-index-statistics-collector.md | 2 +- .../guc-parameters/13-load-management.md | 2 +- .../guc-parameters/14-automatic-vacuuming.md | 2 +- .../1-statement-behavior.md | 6 +- .../2-zone-and-formatting.md | 10 +- .../3-other-default-parameters.md | 4 +- .../guc-parameters/16-lock-management.md | 6 +- .../1-compatibility-with-earlier-versions.md | 12 +- .../2-platform-and-client-compatibility.md | 44 +- .../guc-parameters/18-fault-tolerance.md | 14 +- .../19-connection-pool-parameters.md | 24 ++ .../guc-parameters/20-MogDB-transaction.md | 23 +- .../guc-parameters/21-developer-options.md | 56 ++- .../22-auditing/1-audit-switch.md | 12 + .../22-auditing/3-operation-audit.md | 32 +- .../guc-parameters/23-upgrade-parameters.md | 6 +- .../24-miscellaneous-parameters.md | 20 +- .../guc-parameters/25-wait-events.md | 6 +- .../guc-parameters/26-query.md | 42 +- .../27-system-performance-snapshot.md | 6 +- .../27.1-security-configuration.md | 6 +- ...ity-query-in-a-fully-encrypted-database.md | 23 -- .../29-global-temporary-table.md | 4 +- .../guc-parameters/29.1-HyperLogLog.md | 11 +- .../guc-parameters/30-appendix.md | 20 +- .../guc-parameters/31-scheduled-task.md | 2 +- .../guc-parameters/32-thread-pool.md | 1 + .../33-user-defined-functions.md | 3 +- .../reference-guide/guc-parameters/35-undo.md | 19 +- .../36-DCF-parameters-settings.md | 36 +- .../guc-parameters/37-flashback.md | 14 +- .../guc-parameters/39-reserved-parameters.md | 6 +- .../guc-parameters/cm-parameters/cm_agent.md | 314 ++++++++++++++ .../guc-parameters/cm-parameters/cm_server.md | 391 ++++++++++++++++++ .../global-syscache-parameters.md | 43 ++ product/zh/docs-mogdb/v3.0/toc.md | 4 + .../v3.0/toc_parameters-and-tools.md | 4 + 37 files changed, 1058 insertions(+), 172 deletions(-) delete mode 100644 product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/28-equality-query-in-a-fully-encrypted-database.md create mode 100644 product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_agent.md create mode 100644 product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_server.md create mode 100644 product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/global-syscache-parameters.md diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/1-query-and-index-statistics-collector.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/1-query-and-index-statistics-collector.md index 90cf1fc1..fcc65f77 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/1-query-and-index-statistics-collector.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/1-query-and-index-statistics-collector.md @@ -127,7 +127,7 @@ date: 2021-04-20 - on表示开启计数功能。 - off表示关闭计数功能。 -**默认值: on** +**默认值**：on > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**： > diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/13-load-management.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/13-load-management.md index b8b37bfd..20124112 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/13-load-management.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/13-load-management.md @@ -227,7 +227,7 @@ date: 2021-04-20 ## disable_memory_protect -**参数说明**：禁止内存保护功能。当系统内存不足时如果需要查询系统视图，可以先将此参数置为on，禁止内存保护功能，保证视图可以正常查询。该参数只适用于在系统内存不足时进行系统诊断和调试，正常运行时请保持该参数配置为off。 +**参数说明**：设置是否禁止内存保护功能。当系统内存不足时如果需要查询系统视图，可以先将此参数置为on，禁止内存保护功能，保证视图可以正常查询。该参数只适用于在系统内存不足时进行系统诊断和调试，正常运行时请保持该参数配置为off。 该参数属于USERSET类型参数，且只对当前会话有效。请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/14-automatic-vacuuming.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/14-automatic-vacuuming.md index ceb66061..ee8305dc 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/14-automatic-vacuuming.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/14-automatic-vacuuming.md @@ -23,7 +23,7 @@ date: 2021-04-20 > > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**： > -> 即使此参数设置为off，当事务ID回绕即将发生时，数据库也会自动启动自动清理线程。对于create/drop database发生异常时，可能有的节点提交或回滚，有的节点未提交（prepared状态)，此时系统不能自动修复，需要手动修复。 +> 即使此参数设置为off，当事务ID回绕即将发生时，数据库也会自动启动自动清理线程。对于create/drop database发生异常时，可能有的节点提交或回滚，有的节点未提交（prepared状态），此时系统不能自动修复，需要手动修复。 **取值范围**：布尔型 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/1-statement-behavior.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/1-statement-behavior.md index bb32b30a..0143763e 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/1-statement-behavior.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/1-statement-behavior.md @@ -25,10 +25,10 @@ date: 2021-04-20 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** > > - 设置为“$user”，public时，支持共享数据库（没有用户具有私有模式和所有共享使用public）、用户私有模式和这些功能的组合使用。可以通过改变默认搜索路径来获得其他效果，无论是全局化的还是私有化的。 -> - 设置为空串（”)的时候，系统会自动转换成一对双引号。 +> - 设置为空串（''）的时候，系统会自动转换成一对双引号。 > - 设置的内容中包含双引号，系统会认为是不安全字符，会将每个双引号转换成一对双引号。 -**默认值：**“$user”,public +**默认值：**"$user",public > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** > @@ -42,7 +42,7 @@ date: 2021-04-20 **取值范围：**字符串 -**默认值：**”$user”,public +**默认值：**"$user",public > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** > diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/2-zone-and-formatting.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/2-zone-and-formatting.md index 8cb7ca40..5640a497 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/2-zone-and-formatting.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/2-zone-and-formatting.md @@ -13,9 +13,9 @@ date: 2021-04-20 **参数说明**：设置日期和时间值的显示格式，以及有歧义的输入值的解析规则。 -这个变量包含两个独立的加载部分: 输出格式声明（ISO、Postgres、SQL、German）和输入输出的年/月/日顺序（DMY、MDY、YMD）。这两个可以独立设置或者一起设置。关键字Euro和European等价于DMY；关键字US、NonEuro、NonEuropean等价于MDY。 +这个变量包含两个独立的加载部分：输出格式声明（ISO、Postgres、SQL、German）和输入输出的年/月/日顺序（DMY、MDY、YMD）。这两个可以独立设置或者一起设置。关键字Euro和European等价于DMY；关键字US、NonEuro、NonEuropean等价于MDY。 -该参数属于USERSET类型参数，请**参考表GUC参数设置方式**中对应设置方法进行设置。 +该参数属于USERSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**：字符串 @@ -37,8 +37,8 @@ date: 2021-04-20 - sql_standard表示产生与SQL标准规定匹配的输出。 - postgres表示产生与PostgreSQL 8.4版本相匹配的输出，当[DateStyle](#DateStyle)参数被设为ISO时。 - postgres_verbose表示产生与PostgreSQL 8.4版本相匹配的输出，当[DateStyle](#DateStyle)参数被设为non_ISO时。 -- iso_8601表示产生与在ISO 8601中定义的"格式与代号"相匹配的输出。 -- a表示与numtodsinterval函数相匹配的输出结果，详细请参考numtodsinterval。 +- iso_8601表示产生与在ISO 8601中定义的“格式与代号”相匹配的输出。 +- a表示与numtodsinterval函数相匹配的输出结果，详细请参考[numtodsinterval](8-date-and-time-processing-functions-and-operators)。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**： > IntervalStyle参数也会影响不明确的间隔输入的说明。 @@ -185,6 +185,6 @@ date: 2021-04-20 **取值范围**：字符串 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**： -> MogDB支持pg_catalog.english，pg_catalog.simple两种配置。 +> MogDB支持pg_catalog.english、pg_catalog.simple两种配置。 **默认值**：pg_catalog.english diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/3-other-default-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/3-other-default-parameters.md index fb26b167..6301529a 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/3-other-default-parameters.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/15-default-settings-of-client-connection/3-other-default-parameters.md @@ -13,10 +13,10 @@ date: 2021-04-20 **参数说明**：设置数据查找动态加载的共享库文件的路径。当需要打开一个可以动态装载的模块并且在CREATE FUNCTION或LOAD命令里面声明的名称没有目录部分时，系统将搜索这个目录以查找声明的文件。 -用于dynamic_library_path的数值必须是一个冒号分隔的绝对路径列表。当一个路径名称以特殊变量\$libdir为开头时，会替换为MogDB发布提供的模块安装路径。例如: +用于dynamic_library_path的数值必须是一个冒号分隔的绝对路径列表。当一个路径名称以特殊变量\$libdir为开头时，会替换为MogDB发布提供的模块安装路径。例如： ```bash -dynamic_library_path = '/usr/local/lib/gaussdb:/opt/testgs/lib:$libdir' +dynamic_library_path = '/usr/local/lib/mogdb:/opt/testgs/lib:$libdir' ``` 该参数属于SUSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/16-lock-management.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/16-lock-management.md index 56f81902..5cfb76e2 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/16-lock-management.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/16-lock-management.md @@ -14,7 +14,7 @@ date: 2021-04-20 **参数说明**：设置死锁超时检测时间，以毫秒为单位。当申请的锁超过设定值时，系统会检查是否产生了死锁。 - 死锁的检查代价是比较高的，服务器不会在每次等待锁的时候都运行这个过程。在系统运行过程中死锁是不经常出现的，因此在检查死锁前只需等待一个相对较短的时间。增加这个值就减少了无用的死锁检查浪费的时间，但是会减慢真正的死锁错误报告的速度。在一个负载过重的服务器上，用户可能需要增大它。这个值的设置应该超过事务持续时间，这样就可以减少在锁释放之前就开始死锁检查的问题。 -- 如果要通过设置log_lock_waits来将查询执行过程中的锁等待耗时信息写入日志，请确保log_lock_waits的设置值小于deadlock_timeout的设置值（或默认值）。 +- 当设置log_lock_waits为on时，deadlock_timeout决定一个等待时间来将查询执行过程中的锁等待耗时信息写入日志。如果要研究锁延时情况，可以设置deadlock_timeout的值比正常情况小。 该参数属于SUSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -102,7 +102,9 @@ date: 2021-04-20 ## fault_mon_timeout -**参数说明**：轻量级死锁检测周期。该参数属于SIGHUP类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +**参数说明**：轻量级死锁检测周期。 + +该参数属于SIGHUP类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**：整型，最小值0，最大值1440，单位为分钟（min） diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/1-compatibility-with-earlier-versions.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/1-compatibility-with-earlier-versions.md index 4f3fe8de..06f85131 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/1-compatibility-with-earlier-versions.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/1-compatibility-with-earlier-versions.md @@ -29,7 +29,7 @@ MogDB介绍数据库的向下兼容性和对外兼容性特性的参数控制。 该参数属于USERSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**： -> 在字符串文本符合SQL标准的情况下，\\没有任何其他含义。这个参数影响的是如何处理不符合标准的字符串文本，包括明确的字符串转义语法是（E'…'）。 +> 在字符串文本符合SQL标准的情况下，\\没有任何其他含义。这个参数影响的是如何处理不符合标准的字符串文本，包括明确的字符串转义语法是（E'...')。 **取值范围**：枚举类型 @@ -43,7 +43,7 @@ MogDB介绍数据库的向下兼容性和对外兼容性特性的参数控制。 **参数说明**：警告在普通字符串中直接使用反斜杠转义。 -- 如果需要使用反斜杠作为转义，可以调整为使用转义字符串语法（E'…'）来做转义，因为在每个SQL标准中，普通字符串的默认行为现在将反斜杠作为一个普通字符。 +- 如果需要使用反斜杠作为转义，可以调整为使用转义字符串语法（E'...'）来做转义，因为在每个SQL标准中，普通字符串的默认行为现在将反斜杠作为一个普通字符。 - 这个变量可以帮助定位需要改变的代码。 该参数属于USERSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -66,7 +66,7 @@ on表示当读取或修改大对象时禁用权限检查，与PostgreSQL 9.0以 ## quote_all_identifiers -**参数说明**：当数据库生成SQL时，此选项强制引用所有的标识符（包括非关键字）。这将影响到EXPLAIN的输出及函数的结果，例如pg_get_viewdef。详细说明请参见gs_dump的-quote-all-identifiers选项。 +**参数说明**：当数据库生成SQL时，此选项强制引用所有的标识符（包括非关键字）。这将影响到EXPLAIN的输出及函数的结果，例如pg_get_viewdef。详细说明请参见gs_dump的--quote-all-identifiers选项。 该参数属于USERSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -92,10 +92,10 @@ on表示当读取或修改大对象时禁用权限检查，与PostgreSQL 9.0以 ## standard_conforming_strings -**参数说明**：控制普通字符串文本（'…'）中是否按照SQL标准把反斜扛当普通文本。 +**参数说明**：控制普通字符串文本（'...'）中是否按照SQL标准把反斜扛当普通文本。 - 应用程序通过检查这个参数可以判断字符串文本的处理方式。 -- 建议明确使用转义字符串语法（E'…'）来转义字符。 +- 建议明确使用转义字符串语法（E'...'）来转义字符。 该参数属于USERSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -114,7 +114,7 @@ on表示当读取或修改大对象时禁用权限检查，与PostgreSQL 9.0以 **取值范围**：布尔型 -- on表示扫描可能从表的中间开始，然后选择"环绕"方式来覆盖所有的行，为了与已经在进行中的扫描活动同步。这可能会造成没有用ORDER BY子句的查询得到行排序造成不可预测的后果。 +- on表示扫描可能从表的中间开始，然后选择“环绕”方式来覆盖所有的行，为了与已经在进行中的扫描活动同步。这可能会造成没有用ORDER BY子句的查询得到行排序造成不可预测的后果。 - off表示确保顺序扫描是从表头开始的。 **默认值**：on diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/2-platform-and-client-compatibility.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/2-platform-and-client-compatibility.md index ee4eab40..504d8edb 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/2-platform-and-client-compatibility.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/17-version-and-platform-compatibility/2-platform-and-client-compatibility.md @@ -77,7 +77,9 @@ date: 2021-04-20 ## sql_compatibility -**参数说明**：控制数据库的SQL语法和语句行为同哪一个主流数据库兼容。该参数属于INTERNAL类型参数，用户无法修改，只能查看。 +**参数说明**：控制数据库的SQL语法和语句行为同哪一个主流数据库兼容。 + +该参数属于INTERNAL类型参数，用户无法修改，只能查看。 **取值范围**：枚举型 @@ -90,7 +92,7 @@ date: 2021-04-20 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知：** > -> - 该参数只能在执行**CREATE DATABASE**命令创建数据库的时候设置。 +> - 该参数只能在执行[CREATE DATABASE](CREATE-DATABASE)命令创建数据库的时候设置。 > - 在数据库中，该参数只能是确定的一个值，要么始终设置为A，要么始终设置为B，请勿任意改动，否则会导致数据库行为不一致。 ## behavior_compat_options @@ -110,20 +112,28 @@ date: 2021-04-20 **表 1** 兼容性配置项 -| **兼容性配置项** | **兼容性行为控制** | -| :------------------------ | :----------------------------------------------------------- | -| display_leading_zero | 浮点数显示配置项。
- 不设置此配置项时，对于-1\~0和0\~1之间的小数，不显示小数点前的0。比如，0.25显示为.25。
- 设置此配置项时，对于-1\~0和0\~1之间的小数，显示小数点前的0。比如，0.25显示为0.25。 | -| end_month_calculate | add_months函数计算逻辑配置项。
假定函数add_months的两个参数分别为param1和param2，param1的月份和param2的和为月份result。
- 不设置此配置项时，如果param1的日期（Day字段）为月末，并且param1的日期（Day字段）比result月份的月末日期小，计算结果中的日期字段（Day字段）和param1的日期字段保持一致。比如，
`mogdb=# select add_months('2018-02-28',3) from sys_dummy; add_months ---------------------- 2018-05-28 00:00:00 (1 row)`
- 设置此配置项时，如果param1的日期（Day字段）为月末，并且param1的日期（Day字段）比result月份的月末日期比小，计算结果中的日期字段（Day字段）和result的月末日期保持一致。比如，
`mogdb=# select add_months('2018-02-28',3) from sys_dummy; add_months ---------------------- 2018-05-31 00:00:00 (1 row)` | -| compat_analyze_sample | analyze采样行为配置项。
设置此配置项时，会优化analyze的采样行为，主要体现在analyze时全局采样会更精确的控制在3万条左右，更好的控制analyze时DBnode端的内存消耗，保证analyze性能的稳定性。 | -| bind_schema_tablespace | 绑定模式与同名表空间配置项。
如果存在与模式名sche_name相同的表空间名，那么如果设置search_path为sche_name， default_tablespace也会同步切换到sche_name。 | -| bind_procedure_searchpath | 未指定模式名的数据库对象的搜索路径配置项。
在存储过程中如果不显示指定模式名，会优先在存储过程所属的模式下搜索。
如果找不到，则有两种情况：
- 若不设置此参数，报错退出。
- 若设置此参数，按照search_path中指定的顺序继续搜索。如果还是找不到，报错退出。 | -| correct_to_number | 控制to_number()结果兼容性的配置项。
若设置此配置项，则to_number()函数结果与pg11保持一致，否则默认与O db保持一致。 | -| unbind_dive_bound | 控制对整数除法的结果进行范围校验。
若设置此配置项，则不需要对除法结果做范围校验，例如，INT_MIN/(-1)可以得到输出结果为INT_MAX+1，反之，则会因为超过结果大于INT_MAX而报越界错误。 | -| merge_update_multi | 控制merge into匹配多行时是否进行update操作。
若设置此配置项，匹配多行时update不报错，否则默认与a db保持一致，报错。 | -| return_null_string | 控制函数lpad()和rpad()结果为空字符串”的显示配置项。
- 不设置此配置项时，空字符串显示为NULL。
`mogdb=# select length(lpad('123',0,'*')) from sys_dummy; length ----------------------- (1 row)*`
- 设置此配置项时，空字符串显示为”。
`mogdb=# select length(lpad('123',0,'*')) from sys_dummy; length ----------------------- 0 (1 row)` | -| compat_concat_variadic | 控制函数concat()和concat_ws()对variadic类型结果兼容性的配置项。
若设置此配置项，当concat函数参数为variadic类型时，保留a db和Teradata兼容模式下不同的结果形式；否则默认a db和Teradata兼容模式下结果相同，且与a db保持一致。由于MY无variadic类型，所以该选项对MY无影响。 | -| merge_update_multi | 控制在使用MERGE INTO … WHEN MATCHED THEN UPDATE（参考**MERGE INTO**） 和INSERT … ON DUPLICATE KEY UPDATE（参考**INSERT**）时，当目标表中一条目标数据与多条源数据冲突时UPDATE行为。
若设置此配置项，当存在上述场景时，该冲突行将会多次执行UPDATE；否则（默认）报错，即MERGE或INSERT操作失败。 | -| hide_tailing_zero | numeric显示配置项。不设置此项时，numeric按照指定精度显示。设置此项时，隐藏小数点后的末尾0。
`set behavior_compat_options='hide_tailing_zero'; select cast(123.123 as numeric(15,10)); numeric ---- 123.123 (1 row)` | +| **兼容性配置项** | **兼容性行为控制** | +| :------------------------------ | :----------------------------------------------------------- | +| display_leading_zero | 浮点数显示配置项。
- 不设置此配置项时，对于-1\~0和0\~1之间的小数，不显示小数点前的0。比如，0.25显示为.25。
- 设置此配置项时，对于-1\~0和0\~1之间的小数，显示小数点前的0。比如，0.25显示为0.25。 | +| end_month_calculate | add_months函数计算逻辑配置项。
假定函数add_months的两个参数分别为param1和param2，param1的月份和param2的和为月份result。
- 不设置此配置项时，如果param1的日期（Day字段）为月末，并且param1的日期（Day字段）比result月份的月末日期小，计算结果中的日期字段（Day字段）和param1的日期字段保持一致。比如，
`mogdb=# select add_months('2018-02-28',3) from sys_dummy; add_months ---------------------- 2018-05-28 00:00:00 (1 row)`
- 设置此配置项时，如果param1的日期（Day字段）为月末，并且param1的日期（Day字段）比result月份的月末日期比小，计算结果中的日期字段（Day字段）和result的月末日期保持一致。比如，
`mogdb=# select add_months('2018-02-28',3) from sys_dummy; add_months ---------------------- 2018-05-31 00:00:00 (1 row)` | +| compat_analyze_sample | analyze采样行为配置项。
设置此配置项时，会优化analyze的采样行为，主要体现在analyze时全局采样会更精确的控制在3万条左右，更好的控制analyze时DBnode端的内存消耗，保证analyze性能的稳定性。 | +| bind_schema_tablespace | 绑定模式与同名表空间配置项。
如果存在与模式名sche_name相同的表空间名，那么如果设置search_path为sche_name， default_tablespace也会同步切换到sche_name。 | +| bind_procedure_searchpath | 未指定模式名的数据库对象的搜索路径配置项。
在存储过程中如果不显示指定模式名，会优先在存储过程所属的模式下搜索。
如果找不到，则有两种情况：
- 若不设置此参数，报错退出。
- 若设置此参数，按照search_path中指定的顺序继续搜索。如果还是找不到，报错退出。 | +| correct_to_number | 控制to_number()结果兼容性的配置项。
若设置此配置项，则to_number()函数结果与pg11保持一致，否则默认与O db保持一致。 | +| unbind_dive_bound | 控制对整数除法的结果进行范围校验。
若设置此配置项，则不需要对除法结果做范围校验，例如，INT_MIN/(-1)可以得到输出结果为INT_MAX+1，反之，则会因为超过结果大于INT_MAX而报越界错误。 | +| merge_update_multi | 控制merge into匹配多行时是否进行update操作。
若设置此配置项，匹配多行时update不报错，否则默认与a db保持一致，报错。 | +| return_null_string | 控制函数lpad()和rpad()结果为空字符串”的显示配置项。
- 不设置此配置项时，空字符串显示为NULL。
`mogdb=# select length(lpad('123',0,'*')) from sys_dummy; length ----------------------- (1 row)*`
- 设置此配置项时，空字符串显示为”。
`mogdb=# select length(lpad('123',0,'*')) from sys_dummy; length ----------------------- 0 (1 row)` | +| compat_concat_variadic | 控制函数concat()和concat_ws()对variadic类型结果兼容性的配置项。
若设置此配置项，当concat函数参数为variadic类型时，保留a db和Teradata兼容模式下不同的结果形式；否则默认a db和Teradata兼容模式下结果相同，且与a db保持一致。由于MY无variadic类型，所以该选项对MY无影响。 | +| merge_update_multi | 控制在使用MERGE INTO … WHEN MATCHED THEN UPDATE（参考[MERGE INTO](MERGE-INTO)） 和INSERT … ON DUPLICATE KEY UPDATE（参考[INSERT](INSERT)）时，当目标表中一条目标数据与多条源数据冲突时UPDATE行为。
若设置此配置项，当存在上述场景时，该冲突行将会多次执行UPDATE；否则（默认）报错，即MERGE或INSERT操作失败。 | +| hide_tailing_zero | numeric显示配置项。不设置此项时，numeric按照指定精度显示。设置此项时，隐藏小数点后的末尾0。
`set behavior_compat_options='hide_tailing_zero'; select cast(123.123 as numeric(15,10)); numeric ---- 123.123 (1 row)` | +| rownum_type_compat | 控制ROWNUM的类型，ROWNUM默认类型为INT8，设置此参数后，ROWNUM类型变更为NUMERIC类型。 | +| aformat_null_test | 控制rowtype类型判空逻辑,设置此项时，对于rowtype is not null判断，当一行数据有一列不为空的时候返回ture。否则，对于rowtype is not null判断，当一行数据所有列不为空的时候返回ture. | +| aformat_regexp_match | 控制正则表达式函数的匹配行为。
设置此项，且sql_compatibility参数的值为A或B时，正则表达式的 flags 参数支持的选项含义有变更：
1. “.”默认不能匹配 '\n' 字符。
2. flags 中包含n选项时，“.”能够匹配 '\n' 字符。
3. regexp_replace(source, pattern replacement) 函数替换所有匹配的子串。
4. regexp_replace(source, pattern, replacement, flags) 在 flags值为” 或者null时，返回值为null。
否则，正则表达式的 flags 参数支持的选项含义：
1. “.”默认能匹配 '\n' 字符。
2. flags 中的 n 选项表示按照多行模式匹配。
3. regexp_replace(source, pattern replacement) 函数仅替换第一个匹配到的子串。
4. regexp_replace(source, pattern, replacement, flags) 在 flags值为” 或者null时，返回值为替换后的字符串。 | +| compat_cursor | 控制隐式游标状态兼容行为。设置此项，且兼容O，隐式游标状态（SQL%FOUND、SQL%NOTFOUND、SQL%ISOPNE、SQL%ROWCOUNT）由原先的仅在当前执行的函数有效，拓展到包括本函数调用的子函数有效。 | +| proc_outparam_override | 控制存储过程出参的重载行为，打开该参数后，对于存储过程只有out出参部分不同的情况下，也可以正常调用。 | +| proc_implicit_for_loop_variable | 控制存储过程中FOR_LOOP查询语句行为设置此项时，在FOR rec IN query LOOP语句中，若rec已经定义，不会复用已经定义的rec变量，而且重新建立一个新的变量。否则，会复用已经定义的rec变量，不会建立新的变量。 | +| allow_procedure_compile_check | 控制存储过程中select语句和open cursor语句的编译检查设置此项时，在存储过程中执行select语句、open cursor for语句、cursor%rowtype语句、for rec in语句时，若查询的表不存在，则无法创建创建存储过程，不支持trigger函数的编译检查，若查询的表存在，则成功创建存储过程。 | +| char_coerce_compat | 控制char(n)类型向其它变长字符串类型转换时的行为。默认情况下char(n)类型转换其它变长字符串类型时会省略尾部的空格，开启该参数后，转换时不再省略尾部的空格，并且在转换时如果char(n)类型的长度超过其它变长字符串类型时将会报错。该参数仅在sql_compatibility参数的值为A时生效。 | ## plpgsql.variable_conflict @@ -143,7 +153,7 @@ date: 2021-04-20 **参数说明**：控制是否开启与Teradata数据库相应兼容的特征。该参数在用户连接上与TD兼容的数据库时，可以将参数设置成为on（即超长字符串自动截断功能启用），该功能启用后，在后续的insert语句中，对目标表中char和varchar类型的列插入超长字符串时，会按照目标表中相应列定义的最大长度对超长字符串进行自动截断。保证数据都能插入目标表中，而不是报错。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 超长字符串自动截断功能不适用于insert语句包含外表的场景。 如果向字符集为字节类型编码（SQL_ASCII，LATIN1等）的数据库中插入多字节字符数据（如汉字等），且字符数据跨越截断位置，这种情况下，按照字节长度自动截断，自动截断后会在尾部产生非预期结果。如果用户有对于截断结果正确性的要求，建议用户采用UTF8等能够按照字符截断的输入字符集作为数据库的编码集。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 超长字符串自动截断功能不适用于insert语句包含外表的场景。如果向字符集为字节类型编码（SQL_ASCII、LATIN1等）的数据库中插入多字节字符数据（如汉字等)，且字符数据跨越截断位置，这种情况下，按照字节长度自动截断，自动截断后会在尾部产生非预期结果。如果用户有对于截断结果正确性的要求，建议用户采用UTF8等能够按照字符截断的输入字符集作为数据库的编码集。 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/18-fault-tolerance.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/18-fault-tolerance.md index 9190702f..731bb79a 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/18-fault-tolerance.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/18-fault-tolerance.md @@ -46,14 +46,14 @@ date: 2021-04-20 **取值范围**：布尔型 -- on表示有转换错误的字符将被忽略，以"?"代替，打印错误信息到日志中。 +- on表示有转换错误的字符将被忽略，以“?”代替，打印错误信息到日志中。 - off表示有转换错误的字符不能被转换，打印错误信息到终端。 **默认值**：off ## max_query_retry_times -**参数说明**：指定SQL语句出错自动重试功能的最大重跑次数（目前支持重跑的错误类型为"Connection reset by peer"、"Lock wait timeout"和"Connection timed out"等），设定为0时关闭重跑功能。 +**参数说明**：指定SQL语句出错自动重试功能的最大重跑次数（目前支持重跑的错误类型为“Connection reset by peer”、“Lock wait timeout”和“Connection timed out”等），设定为0时关闭重跑功能。 该参数属于USERSET类型参数，请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -71,6 +71,16 @@ date: 2021-04-20 **默认值**：8KB +## max_cn_temp_file_size + +**参数说明：**指定SQL语句出错自动重试功能中数据库主节点端使用临时文件的最大值，设定为0表示不使用临时文件。 + +该参数属于SIGHUP类型参数，请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 + +**取值范围：**整型，0~10485760， 单位为KB。 + +**默认值：**5GB + ## retry_ecode_list **参数说明**：指定SQL语句出错自动重试功能支持的错误类型列表。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/19-connection-pool-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/19-connection-pool-parameters.md index 94f862ce..60d5b726 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/19-connection-pool-parameters.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/19-connection-pool-parameters.md @@ -9,6 +9,30 @@ date: 2021-04-20 当使用连接池访问数据库时，在系统运行过程中，数据库连接是被当作对象存储在内存中的，当用户需要访问数据库时，并非建立一个新的连接，而是从连接池中取出一个已建立的空闲连接来使用。用户使用完毕后，数据库并非将连接关闭，而是将连接放回连接池中，以供下一个请求访问使用。 +## pooler_maximum_idle_time + +**参数说明：**Pooler链接自动清理功能使用，当链接池中链接空闲时间超过所设置值时，会触发自动清理机制，清理各节点的空闲链接数到minimum_pool_size。 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 此参数在该版本不生效。 + +该参数属于USERSET类型参数，请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 + +**取值范围：**整型，最小值为0，最大值为INT_MAX，最小单位为分钟 + +**默认值：**1h（即60min） + +## minimum_pool_size + +**参数说明：**Pooler链接自动清理功能使用，自动清理后各pooler链接池对应节点的链接数最小剩余量，当参数设置为0时，可以关闭pooler链接自动清理功能。 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 此参数在该版本不生效。 + +该参数属于USERSET类型参数，请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 + +**取值范围：**整型，最小值为1，最大值为65535 + +**默认值：**200 + ## cache_connection **参数说明**：是否回收连接池的连接。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/20-MogDB-transaction.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/20-MogDB-transaction.md index 95461dd9..c7a791f1 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/20-MogDB-transaction.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/20-MogDB-transaction.md @@ -71,7 +71,7 @@ date: 2021-04-20 ## transaction_deferrable -**参数说明**：指定是否允许一个只读串行事务延迟执行，使其不会执行失败。该参数设置为on时，当一个只读事务发现读取的元组正在被其他事务修改，则延迟该只读事务直到其他事务修改完成。目前，MogDB暂时未用到这个参数。与该参数类似的还有一个default_transaction_deferrable，设置它来指定一个事务是否允许延迟。 +**参数说明**：指定是否允许一个只读串行事务延迟执行，使其不会执行失败。该参数设置为on时，当一个只读事务发现读取的元组正在被其他事务修改，则延迟该只读事务直到其他事务修改完成。该参数为预留参数，该版本不生效。与该参数类似的还有一个default_transaction_deferrable，设置它来指定一个事务是否允许延迟。 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -84,7 +84,7 @@ date: 2021-04-20 ## enable_show_any_tuples -**参数说明**：该参数只有在只读事务中可用，用于分析。当这个参数被置为on/true时，表中元组的所有版本都会可见。 +**参数说明**：该参数只有在只读事务中可用，用于分析。 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -115,8 +115,25 @@ date: 2021-04-20 **参数说明**：指定节点名称。 -该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。此参数修改后会导致连接数据库实例失败，不建议进行修改。 +该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +在备机请求主机进行日志复制时，如果application_name参数没有设置，那么该参数会被用来作为备机在主机上的流复制槽名字。该流复制槽的命名方式为 “该参数值\_备机ip\_备机port”。其中，备机ip和备机port取自replconninfo参数中指定的备机ip和端口号。该流复制槽最大长度为61个字符，如果拼接后的字符串超过该长度，则会使用截断后的pgxc_node_name进行拼接，以保证流复制槽名字长度小于等于61个字符。 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **注意：** 此参数修改后会导致连接数据库实例失败，不建议进行修改。 **取值范围**：字符串 **默认值**：当前节点名称 + +## enable_defer_calculate_snapshot + +**参数说明**：延迟计算快照的xmin和oldestxmin，执行1000个事务或者间隔1s才触发计算，设置为on时可以在高负载场景下减少计算快照的开销，但是会导致oldestxmin推进较慢，影响垃圾元组回收，设置为off时xmin和oldestxmin可以实时推进，但是会增加计算快照时的开销。 + +该参数属于SIGHUP类型参数，改请参考[GUC参数分类](30-appendix)进行设置 + +**取值范围：**布尔型。 + +- on表示延迟计算快照xmin和oldestxmin。 +- off表示实时计算快照xmin和oldestxmin**。** + +**默认值：**on diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/21-developer-options.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/21-developer-options.md index 5f7bd17f..31044fc1 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/21-developer-options.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/21-developer-options.md @@ -13,8 +13,6 @@ date: 2021-04-20 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -不建议修改该参数默认值，如果设置为on，可能导致系统表损坏，甚至数据库无法启动。 - **取值范围**：布尔型 - on表示允许修改系统表的结构。 @@ -22,9 +20,11 @@ date: 2021-04-20 **默认值**：off +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif)**注意**：不建议修改该参数默认值，如果设置为on，可能导致系统表损坏，甚至数据库无法启动。 + ## debug_assertions -**参数说明**：控制打开各种断言检查。能够协助调试，当遇到奇怪的问题或者崩溃，请把此参数打开，因为它能暴露编程的错误。要使用这个参数，必须在编译MogDB的时候定义宏USE_ASSERT_CHECKING（通过configure选项 -enable-cassert完成）。 +**参数说明**：控制打开各种断言检查。能够协助调试，当遇到奇怪的问题或者崩溃，请把此参数打开，因为它能暴露编程的错误。要使用这个参数，必须在编译MogDB的时候定义宏USE_ASSERT_CHECKING（通过configure选项 --enable-cassert完成）。 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -58,9 +58,8 @@ date: 2021-04-20 该参数属于BACKEND类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**： +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**：这个参数在从系统索引被破坏的表中恢复数据的时候非常有用。 > -> 这个参数在从系统索引被破坏的表中恢复数据的时候非常有用。 **取值范围**：布尔型 @@ -79,6 +78,8 @@ date: 2021-04-20 **默认值**：0 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 此参数只用于调试和问题定位，为避免影响正常业务运行，生产环境下请确保参数值为默认值0。参数设置为非0时可能会因认证延迟时间过长导致数据库实例状态异常。 + ## pre_auth_delay **参数说明**：启动服务器连接后，延迟指定时间，进行认证。允许调试器附加到认证过程上。 @@ -89,6 +90,8 @@ date: 2021-04-20 **默认值**：0 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 此参数只用于调试和问题定位，为避免影响正常业务运行，生产环境下请确保参数值为默认值0。参数设置为非0时可能会因认证延迟时间过长导致数据库实例状态异常。 + ## trace_notify **参数说明**：为LISTEN和NOTIFY命令生成大量调试输出。client_min_messages或log_min_messages级别必须是DEBUG1或者更低时，才能把这些输出分别发送到客户端或者服务器日志。 @@ -108,7 +111,7 @@ date: 2021-04-20 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：枚举类型，有效值有debug5、debug4、debug3、debug2、debug1、log，取值的详细信息请参见log_min_messages。 +**取值范围**：枚举类型，有效值有debug5、debug4、debug3、debug2、debug1、log，取值的详细信息请参见[log_min_messages](2-logging-time#log_min_messages)。 **默认值**：log @@ -148,7 +151,7 @@ date: 2021-04-20 该参数不支持修改。 -**取值范围**：枚举类型，有效值有application，datanode，internaltool。 +**取值范围**：枚举类型，有效值有application、datanode、internaltool。 **默认值**：application @@ -196,8 +199,8 @@ date: 2021-04-20 **取值范围**：字符串 -- summary: 显示简略的诊断信息。 -- detail: 显示详细的诊断信息。 +- summary：显示简略的诊断信息。 +- detail：显示详细的诊断信息。 目前这两个参数值只在显示多列统计信息未收集的告警的情况下有差别，summary不显示未收集多列统计信息的告警，detail会显示这类告警。 @@ -216,6 +219,8 @@ date: 2021-04-20 **默认值**：off +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 当前版本不支持加速数据库实例，因此该参数设置后不生效。 + ## support_batch_bind **参数说明**：控制是否允许通过JDBC、ODBC、Libpq等接口批量绑定和执行PBE形式的语句。 @@ -237,8 +242,8 @@ date: 2021-04-20 **取值范围**：字符串，当前有效取值为'none', 'all'。 -- none: 表示不启用本特性。 -- all: 表示将部分共享数据和线程分布到不同的NUMA节点下，减少远端访存次数，提高性能。目前仅适用于拥有多个NUMA节点的ARM服务器，并且要求全部NUMA节点都可用于数据库进程，不支持仅选择一部分NUMA节点。 +- none：表示不启用本特性。 +- all：表示将部分共享数据和线程分布到不同的NUMA节点下，减少远端访存次数，提高性能。目前仅适用于拥有多个NUMA节点的ARM服务器，并且要求全部NUMA节点都可用于数据库进程，不支持仅选择一部分NUMA节点。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 当前版本x86平台下不支持numa_distribute_mode设置为all。 @@ -252,7 +257,7 @@ date: 2021-04-20 **取值范围**：布尔型 -**默认值**：off +**默认值**：on ## advance_xlog_file_num @@ -266,10 +271,15 @@ date: 2021-04-20 ## enable_beta_opfusion -**参数说明**：当参数enable_opfusion设置为on时，是否加速TPC-C中聚合函数、排序、nestloop join等SQL语句的执行。对于nestloop join SQL语句，enable_beta_nestloop_fusion必须设置为on。 +**参数说明**：在enable_opfusion参数打开的状态下，如果开启该参数，可以支持TPCC中出现的聚集函数，排序两类SQL语句的加速执行，提升SQL执行性能。 + +该参数属于USERSET类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**： 布尔型 +- on表示开启。 +- off表示不开启。 + **默认值**：off ## string_hash_compatible @@ -286,3 +296,23 @@ date: 2021-04-20 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 计算方式的不同主要体现在字符串计算hash值时传入的字节长度上。（如果为char，则会忽略字符串后面空格的长度，如果为text或varchar，则会保留字符串后面空格的长度。）hash值的计算会影响到查询的计算结果，因此此参数一旦设置后，在整个数据库使用过程中不能再对其进行修改，以避免查询错误。 **默认值**：off + +## pldebugger_timeout + +**参数说明：**该参数用来控制pldebugger server端等待debug端响应的超时时间。 + +该参数属于USERSET类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**：整型，1 ~ 86400，单位为秒。 + +**默认值**：15min + +## plsql_show_all_error + +**参数说明：**该参数用来控制编译PLPGSQL对象时是否支持跳过报错继续编译，具体影响请参考DBE_PLDEVELOPER内的说明。 + +该参数属于USERSET类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**：布尔型 + +**默认值**：off diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/1-audit-switch.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/1-audit-switch.md index e582ea2f..0eab1171 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/1-audit-switch.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/1-audit-switch.md @@ -111,3 +111,15 @@ date: 2021-04-20 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**： > 请尽量保证此参数为1048576，并不要随意调整此参数，否则可能会导致audit_resource_policy无法生效，如果需要控制审计日志的存储空间和时间，请使用audit_resource_policy、audit_space_limit和audit_file_remain_time参数进行控制。 + +## audit_thread_num + +**参数说明：**审计线程的个数。 + +该参数属于POSTMASTER类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围：**整型，1~48 + +**默认值：**1 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知：** 当audit_dml_state开关打开且在高性能场景下，建议增大此参数保证审计消息可以被及时处理和记录。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/3-operation-audit.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/3-operation-audit.md index 2afcee96..23eb2673 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/3-operation-audit.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/3-operation-audit.md @@ -13,14 +13,14 @@ date: 2021-04-20 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：整型，0～524287 +**取值范围**：整型，0～67108863 - 0代表关闭MogDB数据库对象的CREATE、DROP、ALTER操作审计功能。 - 非0代表只审计MogDB的某类或者某些数据库对象的CREATE、DROP、ALTER操作。 **取值说明**: -该参数的值由20个二进制位的组合求出，这20个二进制位分别代表MogDB的20类数据库对象。如果对应的二进制位取值为0，表示不审计对应的数据库对象的CREATE、DROP、ALTER操作；取值为1，表示审计对应的数据库对象的CREATE、DROP、ALTER操作。这19个二进制位代表的具体审计内容请参见[表1](#audit_system_object)。 +该参数的值由26个二进制位的组合求出，这26个二进制位分别代表MogDB的26类数据库对象。如果对应的二进制位取值为0，表示不审计对应的数据库对象的CREATE、DROP、ALTER操作；取值为1，表示审计对应的数据库对象的CREATE、DROP、ALTER操作。这26个二进制位代表的具体审计内容请参见[表1](#audit_system_object)。 **默认值**：12295 @@ -49,6 +49,11 @@ date: 2021-04-20 | 第18位 | 是否审计SYNONYM对象的CREATE、DROP、ALTER操作。 | - 0表示不审计SYNONYM对象的CREATE、DROP、ALTER操作；
- 1表示审计SYNONYM对象的CREATE、DROP、ALTER操作。 | | 第19位 | 是否审计SEQUENCE对象的CREATE、DROP、ALTER操作。 | - 0表示不审计SEQUENCE对象的CREATE、DROP、ALTER操作；
- 1表示审计SEQUENCE对象的CREATE、DROP、ALTER操作。 | | 第20位 | 是否审计CMK、CEK对象的CREATE、DROP操作。 | - 0表示不审计CMK、CEK对象的CREATE、DROP操作；
- 1表示审计CMK、CEK对象的CREATE、DROP操作。 | +| 第21位 | 是否审计PACKAGE对象的CREATE、DROP、ALTER操作。 | - 0表示不审计PACKAGE对象的CREATE、DROP、ALTER操作；
- 1表示审计PACKAGE对象的CREATE、DROP、ALTER操作。 | +| 第22位 | 是否审计MODEL对象的CREATE、DROP操作。 | - 0表示不审计MODEL对象的CREATE、ALTER操作；
- 1表示审计MODEL对象的CREATE、DROP操作。 | +| 第23位 | 是否审计PUBLICATION和SUBSCRIPTION对象的CREATE、DROP、ALTER操作。 | - 0表示不审计PUBLICATION和SUBSCRIPTION对象的CREATE、DROP、ALTER操作；
- 1表示审计PUBLICATION和SUBSCRIPTION对象的CREATE、DROP、ALTER操作。 | +| 第24位 | 是否审计对gs_global_config全局对象的ALTER、DROP操作。 | - 0表示不审计对系统表gs_global_config全局对象的ALTER、DROP操作；
- 1表示审计对系统表gs_global_config全局对象的ALTER、DROP操作。 | +| 第25位 | 是否审计FOREIGN DATA WRAPPER对象的CREATE、DROP、ALTER操作。 | - 0表示不审计FOREIGN DATA WRAPPER对象的CREATE、DROP、ALTER操作；
- 1表示审计FOREIGN DATA WRAPPER对象的CREATE、DROP、ALTER操作。 | ## audit_dml_state @@ -100,7 +105,7 @@ date: 2021-04-20 - 0表示关闭COPY审计功能。 - 1表示开启COPY审计功能。 -**默认值**：0 +**默认值**：1 ## audit_set_parameter @@ -115,6 +120,27 @@ date: 2021-04-20 **默认值**：1 +## audit_xid_info + +**参数说明：**这个参数决定是否在审计日志字段detail_info中记录SQL语句的事务ID。 + +该参数属于SIGHUP类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围：**整型，0、1。 + +- 0表示关闭审计日志记录事务ID功能。 +- 1表示开启审计日志记录事务ID功能。 + +**默认值：**0 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知：** 如果开启此开关，审计日志中detail_info信息则以xid开始，例如： +> +> ``` +> detail_info: xid=14619 , create table t1(id int); +> ``` +> +> 对于不存在事务ID的审计行为，记录xid=NA。 + ## enableSeparationOfDuty **参数说明**：是否开启三权分立选项。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/23-upgrade-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/23-upgrade-parameters.md index 06868429..f1a8caa4 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/23-upgrade-parameters.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/23-upgrade-parameters.md @@ -32,7 +32,9 @@ date: 2021-04-20 ## upgrade_mode -**参数说明**：标示升级模式。该参数不建议用户自己修改。 +**参数说明**：标示升级模式。 + +该参数属于INTERNAL类型参数，为固定参数，用户无法修改此参数，只能查看。 **取值范围**：整数，0~INT_MAX @@ -41,3 +43,5 @@ date: 2021-04-20 - 2表示在灰度升级过程中。 **默认值**：0 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 特殊情况：在使用灰度升级的情况下，若选择策略为大版本升级，即需要执行升级脚本和替换二进制包，会将upgrade_mode设置为2，选择策略为小版本升级，只替换二进制包，则不会设置upgrade_mode设置为2。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/24-miscellaneous-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/24-miscellaneous-parameters.md index d42a14b4..e10a09cc 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/24-miscellaneous-parameters.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/24-miscellaneous-parameters.md @@ -31,7 +31,7 @@ date: 2021-04-20 **参数说明**：Ustore测试参数。 -该参数属于USERSET类型，可以设置包括enable_ustore_partial_seqscan（仅在ustore表中顺序扫描时复制选择性列），enable_candidate_buf_usage_count（是否脏页淘汰加入使用次数权重），ustats_tracker_naptime（重新加载统计文件所用的时间），umax_search_length_for_prune（扩展表前要修剪的块数），ustore_unit_test（开启Ustore白盒测试），设置方法为 ustore_att='需要设置的参数'，例如需要设置enable_ustore_partial_seqscan时，ustore_attr='enable_ustore_partial_seqscan=on'。 +该参数属于USERSET类型，可以设置包括enable_ustore_partial_seqscan（仅在ustore表中顺序扫描时复制选择性列）、enable_candidate_buf_usage_count（是否脏页淘汰加入使用次数权重）、ustats_tracker_naptime（重新加载统计文件所用的时间）、umax_search_length_for_prune（扩展表前要修剪的块数）、ustore_unit_test（开启Ustore白盒测试）。设置方法为 ustore_attr='需要设置的参数'，例如需要设置enable_ustore_partial_seqscan时，ustore_attr='enable_ustore_partial_seqscan=on'。 **取值范围**：字符串 @@ -73,7 +73,7 @@ date: 2021-04-20 **单位**: 8KB -**默认值**：131072, 即1GB +**默认值**：131072，即1GB ## max_index_keys @@ -106,7 +106,7 @@ date: 2021-04-20 ## lc_ctype -**参数说明**：报告当前数据库的字母类别区域设置。如: 哪些字符属于字母，它对应的大写形式是什么。 +**参数说明**：报告当前数据库的字母类别区域设置。如：哪些字符属于字母，它对应的大写形式是什么。 该参数属于INTERNAL类型参数，为固定参数，用户无法修改此参数，只能查看。 @@ -140,14 +140,16 @@ date: 2021-04-20 **取值范围**： 布尔型 -- on，提升deltamerge内部实现的锁级别，并发执行deltamerge和update/delete操作时，一个操作先执行，另一个操作被阻塞，在前一个操作完成后，后一个操作再执行。 -- off，在对表的delta table的同一行并发执行deltamerge和update/delete操作时，后一个对同一行数据更新的操作会报错退出。 +- on：表示提升deltamerge内部实现的锁级别，并发执行deltamerge和update/delete操作时，一个操作先执行，另一个操作被阻塞，在前一个操作完成后，后一个操作再执行。 +- off：表示在对表的delta table的同一行并发执行deltamerge和update/delete操作时，后一个对同一行数据更新的操作会报错退出。 **默认值**：off ## transparent_encrypted_string -**参数说明**：它存储的是透明加密的一个样本串，使用数据库加密密钥加密固定串"TRANS_ENCRYPT_SAMPLE_STRING"后的密文，用来校验二次启动时获取的DEK是否正确。如果校验失败，那么数据库节点将拒绝启动。该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**参数说明**：它存储的是透明加密的一个样本串，使用数据库加密密钥加密固定串"TRANS_ENCRYPT_SAMPLE_STRING"后的密文，用来校验二次启动时获取的DEK是否正确。如果校验失败，那么数据库节点将拒绝启动。 + +该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。该参数当前版本只适用于DWS场景。 **取值范围**：字符串，设置为空表示MogDB非加密。 @@ -157,7 +159,7 @@ date: 2021-04-20 ## transparent_encrypt_kms_url -**参数说明**：它存储的是透明加密的数据库密钥获取地址，内容要求不可出现RFC3986标准外的字符，最大长度2047字节。格式为"kms://协议@KMS主机名1;KMS主机名2:KMS端口号/kms"，例如 kms://https@linux175:29800/。 +**参数说明**：它存储的是透明加密的数据库密钥获取地址，内容要求不可出现RFC3986标准外的字符，最大长度2047字节。格式为"kms://协议@KMS主机名1;KMS主机名2:KMS端口号/kms"，例如 kms://https@linux175:29800/。该参数当前版本只适用于DWS场景。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -167,7 +169,7 @@ date: 2021-04-20 ## transparent_encrypt_kms_region -**参数说明**：它存储的是MogDB的部署区域，内容要求不可出现RFC3986标准外的字符，最大长度2047字节。 +**参数说明**：它存储的是MogDB的部署区域，内容要求不可出现RFC3986标准外的字符，最大长度2047字节。该参数当前版本只适用于DWS场景。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -189,7 +191,7 @@ date: 2021-04-20 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：整型，1000～60000（毫秒） +**取值范围**：整型，1000～60000，单位为毫秒。 **默认值**：1s diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/25-wait-events.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/25-wait-events.md index a7ac2842..3c95bd76 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/25-wait-events.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/25-wait-events.md @@ -11,11 +11,13 @@ date: 2021-04-20 **参数说明**：是否开启等待事件信息实时收集功能。 +在x86平台集中式部署下，硬件配置规格为32核CPU/256GB内存，使用Benchmark SQL 5.0工具测试性能，开关此参数性能影响约1.4%。 + 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**：布尔型 -- on: 表示打开等待事件信息收集功能。 -- off: 表示关闭等待事件信息收集功能。 +- on：表示打开等待事件信息收集功能。 +- off：表示关闭等待事件信息收集功能。 **默认值**：on diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/26-query.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/26-query.md index 162dc68a..890f49c0 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/26-query.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/26-query.md @@ -15,6 +15,8 @@ date: 2021-04-20 当系统中产生的unique sql条目数量大于instr_unique_sql_count时，若开启了unique sql自动淘汰，则系统会按unique sql的更新时间由远到近自动淘汰一定比例的条目，使得新产生的unique sql信息可以继续被统计。若没有开启自动淘汰，则系统产生的新的unique sql信息将不再被统计。 +在x86平台集中式部署下，硬件配置规格为32核CPU/256GB内存，使用Benchmark SQL 5.0工具测试性能，开关此参数性能影响约3%。 + 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**：整型，0~2147483647 @@ -47,14 +49,14 @@ top：只记录顶层SQL。 **取值范围**：布尔型 -- on：表示打开sql响应时间信息计算功能。 -- off：表示关闭sql响应时间信息计算功能。 +- on：表示打开SQL响应时间信息计算功能。 +- off：表示关闭SQL响应时间信息计算功能。 **默认值**：on ## percentile -**参数说明**：sql响应时间百分比信息，后台计算线程根据设置的值计算相应的百分比信息。 +**参数说明**：SQL响应时间百分比信息，后台计算线程根据设置的值计算相应的百分比信息。 该参数属于INTERNAL类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -64,24 +66,26 @@ top：只记录顶层SQL。 ## instr_rt_percentile_interval -**参数说明**：sql响应时间信息计算间隔，sql响应时间信息计算功能打开后，后台计算线程每隔设置的时间进行一次计算。 +**参数说明**：SQL响应时间信息计算间隔，SQL响应时间信息计算功能打开后，后台计算线程每隔设置的时间进行一次计算。 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：整型，0～3600（秒）。 +**取值范围**：整型，0～3600，单位为秒。 **默认值**：10s ## enable_instr_cpu_timer -**参数说明**：是否捕获sql执行的cpu时间消耗 。 +**参数说明**：是否捕获SQL执行的cpu时间消耗 。 + +在x86平台集中式部署下，硬件配置规格为32核CPU/256GB内存，使用Benchmark SQL 5.0工具测试性能，开关此参数性能影响约3.5%。 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**：布尔型 -- on：表示捕获sql执行的cpu时间消耗。 -- off：表示不捕获sql执行的cpu时间消耗。 +- on：表示捕获SQL执行的cpu时间消耗。 +- off：表示不捕获SQL执行的cpu时间消耗。 **默认值**：on @@ -89,6 +93,8 @@ top：只记录顶层SQL。 **参数说明**：控制是否启用Full /Slow SQL特性。 +在x86平台集中式部署下，硬件配置规格为32核CPU/256GB内存，使用Benchmark SQL 5.0工具测试性能，开关此参数性能影响约1.2%。 + 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**：布尔型 @@ -144,30 +150,14 @@ slow sql retention time为慢SQL的保留时间，取值范围为0 ~ 604800 该参数分为两部分，形式为'full sql stat level, slow sql stat level' -第一部分为全量SQL跟踪级别，取值范围为OFF、L0、L1、L2 +full sql stat level为全量SQL跟踪级别，取值范围为OFF、L0、L1、L2 -第二部分为慢SQL的跟踪级别，取值范围为OFF、L0、L1、L2 +slow sql stat level为慢SQL的跟踪级别，取值范围为OFF、L0、L1、L2 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 若全量SQL跟踪级别值为非OFF时，当前SQL跟踪级别值为全量SQL和慢SQL的较高级别（L2 > L1 > L0），级别说明请参见表[GUC参数分类](30-appendix)。 **默认值**：OFF,L0 -## unique_sql_clean_ratio - -**参数说明**：当系统中产生的unique sql条目数量大于等于instr_unique_sql_count时，每次自动淘汰的unique sql条目数量占总条目数量预设上限instr_unique_sql_count的比例。 - -该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**：double类型，0~0.2 - -**默认值**：0.1 - -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **注意：** -> -> - 该值设置过小每次清理的条目较少，可能会导致频繁进行清理；设置过大时每次清理的条目较多，可能会导致频繁插入。建议值0.1。 -> -> - unique_sql_clean_ratio设置为0不代表关闭自动淘汰功能，请通过enable_auto_clean_unique_sql来控制是否开启自动淘汰。当开启自动淘汰，且将unique_sql_clean_ratio设置为0时，将自动把unique_sql_clean_ratio重置为默认值0.1。 - ## enable_auto_clean_unique_sql **参数说明**：当系统中产生的unique sql条目数量大于等于instr_unique_sql_count时，是否启用unique sql自动淘汰功能。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27-system-performance-snapshot.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27-system-performance-snapshot.md index 41f46591..61a8ce9d 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27-system-performance-snapshot.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27-system-performance-snapshot.md @@ -15,14 +15,14 @@ date: 2021-04-20 **取值范围**：布尔型 -- on: 打开数据库监控快照功能。 -- off: 关闭数据库监控快照功能。 +- on：打开数据库监控快照功能。 +- off：关闭数据库监控快照功能。 **默认值**：off ## wdr_snapshot_retention_days -**参数说明**：系统中数据库监控快照数据的保留天数，超过设置的值之后，系统每隔wdr_snapshot_interval时间间隔，清理snapshot_id最小的快照数据。 +**参数说明**：系统中数据库监控快照数据的保留天数。当数据库运行过程期间所生成的快照量数超过保留天数内允许生成的快照数量的最大值时，系统将每隔wdr_snapshot_interval时间间隔，清理snapshot_id最小的快照数据。 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27.1-security-configuration.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27.1-security-configuration.md index 9a79f77b..d483603e 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27.1-security-configuration.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/27.1-security-configuration.md @@ -33,7 +33,7 @@ off：安全策略开关关闭。 ## use_elastic_search -**参数说明**：使能统一审计发送日志至Elastic Search系统, enable_security_policy打开且本参数打开后，统一审计日志会通过http(https)传递至Elastic Search系统（默认使用https安全协议）。此参数打开后需要保证elastic_search_ip_addr对应的es服务可正常连通，否则进程启动失败。 +**参数说明**：使能统一审计发送日志至Elastic Search系统，enable_security_policy打开且本参数打开后，统一审计日志会通过http（https）传递至Elastic Search系统（默认使用https安全协议）。此参数打开后需要保证elastic_search_ip_addr对应的es服务可正常连通，否则进程启动失败。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -53,9 +53,9 @@ off：关闭统一审计日志发送至Elastic Search。 **取值范围**：布尔型。 -on表示是初始用户。 +on：是初始用户。 -off表示不是初始用户。 +off：不是初始用户。 **默认值**：off diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/28-equality-query-in-a-fully-encrypted-database.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/28-equality-query-in-a-fully-encrypted-database.md deleted file mode 100644 index 9dc64f19..00000000 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/28-equality-query-in-a-fully-encrypted-database.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: 全密态数据库支持等值查询 -summary: 全密态数据库支持等值查询 -author: Zhang Cuiping -date: 2021-04-20 ---- - -# 全密态数据库支持等值查询 - -## enable_full_encryption - -**参数说明**：全密态数据库开关，控制全密态数据库是否生效。 - -该参数属于BACKEND类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -enable_full_encryption设置为on后，使用gsql连接数据库时需要输入"-C"参数，或"-enable-client-encryption"，否则连接不成功。 - -**取值范围**：布尔型 - -- on: 全密态数据库开关打开。 -- off: 全密态数据库开关关闭。 - -**默认值**：off diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29-global-temporary-table.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29-global-temporary-table.md index f54f5c27..7e6304b8 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29-global-temporary-table.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29-global-temporary-table.md @@ -15,8 +15,8 @@ date: 2021-04-20 **取值范围**：整型，0 ~ 1000000 -- 0: 全局临时表功能关闭。 -- > 0: 全局临时表功能打开。 +- 0：全局临时表功能关闭。 +- > 0：全局临时表功能打开。 **默认值**：1000 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29.1-HyperLogLog.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29.1-HyperLogLog.md index 8f493756..0ae5d495 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29.1-HyperLogLog.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/29.1-HyperLogLog.md @@ -9,7 +9,7 @@ date: 2021-11-08 ## hll_default_log2m -**参数说明**：该参数可以指定hll数据结构桶的个数。桶的个数会影响hll计算distinct值的精度，桶的个数越多，误差越小。误差范围为：[-1.04/2log2m\*1⁄2,+1.04/2log2m*1⁄2]。 +**参数说明**：该参数可以指定hll数据结构桶的个数。桶的个数会影响hll计算distinct值的精度，桶的个数越多，误差越小。误差范围为：[-1.04/2^log2m\*1⁄2^,+1.04/2^log2m*1⁄2^]。 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -23,7 +23,7 @@ date: 2021-11-08 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：整型，0~12。0表示跳过Explicit模式，取1-12表示在基数到达2hll_default_log2explicit时切换模式。 +**取值范围**：整型，0~12。0表示跳过Explicit模式，取1-12表示在基数到达2^hll_default_log2explicit^时切换模式。 **默认值**：10 @@ -33,7 +33,7 @@ date: 2021-11-08 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：整型，0~14。0表示跳过Explicit模式，取1-14表示在基数到达2hll_default_log2sparse时切换模式。 +**取值范围**：整型，0~14。0表示跳过Explicit模式，取1-14表示在基数到达2^hll_default_log2sparse^时切换模式。 **默认值**：12 @@ -43,7 +43,10 @@ date: 2021-11-08 该参数属于USERSET类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：0，1。0表示默认关闭，1表示默认开启 +**取值范围**：0，1。 + +- 0表示默认关闭。 +- 1表示默认开启。 **默认值**：0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/30-appendix.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/30-appendix.md index 2578e5a3..be0bdccd 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/30-appendix.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/30-appendix.md @@ -12,17 +12,19 @@ date: 2021-04-20 | 参数类型 | 说明 | 设置方式 | | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | INTERNAL | 固定参数，在创建数据库的时候确定，用户无法修改，只能通过show语法或者pg_settings视图进行查看。 | 无 | -| POSTMASTER | 数据库服务端参数，在数据库启动时确定，可以通过配置文件指定。 | 支持表"GUC参数设置方式"中的方式一、方式四。 | -| SIGHUP | 数据库全局参数，可在数据库启动时设置或者在数据库启动后，发送指令重新加载。 | 支持表"GUC参数设置方式"中的方式一、方式二、方式四。 | -| BACKEND | 会话连接参数。在创建会话连接时指定，连接建立后无法修改。连接断掉后参数失效。内部使用参数，不推荐用户设置。 | 支持表"GUC参数设置方式"中的方式一、方式二、方式四。说明:设置该参数后，下一次建立会话连接时生效。 | -| SUSET | 数据库管理员参数。可在数据库启动时、数据库启动后或者数据库管理员通过SQL进行设置。 | 支持表"GUC参数设置方式"中的方式一、方式二或由数据库管理员通过方式三设置。 | -| USERSET | 普通用户参数。可被任何用户在任何时刻设置。 | 支持表"GUC参数设置方式"中的方式一、方式二或方式三设置。 | +| POSTMASTER | 数据库服务端参数，在数据库启动时确定，可以通过配置文件指定。 | 支持表2中的方式一、方式四。 | +| SIGHUP | 数据库全局参数，可在数据库启动时设置或者在数据库启动后，发送指令重新加载。 | 支持表2中的方式一、方式二、方式四。 | +| BACKEND | 会话连接参数。在创建会话连接时指定，连接建立后无法修改。连接断掉后参数失效。内部使用参数，不推荐用户设置。 | 支持表2中的方式一、方式二、方式四。
说明：设置该参数后，下一次建立会话连接时生效。 | +| SUSET | 数据库管理员参数。可在数据库启动时、数据库启动后或者数据库管理员通过SQL进行设置。 | 支持表2中的方式一、方式二或由数据库管理员通过方式三设置。 | +| USERSET | 普通用户参数。可被任何用户在任何时刻设置。 | 支持表2中的方式一、方式二或方式三设置。 | ## **表 2** GUC参数设置方式 | 序号 | 设置方法 | | ------ | ------------------------------------------------------------ | -| 方式一 | 1. 使用如下命令修改参数。
`gs_guc set -D datadir -c "paraname=value"`
说明:如果参数是一个字符串变量，则使用-c parameter="'value'"或者使用-c "parameter = 'value'"。
使用以下命令在数据库节点上同时设置某个参数。
`gs_guc set -N all -I all -c "paraname=value"`
2. 重启数据库使参数生效。
说明:
重启MogDB操作会导致用户执行操作中断，请在操作之前规划好合适的执行窗口。
`gs_om -t stop && gs_om -t start` | -| 方式二 | `gs_guc reload -D datadir -c "paraname=value"`
说明:
使用以下命令在数据库节点上同时设置某个参数。
`gs_guc reload -N all -I all -c "paraname=value"` | -| 方式三 | 修改指定数据库，用户，会话级别的参数。
- 设置数据库级别的参数
`postgres=# ALTER DATABASE dbname SET paraname TO value;`
在下次会话中生效。
- 设置用户级别的参数
`postgres=# ALTER USER username SET paraname TO value;`
在下次会话中生效。
- 设置会话级别的参数
`postgres=# SET paraname TO value;`
修改本次会话中的取值。退出会话后，设置将失效。 | -| 方式四 | 使用ALTER SYSTEM SET修改数据库参数。
- 设置POSTMASERT级别的参数
`postgres=# ALTER SYSTEM SET paraname TO value;`
重启后生效。
- 设置SIGHUP级别的参数
`postgres=# ALTER SYSTEM SET paraname TO value;`
立刻生效(实际等待线程重新加载参数略有延迟)。
- 设置BACKEND级别的参数
`postgres=# ALTER SYSTEM SET paraname TO value;`
在下次会话中生效。 | +| 方式一 | 1. 使用如下命令修改参数。
`gs_guc set -D datadir -c "paraname=value"`
说明：如果参数是一个字符串变量，则使用-c parameter="'value'"或者使用-c "parameter = 'value'"。
使用以下命令在数据库节点上同时设置某个参数。
`gs_guc set -N all -I all -c "paraname=value"`
使用以下命令在数据库节点上设置cm_agent某个参数。
`gs_guc set -Z cmagent -c "paraname=value"`
`gs_guc set -Z cmagent -N all -I all -c "paraname=value"`
使用以下命令在数据库节点上设置cm_server某个参数。
`gs_guc set -Z cmserver -c "paraname=value"`
`gs_guc set -Z cmserver -N all -I all -c "paraname=value"`
2. 重启数据库使参数生效。
说明：
重启MogDB操作会导致用户执行操作中断，请在操作之前规划好合适的执行窗口。
`gs_om -t stop && gs_om -t start` | +| 方式二 | `gs_guc reload -D datadir -c "paraname=value"`
说明：
使用以下命令在数据库节点上同时设置某个参数。
`gs_guc reload -N all -I all -c "paraname=value"` | +| 方式三 | 修改指定数据库、用户、会话级别的参数。
- 设置数据库级别的参数
`MogDB=# ALTER DATABASE dbname SET paraname TO value;`
在下次会话中生效。
- 设置用户级别的参数
`MogDB=# ALTER USER username SET paraname TO value;`
在下次会话中生效。
- 设置会话级别的参数
`MogDB=# SET paraname TO value;`
修改本次会话中的取值。退出会话后，设置将失效。
说明：
SET设置的会话级参数优先级最高，其次是ALTER设置的，其中ALTER DATABASE设置的参数值优先级高于ALTER USER设置，这三种设置方式设置的优先级都高于gs_guc设置方式。 | +| 方式四 | 使用ALTER SYSTEM SET修改数据库参数。
- 设置POSTMASERT级别的参数
`MogDB=# ALTER SYSTEM SET paraname TO value;`
重启后生效。
- 设置SIGHUP级别的参数
`MogDB=# ALTER SYSTEM SET paraname TO value;`
立刻生效（实际等待线程重新加载参数略有延迟）。
- 设置BACKEND级别的参数
`MogDB=# ALTER SYSTEM SET paraname TO value;`
在下次会话中生效。 | + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **注意：** 使用方式一和方式二设置参数时，若所设参数不属于当前环境，数据库会提示参数不在支持范围内的相关信息。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/31-scheduled-task.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/31-scheduled-task.md index aaded6aa..de5c8bb2 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/31-scheduled-task.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/31-scheduled-task.md @@ -9,7 +9,7 @@ date: 2021-06-07 ## job_queue_processes -**参数说明**：表示系统可以并发执行的job数目。该参数为postmaster级别，通过gs_guc设置，需要重启gaussdb才能生效。 +**参数说明**：表示系统可以并发执行的job数目。该参数为postmaster级别，通过gs_guc设置，需要重启MogDB才能生效。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/32-thread-pool.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/32-thread-pool.md index 0c272653..f3e15ac5 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/32-thread-pool.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/32-thread-pool.md @@ -33,5 +33,6 @@ date: 2021-06-07 2. '(allbind)'，利用当前系统所有能查询到的CPU core做线程绑核； 3. '(nodebind: 1, 2)'，利用NUMA组1，2中的CPU core进行绑核； 4. '(cpubind: 0-30)'，利用0-30号CPU core进行绑核。该参数不区分大小写。 + 5. '(numabind: 0-30)'，在NUMA组内利用0-30号CPU core进行绑核。利用0-30号CPU core进行绑核。该参数不区分大小写。 **默认值**：'16, 2, (nobind)' diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/33-user-defined-functions.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/33-user-defined-functions.md index 0b4c48f4..83c772e2 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/33-user-defined-functions.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/33-user-defined-functions.md @@ -49,7 +49,6 @@ date: 2021-11-08 - JDK8 JVM系统属性参数（以-D开头如-Djava.ext.dirs，可参见JDK[官方](https://docs.oracle.com/javase/tutorial/deployment/doingMoreWithRIA/properties.html)说明） - 用户自定义参数（以-D开头，如-Duser.defined.option） -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知：** ->如果用户在pljava_vmoptions中设置参数不满足上述取值范围，会在使用PL/Java语言函数时报错。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知：**如果用户在pljava_vmoptions中设置参数不满足上述取值范围，会在使用PL/Java语言函数时报错。 **默认值**：空 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/35-undo.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/35-undo.md index d3bb0920..61219cbc 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/35-undo.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/35-undo.md @@ -9,13 +9,13 @@ date: 2021-11-08 ## undo_space_limit_size -**参数说明**：用于控制undo强制回收阈值，达到阈值的80%启动强制回收。 +**参数说明**：用于控制undo强制回收阈值，达到阈值的80%启动强制回收，用户需要根据自己的业务情况，设置该值，可以通过先设置一个较大值，然后观察实际业务运行占用undo空间，再将该值调整为合理值。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**：整型，800M~16TB -**默认值**：32GB +**默认值**：256GB ## undo_limit_size_per_transaction @@ -26,18 +26,3 @@ date: 2021-11-08 **取值范围**：整型，2M~16TB **默认值**：32GB - -## undo_zone_count - -**参数说明**：用于控制在内存中可分配的undo zone数量，达到阈值或本次设置的数值小于上次时报错，重新按规则设置合理取值后可恢复正常。当参数设置为0时，禁用undo，禁止创建ustore表。 - -该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**：整型，0~1,048,576 - -取值约束： - -1. 本次设置数值不得小于上次设置的数值，设置错误时会导致数据库无法正常恢复，重新合理设置后重启数据库可恢复正常。 -2. 当前undo_zone_count取值需要根据max_connections来调节设置，修改max_connections取值后，需对应修改undo_zone_count，取值规则为max_connections取值的4倍。 - -**默认值**：0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/36-DCF-parameters-settings.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/36-DCF-parameters-settings.md index 25a8cc22..6ebb7dd3 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/36-DCF-parameters-settings.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/36-DCF-parameters-settings.md @@ -61,7 +61,7 @@ date: 2021-11-08 ## dcf_max_workers -**参数说明**：DCF回调函数线程个数。 +**参数说明**：DCF回调函数线程个数。如果节点数量超过7个，需要增加这个参数的数值（比如增加到40），否则可能会出现主节点一直处于promoting状态，主备节点日志不推进的状态。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -89,9 +89,29 @@ date: 2021-11-08 **默认值**：3 +## dcf_enable_auto_election_priority + +**参数说明：**DCF优先级选主是否允许内部自动调整优先级值。0表示不允许，1表示允许内部自动调整。 + +该参数属于SIGHUP类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围：**整型，0~1 + +**默认值：**1 + +## dcf_election_switch_threshold + +**参数说明：**DCF防频繁切主门限。推荐根据用户业务可接受的最大故障时间配置。 + +该参数属于SIGHUP类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围：**整型，单位s，0~2147483647 + +**默认值：**0 + ## dcf_run_mode -**参数说明**：DCF选举模式，0表示自动选举模式，2表示去使能选举模式。 +**参数说明**：DCF选举模式，0表示自动选举模式，2表示去使能选举模式。目前去使能选举模式只限定少数派恢复场景使用，修改会导致数据库实例不可用。 该参数属于SIGHUP类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -275,11 +295,9 @@ date: 2021-11-08 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**：整型 +**取值范围**：整型，1~22 -- 若不使用压缩算法，取值不生效 -- 若选择ZSTD压缩算法，取值范围1~22 -- 若选择LZ4压缩算法，取值范围1~9 +若不开启压缩，配置的压缩级别将不生效。 **默认值**：1 @@ -305,7 +323,7 @@ date: 2021-11-08 ## dcf_mec_agent_thread_num -**参数说明**：DCF通信工作线程数量，参数重启生效。dcf_mec_agent_thread_num值建议不少于2*节点数*dcf_mec_channel_num。 +**参数说明**：DCF通信工作线程数量，参数重启生效。dcf_mec_agent_thread_num值建议不少于2\*节点数\*dcf_mec_channel_num。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -325,7 +343,7 @@ date: 2021-11-08 ## dcf_log_file_permission -**参数说明**：DCF运行日志文件属性，参数重启生效。若用户需要支持同组的其他用户访问日志，首先需要所有的父目录都支持同组的其他用户也能访问。 +**参数说明**：DCF运行日志文件属性，参数重启生效，参数安装阶段配置，后续不支持修改。若用户需要支持同组的其他用户访问日志，首先需要所有的父目录都支持同组的其他用户也能访问。即若参数dcf_log_path_permission配置为750，dcf_log_file_permission只能为600或者640。若参数dcf_log_path_permission配置为700，dcf_log_file_permission只能为600。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -335,7 +353,7 @@ date: 2021-11-08 ## dcf_log_path_permission -**参数说明**：DCF运行日志目录属性，参数重启生效，不支持修改。 +**参数说明**：DCF运行日志目录属性，参数重启生效，参数安装阶段配置，后续不支持修改。若用户需要支持同组的其他用户访问日志路径，需选择参数750，否则选择700。 该参数属于POSTMASTER类型参数，请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/37-flashback.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/37-flashback.md index 2d2fc020..7bae24f1 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/37-flashback.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/37-flashback.md @@ -39,7 +39,7 @@ date: 2021-11-08 **默认值**：0 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **注意：** 因系统表采用Heap引擎，为避免不必要的系统表膨胀问题（如业务上只是用Uheap闪回功能），在配置version_retention_age的同时，还需同值配置vacuum_defer_cleanup_age，才能有效保留旧版本。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **注意：** 该参数已弃用。 ## vacuum_defer_cleanup_age @@ -50,3 +50,15 @@ date: 2021-11-08 **取值范围**：整型，0～1000000，值为0表示不延迟。取值范围需要扩展到1亿。 **默认值**：0 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **注意：** 在进行Ustore闪回时，无需关注该参数。其服务于之前版本的astore闪回功能，同时具有其他用途。本版本闪回功能已不使用。 + +## undo_retention_time + +**参数说明**：设置undo旧版本保留时间。 + +该参数属于SIGHUP类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**：整型，单位为s，最小值为0，最大值为2147483647。 + +**默认值**：0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/39-reserved-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/39-reserved-parameters.md index de8e5fda..998a8158 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/39-reserved-parameters.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/39-reserved-parameters.md @@ -23,4 +23,8 @@ enable_orc_cache schedule_splits_threshold -backend_version \ No newline at end of file +backend_version + +undo_zone_count + +version_retention_age \ No newline at end of file diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_agent.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_agent.md new file mode 100644 index 00000000..a933e42a --- /dev/null +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_agent.md @@ -0,0 +1,314 @@ +--- +title: cm_agent参数 +summary: cm_agent参数 +author: Guo Huan +date: 2022-05-23 +--- + +# cm_agent参数 + +## log_dir + +**参数说明**：log_dir决定存放cm_agent日志文件的目录。可以是绝对路径，或者是相对路径（相对于$GAUSSLOG的路径）。 + +**取值范围**：字符串。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：“log”，表示在$GAUSSLOG下对应的cm目录下生成cm_agent日志。 + +## log_file_size + +**参数说明**：控制日志文件的大小。当日志文件达到指定大小时，则重新创建一个日志文件记录日志信息。 + +**取值范围**：整型，取值范围0~2047，单位为MB。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：16MB + +## log_min_messages + +**参数说明**：控制写到cm_agent日志文件中的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低，服务器运行日志中记录的消息就越少。 + +**取值范围**：枚举类型，有效值有debug5、debug1、warning、error、log、fatal。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：warning + +## incremental_build + +**参数说明**：控制重建备DN模式是否为增量。打开这个开关，则增量重建备DN；否则，全量重建备DN。 + +**取值范围**：布尔型，有效值有on、off。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：on + +## alarm_component + +**参数说明**：设置用于处理告警内容的告警组件的位置。 + +**取值范围**：字符串。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +- 若前置脚本gs_preinstall中的–alarm-type参数设置为5时，表示未对接第三方组件，告警写入system_alarm日志，此时GUC参数alarm_component的取值为：/opt/snas/bin/snas_cm_cmd。 +- 若前置脚本gs_preinstall中的–alarm-type参数设置为1时，表示对接第三方组件，此时GUC参数alarm_component的值为第三方组件的可执行程序的绝对路径。 + +**默认值**：/opt/snas/bin/snas_cm_cmd + +## alarm_report_interval + +**参数说明**：指定告警上报的时间间隔。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**取值范围**：非负整型，单位为秒。 + +**默认值**：1 + +## alarm_report_max_count + +**参数说明**：指定告警上报的最大次数。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**取值范围**：非负整型。 + +**默认值**：1 + +## agent_report_interval + +**参数说明**：cm_agent上报实例状态的时间间隔。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1 + +## agent_phony_dead_check_interval + +**参数说明**：cm_agent检测DN进程是否僵死的时间间隔。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：10 + +## agent_check_interval + +**参数说明**：cm_agent查询DN等实例状态的时间间隔。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：2 + +## agent_heartbeat_timeout + +**参数说明**：cm_server心跳超时时间。 + +**取值范围**：整型，2~231 - 1，单位为秒。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：8 + +## agent_connect_timeout + +**参数说明**：cm_agent连接cm_server超时时间。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1 + +## agent_connect_retries + +**参数说明**：cm_agent连接cm_server尝试次数。 + +**取值范围**：整型。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：15 + +## agent_kill_instance_timeout + +**参数说明**：当cm_agent在无法连接cm_server主节点后，发起一次杀死本节点上所有实例的操作之前，所需等待的时间间隔。 + +**取值范围**：整型。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：0，不发起杀死本节点上所有实例的操作。 + +## security_mode + +**参数说明**：控制是否以安全模式启动DN。打开这个开关，则以安全模式启动DN；否则，以非安全模式启动DN。 + +**取值范围**：布尔型，有效值有on、off。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：off + +## upgrade_from + +**参数说明**：就地升级过程中使用，用于标示升级前数据库的内部版本号，此参数禁止手动修改。 + +**取值范围**：非负整型。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：0 + +## process_cpu_affinity + +**参数说明**：控制是否以绑核优化模式启动主DN进程。配置该参数为0，则不进行绑核优化；否则，进行绑核优化，且物理CPU片数为2n个。数据库、cm_agent重启生效。仅支持ARM。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**取值范围**：整型，0~2。 + +**默认值**：0 + +## log_threshold_check_interval + +**参数说明**：日志压缩和清除的时间间隔，每1800秒压缩和清理一次。 + +**取值范围**：整型，0~2147483647，单位为秒。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1800 + +## dilatation_shard_count_for_disk_capacity_alarm + +**参数说明**：扩容场景下，设置新增的扩容分片数，用于上报磁盘容量告警时的阈值计算。 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明：** 该分片数请与实际扩容分片数设置为一致。 + +**取值范围**：整型，0~232 - 1，单位为个。该参数设置为0，表示关闭磁盘扩容告警上报；该参数设置为大于0，表示开启磁盘扩容告警上报，且告警上报的阈值根据此参数设置的分片数量进行计算。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1 + +## log_max_size + +**参数说明**：控制日志最大存储值。 + +**取值范围**：整型，0~2147483647，单位为MB。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：10240 + +## log_max_count + +**参数说明**：硬盘上可存储的最多日志数量。 + +**取值范围**：整型，0~10000，单位为个。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：10000 + +## log_saved_days + +**参数说明**：日志保存的天数。 + +**取值范围**：整型，0~1000，单位为天。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：90 + +## enable_log_compress + +**参数说明**：控制压缩日志功能。 + +**取值范围**：布尔型。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +- on表示允许压缩日志。 +- off表示不允许压缩日志。 + +**默认值**：on + +## log_pattern_%s + +**参数说明**：enable_log_compress=on时使用，定义压缩日志的格式，压缩含有关键字%s的所有日志，%s为服务端工具名称。 + +**取值范围**：表1中所有参数对应的值。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：表1 中各参数对应的默认值。不支持用户修改默认值。 + +**表 1** + +| 参数（log_pattern_%s） | 默认值 | +| :------------------------------- | :-------------------- | +| log_pattern_cm_ctl | cm_ctl- | +| log_pattern_gs_clean | gs_clean- | +| log_pattern_gs_ctl | gs_ctl- | +| log_pattern_gs_guc | gs_guc- | +| log_pattern_gs_dump | gs_dump- | +| log_pattern_gs_dumpall | gs_dumpall- | +| log_pattern_gs_restore | gs_restore- | +| log_pattern_gs_initcm | gs_initcm- | +| log_pattern_gs_initdb | gs_initdb- | +| log_pattern_gs_initgtm | gs_initgtm- | +| log_pattern_gtm_ctl | gtm_ctl- | +| log_pattern_cm_agent | cm_agent- | +| log_pattern_system_call | system_call- | +| log_pattern_cm_server | cm_server- | +| log_pattern_om_monitor | om_monitor- | +| log_pattern_gs_local | gs_local- | +| log_pattern_gs_preinstall | gs_preinstall- | +| log_pattern_gs_install | gs_install- | +| log_pattern_gs_replace | gs_replace- | +| log_pattern_gs_uninstall | gs_uninstall- | +| log_pattern_gs_om | gs_om- | +| log_pattern_gs_upgradectl | gs_upgradectl- | +| log_pattern_gs_expand | gs_expand- | +| log_pattern_gs_shrink | gs_shrink- | +| log_pattern_gs_postuninstall | gs_postuninstall- | +| log_pattern_gs_backup | gs_backup- | +| log_pattern_gs_checkos | gs_checkos- | +| log_pattern_gs_collector | gs_collector- | +| log_pattern_GaussReplace | GaussReplace- | +| log_pattern_GaussOM | GaussOM- | +| log_pattern_gs_checkperf | gs_checkperf- | +| log_pattern_gs_check | gs_check- | +| log_pattern_roach-agent | roach-agent- | +| log_pattern_roach-controller | roach-controller- | +| log_pattern_postgresql | postgresql- | +| log_pattern_gtm | gtm- | +| log_pattern_sessionstat | sessionstat- | +| log_pattern_sync | sync- | +| log_pattern_system_alarm | system_alarm- | +| log_pattern_pg_perf | pg_perf- | +| log_pattern_slow_query_log | slow_query_log- | +| log_pattern_asp | asp- | +| log_pattern_etcd | etcd- | +| log_pattern_gs_cgroup | gs_cgroup- | +| log_pattern_pscp | pscp- | +| log_pattern_postgresql-query-log | postgresql-query-log- | +| log_pattern_gs_hotpatch | gs_hotpatch- | +| log_pattern_pssh | pssh- | + +## agent_backup_open + +**参数说明**：灾备数据库实例设置，开启后CM按照灾备数据库实例模式运行。 + +**取值范围**：整型，0~1。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数分类](30-appendix)进行设置。 + +- 0表示关闭。 +- 1表示开启。 + +**默认值**：0 + +## enable_xc_maintenance_mode + +**参数说明**：在数据库实例为只读模式下，控制是否可以修改pgxc_node系统表。 + +**取值范围**：布尔型。参数修改请参考[GUC参数分类](30-appendix)进行设置。 + +- on表示开启可以修改pgxc_node系统表功能。 +- off表示关闭可以修改pgxc_node系统表功能。 + +**默认值**：on + +## unix_socket_directory + +**参数说明**：unix套接字的目录位置。 + +**取值范围**：字符串。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数分类](30-appendix)进行设置。 + +**默认值：”** + +## enable_dcf + +**参数说明**：DCF模式开关。 + +**取值范围**：布尔型。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数分类](30-appendix)进行设置。 + +- 0表示关闭。 +- 1表示开启。 + +**默认值**：off + +## disaster_recovery_type + +**参数说明**：主备数据库实例灾备关系的类型。 + +**取值范围**：整型，0~2。修改后需要重启cm_agent才能生效。参数修改请参考[GUC参数分类](30-appendix)进行设置。 + +- 0表示未搭建灾备关系。 +- 1表示搭建了obs灾备关系。 +- 2表示搭建了流式灾备关系 + +**默认值**：0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_server.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_server.md new file mode 100644 index 00000000..75626c04 --- /dev/null +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/cm-parameters/cm_server.md @@ -0,0 +1,391 @@ +--- +title: cm_agent参数 +summary: cm_agent参数 +author: Guo Huan +date: 2022-05-23 +--- + +# cm_server参数 + +## log_dir + +**参数说明**：log_dir决定存放cm_server日志文件的目录。它可以是绝对路径，或者是相对路径（相对于$GAUSSLOG的路径）。 + +**取值范围**：字符串。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：“log”，表示在$GAUSSLOG下对应的cm目录下生成cm_server日志。 + +## log_file_size + +**参数说明**：控制日志文件的大小。当日志文件达到指定大小时，则重新创建一个日志文件记录日志信息。 + +**取值范围**：整型，取值范围0~2047，单位为MB。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：16MB + +## log_min_messages + +**参数说明**：控制写到cm_server日志文件中的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低，服务器运行日志中记录的消息就越少。 + +**取值范围**：枚举类型，有效值有debug5、debug1、log、warning、error、fatal。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：warning + +## thread_count + +**参数说明**：cm_server线程池的线程数。 + +**取值范围**：整型，2~1000。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1000 + +## alarm_component + +**参数说明**：设置用于处理告警内容的告警组件的位置。 + +**取值范围**：字符串。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +- 若前置脚本gs_preinstall中的–alarm-type参数设置为5时，表示未对接第三方组件，告警写入system_alarm日志，此时GUC参数alarm_component的取值为：/opt/snas/bin/snas_cm_cmd。 +- 若前置脚本gs_preinstall中的–alarm-type参数设置为1时，表示对接第三方组件，此时GUC参数alarm_component的值为第三方组件的可执行程序的绝对路径。 + +**默认值**：/opt/snas/bin/snas_cm_cmd + +## instance_failover_delay_timeout + +**参数说明**：cm_server检测到主机宕机，failover备机的延迟时间。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：0 + +## instance_heartbeat_timeout + +**参数说明**：实例心跳超时时间。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：6 + +## cmserver_ha_connect_timeout + +**参数说明**：cm_server主备连接超时时间。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：2 + +## cmserver_ha_heartbeat_timeout + +**参数说明**：cm_server主备心跳超时时间。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：6 + +## phony_dead_effective_time + +**参数说明**：用于DN进程的僵死检测，当检测到的僵死次数大于该参数值，认为进程僵死，将进程重启。 + +**取值范围**：整型，单位为次数。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：5 + +## enable_transaction_read_only + +**参数说明**：控制数据库是否为只读模式开关。 + +**取值范围**：布尔型，有效值有on，off，true，false，yes，no，1，0。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：on + +## datastorage_threshold_check_interval + +**参数说明**：检测磁盘占用的时间间隔。间隔用户指定时间，检测一次磁盘占用。 + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：10 + +## datastorage_threshold_value_check + +**参数说明**：设置数据库只读模式的磁盘占用阈值，当数据目录所在磁盘占用超过这个阈值，自动将数据库设置为只读模式。 + +**取值范围**：整型，1 ~ 99，表示百分比。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：85 + +## max_datastorage_threshold_check + +**参数说明**：设置磁盘使用率的最大检测间隔时间。当用户手动修改只读模式参数后，会自动在指定间隔时间后开启磁盘满检测操作。 + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：43200 + +## cmserver_ha_status_interval + +**参数说明**：cm_server主备同步状态信息间隔时间。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1 + +## cmserver_self_vote_timeout + +**参数说明**：cm_server自仲裁超时时间。 + +**取值范围**：整型，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)行设置。 + +**默认值**：6 + +## alarm_report_interval + +**参数说明**：指定告警上报的时间间隔。 + +**取值范围**：非负整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：3 + +## alarm_report_max_count + +**参数说明**：指定告警上报的最大次数。 + +**取值范围**：非负整型。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1 + +## enable_az_auto_switchover + +**参数说明**：AZ自动切换开关，若打开，则表示允许cm_server自动切换AZ。否则当发生dn故障等情况时，即使当前AZ已经不再可用，也不会自动切换到其它AZ上，除非手动执行切换命令。 + +**取值范围**：非负整型，0或1，0表示开关关闭，1表示开关打开。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1 + +## instance_keep_heartbeat_timeout + +**参数说明**：cm_agent会定期检测实例状态并上报给cm_server，若实例状态长时间无法成功检测，累积次数超出该数值，则cm_server将下发命令给agent重启该实例。 + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：40 + +## az_switchover_threshold + +**参数说明**：若一个AZ内DN分片的故障率（故障的dn分片数 / 总dn分片数 * 100%）超过该数值，则会触发AZ自动切换。 + +**取值范围**：整型，0~100。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：100 + +## az_check_and_arbitrate_interval + +**参数说明**：当某个AZ状态不正常时，会触发AZ自动切换，该参数是检测AZ状态的时间间隔。 + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：2 + +## az_connect_check_interval + +**参数说明**：定时检测AZ间的网络连接，该参数表示连续两次检测之间的间隔时间。 + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：60 + +## az_connect_check_delay_time + +**参数说明**：每次检测AZ间的网络连接时有多次重试，该参数表示两次重试之间的延迟时间**。** + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：150 + +## cmserver_demote_delay_on_etcd_fault + +**参数说明**：因为etcd不健康而导致cm_server从主降为备的时间间隔**。** + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：8 + +## instance_phony_dead_restart_interval + +**参数说明**：当dn实例僵死时，会被cm_agent重启，相同的实例连续因僵死被杀时，其间隔时间不能小于该参数数值，否则cm_agent不会下发命令**。** + +**取值范围**：整型，单位为秒。最小生效值为1800，如果设置小于此值实际生效值为1800。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：21600 + +## cm_auth_method + +**参数说明**：CM模块端口认证方式，trust表示未配置端口认证，gss表示采用kerberos端口认证。必须注意的是：只有当kerberos服务端和客户端成功安装后才能修改为gss，否则CM模块无法正常通信，将影响数据库状态。 + +**取值范围**：枚举类型，有效值有trust, gss。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：trust + +## cm_krb_server_keyfile + +**参数说明**：kerberos服务端key文件所在位置，需要配置为绝对路径。该文件通常为${GAUSSHOME}/kerberos路径下，以keytab格式结尾，文件名与数据库运行所在用户名相同。与上述cm_auth_method参数是配对的，当cm_auth_method参数修改为gss时，该参数也必须配置为正确路径，否则将影响数据库状态 + +**取值范围**：字符串类型，修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：${GAUSSHOME}/kerberos/{UserName}.keytab，默认值无法生效，仅作为提示 + +## cm_server_arbitrate_delay_base_time_out + +**参数说明**：cm_server仲裁延迟基础时长。cm_server主断连后，仲裁启动计时开始，经过仲裁延迟时长后，将选出新的cm_server主。其中仲裁延迟时长由仲裁延迟基础时长、节点index（server ID序号）和增量时长共同决定。公式为：仲裁延迟时长=仲裁延迟基础时长+节点index*仲裁延迟增量时长参数 + +**取值范围**：整型，index>0，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：10 + +## cm_server_arbitrate_delay_incrememtal_time_out + +**参数说明**：cm_server仲裁延迟增量时长。cm_server主断连后，仲裁启动计时开始，经过仲裁延迟时长后，将选出新的cm_server主。其中仲裁延迟时长由仲裁延迟基础时长、节点index（server ID序号）和增量时长共同决定。公式为：仲裁延迟时长=仲裁延迟基础时长+节点index*仲裁延迟增量时长参数 + +**取值范围**：整型，index>0，单位为秒。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：3 + +## force_promote + +**参数说明**：cm_server是否打开强起逻辑（指数据库状态为Unknown的时候以丢失部分数据为代价保证数据库基本功能可用）的开关。0代表功能关闭，1代表功能开启。该参数同时适用于dn。 + +**取值范围**：整型，0~1。在cm_server上修改后需要重启cm_server才能生效。 + +**默认值**：0 + +## switch_rto + +**参数说明**：cm_server强起逻辑等待时延。在force_promote被置为1时，当数据库的某一分片处于无主状态开始计时，等待该延迟时间后开始执行强起逻辑。 + +**取值范围**：整型，60~2147483647，单位为秒。修改后需要重启cm_server才能生效。 + +**默认值**：0 + +## backup_open + +**参数说明**：灾备数据库实例设置，开启后CM按照灾备数据库实例模式运行 + +**取值范围**：整型，0~1。修改后需要重启cm_server才能生效。非灾备数据库实例不能开启该参数。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +- 0表示关闭。 +- 1表示开启。 + +**默认值**：0 + +## enable_dcf + +**参数说明**：DCF模式开关。 + +**取值范围**：布尔型。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +- 0表示关闭。 +- 1表示开启。 + +**默认值**：off + +## install_type + +**参数说明**：容灾数据库实例相关的设置，用来区别是否是基于dorado的数据库实例。 + +**取值范围**：整型，0~2。修改后需要重启cm_server才能生效。非灾备数据库实例不能开启该参数。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +- 0表示未搭建容灾关系的数据库实例。 +- 1表示基于dorado的数据库实例。 +- 2表示基于流式的数据库实例。 + +**默认值**：0 + +## enable_ssl + +**参数说明**：ssl证书开关。 + +**取值范围**：布尔型。打开后使用ssl证书加密通信。修改后需要重启才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +- on表示启用ssl。 + +- off表示不启用ssl。 + +- **默认值**：off + + > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知：** 出于安全性考虑，建议不要关闭该配置。关闭后cm将**不使用**加密通信，所有信息明文传播，可能带来窃听、篡改、冒充等安全风险。 + +## ssl_cert_expire_alert_threshold + +**参数说明**：ssl证书过期告警时间。 + +**取值范围**：整型，单位为天。证书过期时间少于该时间时，上报证书即将过期告警。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：90 + +## ssl_cert_expire_check_interval + +**参数说明**：ssl证书过期检测周期。 + +**取值范围**：整型，单位为秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：86400 + +## delay_arbitrate_timeout + +**参数说明**：设置等待跟主DN同AZ节点redo回放，优先选择同AZ升主的时间。 + +**取值范围**：整型，[0, 21474836]，单位：秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：0 + +## ddb_type + +**参数说明**：etcd，dcc模式切换开关。 + +**取值范围**：整型。0：etcd；1：dcc。修改后需要重启cm_server才能生效。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：0 + +## ddb_log_level + +**参数说明**：设置ddb日志级别。 + +关闭日志：“NONE”，NONE表示关闭日志打印，不能与以下日志级别混合使用。 + +开启日志：“RUN_ERR|RUN_WAR|RUN_INF|DEBUG_ERR|DEBUG_WAR|DEBUG_INF|TRACE|PROFILE|OPER”日志级别可以从上述字符串中选取字符串并使用竖线组合使用，不能配置空串。 + +**取值范围**：字符串，RUN_ERR|RUN_WAR|RUN_INF|DEBUG_ERR|DEBUG_WAR|DEBUG_INF|TRACE|PROFILE|OPER。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：RUN_ERR|RUN_WAR|DEBUG_ERR|OPER|RUN_INF|PROFILE + +## ddb_log_backup_file_count + +**参数说明**：最大保存日志文件个数。 + +**取值范围**：整型，[1, 100]。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：10 + +## ddb_max_log_file_size + +**参数说明**：单条日志最大字节数。 + +**取值范围**：字符串，[1M, 1000M]。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：10M + +## ddb_log_suppress_enable + +**参数说明**：是否开启日志抑制功能。 + +**取值范围**：整型，0：关闭；1：开启。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：1 + +## ddb_election_timeout + +**参数说明**：dcc选举超时时间。 + +**取值范围**：整型，[1, 600],单位：秒。参数修改请参考[GUC参数设置方式](30-appendix)进行设置。 + +**默认值**：3 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/global-syscache-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/global-syscache-parameters.md new file mode 100644 index 00000000..25a87402 --- /dev/null +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/global-syscache-parameters.md @@ -0,0 +1,43 @@ +--- +title: Global SysCache参数 +summary: Global SysCache参数 +author: Guo Huan +date: 2022-05-23 +--- + +# Global SysCache参数 + +## enable_global_syscache + +**参数说明**：控制是否使用全局系统缓存功能。该参数属于POSTMASTER类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**：布尔型 + +- on表示开启全局系统缓存功能。 +- off表示不开启全局系统缓存功能。 + +**默认值**：on + +推荐结合线程池参数使用。打开该参数后，如果需要访问备机，建议设置备机wal_level级别为hot_standby以上。 + +## global_syscache_threshold + +**参数说明：**全局系统缓存内存最大占用大小。 + +该参数属于PGC_SIGHUP类型参数，请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +需要打开enable_global_syscache参数。 + +**取值范围**：整型，16384~1073741824，单位为kB。 + +**默认值：**163840 + +推荐计算公式：热点DB个数和线程个数的最小值乘以每个DB分配的内存大小 + +即global_syscache_threshold = min(count(hot dbs)，count(threads)) * memofdb + +热点DB数即访问较为频繁的数据库，线程数在线程池模式下取线程池线程个数和后台线程个数之和，非线程池模式不需要计算这个值，直接使用热点DB数。 + +memofdb即平均每个db应该分配的内存，每个DB的底噪内存是2M，平均每增加一个表或者索引，增加11k内存。 + +如果设置的值过小，会导致内存频繁淘汰，内存存在大量碎片无法回收，导致内存控制失效。 diff --git a/product/zh/docs-mogdb/v3.0/toc.md b/product/zh/docs-mogdb/v3.0/toc.md index 7208e3e8..e1ef00d5 100644 --- a/product/zh/docs-mogdb/v3.0/toc.md +++ b/product/zh/docs-mogdb/v3.0/toc.md @@ -1120,6 +1120,9 @@ + [审计开关](/reference-guide/guc-parameters/22-auditing/1-audit-switch.md) + [用户和权限审计](/reference-guide/guc-parameters/22-auditing/2-user-and-permission-audit.md) + [操作审计](/reference-guide/guc-parameters/22-auditing/3-operation-audit.md) + + CM相关参数 + + [cm_agent参数](/reference-guide/guc-parameters/cm-parameters/cm_agent.md) + + [cm_server参数](/reference-guide/guc-parameters/cm-parameters/cm_server.md) + [升级参数](/reference-guide/guc-parameters/23-upgrade-parameters.md) + [其他选项](/reference-guide/guc-parameters/24-miscellaneous-parameters.md) + [等待事件](/reference-guide/guc-parameters/25-wait-events.md) @@ -1138,6 +1141,7 @@ + [回滚相关参数](/reference-guide/guc-parameters/38-rollback-parameters.md) + [预留参数](/reference-guide/guc-parameters/39-reserved-parameters.md) + [AI特性](/reference-guide/guc-parameters/40-AI-features.md) + + [Global SysCache参数](/reference-guide/guc-parameters/global-syscache-parameters.md) + [附录](/reference-guide/guc-parameters/30-appendix.md) + Schema + Information Schema diff --git a/product/zh/docs-mogdb/v3.0/toc_parameters-and-tools.md b/product/zh/docs-mogdb/v3.0/toc_parameters-and-tools.md index a163efe3..27264af4 100644 --- a/product/zh/docs-mogdb/v3.0/toc_parameters-and-tools.md +++ b/product/zh/docs-mogdb/v3.0/toc_parameters-and-tools.md @@ -62,6 +62,9 @@ + [审计开关](./reference-guide/guc-parameters/22-auditing/1-audit-switch.md) + [用户和权限审计](./reference-guide/guc-parameters/22-auditing/2-user-and-permission-audit.md) + [操作审计](./reference-guide/guc-parameters/22-auditing/3-operation-audit.md) + + CM相关参数 + + [cm_agent参数](/reference-guide/guc-parameters/cm-parameters/cm_agent.md) + + [cm_server参数](/reference-guide/guc-parameters/cm-parameters/cm_server.md) + [升级参数](./reference-guide/guc-parameters/23-upgrade-parameters.md) + [其他选项](./reference-guide/guc-parameters/24-miscellaneous-parameters.md) + [等待事件](./reference-guide/guc-parameters/25-wait-events.md) @@ -80,6 +83,7 @@ + [回滚相关参数](./reference-guide/guc-parameters/38-rollback-parameters.md) + [预留参数](./reference-guide/guc-parameters/39-reserved-parameters.md) + [AI特性](./reference-guide/guc-parameters/40-AI-features.md) + + [Global SysCache参数](/reference-guide/guc-parameters/global-syscache-parameters.md) + [附录](./reference-guide/guc-parameters/30-appendix.md) + Schema + Information Schema -- Gitee