华为云用户手册

示例 在当前数据库安装扩展。例如安装security_plugin： --安装扩展之前需要设置enable_extension为true才能够创建。 gaussdb=# SET enable_extension = true; --安装扩展。 gaussdb=# CREATE EXTENSION IF NOT EXISTS security_plugin; --删除扩展。 gaussdb=# DROP EXTENSION security_plugin;

reject_gtm_address 参数说明：设置拒绝连接的GTM IP地址。 参数类型：字符串 参数单位：无 取值范围：以逗号分隔，分隔后的每个子串格式为IP[:port]。 上述的[:port]表示可选。 默认值："" 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：仅由CM组件在特定流程中自动设置，不建议手动进行修改。 设置不当的风险与影响：不当设置可能导致集群与GTM之间无法进行通信，进而影响集群事务。

内置函数 HLL（HyperLogLog）有一系列内置函数用于内部对数据进行处理，一般情况下用户不需要熟知这些函数的使用，具体如表1所示。 表1 内置函数 函数名称 功能描述 hll_in 以string格式接收hll数据。 hll_out 以string格式发送hll数据。 hll_recv 以bytea格式接收hll数据。 hll_send 以bytea格式发送hll数据。 hll_trans_in 以string格式接收hll_trans_type数据。 hll_trans_out 以string格式发送hll_trans_type数据。 hll_trans_recv 以bytea形式接收hll_trans_type数据。 hll_trans_send 以bytea形式发送hll_trans_type数据。 hll_typmod_in 接收typmod类型数据。 hll_typmod_out 发送typmod类型数据。 hll_hashval_in 接收hll_hashval类型数据。 hll_hashval_out 发送hll_hashval类型数据。 hll_add_trans0 类似于hll_add所提供的功能，初始化时无指定入参，通常在聚合运算的第一阶段DN上使用。 hll_add_trans1 类似于hll_add所提供的功能，初始化时指定一个入参，通常在聚合运算的第一阶段DN上使用。 hll_add_trans2 类似于hll_add所提供的功能，初始化时指定两个入参，通常在聚合运算的第一阶段DN上使用。 hll_add_trans3 类似于hll_add所提供的功能，初始化时指定三个入参，通常在聚合运算的第一阶段DN上使用。 hll_add_trans4 类似于hll_add所提供的功能，初始化时指定四个入参，通常在聚合运算的第一阶段DN上使用。 hll_union_trans 类似hll_union所提供的功能，在聚合运算的第一阶段DN上使用。 hll_union_collect 类似于hll_union所提供的功能，在聚合运算第二阶段DN上使用，汇总各个DN上的结果。 hll_pack 在聚合运算第三阶段DN上使用，把自定义hll_trans_type类型最后转换成hll类型。 hll 用于hll类型转换成hll类型，根据输入参数会设定指定参数。 hll_hashval 用于bigint类型转换成hll_hashval类型。 hll_hashval_int4 用于int4类型转换成hll_hashval类型。

废弃函数 由于版本升级，HLL（HyperLogLog）有一些旧的函数废弃，用户可以用类似的函数进行替代。 hll_schema_version(hll) 描述：查看当前hll中的schema version。旧版本schema version是常值1，用来进行hll字段的头部校验，重构后的hll在头部增加字段“HLL”进行校验，schema version不再使用。 hll_regwidth(hll) 描述：查看hll数据结构中桶的位数大小。旧版本桶的位数regwidth取值1~5，会存在较大的误差，也限制了基数估计上限。 重构后regwidth为固定值6，不再使用regwidth变量。 hll_expthresh(hll) 描述：得到当前hll中expthresh大小。采用hll_log2explicit(hll)替代类似功能。 hll_sparseon(hll) 描述：是否启用Sparse模式。采用hll_log2sparse(hll)替代类似功能，0表示关闭Sparse模式。

聚合函数 hll_add_agg(hll_hashval) 描述：把哈希后的数据按照分组放到hll中。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 --准备数据 gaussdb=# CREATE TABLE t_id(id int); gaussdb=# INSERT INTO t_id VALUES(generate_series(1,500)); gaussdb=# CREATE TABLE t_data(a int, c text); gaussdb=# INSERT INTO t_data SELECT mod(id,2), id FROM t_id; --创建表并指定列为hll gaussdb=# CREATE TABLE t_a_c_hll(a int, c hll); --根据a列group by对数据分组，把各组数据加到hll中 gaussdb=# INSERT INTO t_a_c_hll SELECT a, hll_add_agg(hll_hash_text(c)) FROM t_data GROUP BY a; --得到每组数据中hll的Distinct值 gaussdb=# SELECT a, #c AS cardinality FROM t_a_c_hll ORDER BY a; a | cardinality ---+------------------ 0 | 247.862354346299 1 | 250.908710610377 (2 rows) hll_add_agg(hll_hashval, int32 log2m) 描述：把哈希后的数据按照分组放到hll中， 并指定参数log2m，取值范围是10到16。若输入-1或者NULL，则采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_cardinality(hll_add_agg(hll_hash_text(c), 12)) FROM t_data; hll_cardinality ------------------ 497.965240179228 (1 row) hll_add_agg(hll_hashval, int32 log2m, int32 log2explicit) 描述：把哈希后的数据按照分组放到hll中，依次指定参数log2m、log2explicit。 log2explicit取值范围是0到12，0表示直接跳过Explicit模式。该参数可以用来设置Explicit模式的阈值大小，在数据段长度达到2log2explicit后切换为Sparse模式或者Full模式。若输入-1或者NULL，则log2explicit采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_cardinality(hll_add_agg(hll_hash_text(c), NULL, 1)) FROM t_data; hll_cardinality ------------------ 498.496062953313 (1 row) hll_add_agg(hll_hashval, int32 log2m, int32 log2explicit, int64 log2sparse) 描述：把哈希后的数据按照分组放到hll中， 依次指定参数log2m、log2explicit、log2sparse。log2sparse取值范围是0到14，0表示直接跳过Sparse模式。该参数可以用来设置Sparse模式的阈值大小，在数据段长度达到2log2sparse后切换为Full模式。若输入-1或者NULL，则log2sparse采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_cardinality(hll_add_agg(hll_hash_text(c), NULL, 6, 10)) FROM t_data; hll_cardinality ------------------ 498.496062953313 (1 row) hll_add_agg(hll_hashval, int32 log2m, int32 log2explicit, int64 log2sparse, int32 duplicatecheck) 描述：把哈希后的数据按照分组放到hll中, 依次指定参数log2m、log2explicit、log2sparse、duplicatecheck，duplicatecheck取值范围是0或者1，表示是否开启该模式，默认情况下该模式会关闭。若输入-1或者NULL，则duplicatecheck采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_cardinality(hll_add_agg(hll_hash_text(c), NULL, 6, 10, -1)) FROM t_data; hll_cardinality ------------------ 498.496062953313 (1 row) hll_union_agg(hll) 描述：将多个hll类型数据union成一个hll。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 --将各组中的hll数据union成一个hll，并计算distinct值。 gaussdb=# SELECT #hll_union_agg(c) AS cardinality FROM t_a_c_hll; cardinality ------------------ 498.496062953313 (1 row) --删除表 gaussdb=# DROP TABLE t_id; gaussdb=# DROP TABLE t_data; gaussdb=# DROP TABLE t_a_c_hll; 注意：当两个或者多个hll数据结构做union的时候，必须要保证其中每一个hll里面的精度参数一样，否则将不可以进行union。同样的约束也适用于函数hll_union(hll,hll)。

功能函数 hll_empty() 描述：创建一个空的hll。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_empty(); hll_empty ------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m) 描述：创建空的hll并指定参数log2m，取值范围是10到16。若输入-1，则采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT hll_empty(10); hll_empty ------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000 (1 row) gaussdb=# SELECT hll_empty(-1); hll_empty ------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit) 描述：创建空的hll并依次指定参数log2m、log2explicit。log2explicit取值范围是0到12，0表示直接跳过Explicit模式。该参数可以用来设置Explicit模式的阈值大小，在数据段长度达到2log2explicit后切换为Sparse模式或者Full模式。若输入-1，则log2explicit采用内置默认值。 返回值类型: hll 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT hll_empty(10, 4); hll_empty ------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000 (1 row) gaussdb=# SELECT hll_empty(10, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse。log2sparse取值范围是0到14，0表示直接跳过Sparse模式。该参数可以用来设置Sparse模式的阈值大小，在数据段长度达到2log2sparse后切换为Full模式。若输入-1，则log2sparse采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT hll_empty(10, 4, 8); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) gaussdb=# SELECT hll_empty(10, 4, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse, int32 duplicatecheck) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse、duplicatecheck。duplicatecheck取0或者1，表示是否开启该模式，默认情况下该模式会关闭。若输入-1，则duplicatecheck采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT hll_empty(10, 4, 8, 0); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) gaussdb=# SELECT hll_empty(10, 4, 8, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) hll_add(hll, hll_hashval) 描述：把hll_hashval加入到hll中。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_add(hll_empty(), hll_hash_integer(1)); hll_add ---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00 (1 row) hll_add_rev(hll_hashval, hll) 描述：把hll_hashval加入到hll中，和hll_add功能一样，只是参数位置进行了交换。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_add_rev(hll_hash_integer(1), hll_empty()); hll_add_rev ---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00 (1 row) hll_eq(hll, hll) 描述：比较两个hll是否相等。 返回值类型：bool 示例： 1 2 3 4 5 gaussdb=# SELECT hll_eq(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_eq -------- f (1 row) hll_ne(hll, hll) 描述：比较两个hll是否不相等。 返回值类型：bool 示例： 1 2 3 4 5 gaussdb=# SELECT hll_ne(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_ne -------- t (1 row) hll_cardinality(hll) 描述：计算hll的distinct值。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT hll_cardinality(hll_empty() || hll_hash_integer(1)); hll_cardinality ----------------- 1 (1 row) hll_union(hll, hll) 描述：把两个hll数据结构union成一个。 返回值类型：hll 示例： 1 2 3 4 5 gaussdb=# SELECT hll_union(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_union -------------------------------------------------------------------------------------------- \x484c4c10002000002b090000000000000000400000000000000000b3ccc49320cca1ae3e2921ff133fbaed00 (1 row)

