华为云用户手册

Global SysCache特性函数 gs_gsc_table_detail(database_id default NULL, rel_id default NULL) 描述：查看数据库里全局系统缓存的表元数据。调用该函数的用户需要具有SYSADMIN权限。 参数：指定需要查看全局系统缓存的数据库和表，database_id默认值NULL或者-1表示所有的数据库，0表示共享表，其他数字表示指定数据库及共享表，rel_id表示指定表的oid，默认值NULL或者-1表示所有的表，其他值表示指定的表，database_id不存在会报错，rel_id不存在结果为空。 返回值类型：Tuple 示例: select * from gs_gsc_table_detail(-1) limit 1; database_oid | database_name | reloid | relname | relnamespace | reltype | reloftype | relowner | relam | relfilenode | reltablespace | relhasindex | relisshared | relkind | relnatts | relhasoids | relhaspkey | parttype | tdhasuids | attnames | extinfo --------------+---------------+--------+-------------------------+--------------+---------+-----------+----------+-------+-------------+---------------+-------------+-------------+---------+----------+------------+------------+----------+-----------+-----------+--------- 0 | | 2676 | pg_authid_rolname_index | 11 | 0 | 0 | 10 | 403 | 0 | 1664 | f | t | i | 1 | f | f | n | f | 'rolname' | (1 row) gs_gsc_catalog_detail(database_id default NULL, rel_id default NULL) 描述：查看数据库里全局系统缓存的系统表行信息。调用该函数的用户需要具有SYSADMIN权限。 参数：指定需要查看全局系统缓存的数据库和表，database_id默认值NULL或者-1表示所有的数据库，0表示共享表，其他数字表示指定数据库及共享表，rel_id表示指定表的id，仅包含所有有系统缓存的系统表，默认值NULL或者-1表示所有的表，其他值表示指定的表，database_id不存在会报错，rel_id不存在结果为空。 返回值类型：Tuple 示例： --首先通过pg_database获取特定数据库的oid，查询语句一般为：SELECT oid, * FROM pg_database; --返回元组中通过datname列找到对应的oid列的值，然后执行如下查询，示例获取的oid为16574。 gaussdb=# select * from gs_gsc_catalog_detail(16574, 1260); database_id | database_name | rel_id | rel_name | cache_id | self | ctid | infomask | infomask2 | hash_value | refcount -------------+---------------+--------+-----------+----------+--------+--------+----------+-----------+------------+---------- 0 | | 1260 | pg_authid | 10 | (0, 9) | (0, 9) | 10507 | 26 | 531311568 | 10 0 | | 1260 | pg_authid | 11 | (0, 4) | (0, 4) | 2313 | 26 | 365368336 | 1 0 | | 1260 | pg_authid | 11 | (0, 9) | (0, 9) | 10507 | 26 | 3911517328 | 10 0 | | 1260 | pg_authid | 11 | (0, 7) | (0, 7) | 2313 | 26 | 1317799983 | 1 0 | | 1260 | pg_authid | 11 | (0, 5) | (0, 5) | 2313 | 26 | 3664347448 | 1 0 | | 1260 | pg_authid | 11 | (0, 1) | (0, 1) | 2313 | 26 | 276477273 | 1 0 | | 1260 | pg_authid | 11 | (0, 3) | (0, 3) | 2313 | 26 | 2465837659 | 1 0 | | 1260 | pg_authid | 11 | (0, 8) | (0, 8) | 2313 | 26 | 3205288035 | 1 0 | | 1260 | pg_authid | 11 | (0, 6) | (0, 6) | 2313 | 26 | 131811687 | 1 0 | | 1260 | pg_authid | 11 | (0, 2) | (0, 2) | 2313 | 26 | 1226484587 | 1 (10 rows) gs_gsc_clean(database_id default NULL) 描述：清理global syscache的缓存，需要注意，正在使用中的数据不会被清理。调用该函数的用户需要具有SYSADMIN权限。 参数：指定需要清理全局系统缓存的数据库，默认值NULL或者-1表示强制清理所有的数据库全局系统缓存，0表示只淘汰共享表的全局系统缓存，其他数字表示淘汰指定数据库以及共享表的全局系统缓存，database_id不存在会报错。 返回值类型：bool 示例： gaussdb=# select * from gs_gsc_clean(); gs_gsc_clean -------------- t (1 row) gs_gsc_dbstat_info(database_id default NULL) 描述：获取本地节点的GSC的内存统计信息，包括tuple、relation、partition的缓存查询，命中，加载、失效、占用空间信息，DB级别的淘汰信息，线程引用信息，内存占用信息。可以用于定位性能问题，例如当发现hits/searches数组远小于1时，可能是global_syscache_threshold设置太小，导致查询命中率下降。调用该函数的用户需要具有SYSADMIN权限。 参数：指定需要查看的数据库全局系统缓存统计信息，NULL或者-1表示查看所有的数据库，0表示只查看共享表信息，其他数字表示查看指定的数据库和共享表的信息。不合法的输入值，database_id不存在会报错。 返回值类型：Tuple 示例： gaussdb=# select * from gs_gsc_dbstat_info(); database_id | database_name | tup_searches | tup_hits | tup_miss | tup_count | tup_dead | tup_memory | rel_searches | rel_hits | rel_mis s | rel_count | rel_dead | rel_memory | part_searches | part_hits | part_miss | part_count | part_dead | part_memory | total_memory | swa pout_count | refcount -------------+---------------+--------------+----------+----------+-----------+----------+------------+--------------+----------+-------- --+-----------+----------+------------+---------------+-----------+-----------+------------+-----------+-------------+--------------+---- -----------+---------- 0 | | 300 | 235 | 31 | 22 | 2 | 9752 | 598 | 108 | 1 8 | 18 | 0 | 77720 | 0 | 0 | 0 | 0 | 0 | 0 | 752912 | 0 | 0 16574 | testdb | 3368 | 2289 | 329 | 273 | 0 | 92593 | 1113 | 524 | 4 8 | 48 | 0 | 340456 | 0 | 0 | 0 | 0 | 0 | 0 | 4124792 | 0 | 10 (2 rows) 父主题： 函数和操作符

