设置参数

背景信息

GaussDB提供了多种修改GUC参数的方法，用户可以方便的针对数据库、用户、会话进行设置。

• 参数名称不区分大小写。
• 参数取值有整型、浮点型、字符串、布尔型和枚举型五类。
  • 布尔值可以是（on，off）、（true，false）、（yes，no）或者（1，0），且不区分大小写。
  • 枚举类型的取值是在系统表pg_settings的enumvals字段取值定义的。
• 对于有单位的参数，在设置时请指定单位，否则将使用默认的单位。
  • 参数的默认单位在系统表pg_settings的unit字段定义的。
  • 内存单位有：KB（千字节）、MB（兆字节）和GB（吉字节）。
  • 时间单位：ms（毫秒）、s（秒）、min（分钟）、h（小时）和d（天）。

具体参数说明请参见GUC参数说明。

GUC参数设置

GaussDB提供了六类GUC参数，具体分类和设置方式请参见表1：

GaussDB提供了三种方式来修改GUC参数，具体操作请参见表2：

表2 GUC参数设置方式

序号	设置方法
方式一	使用如下命令修改参数。 gs_guc set -D datadir -c "paraname=value" 说明： 如果参数是一个字符串变量，则使用-c parameter="'value'"或者使用-c "parameter = 'value'"。 当参数是一个字符串变量，gs_guc工具不会进行合法性校验，如果配置参数不合法导致数据库运行异常，可以查看gs_log日志进行问题排查。 使用以下命令在数据库节点上同时设置某个参数。 gs_guc set -Z datanode -N all -I all -c "paraname=value" 使用以下命令在数据库节点上设置cm_agent某个参数。 gs_guc set -Z cmagent -c "paraname=value" gs_guc set -Z cmagent -N all -I all -c "paraname=value" 使用以下命令在数据库节点上设置cm_server某个参数。 gs_guc set -Z cmserver -c "paraname=value" gs_guc set -Z cmserver -N all -I all -c "paraname=value" 重启数据库使参数生效。 说明： 重启数据库操作会导致用户执行操作中断，请在操作之前规划好合适的执行窗口。 gs_om -t stop && gs_om -t start
方式二	gs_guc reload -D datadir -c "paraname=value" 说明： 使用以下命令在数据库节点上同时设置某个参数。 gs_guc reload -Z datanode -N all -I all -c "paraname=value"
方式三	修改指定数据库、用户、会话级别的参数。 设置数据库级别的参数 1 gaussdb=# ALTER DATABASE dbname SET paraname TO value; 在下次会话中生效。 设置用户级别的参数 1 gaussdb=# ALTER USER username SET paraname TO value; 在下次会话中生效。 设置会话级别的参数 1 gaussdb=# SET paraname TO value; 修改本次会话中的取值。退出会话后，设置将失效。 说明： SET设置的会话级参数优先级最高，其次是ALTER设置的，其中ALTER DATABASE设置的参数值优先级高于ALTER USER设置，这三种设置方式设置的优先级都高于gs_guc设置方式。 ALTER DATABASE和ALTER USER设置的参数在当前会话都不会生效，需要重启会话才能生效。

• 使用方式一和方式二设置参数时，若所设参数不属于当前节点，数据库会提示参数不在支持范围内的相关信息。
• 使用方式三设置参数时，若参数值为int整型，则会将整数前导零过滤掉，例如SET paraname TO 008192与SET paraname TO 8192效果相同。

操作步骤

使用方式一设置数据库参数，以在数据库主节点设置hot_standby参数为例。

1. 以操作系统用户omm登录数据库主节点。
2. 查看hot_standby参数。

   1	cat /gaussdb/data/dbnode/gaussdb.conf | grep "hot_standby ="

   hot_standby = on

   on表示允许恢复阶段查询操作。

3. 设置hot_standby参数为off，禁止恢复阶段查询操作。

   gs_guc set -Z datanode -D /gaussdb/data/dbnode -c "hot_standby=off"

   

   可以使用以下命令在数据库节点上设置hot_standby参数为off。

   gs_guc set -Z datanode -N all -I all -c "hot_standby=off"

4. 重启数据库使参数生效。

   gs_om -t stop && gs_om -t start

5. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
6. 检查参数设置的正确性。

   1 2 3 4 5

   gaussdb=# SHOW hot_standby; hot_standby ------------- off (1 row)

使用方式二设置参数，以在数据库主节点设置authentication_timeout参数为例。

1. 以操作系统用户omm登录数据库主节点。
2. 查看authentication_timeout参数。

   1	cat /gaussdb/data/dbnode/gaussdb.conf | grep authentication_timeout

   authentication_timeout = 1min