日志函数 hll主要存在三种模式Explicit、Sparse、Full。当数据规模比较小的时候会使用Explicit模式，这种模式下distinct值的计算是没有误差的；随着distinct值越来越多，hll会先后转换为Sparse模式和Full模式，这两种模式在计算结果上没有任何区别，只影响hll函数的计算效率和hll对象的存储空间。下面的函数可以用于查看hll的一些参数。 hll_print(hll) 描述：打印hll的一些debug参数信息。 示例： 1 2 3 4 5 gaussdb=# SELECT hll_print(hll_empty()); hll_print ------------------------------------------------------------------------------- type=1(HLL_EMPTY), log2m=14, log2explicit=10, log2sparse=12, duplicatecheck=0 (1 row) hll_type(hll) 描述：查看当前hll的类型。返回值具体含义如下：返回值0，表示HLL_UNINIT，未初始化的hll对象；返回值1，表示HLL_EMPTY，hll空对象；返回值2，表示HLL_EXPLICIT，Explicit模式的hll对象；返回值3，表示HLL_SPARSE，Sparse模式的hll对象；返回值4，表示HLL_FULL，Full模式的hll对象；返回值5，表示HLL_UNDEFINED，不合法的hll对象。 示例： 1 2 3 4 5 gaussdb=# SELECT hll_type(hll_empty()); hll_type ---------- 1 (1 row) hll_log2m(hll) 描述：查看当前hll数据结构中的log2m数值，log2m是分桶数的对数值，此值会影响最后hll计算distinct误差率，误差率计算公式为±1.04/√(2 ^ log2m)。当显式指定log2m的取值为10-16之间时，hll会设置分桶数为2log2m。当显示指定log2explicit为-1时，会采用内置默认值。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 gaussdb=# SELECT hll_log2m(hll_empty()); hll_log2m ----------- 14 (1 row) gaussdb=# SELECT hll_log2m(hll_empty(10)); hll_log2m ----------- 10 (1 row) gaussdb=# SELECT hll_log2m(hll_empty(-1)); hll_log2m ----------- 14 (1 row) hll_log2explicit(hll) 描述：查看当前hll数据结构中的log2explicit数值。hll通常会由Explicit模式到Sparse模式再到Full模式，这个过程称为promotion hierarchy策略。可以通过调整log2explicit值的大小改变策略，比如log2explicit为0的时候就会跳过Explicit模式而直接进入Sparse模式。当显式指定log2explicit的取值为1-12之间时，hll会在数据段长度超过2log2explicit时转为Sparse模式。当显示指定log2explicit为-1时，会采用内置默认值。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 gaussdb=# SELECT hll_log2explicit(hll_empty()); hll_log2explicit ------------------ 10 (1 row) gaussdb=# SELECT hll_log2explicit(hll_empty(12, 8)); hll_log2explicit ------------------ 8 (1 row) gaussdb=# SELECT hll_log2explicit(hll_empty(12, -1)); hll_log2explicit ------------------ 10 (1 row) hll_log2sparse(hll) 描述：查看当前hll数据结构中的log2sparse数值。hll通常会由Explicit模式到Sparse模式再到Full模式，这个过程称为promotion hierarchy策略。可以通过调整log2sparse值的大小改变策略，比如log2sparse为0的时候就会跳过Sparse模式而直接进入Full模式。当显式指定Sparse的取值为1-14之间时，hll会在数据段长度超过2log2sparse时转为Full模式。当显示指定log2sparse为-1时，会采用内置默认值。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 gaussdb=# SELECT hll_log2sparse(hll_empty()); hll_log2sparse ---------------- 12 (1 row) gaussdb=# SELECT hll_log2sparse(hll_empty(12, 8, 10)); hll_log2sparse ---------------- 10 (1 row) gaussdb=# SELECT hll_log2sparse(hll_empty(12, 8, -1)); hll_log2sparse ---------------- 12 (1 row) hll_duplicatecheck(hll) 描述：是否启用duplicatecheck，0是关闭，1是开启。默认关闭，对于有较多重复值出现的情况，可以开启以提高效率。当显示指定duplicatecheck为-1时，会采用内置默认值。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 gaussdb=# SELECT hll_duplicatecheck(hll_empty()); hll_duplicatecheck -------------------- 0 (1 row) gaussdb=# SELECT hll_duplicatecheck(hll_empty(12, 8, 10, 1)); hll_duplicatecheck -------------------- 1 (1 row) gaussdb=# SELECT hll_duplicatecheck(hll_empty(12, 8, 10, -1)); hll_duplicatecheck -------------------- 0 (1 row)

二进制字符串函数 GaussDB 也提供了函数调用所使用的常用语法。 btrim(string bytea,bytes bytea) 描述：从string的开头和结尾删除只包含bytes中字节的最长的字符串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT btrim(E'\\000trim\\000'::bytea, E'\\000'::bytea) AS RESULT; result ------------ \x7472696d (1 row) get_bit(string, offset) 描述：从字符串中抽取位。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT get_bit(E'Th\\000omas'::bytea, 45) AS RESULT; result -------- 1 (1 row) get_byte(string, offset) 描述：从字符串中抽取字节。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT get_byte(E'Th\\000omas'::bytea, 4) AS RESULT; result -------- 109 (1 row) set_bit(string,offset, newvalue) 描述：设置字符串中的位。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT set_bit(E'Th\\000omas'::bytea, 45, 0) AS RESULT; result ------------------ \x5468006f6d4173 (1 row) set_byte(string,offset, newvalue) 描述：设置字符串中的字节。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT set_byte(E'Th\\000omas'::bytea, 4, 64) AS RESULT; result ------------------ \x5468006f406173 (1 row) rawcmp(raw, raw) 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：integer raweq(raw, raw) 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawge(raw, raw) 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawgt(raw, raw) 描述：raw数据类型比较函数。 参数：raw, raw 返回值类型：boolean rawin(cstring) 描述：raw数据类型解析函数。 参数：cstring 返回值类型：bytea rawle(raw, raw) 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawlike(raw, raw) 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawlt(raw, raw) 描述：raw数据类型解析函数。 参数：raw, raw 返回值类型：boolean rawne(raw, raw) 描述：比较raw类型是否一样。 参数：raw, raw 返回值类型：boolean rawnlike(raw, raw) 描述：比较raw类型与模式是否不匹配。 参数：raw, raw 返回值类型：boolean rawout(bytea) 描述：RAW类型的输出接口。 参数：bytea 返回值类型：cstring rawsend(raw) 描述：转换bytea为二进制类型。 参数：raw 返回值类型：bytea rawtohex(text) 描述：raw格式转换为十六进制。 参数：text 返回值类型：text

字符串操作符 SQL定义了一些字符串函数，在这些函数里使用关键字而不是逗号来分隔参数。 octet_length(string) 描述：二进制字符串中的字节数。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT octet_length(E'jo\\000se'::bytea) AS RESULT; result -------- 5 (1 row) overlay(string placing string from int [for int]) 描述：替换子串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT overlay(E'Th\\000omas'::bytea placing E'\\002\\003'::bytea from 2 for 3) AS RESULT; result ---------------- \x5402036d6173 (1 row) position(substring in string) 描述：特定子字符串的位置。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT position(E'\\000om'::bytea in E'Th\\000omas'::bytea) AS RESULT; result -------- 3 (1 row) substring(string [from int] [for int]) 描述：截取子串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT substring(E'Th\\000omas'::bytea from 2 for 3) AS RESULT; result ---------- \x68006f (1 row) substr(bytea [from int] [for int]) 描述：截取子串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT substr(E'Th\\000omas'::bytea,2, 3) as result; result ---------- \x68006f (1 row) trim([both] bytes from string) 描述：从string的开头和结尾删除只包含bytes中字节的最长字符串。 返回值类型：bytea 示例： 1 2 3 4 5 gaussdb=# SELECT trim(E'\\000'::bytea from E'\\000Tom\\000'::bytea) AS RESULT; result ---------- \x546f6d (1 row)

下标生成函数 generate_subscripts(array anyarray, dim int) 描述：生成一系列包括给定数组的下标。 返回值类型：setof int generate_subscripts(array anyarray, dim int, reverse boolean) 描述：生成一系列包括给定数组的下标。当reverse为真时，该系列则以相反的顺序返回。 返回值类型：setof int

序列号生成函数 generate_series(start, stop) 描述：生成一个数值序列，从start到stop，步长为1。 参数类型：int、bigint、numeric 返回值类型：setof int、setof bigint、setof numeric（与参数类型相同） generate_series(start, stop, step) 描述：生成一个数值序列，从start到stop，步长为step。 参数类型：int、bigint、numeric 返回值类型：setof int、setof bigint、setof numeric（与参数类型相同） generate_series(start, stop, step interval) 描述：生成一个数值序列，从start到stop，步长为step。 参数类型：timestamp或timestamp with time zone 返回值类型：setof timestamp或setof timestamp with time zone（与参数类型相同）