内部函数 GaussDB 中下列函数使用了内部数据类型，用户无法直接调用，在此章节列出。 选择率计算函数 areajoinsel areasel arraycontjoinsel arraycontsel contjoinsel contsel eqjoinsel eqsel iclikejoinsel iclikesel icnlikejoinsel icnlikesel icregexeqjoinsel icregexeqsel icregexnejoinsel icregexnesel likejoinsel likesel neqjoinsel neqsel nlikejoinsel nlikesel positionjoinsel positionsel regexeqjoinsel regexeqsel regexnejoinsel regexnesel scalargtjoinsel scalargtsel scalarltjoinsel scalarltsel tsmatchjoinsel tsmatchsel - 统计信息收集函数 array_typanalyze range_typanalyze ts_typanalyze local_rto_stat standby_statement_history_internal - 排序内部功能函数 bpchar_sortsupport bytea_sortsupport date_sortsupport numeric_sortsupport timestamp_sortsupport 内部类型处理函数 abstimerecv euc_jis_2004_to_utf8 int2recv line_recv oidvectorrecv_extend tidrecv utf8_to_koi8u anyarray_recv euc_jp_to_mic int2vectorrecv lseg_recv path_recv time_recv utf8_to_shift_jis_2004 array_recv euc_jp_to_sjis int4recv macaddr_recv pg_node_tree_recv time_transform utf8_to_sjis ascii_to_mic euc_jp_to_utf8 int8recv mic_to_ascii point_recv timestamp_recv utf8_to_uhc ascii_to_utf8 euc_kr_to_mic internal_out mic_to_big5 poly_recv timestamp_transform utf8_to_win big5_to_euc_tw euc_kr_to_utf8 interval_recv mic_to_euc_cn pound_nexttoken timestamptz_recv uuid_recv big5_to_mic euc_tw_to_big5 interval_transform mic_to_euc_jp prsd_nexttoken timetz_recv varbit_recv big5_to_utf8 euc_tw_to_mic iso_to_koi8r mic_to_euc_kr range_recv tintervalrecv varbit_transform bit_recv euc_tw_to_utf8 iso_to_mic mic_to_euc_tw rawrecv tsqueryrecv varchar_transform boolrecv float4recv iso_to_win1251 mic_to_iso record_recv tsvectorrecv varcharrecv box_recv float8recv iso_to_win866 mic_to_koi8r regclassrecv txid_snapshot_recv void_recv bpcharrecv gb18030_to_utf8 iso8859_1_to_utf8 mic_to_latin1 regconfigrecv uhc_to_utf8 win_to_utf8 btoidsortsupport gbk_to_utf8 iso8859_to_utf8 mic_to_latin2 regdictionaryrecv unknownrecv win1250_to_latin2 bytearecv - johab_to_utf8 mic_to_latin3 regoperatorrecv utf8_to_ascii win1250_to_mic byteawithoutorderwithequalcolrecv gtsvector_compress json_recv mic_to_latin4 regoperrecv utf8_to_big5 win1251_to_iso cash_recv gtsvector_consistent koi8r_to_iso mic_to_sjis regprocedurerecv utf8_to_euc_cn win1251_to_koi8r charrecv gtsvector_decompress koi8r_to_mic mic_to_win1250 regprocrecv utf8_to_euc_jis_2004 win1251_to_mic cidr_recv gtsvector_penalty koi8r_to_utf8 mic_to_win1251 regtyperecv utf8_to_euc_jp win1251_to_win866 cidrecv gtsvector_picksplit koi8r_to_win1251 mic_to_win866 reltimerecv utf8_to_euc_kr win866_to_iso circle_recv gtsvector_same koi8r_to_win866 namerecv shift_jis_2004_to_euc_jis_2004 utf8_to_euc_tw win866_to_koi8r cstring_recv gtsvector_union koi8u_to_utf8 ngram_nexttoken shift_jis_2004_to_utf8 utf8_to_gb18030 win866_to_mic date_recv hll_recv latin1_to_mic numeric_recv sjis_to_euc_jp utf8_to_gbk win866_to_win1251 domain_recv hll_trans_recv latin2_to_mic numeric_transform sjis_to_mic utf8_to_iso8859 xidrecv euc_cn_to_mic - latin2_to_win1250 nvarchar2recv sjis_to_utf8 utf8_to_iso8859_1 xidrecv4 euc_cn_to_utf8 inet_recv latin3_to_mic oidrecv smalldatetime_recv utf8_to_johab xml_recv euc_jis_2004_to_shift_jis_2004 int1recv latin4_to_mic oidvectorrecv textrecv utf8_to_koi8r - i16toi1 int16 int16_bool int16eq int16div int16ge int16gt int16in int16le int16lt int16mi int16mul int16ne int16out int16pl int16recv int16send numeric_bool int2vectorin_extend int2vectorout_extend int2vectorrecv_extend int2vectorsend_extend tdigest_in tdigest_merge tdigest_merge_to_one tdigest_mergep tdigest_out - anyset_out btint2setcmp btint4setcmp btint8setcmp btsetcmp btsetint2cmp btsetint4cmp btsetint8cmp btsetsortsupport float4 float8 hashsetint hashsettext int2 int2seteq int2setge int2setgt int2setle int2setlt int2setne int4 int4seteq int4setge int4setgt int4setle int4setlt int4setne int8 int8seteq int8setge int8setgt int8setle int8setlt int8setne set set_in set_out set_recv set_send seteq setge setgt setint2eq setint2ge setint2gt setint2le setint2lt setint2ne setint4eq setint4ge setint4gt setint4le setint4lt setint4ne setint8eq setint8ge setint8gt setint8le setint8lt setint8ne setle setlt setne settexteq settextge settextgt settextle settextlt settextne settobpchar settonumber settonvarchar2 settotext settovarchar textseteq textsetge textsetgt textsetle textsetlt textsetne gb18030_2022_to_utf8 utf8_to_gb18030_2022 array_to_nesttable array_to_indexby_int_table 聚合操作内部函数 array_agg_finalfn array_agg_transfn bytea_string_agg_finalfn bytea_string_agg_transfn date_list_agg_noarg2_transfn date_list_agg_transfn float4_list_agg_noarg2_transfn float4_list_agg_transfn float8_list_agg_noarg2_transfn float8_list_agg_transfn int2_list_agg_noarg2_transfn int2_list_agg_transfn int4_list_agg_noarg2_transfn int4_list_agg_transfn int8_list_agg_noarg2_transfn int8_list_agg_transfn interval_list_agg_noarg2_transfn interval_list_agg_transfn list_agg_finalfn list_agg_noarg2_transfn list_agg_transfn median_float8_finalfn median_interval_finalfn median_transfn mode_final numeric_list_agg_noarg2_transfn numeric_list_agg_transfn ordered_set_transition percentile_cont_float8_final percentile_cont_interval_final string_agg_finalfn string_agg_transfn timestamp_list_agg_noarg2_transfn timestamp_list_agg_transfn timestamptz_list_agg_noarg2_transfn timestamptz_list_agg_transfn checksumtext_agg_transfn - - - - - 哈希内部功能函数 hashbeginscan hashbuild hashbuildempty hashbulkdelete hashcostestimate hashendscan hashgetbitmap hashgettuple hashinsert hashmarkpos hashmerge hashrescan hashrestrpos hashvacuumcleanup hashvarlena - - - - - - Btree索引内部功能函数 cbtreebuild cbtreecanreturn cbtreecostestimate cbtreegetbitmap cbtreegettuple btbeginscan btbuild btbuildempty btbulkdelete btcanreturn btcostestimate btendscan btfloat4sortsupport btfloat8sortsupport btgetbitmap btgettuple btinsert btint2sortsupport btint4sortsupport btint8sortsupport btmarkpos btmerge btnamesortsupport btrescan btrestrpos bttextsortsupport btvacuumcleanup cbtreeoptions Psort索引内部函数 psortbuild psortcanreturn psortcostestimate psortgetbitmap psortgettuple Ubtree索引内部函数 ubtbeginscan ubtbuild ubtbuildempty ubtbulkdelete ubtcanreturn ubtcostestimate ubtendscan ubtgetbitmap ubtgettuple ubtinsert ubtmarkpos ubtmerge ubtoptions ubtrescan ubtrestrpos ubtvacuumcleanup - - - - plpgsql内部函数 plpgsql_inline_handler 集合相关内部函数 array_indexby_delete array_indexby_length array_integer_deleteidx array_integer_exists array_integer_first array_integer_last array_integer_next array_integer_prior array_varchar_deleteidx array_varchar_exists array_varchar_first array_varchar_last array_varchar_next array_varchar_prior - - - - 外表相关内部函数 dist_fdw_handler roach_handler streaming_fdw_handler dist_fdw_validator file_fdw_handler file_fdw_validator log_fdw_handler dblink_fdw_handler dblink_fdw_validator - - - - - 主DN远程读取备DN数据页辅助函数 gs_read_block_from_remote用于读取表文件的页面。默认只有初始化用户可以查看，其余用户需要赋权后才可以使用。 主DN远程读取备DN数据文件辅助函数 gs_read_file_from_remote用于读取指定的文件。gs_repair_file利用gs_read_file_size_from_remote函数获取文件大小后，依赖这个函数将远端文件逐段读取。默认只有初始化用户可以查看，其余用户需要赋权后才可以使用。 gs_read_file_size_from_remote用于读取指定文件的大小。gs_repair_file函数修复文件时，要先获取远端关于这个文件的大小，用于校验本地文件缺失的文件信息，然后将缺失的文件逐个修复。默认只有初始化用户可以查看，其余用户需要赋权后才可以使用。 以备DN增量重建其他备或级联备DN辅助函数 gs_standby_incremental_filemap_create用于创建备DN增量重建临时filemap文件，用于存储当次增量重建需传输的数据路径与大小。只有初始化用户且application为gs_rewind时可以调用。 gs_standby_incremental_filemap_insert用于向指定临时filemap文件中插入文件信息，指定文件的路径、传输起始点、单次传输数据长度和rebuild标志位。只有初始化用户且application为gs_rewind时可以调用。 gs_standby_incremental_filemap_execute用于获取指定临时filemap文件中存储的文件信息并删除指定filemap，用于备DN增量重建的数据传输。只有初始化用户且application为gs_rewind时可以调用。 AI特性函数 create_snapshot create_snapshot_internal prepare_snapshot_internal prepare_snapshot manage_snapshot_internal archive_snapshot publish_snapshot purge_snapshot_internal purge_snapshot sample_snapshot - - - - PKG_SERVICE函数 isubmit_on_nodes submit_on_nodes - - - - - 其他函数 to_tsvector_for_batch value_of_percentile disable_conn bind_variable job_update job_cancel job_finish similar_escape table_skewness （不可用） timetz_text time_text reltime_text abstime_text _pg_keysequal analyze_query (不可用） analyze_workload （不可用） ssign_table_type gs_comm_proxy_thread_status gs_txid_oldestxmin - pg_stat_segment_space_info remote_segment_space_info set_cost_params set_weight_params start_collect_workload tdigest_in tdigest_merge tdigest_merge_to_one tdigest_mergep tdigest_out - - - - - 视图相关引用函数 adm_hist_sqlstat_func adm_hist_sqlstat_idlog_func adm_hist_sqltext_func gs_txn_snapshot系统表维护函数 gs_insert_delete_txn_snapshot用于GTM-Lite模式下维护全局各节点gs_txn_snapshot系统表，只有系统管理员用户才能调用，当前版本调用该函数将返回f，无实际操作。 xmltype类型相关函数 isschemavalid 父主题： 函数和操作符

层次递归查询函数 层次递归查询语句中可使用以下函数返回连接路径上的相关信息。 sys_connect_by_path(col, separator) 描述：仅在层次递归查询中适用，用于返回从根节点到当前行的连接路径。 参数col为在路径中显示的列的名称，只支持类型为CHAR/VARCHAR/NVARCHAR2/TEXT的列，参数separator为路径节点之间的分隔符。 返回值类型：text 示例： 1 2 3 4 5 6 7 8 gaussdb=# select *, sys_connect_by_path(name, '-') from connect_table start with id = 1 connect by prior id = pid; id | pid | name | sys_connect_by_path ----+-----+------+--------------------- 1 | 0 | a | -a 2 | 1 | b | -a-b 4 | 1 | d | -a-d 3 | 2 | c | -a-b-c (4 rows) connect_by_root(col) 描述：仅在层次递归查询中适用，用于返回当前行最顶层父亲行中某列的值。 参数col为输出列的名称。仅支持如下类型的列：INT8、INT1、INT2、OID、INT4、BOOL、CHAR、NAME、FLOAT4、FLOAT8、ABSTIME、RELTIME、DATE、CASH、TIME、TIMESTAMP、TIMESTAMPTZ、SMALLDATETIME、UUID、INTERVAL、TIMETZ、INT2VECTOR、CLOB、NVARCHAR2、VARCHAR、TEXT、VECTOR、BPCHAR、RAW、BYTEA、NUMERIC、XID、CID以及TID，且通过强制类型转换为上述类型的操作无法绕开白名单限制，如：connect_by_root(col::text)（其中col不是上述白名单中的类型）。 返回值类型：即为所指定列col的数据类型。 示例： 1 2 3 4 5 6 7 8 gaussdb=# select *, connect_by_root(name) from connect_table start with id = 1 connect by prior id = pid; id | pid | name | connect_by_root ----+-----+------+----------------- 1 | 0 | a | a 2 | 1 | b | a 4 | 1 | d | a 3 | 2 | c | a (4 rows) 父主题： 函数和操作符

动态数据脱敏函数 该函数为内部功能调用函数。 creditcardmasking(col text, letter char default 'x') 描述：将col字符串后四位之前的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from creditcardmasking('4511-8454-2178-6551', 'x'); creditcardmasking --------------------- xxxx-xxxx-xxxx-6551 (1 row) basicemailmasking(col text, letter char default 'x') 描述：将col字符串中第一个'@'之前的字符使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from basicemailmasking('Alex15@huawei.com','x'); basicemailmasking ------------------- xxxxxx@huawei.com (1 row) fullemailmasking(col text, letter char default 'x') 描述：将col字符串中出现最后一个'.'之前的字符(除'@'外)使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from fullemailmasking('Alex15@huawei.com','x'); fullemailmasking ------------------- xxxxxx@xxxxxx.com (1 row) alldigitsmasking(col text, letter char default '0') 描述：将col字符串中出现的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from alldigitsmasking('abcdef 123456 ui 323 jsfd321 j3k2l3','0'); alldigitsmasking ------------------------------------- abcdef 000000 ui 000 jsfd000 j0k0l0 (1 row) shufflemasking(col text) 描述：将col字符串中的字符乱序排列。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from shufflemasking('abcdef 123456 ui 323 jsfd321 j3k2l3'); shufflemasking ------------------------------------- 22dc3316 3jb af4e3f135sjl ud2 k32i (1 row) randommasking(col text) 描述：将col字符串中的字符随机化。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from randommasking('abcdef'); randommasking --------------- 63d8dc (1 row) regexpmasking(col text, reg text, replace_text text, pos INTEGER default 0, reg_len INTEGER default -1) 描述：将col字符串使用正则表达式替换。 参数：待替换的字符串、正则表达式、替换的起始位置、替换长度。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from regexpmasking('abcdef 123456 ui 323 jsfd321 j3k2l3','[\d+]','0'); regexpmasking ------------------------------------- abcdef 000000 ui 000 jsfd000 j0k0l0 (1 row) 父主题： 函数和操作符

故障注入系统函数 gs_fault_inject(int64, text, text, text, text, text) 描述：该函数不能调用，调用时会报WARNING信息："unsupported fault injection"，并不会对数据库产生任何影响和改变。 参数：int64注入故障类型（0：C LOG 扩展页面，1：读取CLOG页面，2：强制死锁）。 text第二个入参在第一入参为2的模式下若为“1”则死锁，其余不死锁；第二个入参在第一入参为0，1时，表示CLOG开始扩展或读取的起始页面号。 text第三个入参在第一入参为0，1时，表示扩展或读取的页面个数。 text第四到六入参为预留参数。 返回值类型：int64 父主题： 函数和操作符

全局临时表函数 pg_get_gtt_relstats(relOid) 描述：显示当前会话指定的全局临时表的基本信息。 参数：全局临时表的OID。 返回值类型：record 示例: gaussdb=# select * from pg_get_gtt_relstats(74069); relfilenode | relpages | reltuples | relallvisible | relfrozenxid | relminmxid -------------+----------+-----------+---------------+--------------+------------ 74069 | 58 | 13000 | 0 | 11151 | 0 (1 row) pg_get_gtt_statistics(relOid, attnum, ''::text) 描述：显示当前会话指定的全局临时表的单列统计信息。 参数：全局临时表的OID和属性attnum。 返回值类型：record 示例: gaussdb=# select * from pg_get_gtt_statistics(74069,1,''::text); starelid | starelkind | staattnum | stainherit | stanullfrac | stawidth | stadistinct | stakind1 | stakind2 | stakind3 | stakind4 | stakind5 | staop1 | staop2 | staop3 | staop4 | staop5 | stanumbers1 | stanumbers2 | stanumbers3 | stanu mbers4 | stanumbers5 | stavalues1 | stavalues2 | stavalues3 | stavalues4 | stavalues5 | stadndistinct | staextinfo ----------+------------+-----------+------------+-------------+----------+-------------+----------+----------+----------+----------+----------+--------+--------+--------+--------+--------+-------------+-------------+-------------+------ -------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------+------------+------------+------------+------------+---------------+------------ 74069 | c | 1 | f | 0 | 4 | -1 | 2 | 3 | 0 | 0 | 0 | 97 | 97 | 0 | 0 | 0 | | {1} | | | | {1,130,260,390,520,650,780,910,1040,1170,1300,1430,1560,1690,1820,1950,2080,2210,2340,2470,2600,2730,2860,2990,3120,3250,3380,3510,3640,3770,3900,4030,4160,4290,4420,4550,4680,4810,4940,5070,5200,5330,5460,5590,57 20,5850,5980,6110,6240,6370,6500,6630,6760,6890,7020,7150,7280,7410,7540,7670,7800,7930,8060,8190,8320,8450,8580,8710,8840,8970,9100,9230,9360,9490,9620,9750,9880,10010,10140,10270,10400,10530,10660,10790,10920,11050,11180,11310,11440,1 1570,11700,11830,11960,12090,12220,12350,12480,12610,12740,12870,13000} | | | | | 0 | (1 row) pg_gtt_attached_pid(relOid) 描述：显示正在使用指定全局临时表的所有线程pid和会话ID。当线程池开启时，如果正在使用全局临时表的会话为detach状态，pid会显示为0，sessionid为会话的ID。 参数：全局临时表的OID。 返回值类型：record 示例: gaussdb=# select * from pg_gtt_attached_pid(74069); relid | pid | sessionid -------+-----------------+----------------- 74069 | 139648170456832 | 139648170456832 74069 | 139648123270912 | 139648123270912 (2 rows) dbe_perf.get_global_full_sql_by_timestamp(start_timestamp timestamp, end_timestamp timestamp) 描述：获取实例级的全量SQL(Full SQL)信息。 返回值类型：record 表1 dbe_perf.get_global_full_sql_by_timestamp参数说明 参数 类型 描述 start_timestamp timestamp SQL启动时间范围的开始时间点。 end_timestamp timestamp SQL启动时间范围的结束时间点。 dbe_perf.get_global_slow_sql_by_timestamp(start_timestamp timestamp, end_timestamp timestamp) 描述：获取实例级的慢SQL(Slow SQL)信息。 返回值类型：record 表2 dbe_perf.get_global_slow_sql_by_timestamp参数说明 参数 类型 描述 start_timestamp timestamp SQL启动时间范围的开始时间点。 end_timestamp timestamp SQL启动时间范围的结束时间点。 statement_detail_decode(detail text, format text, pretty bool) 解析全量/慢SQL语句中的details字段的信息。 表3 statement_detail_decode参数说明 参数 类型 描述 detail text SQL语句产生的事件的集合(不可读)。 format text 解析输出格式，取值为plaintext或json。 pretty bool 当format为plaintext时，是否以优雅的格式展示： true表示通过“\n”分隔事件。 false表示通过“,”分隔事件。 pg_list_gtt_relfrozenxids() 描述：显示各会话的冻结事务xid。 pid=0的行，显示所有会话中最老的冻结事务xid。 参数：无。 返回值类型：record 示例: gaussdb=# select * from pg_list_gtt_relfrozenxids(); pid | relfrozenxid -----------------+-------------- 139648123270912 | 11151 139648170456832 | 11155 0 | 11151 (3 rows) 父主题： 函数和操作符

提示信息函数 report_application_error() 描述：PL执行过程中，可以使用此函数来抛ERROR。 返回值类型：void 表1 report_application_error参数说明 参数 类型 说明 是否必选 log text error消息的内容。 是 code int4 error消息对应的error code，范围为：-20999 ~ -20000。 否 父主题： 函数和操作符

HashFunc函数 ora_hash(expression,[seed]) 描述：用于计算给定表达式的哈希值。expression:可输入的类型覆盖字符串，时间类型，数字类型，根据expression进行计算哈希值。seed:可选参数，一个int8值，可以对同一个输入值返回不同的结果, 用于计算带随机数的hash值。 返回类型：int8类型的哈希值。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 gaussdb=# select ora_hash(123); ora_hash ------------ 4089882933 (1 row) gaussdb=# select ora_hash('123'); ora_hash ------------ 2034089965 (1 row) gaussdb=# select ora_hash('sample'); ora_hash ------------ 1573005290 (1 row) gaussdb=# select ora_hash(to_date('2012-1-2','yyyy-mm-dd')); ora_hash ------------ 1171473495 (1 row) gaussdb=# select ora_hash(123,234); ora_hash ------------ -9089505052966355682 (1 row) gaussdb=# select ora_hash('123',234); ora_hash ------------ 5742589019960764616 (1 row) gaussdb=# select ora_hash('sample',234); ora_hash ------------ -1747984408055821656 (1 row) gaussdb=# select ora_hash(to_date('2012-1-2','yyyy-mm-dd'),234); ora_hash ------------ -3306025179710572679 (1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下才能生效。 hash_array(anyarray) 描述：数组哈希，将数组的元素通过哈希函数得到结果，并返回合并结果。 参数：数据类型为anyarray。 返回值类型：integer 示例： 1 2 3 4 5 gaussdb=# select hash_array(ARRAY[[1,2,3],[1,2,3]]); hash_array ------------ -382888479 (1 row) hash_numeric(numeric) 描述：计算Numeric类型的数据的hash值。 参数：Numeric类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 gaussdb=# select hash_numeric(30); hash_numeric -------------- -282860963 (1 row) hash_range(anyrange) 描述：计算range的哈希值。 参数：anyrange类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 gaussdb=# select hash_range(numrange(1.1,2.2)); hash_range ------------ 683508754 (1 row) hashbpchar(character) 描述：计算bpchar的哈希值。 参数：character类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 gaussdb=# select hashbpchar('hello'); hashbpchar ------------- -1870292951 (1 row) hashchar(char) 描述：char和布尔数据转换为哈希值。 参数：char类型的数据或者bool类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# select hashbpchar('hello'); hashbpchar ------------- -1870292951 (1 row) gaussdb=# select hashchar('true'); hashchar ------------ 1686226652 (1 row) hashenum(anyenum) 描述：枚举类型转哈希值。 参数：anyenum类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 6 7 gaussdb=# CREATE TYPE b1 AS ENUM('good', 'bad', 'ugly'); CREATE TYPE gaussdb=# call hashenum('good'::b1); hashenum ------------ 1821213359 (1 row) hashfloat4(real) 描述：float4转哈希值。 参数：real类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 gaussdb=# select hashfloat4(12.1234); hashfloat4 ------------ 1398514061 (1 row) hashfloat8(double precision) 描述：float8转哈希值。 参数：double precision类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 gaussdb=# select hashfloat8(123456.1234); hashfloat8 ------------ 1673665593 (1 row) hashinet(inet) 描述：inet / cidr转哈希值。 参数：inet类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 gaussdb=# select hashinet('127.0.0.1'::inet); hashinet ------------- -1435793109 (1 row) hashint1(tinyint) 描述：INT1转哈希值。 参数：tinyint类型的数据。 返回值类型：uint32 示例： 1 2 3 4 5 gaussdb=# select hashint1(20); hashint1 ------------- -2014641093 (1 row) hashint2(smallint) 描述：INT2转哈希值。 参数：smallint类型的数据。 返回值类型：uint32 示例： gaussdb=# select hashint2(20000); hashint2 ------------ -863179081 (1 row) 父主题： 函数和操作符

触发器函数 pg_get_triggerdef(oid) 描述：获取触发器的定义信息。 参数：待查触发器的OID。 返回值类型：text 示例: -- 创建表tri_insert。 gaussdb=# CREATE TABLE tri_insert (a int, b int); CREATE TABLE -- 创建函数trigger_func。 gaussdb=# CREATE FUNCTION trigger_func() RETURNS trigger LANGUAGE plpgsql AS ' gaussdb'# BEGIN gaussdb'# RAISE NOTICE ''trigger_func(%) called: action = %, when = %, level = %'', TG_ARGV[0], TG_OP, TG_WHEN, TG_LEVEL; gaussdb'# RETURN NULL; gaussdb'# END;'; CREATE FUNCTION -- 创建触发器before_ins_stmt_trig。 gaussdb=# CREATE TRIGGER before_ins_stmt_trig BEFORE INSERT ON tri_insert gaussdb-# FOR EACH STATEMENT EXECUTE PROCEDURE trigger_func('before_ins_stmt'); CREATE TRIGGER -- 创建触发器after_ins_when_trig。 gaussdb=# CREATE TRIGGER after_ins_when_trig AFTER INSERT ON tri_insert gaussdb-# FOR EACH ROW WHEN (new.a IS NOT NULL) EXECUTE PROCEDURE trigger_func('after_ins_when'); CREATE TRIGGER -- 查看表tri_insert的触发器定义信息。 gaussdb=# SELECT pg_get_triggerdef(oid) FROM pg_trigger WHERE tgrelid = 'tri_insert'::regclass; pg_get_triggerdef -------------------------------------------------------------------------------------------------------------------------------------------------------- CREATE TRIGGER before_ins_stmt_trig BEFORE INSERT ON tri_insert FOR EACH STATEMENT EXECUTE PROCEDURE trigger_func('before_ins_stmt') CREATE TRIGGER after_ins_when_trig AFTER INSERT ON tri_insert FOR EACH ROW WHEN ((new.a IS NOT NULL)) EXECUTE PROCEDURE trigger_func('after_ins_when') (2 rows) pg_get_triggerdef(oid, boolean) 描述：获取触发器的定义信息。 参数：待查触发器的OID及是否以pretty方式展示。 仅在创建trigger时指定WHEN条件的情况下，布尔类型参数才生效。 返回值类型：text 示例: -- 查看表tri_insert的触发器定义信息，以非pretty形式。 gaussdb=# SELECT pg_get_triggerdef(oid, false) FROM pg_trigger WHERE tgrelid = 'tri_insert'::regclass; pg_get_triggerdef -------------------------------------------------------------------------------------------------------------------------------------------------------- CREATE TRIGGER before_ins_stmt_trig BEFORE INSERT ON tri_insert FOR EACH STATEMENT EXECUTE PROCEDURE trigger_func('before_ins_stmt') CREATE TRIGGER after_ins_when_trig AFTER INSERT ON tri_insert FOR EACH ROW WHEN ((new.a IS NOT NULL)) EXECUTE PROCEDURE trigger_func('after_ins_when') (2 rows) -- 查看表tri_insert的触发器定义信息，以pretty形式。 gaussdb=# SELECT pg_get_triggerdef(oid, true) FROM pg_trigger WHERE tgrelid = 'tri_insert'::regclass; pg_get_triggerdef ------------------------------------------------------------------------------------------------------------------------------------------------------ CREATE TRIGGER before_ins_stmt_trig BEFORE INSERT ON tri_insert FOR EACH STATEMENT EXECUTE PROCEDURE trigger_func('before_ins_stmt') CREATE TRIGGER after_ins_when_trig AFTER INSERT ON tri_insert FOR EACH ROW WHEN (new.a IS NOT NULL) EXECUTE PROCEDURE trigger_func('after_ins_when') (2 rows) -- 清理表tri_insert。 gaussdb=# DROP TABLE tri_insert CASCADE; DROP TABLE -- 清理函数trigger_func。 gaussdb=# DROP FUNCTION trigger_func; DROP FUNCTION 父主题： 函数和操作符

分区表统计信息函数 gs_stat_get_partition_stats(oid) 描述：获取特定分区的统计信息。 返回值类型：record gs_stat_get_xact_partition_stats(oid) 描述：获取特定分区的事务中统计信息。 返回值类型：record gs_stat_get_all_partitions_stats() 描述：获取所有分区的统计信息。 返回值类型：setof record gs_stat_get_xact_all_partitions_stats() 描述：获取所有分区的事务中统计信息。 返回值类型：setof record gs_statio_get_all_partitions_stats() 描述：获取所有分区的I/O统计信息。 返回值类型：setof record 上述五个函数示例： 运行时统计信息上报是异步的，且基于UDP协议，后台线程处理可能存在延迟和丢包，此处示例预期仅供参考。 事务外统计信息查询 gaussdb=# CREATE TABLE part_tab1 gaussdb-# ( gaussdb(# a int, b int gaussdb(# ) gaussdb-# PARTITION BY RANGE(b) gaussdb-# ( gaussdb(# PARTITION P1 VALUES LESS THAN(10), gaussdb(# PARTITION P2 VALUES LESS THAN(20), gaussdb(# PARTITION P3 VALUES LESS THAN(MAXVALUE) gaussdb(# ); CREATE TABLE gaussdb=# CREATE TABLE subpart_tab1 gaussdb-# ( gaussdb(# month_code VARCHAR2 ( 30 ) NOT NULL , gaussdb(# dept_code VARCHAR2 ( 30 ) NOT NULL , gaussdb(# user_no VARCHAR2 ( 30 ) NOT NULL , gaussdb(# sales_amt int gaussdb(# ) gaussdb-# PARTITION BY RANGE (month_code) SUBPARTITION BY RANGE (dept_code) gaussdb-# ( gaussdb(# PARTITION p_201901 VALUES LESS THAN( '201903' ) gaussdb(# ( gaussdb(# SUBPARTITION p_201901_a VALUES LESS THAN( '2' ), gaussdb(# SUBPARTITION p_201901_b VALUES LESS THAN( '3' ) gaussdb(# ), gaussdb(# PARTITION p_201902 VALUES LESS THAN( '201904' ) gaussdb(# ( gaussdb(# SUBPARTITION p_201902_a VALUES LESS THAN( '2' ), gaussdb(# SUBPARTITION p_201902_b VALUES LESS THAN( '3' ) gaussdb(# ) gaussdb(# ); CREATE TABLE gaussdb=# CREATE INDEX index_part_tab1 ON part_tab1(b) LOCAL gaussdb-# ( gaussdb(# PARTITION b_index1, gaussdb(# PARTITION b_index2, gaussdb(# PARTITION b_index3 gaussdb(# ); CREATE INDEX gaussdb=# CREATE INDEX idx_user_no ON subpart_tab1(user_no) LOCAL; CREATE INDEX gaussdb=# INSERT INTO part_tab1 VALUES(1, 1); INSERT 0 1 gaussdb=# INSERT INTO part_tab1 VALUES(1, 11); INSERT 0 1 gaussdb=# INSERT INTO part_tab1 VALUES(1, 21); INSERT 0 1 gaussdb=# UPDATE part_tab1 SET a = 2 WHERE b = 1; UPDATE 1 gaussdb=# UPDATE part_tab1 SET a = 3 WHERE b = 11; UPDATE 1 gaussdb=# UPDATE /*+ indexscan(part_tab1) */ part_tab1 SET a = 4 WHERE b = 21; UPDATE 1 gaussdb=# DELETE FROM part_tab1; DELETE 3 gaussdb=# ANALYZE part_tab1; ANALYZE gaussdb=# VACUUM part_tab1; VACUUM gaussdb=# INSERT INTO subpart_tab1 VALUES('201902', '1', '1', 1); INSERT 0 1 gaussdb=# INSERT INTO subpart_tab1 VALUES('201902', '2', '2', 1); INSERT 0 1 gaussdb=# INSERT INTO subpart_tab1 VALUES('201903', '1', '3', 1); INSERT 0 1 gaussdb=# INSERT INTO subpart_tab1 VALUES('201903', '2', '4', 1); INSERT 0 1 gaussdb=# UPDATE subpart_tab1 SET sales_amt = 2 WHERE user_no='1'; UPDATE 1 gaussdb=# UPDATE subpart_tab1 SET sales_amt = 3 WHERE user_no='2'; UPDATE 1 gaussdb=# UPDATE subpart_tab1 SET sales_amt = 4 WHERE user_no='3'; UPDATE 1 gaussdb=# UPDATE /*+ indexscan(subpart_tab1) */ subpart_tab1 SET sales_amt = 5 WHERE user_no='4'; UPDATE 1 gaussdb=# DELETE FROM subpart_tab1; DELETE 4 gaussdb=# ANALYZE subpart_tab1; ANALYZE gaussdb=# VACUUM subpart_tab1; VACUUM gaussdb=# SELECT * FROM gs_stat_all_partitions; partition_oid | schemaname | relname | partition_name | sub_partition_name | seq_scan | seq_tup_read | idx_scan | idx_tup_fetch | n_tup_ins | n_tup_upd | n_tup_del | n_tup_hot_upd | n_live_tup | n_dead_tup | last_vacuum | last_autovacuum | last_analyze | last_autoanalyze | vacuum_count | autovacuum_count | analyze_count | autoanalyze_count ---------------+------------+--------------+----------------+--------------------+----------+--------------+----------+---------------+-----------+-----------+-----------+---------------+------------+ ------------+-------------------------------+------------------------+-------------------------------+------------------------+--------------+------------------+---------------+------------------- 16964 | public | subpart_tab1 | p_201902 | p_201902_b | 5 | 1 | 4 | 1 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:45.293965+08 | 2000-01-01 08:00:00+08 | 2023-05-15 20:36:44.688861+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 16963 | public | subpart_tab1 | p_201902 | p_201902_a | 5 | 1 | 4 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:45.291022+08 | 2000-01-01 08:00:00+08 | 2023-05-15 20:36:44.688843+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 16961 | public | subpart_tab1 | p_201901 | p_201901_b | 5 | 1 | 4 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:45.288037+08 | 2000-01-01 08:00:00+08 | 2023-05-15 20:36:44.688829+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 16960 | public | subpart_tab1 | p_201901 | p_201901_a | 5 | 1 | 4 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:45.285311+08 | 2000-01-01 08:00:00+08 | 2023-05-15 20:36:44.688802+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 16954 | public | part_tab1 | p3 | | 2 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:29.490636+08 | 2000-01-01 08:00:00+08 | 2023-05-15 20:36:28.540115+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 16953 | public | part_tab1 | p2 | | 4 | 1 | 1 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:29.487914+08 | 2000-01-01 08:00:00+08 | 2023-05-15 20:36:28.540098+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 16952 | public | part_tab1 | p1 | | 5 | 1 | 1 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:29.48536+08 | 2000-01-01 08:00:00+08 | 2023-05-15 20:36:28.540071+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 (7 rows) gaussdb=# SELECT * FROM gs_statio_all_partitions; partition_oid | schemaname | relname | partition_name | sub_partition_name | heap_blks_read | heap_blks_hit | idx_blks_read | idx_blks_hit | toast_blks_read | toast_blks_hit | tidx_blks_read | t idx_blks_hit ---------------+------------+--------------+----------------+--------------------+----------------+---------------+---------------+--------------+-----------------+----------------+----------------+-- ------------- 16964 | public | subpart_tab1 | p_201902 | p_201902_b | 4 | 8 | 2 | 21 | | | | 16963 | public | subpart_tab1 | p_201902 | p_201902_a | 4 | 8 | 2 | 21 | | | | 16961 | public | subpart_tab1 | p_201901 | p_201901_b | 4 | 8 | 2 | 21 | | | | 16960 | public | subpart_tab1 | p_201901 | p_201901_a | 4 | 8 | 2 | 21 | | | | 16954 | public | part_tab1 | p3 | | 4 | 8 | 2 | 15 | | | | 16953 | public | part_tab1 | p2 | | 4 | 8 | 2 | 15 | | | | 16952 | public | part_tab1 | p1 | | 4 | 8 | 2 | 15 | | | | (7 rows) gaussdb=# SELECT * FROM gs_stat_get_partition_stats(16952); partition_oid | seq_scan | seq_tup_read | idx_scan | idx_tup_fetch | n_tup_ins | n_tup_upd | n_tup_del | n_tup_hot_upd | n_live_tup | n_dead_tup | last_vacuum | last_autovacuum | last_analyze | last_autoanalyze | vacuum_count | autovacuum_count | analyze_count | autoanalyze_count | last_data_changed | heap_blks_read | heap_blks_hit | idx_blks_re ad | idx_blks_hit | tup_fetch | block_fetch ---------------+----------+--------------+----------+---------------+-----------+-----------+-----------+---------------+------------+------------+------------------------------+---------------------- --+-------------------------------+------------------------+--------------+------------------+---------------+-------------------+------------------------+----------------+---------------+------------ ---+--------------+-----------+------------- 16952 | 5 | 1 | 1 | 0 | 1 | 1 | 1 | 1 | 0 | 1 | 2023-05-15 20:36:29.48536+08 | 2000-01-01 08:00:00+0 8 | 2023-05-15 20:36:28.540071+08 | 2000-01-01 08:00:00+08 | 1 | 0 | 1 | 0 | 2000-01-01 08:00:00+08 | 4 | 8 | 2 | 21 | 0 | 12 (1 row) 事务内统计信息查询： gaussdb=# BEGIN; BEGIN gaussdb=# INSERT INTO part_tab1 VALUES(1, 1); INSERT 0 1 gaussdb=# INSERT INTO part_tab1 VALUES(1, 11); INSERT 0 1 gaussdb=# INSERT INTO part_tab1 VALUES(1, 21); INSERT 0 1 gaussdb=# UPDATE part_tab1 SET a = 2 WHERE b = 1; UPDATE 1 gaussdb=# UPDATE part_tab1 SET a = 3 WHERE b = 11; UPDATE 1 gaussdb=# UPDATE /*+ indexscan(part_tab1) */ part_tab1 SET a = 4 WHERE b = 21; UPDATE 1 gaussdb=# DELETE FROM part_tab1; DELETE 3 gaussdb=# INSERT INTO subpart_tab1 VALUES('201902', '1', '1', 1); INSERT 0 1 gaussdb=# INSERT INTO subpart_tab1 VALUES('201902', '2', '2', 1); INSERT 0 1 gaussdb=# INSERT INTO subpart_tab1 VALUES('201903', '1', '3', 1); INSERT 0 1 gaussdb=# INSERT INTO subpart_tab1 VALUES('201903', '2', '4', 1); INSERT 0 1 gaussdb=# UPDATE subpart_tab1 SET sales_amt = 2 WHERE user_no='1'; UPDATE 1 gaussdb=# UPDATE subpart_tab1 SET sales_amt = 3 WHERE user_no='2'; UPDATE 1 gaussdb=# UPDATE subpart_tab1 SET sales_amt = 4 WHERE user_no='3'; UPDATE 1 gaussdb=# UPDATE /*+ indexscan(subpart_tab1) */ subpart_tab1 SET sales_amt = 5 WHERE user_no='4'; UPDATE 1 gaussdb=# DELETE FROM subpart_tab1; DELETE 4 gaussdb=# SELECT * FROM gs_stat_xact_all_partitions; partition_oid | schemaname | relname | partition_name | sub_partition_name | seq_scan | seq_tup_read | idx_scan | idx_tup_fetch | n_tup_ins | n_tup_upd | n_tup_del | n_tup_hot_upd ---------------+------------+--------------+----------------+--------------------+----------+--------------+----------+---------------+-----------+-----------+-----------+--------------- 16964 | public | subpart_tab1 | p_201902 | p_201902_b | 4 | 4 | 1 | 2 | 1 | 1 | 1 | 1 16963 | public | subpart_tab1 | p_201902 | p_201902_a | 4 | 4 | 1 | 0 | 1 | 1 | 1 | 1 16961 | public | subpart_tab1 | p_201901 | p_201901_b | 4 | 4 | 1 | 0 | 1 | 1 | 1 | 1 16960 | public | subpart_tab1 | p_201901 | p_201901_a | 4 | 4 | 1 | 0 | 1 | 1 | 1 | 1 16954 | public | part_tab1 | p3 | | 1 | 1 | 1 | 2 | 1 | 1 | 1 | 1 16953 | public | part_tab1 | p2 | | 3 | 2 | 0 | 0 | 1 | 1 | 1 | 1 16952 | public | part_tab1 | p1 | | 4 | 2 | 0 | 0 | 1 | 1 | 1 | 1 (7 rows) gaussdb=# SELECT * FROM gs_stat_get_xact_partition_stats(16952); partition_oid | seq_scan | seq_tup_read | idx_scan | idx_tup_fetch | n_tup_ins | n_tup_upd | n_tup_del | n_tup_hot_upd | tup_fetch ---------------+----------+--------------+----------+---------------+-----------+-----------+-----------+---------------+----------- 16952 | 4 | 2 | 0 | 0 | 1 | 1 | 1 | 1 | 0 (1 row) -- 删除表 gaussdb=# DROP TABLE part_tab1; DROP TABLE gaussdb=# DROP TABLE subpart_tab1; DROP TABLE gs_stat_get_partition_analyze_count(oid) 描述：用户在该分区上启动分析的次数 返回值类型：bigint gs_stat_get_partition_autoanalyze_count(oid) 描述：autovacuum守护进程在该分区上启动分析的次数。 返回值类型：bigint gs_stat_get_partition_autovacuum_count(oid) 描述：autovacuum守护进程在该分区上启动清理的次数。 返回值类型：bigint gs_stat_get_partition_last_analyze_time(oid) 描述：用户在该分区上最后一次手动启动分析或者autovacuum线程启动分析的时间。 返回值类型：timestamptz gs_stat_get_partition_last_autoanalyze_time(oid) 描述：autovacuum守护进程在该分区上最后一次启动分析的时间。 返回值类型：timestamptz gs_stat_get_partition_last_autovacuum_time(oid) 描述：autovacuum守护进程在该分区上最后一次启动清理的时间。 返回值类型：timestamptz gs_stat_get_partition_last_data_changed_time(oid) 描述：对于在分区上的修改insert/update/delete/truncate，在该表上最后一次操作的时间。当前暂不支持。 返回值类型：timestamptz gs_stat_get_partition_last_vacuum_time(oid) 描述：用户在该分区上最后一次手动启动清理或者autovacuum线程启动清理的时间。 返回值类型：timestamptz gs_stat_get_partition_numscans(oid) 描述：分区顺序扫描读取的行数目。 返回值类型：bigint gs_stat_get_partition_tuples_returned(oid) 描述：分区顺序扫描读取的行数目。 返回值类型：bigint gs_stat_get_partition_tuples_fetched(oid) 描述：分区位图扫描抓取的行数目。 返回值类型：bigint gs_stat_get_partition_vacuum_count(oid) 描述：用户在该分区上启动清理的次数。 返回值类型：bigint gs_stat_get_xact_partition_tuples_fetched(oid) 描述：事务中扫描的tuple行数。 返回值类型：bigint gs_stat_get_xact_partition_numscans(oid) 描述：当前事务中分区执行的顺序扫描次数。 返回值类型：bigint gs_stat_get_xact_partition_tuples_returned(oid) 描述：当前事务中分区通过顺序扫描读取的行数。 返回值类型：bigint gs_stat_get_partition_blocks_fetched(oid) 描述：分区的磁盘块抓取请求的数量。 返回值类型：bigint gs_stat_get_partition_blocks_hit(oid) 描述：在缓冲区中找到的分区的磁盘块请求数目。 返回值类型：bigint pg_stat_get_partition_tuples_inserted(oid) 描述：插入相应表分区中行的数量。 返回值类型：bigint pg_stat_get_partition_tuples_updated(oid) 描述：在相应表分区中已更新行的数量。 返回值类型：bigint pg_stat_get_partition_tuples_deleted(oid) 描述：从相应表分区中删除行的数量。 返回值类型：bigint pg_stat_get_partition_tuples_changed(oid) 描述：该表分区上一次analyze或autoanalyze之后插入、更新、删除行的总数量。 返回值类型：bigint pg_stat_get_partition_live_tuples(oid) 描述：分区表活行数。 返回值类型：bigint pg_stat_get_partition_dead_tuples(oid) 描述：分区表死行数。 返回值类型：bigint pg_stat_get_xact_partition_tuples_inserted(oid) 描述：表分区相关的活跃子事务中插入的tuple数。 返回值类型：bigint pg_stat_get_xact_partition_tuples_deleted(oid) 描述：表分区相关的活跃子事务中删除的tuple数。 返回值类型：bigint pg_stat_get_xact_partition_tuples_hot_updated(oid) 描述：表分区相关的活跃子事务中热更新的tuple数。 返回值类型：bigint pg_stat_get_xact_partition_tuples_updated(oid) 描述：表分区相关的活跃子事务中更新的tuple数。 返回值类型：bigint pg_stat_get_partition_tuples_hot_updated(oid) 描述：返回给定分区id的分区热更新元组数的统计。 参数：oid 返回值类型：bigint

SQL限流函数 gs_add_workload_rule(rule_type, rule_name, databases, start_time, end_time, max_workload, option_val) 描述：创建一条SQL限流规则，需要具有sysadmin权限的用户才可执行。 参数：参数介绍请参见表1。 返回值类型：int8 表1 gs_add_workload_rule参数说明 参数名称 类型 描述 取值范围 rule_type text 限流规则类型，不区分大小写。 “sqlid”：根据Unique SQL ID进行限流； “select”、“insert”、“update”、“delete”、“merge”：根据查询类型和关键字进行限流； “resource”：根据系统资源利用率进行实例级别的限流。 rule_name name 限流规则名称，用于检索限流规则。 任意字符串，可以为NULL。 databases name[] 限流规则生效的数据库名称数组，区分大小写。 数据库名列表，必须为已创建的数据库名。可以为NULL，表示所有数据库生效。 目前只有指定rule_type为查询类型时，数据库列表才生效，因为Unique SQL ID本身是与库进行绑定的，其只属于某个库；而根据资源利用率的限流规则是对实例生效的，即对所有库生效。 start_time timestamptz 限流规则生效的开始时间。 可以为NULL，表示从当前时间开始生效。 end_time timestamptz 限流规则生效的结束时间。 可以为NULL，表示规则一直生效。 max_workload int8 限流规则设置的最大并发数。 - option_val text[] 限流规则的补充信息。 与rule_type匹配，具体匹配关系如下： “sqlid”：要限流的Unique SQL ID，以及慢SQL管控规则，格式为'{id=1234, time_limit=100, max_execute_time=500, max_iops=1}'，其中id为Unique SQL ID，为必选项，可通过dbe_perf.statement或者pg_stat_activity视图获取。其他选项非必选，其含义参考慢SQL管控规则的Hint； “select”、“insert”、“update”、“delete”、“merge”： 要限流的关键字序列，不区分大小写，可以为NULL； “resource”： 要限流的资源阈值，形式为'{cpu-80, memory-70}'，表示触发实例级别限流的操作系统资源阈值，可以为NULL，表示不管资源利用率直接进行限流。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 gaussdb=# select gs_add_workload_rule('sqlid', 'rule for one query', '', now(), '', 20, '{id=32413214}'); gs_add_workload_rule ---------------------- 1 (1 row) gaussdb=# create database db1; gaussdb=# create database db2; gaussdb=# select gs_add_workload_rule('select', 'rule for select', '{db1, db2}', '', '', 100, '{tb1, tb2}'); gs_add_workload_rule ---------------------- 2 (1 row) gaussdb=# select gs_add_workload_rule('resource', 'rule for resource', '{}', '', '', 20, '{cpu-80}'); gs_add_workload_rule ---------------------- 3 (1 row) gaussdb=# drop database db1; DROP DATABASE gaussdb=# drop database db2; DROP DATABASE gs_update_workload_rule(rule_id, rule_name, databases, start_time, end_time, max_workload, option_val) 描述：更新一条SQL限流规则，需要重新设置全部参数，不支持只指定部分参数。需要具有sysadmin权限的用户才可执行。 参数：参数介绍请参见表2 返回值类型：boolean 表2 gs_update_workload_rule参数说明 参数名称 类型 描述 取值范围 rule_id int8 要更新的限流规则ID。 - rule_name name 限流规则名称，用于检索限流规则。 任意字符串，可以为NULL。 databases name[] 限流规则生效的数据库名称数组，区分大小写。 数据库名列表，必须为已创建的数据库名。可以为NULL，表示所有数据库生效。 目前只有指定rule_type为查询类型时，数据库列表才生效，因为Unique SQL ID本身是与库进行绑定的，其只属于某个库；而根据资源利用率的限流规则是对实例生效的，即对所有库生效。 start_time timestamptz 限流规则生效的开始时间。 可以为NULL，表示从当前时间开始生效。 end_time timestamptz 限流规则生效的结束时间。 可以为NULL，表示规则一直生效。 max_workload int8 限流规则设置的最大并发数。 - option_val text[] 限流规则的补充信息。 与rule_type匹配，具体匹配关系如下： “sqlid”：要限流的Unique SQL ID，以及慢SQL管控规则，格式为'{id=1234, time_limit=100, max_execute_time=500, max_iops=1}'，其中id为Unique SQL ID，为必选项，可通过dbe_perf.statement或者pg_stat_activity视图获取。其他选项非必选，其含义参考慢SQL管控规则的Hint； “select”、“insert”、“update”、“delete”、“merge” ：要限流的关键字序列，不区分大小写，可以为NULL； “resource”：要限流的资源阈值，形式为'{cpu-80, memory-70}'，表示触发实例级别限流的操作系统资源阈值，可以为NULL，表示不管资源利用率直接进行限流。 示例： 1 2 3 4 5 6 7 8 gaussdb=# create database db1; gaussdb=# select gs_update_workload_rule(2, 'rule for select 2', '{db1}', now(), '', 50, '{tb1}'); gs_update_workload_rule ------------------------- t (1 row) gaussdb=# drop database db1; DROP DATABASE gs_delete_workload_rule(rule_id int8) 描述：删除一条SQL限流规则，需要具有sysadmin权限的用户才可执行。 参数：rule_id，要更新的限流规则ID，类型为int8。 返回值类型：boolean 示例： 1 2 3 4 5 gaussdb=# select gs_delete_workload_rule(3); gs_delete_workload_rule ------------------------- t (1 row) gs_get_workload_rule_stat(rule_id) 描述：查询SQL限流规则拦截SQL的次数，需要具有sysadmin权限的用户才可执行。 参数：rule_id，要查询的限流规则ID，类型为int8。可以指定rule_id为-1，此时表示查询所有的SQL限流规则。 返回值类型： 名称 类型 描述 rule_id int8 SQL限流规则的ID。 validate_count int8 SQL限流规则拦截SQL的次数。 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# select * from gs_get_workload_rule_stat(1); rule_id | validate_count ---------+---------------- 1 | 0 (1 row) gaussdb=# select * from gs_get_workload_rule_stat(-1); rule_id | validate_count ---------+---------------- 1 | 0 2 | 0 (2 rows) 父主题： 系统管理函数

咨询锁函数 咨询锁函数用于管理咨询锁（Advisory Lock）。 pg_advisory_lock(key bigint) 描述：获取会话级别的排他咨询锁。 返回值类型：void 备注：pg_advisory_lock锁定应用程序定义的资源，该资源可以用一个64位或两个不重叠的32位键值标识。如果已经有另外的会话锁定了该资源，则该函数将阻塞到该资源可用为止。这个锁是排他的。多个锁定请求将会被压入栈中，因此，如果同一个资源被锁定了三次，它必须被解锁三次以将资源释放给其他会话使用。 pg_advisory_lock(key1 int, key2 int) 描述：获取会话级别的排他咨询锁。 返回值类型：void 备注：只允许sysadmin对键值对(65535, 65535)加会话级别的排他咨询锁，普通用户无权限。 pg_advisory_lock(lock_id int4, lock_id int4, datebase_name Name) 描述：通过传入锁ID和数据库名字，获取指定数据库的排他咨询锁。 返回值类型：void pg_advisory_lock_shared(key bigint) 描述：获取会话级别的共享咨询锁。 返回值类型：void pg_advisory_lock_shared(key1 int, key2 int) 描述：获取会话级别的共享咨询锁。 返回值类型：void 备注：pg_advisory_lock_shared类似于pg_advisory_lock，不同之处仅在于共享锁会话可以和其他请求共享锁的会话共享资源，但排他锁除外。 pg_advisory_unlock(key bigint) 描述：释放会话级别的排他咨询锁。 返回值类型：Boolean pg_advisory_unlock(key1 int, key2 int) 描述：释放会话级别的排他咨询锁。 返回值类型：Boolean 备注：pg_advisory_unlock释放先前取得的排他咨询锁。如果释放成功则返回true。如果实际上并未持有指定的锁，将返回false并在服务器中产生一条SQL警告信息。 pg_advisory_unlock(lock_id int4, lock_id int4, datebase_name Name) 描述：通过传入锁ID和数据库名字，释放指定数据库上的排他咨询锁。 返回值类型：Boolean 备注：如果释放成功则返回true；如果未持有锁，则返回false。 pg_advisory_unlock_shared(key bigint) 描述：释放会话级别的共享咨询锁。 返回值类型：Boolean pg_advisory_unlock_shared(key1 int, key2 int) 描述：释放会话级别的共享咨询锁。 返回值类型：Boolean 备注：pg_advisory_unlock_shared类似于pg_advisory_unlock，不同之处在于该函数释放的是共享咨询锁。 pg_advisory_unlock_all() 描述：释放当前会话持有的所有咨询锁。 返回值类型：void 备注：pg_advisory_unlock_all将会释放当前会话持有的所有咨询锁，该函数在会话结束的时候被隐含调用，即使客户端异常地断开连接也是一样。 pg_advisory_xact_lock(key bigint) 描述：获取事务级别的排他咨询锁。 返回值类型：void pg_advisory_xact_lock(key1 int, key2 int) 描述：获取事务级别的排他咨询锁。 返回值类型：void 备注：pg_advisory_xact_lock类似于pg_advisory_lock，不同之处在于锁是自动在当前事务结束时释放，而且不能被显式的释放。只允许sysadmin对键值对(65535, 65535)加事务级别的排他咨询锁，普通用户无权限。 pg_advisory_xact_lock_shared(key bigint) 描述：获取事务级别的共享咨询锁。 返回值类型：void pg_advisory_xact_lock_shared(key1 int, key2 int) 描述：获取事务级别的共享咨询锁。 返回值类型：void 备注：pg_advisory_xact_lock_shared类似于pg_advisory_lock_shared，不同之处在于锁是在当前事务结束时自动释放，而且不能被显式的释放。 pg_try_advisory_lock(key bigint) 描述：尝试获取会话级排他咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_lock类似于pg_advisory_lock，不同之处在于该函数不会阻塞以等待资源的释放。它要么立即获得锁并返回true，要么返回false表示目前不能锁定。 pg_try_advisory_lock(key1 int, key2 int) 描述：尝试获取会话级排他咨询锁。 返回值类型：Boolean 备注：只允许sysadmin对键值对(65535, 65535)加会话级别的排他咨询锁，普通用户无权限。 pg_try_advisory_lock_shared(key bigint) 描述：尝试获取会话级共享咨询锁。 返回值类型：Boolean pg_try_advisory_lock_shared(key1 int, key2 int) 描述：尝试获取会话级共享咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_lock_shared类似于pg_try_advisory_lock，不同之处在于该函数尝试获得共享锁而不是排他锁。 pg_try_advisory_xact_lock(key bigint) 描述：尝试获取事务级别的排他咨询锁。 返回值类型：Boolean pg_try_advisory_xact_lock(key1 int, key2 int) 描述：尝试获取事务级别的排他咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_xact_lock类似于pg_try_advisory_lock，不同之处在于如果得到锁，在当前事务的结束时自动释放，而且不能被显式的释放。只允许sysadmin对键值对(65535, 65535)加事务级别的排他咨询锁，普通用户无权限。 pg_try_advisory_xact_lock_shared(key bigint) 描述：尝试获取事务级别的共享咨询锁。 返回值类型：Boolean pg_try_advisory_xact_lock_shared(key1 int, key2 int) 描述：尝试获取事务级别的共享咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_xact_lock_shared类似于pg_try_advisory_lock_shared，不同之处在于如果得到锁，在当前事务结束时自动释放，而且不能被显式的释放。 lock_cluster_ddl() 描述：尝试对数据库内所有存活的数据库主节点获取会话级别的排他咨询锁。 返回值类型：Boolean 备注：只允许sysadmin调用，普通用户无权限。 unlock_cluster_ddl() 描述：尝试对数据库主节点会话级别的排他咨询锁。 返回值类型：Boolean 会话级别咨询锁示例： gaussdb=# select pg_advisory_lock(1); --依次获取3个会话级别的咨询锁 pg_advisory_lock ------------------ (1 row) gaussdb=# select pg_advisory_lock(1,2); pg_advisory_lock ------------------ (1 row) gaussdb=# select pg_advisory_lock(2,2,'postgres'); pg_advisory_lock ------------------ (1 row) gaussdb=# select * from pg_locks; --查询pg_locks表，看到新增了3个advisory类型的锁 locktype | database | relation | page | tuple | bucket | virtualxid | transactionid | classid | objid | objsubid | virtualtransaction | pid | sessionid | mode | granted | fastpath | locktag | global_sessionid ------------+----------+----------+------+-------+--------+------------+---------------+---------+-------+----------+--------------------+-----------------+-----------------+-----------------+---------+----------+------ -------------+------------------ relation | 12850 | 10652 | | | | | | | | | 4/27611 | 140245958915840 | 140245958915840 | AccessShareLock | t | t | 3232: 299c:0:0:0:0 | 0:0#0 virtualxid | | | | | | 4/27611 | | | | | 4/27611 | 140245958915840 | 140245958915840 | ExclusiveLock | t | t | 4:6bd b:0:0:0:7 | 0:0#0 virtualxid | | | | | | 19/16219 | | | | | 19/16219 | 140246771033856 | 140246771033856 | ExclusiveLock | t | t | 13:3f 5b:0:0:0:7 | 0:0#0 virtualxid | | | | | | 17/97293 | | | | | 17/97293 | 140246750590720 | 140246750590720 | ExclusiveLock | t | t | 11:17 c0d:0:0:0:7 | 0:0#0 advisory | 12850 | | | | | | | 0 | 1 | 1 | 4/27611 | 140245958915840 | 140245958915840 | ExclusiveLock | t | f | 3232: 0:1:1:0:b | 0:0#0 advisory | 12850 | | | | | | | 1 | 2 | 2 | 4/27611 | 140245958915840 | 140245958915840 | ExclusiveLock | t | f | 3232: 1:2:2:0:b | 0:0#0 advisory | 12850 | | | | | | | 2 | 2 | 2 | 4/27611 | 140245958915840 | 140245958915840 | ExclusiveLock | t | f | 3232: 2:2:2:0:b | 0:0#0 (7 rows) gaussdb=# select pg_advisory_unlock(1); --依次释放3个会话级别的咨询锁 pg_advisory_unlock -------------------- t (1 row) gaussdb=# select pg_advisory_unlock(1,2); pg_advisory_unlock -------------------- t (1 row) gaussdb=# select pg_advisory_unlock(2,2,'postgres'); pg_advisory_unlock -------------------- t (1 row) gaussdb=# select * from pg_locks; --查询pg_locks表，看到3个advisory类型的锁已被释放 locktype | database | relation | page | tuple | bucket | virtualxid | transactionid | classid | objid | objsubid | virtualtransaction | pid | sessionid | mode | granted | fastpath | locktag | global_sessionid ------------+----------+----------+------+-------+--------+------------+---------------+---------+-------+----------+--------------------+-----------------+-----------------+-----------------+---------+----------+------ -------------+------------------ relation | 12850 | 10652 | | | | | | | | | 4/27618 | 140245958915840 | 140245958915840 | AccessShareLock | t | t | 3232: 299c:0:0:0:0 | 0:0#0 virtualxid | | | | | | 4/27618 | | | | | 4/27618 | 140245958915840 | 140245958915840 | ExclusiveLock | t | t | 4:6be 2:0:0:0:7 | 0:0#0 virtualxid | | | | | | 19/16254 | | | | | 19/16254 | 140246771033856 | 140246771033856 | ExclusiveLock | t | t | 13:3f 7e:0:0:0:7 | 0:0#0 virtualxid | | | | | | 17/97506 | | | | | 17/97506 | 140246750590720 | 140246750590720 | ExclusiveLock | t | t | 11:17 ce2:0:0:0:7 | 0:0#0 (4 rows) gaussdb=# select pg_advisory_lock(1); --再次获取会话级别的咨询锁 pg_advisory_lock ------------------ (1 row) gaussdb=# select pg_advisory_unlock_all(); --释放所有会话级别的咨询锁 pg_advisory_unlock_all ------------------------ (1 row) gaussdb=# select * from pg_locks; --查询pg_locks表，看到advisory类型的锁已被释放 locktype | database | relation | page | tuple | bucket | virtualxid | transactionid | classid | objid | objsubid | virtualtransaction | pid | sessionid | mode | granted | fastpath | locktag | global_sessionid ------------+----------+----------+------+-------+--------+------------+---------------+---------+-------+----------+--------------------+-----------------+-----------------+-----------------+---------+----------+------ -------------+------------------ relation | 12850 | 10652 | | | | | | | | | 4/27629 | 140245958915840 | 140245958915840 | AccessShareLock | t | t | 3232: 299c:0:0:0:0 | 0:0#0 virtualxid | | | | | | 4/27629 | | | | | 4/27629 | 140245958915840 | 140245958915840 | ExclusiveLock | t | t | 4:6be d:0:0:0:7 | 0:0#0 virtualxid | | | | | | 19/16369 | | | | | 19/16369 | 140246771033856 | 140246771033856 | ExclusiveLock | t | t | 13:3f f1:0:0:0:7 | 0:0#0 virtualxid | | | | | | 17/98194 | | | | | 17/98194 | 140246750590720 | 140246750590720 | ExclusiveLock | t | t | 11:17 f92:0:0:0:7 | 0:0#0 (4 rows) 事务级别咨询锁示例： gaussdb=# select pg_advisory_xact_lock_shared(1); --获取事务级别的共享咨询锁 pg_advisory_xact_lock_shared ------------------------------ (1 row) gaussdb=# select * from pg_locks; --因单条语句视为一个事务，因此咨询锁已随事务提交自动释放。查询pg_locks表，看不到事务级咨询锁 locktype | database | relation | page | tuple | bucket | virtualxid | transactionid | classid | objid | objsubid | virtualtransaction | pid | sessionid | mode | granted | fastpath | locktag | global_sessionid ------------+----------+----------+------+-------+--------+------------+---------------+---------+-------+----------+--------------------+-----------------+-----------------+-----------------+---------+----------+------ -------------+------------------ relation | 12850 | 10652 | | | | | | | | | 4/27631 | 140245958915840 | 140245958915840 | AccessShareLock | t | t | 3232: 299c:0:0:0:0 | 0:0#0 virtualxid | | | | | | 4/27631 | | | | | 4/27631 | 140245958915840 | 140245958915840 | ExclusiveLock | t | t | 4:6be f:0:0:0:7 | 0:0#0 virtualxid | | | | | | 19/16396 | | | | | 19/16396 | 140246771033856 | 140246771033856 | ExclusiveLock | t | t | 13:40 0c:0:0:0:7 | 0:0#0 virtualxid | | | | | | 17/98359 | | | | | 17/98359 | 140246750590720 | 140246750590720 | ExclusiveLock | t | t | 11:18 037:0:0:0:7 | 0:0#0 (4 rows) gaussdb=# start transaction; --显式开启事务块 START TRANSACTION gaussdb=# select pg_advisory_xact_lock_shared(1); --获取事务级别的共享咨询锁 pg_advisory_xact_lock_shared ------------------------------ (1 row) gaussdb=# select * from pg_locks; --查询pg_locks表，新增了一个advisory类型锁 locktype | database | relation | page | tuple | bucket | virtualxid | transactionid | classid | objid | objsubid | virtualtransaction | pid | sessionid | mode | granted | fastpath | locktag | global_sessionid ------------+----------+----------+------+-------+--------+------------+---------------+---------+-------+----------+--------------------+-----------------+-----------------+-----------------+---------+----------+------ -------------+------------------ relation | 12850 | 10652 | | | | | | | | | 4/27632 | 140245958915840 | 140245958915840 | AccessShareLock | t | t | 3232: 299c:0:0:0:0 | 0:0#0 virtualxid | | | | | | 4/27632 | | | | | 4/27632 | 140245958915840 | 140245958915840 | ExclusiveLock | t | t | 4:6bf 0:0:0:0:7 | 0:0#0 virtualxid | | | | | | 19/16399 | | | | | 19/16399 | 140246771033856 | 140246771033856 | ExclusiveLock | t | t | 13:40 0f:0:0:0:7 | 0:0#0 virtualxid | | | | | | 17/98377 | | | | | 17/98377 | 140246750590720 | 140246750590720 | ExclusiveLock | t | t | 11:18 049:0:0:0:7 | 0:0#0 advisory | 12850 | | | | | | | 0 | 1 | 1 | 4/27632 | 140245958915840 | 140245958915840 | ShareLock | t | f | 3232: 0:1:1:0:b | 0:0#0 (5 rows) gaussdb=# commit; --提交事务块 COMMIT gaussdb=# select * from pg_locks; --查询pg_locks表，事务级别advisory类型锁已自动释放 locktype | database | relation | page | tuple | bucket | virtualxid | transactionid | classid | objid | objsubid | virtualtransaction | pid | sessionid | mode | granted | fastpath | locktag | global_sessionid ------------+----------+----------+------+-------+--------+------------+---------------+---------+-------+----------+--------------------+-----------------+-----------------+-----------------+---------+----------+------ -------------+------------------ relation | 12850 | 10652 | | | | | | | | | 4/27633 | 140245958915840 | 140245958915840 | AccessShareLock | t | t | 3232: 299c:0:0:0:0 | 0:0#0 virtualxid | | | | | | 4/27633 | | | | | 4/27633 | 140245958915840 | 140245958915840 | ExclusiveLock | t | t | 4:6bf 1:0:0:0:7 | 0:0#0 virtualxid | | | | | | 19/16401 | | | | | 19/16401 | 140246771033856 | 140246771033856 | ExclusiveLock | t | t | 13:40 11:0:0:0:7 | 0:0#0 virtualxid | | | | | | 17/98385 | | | | | 17/98385 | 140246750590720 | 140246750590720 | ExclusiveLock | t | t | 11:18 051:0:0:0:7 | 0:0#0 (4 rows) 尝试获取咨询锁示例： gaussdb=# select pg_try_advisory_lock_shared(1); --在没有其他连接加咨询锁时，尝试获取对象1的共享咨询锁成功 pg_try_advisory_lock_shared ----------------------------- t (1 row) gaussdb=# select pg_advisory_unlock_all(); --释放这个咨询锁 pg_advisory_unlock_all ------------------------ (1 row) gaussdb=# select pg_advisory_lock(1); --获取对象1的排他咨询锁 pg_advisory_lock ------------------ (1 row) --保持这个连接不断开，新启动一个连接 gaussdb=# select pg_try_advisory_lock_shared(1); --因已有连接持有排他锁，所以新连接中尝试获取对象1的共享咨询锁失败 pg_try_advisory_lock_shared ----------------------------- f (1 row) 父主题： 系统管理函数

数据库对象位置函数 pg_relation_filenode(relation regclass) 描述：指定关系的文件节点数。 返回值类型：oid 备注：pg_relation_filenode接受一个表、索引、序列或压缩表的OID或者名称，并且返回当前分配给它的“filenode”数。文件节点是关系使用的文件名称的基本组件。对大多数表来说，结果和pg_class.relfilenode相同，但对确定的系统目录来说，relfilenode为0而且这个函数必须用来获取正确的值。如果传递一个没有存储的关系，比如一个视图，那么这个函数返回NULL。 pg_relation_filepath(relation regclass) 描述：指定关系的文件路径名。 返回值类型：text 备注：pg_relation_filepath类似于pg_relation_filenode，但是它返回关系的整个文件路径名（相对于数据库的数据目录PGDATA）。 pg_filenode_relation(tablespace oid, filenode oid) 描述：获取对应的tablespace和relfilenode所对应的表名。 返回类型：regclass pg_partition_filenode(partition_oid) 描述：获取到指定分区表的oid锁对应的filenode。 返回类型：oid pg_partition_filepath(partition_oid) 描述：指定分区的文件路径名。 返回值类型：text

数据库对象尺寸函数 数据库对象尺寸函数计算数据库对象使用的实际磁盘空间。 pg_column_size(any) 描述：存储一个指定的数值需要的字节数（可能压缩过）。 返回值类型：int 备注：pg_column_size显示用于存储某个独立数据值的空间。 1 2 3 4 5 gaussdb=# SELECT pg_column_size(1); pg_column_size ---------------- 4 (1 row) pg_database_size(oid) 描述：指定OID代表的数据库使用的磁盘空间。 返回值类型：bigint pg_database_size(name) 描述：指定名称的数据库使用的磁盘空间。 返回值类型：bigint 备注：pg_database_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 示例： 1 2 3 4 5 6 7 8 9 gaussdb=# CREATE DATABASE testdb dbcompatibility 'A'; CREATE DATABASE gaussdb=# SELECT pg_database_size('testdb'); pg_database_size ------------------ 51590112 (1 row) gaussdb=# DROP DATABASE testdb; DROP DATABASE pg_relation_size(oid) 描述：指定OID代表的表或者索引所使用的磁盘空间。 返回值类型：bigint get_db_source_datasize() 描述：估算当前数据库非压缩态的数据总容量。 返回值类型：bigint 备注：调用该函数前需要做analyze。 示例： 1 2 3 4 5 6 7 gaussdb=# analyze; ANALYZE gaussdb=# SELECT get_db_source_datasize(); get_db_source_datasize ------------------------ 35384925667 (1 row) pg_relation_size(text) 描述：指定名称的表或者索引使用的磁盘空间。表名称可以用模式名修饰。 返回值类型：bigint pg_relation_size(relation regclass, fork text) 描述：指定表或索引的指定分叉树（'main'，'fsm'或'vm'）使用的磁盘空间。 返回值类型：bigint pg_relation_size(relation regclass) 描述：pg_relation_size(..., 'main')的简写。 返回值类型：bigint 备注：pg_relation_size接受一个表、索引、压缩表的OID或者名称，然后返回它们的字节大小。 pg_partition_size(oid, oid) 描述：指定OID代表的分区使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_size(text, text) 描述：指定名称的分区使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_partition_indexes_size(oid, oid) 描述：指定OID代表的分区的索引使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_indexes_size(text, text) 描述：指定名称的分区的索引使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_indexes_size(regclass) 描述：附加到指定表的索引使用的总磁盘空间。 返回值类型：bigint pg_size_pretty(bigint) 描述：将以64位整数表示的字节值转换为具有单位的易读格式。 返回值类型：text pg_size_pretty(numeric) 描述：将以数值表示的字节值转换为具有单位的易读格式。 返回值类型：text 备注：pg_size_pretty用于把其他函数的结果格式化成一种易读的格式，可以根据情况使用kB 、MB 、GB 、TB。 pg_table_size(regclass) 描述：指定的表使用的磁盘空间，不计索引（但是包含TOAST，自由空间映射和可见性映射）。 返回值类型：bigint pg_tablespace_size(oid) 描述：指定OID代表的表空间使用的磁盘空间。 返回值类型：bigint pg_tablespace_size(name) 描述：指定名称的表空间使用的磁盘空间。 返回值类型：bigint 备注： pg_tablespace_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 pg_total_relation_size(oid) 描述：指定OID代表的表使用的磁盘空间，包括索引和压缩数据。 返回值类型：bigint pg_total_relation_size(regclass) 描述：指定的表使用的总磁盘空间，包括所有的索引和TOAST数据。 返回值类型：bigint pg_total_relation_size(text) 描述：指定名称的表所使用的全部磁盘空间，包括索引和压缩数据。表名称可以用模式名修饰。 返回值类型：bigint 备注：pg_total_relation_size接受一个表或者一个压缩表的OID或者名称，然后返回以字节计的数据和所有相关的索引和压缩表的尺寸。 datalength(any) 描述：计算一个指定的数据需要的字节数（不考虑数据的管理空间和数据压缩，数据类型转换等情况）。 返回值类型：int 备注：datalength用于计算某个独立数据值的空间。 示例： gaussdb=# SELECT datalength(1); datalength ------------ 4 (1 row) 目前支持的数据类型及计算方式见下表： 数据类型 存储空间 数值类型 整数类型 TINYINT 1 SMALLINT 2 INTEGER 4 BINARY_INTEGER 4 BIGINT 8 任意精度型 DECIMAL 每4位十进制数占两个字节，小数点前后数字分别计算。 NUMERIC 每4位十进制数占两个字节，小数点前后数字分别计算。 NUMBER 每4位十进制数占两个字节，小数点前后数字分别计算。 序列整型 SMALLSERIAL 2 SERIAL 4 BIGSERIAL 8 LARGESERIAL 每4位十进制数占两个字节，小数点前后数字分别计算。 浮点类型 FLOAT4 4 DOUBLE PRECISION 8 FLOAT8 8 BINARY_DOUBLE 8 FLOAT[(p)] 每4位十进制数占两个字节，小数点前后数字分别计算。 DEC[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算。 INTEGER[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算。 布尔类型 布尔类型 BOOLEAN 1 字符类型 字符类型 CHAR n CHAR(n) n CHARACTER(n) n NCHAR(n) n VARCHAR(n) n CHARACTER 字符实际字节数。 VARYING(n) 字符实际字节数。 VARCHAR2(n) 字符实际字节数。 NVARCHAR(n) 字符实际字节数。 NVARCHAR2(n) 字符实际字节数。 TEXT 字符实际字节数。 CLOB 字符实际字节数。 时间类型 时间类型 DATE 8 TIME 8 TIMEZ 12 TIMESTAMP 8 TIMESTAMPZ 8 SMALLDATETIME 8 INTERVAL DAY TO SECOND 16 INTERVAL 16 RELTIME 4 ABSTIME 4 TINTERVAL 12

快照同步函数 快照同步函数是导出当前快照的标识符。 pg_export_snapshot() 描述：保存当前的快照并返回它的标识符。 返回值类型：text 备注：函数pg_export_snapshot保存当前的快照并返回一个文本字符串标识此快照。这个字符串必须传递给想要导入快照的客户端。可用在set transaction snapshot snapshot_id时导入snapshot，但是应用的前提是该事务设置了SERIALIZABLE或REPEATABLE READ隔离级别。而GaussDB目前是不支持这两种隔离级别的。该函数的输出不可用做set transaction snapshot的输入。 1 2 3 4 5 gaussdb=# SELECT * FROM pg_export_snapshot(); pg_export_snapshot -------------------- 00000000000070AD-1 (1 row) pg_export_snapshot_and_csn() 描述：保存当前的快照并返回它的标识符。比pg_export_snapshot()多返回一列 CS N，表示当前快照的CSN。 返回值类型：text 1 2 3 4 5 gaussdb=# SELECT * FROM pg_export_snapshot_and_csn(); snapshot | csn --------------------+------ 0000000000007129-1 | 390D (1 row) 父主题： 系统管理函数

双数据库实例容灾控制函数 gs_streaming_dr_in_switchover() 描述：基于流式复制的异地容灾解决方案中主数据库实例在执行计划内switchover过程中截断业务的接口。 返回值类型：Boolean，表明此次业务截断是否成功，是否可以正常进行switchover流程。 gaussdb=# SELECT * FROM gs_streaming_dr_in_switchover(); is_in_switchover ------------------ f (1 row) 父主题： 系统管理函数

恢复控制函数 恢复信息函数提供了当前备机状态的信息。这些函数可能在恢复期间或正常运行中执行。 pg_is_in_recovery() 描述：如果恢复仍然在进行中则返回true。 返回值类型：Boolean pg_last_xlog_receive_location() 描述：获取最后接收事务日志的位置并通过流复制将其同步到磁盘。当流复制正在进行时，事务日志将持续递增。如果恢复已完成，则最后一次获取的WAL记录会被静态保持并在恢复过程中同步到磁盘。如果流复制不可用，或还没有开始，这个函数返回NULL。 返回值类型：text pg_last_xlog_replay_location() 描述：获取最后一个事务日志在恢复时重放的位置。如果恢复仍在进行，事务日志将持续递增。如果已经完成恢复，则将保持在恢复期间最后接收WAL记录的值。如果未进行恢复但服务器正常启动时，则这个函数返回NULL。 返回值类型：text pg_last_xact_replay_timestamp() 描述：获取最后一个事务在恢复时重放的时间戳。这是为在主节点上生成事务提交或终止WAL记录的时间。如果在恢复时没有事务重放，则这个函数返回NULL。如果恢复仍在进行，则事务日志将持续递增。如果恢复已经完成，则将保持在恢复期间最后接收WAL记录的值。如果服务器无需恢复就已正常启动，则这个函数返回NULL。 返回值类型：timestamp with time zone 恢复控制函数控制恢复的进程。这些函数可能只在恢复时被执行。 pg_is_xlog_replay_paused() 描述：如果恢复暂停则返回true。 返回值类型：Boolean pg_xlog_replay_pause() 描述：立即暂停恢复。 返回值类型：void pg_xlog_replay_resume() 描述：如果恢复处于暂停状态，则重新启动。 返回值类型：void gs_get_active_archiving_standby() 描述：查询同一分片内归档备机的信息。返回备机名，备机归档位置和已归档日志个数。 返回值类型：text，int gs_pitr_get_warning_for_xlog_force_recycle() 描述：查询开启归档后是否因归档槽不推进日志大量堆积导致日志被回收。 返回值类型：bool gs_pitr_clean_history_global_barriers(stop_barrier_timestamp cstring) 描述：清理指定时间之前所有barrier记录。返回最老的barrier记录。入参为cstring类型，linux时间戳。需要管理员角色或运维管理员角色执行。 返回值类型：text gs_pitr_archive_slot_force_advance(stop_barrier_timestamp cstring) 描述：强制推进归档槽，并清理不需要的barrier记录。返回新的归档槽位置。入参为cstring类型，linux时间戳。需要管理员角色或运维管理员角色执行。 返回值类型：text 当恢复暂停时，没有发生数据库更改。如果是在热备里，所有新的查询将看到一致的数据库快照，并且不会有进一步的查询冲突产生，直到恢复继续。 如果不能使用流复制，则暂停状态将无限的延续。当流复制正在进行时，将连续接收WAL记录，最终将填满可用磁盘空间，这个进度取决于暂停的持续时间，WAL生成的速度和可用的磁盘空间。 gs_recent_barrier_buffer_info(start_time text, end_time text) 描述：根据用户输入的时间范围，进行相应的barrier信息查询，获取time_stamp、CSN、LSN和standard_time。 返回值类型：records 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。输入参数start_time和end_time采用“年-月-日 时间”格式，其中时间采用clock格式。查询最大时间跨度为1天，超出跨度约束，根据查询起始时间将结束时间自动转换为极限边界进行查询。例如： gaussdb=# SELECT * FROM gs_recent_barrier_buffer_info('2024-01-15 23:27:50', '2024-01-15 23:28:00'); timestamp | lsn | csn | standard_time ------------+-------------------+----------+--------------------- 1705332470 | 00000000/15FFBBA0 | 41020421 | 2024-01-15 23:27:50 1705332471 | 00000000/15FFBDF0 | 41020422 | 2024-01-15 23:27:51 1705332472 | 00000000/15FFC058 | 41020423 | 2024-01-15 23:27:52 1705332472 | 00000000/15FFC0F8 | 41020424 | 2024-01-15 23:27:52 1705332473 | 00000000/15FFC348 | 41020425 | 2024-01-15 23:27:53 1705332474 | 00000000/15FFC598 | 41020426 | 2024-01-15 23:27:54 1705332475 | 00000000/15FFC638 | 41020427 | 2024-01-15 23:27:55 1705332476 | 00000000/15FFC888 | 41020428 | 2024-01-15 23:27:56 1705332476 | 00000000/15FFDC80 | 41020433 | 2024-01-15 23:27:56 1705332477 | 00000000/15FFDD20 | 41020434 | 2024-01-15 23:27:57 1705332478 | 00000000/15FFDF70 | 41020435 | 2024-01-15 23:27:58 1705332479 | 00000000/15FFE1D8 | 41020436 | 2024-01-15 23:27:59 1705332480 | 00000000/15FFE278 | 41020437 | 2024-01-15 23:28:00 1705332480 | 00000000/15FFE4C8 | 41020438 | 2024-01-15 23:28:00 (14 rows) gs_show_obs_media_files(slot_name cstring, src cstring, offset int32, limit int32) 描述：根据用户输入的归档槽（slot_name）和OBS目录地址（src），查询OBS文件列表。 返回值类型：records 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。Offset为查询结果偏移，limit为输出最大行数，查询src下所有文件。例如： gaussdb=# SELECT gs_show_obs_archive_files('ssh','dn1/pg_xlog',0, 5); gs_show_obs_archive_files --------------------------------------------------------------------------------------------- (wstdist_ssh/archive/dn1/pg_xlog/000000010000000000000007_00_01_00000004_00000002_00000000) (wstdist_ssh/archive/dn1/pg_xlog/000000010000000000000007_00_01_00000103_00000003_00000000) (wstdist_ssh/archive/dn1/pg_xlog/000000010000000000000007_01_01_00000004_00000002_00000000) (wstdist_ssh/archive/dn1/pg_xlog/000000010000000000000007_01_01_00000103_00000003_00000000) (wstdist_ssh/archive/dn1/pg_xlog/000000010000000000000007_02_01_00000004_00000002_00000000) (5 rows) gs_upload_obs_media_file(slot_name cstring, src cstring, dest cstring, is_forced bool) 描述：根据用户输入的归档槽（slot_name）、上传文件原地址（src）、OBS地址（dest）和是否强制上传（is_forced），上传OBS文件。 返回值类型：void 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。原文件目录仅允许为$GAUSSLOG目录。例如： gaussdb=# SELECT * FROM gs_upload_obs_archive_file('ssh', '/data/gauss/log/stwang/test/000000010000000000000007_02_01_00000004_00000002_00000000', 'dn1/pg_xlog/000000010000000000000019_02_01_00000000_00000000_00000003', true); gs_upload_obs_archive_file ---------------------------- (1 row) gs_download_obs_media_file(slot_name cstring, src cstring, dest cstring) 描述：根据用户输入的归档槽（slot_name）、下载原地址（src）和本地目标地址（dest），下载OBS文件。 返回值类型：void 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。下载目录仅允许为$GAUSSLOG目录。例如： gaussdb=# SELECT * FROM gs_download_obs_archive_file('ssh','dn1/pg_xlog/000000010000000000000019_02_01_00000000_00000000_00000003','/data/gauss/log/stwang/test'); gs_download_obs_archive_file ------------------------------ (1 row)

备份控制函数 备份控制函数可帮助进行在线备份。 pg_create_restore_point(name text) 描述：为执行恢复创建一个命名点。需要管理员角色权限。 返回值类型：text 备注：pg_create_restore_point创建了一个可以用作恢复目的、有命名的事务日志记录，并返回相应的事务日志位置。在恢复过程中，recovery_target_name可以通过这个名称定位对应的日志恢复点，并从此处开始执行恢复操作。避免使用相同的名称创建多个恢复点，因为恢复操作将在第一个匹配（恢复目标）的名称上停止。 pg_current_xlog_location() 描述：获取当前事务日志的写入位置。 返回值类型：text 备注：pg_current_xlog_location使用与前面那些函数相同的格式显示当前事务日志的写入位置。如果是只读操作，不需要系统管理员权限。 pg_current_xlog_insert_location() 描述：获取当前事务日志的插入位置。 返回值类型：text 备注：pg_current_xlog_insert_location显示当前事务日志的插入位置。插入点是事务日志在某个瞬间的“逻辑终点”，而实际的写入位置则是从服务器内部缓冲区写出时的终点。写入位置是可以从服务器外部检测到的终点，如果要归档部分完成事务日志文件，则该操作即可实现。插入点主要用于服务器调试目的。如果是只读操作，不需要系统管理员权限。 gs_current_xlog_insert_end_location() 描述：获取当前事务日志的插入位置。 返回值类型：text 备注：gs_current_xlog_insert_end_location显示当前事务日志的实际插入位置。 pg_start_backup(label text [, fast boolean ]) 描述：开始执行在线备份。需要管理员角色、复制的角色或运维管理员角色打开operation_mode。 返回值类型：text 备注：pg_start_backup接受一个用户定义的备份标签（通常这是备份转储文件存放地点的名称）。这个函数向数据库的数据目录写入一个备份标签文件，然后以文本方式返回备份的事务日志起始位置。 1 2 3 4 5 gaussdb=# SELECT pg_start_backup('label_goes_here'); pg_start_backup ----------------- 0/3000020 (1 row) pg_stop_backup() 描述：完成执行在线备份。需要管理员角色、复制的角色或运维管理员角色打开operation_mode。 返回值类型：text 备注：pg_stop_backup删除pg_start_backup创建的标签文件，并且在事务日志归档区里创建一个备份历史文件。这个历史文件包含给予pg_start_backup的标签、备份的事务日志起始与终止位置、备份的起始和终止时间。返回值是备份的事务日志终止位置。计算出中止位置后，当前事务日志的插入点将自动前进到下一个事务日志文件，结束的事务日志文件可以被立即归档从而完成备份。 pg_switch_xlog() 描述：切换到一个新的事务日志文件。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：text 备注：pg_switch_xlog移动到下一个事务日志文件，以允许将当前日志文件归档（假定使用连续归档）。返回值是刚完成的事务日志文件的事务日志结束位置+1。如果从最后一次事务日志切换以来没有活动的事务日志，则pg_switch_xlog不进行移动操作，直接返回当前事务日志文件的开始位置。 pg_xlogfile_name(location text) 描述：将事务日志的位置字符串转换为文件名。 返回值类型：text 备注：pg_xlogfile_name仅抽取事务日志文件名称。如果给定的事务日志位置恰好位于事务日志文件的交界上，这两个函数都返回前一个事务日志文件的名称。这对于管理事务日志归档来说是非常有利的，因为前一个文件是当前最后一个需要归档的文件。 pg_xlogfile_name_offset(location text) 描述：将事务日志的位置字符串转换为文件名并返回在文件中的字节偏移量。 返回值类型：text,integer 备注：可以使用pg_xlogfile_name_offset从前述函数的返回结果中抽取相应的事务日志文件名称和字节偏移量。例如： 1 2 3 4 5 6 7 gaussdb=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); NOTICE: pg_stop_backup cleanup done, waiting for required WAL segments to be archived NOTICE: pg_stop_backup complete, all required WAL segments have been archived file_name | file_offset --------------------------+------------- 000000010000000000000003 | 272 (1 row) pg_xlog_location_diff(location text, location text) 描述：计算两个事务日志位置之间在字节上的区别。 返回值类型：numeric pg_cbm_start_tracked_location() 描述：用于查询cbm解析的起始lsn位置。 返回值类型：text pg_cbm_tracked_location() 描述：用于查询cbm解析到的lsn位置。 返回值类型：text pg_cbm_get_merged_file(startLSNArg text, endLSNArg text) 描述：用于将指定lsn范围之内的cbm文件合并成一个cbm文件，并返回合并完的cbm文件名。 返回值类型：text 备注：必须是系统管理员或运维管理员才能获取cbm合并文件。 pg_cbm_get_changed_block(startLSNArg text, endLSNArg text) 描述：用于将指定lsn范围之内的cbm文件合并成一个表，并返回表的各行记录。 返回值类型：records 备注：pg_cbm_get_changed_block返回的表字段包含：合并起始的lsn、合并截止的lsn、表空间oid、库oid、表的relfilenode、表的fork number、表是否为系统表、表是否被删除、表是否被创建、表是否被截断、表被截断后的页面数、有多少页被修改以及被修改的页号的列表。 pg_cbm_recycle_file(targetLSNArg text) 描述：删除不再使用的cbm文件，并返回删除后的第一条lsn。 返回值类型：text pg_cbm_force_track(targetLSNArg text,timeOut int) 描述：强制执行一次cbm追踪到指定的xlog位置，并返回实际追踪结束点的xlog位置。 返回值类型：text pg_enable_delay_ddl_recycle() 描述：开启延迟DDL功能，并返回开启点的xlog位置。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：text pg_disable_delay_ddl_recycle(barrierLSNArg text, isForce bool) 描述：关闭延迟DDL功能，并返回本次延迟DDL生效的xlog范围。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：records pg_enable_delay_xlog_recycle() 描述：开启延迟xlog回收功能，数据库主节点修复使用。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：void pg_disable_delay_xlog_recycle() 描述：关闭延迟xlog回收功能，数据库主节点修复使用。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：void pg_cbm_rotate_file(rotate_lsn text) 描述：等待cbm解析到rotate_lsn之后，强制切换文件，在build期间调用。 返回值类型：void。 gs_roach_stop_backup(backupid text) 描述：停止一个内部备份工具GaussRoach开启的备份。与pg_stop_backup系统函数类似，但更轻量。 返回值类型：text，内容为当前日志的插入位置。 gs_roach_enable_delay_ddl_recycle(backupid name) 描述：开启延迟DDL功能，并返回开启点的日志位置。与pg_enable_delay_ddl_recycle系统函数类似，但更轻量。并且，通过传入不同的backupid，可以支持并发打开延迟DDL。 返回值类型：text，内容为返回开启点的日志位置。 gs_roach_disable_delay_ddl_recycle(backupid text) 描述：关闭延迟DDL功能，并返回本次延迟DDL生效的日志范围。与pg_enable_delay_ddl_recycle系统函数类似，但更轻量。并且，通过传入不同的backupid，可以支持并发关闭延迟DDL功能。 返回值类型：records，内容为本次延迟DDL生效的日志范围。 gs_roach_switch_xlog(request_ckpt bool) 描述：切换当前使用的日志段文件，并且，如果request_ckpt为true，则触发一个全量检查点。 返回值类型：text，内容为切段日志的位置。 gs_block_dw_io(timeout int, identifier text) 描述：阻塞双写页面刷盘。 参数说明： timeout 阻塞时长。 取值范围：[0, 3600]（秒），0为阻塞时长为0。 identifier 此次操作的标识。 取值范围：字符串，不支持除大小写字母、数字以及下划线(_)以外的字符。 返回值类型：bool 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。 gs_is_dw_io_blocked() 描述：查看当前双写页面刷盘是否被阻塞，如果处于阻塞中则返回true。 返回值类型：bool 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。 gs_pitr_advance_last_updated_barrier() 描述：在PITR模式下，强制推进上次上传到OBS/NAS介质中的全局最大已归档恢复点到当前点，无入参。 返回值类型：text 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。同时只能在集中式的主DN上使用才有效。返回值为当前推进到的最新本地最大已归档恢复点。 gs_pitr_clean_local_barrier_files('delete_timestamp') 描述：清理本地缓存的barrier记录文件。 参数范围：delete_timestamp参数类型为text，为linux时间戳，长度为10位。 返回值类型：text 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。返回的结果是删除后本地最老barrier文件的开始时间戳。

服务器信号函数 服务器信号函数向其他服务器进程发送控制信号。只有系统管理员有权执行以下函数。 pg_cancel_backend(pid int) 描述：取消一个后端线程正在执行的语句。 返回值类型：Boolean 备注：pg_cancel_backend向由pid标识的后端进程发送一个查询取消（SIGINT）信号。一个活动的后端进程的PID可以从pg_stat_activity视图的pid字段找到，或者在服务器上用ps列出数据库进程。具有SYSADMIN权限的用户，后端进程所连接的数据库的属主，后端进程的属主或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。 pg_cancel_session(pid bigint, sessionid bigint) 描述：线程池模式下，取消一个活跃状态会话正在执行的语句。 返回值类型：Boolean 备注：pg_cancel_session的入参可以通过pg_stat_activity中的pid字段和sessionid的字段查询，可以用于清理线程池模式下，活跃状态会话正在执行的语句。当入参pid和sessionid相同，且均为线程id时，功能和pg_cancel_backend相同。 pg_reload_conf() 描述：导致所有服务器进程重新装载它们的配置文件。 返回值类型：Boolean 备注：pg_reload_conf给服务器发送一个SIGHUP信号，导致所有服务器进程重新装载配置文件。 pg_rotate_logfile() 描述：滚动服务器的日志文件。 返回值类型：Boolean 备注：pg_rotate_logfile给日志文件管理器发送信号，使之立即切换到一个新的输出文件。这个函数只有在redirect_stderr用于日志输出的时候才有用，否则不会产生日志文件管理器子进程。 pg_terminate_backend(pid int) 描述：终止一个后台线程。 返回值类型：Boolean 备注：如果成功，函数返回true，否则返回false。具有SYSADMIN权限的用户，后端线程所连接的数据库的属主，后端线程的属主或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。若执行该函数后未成功终止目标会话，则会强制关闭该会话和客户端的socket连接。 该函数可终止非线程池的线程、活跃状态的线程池线程，但无法终止非活跃状态的线程池线程。 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT pid from pg_stat_activity; pid ----------------- 140657876268816 (1 rows) gaussdb=# SELECT pg_terminate_backend(140657876268816); pg_terminate_backend ---------------------- t (1 row) pg_terminate_session(pid int64, sessionid int64) 描述：线程池模式下，终止一个后台session。 返回值类型：Boolean 备注：如果成功，函数返回true，否则返回false。具有SYSADMIN权限的用户、会话所连接的数据库的属主、会话的属主、或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。若执行该函数后未成功终止目标会话，则会强制关闭该会话和客户端的socket连接。 当入参pid和sessionid相同，且均为线程id时，该函数可终止非线程池的线程、活跃状态的线程池线程。 当入参pid和sessionid不同时，该函数可终止活跃状态的会话，或关闭非活跃状态会话和客户端的socket连接。 pg_terminate_active_session_socket(pid int64, sessionid int64) 描述：关闭一个活跃session和客户端的socket连接。 返回值类型：Boolean 备注：如果成功，函数返回true，否则返回false。具有SYSADMIN权限的用户、后端线程所连接的数据库的属主、后端线程的属主或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。 父主题： 系统管理函数

通用文件访问函数 通用文件访问函数提供了对数据库服务器上的文件的本地访问接口。只有数据库目录和log_directory目录里面的文件可以访问。使用相对路径访问数据库目录里面的文件，以及匹配log_directory配置而设置的路径访问日志文件。只有数据库初始化用户才能使用这些函数。 pg_ls_dir(dirname text) 描述：列出目录中的文件。 返回值类型：setof text 备注：pg_ls_dir返回指定目录里面的除了特殊项“.”和“..”之外所有名称。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 gaussdb=# SELECT pg_ls_dir('./'); pg_ls_dir ---------------------- .postgresql.conf.swp postgresql.conf pg_tblspc PG_VERSION pg_ident.conf core server.crt pg_serial pg_twophase postgresql.conf.lock pg_stat_tmp pg_notify pg_subtrans pg_ctl.lock pg_xlog pg_clog base pg_snapshots postmaster.opts postmaster.pid server.key.rand server.key.cipher pg_multixact pg_errorinfo server.key pg_hba.conf pg_replslot .pg_hba.conf.swp cacert.pem pg_hba.conf.lock global gaussdb.state (32 rows) pg_read_file(filename text, offset bigint, length bigint) 描述：返回一个文本文件的内容。 返回值类型：text 备注：pg_read_file返回一个文本文件的一部分，从offset开始，最多返回length字节（如果先达到文件结尾，则小于这个数值）。如果offset是负数，则它是相对于文件结尾回退的长度。如果省略了offset和length，则返回整个文件。 示例： 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT pg_read_file('postmaster.pid',0,100); pg_read_file --------------------------------------- 53078 + /srv/BigData/hadoop/data1/dbnode+ 1500022474 + 8000 + /var/run/ FusionInsight + localhost + 2 (1 row) pg_read_binary_file(filename text [, offset bigint, length bigint,missing_ok boolean]) 描述：返回一个二进制文件的内容。 返回值类型：bytea 备注：pg_read_binary_file的功能与pg_read_file类似，除了结果的返回值为bytea类型不一致，相应地不会执行编码检查。与convert_from函数结合，这个函数可以用来读取用指定编码的一个文件。 1 gaussdb=# SELECT convert_from(pg_read_binary_file('filename'), 'UTF8'); pg_stat_file(filename text) 描述：返回一个文本文件的状态信息。 返回值类型：record 备注：pg_stat_file返回一条记录，其中包含：文件大小、最后访问时间戳、最后更改时间戳、最后文件状态修改时间戳以及标识传入参数是否为目录的Boolean值。典型的用法： 1 gaussdb=# SELECT * FROM pg_stat_file('filename'); 1 gaussdb=# SELECT (pg_stat_file('filename')).modification; 示例： 1 2 3 4 5 6 7 8 9 10 11 12 gaussdb=# SELECT convert_from(pg_read_binary_file('postmaster.pid'), 'UTF8'); convert_from -------------------------------------- 4881 + /srv/BigData/gaussdb/data1/dbnode+ 1496308688 + 25108 + /opt/user/Bigdata/gaussdb/gaussdb_tmp + * + 25108001 43352069 + (1 row) 1 2 3 4 5 6 7 8 9 gaussdb=# SELECT * FROM pg_stat_file('postmaster.pid'); size | access | modification | change | creation | isdir ------+------------------------+------------------------+------------------------ +----------+------- 117 | 2017-06-05 11:06:34+08 | 2017-06-01 17:18:08+08 | 2017-06-01 17:18:08+08 | | f (1 row) 1 2 3 4 5 gaussdb=# SELECT (pg_stat_file('postmaster.pid')).modification; modification ------------------------ 2017-06-01 17:18:08+08 (1 row) 父主题： 系统管理函数

配置设置函数 配置设置函数是可以用于查询以及修改运行时配置参数的函数。 current_setting(setting_name) 描述：当前的设置值。 返回值类型：text 备注：current_setting用于以查询形式获取setting_name的当前值。和SQL语句SHOW是等效的。比如： 1 2 3 4 5 6 gaussdb=# SELECT current_setting('datestyle'); current_setting ----------------- ISO, MDY (1 row) set_working_grand_version_num_manually(tmp_version) 描述：通过切换授权版本号来更新和升级数据库的新特性。 返回值类型：void shell_in(type) 描述： 为shell类型输入路由（那些尚未填充的类型）。 返回值类型：void shell_out(type) 描述：为shell 类型输出路由（那些尚未填充的类型）。 返回值类型：void set_config(setting_name, new_value, is_local) 描述：设置参数并返回新值。 返回值类型：text 备注：set_config将参数setting_name设置为new_value。如果is_local为true，则new_value将只应用于当前事务。如果希望new_value应用于当前会话，可以使用false，和SQL语句SET是等效的。例如： 1 2 3 4 5 6 gaussdb=# SELECT set_config('log_statement_stats', 'off', false); set_config ------------ off (1 row) 父主题： 系统管理函数

注释信息函数 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中所有数据库的全局表，因此这些表的注释也是全局存储的。

事务ID和快照 内部事务ID类型（xid）是64位。这些函数使用的数据类型txid_snapshot，存储在特定时刻事务ID可见性的信息。其组件描述在表12。 表12 快照组件 名称 描述 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。 以下的函数在一个输出形式中提供服务器事务信息。这些函数的主要用途是为了确定在两个快照之间有哪个事务提交。 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, oid，text get_remote_prepared_xacts() 描述：获取所有远程节点两阶段残留事务信息，包括事务id，两阶段gid名称，prepared的时间，owner的名称，database的名称及node_name。 返回类型：xid, text, timestamptz, name, name，text global_clean_prepared_xacts(text, text) 描述：并发清理两阶段残留事务，仅GaussDB分布式场景下gs_clean工具可以调用清理，其他用户调用均返回false。 返回类型：Boolean gs_get_next_xid_csn() 描述：返回全局所有节点上的next_xid和next_csn值。 返回值如下： 表13 gs_get_next_xid_csn返回参数说明 字段名 描述 nodename 节点名称。 next_xid 当前节点下一个事务id号。 next_csn 当前节点下一个csn号。

系统表信息函数 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 gaussdb-# (prod_id NUMBER(6), gaussdb(# cust_id NUMBER, gaussdb(# time_id DATE, gaussdb(# channel_id CHAR(1), gaussdb(# promo_id NUMBER(6), gaussdb(# quantity_sold NUMBER(3), gaussdb(# amount_sold NUMBER(10,2) gaussdb(# ) PARTITION BY RANGE( time_id) INTERVAL('1 day') gaussdb-# ( gaussdb(# partition p1 VALUES LESS THAN ('2019-02-01 00:00:00'), gaussdb(# partition p2 VALUES LESS THAN ('2019-02-02 00:00:00') gaussdb(# ); 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) + TO GROUP group1; (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) + TO GROUP group1; (1 row) 返回类型：text 备注：pg_get_tabledef重构出表定义的CREATE语句，包含了表定义本身、索引信息、comments信息。对于表对象依赖的group、schema、tablespace、server等信息，需要用户自己去创建，表定义里不会有这些对象的创建语句。 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) 描述：获取表空间所在的文件系统的路径。 返回类型：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返回传递给他的值的排序。 示例： 1 2 3 4 5 gaussdb=# SELECT collation for (description) FROM pg_description LIMIT 1; pg_collation_for ------------------ "default" (1 row) 值可能是引号括起来的并且模式限制的。如果没有为参数表达式排序，则返回一个null值。如果参数不是排序的类型，则抛出一个错误。 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) gs_get_sequence_parameters(sequence_oid) 描述：获取指定sequence的参数，包含起始值，最小值和最大值，递增值等。该函数针对无权限的sequence返回null值。 返回类型：int16, int16, int16, int16, Boolean 示例： gaussdb=# SELECT * FROM gs_get_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) 描述：指定用户是否有访问表任何列的权限。 表1 参数类型说明 参数名 合法入参类型 user name, oid table text, oid privilege text 返回类型：Boolean has_any_column_privilege(table, privilege) 描述：当前用户是否有访问表任何列的权限，合法参数类型见表1。 返回类型：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) 描述：指定用户是否有访问列的权限。 表2 参数类型说明 参数名 合法入参类型 user name, oid table text, oid column text, smallint privilege text 返回类型：Boolean has_column_privilege(table, column, privilege) 描述：当前用户是否有访问列的权限，合法参数类型见表2。 返回类型：Boolean 备注：has_column_privilege检查用户是否以特定方式访问一列。其参数类似于has_table_privilege，可以通过列名或属性号添加列。想要的访问权限类型必须是SELECT、INSERT、UPDATE、COMMENT或REFERENCES的一些组合。 拥有表的表级别权限则隐含的拥有该表每列的列级权限。 has_cek_privilege(user, cek, privilege) 描述：指定用户是否有访问列加密密钥CEK的权限。参数说明如下。 表3 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 cek text，oid 列加密密钥 列加密密钥名称或id。 privilege text 权限 USAGE：允许使用指定列加密密钥。 DROP：允许删除指定列加密密钥。 返回类型：Boolean has_cmk_privilege(user, cmk, privilege) 描述：指定用户是否有访问客户端加密主密钥CMK的权限。参数说明如下。 表4 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 cmk text，oid 客户端加密主密钥 客户端加密主密钥名称或id。 privilege text 权限 USAGE：允许使用指定客户端加密主密钥。 DROP：允许删除指定客户端加密主密钥。 返回类型：Boolean has_database_privilege(user, database, privilege) 描述：指定用户是否有访问数据库的权限。参数说明如下。 表5 参数类型说明 参数名 合法入参类型 user name, oid database text, oid privilege text 返回类型：Boolean has_database_privilege(database, privilege) 描述：当前用户是否有访问数据库的权限，合法参数类型请参见表5。 返回类型：Boolean 备注：has_database_privilege检查用户是否能以在特定方式访问数据库。其参数类似has_table_privilege。访问权限类型必须是CREATE、CONNECT、TEMPORARY、ALTER、DROP、COMMENT或TEMP（等价于TEMPORARY）的一些组合。 has_directory_privilege(user, directory, privilege) 描述：指定用户是否有访问directory的权限。 表6 参数类型说明 参数名 合法入参类型 user name, oid directory text, oid privilege text 返回类型：Boolean has_directory_privilege(directory, privilege) 描述：当前用户是否有访问directory的权限，合法参数类型请参见表6。 返回类型：Boolean has_foreign_data_wrapper_privilege(user, fdw, privilege) 描述：指定用户是否有访问外部数据封装器的权限。 表7 参数类型说明 参数名 合法入参类型 user name, oid fdw text, oid privilege text 返回类型：Boolean has_foreign_data_wrapper_privilege(fdw, privilege) 描述：当前用户是否有访问外部数据封装器的权限。合法参数类型请参见表7。 返回类型：Boolean 备注：has_foreign_data_wrapper_privilege检查用户是否能以特定方式访问外部数据封装器。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_function_privilege(user, function, privilege) 描述：指定用户是否有访问函数的权限。 表8 参数类型说明 参数名 合法入参类型 user name, oid function text, oid privilege text 返回类型：Boolean has_function_privilege(function, privilege) 描述：当前用户是否有访问函数的权限。合法参数类型请参见表8。 返回类型：Boolean 备注：has_function_privilege检查一个用户是否能以指定方式访问一个函数。其参数类似has_table_privilege。使用文本字符而不是OID声明一个函数时，允许输入的类型和regprocedure数据类型一样（请参考对象标识符类型）。访问权限类型必须是EXECUTE、ALTER、DROP或COMMENT。 has_language_privilege(user, language, privilege) 描述：指定用户是否有访问语言的权限。 表9 参数类型说明 参数名 合法入参类型 user name, oid language text, oid privilege text 返回类型：Boolean has_language_privilege(language, privilege) 描述：当前用户是否有访问语言的权限。合法参数类型请参见表9。 返回类型：Boolean 备注：has_language_privilege检查用户是否能以特定方式访问一个过程语言。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_nodegroup_privilege(user, nodegroup, privilege) 描述：检查用户是否有数据库节点访问权限。 返回类型：Boolean 表10 参数类型说明 参数名 合法入参类型 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的一些组合。 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'的值。 返回值类型：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) 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, ...] 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，查找表空间名称。 返回值类型：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 503.1.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_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() 描述：返回客户端信息。 返回值类型：record

条件表达式函数 coalesce(expr1, expr2, ..., exprn) 描述： 返回参数列表中第一个非NULL的参数值。 COALESCE(expr1, expr2) 等价于CASE WHEN expr1 IS NOT NULL THEN expr1 ELSE expr2 END。 示例： 1 2 3 4 5 gaussdb=# SELECT coalesce(NULL,'hello'); coalesce ---------- hello (1 row) 备注： 如果表达式列表中的所有表达式都等于NULL，则本函数返回NULL。 它常用于在显示数据时用缺省值替换NULL。 和CASE表达式一样，COALESCE不会计算不需要用来判断结果的参数；即在第一个非空参数右边的参数不会被计算。 decode(base_expr, compare1, value1, Compare2,value2, … default) 描述：把base_expr与后面的每个compare(n) 进行比较，如果匹配返回相应的value(n)。如果没有发生匹配，则返回default。 示例： 1 2 3 4 5 gaussdb=# SELECT decode('A','A',1,'B',2,0); case ------ 1 (1 row) 备注： 不支持对xml数据类型的操作 nullif(expr1, expr2) 描述：当且仅当expr1和expr2相等时，NULLIF才返回NULL，否则它返回expr1。 nullif(expr1, expr2) 逻辑上等价于CASE WHEN expr1 = expr2 THEN NULL ELSE expr1 END。 示例： 1 2 3 4 5 gaussdb=# SELECT nullif('hello','world'); nullif -------- hello (1 row) 备注： 不支持对xml数据类型的操作。 如果两个参数的数据类型不同，则： 若两种数据类型之间存在隐式转换，则以其中优先级较高的数据类型为基准将另一个参数隐式转换成该类型，转换成功则进行计算，转换失败则返回错误。如： 1 2 3 4 5 gaussdb=# SELECT nullif('1234'::VARCHAR,123::INT4); nullif -------- 1234 (1 row) 1 2 gaussdb=# SELECT nullif('1234'::VARCHAR,'2012-12-24'::DATE); ERROR: invalid input syntax for type timestamp: "1234" 若两种数据类型之间不存在隐式转换，则返回错误。如： 1 2 3 4 5 gaussdb=# SELECT nullif(TRUE::BOOLEAN,'2012-12-24'::DATE); ERROR: operator does not exist: boolean = timestamp without time zone LINE 1: SELECT nullif(TRUE::BOOLEAN,'2012-12-24'::DATE) FROM sys_dummy; ^ HINT: No operator matches the given name and argument type(s). You might need to add explicit type casts. nvl( expr1 , expr2 ) 描述： 如果expr1为NULL则返回expr2。 如果expr1非NULL，则返回expr1。 示例： 1 2 3 4 5 gaussdb=# SELECT nvl('hello','world'); nvl ------- hello (1 row) 备注：参数expr1和expr2可以为任意类型，当NVL的两个参数不属于同类型时，看第二个参数是否可以向第一个参数进行隐式转换。如果可以则返回第一个参数类型，否则返回错误。 nvl2( expr1 , expr2，expr3 ) 描述： 如果expr1为NULL，则返回expr3。 如果expr1非NULL，则返回expr2。 此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下有效。 示例： 1 2 3 4 5 gaussdb=# SELECT nvl2('hello','world','other'); case ------- world (1 row) 备注：参数expr2和expr3可以为任意类型， 当NVL2的后面两个参数不属于同类型时，看expr3参数是否可以向expr2参数进行隐式转换，如果不能隐式转换，会返回错误。如果第一个参数是数值类型，函数在将本参数和其他参数都转换为numeric类型，然后进行比较，对于不能转换的，提示出错信息；第一个参数是其他类型的，函数将其他参数都转换为第一个参数的类型进行比较，对于不能转换的，提示出错信息。 greatest(expr1 [, ...]) 描述：获取并返回参数列表中值最大的表达式的值。 返回值类型： 示例： 1 2 3 4 5 gaussdb=# SELECT greatest(1*2,2-3,4-1); greatest ---------- 3 (1 row) 1 2 3 4 5 gaussdb=# SELECT greatest('HARRY', 'HARRIOT', 'HAROLD'); greatest ---------- HARRY (1 row) 备注： 不支持对xml数据类型的操作。 此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下： 如果参数中有任意一个参数的值为null，函数返回null。 如果第一个参数是数值类型，函数将第一个参数和其他参数都转换为numeric类型，然后进行比较，对于不能转换的，提示出错信息；第一个参数是其他类型的，函数将其他参数都转换为第一个参数的类型进行比较，对于不能转换的，提示出错信息。 least(expr1 [, ...]) 描述：获取并返回参数列表中值最小的表达式的值。 示例： 1 2 3 4 5 gaussdb=# SELECT least(1*2,2-3,4-1); least ------- -1 (1 row) 1 2 3 4 5 gaussdb=# SELECT least('HARRY','HARRIOT','HAROLD'); least -------- HAROLD (1 row) 备注： 不支持对xml数据类型的操作。 此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下： 如果参数中有任意一个参数的值为null，函数返回null。 如果第一个参数是数值类型，函数将第一个参数和其他参数都转换为numeric类型，然后进行比较，对于不能转换的，提示出错信息；第一个参数是其他类型的，函数将其他参数都转换为第一个参数的类型进行比较，对于不能转换的，提示出错信息。 EMPTY_BLOB() 描述：使用EMPTY_BLOB在INSERT或UPDATE语句中初始化一个BLOB变量，取值为NULL。 返回值类型：BLOB 示例： 1 2 3 4 5 6 --新建表 gaussdb=# CREATE TABLE blob_tb(b blob,id int); --插入数据 gaussdb=# INSERT INTO blob_tb VALUES (empty_blob(),1); --删除表 gaussdb=# DROP TABLE blob_tb; 备注：使用DBE_LOB.GET_LENGTH求得的长度为0。 EMPTY_CLOB() 描述：使用EMPTY_CLOB在INSERT或UPDATE语句中初始化一个CLOB变量，取值为空。 此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下有效。 返回值类型：CLOB 示例： 1 2 3 4 5 6 --新建表 gaussdb=# CREATE TABLE clob_tb(c clob,id int); --插入数据 gaussdb=# INSERT INTO clob_tb VALUES (empty_clob(),1); --删除表 gaussdb=# DROP TABLE clob_tb; 备注：使用DBE_LOB.GET_LENGTH求得的长度为0。 lnnvl(condition) 描述：lnnvl用于某个查询语句的where子句中，如果条件为true就返回false，如果条件为unknown或者false，就返回true。 condition：必须为逻辑表达式，但不能用于复合条件如and，or或者between。 返回类型：bool 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 --新建表 gaussdb=# CREATE TABLE student_demo (name VARCHAR2(20), grade NUMBER(10,2)); CREATE TABLE --插入数据 gaussdb=# INSERT INTO student_demo VALUES ('name0',0); INSERT 0 1 gaussdb=# INSERT INTO student_demo VALUES ('name1',1); INSERT 0 1 gaussdb=# INSERT INTO student_demo VALUES ('name2',2); INSERT 0 1 --调用lnnvl gaussdb=# SELECT * FROM student_demo WHERE LNNVL(name = 'name1'); name | grade -------+------- name0 | 0.00 name2 | 2.00 (2 rows) --删除表 gaussdb=# DROP TABLE student_demo; DROP TABLE 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下生效。

序列号生成函数 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（与参数类型相同）

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