SET

功能描述

用于修改运行时配置参数。

注意事项

大多数运行时参数都可以用SET在运行时设置,但有些则在服务运行过程中或会话开始之后不能修改。

语法格式

  • 设置所处的时区。

    1. SET [ SESSION | LOCAL ] TIME ZONE { timezone | LOCAL | DEFAULT };
  • 设置所属的模式。

    1. SET [ SESSION | LOCAL ]
    2. {CURRENT_SCHEMA { TO | = } { schema | DEFAULT }
    3. | SCHEMA 'schema'};
  • 设置客户端编码集。

    1. SET [ SESSION | LOCAL ] NAMES encoding_name;
  • 设置XML的解析方式。

    1. SET [ SESSION | LOCAL ] XML OPTION { DOCUMENT | CONTENT };
  • 设置其他运行时参数。

    1. SET [ LOCAL | SESSION ]
    2. { {config_parameter { { TO | = } { value | DEFAULT }
    3. | FROM CURRENT }}};
  • 设置运行时的参数。

    1. SET { GLOBAL | @@GLOBAL.}
    2. { {config_parameter = { expr | DEFAULT }}};
    3. SET [ SESSION | @@SESSION. | @@]
    4. { {config_parameter = { expr | DEFAULT }}};
  • 在兼容B模式(sql_compatibility = ‘B’)下设置参数。

    1. SET [ SESSION | @@SESSION. | @@]
    2. { {config_parameter = { expr | DEFAULT }}};
    3. SET { GLOBAL | @@GLOBAL.}
    4. { {config_parameter = { expr | DEFAULT }}}
  • 设置自定义变量

    1. SET @var_name := expr [, @var_name := expr] ...
    2. SET @var_name = expr [, @var_name = expr] ...

参数说明

  • SESSION

    声明的参数只对当前会话起作用。如果SESSION和LOCAL都没出现,则SESSION为缺省值。

    如果在事务中执行了此命令,命令的产生影响将在事务回滚之后消失。如果该事务已提交,影响将持续到会话的结束,除非被另外一个SET命令重置参数。

  • LOCAL

    声明的参数只在当前事务中有效。在COMMIT或ROLLBACK之后,会话级别的设置将再次生效。

    不论事务是否提交,此命令的影响只持续到当前事务结束。一个特例是:在一个事务里面,即有SET命令,又有SET LOCAL命令,且SET LOCAL在SET后面,则在事务结束之前,SET LOCAL命令会起作用,但事务提交之后,则是SET命令会生效。

  • TIME ZONE timezone

    用于指定当前会话的本地时区。

    取值范围:有效的本地时区。该选项对应的运行时参数名称为TimeZone,DEFAULT缺省值为PRC。

  • CURRENT_SCHEMA

    schema

    CURRENT_SCHEMA用于指定当前的模式。

    取值范围:已存在模式名称。如果模式名不存在,会导致CURRENT_SCHEMA值为空。

  • SCHEMA schema

    同CURRENT_SCHEMA。此处的schema是个字符串。

    例如:set schema ‘public’。

  • NAMES encoding_name

    用于设置客户端的字符编码。等价于set client_encoding to encoding_name。

    取值范围:有效的字符编码。该选项对应的运行时参数名称为client_encoding,默认编码为UTF8。

  • XML OPTION option

    用于设置XML的解析方式。

    取值范围:CONTENT(缺省)、DOCUMENT。

  • config_parameter

    可设置的运行时参数的名称。可用的运行时参数可以使用SHOW ALL命令查看。

    SET - 图1 说明: 部分通过SHOW ALL查看的参数不能通过SET设置。如max_datanodes。

  • value

    config_parameter的新值。可以声明为字符串常量、标识符、数字,或者逗号分隔的列表。DEFAULT用于把这些参数设置为它们的缺省值。

  • GLOBAL | @@GLOBAL.

    声明的参数生效范围为postmaster、sighup、backend,可通过pg_settings系统视图的context字段确定。设置参数范围和生效方式与ALTER SYSTEM SET 语法相同。支持config_parameter赋值为表达式。

  • SESSION | @@SESSION. | @@

    声明的参数生效方式为superuser、user,可通过pg_settings系统视图的context字段确定,如果没有出现GLOBAL /SESSION,则SESSION为缺省值。支持config_parameter赋值为表达式。

    SET - 图2 说明:

    • SET SESSION/GLOBAL 语法只有在B模式下(sql_compatibility = B)支持,并且GUC参数enable_set_variable_b_format打开的场景下才支持(enable_set_variable_b_format = on)。
    • 使用@@config_parameter进行操作符运算时,尽量使用空格隔开。比如set @config_parameter1=@config_parameter1*2; 命令中,会将=@当做操作符,可将其修改为set @config_parameter1= @config_parameter1 * 2 。
    • 使用 @var_name := expr的方式在SQL语句中实现为用户变量赋值并返回赋值后的结果;
    • 在sql语句中使用用户自定义变量时,由于计划和对用户变量处理上的不同,无法保证在每种情况下都可以输出和MySQL数据库保持一致,具体的解决方可以使变量的赋值和返回结果出现在相同的阶段。对于MySQL数据库本身,也会存在取值和赋值运算位置不同导致的结果不符合SQL本身语义的场景。具体用例请参考下文示例。
    • 目前阶段若使用expr中包含有和被赋值的用户自定义变量相同的变量,那么当在查询语句中使用了此语法且用到了表的时候,那么不允许更改此用户自定义变量的类型。
  • var_name

    自定义变量名。变量名只能由数字、字母、下划线(_),点(.)、$组成,如果使用单引号、双引号等引用是,则可以使用其他字符,如’var_name’,“var_name”,`var_name`。

    SET - 图3 说明:

    • SET自定义用户变量的只有在B模式下(sql_compatibility = B)支持,并且GUC参数enable_set_variable_b_format打开的场景下才支持(enable_set_variable_b_format = on)或者GUC参数b_format_behavior_compat_options设置值包含enable_set_variables的场景下也支持(即b_format_behavior_compat_options = ‘enable_set_variables’)。
    • 自定义变量只会存储整型,浮点型,字符串,位串和NULL。对于BOOLEAN,INT1,INT2,INT4,INT8类型会转为INT8类型;FLOAT4,FLOAT8,NUMBERIC会转化为FLOAT8进行存储(需要注意浮点型可能会有精度丢失);BIT类型以BIT存储,VARBIT类型以VARBIT存储;NULL值以NULL存储;其他类型若可转化为字符串,则转为TEXT存储。
    • 使用@var_name进行操作符运算时,尽量使用空格隔开。比如set @v1=@v2+1;命令中,会将=@当做操作符,可将其修改为set @v1= @v2+1。
    • 当sql_compatibility = B && enable_set_variable_b_format = on时,对于openGauss原始的@ expr,请参考数字操作符,@需要与expr有空格,否则会将其解析成用户变量。
    • 未初始化的变量值未NULL。
    • Prepare语句中用户自定义变量存储的字符串只支持select/insert/update/delete/merge语法。
    • 对于连续赋值的场景,只支持@var_name1 := @var_name2 := … := expr和@var_name1 = @var_name2 := … := expr,等号(=)只有放在首位才表示赋值,其他位置表示比较操作符。
  • expr

    表达式,支持可直接或间接转为整型,浮点型,字符串,位串和NULL的表达式。

    SET - 图4 注意:

    字符串表达式中避免包含口令等敏感信息的函数,如加解密类函数gs_encrypt,gs_decrypt等,防止敏感信息泄露。