数组函数 array_append(anyarray, anyelement) 描述：向数组末尾添加元素，只支持一维数组。 返回类型：anyarray 示例： 1 2 3 4 5 gaussdb=# SELECT array_append(ARRAY[1,2], 3) AS RESULT; result --------- {1,2,3} (1 row) array_prepend(anyelement, anyarray) 描述：向数组开头添加元素，只支持一维数组。 返回类型：anyarray 示例： 1 2 3 4 5 gaussdb=# SELECT array_prepend(1, ARRAY[2,3]) AS RESULT; result --------- {1,2,3} (1 row) array_cat(anyarray, anyarray) 描述：连接两个数组，支持多维数组。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT array_cat(ARRAY[1,2,3], ARRAY[4,5]) AS RESULT; result ------------- {1,2,3,4,5} (1 row) gaussdb=# SELECT array_cat(ARRAY[[1,2],[4,5]], ARRAY[6,7]) AS RESULT; result --------------------- {{1,2},{4,5},{6,7}} (1 row) array_union(anyarray, anyarray) 描述：连接两个数组，只支持一维数组。有入参为NULL时返回另一个入参。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT array_union(ARRAY[1,2,3], ARRAY[3,4,5]) AS RESULT; result ------------- {1,2,3,3,4,5} (1 row) gaussdb=# SELECT array_union(ARRAY[1,2,3], NULL) AS RESULT; result --------- {1,2,3} (1 row) array_union_distinct(anyarray, anyarray) 描述：连接两个数组，并去重，只支持一维数组。有入参为NULL时返回另一个入参。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT array_union_distinct(ARRAY[1,2,3], ARRAY[3,4,5]) AS RESULT; result ------------- {1,2,3,4,5} (1 row) gaussdb=# SELECT array_union_distinct(ARRAY[1,2,3], NULL) AS RESULT; result --------- {1,2,3} (1 row) array_intersect(anyarray, anyarray) 描述：两个数组取交集，只支持一维数组。有入参为NULL时返回NULL。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT array_intersect(ARRAY[1,2,3], ARRAY[3,4,5]) AS RESULT; result ------------- {3} (1 row) gaussdb=# SELECT array_intersect(ARRAY[1,2,3], NULL) AS RESULT; result -------- (1 row) array_intersect_distinct(anyarray, anyarray) 描述：两个数组取交集，并去重，只支持一维数组。有入参为NULL时返回NULL。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT array_intersect_distinct(ARRAY[1,2,2], ARRAY[2,2,4,5]) AS RESULT; result ------------- {2} (1 row) gaussdb=# SELECT array_intersect_distinct(ARRAY[1,2,3], NULL) AS RESULT; result -------- (1 row) array_except(anyarray, anyarray) 描述：两个数组取差，只支持一维数组。第一个入参为NULL时返回NULL, 第二个入参为NULL时返回第一个入参。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 gaussdb=# SELECT array_except(ARRAY[1,2,3], ARRAY[3,4,5]) AS RESULT; result ------------- {1,2} (1 row) gaussdb=# SELECT array_except(ARRAY[1,2,3], NULL) AS RESULT; result --------- {1,2,3} (1 row) gaussdb=# SELECT array_except(NULL, ARRAY[3,4,5]) AS RESULT; result -------- (1 row) array_except_distinct(anyarray, anyarray) 描述：两个数组取差，并去重，只支持一维数组。第一个入参为NULL时返回NULL, 第二个入参为NULL时返回第一个入参。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 gaussdb=# SELECT array_except_distinct(ARRAY[1,2,2,3], ARRAY[3,4,5]) AS RESULT; result ------------- {1,2} (1 row) gaussdb=# SELECT array_except_distinct(ARRAY[1,2,3], NULL) AS RESULT; result --------- {1,2,3} (1 row) gaussdb=# SELECT array_except_distinct(NULL, ARRAY[3,4,5]) AS RESULT; result -------- (1 row) array_ndims(anyarray) 描述：返回数组的维数。 返回类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT array_ndims(ARRAY[[1,2,3], [4,5,6]]) AS RESULT; result -------- 2 (1 row) array_dims(anyarray) 描述：返回数组维数的文本表示。 返回类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT array_dims(ARRAY[[1,2,3], [4,5,6]]) AS RESULT; result ------------ [1:2][1:3] (1 row) array_length(anyarray, int) 描述：返回数组维度的长度。 返回类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT array_length(array[1,2,3], 1) AS RESULT; result -------- 3 (1 row) array_lower(anyarray, int) 描述：返回数组维数的下界。 返回类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT array_lower('[0:2]={1,2,3}'::int[], 1) AS RESULT; result -------- 0 (1 row) array_sort(anyarray) 描述：返回从小到大排列好的数组。只支持一维anyarray数组排序，多维数组返回NULL值。目前暂不支持record、xml、xmltype、json类型数组排序。 返回类型：anyarray 示例： 1 2 3 4 5 6 7 8 9 10 gaussdb=# SELECT array_sort(ARRAY[5,1,3,6,2,7]) AS RESULT; result ------------- {1,2,3,5,6,7} (1 row) gaussdb=# SELECT array_sort(array[array[1,23], array[1,34]]); array_sort ------------- {NULL,NULL} (1 row) array_upper(anyarray, int) 描述：返回数组维数的上界。 返回类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT array_upper(ARRAY[1,8,3,7], 1) AS RESULT; result -------- 4 (1 row) array_to_string(anyarray, text [, text]) 描述：使用第一个text作为数组的新分隔符，使用第二个text替换数组值为NULL的值。 返回类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT array_to_string(ARRAY[1, 2, 3, NULL, 5], ',', '*') AS RESULT; result ----------- 1,2,3,*,5 (1 row) array_delete(anyarray) 描述：清空数组中的元素并返回一个同类型的空数组。 返回类型：anyarray 示例： gaussdb=# SELECT array_delete(ARRAY[1,8,3,7]) AS RESULT; result -------- {} (1 row) array_deleteidx(anyarray, int) 描述：从数组中删除指定下标的元素并返回剩余元素组成的数组。 返回类型：anyarray 示例： gaussdb=# SELECT array_deleteidx(ARRAY[1,2,3,4,5], 1) AS RESULT; result ----------- {2,3,4,5} (1 row) array_deleteidx(anyarray, int)此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下被禁用。 array_extendnull(anyarray, int) 描述：往数组尾部添加指定个数空元素。 返回类型：anyarray 示例： gaussdb=# SELECT array_extendnull(ARRAY[1,8,3,7],1) AS RESULT; result -------------- {1,8,3,7,null} (1 row) array_extendnull(anyarray, int, int) 描述：往数组尾部添加指定个数的指定索引的元素。 返回类型：anyarray 示例： gaussdb=# SELECT array_extendnull(ARRAY[1,8,3,7],2,2) AS RESULT; result -------------- {1,8,3,7,8,8} (1 row) array_extendnull(anyarray, int, int)此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下有效。 array_trim(anyarray, int) 描述：从数组尾部删除指定个数个元素。 返回类型：anyarray 示例： gaussdb=# SELECT array_trim(ARRAY[1,8,3,7],1) AS RESULT; result --------- {1,8,3} (1 row) array_exists(anyarray, int) 描述：检查第二个参数是否是数组的合法下标。 返回类型：boolean 示例： gaussdb=# SELECT array_exists(ARRAY[1,8,3,7],1) AS RESULT; result -------- t (1 row) array_next(anyarray, int) 描述：根据第二个入参返回数组中指定下标元素的下一个元素的下标。 返回类型：int 示例： gaussdb=# SELECT array_next(ARRAY[1,8,3,7],1) AS RESULT; result -------- 2 (1 row) array_prior(anyarray, int) 描述：根据第二个入参返回数组中指定下标元素的上一个元素的下标。 返回类型：int 示例： gaussdb=# SELECT array_prior(ARRAY[1,8,3,7],2) AS RESULT; result -------- 1 (1 row) string_to_array(text, text [, text]) 描述：使用第二个text指定分隔符，使用第三个可选的text作为NULL值替换模板，如果分隔后的子串与第三个可选的text完全匹配，则将其替换为NULL。 返回类型：text[] 示例： 1 2 3 4 5 6 7 8 9 10 gaussdb=# SELECT string_to_array('xx~^~yy~^~zz', '~^~', 'yy') AS RESULT; result -------------- {xx,NULL,zz} (1 row) gaussdb=# SELECT string_to_array('xx~^~yy~^~zz', '~^~', 'y') AS RESULT; result ------------ {xx,yy,zz} (1 row) 在string_to_array中，如果分隔符参数是NULL，输入字符串中的每个字符将在结果数组中变成一个独立的元素。如果分隔符是一个空白字符串，则整个输入的字符串将变为一个元素的数组。否则输入字符串将在每个分隔字符串处分开。 在string_to_array中，如果省略NULL字符串参数或为NULL，将字符串中没有输入内容的子串替换为NULL。 在array_to_string中，如果省略NULL字符串参数或为NULL，运算中将跳过在数组中的任何NULL元素，并且不会在输出字符串中出现。 unnest(anyarray) 描述：扩大一个数组为一组行。 返回类型：setof anyelement 示例： 1 2 3 4 5 6 gaussdb=# SELECT unnest(ARRAY[1,2]) AS RESULT; result -------- 1 2 (2 rows)

enable_ledger 参数说明：控制是否启用账本数据库功能。若此参数设置为打开（on）状态，则启用账本数据库功能，允许创建新的防篡改模式和修改普通模式为防篡改模式。 参数类型：布尔型 参数单位：无 取值范围： on：表示启用账本数据库功能。 off：表示不启用账本数据库功能。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：该参数默认关闭，需要开启账本数据库功能时，将enable_ledger设置为on。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

ledger_hist_level 参数说明：全局区块表记录控制开关，用于控制全局区块表中是否记录SQL语句。 参数类型：整型 参数单位：无 取值范围： 0：表示在全局区块表中不记录SQL语句。 1：表示在全局区块表中记录SQL语句。 默认值：1 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

logical_replication_dictionary_retention_time 参数说明：GS_TXN_LSN_TIME以及数据字典相关系统表数据保留时间。 参数类型：整型 参数单位：d（天） 取值范围：1 ~ 3650 默认值：365 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：根据实际业务需求进行设置。 设置不当的风险与影响：设置过小，会导致指定位点解码的可选区间过小；设置过大，会影响解码性能。