3. 设置authentication_timeout参数为59s。

   gs_guc reload -Z datanode -N all -I all -c "authentication_timeout = 59s"
   
   Total instances: 2. Failed instances: 0.
   Success to perform gs_guc!

   

   可以使用以下命令在数据库节点上设置authentication_timeout参数为59s。

   gs_guc reload -Z datanode -N all -I all -c "authentication_timeout = 59s"

4. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
5. 检查参数设置的正确性。

   1 2 3 4 5

   gaussdb=# SHOW authentication_timeout; authentication_timeout ------------------------ 59s (1 row)

使用方式三设置参数，以设置explain_perf_mode参数为例。

1. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
2. 查看explain_perf_mode参数。

   1 2 3 4 5

   gaussdb=# SHOW explain_perf_mode; explain_perf_mode ------------------- normal (1 row)

3. 设置explain_perf_mode参数。

   使用以下任意方式进行设置：

   • 设置数据库级别的参数。

     1	gaussdb=# ALTER DATABASE postgres SET explain_perf_mode TO pretty;

     当结果显示为如下信息，则表示设置成功。

     ALTER DATABASE

     在下次会话中生效。

   • 设置用户级别的参数

     1	gaussdb=# ALTER USER omm SET explain_perf_mode TO pretty;

     当结果显示为如下信息，则表示设置成功。

     ALTER ROLE

     在下次会话中生效。

   • 设置会话级别的参数。

     1	gaussdb=# SET explain_perf_mode TO pretty;

     当结果显示为如下信息，则表示设置成功。

     SET

4. 检查参数设置的正确性。

   1 2 3 4 5

   gaussdb=# SHOW explain_perf_mode; explain_perf_mode -------------- pretty (1 row)

示例

• 示例1：使用方式一修改GaussDB数据库主节点的最大连接数。
  1. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
  2. 查看最大连接数。

     1 2 3 4 5

     gaussdb=# SHOW max_connections; max_connections ----------------- 200 (1 row)

  3. 使用如下命令退出数据库。

     1	gaussdb=# \q

  4. 修改GaussDB数据库主节点的最大连接数。

     gs_guc set -Z datanode -N all -I all -c "max_connections = 800"

  5. 重启数据库。

     gs_om -t stop && gs_om -t start

  6. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
  7. 查看最大连接数。

     1 2 3 4 5

     gaussdb=# SHOW max_connections; max_connections ----------------- 800 (1 row)

• 示例2：使用方式二设置数据库主节点的客户端认证最长时间参数“authentication_timeout”
  1. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节
  2. 查看客户端认证的最长时间。

     1 2 3 4 5

     gaussdb=# SHOW authentication_timeout; authentication_timeout ------------------------ 1min (1 row)

  3. 使用如下命令退出数据库。

     1	gaussdb=# \q

  4. 修改数据库主节点的客户端认证最长时间。

     gs_guc reload -Z datanode -N all -I all -c "authentication_timeout = 59s"

  5. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
  6. 查看客户端认证的最长时间。

     1 2 3 4 5

     gaussdb=# SHOW authentication_timeout; authentication_timeout ------------------------ 59s (1 row)

• 示例3：修改GaussDB数据库节点的最大连接数。
  1. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
  2. 查看最大连接数。

     1 2 3 4 5

     gaussdb=# SHOW max_connections; max_connections ----------------- 200 (1 row)

  3. 使用如下命令退出数据库。

     1	gaussdb=# \q

  4. 修改GaussDB数据库节点的最大连接数。

     gs_guc set -Z datanode -N all -I all -c "max_connections = 500"

  5. 重启数据库。

     gs_om -t stop
     gs_om -t start

  6. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
  7. 查看最大连接数。

     1 2 3 4 5

     gaussdb=# SHOW max_connections; max_connections ----------------- 500 (1 row)

• 示例4：设置数据库节点的客户端认证最长时间参数“authentication_timeout”
  1. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
  2. 查看客户端认证的最长时间。

     1 2 3 4 5

     gaussdb=# SHOW authentication_timeout; authentication_timeout ------------------------ 1min (1 row)

  3. 使用如下命令退出数据库。

     1	gaussdb=# \q

  4. 修改GaussDB数据库节点的客户端认证最长时间。

     gs_guc reload -Z datanode -N all -I all -c "authentication_timeout = 30s"

  5. 连接数据库，具体操作请参见《开发者指南》中“数据库使用入门 > 连接数据库 > 使用gsql连接”章节。
  6. 查看客户端认证的最长时间。

     1 2 3 4 5

     gaussdb=# SHOW authentication_timeout; authentication_timeout ------------------------ 30s (1 row)