示例

  1. --设置模式搜索路径。
  2. openGauss=# SET search_path TO tpcds, public;
  3. --把日期时间风格设置为传统的 POSTGRES 风格(日在月前)。
  4. openGauss=# SET datestyle TO postgres,dmy;
  5. --SET自定义用户变量的功能
  6. openGauss=# create database user_var dbcompatibility 'b';
  7. openGauss=# \c user_var
  8. user_var=# SET b_format_behavior_compat_options = enable_set_variables;
  9. user_var=# SET @v1 := 1, @v2 := 1.1, @v3 := true, @v4 := 'dasda', @v5 := x'41';
  10. --查询自定义用户变量
  11. user_var=# select @v1, @v2, @v3, @v4, @v5, @v6, @v7;
  12. --PREPARE语法使用自定义用户变量
  13. user_var=# SET @sql = 'select 1';
  14. user_var=# PREPARE stmt as @sql;
  15. user_var=# EXECUTE stmt;
  16. --设置B兼容性参数
  17. openGauss=# create database test_set dbcompatibility 'B';
  18. openGauss=# \c test_set
  19. test_set=# set b_format_behavior_compat_options = 'enable_set_variables';
  20. --session变量设置
  21. test_set=# set @@codegen_cost_threshold = 10000;
  22. test_set=# set @@session.codegen_cost_threshold = @@codegen_cost_threshold * 2;
  23. --global变量设置
  24. test_set=#set global most_available_sync = t;
  25. test_set=#set @@global.most_available_sync = t;
  26. -- 自定义用户变量赋值的功能
  27. openGauss=# create database user_var dbcompatibility 'b';
  28. openGauss=# \c user_var
  29. user_var=# show sql_compatibility;
  30. sql_compatibility
  31. -------------------
  32. B
  33. (1 row)
  34. user_var=# show enable_set_variable_b_format;
  35. enable_set_variable_b_format
  36. ------------------------------
  37. on
  38. (1 row)
  39. -- 常用用法,使用其作为行号
  40. user_var=# set @rownum := 0;
  41. SET
  42. user_var=# SELECT actor_id, @rownum := @rownum + 1 AS rownums FROM actor order by actor_id LIMIT 3;
  43. actor_id | rownums
  44. ----------+---------
  45. 1 | 1
  46. 2 | 2
  47. 3 | 3
  48. (3 rows)
  49. -- 取值赋值阶段不同导致预期不服
  50. user_var=# set @rowno = 0;
  51. SET
  52. user_var=# SELECT salary, (@rowno := @rowno + 1) AS rowno
  53. FROM employee WHERE @rowno = 0;
  54. salary | rowno
  55. --------+-------
  56. 100 | 1
  57. 200 | 2
  58. 300 | 3
  59. (3 rows)
  60. --正确用法,让变量的赋值取值在一个阶段发生
  61. user_var=# SELECT salary, @rowno AS rowno
  62. FROM employee WHERE (@rowno := @rowno + 1) = 2;
  63. salary | rowno
  64. --------+-------
  65. 200 | 2
  66. (1 row)

相关链接

RESETSHOW