logical_replica_identity_force 参数说明：控制全局逻辑复制旧元组的记录级别。 参数类型：枚举类型 参数单位：无 取值范围： 'full'：表示所有列都记录为副本标识。 'unique'：表示副本标识为主键和唯一键。 'default'：表示复制副本标识为默认选择（主键或无）。 'nothing'：表示没有记录此关系的副本标识。 'none'‬：表示此全局控制参数不生效。 默认值：'none' 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 如需将已设置为非默认值的logical_replica_identity_force参数重新设置成'none'，须使用将GUC参数恢复成默认值的方法。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

max_cached_tuplebufs 参数说明：逻辑解码时，总元组信息在内存中缓存的数量上限。 参数类型：整型 参数单位：无 取值范围：1 ~ 2147483647‬ 默认值：8192 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。建议设置为max_changes_in_memory的两倍以上。 设置不当的风险与影响：设置过大，解码到大事务会占用较多的动态内存；设置过小，解码效率会降低。

enable_logical_replication_dictionary 参数说明：表示是否开启创建多版本字典表类型的逻辑复制槽。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启。 off：表示关闭。 默认值：on 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：该参数默认on，如果需要创建online catalog类型的逻辑复制槽时设置为off。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 当该参数开启时，字典类型的系统表基线化完成后才能创建逻辑复制槽，否则创建失败。

max_keep_log_seg 参数说明：流控参数，逻辑复制在DN本地会解析物理日志转换成逻辑日志，当未被解析的物理日志文件数量大于该参数时会触发限流。 参数类型：整型 参数单位：无 取值范围：0 ~ 2147483647。0表示关闭限流功能。 默认值：0 设置方式：该参数属于USERSET类型参数，请参见表1中对应设置方法进行设置。 设置建议：根据实际业务需求，判断是否需要进行流控。 设置不当的风险与影响：设置过大，流控一直不触发。

enable_logical_replication_ddl 参数说明：设置逻辑解码是否支持DDL，是否反解析，是否生成日志。 参数类型：布尔型 参数单位：无 取值范围： on：逻辑复制可支持DDL，对DDL执行结果进行反解析，并生成DDL的WAL日志。 off：不支持DDL，不反解析也不生成WAL日志。 默认值：on 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

enable_logicalrepl_xlog_prune 参数说明：设置是否开启逻辑复制槽强制失效功能。当GUC参数enable_logicalrepl_xlog_prune=on、max_size_for_xlog_retention为非零值时，如果max_size_for_xlog_retention大于0且当前逻辑复制槽导致保留日志的段数（每段日志大小为16MB）超过max_size_for_xlog_retention，或者max_size_for_xlog_retention小于0且磁盘使用率达到(-max_size_for_xlog_retention)/100，则该逻辑复制槽会强制失效，restart_lsn被置为7FFFFFFF/FFFFFFFF，该复制槽不阻塞xlog日志的回收。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启逻辑复制槽强制失效功能。 off：表示关闭逻辑复制槽强制失效功能。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：根据实际业务需要确认是否开启。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

操作步骤 连接数据库，具体操作请参见通过gsql连接实例章节。 查看数据库GUC参数当前取值。 方法一：使用SHOW命令。 使用如下命令查看单个参数： 1 gaussdb=# SHOW server_version; server_version显示数据库版本信息的参数。 使用如下命令查看所有参数： 1 gaussdb=# SHOW ALL; 方法二：使用pg_settings视图。 使用如下命令查看单个参数： 1 gaussdb=# SELECT * FROM pg_settings WHERE NAME='server_version'; 使用如下命令查看所有参数： 1 gaussdb=# SELECT * FROM pg_settings;

示例 在当前数据库安装扩展。例如安装security_plugin： --安装扩展之前需要设置enable_extension为true才能够创建。 gaussdb=# SET enable_extension = true; --安装扩展。 gaussdb=# CREATE EXTENSION IF NOT EXISTS security_plugin; --删除扩展。 gaussdb=# DROP EXTENSION security_plugin;

更新表中数据 修改已经存储在数据库中数据的行为叫做更新。用户可以更新单独一行、所有行或者指定的部分行。还可以独立更新每个字段，而其他字段则不受影响。 使用UPDATE命令更新现有行，需要提供以下三种信息： 表的名称和需要更新的字段名 字段的新值 需要更新的行 SQL通常不会为数据行提供唯一标识，因此无法直接声明需要更新哪一行。但是可以通过声明一个被更新的行必须满足的条件。只有在表里存在主键的时候，才可以通过主键指定一个独立的行。 建立表和插入数据的步骤请参见创建表和向表中插入数据。 需要将表customer_t1中c_customer_sk为9527的地域重新定义为9876。 1 gaussdb=# UPDATE customer_t1 SET c_customer_sk = 9876 WHERE c_customer_sk = 9527; 这里的表名称也可以使用模式名修饰，否则会从默认的模式路径找到这个表。SET后面紧跟字段和新的字段值。新的字段值不仅可以是常量，也可以是变量表达式。 比如，把所有c_customer_sk的值增加100。 1 gaussdb=# UPDATE customer_t1 SET c_customer_sk = c_customer_sk + 100; 在这里省略了WHERE子句，表示表中的所有行都要被更新。如果出现了WHERE子句，那么只有匹配其条件的行才会被更新。 在SET子句中的等号是一个赋值，而在WHERE子句中的等号是比较。WHERE条件不一定是相等比较，许多其他的操作符也可以使用。 用户可以在一个UPDATE命令中更新更多的字段，方法是在SET子句中列出更多赋值，比如： 1 gaussdb=# UPDATE customer_t1 SET c_customer_id = 'Admin', c_first_name = 'Local' WHERE c_customer_sk = 4421; 批量更新或删除数据后，会在数据文件中产生大量的删除标记，查询过程中标记删除的数据也是需要扫描的。故多次批量更新/删除后，标记删除的数据量过大会严重影响查询的性能。建议在批量更新/删除业务会反复执行的场景下，定期执行VACUUM FULL以保证查询性能。 父主题： 创建和管理表

事务ID和快照 内部事务ID类型（xid）是64位。这些函数使用的数据类型txid_snapshot，存储在特定时刻事务ID可见性的信息。其组件描述如表13所示。 表13 快照组件 名称 描述 xmin 最早的事务ID（txid）仍然活动。所有较早事务将是已经提交可见的，或者是直接回滚。 xmax 作为尚未分配的txid。所有大于或等于此txids的都是尚未开始的快照时间，因此不可见。 xip_list 当前快照中活动的txids。这个列表只包含在xmin和xmax之间活动的txids，有可能活动的txids高于xmax。介于大于等于xmin、小于xmax，并且不在这个列表中的txid，在这个时间快照已经完成的，因此按照提交状态查看他是可见还是回滚。这个列表不包含子事务的txids。 txid_snapshot的文本表示为：xmin:xmax:xip_list。 示例：10:20:10,14,15意思为：xmin=10, xmax=20, xip_list=10, 14, 15。 以下的函数在一个输出形式中提供服务器事务信息。这些函数的主要用途是为了确定在两个快照之间有哪些事务提交。 pgxc_is_committed(transaction_id) 描述：如果普通表提交或忽略给定的XID（gxid）。NULL表示的状态是未知的（运行、准备、冻结等）。 返回类型：Boolean pgxc_is_committed(transaction_id, bucketid) 描述: 当前版本集中式不支持hashbucket 表，该接口函数调用报错。 txid_current() 描述：获取当前事务ID。 返回类型：bigint gs_txid_oldestxmin() 描述：获取当前最小事务id的值oldesxmin。 返回类型：bigint txid_current_snapshot() 描述：获取当前快照。 返回类型：txid_snapshot txid_snapshot_xip(txid_snapshot) 描述：在快照中获取正在进行的事务ID。 返回类型：setof bigint txid_snapshot_xmax(txid_snapshot) 描述：获取快照的xmax。 返回类型：bigint txid_snapshot_xmin(txid_snapshot) 描述：获取快照的xmin。 返回类型：bigint txid_visible_in_snapshot(bigint, txid_snapshot) 描述：在快照中事务ID是否可见（不使用子事务ID）。 返回类型：Boolean get_local_prepared_xact() 描述：获取当前节点两阶段残留事务信息，包括事务id、两阶段gid名称、prepared的时间、owner的oid、database的oid及当前节点的node_name。 返回类型：xid, text, timestamptz, oid, text get_remote_prepared_xacts() 描述：获取所有远程节点两阶段残留事务信息，包括事务id、两阶段gid名称、prepared的时间、owner的名称、database的名称及node_name。 返回类型：xid, text, timestamptz, name, text global_clean_prepared_xacts(text, text) 描述：并发清理两阶段残留事务，调用该函数将返回false。 返回类型：Boolean gs_get_next_xid_csn() 描述：返回全局所有节点上的next_xid和next_csn值。 返回值如表14所示。 表14 gs_get_next_xid_csn返回参数说明 字段名 描述 nodename 节点名称。 next_xid 当前节点下一个事务id号。 next_csn 当前节点下一个csn号。

注释信息函数 col_description(table_oid, column_number) 描述：获取一个表字段的注释。 返回类型：text 备注：col_description返回一个表中字段的注释，通过表OID和字段号来声明。 obj_description(object_oid, catalog_name) 描述：获取一个数据库对象的注释。 返回类型：text 备注：带有两个参数的obj_description返回一个数据库对象的注释，该对象是通过其OID和其所属的系统表名称声明。比如，obj_description(123456,'pg_class')将返回OID为123456的表的注释。只带一个参数的obj_description只要求对象OID。 obj_description不能用于表字段，因为字段没有自己的OID。 obj_description(object_oid) 描述：获取一个数据库对象的注释。 返回类型：text shobj_description(object_oid, catalog_name) 描述：获取一个共享数据库对象的注释。 返回类型：text 备注：shobj_description和obj_description差不多，不同之处仅在于前者用于共享对象。一些系统表是通用于GaussDB中所有数据库的全局表，因此这些表的注释也是全局存储的。

