diff --git a/product/en/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md b/product/en/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md index 3bd3f29a6e15d8c7f443f890e691de2148f04833..765167b3717f4e6930ab9f491d4d7613d7c174bf 100644 --- a/product/en/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md +++ b/product/en/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md @@ -300,6 +300,23 @@ After the upgrade, if the verification is successful, the subsequent operation i gs_upgradectl -t commit-upgrade -X /opt/software/mogdb/clusterconfig.xml ``` +3. Reset the control file format to be compatible with the new ustore storage engine added in version 2.1.0 (2.0.1 upgrade to 2.1 only). + + > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **CAUTION**: + > + > - This operation is not reversible and cannot be downgraded back to version 2.0.1 after execution. + > - Before performing this operation, it is recommended to make a full data backup by referring to [Logical Backup Recovery](1-3-br). + + ``` + pg_resetxlog -f $PGDATA + ``` + + The echo appear as follow: + + ``` + Transaction log reset + ``` + ## Version Rollback This section introduces how to roll back the upgrade. diff --git a/product/en/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md b/product/en/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md index 3bd3f29a6e15d8c7f443f890e691de2148f04833..765167b3717f4e6930ab9f491d4d7613d7c174bf 100644 --- a/product/en/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md +++ b/product/en/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md @@ -300,6 +300,23 @@ After the upgrade, if the verification is successful, the subsequent operation i gs_upgradectl -t commit-upgrade -X /opt/software/mogdb/clusterconfig.xml ``` +3. Reset the control file format to be compatible with the new ustore storage engine added in version 2.1.0 (2.0.1 upgrade to 2.1 only). + + > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **CAUTION**: + > + > - This operation is not reversible and cannot be downgraded back to version 2.0.1 after execution. + > - Before performing this operation, it is recommended to make a full data backup by referring to [Logical Backup Recovery](1-3-br). + + ``` + pg_resetxlog -f $PGDATA + ``` + + The echo appear as follow: + + ``` + Transaction log reset + ``` + ## Version Rollback This section introduces how to roll back the upgrade. diff --git a/product/zh/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md b/product/zh/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md index ca203f23ab7c916a049932d7ad7834c21987f285..b633513d6355577e7dbfd12bed86fa6316150863 100644 --- a/product/zh/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md +++ b/product/zh/docs-mogdb/v2.1/administrator-guide/upgrade-guide.md @@ -284,7 +284,7 @@ root用户密码 升级完成后,如果验证也没问题。接下来就可以提交升级。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 一旦提交操作完成,则不能再执行回滚操作。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:一旦提交操作完成,则不能再执行回滚操作。 **操作步骤** @@ -300,6 +300,23 @@ root用户密码 gs_upgradectl -t commit-upgrade -X /opt/software/mogdb/clusterconfig.xml ``` +3. 重置控制文件格式以兼容2.1.0版本中新增的ustore存储引擎(仅限于2.0.1升级到2.1)。 + + > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif)**警告:** + > + > - 此操作不可回退,执行后无法再降级回2.0.1版本。 + > - 执行此操作前,建议参考[逻辑备份恢复](1-3-br)做一次数据全备份。 + + ``` + pg_resetxlog -f $PGDATA + ``` + + 回显为: + + ``` + Transaction log reset + ``` + ## 升级版本回滚 本章介绍版本回滚方法。 diff --git a/product/zh/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md b/product/zh/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md index 00e4c7fcf7646d9ebb60fbad68c3c379f4b326e6..1c73b822c0db4379acefc661aaca2a8026168e6e 100644 --- a/product/zh/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md +++ b/product/zh/docs-mogdb/v3.0/administrator-guide/upgrade-guide.md @@ -284,7 +284,7 @@ root用户密码 升级完成后,如果验证也没问题。接下来就可以提交升级。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 一旦提交操作完成,则不能再执行回滚操作。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:一旦提交操作完成,则不能再执行回滚操作。 **操作步骤** @@ -300,6 +300,23 @@ root用户密码 gs_upgradectl -t commit-upgrade -X /opt/software/mogdb/clusterconfig.xml ``` +3. 重置控制文件格式以兼容2.1.0版本中新增的ustore存储引擎(仅限于2.0.1升级到2.1)。 + + > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif)**警告:** + > + > - 此操作不可回退,执行后无法再降级回2.0.1版本。 + > - 执行此操作前,建议参考[逻辑备份恢复](1-3-br)做一次数据全备份。 + + ``` + pg_resetxlog -f $PGDATA + ``` + + 回显为: + + ``` + Transaction log reset + ``` + ## 升级版本回滚 本章介绍版本回滚方法。 diff --git a/product/zh/docs-mogdb/v3.0/installation-guide/standard-installation/3-modifying-os-configuration.md b/product/zh/docs-mogdb/v3.0/installation-guide/standard-installation/3-modifying-os-configuration.md index 3fc729b2da20dc934e548b47db57f7f73a45a7a0..148705c535bf45bf9e0144db8548890f89f587af 100644 --- a/product/zh/docs-mogdb/v3.0/installation-guide/standard-installation/3-modifying-os-configuration.md +++ b/product/zh/docs-mogdb/v3.0/installation-guide/standard-installation/3-modifying-os-configuration.md @@ -121,7 +121,7 @@ swapoff -a ifconfig ``` -2. 使用如下命令将各数据库节点的网卡MTU值设置为相同大小。对于X86,MTU值推荐1500;对于ARM,MTU值推荐8192。 +2. 使用如下命令将各数据库节点的网卡MTU值设置为相同大小。MTU值推荐8192,要求不小于1500。 ``` ifconfig 网卡编号 mtu 值 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/1-logging-destination.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/1-logging-destination.md index cab9bdbfc9b5be670ed9f698daf68d87b97884de..696afa2b790d186f30be0ba22fd6f41b6ac53f5e 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/1-logging-destination.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/1-logging-destination.md @@ -9,17 +9,17 @@ date: 2021-04-20 ## log_destination -**参数说明**: MogDB支持多种方法记录服务器日志,log_destination的取值为一个逗号分隔开的列表(如log_destination="stderr,csvlog")。 +**参数说明**:MogDB支持多种方法记录服务器日志,log_destination的取值为一个逗号分隔开的列表(如log_destination="stderr,csvlog")。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 有效值为stderr、csvlog、syslog。 - 取值为stderr,表示日志打印到屏幕。 -- 取值为csvlog,表示日志的输出格式为"逗号分隔值"即CSV (Comma Separated Value)格式。使用csvlog记录日志的前提是将[logging_collector](#logging_collector)设置为on,请参见**使用CSV格式写日志**。 +- 取值为csvlog,表示日志的输出格式为"逗号分隔值"即CSV (Comma Separated Value)格式。使用csvlog记录日志的前提是将[logging_collector](#logging_collector)设置为on,请参见[使用CSV格式写日志](4-using-csv-log-output)。 - 取值为syslog,表示通过操作系统的syslog记录日志。MogDB使用syslog的LOCAL0 ~ LOCAL7记录日志,请参见[syslog_facility](#syslog_facility)。使用syslog记录日志需在操作系统后台服务配置文件中添加代码: @@ -27,149 +27,148 @@ date: 2021-04-20 local0.* /var/log/omm ``` -**默认值**: stderr +**默认值**:stderr ## logging_collector -**参数说明**: 控制开启后端日志收集进程logger进行日志收集。该进程捕获发送到stderr或csvlog的日志消息并写入日志文件。 +**参数说明**:控制开启后端日志收集进程logger进行日志收集。该进程捕获发送到stderr或csvlog的日志消息并写入日志文件。 这种记录日志的方法比将日志记录到syslog更加有效,因为某些类型的消息在syslog的输出中无法显示。例如动态链接库加载失败消息和脚本(例如archive_command)产生的错误消息。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 将服务器日志发送到stderr时可以不使用logging_collector参数,此时日志消息会被发送到服务器的stderr指向的空间。这种方法的缺点是日志回滚困难,只适用于较小的日志容量。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**:将服务器日志发送到stderr时可以不使用logging_collector参数,此时日志消息会被发送到服务器的stderr指向的空间。这种方法的缺点是日志回滚困难,只适用于较小的日志容量。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启日志收集功能。 - off表示关闭日志收集功能。 -**默认值**: on +**默认值**:on ## log_directory -**参数说明**: logging_collector设置为on时,log_directory决定存放服务器日志文件的目录。它可以是绝对路径,或者是相对路径(相对于数据目录的路径)。log_directory支持动态修改,可以通过gs_guc reload实现。 +**参数说明**:logging_collector设置为on时,log_directory决定存放服务器日志文件的目录。它可以是绝对路径,或者是相对路径(相对于数据目录的路径)。log_directory支持动态修改,可以通过gs_guc reload实现。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 当配置文件中log_directory的值为非法路径时,会导致MogDB无法重新启动。 > - 通过gs_guc reload动态修改log_directory时,当指定路径为合法路径时,日志输出到新的路径下。当指定路径为非法路径时,日志输出到上一次合法的日志输出路径下而不影响数据库正常运行。此时即使指定的log_directory的值非法,也会写入到配置文件中。 > - 在沙箱环境,路径中不可以包含/var/chroot,例如log的绝对路径是/var/chroot/var/lib/log/Ruby/pg_log/cn_log,则只需要设置为/var/lib/log/Ruby/pg_log/cn_log。 > -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > -> - 合法路径: 用户对此路径有读写权限 -> - 非法路径: 用户对此路径无读写权限 +> - 合法路径:用户对此路径有读写权限 +> - 非法路径:用户对此路径无读写权限 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: 安装时指定。 +**默认值**:安装时指定。 ## log_filename -**参数说明**: logging_collector设置为on时,log_filename决定服务器运行日志文件的名称。通常日志文件名是按照strftime模式生成,因此可以用系统时间定义日志文件名,用%转义字符实现。 +**参数说明**:logging_collector设置为on时,log_filename决定服务器运行日志文件的名称。通常日志文件名是按照strftime模式生成,因此可以用系统时间定义日志文件名,用%转义字符实现。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 建议使用%转义字符定义日志文件名称,否则难以对日志文件进行有效的管理。 > - 当log_destination设为csvlog时,系统会生成附加了时间戳的日志文件名,文件格式为csv格式,例如"server_log.1093827753.csv"。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: postgresql-%Y-%m-%d_%H%M%S.log +**默认值**:postgresql-%Y-%m-%d_%H%M%S.log ## log_file_mode -**参数说明**: [logging_collector](#logging_collector)设置为on时,log_file_mode设置服务器日志文件的权限。通常log_file_mode的取值是能够被chmod和umask系统调用接受的数字。 +**参数说明**:[logging_collector](#logging_collector)设置为on时,log_file_mode设置服务器日志文件的权限。通常log_file_mode的取值是能够被chmod和umask系统调用接受的数字。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 使用此选项前请设置log_directory,将日志存储到数据目录之外的地方。 > - 因日志文件可能含有敏感数据,故不能将其设为对外可读。 -**取值范围:**整型,0000~0777(8进制计数,转化为十进制 0 ~ 511)。 +**取值范围**:整型,0000~0777(8进制计数,转化为十进制 0 ~ 511)。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 0600表示只允许服务器管理员读写日志文件。 > - 0640表示允许管理员所在用户组成员只能读日志文件。 -**默认值**: 0600 +**默认值**:0600 ## log_truncate_on_rotation -**参数说明**: logging_collector设置为on时,log_truncate_on_rotation设置日志消息的写入方式。 +**参数说明**:logging_collector设置为on时,log_truncate_on_rotation设置日志消息的写入方式。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 示例如下: -假设日志需要保留7天,每天生成一个日志文件,日志文件名设置为server_log.Mon、server_log.Tue等。第二周的周二生成的日志消息会覆盖写入到server_log.Tue。设置方法: 将log_filename设置为server_log.%a ,log_truncate_on_rotation设置为on,log_rotation_age设置为1440,即日志有效时间为1天。 +假设日志需要保留7天,每天生成一个日志文件,日志文件名设置为server_log.Mon、server_log.Tue等。第二周的周二生成的日志消息会覆盖写入到server_log.Tue。设置方法:将log_filename设置为server_log.%a ,log_truncate_on_rotation设置为on,log_rotation_age设置为1440,即日志有效时间为1天。 -**取值范围:** 布尔型 +**取值范围**: 布尔型 - on表示MogDB以覆盖写入的方式写服务器日志消息。 - off表示MogDB将日志消息附加到同名的现有日志文件上。 -**默认值**: off +**默认值**:off ## log_rotation_age -**参数说明**: logging_collector设置为on时,log_rotation_age决定创建一个新日志文件的时间间隔。当现在的时间减去上次创建一个服务器日志的时间超过了log_rotation_age的值时,将生成一个新的日志文件。 +**参数说明**:logging_collector设置为on时,log_rotation_age决定创建一个新日志文件的时间间隔。当现在的时间减去上次创建一个服务器日志的时间超过了log_rotation_age的值时,将生成一个新的日志文件。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0 ~ 35791394,单位为min。其中0表示关闭基于时间的新日志文件的创建。 +**取值范围**:整型,0 ~ 35791394,单位为min。其中0表示关闭基于时间的新日志文件的创建。 -**默认值**: 1440(min) +**默认值**:1440(min) ## log_rotation_size -**参数说明**: logging_collector设置为on时,log_rotation_size决定服务器日志文件的最大容量。当日志消息的总量超过日志文件容量时,服务器将生成一个新的日志文件。 +**参数说明**:logging_collector设置为on时,log_rotation_size决定服务器日志文件的最大容量。当日志消息的总量超过日志文件容量时,服务器将生成一个新的日志文件。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0 ~ INT_MAX / 1024,单位为kB。 +**取值范围**:整型,0 ~ INT_MAX / 1024,单位为kB。 0表示关闭基于容量的新日志文件的创建。 建议该值大小设置级别至少为MB级,利于日志文件的及时划分。 -**默认值**: 20MB +**默认值**:20MB ## syslog_facility -**参数说明**: log_destination设置为syslog时,syslog_facility配置使用syslog记录日志的"设备"。 +**参数说明**:log_destination设置为syslog时,syslog_facility配置使用syslog记录日志的“设备”。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型,有效值有local0、local1、local2、local3、local4、local5、local6、local7。 +**取值范围**:枚举类型,有效值有local0、local1、local2、local3、local4、local5、local6、local7。 -**默认值**: local0 +**默认值**:local0 ## syslog_ident -**参数说明**: [log_destination](#log_destination)设置为syslog时,syslog_ident设置在syslog日志中MogDB日志消息的标识。 +**参数说明**:[log_destination](#log_destination)设置为syslog时,syslog_ident设置在syslog日志中MogDB日志消息的标识。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: postgres +**默认值**:postgres ## event_source -**参数说明**: 该参数仅在windows环境下生效, MogDB暂不支持。log_destination设置为eventlog时,event_source设置在日志中MogDB日志消息的标识。 +**参数说明**:该参数仅在windows环境下生效,MogDB暂不支持。log_destination设置为eventlog时,event_source设置在日志中MogDB日志消息的标识。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: PostgreSQL +**默认值**:PostgreSQL diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/2-logging-time.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/2-logging-time.md index 6d627746763eaf93875d20c4c1e1bd2e225489a9..c97cde97df103aeb9998bb638c884a566e15dca7 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/2-logging-time.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/2-logging-time.md @@ -9,78 +9,81 @@ date: 2021-04-20 ## client_min_messages -**参数说明**: 控制发送到客户端的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低,发送给客户端的消息就越少。 +**参数说明**:控制发送到客户端的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低,发送给客户端的消息就越少。 该参数属于USERSET类型参数,请参考表[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) **须知**: +> > 当client_min_messages和[log_min_messages](#log_min_messages)取相同值时,其值所代表的级别不同。 -**取值范围:**枚举类型,有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表**信息严重程度分类**。在实际设置过程中,如果设置的级别大于error,为fatal或panic,系统会默认将级别转为error。 +**取值范围**:枚举类型,有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见[表1](#信息严重程度分类)。在实际设置过程中,如果设置的级别大于error,为fatal或panic,系统会默认将级别转为error。 -**默认值**: notice +**默认值**:notice ## log_min_messages -**参数说明**: 控制写到服务器日志文件中的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低,服务器运行日志中记录的消息就越少。 +**参数说明**:控制写到服务器日志文件中的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低,服务器运行日志中记录的消息就越少。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 当[client_min_messages](#client_min_messages)和log_min_messages取相同值log时所代表的消息级别不同。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> 当[client_min_messages](#client_min_messages)和log_min_messages取相同值log时所代表的消息级别不同。部分日志信息的打印需要同时配置该参数与logging_modules,即设置该参数打开后可能还需要设置logging_modules打开对应模块的日志打印开关。 -**取值范围:**枚举类型,有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表**信息严重程度分类**。 +**取值范围**:枚举类型,有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见[表1](#信息严重程度分类)。 -**默认值**: warning +**默认值**:warning ## log_min_error_statement -**参数说明**: 控制在服务器日志中记录错误的SQL语句。 +**参数说明**:控制在服务器日志中记录错误的SQL语句。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型,有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表**信息严重程度分类**。 +**取值范围**:枚举类型,有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表[表1](#信息严重程度分类)。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 设置为error,表示导致错误、日志消息、致命错误、panic的语句都将被记录。 > - 设置为panic,表示关闭此特性。 -**默认值**: error +**默认值**:error ## log_min_duration_statement -**参数说明**: 当某条语句的持续时间大于或者等于特定的毫秒数时,log_min_duration_statement参数用于控制记录每条完成语句的持续时间。 +**参数说明**:当某条语句的持续时间大于或者等于特定的毫秒数时,log_min_duration_statement参数用于控制记录每条完成语句的持续时间。 设置log_min_duration_statement可以很方便地跟踪需要优化的查询语句。对于使用扩展查询协议的客户端,语法分析、绑定、执行每一步所花时间被独立记录。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 当此选项与log_statement同时使用时,已经被log_statement记录的语句文本不会被重复记录。在没有使用syslog情况下,推荐使用log_line_prefix记录PID或会话ID,方便将当前语句消息连接到最后的持续时间消息。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> 当此选项与[log_statement](3-logging-content#log_statement)同时使用时,已经被log_statement记录的语句文本不会被重复记录。在没有使用syslog情况下,推荐使用[log_line_prefix](3-logging-content#log_line_prefix)记录PID或会话ID,方便将当前语句消息连接到最后的持续时间消息。 -**取值范围:**整型,-1 ~ INT_MAX,单位为毫秒。 +**取值范围**:整型,-1 ~ INT_MAX,单位为毫秒。 - 设置为250,所有运行时间不短于250ms的SQL语句都会被记录。 - 设置为0,输出所有语句的持续时间。 - 设置为-1,关闭此功能。 -**默认值**: 30min +**默认值**:30min ## backtrace_min_messages -**参数说明**: 控制当产生该设置参数级别相等或更高级别的信息时,会打印函数的堆栈信息到服务器日志文件中。 +**参数说明**:控制当产生该设置参数级别相等或更高级别的信息时,会打印函数的堆栈信息到服务器日志文件中。 该参数属于SUSET类型参数,请参考表[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) **须知**: +> > 该参数作为客户现场问题定位手段使用,且由于频繁的打印函数栈会对系统的开销及稳定性有一定的影响,因此如果需要进行问题定位时,建议避免将backtrace_min_messages的值设置为fatal及panic以外的级别。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 -有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表**信息严重程度分类**。 +有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见[表1](#信息严重程度分类)。 -**默认值**: panic +**默认值**:panic [表1](#信息严重程度分类)解释MogDB中使用的消息安全级别。当日志输出到syslog或者eventlog(仅windows环境下, MogDB版本不涉及该参数)时,MogDB进行如表中的转换。 @@ -99,17 +102,18 @@ date: 2021-04-20 ## plog_merge_age -**参数说明**: 该参数用于控制性能日志数据输出的周期。 +**参数说明**:该参数用于控制性能日志数据输出的周期。 该参数属于USERSET类型参数,请参考表[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) **须知**: +> > 该参数以毫秒为单位的,建议在使用过程中设置值为1000的整数倍,即设置值以秒为最小单位。该参数所控制的性能日志文件以prf为扩展名,文件放置在$GAUSSLOG/gs_profile/目录下面,其中node_name是由postgres.conf文件中的pgxc_node_name的值,不建议外部使用该参数。 -**取值范围:**0~2147483647,单位为毫秒(ms)。 +**取值范围**:0~2147483647,单位为毫秒(ms)。 当设置为0时,当前会话不再输出性能日志数据。当设置为非0时,当前会话按照指定的时间周期进行输出性能日志数据。 该参数设置得越小,输出的日志数据越多,对性能的负面影响越大。 -**默认值**: 0 +**默认值**:0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/3-logging-content.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/3-logging-content.md index b83bc75bb1dd8de07931483afb6980a7c2aaedeb..1049c3183dfe3bd71fbcc3a36e006e722c247e65 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/3-logging-content.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/3-logging-content.md @@ -9,153 +9,153 @@ date: 2021-04-20 ## debug_print_parse -**参数说明**: 用于控制打印解析树结果。 +**参数说明**:用于控制打印解析树结果。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启打印结果的功能。 - off表示关闭打印结果的功能。 -**默认值**: off +**默认值**:off ## debug_print_rewritten -**参数说明**: 用于控制打印查询重写结果。 +**参数说明**:用于控制打印查询重写结果。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启打印结果的功能。 - off表示关闭打印结果的功能。 -**默认值**: off +**默认值**:off ## debug_print_plan -**参数说明**: 用于设置是否将查询的执行计划打印到日志中。 +**参数说明**:用于设置是否将查询的执行计划打印到日志中。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启打印结果的功能。 - off表示关闭打印结果的功能。 -**默认值**: off +**默认值**:off -![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** - -- 只有当日志的级别为log及以上时,debug_print_parse、debug_print_rewritten和debug_print_plan的调试信息才会输出。当这些选项打开时,调试信息只会记录在服务器的日志中,而不会输出到客户端的日志中。通过设置client_min_messages和log_min_messages参数可以改变日志级别。 - -- 在打开debug_print_plan开关的情况下需尽量避免调用gs_encrypt_aes128及gs_decrypt_aes128函数,避免敏感参数信息在日志中泄露的风险。同时建议用户在打开debug_print_plan开关生成的日志中对gs_encrypt_aes128及gs_decrypt_aes128函数的参数信息进行过滤后再提供给外部维护人员定位,日志使用完成后请及时删除。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> - 只有当日志的级别为log及以上时,debug_print_parse、debug_print_rewritten和debug_print_plan的调试信息才会输出。当这些选项打开时,调试信息只会记录在服务器的日志中,而不会输出到客户端的日志中。通过设置client_min_messages和log_min_messages参数可以改变日志级别。 +> - 在打开debug_print_plan开关的情况下需尽量避免调用gs_encrypt_aes128及gs_decrypt_aes128函数,避免敏感参数信息在日志中泄露的风险。同时建议用户在打开debug_print_plan开关生成的日志中对gs_encrypt_aes128及gs_decrypt_aes128函数的参数信息进行过滤后再提供给外部维护人员定位,日志使用完成后请及时删除。 ## debug_pretty_print -**参数说明**: 设置此选项对debug_print_parse、debug_print_rewritten和debug_print_plan产生的日志进行缩进,会生成易读但比设置为off时更长的输出格式。 +**参数说明**:设置此选项对debug_print_parse、debug_print_rewritten和debug_print_plan产生的日志进行缩进,会生成易读但比设置为off时更长的输出格式。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示进行缩进。 - off表示不进行缩进。 -**默认值**: on +**默认值**:on ## log_checkpoints -**参数说明**: 控制在服务器日志中记录检查点和重启点的信息。打开此参数时,服务器日志消息包含涉及检查点和重启点的统计量,其中包含需要写的缓存区的数量及写入所花费的时间等。 +**参数说明**:控制在服务器日志中记录检查点和重启点的信息。打开此参数时,服务器日志消息包含涉及检查点和重启点的统计量,其中包含需要写的缓存区的数量及写入所花费的时间等。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开此参数时,服务器日志消息包含涉及检查点和重启点的统计量。 - off表示关闭此参数时,服务器日志消息包含不涉及检查点和重启点的统计量。 -**默认值**: off +**默认值**:off ## log_connections -**参数说明**: 控制记录客户端的连接请求信息。 +**参数说明**:控制记录客户端的连接请求信息。 该参数属于BACKEND类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 有些客户端程序(例如gsql),在判断是否需要口令的时候会尝试连接两次,因此日志消息中重复的"connection receive"(收到连接请求)并不意味着一定是问题。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> 有些客户端程序(例如gsql),在判断是否需要口令的时候会尝试连接两次,因此日志消息中重复的"connection receive"(收到连接请求)并不意味着一定是问题。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示记录信息。 - off表示不记录信息。 -**默认值**: off +**默认值**:off ## log_disconnections -**参数说明**: 控制记录客户端结束连接信息。 +**参数说明**:控制记录客户端结束连接信息。 该参数属于BACKEND类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示记录信息。 - off表示不记录信息。 -**默认值**: off +**默认值**:off ## log_duration -**参数说明**: 控制记录每个已完成SQL语句的执行时间。对使用扩展查询协议的客户端、会记录语法分析、绑定和执行每一步所花费的时间。 +**参数说明**:控制记录每个已完成SQL语句的执行时间。对使用扩展查询协议的客户端、会记录语法分析、绑定和执行每一步所花费的时间。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - 设置为off,该选项与log_min_duration_statement的不同之处在于log_min_duration_statement强制记录查询文本。 - 设置为on并且log_min_duration_statement大于零,记录所有持续时间,但是仅记录超过阈值的语句。这可用于在高负载情况下搜集统计信息。 -**默认值**: on +**默认值**:on ## log_error_verbosity -**参数说明**: 控制服务器日志中每条记录的消息写入的详细度。 +**参数说明**:控制服务器日志中每条记录的消息写入的详细度。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 - terse输出不包括DETAIL、HINT、QUERY及CONTEXT错误信息的记录。 - verbose输出包括SQLSTATE错误代码、源代码文件名、函数名及产生错误所在的行号。 - default输出包括DETAIL、HINT、QUERY及CONTEXT错误信息的记录,不包括SQLSTATE错误代码 、源代码文件名、函数名及产生错误所在的行号。 -**默认值**: default +**默认值**:default ## log_hostname -**参数说明**: 选项关闭状态下,连接消息日志只显示正在连接主机的IP地址。打开此选项同时可以记录主机名。由于解析主机名可能需要一定的时间,可能影响数据库的性能。 +**参数说明**:选项关闭状态下,连接消息日志只显示正在连接主机的IP地址。打开此选项同时可以记录主机名。由于解析主机名可能需要一定的时间,可能影响数据库的性能。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示可以同时记录主机名。 - off表示不可以同时记录主机名。 -**默认值**: on +**默认值**:on ## log_line_prefix -**参数说明**: 控制每条日志信息的前缀格式。日志前缀类似于printf风格的字符串,在日志的每行开头输出。用以%为开头的"转义字符"代替[表1](#转义字符表)中的状态信息。 +**参数说明**:控制每条日志信息的前缀格式。日志前缀类似于printf风格的字符串,在日志的每行开头输出。用以%为开头的“转义字符”代替[表1](#转义字符表)中的状态信息。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **表 1** 转义字符表 -| 转义字符 | 效果 +| 转义字符 | 效果| | -----------------------| ------------------------------- | | %a | 应用程序名称。 | | %u | 用户名。 | @@ -166,7 +166,7 @@ date: 2021-04-20 | %t | 时间戳(没有毫秒)。 | | %m | 带毫秒的时间戳。 | | %n | 表示指定错误从哪个节点上报的。 | -| %i | 命令标签: 会话当前执行的命令类型。 | +| %i | 命令标签:会话当前执行的命令类型。 | | %e | SQLSTATE错误码。 | | %c | 会话ID,详见说明。 | | %l | 每个会话或线程的日志编号,从1开始。 | @@ -177,101 +177,94 @@ date: 2021-04-20 | %S | 会话ID。 | | %% | 字符% 。 | -![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -转义字符%c打印一个独一无二的会话ID,由两个4字节的十六进制数组成,通过字符"."分开。这两个十六进制数分别表示进程的启动时间及进程编号,所以%c也可以看作是保存打印这些名目的途径的空间。比如,从pg_stat_activity中产生会话ID,可以用下面的查询: - -```sql -SELECT to_hex(EXTRACT(EPOCH FROM backend_start)::integer) || '.' || - to_hex(pid) -FROM pg_stat_activity; -``` +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: +> +> 转义字符%c打印一个独一无二的会话ID,由两个4字节的十六进制数组成,通过字符"."分开。这两个十六进制数分别表示进程的启动时间及进程编号,所以%c也可以看作是保存打印这些名目的途径的空间。比如,从pg_stat_activity中产生会话ID,可以用下面的查询: +> +> ```sql +> SELECT to_hex(EXTRACT(EPOCH FROM backend_start)::integer) || '.' || +> to_hex(pid) +> FROM pg_stat_activity; +> ``` - 当log_line_prefix设置为非空值时,请将其最后一个字符作为一个独立的段,以此来直观地与后续的日志进行区分,也可以使用一个标点符号。 - Syslog生成自己的时间戳及进程ID信息,所以当登录日志时,不需要包含这些转义字符。 -**取值范围:**字符串 - -**默认值**: %m %c %d %p %a %x %n %e +**取值范围**:字符串 -![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +**默认值**:%m %c %d %p %a %x %n %e -%m %c %d %p %a %x %n %e表示在日志开头附加会话开始时间戳,会话ID,数据库名,线程ID,应用程序名,事务ID,报错节点,SQLSTATE错误码。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:%m %c %d %p %a %x %n %e表示在日志开头附加会话开始时间戳、会话ID、数据库名、线程ID、应用程序名、事务ID、报错节点、SQLSTATE错误码。 ## log_lock_waits -**参数说明**: 当一个会话的等待获得一个锁的时间超过deadlock_timeout的值时,此选项控制在数据库日志中记录此消息。这对于决定锁等待是否会产生一个坏的行为是非常有用的。 +**参数说明**:当一个会话的等待获得一个锁的时间超过[deadlock_timeout](16-lock-management#deadlock_timeout)的值时,此选项控制在数据库日志中记录此消息。这对于决定锁等待是否会产生一个坏的行为是非常有用的。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示记录此信息。 - off表示不记录此信息。 -**默认值**: off +**默认值**:off ## log_statement -**参数说明**: 控制记录SQL语句。对于使用扩展查询协议的客户端,记录接收到执行消息的事件和绑定参数的值(内置单引号要双写)。 +**参数说明**:控制记录SQL语句。对于使用扩展查询协议的客户端,记录接收到执行消息的事件和绑定参数的值(内置单引号要双写)。 该参数属于SUSET类型参数,请参考表[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) **须知**: +> +> 即使log_statement设置为all,包含简单语法错误的语句也不会被记录,因为仅在完成基本的语法分析并确定了语句类型之后才记录日志。在使用扩展查询协议的情况下,在执行阶段之前(语法分析或规划阶段)同样不会记录。将log_min_error_statement设为ERROR或更低才能记录这些语句。 -即使log_statement设置为all,包含简单语法错误的语句也不会被记录,因为仅在完成基本的语法分析并确定了语句类型之后才记录日志。在使用扩展查询协议的情况下,在执行阶段之前(语法分析或规划阶段)同样不会记录。将log_min_error_statement设为ERROR或更低才能记录这些语句。 - -**取值范围:**枚举类型 +**取值范围**:枚举类型 - none表示不记录语句。 - ddl表示记录所有的数据定义语句,比如CREATE、ALTER和DROP语句。 -- mod表示记录所有DDL语句,还包括数据修改语句INSERT、UPDATE、DELETE、TRUNCATE和COPY FROM 。 +- mod表示记录所有DDL语句,还包括数据修改语句INSERT、UPDATE、DELETE、TRUNCATE和COPY FROM。 - all表示记录所有语句,PREPARE、EXECUTE和EXPLAIN ANALYZE语句也同样被记录。 -**默认值**: none +**默认值**:none ## log_temp_files -**参数说明**: 控制记录临时文件的删除信息。临时文件可以用来排序、哈希及临时查询结果。当一个临时文件被删除时,将会产生一条日志消息。 +**参数说明**:控制记录临时文件的删除信息。临时文件可以用来排序、哈希及临时查询结果。当一个临时文件被删除时,将会产生一条日志消息。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为-1,最大值2147483647,单位KB。 +**取值范围**:整型,最小值为-1,最大值2147483647,单位KB。 - 正整数表示只记录比log_temp_files设定值大的临时文件的删除信息。 -- 值0 表示记录所有的临时文件的删除信息。 -- 值-1 表示不记录任何临时文件的删除信息。 +- 值0表示记录所有的临时文件的删除信息。 +- 值-1表示不记录任何临时文件的删除信息。 -**默认值**: -1 +**默认值**:-1 ## log_timezone -**参数说明**: 设置服务器写日志文件时使用的时区。与TimeZone不同,这个值是数据库范围的,针对所有连接到本数据库的会话生效。 +**参数说明**:设置服务器写日志文件时使用的时区。与[TimeZone](2-zone-and-formatting#timezone)不同,这个值是数据库范围的,针对所有连接到本数据库的会话生效。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 - -**默认值**: PRC +**取值范围**:字符串,可查询视图PG_TIMEZONE_NAMES获得。 -![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +**默认值**:PRC -gs_initdb进行相应系统环境设置时会对默认值进行修改。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:gs_initdb进行相应系统环境设置时会对默认值进行修改。 ## logging_module -**参数说明**: 用于设置或者显示模块日志在服务端的可输出性。该参数属于会话级参数,不建议通过gs_guc工具来设置。 +**参数说明**:用于设置或者显示模块日志在服务端的可输出性。该参数属于会话级参数,不建议通过gs_guc工具来设置。 该参数属于USERSET类型参数,设置请参考表[GUC参数分类](30-appendix)中对应设置的方法进行设置。 -**取值范围:**字符串 - -**默认值**: 所有模块日志在服务端是不输出的,可由SHOW logging_module查看 +**取值范围**:字符串 -```sql -ALL,on(),off(DFS,GUC,ORC,SLRU,MEM_CTL,AUTOVAC,CACHE,ADIO,SSL,TBLSPC,WLM,EXECUTOR,OPFUSION,VEC_EXECUTOR,LLVM,OPT,OPT_REWRITE,OPT_JOIN,OPT_AGG,OPT_SUBPLAN,OPT_SETOP,OPT_SKEW,UDF,COOP_ANALYZE,WLMCP,ACCELERATE,,PLANHINT,SNAPSHOT,XACT,HANDLE,CLOG,EC,REMOTE,CN_RETRY,PLSQL,TEXTSEARCH,SEQ,REDO,FUNCTION,PARSER,INSTR,INCRE_CKPT,DBL_WRT,RTO,HEARTBEAT -``` +**默认值**:所有模块日志在服务端是不输出的,可由SHOW logging_module查看。为ALL,on(),off(DFS、GUC、ORC、SLRU、MEM_CTL、AUTOVAC、CACHE、ADIO、SSL、TBLSPC、WLM、EXECUTOR、OPFUSION、VEC_EXECUTOR、LLVM、OPT、OPT_REWRITE、OPT_JOIN、OPT_AGG、OPT_SUBPLAN、OPT_SETOP、OPT_SKEW、UDF、COOP_ANALYZE、WLMCP、ACCELERATE、PLANHINT、SNAPSHOT、XACT、HANDLE、CLOG、EC、REMOTE、CN_RETRY、PLSQL、TEXTSEARCH、SEQ、REDO、FUNCTION、PARSER、INSTR、INCRE_CKPT、DBL_WRT、RTO、HEARTBEAT)。 -**设置方法**: 首先,可以通过SHOW logging_module来查看哪些模块是支持可控制的。例如,查询输出结果为: +**设置方法**:首先,可以通过SHOW logging_module来查看哪些模块是支持可控制的。例如,查询输出结果为: ```sql mogdb=# show logging_module; @@ -281,7 +274,7 @@ ALL,on(),off(DFS,GUC,ORC,SLRU,MEM_CTL,AUTOVAC,CACHE,ADIO,SSL,TBLSPC,WLM,EXECUTOR (1 row) ``` -支持可控制的模块使用大写来标识,特殊标识ALL用于对所有模块日志进行设置。可以使用on/off来控制模块日志的输出。设置SSL模块日志为可输出,使用如下命令: +支持可控制的模块使用大写来标识,特殊标识ALL用于对所有模块日志进行设置。可以使用on/off来控制模块日志的输出。设置SSL模块日志为可输出,使用如下命令: ```sql mogdb=# set logging_module='on(SSL)'; @@ -303,7 +296,7 @@ SET mogdb=# show logging_module; logging_module ------------------------------------- -LL,on(),off(DFS,GUC,ORC,SLRU,MEM_CTL,AUTOVAC,CACHE,ADIO,SSL,TBLSPC,WLM,EXECUTOR,VEC_EXECUTOR,LLVM,OPT,OPT_REWRITE,OPT_JOIN,OPT_AGG,OPT_SUBPLAN,OPT_SETOP,OPT_SKEW,UDF,COOP_ANALYZE,WLMCP,ACCELERATE,PLANHINT,SNAPSHOT,XACT,HANDLE,CLOG,EC,REMOTE,CN_RETRY,PLSQL,TEXTSEARCH,SEQ,REDO,FUNCTION,PARSER,INSTR,INCRE_CKPT,DBL_WRT,RTO,HEARTBEAT) +ALL,on(),off(DFS,GUC,ORC,SLRU,MEM_CTL,AUTOVAC,CACHE,ADIO,SSL,TBLSPC,WLM,EXECUTOR,VEC_EXECUTOR,LLVM,OPT,OPT_REWRITE,OPT_JOIN,OPT_AGG,OPT_SUBPLAN,OPT_SETOP,OPT_SKEW,UDF,COOP_ANALYZE,WLMCP,ACCELERATE,PLANHINT,SNAPSHOT,XACT,HANDLE,CLOG,EC,REMOTE,CN_RETRY,PLSQL,TEXTSEARCH,SEQ,REDO,FUNCTION,PARSER,INSTR,INCRE_CKPT,DBL_WRT,RTO,HEARTBEAT) (1 row) mogdb=# set logging_module='on(ALL)'; @@ -315,34 +308,34 @@ ALL,on(DFS,GUC,ORC,SLRU,MEM_CTL,AUTOVAC,CACHE,ADIO,SSL,TBLSPC,WLM,EXECUTOR,VEC_E (1 row) ``` -**依赖关系**: 该参数依赖于log_min_messages参数的设置 +**依赖关系**:该参数依赖于log_min_messages参数的设置 ## opfusion_debug_mode -**参数说明**: 用于调试简单查询是否进行查询优化。设置成log级别可以在数据库节点的执行计划中看到没有查询优化的具体原因。 +**参数说明**:用于调试简单查询是否进行查询优化。设置成log级别可以在数据库节点的执行计划中看到没有查询优化的具体原因。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 - off表示不打开该功能。 - log表示打开该功能,可以在数据库节点的执行计划中看到没有查询优化的具体原因。 -![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** - -提供在log中显示语句没有查询优化的具体原因,需要将参数设置成log级别,log_min_messages设置成debug4级别,logging_module设置'on(OPFUSION)',注意log内容可能会比较多,尽可能在调优期间执行少量作业使用。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> 提供在log中显示语句没有查询优化的具体原因,需要将参数设置成log级别,log_min_messages设置成debug4级别,logging_module设置'on(OPFUSION)',注意log内容可能会比较多,尽可能在调优期间执行少量作业使用。 -**默认值**: off +**默认值**:off ## enable_debug_vacuum -**参数说明**: 允许输出一些与VACUUM相关的日志,便于定位VACUUM相关问题。开发人员专用,不建议普通用户使用。 +**参数说明**:允许输出一些与VACUUM相关的日志,便于定位VACUUM相关问题。开发人员专用,不建议普通用户使用。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on/true表示开启此日志开关。 - off/false表示关闭此日志开关。 -**默认值**: off +**默认值**:off diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/4-using-csv-log-output.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/4-using-csv-log-output.md index b769ac086bcf93e87820c8fadc26feb178dc4e67..fa28be49c8f6ace6a3d56ac49ea0eb109d86ec41 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/4-using-csv-log-output.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/10-error-reporting-and-logging/4-using-csv-log-output.md @@ -9,14 +9,14 @@ date: 2021-04-20 **前提条件** -- log_destination的值设置为csvlog。 -- logging_collector的值设置为on。 +- [log_destination](1-logging-destination#log_destination)的值设置为csvlog。 +- [logging_collector](1-logging-destination#logging_collector)的值设置为on。 **csvlog定义** -以"逗号分隔值" 即CSV(Comma Separated Value)的形式发出日志。 +以“逗号分隔值”即CSV(Comma Separated Value)的形式发出日志。 -以下是简单的用来存储CSV形式日志输出的表定义: +以下是简单的用来存储CSV形式日志输出的表定义: ```sql CREATE TABLE gaussdb_log @@ -70,19 +70,19 @@ application_name text | transaction_id | 事务ID | location | 在MogDB源代码中错误的位置(如果log_error_verbosity的值设为verbose ) | | query_id | 查询ID | application_name | 应用名称 | -使用COPY FROM命令将日志文件导入这个表: +使用COPY FROM命令将日志文件导入这个表: ```shell COPY gaussdb_log FROM '/opt/data/pg_log/logfile.csv' WITH csv; ``` -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > 此处的日志名"logfile.csv"要换成实际生成的日志的名称。 **简化输入** -简化输入到CSV日志文件,可以通过如下操作: +简化输入到CSV日志文件,可以通过如下操作: -- 设置log_filename和log_rotation_age,为日志文件提供一个一致的、可预测的命名方案。通过日志文件名,预测一个独立的日志文件完成并进入准备导入状态的时间。 -- 将log_rotation_size设为0来终止基于尺寸的日志回滚,因为基于尺寸的日志回滚让预测日志文件名变得非常的困难。 -- 将log_truncate_on_rotation设为on以便区分在同一日志文件中旧的日志数据和新的日志数据。 +- 设置[log_filename](1-logging-destination#log_filename)和[log_rotation_age](1-logging-destination#log_rotation_age),为日志文件提供一个一致的、可预测的命名方案。通过日志文件名,预测一个独立的日志文件完成并进入准备导入状态的时间。 +- 将[log_rotation_size](1-logging-destination#log_rotation_size)设为0来终止基于尺寸的日志回滚,因为基于尺寸的日志回滚让预测日志文件名变得非常的困难。 +- 将[log_truncate_on_rotation](1-logging-destination#log_truncate_on_rotation)设为on以便区分在同一日志文件中旧的日志数据和新的日志数据。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/11-alarm-detection.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/11-alarm-detection.md index 7a97fa12ac22408404116499f87ab048d3e507b6..470841e6f5780728b3f7254c5b663c74ca15e6f5 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/11-alarm-detection.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/11-alarm-detection.md @@ -11,46 +11,46 @@ date: 2021-04-20 ## enable_alarm -**参数说明**: 允许打开告警检测线程,检测数据库中可能的错误场景。 +**参数说明**:允许打开告警检测线程,检测数据库中可能的错误场景。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许打开告警检测线程。 - off表示不允许打开告警检测线程。 -**默认值**: on +**默认值**:on ## connection_alarm_rate -**参数说明**: 允许和数据库连接的最大并发连接数的比率限制。数据库连接的最大并发连接数为max_connections* connection_alarm_rate。 +**参数说明**:允许和数据库连接的最大并发连接数的比率限制。数据库连接的最大并发连接数为max_connections * connection_alarm_rate。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**浮点型,0.0~1.0 +**取值范围**:浮点型,0.0~1.0 -**默认值**: 0.9 +**默认值**:0.9 ## alarm_report_interval -**参数说明**: 指定告警上报的时间间隔。 +**参数说明**:指定告警上报的时间间隔。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,单位为秒。 +**取值范围**:整型,单位为秒。 -**默认值**: 10 +**默认值**:10 ## alarm_component -**参数说明**: 在对告警做上报时,会进行告警抑制,即同一个实例的同一个告警项在alarm_report_interval(默认值为10s)内不做重复上报。在这种情况下设置用于处理告警内容的告警组件的位置。 +**参数说明**:在对告警做上报时,会进行告警抑制,即同一个实例的同一个告警项在alarm_report_interval(默认值为10s)内不做重复上报。在这种情况下设置用于处理告警内容的告警组件的位置。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: /opt/huawei/snas/bin/snas_cm_cmd +**默认值**:/opt/snas/bin/snas_cm_cmd ## table_skewness_warning_threshold 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 8eb2c847f0b96e0254214398e171cec482fd52d2..90cf1fc17b3e73a068c66805ba64db7ff7430ba2 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 @@ -11,129 +11,128 @@ date: 2021-04-20 ## track_activities -**参数说明**: 控制收集每个会话中当前正在执行命令的统计数据。 +**参数说明**:控制收集每个会话中当前正在执行命令的统计数据。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启收集功能。 - off表示关闭收集功能。 -**默认值**: on +**默认值**:on ## track_counts -**参数说明**: 控制收集数据库活动的统计数据。 +**参数说明**:控制收集数据库活动的统计数据。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启收集功能。 - off表示关闭收集功能。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> -> 在AutoVacuum自动清理进程中选择清理的数据库时,需要数据库的统计数据,故默认值设为on。 +**默认值**:on -**默认值**: on +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:在AutoVacuum自动清理进程中选择清理的数据库时,需要数据库的统计数据,故默认值设为on。 +> ## track_io_timing -**参数说明**: 控制收集数据库I/O调用时序的统计数据。I/O时序统计数据可以在pg_stat_database中查询。 +**参数说明**:控制收集数据库I/O调用时序的统计数据。I/O时序统计数据可以在pg_stat_database中查询。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启收集功能,开启时,收集器会在重复地去查询当前时间的操作系统,这可能会引起某些平台的重大开销,故默认值设置为off。 - off表示关闭收集功能。 -**默认值**: off +**默认值**:off ## track_functions -**参数说明**: 控制收集函数的调用次数和调用耗时的统计数据。 +**参数说明**:控制收集函数的调用次数和调用耗时的统计数据。 该参数属于SUSET类型参数,请参考表[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) **须知**:当SQL语言函数设置为调用查询的“内联”函数时,不管是否设置此选项,这些SQL语言函数无法被追踪到。 > -> 当SQL语言函数设置为调用查询的"内联"函数时,不管是否设置此选项,这些SQL语言函数无法被追踪到。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 - pl表示只追踪过程语言函数。 - all表示追踪SQL语言函数。 - none表示关闭函数追踪功能。 -**默认值**: none +**默认值**:none ## track_activity_query_size -**参数说明**: 设置用于跟踪每一个活动会话的当前正在执行命令的字节数。 +**参数说明**:设置用于跟踪每一个活动会话的当前正在执行命令的字节数。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,100~102400 +**取值范围**:整型,100~102400 -**默认值**: 1024 +**默认值**:1024 ## stats_temp_directory -**参数说明**: 设置存储临时统计数据的目录。 +**参数说明**:设置存储临时统计数据的目录。 该参数属于SIGHUP类型参数,请参考表[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) **须知**:将其设置为一个基于RAM的文件系统目录会减少实际的I/O开销并可以提升其性能。 > -> 将其设置为一个基于RAM的文件系统目录会减少实际的I/O开销并可以提升其性能。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: pg_stat_tmp +**默认值**:pg_stat_tmp ## track_thread_wait_status_interval -**参数说明**: 用来定期收集thread状态信息的时间间隔。 +**参数说明**:用来定期收集thread状态信息的时间间隔。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**0~1天,单位为min。 +**取值范围**:0~1天,单位为min。 -**默认值**: 30min +**默认值**:30min ## enable_save_datachanged_timestamp -**参数说明**: 确定是否收集insert/update/delete, exchange/truncate/drop partition操作对表数据改动的时间。 +**参数说明**:确定是否收集insert/update/delete, exchange/truncate/drop partition操作对表数据改动的时间。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许收集相关操作对表数据改动的时间。 - off表示禁止收集相关操作对表数据改动的时间。 -**默认值**: on +**默认值**:on ## track_sql_count -**参数说明**: 控制对每个会话中当前正在执行的SELECT、INSERT、UPDATE、DELETE、MERGE INTO语句进行计数的统计数据。 +**参数说明**:控制对每个会话中当前正在执行的SELECT、INSERT、UPDATE、DELETE、MERGE INTO语句进行计数的统计数据。 + +在x86平台集中式部署下,硬件配置规格为32核CPU/256GB内存,使用Benchmark SQL 5.0工具测试性能,开关此参数性能影响约0.8%。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启计数功能。 - off表示关闭计数功能。 **默认值: on** -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > -> - track_sql_count参数受track_activities约束。 -> - track_activities开启而track_sql_count关闭时,如果查询了gs_sql_count视图,日志中将会有WARNING提示track_sql_count是关闭的。 -> - track_activities和track_sql_count同时关闭,那么此时日志中将会有两条WARNING,分别提示track_activities是关闭的和track_sql_count是关闭的。 -> - track_activities关闭而track_sql_count开启,此时日志中将仅有WARNING提示track_activities是关闭。 +> - track_sql_count参数受track_activities约束: +> - track_activities开启而track_sql_count关闭时,如果查询了gs_sql_count视图,日志中将会有WARNING提示track_sql_count是关闭的; +> - track_activities和track_sql_count同时关闭,那么此时日志中将会有两条WARNING,分别提示track_activities是关闭的和track_sql_count是关闭的; +> - track_activities关闭而track_sql_count开启,此时日志中将仅有WARNING提示track_activities是关闭。 > - 当参数关闭时,查询视图的结果为0行。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/2-performance-statistics.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/2-performance-statistics.md index 69ad235210244b2864f59602519a3a4d385fb0d3..68eb28cdad4971fb31ddc148a65c8125302cc576 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/2-performance-statistics.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/12-statistics-during-the-database-running/2-performance-statistics.md @@ -11,7 +11,7 @@ date: 2021-04-20 **输出性能统计日志** -**参数说明**: 对每条查询,以下4个选项控制在服务器日志里记录相应模块的性能统计数据,具体含义如下: +**参数说明**:对每条查询,以下4个选项控制在服务器日志里记录相应模块的性能统计数据,具体含义如下: - log_parser_stats控制在服务器日志里记录解析器的性能统计数据。 - log_planner_stats控制在服务器日志里记录查询优化器的性能统计数据。 @@ -22,14 +22,14 @@ date: 2021-04-20 这些参数属于SUSET类型参数,请参考表[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) **须知**: > > - log_statement_stats记录总的语句统计数据,而其他的只记录针对每个模块的统计数据。 > - log_statement_stats不能和其他任何针对每个模块统计的选项一起打开。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启记录性能统计数据的功能。 - off表示关闭记录性能统计数据的功能。 -**默认值: off** +**默认值**:off 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 08282f5d43307aa769bdf817a4a613d93188e4b7..b8b37bfd31be1418ab6513bf33ad193585e28584 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 @@ -11,7 +11,7 @@ date: 2021-04-20 ## use_workload_manager -**参数说明**: 是否开启资源管理功能。 +**参数说明**:是否开启资源管理功能。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -24,17 +24,19 @@ date: 2021-04-20 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > > - 当使用表[GUC参数设置方式](30-appendix)中的方式二来修改参数值时,新参数值只能对更改操作执行后启动的线程生效。此外,对于后台线程以及线程复用执行的新作业,该参数值的改动不会生效。如果希望这类线程即时识别参数变化,可以使用kill session或重启节点的方式来实现。 + > > - use_workload_manager参数由off变为on状态后,不会统计off时的存储资源。如果需要统计off时用户使用的存储资源,请在数据库中执行以下命令: > - > ```sql - > select gs_wlm_readjust_user_space(0); - > ``` + > ```sql + > select gs_wlm_readjust_user_space(0); + > ``` + > -**默认值**: off +**默认值**:off ## cgroup_name -**参数说明**: 设置当前使用的Cgroups的名称或者调整当前group下排队的优先级。 +**参数说明**:设置当前使用的Cgroups的名称或者调整当前group下排队的优先级。 即如果先设置cgroup_name,再设置session_respool,那么session_respool关联的控制组起作用,如果再切换cgroup_name,那么新切换的cgroup_name起作用。 @@ -46,11 +48,11 @@ date: 2021-04-20 **取值范围**: 字符串 -**默认值**: InvalidGroup +**默认值**:InvalidGroup ## cpu_collect_timer -**参数说明**: 设置语句执行时在数据库节点上收集CPU时间的周期。 +**参数说明**:设置语句执行时在数据库节点上收集CPU时间的周期。 数据库管理员需根据系统资源(如CPU资源、IO资源和内存资源)情况,调整此数值大小,使得系统支持较合适的收集周期,太小会影响执行效率,太大会影响异常处理的精确度。 @@ -58,41 +60,40 @@ date: 2021-04-20 **取值范围**: 整型,1~INT_MAX, 单位为秒。 -**默认值**: 30 +**默认值**:30 ## memory_tracking_mode -**参数说明**: 设置记录内存信息的模式。 +**参数说明**:设置记录内存信息的模式。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**: -- none,不启动内存统计功能。 +- none:表示不启动内存统计功能。 - peak:表示统计query级内存peak值,此数值计入数据库日志,也可以由explain analyze输出。 -- normal,仅做内存实时统计,不生成文件。 -- executor,生成统计文件,包含执行层使用过的所有已分配内存的上下文信息。 -- fullexec,生成文件包含执行层申请过的所有内存上下文信息。 +- normal:表示仅做内存实时统计,不生成文件。 +- executor:表示生成统计文件,包含执行层使用过的所有已分配内存的上下文信息。 +- fullexec:表示生成文件包含执行层申请过的所有内存上下文信息。 -**默认值**: none +**默认值**:none ## memory_detail_tracking -**参数说明**: 设置需要的线程内分配内存上下文的顺序号以及当前线程所在query的plannodeid。 +**参数说明**:设置需要的线程内分配内存上下文的顺序号以及当前线程所在query的plannodeid。 该参数属于USERSET类型参数,请参考表[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) **须知:**该参数不允许用户进行设置,建议保持默认值。 > -> 该参数不允许用户进行设置,建议保持默认值。 ## enable_resource_track -**参数说明**: 是否开启资源实时监控功能。 +**参数说明**:是否开启资源实时监控功能。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -101,11 +102,11 @@ date: 2021-04-20 - on表示打开资源监控。 - off表示关闭资源监控。 -**默认值**: on +**默认值**:on ## enable_resource_record -**参数说明**: 是否开启资源监控记录归档功能。 +**参数说明**:是否开启资源监控记录归档功能。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -114,11 +115,11 @@ date: 2021-04-20 - on表示开启资源监控记录归档功能。 - off表示关闭资源监控记录归档功能。 -**默认值**: off +**默认值**:off ## enable_logical_io_statistics -**参数说明**: 设置是否开启资源监控逻辑IO统计功能。开启时,对于PG_TOTAL_USER_RESOURCE_INFO视图中的read_kbytes、write_kbytes、read_counts、write_counts、read_speed和write_speed字段,会统计对应用户的逻辑读写字节数、次数以及速率。 +**参数说明**:设置是否开启资源监控逻辑IO统计功能。开启时,对于PG_TOTAL_USER_RESOURCE_INFO视图中的read_kbytes、write_kbytes、read_counts、write_counts、read_speed和write_speed字段,会统计对应用户的逻辑读写字节数、次数以及速率。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -127,11 +128,11 @@ date: 2021-04-20 - on表示开启资源监控逻辑IO统计功能。 - off表示关闭资源监控逻辑IO统计功能。 -**默认值**: on +**默认值**:on ## enable_user_metric_persistent -**参数说明**:设置是否开启用户历史资源监控转存功能。开启时,对于PG_TOTAL_USER_RESOURCE_INFO视图中数据,会定期采样保存到GS_WLM_USER_RESOURCE_HISTORY系统表中。 +**参数说明**:设置是否开启用户历史资源监控转存功能。开启时,对于PG_TOTAL_USER_RESOURCE_INFO视图中数据,会定期采样保存到[GS_WLM_USER_RESOURCE_HISTORY](GS_WLM_USER_RESOURCE_HISTORY)系统表中。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -145,7 +146,7 @@ date: 2021-04-20 ## user_metric_retention_time -**参数说明**:设置用户历史资源监控数据的保存天数。该参数仅在 enable_user_metric_persistent为on时有效。 +**参数说明**:设置用户历史资源监控数据的保存天数。该参数仅在enable_user_metric_persistent为on时有效。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中的方法一和方法二进行设置。 @@ -159,7 +160,7 @@ date: 2021-04-20 ## enable_instance_metric_persistent -**参数说明**: 设置是否开启实例资源监控转存功能。开启时,对实例的监控数据会保存到GS_WLM_INSTANCE_HISTORY系统表中。 +**参数说明**:设置是否开启实例资源监控转存功能。开启时,对实例的监控数据会保存到[GS_WLM_INSTANCE_HISTORY](GS_WLM_INSTANCE_HISTORY)系统表中。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -168,11 +169,11 @@ date: 2021-04-20 - on表示开启实例资源监控转存功能。 - off表示关闭实例资源监控转存功能。 -**默认值**: on +**默认值**:on ## instance_metric_retention_time -**参数说明**: 设置实例历史资源监控数据的保存天数。该参数仅在enable_instance_metric_persistent为on时有效。 +**参数说明**:设置实例历史资源监控数据的保存天数。该参数仅在enable_instance_metric_persistent为on时有效。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中的方法一和方法二进行设置。 @@ -181,39 +182,39 @@ date: 2021-04-20 - 值等于0时,实例历史资源监控数据将永久保存。 - 值大于0时,实例历史资源监控数据将保存对应设置天数。 -**默认值**: 7 +**默认值**:7 ## resource_track_level -**参数说明**: 设置当前会话的资源监控的等级。该参数只有当参数enable_resource_track为on时才有效。 +**参数说明**:设置当前会话的资源监控的等级。该参数只有当参数enable_resource_track为on时才有效。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**: 枚举型 -- none,不开启资源监控功能。 -- query,开启query级别资源监控功能。 -- operator,开启query级别和算子级别资源监控功能。 +- none:表示不开启资源监控功能。 +- query:表示开启query级别资源监控功能。 +- operator:表示开启query级别和算子级别资源监控功能。 -**默认值**: query +**默认值**:query ## resource_track_cost -**参数说明**: 设置对当前会话的语句进行资源监控的最小执行代价。该参数只有当参数enable_resource_track为on时才有效。 +**参数说明**:设置对当前会话的语句进行资源监控的最小执行代价。该参数只有当参数enable_resource_track为on时才有效。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**: 整型,-1~INT_MAX - 值为-1时,不进行资源监控。 -- 值大于或等于0时,值大于或等于0且小于等于9时,对执行代价大于等于10的语句进行资源监控。 +- 值大于或等于0且小于等于9时,对执行代价大于等于10的语句进行资源监控。 - 值大于或等于10时,对执行代价超过该参数值的语句进行资源监控。 -**默认值**: 100000 +**默认值**:100000 ## resource_track_duration -**参数说明**: 设置资源监控实时视图中记录的语句执行结束后进行历史信息转存的最小执行时间。当执行完成的作业,其执行时间不小于此参数值时,作业信息会从实时视图(以statistics为后缀的视图)转存到相应的历史视图(以history为后缀的视图)中。该参数只有当[enable_resource_track](#enable_resource_track)为on时才有效。 +**参数说明**:设置资源监控实时视图中记录的语句执行结束后进行历史信息转存的最小执行时间。当执行完成的作业,其执行时间不小于此参数值时,作业信息会从实时视图(以statistics为后缀的视图)转存到相应的历史视图(以history为后缀的视图)中。该参数只有当[enable_resource_track](#enable_resource_track)为on时才有效。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -222,11 +223,11 @@ date: 2021-04-20 - 值为0时,资源监控实时视图中记录的所有语句都进行历史信息归档。 - 值大于0时,资源监控实时视图中记录的语句的执行时间超过这个值就会进行历史信息归档。 -**默认值**: 1min +**默认值**:1min ## disable_memory_protect -**参数说明**: 禁止内存保护功能。当系统内存不足时如果需要查询系统视图,可以先将此参数置为on,禁止内存保护功能,保证视图可以正常查询。该参数只适用于在系统内存不足时进行系统诊断和调试,正常运行时请保持该参数配置为off。 +**参数说明**:禁止内存保护功能。当系统内存不足时如果需要查询系统视图,可以先将此参数置为on,禁止内存保护功能,保证视图可以正常查询。该参数只适用于在系统内存不足时进行系统诊断和调试,正常运行时请保持该参数配置为off。 该参数属于USERSET类型参数,且只对当前会话有效。请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -235,17 +236,17 @@ date: 2021-04-20 - on表示禁止内存保护功能。 - off表示启动内存保护功能。 -**默认值**: off +**默认值**:off ## query_band -**参数说明**: 用于标示当前会话的作业类型,由用户自定义。 +**参数说明**:用于标示当前会话的作业类型,由用户自定义。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**: 字符型 -**默认值**: 空 +**默认值**:空 ## memory_fault_percent @@ -268,31 +269,32 @@ date: 2021-04-20 - on表示打开黑匣子功能。 - off表示关闭黑匣子功能。 -**默认值**: off +**默认值**:on + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** 黑匣子功能生成core文件依赖操作系统开放ptrace接口。若发生权限不足(errno = 1),请确保/proc/sys/mogdb/yama/ptrace_scope配置合理。 ## bbox_dump_count -**参数说明**: 在[bbox_dump_path](#bbox_dump_path)定义的路径下,允许存储的MogDB所产生core文件最大数。超过此数量,旧的core文件会被删除。此参数只有当[enable_bbox_dump](#enable_bbox_dump)为on时才生效。 +**参数说明**:在[bbox_dump_path](#bbox_dump_path)定义的路径下,允许存储的MogDB所产生core文件最大数。超过此数量,旧的core文件会被删除。此参数只有当[enable_bbox_dump](#enable_bbox_dump)为on时才生效。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**: 整型,1~20 -**默认值**: 8 +**默认值**:8 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:**在并发产生core文件时,core文件的产生个数可能大于bbox_dump_count。 > -> 在并发产生core文件时,core文件的产生个数可能大于bbox_dump_count。 ## bbox_dump_path -**参数说明**: 黑匣子core文件的生成路径。此参数只有当[enable_bbox_dump](#enable_bbox_dump)为on时才生效。 +**参数说明**:黑匣子core文件的生成路径。此参数只有当[enable_bbox_dump](#enable_bbox_dump)为on时才生效。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 **取值范围**: 字符型 -**默认值**: 空。默认生成黑匣子core文件的路径为读取/proc/sys/mogdb/core_pattern下的路径,如果这个路径不是一个目录,或者用户对此目录没有写权限,黑匣子core文件将生成在数据库的data目录下。或者以安装时指定的目录为准。 +**默认值**:空。默认生成黑匣子core文件的路径为读取/proc/sys/mogdb/core_pattern下的路径,如果这个路径不是一个目录,或者用户对此目录没有写权限,黑匣子core文件将生成在数据库的data目录下。或者以安装时指定的目录为准。 ## enable_ffic_log @@ -305,7 +307,7 @@ date: 2021-04-20 - on表示打开FFIC功能。 - off表示关闭FFIC功能。 -**默认值**: on +**默认值**:on ## io_limits @@ -315,7 +317,7 @@ date: 2021-04-20 **取值范围**: 整型,0~1073741823 -**默认值**: 0 +**默认值**:0 ## io_priority @@ -330,7 +332,7 @@ date: 2021-04-20 - Medium:表示限制iops为该作业原始触发数值的20%。 - High:表示限制iops为该作业原始触发数值的50%。 -**默认值**: None +**默认值**:None ## io_control_unit @@ -342,7 +344,7 @@ date: 2021-04-20 **取值范围**: 整型,1000~1000000 -**默认值**: 6000 +**默认值**:6000 ## session_respool @@ -358,7 +360,7 @@ date: 2021-04-20 **取值范围**: string类型,通过create resource pool所设置的资源池。 -**默认值**: invalid_pool +**默认值**:invalid_pool ## session_statistics_memory @@ -368,7 +370,7 @@ date: 2021-04-20 **取值范围**: 整型,5 * 1024 ~ max_process_memory的50%,单位KB。 -**默认值**: 5MB +**默认值**:5MB ## topsql_retention_time @@ -376,12 +378,12 @@ date: 2021-04-20 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -取值范围: 整型,0~730,单位为天。 +**取值范围**:整型,0~730,单位为天。 - 值为0时,表示数据永久保存。 - 值大于0时,表示数据能够保存的对应天数。 -默认值: 0 +**默认值**: 0 ## session_history_memory @@ -391,7 +393,7 @@ date: 2021-04-20 **取值范围**: 整型,10 * 1024~max_process_memory的50%,单位KB。 -**默认值**: 10MB +**默认值**:10MB ## transaction_pending_time @@ -401,7 +403,7 @@ date: 2021-04-20 **取值范围**: 整型,-1~INT_MAX/2,单位为秒。 -- 值为-1或0: 事务块语句和存储过程语句无超时判断,排队至资源满足可执行条件。 -- 值大于0: 事务块语句和存储过程语句排队超过所设数值的时间后,无视当前资源情况强制执行。 +- 值为-1或0时,事务块语句和存储过程语句无超时判断,排队至资源满足可执行条件。 +- 值大于0时,事务块语句和存储过程语句排队超过所设数值的时间后,无视当前资源情况强制执行。 -**默认值**: 0 +**默认值**:0 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 4f2fa9c2de5466a6b2ae785c4d0acf3b5505db23..ceb66061f490528d8723dba1e8ec6dd1c00ff36e 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 @@ -11,64 +11,65 @@ date: 2021-04-20 ## autovacuum -**参数说明**: 控制数据库自动清理线程(autovacuum)的启动。自动清理线程运行的前提是将track_counts设置为on。 +**参数说明**:控制数据库自动清理线程(autovacuum)的启动。自动清理线程运行的前提是将[track_counts](1-query-and-index-statistics-collector#track_counts)设置为on。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 如果希望系统在故障恢复后,具备自动清理两阶段事务的功能,请将autovacuum设置为on; > - 当设置autovacuum为on,[autovacuum_max_workers](#autovacuum_max_workers)为0时,表示系统不会自动进行autovacuum,只会在故障恢复后,自动清理两阶段事务; > - 当设置autovacuum为on,[autovacuum_max_workers](#autovacuum_max_workers)大于0时,表示系统不仅在故障恢复后,自动清理两阶段事务,并且还可以自动清理线程。 > -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 即使此参数设置为off,当事务ID回绕即将发生时,数据库也会自动启动自动清理线程。对于create/drop database发生异常时,可能有的节点提交或回滚,有的节点未提交(prepared状态),此时系统不能自动修复,需要手动修复。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> 即使此参数设置为off,当事务ID回绕即将发生时,数据库也会自动启动自动清理线程。对于create/drop database发生异常时,可能有的节点提交或回滚,有的节点未提交(prepared状态),此时系统不能自动修复,需要手动修复。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启数据库自动清理线程。 - off表示关闭数据库自动清理线程。 -**默认值**: on +**默认值**:on ## autovacuum_mode -**参数说明**: 该参数仅在autovacuum设置为on的场景下生效,它控制autoanalyze或autovacuum的打开情况。 +**参数说明**:该参数仅在autovacuum设置为on的场景下生效,它控制autoanalyze或autovacuum的打开情况。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 - analyze表示只做autoanalyze。 - vacuum表示只做autovacuum。 - mix表示autoanalyze和autovacuum都做。 - none表示二者都不做。 -**默认值**: mix +**默认值**:mix ## autoanalyze_timeout -**参数说明**: 设置autoanalyze的超时时间。在对某张表做autoanalyze时,如果该表的analyze时长超过了autoanalyze_timeout,则自动取消该表此次analyze。 +**参数说明**:设置autoanalyze的超时时间。在对某张表做autoanalyze时,如果该表的analyze时长超过了autoanalyze_timeout,则自动取消该表此次analyze。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**int类型,单位是s,0~2147483。 +**取值范围**:整型,0~2147483,单位是秒。 -**默认值**: 5min(即300s) +**默认值**:5min(即300s) ## autovacuum_io_limits -**参数说明**: 控制autovacuum线程每秒触发IO的上限。 +**参数说明**:控制autovacuum线程每秒触发IO的上限。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~1073741823和-1。其中-1表示不控制,而是使用系统默认控制组。 +**取值范围**:整型,0~1073741823和-1。其中-1表示不控制,而是使用系统默认控制组。 -**默认值**: -1 +**默认值**:-1 ## log_autovacuum_min_duration -**参数说明**: 当自动清理的执行时间大于或者等于某个特定的值时,向服务器日志中记录自动清理执行的每一步操作。设置此选项有助于追踪自动清理的行为。 +**参数说明**:当自动清理的执行时间大于或者等于某个特定的值时,向服务器日志中记录自动清理执行的每一步操作。设置此选项有助于追踪自动清理的行为。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 @@ -76,111 +77,113 @@ date: 2021-04-20 将log_autovacuum_min_duration设置为250ms,记录所有运行大于或者等于250ms的自动清理命令的相关信息。 -**取值范围:**整型,最小值为-1,最大值为2147483647,单位为毫秒。 +**取值范围**:整型,最小值为-1,最大值为2147483647,单位为毫秒。 - 当参数设置为0时,表示所有的自动清理操作都记录到日志中。 - 当参数设置为-1时,表示所有的自动清理操作都不记录到日志中。 -- 当参数设置为非-1时,当由于锁冲突的存在导致一个自动清理操作被跳过,记录一条消息。 +- 当参数设置为非-1、非0时,当由于锁冲突的存在导致一个自动清理操作被跳过,记录一条消息。 -**默认值**: -1 +**默认值**:-1 ## autovacuum_max_workers -**参数说明**: 设置能同时运行的自动清理线程的最大数量,该参数的取值上限与GUC参数max_connections和job_queue_processes大小有关。 +**参数说明**:设置能同时运行的自动清理线程的最大数量,该参数的取值上限与GUC参数max_connections和job_queue_processes大小有关。 该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0(表示不会自动进行autovacuum),理论最大值为262143,实际最大值为动态值,计算公式为"262143 - max_connections - job_queue_processes - 辅助线程数 - autovacuum的lancher线程数 - 1",其中辅助线程数和autovacuum的lancher线程数由两个宏来指定,当前版本的默认值分别为20和2。 +**取值范围**:整型,最小值为0(表示不会自动进行autovacuum),理论最大值为262143,实际最大值为动态值,计算公式为“262143 - max_connections的值 - job_queue_processes的值 - 辅助线程数 – autovacuum的lancher线程数 - 1”,其中辅助线程数和autovacuum的lancher线程数由两个宏来指定,当前版本的默认值分别为20和2。 -**默认值**: 3 +**默认值**:3 ## autovacuum_naptime -**参数说明**: 设置两次自动清理操作的时间间隔。 +**参数说明**:设置两次自动清理操作的时间间隔。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,单位为s,最小值为1,最大值为2147483。 +**取值范围**:整型,单位为s,最小值为1,最大值为2147483。 -**默认值**: 10min(即600s) +**默认值**:10min(即600s) ## autovacuum_vacuum_threshold -**参数说明**: 设置触发VACUUM的阈值。当表上被删除或更新的记录数超过设定的阈值时才会对这个表执行VACUUM操作。 +**参数说明**:设置触发VACUUM的阈值。当表上被删除或更新的记录数超过设定的阈值时才会对这个表执行VACUUM操作。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0,最大值为2147483647。 +**取值范围**:整型,最小值为0,最大值为2147483647。 -**默认值**: 50 +**默认值**:50 ## autovacuum_analyze_threshold -**参数说明**: 设置触发ANALYZE操作的阈值。当表上被删除、插入或更新的记录数超过设定的阈值时才会对这个表执行ANALYZE操作。 +**参数说明**:设置触发ANALYZE操作的阈值。当表上被删除、插入或更新的记录数超过设定的阈值时才会对这个表执行ANALYZE操作。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0,最大值为2147483647。 +**取值范围**:整型,最小值为0,最大值为2147483647。 -**默认值**: 50 +**默认值**:50 ## autovacuum_vacuum_scale_factor -**参数说明**: 设置触发一个VACUUM时增加到autovacuum_vacuum_threshold的表大小的缩放系数。 +**参数说明**:设置触发一个VACUUM时增加到autovacuum_vacuum_threshold的表大小的缩放系数。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**浮点型,0.0~100.0 +**取值范围**:浮点型,0.0~100.0 -**默认值**: 0.2 +**默认值**:0.2 ## autovacuum_analyze_scale_factor -**参数说明**: 设置触发一个ANALYZE时增加到autovacuum_analyze_threshold的表大小的缩放系数。 +**参数说明**:设置触发一个ANALYZE时增加到autovacuum_analyze_threshold的表大小的缩放系数。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**浮点型,0.0~100.0 +**取值范围**:浮点型,0.0~100.0 -**默认值**: 0.1 +**默认值**:0.1 ## autovacuum_freeze_max_age -**参数说明**: 设置事务内的最大时间,使得表的pg_class.relfrozenxid字段在VACUUM操作执行之前被写入。 +**参数说明**:设置事务内的最大时间,使得表的pg_class.relfrozenxid字段在VACUUM操作执行之前被写入。 - VACUUM也可以删除pg_clog/子目录中的旧文件。 - 即使自动清理线程被禁止,系统也会调用自动清理线程来防止循环重复。 该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围: 长**整型,100 000~576 460 752 303 423 487 +**取值范围**:长整型,100 000~576 460 752 303 423 487 -**默认值**: 20000000000 +**默认值**:4000000000 ## autovacuum_vacuum_cost_delay -**参数说明**: 设置在自动VACUUM操作里使用的开销延迟数值。 +**参数说明**:设置在自动VACUUM操作里使用的开销延迟数值。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,-1~100,单位为毫秒(ms)。其中-1表示使用常规的vacuum_cost_delay。 +**取值范围**:整型,-1~100,单位为毫秒(ms)。其中-1表示使用常规的vacuum_cost_delay。 -**默认值**: 20ms +**默认值**:20ms ## autovacuum_vacuum_cost_limit -**参数说明**: 设置在自动VACUUM操作里使用的开销限制数值。 +**参数说明**:设置在自动VACUUM操作里使用的开销限制数值。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,-1~10000。其中-1表示使用常规的vacuum_cost_limit。 +**取值范围**:整型,-1~10000。其中-1表示使用常规的vacuum_cost_limit。 -**默认值**: -1 +**默认值**:-1 ## defer_csn_cleanup_time -**参数说明**: 用来指定本地回收时间间隔,单位为毫秒(ms)。 +**参数说明:**用来指定本地回收时间间隔。 + +该参数属于SIGHUP类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~INT_MAX。 +**取值范围:**整型,0~INT_MAX,单位为毫秒(ms)。 -**默认值**: 5s(即5000ms) +**默认值**:5s(即5000ms) 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 1ba03642e55ea97b6dfd0c662558f7e8b5b4044a..bb32b30a82680005ab055aa8b6cd13ed896cd413 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 @@ -11,44 +11,46 @@ date: 2021-04-20 ## search_path -**参数说明**: 当一个被引用对象没有指定模式时,此参数设置模式搜索顺序。它的值由一个或多个模式名构成,不同的模式名用逗号隔开。 +**参数说明:**当一个被引用对象没有指定模式时,此参数设置模式搜索顺序。它的值由一个或多个模式名构成,不同的模式名用逗号隔开。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 - 当前会话如果存放临时表的模式时,可以使用别名pg_temp将它列在搜索路径中,如'pg_temp,public'。存放临时表的模式始终会作为第一个被搜索的对象,排在pg_catalog和search_path中所有模式的前面,即具有第一搜索优先级。建议用户不要在search_path中显示设置pg_temp。如果在search_path中指定了pg_temp,但不是在最前面,系统会提示设置无效,pg_temp仍被优先搜索。通过使用别名pg_temp,系统只会在存放临时表的模式中搜索表、视图和数据类型这样的数据库对象,不会在里面搜索函数或运算符这样的数据库对象。 - 系统表所在的模式pg_catalog,总是排在search_path中指定的所有模式前面被搜索,即具有第二搜索优先级(pg_temp具有第一搜索优先级)。建议用户不要在search_path中显式设置pg_catalog。如果在search_path中指定了pg_catalog,但不是在最前面,系统会提示设置无效,pg_catalog仍被第二优先搜索。 - 当没有指定一个特定模式而创建一个对象时,它们被放置到以search_path为命名的第一个有效模式中。当搜索路径为空时,会报错误。 - 通过SQL函数current_schema可以检测当前搜索路径的有效值。这和检测search_path的值不尽相同,因为current_schema显示search_path中首位有效的模式名称。 -**取值范围:**字符串 +**取值范围:**字符串 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > -> - 设置为"$user",public时,支持共享数据库(没有用户具有私有模式和所有共享使用public),用户私有模式和这些功能的组合使用。可以通过改变默认搜索路径来获得其他效果,无论是全局化的还是私有化的。 -> - 设置为空串(")的时候,系统会自动转换成一对双引号。 +> - 设置为“$user”,public时,支持共享数据库(没有用户具有私有模式和所有共享使用public)、用户私有模式和这些功能的组合使用。可以通过改变默认搜索路径来获得其他效果,无论是全局化的还是私有化的。 +> - 设置为空串(”)的时候,系统会自动转换成一对双引号。 > - 设置的内容中包含双引号,系统会认为是不安全字符,会将每个双引号转换成一对双引号。 -**默认值**: `"$user",public` +**默认值:**“$user”,public -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> `$user`表示与当前会话用户名同名的模式名,如果这样的模式不存在,`$user`将被忽略。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> +> \$user表示与当前会话用户名同名的模式名,如果这样的模式不存在,$user将被忽略。 ## current_schema -**参数说明**: 此参数设置当前的模式。 +**参数说明:**此参数设置当前的模式。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围:**字符串 -**默认值**: `"$user",public` +**默认值:**”$user”,public -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> `$user`表示与当前会话用户名同名的模式名,如果这样的模式不存在,`$user`将被忽略。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> +> \$user表示与当前会话用户名同名的模式名,如果这样的模式不存在,$user将被忽略。 ## default_tablespace -**参数说明**: 当CREATE命令没有明确声明表空间时,所创建对象(表和索引等)的缺省表空间。 +**参数说明:**当CREATE命令没有明确声明表空间时,所创建对象(表和索引等)的缺省表空间。 - 值是一个表空间的名称或者一个表示使用当前数据库缺省表空间的空字符串。若指定的是一个非默认表空间,用户必须具有它的CREATE权限,否则尝试创建会失败。 @@ -56,200 +58,188 @@ date: 2021-04-20 - 创建数据库时不使用此参数。默认情况下,一个新的数据库从模板数据库继承表空间配置。 - 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串,其中空表示使用默认表空间。 - -**默认值**: 空 - -## default_storage_nodegroup + 该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**参数说明**: 此参数设置当前的默认建表所在的Node Group,目前只适用普通表。 +**取值范围:**字符串,其中空表示使用默认表空间。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 - -- 值为"installation"表示建表会默认建在安装的Node Group上。 -- 值为其他字符串表示建表会默认建在设置的Node Group上。 - -**取值范围:**字符串 - -**默认值**: installation +**默认值:**空 ## temp_tablespaces -**参数说明**: 当一个CREATE命令没有明确指定一个表空间时,temp_tablespaces指定了创建临时对象(临时表和临时表的索引)所在的表空间。在这些表空间中创建临时文件用来做大型数据的排序工作。 +**参数说明:**当一个CREATE命令没有明确指定一个表空间时,temp_tablespaces指定了创建临时对象(临时表和临时表的索引)所在的表空间。在这些表空间中创建临时文件用来做大型数据的排序工作。 其值是一系列表空间名的列表。如果列表中有多个表空间时,每次临时对象的创建,MogDB会在列表中随机选择一个表空间;如果在事务中,连续创建的临时对象被放置在列表里连续的表空间中。如果选择的列表中的元素是一个空串,MogDB将自动将当前的数据库设为默认的表空间。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串。空字符串表示所有的临时对象仅在当前数据库默认的表空间中创建,请参见[default_tablespace](#default_tablespace)。 +**取值范围:**字符串。空字符串表示所有的临时对象仅在当前数据库默认的表空间中创建,请参见[default_tablespace](#default_tablespace)。 -**默认值**: 空 +**默认值:**空 ## check_function_bodies -**参数说明**: 设置是否在CREATE FUNCTION执行过程中进行函数体字符串的合法性验证。为了避免产生问题(比如避免从转储中恢复函数定义时向前引用的问题),偶尔会禁用验证。 +**参数说明:**设置是否在CREATE FUNCTION执行过程中进行函数体字符串的合法性验证。为了避免产生问题(比如避免从转储中恢复函数定义时向前引用的问题),偶尔会禁用验证。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围:**布尔型 - on表示在CREATE FUNCTION执行过程中进行函数体字符串的合法性验证。 - off表示在CREATE FUNCTION执行过程中不进行函数体字符串的合法性验证。 -**默认值**: on +**默认值:**on ## default_transaction_isolation -**参数说明**: 设置默认的事务隔离级别。 +**参数说明:**设置默认的事务隔离级别。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围:**枚举类型 - read committed表示事务读已提交。 - repeatable read表示事务可重复读。 - serializable,MogDB目前功能上不支持此隔离级别,等价于repeatable read。 -**默认值**: read committed +**默认值:**read committed ## default_transaction_read_only -**参数说明**: 设置每个新创建事务是否是只读状态。 +**参数说明:**设置每个新创建事务是否是只读状态。 -该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围:**布尔型 - on表示只读状态。 - off表示非只读状态。 -**默认值**: off +**默认值:**off ## default_transaction_deferrable -**参数说明**: 控制每个新事务的默认延迟状态。只读事务或者那些比序列化更加低的隔离级别的事务除外。 +**参数说明:**控制每个新事务的默认延迟状态。只读事务或者那些比序列化更加低的隔离级别的事务除外。 MogDB不支持可串行化的隔离级别,因此,该参数无实际意义。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围:**布尔型 - on表示默认延迟。 - off表示默认不延迟。 -**默认值**: off +**默认值:**off ## session_replication_role -**参数说明**: 控制当前会话与复制相关的触发器和规则的行为。 +**参数说明:**控制当前会话与复制相关的触发器和规则的行为。 -该参数属于SUSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于SUSET类型参数,请参考[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) **须知:**设置此参数会丢弃之前任何缓存的执行计划。 -**取值范围:**枚举类型 +**取值范围:**枚举类型 - origin表示从当前会话中复制插入、删除、更新等操作。 - replica表示从其他地方复制插入、删除、更新等操作到当前会话。 - local表示函数执行复制时会检测当前登录数据库的角色并采取相应的操作。 -**默认值**: origin +**默认值:**origin ## statement_timeout -**参数说明**: 当语句执行时间超过该参数设置的时间(从服务器收到命令时开始计时)时,该语句将会报错并退出执行。 +**参数说明:**当语句执行时间超过该参数设置的时间(从服务器收到命令时开始计时)时,该语句将会报错并退出执行。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0,最大值为2147483647,单位为毫秒。 +**取值范围:**整型,最小值为0,最大值为2147483647,单位为毫秒。 -**默认值**: 0 +**默认值:**0 ## vacuum_freeze_min_age -**参数说明**: 指定VACUUM在扫描一个表时用于判断是否用FrozenXID替换事务ID的中断寿命(在同一个事务中)。 +**参数说明:**指定VACUUM在扫描一个表时用于判断是否用FrozenXID替换事务ID的中断寿命(在同一个事务中)。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~576 460 752 303 423 487 +**取值范围:**整型,0~576 460 752 303 423 487 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> > 尽管随时可以将此参数设为0到10亿之间的任意值,但是,VACUUM将默认其有效值范围限制在autovacuum_freeze_max_age的50%以内。 -**默认值**: 5000000000 +**默认值:**2000000000 ## vacuum_freeze_table_age -**参数说明**: 指定VACUUM对全表的扫描冻结元组的时间。如果表的pg_class.relfrozenxid字段的值已经达到了参数指定的时间,VACUUM对全表进行扫描。 +**参数说明:**指定VACUUM对全表的扫描冻结元组的时间。如果表的pg_class.relfrozenxid字段的值已经达到了参数指定的时间,VACUUM对全表进行扫描。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~576 460 752 303 423 487 +**取值范围:**整型,0~576 460 752 303 423 487 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> > 尽管随时可以将此参数设为零到20亿之间的值,但是,VACUUM将默认其有效值范围限制在autovacuum_freeze_max_age的95%以内。定期的手动VACUUM可以在对此表的反重叠自动清理启动之前运行。 -**默认值**: 15000000000 +**默认值:**15000000000 ## bytea_output -**参数说明**: 设置bytea类型值的输出格式。 +**参数说明:**设置bytea类型值的输出格式。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围:**枚举类型 -- hex: 将二进制数据编码为每字节2位十六进制数字。 -- escape: 传统化的PostgreSQL格式。采用以ASCII字符序列表示二进制串的方法,同时将那些无法表示成ASCII字符的二进制串转换成特殊的转义序列。 +- hex:将二进制数据编码为每字节2位十六进制数字。 +- escape:传统化的PostgreSQL格式。采用以ASCII字符序列表示二进制串的方法,同时将那些无法表示成ASCII字符的二进制串转换成特殊的转义序列。 -**默认值**: hex +**默认值:**hex ## xmlbinary -**参数说明**: 设置二进制值是如何在XML中进行编码的。 +**参数说明:**设置二进制值是如何在XML中进行编码的。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围:**枚举类型 - base64 - hex -**默认值**: base64 +**默认值:**base64 ## xmloption -**参数说明**: 当XML和字符串值之间进行转换时,设置document或content是否是隐含的。 +**参数说明:**当XML和字符串值之间进行转换时,设置document或content是否是隐含的。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围:**枚举类型 -- document: 表示HTML格式的文档。 -- content: 普通的字符串。 +- document:表示HTML格式的文档。 +- content:普通的字符串。 -**默认值**: content +**默认值:**content ## max_compile_functions -**参数说明**: 设置服务器存储的函数编译结果的最大数量。存储过多的函数和存储过程的编译结果可能占用很大内存。将此参数设置为一个合理的值,有助于减少内存占用,提升系统性能。 +**参数说明:**设置服务器存储的函数编译结果的最大数量。存储过多的函数和存储过程的编译结果可能占用很大内存。将此参数设置为一个合理的值,有助于减少内存占用,提升系统性能。 -该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于POSTMASTER类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,取值必须大于等于1。 +**取值范围:**整型,1~ 2147483647。 -**默认值**: 1000 +**默认值:**1000 ## gin_pending_list_limit -**参数说明**: 设置当GIN索引启用fastupdate时,pending list容量的最大值。当pending list的容量大于设置值时,会把pending list中数据批量移动到GIN索引数据结构中以进行清理。单个GIN索引可通过更改索引存储参数覆盖此设置值。 +**参数说明:**设置当GIN索引启用fastupdate时,pending list容量的最大值。当pending list的容量大于设置值时,会把pending list中数据批量移动到GIN索引数据结构中以进行清理。单个GIN索引可通过更改索引存储参数覆盖此设置值。 -该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +该参数属于USERSET类型参数,请参考[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为64,最大值为INT_MAX,单位为KB。 +**取值范围:**整型,最小值为64,最大值为INT_MAX,单位为KB。 -**默认值**: 4MB +**默认值:**4MB 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 6c2b5dc089132484f15ccff4344bcf14a1ac7c49..8cb7ca40365d7754dd19590e4ae60b57e776e07c 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 @@ -11,28 +11,28 @@ date: 2021-04-20 ## DateStyle -**参数说明**: 设置日期和时间值的显示格式,以及有歧义的输入值的解析规则。 +**参数说明**:设置日期和时间值的显示格式,以及有歧义的输入值的解析规则。 这个变量包含两个独立的加载部分: 输出格式声明(ISO、Postgres、SQL、German)和输入输出的年/月/日顺序(DMY、MDY、YMD)。这两个可以独立设置或者一起设置。关键字Euro和European等价于DMY;关键字US、NonEuro、NonEuropean等价于MDY。 该参数属于USERSET类型参数,请**参考表GUC参数设置方式**中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: ISO,MDY +**默认值**:ISO,MDY -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > gs_initdb会将这个参数初始化成与[lc_time](#lc_time)一致的值。 -**设置建议:**优先推荐使用ISO格式。Postgres、SQL和German均采用字母缩写的形式来表示时区,例如"EST、WST、CST"等。这些缩写可同时指代不同的时区,比如CST可同时代表美国中部时间(Central Standard Time (USA)UT-6:00)、澳大利亚中部时间(Central Standard Time(Australia)UT+9:30)、中国标准时间(China Standard Time UT+8:00)、古巴标准时间(Cuba Standard Time UT-4:00)。这种情况下在时区转化时可能会得不到正确的结果,从而引发其他问题。 +**设置建议**:优先推荐使用ISO格式。Postgres、SQL和German均采用字母缩写的形式来表示时区,例如"EST、WST、CST"等。这些缩写可同时指代不同的时区,比如CST可同时代表美国中部时间(Central Standard Time (USA)UT-6:00)、澳大利亚中部时间(Central Standard Time(Australia)UT+9:30)、中国标准时间(China Standard Time UT+8:00)、古巴标准时间(Cuba Standard Time UT-4:00)。这种情况下在时区转化时可能会得不到正确的结果,从而引发其他问题。 ## IntervalStyle -**参数说明**: 设置区间值的显示格式。 +**参数说明**:设置区间值的显示格式。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 - sql_standard表示产生与SQL标准规定匹配的输出。 - postgres表示产生与PostgreSQL 8.4版本相匹配的输出,当[DateStyle](#DateStyle)参数被设为ISO时。 @@ -40,75 +40,75 @@ date: 2021-04-20 - iso_8601表示产生与在ISO 8601中定义的"格式与代号"相匹配的输出。 - a表示与numtodsinterval函数相匹配的输出结果,详细请参考numtodsinterval。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > IntervalStyle参数也会影响不明确的间隔输入的说明。 -**默认值**: postgres +**默认值**:postgres ## TimeZone -**参数说明**: 设置显示和解释时间类型数值时使用的时区。 +**参数说明**:设置显示和解释时间类型数值时使用的时区。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串,可查询视图PG_TIMEZONE_NAMES获得。 +**取值范围**:字符串,可查询视图PG_TIMEZONE_NAMES获得。 -**默认值**: PRC +**默认值**:PRC -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > gs_initdb将设置一个与其系统环境一致的时区值。 ## timezone_abbreviations -**参数说明**: 设置服务器接受的时区缩写值。 +**参数说明**:设置服务器接受的时区缩写值。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串,可查询视图pg_timezone_names获得。 +**取值范围**:字符串,可查询视图pg_timezone_names获得。 -**默认值**: Default +**默认值**:Default -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > Default表示通用时区的缩写, 适合绝大部分情况。但也可设置其他诸如 'Australia' 和 'India' 等用来定义特定的安装。而设置除此之外的时区缩写, 需要在建数据库之前通过相应的配置文件进行设置。 ## extra_float_digits -**参数说明**: 这个参数为浮点数值调整显示的数据位数,浮点类型包括float4、float8 以及几何数据类型。参数值加在标准的数据位数上(FLT_DIG或DBL_DIG中合适的)。 +**参数说明**:这个参数为浮点数值调整显示的数据位数,浮点类型包括float4、float8 以及几何数据类型。参数值加在标准的数据位数上(FLT_DIG或DBL_DIG中合适的)。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,-15~3 +**取值范围**:整型,-15~3 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 设置为3,表示包括部分关键的数据位。这个功能对转储那些需要精确恢复的浮点数据特别有用。 > - 设置为负数,表示消除不需要的数据位。 -**默认值**: 0 +**默认值**:0 ## client_encoding -**参数说明**: 设置客户端的字符编码类型。 +**参数说明**:设置客户端的字符编码类型。 请根据前端业务的情况确定。尽量客户端编码和服务器端编码一致,提高效率。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**兼容PostgreSQL所有的字符编码类型。其中UTF8表示使用数据库的字符编码类型。 +**取值范围**:兼容PostgreSQL所有的字符编码类型。其中UTF8表示使用数据库的字符编码类型。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 使用命令locale -a查看当前系统支持的区域和相应的编码格式,并可以选择进行设置。 > - 默认情况下,gs_initdb会根据当前的系统环境初始化此参数,通过locale命令可以查看当前的配置环境。 > - 参数建议保持默认值,不建议通过gs_guc工具或其他方式直接在postgresql.conf文件中设置client_encoding参数,即使设置也不会生效,以保证MogDB内部通信编码格式一致。 -**默认值**: UTF8 +**默认值**:UTF8 **推荐值:**SQL_ASCII/UTF8 ## lc_messages -**参数说明**: 设置信息显示的语言。 +**参数说明**:设置信息显示的语言。 - 可接受的值是与系统相关的。 @@ -116,63 +116,63 @@ date: 2021-04-20 该参数属于SUSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 使用命令locale -a查看当前系统支持的区域和相应的编码格式,并可以选择进行设置。 > - 默认情况下,gs_initdb会根据当前的系统环境初始化此参数,通过locale命令可以查看当前的配置环境。 -**默认值**: C +**默认值**:C ## lc_monetary -**参数说明**: 设置货币值的显示格式,影响to_char之类的函数的输出。可接受的值是系统相关的。 +**参数说明**:设置货币值的显示格式,影响to_char之类的函数的输出。可接受的值是系统相关的。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 使用命令locale -a查看当前系统支持的区域和相应的编码格式,并可以选择进行设置。 > - 默认情况下,gs_initdb会根据当前的系统环境初始化此参数,通过locale命令可以查看当前的配置环境。 -**默认值**: C +**默认值**:C ## lc_numeric -**参数说明**: 设置数值的显示格式,影响to_char之类的函数的输出。可接受的值是系统相关的。 +**参数说明**:设置数值的显示格式,影响to_char之类的函数的输出。可接受的值是系统相关的。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 使用命令locale -a查看当前系统支持的区域和相应的编码格式,并可以选择进行设置。 > - 默认情况下,gs_initdb会根据当前的系统环境初始化此参数,通过locale命令可以查看当前的配置环境。 -**默认值**: C +**默认值**:C ## lc_time -**参数说明**: 设置时间和区域的显示格式,影响to_char之类的函数的输出。可接受的值是系统相关的。 +**参数说明**:设置时间和区域的显示格式,影响to_char之类的函数的输出。可接受的值是系统相关的。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 使用命令locale -a查看当前系统支持的区域和相应的编码格式,并可以选择进行设置。 > - 默认情况下,gs_initdb会根据当前的系统环境初始化此参数,通过locale命令可以查看当前的配置环境。 -**默认值**: C +**默认值**:C ## default_text_search_config -**参数说明**: 设置全文检索的配置信息。 +**参数说明**:设置全文检索的配置信息。 如果设置为不存在的文本搜索配置时将会报错。如果default_text_search_config对应的文本搜索配置被删除,需要重新设置default_text_search_config,否则会报设置错误。 @@ -182,9 +182,9 @@ date: 2021-04-20 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > MogDB支持pg_catalog.english,pg_catalog.simple两种配置。 -**默认值**: pg_catalog.english +**默认值**: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 e5abb7a17c020686e6949ddd0f443e89c42ee881..fb26b167e60a923085a5874f0d821230b84ed306 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 @@ -11,7 +11,7 @@ date: 2021-04-20 ## dynamic_library_path -**参数说明**: 设置数据查找动态加载的共享库文件的路径。当需要打开一个可以动态装载的模块并且在CREATE FUNCTION或LOAD命令里面声明的名称没有目录部分时,系统将搜索这个目录以查找声明的文件。 +**参数说明**:设置数据查找动态加载的共享库文件的路径。当需要打开一个可以动态装载的模块并且在CREATE FUNCTION或LOAD命令里面声明的名称没有目录部分时,系统将搜索这个目录以查找声明的文件。 用于dynamic_library_path的数值必须是一个冒号分隔的绝对路径列表。当一个路径名称以特殊变量\$libdir为开头时,会替换为MogDB发布提供的模块安装路径。例如: @@ -23,24 +23,24 @@ dynamic_library_path = '/usr/local/lib/gaussdb:/opt/testgs/lib:$libdir' **取值范围**字符串 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > 设置为空字符串,表示关闭自动路径搜索。 -**默认值**: `$libdir` +**默认值**: `$libdir` ## gin_fuzzy_search_limit -**参数说明**: 设置GIN索引返回的集合大小的上限。 +**参数说明**:设置GIN索引返回的集合大小的上限。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~2147483647 +**取值范围**:整型,0~2147483647 -**默认值**: 0 +**默认值**:0 ## local_preload_libraries -**参数说明**: 指定一个或多个共享库,它们在开始连接前预先加载。多个加载库之间用逗号分隔,除了双引号,所有的库名都转换为小写。 +**参数说明**:指定一个或多个共享库,它们在开始连接前预先加载。多个加载库之间用逗号分隔,除了双引号,所有的库名都转换为小写。 - 并非只有系统管理员才能更改此选项,因此只能加载安装的标准库目录下plugins子目录中的库文件,数据库管理员有责任确保该目录中的库都是安全的。local_preload_libraries中指定的项可以明确含有该目录,例如`$libdir/plugins/mylib`; 也可以仅指定库的名称,例如mylib(等价于`$libdir/plugins/mylib`)。 - 与shared_preload_libraries不同,在会话开始之前加载模块与在会话中使用到该模块的时候临时加载相比并不具有性能优势。相反,这个特性的目的是为了调试或者测量在特定会话中不明确使用LOAD加载的库。例如针对某个用户将该参数设为ALTER USER SET来进行调试。 @@ -49,6 +49,6 @@ dynamic_library_path = '/usr/local/lib/gaussdb:/opt/testgs/lib:$libdir' 该参数属于BACKEND类型参数,请参考表[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 5c21e89e641bce95e537d5bb4076742aad02db82..56f81902ec49c343e3968f71e0fe218f4aa26960 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 @@ -11,40 +11,40 @@ date: 2021-04-20 ## deadlock_timeout -**参数说明**: 设置死锁超时检测时间,以毫秒为单位。当申请的锁超过设定值时,系统会检查是否产生了死锁。 +**参数说明**:设置死锁超时检测时间,以毫秒为单位。当申请的锁超过设定值时,系统会检查是否产生了死锁。 - 死锁的检查代价是比较高的,服务器不会在每次等待锁的时候都运行这个过程。在系统运行过程中死锁是不经常出现的,因此在检查死锁前只需等待一个相对较短的时间。增加这个值就减少了无用的死锁检查浪费的时间,但是会减慢真正的死锁错误报告的速度。在一个负载过重的服务器上,用户可能需要增大它。这个值的设置应该超过事务持续时间,这样就可以减少在锁释放之前就开始死锁检查的问题。 - 如果要通过设置log_lock_waits来将查询执行过程中的锁等待耗时信息写入日志,请确保log_lock_waits的设置值小于deadlock_timeout的设置值(或默认值)。 该参数属于SUSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~2147483647,单位为毫秒(ms)。 +**取值范围**:整型,1~2147483647,单位为毫秒(ms)。 -**默认值**: 1s +**默认值**:1s ## lockwait_timeout -**参数说明**: 控制单个锁的最长等待时间。当申请的锁等待时间超过设定值时,系统会报错。 +**参数说明**:控制单个锁的最长等待时间。当申请的锁等待时间超过设定值时,系统会报错。 该参数属于SUSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0 ~ INT_MAX,单位为毫秒(ms)。 +**取值范围**:整型,0 ~ INT_MAX,单位为毫秒(ms)。 -**默认值**: 20min +**默认值**:20min ## update_lockwait_timeout -**参数说明**: 允许并发更新参数开启情况下,该参数控制并发更新同一行时单个锁的最长等待时间。当申请的锁等待时间超过设定值时,系统会报错。 +**参数说明**:允许并发更新参数开启情况下,该参数控制并发更新同一行时单个锁的最长等待时间。当申请的锁等待时间超过设定值时,系统会报错。 该参数属于SUSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0 ~ INT_MAX,单位为毫秒(ms)。 +**取值范围**:整型,0 ~ INT_MAX,单位为毫秒(ms)。 -**默认值**: 2min +**默认值**:2min ## max_locks_per_transaction -**参数说明**: 控制每个事务能够得到的平均的对象锁的数量。 +**参数说明**:控制每个事务能够得到的平均的对象锁的数量。 - 共享的锁表的大小是以假设任意时刻最多只有max_locks_per_transaction*(max_connections+max_prepared_transactions) 个独立的对象需要被锁住为基础进行计算的。不超过设定数量的多个对象可以在任一时刻同时被锁定。当在一个事务里面修改很多不同的表时,可能需要提高这个默认数值。只能在数据库启动的时候设置。 - 增大这个参数可能导致MogDB请求更多的System V共享内存,有可能超过操作系统的缺省配置。 @@ -52,39 +52,39 @@ date: 2021-04-20 该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,10 ~ INT_MAX +**取值范围**:整型,10 ~ INT_MAX -**默认值**: 256 +**默认值**:256 ## max_pred_locks_per_transaction -**参数说明**: 控制每个事务允许断定锁的最大数量,是一个平均值。 +**参数说明**:控制每个事务允许断定锁的最大数量,是一个平均值。 - 共享的断定锁表的大小是以假设任意时刻最多只有max_pred_locks_per_transaction*(max_connections+max_prepared_transactions) 个独立的对象需要被锁住为基础进行计算的。不超过设定数量的多个对象可以在任一时刻同时被锁定。当在一个事务里面修改很多不同的表时,可能需要提高这个默认数值。只能在服务器启动的时候设置。 - 增大这个参数可能导致MogDB请求更多的System V共享内存,有可能超过操作系统的缺省配置。 该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,10 ~ INT_MAX +**取值范围**:整型,10 ~ INT_MAX -**默认值**: 64 +**默认值**:64 ## gs_clean_timeout -**参数说明**: 控制主节点周期性清理临时表的时间,是一个平均值。 +**参数说明**:控制主节点周期性清理临时表的时间,是一个平均值。 - 数据库连接异常终止时,通常会有临时表残留,此时需要对数据库中的临时表进行清理。 - 增大这个参数可能导致MogDB临时表清理时间延长。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0 ~ 2147483,单位为秒(s)。 +**取值范围**:整型,0 ~ 2147483,单位为秒(s)。 -**默认值**: 1min +**默认值**:1min ## partition_lock_upgrade_timeout -**参数说明**: 在执行某些查询语句的过程中,会需要将分区表上的锁级别由允许读的ExclusiveLock级别升级到读写阻塞的AccessExclusiveLock级别。如果此时已经存在并发的读事务,那么该锁升级操作将阻塞等待。partition_lock_upgrade_timeout为尝试锁升级的等待超时时间。 +**参数说明**:在执行某些查询语句的过程中,会需要将分区表上的锁级别由允许读的ExclusiveLock级别升级到读写阻塞的AccessExclusiveLock级别。如果此时已经存在并发的读事务,那么该锁升级操作将阻塞等待。partition_lock_upgrade_timeout为尝试锁升级的等待超时时间。 - 在分区表上进行MERGE PARTITION和CLUSTER PARTITION操作时,都利用了临时表进行数据重排和文件交换,为了最大程度提高分区上的操作并发度,在数据重排阶段给相关分区加锁ExclusiveLock,在文件交换阶段加锁AccessExclusiveLock。 @@ -96,30 +96,30 @@ date: 2021-04-20 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,最小值-1,最大值3000,单位为秒(s)。 +**取值范围**:整型,最小值-1,最大值3000,单位为秒(s)。 -**默认值**: 1800 +**默认值**:1800 ## fault_mon_timeout -**参数说明**: 轻量级死锁检测周期。该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 +**参数说明**:轻量级死锁检测周期。该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,最小值0,最大值1440,单位为分钟(min) +**取值范围**:整型,最小值0,最大值1440,单位为分钟(min) -**默认值**: 5min +**默认值**:5min ## enable_online_ddl_waitlock -**参数说明**: 控制DDL是否会阻塞等待pg_advisory_lock/pgxc_lock_for_backup等MogDB锁。主要用于OM在线操作场景,不建议用户设置。 +**参数说明**:控制DDL是否会阻塞等待pg_advisory_lock/pgxc_lock_for_backup等MogDB锁。主要用于OM在线操作场景,不建议用户设置。 该参数属于SIGHUP类型参数,参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示开启。 - off表示关闭。 -**默认值**: off +**默认值**:off ## xloginsert_locks @@ -133,7 +133,7 @@ date: 2021-04-20 ## num_internal_lock_partitions -**参数说明**: 控制内部轻量级锁分区的个数。主要用于各类场景的性能调优。内容以关键字和数字的KV方式组织,各个不同类型锁之间以逗号隔开。先后顺序对设置结果不影响,例如“CLOG_PART=256,CSNLOG_PART=512”等同于“CSNLOG_PART=512,CLOG_PART=256”。重复设置同一关键字时,以最后一次设置为准,例如“CLOG_PART=256,CLOG_PART=2”,设置的结果为CLOG_PART=2。当没有设置关键字时,则为默认值,各类锁的使用描述和最大、最小、默认值如下。 +**参数说明**:控制内部轻量级锁分区的个数。主要用于各类场景的性能调优。内容以关键字和数字的KV方式组织,各个不同类型锁之间以逗号隔开。先后顺序对设置结果不影响,例如“CLOG_PART=256,CSNLOG_PART=512”等同于“CSNLOG_PART=512,CLOG_PART=256”。重复设置同一关键字时,以最后一次设置为准,例如“CLOG_PART=256,CLOG_PART=2”,设置的结果为CLOG_PART=2。当没有设置关键字时,则为默认值,各类锁的使用描述和最大、最小、默认值如下。 - CLOG_PART:CLOG文件控制器的个数。增大该值可以提高CLOG日志写入效率,提升事务提交性能,但是会增大内存使用;减小该值会减少相应内存使用,但可能使得CLOG日志写入冲突变大,影响性能。最小值为1,最大值为256。 - CSNLOG_PART:CSNLOG文件控制器的个数。增大该值可以提高CSNLOG日志写入效率,提升事务提交性能,但是会增大内存使用;减小该值会减少相应内存使用,但可能使得CSNLOG日志写入冲突变大,影响性能。最小值为1,最大值为512。 @@ -142,7 +142,7 @@ date: 2021-04-20 该参数属于POSTMASTER类型参数,参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串 +**取值范围**:字符串 **默认值**: 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 bbb335211d88f564c532f7acb57310271be318b1..4f3fe8de6207b35cb93c710185670c6269d3c301 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 @@ -11,123 +11,123 @@ MogDB介绍数据库的向下兼容性和对外兼容性特性的参数控制。 ## array_nulls -**参数说明**: 控制数组输入解析器是否将未用引用的NULL识别为数组的一个NULL元素。 +**参数说明**:控制数组输入解析器是否将未用引用的NULL识别为数组的一个NULL元素。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许向数组中输入空元素。 - off表示向下兼容旧式模式。仍然能够创建包含NULL值的数组。 -**默认值**: on +**默认值**:on ## backslash_quote -**参数说明**: 控制字符串文本中的单引号是否能够用\'表示。 +**参数说明**:控制字符串文本中的单引号是否能够用\'表示。 该参数属于USERSET类型参数,请参考表[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) **须知**: > 在字符串文本符合SQL标准的情况下,\\没有任何其他含义。这个参数影响的是如何处理不符合标准的字符串文本,包括明确的字符串转义语法是(E'…')。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 - on表示一直允许使用\'表示。 - off表示拒绝使用\'表示。 - safe_encoding表示仅在客户端字符集编码不会在多字节字符末尾包含\\的ASCII值时允许。 -**默认值**: safe_encoding +**默认值**:safe_encoding ## escape_string_warning -**参数说明**: 警告在普通字符串中直接使用反斜杠转义。 +**参数说明**:警告在普通字符串中直接使用反斜杠转义。 - 如果需要使用反斜杠作为转义,可以调整为使用转义字符串语法(E'…')来做转义,因为在每个SQL标准中,普通字符串的默认行为现在将反斜杠作为一个普通字符。 - 这个变量可以帮助定位需要改变的代码。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 -**默认值**: on +**默认值**:on ## lo_compat_privileges -**参数说明**: 控制是否启动对大对象权限检查的向后兼容模式。 +**参数说明**:控制是否启动对大对象权限检查的向后兼容模式。 该参数属于SUSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 on表示当读取或修改大对象时禁用权限检查,与PostgreSQL 9.0以前的版本兼容。 -**默认值**: off +**默认值**:off ## 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)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开强制引用。 - off表示关闭强制引用。 -**默认值**: off +**默认值**:off ## sql_inheritance -**参数说明**: 控制继承语义。用来控制继承表的访问策略,off表示各种命令不能访问子表,即默认使用ONLY关键字。这是为了兼容旧版本而设置的。 +**参数说明**:控制继承语义。用来控制继承表的访问策略,off表示各种命令不能访问子表,即默认使用ONLY关键字。这是为了兼容旧版本而设置的。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示可以访问子表。 - off表示不访问子表。 -**默认值**: on +**默认值**:on ## standard_conforming_strings -**参数说明**: 控制普通字符串文本('…')中是否按照SQL标准把反斜扛当普通文本。 +**参数说明**:控制普通字符串文本('…')中是否按照SQL标准把反斜扛当普通文本。 - 应用程序通过检查这个参数可以判断字符串文本的处理方式。 - 建议明确使用转义字符串语法(E'…')来转义字符。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开控制功能。 - off表示关闭控制功能。 -**默认值**: on +**默认值**:on ## synchronize_seqscans -**参数说明**: 控制启动同步的顺序扫描。在大约相同的时间内并行扫描读取相同的数据块,共享I/O负载。 +**参数说明**:控制启动同步的顺序扫描。在大约相同的时间内并行扫描读取相同的数据块,共享I/O负载。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示扫描可能从表的中间开始,然后选择"环绕"方式来覆盖所有的行,为了与已经在进行中的扫描活动同步。这可能会造成没有用ORDER BY子句的查询得到行排序造成不可预测的后果。 - off表示确保顺序扫描是从表头开始的。 -**默认值**: on +**默认值**:on ## enable_beta_features -**参数说明**: 控制开启某些非正式发布的特性,仅用于POC验证。这些特性属于延伸特性,建议客户谨慎开启,在某些功能场景下可能存在问题。 +**参数说明**:控制开启某些非正式发布的特性,仅用于POC验证。这些特性属于延伸特性,建议客户谨慎开启,在某些功能场景下可能存在问题。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启这些功能受限的特性,保持前向兼容。但某些场景可能存在功能上的问题。 - off表示禁止使用这些特性。 -**默认值**: off +**默认值**:off 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 4c192bdba612eb647fb160d2f634a831668db2cc..ee4eab408d9e1c1da257be497566f5f428362d6d 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 @@ -15,7 +15,7 @@ date: 2021-04-20 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示优先将字符串转为数字。 - off表示不优先将字符串转为数字。 @@ -46,47 +46,47 @@ date: 2021-04-20 ## transform_null_equals -**参数说明**: 控制表达式expr = NULL(或NULL = expr)当做expr IS NULL处理。如果expr得出NULL值则返回真,否则返回假。 +**参数说明**:控制表达式expr = NULL(或NULL = expr)当做expr IS NULL处理。如果expr得出NULL值则返回真,否则返回假。 - 正确的SQL标准兼容的expr = NULL总是返回NULL(未知)。 - Microsoft Access里的过滤表单生成的查询使用expr = NULL来测试空值。打开这个选项,可以使用该接口来访问数据库。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示控制表达式expr = NULL(或NULL = expr)当做expr IS NULL处理。 - off表示不控制,即expr = NULL总是返回NULL(未知)。 -**默认值**: off +**默认值**:off > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 新用户经常在涉及NULL的表达式上语义混淆,故默认值设为off。 ## support_extended_features -**参数说明**: 控制是否支持数据库的扩展特性。 +**参数说明**:控制是否支持数据库的扩展特性。 该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示支持数据库的扩展特性。 - off表示不支持数据库的扩展特性。 -**默认值**: off +**默认值**:off ## sql_compatibility -**参数说明**: 控制数据库的SQL语法和语句行为同哪一个主流数据库兼容。该参数属于INTERNAL类型参数,用户无法修改,只能查看。 +**参数说明**:控制数据库的SQL语法和语句行为同哪一个主流数据库兼容。该参数属于INTERNAL类型参数,用户无法修改,只能查看。 -**取值范围**: 枚举型 +**取值范围**:枚举型 - A表示同O数据库兼容。 - B表示同MY数据库兼容。 - C表示同TD数据库兼容。 - PG表示同POSTGRES数据库兼容。 -**默认值**: A +**默认值**:A > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > @@ -95,13 +95,13 @@ date: 2021-04-20 ## behavior_compat_options -**参数说明**: 数据库兼容性行为配置项,该参数的值由若干个配置项用逗号隔开构成。 +**参数说明**:数据库兼容性行为配置项,该参数的值由若干个配置项用逗号隔开构成。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > @@ -141,28 +141,28 @@ date: 2021-04-20 ## td_compatible_truncation -**参数说明**: 控制是否开启与Teradata数据库相应兼容的特征。该参数在用户连接上与TD兼容的数据库时,可以将参数设置成为on(即超长字符串自动截断功能启用),该功能启用后,在后续的insert语句中,对目标表中char和varchar类型的列插入超长字符串时,会按照目标表中相应列定义的最大长度对超长字符串进行自动截断。保证数据都能插入目标表中,而不是报错。 +**参数说明**:控制是否开启与Teradata数据库相应兼容的特征。该参数在用户连接上与TD兼容的数据库时,可以将参数设置成为on(即超长字符串自动截断功能启用),该功能启用后,在后续的insert语句中,对目标表中char和varchar类型的列插入超长字符串时,会按照目标表中相应列定义的最大长度对超长字符串进行自动截断。保证数据都能插入目标表中,而不是报错。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 超长字符串自动截断功能不适用于insert语句包含外表的场景。 如果向字符集为字节类型编码(SQL_ASCII,LATIN1等)的数据库中插入多字节字符数据(如汉字等),且字符数据跨越截断位置,这种情况下,按照字节长度自动截断,自动截断后会在尾部产生非预期结果。如果用户有对于截断结果正确性的要求,建议用户采用UTF8等能够按照字符截断的输入字符集作为数据库的编码集。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示启动超长字符串自动截断功能。 - off表示停止超长字符串自动截断功能。 -**默认值**: off +**默认值**:off ## lastval_supported -**参数说明**: 控制是否可以使用lastval函数。 +**参数说明**:控制是否可以使用lastval函数。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示支持lastval函数,同时nextval函数不支持下推。 - off表示不支持lastval函数,同时nextval函数可以下推。 -**默认值**: off +**默认值**:off 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 3b529c838538b6a950d9e5721ce83698645b9950..9190702f990dc8da4c2d6ab00bbb2246ce35ff2e 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 @@ -11,24 +11,24 @@ date: 2021-04-20 ## exit_on_error -**参数说明**: 打开该开关,ERROR级别报错会升级为PANIC报错,从而可以产生core堆栈。主要用于问题定位和业务测试。 +**参数说明**:打开该开关,ERROR级别报错会升级为PANIC报错,从而可以产生core堆栈。主要用于问题定位和业务测试。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示ERROR级别报错会升级为PANIC报错。 - off表示不会对ERROR级别报错进行升级。 -**默认值**: off +**默认值**:off ## restart_after_crash -**参数说明**: 设置为on,后端进程崩溃时,MogDB将自动重新初始化此后端进程。 +**参数说明**:设置为on,后端进程崩溃时,MogDB将自动重新初始化此后端进程。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示能够最大限度地提高数据库的可用性。 @@ -36,63 +36,63 @@ date: 2021-04-20 - off表示能够使得管理工具在后端进程崩溃时获取控制权并采取适当的措施进行处理。 -**默认值**: on +**默认值**:on ## omit_encoding_error -**参数说明**: 设置为on,数据库的客户端字符集编码为UTF-8时,出现的字符编码转换错误将打印在日志中,有转换错误的被转换字符会被忽略,以“?”代替。 +**参数说明**:设置为on,数据库的客户端字符集编码为UTF-8时,出现的字符编码转换错误将打印在日志中,有转换错误的被转换字符会被忽略,以“?”代替。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示有转换错误的字符将被忽略,以"?"代替,打印错误信息到日志中。 - off表示有转换错误的字符不能被转换,打印错误信息到终端。 -**默认值**: 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)中对应设置方法进行设置。 -**取值范围:**整型,0~20。 +**取值范围**:整型,0~20。 -**默认值**: 0 +**默认值**:0 ## cn_send_buffer_size -**参数说明**: 指定数据库主节点发送数据缓存区的大小。 +**参数说明**:指定数据库主节点发送数据缓存区的大小。 该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,8~128, 单位为KB。 +**取值范围**:整型,8~128, 单位为KB。 -**默认值**: 8KB +**默认值**:8KB ## retry_ecode_list -**参数说明**: 指定SQL语句出错自动重试功能支持的错误类型列表。 +**参数说明**:指定SQL语句出错自动重试功能支持的错误类型列表。 该参数属于USERSET类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串。 +**取值范围**:字符串。 -**默认值**: YY001 YY002 YY003 YY004 YY005 YY006 YY007 YY008 YY009 YY010 YY011 YY012 YY013 YY014 YY015 53200 08006 08000 57P01 XX003 XX009 YY016 +**默认值**:YY001 YY002 YY003 YY004 YY005 YY006 YY007 YY008 YY009 YY010 YY011 YY012 YY013 YY014 YY015 53200 08006 08000 57P01 XX003 XX009 YY016 ## data_sync_retry -**参数说明**: 控制当fsync到磁盘失败后是否继续运行数据库。由于在某些操作系统的场景下,fsync失败后重试阶段即使再次fsync失败也不会报错,从而导致数据丢失。 +**参数说明**:控制当fsync到磁盘失败后是否继续运行数据库。由于在某些操作系统的场景下,fsync失败后重试阶段即使再次fsync失败也不会报错,从而导致数据丢失。 该参数属于POSTMASTER类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示当fsync同步到磁盘失败后采取重试机制,数据库继续运行。 - off表示当fsync同步到磁盘失败后直接报panic,停止数据库。 -**默认值**: off +**默认值**:off ## remote_read_mode 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 b257330b6342026486ccdfc910a819b22195ed4d..94f862ceab43d25faf42e4a6b6f557af285c259a 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 @@ -11,13 +11,13 @@ date: 2021-04-20 ## cache_connection -**参数说明**: 是否回收连接池的连接。 +**参数说明**:是否回收连接池的连接。 该参数属于SIGHUP类型参数,请参考表[GUC参数设置方式](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示回收连接池的连接。 - off表示不回收连接池的连接。 -**默认值**: on +**默认值**:on diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/2-file-location.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/2-file-location.md index d9b660ca61f0f62621061a4a1cc8bc37646f0016..bf8954067949eb33a9615d805083cd0a5fac5d94 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/2-file-location.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/2-file-location.md @@ -11,59 +11,58 @@ date: 2021-04-20 修改任意一个配置文件的存放目录时,postgresql.conf里的data_directory参数必须设置为实际数据目录(data)。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > 考虑到配置文件修改一旦出错对数据库的影响很大,不建议安装后再修改本节的配置文件。 ## data_directory -**参数说明**: 设置MogDB的数据目录(data目录)。此参数可以通过如下方式指定。 +**参数说明**:设置MogDB的数据目录(data目录)。此参数可以通过如下方式指定。 - 在安装MogDB时指定。 - 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串,长度大于0 +**取值范围**:字符串,长度大于0 -**默认值**: 安装时指定,如果在安装时不指定,则默认不初始化数据库。 +**默认值**:安装时指定,如果在安装时不指定,则默认不初始化数据库。 ## config_file -**参数说明**: 设置主服务器配置文件名称(postgresql.conf)。 +**参数说明**:设置主服务器配置文件名称(postgresql.conf)。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置,不支持使用表[GUC参数设置方式](30-appendix)中的方式四进行修改。 -**取值范围:**字符串,长度大于0 +**取值范围**:字符串,长度大于0 -**默认值**: postgresql.conf(实际安装可能带有绝对目录) +**默认值**:postgresql.conf(实际安装可能带有绝对目录) ## hba_file -**参数说明**: 设置基于主机认证(HBA)的配置文件(pg_hba.conf)。此参数只能在配置文件postgresql.conf中指定。 +**参数说明**:设置基于主机认证(HBA)的配置文件(pg_hba.conf)。此参数只能在配置文件postgresql.conf中指定。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: pg_hba.conf(实际安装可能带有绝对目录) +**默认值**:pg_hba.conf(实际安装可能带有绝对目录) ## ident_file -**参数说明**: 设置用于客户端认证的配置文件的名称(pg_ident.conf)。 +**参数说明**:设置用于客户端认证的配置文件的名称(pg_ident.conf)。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: pg_ident.conf(实际安装可能带有绝对目录) +**默认值**:pg_ident.conf(实际安装可能带有绝对目录) ## external_pid_file -**参数说明**: 声明可被服务器管理程序使用的额外PID文件。 +**参数说明**:声明可被服务器管理程序使用的额外PID文件。 该参数属于POSTMASTER类型参数,请参考表[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) **须知**:这个参数只能在数据库服务重新启动后生效。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 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 972ebf0d376896a08b7e7e1369239e95bc1f2bab..95461dd93b106796650ed6c86d78c83ce5d5d293 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 @@ -11,112 +11,112 @@ date: 2021-04-20 ## transaction_isolation -**参数说明**: 设置当前事务的隔离级别。 +**参数说明**:设置当前事务的隔离级别。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串,只识别以下字符串,大小写空格敏感: +**取值范围**:字符串,只识别以下字符串,大小写空格敏感: - serializable: MogDB中等价于REPEATABLE READ。 - read committed: 只能读取已提交的事务的数据(缺省),不能读取到未提交的数据。 - repeatable read: 仅能读取事务开始之前提交的数据,不能读取未提交的数据以及在事务执行期间由其它并发事务提交的修改。 - default: 设置为default_transaction_isolation所设隔离级别。 -**默认值**: read committed +**默认值**:read committed ## transaction_read_only -**参数说明**: 设置当前事务是只读事务。 +**参数说明**:设置当前事务是只读事务。 该参数在数据库恢复过程中或者在备机里,固定为on;否则,固定为default_transaction_read_only的值。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示设置当前事务为只读事务。 - off表示该事务可以是非只读事务。 -**默认值**: off +**默认值**:off ## xc_maintenance_mode -**参数说明**: 设置系统进入维护模式。 +**参数说明**:设置系统进入维护模式。 该参数属于SUSET类型参数,仅支持表[GUC参数分类](30-appendix)中的方式三进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示该功能启用。 - off表示该功能被禁用。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > > 谨慎打开这个开关,避免引起MogDB数据不一致。 -**默认值**: off +**默认值**:off ## allow_concurrent_tuple_update -**参数说明**: 设置是否允许并发更新。 +**参数说明**:设置是否允许并发更新。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示该功能启用。 - off表示该功能被禁用。 -**默认值**: on +**默认值**:on ## transaction_deferrable -**参数说明**: 指定是否允许一个只读串行事务延迟执行,使其不会执行失败。该参数设置为on时,当一个只读事务发现读取的元组正在被其他事务修改,则延迟该只读事务直到其他事务修改完成。目前,MogDB暂时未用到这个参数。与该参数类似的还有一个default_transaction_deferrable,设置它来指定一个事务是否允许延迟。 +**参数说明**:指定是否允许一个只读串行事务延迟执行,使其不会执行失败。该参数设置为on时,当一个只读事务发现读取的元组正在被其他事务修改,则延迟该只读事务直到其他事务修改完成。目前,MogDB暂时未用到这个参数。与该参数类似的还有一个default_transaction_deferrable,设置它来指定一个事务是否允许延迟。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许执行。 - off表示不允许执行。 -**默认值**: off +**默认值**:off ## enable_show_any_tuples -**参数说明**: 该参数只有在只读事务中可用,用于分析。当这个参数被置为on/true时,表中元组的所有版本都会可见。 +**参数说明**:该参数只有在只读事务中可用,用于分析。当这个参数被置为on/true时,表中元组的所有版本都会可见。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on/true表示表中元组的所有版本都会可见。 - off/false表示表中元组的所有版本都不可见。 -**默认值**: off +**默认值**:off ## replication_type -**参数说明**: 标记当前HA模式是单主机模式、主备从模式还是一主多备模式。 +**参数说明**:标记当前HA模式是单主机模式、主备从模式还是一主多备模式。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 该参数用户不能自己去设置参数值。 -**取值范围:**0~2 +**取值范围**:0~2 - 2 表示单主机模式,此模式无法扩展备机。 - 1 表示使用一主多备模式,全场景覆盖,推荐使用。 - 0 表示主备从模式,目前此模式暂不支持。 -**默认值**: 1 +**默认值**:1 ## pgxc_node_name -**参数说明**: 指定节点名称。 +**参数说明**:指定节点名称。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。此参数修改后会导致连接数据库实例失败,不建议进行修改。 -**取值范围**: 字符串 +**取值范围**:字符串 -**默认值**: 当前节点名称 +**默认值**:当前节点名称 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 a9b146af79b20c83aa69e7067765607ded788739..5f7bd17fa73dc4376a961462dd5fa7c9ffb79d27 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 @@ -9,272 +9,272 @@ date: 2021-04-20 ## allow_system_table_mods -**参数说明**: 设置是否允许修改系统表的结构。 +**参数说明**:设置是否允许修改系统表的结构。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 不建议修改该参数默认值,如果设置为on,可能导致系统表损坏,甚至数据库无法启动。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许修改系统表的结构。 - off表示不允许修改系统表的结构。 -**默认值**: off +**默认值**:off ## debug_assertions -**参数说明**: 控制打开各种断言检查。能够协助调试,当遇到奇怪的问题或者崩溃,请把此参数打开,因为它能暴露编程的错误。要使用这个参数,必须在编译MogDB的时候定义宏USE_ASSERT_CHECKING(通过configure选项 -enable-cassert完成)。 +**参数说明**:控制打开各种断言检查。能够协助调试,当遇到奇怪的问题或者崩溃,请把此参数打开,因为它能暴露编程的错误。要使用这个参数,必须在编译MogDB的时候定义宏USE_ASSERT_CHECKING(通过configure选项 -enable-cassert完成)。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开断言检查。 - off表示不打开断言检查。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > 当启用断言选项编译MogDB时,debug_assertions缺省值为on 。 -**默认值**: off +**默认值**:off ## ignore_checksum_failure -**参数说明**: 设置读取数据时是否忽略校验信息检查失败(但仍然会告警),继续执行可能导致崩溃,传播或隐藏损坏数据,无法从远程节点恢复数据及其他严重问题。不建议用户修改设置。 +**参数说明**:设置读取数据时是否忽略校验信息检查失败(但仍然会告警),继续执行可能导致崩溃,传播或隐藏损坏数据,无法从远程节点恢复数据及其他严重问题。不建议用户修改设置。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示忽略数据校验错误。 - off表示数据校验错误正常报错。 -**默认值**: off +**默认值**:off ## ignore_system_indexes -**参数说明**: 读取系统表时忽略系统索引(但是修改系统表时依然同时修改索引)。 +**参数说明**:读取系统表时忽略系统索引(但是修改系统表时依然同时修改索引)。 该参数属于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) **须知**: > > 这个参数在从系统索引被破坏的表中恢复数据的时候非常有用。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示忽略系统索引。 - off表示不忽略系统索引。 -**默认值**: off +**默认值**:off ## post_auth_delay -**参数说明**: 在认证成功后,延迟指定时间,启动服务器连接。允许调试器附加到启动进程上。 +**参数说明**:在认证成功后,延迟指定时间,启动服务器连接。允许调试器附加到启动进程上。 该参数属于BACKEND类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0,最大值为2147,单位为秒。 +**取值范围**:整型,最小值为0,最大值为2147,单位为秒。 -**默认值**: 0 +**默认值**:0 ## pre_auth_delay -**参数说明**: 启动服务器连接后,延迟指定时间,进行认证。允许调试器附加到认证过程上。 +**参数说明**:启动服务器连接后,延迟指定时间,进行认证。允许调试器附加到认证过程上。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0~60,单位为秒。 +**取值范围**:整型,最小值为0~60,单位为秒。 -**默认值**: 0 +**默认值**:0 ## trace_notify -**参数说明**: 为LISTEN和NOTIFY命令生成大量调试输出。client_min_messages或log_min_messages级别必须是DEBUG1或者更低时,才能把这些输出分别发送到客户端或者服务器日志。 +**参数说明**:为LISTEN和NOTIFY命令生成大量调试输出。client_min_messages或log_min_messages级别必须是DEBUG1或者更低时,才能把这些输出分别发送到客户端或者服务器日志。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开输出功能。 - off表示关闭输出功能。 -**默认值**: off +**默认值**:off ## trace_recovery_messages -**参数说明**: 启用恢复相关调试输出的日志录,否则将不会被记录。该参数允许覆盖正常设置的log_min_messages,但是仅限于特定的消息,这是为了在调试备机中使用。 +**参数说明**:启用恢复相关调试输出的日志录,否则将不会被记录。该参数允许覆盖正常设置的log_min_messages,但是仅限于特定的消息,这是为了在调试备机中使用。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型,有效值有debug5、debug4、debug3、debug2、debug1、log,取值的详细信息请参见log_min_messages。 +**取值范围**:枚举类型,有效值有debug5、debug4、debug3、debug2、debug1、log,取值的详细信息请参见log_min_messages。 -**默认值**: log +**默认值**:log -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 默认值log表示不影响记录决策。 > - 除默认值外,其他值会导致优先级更高的恢复相关调试信息被记录,因为它们有log优先权。对于常见的log_min_messages设置,这会导致无条件地将它们记录到服务器日志上。 ## trace_sort -**参数说明**: 控制是否在日志中打印排序操作中的资源使用相关信息。这个选项只有在编译MogDB的时候定义了TRACE_SORT宏的时候才可用,不过目前TRACE_SORT是由缺省定义的。 +**参数说明**:控制是否在日志中打印排序操作中的资源使用相关信息。这个选项只有在编译MogDB的时候定义了TRACE_SORT宏的时候才可用,不过目前TRACE_SORT是由缺省定义的。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开控制功能。 - off表示关闭控制功能。 -**默认值**: off +**默认值**:off ## zero_damaged_pages -**参数说明**: 控制检测导致MogDB报告错误的损坏的页头,终止当前事务。 +**参数说明**:控制检测导致MogDB报告错误的损坏的页头,终止当前事务。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 设置为on时,会导致系统报告一个警告,把损坏的页面填充为零然后继续处理。这种行为会破坏数据,也就是所有在已经损坏页面上的行记录。但是它允许绕开坏页面然后从表中尚存的未损坏页面上继续检索数据行。因此它在因为硬件或者软件错误导致的崩溃中进行恢复是很有用的。通常不应该把它设置为on,除非不需要从崩溃的页面中恢复数据。 -**默认值**: off +**默认值**:off ## remotetype -**参数说明**: 设置远程连接类型。 +**参数说明**:设置远程连接类型。 该参数不支持修改。 -**取值范围**: 枚举类型,有效值有application,datanode,internaltool。 +**取值范围**:枚举类型,有效值有application,datanode,internaltool。 -**默认值**: application +**默认值**:application ## max_user_defined_exception -**参数说明**: 异常最大个数,默认值不可更改。 +**参数说明**:异常最大个数,默认值不可更改。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,当前只能取固定值1000 +**取值范围**:整型,当前只能取固定值1000 -**默认值**: 1000 +**默认值**:1000 ## enable_fast_numeric -**参数说明**: 标识是否开启Numeric类型数据运算优化。Numeric数据运算是较为耗时的操作之一,通过将Numeric转化为int64/int128类型,提高Numeric运算的性能。 +**参数说明**:标识是否开启Numeric类型数据运算优化。Numeric数据运算是较为耗时的操作之一,通过将Numeric转化为int64/int128类型,提高Numeric运算的性能。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on/true表示开启Numeric优化。 - off/false表示关闭Numeric优化。 -**默认值**: on +**默认值**:on ## enable_compress_spill -**参数说明**: 标识是否开启下盘压缩功能。 +**参数说明**:标识是否开启下盘压缩功能。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on/true表示开启下盘优化。 - off/false表示关闭下盘优化。 -**默认值**: on +**默认值**:on ## resource_track_log -**参数说明**: 控制自诊断的日志级别。目前仅对多列统计信息进行控制。 +**参数说明**:控制自诊断的日志级别。目前仅对多列统计信息进行控制。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 - summary: 显示简略的诊断信息。 - detail: 显示详细的诊断信息。 目前这两个参数值只在显示多列统计信息未收集的告警的情况下有差别,summary不显示未收集多列统计信息的告警,detail会显示这类告警。 -**默认值**: summary +**默认值**:summary ## show_acce_estimate_detail -**参数说明**: 评估信息一般用于运维人员在维护工作中使用,因此该参数默认关闭,此外为了避免这些信息干扰正常的explain信息显示,只有在explain命令的verbose选项打开的情况下才显示评估信息 +**参数说明**:评估信息一般用于运维人员在维护工作中使用,因此该参数默认关闭,此外为了避免这些信息干扰正常的explain信息显示,只有在explain命令的verbose选项打开的情况下才显示评估信息 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示可以在explain命令的输出中显示评估信息。 - off表示不在explain命令的输出中显示评估信息。 -**默认值**: off +**默认值**:off ## support_batch_bind -**参数说明**: 控制是否允许通过JDBC、ODBC、Libpq等接口批量绑定和执行PBE形式的语句。 +**参数说明**:控制是否允许通过JDBC、ODBC、Libpq等接口批量绑定和执行PBE形式的语句。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用批量绑定和执行。 - off表示不使用批量绑定和执行。 -**默认值**: on +**默认值**:on ## numa_distribute_mode -**参数说明**: 用于控制部分共享数据和线程在NUMA节点间分布的属性。用于大型多NUMA节点的ARM服务器性能调优,一般不用设置。 +**参数说明**:用于控制部分共享数据和线程在NUMA节点间分布的属性。用于大型多NUMA节点的ARM服务器性能调优,一般不用设置。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,当前有效取值为'none', 'all'。 +**取值范围**:字符串,当前有效取值为'none', 'all'。 - none: 表示不启用本特性。 - all: 表示将部分共享数据和线程分布到不同的NUMA节点下,减少远端访存次数,提高性能。目前仅适用于拥有多个NUMA节点的ARM服务器,并且要求全部NUMA节点都可用于数据库进程,不支持仅选择一部分NUMA节点。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 当前版本x86平台下不支持numa_distribute_mode设置为all。 -**默认值**: 'none' +**默认值**:'none' ## log_pagewriter -**参数说明**: 设置用于增量检查点打开后,显示线程的刷页信息以及增量检查点的详细信息,信息比较多,不建议设置为true。 +**参数说明**:设置用于增量检查点打开后,显示线程的刷页信息以及增量检查点的详细信息,信息比较多,不建议设置为true。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 -**默认值**: off +**默认值**:off ## advance_xlog_file_num -**参数说明**: 用于控制在后台周期性地提前初始化xlog文件的数目。该参数是为了避免事务提交时执行xlog文件初始化影响性能,但仅在超重负载时才可能出现,因此一般不用配置。 +**参数说明**:用于控制在后台周期性地提前初始化xlog文件的数目。该参数是为了避免事务提交时执行xlog文件初始化影响性能,但仅在超重负载时才可能出现,因此一般不用配置。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~1000000(0表示不提前初始化)。例如,取值10,表示后台线程会周期性地根据当前xlog写入位置提前初始化10个xlog文件。 +**取值范围**:整型,0~1000000(0表示不提前初始化)。例如,取值10,表示后台线程会周期性地根据当前xlog写入位置提前初始化10个xlog文件。 -**默认值**: 0 +**默认值**:0 ## enable_beta_opfusion -**参数说明**: 当参数enable_opfusion设置为on时,是否加速TPC-C中聚合函数、排序、nestloop join等SQL语句的执行。对于nestloop join SQL语句,enable_beta_nestloop_fusion必须设置为on。 +**参数说明**:当参数enable_opfusion设置为on时,是否加速TPC-C中聚合函数、排序、nestloop join等SQL语句的执行。对于nestloop join SQL语句,enable_beta_nestloop_fusion必须设置为on。 -**取值范围**: 布尔型 +**取值范围**: 布尔型 -**默认值**: off +**默认值**:off ## string_hash_compatible -**参数说明**: 该参数用来说明char类型和varchar/text类型的hash值计算方式是否相同,以此来判断进行分布列从char类型到相同值的varchar/text类型转换,数据分布变化时,是否需要进行重分布。 +**参数说明**:该参数用来说明char类型和varchar/text类型的hash值计算方式是否相同,以此来判断进行分布列从char类型到相同值的varchar/text类型转换,数据分布变化时,是否需要进行重分布。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -285,4 +285,4 @@ date: 2021-04-20 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 计算方式的不同主要体现在字符串计算hash值时传入的字节长度上。(如果为char,则会忽略字符串后面空格的长度,如果为text或varchar,则会保留字符串后面空格的长度。)hash值的计算会影响到查询的计算结果,因此此参数一旦设置后,在整个数据库使用过程中不能再对其进行修改,以避免查询错误。 -**默认值**: off +**默认值**: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 e47124e53490a1a2e74c4ffbbe14f5706c56b88e..e582ea2ff9a6373b6844b123a205e972bd624775 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 @@ -9,105 +9,105 @@ date: 2021-04-20 ## audit_enabled -**参数说明**: 控制审计进程的开启和关闭。审计进程开启后,将从管道读取后台进程写入的审计信息,并写入审计文件。 +**参数说明**:控制审计进程的开启和关闭。审计进程开启后,将从管道读取后台进程写入的审计信息,并写入审计文件。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示启动审计功能。 - off表示关闭审计功能。 -**默认值**: on +**默认值**:on ## audit_directory -**参数说明**: 审计文件的存储目录。一个相对于数据目录data的路径,可自行指定。 +**参数说明**:审计文件的存储目录。一个相对于数据目录data的路径,可自行指定。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: pg_audit。如果使用om工具部署MogDB,则审计日志路径为"$GAUSSLOG/pg_audit/实例名称"。 +**默认值**:pg_audit。如果使用om工具部署MogDB,则审计日志路径为"$GAUSSLOG/pg_audit/实例名称"。 ## audit_data_format -**参数说明**: 审计日志文件的格式。当前仅支持二进制格式。 +**参数说明**:审计日志文件的格式。当前仅支持二进制格式。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: binary +**默认值**:binary ## audit_rotation_interval -**参数说明**: 指定创建一个新审计日志文件的时间间隔。当现在的时间减去上次创建一个审计日志的时间超过了此参数值时,服务器将生成一个新的审计日志文件。 +**参数说明**:指定创建一个新审计日志文件的时间间隔。当现在的时间减去上次创建一个审计日志的时间超过了此参数值时,服务器将生成一个新的审计日志文件。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~INT_MAX/60,单位为min。 +**取值范围**:整型,1~INT_MAX/60,单位为min。 -**默认值**: 1d +**默认值**:1d -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > 请不要随意调整此参数,否侧可能会导致audit_resource_policy无法生效,如果需要控制审计日志的存储空间和时间,请使用[audit_resource_policy](#audit_resource_policy)、[audit_space_limit](#audit_space_limit)和[audit_file_remain_time](#audit_file_remain_time)参数进行控制。 ## audit_rotation_size -**参数说明**: 指定审计日志文件的最大容量。当审计日志消息的总量超过此参数值时,服务器将生成一个新的审计日志文件。 +**参数说明**:指定审计日志文件的最大容量。当审计日志消息的总量超过此参数值时,服务器将生成一个新的审计日志文件。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1024~1048576,单位为KB。 +**取值范围**:整型,1024~1048576,单位为KB。 -**默认值**: 10MB +**默认值**:10MB -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > 请不要随意调整此参数,否侧可能会导致audit_resource_policy无法生效,如果需要控制审计日志的存储空间和时间,请使用audit_resource_policy、audit_space_limit和audit_file_remain_time参数进行控制。 ## audit_resource_policy -**参数说明**: 控制审计日志的保存策略,以空间还是时间限制为优先策略。 +**参数说明**:控制审计日志的保存策略,以空间还是时间限制为优先策略。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示采用空间优先策略,最多存储[audit_space_limit](#audit_space_limit)大小的日志。 - off表示采用时间优先策略,最少存储[audit_file_remain_time](#audit_file_remain_time)长度时间的日志。 -**默认值**: on +**默认值**:on ## audit_file_remain_time -**参数说明**: 表示需记录审计日志的最短时间要求,该参数在[audit_resource_policy](#audit_resource_policy)为off时生效。 +**参数说明**:表示需记录审计日志的最短时间要求,该参数在[audit_resource_policy](#audit_resource_policy)为off时生效。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~730,单位为day,0表示无时间限制。 +**取值范围**:整型,0~730,单位为day,0表示无时间限制。 -**默认值**: 90 +**默认值**:90 ## audit_space_limit -**参数说明**: 审计文件占用的磁盘空间总量。 +**参数说明**:审计文件占用的磁盘空间总量。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1024KB~1024GB,单位为KB。 +**取值范围**:整型,1024KB~1024GB,单位为KB。 -**默认值**: 1GB +**默认值**:1GB ## audit_file_remain_threshold -**参数说明**: 审计目录下审计文件个数的最大值。 +**参数说明**:审计目录下审计文件个数的最大值。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1~1048576 +**取值范围**:整型,1~1048576 -**默认值**: 1048576 +**默认值**:1048576 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![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参数进行控制。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/2-user-and-permission-audit.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/2-user-and-permission-audit.md index 8d262b3d691bd92535669dc09fbc8ac51e112853..932cfbd92e1fa414515174e7cf1a1376f650470a 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/2-user-and-permission-audit.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/22-auditing/2-user-and-permission-audit.md @@ -9,11 +9,11 @@ date: 2021-04-20 ## audit_login_logout -**参数说明**: 这个参数决定是否审计MogDB用户的登录(包括登录成功和登录失败)、注销。 +**参数说明**:这个参数决定是否审计MogDB用户的登录(包括登录成功和登录失败)、注销。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~7。 +**取值范围**:整型,0~7。 - 0表示关闭用户登录、注销审计功能。 - 1表示只审计用户登录成功。 @@ -24,20 +24,20 @@ date: 2021-04-20 - 6表示只审计用户注销和登录失败。 - 7表示审计用户登录成功、失败和注销。 -**默认值**: 7 +**默认值**:7 ## audit_database_process -**参数说明**: 该参数决定是否对MogDB的启动、停止、切换和恢复进行审计。 +**参数说明**:该参数决定是否对MogDB的启动、停止、切换和恢复进行审计。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭MogDB启动、停止、恢复和切换审计功能。 - 1表示开启MogDB启动、停止、恢复和切换审计功能。 -**默认值**: 1 +**默认值**:1 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > @@ -45,39 +45,39 @@ date: 2021-04-20 ## audit_user_locked -**参数说明**: 该参数决定是否审计MogDB用户的锁定和解锁。 +**参数说明**:该参数决定是否审计MogDB用户的锁定和解锁。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭用户锁定和解锁审计功能。 - 1表示开启审计用户锁定和解锁功能。 -**默认值**: 1 +**默认值**:1 ## audit_user_violation -**参数说明**: 该参数决定是否审计用户的越权访问操作。 +**参数说明**:该参数决定是否审计用户的越权访问操作。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭用户越权操作审计功能。 - 1表示开启用户越权操作审计功能。 -**默认值**: 0 +**默认值**:0 ## audit_grant_revoke -**参数说明**: 该参数决定是否审计MogDB用户权限授予和回收的操作。 +**参数说明**:该参数决定是否审计MogDB用户权限授予和回收的操作。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭审计用户权限授予和回收功能。 - 1表示开启审计用户权限授予和回收功能。 -**默认值**: 1 +**默认值**:1 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 789d2818b7737c0c5d79242575e01151aa008010..2afcee96caf9bf7684a7836baa6fcfe38a0f5d93 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 @@ -9,11 +9,11 @@ date: 2021-04-20 ## audit_system_object -**参数说明**: 该参数决定是否对MogDB数据库对象的CREATE、DROP、ALTER操作进行审计。MogDB数据库对象包括DATABASE、USER、schema、TABLE等。通过修改该配置参数的值,可以只审计需要的数据库对象的操作。 +**参数说明**:该参数决定是否对MogDB数据库对象的CREATE、DROP、ALTER操作进行审计。MogDB数据库对象包括DATABASE、USER、schema、TABLE等。通过修改该配置参数的值,可以只审计需要的数据库对象的操作。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~524287 +**取值范围**:整型,0~524287 - 0代表关闭MogDB数据库对象的CREATE、DROP、ALTER操作审计功能。 - 非0代表只审计MogDB的某类或者某些数据库对象的CREATE、DROP、ALTER操作。 @@ -22,7 +22,7 @@ date: 2021-04-20 该参数的值由20个二进制位的组合求出,这20个二进制位分别代表MogDB的20类数据库对象。如果对应的二进制位取值为0,表示不审计对应的数据库对象的CREATE、DROP、ALTER操作;取值为1,表示审计对应的数据库对象的CREATE、DROP、ALTER操作。这19个二进制位代表的具体审计内容请参见[表1](#audit_system_object)。 -**默认值**: 12295 +**默认值**:12295 **表 1** audit_system_object取值含义说明 @@ -52,29 +52,29 @@ date: 2021-04-20 ## audit_dml_state -**参数说明**: 这个参数决定是否对具体表的INSERT、UPDATE、DELETE操作进行审计。 +**参数说明**:这个参数决定是否对具体表的INSERT、UPDATE、DELETE操作进行审计。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭具体表的DML操作(SELECT除外)审计功能。 - 1表示开启具体表的DML操作(SELECT除外)审计功能。 -**默认值**: 0 +**默认值**:0 ## audit_dml_state_select -**参数说明**: 这个参数决定是否对SELECT操作进行审计。 +**参数说明**:这个参数决定是否对SELECT操作进行审计。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭SELECT操作审计功能。 - 1表示开启SELECT审计操作功能。 -**默认值**: 0 +**默认值**:0 ## audit_function_exec @@ -82,77 +82,77 @@ date: 2021-04-20 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭过程或函数执行的审计功能。 - 1表示开启过程或函数执行的审计功能。 -**默认值**: 0 +**默认值**:0 ## audit_copy_exec -**参数说明**: 这个参数决定是否对COPY操作进行审计。 +**参数说明**:这个参数决定是否对COPY操作进行审计。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭COPY审计功能。 - 1表示开启COPY审计功能。 -**默认值**: 0 +**默认值**:0 ## audit_set_parameter -**参数说明**: 这个参数决定是否对SET操作进行审计。 +**参数说明**:这个参数决定是否对SET操作进行审计。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0、1。 +**取值范围**:整型,0、1。 - 0表示关闭SET审计功能。 - 1表示开启SET审计功能。 -**默认值**: 1 +**默认值**:1 ## enableSeparationOfDuty -**参数说明**: 是否开启三权分立选项。 +**参数说明**:是否开启三权分立选项。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示开启三权分立。 - off表示不开启三权分立。 -**默认值**: off +**默认值**:off ## enable_nonsysadmin_execute_direct -**参数说明**: 是否允许非系统管理员执行EXECUTE DIRECT ON语句。 +**参数说明**:是否允许非系统管理员执行EXECUTE DIRECT ON语句。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许任意用户执行EXECUTE DIRECT ON语句。 - off表示只允许系统管理员执行EXECUTE DIRECT ON语句。 -**默认值**: off +**默认值**:off ## enable_access_server_directory -**参数说明**: 是否开启非初始用户创建、修改和删除DIRECTORY的权限。 +**参数说明**:是否开启非初始用户创建、修改和删除DIRECTORY的权限。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示开启非初始用户创建、修改和删除DIRECTORY的权限。 - off表示不开启非初始用户创建、修改和删除DIRECTORY的权限。 -**默认值**: off +**默认值**:off > ![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/23-upgrade-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/23-upgrade-parameters.md index 9780d6e605bfbd37f1c55ad08c0bc83bb3864627..068684290736511b612c5176da4acb7462c310d8 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 @@ -9,35 +9,35 @@ date: 2021-04-20 ## IsInplaceUpgrade -**参数说明**: 标示是否在升级的过程中。该参数用户无法修改。 +**参数说明**:标示是否在升级的过程中。该参数用户无法修改。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示在升级过程中。 - off表示不在升级过程中。 -**默认值**: off +**默认值**:off ## inplace_upgrade_next_system_object_oids -**参数说明**: 标示就地升级过程中,新增系统对象的OID。该参数用户无法修改。 +**参数说明**:标示就地升级过程中,新增系统对象的OID。该参数用户无法修改。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 ## upgrade_mode -**参数说明**: 标示升级模式。该参数不建议用户自己修改。 +**参数说明**:标示升级模式。该参数不建议用户自己修改。 -**取值范围:**整数,0~INT_MAX +**取值范围**:整数,0~INT_MAX - 0表示不在升级过程中。 - 1表示在就地升级过程中。 - 2表示在灰度升级过程中。 -**默认值**: 0 +**默认值**:0 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 7d9d198b1f120b314105bd730933f8b4f7a97afc..d42a14b4edd9415f2d50e1359abfec88b4835b46 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 @@ -9,189 +9,189 @@ date: 2021-04-20 ## enable_default_ustore_table -**参数说明**: 指定是否开启默认支持Ustore存储引擎。该参数为on时,创建的表类型都为Ustore表。 +**参数说明**:指定是否开启默认支持Ustore存储引擎。该参数为on时,创建的表类型都为Ustore表。 该参数属于USERSET类型,请参考表[GUC参数分类](30-appendix)对应设置方法进行设置。 -**取值范围**: [off,on] +**取值范围**:[off,on] -**默认值**: off +**默认值**:off ## reserve_space_for_nullable_atts -**参数说明**: 指定是否为Ustore表的可空属性预留空间。该参数为on时默认为Ustore表的可空属性预留空间。 +**参数说明**:指定是否为Ustore表的可空属性预留空间。该参数为on时默认为Ustore表的可空属性预留空间。 该参数属于USERSET类型,请参考表[GUC参数分类](30-appendix)对应设置方法进行设置。 -**取值范围**: [off,on] +**取值范围**:[off,on] -**默认值**: off +**默认值**:off ## ustore_attr -**参数说明**: Ustore测试参数。 +**参数说明**: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'。 -**取值范围**: 字符串 +**取值范围**:字符串 ## server_version -**参数说明**: 报告服务器版本号(字符串形式)。 +**参数说明**:报告服务器版本号(字符串形式)。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。该参数继承自PostgreSQL内核,表示当前数据库内核兼容PostgreSQL对应的server_version版本,无实际含义,为保持北向对外工具接口的生态兼容性(工具连接时查询),保留该参数。该参数不推荐使用,如想查询服务器版本号,可通过函数opengauss_version()获取。 -**取值范围:** 字符串 +**取值范围**: 字符串 -**默认值**: 9.2.4 +**默认值**: 9.2.4 ## server_version_num -**参数说明**: 报告服务器版本号(整数形式)。 +**参数说明**:报告服务器版本号(整数形式)。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。该参数继承自PostgreSQL内核,表示当前数据库内核兼容PostgreSQL对应的server_version_num版本,无实际含义,为保持北向对外工具接口的生态兼容性(工具连接时查询),保留该参数。 -**取值范围:**整数 +**取值范围**:整数 -**默认值**: 90204 +**默认值**:90204 ## block_size -**参数说明**: 报告当前数据库所使用的块大小。 +**参数说明**:报告当前数据库所使用的块大小。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**取值范围:**8192 +**取值范围**:8192 -**默认值**: 8192 +**默认值**:8192 ## segment_size -**参数说明**: 报告当前数据库所使用的段文件大小。 +**参数说明**:报告当前数据库所使用的段文件大小。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 **单位**: 8KB -**默认值**: 131072, 即1GB +**默认值**:131072, 即1GB ## max_index_keys -**参数说明**: 报告当前数据库能够支持的索引键值的最大数目。 +**参数说明**:报告当前数据库能够支持的索引键值的最大数目。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**默认值**: 32 +**默认值**:32 ## integer_datetimes -**参数说明**: 报告是否支持64位整数形式的日期和时间格式。 +**参数说明**:报告是否支持64位整数形式的日期和时间格式。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示支持。 - off表示不支持。 -**默认值**: on +**默认值**:on ## lc_collate -**参数说明**: 报告当前数据库的字符串排序区域设置。 +**参数说明**:报告当前数据库的字符串排序区域设置。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**默认值**: 依赖于MogDB安装部署时的配置 +**默认值**:依赖于MogDB安装部署时的配置 ## lc_ctype -**参数说明**: 报告当前数据库的字母类别区域设置。如: 哪些字符属于字母,它对应的大写形式是什么。 +**参数说明**:报告当前数据库的字母类别区域设置。如: 哪些字符属于字母,它对应的大写形式是什么。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**默认值**: 依赖于MogDB安装部署时的配置 +**默认值**:依赖于MogDB安装部署时的配置 ## max_identifier_length -**参数说明**: 报告当前系统允许的标识符最大长度。 +**参数说明**:报告当前系统允许的标识符最大长度。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**取值范围:**整型 +**取值范围**:整型 -**默认值**: 63 +**默认值**:63 ## server_encoding -**参数说明**: 报告当前数据库的服务端编码字符集。 +**参数说明**:报告当前数据库的服务端编码字符集。 默认情况下,gs_initdb会根据当前的系统环境初始化此参数,通过locale命令可以查看当前的配置环境。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**默认值**: 在创建数据库的时候由当前系统环境决定的。 +**默认值**:在创建数据库的时候由当前系统环境决定的。 ## enable_upgrade_merge_lock_mode -**参数说明**: 当该参数设置为on时,通过提升deltamerge内部实现的锁级别,避免和update/delete并发操作时的报错。 +**参数说明**:当该参数设置为on时,通过提升deltamerge内部实现的锁级别,避免和update/delete并发操作时的报错。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:** 布尔型 +**取值范围**: 布尔型 - on,提升deltamerge内部实现的锁级别,并发执行deltamerge和update/delete操作时,一个操作先执行,另一个操作被阻塞,在前一个操作完成后,后一个操作再执行。 - off,在对表的delta table的同一行并发执行deltamerge和update/delete操作时,后一个对同一行数据更新的操作会报错退出。 -**默认值**: off +**默认值**:off ## transparent_encrypted_string -**参数说明**: 它存储的是透明加密的一个样本串,使用数据库加密密钥加密固定串"TRANS_ENCRYPT_SAMPLE_STRING"后的密文,用来校验二次启动时获取的DEK是否正确。如果校验失败,那么数据库节点将拒绝启动。该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**参数说明**:它存储的是透明加密的一个样本串,使用数据库加密密钥加密固定串"TRANS_ENCRYPT_SAMPLE_STRING"后的密文,用来校验二次启动时获取的DEK是否正确。如果校验失败,那么数据库节点将拒绝启动。该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串,设置为空表示MogDB非加密。 +**取值范围**:字符串,设置为空表示MogDB非加密。 -**默认值**: 空 +**默认值**:空 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 请勿手动设置该参数,设置不当将导致MogDB不可用。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:请勿手动设置该参数,设置不当将导致MogDB不可用。 ## 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/。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 ## transparent_encrypt_kms_region -**参数说明**: 它存储的是MogDB的部署区域,内容要求不可出现RFC3986标准外的字符,最大长度2047字节。 +**参数说明**:它存储的是MogDB的部署区域,内容要求不可出现RFC3986标准外的字符,最大长度2047字节。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 ## basebackup_timeout -**参数说明**: 备份传输完成后连接无读写的超时时间。 通过gs_basebackup工具作传输时,如果指定较高压缩率时,可能在传输表空间完成后超时(客户端需要压缩传输数据)。 +**参数说明**:备份传输完成后连接无读写的超时时间。 通过gs_basebackup工具作传输时,如果指定较高压缩率时,可能在传输表空间完成后超时(客户端需要压缩传输数据)。 -**取值范围**: 整型,0 ~ INT_MAX,单位为秒。其中0表示禁用该功能。 +**取值范围**:整型,0 ~ INT_MAX,单位为秒。其中0表示禁用该功能。 -**默认值**: 600s +**默认值**: 600s ## datanode_heartbeat_interval -**参数说明**: 设置心跳线程间心跳消息发送时间间隔,建议值不超过wal_receiver_timeout / 2。 +**参数说明**:设置心跳线程间心跳消息发送时间间隔,建议值不超过wal_receiver_timeout / 2。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1000~60000(毫秒) +**取值范围**:整型,1000~60000(毫秒) -**默认值**: 1s +**默认值**:1s ## max_concurrent_autonomous_transactions 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 e50c3c56bbc44c15a52ae8b7fae193c5c3bbe1cd..a7ac2842068f52a8d35c2097bc5ada2bfecfb35f 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 @@ -9,13 +9,13 @@ date: 2021-04-20 ## enable_instr_track_wait -**参数说明**: 是否开启等待事件信息实时收集功能。 +**参数说明**:是否开启等待事件信息实时收集功能。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on: 表示打开等待事件信息收集功能。 - off: 表示关闭等待事件信息收集功能。 -**默认值**: on +**默认值**: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 b4fd3418170043c61339ae0fc7f846465d007aa9..162dc68a6847ebe40e4e23a725ad56eee32a526c 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 @@ -9,7 +9,7 @@ date: 2021-04-20 ## instr_unique_sql_count -**参数说明**: 控制系统中unique sql信息实时收集功能。配置为0表示不启用unique sql信息收集功能。 +**参数说明**:控制系统中unique sql信息实时收集功能。配置为0表示不启用unique sql信息收集功能。 该值由大变小将会清空系统中原有的数据重新统计;从小变大不受影响。 @@ -29,11 +29,11 @@ date: 2021-04-20 ## instr_unique_sql_track_type -**参数说明**: unique sql记录SQL方式。 +**参数说明**:unique sql记录SQL方式。 该参数属于INTERNAL类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 枚举类型 +**取值范围**:枚举类型 top:只记录顶层SQL。 @@ -41,11 +41,11 @@ top:只记录顶层SQL。 ## enable_instr_rt_percentile -**参数说明**: 是否开启计算系统中80%和95%的SQL响应时间的功能。 +**参数说明**:是否开启计算系统中80%和95%的SQL响应时间的功能。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on:表示打开sql响应时间信息计算功能。 - off:表示关闭sql响应时间信息计算功能。 @@ -54,31 +54,31 @@ top:只记录顶层SQL。 ## percentile -**参数说明**: sql响应时间百分比信息,后台计算线程根据设置的值计算相应的百分比信息。 +**参数说明**:sql响应时间百分比信息,后台计算线程根据设置的值计算相应的百分比信息。 该参数属于INTERNAL类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。 +**取值范围**:字符串。 **默认值**:80,95 ## 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时间消耗 。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on:表示捕获sql执行的cpu时间消耗。 - off:表示不捕获sql执行的cpu时间消耗。 @@ -87,44 +87,44 @@ top:只记录顶层SQL。 ## enable_stmt_track -**参数说明**: 控制是否启用Full /Slow SQL特性。 +**参数说明**:控制是否启用Full /Slow SQL特性。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on:表示开启Full /Slow SQL捕获。 - off:表示关闭Full /Slow SQL捕获。 -**默认值**: on +**默认值**:on ## track_stmt_session_slot -**参数说明**: 设置一个session缓存的最大的全量/慢SQL的数量,超过这个数量,新的语句执行将不会被跟踪,直到落盘线程将缓存语句落盘,留出空闲的空间。 +**参数说明**:设置一个session缓存的最大的全量/慢SQL的数量,超过这个数量,新的语句执行将不会被跟踪,直到落盘线程将缓存语句落盘,留出空闲的空间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0 ~ 2147483647 +**取值范围**:整型,0 ~ 2147483647 -**默认值**: 1000 +**默认值**:1000 ## track_stmt_details_size -**参数说明**: 设置单语句可以收集的最大的执行事件的大小(byte)。 +**参数说明**:设置单语句可以收集的最大的执行事件的大小(byte)。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0 ~ 100000000 +**取值范围**:整型,0 ~ 100000000 -**默认值**: 4096 +**默认值**:4096 ## track_stmt_retention_time -**参数说明**: 组合参数,控制全量/慢SQL记录的保留时间。以60秒为周期读取该参数,并执行清理超过保留时间的记录,仅sysadmin用户可以访问。 +**参数说明**:组合参数,控制全量/慢SQL记录的保留时间。以60秒为周期读取该参数,并执行清理超过保留时间的记录,仅sysadmin用户可以访问。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符型 +**取值范围**:字符型 该参数分为两部分,形式为'full sql retention time, slow sql retention time' @@ -132,15 +132,15 @@ full sql retention time为全量SQL保留时间,取值范围为0 ~ 86400 slow sql retention time为慢SQL的保留时间,取值范围为0 ~ 604800 -**默认值**: 3600,604800 +**默认值**:3600,604800 ## track_stmt_stat_level -**参数说明**: 控制语句执行跟踪的级别。 +**参数说明**:控制语句执行跟踪的级别。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置,不区分英文字母大小写。 -**取值范围**: 字符型 +**取值范围**:字符型 该参数分为两部分,形式为'full sql stat level, slow sql stat level' @@ -150,17 +150,17 @@ slow sql retention time为慢SQL的保留时间,取值范围为0 ~ 604800 > ![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 +**默认值**:OFF,L0 ## unique_sql_clean_ratio -**参数说明**: 当系统中产生的unique sql条目数量大于等于instr_unique_sql_count时,每次自动淘汰的unique sql条目数量占总条目数量预设上限instr_unique_sql_count的比例。 +**参数说明**:当系统中产生的unique sql条目数量大于等于instr_unique_sql_count时,每次自动淘汰的unique sql条目数量占总条目数量预设上限instr_unique_sql_count的比例。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: double类型,0~0.2 +**取值范围**:double类型,0~0.2 -**默认值**: 0.1 +**默认值**:0.1 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **注意:** > @@ -170,12 +170,12 @@ slow sql retention time为慢SQL的保留时间,取值范围为0 ~ 604800 ## enable_auto_clean_unique_sql -**参数说明**: 当系统中产生的unique sql条目数量大于等于instr_unique_sql_count时,是否启用unique sql自动淘汰功能。 +**参数说明**:当系统中产生的unique sql条目数量大于等于instr_unique_sql_count时,是否启用unique sql自动淘汰功能。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 -**默认值**: off +**默认值**:off > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **注意:** 由于快照有部分信息是来源于unique sql,所以开启自动淘汰的情况下,在生成wdr报告时,如果选择的起始快照和终止快照跨过了淘汰发生的时间,会导致无法生成wdr报告。 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 93fb5c673a48df8e221fd87d7447e83449d1ff20..41f46591993ffd4e79ece684bccfce9ae447a074 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 @@ -9,114 +9,114 @@ date: 2021-04-20 ## enable_wdr_snapshot -**参数说明**: 是否开启数据库监控快照功能。 +**参数说明**:是否开启数据库监控快照功能。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on: 打开数据库监控快照功能。 - off: 关闭数据库监控快照功能。 -**默认值**: off +**默认值**:off ## wdr_snapshot_retention_days -**参数说明**: 系统中数据库监控快照数据的保留天数,超过设置的值之后,系统每隔wdr_snapshot_interval时间间隔,清理snapshot_id最小的快照数据。 +**参数说明**:系统中数据库监控快照数据的保留天数,超过设置的值之后,系统每隔wdr_snapshot_interval时间间隔,清理snapshot_id最小的快照数据。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1~8。 +**取值范围**:整型,1~8。 -**默认值**: 8 +**默认值**:8 ## wdr_snapshot_query_timeout -**参数说明**: 系统执行数据库监控快照操作时,设置快照操作相关的sql语句的执行超时时间。如果语句超过设置的时间没有执行完并返回结果,则本次快照操作失败。 +**参数说明**:系统执行数据库监控快照操作时,设置快照操作相关的sql语句的执行超时时间。如果语句超过设置的时间没有执行完并返回结果,则本次快照操作失败。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,100~INT_MAX(秒)。 +**取值范围**:整型,100~INT_MAX(秒)。 -**默认值**: 100s +**默认值**:100s ## wdr_snapshot_interval -**参数说明**: 后台线程Snapshot自动对数据库监控数据执行快照操作的时间间隔。 +**参数说明**:后台线程Snapshot自动对数据库监控数据执行快照操作的时间间隔。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,10~60(分钟)。 +**取值范围**:整型,10~60(分钟)。 -**默认值**: 1h +**默认值**:1h ## asp_flush_mode -**参数说明**: ASP刷新到磁盘上的方式分为写文件和写系统表,当为‘file’时,默认写文件,为‘table’时写系统表,为‘all’时,即写文件也写系统表,仅sysadmin用户可以访问。 +**参数说明**:ASP刷新到磁盘上的方式分为写文件和写系统表,当为‘file’时,默认写文件,为‘table’时写系统表,为‘all’时,即写文件也写系统表,仅sysadmin用户可以访问。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,‘table’、‘file’、‘all’。 +**取值范围**:字符串,‘table’、‘file’、‘all’。 **默认值**:‘table’ ## asp_flush_rate -**参数说明**: 当内存中样本个数达到asp_sample_num时,会按一定比例把内存中样本刷新到磁盘上,asp_flush_rate为刷新比例。该参数为10时表示按10:1进行刷新。 +**参数说明**:当内存中样本个数达到asp_sample_num时,会按一定比例把内存中样本刷新到磁盘上,asp_flush_rate为刷新比例。该参数为10时表示按10:1进行刷新。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~10。 +**取值范围**:整型,1~10。 **默认值**:10 ## asp_log_filename -**参数说明**: 当ASP写文件时,该参数设置文件名的格式,仅sysadmin用户可以访问。 +**参数说明**:当ASP写文件时,该参数设置文件名的格式,仅sysadmin用户可以访问。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。 +**取值范围**:字符串。 **默认值**:“asp-%Y-%m-%d_%H%M%S.log” ## asp_retention_days -**参数说明**: 当ASP样本写到系统表时,该参数表示保留的最大天数。 +**参数说明**:当ASP样本写到系统表时,该参数表示保留的最大天数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~7。 +**取值范围**:整型,1~7。 **默认值**:2 ## asp_sample_interval -**参数说明**: 每次采样的间隔。 +**参数说明**:每次采样的间隔。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~10,单位为秒。 +**取值范围**:整型,1~10,单位为秒。 **默认值**:1s ## asp_sample_num -**参数说明**: LOCAL_ACTIVE_SESSION视图最大的样本个数,仅sysadmin用户可以访问。 +**参数说明**:LOCAL_ACTIVE_SESSION视图最大的样本个数,仅sysadmin用户可以访问。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,10000~100000。 +**取值范围**:整型,10000~100000。 **默认值**:100000 ## enable_asp -**参数说明**: 是否开启活跃会话信息active session profile。 +**参数说明**:是否开启活跃会话信息active session profile。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on:打开active session profile功能。 - off:关闭active session profile功能。 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 f6ee251f47b729ff7e995a6dab548421e21c716d..9a79f77b815a837bb210491409357bcfabd80386 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 @@ -9,21 +9,21 @@ date: 2021-11-08 ## elastic_search_ip_addr -**参数说明**: Elastic Search系统IP地址。 +**参数说明**:Elastic Search系统IP地址。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。 +**取值范围**:字符串。 **默认值**:'https:127.0.0.1' ## enable_security_policy -**参数说明**: 安全策略开关,控制统一审计和数据动态脱敏策略是否生效。 +**参数说明**:安全策略开关,控制统一审计和数据动态脱敏策略是否生效。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型。 +**取值范围**:布尔型。 on:安全策略开关打开。 @@ -33,11 +33,11 @@ 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)中对应设置方法进行设置。 -**取值范围**: 布尔型。 +**取值范围**:布尔型。 on:使能统一审计日志发送至Elastic Search。 @@ -47,11 +47,11 @@ off:关闭统一审计日志发送至Elastic Search。 ## is_sysadmin -**参数说明**: 表示当前用户是否是初始用户。 +**参数说明**:表示当前用户是否是初始用户。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**取值范围**: 布尔型。 +**取值范围**:布尔型。 on表示是初始用户。 @@ -61,11 +61,11 @@ off表示不是初始用户。 ## enable_tde -**参数说明**: 透明数据加密功能开关。创建加密表前需要将此参数置为on。当前参数值为off时,禁止创建新的加密表,对于已经创建的加密表只在读取数据时解密,写入数据时不再加密。 +**参数说明**:透明数据加密功能开关。创建加密表前需要将此参数置为on。当前参数值为off时,禁止创建新的加密表,对于已经创建的加密表只在读取数据时解密,写入数据时不再加密。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型。 +**取值范围**:布尔型。 on:开启透明数据加密功能。 @@ -75,10 +75,10 @@ off:关闭透明数据加密功能。 ## tde_cmk_id -**参数说明**: 透明数据加密功能使用的数据库实例主密钥CMK的ID编号,由使用的密钥管理服务KMS生成。数据库实例主密钥CMK用于对数据加密密钥DEK进行加密保护,当前需要对DEK进行解密时,需要给KMS发起请求报文,将DEK密文和对应CMK的ID编号一起发送给KMS。 +**参数说明**:透明数据加密功能使用的数据库实例主密钥CMK的ID编号,由使用的密钥管理服务KMS生成。数据库实例主密钥CMK用于对数据加密密钥DEK进行加密保护,当前需要对DEK进行解密时,需要给KMS发起请求报文,将DEK密文和对应CMK的ID编号一起发送给KMS。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。 +**取值范围**:字符串。 **默认值**:”” 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 index 44d9608450c8c1352955485846fb6a3a7c005942..9dc64f19e3ef3011b6e41c92a090bdf5a8a7fd88 100644 --- 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 @@ -9,15 +9,15 @@ date: 2021-04-20 ## enable_full_encryption -**参数说明**: 全密态数据库开关,控制全密态数据库是否生效。 +**参数说明**:全密态数据库开关,控制全密态数据库是否生效。 该参数属于BACKEND类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 enable_full_encryption设置为on后,使用gsql连接数据库时需要输入"-C"参数,或"-enable-client-encryption",否则连接不成功。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on: 全密态数据库开关打开。 - off: 全密态数据库开关关闭。 -**默认值**: 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 740311c804f31e099465d5ac129a4be1f92b5978..f54f5c27ab00213394f8ae8aed84608b13e9a422 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 @@ -9,23 +9,23 @@ date: 2021-04-20 ## max_active_global_temporary_table -**参数说明**: 全局临时表功能开关,控制是否可以创建全局临时表。 +**参数说明**:全局临时表功能开关,控制是否可以创建全局临时表。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0 ~ 1000000 +**取值范围**:整型,0 ~ 1000000 - 0: 全局临时表功能关闭。 - > 0: 全局临时表功能打开。 -**默认值**: 1000 +**默认值**:1000 ## vacuum_gtt_defer_check_age -**参数说明**: vacuum执行后检查全局临时表relfrozenxid与普通表的差异。如果全局临时表relfrozenxid落后超过指定参数值,就产生WARNING。一般不用修改。 +**参数说明**:vacuum执行后检查全局临时表relfrozenxid与普通表的差异。如果全局临时表relfrozenxid落后超过指定参数值,就产生WARNING。一般不用修改。 该参数USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0 ~ 1000000 +**取值范围**:整型,0 ~ 1000000 -**默认值**: 10000 +**默认值**:10000 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 dd801b9374df402599c9e8bef7b68410a72c8859..8f4937560e0fd3e0d9f0f5d9d4680101de43b46b 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,93 +9,93 @@ 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/2log2m\*1⁄2,+1.04/2log2m*1⁄2]。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,10~16。 +**取值范围**:整型,10~16。 -**默认值**: 14 +**默认值**:14 ## hll_default_log2explicit -**参数说明**: 该参数可以用来设置从Explicit模式到Sparse模式的默认阈值大小。 +**参数说明**:该参数可以用来设置从Explicit模式到Sparse模式的默认阈值大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~12。0表示跳过Explicit模式,取1-12表示在基数到达2hll_default_log2explicit时切换模式。 +**取值范围**:整型,0~12。0表示跳过Explicit模式,取1-12表示在基数到达2hll_default_log2explicit时切换模式。 -**默认值**: 10 +**默认值**:10 ## hll_default_log2sparse -**参数说明**: 该参数可以用来设置从Sparse模式到Full模式的默认阈值大小。 +**参数说明**:该参数可以用来设置从Sparse模式到Full模式的默认阈值大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~14。0表示跳过Explicit模式,取1-14表示在基数到达2hll_default_log2sparse时切换模式。 +**取值范围**:整型,0~14。0表示跳过Explicit模式,取1-14表示在基数到达2hll_default_log2sparse时切换模式。 -**默认值**: 12 +**默认值**:12 ## hll_duplicate_check -**参数说明**: 该参数可以用来指定是否默认开启duplicatecheck。 +**参数说明**:该参数可以用来指定是否默认开启duplicatecheck。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 0,1。0表示默认关闭,1表示默认开启 +**取值范围**:0,1。0表示默认关闭,1表示默认开启 -**默认值**: 0 +**默认值**:0 ## hll_default_regwidth(废弃) -**参数说明**: 该参数可以指定hll数据结构每个桶的位数,该值越大,hll所占内存越高。hll_default_regwidth和hll_default_log2m可以决定当前hll能够计算的最大distinct value。当前regwidth设为固定值,该参数不再使用。 +**参数说明**:该参数可以指定hll数据结构每个桶的位数,该值越大,hll所占内存越高。hll_default_regwidth和hll_default_log2m可以决定当前hll能够计算的最大distinct value。当前regwidth设为固定值,该参数不再使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~5。 +**取值范围**:整型,1~5。 -**默认值**: 5 +**默认值**:5 ## hll_default_expthresh(废弃) -**参数说明**: 该参数可以用来设置从Explicit模式到Sparse模式的默认阈值大小。当前已经使用参数hll_default_log2explicit替代类似功能。 +**参数说明**:该参数可以用来设置从Explicit模式到Sparse模式的默认阈值大小。当前已经使用参数hll_default_log2explicit替代类似功能。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,-1~7。-1表示自动模式,0表示跳过Explicit模式,取1-7表示在基数到达2hll_default_expthresh时切换模式。 +**取值范围**:整型,-1~7。-1表示自动模式,0表示跳过Explicit模式,取1-7表示在基数到达2hll_default_expthresh时切换模式。 -**默认值**: -1 +**默认值**:-1 ## hll_default_sparseon(废弃) -**参数说明**: 该参数可用来指定是否默认开启Sparse模式。当前已经使用参数hll_default_log2sparse替代类似功能,hll_default_log2sparse设置为0时关闭Sparse模式。 +**参数说明**:该参数可用来指定是否默认开启Sparse模式。当前已经使用参数hll_default_log2sparse替代类似功能,hll_default_log2sparse设置为0时关闭Sparse模式。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 0,1。0表示默认关闭,1表示默认开启。 +**取值范围**:0,1。0表示默认关闭,1表示默认开启。 -**默认值**: 1 +**默认值**:1 ## hll_max_sparse(废弃) -**参数说明**: 该参数可以用来指定max_sparse的大小。当前已经使用参数hll_default_log2sparse替代类似功能。 +**参数说明**:该参数可以用来指定max_sparse的大小。当前已经使用参数hll_default_log2sparse替代类似功能。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,-1~2147483647 +**取值范围**:整型,-1~2147483647 -**默认值**: -1 +**默认值**:-1 ## enable_compress_hll(废弃) -**参数说明**: 该参数可以用来指定是否对hll开启内存优化模式。目前hll内存已经进行了优化设计,该参数不再使用。 +**参数说明**:该参数可以用来指定是否对hll开启内存优化模式。目前hll内存已经进行了优化设计,该参数不再使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on/true表示对hll开启内存优化模式。 - off/false表示不开启内存优化模式。 -**默认值**: off +**默认值**:off diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/1-connection-settings.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/1-connection-settings.md index c255db0b7231e2bdcfe26ba88d9deb296f1bd9a9..3a2e65ba161a8161bef6963242aeed22b3ef3dca 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/1-connection-settings.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/1-connection-settings.md @@ -11,40 +11,38 @@ date: 2021-04-20 ## listen_addresses -**参数说明**: 声明服务器侦听客户端的TCP/IP地址。 +**参数说明**:声明服务器侦听客户端的TCP/IP地址。 该参数指定MogDB服务器使用哪些IP地址进行侦听,如IPV4或IPV6(若支持)。服务器主机上可能存在多个网卡,每个网卡可以绑定多个IP地址,该参数就是控制MogDB到底绑定在哪个或者哪几个IP地址上。而客户端则可以通过该参数中指定的IP地址来连接MogDB或者给MogDB发送请求。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: +**取值范围**: - 主机名或IP地址,多个值之间用英文逗号分隔。 - 星号`*`或`0.0.0.0`表示侦听所有IP地址。配置侦听所有IP地址存在安全风险,不推荐用户使用。必须与有效地址结合使用(比如本地IP等),否则,可能造成Build失败的问题。同时,主备环境下配置为`*`或`0.0.0.0`时,主节点数据库路径下postgresql.conf文件中的localport端口号不能为数据库dataPortBase+1,否则会导致数据库无法启动。 - 置空则服务器不会侦听任何IP地址,这种情况下,只有Unix域套接字可以用于连接数据库。 -**默认值**: 数据库实例安装好后,根据XML配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为:listen_addresses = 'x.x.x.x'。 +**默认值**:数据库实例安装好后,根据XML配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为:listen_addresses = 'x.x.x.x'。 ## local_bind_address -**参数说明**: 声明当前节点连接MogDB其他节点绑定的本地IP地址。 +**参数说明**:声明当前节点连接MogDB其他节点绑定的本地IP地址。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**默认值**: 数据库实例安装好后,根据XML配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为:local_bind_address = 'x.x.x.x'。。 +**默认值**:数据库实例安装好后,根据XML配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为:local_bind_address = 'x.x.x.x'。。 ## port -**参数说明**: MogDB服务侦听的TCP端口号。 +**参数说明**:MogDB服务侦听的TCP端口号。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> -> 该参数由安装时的配置文件指定,请勿轻易修改,否则修改后会影响数据库正常通信。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:**该参数由安装时的配置文件指定,请勿轻易修改,否则修改后会影响数据库正常通信。 > -**取值范围**: 整型,1~65535 +**取值范围**:整型,1~65535 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > @@ -52,24 +50,25 @@ date: 2021-04-20 > - 1~1023为操作系统保留端口号,请不要使用。 > - 通过配置文件安装数据库实例时,配置文件中的端口号需要注意通信矩阵预留端口。如:DN还需保留dataPortBase+1作为内部工具使用端口,保留dataPortBase+6作为流引擎消息队列通信端口等。故数据库实例安装阶段,port最大值为:DN可设置65529,同时需要保证端口号不冲突。 -**默认值**: 5432(实际值由安装时的配置文件指定) +**默认值**:5432(实际值由安装时的配置文件指定) ## max_connections -**参数说明**: 允许和数据库连接的最大并发连接数。此参数会影响MogDB的并发能力。 +**参数说明**:允许和数据库连接的最大并发连接数。此参数会影响MogDB的并发能力。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型。最小值为10(要大于max_wal_senders),理论最大值为262143,实际最大值为动态值,计算公式为“262143 - job_queue_processes - autovacuum_max_workers - AUXILIARY_BACKENDS - AV_LAUNCHER_PROCS - max_inner_tool_connections”。job_queue_processes、autovacuum_max_workers和max_inner_tool_connections的值取决于对应GUC参数的设置。AUXILIARY_BACKENDS为预留辅助线程数,固定为20,AV_LAUNCHER_PROCS为预留autovacuum的lancher线程数,固定为2。 +**取值范围**:整型。最小值为10(要大于max_wal_senders),理论最大值为262143,实际最大值为动态值,计算公式为“262143 - job_queue_processes - autovacuum_max_workers - AUXILIARY_BACKENDS - AV_LAUNCHER_PROCS - max_inner_tool_connections”。job_queue_processes、autovacuum_max_workers和max_inner_tool_connections的值取决于对应GUC参数的设置。AUXILIARY_BACKENDS为预留辅助线程数,固定为20,AV_LAUNCHER_PROCS为预留autovacuum的lancher线程数,固定为2。 + +**默认值**: -**默认值**: 200 +- **200**:编译安装数据库或极简安装数据库的情况下。 +- **5000**:使用om安装数据库的情况下。 **设置建议:** 数据库主节点中此参数建议保持默认值。 -当修改此默认值时,请同时修改undo_zone_count取值,具体设置原则请参见[undo章节](35-undo)。 - **配置不当时影响:** - 若配置max_connections过大,超过计算公式所描述的最大动态值,会出现节点拉起失败问题,报错提示“invalid value for parameter “max_connections””。 @@ -82,13 +81,13 @@ date: 2021-04-20 ## max_inner_tool_connections -**参数说明**: 允许和数据库连接的工具的最大并发连接数。此参数会影响MogDB的工具连接并发能力。 +**参数说明**:允许和数据库连接的工具的最大并发连接数。此参数会影响MogDB的工具连接并发能力。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,最小值为1,最大值为MIN(262143, max_connections),max_connections的计算方法见上文。 +**取值范围**:整型,最小值为1,最大值为MIN(262143, max_connections),max_connections的计算方法见上文。 -**默认值**: 数据库节点为50。如果该默认值超过内核支持的最大值(在执行gs_initdb的时候判断),系统会提示错误。 +**默认值**:数据库节点为50。如果该默认值超过内核支持的最大值(在执行gs_initdb的时候判断),系统会提示错误。 **设置建议:** @@ -98,39 +97,39 @@ date: 2021-04-20 ## sysadmin_reserved_connections -**参数说明**: 为管理员用户预留的最少连接数, 不建议设置过大。该参数和max_connections参数配合使用,管理员用户的最大连接数等于max_connections+sysadmin_reserved_connections。 +**参数说明**:为管理员用户预留的最少连接数, 不建议设置过大。该参数和max_connections参数配合使用,管理员用户的最大连接数等于max_connections+sysadmin_reserved_connections。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,最小值为0,最大值为MIN(262143, max_connections),max_connections的计算方法见上文。 +**取值范围**:整型,最小值为0,最大值为MIN(262143, max_connections),max_connections的计算方法见上文。 -**默认值**: 3 +**默认值**:3 ## unix_socket_directory -**参数说明**: 设置MogDB服务器侦听客户端连接的Unix域套接字目录。 +**参数说明**:设置MogDB服务器侦听客户端连接的Unix域套接字目录。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 该参数的长度限制于操作系统的长度,超过该限制将会导致Unix-domain socket path "xxx" is too long的问题。 -**取值范围**: 字符串 +**取值范围**:字符串 -**默认值**: 空字符串(实际值由安装时配置文件指定) +**默认值**:空字符串(实际值由安装时配置文件指定) ## unix_socket_group -**参数说明**: 设置Unix域套接字的所属组(套接字的所属用户总是启动服务器的用户)。可以与选项[unix_socket_permissions](#unix_socket_permissions)一起用于对套接字进行访问控制。 +**参数说明**:设置Unix域套接字的所属组(套接字的所属用户总是启动服务器的用户)。可以与选项[unix_socket_permissions](#unix_socket_permissions)一起用于对套接字进行访问控制。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,其中空字符串表示当前用户的缺省组。 +**取值范围**:字符串,其中空字符串表示当前用户的缺省组。 -**默认值**: 空字符串 +**默认值**:空字符串 ## unix_socket_permissions -**参数说明**: 设置Unix域套接字的访问权限。 +**参数说明**:设置Unix域套接字的访问权限。 Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应该是数值的格式(chmod和umask命令可接受的格式)。如果使用自定义的八进制格式,数字必须以0开头。 @@ -138,13 +137,13 @@ Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 0000-0777 +**取值范围**:0000-0777 -**默认值**: 0777 +**默认值**:0777 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > -> 在Linux中,文档具有十个属性,其中第一个属性为文档类型,后面九个为权限属性,分别为Owner,Group及Others这三个组别的read、write、execute属性。 文档的权限属性分别简写为r,w,x,这九个属性三个为一组,也可以使用数字来表示文档的权限,对照表如下: +> 在Linux中,文档具有十个属性,其中第一个属性为文档类型,后面九个为权限属性,分别为Owner,Group及Others这三个组别的read、write、execute属性。 文档的权限属性分别简写为r、w、x,这九个属性三个为一组,也可以使用数字来表示文档的权限,对照表如下: > > r: 4 > @@ -156,35 +155,37 @@ Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应 > > 同一组(owner/group/others)的三个属性是累加的。 > -> 例如,-rwxrwx-表示这个文档的权限为: +> 例如,-rwxrwx---表示这个文档的权限为: > > owner = rwx = 4+2+1 = 7 > > group = rwx = 4+2+1 = 7 > -> others = - = 0+0+0 = 0 +> others = --- = 0+0+0 = 0 > > 所以其权限为0770。 ## application_name -**参数说明**: 当前连接请求当中,所使用的客户端名称。 +**参数说明**:当前连接请求当中,所使用的客户端名称。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。 +在备机请求主机进行日志复制时,如果该参数非空串,那么会被用来作为备机在主机上的流复制槽名字。此时,如果该参数长度超过61个字节,那么流复制槽名字只会截取使用前61个字节的字符。 + +**取值范围**:字符串。 -**默认值**: 空字符串(连接到后端的应用名,以实际安装为准) +**默认值**:空字符串(连接到后端的应用名,以实际安装为准) ## connection_info -**参数说明**: 连接数据库的驱动类型、驱动版本号、当前驱动的部署路径和进程属主用户。 +**参数说明**:连接数据库的驱动类型、驱动版本号、当前驱动的部署路径和进程属主用户。 该参数属于USERSET类型参数,属于运维类参数,不建议用户设置。 -**取值范围**: 字符串。 +**取值范围**:字符串。 -**默认值**: 空字符串**。** +**默认值**:空字符串**。** > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > @@ -192,7 +193,7 @@ Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应 > - 驱动连接数据库的时候自行拼接的connection_info参数格式如下: > > ```sql -> {"driver_name":"ODBC","driver_version": "(MogDB 2.1.1 build 56189e20) compiled at 2022-01-07 18:47:53 commit 0 last mr","driver_path":"/usr/local/lib/psqlodbcw.so","os_user":"omm"} +> {"driver_name":"ODBC","driver_version": "(MogDB X.X.X build 56189e20) compiled at 2022-01-07 18:47:53 commit 0 last mr","driver_path":"/usr/local/lib/psqlodbcw.so","os_user":"omm"} > ``` > > 默认显示driver_name和driver_version,driver_path和os_user的显示由用户控制。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/2-security-and-authentication.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/2-security-and-authentication.md index 095961b91842d28115bf980b4d98b57bd544971b..06646d99a145b4fa08b98f1ddf56fcabdc979299 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/2-security-and-authentication.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/2-security-and-authentication.md @@ -11,213 +11,214 @@ date: 2021-04-20 ## authentication_timeout -**参数说明**: 完成客户端认证的最长时间。如果一个客户端没有在这段时间里完成与服务器端的认证,则服务器自动中断与客户端的连接,这样就避免了出问题的客户端无限制地占用连接数。 +**参数说明**:完成客户端认证的最长时间。如果一个客户端没有在这段时间里完成与服务器端的认证,则服务器自动中断与客户端的连接,这样就避免了出问题的客户端无限制地占用连接数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为1,最大值为600,最小单位为s。 +**取值范围**:整型,最小值为1,最大值为600,最小单位为s。 -**默认值**: 1min +**默认值**:1min ## auth_iteration_count -**参数说明**: 认证加密信息生成过程中使用的迭代次数。 +**参数说明**:认证加密信息生成过程中使用的迭代次数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,2048-134217728。 +**取值范围**:整型,2048-134217728。 -**默认值**: 10000 +**默认值**:10000 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > 迭代次数设置过小会降低口令存储的安全性,设置过大会导致认证、用户创建等涉及口令加密的场景性能劣化,请根据实际硬件条件合理设置迭代次数,推荐采用默认迭代次数。 ## session_authorization -**参数说明**: 当前会话的用户标识。 +**参数说明**:当前会话的用户标识。 该参数属于USERSET类型参数,此参数为内部参数,只能通过[SET SESSION AUTHORIZATION](SET-SESSION-AUTHORIZATION)语法设置,不支持直接设置。 -**取值范围**: 字符串。 +**取值范围**:字符串。 -**默认值**: NULL +**默认值**:NULL ## session_timeout -**参数说明**: 表明与服务器建立链接后,不进行任何操作的最长时间。 +**参数说明**:表明与服务器建立链接后,不进行任何操作的最长时间。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0-86400,最小单位为s,0表示关闭超时设置。 +**取值范围**:整型,0-86400,最小单位为s,0表示关闭超时设置。 -**默认值**: 10min +**默认值**:10min -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > MogDB gsql客户端中有自动重连机制,所以针对初始化用户本地连接,超时后gsql表现的现象为断开后重连。 ## ssl -**参数说明**: 启用SSL连接。请在使用这个选项之前阅读**使用gsql连接**。 +**参数说明**:启用SSL连接。请在使用这个选项之前阅读[gsql客户端连接](using-the-gsql-client-for-connection)。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示启用SSL连接。 - off表示不启用SSL连接。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> MogDB目前支持SSL的场景为客户端连接数据库主节点场景,该参数目前建议只在数据库主节点中开启,数据库节点默认值为off。开启此参数需要同时配置ssl_cert_file、ssl_key_file和ssl_ca_file等参数及对应文件,不正确的配置可能会导致MogDB无法正常启动。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> 开启此参数需要同时配置ssl_cert_file、ssl_key_file和ssl_ca_file等参数及对应文件,不正确的配置可能会导致MogDB无法正常启动。 -**默认值**: off +**默认值**:on ## require_ssl -**参数说明**: 设置服务器端是否强制要求SSL连接,该参数只有当参数[ssl](#ssl)为on时才有效。请在使用这个选项之前阅读**使用gsql连接**。 +**参数说明**:设置服务器端是否强制要求SSL连接,该参数只有当参数[ssl](#ssl)为on时才有效。请在使用这个选项之前阅读[gsql客户端连接](using-the-gsql-client-for-connection)。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示服务器端强制要求SSL连接。 - off表示服务器端对是否通过SSL连接不作强制要求。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > MogDB目前支持SSL的场景为客户端连接数据库主节点场景,该参数目前建议只在数据库主节点中开启。 -**默认值**: off +**默认值**:off ## ssl_ciphers -**参数说明**: 指定SSL支持的加密算法列表。 +**参数说明**:指定SSL支持的加密算法列表。ssl_ciphers设置错误会导致数据库不能正常启动。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串,如果指定多个加密算法,加密算法之间需要以分号分割。详细请参见**用SSL进行安全的TCP/IP连接**获取支持的加密算法。 +**取值范围**:字符串,如果指定多个加密算法,加密算法之间需要以分号分割。详细请参见[用SSL进行安全的TCP/IP连接](1-client-access-authentication#用ssl进行安全的tcpip连接)获取支持的加密算法。 -**默认值**: ALL +**默认值**:ALL ## ssl_renegotiation_limit -**参数说明**: 指定在会话密钥重新协商之前,通过SSL加密通道可以传输的流量。这个重新协商流量限制机制可以减少攻击者针对大量数据使用密码分析法破解密钥的几率,但是也带来较大的性能损失。流量是指发送和接受的流量总和。使用SSL重协商机制可能引入其他风险,因此已禁用SSL重协商机制,为保持版本兼容保留此参数,修改参数配置不再起作用。 +**参数说明**:指定在会话密钥重新协商之前,通过SSL加密通道可以传输的流量。这个重新协商流量限制机制可以减少攻击者针对大量数据使用密码分析法破解密钥的几率,但是也带来较大的性能损失。流量是指发送和接受的流量总和。使用SSL重协商机制可能引入其他风险,因此已禁用SSL重协商机制,为保持版本兼容保留此参数,修改参数配置不再起作用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0,最大值为2147483647。单位为KB。其中0表示禁用重新协商机制。 +**取值范围**:整型,最小值为0,最大值为2147483647。单位为KB。其中0表示禁用重新协商机制。 -**默认值**: 0 +**默认值**:0 ## ssl_cert_file -**参数说明**: 指定包含SSL服务器证书的文件的名称。相对路径是相对于数据目录的。 +**参数说明**:指定包含SSL服务器证书的文件的名称。相对路径是相对于数据目录的。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: server.crt +**默认值**:server.crt ## ssl_key_file -**参数说明**: 指定包含SSL私钥的文件名称。相对路径是相对于数据目录的。 +**参数说明**:指定包含SSL私钥的文件名称。相对路径是相对于数据目录的。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 取值范围:字符串 -**默认值**: server.key +**默认值**:server.key ## ssl_ca_file -**参数说明**: 指定包含CA信息的文件的名称。相对路径是相对于数据目录的。 +**参数说明**:指定包含CA信息的文件的名称。相对路径是相对于数据目录的。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串,其中空字符串表示没有CA文件被加载,不进行客户端证书验证。 -**默认值**: cacert.pem +**默认值**:cacert.pem ## ssl_crl_file -**参数说明**: 指定包含CRL信息的文件的名称。必须使用相对路径,相对路径是相对于数据目录的。 +**参数说明**:证书吊销列表,如果客户端证书在该列表中,则当前客户端证书被视为无效证书。必须使用相对路径,相对路径是相对于数据目录的。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,其中空表示没有CA文件被加载,不进行客户端证书验证。 +**取值范围**:字符串,空字符串表示没有吊销列表。 -**默认值**: 空 +**默认值**:空 ## krb_server_keyfile -**参数说明**: 指定Kerberos服务主配置文件的位置,详细请参见**配置客户端接入认证**。 +**参数说明**:指定Kerberos服务主配置文件的位置,详细请参见[配置客户端接入认证](1-client-access-authentication#配置客户端接入认证)。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 ## krb_srvname -**参数说明**: 设置Kerberos服务名,详细请参见**配置客户端接入认证**。 +**参数说明**:设置Kerberos服务名,详细请参见[配置客户端接入认证](1-client-access-authentication#配置客户端接入认证)。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: postgres +**默认值**:postgres ## krb_caseins_users -**参数说明**: 设置Kerberos用户名是否大小写敏感。 +**参数说明**:设置Kerberos用户名是否大小写敏感。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示大小写不敏感。 - off表示大小写敏感。 -**默认值**: off +**默认值**:off ## modify_initial_password -**参数说明**: 当MogDB安装成功后,数据库中仅存在一个初始用户(UID为10的用户)。客户通过该帐户初次登录数据库进行操作时,该参数决定是否要对该初始帐户的密码进行修改。 +**参数说明**:当MogDB安装成功后,数据库中仅存在一个初始用户(UID为10的用户)。客户通过该帐户初次登录数据库进行操作时,该参数决定是否要对该初始帐户的密码进行修改。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 如果安装过程中未指定初始用户密码,则安装后初始用户密码默认为空,执行其他操作前需要先通过gsql客户端设置初始用户的密码。此参数功能不再生效,保留此参数仅为兼容升级场景。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示MogDB安装成功后初始用户首次登录操作前需要修改初始密码。 - off表示MogDB安装成功后初始用户无需修改初始密码即可进行操作。 -**默认值**: off +**默认值**:off ## password_policy -**参数说明**: 在使用CREATE ROLE/USER或者ALTER ROLE/USER命令创建或者修改MogDB帐户时,该参数决定是否进行密码复杂度检查。关于密码复杂度检查策略请参见**设置密码安全策略**。 +**参数说明**:在使用CREATE ROLE/USER或者ALTER ROLE/USER命令创建或者修改MogDB帐户时,该参数决定是否进行密码复杂度检查。关于密码复杂度检查策略请参见[设置密码安全策略](2-managing-users-and-their-permissions#设置密码安全策略)。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > 从安全性考虑,请勿关闭密码复杂度策略。 -**取值范围:**0、1 +**取值范围**:0、1 -- 0表示不采用任何密码复杂度策略。 +- 0表示不采用密码复杂度校验策略。 - 1表示采用默认密码复杂度校验策略。 -**默认值**: 1 +**默认值**:1 ## password_reuse_time -**参数说明**: 在使用ALTER USER或者ALTER ROLE修改用户密码时,该参数指定是否对新密码进行可重用天数检查。关于密码可重用策略请参见**设置密码安全策略**。 +**参数说明**:在使用ALTER USER或者ALTER ROLE修改用户密码时,该参数指定是否对新密码进行可重用天数检查。关于密码可重用策略请参见[设置密码安全策略](2-managing-users-and-their-permissions#设置密码安全策略)。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > 修改密码时会检查配置参数[password_reuse_time](#password_reuse_time)和[password_reuse_max](#password_reuse_max)。 > > - 当[password_reuse_time](#password_reuse_time)和[password_reuse_max](#password_reuse_max)都为正数时,只要满足其中任一个,即可认为密码可以重用。 @@ -225,16 +226,16 @@ date: 2021-04-20 > - 当[password_reuse_max](#password_reuse_max)为0时,表示不限制密码重用次数,仅限制密码重用天数。 > - 当[password_reuse_time](#password_reuse_time)和[password_reuse_max](#password_reuse_max)都为0时,表示不对密码重用进行限制。 -**取值范围:**浮点型,最小值为0,最大值为3650,单位为天。 +**取值范围**:浮点型,最小值为0,最大值为3650,单位为天。 - 0表示不检查密码可重用的天数。 - 正数表示新密码不能为该值指定的天数内使用过的密码。 -**默认值**: 60 +**默认值**:60 ## password_reuse_max -**参数说明**: 在使用ALTER USER或者ALTER ROLE修改用户密码时,该参数指定是否对新密码进行可重用次数检查。关于密码可重用策略请参见**设置密码安全策略**。 +**参数说明**:在使用ALTER USER或者ALTER ROLE修改用户密码时,该参数指定是否对新密码进行可重用次数检查。关于密码可重用策略请参见[设置密码安全策略](2-managing-users-and-their-permissions#设置密码安全策略)。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -246,157 +247,157 @@ date: 2021-04-20 > - 当[password_reuse_max](#password_reuse_max)为0时,表示不限制密码重用次数,仅限制密码重用天数。 > - 当[password_reuse_time](#password_reuse_time)和[password_reuse_max](#password_reuse_max)都为0时,表示不对密码重用进行限制。 -**取值范围:**整型,最小值为0,最大值为1000。 +**取值范围**:整型,最小值为0,最大值为1000。 - 0表示不检查密码可重用次数。 - 正整数表示新密码不能为该值指定的次数内使用过的密码。 -**默认值**: 0 +**默认值**:0 ## password_lock_time -**参数说明**: 该参数指定帐户被锁定后自动解锁的时间。关于帐户自动锁定策略请参见**设置密码安全策略**。 +**参数说明**:该参数指定帐户被锁定后自动解锁的时间。关于帐户自动锁定策略请参见[设置密码安全策略](2-managing-users-and-their-permissions#设置密码安全策略)。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > password_lock_time和[failed_login_attempts](#failed_login_attempts)必须都为正数时锁定和解锁功能才能生效。 -**取值范围:**浮点型,最小值为0,最大值为365,单位为天。 +**取值范围**:浮点型,最小值为0,最大值为365,单位为天。 - 0表示密码验证失败时,自动锁定功能不生效。 - 正数表示帐户被锁定后,当锁定时间超过password_lock_time设定的值时,帐户将会被自行解锁。 -**默认值**: 1d +**默认值**:1d ## failed_login_attempts -**参数说明**: 在任意时在任意时候,如果输入密码错误的次数达到failed_login_attempts参数设定的值,则当前帐户会被锁定。password_lock_time参数设定的天数过后,帐户自动解锁。例如,登录时输入密码失败,ALTER USER时修改密码失败等。关于帐户自动锁定策略请参见**设置密码安全策略**。 +**参数说明**:在任意时在任意时候,如果输入密码错误的次数达到failed_login_attempts参数设定的值,则当前帐户会被锁定。password_lock_time参数设定的天数过后,帐户自动解锁。例如,登录时输入密码失败,ALTER USER时修改密码失败等。关于帐户自动锁定策略请参见[设置密码安全策略](2-managing-users-and-their-permissions#设置密码安全策略)。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > failed_login_attempts和[password_lock_time](#password_lock_time)必须都为正数时锁定和解锁功能才能生效。 -**取值范围:**整型,最小值为0,最大值为1000。 +**取值范围**:整型,最小值为0,最大值为1000。 - 0表示自动锁定功能不生效。 - 正整数表示当错误密码次数达到failed_login_attempts设定的值时,当前帐户将被锁定。 -**默认值**: 10 +**默认值**:10 ## password_encryption_type -**参数说明**: 该字段决定采用何种加密方式对用户密码进行加密存储。修改此参数的配置不会自动触发已有用户密码加密方式的修改,只会影响新创建用户或修改用户密码操作。 +**参数说明**:该字段决定采用何种加密方式对用户密码进行加密存储。修改此参数的配置不会自动触发已有用户密码加密方式的修改,只会影响新创建用户或修改用户密码操作。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**0、1、2、3 +**取值范围**:0、1、2、3 - 0表示采用md5方式对密码加密。 - 1表示采用sha256和md5两种方式分别对密码加密。 - 2表示采用sha256方式对密码加密。 - 3表示采用sm3方式对密码加密。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > md5加密算法安全性低,存在安全风险,不建议用户使用。 -**默认值**: 2 +**默认值**:2 ## password_min_length -**参数说明**: 该字段决定帐户密码的最小长度。 +**参数说明**:该字段决定帐户密码的最小长度。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,6~999个字符。 +**取值范围**:整型,6~999个字符。 -**默认值**: 8 +**默认值**:8 ## password_max_length -**参数说明**: 该字段决定帐户密码的最大长度。 +**参数说明**:该字段决定帐户密码的最大长度。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,6~999个字符。 +**取值范围**:整型,6~999个字符。 -**默认值**: 32 +**默认值**:32 ## password_min_uppercase -**参数说明**: 该字段决定帐户密码中至少需要包含大写字母个数。 +**参数说明**:该字段决定帐户密码中至少需要包含大写字母个数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~999 +**取值范围**:整型,0~999 - 0表示没有限制。 - 1~999表示创建账户所指定的密码中至少需要包含大写字母个数。 -**默认值**: 0 +**默认值**:0 ## password_min_lowercase -**参数说明**: 该字段决定帐户密码中至少需要包含小写字母的个数。 +**参数说明**:该字段决定帐户密码中至少需要包含小写字母的个数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~999 +**取值范围**:整型,0~999 - 0表示没有限制。 - 1~999表示创建帐户所指定的密码中至少需要包含小写字母个数。 -**默认值**: 0 +**默认值**:0 ## password_min_digital -**参数说明**: 该字段决定帐户密码中至少需要包含数字的个数。 +**参数说明**:该字段决定帐户密码中至少需要包含数字的个数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~999 +**取值范围**:整型,0~999 - 0表示没有限制。 - 1~999表示创建帐户所指定的密码中至少需要包含数字个数。 -**默认值**: 0 +**默认值**:0 ## password_min_special -**参数说明**: 该字段决定帐户密码中至少需要包含特殊字符个数。 +**参数说明**:该字段决定帐户密码中至少需要包含特殊字符个数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~999 +**取值范围**:整型,0~999 - 0表示没有限制。 - 1~999表示创建帐户所指定的密码中至少需要包含特殊字符个数。 -**默认值**: 0 +**默认值**:0 ## password_effect_time -**参数说明**: 该字段决定帐户密码的有效时间。 +**参数说明**:该字段决定帐户密码的有效时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**浮点型,最小值为0,最大值为999,单位为天。 +**取值范围**:浮点型,最小值为0,最大值为999,单位为天。 - 0表示不开启有效期限制功能。 - 1~999表示创建帐户所指定的密码有效期,临近或超过有效期系统会提示用户修改密码。 -**默认值**: 90 +**默认值**:90 ## password_notify_time -**参数说明**: 该字段决定帐户密码到期前提醒的天数。 +**参数说明**:该字段决定帐户密码到期前提醒的天数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,最小值为0,最大值为999,单位为天。 +**取值范围**:整型,最小值为0,最大值为999,单位为天。 - 0表示不开启提醒功能。 - 1~999表示帐户密码到期前提醒的天数。 -**默认值**: 7 +**默认值**:7 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/3-communication-library-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/3-communication-library-parameters.md index 2b51a7f255fa13492d620a6b9feb5465f712ebe5..5b3de42ca63efa8c67fde572129ec0c97c506689 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/3-communication-library-parameters.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/3-connection-and-authentication/3-communication-library-parameters.md @@ -11,7 +11,7 @@ date: 2021-04-20 ## tcp_keepalives_idle -**参数说明**: 在支持TCP_KEEPIDLE套接字选项的系统上,设置发送活跃信号的间隔秒数。不设置发送保持活跃信号,连接就会处于闲置状态。 +**参数说明**:在支持TCP_KEEPIDLE套接字选项的系统上,设置发送活跃信号的间隔秒数。不设置发送保持活跃信号,连接就会处于闲置状态。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -24,19 +24,19 @@ date: 2021-04-20 > - 该参数在不同的**会话之间不共享**,也就是说不同的会话连接可能有不同的值。 > - 查看该参数时查出来的是**当前会话连接内的参数值**,而不是**guc副本的值**。 -**取值范围**: 0-3600,单位为s。 +**取值范围**:0-3600,单位为s。 -**默认值**: 0 +**默认值**:0 ## tcp_keepalives_interval -**参数说明**: 在支持TCP_KEEPINTVL套接字选项的操作系统上,以秒数声明在重新传输之间等待响应的时间。 +**参数说明**:在支持TCP_KEEPINTVL套接字选项的操作系统上,以秒数声明在重新传输之间等待响应的时间。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 0-180,单位为s。 +**取值范围**:0-180,单位为s。 -**默认值**: 0 +**默认值**:0 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > @@ -48,7 +48,7 @@ date: 2021-04-20 ## tcp_keepalives_count -**参数说明**: 在支持TCP_KEEPCNT套接字选项的操作系统上,设置MogDB服务端在断开与客户端连接之前可以等待的保持活跃信号个数。 +**参数说明**:在支持TCP_KEEPCNT套接字选项的操作系统上,设置MogDB服务端在断开与客户端连接之前可以等待的保持活跃信号个数。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -60,13 +60,13 @@ date: 2021-04-20 > - 该参数在不同的**会话之间不共享**,也就是说不同的会话连接可能有不同的值。 > - 查看该参数时查出来的是**当前会话连接内的参数值**,而不是**guc副本的值**。 -**取值范围**: 0-100,其中0表示MogDB未收到客户端反馈的保持活跃信号则立即断开连接。 +**取值范围**:0-100,其中0表示MogDB未收到客户端反馈的保持活跃信号则立即断开连接。 -**默认值**: 0 +**默认值**:0 ## comm_proxy_attr -**参数说明**: 通信代理库相关参数配置。 +**参数说明**:通信代理库相关参数配置。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > @@ -84,4 +84,4 @@ date: 2021-04-20 **取值范围**:字符串,长度大于0。 -**默认值**: 'none' +**默认值**:'none' 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 dca858ae58958dbcc952a7f7125c58fdde09ae93..aaded6aa9c8aa462a4dc6bfc60038886d0633920 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,11 +9,11 @@ date: 2021-06-07 ## job_queue_processes -**参数说明**: 表示系统可以并发执行的job数目。该参数为postmaster级别,通过gs_guc设置,需要重启gaussdb才能生效。 +**参数说明**:表示系统可以并发执行的job数目。该参数为postmaster级别,通过gs_guc设置,需要重启gaussdb才能生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 0~1000 +**取值范围**:0~1000 功能: @@ -26,7 +26,7 @@ date: 2021-06-07 注:如果同一时间内并行的job数很多,过小的参数值会导致job等待。而过大的参数值则消耗更多的系统资源,建议设置此参数为100,用户可以根据系统资源情况合理调整。 -**默认值**: 10 +**默认值**:10 ## enable_prevent_job_task_startup 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 940b19cd7f1e8e7073f7ed394883b0e3d54648eb..0b4c48f487248bcd1829eff54bccd57030082f1e 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 @@ -9,33 +9,33 @@ date: 2021-11-08 ## udf_memory_limit -**参数说明**: 控制每个数据库节点执行UDF时可用的最大物理内存量。本参数当前版本不生效,请使用FencedUDFMemoryLimit和UDFWorkerMemHardLimit参数控制fenced udf worker虚存。 +**参数说明**:控制每个数据库节点执行UDF时可用的最大物理内存量。本参数当前版本不生效,请使用FencedUDFMemoryLimit和UDFWorkerMemHardLimit参数控制fenced udf worker虚存。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,200\*1024~max_process_memory,单位为KB。 +**取值范围**:整型,200\*1024~max_process_memory,单位为KB。 -**默认值**: 200MB +**默认值**:200MB ## FencedUDFMemoryLimit -**参数说明**: 控制每个fenced udf worker进程使用的虚拟内存。 +**参数说明**:控制每个fenced udf worker进程使用的虚拟内存。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整数,0 \~ 2147483647,单位为KB,设置可带单位(KB,MB,GB)。其中0表示不做内存控制。 +**取值范围**:整数,0 \~ 2147483647,单位为KB,设置可带单位(KB,MB,GB)。其中0表示不做内存控制。 -**默认值**: 0 +**默认值**:0 ## UDFWorkerMemHardLimit -**参数说明**: 控制fencedUDFMemoryLimit的最大值。 +**参数说明**:控制fencedUDFMemoryLimit的最大值。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整数,0 \~ 2147483647,单位为KB,设置时可带单位(KB,MB,GB)。 +**取值范围**:整数,0 \~ 2147483647,单位为KB,设置时可带单位(KB,MB,GB)。 -**默认值**: 1GB +**默认值**:1GB ## pljava_vmoptions @@ -43,7 +43,7 @@ date: 2021-11-08 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,支持: +**取值范围**:字符串,支持: - JDK8 JVM启动参数(可参见JDK[官方](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html)说明) - JDK8 JVM系统属性参数(以-D开头如-Djava.ext.dirs,可参见JDK[官方](https://docs.oracle.com/javase/tutorial/deployment/doingMoreWithRIA/properties.html)说明) @@ -52,4 +52,4 @@ date: 2021-11-08 > ![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/34-backup-and-restoration.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/34-backup-and-restoration.md index 347be8f065f9f56eeae8c06df610198f405ddfb0..de94a15dcacdc209ba2e0ab304dd1db784320573 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/34-backup-and-restoration.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/34-backup-and-restoration.md @@ -9,29 +9,29 @@ date: 2021-11-08 ## operation_mode -**参数说明**: 标示系统进入备份恢复模式。 +**参数说明**:标示系统进入备份恢复模式。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示在备份恢复过程中。 - off表示不在备份恢复过程中。 -**默认值**: off +**默认值**:off ## enable_cbm_tracking -**参数说明**: 当使用roach执行数据库实例的全量和增量备份时需要开启此参数,如果关闭会导致备份失败。 +**参数说明**:当使用roach执行数据库实例的全量和增量备份时需要开启此参数,如果关闭会导致备份失败。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示追踪功能开启。 - off表示追踪功能关闭。 -**默认值**: off +**默认值**:off ## hadr_max_size_for_xlog_receiver 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 853f43e5617af81018417118157a2cf63a17345e..d3bb09204abd5c6173ed43e5b0ddfcb5c33e6ab6 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,35 +9,35 @@ date: 2021-11-08 ## undo_space_limit_size -**参数说明**: 用于控制undo强制回收阈值,达到阈值的80%启动强制回收。 +**参数说明**:用于控制undo强制回收阈值,达到阈值的80%启动强制回收。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,800M~16TB +**取值范围**:整型,800M~16TB -**默认值**: 32GB +**默认值**:32GB ## undo_limit_size_per_transaction -**参数说明**: 用于控制单事务undo分配空间阈值,达到阈值时事务报错回滚。 +**参数说明**:用于控制单事务undo分配空间阈值,达到阈值时事务报错回滚。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,2M~16TB +**取值范围**:整型,2M~16TB -**默认值**: 32GB +**默认值**:32GB ## undo_zone_count -**参数说明**: 用于控制在内存中可分配的undo zone数量,达到阈值或本次设置的数值小于上次时报错,重新按规则设置合理取值后可恢复正常。当参数设置为0时,禁用undo,禁止创建ustore表。 +**参数说明**:用于控制在内存中可分配的undo zone数量,达到阈值或本次设置的数值小于上次时报错,重新按规则设置合理取值后可恢复正常。当参数设置为0时,禁用undo,禁止创建ustore表。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~1,048,576 +**取值范围**:整型,0~1,048,576 取值约束: 1. 本次设置数值不得小于上次设置的数值,设置错误时会导致数据库无法正常恢复,重新合理设置后重启数据库可恢复正常。 2. 当前undo_zone_count取值需要根据max_connections来调节设置,修改max_connections取值后,需对应修改undo_zone_count,取值规则为max_connections取值的4倍。 -**默认值**: 0 +**默认值**: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 91d9766e5c3c17ad81dcd15280d2bd57e1d5aff1..25a8cc221593993a9921f989ef7a86ba4942ea63 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 @@ -9,103 +9,103 @@ date: 2021-11-08 ## enable_dcf -**参数说明**: 是否开启DCF模式,该参数不允许修改。 +**参数说明**:是否开启DCF模式,该参数不允许修改。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型,on/off。on表示当前安装部署方式为DCF模式,off表示当前安装部署方式为非DCF模式。 +**取值范围**:布尔型,on/off。on表示当前安装部署方式为DCF模式,off表示当前安装部署方式为非DCF模式。 -**默认值**: off +**默认值**:off ## dcf_ssl -**参数说明**: 是否开启SSL,重启生效。 +**参数说明**:是否开启SSL,重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型,on/off。on表示使用SSL,off表示不使用SSL。 +**取值范围**:布尔型,on/off。on表示使用SSL,off表示不使用SSL。 -**默认值**: on +**默认值**:on ## dcf_config -**参数说明**: 用户安装时自定义配置信息,该参数不允许修改。 +**参数说明**:用户安装时自定义配置信息,该参数不允许修改。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**默认值**: 字符串,安装时用户自定义配置 +**默认值**:字符串,安装时用户自定义配置 ## dcf_data_path -**参数说明**: DCF数据路径,该参数不允许修改。 +**参数说明**:DCF数据路径,该参数不允许修改。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**默认值**: 字符串,DN数据目录下的dcf_data目录 +**默认值**:字符串,DN数据目录下的dcf_data目录 ## dcf_log_path -**参数说明**: DCF日志路径,该参数不允许修改。 +**参数说明**:DCF日志路径,该参数不允许修改。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**默认值**: 字符串,DN数据目录下的dcf_log目录 +**默认值**:字符串,DN数据目录下的dcf_log目录 ## dcf_node_id -**参数说明**: DCF所在DN节点ID,用户安装时自定义,该参数不允许修改。 +**参数说明**:DCF所在DN节点ID,用户安装时自定义,该参数不允许修改。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**默认值**: 整型,安装时用户自定义配置 +**默认值**:整型,安装时用户自定义配置 ## dcf_max_workers -**参数说明**: DCF回调函数线程个数。 +**参数说明**:DCF回调函数线程个数。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,10~262143 +**取值范围**:整型,10~262143 -**默认值**: 10 +**默认值**:10 ## dcf_truncate_threshold -**参数说明**: DN对DCF日志进行truncate的门限阈值。 +**参数说明**:DN对DCF日志进行truncate的门限阈值。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~2147483647 +**取值范围**:整型,1~2147483647 -**默认值**: 100000 +**默认值**:100000 ## dcf_election_timeout -**参数说明**: DCF leader和follower选举超时时间。选举超时时间数值依赖于当前DN之间的网络状况,在超时时间较小且网络极差的情形下,会有超时选举发生,待网络恢复选举恢复正常。建议根据当前网络状态合理设置超时时间。对DCF节点时钟的约束:DCF节点间最大时钟差异小于选举超时时间的一半。 +**参数说明**:DCF leader和follower选举超时时间。选举超时时间数值依赖于当前DN之间的网络状况,在超时时间较小且网络极差的情形下,会有超时选举发生,待网络恢复选举恢复正常。建议根据当前网络状态合理设置超时时间。对DCF节点时钟的约束:DCF节点间最大时钟差异小于选举超时时间的一半。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位s,1~600 +**取值范围**:整型,单位s,1~600 -**默认值**: 3 +**默认值**:3 ## dcf_run_mode -**参数说明**: DCF选举模式,0表示自动选举模式,2表示去使能选举模式。 +**参数说明**:DCF选举模式,0表示自动选举模式,2表示去使能选举模式。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 枚举类型,0、2 +**取值范围**:枚举类型,0、2 -**默认值**: 0 +**默认值**:0 ## dcf_log_level -**参数说明**: DCF日志级别。 +**参数说明**:DCF日志级别。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串 +**取值范围**:字符串 - **关闭日志**:“NONE”,NONE表示关闭日志打印,不能与以下日志级别混合使用。 @@ -113,232 +113,232 @@ date: 2021-11-08 日志级别可以从上述字符串中选取字符串并使用竖线组合使用,不能配置空串。 -**默认值**: “RUN_ERR|RUN_WAR|DEBUG_ERR|OPER|RUN_INF|PROFILE” +**默认值**:“RUN_ERR|RUN_WAR|DEBUG_ERR|OPER|RUN_INF|PROFILE” ## dcf_log_backup_file_count -**参数说明**: DCF运行日志备份保留个数。 +**参数说明**:DCF运行日志备份保留个数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~100 +**取值范围**:整型,1~100 -**默认值**: 10 +**默认值**:10 ## dcf_max_log_file_size -**参数说明**: DCF运行日志单个文件最大大小。 +**参数说明**:DCF运行日志单个文件最大大小。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位MB,1~1000 +**取值范围**:整型,单位MB,1~1000 -**默认值**: 10 +**默认值**:10 ## dcf_socket_timeout -**参数说明**: DCF通信模块连接socket超时时间,参数重启生效。对于网络环境比较差的环境,若配置很小的超时时间,可能会导致建链不成功,此时需要适当增大此值。 +**参数说明**:DCF通信模块连接socket超时时间,参数重启生效。对于网络环境比较差的环境,若配置很小的超时时间,可能会导致建链不成功,此时需要适当增大此值。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位ms,10~600000 +**取值范围**:整型,单位ms,10~600000 -**默认值**: 5000 +**默认值**:5000 ## dcf_connect_timeout -**参数说明**: DCF通信模块建立连接超时时间,参数重启生效。对于网络环境比较差的环境,若配置很小的超时时间,可能会导致建链不成功,此时需要适当增大此值。 +**参数说明**:DCF通信模块建立连接超时时间,参数重启生效。对于网络环境比较差的环境,若配置很小的超时时间,可能会导致建链不成功,此时需要适当增大此值。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位ms,10~600000 +**取值范围**:整型,单位ms,10~600000 -**默认值**: 60000 +**默认值**:60000 ## dcf_mec_fragment_size -**参数说明**: DCF通信模块fragment大小,参数重启生效。 +**参数说明**:DCF通信模块fragment大小,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位KB,32~10240 +**取值范围**:整型,单位KB,32~10240 -**默认值**: 64 +**默认值**:64 ## dcf_stg_pool_max_size -**参数说明**: DCF存储模内存池最大值,参数重启生效。 +**参数说明**:DCF存储模内存池最大值,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位MB,32~2147483647 +**取值范围**:整型,单位MB,32~2147483647 -**默认值**: 2048 +**默认值**:2048 ## dcf_stg_pool_init_size -**参数说明**: DCF存储模块内存池最小值,参数重启生效。 +**参数说明**:DCF存储模块内存池最小值,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位MB,32~2147483647 +**取值范围**:整型,单位MB,32~2147483647 -**默认值**: 32 +**默认值**:32 ## dcf_mec_pool_max_size -**参数说明**: DCF通信模块内存池最大值,参数重启生效。 +**参数说明**:DCF通信模块内存池最大值,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位MB,32~2147483647 +**取值范围**:整型,单位MB,32~2147483647 -**默认值**: 200 +**默认值**:200 ## dcf_flow_control_disk_rawait_threshold -**参数说明**: DCF流控功能的磁盘等待阈值。 +**参数说明**:DCF流控功能的磁盘等待阈值。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位us,0~2147483647 +**取值范围**:整型,单位us,0~2147483647 -**默认值**: 100000 +**默认值**:100000 ## dcf_flow_control_net_queue_message_num_threshold -**参数说明**: DCF流控功能的网络队列消息数阈值。 +**参数说明**:DCF流控功能的网络队列消息数阈值。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~2147483647 +**取值范围**:整型,0~2147483647 -**默认值**: 1024 +**默认值**:1024 ## dcf_flow_control_cpu_threshold -**参数说明**: DCF CPU流控阈值。 +**参数说明**:DCF CPU流控阈值。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位百分比,0~2147483647 +**取值范围**:整型,单位百分比,0~2147483647 -**默认值**: 100 +**默认值**:100 ## dcf_mec_batch_size -**参数说明**: DCF通信批量消息数,数值为0时,DCF会根据网络以及写入数据量自适应调整,参数重启生效。 +**参数说明**:DCF通信批量消息数,数值为0时,DCF会根据网络以及写入数据量自适应调整,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~1024 +**取值范围**:整型,0~1024 -**默认值**: 0 +**默认值**:0 ## dcf_mem_pool_max_size -**参数说明**: DCF内存最大值,参数重启生效。 +**参数说明**:DCF内存最大值,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位MB,32~2147483647 +**取值范围**:整型,单位MB,32~2147483647 -**默认值**: 2048 +**默认值**:2048 ## dcf_mem_pool_init_size -**参数说明**: DCF内存初始化大小,参数重启生效。 +**参数说明**:DCF内存初始化大小,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,单位MB,32~2147483647 +**取值范围**:整型,单位MB,32~2147483647 -**默认值**: 32 +**默认值**:32 ## dcf_compress_algorithm -**参数说明**: DCF运行日志传输压缩算法,参数重启生效。 +**参数说明**:DCF运行日志传输压缩算法,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型 +**取值范围**:整型 - 0表示不压缩 - 1表示ZSTD压缩算法 - 2表示LZ4压缩算法 -**默认值**: 0 +**默认值**:0 ## dcf_compress_level -**参数说明**: DCF日志传输压缩级别,参数重启生效,此参数生效前提必须配置有效的压缩算法,即设置合法的dcf_compress_algorithm参数。 +**参数说明**:DCF日志传输压缩级别,参数重启生效,此参数生效前提必须配置有效的压缩算法,即设置合法的dcf_compress_algorithm参数。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型 +**取值范围**:整型 - 若不使用压缩算法,取值不生效 - 若选择ZSTD压缩算法,取值范围1~22 - 若选择LZ4压缩算法,取值范围1~9 -**默认值**: 1 +**默认值**:1 ## dcf_mec_channel_num -**参数说明**: DCF通信通道数量,参数重启生效。 +**参数说明**:DCF通信通道数量,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~64 +**取值范围**:整型,1~64 -**默认值**: 1 +**默认值**:1 ## dcf_rep_append_thread_num -**参数说明**: DCF日志复制线程数量,参数重启生效。 +**参数说明**:DCF日志复制线程数量,参数重启生效。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~1000 +**取值范围**:整型,1~1000 -**默认值**: 2 +**默认值**:2 ## 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)中对应设置方法进行设置。 -**取值范围**: 整型,1~1000 +**取值范围**:整型,1~1000 -**默认值**: 10 +**默认值**:10 ## dcf_mec_reactor_thread_num -**参数说明**: DCF使用reactor线程数量,参数重启生效。dcf_mec_reactor_thread_num与dcf_mec_agent_thread_num比例建议1:40。 +**参数说明**:DCF使用reactor线程数量,参数重启生效。dcf_mec_reactor_thread_num与dcf_mec_agent_thread_num比例建议1:40。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~100 +**取值范围**:整型,1~100 -**默认值**: 1 +**默认值**:1 ## dcf_log_file_permission -**参数说明**: DCF运行日志文件属性,参数重启生效。若用户需要支持同组的其他用户访问日志,首先需要所有的父目录都支持同组的其他用户也能访问。 +**参数说明**:DCF运行日志文件属性,参数重启生效。若用户需要支持同组的其他用户访问日志,首先需要所有的父目录都支持同组的其他用户也能访问。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 枚举型,600、640 +**取值范围**:枚举型,600、640 -**默认值**: 600 +**默认值**:600 ## dcf_log_path_permission -**参数说明**: DCF运行日志目录属性,参数重启生效,不支持修改。 +**参数说明**:DCF运行日志目录属性,参数重启生效,不支持修改。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 枚举型,700、750 +**取值范围**:枚举型,700、750 -**默认值**: 700 +**默认值**:700 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/38-rollback-parameters.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/38-rollback-parameters.md index 9769c979bacec168b87d983640e76c1ebb8adeb2..bc7109fc61b133b7463945c9efd303d3f6cf2133 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/38-rollback-parameters.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/38-rollback-parameters.md @@ -9,10 +9,10 @@ date: 2021-11-08 ## max_undo_workers -**参数说明**: 异步回滚调用的undoworker线程数量,参数重启生效。 +**参数说明**:异步回滚调用的undoworker线程数量,参数重启生效。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~100 +**取值范围**:整型,1~100 -**默认值**: 5 +**默认值**:5 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/1-memory.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/1-memory.md index 0b98baa9aec4b795d185e33a27f3f704ba656262..4f7af5e37c06fed935767040ef39b707dbd972a8 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/1-memory.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/1-memory.md @@ -9,110 +9,111 @@ date: 2021-04-20 介绍与内存相关的参数设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 这些参数只能在数据库服务重新启动后生效。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:**这些参数只能在数据库服务重新启动后生效。 ## memorypool_enable -**参数说明**: 设置是否允许使用内存池。 +**参数说明**:设置是否允许使用内存池。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示允许使用内存池。 - off表示不允许使用内存池。 -**默认值**: off +**默认值**:off ## memorypool_size -**参数说明**: 设置内存池大小。 +**参数说明**:设置内存池大小。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,128*1024~INT_MAX/2,单位为KB。 +**取值范围**:整型,128*1024~INT_MAX/2,单位为KB。 -**默认值**: 512MB +**默认值**:512MB ## enable_memory_limit -**参数说明**: 启用逻辑内存管理模块。 +**参数说明**:启用逻辑内存管理模块。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示启用逻辑内存管理模块。 - off表示不启用逻辑内存管理模块。 -**默认值**: on +**默认值**:on -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > > - 若max_process_memory-shared_buffers-cstore_buffers-元数据少于2G,MogDB强制把enable_memory_limit设置为off。其中元数据是MogDB内部使用的内存和部分并发参数,如max_connections、thread_pool_attr、max_prepared_transactions等参数相关。 > - 当该值为off时,不对数据库使用的内存做限制,在大并发或者复杂查询时,使用内存过多,可能导致操作系统OOM问题。 ## max_process_memory -**参数说明**: 设置一个数据库节点可用的最大物理内存。 +**参数说明**:设置一个数据库节点可用的最大物理内存。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型 , `2*1024*1024` ~ INT_MAX,单位为KB。 +**取值范围**:整型 , `2*1024*1024` ~ INT_MAX,单位为KB。 + +**默认值**:12GB。 -**默认值**: 12GB。 +**设置建议:** -**设置建议:** +数据库节点上该数值需要根据系统物理内存及单节点部署主数据库节点个数决定。建议计算公式如下:`(物理内存大小 - vm.min_free_kbytes) * 0.7 / (1 + 主节点个数)`。该系数的目的是尽可能保证系统的可靠性,不会因数据库内存膨胀导致节点OOM。这个公式中提到vm.min_free_kbytes,其含义是预留操作系统内存供内核使用,通常用作操作系统内核中通信收发内存分配,至少为5%内存。即,max_process_memory = `物理内存 * 0.665 / (1 + 主节点个数)`。 -数据库节点上该数值需要根据系统物理内存及单节点部署主数据库节点个数决定。建议计算公式如下: `(物理内存大小 - vm.min_free_kbytes) * 0.7 / (1 + 主节点个数)`。该系数的目的是尽可能保证系统的可靠性,不会因数据库内存膨胀导致节点OOM。这个公式中提到vm.min_free_kbytes,其含义是预留操作系统内存供内核使用,通常用作操作系统内核中通信收发内存分配,至少为5%内存。即,max_process_memory = `物理内存 * 0.665 / (1 + 主节点个数)`。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-caution.gif) **注意:** 当该值设置不合理,即大于服务器物理内存,可能导致操作系统OOM问题。 ## enable_memory_context_control -**参数说明**: 启用检查内存上下文是否超过给定限制的功能。仅适用于DEBUG版本。 +**参数说明**:启用检查内存上下文是否超过给定限制的功能。仅适用于DEBUG版本。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示启用最大内存上下文限制检查功能。 - off表示关闭最大内存上下文限制检查功能。 -**默认值**: off +**默认值**:off ## uncontrolled_memory_context -**参数说明**: 启用检查内存上下文是否超过给定限制的功能时,设置不受此功能约束。仅适用于DEBUG版本。 +**参数说明**:启用检查内存上下文是否超过给定限制的功能时,设置不受此功能约束。仅适用于DEBUG版本。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 查询时会在参数值的最前面添加标题含义字符串“MemoryContext white list:”。 -**取值范围**: 字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 ## shared_buffers -**参数说明**: 设置MogDB使用的共享内存大小。增加此参数的值会使MogDB比系统默认设置需要更多的System V共享内存。 +**参数说明**:设置MogDB使用的共享内存大小。增加此参数的值会使MogDB比系统默认设置需要更多的System V共享内存。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,16 ~ 1073741823 ,单位为KB。 +**取值范围**:整型,16 ~ 1073741823 ,单位为KB。 shared_buffers需要设置为BLCKSZ的整数倍,BLCKSZ目前设置为8KB,即shared_buffers需要设置为8KB整数倍。改变BLCKSZ的值会改变最小值。 -**默认值**: 数据库节点为1GB。如果操作系统支持的共享内存小于32MB,则在初始化数据存储区时会自动调整为操作系统支持的最大值。 +**默认值**:8MB -**设置建议:** +**设置建议:** -建议设置shared_buffers值为内存的40%以内。行存列存分开对待。行存设大,列存设小。列存: `(单服务器内存/单服务器数据库节点个数) * 0.4 * 0.25`。 +建议设置shared_buffers值为内存的40%以内。行存列存分开对待。行存设大,列存设小。列存:`(单服务器内存/单服务器数据库节点个数) * 0.4 * 0.25`。 如果设置较大的shared_buffers需要同时增加checkpoint_segments的值,因为写入大量新增、修改数据需要消耗更多的时间周期。 ## segment_buffers -**参数说明**: 设置MogDB段页式元数据页的内存大小。 +**参数说明**:设置MogDB段页式元数据页的内存大小。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -120,7 +121,7 @@ shared_buffers需要设置为BLCKSZ的整数倍,BLCKSZ目前设置为8KB,即 segment_buffers需要设置为BLCKSZ的整数倍,BLCKSZ目前设置为8KB,即segment_buffers需要设置为8KB整数倍。改变BLCKSZ的值会改变最小值。 -**默认值**: 8MB +**默认值**:8MB **设置建议:** @@ -128,29 +129,29 @@ segment_buffers 用来缓存段页式段头的内容,属于关键元数据信 ## bulk_write_ring_size -**参数说明**: 数据并行导入使用的环形缓冲区大小。 +**参数说明**:大批量数据写入触发时(例如copy动作),该操作使用的环形缓冲区大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,16384 ~ 2147483647,单位为KB。 +**取值范围**:整型,16384 ~ 2147483647,单位为KB。 -**默认值**: 2GB +**默认值**:2GB -**设置建议:**建议导入压力大的场景中增加数据库节点中此参数配置。 +**设置建议:**建议导入压力大的场景中增加数据库节点中此参数配置。 ## standby_shared_buffers_fraction -**参数说明**: 备实例所在服务器使用shared_buffers内存缓冲区大小的比例。 +**参数说明**:备实例所在服务器使用shared_buffers内存缓冲区大小的比例。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**双精度类型,0.1~1.0 +**取值范围**:双精度类型,0.1~1.0 -**默认值**: 0.3 +**默认值**:0.3 ## temp_buffers -**参数说明**: 设置每个数据库会话使用的LOCAL临时缓冲区的大小。 +**参数说明**:设置每个数据库会话使用的LOCAL临时缓冲区的大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -158,54 +159,54 @@ segment_buffers 用来缓存段页式段头的内容,属于关键元数据信 一个会话将按照temp_buffers给出的限制,根据需要分配临时缓冲区。如果在一个并不需要大量临时缓冲区的会话里设置一个大的数值,其开销只是一个缓冲区描述符的大小。当缓冲区被使用,就会额外消耗8192字节。 -**取值范围:**整型,100~1073741823,单位为8KB。 +**取值范围**:整型,100~1073741823,单位为8KB。 -**默认值**: 1MB +**默认值**:1MB ## max_prepared_transactions -**参数说明**: 设置可以同时处于"预备"状态的事务的最大数目。增加此参数的值会使MogDB比系统默认设置需要更多的System V共享内存。 +**参数说明**:设置可以同时处于"预备"状态的事务的最大数目。增加此参数的值会使MogDB比系统默认设置需要更多的System V共享内存。 当MogDB部署为主备双机时,在备机上此参数的设置必须要高于或等于主机上的,否则无法在备机上进行查询操作。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型。0~262143。 +**取值范围**:整型。0~262143。 -**默认值**: 800 +**默认值**:10 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> 为避免在准备步骤失败,此参数的值不能小于max_connections。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:**一般不需要对事务显式进行PREPARE操作,如果业务对事务进行显示PREPARE操作,为避免在准备步骤失败,需要调大该值,大于需要进行PREPARE业务的并发数。 ## work_mem -**参数说明**: 设置内部排序操作和Hash表在开始写入临时磁盘文件之前使用的内存大小。ORDER BY,DISTINCT和merge joins都要用到排序操作。Hash表在散列连接、散列为基础的聚集、散列为基础的IN子查询处理中都要用到。 +**参数说明**: 设置内部排序操作和Hash表在开始写入临时磁盘文件之前使用的内存大小。ORDER BY,DISTINCT和merge joins都要用到排序操作。Hash表在散列连接、散列为基础的聚集、散列为基础的IN子查询处理中都要用到。 对于复杂的查询,可能会同时并发运行好几个排序或者散列操作,每个都可以使用此参数所声明的内存量,不足时会使用临时文件。同样,好几个正在运行的会话可能会同时进行排序操作。因此使用的总内存可能是work_mem的好几倍。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:** 整型,64~2147483647,单位为KB。 +**取值范围**: 整型,64~2147483647,单位为KB。 -**默认值**: 64MB +**默认值**:64MB -**设置建议:** +**设置建议:** > 依据查询特点和并发来确定,一旦work_mem限定的物理内存不够,算子运算数据将写入临时表空间,带来5-10倍的性能下降,查询响应时间从秒级下降到分钟级。 > > - 对于串行无并发的复杂查询场景,平均每个查询有5-10关联操作,建议work_mem=50%内存/10。 > - 对于串行无并发的简单查询场景,平均每个查询有2-5个关联操作,建议work_mem=50%内存/5。 > - 对于并发场景,建议work_mem=串行下的work_mem/物理并发数。 +> - 对于BitmapScan的哈希表也会受到work_mem的限制,但不会被严格管控下盘。完全Lossify的情况下,哈希表每占用1MB的内存,对应一次BitmapHeapScan的16GB的页面(Ustore为32GB),达到work_mem上限后,会按此比例随数据访问量线性增长。 ## query_mem -**参数说明**: 设置执行作业所使用的内存。如果设置的query_mem值大于0,在生成执行计划时,优化器会将作业的估算内存调整为该值。 +**参数说明**:设置执行作业所使用的内存。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:** 0,或大于32M的整型,默认单位为KB。如果设置值为负数或小于32M,将设置为默认值0,此时优化器不会根据该值调整作业的估算内存。 +**取值范围**: 0,或大于32M的整型,默认单位为KB。 -**默认值**: 0 +**默认值**:0 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > @@ -214,13 +215,13 @@ segment_buffers 用来缓存段页式段头的内容,属于关键元数据信 ## query_max_mem -**参数说明**: 设置执行作业所能够使用的最大内存。如果设置的query_max_mem值大于0,当作业执行时所使用内存超过该值时,将报错退出。 +**参数说明**:设置执行作业所能够使用的最大内存。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**0,或大于32M的整型,默认单位为KB。如果设置值为负数或小于32M,将设置为默认值0,此时不会根据该值限制作业的内存使用。 +**取值范围**:0,或大于32M的整型,默认单位为KB。 -**默认值**: 0 +**默认值**:0 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > @@ -229,88 +230,84 @@ segment_buffers 用来缓存段页式段头的内容,属于关键元数据信 ## maintenance_work_mem -**参数说明**: 设置在维护性操作(比如VACUUM、CREATE INDEX、ALTER TABLE ADD FOREIGN KEY等)中可使用的最大的内存。该参数的设置会影响VACUUM、VACUUM FULL、CLUSTER、CREATE INDEX的执行效率。 +**参数说明**:设置在维护性操作(比如VACUUM、CREATE INDEX、ALTER TABLE ADD FOREIGN KEY等)中可使用的最大的内存。该参数的设置会影响VACUUM、VACUUM FULL、CLUSTER、CREATE INDEX的执行效率。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1024~INT_MAX,单位为KB。 +**取值范围**:整型,1024~INT_MAX,单位为KB。 -**默认值**: 16MB +**默认值**:16MB -**设置建议:** +**设置建议:** -- 建议设置此参数的值大于[work_mem](#work_mem),可以改进清理和恢复数据库转储的速度。因为在一个数据库会话里,任意时刻只有一个维护性操作可以执行,并且在执行维护性操作时不会有太多的会话。 -- 当自动清理线程运行时,autovacuum_max_workers倍数的内存将会被分配,所以此时设置maintenance_work_mem的值应该不小于[work_mem](#work_mem)。 +- 建议设置此参数的值大于work_mem,可以改进清理和恢复数据库转储的速度。因为在一个数据库会话里,任意时刻只有一个维护性操作可以执行,并且在执行维护性操作时不会有太多的会话。 +- 当[自动清理](14-automatic-vacuuming)线程运行时,autovacuum_max_workers倍数的内存将会被分配,所以此时设置maintenance_work_mem的值应该不小于work_mem。 - 如果进行大数据量的cluster等,可以在session中调大该值。 ## psort_work_mem -**参数说明**: 设置列存表在进行局部排序中,在开始写入临时磁盘文件之前使用的内存大小。带partial cluster key的表、带索引的表插入、创建表索引、删除表和更新表都会用到。 +**参数说明**:设置列存表在进行局部排序中,在开始写入临时磁盘文件之前使用的内存大小。带partial cluster key的表、带索引的表插入、创建表索引、删除表和更新表都会用到。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 同样,多个正在运行的会话可能会同时进行表的局部排序操作。因此,使用的总内存可能是psort_work_mem的几倍。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:**同样,多个正在运行的会话可能会同时进行表的局部排序操作。因此,使用的总内存可能是psort_work_mem的几倍。 -**取值范围:**整型64~2147483647,单位为KB。 +**取值范围**:整型64~2147483647,单位为KB。 -**默认值**: 512MB +**默认值**:512MB ## max_loaded_cudesc -**参数说明**: 设置列存表在做扫描时,每列缓存cudesc信息的个数。增大设置会提高查询性能,但也会增加内存占用,特别是当列存表的列非常多时。 +**参数说明**:设置列存表在做扫描时,每列缓存cudesc信息的个数。增大设置会提高查询性能,但也会增加内存占用,特别是当列存表的列非常多时。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> max_loaded_cudesc设置过高时,有可能引起内存分配不足。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:**max_loaded_cudesc设置过高时,有可能引起内存分配不足。 -**取值范围:**100~1073741823。 +**取值范围**:100~1073741823。 -**默认值**: 1024 +**默认值**:1024 ## max_stack_depth -**参数说明**: 设置MogDB执行堆栈的最大安全深度。需要这个安全界限是因为在服务器里,并非所有程序都检查了堆栈深度,只是在可能递规的过程,比如表达式计算这样的过程里面才进行检查。 +**参数说明**:设置MogDB执行堆栈的最大安全深度。需要这个安全界限是因为在服务器里,并非所有程序都检查了堆栈深度,只是在可能递规的过程,比如表达式计算这样的过程里面才进行检查。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,100~INT_MAX,单位为KB。 +**取值范围**:整型,100~INT_MAX,单位为KB。 -**默认值**: 2MB +**默认值**:2MB -**设置原则**: +**设置原则**: - 数据库需要预留640KB堆栈深度,因此此参数的最佳设置是等于操作系统内核允许的最大值(就是ulimit -s的设置)- 640KB。 - 如果设置此参数的值大于实际的内核限制,则一个正在运行的递归函数可能会导致一个独立的服务器进程崩溃。在MogDB能够检测内核限制的操作系统上(SLES上),将自动限制设置为一个不安全的值。 - 因为并非所有的操作都能够检测,所以建议用户在此设置一个明确的值。 - -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> 默认值2MB,这个值相对比较小,不容易导致系统崩溃。 +- 默认值2MB,这个值相对比较小,不容易导致系统崩溃。 ## cstore_buffers -**参数说明**: 设置列存所使用的共享缓冲区的大小。 +**参数说明**:设置列存所使用的共享缓冲区的大小。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,16384~1073741823,单位为KB。 +**取值范围**:整型,16384~1073741823,单位为KB。 -**默认值**: 1GB +**默认值**:1GB -**设置建议**: +**设置建议**: 列存表使用cstore_buffers设置的共享缓冲区,几乎不用shared_buffers。因此在列存表为主的场景中,应减少shared_buffers,增加cstore_buffers。 ## bulk_read_ring_size -**参数说明**: 并行导出,使用的环形缓冲区大小。 +**参数说明**:大批量数据查询时(例如大表扫描),该操作使用的环形缓冲区大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,256~2147483647,单位为KB。 +**取值范围**:整型,256~2147483647,单位为KB。 -**默认值**: 16MB +**默认值**:16MB ## enable_early_free @@ -324,3 +321,17 @@ segment_buffers 用来缓存段页式段头的内容,属于关键元数据信 - off表示不支持算子内存提前释放。 **默认值**:on + +## local_syscache_threshold + +**参数说明**:系统表cache在单个session缓存的大小。 + +该参数属于PG_SIGHUP类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +如果enable_global_plancache已打开,为保证GPC生效,local_syscache_threshold设置值小于16MB时不会生效,最小为16MB。 + +如果enable_global_plancache和enable_thread_pool打开,该参数描述的是当前线程和绑定到当前线程上的session缓存的总大小。 + +**取值范围**:整型,1\*1024 ~ 512\*1024,单位KB。 + +**默认值**:on diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/2-disk-space.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/2-disk-space.md index ac29f8e1617365cd52ece6ef5a5af73468e96dad..447786b96a5c3c0b79b86e799bd7b83c2e24d59b 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/2-disk-space.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/2-disk-space.md @@ -11,25 +11,25 @@ date: 2021-04-20 ## sql_use_spacelimit -**参数说明**: 限制单个SQL在单个数据库节点上,触发落盘操作时,落盘文件的空间大小,管控的空间包括普通表、临时表以及中间结果集落盘占用的空间。 +**参数说明**:限制单个SQL在单个数据库节点上,触发落盘操作时,落盘文件的空间大小,管控的空间包括普通表、临时表以及中间结果集落盘占用的空间。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置 -**取值范围:**整型,-1~2147483647,单位为KB。其中-1表示没有限制。 +**取值范围**:整型,-1~2147483647,单位为KB。其中-1表示没有限制。 -**默认值**: -1 +**默认值**:-1 ## temp_file_limit -**参数说明**: 限制一个会话中,触发下盘操作时,单个下盘文件的空间大小。例如一次会话中,排序和哈希表使用的临时文件,或者游标占用的临时文件。 +**参数说明**:限制一个会话中,触发下盘操作时,单个下盘文件的空间大小。例如一次会话中,排序和哈希表使用的临时文件,或者游标占用的临时文件。 此设置为会话级别的下盘文件控制。 该参数属于SUSET类型参数,请参考表[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) **须知**: > SQL查询执行时使用的临时表空间不在此限制。 -**取值范围:**整型,-1~2147483647,单位为KB。其中-1表示没有限制。 +**取值范围**:整型,-1~2147483647,单位为KB。其中-1表示没有限制。 -**默认值**: -1 +**默认值**:-1 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/3-kernel-resource-usage.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/3-kernel-resource-usage.md index fb8ddeda7aedf83b8bccd1a280179295dc6510ac..325eb638c890a2974d422babe8805ff7fc2b33a8 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/3-kernel-resource-usage.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/3-kernel-resource-usage.md @@ -11,19 +11,19 @@ date: 2021-04-20 ## max_files_per_process -**参数说明**: 设置每个服务器进程允许同时打开的最大文件数目。如果操作系统内核强制一个合理的数目,则不需要设置。 +**参数说明**:设置每个服务器进程允许同时打开的最大文件数目。如果操作系统内核强制一个合理的数目,则不需要设置。 但是在一些平台上(特别是大多数BSD系统),内核允许独立进程打开比系统真正可以支持的数目大得多的文件数。如果用户发现有的"Too many open files"这样的失败现象,请尝试缩小这个设置。通常情况下需要满足,系统FD(file descriptor)数量>=`最大并发数*数据库节点个数*max_files_per_process*3`。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,25~2147483647。 +**取值范围**:整型,25~2147483647。 -**默认值**: 1000 +**默认值**:1000 ## shared_preload_libraries -**参数说明**: 此参数用于声明一个或者多个在服务器启动的时候预先装载的共享库,多个库名称之间用逗号分隔。比如 '$libdir/mylib' 会在加载标准库目录中的库文件之前预先加载mylib.so(某些平台上可能是mylib.sl)库文件。 +**参数说明**:此参数用于声明一个或者多个在服务器启动的时候预先装载的共享库,多个库名称之间用逗号分隔。比如 '$libdir/mylib' 会在加载标准库目录中的库文件之前预先加载mylib.so(某些平台上可能是mylib.sl)库文件。 可以用这个方法预先装载MogDB的存储过程库,通常是使用 '$libdir/plXXX' 语法。XXX只能是pgsql,perl,tcl,python之一。 @@ -31,11 +31,11 @@ date: 2021-04-20 该参数属于POSTMASTER类型参数,请参考表[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) **须知**: > > - 如果被声明的库不存在,MogDB服务将会启动失败。 > - 每一个支持MogDB的库都有一个特殊的标记用于保证兼容性。因此,不支持MogDB的库不能用这种方法加载。 -**取值范围:**字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/4-cost-based-vacuum-delay.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/4-cost-based-vacuum-delay.md index 5761a33ca77a31ef85b42cfc136f28b29f56c26b..d3edd1d38f8e14c4426de4f634efa11f11110421 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/4-cost-based-vacuum-delay.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/4-cost-based-vacuum-delay.md @@ -9,21 +9,21 @@ date: 2021-04-20 这个特性的目的是允许管理员减少VACUUM和ANALYZE语句在并发活动的数据库上的I/O影响。比如,像VACUUM和ANALYZE这样的维护语句并不需要迅速完成,并且不希望他们严重干扰系统执行其他的数据库操作。基于开销的清理延迟为管理员提供了一个实现这个目的手段。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: > 有些清理操作会持有关键的锁,这些操作应该尽快结束并释放锁。所以MogDB的机制是,在这类操作过程中,基于开销的清理延迟不会发生作用。为了避免在这种情况下的长延时,实际的开销限制取下面两者之间的较大值: > -> - vacuum_cost_delay*accumulated_balance/vacuum_cost_limit* -> - vacuum_cost_delay*4 +> - vacuum_cost_delay\*accumulated_balance/vacuum_cost_limit +> - vacuum_cost_delay\*4 **背景信息** -在ANALYZE | ANALYSE和VACUUM语句执行过程中,系统维护一个内部的记数器,跟踪所执行的各种I/O操作的近似开销。如果积累的开销达到了vacuum_cost_limit声明的限制,则执行这个操作的进程将睡眠vacuum_cost_delay指定的时间。然后它会重置记数器然后继续执行。 +在[ANALYZE | ANALYSE](ANALYZE-ANALYSE)和[VACUUM](VACUUM)语句执行过程中,系统维护一个内部的记数器,跟踪所执行的各种I/O操作的近似开销。如果积累的开销达到了vacuum_cost_limit声明的限制,则执行这个操作的进程将睡眠vacuum_cost_delay指定的时间。然后它会重置记数器然后继续执行。 这个特性是缺省关闭的。如需开启,需要把vacuum_cost_delay变量设置为一个非零值。 ## vacuum_cost_delay -**参数说明**: 指定开销超过vacuum_cost_limit的值时,进程睡眠的时间。 +**参数说明**:指定开销超过vacuum_cost_limit的值时,进程睡眠的时间。 要注意在许多系统上,睡眠的有效分辨率是10毫秒。因此把vacuum_cost_delay设置为一个不是10的整数倍的数值与将它设置为下一个10的整数倍作用相同。 @@ -31,46 +31,46 @@ date: 2021-04-20 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**integer(毫秒),0~100,正数值表示打开基于开销的清理延迟特性;0表示关闭基于开销的清理延迟特性。 +**取值范围**:整型,0~100,正数值表示打开基于开销的清理延迟特性;0表示关闭基于开销的清理延迟特性。 -**默认值**: 0 +**默认值**:0 ## vacuum_cost_page_hit -**参数说明**: 清理一个在共享缓存里找到的缓冲区的预计开销。它代表锁住缓冲池、查找共享的Hash表、扫描页面内容的开销。 +**参数说明**:清理一个在共享缓存里找到的缓冲区的预计开销。它代表锁住缓冲池、查找共享的Hash表、扫描页面内容的开销。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**integer,0~10000。 +**取值范围**:整型,0~10000。 -**默认值**: 1 +**默认值**:1 ## vacuum_cost_page_miss -**参数说明**: 清理一个要从磁盘上读取的缓冲区的预计开销。它代表锁住缓冲池、查找共享Hash表、从磁盘读取需要的数据块、扫描它的内容的开销。 +**参数说明**:清理一个要从磁盘上读取的缓冲区的预计开销。它代表锁住缓冲池、查找共享Hash表、从磁盘读取需要的数据块、扫描它的内容的开销。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**integer,0~10000。 +**取值范围**:整型,0~10000。 -**默认值**: 10 +**默认值**:10 ## vacuum_cost_page_dirty -**参数说明**: 清理修改一个原先是干净的块的预计开销。它代表把一个脏的磁盘块再次刷新到磁盘上的额外开销。 +**参数说明**:清理修改一个原先是干净的块的预计开销。它代表把一个脏的磁盘块再次刷新到磁盘上的额外开销。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**integer,0~1000 +**取值范围**:整型,0~1000 -**默认值**: 20 +**默认值**:20 ## vacuum_cost_limit -**参数说明**: 导致清理进程休眠的开销限制。 +**参数说明**:设置清理进程休眠的开销限制。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**integer,1~10000。 +**取值范围**:整型,1~10000。 -**默认值**: 200 +**默认值**:200 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/5-background-writer.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/5-background-writer.md index 0ca5f021562729c616b21d0b2430331f6a1a7625..ea47e085962f94d6a31671e63c33dfc7e1b4bd67 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/5-background-writer.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/5-background-writer.md @@ -26,17 +26,17 @@ date: 2021-04-20 ## bgwriter_delay -**参数说明**: 设置后端写进程写“脏”共享缓冲区之间的时间间隔。每一次,后端写进程都会为一些脏的缓冲区发出写操作(用bgwriter_lru_maxpages参数控制每次写的量),然后休眠bgwriter_delay毫秒后才再次启动。 +**参数说明**:设置后端写进程写“脏”共享缓冲区之间的时间间隔。每一次,后端写进程都会为一些脏的缓冲区发出写操作(用bgwriter_lru_maxpages参数控制每次写的量),然后休眠bgwriter_delay毫秒后才再次启动。 在许多系统上,休眠延时的有效分辨率是10毫秒。因此,设置一个不是10的倍数的数值与把它设置为下一个10的倍数是一样的效果。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,10~10000,单位为毫秒。 +**取值范围**:整型,10~10000,单位为毫秒。 -**默认值**: 2s +**默认值**:2s -**设置建议:**在数据写压力比较大的场景中可以尝试减小该值以降低checkpoint的压力。 +**设置建议**:在数据写压力比较大的场景中可以尝试减小该值以降低checkpoint的压力。 ## candidate_buf_percent_target @@ -50,33 +50,33 @@ date: 2021-04-20 ## bgwriter_lru_maxpages -**参数说明**: 设置后端写进程每次可写入磁盘的"脏"缓存区的个数。 +**参数说明**:设置后端写进程每次可写入磁盘的"脏"缓存区的个数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~1000 +**取值范围**:整型,0~1000 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > 此参数设置为0表示禁用后端写功能,禁用后端写功能不会对checkpoints产生影响。 -**默认值**: 100 +**默认值**:100 ## bgwriter_lru_multiplier -**参数说明**: 通过与已使用缓存区数目的乘积评估下次服务器需要的缓存区数目。 +**参数说明**:通过与已使用缓存区数目的乘积评估下次服务器需要的缓存区数目。 -写"脏"缓存区到磁盘的数目取决于服务器最近几次使用的缓存区数目。最近的buffers数目的平均值乘以bgwriter_lru_multiplier是为了评估下次服务器进程需要的buffers数目。在有足够多的干净的、可用的缓存区之前,后端写进程会一直写"脏"缓存区的(每次写的缓存区数目不会超过bgwriter_lru_maxpages的值)。 +写“脏”缓存区到磁盘的数目取决于服务器最近几次使用的缓存区数目。最近的buffers数目的平均值乘以bgwriter_lru_multiplier是为了评估下次服务器进程需要的buffers数目。在有足够多的干净的、可用的缓存区之前,后端写进程会一直写“脏”缓存区的(每次写的缓存区数目不会超过bgwriter_lru_maxpages的值)。 -设置bgwriter_lru_multiplier的值为1.0表示一种"实时"策略,其作用是精准预测下次写"脏"缓冲区的数目。设置为较大的值可以应对突然的需求高峰,而较小的值则可以让服务器进程执行更多的写操作。 +设置bgwriter_lru_multiplier的值为1.0表示一种“实时”策略,其作用是精准预测下次写“脏”缓冲区的数目。设置为较大的值可以应对突然的需求高峰,而较小的值则可以让服务器进程执行更多的写操作。 设置较小的bgwriter_lru_maxpages和bgwriter_lru_multiplier会减小后端写进程导致的额外I/O开销,但是服务器进程必须自己发出写操作,增加了对查询的响应时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**浮点型,0~10。 +**取值范围**:浮点型,0~10。 -**默认值**: 2 +**默认值**:2 ## pagewriter_thread_num @@ -110,23 +110,43 @@ date: 2021-04-20 ## max_io_capacity -**参数说明**: 设置后端写进程批量刷页每秒的IO上限,需要根据具体业务场景和机器磁盘IO能力进行设置。要求RTO很短时间或者数据量比共享内存大多倍的情况,业务访问数据量又是随机访问时,该值不宜过小。该参数设置较小会减小后端写进程刷页个数,如果业务触发页面淘汰多时,该值设置小会影响业务。 +**参数说明**:设置后端写进程批量刷页每秒的IO上限,需要根据具体业务场景和机器磁盘IO能力进行设置。要求RTO很短时间或者数据量比共享内存大多倍的情况,业务访问数据量又是随机访问时,该值不宜过小。该参数设置较小会减小后端写进程刷页个数,如果业务触发页面淘汰多时,该值设置小会影响业务。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,30720~10485760。单位是KB。 +**取值范围**:整型,30720~10485760。单位是KB。 -**默认值**: 512000KB(500MB) +**默认值**:512000KB(500MB) ## enable_consider_usecount -**参数说明**: 设置backend线程在页面置换时是否考虑页面热度,建议大容量场景下开启此参数。 +**参数说明**:设置backend线程在页面置换时是否考虑页面热度,建议大容量场景下开启此参数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on/true表示考虑页面热度。 - off/false表示不考虑页面热度。 -**默认值**: off +**默认值**:off + +## dw_file_num + +**参数说明**:设置批量双写文件的数量,该值与pagewriter_thread_num有关,不会大于pagwriter_thread_num,如果设置过大,内部会纠正为pagewriter_thread_num。 + +该参数属于POSTMASTER类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:整型,1~16 + +**默认值**:1 + +## dw_file_size + +**参数说明**:设置每个批量双写文件的大小。 + +该参数属于POSTMASTER类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:整型,32~256 + +**默认值**:256 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/6-asynchronous-io-operations.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/6-asynchronous-io-operations.md index f862334fb5de69d7d64c567dc801e4741fb0f774..fea278bf119b1a9d6eeddb7c269ce4feba0786cd 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/6-asynchronous-io-operations.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/4-resource-consumption/6-asynchronous-io-operations.md @@ -9,114 +9,116 @@ date: 2021-04-20 ## enable_adio_debug -**参数说明**: 允许维护人员输出一些与ADIO相关的日志,便于定位ADIO相关问题。开发人员专用,不建议普通用户使用。 +**参数说明**:允许维护人员输出一些与ADIO相关的日志,便于定位ADIO相关问题。开发人员专用,不建议普通用户使用。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on/true表示开启此日志开关。 - off/false表示关闭此日志开关。 -**默认值**: off +**默认值**:off + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 当前版本暂不支持打开该开关,即使用户手动设置为打开,系统内部也会自动设置为关闭状态。 ## enable_adio_function -**参数说明**: 是否开起ADIO功能。 +**参数说明**:是否开启ADIO功能。 + +该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -当前版本暂不支持开启异步IO功能,默认该功能关闭,请勿自行修改。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 当前版本暂不支持开启异步IO功能,默认该功能关闭。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on/true表示开启此功能。 - off/false表示关闭此功能。 -**默认值**: off +**默认值**:off ## enable_fast_allocate -**参数说明**: 磁盘空间快速分配开关。 +**参数说明**:磁盘空间快速分配开关。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。只有在XFS文件系统上才能开启该开关。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on/true表示开启此功能。 - off/false表示关闭此功能。 -**默认值**: off +**默认值**:off ## prefetch_quantity -**参数说明**: 描述行存储使用ADIO预读取IO量的大小。 +**参数说明**:描述行存储使用ADIO预读取IO量的大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,128~131072,单位为8KB。 +**取值范围**:整型,128~131072,单位为8KB。 -**默认值**: 32MB (4096 * 8KB) +**默认值**:32MB (4096 * 8KB) ## backwrite_quantity -**参数说明**: 描述行存储使用ADIO预读取IO量的大小。 - -**参数说明**: 描述行存储使用ADIO写入IO量的大小。 +**参数说明**:描述行存储使用ADIO写入IO量的大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,128~131072,单位为8KB。 +**取值范围**:整型,128~131072,单位为8KB。 -**默认值**: 8MB (1024 * 8KB) +**默认值**:8MB (1024 * 8KB) ## cstore_prefetch_quantity -**参数说明**: 描述列存储使用ADIO预取IO量的大小。 +**参数说明**:描述列存储使用ADIO预取IO量的大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1024~1048576,单位为KB。 +**取值范围**:整型,1024~1048576,单位为KB。 -**默认值**: 32MB +**默认值**:32MB ## cstore_backwrite_quantity -**参数说明**: 描述列存储使用ADIO写入IO量的大小。 +**参数说明**:描述列存储使用ADIO写入IO量的大小。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1024~1048576,单位为KB。 +**取值范围**:整型,1024~1048576,单位为KB。 -**默认值**: 8MB +**默认值**:8MB ## cstore_backwrite_max_threshold -**参数说明**: 描述列存储使用ADIO写入数据库可缓存最大的IO量。 +**参数说明**:描述列存储使用ADIO写入数据库可缓存最大的IO量。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,4096~INT_MAX/2,单位为KB。 +**取值范围**:整型,4096~INT_MAX/2,单位为KB。 -**默认值**: 2GB +**默认值**:2GB ## fast_extend_file_size -**参数说明**: 描述列存储使用ADIO预扩展磁盘的大小。 +**参数说明**:描述列存储使用ADIO预扩展磁盘的大小。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1024~1048576,单位为KB。 +**取值范围**:整型,1024~1048576,单位为KB。 -**默认值**: 8MB +**默认值**:8MB ## effective_io_concurrency -**参数说明**: 磁盘子系统可以同时有效处理的请求数。对于RAID阵列,此参数应该是阵列中驱动器主轴的数量。 +**参数说明**:磁盘子系统可以同时有效处理的请求数。对于RAID阵列,此参数应该是阵列中驱动器主轴的数量。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型 ,0~1000 +**取值范围**:整型 ,0~1000 -**默认值**: 1 +**默认值**:1 ## checkpoint_flush_after diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/40-AI-features.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/40-AI-features.md index 8571058bde7423226245e9bce9fe3d3f2055688a..371b88687ca1aae87cb279eadecb28ac8df692f1 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/40-AI-features.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/40-AI-features.md @@ -9,56 +9,56 @@ date: 2021-11-08 ## enable_hypo_index -**参数说明**: 该参数控制数据库的优化器进行EXPLAIN时是否考虑创建虚拟索引。通过对特定的查询语句执行explain,用户可根据优化器给出的执行计划评估该索引是否能够提升该查询语句的执行效率。 +**参数说明**:该参数控制数据库的优化器进行EXPLAIN时是否考虑创建虚拟索引。通过对特定的查询语句执行explain,用户可根据优化器给出的执行计划评估该索引是否能够提升该查询语句的执行效率。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示在进行EXPLAIN时创建虚拟索引。 - off表示在进行EXPLAIN时不创建虚拟索引。 -**默认值**: off +**默认值**:off ## db4ai_snapshot_mode -**参数说明**: snapshot有2种模式:MSS(物化模式,存储数据实体)和CSS(计算模式,存储增量信息)。 +**参数说明**:snapshot有2种模式:MSS(物化模式,存储数据实体)和CSS(计算模式,存储增量信息)。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,MSS/CSS +**取值范围**:字符串,MSS/CSS - MSS表示物化模式,db4ai在创建快照的时候存储数据实体。 - CSS表示计算模式,db4ai在创建快照的时候存储增量信息。 -**默认值**: MSS +**默认值**:MSS ## db4ai_snapshot_version_delimiter -**参数说明**: 该参数为数据表快照版本分隔符。 +**参数说明**:该参数为数据表快照版本分隔符。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,长度大于0 +**取值范围**:字符串,长度大于0 -**默认值**: @ +**默认值**:@ ## db4ai_snapshot_version_separator -**参数说明**: 该参数用于指定数据表快照子版本分隔符。 +**参数说明**:该参数用于指定数据表快照子版本分隔符。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,长度大于0 +**取值范围**:字符串,长度大于0 -**默认值**: . +**默认值**:. ## unix_socket_directory -**参数说明**: 用于指定unix_socket通信方式中,文件存放的路径。此参数只能在配置文件postgresql.conf中指定。再启动fenced模式前需要设定该GUC参数。 +**参数说明**:用于指定unix_socket通信方式中,文件存放的路径。此参数只能在配置文件postgresql.conf中指定。再启动fenced模式前需要设定该GUC参数。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串,长度大于等于0 +**取值范围**:字符串,长度大于等于0 -**默认值**: “ +**默认值**:“ diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/5-parallel-import.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/5-parallel-import.md deleted file mode 100644 index 4f3c01f85b0b5a8159a074c9a01becffaec07666..0000000000000000000000000000000000000000 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/5-parallel-import.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: 并行导入 -summary: 并行导入 -author: Zhang Cuiping -date: 2021-04-20 ---- - -# 并行导入 - -MogDB提供了并行导入功能,以快速、高效地完成大量数据导入。介绍MogDB并行导入的相关参数。 - -## raise_errors_if_no_files - -**参数说明**: 导入时是否区分"导入文件记录数为空"和"导入文件不存在"。raise_errors_if_no_files=TRUE,则"导入文件不存在"的时候,MogDB将抛出"文件不存在的"错误。 - -该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 布尔型 - -- on表示导入时区分"导入文件记录数为空"和"导入文件不存在"。 -- off表示导入时不区分"导入文件记录数为空"和"导入文件不存在"。 - -**默认值**: off - -## partition_mem_batch - -**参数说明**: 为了优化对列存分区表的批量插入,在批量插入过程中会对数据进行缓存后再批量写盘。通过partition_mem_batch可指定缓存个数。该值设置过大,将消耗较多系统内存资源;设置过小,将降低系统列存分区表批量插入性能。 - -该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 1~ 65535 - -**默认值**: 256 - -## partition_max_cache_size - -**参数说明**: 为了优化对列存分区表的批量插入,在批量插入过程中会对数据进行缓存后再批量写盘。通过partition_max_cache_size可指定数据缓存区大小。该值设置过大,将消耗较多系统内存资源;设置过小,将降低列存分区表批量插入性能。 - -该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: - -列存分区表: 4096~ INT_MAX / 2,最小单位为KB。 - -**默认值**: 2GB - -## enable_delta_store - -**参数说明**: 为了增强列存单条数据导入的性能和解决磁盘冗余问题,可通过此参数选择是否开启支持列存delta表功能。该参数开启时,数据导入列存表,会根据表定义时指定的DELTAROW_THRESHOLD决定数据进入delta表存储还是主表CU存储,当数据量小于DELTAROW_THRESHOLD时,数据进入delta表。该参数影响的操作包括insert,copy,vacuum,vacuum full,vacuum deltamerge重分布等所有涉及列存表数据移动的操作。 - -该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: - -- on表示开启列存delta表功能。 -- off表示不开启列存delta表功能。 - -**默认值**: off diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/1-settings.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/1-settings.md index 6a97c9dc6ec343f8f0383c3c1417900bb9d3d795..9b41fc531f786a52ebba5aa4597983e294b96982 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/1-settings.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/1-settings.md @@ -9,23 +9,23 @@ date: 2021-04-20 ## wal_level -**参数说明**: 设置写入WAL信息量的级别。 +**参数说明**:设置写入WAL信息量的级别。 该参数属于POSTMASTER类型参数,请参考表[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) **须知**: > > - 如果需要启用WAL日志归档和主备机的数据流复制,必须将此参数设置为archive或者hot_standby。 > - 如果此参数设置为minimal,archive_mode必须设置为off,hot_standby必须设置为off,max_wal_senders参数设置为0,且需为单机环境,否则将导致数据库无法启动。 > - 如果此参数设置为archive,hot_standby必须设置为off,否则将导致数据库无法启动。但是,hot_standby在双机环境中不能设置为off,具体参见hot_standby参数说明。 -**取值范围**: 枚举类型 +**取值范围**:枚举类型 - minimal - 优点: 一些重要操作(包括创建表、创建索引、簇操作和表的复制)都能安全的跳过,这样就可以使操作变得更快。 + 优点:一些重要操作(包括创建表、创建索引、簇操作和表的复制)都能安全的跳过,这样就可以使操作变得更快。 - 缺点: WAL仅提供从数据库服务器崩溃或者紧急关闭状态恢复时所需要的基本信息,无法用WAL归档日志恢复数据。 + 缺点:WAL仅提供从数据库服务器崩溃或者紧急关闭状态恢复时所需要的基本信息,无法用WAL归档日志恢复数据。 - archive @@ -40,61 +40,72 @@ date: 2021-04-20 这个参数表示WAL日志支持逻辑复制。 -**默认值**: hot_standby +**默认值**:hot_standby ## fsync -**参数说明**: 设置MogDB服务器是否使用fsync()系统函数(请参见[wal_sync_method](#wal_sync_method))确保数据的更新及时写入物理磁盘中。 +**参数说明**:设置MogDB服务器是否使用fsync()系统函数(请参见[wal_sync_method](#wal_sync_method))确保数据的更新及时写入物理磁盘中。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 使用fsync()系统函数可以保证在操作系统或者硬件崩溃的情况下将数据恢复到一个已知的状态。 > - 如果将此参数关闭,可能会在系统崩溃时无法恢复原来的数据,导致数据库不可用。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示使用fsync()系统函数。 - off表示不使用fsync()系统函数。 -**默认值**: on +**默认值**:on ## synchronous_commit -**参数说明**: 设置当前事务的同步方式。 +**参数说明**:设置当前事务的同步方式。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 枚举类型 - -- on表示将备机的同步日志刷新到磁盘。 -- off表示异步提交。 -- local表示为本地提交。 -- remote_write表示要备机的同步日志写到磁盘。 -- remote_receive表示要备机同步日志接收数据。 -- remote_apply表示要备机同步日志回放完成。 -- true表示将备机的同步日志刷新到磁盘。 -- false表示异步提交。 -- yes表示将备机的同步日志刷新到磁盘。 -- no表示异步提交。 -- 1表示将备机的同步日志刷新到磁盘。 -- 0表示异步提交。 -- 2表示将备机同步日志回放完成。 - -**默认值**: off +通常情况下,一个事务产生的日志的同步顺序如下: + +1. 主机将日志内容写入本地内存。 +2. 主机将本地内存中的日志写入本地文件系统。 +3. 主机将本地文件系统中的日志内容刷盘。 +4. 主机将日志内容发送给备机。 +5. 备机接受到日志内容,存入备机内存。 +6. 备机将备机内存中的日志写入备机文件系统。 +7. 备机将备机文件系统中的日志内容刷盘。 +8. 备机回放日志,完成对数据文件的增量更新。 + +**取值范围**:枚举类型 + +- on:表示主机事务提交需要等待备机将对应日志刷新到磁盘。 +- off:表示主机事务提交无需等待主机自身将对应日志刷新到磁盘,通常也称为异步提交。 +- local:表示主机事务提交需要等待主机自身将对应日志刷新到磁盘,通常也称为本地提交。 +- remote_write:表示主机事务提交需要等待备机将对应日志写到文件系统(无需刷新到磁盘)。 +- remote_receive:表示主机事务提交需要等待备机接收到对应日志数据(无需写入文件系统)。 +- remote_apply:表示主机事务提交需要等待备机完成对应日志的回放操作。 +- true:同on。 +- false:同off。 +- yes:同on。 +- no:同off。 +- 1:同on。 +- 0:同off。 +- 2:同remote_apply。 + +**默认值**:on ## wal_sync_method -**参数说明**: 设置向磁盘强制更新WAL数据的方法。 +**参数说明**:设置向磁盘强制更新WAL数据的方法。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > 如果将[fsync](#fsync)关闭,这个参数的设置就没有意义,因为所有数据更新都不会强制写入磁盘。 -**取值范围**: 枚举类型 +**取值范围**:枚举类型 - open_datasync表示用带O_DSYNC选项的open()打开"WAL"文件。 @@ -102,154 +113,151 @@ date: 2021-04-20 - fsync_writethrough表示每次提交的时候调用fsync()强制把缓冲区任何数据写入磁盘。 - > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** + > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:由于历史原因,Windows平台支持将wal_sync_method设置为fsync_writethrough。在windows平台上fsync_writethrough和fsync等效。 > - > 由于历史原因,Windows平台支持将wal_sync_method设置为fsync_writethrough。在windows平台上fsync_writethrough和fsync等效。 - + - fsync表示每次提交的时候调用fsync()。(支持suse10和suse11) - open_sync表示用带O_SYNC选项的open()写"WAL"文件。(支持suse10和suse11) - > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** + > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:不是所有的平台都支持以上参数。 > - > 不是所有的平台都支持以上参数。 -**默认值**: fdatasync +**默认值**:fdatasync ## full_page_writes -**参数说明**: 设置MogDB服务器在检查点之后对页面的第一次修改时,是否将每个磁盘页面的全部内容写到WAL日志中。当增量检查点开关和enable_double_write同时打开时,则不使用full_page_writes。 +**参数说明**:设置MogDB服务器在检查点之后对页面的第一次修改时,是否将每个磁盘页面的全部内容写到WAL日志中。当增量检查点开关和enable_double_write同时打开时,则不使用full_page_writes。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 设置这个参数是因为在操作系统崩溃过程中可能磁盘页面只写入了一部分内容,从而导致在同一个页面中包含新旧数据的混合。在崩溃后的恢复期间,由于在WAL日志中存储的行变化信息不够完整,因此无法完全恢复该页。把完整的页面影像保存下来就可以保证页面被正确还原,代价是增加了写入WAL日志的数据量。 > - 关闭此参数,在系统崩溃的时候,可能无法恢复原来的数据。如果服务器硬件的特质(比如电池供电的磁盘控制器)可以减小部分页面的写入风险,或者文件系统特性支持(比如ReiserFS 4),并且清楚知道写入风险在一个可以接受的范畴,可以关闭这个参数。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示启用此特性。 - off表示关闭此特性。 -**默认值**: on +**默认值**:on ## wal_log_hints -**参数说明**: 设置在检查点之后对页面的第一次修改为页面上元组hint bits的修改时,是否将整个页面的全部内容写到WAL日志中。不推荐用户修改此设置。 +**参数说明**:设置在检查点之后对页面的第一次修改为页面上元组hint bits的修改时,是否将整个页面的全部内容写到WAL日志中。不推荐用户修改此设置。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示整个页面全部内容写到WAL日志中。 - off表示整个页面内容不会写到WAL日志中。 -**默认值**: on +**默认值**:on ## wal_buffers -**参数说明**: 设置用于存放WAL数据的共享内存空间的XLOG_BLCKSZ数,XLOG_BLCKSZ的大小默认为8KB。 +**参数说明**:设置用于存放WAL数据的共享内存空间的XLOG_BLCKSZ数,XLOG_BLCKSZ的大小默认为8KB。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**-1~218 +**取值范围**:-1~2^18^ -- 如果设置为-1,表示wal_buffers的大小随着参数shared_buffers自动调整,为shared_buffers的1/32,最小值为8个XLOG_BLCKSZ,最大值为2048个XLOG_BLCKSZ。 +- 如果设置为-1,表示wal_buffers的大小随着参数shared_buffers自动调整,为shared_buffers的1/32,最小值为8个XLOG_BLCKSZ,最大值为2048个XLOG_BLCKSZ,自动调整后的值小于最小值时会调整为最小值,大于最大值时会调整为最大值。 - 如果设置为其他值,当小于4时,会被默认设置为4。 -**默认值**: 16MB +**默认值**:2048,即16MB -**设置建议:**每次事务提交时,WAL缓冲区的内容都写入到磁盘中,因此设置为很大的值不会带来明显的性能提升。如果将它设置成几百兆,就可以在有很多即时事务提交的服务器上提高写入磁盘的性能。根据经验来说,默认值可以满足大多数的情况。 +**设置建议**:每次事务提交时,WAL缓冲区的内容都写入到磁盘中,因此设置为很大的值不会带来明显的性能提升。如果将它设置成几百兆,就可以在有很多即时事务提交的服务器上提高写入磁盘的性能。根据经验来说,默认值可以满足大多数的情况。 ## wal_writer_delay -**参数说明**: WalWriter进程的写间隔时间。 +**参数说明**:WalWriter进程的写间隔时间。 该参数属于SIGHUP类型参数,请参考表[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) **须知**:如果时间过长可能造成WAL缓冲区的内存不足,时间过短会引起WAL不断写入,增加磁盘I/O负担。 > -> 如果时间过长可能造成WAL缓冲区的内存不足,时间过短会引起WAL不断写入,增加磁盘I/O负担。 -**取值范围**: 整型, 1~10000,单位为毫秒。 +**取值范围**:整型, 1~10000,单位为毫秒。 -**默认值**: 200ms +**默认值**:200ms ## commit_delay -**参数说明**: 表示一个已经提交的数据在WAL缓冲区中存放的时间。 +**参数说明**:表示一个已经提交的数据在WAL缓冲区中存放的时间。 该参数属于USERSET类型参数,请参考表[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) **须知**: > > - 设置为非 0 值时事务执行commit后不会立即写入WAL中,而仍存放在WAL缓冲区中,等待WalWriter进程周期性写入磁盘。 > - 如果系统负载很高,在延迟时间内,其他事务可能已经准备好提交。但如果没有事务准备提交,这个延迟就是在浪费时间。 -**取值范围**: 整型, 0~100000,单位为微秒,其中0表示无延迟。 +**取值范围**:整型, 0~100000,单位为微秒,其中0表示无延迟。 -**默认值**: 0 +**默认值**:0 ## commit_siblings -**参数说明**: 当一个事务发出提交请求时,如果数据库中正在执行的事务数量大于此参数的值,则该事务将等待一段时间([commit_delay](#commit_delay)的值),否则该事务则直接写入WAL。 +**参数说明**:当一个事务发出提交请求时,如果数据库中正在执行的事务数量大于此参数的值,则该事务将等待一段时间([commit_delay](#commit_delay)的值),否则该事务则直接写入WAL。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型, 0~1000 +**取值范围**:整型, 0~1000 -**默认值**: 5 +**默认值**:5 ## wal_block_size -**参数说明**: 说明WAL日志段文件中日志页面的大小。 +**参数说明**:说明WAL日志段文件中日志页面的大小。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**取值范围**: 整型,单位为Byte。 +**取值范围**:整型,单位为Byte。 -**默认值**: 8192 +**默认值**:8192 ## wal_segment_size -**参数说明**: 说明WAL日志段文件的大小。 +**参数说明**:说明WAL日志段文件的大小。 该参数属于INTERNAL类型参数,为固定参数,用户无法修改此参数,只能查看。 -**取值范围**: 整型,单位为8KB。 +**取值范围**:整型,单位为8KB。 -**默认值**: 16MB (2048 * 8KB) +**默认值**:16MB (2048 * 8KB) ## walwriter_cpu_bind -**参数说明**: 绑定到WAL写入线程的CPU核,与thread pool配合使用。 +**参数说明**:绑定到WAL写入线程的CPU核,与thread pool配合使用。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**:整型,-1~核数减1。 -**默认值**: -1 +**默认值**:-1 ## walwriter_sleep_threshold -**参数说明**: xlogflusher进入sleep之前空闲xlog刷新的次数,达到阈值会休眠。 +**参数说明**:xlogflusher进入sleep之前空闲xlog刷新的次数,达到阈值会休眠。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**:整型,1~50000。 -**默认值**: 500 +**默认值**:500 ## wal_file_init_num -**参数说明**: WAL编写器将创建的xlog段文件的数量。 +**参数说明**:WAL编写器将创建的xlog段文件的数量。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 **取值范围**:整型,0~1000000。 -**默认值**: 10 +**默认值**:10 ## force_promote @@ -257,8 +265,30 @@ date: 2021-04-20 备机强切在集群故障状态下,以丢失部分数据为代价换取集群尽可能快的恢复服务;是集群状态为不可用时的一个逃生方法,不建议频繁触发。如果操作者不清楚备机强切后丢失数据对业务的影响,请勿使用本功能。 -**取值范围**: 整型,0或1 +**取值范围**:整型,0或1 0表示关闭,1表示开启 -**默认值**: 0 +**默认值**:0 + +## wal_flush_timeout + +**参数说明:**遍历WalInsertStatusEntryTbl的超时时间。Xlog刷盘自适应控制的刷盘IO遍历WalInsertStatusEntryTbl等待的最大时间。 + +该参数属于SIGHUP类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** 如果时间过长可能造成Xlog刷盘频率降低,降低Xlog处理性能。 + +**取值范围**:整型, 0 ~ 90000000(微秒) + +**默认值:**2us + +## wal_flush_delay + +**参数说明:**遍历WalInsertStatusEntryTbl时,遇到WAL_NOT_COPIED状态entry时等待的时间间隔。 + +该参数属于SIGHUP类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:整型, 0 ~ 90000000(微秒) + +**默认值:**1us diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/2-checkpoints.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/2-checkpoints.md index 369c11f4c2343b3ad3f95b3f96dd1853c77f0950..4cb55774abdf34d1b6ce817a002431106ced1bc9 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/2-checkpoints.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/2-checkpoints.md @@ -9,122 +9,121 @@ date: 2021-04-20 ## checkpoint_segments -**参数说明**: 设置[checkpoint_timeout](#checkpoint_timeout)周期内所保留的最少WAL日志段文件数量。每个日志文件大小为16MB。 +**参数说明**:设置[checkpoint_timeout](#checkpoint_timeout)周期内所保留的最少WAL日志段文件数量。每个日志文件大小为16MB。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,最小值1 +**取值范围**:整型,最小值1 -提升此参数可加快大数据的导入速度,但需要结合[checkpoint_timeout](#checkpoint_timeout)、shared_buffers这两个参数统一考虑。这个参数同时影响WAL日志段文件复用数量,通常情况下pg_xlog文件夹下最大的复用文件个数为2倍的checkpoint_segments个,复用的文件被改名为后续即将使用的WAL日志段文件,不会被真正删除。 +提升此参数可加快大数据的导入速度,但需要结合[checkpoint_timeout](#checkpoint_timeout)、[shared_buffers](1-memory#shared_buffers)这两个参数统一考虑。这个参数同时影响WAL日志段文件复用数量,通常情况下pg_xlog文件夹下最大的复用文件个数为2倍的checkpoint_segments个,复用的文件被改名为后续即将使用的WAL日志段文件,不会被真正删除。 -**默认值**: 64 +**默认值**:64 ## checkpoint_timeout -**参数说明**: 设置自动WAL检查点之间的最长时间。 +**参数说明**:设置自动WAL检查点之间的最长时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,30~3600(秒) +**取值范围**:整型,30~3600(秒) -在提升[checkpoint_segments](#checkpoint_segments)以加快大数据导入的场景也需将此参数调大,同时这两个参数提升会加大shared_buffers的负担,需要综合考虑。 +在提升[checkpoint_segments](#checkpoint_segments)以加快大数据导入的场景也需将此参数调大,同时这两个参数提升会加大[shared_buffers](1-memory#shared_buffers)的负担,需要综合考虑。 -**默认值**: 15min +**默认值**:15min ## checkpoint_completion_target -**参数说明**: 指定检查点完成的目标。 +**参数说明**:指定检查点完成的目标。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 0.0~1.0 +**取值范围**:双精度浮点类型,0.0~1.0 -**默认值**: 0.5 +**默认值**:0.5 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> 默认值0.5表示每个checkpoint需要在checkpoints间隔时间的50%内完成。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:默认值0.5表示每个checkpoint需要在checkpoints间隔时间的50%内完成。 ## checkpoint_warning -**参数说明**: 如果由于填充检查点段文件导致检查点发生的时间间隔接近这个参数表示的秒数,就向服务器日志发送一个建议增加[checkpoint_segments](#checkpoint_segments)值的消息。 +**参数说明**:如果由于填充检查点段文件导致检查点发生的时间间隔接近这个参数表示的秒数,就向服务器日志发送一个建议增加[checkpoint_segments](#checkpoint_segments)值的消息。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~INT_MAX(秒),其中0表示关闭警告。 +**取值范围**:整型,0~INT_MAX(秒),其中0表示关闭警告。 -**默认值**: 5min +**默认值**:5min -**推荐值**: 5min +**推荐值**:5min ## checkpoint_wait_timeout -**参数说明**: 设置请求检查点等待checkpointer线程启动的最长时间。 +**参数说明**:设置请求检查点等待checkpointer线程启动的最长时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,2~3600(秒) +**取值范围**:整型,2~3600(秒) -**默认值**: 1min +**默认值**:1min ## enable_incremental_checkpoint -**参数说明**: 增量检查点开关。 +**参数说明**:增量检查点开关。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 -**默认值**: on +**默认值**:on ## enable_double_write -**参数说明**: 双写开关。当增量检查点开关打开时,同时enable_double_write打开,则使用enable_double_write双写特性保护,不再使用full_page_writes防止半页写问题。 +**参数说明**:双写开关。当增量检查点开关打开时,同时enable_double_write打开,则使用enable_double_write双写特性保护,不再使用full_page_writes防止半页写问题。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 -**默认值**: on +**默认值**:on ## incremental_checkpoint_timeout -**参数说明**: 增量检查点开关打开之后,设置自动WAL检查点之间的最长时间。 +**参数说明**:增量检查点开关打开之后,设置自动WAL检查点之间的最长时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~3600(秒) +**取值范围**:整型,1~3600(秒) -**默认值**: 1min +**默认值**:1min ## enable_xlog_prune -**参数说明**: 设置在任一备机断联时,主机是否根据xlog日志的大小超过参数max_size_for_xlog_prune的值而回收日志。 +**参数说明**:设置在任一备机断联时,主机是否根据xlog日志的大小超过参数max_size_for_xlog_prune的值而回收日志。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 -- 设置为on时,如果任一备机断联时,主机不回收日志。 -- 设置为off时,如果任一备机断联时,主机回收日志。 +- 设置为on时,如果任一备机断联时,主机回收日志。 +- 设置为off时,如果任一备机断联时,主机不回收日志。 -**默认值**: on +**默认值**:on ## max_redo_log_size -**参数说明**: 备DN表示当前回放的最新检查点位置和当前日志回放位置之间日志量的期望值,主DN表示恢复点到当前最新日志之间日志量的期望值,关注RTO的情况下,这个值建议不宜过大。 +**参数说明**:备DN表示当前回放的最新检查点位置和当前日志回放位置之间日志量的期望值,主DN表示恢复点到当前最新日志之间日志量的期望值,关注RTO的情况下,这个值建议不宜过大。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,163840~2147483647,单位为KB。 +**取值范围**:整型,163840~2147483647,单位为KB。 -**默认值**: 1GB +**默认值**:1GB ## max_size_for_xlog_prune -**参数说明**: 在enable_xlog_prune打开时生效,如果有备机断连且xlog日志大小大于此阈值,则回收日志。 +**参数说明**:在enable_xlog_prune、synchronous_commit都打开时生效,如果有备机断连且xlog日志大小大于此阈值,则回收日志。所有备机断联且无逻辑复制槽时,不回收日志。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~2147483647,单位为KB +**取值范围**:整型,0~2147483647,单位为KB -**默认值**: 2147483647,单位KB +**默认值**:2147483647,单位KB diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/3-log-replay.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/3-log-replay.md index 8f39c5a2acb78f1dd3a04cb52d20bd1e9b35c7bb..6a24b9512ed703336ec1930f1eb573947da7fe15 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/3-log-replay.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/3-log-replay.md @@ -9,80 +9,80 @@ date: 2021-04-20 ## recovery_time_target -**参数说明**: 设置recovery_time_target秒能够让备机完成日志写入和回放。 +**参数说明**:设置recovery_time_target秒能够让备机完成日志写入和回放。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~3600(秒) +**取值范围**:整型,0~3600(秒) -0是指不开启日志流控,1~3600是指备机能够在recovery_time_target时间内完成日志的写入和回放,可以保证主机与备机切换时能够在recovery_time_target秒完成日志写入和回放,保证备机能够快速升主机。recovery_time_target设置时间过小会影响主机的性能,设置过大会失去流控效果。 +0是指不开启日志流控,1~3600是指备机能够在recovery_time_target时间内完成日志的写入和回放,可以保证主机与备机切换时能够在recovery_time_target秒完成日志写入和回放,保证备机能够快速升主机。recovery_time_target设置时间过小会影响主机的性能,设置过大会失去流控效果。另外,由于极致RTO自带流控,所以同时开启极致RTO与流控时会以极致RTO优先,在运行期间使流控不生效。 -**默认值**: 0 +**默认值**:0 ## recovery_max_workers -**参数说明**: 设置最大并行回放线程个数。 +**参数说明**:设置最大并行回放线程个数。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~20 +**取值范围**:整型,0~20 -**默认值**: 1 (安装工具默认将设置为4以获得更好的性能) +**默认值**:1 (安装工具默认将设置为4,以获得更好的性能) ## recovery_parse_workers -**参数说明**: 是极致RTO特性中ParseRedoRecord线程的数量。 +**参数说明**:是极致RTO特性中ParseRedoRecord线程的数量。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~16 +**取值范围**:整型,1~16 -仅在开启极致RTO情况下可以设置recovery_parse_workers为>1。需要配合recovery_redo_workers使用。若同时开启recovery_parse_workers和recovery_max_workers,以开启极致RTO的recovery_parse_workers为准,并行回放特性失效。因极致RTO不支持hot standby模式和主备从模式, 仅在参数hot_standby设置成off,replication_type设置成1时可以设置recovery_parse_workers为>1。另外,极致RTO也不支持列存,在已经使用列存表或者即将使用列存表的系统中,请关闭极致RTO。 +仅在开启极致RTO情况下可以设置recovery_parse_workers为>1。需要配合recovery_redo_workers使用。若同时开启recovery_parse_workers和recovery_max_workers,以开启极致RTO的recovery_parse_workers为准,并行回放特性失效。因极致RTO不支持hot standby模式和主备从模式, 仅在参数hot_standby设置成off,replication_type设置成1时可以设置recovery_parse_workers为>1。另外,极致RTO也不支持列存,在已经使用列存表或者即将使用列存表的系统中,请关闭极致RTO。由于极致RTO自带流控,所以同时开启极致RTO与流控时会以极致RTO优先,在运行期间使流控不生效。 -**默认值**: 1 +**默认值**:1 ## recovery_redo_workers -**参数说明**: 是极致RTO特性中每个ParseRedoRecord线程对应的PageRedoWorker数量。 +**参数说明**:是极致RTO特性中每个ParseRedoRecord线程对应的PageRedoWorker数量。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~8 +**取值范围**:整型,1~8 需要配合recovery_parse_workers使用。在配合recovery_parse_workers使用时,只有recovery_parse_workers大于0,recovery_redo_workers参数才生效。 -**默认值**: 1 +**默认值**:1 ## recovery_parallelism -**参数说明**: 查询实际回放线程个数,该参数为只读参数。 +**参数说明**:查询实际回放线程个数,该参数为只读参数,无法修改。 -**取值范围**: 整型,1~2147483647 +该参数属于POSTMASTER类型参数,受recovery_max_workers以及recovery_parse_workers参数影响,任意一值大于0时,recover_parallelism将被重新计算。 -该参数受参数: recovery_max_workers及参数: recovery_parse_workers影响,上述任意一参数值大于0时,该参数值将重新计算。 +**取值范围**:整型,1~2147483647 -**默认值**: 1 +**默认值**:1 ## enable_page_lsn_check -**参数说明**: 数据页lsn检查开关。回放时,检查数据页当前的lsn是否是期望的lsn。 +**参数说明**:数据页lsn检查开关。回放时,检查数据页当前的lsn是否是期望的lsn。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 -**默认值**: on +**默认值**:on ## recovery_min_apply_delay -**参数说明**: 设置备节点回放的延迟时间。 +**参数说明**:设置备节点回放的延迟时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > -> - 此参数主节点设置无效,必须设置在需要延迟的备节点上。 -> - 延迟时间是根据主服务器上事物提交的时间戳与备机上的当前时间来计算,因此需要保证主备系统时钟一致。 +> - 此参数主节点设置无效,必须设置在需要延迟的备节点上,推荐设置在异步备上,设置了延时的异步备如果升主RTO时间会比较长。 +> - 延迟时间是根据主服务器上事务提交的时间戳与备机上的当前时间来计算,因此需要保证主备系统时钟一致。 > - 延迟时间设置过长时,可能会导致该备机XLOG文件所在的磁盘满,需要平衡考虑磁盘大小来设置延迟时间。 > - 没有事务的操作不会被延迟。 > - 主备切换之后,原主机若需延迟,需要再手动配置此参数。 @@ -91,6 +91,20 @@ date: 2021-04-20 > - 主机执行了持有AccessExclusive锁的DDL操作,比如DROP和TRUNCATE操作,在备机延迟回放该条记录期间,在备机上对该操作对象执行查询操作会等待锁释放之后才会返回。 > - 不支持MOT表。 -**取值范围**: 整型,0~INT_MAX,单位为毫秒。 +**取值范围**:整型,0~INT_MAX,单位为毫秒。 -**默认值**: 0(不增加延迟) +**默认值**:0(不增加延迟) + +## redo_bind_cpu_attr + +**参数说明**:用于控制回放线程的绑核操作,仅sysadmin用户可以访问。 + +该参数属于POSTMASTER类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:字符串,长度大于0,该参数不区分大小写。 + +- 'nobind':线程不做绑核。 +- 'nodebind: 1, 2':利用NUMA组1,2中的CPU core进行绑核。 +- 'cpubind: 0-30':利用0-30号CPU core进行绑核。 + +**默认值**:'nobind' diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/4-archiving.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/4-archiving.md index 9f7029558ba6618e4f645977f277986705cfb0e3..02a7dbcfeadd78af11fc27b6fc36c7564acf5bcc 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/4-archiving.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/6-write-ahead-log/4-archiving.md @@ -9,27 +9,30 @@ date: 2021-04-20 ## archive_mode -**参数说明**: 表示是否进行归档操作。 +**参数说明**:表示是否进行归档操作。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** -> 当wal_level设置成minimal时,archive_mode参数无法使用。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> - 当wal_level设置成minimal时,archive_mode参数无法使用。 +> - 无论是同步备机还是异步备机都能够开启归档,归档开启的方式与单机开启归档一致,将archive_mode置为on,并设置正确的archive_dest或者archive_command即可。 +> - 若未开启最大可用模式以及有同步备机与主机断开连接时,主机会因为业务阻塞的原因无法给备机发送归档的位置,从而导致归档失败。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示进行归档。 - off表示不进行归档。 -**默认值**: off +**默认值**:off ## archive_command -**参数说明**: 由管理员设置的用于归档WAL日志的命令,建议归档路径为绝对路径。 +**参数说明**:由管理员设置的用于归档WAL日志的命令,建议归档路径为绝对路径。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 当archive_dest和archive_command同时配置时,WAL日志优先保存到archive_dest所设置的目录中,archive_command配置的命令不生效。 > @@ -41,11 +44,11 @@ date: 2021-04-20 > archive_command = 'cp --remove-destination %p /mnt/server/archivedir/%f' > ``` > -> - -remove-destination选项作用为: 拷贝前如果目标文件已存在,会先删除已存在的目标文件,然后执行拷贝操作。 +> - --remove-destination选项作用为:拷贝前如果目标文件已存在,会先删除已存在的目标文件,然后执行拷贝操作。 > -> - 如果归档命令有多条,则需将其写入SHELL脚本文件中,然后将archive_command配置为执行该脚本的命令。示例如下: +> - 如果归档命令有多条,则需将其写入SHELL脚本文件中,然后将archive_command配置为执行该脚本的命令。示例如下: > -> ```sql +> ``` > --假设多条命令如下。 > test ! -f dir/%f && cp %p dir/%f > --则test.sh脚本内容如下。 @@ -54,17 +57,17 @@ date: 2021-04-20 > archive_command='sh dir/test.sh %p %f' > ``` -**取值范围**: 字符串 +**取值范围**:字符串 -**默认值**: (disabled) +**默认值**:(disabled) ## archive_dest -**参数说明**: 由管理员设置的用于归档WAL日志的目录,建议归档路径为绝对路径。 +**参数说明**:由管理员设置的用于归档WAL日志的目录,建议归档路径为绝对路径。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 当archive_dest和archive_command同时配置时,WAL日志优先保存到archive_dest所设置的目录中,archive_command配置的命令不生效。 > @@ -74,19 +77,21 @@ date: 2021-04-20 > archive_dest = '/mnt/server/archivedir/' > ``` -**默认值**: 空字符串 +**取值范围**:字符串 + +**默认值**:空字符串 ## archive_timeout -**参数说明**: 表示归档周期。 +**参数说明**:表示归档周期。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 超过该参数设定的时间时强制切换WAL段。 > - 由于强制切换而提早关闭的归档文件仍然与完整的归档文件长度相同。因此,将archive_timeout设为很小的值将导致占用巨大的归档存储空间,建议将archive_timeout设置为60秒。 -**取值范围**: 整型,0 ~ INT_MAX,单位为秒。其中0表示禁用该功能。 +**取值范围**:整型,0 ~ INT_MAX,单位为秒。其中0表示禁用该功能。 -**默认值**: 0 +**默认值**:0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/1-sending-server.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/1-sending-server.md index aaa04d4204810e0f2538ada114e0a2896f3c8189..1d5876029cb43a5ae4bb1f40f7db772b5c607dbc 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/1-sending-server.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/1-sending-server.md @@ -9,27 +9,30 @@ date: 2021-04-20 ## max_wal_senders -**参数说明**: 指定事务日志发送进程的并发连接最大数量。不可大于等于max_connections。 +**参数说明**:指定事务日志发送进程的并发连接最大数量。不可大于等于[max_connections](1-connection-settings#max_connections)。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** wal_level必须设置为archive或者hot_standby以允许备机的连接。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**:[wal_level](1-settings#wal_level)必须设置为archive或者hot_standby以允许备机的连接。 -**取值范围**: 整型,0~262143 +**取值范围**:整型,0~1024 -**默认值**: 16 +- 建议取值范围为8 ~ 100。 +- 只有当使用单DN实例无主备场景下才可以设置为0。 + +**默认值**:16 ## wal_keep_segments -**参数说明**: Xlog日志文件段数量。设置"pg_xlog"目录下保留事务日志文件的最小数目,备机通过获取主机的日志进行流复制。 +**参数说明**:Xlog日志文件段数量。设置"pg_xlog"目录下保留事务日志文件的最小数目,备机通过获取主机的日志进行流复制。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,2 ~ INT_MAX +**取值范围**:整型,2 ~ INT_MAX -**默认值**: 16 +**默认值**:16 -**设置建议:** +**设置建议**: - 当服务器开启日志归档或者从检查点恢复时,保留的日志文件数量可能大于wal_keep_segments设定的值。 - 如果此参数设置过小,则在备机请求事务日志时,此事务日志可能已经被产生的新事务日志覆盖,导致请求失败,主备关系断开。 @@ -38,337 +41,113 @@ date: 2021-04-20 ## wal_sender_timeout -**参数说明**: 设置本端等待事务日志接收端接收日志的最大等待时间。 +**参数说明**:设置本端等待事务日志接收端接收日志的最大等待时间。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 如果主机数据较大,重建备机数据库时需要增大此参数的值,主机数据在 500G时,此参数的参考值为600s。 > - 此值不能大于wal_receiver_timeout或数据库重建时的超时参数。 -**取值范围:**整型,0 ~ INT_MAX,单位为毫秒(ms)。 +**取值范围**:整型,0 ~ INT_MAX,单位为毫秒(ms)。 -**默认值**: 6s +**默认值**:6s ## max_replication_slots -**参数说明**: 设置主机端的日志复制slot个数。 +**参数说明**:设置主机端的日志复制slot个数。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型, 0~262143。 +**取值范围**:整型,0 ~ 1024(建议取值范围:8 ~ 100) -**默认值**: 8 +**默认值**:8 -**设置建议**: +**设置建议**: -使用逻辑解码时,该参数值建议设为: 当前物理流复制槽数+所需的逻辑复制槽数。 +当使用双机复制、逻辑解码时,该参数值建议设为:当前物理流复制槽数+所需的逻辑复制槽数。如果实际设置值比上述建议值要小,那么可能造成这些功能不可用或异常。 - 物理流复制槽提供了一种自动化的方法来确保主节点在所有备节点或从备节点收到xlog之前,xlog不会被移除。也就是说物理流复制槽用于支撑主备HA。数据库所需要的物理流复制槽数为备节点加从备的和与主节点之间的比例。例如,假设数据库高可用方案为1主、1备、1从备,则所需物理流复制槽数为2。假设数据库的高可用方案为1主3备,则所需物理流复制槽数为3。 -- 关于逻辑复制槽数,请按如下规则考虑: +- 目前默认不支持主备从部署方式。 +- 关于逻辑复制槽数,请按如下规则考虑: - 一个逻辑复制槽只能解码一个数据库的修改,如果需要解码多个数据库,则需要创建多个逻辑复制槽。 - 如果需要多路逻辑复制同步给多个目标数据库,在源端数据库需要创建多个逻辑复制槽,每个逻辑复制槽对应一条逻辑复制链路。 ## enable_slot_log -**参数说明**: 是否开启逻辑复制槽主备同步特性。 +**参数说明**:是否开启逻辑复制槽主备同步特性。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示开启逻辑复制槽主备同步特性。 - off表示不开启逻辑复制槽主备同步特性。 -**默认值**: off +**默认值**:off ## max_changes_in_memory -**参数说明**: 逻辑解码时单条事务在内存中缓存的大小上限,单位字节。 +**参数说明**:逻辑解码时单条事务在内存中缓存的大小上限,单位字节。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~2147483647 +**取值范围**:整型,1~2147483647 -**默认值**: 4096 +**默认值**:4096 ## max_cached_tuplebufs -**参数说明**: 逻辑解码时总元组信息在内存中缓存的大小上限,单位字节。建议设置为max_changes_in_memory的两倍以上。 +**参数说明**:逻辑解码时总元组信息在内存中缓存的大小上限,单位字节。建议设置为[max_changes_in_memory](1-sending-server#max_changes_in_memory)的两倍以上。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~2147483647 - -**默认值**: 8192 - -## replconninfo1 - -**参数说明**: 设置本端侦听和鉴权的第一个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第一个节点信息。 - -**默认值**: 空字符串 - -## replconninfo2 - -**参数说明**: 设置本端侦听和鉴权的第二个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第二个节点信息。 - -**默认值**: 空字符串 - -## replconninfo3 - -**参数说明**: 设置本端侦听和鉴权的第三个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第三个节点信息。 - -**默认值**: 空字符串 - -## replconninfo4 - -**参数说明**: 设置本端侦听和鉴权的第四个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第四个节点信息。 - -**默认值**: 空字符串 - -## replconninfo5 - -**参数说明**: 设置本端侦听和鉴权的第五个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第五个节点信息。 - -**默认值**: 空字符串 - -## replconninfo6 - -**参数说明**: 设置本端侦听和鉴权的第六个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第六个节点信息。 - -**默认值**: 空字符串 - -## replconninfo7 - -**参数说明**: 设置本端侦听和鉴权的第七个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第七个节点信息。 - -**默认值**: 空字符串 - -## replconninfo8 - -**参数说明**: 设置本端侦听和鉴权的第八个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围:**字符串。其中空字符串表示没有配置第八个节点信息。 - -**默认值**: 空字符串 - -## replconninfo9 - -**参数说明**: 设置本端侦听和鉴权的第九个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第九个节点信息。 - -**默认值**: 空字符串 - -## replconninfo10 - -**参数说明**: 设置本端侦听和鉴权的第十个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第十个节点信息。 - -**默认值**: 空字符串 - -## replconninfo11 - -**参数说明**: 设置本端侦听和鉴权的第十一个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第十一个节点信息。 - -**默认值**: 空字符串 - -## replconninfo12 +**取值范围**:整型,1~2147483647 -**参数说明**: 设置本端侦听和鉴权的第十二个节点信息。 +**默认值**:8192 -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第十二个节点信息。 - -**默认值**: 空字符串 - -## replconninfo13 - -**参数说明**: 设置本端侦听和鉴权的第十三个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第十三个节点信息。 - -**默认值**: 空字符串 +## enable_wal_shipping_compression -## replconninfo14 - -**参数说明**: 设置本端侦听和鉴权的第十四个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第十四个节点信息。 - -**默认值**: 空字符串 - -## replconninfo15 - -**参数说明**: 设置本端侦听和鉴权的第十五个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**参数说明:**在流式容灾模式下设置启动跨数据库实例日志压缩功能。 -**取值范围**: 字符串。其中空字符串表示没有配置第十五个节点信息。 - -**默认值**: 空字符串 - -## replconninfo16 - -**参数说明**: 设置本端侦听和鉴权的第十六个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第十六个节点信息。 - -**默认值**: 空字符串 - -## replconninfo17 - -**参数说明**: 设置本端侦听和鉴权的第十七个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第十七个节点信息。 - -**默认值**: 空字符串 - -## replconninfo18 - -**参数说明**: 设置本端侦听和鉴权的第十八个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +该参数属于SIGHUP类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。其中空字符串表示没有配置第十八个节点信息。 +> **须知:** 该参数仅作用于流式容灾中跨数据库实例传输的一对walsender与walreceiver中,在主数据库实例上配置。 -**默认值**: 空字符串 - -## cross_cluster_replconninfo1 - -**参数说明**: 设置跨集群的本端侦听和鉴权的第一个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第一个节点信息。 - -**默认值**: 空字符串 - -## cross_cluster_replconninfo2 - -**参数说明**: 设置跨集群的本端侦听和鉴权的第二个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第二个节点信息。 - -**默认值**: 空字符串 - -## cross_cluster_replconninfo3 - -**参数说明**: 设置跨集群的本端侦听和鉴权的第三个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第三个节点信息。 - -**默认值**: 空字符串 - -## cross_cluster_replconninfo4 - -**参数说明**: 设置跨集群的本端侦听和鉴权的第四个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第四个节点信息。 - -**默认值**: 空字符串 - -## cross_cluster_replconninfo5 - -**参数说明**: 设置跨集群的本端侦听和鉴权的第五个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**: 字符串。其中空字符串表示没有配置第五个节点信息。 - -**默认值**: 空字符串 - -## cross_cluster_replconninfo6 - -**参数说明**: 设置跨集群的本端侦听和鉴权的第六个节点信息。 - -该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**取值范围**:布尔型 -**取值范围**: 字符串。其中空字符串表示没有配置第六个节点信息。 +- true表示打开流式容灾跨数据库实例日志压缩 +- false表示关闭流式容灾跨数据库实例日志压缩 -**默认值**: 空字符串 +**默认值:**false -## cross_cluster_replconninfo7 +## replconninfoN -**参数说明**: 设置跨集群的本端侦听和鉴权的第七个节点信息。 +**参数说明**:设置本端侦听和鉴权的第N个节点信息(N=1, 2, 3, ...8)。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。其中空字符串表示没有配置第七个节点信息。 +**取值范围**:字符串。其中空字符串表示没有配置第N个节点信息。 -**默认值**: 空字符串 +**默认值**:空字符串 -## cross_cluster_replconninfo8 +## cross_cluster_replconninfoN -**参数说明**: 设置跨集群的本端侦听和鉴权的第八个节点信息。 +**参数说明**:设置跨集群的本端侦听和鉴权的第N个节点信息(N=1, 2, 3, ...8)。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串。其中空字符串表示没有配置第八个节点信息。 +**取值范围**:字符串。其中空字符串表示没有配置第N个节点信息。 -**默认值**: 空字符串 +**默认值**:空字符串 ## available_zone -**参数说明**: 设置本端节点所在区域信息。 +**参数说明**:设置本端节点所在区域信息。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符串。其中空字符串表示没有配置节点信息。 +**取值范围**:字符串。其中空字符串表示没有配置节点信息。 -**默认值**: 空字符串 +**默认值**:空字符串 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/2-primary-server.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/2-primary-server.md index 370325a6cf06b60bb2af721fe5dd3202b026cfc3..77b53f9d32563a1f562776fe0f84c09ba2a481c0 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/2-primary-server.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/2-primary-server.md @@ -9,20 +9,20 @@ date: 2021-04-20 ## synchronous_standby_names -**参数说明**: 潜在同步复制的备机名称列表,每个名称用逗号分隔。 +**参数说明**:潜在同步复制的备机名称列表,每个名称用逗号分隔。 该参数属于SIGHUP类型参数,请参考表[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) **须知**: > > - 当前连接的同步备机是列表中的第一个名称。如果当前同步备机失去连接,则它会立即更换下一个优先级更高的备机,并将此备机的名称放入列表中。 > - 备机名称可以通过设置环境变量PGAPPNAME指定。 -**取值范围**: 字符串。当取值为*,表示匹配任意提供同步复制的备机名称。支持按如下格式配置: +**取值范围**:字符串。当取值为*,表示匹配任意提供同步复制的备机名称。支持按如下格式配置: -- ANY **num_sync (standby_name** [, …]) -- [FIRST] **num_sync (standby_name** [, …]) -- **standby_name** [, …] +- ANY **num_sync (standby_name** [, ...]) [, ANY **num_sync (standby_name** [, ...])] +- [FIRST] **num_sync (standby_name** [, ...]) +- **standby_name** [, ...] > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > @@ -30,6 +30,8 @@ date: 2021-04-20 > > - ANY N (node1,node2,…) 表示在括号内任选N个主机名称作为同步复制的备机名称列表。例如,ANY 1 (node1,node2) 表示在node1和node2中任选一个作为同步复制的备机名称。 > +> - ANY N1 (node1,node2,…), ANY N2 (node3,node4,…) 表示分组潜在同步复制的备机名称列表,在第一组括号内任选N1个主机名称作为第一组同步复制的备机名称列表,在第二组括号内任选N2个主机名称作为第二组同步复制的备机名称列表。此时两个分组之间为且关系,必须两个分组均达到各自需求的同步备机数,本地事务才可以被提交。 +> > - FIRST N (node1,node2,…)表示在括号内按出现顺序的先后作为优先级选择前N个主机名称作为同步复制的备机名称列表。例如,FIRST 1 (node1,node2)表示选择node1作为同步复制的备机名称。 > > - node1,node2,…和FIRST 1 (node1,node2,…) 具有的含义相同。 @@ -39,31 +41,58 @@ date: 2021-04-20 > ``` > gs_guc reload -Z datanode -N @NODE_NAME@ -D @DN_PATH@ -c "synchronous_standby_names='ANY NODE 1(dn_instanceId1, dn_instanceId2)'"; > ``` +> +> 或者: +> +> ``` +> gs_guc reload -Z datanode -N @NODE_NAME@ -D @DN_PATH@ -c "synchronous_standby_names='ANY 1(AZ1, AZ2)'"; +> ``` > -> 或者: -> -> ``` -> gs_guc reload -Z datanode -N @NODE_NAME@ -D @DN_PATH@ -c "synchronous_standby_names='ANY 1(AZ1, AZ2)'"; -> ``` -**默认值**: * +**默认值**:* + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif)**说明:** +> +> - 备机名称列表中不可出现重复的名称,配置中num_sync 不可大于备机列表数量。 +> - 多分组同步备机配置 如ANY N1 (node1,node2,…), ANY N2 (node3,node4,…) 的时候,多个分组之间为且关系,当前仅支持多ANY分组。不允许使用 * 来作为模糊匹配,不允许出现配置重复的备机。 ## most_available_sync -**参数说明**: 在有同步备机故障时,主机事务不因同步备机故障而被阻塞。比如有两个同步备机,一个故障,另一个正常,这个时候主机事务只会等好的这个同步备,而不被故障的同步备所阻塞; 再比如走quroum协议时,一主三同步备,配置ANY 2(node1,node2,node3),当node1、node3故障,node2正常时,主机业务同样不被阻塞。 +**参数说明**:在有同步备机故障时,主机事务不因同步备机故障而被阻塞。比如有两个同步备机,一个故障,另一个正常,这个时候主机事务只会等好的这个同步备,而不被故障的同步备所阻塞; 再比如走quroum协议时,一主三同步备,配置ANY 2(node1,node2,node3),当node1、node3故障,node2正常时,主机业务同样不被阻塞。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示在有同步备机故障时,不阻塞主机。 - off表示在有同步备机故障时,阻塞主机。 -**默认值**: off +**默认值**:off + +## keep_sync_window + +**参数说明:**延迟进入最大可用模式的时间。 + +- 当最大可用模式most_available_sync配置为on,在主备场景下,当存在同步备发生故障,导致不满足当前所配置的同步备数量(详细可参考synchonous_standby_name的含义)时,如果配置了keep_sync_window参数, 则在keep_sync_window设置的时间窗口内,继续保持最大保护模式,即阻塞主机的事务提交, 延缓进入最大可用模式的时间。 +- 若在keep_sync_window超时窗口内,同步备机故障恢复,且满足当前所配置的同步备数量, 则不阻塞事务, 恢复到正常状态. +- 如果设置keep_sync_window,推荐最小配置为5s,以避免监控系统监控到网络不稳定的误报。 + +该参数属于SIGHUP类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围:**整形,范围0~INT_MAX,单位为秒。 + +- 0表示不设置keep_sync_window超时时间窗口, 即直接进入最大可用模式。 +- 其余表示keep_sync_window超时时间窗口的大小。 + +**默认值**:0 + +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> +> 配置该参数可能会对RPO造成影响, 若主机在所配置的超时时间窗口内发生故障,则从开始阻塞到主机故障这段时间窗口内的数据可能丢失。 ## enable_stream_replication -**参数说明**: 控制主备、主从是否进行数据和日志同步。 +**参数说明**:控制主备、主从是否进行数据和日志同步。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -71,145 +100,149 @@ date: 2021-04-20 > > - 此参数属于性能测试参数,用于测试带有备机和不带备机的性能参数。关闭参数后,不能进行切换、故障等异常场景测试,否则会出现主备从不一致的情况。 > - 此参数属于受控参数,不建议正常业务场景下关闭此参数。 +> - 当前版本默认不支持主备从部署模式。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开主备、主从同步。 - off表示关闭主备、主从同步。 -**默认值**: on +**默认值**:on ## enable_mix_replication -**参数说明**: 控制主备、主从之间WAL日志及数据复制的方式。 +**参数说明**:控制主备、主从之间WAL日志及数据复制的方式。 该参数属于INTERNAL类型参数,默认值为off,不允许外部修改。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> +> - 此参数目前不允许正常业务场景下改变其值,即关闭WAL日志、数据页混合复制模式。 > -> 此参数目前不允许正常业务场景下改变其值,即关闭WAL日志、数据页混合复制模式。 +> - 当前版本默认不支持主备从部署模式。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示打开WAL日志、数据页混合复制模式。 - off表示关闭WAL日志、数据页混合复制模式。 -**默认值**: off +**默认值**:off ## vacuum_defer_cleanup_age -**参数说明**: 指定VACUUM使用的事务数,VACUUM会延迟清除无效的行存表记录,延迟的事务个数通过vacuum_defer_cleanup_age进行设置。即VACUUM和VACUUM FULL操作不会立即清理刚刚被删除元组。 +**参数说明**:指定VACUUM使用的事务数,VACUUM会延迟清除无效的行存表记录,延迟的事务个数通过vacuum_defer_cleanup_age进行设置。即VACUUM和VACUUM FULL操作不会立即清理刚刚被删除元组。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0~1000000,值为0表示不延迟。 +**取值范围**:整型,0~1000000,值为0表示不延迟。 -**默认值**: 0 +**默认值**:0 ## data_replicate_buffer_size -**参数说明**: 发送端与接收端传递数据页时,队列占用内存的大小。此参数会影响主备之间复制的缓冲大小。 +**参数说明**:发送端与接收端传递数据页时,队列占用内存的大小。此参数会影响主备之间复制的缓冲大小。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,4096~1072693248,单位为KB。 +**取值范围**:整型,4096~1072693248,单位为KB。 -**默认值**: 16MB(即16448KB) +**默认值**:16MB(即16448KB) ## walsender_max_send_size -**参数说明**: 设置主机端日志或数据发送缓冲区的大小。 +**参数说明**:设置主机端日志或数据发送缓冲区的大小。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,8~INT_MAX,单位为KB。 +**取值范围**:整型,8~INT_MAX,单位为KB。 -**默认值**: 8M(即8192KB) +**默认值**:8M(即8192KB) ## enable_data_replicate -**参数说明**: 当数据库在数据导入行存表时,主机与备机的数据同步方式可以进行选择。 +**参数说明**:当数据库在数据导入行存表时,主机与备机的数据同步方式可以进行选择。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示导入数据行存表时主备数据采用数据页的方式进行同步。当replication_type参数为1时,不允许设置为on,如果此时用guc工具设置成on,会强制改为off。 - off表示导入数据行存表时主备数据采用日志(Xlog)方式进行同步。 -**默认值**: off +**默认值**:off ## ha_module_debug -**参数说明**: 用于查看数据复制时具体数据块的复制状态日志。 +**参数说明**:用于查看数据复制时具体数据块的复制状态日志。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示日志中将打印数据复制时每个数据块的状态。 - off表示日志中不打印数据复制时每个数据块的状态。 -**默认值**: off +**默认值**:off ## enable_incremental_catchup -**参数说明**: 控制主备之间数据追赶(catchup)的方式。 +**参数说明**:控制主备之间数据追赶(catchup)的方式,目前默认不支持主备从部署模式。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示备机catchup时用增量catchup方式,即从从备本地数据文件扫描获得主备差异数据文件列表,进行主备之间的catchup。 - off表示备机catchup时用全量catchup方式,即从主机本地所有数据文件扫描获得主备差异数据文件列表,进行主备之间的catchup。 -**默认值**: on +**默认值**:on ## wait_dummy_time -**参数说明**: 同时控制增量数据追赶(catchup)时,MogDB主备从按顺序启动时等待从备启动的最长时间以及等待从备发回扫描列表的最长时间。 +**参数说明**:同时控制增量数据追赶(catchup)时,MogDB主备从按顺序启动时等待从备启动的最长时间以及等待从备发回扫描列表的最长时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,范围1~INT_MAX,单位为秒 +**取值范围**:整型,范围1~INT_MAX,单位为秒 -**默认值**: 300 +**默认值**:300 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > -> 单位只能设置为秒。 +> - 单位只能设置为秒。 +> - 当前版本默认不支持主备从部署模式。 ## catchup2normal_wait_time -**参数说明**: 打开最大可用模式most_available_sync,主备场景下,控制备机数据追赶(catchup)阻塞主机的最长时间。该时间为估算值,实际结果可能与参数值有偏差。 +**参数说明**:打开最大可用模式most_available_sync,主备场景下,控制备机数据追赶(catchup)阻塞主机的最长时间。该时间为估算值,实际结果可能与参数值有偏差。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,范围-1~10000,单位为毫秒。 +**取值范围**:整型,范围-1~10000,单位为毫秒。 - -1表示主机阻塞直到备机数据追赶完成。 - 0表示备机数据追赶时始终不阻塞主机。 - 其余值表示备机数据追赶时阻塞主机的最长时间。例如,取值5000,表示当备机数据追赶完成时间还剩5s时,阻塞主机等待其完成。 -**默认值**: -1 +**默认值**:-1 ## sync_config_strategy -**参数说明**: 主机和备机、备机和级联备之间配置文件的同步策略。 +**参数说明**:主机和备机、备机和级联备之间配置文件的同步策略。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**枚举类型 +**取值范围**:枚举类型 - all_node: 主机配置为all_node时,表示允许主机向所有备机主动同步配置文件;备机配置为all_node时,表示允许当前备机向其主机发送同步请求,允许当前备机向其所有级联备主动同步配置文件;级联备配置为all_node时,表示允许当前级联备向其备机发送同步请求。 - only_sync_node: 主机配置为only_sync_node时,表示仅允许主机向所有同步备机主动同步配置文件;备机配置为only_sync_node时,表示允许当前备机向其主机发送同步请求,不允许当前备机向其所有级联备主动同步配置文件;级联备配置为only_sync_node时,表示允许当前级联备向其备机发送同步请求。 - none_node: 主机配置为none_node时,表示不允许主机向任何备机主动同步配置文件;备机配置为none_node时,表示不允许当前备机向其主机发送同步请求,不允许当前备机向其所有级联备主动同步配置文件;级联备配置为none_node时,表示不允许当前级联备向其备机发送同步请求。 -**默认值**: all_node +**默认值**:all_node > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > > - 在一个包含了主机、备机和级联备的MogDB集群中,主机相对于备机是发送端,备机相对于主机是接收端,备机相对于级联备是发送端,级联备相对于备机是接收端。 > - 发送端主动向接收端同步配置文件、接收端请求发送端同步配置文件是两个独立的事件,均会使得配置文件同步。若不希望配置文件同步,则需要将集群中所有节点的sync_config_strategy参数配置为none_node;若仅希望主机与同步备机同步配置文件,则需要将主机的sync_config_strategy参数配置为only_sync_node,其余节点配置为none_node;若希望所有节点同步配置文件,则需要将所有节点的sync_config_strategy参数配置为all_node。目前暂不支持自定义指定任意节点间的同步策略。 > - 配置参数同步的具体表现为,发送端发送配置文件,对接收端配置文件中的对应参数直接覆盖。若设置了配置文件需要同步的策略,则修改接收端配置参数后,发送端会立刻覆盖接收端的配置参数,使得接收端修改不生效。 -> - 即使设置了配置文件需要同步的策略,仍有部分配置参数不会被同步。它们是: “application_name”, “archive_command”, “audit_directory”, “available_zone”, “comm_control_port”, “comm_sctp_port”, “listen_addresses”, “log_directory”, “port”, “replconninfo1”, “replconninfo2”, “replconninfo3”, “replconninfo4”, “replconninfo5”, “replconninfo6”, “replconninfo7”, “replconninfo8”, “ssl”, “ssl_ca_file”, “ssl_cert_file”, “ssl_ciphers”, “ssl_crl_file”, “ssl_key_file”, “ssl_renegotiation_limit”, “ssl_cert_notify_time”, “synchronous_standby_names”, “local_bind_address”, “perf_directory”, “query_log_directory”, “asp_log_directory”, “streaming_router_port”, “enable_upsert_to_merge”, “archive_dest”, “recovery_min_apply_delay”, “sync_config_strategy”。 +> - 即使设置了配置文件需要同步的策略,仍有部分配置参数不会被同步。它们是:“application_name”、 “archive_command”、 “audit_directory”、 “available_zone”、 “comm_control_port”、 “comm_sctp_port”、 “listen_addresses”、 “log_directory”、 “port”、 “replconninfo1”、 “replconninfo2”、 “replconninfo3”、 “replconninfo4”、 “replconninfo5”、 “replconninfo6”、 “replconninfo7”、 “replconninfo8”、 “ssl”、 “ssl_ca_file”、 “ssl_cert_file”、 “ssl_ciphers”、 “ssl_crl_file”、 “ssl_key_file”、 “ssl_renegotiation_limit”、 “ssl_cert_notify_time”、 “synchronous_standby_names”、 “local_bind_address”、 “perf_directory”、 “query_log_directory”、 “asp_log_directory”、 “streaming_router_port”、 “enable_upsert_to_merge”、 “archive_dest”、 “recovery_min_apply_delay”、 “sync_config_strategy”。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/3-standby-server.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/3-standby-server.md index 7d3e8e6164420c0a6deb37d86b5409a8d4518814..e20fdb6dd82434e77d0cd6b9439a31ec4c6b78cc 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/3-standby-server.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/7-ha-replication/3-standby-server.md @@ -9,126 +9,138 @@ date: 2021-04-20 ## hot_standby -**参数说明**: 设置是否允许备机在恢复过程中连接和查询。 +**参数说明**:设置是否允许备机在恢复过程中连接和查询。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > -> - 如果此参数设置为on,wal_level必须设置为hot_standby,否则将导致数据库无法启动。 +> - 如果此参数设置为on,[wal_level](1-settings#wal_level)必须设置为hot_standby,否则将导致数据库无法启动。 > - 在双机环境中,因为会对双机其他一些功能产生影响,hot_standby参数不能设置成off。 +> - 如果hot_standby参数曾经被关闭,且wal_level参数曾被设置低于hot_standby等级,那么,再次打开hot_standby参数之前,为了确保主备环境下备机上待回放的日志都可以支持备机查询功能,需要进行如下操作: +> - 将主、备的wal_level参数调整到hot_standby等级或以上,并重启实例生效。 +> - 在主机上执行checkpoint操作,并通过查询pg_stat_get_wal_senders()系统函数,确认各个备机的receiver_replay_location追上主机当前的sender_flush_location,保证wal_level的调整同步到备机并生效,且备机不需要再回放之前低等级的日志。 +> - 将主、备的hot_standby参数打开(设为on),并重启实例生效。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许备机在恢复过程中连接和查询。 - off表示不允许备机在恢复过程中连接和查询。 -**默认值**: on +**默认值**:on ## max_standby_archive_delay -**参数说明**: 当开启双机热备模式时,如果备机正处理归档WAL日志数据,这时进行查询就会产生冲突,此参数就是设置备机取消查询之前所等待的时间。 +**参数说明**:当开启双机热备模式时,如果备机正处理归档WAL日志数据,这时进行查询就会产生冲突,此参数就是设置备机取消查询之前所等待的时间。 该参数属于SIGHUP类型参数,请参考表[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) **须知**:-1表示允许备机一直等待冲突的查询完成。 > -> -1表示允许备机一直等待冲突的查询完成。 -**取值范围:**整型,范围: -1~INT_MAX,单位为毫秒。 +**取值范围**:整型,范围:-1~INT_MAX,单位为毫秒。 -**默认值**: 3s(即3000ms) +**默认值**:3s(即3000ms) ## max_standby_streaming_delay -**参数说明**: 当开启双机热备模式时,如果备机正通过流复制接收WAL日志数据,这时进行查询就会产生冲突,这个参数就是设置备机取消查询之前所等待的时间。 +**参数说明**:当开启双机热备模式时,如果备机正通过流复制接收WAL日志数据,这时进行查询就会产生冲突,这个参数就是设置备机取消查询之前所等待的时间。 该参数属于SIGHUP类型参数,请参考表[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) **须知**:-1表示允许备机一直等待冲突的查询完成。 > -> -1表示允许备机一直等待冲突的查询完成。 -**取值范围:**整型(毫秒),范围: -1~INT_MAX。 +**取值范围**:整型(毫秒),范围:-1~INT_MAX。 -**默认值**: 3s(即3000ms) +**默认值**: 3s(即3000ms) ## wal_receiver_status_interval -**参数说明**: 设置WAL日志接收进程的状态通知给主机的最大时间间隔。 +**参数说明**:设置WAL日志接收进程的状态通知给主机的最大时间间隔。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,范围: 0 ~ INT_MAX,单位为毫秒。 +**取值范围**:整型,范围:0 ~ INT_MAX,单位为毫秒。 -**默认值**: 5s(即5000ms) +**默认值**:5s(即5000ms) > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> > 当该参数设置为0时,表示关闭备机向主机反馈日志接收位置等信息,可能会导致主机事务提交阻塞、switchover操作失败等异常现象。正常业务场景,不建议将该参数设置为0。 ## hot_standby_feedback -**参数说明**: 设置是否允许将备机上执行查询的结果反馈给主机,这可以避免查询冲突。 +**参数说明**:设置是否允许将备机上执行查询的结果反馈给主机,这可以避免查询冲突。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示允许将备机上执行查询的最小事务号反馈给主机。 - off表示不允许将备机上执行查询的最小事务号反馈给主机。 -**默认值**: off +**默认值**:off -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**:当该参数为on时,主机的旧版本数据的清理会受限于备机正在读的事务,即主机只允许清理小于备机反馈回来的事务所作的更改。 所以,若该参数开启时,会影响主机的性能。 > -> 当该参数为on时,主机的旧版本数据的清理会受限于备机正在读的事务,即主机只允许清理小于备机反馈回来的事务所作的更改。 所以,若该参数开启时,会影响主机的性能。 ## wal_receiver_timeout -**参数说明**: 设置从主机接收数据的最大等待时间。 +**参数说明**:设置从主机接收数据的最大等待时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0 ~ INT_MAX,单位为毫秒。 +**取值范围**:整型,0 ~ INT_MAX,单位为毫秒。 -**默认值**: 6s(即6000ms) +**默认值**:6s(即6000ms) ## wal_receiver_connect_timeout -**参数说明**: 设置连接主机的最大等待超时时间。 +**参数说明**:设置连接主机的最大等待超时时间。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,0 ~ INT_MAX / 1000,单位为秒。 +**取值范围**:整型,0 ~ INT_MAX / 1000,单位为秒。 -**默认值**: 2s +**默认值**:2s ## wal_receiver_connect_retries -**参数说明**: 设置连接主机的最大尝试次数。 +**参数说明**:设置连接主机的最大尝试次数。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,1~ INT_MAX。 +**取值范围**:整型,1~ INT_MAX。 -**默认值**: 1 +**默认值**:1 ## wal_receiver_buffer_size -**参数说明**: 备机与从备接收Xlog存放到内存缓冲区的大小。 +**参数说明**:备机与从备接收Xlog存放到内存缓冲区的大小,目前默认不支持主备从部署模式。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**整型,4096~1047552,单位为KB。 +**取值范围**:整型,4096~1047552,单位为KB。 -**默认值**: 64MB(即65536KB) +**默认值**:64MB(即65536KB) ## primary_slotname -**参数说明**: 设置备机对应主机的slot name,用于主备校验,与wal日志删除机制。 +**参数说明**:设置备机对应主机的slot name,用于主备校验,与wal日志删除机制。 该参数属于SIGHUP类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**字符型 +**取值范围**:字符型 + +**默认值**:空字符串 + +## max_logical_replication_workers + +**参数说明**:订阅端apply worker线程的最大数量。 + +该参数属于POSTMASTER类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:整型,0~262143 -**默认值**: 空字符串 +**默认值**:4 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/8-mot.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/8-mot.md index 2c35cdd3196c80f04ced18cd717e1251687e86a6..7a089893456a662e085d0850ba8b98aa5c590199 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/8-mot.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/8-mot.md @@ -11,63 +11,62 @@ date: 2021-04-20 ## enable_codegen_mot -**参数说明**: 设置是否启用原生LLVM Lite执行简单查询。如果当前平台上不支持原生LLVM,那么将使用伪LLVM。 +**参数说明**:设置是否启用原生LLVM Lite执行简单查询。如果当前平台上不支持原生LLVM,那么将使用伪LLVM。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔值 +**取值范围**:布尔值 -**默认值**: true +**默认值**:true ## force_pseudo_codegen_mot -**参数说明**: 设置是否强制伪LLVM Lite执行简单查询,即使当前平台上支持原生LLVM。 +**参数说明**:设置是否强制伪LLVM Lite执行简单查询,即使当前平台上支持原生LLVM。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔值 +**取值范围**:布尔值 -**默认值**: true +**默认值**:true -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> 即使将force_pseudo_codegen_mot设置为true,而当前平台不支持原生LLVM,那么仍然会使用伪LLVM。 +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**:即使将force_pseudo_codegen_mot设置为true,而当前平台不支持原生LLVM,那么仍然会使用伪LLVM。 ## enable_codegen_mot_print -**参数说明**: 设置是否打印生成函数的IR字节码(如果使用伪 LLVM,则打印伪IR字节码)。 +**参数说明**:设置是否打印生成函数的IR字节码(如果使用伪 LLVM,则打印伪IR字节码)。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔值 +**取值范围**:布尔值 -**默认值**: true +**默认值**:true ## codegen_mot_limit -**参数说明**: 设置全局缓存计划源的数量限制,以及每个会话的克隆计划。 +**参数说明**:设置全局缓存计划源的数量限制以及每个会话的克隆计划。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: uint32 +**取值范围**:uint32 -**默认值**: 100 +**默认值**:100 ## mot_allow_index_on_nullable_column -**参数说明**: 设置是否允许在内存表nullable列上创建索引。 +**参数说明**:设置是否允许在内存表nullable列上创建索引。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔值 +**取值范围**:布尔值 -**默认值**: true +**默认值**:true ## mot_config_file -**参数说明**: 指定MOT的主配置文件。 +**参数说明**:指定MOT的主配置文件。 该参数属于POSTMASTER类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串 +**取值范围**:字符串 -**默认值**: NULL +**默认值**:NULL diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/1-optimizer-method-configuration.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/1-optimizer-method-configuration.md index be3f0d2b9c5b0ad1411c2bcb2b38e436d9792044..a15fcb21095a18a7c8a6c64237871eb14e91de61 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/1-optimizer-method-configuration.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/1-optimizer-method-configuration.md @@ -11,297 +11,331 @@ date: 2021-04-20 ## enable_bitmapscan -**参数说明**: 控制优化器对位图扫描规划类型的使用。 +**参数说明**:控制优化器对位图扫描规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## force_bitmapand -**参数说明**: 控制优化器强制使用bitmapand规划类型的使用。 +**参数说明**:控制优化器强制使用bitmapand规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: off +**默认值**:off ## enable_hashagg -**参数说明**: 控制优化器对Hash聚集规划类型的使用。 +**参数说明**:控制优化器对Hash聚集规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_hashjoin -**参数说明**: 控制优化器对Hash连接规划类型的使用。 +**参数说明**:控制优化器对Hash连接规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_indexscan -**参数说明**: 控制优化器对索引扫描规划类型的使用。 +**参数说明**:控制优化器对索引扫描规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_indexonlyscan -**参数说明**: 控制优化器对仅索引扫描规划类型的使用。 +**参数说明**:控制优化器对仅索引扫描规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_material -**参数说明**: 控制优化器对实体化的使用。消除整个实体化是不可能的,但是可以关闭这个变量以防止优化器插入实体节点。 +**参数说明**:控制优化器对实体化的使用。消除整个实体化是不可能的,但是可以关闭这个变量以防止优化器插入实体节点。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_mergejoin -**参数说明**: 控制优化器对融合连接规划类型的使用。 +**参数说明**:控制优化器对融合连接规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: off +**默认值**:off ## enable_nestloop -**参数说明**: 控制优化器对内表全表扫描嵌套循环连接规划类型的使用。完全消除嵌套循环连接是不可能的,但是关闭这个变量就会让优化器在存在其他方法的时候优先选择其他方法。 +**参数说明**:控制优化器对内表全表扫描嵌套循环连接规划类型的使用。完全消除嵌套循环连接是不可能的,但是关闭这个变量就会让优化器在存在其他方法的时候优先选择其他方法。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: off +**默认值**:off ## enable_index_nestloop -**参数说明**: 控制优化器对内表参数化索引扫描嵌套循环连接规划类型的使用。 +**参数说明**:控制优化器对内表参数化索引扫描嵌套循环连接规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_seqscan -**参数说明**: 控制优化器对顺序扫描规划类型的使用。完全消除顺序扫描是不可能的,但是关闭这个变量会让优化器在存在其他方法的时候优先选择其他方法。 +**参数说明**:控制优化器对顺序扫描规划类型的使用。完全消除顺序扫描是不可能的,但是关闭这个变量会让优化器在存在其他方法的时候优先选择其他方法。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_sort -**参数说明**: 控制优化器使用的排序步骤。完全消除明确的排序是不可能的,但是关闭这个变量可以让优化器在存在其他方法的时候优先选择其他方法。 +**参数说明**:控制优化器使用的排序步骤。完全消除明确的排序是不可能的,但是关闭这个变量可以让优化器在存在其他方法的时候优先选择其他方法。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_tidscan -**参数说明**: 控制优化器对TID扫描规划类型的使用。 +**参数说明**:控制优化器对TID扫描规划类型的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_kill_query -**参数说明**: CASCADE模式删除用户时,会删除此用户拥有的所有对象。此参数标识是否允许在删除用户的时候,取消锁定此用户所属对象的query。 +**参数说明**:CASCADE模式删除用户时,会删除此用户拥有的所有对象。此参数标识是否允许在删除用户的时候,取消锁定此用户所属对象的query。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示允许取消锁定。 - off表示不允许取消锁定。 -**默认值**: off +**默认值**:off ## enforce_a_behavior -**参数说明**: 控制正则表达式的规则匹配模式。 +**参数说明**:控制正则表达式的规则匹配模式。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示正则表达式采用A格式的匹配规则。 - off表示正则表达式采用POSIX格式的匹配规则。 -**默认值**: on +**默认值**:on ## max_recursive_times -**参数说明**: 控制with recursive的最大迭代次数。 +**参数说明**:控制with recursive的最大迭代次数。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~INT_MAX。 +**取值范围**:整型,0~INT_MAX。 -**默认值**: 200 +**默认值**:200 ## enable_vector_engine -**参数说明**: 控制优化器对向量化执行引擎的使用。 +**参数说明**:控制优化器对向量化执行引擎的使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## enable_change_hjcost -**参数说明**: 控制优化器在Hash Join代价估算路径选择时,是否使用将内表运行时代价排除在Hash Join节点运行时代价外的估算方式。如果使用,则有利于选择条数少,但运行代价大的表做内表。 +**参数说明**:控制优化器在Hash Join代价估算路径选择时,是否使用将内表运行时代价排除在Hash Join节点运行时代价外的估算方式。如果使用,则有利于选择条数少,但运行代价大的表做内表。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: off +**默认值**:off ## enable_absolute_tablespace -**参数说明**: 控制表空间是否可以使用绝对路径。 +**参数说明**:控制表空间是否可以使用绝对路径。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示可以使用绝对路径。 - off表示不可以使用绝对路径。 -**默认值**: on +**默认值**:on ## enable_valuepartition_pruning -**参数说明**: 是否对DFS分区表进行静态/动态优化。 +**参数说明**:是否对DFS分区表进行静态/动态优化。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围:**布尔型 +**取值范围**:布尔型 - on表示对DFS分区表进行静态/动态优化。 - off表示不对DFS分区表进行静态/动态优化。 -**默认值**: on +**默认值**:on + +## expected_computing_nodegroup + +**参数说明**:标识选定的计算Node Group模式或目标计算Node Group。Node Group目前为内部用机制,用户无需设置。 + +共4种计算Node Group模式,用于关联操作和聚集操作时选定计算Node Group。在每一种模式中,优化器有针对性地选定几个候选计算Node Group,然后根据代价,从中为当前算子挑选最佳计算Node Group。 + +该参数属于USERSET类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:字符串 + +- optimal:候选计算Node Group列表包含算子操作对象所在的Node Group和由当前用户具有COMPUTE权限的所有Node Group包含的数据库节点构成的Node Group +- query:候选计算Node Group列表包含算子操作对象所在的Node Group和由当前查询涉及的所有基表所在Node Group包含的数据库节点构成的Node Group +- Node Group名([enable_nodegroup_debug](#enable_nodegroup_debug)被设置为off):候选计算Node Group列表包含算子操作对象所在的Node Group和该指定的Node Group +- Node Group名([enable_nodegroup_debug](#enable_nodegroup_debug)被设置为on):候选计算Node Group为指定的Node Group + +**默认值**:query + +## enable_nodegroup_debug + +**参数说明**:控制优化器在多Node Group环境下,是否使用强制弹性计算。Node Group目前为内部用机制,用户无需设置。 + +该参数只在[expected_computing_nodegroup](#expected_computing_nodegroup)被设置为具体Node Group时生效。 + +该参数属于USERSET类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:布尔型 + +- on表示强制将计算弹性到expected_computing_nodegroup所指定的Node Group进行计算。 +- off表示不强制使用某个Node Group进行计算。 + +**默认值**:off ## qrw_inlist2join_optmode -**参数说明**: 控制是否使用inlist-to-join查询重写。 +**参数说明**:控制是否使用inlist-to-join查询重写。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串 +**取值范围**:字符串 - disable: 关闭inlist2join查询重写。 - cost_base: 基于代价的inlist2join查询重写。 - rule_base: 基于规则的inlist2join查询重写,即强制使用inlist2join查询重写。 - 任意正整数: inlist2join查询重写阈值,即list内元素个数大于该阈值,进行inlist2join查询重写。 -**默认值**: cost_base +**默认值**:cost_base ## skew_option -**参数说明**: 控制是否使用优化策略。 +**参数说明**:控制是否使用优化策略。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 字符串 +**取值范围**:字符串 - off: 关闭策略。 - normal: 采用激进策略。对于不确定是否出现倾斜的场景,认为存在倾斜,并进行相应优化。 - lazy: 采用保守策略。对于不确定是否出现倾斜场景,认为不存在倾斜,不进行优化。 -**默认值**: normal +**默认值**:normal ## default_limit_rows -**参数说明**: 设置生成genericplan的缺省limit估算行数。此参数设置为正数时意为直接将设置的值作为估算limit的行数,为负数时代表使用百分比的形式设置默认的估算值,负数转换为默认百分比,即-5代表5%。 +**参数说明**:设置生成genericplan的缺省limit估算行数。此参数设置为正数时意为直接将设置的值作为估算limit的行数,为负数时代表使用百分比的形式设置默认的估算值,负数转换为默认百分比,即-5代表5%。 -**取值范围**: 浮点型,-100~DBL_MAX。 +该参数属于USERSET类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**默认值**: -10 +**取值范围**:浮点型,-100~DBL_MAX。 + +**默认值**:-10 ## check_implicit_conversions @@ -315,3 +349,27 @@ date: 2021-04-20 - off表示不进行相关检查。 **默认值**:off + +## cost_weight_index + +**参数说明**:设置index_scan的代价权重。 + +该参数属于USERSET类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:浮点型,1e-10~1e+10。 + +**默认值**:1 + +## try_vector_engine_strategy + +**参数说明**:设置行存表走向量化执行引擎的策略。通过设置该参数,可以使包含行存表的查询可以转换为向量化的执行计划执行计算,从而提升类AP场景的复杂查询的执行性能。 + +该参数属于USERSET类型参数,请参考[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:枚举型 + +- off,为默认取值,表示关闭本功能,即行存表不会转换为向量的执行计划执行。 +- force,表示只要查询中不包含向量化引擎不支持的类型或者表达式,则不论查询的基表为行存表、列存表,还是行列混合存储的,强制将查询转换为向量化的执行计划执行计算。在这种情况下,针对不同的查询场景可能出现性能下降。 +- optimal,表示在force的基础上,由优化器根据查询的复杂度进行选择是否将查询语句转换为向量化的执行计划,尽可能避免转换为向量化的执行计划后出现性能下降。 + +**默认值**:off diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/2-optimizer-cost-constants.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/2-optimizer-cost-constants.md index f13e16c31f87c1ff316b80071c0dd62cdd454637..aecc306fa56eededadb5b660a5672fd65bdb9aa6 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/2-optimizer-cost-constants.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/2-optimizer-cost-constants.md @@ -11,65 +11,66 @@ date: 2021-04-20 ## seq_page_cost -**参数说明**: 设置优化器计算一次顺序磁盘页面抓取的开销。 +**参数说明**:设置优化器计算一次顺序磁盘页面抓取的开销。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 浮点型,0~DBL_MAX。 +**取值范围**:浮点型,0~DBL_MAX。 -**默认值**: 1 +**默认值**:1 ## random_page_cost -**参数说明**: 设置优化器计算一次非顺序抓取磁盘页面的开销。 +**参数说明**:设置优化器计算一次非顺序抓取磁盘页面的开销。 该参数属于USERSET类型参数,请参考表[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) **须知**: +> > 虽然服务器允许将random_page_cost设置的比seq_page_cost小,但是物理上实际不受影响。如果所有数据库都位于随机访问内存中时,两者设置为相等很合理。因为在此种情况下,非顺序抓取页并没有副作用。同样,在缓冲率很高的数据库上,应该相对于CPU参数同时降低这两个值,因为获取内存中的页要比通常情况下开销小很多。 -**取值范围**: 浮点型,0~DBL_MAX。 +**取值范围**:浮点型,0~DBL_MAX。 -**默认值**: 4 +**默认值**:4 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: > > - 对于特别表空间中的表和索引,可以通过设置同名的表空间的参数来覆盖这个值。 > - 相对于seq_page_cost,减少这个值将导致系统更倾向于使用索引扫描,而增加这个值使得索引扫描开销比较高。可以通过同时增加或减少这两个值来调整磁盘I/O相对于CPU的开销。 ## cpu_tuple_cost -**参数说明**: 设置优化器计算在一次查询中处理每一行数据的开销。 +**参数说明**:设置优化器计算在一次查询中处理每一行数据的开销。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 浮点型,0~DBL_MAX。 +**取值范围**:浮点型,0~DBL_MAX。 -**默认值**: 0.01 +**默认值**:0.01 ## cpu_index_tuple_cost -**参数说明**: 设置优化器计算在一次索引扫描中处理每条索引的开销。 +**参数说明**:设置优化器计算在一次索引扫描中处理每条索引的开销。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 浮点型,0~DBL_MAX。 +**取值范围**:浮点型,0~DBL_MAX。 -**默认值**: 0.005 +**默认值**:0.005 ## cpu_operator_cost -**参数说明**: 设置优化器计算一次查询中执行一个操作符或函数的开销。 +**参数说明**:设置优化器计算一次查询中执行一个操作符或函数的开销。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 浮点型,0~DBL_MAX。 +**取值范围**:浮点型,0~DBL_MAX。 -**默认值**: 0.0025 +**默认值**:0.0025 ## effective_cache_size -**参数说明**: 设置优化器在一次单一的查询中可用的磁盘缓冲区的有效大小。 +**参数说明**:设置优化器在一次单一的查询中可用的磁盘缓冲区的有效大小。 设置这个参数,还要考虑MogDB的共享缓冲区以及内核的磁盘缓冲区。另外,还要考虑预计的在不同表之间的并发查询数目,因为它们将共享可用的空间。 @@ -77,18 +78,18 @@ date: 2021-04-20 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~INT_MAX,单位为8KB。 +**取值范围**:整型,1~INT_MAX,单位为8KB。 比默认值高的数值可能会导致使用索引扫描,更低的数值可能会导致选择顺序扫描。 -**默认值**: 128MB +**默认值**:128MB ## allocate_mem_cost -**参数说明**: 设置优化器计算Hash Join创建Hash表开辟内存空间所需的开销,供Hash join估算不准时调优使用。 +**参数说明**:设置优化器计算Hash Join创建Hash表开辟内存空间所需的开销,供Hash join估算不准时调优使用。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 浮点型,0~DBL_MAX。 +**取值范围**:浮点型,0~DBL_MAX。 -**默认值**: 0 +**默认值**:0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/3-genetic-query-optimizer.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/3-genetic-query-optimizer.md index c2c0b0e560a2f07c93ab8f8892bb27e4fe8fe3a8..c604834eefcc3f80db3e230dc87c69bb5041c1d0 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/3-genetic-query-optimizer.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/3-genetic-query-optimizer.md @@ -11,96 +11,102 @@ date: 2021-04-20 ## geqo -**参数说明**: 控制基因查询优化的使用。 +**参数说明**:控制基因查询优化的使用。 该参数属于USERSET类型参数,请参考表[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) **须知**: +> > 通常情况下在执行过程中不要关闭,geqo_threshold变量提供了更精细的控制GEQO的方法。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示使用。 - off表示不使用。 -**默认值**: on +**默认值**:on ## geqo_threshold -**参数说明**: 如果执行语句的数量超过设计的FROM的项数,则会使用基因查询优化来执行查询。 +**参数说明**:如果执行语句的数量超过设计的FROM的项数,则会使用基因查询优化来执行查询。 该参数属于USERSET类型参数,请参考表[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) **须知**: > > - 对于简单的查询,通常用详尽搜索方法,当涉及多个表的查询的时候,用GEQO可以更好的管理查询。 > - 一个FULL OUTER JOIN构造仅作为一个FROM项。 -**取值范围**: 整型,2~INT_MAX。 +**取值范围**:整型,2~INT_MAX。 -**默认值**: 12 +**默认值**:12 ## geqo_effort -**参数说明**: 控制GEQO在规划时间和规划质量之间的平衡。 +**参数说明**:控制GEQO在规划时间和规划质量之间的平衡。 该参数属于USERSET类型参数,请参考表[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) **须知**: +> > geqo_effort实际上并没有直接做任何事情,只是用于计算其他影响GEQO的变量的默认值。如果愿意,可以手工设置其他参数。 -**取值范围**: 整型,1~10。 +**取值范围**:整型,1~10。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> > 比默认值大的数值增加了查询规划的时间,但是也增加了选中有效查询的几率。 -**默认值**: 5 +**默认值**:5 ## geqo_pool_size -**参数说明**: 控制GEQO使用池的大小,也就是基因全体中的个体数量。 +**参数说明**:控制GEQO使用池的大小,也就是基因全体中的个体数量。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~INT_MAX。 +**取值范围**:整型,0~INT_MAX。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> > 至少是2,且有用的值一般在100到1000之间。设置为0,表示使用系统自适应方式,MogDB会基于geqo_effort和表的个数选取合适的值。 -**默认值**: 0 +**默认值**:0 ## geqo_generations -**参数说明**: 控制GEQO使用的算法的迭代次数。 +**参数说明**:控制GEQO使用的算法的迭代次数。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0~INT_MAX。 +**取值范围**:整型,0~INT_MAX。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> > 必须至少是1,且有用的值介于100和1000之间。如果设置为0,则基于geqo_pool_size选取合适的值。 -**默认值**: 0 +**默认值**:0 ## geqo_selection_bias -**参数说明**: 控制GEQO的选择性偏好,即就是一个种群中的选择性压力。 +**参数说明**:控制GEQO的选择性偏好,即就是一个种群中的选择性压力。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 浮点型,1.5~2.0。 +**取值范围**:浮点型,1.5~2.0。 -**默认值**: 2 +**默认值**:2 ## geqo_seed -**参数说明**: 控制GEQO使用的随机数生产器的初始化值,用来从顺序连接在一起的查询空间中查找随机路径。 +**参数说明**:控制GEQO使用的随机数生产器的初始化值,用来从顺序连接在一起的查询空间中查找随机路径。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 浮点型,0.0~1.0。 +**取值范围**:浮点型,0.0~1.0。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知**: +> > 不同的值会改变搜索的连接路径,从而影响了所找路径的优劣。 -**默认值**: 0 +**默认值**:0 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/4-other-optimizer-options.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/4-other-optimizer-options.md index 18ef5818be3b05a3d9e6c0d962d3d4ef94f6ef49..e77048963008fba2ea4298395bd2d1faaaa0a591 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/4-other-optimizer-options.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/4-other-optimizer-options.md @@ -9,15 +9,15 @@ date: 2021-04-20 ## explain_dna_file -**参数说明**: 指定explain_perf_mode为run,导出的csv信息的目标文件。 +**参数说明**:指定explain_perf_mode为run,导出的csv信息的目标文件。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** 这个参数的取值必须是绝对路径加上.csv格式的文件名。 -**取值范围**: 字符串 +**取值范围**:字符串 -**默认值**: 空 +**默认值**:空 ## explain_perf_mode @@ -36,11 +36,11 @@ date: 2021-04-20 ## analysis_options -**参数说明**: 通过开启对应选项中所对应的功能选项使用相应的定位功能,包括数据校验,性能统计等,参见取值范围中的选项说明。 +**参数说明**:通过开启对应选项中所对应的功能选项使用相应的定位功能,包括数据校验,性能统计等,参见取值范围中的选项说明。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。设置时,选择开启或者关闭的选项请使用'on()'或'off()'包括,未被显示指定的功能选项会维持原来的值,参考格式:'on(option1, option2, …)'。 -**取值范围**: 字符串 +**取值范围**:字符串 - LLVM_COMPILE表示在explain performance显示界面中显示每个线程的codegen编译时间。 @@ -50,7 +50,7 @@ date: 2021-04-20 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** pretty模式当前版本不支持。 -**默认值**: ALL,on(),off(LLVM_COMPILE,HASH_CONFLICT,STREAM_DATA_CHECK),不开启任何定位功能。 +**默认值**:ALL,on(),off(LLVM_COMPILE,HASH_CONFLICT,STREAM_DATA_CHECK),不开启任何定位功能。 ## cost_param @@ -121,19 +121,6 @@ set rewrite_rule=none; --关闭所有可选查询重写规则 **默认值**:on -## enable_light_proxy - -**参数说明**:设置优化器是否对简单查询在数据库主节点上优化执行,应用端和内核端字符集不匹配时,该参数不生效,建议建库时将字符集设为UTF8。 - -该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 - -**取值范围**:布尔型。 - -- on表示优化器将优化数据库主节点上简单查询的执行。 -- off表示不使用优化。 - -**默认值**:on - ## enable_global_plancache **参数说明**:设置是否对PBE查询的执行计划进行缓存共享,开启该功能可以节省高并发下数据库节点的内存使用。 @@ -161,16 +148,16 @@ set rewrite_rule=none; --关闭所有可选查询重写规则 ## enable_global_stats -**参数说明**: 标识当前统计信息模式,区别采用全局统计信息收集模式还是单节点统计信息收集模式,默认创建为采用全局统计信息模式。当关闭该参数时,则默认收集MogDB第一个节点的统计信息,此时可能会影响生成查询计划的质量,但信息收集性能较优,建议客户谨慎考虑。 +**参数说明**:标识当前统计信息模式,区别采用全局统计信息收集模式还是单节点统计信息收集模式,默认创建为采用全局统计信息模式。当关闭该参数时,则默认收集MogDB第一个节点的统计信息,此时可能会影响生成查询计划的质量,但信息收集性能较优,建议客户谨慎考虑。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on/true表示全局统计信息。 - off/false表示数据库节点统计信息。 -**默认值**: on +**默认值**:on ## enable_opfusion @@ -267,7 +254,7 @@ set sql_beta_feature=none; - none:不使用任何Beta优化器特性。 - sel_semi_poisson:使用泊松分布对等值的半连接和反连接选择率进行校准。 -- sel_expr_instr:使用字符串匹配的行数估算方法对instr(col, 'const') > 0, = 0, = 1进行更准确的估算。 +- sel_expr_instr: 使用字符串匹配的行数估算方法对instr(col, 'const') > 0、= 0、 = 1进行更准确的估算。 - param_path_gen:生成更多可能的参数化路径。 - rand_cost_opt:对小数据量表的随机读取代价进行优化。 - param_path_opt:利用表的膨胀系数优化索引analyze信息。 @@ -277,48 +264,51 @@ set sql_beta_feature=none; - canonical_pathkey:正则化pathkey生成置后(pathkey是指标记数据有序性键值的集合)。 - index_cost_with_leaf_pages_only:估算索引代价时考虑索引叶子结点。 - partition_opfusion:开启分区表优化。 +- a_style_coerce:开启Decode类型转换规则兼容O,详见**对于case,在ORA兼容模式下的处理和相关构造**。 +- partition_fdw_on:支持基于分区表创建postgres foreign table下的相关SQL。 +- predpush_same_level:开启predpush hint控制同层参数化路径的功能。 **默认值**:none ## ngram_gram_size -**参数说明**: ngram解析器分词的长度。 +**参数说明**:ngram解析器分词的长度。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~4 +**取值范围**:整型,1~4 -**默认值**: 2 +**默认值**:2 ## ngram_grapsymbol_ignore -**参数说明**: ngram解析器是否忽略图形化字符。 +**参数说明**:ngram解析器是否忽略图形化字符。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示忽略图形化字符。 - off表示不忽略图形化字符。 -**默认值**: off +**默认值**:off ## ngram_punctuation_ignore -**参数说明**: ngram解析器是否忽略标点符号。 +**参数说明**:ngram解析器是否忽略标点符号。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示忽略标点符号。 - off表示不忽略标点符号。 -**默认值**: on +**默认值**:on ## default_statistics_target -**参数说明**:为没有用ALTER TABLE SET STATISTICS设置字段目标的表设置缺省统计目标。此参数设置为正数是代表统计信息的样本数量,为负数时,代表使用百分比的形式设置统计目标,负数转换为对应的百分比,即-5代表5%。 +**参数说明**:为没有用ALTER TABLE SET STATISTICS设置字段目标的表设置缺省统计目标。此参数设置为正数时,代表统计信息的样本数量;设置为负数时,代表使用百分比的形式设置统计目标,负数转换为对应的百分比,即-5代表5%。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -327,9 +317,9 @@ set sql_beta_feature=none; > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** > > - 比默认值大的正数数值增加了ANALYZE所需的时间,但是可能会改善优化器的估计质量。 -> - 调整此参数可能存在性能劣化的风险,如果某个查询劣化,可以考虑 +> - 调整此参数可能存在性能劣化的风险,如果某个查询劣化,可以考虑: > 1. 恢复默认的统计信息。 -> 2. 使用plan hint来调整到之前的查询计划。(详细参见**使用Plan Hint进行调优**) +> 2. 使用plan hint来调整到之前的查询计划。(详情参见[使用Plan Hint进行调优](9-hint-based-tuning)) > - 当此guc参数设置为负数时,如果计算的采样样本数大于等于总数据量的2%,且用户表的数据量小于1600000时,ANALYZE所需时间相比guc参数为默认值的时间会有所增加。 > - 当此guc参数设置为负数时,则autoanalyze不生效。 @@ -396,7 +386,7 @@ set sql_beta_feature=none; ## plan_mode_seed -**参数说明**:该参数为调测参数,目前仅支持OPTIMIZE_PLAN和RANDOM_PLAN两种。其中:OPTIMIZE_PLAN表示通过动态规划算法进行代价估算的最优plan,参数值设置为0;RANDOM_PLAN表示随机生成的plan;如果设置为-1,表示用户不指定随机数的种子标识符seed值,由优化器随机生成[1, 2147483647]范围整型值的随机数,并根据随机数生成随机的执行计划;如果用户指定guc参数值为[1, 2147483647]范围的整型值,表示指定的生成随机数的种子标识符seed,优化器需要根据seed值生成随机的执行计划。 +**参数说明**:该参数为调测参数,目前仅支持OPTIMIZE_PLAN和RANDOM_PLAN两种。其中: OPTIMIZE_PLAN表示通过动态规划算法进行代价估算的最优plan,参数值设置为0;RANDOM_PLAN表示随机生成的plan;如果设置guc参数值为-1,表示用户不指定随机数的种子标识符seed值,由优化器随机生成[1, 2147483647]范围整型值的随机数,并根据随机数生成随机的执行计划。 如果设置guc参数值为[1, 2147483647]范围的整型值,表示指定的生成随机数的种子标识符seed,优化器需要根据seed值生成随机的执行计划。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 @@ -421,11 +411,11 @@ set sql_beta_feature=none; ## enable_codegen -**参数说明**: 标识是否允许开启代码生成优化,目前代码生成使用的是LLVM优化。 +**参数说明**:标识是否允许开启代码生成优化,目前代码生成使用的是LLVM优化。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示允许开启代码生成优化。 @@ -433,15 +423,15 @@ set sql_beta_feature=none; > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** 目前LLVM优化仅支持向量化执行引擎特性和SQL on Hadoop特性,在其他场景下建议关闭此参数。 -**默认值**: off +**默认值**:on ## codegen_strategy -**参数说明**: 标识在表达式codegen化过程中所使用的代码生成优化策略。 +**参数说明**:标识在表达式codegen化过程中所使用的代码生成优化策略。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 枚举类型 +**取值范围**:枚举类型 - partial表示当所计算表达式中即使包含部分未被codegen化的函数时,仍可借助表达式全codegen框架调用LLVM动态编译优化策略。 @@ -449,102 +439,108 @@ set sql_beta_feature=none; > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-notice.gif) **须知:** 在开启代码生成优化会导致查询性能下降的场景下可以设置此参数为pure,其他场景下建议不改变此参数的默认值partial。 -**默认值**: partial +**默认值**:partial ## enable_codegen_print -**参数说明**: 标识是否允许在log日志中打印所生成的LLVM IR函数。 +**参数说明**:标识是否允许在log日志中打印所生成的LLVM IR函数。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示允许在log日志中打印IR函数。 - off表示不允许在log日志中打印IR函数。 -**默认值**: off +**默认值**:off ## codegen_cost_threshold -**参数说明**: 由于LLVM编译生成最终的可执行机器码需要一定时间,因此只有当实际执行的代价大于编译生成机器码所需要的代码和优化后的执行代价之和时,利用代码生成才有收益。codegen_cost_threshold标识代价的阈值,当执行估算代价大于该代价时,使用LLVM优化。 +**参数说明**:由于LLVM编译生成最终的可执行机器码需要一定时间,因此只有当实际执行的代价大于编译生成机器码所需要的代码和优化后的执行代价之和时,利用代码生成才有收益。codegen_cost_threshold标识代价的阈值,当执行估算代价大于该代价时,使用LLVM优化。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,0 ~ 2147483647。 +**取值范围**:整型,0 ~ 2147483647。 -**默认值**: 10000 +**默认值**:10000 ## enable_bloom_filter -**参数说明**: 标识是否允许使用BloomFilter优化。该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**参数说明**:标识是否允许使用BloomFilter优化。 + +该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示允许使用BloomFilter优化。 - off表示不允许使用BloomFilter优化。 -**默认值**: on +**默认值**:on ## enable_extrapolation_stats -**参数说明**: 标识对于日期类型是否允许基于历史统计信息使用推理估算的逻辑。使用该逻辑对于未及时收集统计信息的表可以增大估算准确的可能性,但也存在错误推理导致估算过大的可能性,需要对于日期类型数据定期插入的场景开启此开关。该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**参数说明**:标识对于日期类型是否允许基于历史统计信息使用推理估算的逻辑。使用该逻辑对于未及时收集统计信息的表可以增大估算准确的可能性,但也存在错误推理导致估算过大的可能性,需要对于日期类型数据定期插入的场景开启此开关。 -**取值范围**: 布尔型 +该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:布尔型 - on表示允许基于历史统计信息使用推理估算的逻辑。 - off表示不允许基于历史统计信息使用推理估算的逻辑。 -**默认值**: off +**默认值**:off ## autoanalyze -**参数说明**: 标识是否允许在生成计划的时候,对于没有统计信息的表进行统计信息自动收集。对于外表和临时表,不支持autoanalyze,如果需要收集统计信息,用户需手动执行analyze操作。如果在auto analyze某个表的过程中数据库发生异常,当数据库正常运行之后再执行语句有可能仍提示需要收集此表的统计信息。此时需要用户对该表手动执行一次analyze操作,以同步统计信息数据。该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**参数说明**:标识是否允许在生成计划的时候,对于没有统计信息的表进行统计信息自动收集。对于外表和临时表,不支持autoanalyze,如果需要收集统计信息,用户需手动执行analyze操作。如果在auto analyze某个表的过程中数据库发生异常,当数据库正常运行之后再执行语句有可能仍提示需要收集此表的统计信息。此时需要用户对该表手动执行一次analyze操作,以同步统计信息数据。 -**取值范围**: 布尔型 +该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 + +**取值范围**:布尔型 - on表示允许自动进行统计信息收集。 - off表示不允许自动进行统计信息收集。 -**默认值**: off +**默认值**:off ## enable_analyze_check -**参数说明**: 标识是否允许在生成计划的时候,对于在pg_class中显示reltuples和relpages均为0的表,检查该表是否曾进行过统计信息收集。 +**参数说明**:标识是否允许在生成计划的时候,对于在pg_class中显示reltuples和relpages均为0的表,检查该表是否曾进行过统计信息收集。 该参数属于SUSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示允许检查。 - off表示不允许检查。 -**默认值**: off +**默认值**:off ## enable_sonic_hashagg -**参数说明**: 标识是否依据规则约束使用基于面向列的hash表设计的Hash Agg算子。 +**参数说明**:标识是否依据规则约束使用基于面向列的hash表设计的Hash Agg算子。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示在满足约束条件时使用基于面向列的hash表设计的Hash Agg算子。 - off表示不使用面向列的hash表设计的Hash Agg算子。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** > -> - 在开启enable_sonic_hashagg,且查询达到约束条件使用基于面向列的hash表设计的Hash Agg算子时,查询对应的Hash Agg算子内存使用通常可获得精简。但对于代码生成技术可获得显著性能提升的场景enable_codegen打开后获得较大性能提升),对应的算子查询性能可能会出现劣化。 -> - 开启enable_sonic_hashagg,且查询达到约束条件使用基于面向列的hash表设计的Hash Agg算子时,在Explain Analyze/Performance的执行计划和执行信息中,算子显示为“Sonic Hash Aggregation”,而未达到该约束条件时,算子名称将显示为“Hash Aggregation”,Explain详解请参见详解。 +> - 在开启enable_sonic_hashagg,且查询达到约束条件使用基于面向列的hash表设计的Hash Agg算子时,查询对应的Hash Agg算子内存使用通常可获得精简。但对于代码生成技术可获得显著性能提升的场景enable_codegen打开后获得较大性能提升,对应的算子查询性能可能会出现劣化。 +> - 开启enable_sonic_hashagg,且查询达到约束条件使用基于面向列的hash表设计的Hash Agg算子时,在Explain Analyze/Performance的执行计划和执行信息中,算子显示为“Sonic Hash Aggregation”,而未达到该约束条件时,算子名称将显示为“Hash Aggregation”,Explain详解请参见[详解](2-introduction-to-the-sql-execution-plan#详解)。 -**默认值**: on +**默认值**:on ## enable_sonic_hashjoin -**参数说明**: 标识是否依据规则约束使用基于面向列的hash表设计的Hash Join算子。 +**参数说明**:标识是否依据规则约束使用基于面向列的hash表设计的Hash Join算子。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示在满足约束条件时使用基于面向列的hash表设计的Hash Join算子。 - off表示不使用面向列的hash表设计的Hash Join算子。 @@ -553,22 +549,22 @@ set sql_beta_feature=none; > > - 当前开关仅适用于Inner Join的场景。 > - 在开启enable_sonic_hashjoin,查询对应的Hash Inner算子内存使用通常可获得精简。但对于代码生成技术可获得显著性能提升的场景,对应的算子查询性能可能会出现劣化。 -> - 开启enable_sonic_hashjoin,且查询达到约束条件使用基于面向列的hash表设计的Hash Join算子时,在Explain Analyze/Performance的执行计划和执行信息中,算子显示为“Sonic Hash Join”,而未达到该约束条件时,算子名称将显示为“Hash Join”,Explain详解请参见详解。 +> - 开启enable_sonic_hashjoin,且查询达到约束条件使用基于面向列的hash表设计的Hash Join算子时,在Explain Analyze/Performance的执行计划和执行信息中,算子显示为“Sonic Hash Join”,而未达到该约束条件时,算子名称将显示为“Hash Join”,Explain详解请参见[详解](2-introduction-to-the-sql-execution-plan#详解)。 -**默认值**: on +**默认值**:on ## enable_sonic_optspill -**参数说明**: 标识是否对面向列的hash表设计的Hash Join算子进行下盘文件数优化。该参数打开时,在Hash Join算子下盘文件较多的时候,下盘文件数不会显著增加。 +**参数说明**:标识是否对面向列的hash表设计的Hash Join算子进行下盘文件数优化。该参数打开时,在Hash Join算子下盘文件较多的时候,下盘文件数不会显著增加。 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 布尔型 +**取值范围**:布尔型 - on表示优化面向列的hash表设计的Hash Join算子的下盘文件数。 - off表示不优化面向列的hash表设计的Hash Join算子的下盘文件数。 -**默认值**: on +**默认值**:on ## log_parser_stats @@ -674,7 +670,10 @@ set sql_beta_feature=none; 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**:布尔型,true表示开启,false表示关闭。 +**取值范围**:布尔型 + +- true表示开启。 +- false表示关闭。 **默认值**:false @@ -684,19 +683,24 @@ set sql_beta_feature=none; 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**:枚举型,LOG或NOTICE,LOG表示在日志中打印执行计划,NOTICE表示以提示知的形式打印出计划。 +**取值范围**:枚举型,LOG或NOTICE。 + +- LOG表示在日志中打印执行计划。 +- NOTICE表示以提示的形式打印出计划。 **默认值**:LOG ## query_dop -**参数说明**: 用户自定义的查询并行度。该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 +**参数说明**:用户自定义的查询并行度。 + +该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**: 整型,1~64。打开固定SMP功能,系统会使用固定并行度。 +**取值范围**:整型,1~64。打开固定SMP功能,系统会使用固定并行度。 > ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** 在开启并行查询后,请保证系统CPU、内存、网络等资源充足,以达到最佳效果。 -**默认值**: 1 +**默认值**:1 ## enable_startwith_debug @@ -704,6 +708,9 @@ set sql_beta_feature=none; 该参数属于USERSET类型参数,请参考表[GUC参数分类](30-appendix)中对应设置方法进行设置。 -**取值范围**:布尔型,true表示开启,false表示关闭。 +**取值范围**:布尔型。 + +- true表示开启。 +- false表示关闭。 **默认值**:false diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/introduction-to-query-planning.md b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/introduction-to-query-planning.md index c74144da39cdba57b573c6abb93a08c576da9c00..f4e972a23bb8605ba2bab8dc7947a37c0b365926 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/introduction-to-query-planning.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/guc-parameters/9-query-planning/introduction-to-query-planning.md @@ -9,8 +9,9 @@ date: 2021-04-20 介绍查询优化器方法配置、开销常量、规划算法以及一些配置参数。 -> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明:** -> 优化器中涉及的两个参数: +> ![img](https://cdn-mogdb.enmotech.com/docs-media/icon/icon-note.gif) **说明**: +> +> 优化器中涉及的两个参数: > > - INT_MAX数据类型INT的最大值,其值为2147483647。 > - DBL_MAX数据类型FLOAT的最大值。 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/ALTER-GLOBAL-CONFIGURATION.md b/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/ALTER-GLOBAL-CONFIGURATION.md index 200aa0209965341451fcad18202eded56bad2113..8fa58af55fe9fbf7b8f2ab0ee998a4fe645374ff 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/ALTER-GLOBAL-CONFIGURATION.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/ALTER-GLOBAL-CONFIGURATION.md @@ -19,12 +19,18 @@ date: 2022-05-16 ## 语法格式 ``` -ALTER GLOBAL CONFIGURATION with(参数名称=参数值,参数名称=参数值...); +ALTER GLOBAL CONFIGURATION with( { paraname = value } [, ...] ); ``` ## 参数说明 -参数名称和参数值都是text类型。 +- paraname + + 参数名称,text类型。 + +- value + + 参数值,text类型。 ## 示例 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/CREATE-INCREMENTAL-MATERIALIZED-VIEW.md b/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/CREATE-INCREMENTAL-MATERIALIZED-VIEW.md index 77b62c30f33e2c90bf9e1c9b85242ad2c2581875..640d605d4a278ddc61157348da1044d57d8b5145 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/CREATE-INCREMENTAL-MATERIALIZED-VIEW.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/CREATE-INCREMENTAL-MATERIALIZED-VIEW.md @@ -51,7 +51,7 @@ CreateIncrementalMaterializedView ::= CREATE INCREMENTAL MATERIALIZED VIEW mv_na - **AS query** - 一个SELECT、TABLE 或者VALUES命令。这个查询将在一个安全受限的操作中运行。 + 一个SELECT或者TABLE命令。这个查询将在一个安全受限的操作中运行。 ## 示例 diff --git a/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/DROP-MATERIALIZED-VIEW.md b/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/DROP-MATERIALIZED-VIEW.md index f6e3eead7d763a172bdd84e65c90b8cc9d14bb82..f7670cd15b010cff1b07e810ca2bf857c01fe903 100644 --- a/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/DROP-MATERIALIZED-VIEW.md +++ b/product/zh/docs-mogdb/v3.0/reference-guide/sql-syntax/DROP-MATERIALIZED-VIEW.md @@ -13,7 +13,7 @@ date: 2021-05-18 ## 注意事项 -只有物化视图的所有者有权限执行DROP MATERIALIZED VIEW命令,系统管理员默认拥有此权限。 +物化视图的所有者、物化视图所在模式、被授予了物化视图DROP权限的用户或拥有DROP ANY TABLE权限的用户才有权限执行DROP MATERIALIZED VIEW命令,系统管理员默认拥有此权限。 ## 语法格式 diff --git a/product/zh/docs-mogdb/v3.0/toc.md b/product/zh/docs-mogdb/v3.0/toc.md index cf82a7c7151d754df7bafc3181aa96cddd4777fa..7208e3e836eddd42891d03aa4fb47388118683f8 100644 --- a/product/zh/docs-mogdb/v3.0/toc.md +++ b/product/zh/docs-mogdb/v3.0/toc.md @@ -1077,7 +1077,6 @@ + [基于开销的清理延迟](/reference-guide/guc-parameters/4-resource-consumption/4-cost-based-vacuum-delay.md) + [后端写进程](/reference-guide/guc-parameters/4-resource-consumption/5-background-writer.md) + [异步IO](/reference-guide/guc-parameters/4-resource-consumption/6-asynchronous-io-operations.md) - + [并行导入](/reference-guide/guc-parameters/5-parallel-import.md) + 预写式日志 + [设置](/reference-guide/guc-parameters/6-write-ahead-log/1-settings.md) + [检查点](/reference-guide/guc-parameters/6-write-ahead-log/2-checkpoints.md) 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 69ea5e71611c296dc95c54c1562e10ff638efbfa..a163efe3fe0c9befcc29024175f46d999cdeceb0 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 @@ -19,7 +19,6 @@ + [基于开销的清理延迟](./reference-guide/guc-parameters/4-resource-consumption/4-cost-based-vacuum-delay.md) + [后端写进程](./reference-guide/guc-parameters/4-resource-consumption/5-background-writer.md) + [异步IO](./reference-guide/guc-parameters/4-resource-consumption/6-asynchronous-io-operations.md) - + [并行导入](./reference-guide/guc-parameters/5-parallel-import.md) + 预写式日志 + [设置](./reference-guide/guc-parameters/6-write-ahead-log/1-settings.md) + [检查点](./reference-guide/guc-parameters/6-write-ahead-log/2-checkpoints.md)