系统表信息函数 format_type(type_oid, typemod) 描述：获取数据类型的SQL名称 返回类型：text 备注：format_type通过某个数据类型的OID以及可能的修饰词，返回其SQL名称。如果不知道具体的修饰词，则在修饰词的位置传入NULL。修饰词一般只对有长度限制的数据类型有意义。format_type所返回的SQL名称中包含数据类型的长度值，其大小是：实际存储长度len - sizeof(int32)，单位字节。原因是数据存储时需要32位的空间来存储用户对数据类型的自定义长度信息，即实际存储长度要比用户定义长度多4个字节。在下例中，format_type返回的SQL名称为“character varying(6)”，6表示varchar类型的长度值是6字节，因此该类型的实际存储长度为10字节。 1 2 3 4 5 gaussdb=# SELECT format_type((SELECT oid FROM pg_type WHERE typname='varchar'), 10); format_type ---------------------- character varying(6) (1 row) getdistributekey(table_name) 描述：获取一个hash表的分布列。单机环境下不支持分布，该函数返回为空。 pg_check_authid(role_oid) 描述：检查是否存在给定oid的角色名。 返回类型：Boolean 示例： gaussdb=# SELECT pg_check_authid(1); pg_check_authid ----------------- f (1 row) pg_describe_object(catalog_id, object_id, object_sub_id) 描述：获取数据库对象的描述。 返回类型：text 备注：pg_describe_object返回目录OID，对象OID和一个（或许0个）子对象ID指定的数据库对象的描述。这有助于确认存储在pg_depend系统表中对象的身份。 pg_get_constraintdef(constraint_oid) 描述：获取约束的定义。 返回类型：text pg_get_constraintdef(constraint_oid, pretty_bool) 描述：获取约束的定义。 返回类型：text 备注：pg_get_constraintdef和pg_get_indexdef分别从约束或索引上使用创建命令进行重构。 pg_get_expr(pg_node_tree, relation_oid) 描述：反编译表达式的内部形式，假设其中的任何Vars都引用第二个参数指定的关系。 返回类型：text pg_get_expr(pg_node_tree, relation_oid, pretty_bool) 描述：反编译表达式的内部形式，假设其中的任何Vars都引用第二个参数指定的关系。 返回类型：text 备注：pg_get_expr反编译一个独立表达式的内部形式，比如一个字段的缺省值。便于检查系统表的内容。如果表达式包含关键字，则指定关键字引用相关的OID作为第二个参数；如果没有关键字，为零即可。 pg_get_functiondef(func_oid) 描述：获取函数的定义 返回类型：text 示例： gaussdb=# SELECT * FROM pg_get_functiondef(598); headerlines | definition -------------+---------------------------------------------------- 4 | CREATE OR REPLACE FUNCTION pg_catalog.abbrev(inet)+ | RETURNS text + | LANGUAGE internal + | IMMUTABLE STRICT NOT FENCED NOT SHIPPABLE + | AS $function$inet_abbrev$function$ + | (1 row) pg_get_function_arguments(func_oid) 描述：获取函数定义的参数列表（带默认值）。 返回类型：text 备注：pg_get_function_arguments返回一个函数的参数列表，需要在CREATE FUNCTION中使用这种格式。 pg_get_function_identity_arguments(func_oid) 描述：获取参数列表来确定一个函数 (不带默认值)。 返回类型：text 备注：pg_get_function_identity_arguments返回需要的参数列表用来标识函数，这种形式需要在ALTER FUNCTION中使用，并且这种形式省略了默认值。 pg_get_function_result(func_oid) 描述：获取函数的RETURNS子句。 返回类型：text 备注：pg_get_function_result为函数返回适当的RETURNS子句。 pg_get_indexdef(index_oid) 描述：获取索引的CREATE INDEX命令。 返回类型：text 示例： gaussdb=# SELECT * FROM pg_get_indexdef(16416); pg_get_indexdef ------------------------------------------------------------------------- CREATE INDEX test3_b_idx ON test3 USING btree (b) TABLESPACE pg_default (1 row) pg_get_indexdef(index_oid, dump_schema_only) 描述：获取索引的CREATE INDEX命令，仅用于dump场景。对于包含local索引的间隔分区表，当dump_schema_only为true时，返回的创建索引语句中不包含自动创建的分区的local索引信息；当dump_schema_only为false时，返回的创建索引语句中包含自动创建的分区的local索引信息。对于非间隔分区表或者不包含local索引的间隔分区表，dump_schema_only参数取值不影响函数返回结果。 返回类型：text 示例： gaussdb=# CREATE TABLE sales (prod_id NUMBER(6), cust_id NUMBER, time_id DATE, channel_id CHAR(1), promo_id NUMBER(6), quantity_sold NUMBER(3), amount_sold NUMBER(10,2)) PARTITION BY RANGE( time_id) INTERVAL('1 day') (partition p1 VALUES LESS THAN ('2019-02-01 00:00:00'), partition p2 VALUES LESS THAN ('2019-02-02 00:00:00') ); CREATE TABLE gaussdb=# CREATE INDEX index_sales ON sales(prod_id) local (PARTITION idx_p1 ,PARTITION idx_p2); CREATE INDEX gaussdb=# -- 插入数据没有匹配的分区，新创建一个分区，并将数据插入该分区。 gaussdb=# INSERT INTO sales VALUES(1, 12, '2019-02-05 00:00:00', 'a', 1, 1, 1); INSERT 0 1 gaussdb=# SELECT oid FROM pg_class WHERE relname = 'index_sales'; oid ------- 24632 (1 row) gaussdb=# SELECT * FROM pg_get_indexdef(24632, true); pg_get_indexdef -------------------------------------------------------------------------------------------------------------------------- CREATE INDEX index_sales ON sales USING btree (prod_id) LOCAL(PARTITION idx_p1, PARTITION idx_p2) TABLESPACE pg_default (1 row) gaussdb=# SELECT * FROM pg_get_indexdef(24632, false); pg_get_indexdef ------------------------------------------------------------------------------------------------------------------------------------ -------------------- CREATE INDEX index_sales ON sales USING btree (prod_id) LOCAL(PARTITION idx_p1, PARTITION idx_p2, PARTITION sys_p1_prod_id_idx) TA BLESPACE pg_default (1 row pg_get_indexdef(index_oid, column_no, pretty_bool) 描述：获取索引的CREATE INDEX命令，或者如果column_no不为零，则只获取一个索引字段的定义。 示例： gaussdb=# SELECT * FROM pg_get_indexdef(16416, 0, false); pg_get_indexdef ------------------------------------------------------------------------- CREATE INDEX test3_b_idx ON test3 USING btree (b) TABLESPACE pg_default (1 row) gaussdb=# select * from pg_get_indexdef(16416, 1, false); pg_get_indexdef ----------------- b (1 row) 返回类型：text 备注：pg_get_functiondef为函数返回一个完整的CREATE OR REPLACE FUNCTION语句。 pg_get_keywords() 描述：获取SQL关键字和类别列表。 返回类型：setof record 备注：pg_get_keywords返回一组关于描述服务器识别SQL关键字的记录。word列包含关键字。catcode列包含一个分类代码：U表示通用的、C表示列名、T表示类型或函数名、或R表示保留。catdesc列包含了一个可能本地化描述分类的字符串。 pg_get_userbyid(role_oid) 描述：获取给定OID的角色名。 返回类型：name 备注：pg_get_userbyid通过角色的OID抽取对应的用户名。 pg_check_authid(role_id) 描述：通过role_id检查用户是否存在。 返回类型：text 示例： gaussdb=# SELECT pg_check_authid(20); pg_check_authid ----------------- f (1 row) pg_get_viewdef(view_name) 描述：为视图获取底层的SELECT命令。 返回类型：text pg_get_viewdef(view_name, pretty_bool) 描述：为视图获取底层的SELECT命令，如果pretty_bool为true，行字段可以包含80列。 返回类型：text 备注：pg_get_viewdef重构出定义视图的SELECT查询。这些函数大多数都有两种形式，其中带有pretty_bool参数，且参数为true时，是"适合打印"的结果，这种格式更容易读。另一种是缺省的格式，更有可能被将来的不同版本用同样的方法解释。如果是用于转储，那么尽可能避免使用"适合打印"的格式。给pretty-print参数传递false生成的结果和没有这个参数的变种生成的结果完全一样。 pg_get_viewdef(view_oid) 描述：为视图获取底层的SELECT命令。 返回类型：text pg_get_viewdef(view_oid, pretty_bool) 描述：为视图获取底层的SELECT命令，如果pretty_bool为true，行字段可以包含80列。 返回类型：text pg_get_viewdef(view_oid, wrap_column_int) 描述：为视图获取底层的SELECT命令，行字段被换到指定的列数，打印是隐含的。 返回类型：text pg_get_tabledef(table_oid) 描述：根据table_oid获取表定义。 示例： gaussdb=# SELECT * FROM pg_get_tabledef(16384); pg_get_tabledef ----------------------------------------------------------------------------------------------- SET search_path = public; + CREATE TABLE t1 ( + c1 bigint DEFAULT nextval('serial'::regclass) + ) + WITH (orientation=row, compression=no, storage_type=USTORE, segment=off); + ALTER TABLE t1 ILM ADD POLICY ROW STORE COMPRESS ADVANCED ROW AFTER 1 DAYS OF NO MODIFICATION; (1 row) 返回类型：text pg_get_tabledef(table_name) 描述：根据table_name获取表定义 示例： gaussdb=# SELECT * FROM pg_get_tabledef('t1'); pg_get_tabledef ----------------------------------------------------------------------------------------------- SET search_path = public; + CREATE TABLE t1 ( + c1 bigint DEFAULT nextval('serial'::regclass) + ) + WITH (orientation=row, compression=no, storage_type=USTORE, segment=off); + ALTER TABLE t1 ILM ADD POLICY ROW STORE COMPRESS ADVANCED ROW AFTER 1 DAYS OF NO MODIFICATION; (1 row) 返回类型：text 备注：pg_get_tabledef重构出表定义的CREATE语句，包含了表定义本身、索引信息、comments、ilm策略（若存在）信息。对于表对象依赖的group、schema、tablespace、server等信息，需要单独创建，表定义里不会有这些对象的创建语句。如果ilm策略信息是继承自父对象，pg_get_tabledef不会返回该数据对象的ilm策略信息创建语句。 pg_options_to_table(reloptions) 描述：获取存储选项名称/值对的集合。 返回类型：setof record 备注：pg_options_to_table当通过pg_class.reloptions或pg_attribute.attoptions时返回存储选项名称/值对（option_name/option_value）的集合。 pg_tablespace_databases(tablespace_oid) 描述：获取在指定的表空间中有对象的数据库OID集合。 返回类型：setof oid 备注：pg_tablespace_databases允许检查表空间的状况，返回在该表空间中保存了对象的数据库OID集合。如果这个函数返回数据行，则该表空间是非空的，因此不能删除。要显示该表空间中的特定对象，用户需要连接pg_tablespace_databases标识的数据库与查询pg_class系统表。 pg_tablespace_location(tablespace_oid) 描述：获取表空间所在的文件系统的路径。多租场景下，non-PDB调用该函数时返回non-PDB表空间所在的文件路径，PDB调用该函数时返回PDB表空间所在的文件路径。 返回类型：text pg_typeof(any) 描述：获取任何值的数据类型。 返回类型：regtype 备注：pg_typeof返回传递给他的值的数据类型OID。这有助于故障排除或动态构造SQL查询。声明此函数返回regtype，这是一个OID别名类型（请参考对象标识符类型）；它是一个为了比较而显示类型名称的OID。 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT pg_typeof(33); pg_typeof ----------- integer (1 row) gaussdb=# SELECT typlen FROM pg_type WHERE oid = pg_typeof(33); typlen -------- 4 (1 row) collation for (any) 描述：获取参数的排序。 返回类型：text 备注：表达式collation for返回传递给他的值的排序。 值可能是引号括起来的并且模式限制的。如果没有为参数表达式排序，则返回一个null值。如果参数不是排序的类型，则抛出一个错误。 示例： 1 2 3 4 5 gaussdb=# SELECT collation for (description) FROM pg_description LIMIT 1; pg_collation_for ------------------ "default" (1 row) pg_extension_update_paths(name) 描述：返回指定扩展的版本更新路径。 返回类型：text(source text), text(path text), text(target text) pg_get_serial_sequence(tablename, colname) 描述：获取对应表名和列名上的序列。 返回类型：text 示例： gaussdb=# select * from pg_get_serial_sequence('t1', 'c1'); pg_get_serial_sequence ------------------------ public.serial (1 row) pg_sequence_parameters(sequence_oid) 描述：获取指定sequence的参数，包含起始值，最小值和最大值，递增值等。 返回类型：int16, int16, int16, int16, Boolean 示例： gaussdb=# select * from pg_sequence_parameters(16420); start_value | minimum_value | maximum_value | increment | cycle_option -------------+---------------+---------------------+-----------+-------------- 101 | 1 | 9223372036854775807 | 1 | f (1 row)

模式可见性查询函数 每个函数执行检查数据库对象类型的可见性。对于函数和操作符，如果在前面的搜索路径中没有相同的对象名称和参数的数据类型，则此对象是可见的。对于操作符类，则要同时考虑名称和相关索引的访问方法。 所有这些函数都需要使用OID来标识需要检查的对象。如果想通过名称测试对象，则使用OID别名类型（regclass、regtype、regprocedure、regoperator、regconfig或regdictionary）将会很方便。 比如，如果一个表所在的模式在搜索路径中，并且在前面的搜索路径中没有同名的表，则这个表是可见的。它等效于表可以不带明确模式修饰进行引用。比如，要列出所有可见表的名称： 1 gaussdb=# SELECT relname FROM pg_class WHERE pg_table_is_visible(oid); pg_collation_is_visible(collation_oid) 描述：该排序是否在搜索路径中可见。 返回类型：Boolean pg_conversion_is_visible(conversion_oid) 描述：该转换是否在搜索路径中可见。 返回类型：Boolean pg_function_is_visible(function_oid) 描述：该函数是否在搜索路径中可见。 返回类型：Boolean pg_opclass_is_visible(opclass_oid) 描述：该操作符类是否在搜索路径中可见。 返回类型：Boolean pg_operator_is_visible(operator_oid) 描述：该操作符是否在搜索路径中可见。 返回类型：Boolean pg_opfamily_is_visible(opclass_oid) 描述：该操作符族是否在搜索路径中可见。 返回类型：Boolean pg_table_is_visible(table_oid) 描述：该表是否在搜索路径中可见。 返回类型：Boolean pg_ts_config_is_visible(config_oid) 描述：该文本检索配置是否在搜索路径中可见。 返回类型：Boolean pg_ts_dict_is_visible(dict_oid) 描述：该文本检索词典是否在搜索路径中可见。 返回类型：Boolean pg_ts_parser_is_visible(parser_oid) 描述：该文本搜索解析是否在搜索路径中可见。 返回类型：Boolean pg_ts_template_is_visible(template_oid) 描述：该文本检索模板是否在搜索路径中可见。 返回类型：Boolean pg_type_is_visible(type_oid) 描述：该类型（或域）是否在搜索路径中可见。 返回类型：Boolean

访问权限查询函数 DDL类权限ALTER、DROP、COMMENT、INDEX、VACUUM属于所有者固有的权限，隐式拥有。 以下访问权限查询函数仅表示用户是否具有某对象上的某种对象权限，即返回记录在系统表acl字段中的对象权限拥有情况。 has_any_column_privilege(user, table, privilege) 描述：指定用户是否有访问表任何列的权限。 表2 参数类型说明 参数名 合法入参类型 user name, oid table text, oid privilege text 返回类型：Boolean has_any_column_privilege(table, privilege) 描述：当前用户是否有访问表任何列的权限，合法参数类型见表2。 返回类型：Boolean 备注：has_any_column_privilege检查用户是否以特定方式访问表的任何列。其参数可能与has_table_privilege类似，除了访问权限类型必须是SELECT、INSERT、UPDATE、COMMENT或REFEREN CES 的一些组合。 拥有表的表级别权限则隐含的拥有该表每列的列级权限，因此如果与has_table_privilege参数相同，has_any_column_privilege总是返回true。但是如果授予至少一列的列级权限也返回成功。 has_column_privilege(user, table, column, privilege) 描述：指定用户是否有访问列的权限。 表3 参数类型说明 参数名 合法入参类型 user name, oid table text, oid column text, smallint privilege text 返回类型：Boolean has_column_privilege(table, column, privilege) 描述：当前用户是否有访问列的权限，合法参数类型见表3。 返回类型：Boolean 备注：has_column_privilege检查用户是否以特定方式访问一列。其参数类似于has_table_privilege，可以通过列名或属性号添加列。想要的访问权限类型必须是SELECT、INSERT、UPDATE、COMMENT或REFERENCES的一些组合。 拥有表的表级别权限则隐含的拥有该表每列的列级权限。 has_cek_privilege(user, cek, privilege) 描述：指定用户是否有访问列加密密钥CEK的权限。参数说明如下。 表4 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 cek text，oid 列加密密钥 列加密密钥名称或id。 privilege text 权限 USAGE：允许使用指定列加密密钥。 DROP：允许删除指定列加密密钥。 返回类型：Boolean has_cmk_privilege(user, cmk, privilege) 描述：指定用户是否有访问客户端加密主密钥CMK的权限。参数说明如下。 表5 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 cmk text，oid 客户端加密主密钥 客户端加密主密钥名称或id。 privilege text 权限 USAGE：允许使用指定客户端加密主密钥。 DROP：允许删除指定客户端加密主密钥。 返回类型：Boolean has_database_privilege(user, database, privilege) 描述：指定用户是否有访问数据库的权限。参数说明如下。non-PDB下不支持查询PDB相关的信息。PDB下不能使用该函数。 表6 参数类型说明 参数名 合法入参类型 user name, oid database text, oid privilege text 返回类型：Boolean has_database_privilege(database, privilege) 描述：当前用户是否有访问数据库的权限，合法参数类型请参见表6。non-PDB下不支持查询PDB相关的信息。PDB下不能使用该函数。 返回类型：Boolean 备注：has_database_privilege检查用户是否能以在特定方式访问数据库。其参数类似has_table_privilege。访问权限类型必须是CREATE、CONNECT、TEMPORARY、ALTER、DROP、COMMENT或TEMP（等价于TEMPORARY）的一些组合。 has_directory_privilege(user, directory, privilege) 描述：指定用户是否有访问directory的权限。 表7 参数类型说明 参数名 合法入参类型 user name, oid directory text, oid privilege text 返回类型：Boolean has_directory_privilege(directory, privilege) 描述：当前用户是否有访问directory的权限，合法参数类型请参见表7。 返回类型：Boolean has_foreign_data_wrapper_privilege(user, fdw, privilege) 描述：指定用户是否有访问外部数据封装器的权限。 表8 参数类型说明 参数名 合法入参类型 user name, oid fdw text, oid privilege text 返回类型：Boolean has_foreign_data_wrapper_privilege(fdw, privilege) 描述：当前用户是否有访问外部数据封装器的权限。合法参数类型请参见表8。 返回类型：Boolean 备注：has_foreign_data_wrapper_privilege检查用户是否能以特定方式访问外部数据封装器。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_function_privilege(user, function, privilege) 描述：指定用户是否有访问函数的权限。 表9 参数类型说明 参数名 合法入参类型 user name, oid function text, oid privilege text 返回类型：Boolean has_function_privilege(function, privilege) 描述：当前用户是否有访问函数的权限。合法参数类型请参见表9。 返回类型：Boolean 备注：has_function_privilege检查一个用户是否能以指定方式访问一个函数。其参数类似has_table_privilege。使用文本字符而不是OID声明一个函数时，允许输入的类型和regprocedure数据类型一样（请参考对象标识符类型）。访问权限类型必须是EXECUTE、ALTER、DROP或COMMENT。 has_language_privilege(user, language, privilege) 描述：指定用户是否有访问语言的权限。 表10 参数类型说明 参数名 合法入参类型 user name, oid language text, oid privilege text 返回类型：Boolean has_language_privilege(language, privilege) 描述：当前用户是否有访问语言的权限。合法参数类型请参见表10。 返回类型：Boolean 备注：has_language_privilege检查用户是否能以特定方式访问一个过程语言。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_nodegroup_privilege(user, nodegroup, privilege) 描述：检查用户是否有数据库节点访问权限。 返回类型：Boolean 表11 参数类型说明 参数名 合法入参类型 user name, oid nodegroup text, oid privilege text has_nodegroup_privilege(nodegroup, privilege) 描述：检查用户是否有数据库节点访问权限。参数与has_table_privilege类似。访问权限类型必须是USAGE、CREATE、COMPUTE、ALTER或DROP。 返回类型：Boolean has_schema_privilege(user, schema, privilege) 描述：指定用户是否有访问模式的权限。 返回类型：Boolean has_schema_privilege(schema, privilege) 描述：当前用户是否有访问模式的权限。 返回类型：Boolean 备注：has_schema_privilege检查用户是否能以特定方式访问一个模式。其参数类似has_table_privilege。访问权限类型必须是CREATE、USAGE、ALTER、DROP或COMMENT的一些组合。当检查类型里包含CREATE权限且被检查的Schema是用户同名的Schema时，由于同名Schema的特殊约束，必须拥有Schema的OWNER权限，该函数才会返回TRUE。 has_server_privilege(user, server, privilege) 描述：指定用户是否有访问外部服务的权限。 返回类型：Boolean has_server_privilege(server, privilege) 描述：当前用户是否有访问外部服务的权限。 返回类型：Boolean 备注：has_server_privilege检查用户是否能以指定方式访问一个外部服务器。其参数类似has_table_privilege。访问权限类型必须是USAGE、ALTER、DROP或COMMENT之一的值。 has_table_privilege(user, table, privilege) 描述：指定用户是否有访问表的权限。 返回类型：Boolean has_table_privilege(table, privilege) 描述：当前用户是否有访问表的权限。 返回类型：Boolean 备注：has_table_privilege检查用户是否以特定方式访问表。用户可以通过名称或OID（pg_authid.oid）来指定，public表示为PUBLIC角色，或如果缺省该参数，则使用current_user。该表可以通过名称或者OID声明。如果用名称声明，则在必要时可以用模式进行修饰。如果使用文本字符串来声明所希望的权限类型，这个文本字符串必须是SELECT、INSERT、UPDATE、DELETE、TRUNCATE、REFERENCES、TRIGGER、ALTER、DROP、COMMENT、INDEX或VACUUM之一的值。可以给权限类型添加WITH GRANT OPTION，用来测试权限是否拥有授权选项。也可以用逗号分隔列出的多个权限类型，如果拥有任何所列出的权限，则结果为true。 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT has_table_privilege('tpcds.web_site', 'select'); has_table_privilege --------------------- t (1 row) gaussdb=# SELECT has_table_privilege('omm', 'tpcds.web_site', 'select,INSERT WITH GRANT OPTION '); has_table_privilege --------------------- t (1 row) has_tablespace_privilege(user, tablespace, privilege) 描述：指定用户是否有访问表空间的权限。 返回类型：Boolean has_tablespace_privilege(tablespace, privilege) 描述：当前用户是否有访问表空间的权限。 返回类型：Boolean 备注：has_tablespace_privilege检查用户是否能以特定方式访问一个表空间。其参数类似has_table_privilege。访问权限类型必须是CREATE、ALTER、DROP或COMMENT之一的值。 pg_has_role(user, role, privilege) 描述：指定用户是否有角色的权限。 返回类型：Boolean pg_has_role(role, privilege) 描述：当前用户是否有角色的权限。 返回类型：Boolean 备注：pg_has_role检查用户是否能以特定方式访问一个角色。其参数类似has_table_privilege，除了public不能用做用户名。访问权限类型必须是MEMBER或USAGE的一些组合。 MEMBER表示的是角色中的直接或间接成员关系（也就是SET ROLE的权限），而USAGE表示无需通过SET ROLE也直接拥有角色的使用权限。

会话信息函数 SYS_CONTEXT() 描述：返回当前时刻与上下文命名空间'namespace'关联的参数'parameter'的值，该函数功能在第一个入参为'userenv'时与USERENV()功能一致。 当前支持的第二个入参参数： 'current_edition_name'、'current_schema'、'current_sql'、'current_user'、'current_userid'、'database_role'、'ip_address'、'is_apply_server'、'isdba'、'nls_currency'、'nls_date_format'、'nls_date_language'、'server_host'、'service_name'、'session_user'、'session_userid'、'db_name'、'db_unique_name'、'instance'、'instance_name'、'current_edition_id'、'current_schemaid'、'lang'、'language'、'sid' 返回值类型：text 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 SELECT SYS_CONTEXT('userenv','NLS_CURRENCY'); sys_context ------------- $ (1 row) SELECT SYS_CONTEXT('userenv','NLS_DATE_FORMAT'); sys_context --------------- ISO, MDY (1 row) SELECT SYS_CONTEXT('userenv','NLS_DATE_LANGUAGE'); sys_context ------------- en_US.UTF-8 (1 row) USERENV() 描述：返回当前时刻与上下文命名空间'namespace'关联的参数'parameter'的值，该函数功能与SYS_CONTEXT()在第一个入参为'userenv'时功能一致。 当前支持的入参： 'current_edition_name'、'current_schema'、'current_sql'、'current_user'、'current_userid'、'database_role'、'ip_address'、'is_apply_server'、'isdba'、'nls_currency'、'nls_date_format'、'nls_date_language'、'server_host'、'service_name'、'session_user'、'session_userid'、'db_name'、'db_unique_name'、'instance'、'instance_name'、'current_edition_id'、'current_schemaid'、'lang'、'language'、'sid' 当前不支持的入参： 'action'、'is_application_root'、'is_application_pdb'、'audited_cursorid'、'authenticated_identity'、'authentication_data'、'authentication_method'、'cdb_domain'、'cdb_name'、'client_identifier'、'con_id'、'con_name'、'current_sql_length'、'db_domain'、'db_supplemental_log_level'、'dblink_info'、'drain_status'、'entryid'、'enterprise_identity'、'fg_job_id'、'global_uid'、'identification_type'、'is_dg_rolling_upgrade'、'ldap_server_type'、'module'、'network_protocol'、'nls_calendar'、'nls_sort'、'nls_territory'、'oracle_home'、'os_user'、'platform_slash'、'policy_invoker'、'proxy_enterprise_identity'、'proxy_user'、'proxy_userid'、'scheduler_job'、'session_edition_id'、'session_edition_name'、'sessionid'、'statementid'、'terminal'、'unified_audit_sessionid'、'session_default_collation'、'client_info'、'bg_job_id'、'client_program_name'、'current_bind'、'global_context_memory'、'host'、'current_sqln' 返回值类型：text 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 SELECT USERENV('sid'); userenv --------- 955 (1 row) SELECT USERENV('instance'); userenv --------- 14524 (1 row) SELECT USERENV('action'); userenv --------- (1 row) SELECT USERENV('actijj'); ERROR: unrecognized configuration parameter "actijj" CONTEXT: PL/pgSQL function userenv(text) line 114 at RETURN referenced column: userenv 当入参为当前不支持的入参时，则返回NULL；当入参为非法入参时报错。 current_catalog 描述：当前数据库的名称（在标准SQL中称"catalog"）。 返回值类型：name 示例： 1 2 3 4 5 testdb=# SELECT current_catalog; current_database ------------------ testdb (1 row) current_database() 描述：当前数据库的名称。 返回值类型：name 示例： 1 2 3 4 5 testdb=# SELECT current_database(); current_database ------------------ testdb (1 row) current_query() 描述：由客户端提交的当前执行语句（可能包含多个声明）。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT current_query(); current_query ------------------------- SELECT current_query(); (1 row) current_schema[()] 描述：当前模式的名称。 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT current_schema(); current_schema ---------------- public (1 row) 备注：current_schema返回在搜索路径中第一个顺位有效的模式名。（如果搜索路径为空则返回NULL，没有有效的模式名也返回NULL）。如果创建表或者其他命名对象时没有声明目标模式，则将使用这些对象的模式。 current_schemas(Boolean) 描述：搜索路径中的模式名称。 返回值类型：name[] 示例： 1 2 3 4 5 gaussdb=# SELECT current_schemas(true); current_schemas --------------------- {pg_catalog,public} (1 row) 备注： current_schemas(Boolean)返回搜索路径中所有模式名称的数组。布尔选项决定像pg_catalog这样隐含包含的系统模式是否包含在返回的搜索路径中。 搜索路径可以通过运行时设置更改。命令是： 1 SET search_path TO schema [, schema, ...] database() 描述：返回当前的schema的名称。 参数：无 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT database(); database ---------- public (1 row) 此函数仅当sql_compatibility = 'B'，设置参数 b_format_version = '5.7'和参数b_format_dev_version = 's1'时生效。 current_user 描述：当前执行环境下的用户名。 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT current_user; current_user -------------- omm (1 row) 备注：current_user是用于权限检查的用户标识。通常，他表示会话用户，但是可以通过SET ROLE改变他。在函数执行的过程中随着属性SECURITY DEFINER的改变，其值也会改变。 definer_current_user 描述：当前执行环境下的用户名。 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT definer_current_user(); definer_current_user ---------------------- omm (1 row) pg_current_sessionid() 描述：当前执行环境下的会话ID。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT pg_current_sessionid(); pg_current_sessionid ---------------------------- 1579228402.140190434944768 (1 row) 备注：pg_current_sessionid()是用于获取当前执行环境下的会话ID。其组成结构为：时间戳.会话ID，当线程池模式开启（enable_thread_pool=on）时，会话ID为SessionID；而线程池模式关闭时，会话ID为ThreadID。 pg_current_sessid 描述：当前执行环境下的会话ID。 返回值类型：text 示例： gaussdb=# select pg_current_sessid(); pg_current_sessid ------------------- 140308875015936 (1 row) 备注：在线程池模式下获得当前会话的会话ID，非线程池模式下获得当前会话对应的后台线程ID。 pg_current_userid 描述：当前用户ID。 返回值类型：text gaussdb=# SELECT pg_current_userid(); pg_current_userid ------------------- 10 (1 row) working_version_num() 描述：版本序号信息。返回一个系统兼容性有关的版本序号。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT working_version_num(); working_version_num --------------------- 92231 (1 row) tablespace_oid_name(oid) 描述: 根据表空间oid，查找表空间名称。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT tablespace_oid_name(1663); tablespace_oid_name --------------------- pg_default (1 row) inet_client_addr() 描述：连接的远端地址。inet_client_addr返回当前客户端的IP地址。 此函数只有在远程连接模式下有效。 返回值类型：inet 示例： 1 2 3 4 5 gaussdb=# SELECT inet_client_addr(); inet_client_addr ------------------ 10.10.0.50 (1 row) inet_client_port() 描述：连接的远端端口。inet_client_port返回当前客户端的端口号。 此函数只有在远程连接模式下有效。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT inet_client_port(); inet_client_port ------------------ 33143 (1 row) inet_server_addr() 描述：连接的本地地址。inet_server_addr返回服务器接收当前连接用的IP地址。 此函数只有在远程连接模式下有效。 返回值类型：inet 示例： 1 2 3 4 5 gaussdb=# SELECT inet_server_addr(); inet_server_addr ------------------ 10.10.0.13 (1 row) inet_server_port() 描述：连接的本地端口。inet_server_port返回接收当前连接的端口号。如果是通过Unix-domain socket连接的，则所有这些函数都返回NULL。 此函数只有在远程连接模式下有效。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT inet_server_port(); inet_server_port ------------------ 8000 (1 row) pg_backend_pid() 描述：当前会话连接的服务线程的线程ID。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT pg_backend_pid(); pg_backend_pid ----------------- 140229352617744 (1 row) pg_conf_load_time() 描述：配置加载时间。pg_conf_load_time返回最后加载服务器配置文件的时间戳。 返回值类型：timestamp with time zone 示例： 1 2 3 4 5 gaussdb=# SELECT pg_conf_load_time(); pg_conf_load_time ------------------------------ 2017-09-01 16:05:23.89868+08 (1 row) pg_my_temp_schema() 描述：会话的临时模式的OID，不存在则为0。 返回值类型：oid 示例： 1 2 3 4 5 gaussdb=# SELECT pg_my_temp_schema(); pg_my_temp_schema ------------------- 0 (1 row) 备注：pg_my_temp_schema返回当前会话中临时模式的OID，如果不存在（没有创建临时表）的话则返回0。如果给定的OID是其它会话中临时模式的OID，pg_is_other_temp_schema则返回true。 pg_is_other_temp_schema(oid) 描述：是否为另一个会话的临时模式。 返回值类型：Boolean 示例： 1 2 3 4 5 gaussdb=# SELECT pg_is_other_temp_schema(25356); pg_is_other_temp_schema ------------------------- f (1 row) pg_listening_channels() 描述：会话正在侦听的信道名称。 返回值类型：setof text 示例： 1 2 3 4 gaussdb=# SELECT pg_listening_channels(); pg_listening_channels ----------------------- (0 rows) 备注：pg_listening_channels返回当前会话正在侦听的一组信道名称。 pg_postmaster_start_time() 描述：服务器启动时间。pg_postmaster_start_time返回服务器启动时的timestamp with time zone。 返回值类型：timestamp with time zone 示例： 1 2 3 4 5 gaussdb=# SELECT pg_postmaster_start_time(); pg_postmaster_start_time ------------------------------ 2017-08-30 16:02:54.99854+08 (1 row) pg_get_ruledef(rule_oid) 描述：获取规则的CREATE RULE命令。 返回值类型：text 示例： gaussdb=# SELECT * FROM pg_get_ruledef(24828); pg_get_ruledef ------------------------------------------------------------------- CREATE RULE t1_ins AS ON INSERT TO t1 DO INSTEAD INSERT INTO t2 (id) VALUES (new.id); (1 row) sessionid2pid() 描述: 从sessionid中得到pid信息（例如，gs_session_stat中sessid列）。 返回值类型: int8 示例： 1 2 3 4 5 6 gaussdb=# SELECT sessionid2pid(sessid::cstring) FROM gs_session_stat LIMIT 2; sessionid2pid ----------------- 139973107902208 139973107902208 (2 rows) session_context( 'namespace' , 'parameter') 描述：获取并返回指定namespace下参数parameter的值。 返回值类型：VARCHAR 示例： 1 2 3 4 5 gaussdb=# SELECT session_context('USERENV', 'CURRENT_SCHEMA'); session_context ------------------ public (1 row) 备注：当前支持的parameter：current_user、current_schema、client_info、ip_address、sessionid、sid。 pg_trigger_depth() 描述：触发器的嵌套层次。 返回值类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT pg_trigger_depth(); pg_trigger_depth ------------------ 0 (1 row) session_user 描述：会话用户名。 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT session_user; session_user -------------- omm (1 row) 备注：session_user通常是连接当前数据库的初始用户，不过系统管理员可以用SET SESSION AUTHORIZATION修改这个设置。 user 描述：等价于current_user。 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT user; current_user -------------- omm (1 row) getpgusername() 描述：获取数据库用户名。 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT getpgusername(); getpgusername --------------- GaussDB_userna (1 row) getdatabaseencoding() 描述：获取数据库编码方式。 返回值类型：name 示例： 1 2 3 4 5 gaussdb=# SELECT getdatabaseencoding(); getdatabaseencoding --------------------- SQL_ASCII (1 row) version() 描述：版本信息。version返回一个描述服务器版本信息的字符串。 返回值类型：text 示例： gaussdb=# SELECT version(); version ------------------------------------------------------------------------------------------------------------------------------------------------------------- gaussdb (GaussDB Kernel XXX.X.XXX build fab4f5ea) compiled at 2021-10-24 11:58:22 commit 3086 last mr 6592 release (1 row) opengauss_version() 描述：openGauss版本信息。 返回值类型：text 使用示例如下，查询结果中的x.x.x请以实际输出为准： 1 2 3 4 5 gaussdb=# SELECT opengauss_version(); opengauss_version ------------------- x.x.x (1 row) gs_deployment() 描述：当前系统的部署形态信息。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT gs_deployment(); gs_deployment --------------------- BusinessCentralized (1 row) get_hostname() 描述：返回当前节点的hostname。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT get_hostname(); get_hostname -------------- linux-user (1 row) get_nodename() 描述：返回当前节点的名字。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT get_nodename(); get_nodename -------------- datanode1 (1 row) get_nodeinfo(text) 描述：根据检索的属性返回对应的节点信息的值，可检索属性目前包括：node_name、node_type。 返回值类型：text 示例： 1 2 3 4 5 6 7 8 9 10 gaussdb=# SELECT get_nodeinfo('node_type'); get_nodeinfo -------------- CEN_DN (1 row) gaussdb=# SELECT get_nodeinfo('node_name'); get_nodeinfo -------------- datanode1 (1 row) get_schema_oid(cstring) 描述：返回查询schema的oid。 返回值类型：oid 示例： 1 2 3 4 5 gaussdb=# SELECT get_schema_oid('public'); get_schema_oid ---------------- 2200 (1 row) get_client_info() 描述：返回客户端信息。多租场景下，non-PDB调用该函数时返回全部信息，PDB调用该函数时仅返回该PDB相关信息。 返回值类型：record pv_session_memory_detail() 描述：返回会话的内存使用情况，以MemoryContext节点来统计。多租场景下，non-PDB调用该函数时返回全局统计信息，PDB调用该函数时仅返回该PDB的统计信息。 返回值类型：record 表1 返回值说明 名称 类型 描述 sessid text 关闭线程池（enable_thread_pool = off）时该字段表示线程启动时间+session标识（字符串信息为timestamp.sessionid）。 开启线程池（enable_thread_pool = on）时，内存上下文是线程级别的，则对应的该字段表示线程启动时间+线程标识（字符串信息为timestamp.threadid），内存上下文是session级别的，则对应的该字段表示线程启动时间+session标识（字符串信息为timestamp.sessionid）。 threadid bigint 会话绑定的线程标识。 contextname text 内存上下文名称。 level smallint 当前上下文在整体内存上下文中的层级。 parent text 父内存上下文名称。 totalsize bigint 当前内存上下文的内存总数，单位Byte。 freesize bigint 当前内存上下文中已释放的内存总数，单位Byte。 usedsize bigint 当前内存上下文中已使用的内存总数，单位Byte；“TempSmallContextGroup”内存上下文中该字段含义为统计计数。