华为云用户手册

废弃函数 GaussDB中下列函数在最新版本中已废弃： gs_wlm_get_session_info gs_wlm_get_user_session_info check_engine_status encode_plan_node model_train_opt gs_stat_get_wlm_plan_operator_info track_model_train_opt array_extend dbe_perf.global_slow_query_info dbe_perf.global_slow_query_info_bytime dbe_perf.global_slow_query_history pg_reload_conf pg_rotate_logfile gs_stat_ustore 父主题： 函数和操作符

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 示例： 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_miss | rel_count | rel_dead | rel_memory | part_searches | part_hits | part_miss | part_count | part_dead | part_memory | total_memory | swapout_count | refcount-------------+---------------+--------------+----------+----------+-----------+----------+------------+--------------+----------+----------+-----------+----------+------------+---------------+-----------+-----------+------------+-----------+-------------+--------------+---------------+---------- 0 | | 300 | 235 | 31 | 22 | 2 | 9752 | 598 | 108 | 18 | 18 | 0 | 77720 | 0 | 0 | 0 | 0 | 0 | 0 | 752912 | 0 | 0 16574 | testdb | 3368 | 2289 | 329 | 273 | 0 | 92593 | 1113 | 524 | 48 | 48 | 0 | 340456 | 0 | 0 | 0 | 0 | 0 | 0 | 4124792 | 0 | 10(2 rows) 父主题： 函数和操作符

hotkey特性函数 gs_stat_get_hotkeys_info() 描述：获取本地节点查询的热词信息。 返回值类型：Tuple 示例： 123456 gaussdb=# select * from gs_stat_get_hotkeys_info() order by count, hash_value; database_name | schema_name | table_name | key_value | hash_value | count ---------------+-------------+-------------------+-----------+------------+------- regression | public | hotkey_single_col | {22} | 1858004829 | 2 regression | public | hotkey_single_col | {11} | 2011968649 | 2(2 rows) gs_stat_clean_hotkeys() 描述：清理hotkey缓存，重置hotkey状态信息。 返回值类型：bool, 恒为true 示例： 12345 gaussdb=# select * from gs_stat_clean_hotkeys(); gs_stat_clean_hotkeys ----------------------- t(1 row) 父主题： 函数和操作符

动态数据脱敏函数 该函数为内部功能调用函数。 creditcardmasking(col text, letter char default 'x') 描述：将col字符串后四位之前的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text basicmailmasking(col text, letter char default 'x') 描述：将col字符串中第一个'@'之前的字符使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text fullmailmasking(col text, letter char default 'x') 描述：将col字符串中出现最后一个'.'之前的字符(除'@'外)使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text alldigitsmasking(col text, letter char default '0') 描述：将col字符串中出现的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text shufflemasking(col text) 描述：将col字符串中的字符乱序排列。 参数：待替换的字符串、替换字符。 返回值类型：text randommasking(col text) 描述：将col字符串中的字符随机化。 参数：待替换的字符串、替换字符。 返回值类型：text regexpmasking(col text, reg text, replace_text text, pos INTEGER default 0, reg_len INTEGER default -1) 描述：将col字符串使用正则表达式替换。 参数：待替换的字符串、正则表达式、替换的起始位置、替换长度、。 返回值类型：text 父主题： 函数和操作符

重分布函数 以下函数为重分布期间gs_redis工具所用的系统函数，用户不要主动调用： pg_get_redis_rel_end_ctid(text, name, int, int) pg_get_redis_rel_start_ctid(text, name, int, int) pg_enable_redis_proc_cancelable() pg_disable_redis_proc_cancelable() pg_tupleid_get_blocknum(tid) pg_tupleid_get_offset(tid) pg_tupleid_get_ctid_to_bigint (ctid) 以下函数均针对时序表（当前特性是实验室特性，使用时请联系华为工程师提供技术支持），所指oid均只针对时序表： redis_ts_table(oid) 描述：以表cpu为例，将old表（redis_old_cpu）的数据逐步转移到新的表(redis_new_cpu)，从时间线最后的一个partition开始转移，并在redis_old_cpu的一个partition为空时将此partition删除，在仅余一个partition时将old表删除，并将表恢复至原cpu，为下述job所调用，用户无需手动调用。 返回值类型：void 表1 redis_ts_table参数说明 参数 类型 说明 是否必选 old_oid oid redis_old_cpu的标识。 是 cancel_unuse_redis() 描述：取消时序表（当前特性是实验室特性，使用时请联系华为工程师提供技术支持）重分布。 返回值：void submit_redis_task(oid, interval) 描述：调用函数redis_ts_table，对一个表只允许调用一个job，如需修改，需要先停止该job，再重新调用。 参数：以表cpu为例，参见表2。 返回值类型：void 表2 submit_redis_task参数说明 参数 类型 说明 是否必选 old_oid oid redis_old_cpu的标识。 是 schedule_interval interval 用来计算dbe_task.submit中传入的interval_time，代表此job每间隔多长时间执行一次。 否 submit_all_redis_task(interval) 描述：对于当前连接数据库中所有未完成重分布的表调用函数submit_redis_task。 返回值类型：void 表3 submit_all_redis_task参数说明 参数 类型 说明 是否必选 schedule_interval interval 与submit_redis_task的入参schedule_interval为一个含义。 否 cancel_redis_task(oid) 描述：当某表已转移完成，停止该表的转移的job。 参数：以表cpu为例，为redis_old_cpu的oid。 返回值类型：void cancel_all_redis_task() 描述：对当前连接数据库的所有时序表（当前特性是实验室特性，使用时请联系华为工程师提供技术支持），停止所有在转移的job。 返回值类型：void submit_cancel_redis_task(interval) 描述：对当前连接数据库的所有时序表（当前特性是实验室特性，使用时请联系华为工程师提供技术支持）创建job，调用函数cancel_redis_task。 参数：间隔多长时间调用此job，默认值1h。 返回值类型：void flush_depend_rule(oid) 描述：以cpu表为例，如果用户直接对redis_old_cpu表和redis_new_cpu执行了某些sql，原rule不能正常工作，可以通过此函数重建相关rule，当前创建rule的语句在pg_rules系统表中，不建议用户作允许的操作以外的行为，直接在redis_new_cpu和redis_old_cpu上执行sql，可能会造成未知错误。 参数：以表cpu为例，为表cpu的oid。 返回值类型：void 父主题： 函数和操作符

关键字 SQL里有保留字和非保留字之分。根据标准，保留字决不能用做其他标识符。非保留字只是在特定的环境里有特殊的含义，而在其他环境里是可以用做标识符的。 表1 SQL关键字 关键字 GaussDB SQL:1999 SQL-92 ABORT 非保留 - - ABS - 非保留 - ABSOLUTE 非保留 保留 保留 ACCESS 非保留 - - ACCOUNT 非保留 - - ACTION 非保留 保留 保留 ADA - 非保留 非保留 ADD 非保留 保留 保留 ADMIN 非保留 保留 - AFTER 非保留 保留 - AGGREGATE 非保留 保留 - ALGORITHM 非保留 - - ALIAS - 保留 - ALL 保留 保留 保留 ALLOCATE - 保留 保留 ALSO 非保留 - - ALTER 非保留 保留 保留 ALWAYS 非保留 - - ANALYSE 保留 - - ANALYZE 保留 - - AND 保留 保留 保留 ANY 保留 保留 保留 APP 非保留 - - APPEND 非保留 - - ARCHIVE 非保留 - - ARE - 保留 保留 ARRAY 保留 保留 - AS 保留 保留 保留 ASC 保留 保留 保留 ASENSITIVE - 非保留 - ASSERTION 非保留 保留 保留 ASSIGNMENT 非保留 非保留 - ASYMMETRIC 保留 非保留 - AT 非保留 保留 保留 ATOMIC - 非保留 - ATTRIBUTE 非保留 - - AUDIT 非保留 - - AUTHID 保留 - - AUTHORIZATION 保留(可以是函数或类型) 保留 保留 AUTO_INCREMENT 非保留 - - AUTOEXTEND 非保留 - - AUTOMAPPED 非保留 - - AVG - 非保留 保留 BACKWARD 非保留 - - BARRIER 非保留 - - BEFORE 非保留 保留 - BEGIN 非保留 保留 保留 BEGIN_NON_ANOYBLOCK 非保留 - - BETWEEN 非保留(不能是函数或类型) 非保留 保留 BIGINT 非保留(不能是函数或类型) - - BINARY 保留(可以是函数或类型) 保留 - BINARY_DOUBLE 非保留(不能是函数或类型) - - BINARY_INTEGER 非保留(不能是函数或类型) - - BIT 非保留(不能是函数或类型) 保留 保留 BITVAR - 非保留 - BIT_LENGTH - 非保留 保留 BLANKS 非保留 - - BLOB 非保留 保留 - BLOCKCHAIN 非保留 - - BODY 非保留 - - BOOLEAN 非保留(不能是函数或类型) 保留 - BOTH 保留 保留 保留 BUCKETCNT 非保留(不能是函数或类型) - - BUCKETS 保留 - - BREADTH - 保留 - BY 非保留 保留 保留 BYTEAWITHOUTORDER 非保留(不能是函数或类型) - - BYTEAWITHOUTORDERWITHEQUAL 非保留(不能是函数或类型) - - C - 非保留 非保留 CACHE 非保留 - - CALL 非保留 保留 - CALLED 非保留 非保留 - CANCELABLE 非保留 - - CARDINALITY - 非保留 - CASCADE 非保留 保留 保留 CASCADED 非保留 保留 保留 CASE 保留 保留 保留 CAST 保留 保留 保留 CATALOG 非保留 保留 保留 CATALOG_NAME - 非保留 非保留 CHAIN 非保留 非保留 - CHANGE 非保留 - - CHAR 非保留(不能是函数或类型) 保留 保留 CHARACTER 非保留(不能是函数或类型) 保留 保留 CHARACTERISTICS 非保留 - - CHARACTERSET 非保留 - - CHARACTER_LENGTH - 非保留 保留 CHARACTER_SET_CATALOG - 非保留 非保留 CHARACTER_SET_NAME - 非保留 非保留 CHARACTER_SET_SCHEMA - 非保留 非保留 CHAR_LENGTH - 非保留 保留 CHECK 保留 保留 保留 CHECKED - 非保留 - CHECKPOINT 非保留 - - CLASS 非保留 保留 - CLEAN 非保留 - - CLASS_ORIGIN - 非保留 非保留 CLIENT 非保留 - - CLIENT_MASTER_KEY 非保留 - - CLIENT_MASTER_KEYS 非保留 - - CLOB 非保留 保留 - CLOSE 非保留 保留 保留 CLUSTER 非保留 - - COALESCE 非保留(不能是函数或类型) 非保留 保留 COBOL - 非保留 非保留 COLLATE 保留 保留 保留 COLLATION 保留(可以是函数或类型) 保留 保留 COLLATION_CATALOG - 非保留 非保留 COLLATION_NAME - 非保留 非保留 COLLATION_SCHEMA - 非保留 非保留 COLUMN 保留 保留 保留 COLUMN_ENCRYPTION_KEY 非保留 - - COLUMN_ENCRYPTION_KEYS 非保留 - - COLUMN_NAME - 非保留 非保留 COMMAND_FUNCTION - 非保留 非保留 COMMAND_FUNCTION_CODE - 非保留 - COMMENT 非保留 - - COMMENTS 非保留 - - COMMIT 非保留 保留 保留 COMMITTED 非保留 非保留 非保留 COMPACT 非保留 - - COMPATIBLE_ILLEGAL_CHARS 非保留 - - COMPLETE 非保留 - - COMPRESS 非保留 - - COMPLETION 非保留 - - CONCURRENTLY 保留(可以是函数或类型) - - CONDITION 非保留 - - CONDITION_NUMBER - 非保留 非保留 CONFIGURATION 非保留 - - CONNECT 保留 保留 保留 CONNECTION 非保留 保留 保留 CONSTANT 非保留 - - CONNECTION_NAME - 非保留 非保留 CONSTRAINT 保留 保留 保留 CONSTRAINTS 非保留 保留 保留 CONSTRAINT_CATALOG - 非保留 非保留 CONSTRAINT_NAME - 非保留 非保留 CONSTRAINT_SCHEMA - 非保留 非保留 CONSTRUCTOR - 保留 - CONTAINS - 非保留 - CONTAINING 保留 - - CONTENT 非保留 - - CONTINUE 非保留 保留 保留 CONTVIEW 非保留 - - CONVERSION 非保留 - - CONVERT - 非保留 保留 COORDINATOR 非保留 - - COORDINATORS 非保留 - - COPY 非保留 - - CORRESPONDING - 保留 保留 COST 非保留 - - COUNT - 非保留 保留 CREATE 保留 保留 保留 CROSS 保留(可以是函数或类型) 保留 保留 CSN 保留(可以是函数或类型) - - CSV 非保留 - - CUBE 非保留 保留 - CURRENT 非保留 保留 保留 CURRENT_CATALOG 保留 - - CURRENT_DATE 保留 保留 保留 CURRENT_PATH - 保留 - CURRENT_ROLE 保留 保留 - CURRENT_SCHEMA 保留(可以是函数或类型) - - CURRENT_TIME 保留 保留 保留 CURRENT_TIMESTAMP 保留 保留 保留 CURRENT_USER 保留 保留 保留 CURSOR 非保留 保留 保留 CURSOR_NAME - 非保留 非保留 CYCLE 非保留 保留 - DATA 非保留 保留 非保留 DATABASE 非保留 - - DATAFILE 非保留 - - DATANODE 非保留 - - DATANODES 非保留 - - DATATYPE_CL 非保留 - - DATE 非保留(不能是函数或类型) 保留 保留 DATE_FORMAT 非保留 - - DATETIME_INTERVAL_CODE - 非保留 非保留 DATETIME_INTERVAL_PRECISION - 非保留 非保留 DAY 非保留 保留 保留 DBCOMPATIBILITY 非保留 - - DEALLOCATE 非保留 保留 保留 DEC 非保留(不能是函数或类型) 保留 保留 DECIMAL 非保留(不能是函数或类型) 保留 保留 DECLARE 非保留 保留 保留 DECODE 非保留(不能是函数或类型) - - DEFAULT 保留 保留 保留 DEFAULTS 非保留 - - DEFERRABLE 保留 保留 保留 DEFERRED 非保留 保留 保留 DEFINED - 非保留 - DEFINER 非保留 非保留 - DELETE 非保留 保留 保留 DELIMITER 非保留 - - DELIMITERS 非保留 - - DELTA 非保留 - - DELTAMERGE 保留(可以是函数或类型) - - DEPTH - 保留 - DEREF - 保留 - DESC 保留 保留 保留 DESCRIBE - 保留 保留 DESCRIPTOR - 保留 保留 DESTROY - 保留 - DESTRUCTOR - 保留 - DETERMINISTIC 非保留 保留 - DIAGNOSTICS - 保留 保留 DICTIONARY 非保留 保留 - DIRECT 非保留 - - DIRECTORY 非保留 - - DISABLE 非保留 - - DISCARD 非保留 - - DISCONNECT 非保留 保留 保留 DISPATCH - 非保留 - DISTINCT 保留 保留 保留 DISTRIBUTE 非保留 - - DISTRIBUTION 非保留 - - DO 保留 - - DOCUMENT 非保留 - - DOMAIN 非保留 保留 保留 DOUBLE 非保留 保留 保留 DROP 非保留 保留 保留 DUPLICATE 非保留 - - DYNAMIC - 保留 - DYNAMIC_FUNCTION - 非保留 非保留 DYNAMIC_FUNCTION_CODE - 非保留 - EACH 非保留 保留 - ELASTIC 非保留 - - ELSE 保留 保留 保留 ENABLE 非保留 - - ENCLOSED 非保留 - - ENCODING 非保留 - - ENCRYPTED 非保留 - - ENCRYPTED_VALUE 非保留 - - ENCRYPTION 非保留 - - ENCRYPTION_TYPE 非保留 - - END 保留 保留 保留 END-EXEC - 保留 保留 ENFORCED 非保留 - - ENUM 非保留 - - EOL 非保留 - - ERRORS 非保留 - - EQUALS - 保留 - ESCAPE 非保留 保留 保留 ESCAPING 非保留 - - EVERY 非保留 保留 - EXCEPT 保留 保留 保留 EXCEPTION - 保留 保留 EXCHANGE 非保留 - - EXCLUDE 非保留 - - EXCLUDED 保留 - - EXCLUDING 非保留 - - EXCLUSIVE 非保留 - - EXEC - 保留 保留 EXECUTE 非保留 保留 保留 EXISTING - 非保留 - EXISTS 非保留(不能是函数或类型) 非保留 保留 EXPIRED_P 非保留 - - EXPLAIN 非保留 - - EXTENSION 非保留 - - EXTERNAL 非保留 保留 保留 EXTRACT 非保留(不能是函数或类型) 非保留 保留 FALSE 保留 保留 保留 FAMILY 非保留 - - FAST 非保留 - - FEATURES 非保留 - - FENCED 保留 - - FETCH 保留 保留 保留 FIELDS 非保留 - - FILEHEADER 非保留 - - FILL_MISSING_FIELDS 非保留 - - FILLER 非保留 - - FILTER 非保留 保留 保留 FINAL - 非保留 - FIRST 非保留 保留 保留 FIXED 非保留 保留 保留 FLOAT 非保留(不能是函数或类型) 保留 保留 FOLLOWING 非保留 - - FOR 保留 保留 保留 FORCE 非保留 - - FOREIGN 保留 保留 保留 FORMATTER 非保留 - - FORTRAN - 非保留 非保留 FORWARD 非保留 - - FOUND - 保留 保留 FREE - 保留 - FREEZE 保留(可以是函数或类型) - - FROM 保留 保留 保留 FULL 保留(可以是函数或类型) 保留 保留 FUNCTION 非保留 保留 - FUNCTIONS 非保留 - - G - 非保留 - GENERAL - 保留 - GENERATED 非保留 非保留 - GET - 保留 保留 GLOBAL 非保留 保留 保留 GO - 保留 保留 GOTO - 保留 保留 GRANT 保留 保留 保留 GRANTED 非保留 非保留 - GREATEST 非保留(不能是函数或类型) - - GROUP 保留 保留 保留 GROUPING 非保留(不能是函数或类型) 保留 - GROUPPARENT 保留 - - HANDLER 非保留 - - HAVING 保留 保留 保留 HDFSDIRECTORY 保留(可以是函数或类型) - - HEADER 非保留 - - HIERARCHY - 非保留 - HOLD 非保留 非保留 - HOST - 保留 - HOUR 非保留 保留 保留 IDENTIFIED 非保留 - - IDENTITY 非保留 保留 保留 IF 非保留 - - IGNORE - 保留 - IGNORE_EXTRA_DATA 非保留 - - ILIKE 保留(可以是函数或类型) - - IMMEDIATE 非保留 保留 保留 IMMUTABLE 非保留 - - IMPLEMENTATION - 非保留 - IMPLICIT 非保留 - - IN 保留 保留 保留 INCLUDE 非保留 - - INCLUDING 非保留 - - INCREMENT 非保留 - - INCREMENTAL 非保留 - - INDEX 非保留 - - INDEXES 非保留 - - INDICATOR - 保留 保留 INFILE 非保留 - - INFIX - 非保留 - INHERIT 非保留 - - INHERITS 非保留 - - INITIAL 非保留 - - INITIALIZE - 保留 - INITIALLY 保留 保留 保留 INITRANS 非保留 - - INLINE 非保留 - - INNER 保留(可以是函数或类型) 保留 保留 INOUT 非保留(不能是函数或类型) 保留 - INPUT 非保留 保留 保留 INSENSITIVE 非保留 非保留 保留 INSERT 非保留 保留 保留 INSTANCE - 非保留 - INSTANTIABLE - 非保留 - INSTEAD 非保留 - - INT 非保留(不能是函数或类型) 保留 保留 INTEGER 非保留(不能是函数或类型) 保留 保留 INTERNAL 非保留 - - INTERSECT 保留 保留 保留 INTERVAL 非保留(不能是函数或类型) 保留 保留 INTO 保留 保留 保留 INVOKER 非保留 非保留 - IP 非保留 - - IS 保留 保留 保留 ISNULL 非保留 - - ISOLATION 非保留 保留 保留 ITERATE - 保留 - JOIN 保留(可以是函数或类型) 保留 保留 K - 非保留 - KEY 非保留 保留 保留 KEY_PATH 非保留 - - KEY_MEMBER - 非保留 - KEY_STORE 非保留 - - KEY_TYPE - 非保留 - KILL 非保留 - - LABEL 非保留 - - LANGUAGE 非保留 保留 保留 LARGE 非保留 保留 - LAST 非保留 保留 保留 LATERAL - 保留 - LC_COLLATE 非保留 - - LC_CTYPE 非保留 - - LEADING 保留 保留 保留 LEAKPROOF 非保留 - - LEAST 非保留(不能是函数或类型) - - LEFT 保留(可以是函数或类型) 保留 保留 LENGTH - 非保留 非保留 LESS 保留 保留 - LEVEL 非保留 保留 保留 LIKE 保留(可以是函数或类型) 保留 保留 LIMIT 保留 保留 - LIST 非保留 - - LISTEN 非保留 - - LOAD 非保留 - - LOCAL 非保留 保留 保留 LOCALTIME 保留 保留 - LOCALTIMESTAMP 保留 保留 - LOCATION 非保留 - - LOCATOR - 保留 - LOCK 非保留 - - LOG 非保留 - - LOGGING 非保留 - - LOGIN_ANY 非保留 - - LOGIN_FAILURE 非保留 - - LOGIN_SUCCESS 非保留 - - LOGOUT 非保留 - - LOOP 非保留 - - LOWER - 非保留 保留 M - 非保留 - MAP - 保留 - MAPPING 非保留 - - MASKING 非保留 - - MASTER 非保留 - - MATCH 非保留 保留 保留 MATCHED 非保留 - - MATERIALIZED 非保留 - - MAX - 非保留 保留 MAXEXTENTS 非保留 - - MAXSIZE 非保留 - - MAXTRANS 非保留 - - MAXVALUE 保留 - - MERGE 非保留 - - MESSAGE_LENGTH - 非保留 非保留 MESSAGE_OCTET_LENGTH - 非保留 非保留 MESSAGE_TEXT - 非保留 非保留 METHOD - 非保留 - MIN - 非保留 保留 MINEXTENTS 非保留 - - MINUS 保留 - - MINUTE 非保留 保留 保留 MINVALUE 非保留 - - MOD - 非保留 - MODE 非保留 - - MODEL 非保留 - - MODIFIES - 保留 - MODIFY 保留 保留 - MODULE - 保留 保留 MONTH 非保留 保留 保留 MORE - 非保留 非保留 MOVE 非保留 - - MOVEMENT 非保留 - - MUMPS - 非保留 非保留 NAME 非保留 非保留 非保留 NAMES 非保留 保留 保留 NATIONAL 非保留(不能是函数或类型) 保留 保留 NATURAL 保留(可以是函数或类型) 保留 保留 NCHAR 非保留(不能是函数或类型) 保留 保留 NCLOB - 保留 - NEW - 保留 - NEXT 非保留 保留 保留 NO 非保留 保留 保留 NOCOMPRESS 非保留 - - NOCYCLE 保留 - - NODE 非保留 - - NOLOGGING 非保留 - - NOMAXVALUE 非保留 - - NOMINVALUE 非保留 - - NONE 非保留(不能是函数或类型) 保留 - NOT 保留 保留 保留 NOTHING 非保留 - - NOTIFY 非保留 - - NOTNULL 保留(可以是函数或类型) - - NOWAIT 非保留 - - NULL 保留 保留 保留 NULLABLE - 非保留 非保留 NULLIF 非保留(不能是函数或类型) 非保留 保留 NULLS 非保留 - - NULLCOLS 非保留 - - NUMBER 非保留(不能是函数或类型) 非保留 非保留 NUMERIC 非保留(不能是函数或类型) 保留 保留 NUMSTR 非保留 - - NVARCHAR2 非保留(不能是函数或类型) - - NVL 非保留(不能是函数或类型) - - OBJECT 非保留 保留 - OCTET_LENGTH - 非保留 保留 OF 非保留 保留 保留 OFF 非保留 保留 - OFFSET 保留 - - OIDS 非保留 - - OLD - 保留 - ON 保留 保留 保留 ONLY 保留 保留 保留 OPEN - 保留 保留 OPERATION - 保留 - OPERATOR 非保留 - - OPTIMIZATION 非保留 - - OPTION 非保留 保留 保留 OPTIONALLY 非保留 - - OPTIONS 非保留 非保留 - OR 保留 保留 保留 ORDER 保留 保留 保留 ORDINALITY - 保留 - OUT 非保留(不能是函数或类型) 保留 - OUTER 保留(可以是函数或类型) 保留 保留 OUTPUT - 保留 保留 OVER 非保留 - - OVERLAPS 保留(可以是函数或类型) 非保留 保留 OVERLAY 非保留(不能是函数或类型) 非保留 - OVERRIDING - 非保留 - OWNED 非保留 - - OWNER 非保留 - - PACKAGE 非保留 - - PACKAGES 非保留 - - PAD - 保留 保留 PARAMETER - 保留 - PARAMETERS - 保留 - PARAMETER_MODE - 非保留 - PARAMETER_NAME - 非保留 - PARAMETER_ORDINAL_POSITION - 非保留 - PARAMETER_SPECIFIC_CATALOG - 非保留 - PARAMETER_SPECIFIC_NAME - 非保留 - PARAMETER_SPECIFIC_SCHEMA - 非保留 - PARSER 非保留 - - PARTIAL 非保留 保留 保留 PARTITION 非保留 - - PARTITIONS 非保留 - - PASCAL - 非保留 非保留 PASSING 非保留 - - PASSWORD 非保留 - - PATH - 保留 - PCTFREE 非保留 - - PER 非保留 - - PERCENT 非保留 - - PERFORMANCE 保留 - - PERM 非保留 - - PIVOT 非保留 - - PLACING 保留 - - PLAN 非保留 - - PLANS 非保留 - - POLICY 非保留 - - PLI - 非保留 非保留 POOL 非保留 - - POSITION 非保留(不能是函数或类型) 非保留 保留 POSTFIX - 保留 - PRECEDING 非保留 - - PRECISION 非保留(不能是函数或类型) 保留 保留 PREDICT 非保留 - - PREFERRED 非保留 - - PREFIX 非保留 保留 - PREORDER - 保留 - PREPARE 非保留 保留 保留 PREPARED 非保留 - - PRESERVE 非保留 保留 保留 PRIMARY 保留 保留 保留 PRIOR 保留 保留 保留 PRIORER 保留 - - PRIVATE 非保留 - - PRIVILEGE 非保留 - - PRIVILEGES 非保留 保留 保留 PROCEDURAL 非保留 - - PROCEDURE 保留 保留 保留 PROFILE 非保留 - - PUBLIC - 保留 保留 PUBLICATION 非保留 - - PUBLISH 非保留 - - PURGE 非保留 - - QUERY 非保留 - - QUOTE 非保留 - - RANDOMIZED 非保留 - - RANGE 非保留 - - RATIO 非保留 - - RAW 非保留 - - READ 非保留 保留 保留 READS - 保留 - REAL 非保留(不能是函数或类型) 保留 保留 REASSIGN 非保留 - - REBUILD 非保留 - - RECHECK 非保留 - - RECURSIVE 非保留 保留 - RECYCLEBIN 保留(可以是函数或类型) - - REDISANYVALUE 非保留 - - REF 非保留 保留 - REFERENCES 保留 保留 保留 REFERENCING - 保留 - REFRESH 非保留 - - REINDEX 非保留 - - REJECT 保留 - - RELATIVE 非保留 保留 保留 RELEASE 非保留 - - RELOPTIONS 非保留 - - REMOTE 非保留 - - REMOVE 非保留 - - RENAME 非保留 - - REPEATABLE 非保留 非保留 非保留 REPLACE 非保留 - - REPLICA 非保留 - - RESET 非保留 - - RESIZE 非保留 - - RESOURCE 非保留 - - RESTART 非保留 - - RESTRICT 非保留 保留 保留 RESULT - 保留 - RETURN 非保留 保留 - RETURNED_LENGTH - 非保留 非保留 RETURNED_OCTET_LENGTH - 非保留 非保留 RETURNED_SQLSTATE - 非保留 非保留 RETURNING 保留 - - RETURNS 非保留 保留 - REUSE 非保留 - - REVOKE 非保留 保留 保留 RIGHT 保留(可以是函数或类型) 保留 保留 ROLE 非保留 保留 - ROLES 非保留 - - ROLLBACK 非保留 保留 保留 ROLLUP 非保留 保留 - ROTATION 非保留 - - ROUTINE - 保留 - ROUTINE_CATALOG - 非保留 - ROUTINE_NAME - 非保留 - ROUTINE_SCHEMA - 非保留 - ROW 非保留(不能是函数或类型) 保留 - ROWNUM 保留 - - ROWS 非保留 保留 保留 ROWTYPE 非保留 - - ROW_COUNT - 非保留 非保留 RULE 非保留 - - SAMPLE 非保留 - - SAVEPOINT 非保留 保留 - SCALE - 非保留 非保留 SCHEMA 非保留 保留 保留 SCHEMA_NAME - 非保留 非保留 SCOPE - 保留 - SCROLL 非保留 保留 保留 SEARCH 非保留 保留 - SECOND 非保留 保留 保留 SECTION - 保留 保留 SECURITY 非保留 非保留 - SELECT 保留 保留 保留 SELF - 非保留 - SENSITIVE - 非保留 - SEQUENCE 非保留 保留 - SEQUENCES 非保留 - - SERIALIZABLE 非保留 非保留 非保留 SERVER 非保留 - - SERVER_NAME - 非保留 非保留 SESSION 非保留 保留 保留 SESSION_USER 保留 保留 保留 SET 非保留 保留 保留 SETOF 非保留(不能是函数或类型) - - SETS 非保留 保留 - SHARE 非保留 - - SHIPPABLE 非保留 - - SHOW 非保留 - - SHUTDOWN 非保留 - - SIBLINGS 非保留 - - SIMILAR 保留(可以是函数或类型) 非保留 - SIMPLE 非保留 非保留 - SIZE 非保留 保留 保留 SKIP 非保留 - - SLICE 非保留 - - SMALLDATETIME 非保留(不能是函数或类型) - - SMALLDATETIME_FORMAT 非保留 - - SMALLINT 非保留(不能是函数或类型) 保留 保留 SNAPSHOT 非保留 - - SOME 保留 保留 保留 SOURCE 非保留 非保留 - SPACE 非保留 非保留 保留 SPECIFIC - 保留 - SPECIFICTYPE - 保留 - SPECIFIC_NAME - 非保留 - SPILL 非保留 - - SPLIT 保留 - - SQL - 保留 保留 SQLCODE - - 保留 SQLERROR - - 保留 SQLEXCEPTION - 保留 - SQLSTATE - 保留 保留 SQLWARNING - 保留 - STABLE 非保留 - - STANDALONE 非保留 - - START 非保留 保留 - STATE - 保留 - STATEMENT 非保留 保留 - STATEMENT_ID 非保留 - - STATIC - 保留 - STATISTICS 非保留 - - STDIN 非保留 - - STDOUT 非保留 - - STORAGE 非保留 - - STORE 非保留 - - STORED 非保留 - - STRATIFY 非保留 - - STREAM 非保留 - - STRICT 非保留 - - STRIP 非保留 - - SUBPARTITION 非保留 - - SUBPARTITIONS 非保留 - - SUBSCRIPTION 非保留 - - STRUCTURE - 保留 - STYLE - 非保留 - SUBCLASS_ORIGIN - 非保留 非保留 SUBLIST - 非保留 - SUBSTRING 非保留(不能是函数或类型) 非保留 保留 SUM - 非保留 保留 SYMMETRIC 保留 非保留 - SYNONYM 非保留 - - SYS_REFCURSOR 非保留 - - SYSDATE 保留 - - SYSID 非保留 - - SYSTEM 非保留 非保留 - SYSTEM_USER - 保留 保留 TABLE 保留 保留 保留 TABLES 非保留 - - TABLESAMPLE 保留(可以是函数或类型) - - TABLESPACE 非保留 - - TABLE_NAME - 非保留 非保留 TARGET 非保留 - - TEMP 非保留 - - TEMPLATE 非保留 - - TEMPORARY 非保留 保留 保留 TERMINATE - 保留 - TERMINATED 非保留 - - TEXT 非保留 - - THAN 非保留 保留 - THEN 保留 保留 保留 TIME 非保留(不能是函数或类型) 保留 保留 TIME_FORMAT 非保留 - - TIMECAPSULE 保留(可以是函数或类型) - - TIMESTAMP 非保留(不能是函数或类型) 保留 保留 TIMESTAMP_FORMAT 非保留 - - TIMESTAMPDIFF 非保留(不能是函数或类型) - - TIMEZONE_HOUR - 保留 保留 TIMEZONE_MINUTE - 保留 保留 TINYINT 非保留(不能是函数或类型) - - TO 保留 保留 保留 TRAILING 保留 保留 保留 TRANSACTION 非保留 保留 保留 TRANSACTIONS_COMMITTED - 非保留 - TRANSACTIONS_ROLLED_BACK - 非保留 - TRANSACTION_ACTIVE - 非保留 - TRANSFORM 非保留 - - TRANSFORMS - 非保留 - TRANSLATE - 非保留 保留 TRANSLATION - 保留 保留 TREAT 非保留(不能是函数或类型) 保留 - TRIGGER 非保留 保留 - TRIGGER_CATALOG - 非保留 - TRIGGER_NAME - 非保留 - TRIGGER_SCHEMA - 非保留 - TRIM 非保留(不能是函数或类型) 非保留 保留 TRUE 保留 保留 保留 TRUNCATE 非保留 - - TRUSTED 非保留 - - TSFIELD 非保留 - - TSTAG 非保留 - - TSTIME 非保留 - - TYPE 非保留 非保留 非保留 TYPES 非保留 - - UESCAPE - - - UNBOUNDED 非保留 - - UNCOMMITTED 非保留 非保留 非保留 UNDER - 保留 - UNENCRYPTED 非保留 - - UNION 保留 保留 保留 UNIQUE 保留 保留 保留 UNKNOWN 非保留 保留 保留 UNLIMITED 非保留 - - UNLISTEN 非保留 - - UNLOCK 非保留 - - UNLOGGED 非保留 - - UNNAMED - 非保留 非保留 UNNEST - 保留 - UNPIVOT 非保留 - - UNTIL 非保留 - - UNUSABLE 非保留 - - UPDATE 非保留 保留 保留 USEEOF 非保留 - - UPPER - 非保留 保留 USAGE - 保留 保留 USER 保留 保留 保留 USER_DEFINED_TYPE_CATALOG - 非保留 - USER_DEFINED_TYPE_NAME - 非保留 - USER_DEFINED_TYPE_SCHEMA - 非保留 - USING 保留 保留 保留 VACUUM 非保留 - - VALID 非保留 - - VALIDATE 非保留 - - VALIDATION 非保留 - - VALIDATOR 非保留 - - VALUE 非保留 保留 保留 VALUES 非保留(不能是函数或类型) 保留 保留 VARCHAR 非保留(不能是函数或类型) 保留 保留 VARCHAR2 非保留(不能是函数或类型) - - VARIABLE - 保留 - VARIABLES 非保留 - - VARIADIC 保留 - - VARYING 非保留 保留 保留 VCGROUP 非保留 - - VERBOSE 保留(可以是函数或类型) - - VERIFY 保留 - - VERSION 非保留 - - VIEW 非保留 保留 保留 VOLATILE 非保留 - - WAIT 非保留 - - WEAK 非保留 - - WHEN 保留 保留 保留 WHENEVER - 保留 保留 WHERE 保留 保留 保留 WHITESPACE 非保留 - - WINDOW 保留 - - WITH 保留 保留 保留 WITHIN 非保留 - - WITHOUT 非保留 保留 - WORK 非保留 保留 保留 WORKLOAD 非保留 - - WRAPPER 非保留 - - WRITE 非保留 保留 保留 XML 非保留 - - XMLATTRIBUTES 非保留(不能是函数或类型) - - XMLCONCAT 非保留(不能是函数或类型) - - XMLELEMENT 非保留(不能是函数或类型) - - XMLEXISTS 非保留(不能是函数或类型) - - XMLFOREST 非保留(不能是函数或类型) - - XMLPARSE 非保留(不能是函数或类型) - - XMLPI 非保留(不能是函数或类型) - - XMLROOT 非保留(不能是函数或类型) - - XMLSERIALIZE 非保留(不能是函数或类型) - - XMLTYPE 非保留 - - YEAR 非保留 保留 保留 YES 非保留 - - ZONE 非保留 保留 保留 下表所示字段在建表时禁止作为列名。 CTID XMIN CMIN XMAX CMAX TABLEOID XC_NODE_ID TID OID GS_TUPLE_UID TABLEBUCKETID - - - - 父主题： SQL参考

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

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

HashFunc函数 bucketabstime(value，flag) 描述：对abstime格式的数值value计算hash值并找到对应的hashbucket桶。 参数：value为需要转换的数值，类型为abstime，flag为int类型表示数据分布方式，0表示hash分布。 返回值类型：int32 示例： 12345 gaussdb=# select bucketabstime('2011-10-01 10:10:10.112',1); bucketabstime--------------- 13954(1 row) bucketbool(value，flag) 描述：对bool格式的数值value计算hash值并找到对应的hashbucket桶。 参数：value为需要转换的数值，类型为bool，flag为int类型表示数据分布方式，0表示hash分布。 返回值类型：int32 示例： 1 2 3 4 5 6 7 8 910 gaussdb=# select bucketbool(true,1); bucketbool------------ 1(1 row)gaussdb=# select bucketbool(false,1); bucketbool------------ 0(1 row) bucketbpchar(value, flag) 描述：对bpchar格式的数值value计算hash值并找到对应的hashbucket桶。 参数：value为需要转换的数值，类型为bpchar，flag为int类型表示数据分布方式，0表示hash分布。 返回值类型：int32 示例： 12345 gaussdb=# select bucketbpchar('test',1); bucketbpchar-------------- 9761(1 row) bucketbytea(value，flag) 描述：对bytea格式的数值value计算hash值并找到对应的hashbucket桶。 参数：value为需要转换的数值，类型为bytea，flag为int类型表示数据分布方式，0表示hash分布。 返回值类型：int32 示例： 12345 gaussdb=# select bucketbytea('test',1); bucketbytea------------- 9761(1 row) bucketcash(value，flag) 描述：对money格式的数值value计算hash值并找到对应的hashbucket桶。 参数：value为需要转换的数值，类型为money，flag为int类型表示数据分布方式，0表示hash分布。 返回值类型：int32 示例： 12345 gaussdb=# select bucketcash(10::money,1); bucketcash------------ 8468(1 row) getbucket(value，flag) 描述：从分布列获取hashbucket桶。 value为需要输入的数值，类型： “char”,abstime,bigint,boolean,bytea,character varying,character,date,double precision,int2vector,integer,interval,money,name,numeric,nvarchar2,oid,oidvector,raw,real,record,reltime,smalldatetime,smallint,text,time with time zone,time without time zone,timestamp with time zone,timestamp without time zone,tinyint,uuid。 flag表示数据分布方式，类型：integer 返回值类型：integer 示例： 1 2 3 4 5 6 7 8 91011121314151617181920212223 gaussdb=# select getbucket(10,'H'); getbucket ----------- 14535(1 row)gaussdb=# select getbucket(11,'H'); getbucket ----------- 13449(1 row)gaussdb=# select getbucket(11,'R'); getbucket ----------- 13449(1 row)gaussdb=# select getbucket(12,'R'); getbucket ----------- 9412(1 row) ora_hash(expression,[seed]) 描述：用于计算给定表达式的哈希值。expression:可输入的类型覆盖字符串，时间类型，数字类型，根据expression进行计算哈希值。seed:可选参数，一个int8值，可以对同一个输入值返回不同的结果, 用于计算带随机数的hash值。 返回类型：int8类型的哈希值。 示例： 1 2 3 4 5 6 7 8 910111213141516171819202122232425262728293031323334353637383940 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 示例： 12345 gaussdb=# select hash_array(ARRAY[[1,2,3],[1,2,3]]); hash_array ------------ -382888479(1 row) hash_group(key) 描述：流引擎（由于规格变更，当前版本已经不再支持本特性，请不要使用）中，该函数可将Group Clause中的各列计算为一个hash值。 参数：key为Group Clause中各列的值。 返回值类型：32位hash值 示例： 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132 按照步骤依次执行。gaussdb=# CREATE TABLE tt(a int, b int,c int,d int);NOTICE: The 'DISTRIBUTE BY' clause is not specified. Using 'a' as the distribution column by default.HINT: Please use 'DISTRIBUTE BY' clause to specify suitable data distribution column.CREATE TABLEgaussdb=# select * from tt; a | b | c | d ---+---+---+---(0 rows)gaussdb=# insert into tt values(1,2,3,4);INSERT 0 1gaussdb=# select * from tt; a | b | c | d ---+---+---+--- 1 | 2 | 3 | 4(1 row)gaussdb=# insert into tt values(5,6,7,8);INSERT 0 1gaussdb=# select * from tt; a | b | c | d ---+---+---+--- 1 | 2 | 3 | 4 5 | 6 | 7 | 8(2 rows)gaussdb=# select hash_group(a,b) from tt where a=1 and b=2; hash_group ------------ 990882385(1 row) hash_numeric(numeric) 描述：计算Numeric类型的数据的hash值。 参数：Numeric类型的数据。 返回值类型：integer 示例： 12345 gaussdb=# select hash_numeric(30); hash_numeric -------------- -282860963(1 row) hash_range(anyrange) 描述：计算range的哈希值。 参数：anyrange类型的数据。 返回值类型：integer 示例： 12345 gaussdb=# select hash_range(numrange(1.1,2.2)); hash_range ------------ 683508754(1 row) hashbpchar(character) 描述：计算bpchar的哈希值。 参数：character类型的数据。 返回值类型：integer 示例： 12345 gaussdb=# select hashbpchar('hello'); hashbpchar ------------- -1870292951(1 row) hashchar(char) 描述：char和布尔数据转换为哈希值。 参数：char类型的数据或者bool类型的数据。 返回值类型：integer 示例： 1 2 3 4 5 6 7 8 91011 gaussdb=# select hashbpchar('hello'); hashbpchar ------------- -1870292951(1 row)gaussdb=# select hashchar('true'); hashchar ------------ 1686226652(1 row) hashenum(anyenum) 描述：枚举类型转哈希值。 参数：anyenum类型的数据。 返回值类型：integer 示例： 1234567 gaussdb=# CREATE TYPE b1 AS ENUM('good', 'bad', 'ugly');CREATE TYPEgaussdb=# call hashenum('good'::b1); hashenum ------------ 1821213359(1 row) hashfloat4(real) 描述：float4转哈希值。 参数：real类型的数据。 返回值类型：integer 示例： 12345 gaussdb=# select hashfloat4(12.1234); hashfloat4 ------------ 1398514061(1 row) hashfloat8(double precision) 描述：float8转哈希值。 参数：double precision类型的数据。 返回值类型：integer 示例： 12345 gaussdb=# select hashfloat8(123456.1234); hashfloat8 ------------ 1673665593(1 row) hashinet(inet) 描述：支持inet / cidr上的哈希索引的功能。返回传入inet的hash值。 参数：inet类型的数据。 返回值类型：integer 示例： 12345 gaussdb=# select hashinet('127.0.0.1'::inet); hashinet ------------- -1435793109(1 row) hashint1(tinyint) 描述：INT1转哈希值。 参数：tinyint类型的数据。 返回值类型：uint32 示例： 12345 gaussdb=# select hashint1(20); hashint1 ------------- -2014641093(1 row) hashint2(smallint) 描述：INT2转哈希值。 参数：smallint类型的数据。 返回值类型：uint32 示例： gaussdb=# select hashint2(20000); hashint2 ------------ -863179081(1 row) bucketchar 描述：计算入参的哈希值。 参数：char, integer 返回值类型：integer bucketdate 描述：计算入参的哈希值。 参数：date, integer 返回值类型：integer bucketfloat4 描述：计算入参的哈希值。 参数：real, integer 返回值类型：integer bucketfloat8 描述：计算入参的哈希值。 参数：double precision, integer 返回值类型：integer bucketint1 描述：计算入参的哈希值。 参数：tinyint, integer 返回值类型：integer bucketint2 描述：计算入参的哈希值。 参数：smallint, integer 返回值类型：integer bucketint2vector 描述：计算入参的哈希值。 参数：int2vector, integer 返回值类型：integer bucketint4 描述：计算入参的哈希值。 参数：integer, integer 返回值类型：integer bucketint8 描述：计算入参的哈希值。 参数：bigint, integer 返回值类型：integer bucketinterval 描述：计算入参的哈希值。 参数：interval, integer 返回值类型：integer bucketname 描述：计算入参的哈希值。 参数：name, integer 返回值类型：integer bucketnumeric 描述：计算入参的哈希值。 参数：numeric, integer 返回值类型：integer bucketnvarchar2 描述：计算入参的哈希值。 参数：nvarchar2, integer 返回值类型：integer bucketoid 描述：计算入参的哈希值。 参数：oid, integer 返回值类型：integer bucketoidvector 描述：计算入参的哈希值。 参数：oidvector, integer 返回值类型：integer bucketraw 描述：计算入参的哈希值。 参数：raw, integer 返回值类型：integer bucketreltime 描述：计算入参的哈希值。 参数：reltime, integer 返回值类型：integer bucketsmalldatetime 描述：计算入参的哈希值。 参数：smalldatetime, integer 返回值类型：integer buckettext 描述：计算入参的哈希值。 参数：text, integer 返回值类型：integer buckettime 描述：计算入参的哈希值。 参数：time without time zone, integer 返回值类型：integer buckettimestamp 描述：计算入参的哈希值。 参数：timestamp without time zone, integer 返回值类型：integer buckettimestamptz 描述：计算入参的哈希值。 参数：timestamp with time zone, integer 返回值类型：integer buckettimetz 描述：计算入参的哈希值。 参数：time with time zone, integer 返回值类型：integer bucketuuid 描述：计算入参的哈希值。 参数：uuid, integer 返回值类型：integer bucketvarchar 描述：计算入参的哈希值。 参数：character varying, integer 返回值类型：integer 父主题： 函数和操作符

数据库对象位置函数 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）。 get_large_table_name(relfile_node text, threshold_size_gb int8) 描述：根据表的文件编码（relfile_node）查询对应的表大小（单位为GB）是否超过阈值（threshold_size_gb），如果超过则返回模式名和表名（形式为schemaname.tablename）， 否则返回字符串’null’。 返回值类型：text pg_filenode_relation(tablespacename, relname) 描述：获取到对应的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显示用于存储某个独立数据值的空间。 12345 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或者名称，然后返回该对象使用的全部磁盘空间。 示例： 12345 gaussdb=# SELECT pg_database_size('testdb'); pg_database_size ------------------ 51590112(1 row) pg_relation_size(oid) 描述：指定OID代表的表或者索引所使用的磁盘空间。 返回值类型：bigint get_db_source_datasize() 描述：估算当前数据库非压缩态的数据总容量 返回值类型：bigint 备注：（1）调用该函数前需要做analyze；（2）通过估算列存的压缩率计算非压缩态的数据总容量。 示例： 1234567 gaussdb=# analyze;ANALYZEgaussdb=# 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 浮点类型 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) 字符实际字节数 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

段页式存储函数 当前特性是实验室特性，使用时请联系华为工程师提供技术支持。 local_segment_space_info(tablespacename TEXT, databasename TEXT) 描述：输出为当前节点，该表空间下所有ExtentGroup的使用信息。 返回值类型： node_name 节点名称 extent_size 该ExtentGroup的extent规格，单位是block数。 forknum Fork号 total_blocks 物理文件总extent数目。 meta_data_blocks 表空间管理的metadata占用的block数，只包括space header，map page等，不包括segment head。 used_data_blocks 存数据占用的extent数目。包括segment head。 utilization 使用的block数占总block数的百分比。即(used_data_blocks+meta_data_block)/total_blocks。 high_water_mark 高水位线，被分配出去的extent，最大的物理页号。超过高水位线的block都没有被使用，可以被直接回收。 例如： select * from local_segment_space_info('pg_default', 'testdb'); node_name | extent_size | forknum | total_blocks | meta_data_blocks | used_data_blocks | utilization | high_water_mark -------------------+-------------+---------+--------------+------------------+------------------+-------------+----------------- dn_6001_6002_6003 | 1 | 0 | 16384 | 4157 | 1 | .253784 | 4158 dn_6001_6002_6003 | 8 | 0 | 16384 | 4157 | 8 | .254211 | 4165(2 rows) global_segment_space_info(tablespacename TEXT, databasename TEXT) 描述：效果跟local_segment_space_info类似，返回的是整个集群中所有节点上的使用信息。 pg_stat_segment_extent_usage(int4 tablespace oid, int4 database oid, int4 extent_type, int4 forknum) 描述：每次返回一个ExtentGroup中，每个被分配出去的extent的使用情况。extent_type表示ExtentGroup的类型，合理取值为[1,5]的int值。在此范围外的会报error。forknum 表示fork号，合法取值为[0,4]的int值，目前只有三种值有效，数据文件为0，FSM文件为1，visibility map文件为2。 返回值类型： 名称 描述 start_block Extent的起始物理页号。 extent_size Extent的大小。 usage_type Extent的使用类型，比如segment head，data extent等。 ower_location 有指针指向该extent的对象的位置。比如data extent的owner就是它所属的segment的head位置。 special_data 该extent在它owner中的位置。该字段的数据跟使用类型有关。比如data extent的special data就是它在所属segment中的extent id。 其中，usage_type为枚举类型，每一项的含义为： Non-bucket table segment head ：非hashbucket表的数据段头。 Non-bucket table fork head：非段页式表的fork段头。 Bucket table main head：hashbucket表的主表段头。 Bucket table map block：hashbucket表的MapBlock。 Bucket segment head：hashbucket表每个bucket的段头。 Data extent：数据块。 例如： select * from pg_stat_segment_extent_usage((select oid::int4 from pg_tablespace where spcname='pg_default'), (select oid::int4 from pg_database where datname='testdb'), 1, 0);start_block | extent_size | usage_type | ower_location | special_data-------------+-------------+------------------------+---------------+--------------4157 | 1 | Bucket table main head | 4294967295 | 04158 | 1 | Bucket table map block | 4157 | 04159 | 1 | Bucket table map block | 4157 | 14160 | 1 | Bucket table map block | 4157 | 24161 | 1 | Bucket table map block | 4157 | 34162 | 1 | Bucket table map block | 4157 | 44163 | 1 | Bucket table map block | 4157 | 54164 | 1 | Bucket table map block | 4157 | 64165 | 1 | Bucket table map block | 4157 | 74166 | 1 | Bucket table map block | 4157 | 8 local_space_shrink(tablespacename TEXT, databasename TEXT) 描述：当前节点上对指定段页式空间做物理空间收缩。注意，目前只支持对当前连接的database做shrink。 返回值：空 gs_space_shrink(int4 tablespace, int4 database, int4 extent_type, int4 forknum) 描述：效果跟local_space_shrink类似，对指定段页式空间做物理空间收缩，但参数不同，传入的是tablespace和database的oid，extent_type为[2,5]的int值。注意：extent_type = 1表示段页式元数据，目前不支持对元数据所在的物理文件做收缩。该函数仅限工具使用，不建议用户直接使用。 返回值：空 global_space_shrink(tablespacename TEXT, databasename TEXT) 描述：在cn上执行，对整个集群上所有dn执行段页式存储空间压缩。 注意：global_space_shrink 锁cluster，在此期间不能执行DDL操作。而local_space_shrink不会锁集群。 gs_stat_remain_segment_info() 描述：在CN上执行，展示在DN节点上，因为故障等原因，残留的extent。默认只有初始用户、具有sysadmin属性的用户以及在运维模式下具有运维管理员属性的用户可以查看，其余用户需要赋权后才可以使用。只支持在主机上执行。残留extent主要分为两类：分配而未被利用的segment和分配出去而未被利用的extent。两者主要区别在于segment会包含多个extent，回收时，要将segment上的extent一并全部回收。 返回值类型： 名称 描述 node_name 节点名称。 space_id 表空间ID。 db_id 数据库ID。 block_id Extent的ID。 type Extent的类型，当前有三种：ALLOC_SEGMENT|DROP_SEGMENT|SHRINK_EXTENT。 其中type的三种类型分别表示： ALLOC_SEGMENT:用户创建一张段页式表，当segment刚被分配，但是建表语句所在事务仍未提交时，节点故障，导致该segment被分配后，没有被使用。 DROP_SEGMENT:用户删除段页式表，当该事务成功提交，但是此表的segment页面对应的bit位未被重置，就发生掉电等故障，造成该segment未被使用，也未被释放。 SHRINK_EXTENT:用户对段页式表执行shrink操作，在未对空置出的extent进行释放时，发生掉电等故障，造成该extent残留，无法被重新利用。 例如： select * from gs_stat_remain_segment_info(); node_name | space_id | db_id | block_id | type -------------------+----------+-------+----------+--------------- dn_6001_6002_6003 | 16804 | 16803 | 4157 | ALLOC_SEGMENT(1 row) gs_free_remain_segment() 描述：清理通过函数gs_stat_remain_segment_info查询出的当前库的残留。默认只有初始用户、具有sysadmin属性的用户以及在运维模式下具有运维管理员属性的用户可以执行，其余用户需要赋权后才可以使用。只支持在主机上执行。 返回值：bool gs_local_stat_remain_segment_info() 描述：在主DN上执行，显示当前节点的段页式残留信息。用户权限、返回值请参考gs_stat_remain_segment_info。 gs_local_free_remain_segment() 描述：在主DN上执行，清理通过函数gs_local_stat_remain_segment_info查询出的当前库的残留。用户权限、返回值请参考gs_free_remain_segment。 父主题： 系统管理函数

咨询锁函数 咨询锁函数用于管理咨询锁（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(int4, int4, Name) 描述：获取指定数据库的排他咨询锁。 返回值类型：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(int4, int4, Name) 描述：释放指定数据库上的排他咨询锁。 返回值类型：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() 描述：尝试对集群内所有存活的CN节点获取会话级别的排他咨询锁。 返回值类型：Boolean 备注：只允许sysadmin调用，普通用户无权限。 unlock_cluster_ddl() 描述：尝试对CN节点会话级别的排他咨询锁。 返回值类型：Boolean 父主题： 系统管理函数

双集群容灾查询函数 gs_get_global_barrier_status() 描述：两地三中心跨Region容灾特性开启后，主集群和灾备集群通过obs进行日志同步，通过barrier日志在主集群的落盘，在灾备集群的回放来确定主集群归档日志进度与灾备集群日志回放进度。gs_get_global_barrier_status用以查询主集群已在obs完成归档的最新global barrier。 返回值类型：text global_barrier_id：全局最新barrier ID global_achive_barrier_id：全局最新归档barrier ID gs_get_local_barrier_status() 描述：两地三中心跨Region容灾特性开启后，主集群和灾备集群通过obs进行日志同步，通过barrier日志在主集群的落盘，在灾备集群的回放来确定主集群归档日志进度与灾备集群日志回放进度。gs_get_local_barrier_status用于查询灾备集群每个节点当前的日志回放情况。 返回值类型：text barrier_id：灾备集群某节点当前回放到的最新barrier ID barrier_lsn：灾备集群某节点当前回放到的最新barrier ID的Log Sequence Number ( LSN ) archive_lsn：灾备集群某节点当前已获得归档日志的位置，该参数当前未生效。 flush_lsn：灾备集群某节点当前已完成刷盘日志位置。 gs_get_global_barriers_status() 描述：两地三中心跨Region容灾特性-基于OBS的解决方案开启后，主数据库实例和多个灾备数据库实例通过obs进行日志同步，通过barrier日志在主数据库实例的落盘，在灾备数据库实例的回放来确定主数据库实例归档日志进度与灾备数据库实例日志回放进度。gs_get_global_barriers_status用以查询主数据库实例已在obs完成归档的最新global barrier。 返回值类型：text slot_name：容灾使用的槽位名。 global_barrier_id：全局最新barrier ID。 global_achive_barrier_id：全局最新归档barrier ID。 gs_upload_obs_file('slot_name', 'src_file', 'dest_file') 描述：两地三中心跨Region容灾特性开启后，主集群上传数据到OBS上的函数。 返回值类型：void slot_name：主集群CN创建的复制槽的名字。 src_file：主集群CN数据目录下的需要上传的文件的文件位置。 dest_file：上传到OBS上对应的文件的文件位置。 gs_download_obs_file('slot_name', 'src_file', 'dest_file') 描述：两地三中心跨Region容灾特性开启后，灾备集群从OBS上下载数据到本地的函数。 返回值类型：void slot_name：灾备集群CN创建的复制槽的名字。 src_file：OBS需要下载的文件的文件位置。 dest_file：灾备集群CN数据目录下需要存放下载文件对应的文件位置。 gs_get_obs_file_context('file_name', 'slot_name') 描述：两地三中心跨Region容灾特性开启后，查询OBS上对应文件的内容。 返回值类型：text file_name：OBS上文件的文件名。 slot_name：主/灾备集群CN创建的复制槽的名字。 gs_set_obs_file_context('file_name', 'file_context','slot_name') 描述：两地三中心跨Region容灾特性开启后，在OBS上创建文件并写入对应的内容。 返回值类型：text file_name：OBS上文件的文件名。 file_context： 写入文件的内容。 slot_name：主/灾备集群CN创建的复制槽的名字。 gs_get_hadr_key_cn() 描述：两地三中心跨Region容灾特性开启后，在OBS上创建文件并写入对应的内容。 返回值类型：text file_name：OBS上文件的文件名。 file_context： 写入文件的内容。 slot_name：主/灾备集群CN创建的复制槽的名字。 gs_hadr_has_barrier_creator() 描述：两地三中心跨Region容灾特性开启后，查询当前cn节点是否存在barrier_creator线程，存在返回true（需要系统管理员角色）。 返回值类型：Boolean 备注：该函数只有在容灾集群启动计划内switchover时使用。 gs_hadr_in_recovery() 描述：两地三中心跨Region容灾特性开启后，查询当前节点是否处于基于目标barrier的日志恢复中，还在恢复中返回true。只有完成日志恢复，才会启动switchover流程中的灾备集群升为生产集群的步骤，需要系统管理员角色执行。 返回值类型：Boolean 该函数只有在容灾集群启动计划内switchover时使用。 gs_streaming_dr_get_switchover_barrier() 描述：两地三中心跨Region容灾-基于流式复制的解决方案中，查询灾备集群参与容灾的CN与首备DN实例是否已接收到switchover barrier日志并完成回放，已完成返回true。灾备集群只有在所有DN实例都完成switchover barrier日志回放，才会启动switchover流程中的灾备数据库实例升为生产数据库实例的步骤（需要系统管理员角色）。 返回值类型：Boolean 备注：该函数只有在流式容灾解决方案中容灾数据库实例启动计划内switchover时使用。 gs_streaming_dr_service_truncation_check() 描述：两地三中心跨Region容灾-基于流式复制的解决方案中，查询主集群参与容灾的CN与主DN实例是否已完成switchover barrier日志发送，已完成返回true。只有完成日志发送，才会启动switchover流程中的生产数据库实例降为灾备数据库实例的步骤（需要系统管理员角色）。 返回值类型：Boolean 备注：该函数只有在容灾数据库实例启动计划内switchover时使用。 gs_hadr_local_rto_and_rpo_stat() 描述：显示流式容灾的本地节点数据库实例和灾备数据库实例日志流控信息（如果在没有参加流式容灾的节点执行，如备DN或部分CN节点，则可能返回空）。 返回值类型：record，具体各个字段的类型和含义如下： 参数 类型 描述 hadr_sender_node_name text 节点的名称，包含主数据库实例和备数据库实例首备。 hadr_receiver_node_name text 备数据库实例首备名称。 source_ip text 主数据库实例主DN IP地址。 source_port int 主数据库实例主DN通信端口。 dest_ip text 备数据库实例首备DN IP地址。 dest_port int 备数据库实例首备DN通信端口。 current_rto int 流控的信息，当前主备数据库实例的日志rto时间（单位：秒）。 target_rto int 流控的信息，目标主备数据库实例间的rto时间（单位：秒）。 current_rpo int 流控的信息，当前主备数据库实例的日志rpo时间（单位：秒）。 target_rpo int 流控的信息，目标主备数据库实例间的rpo时间（单位：秒）。 rto_sleep_time int RTO流控信息，为了达到目标rto，预期主机walsender所需要的睡眠时间（单位：微秒）。 rpo_sleep_time int RPO流控信息，为了达到目标rpo，预期主机xlogInsert所需要的睡眠时间（单位：微秒）。 gs_hadr_remote_rto_and_rpo_stat() 描述：显示流式容灾的其他所有分片或CN数据库实例和灾备数据库实例日志流控信息（一般在CN节点执行；如果在DN节点执行，可能返回为空）。 返回值类型：record，具体各个字段的类型和含义如下： 参数 类型 描述 hadr_sender_node_name text 节点的名称，包含主数据库实例和备数据库实例首备。 hadr_receiver_node_name text 备数据库实例首备名称。 source_ip text 主数据库实例主DN IP地址。 source_port int 主数据库实例主DN通信端口。 dest_ip text 备数据库实例首备DN IP地址。 dest_port int 备数据库实例首备DN通信端口。 current_rto int 流控的信息，当前主备数据库实例的日志rto时间（单位：秒）。 target_rto int 流控的信息，目标主备数据库实例间的rto时间（单位：秒）。 current_rpo int 流控的信息，当前主备数据库实例的日志rpo时间（单位：秒）。 target_rpo int 流控的信息，目标主备数据库实例间的rpo时间（单位：秒）。 rto_sleep_time int RTO流控信息，为了达到目标rto，预期主机walsender所需要的睡眠时间（单位：微秒）。 rpo_sleep_time int RPO流控信息，为了达到目标rpo，预期主机xlogInsert所需要的睡眠时间（单位：微秒）。 父主题： 系统管理函数

恢复控制函数 恢复信息函数提供了当前备机状态的信息。这些函数可能在恢复期间或正常运行中执行。 pg_is_in_recovery() 描述：如果恢复仍然在进行中则返回true。 返回值类型：bool 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。 返回值类型：bool pg_xlog_replay_pause() 描述：立即暂停恢复。 返回值类型：void pg_xlog_replay_resume() 描述：如果恢复处于暂停状态，则重新启动。 返回值类型：void gs_get_active_archiving_standby() 描述：查询同一分片内归档备机的信息。返回备机名，备机归档位置和已归档日志个数。 返回值类型：text，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生成的速度和可用的磁盘空间。

备份控制函数 备份控制函数可帮助进行在线备份。 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, is_full_backup boolean) 描述：开始执行在线备份（需要管理员角色、复制的角色或运维管理员角色打开operate_mode）。以gs_roach开头的label串为保留命名串，只能由内部备份工具GaussRoach使用。 返回值类型：text 备注：pg_start_backup接受一个用户定义的备份标签（通常这是备份转储文件存放地点的名称）。这个函数向数据库集群的数据目录写入一个备份标签文件，然后以文本方式返回备份的事务日志起始位置。 12345 gaussdb=# SELECT pg_start_backup('label_goes_here',true); pg_start_backup----------------- 0/3000020(1 row) pg_stop_backup() 描述：完成执行在线备份。需要管理员角色或复制的角色执行。 返回值类型：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从前述函数的返回结果中抽取相应的事务日志文件名称和字节偏移量。例如： 1234567 gaussdb=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());NOTICE: pg_stop_backup cleanup done, waiting for required WAL segments to be archivedNOTICE: 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回收功能，cn修复使用。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：void pg_disable_delay_xlog_recycle() 描述：关闭延迟xlog回收功能，cn修复使用。需要管理员角色或运维管理员角色打开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权限，运维管理员角色须打开operate_mode。 gs_is_dw_io_blocked() 描述：查看当前双写页面刷盘是否被阻塞，如果处于阻塞中则返回true。 返回值类型：bool 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。 gs_pitr_advance_last_updated_barrier() 描述：在PITR模式下，强制推进上次上传到OBS/NAS介质中的全局最大已归档恢复点到当前点，无入参。 返回值类型：text 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。同时只能在分布式的第一个normal CN上使用才有效。返回值为当前推进到的最新本地最大已归档恢复点。 gs_pitr_clean_local_barrier_files('delete_timestamp') 描述：清理本地缓存的barrier记录文件。 参数范围：delete_timestamp参数类型为text，为linux时间戳，长度为10位。 返回值类型：text 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。返回的结果是删除后本地最老barrier文件的开始时间戳。 gs_get_barrier_lsn(barrier_name text) 描述：获取备份创建的barrier对应的lsn。 返回值类型：text 备注：当前入参仅支持gs_roach_full和gs_roach_inc。调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。 gs_gbr_relation_associated_filenode(schemaName name, tableName name) 描述：返回与输入table相关的全部索引、sequence、分区、toast、toast index的relfilenode。 返回值类型：records 备注：gs_gbr_relation_associated_filenode返回的字段包含文件类型relkind、文件所在namespace、文件对应的relation name、文件所在的database oid、文件所在的tablespace oid以及文件的relfilenode。

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

通用文件访问函数 通用文件访问函数提供了对数据库服务器上的文件的本地访问接口。只有数据库集群目录和log_directory目录里面的文件可以访问。使用相对路径访问集群目录里面的文件，以及匹配log_directory配置而设置的路径访问日志文件。只有数据库初始化用户才能使用这些函数。 pg_ls_dir(dirname text) 描述：列出目录中的文件。 返回值类型：setof text 备注：pg_ls_dir返回指定目录里面的除了特殊项“.”和“..”之外所有名称。 示例： 1 2 3 4 5 6 7 8 9101112131415161718192021222324252627282930313233343536 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 91011 gaussdb=# SELECT pg_read_file('postmaster.pid',0,100); pg_read_file --------------------------------------- 53078 + /srv/BigData/testdir/data1/coordinator+ 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 9101112 gaussdb=# SELECT convert_from(pg_read_binary_file('postmaster.pid'), 'UTF8'); convert_from -------------------------------------- 4881 + /srv/BigData/gaussdb/data1/coordinator+ 1496308688 + 25108 + /opt/huawei/Bigdata/gaussdb/gaussdb_tmp + * + 25108001 43352069 +(1 row) 123456789 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) 12345 gaussdb=# SELECT (pg_stat_file('postmaster.pid')).modification; modification ------------------------ 2017-06-01 17:18:08+08(1 row) 父主题： 系统管理函数

双集群容灾控制函数 双集群容灾控制函数可以创建归档槽，归档槽指定了保存物理日志的obs信息。 pg_create_physical_replication_slot_extern(slotname text, dummy_standby bool, extra_content text, need_recycle_xlog bool) 描述：创建OBS/NAS归档槽。slotname 为本次灾备的slotname ，主备必须使用同一个slotname 。dummy_standby标志是主备从还是一主多备，false表示一主多备，true表示主备从。extra_content包含了归档槽的一些信息。对于OBS归档槽，其格式为"OBS;obs_server_ip;obs_bucket_name;obs_ak;obs_sk;archive_path;is_recovery;is_vote_replicate"，OBS表示归档槽的归档的介质，obs_server_ip为obs的ip，obs_bucket_name为obs的桶名，obs_ak为obs的ak，obs_sk为obs的sk，archive_path为归档的路径i，is_recovery标志是归档槽还是恢复槽，0表示是归档槽，主要是主集群使用；1表示是恢复槽，主要是灾备集群使用。is_vote_replicate标志是否是投票副本优先，0表示同步备机归档优先，1表示投票副本归档优先，当前版本该字段为预留字段，暂未适配。对于NAS归档槽，其格式为"NAS;archive_path;is_recovery;is_vote_replicate"，相比OBS归档槽，缺少了OBS相关的配置信息，其余字段意义相同。 如果是不指定OBS或NAS介质的话，默认指定的是OBS归档槽，其extra_content格式为"obs_server_ip;obs_bucket_name;obs_ak;obs_sk;archive_path;is_recovery;is_vote_replicate"。 need_recycle_xlog标志创建归档槽时是否回收老的归档日志，true表示回收，false表示不回收。 返回值类型：records包含本次灾备的slotname和xlog_position 备注：调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。在正常集群下不要使用is_recovery值为1，否则会创建出恢复槽，导致集群进入恢复不可用。 例如： 创建OBS归档槽： 12345 gaussdb=# select * from pg_create_physical_replication_slot_extern('uuid', false, 'OBS;obs.cn-north-7.ulanqab.huawei.com;dyk;19D772JBCACXX3KWS51D;********;gaussdb_uuid/dn1;0;0', false); slotname | xlog_position----------+--------------- uuid |(1 row) 创建NAS归档槽： 1234 gaussdb=# select * from pg_create_physical_replication_slot_extern('uuid', false, 'NAS;/data/nas/media/gaussdb_uuid/dn1;0;0', false); slotname | xlog_position----------+--------------- uuid | gs_set_obs_delete_location(delete_location text) 描述：设置obs归档日志可删除的位置。delete_location实际为Log Sequence Number ( LSN )，该位置之前的日志在灾备集群已经完成回放并且落盘，可以在obs上进行删除。 返回值类型：xlog_file_name text，表明此次可删除点所在的日志文件名。无论obs删除是否成功，该值都会正常返回。 gaussdb=# select gs_set_obs_delete_location('0/54000000'); gs_set_obs_delete_location ----------------------------- 000000010000000000000054_00(1 row) gs_hadr_do_switchover() 描述：异地容灾集群中主集群在执行计划内swithover过程中截断业务的接口。 返回值类型：bool，表明此次业务截断是否成功，是否可以正常进行switchover流程。 gs_set_obs_delete_location_with_slotname(cstring, cstring ) 描述：设置某个容灾关系上obs归档日志可删除的位置。第一个参数实际为Log Sequence Number ( LSN )，该位置之前的日志在灾备数据库实例已经完成回放并且落盘，可以在obs上进行删除，第二个参数为归档槽的名称。 返回值类型：xlog_file_name text，表明此次可删除点所在的日志文件名。无论obs删除是否成功，该值都会正常返回。 gs_streaming_dr_in_switchover() 描述：基于流式复制的异地容灾解决方案中主集群在执行计划内swithover过程中截断业务的接口。 返回值类型：bool，表明此次业务截断是否成功，是否可以正常进行switchover流程。 父主题： 系统管理函数

条件表达式函数 coalesce(expr1, expr2, ..., exprn) 描述： 返回参数列表中第一个非NULL的参数值。 COALESCE(expr1, expr2) 等价于CASE WHEN expr1 IS NOT NULL THEN expr1 ELSE expr2 END。 示例： 12345 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。 示例： 12345 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。 示例： 12345 gaussdb=# SELECT nullif('hello','world'); nullif -------- hello(1 row) 备注：不支持对xml数据类型的操作。 如果两个参数的数据类型不同，则： 若两种数据类型之间存在隐式转换，则以其中优先级较高的数据类型为基准将另一个参数隐式转换成该类型，转换成功则进行计算，转换失败则返回错误。如： 12345 gaussdb=# SELECT nullif('1234'::VARCHAR,123::INT4); nullif -------- 1234(1 row) 12 gaussdb=# SELECT nullif('1234'::VARCHAR,'2012-12-24'::DATE);ERROR: invalid input syntax for type timestamp: "1234" 若两种数据类型之间不存在隐式转换，则返回错误。如： 12345 gaussdb=# SELECT nullif(TRUE::BOOLEAN,'2012-12-24'::DATE);ERROR: operator does not exist: boolean = timestamp without time zoneLINE 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。 示例： 12345 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的情况下有效。 示例： 12345 gaussdb=# SELECT nvl2('hello','world','other'); case ------- world(1 row) 备注：参数expr2和expr3可以为任意类型， 当NVL2的后面两个参数不属于同类型时，看expr3参数是否可以向expr2参数进行隐式转换，如果不能隐式转换，会返回错误。如果第一个参数是数值类型，函数将第一个参数和其他参数都转换为numeric类型，然后进行比较，对于不能转换的，提示出错信息；第一个参数是其他类型的，函数将其他参数都转换为第一个参数的类型进行比较，对于不能转换的，提示出错信息。 greatest(expr1 [, ...]) 描述：获取并返回参数列表中值最大的表达式的值。 返回值类型： 示例： 12345 gaussdb=# SELECT greatest(1*2,2-3,4-1); greatest ---------- 3(1 row) 12345 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 [, ...]) 描述：获取并返回参数列表中值最小的表达式的值。 示例： 12345 gaussdb=# SELECT least(1*2,2-3,4-1); least ------- -1(1 row) 12345 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 示例： 123456 --新建表gaussdb=# CREATE TABLE blob_tb(b blob,id int) DISTRIBUTE BY REPLICATION;--插入数据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 示例： 123456 --新建表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 910111213141516171819 --新建表gaussdb=# CREATE TABLE student_demo (name VARCHAR2(20), grade NUMBER(10,2));CREATE TABLE--插入数据gaussdb=# INSERT INTO student_demo VALUES ('name0',0);INSERT 0 1gaussdb=# INSERT INTO student_demo VALUES ('name1',1);INSERT 0 1gaussdb=# INSERT INTO student_demo VALUES ('name2',2);INSERT 0 1--调用lnnvlgaussdb=# SELECT * FROM student_demo WHERE LNNVL(name = 'name1'); name | grade -------+------- name0 | 0.00 name2 | 2.00(2 rows) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下，才支持lnnvl函数。

服务器信号函数 服务器信号函数向其他服务器进程发送控制信号。仅系统管理员有权执行以下函数。 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的字段查询，可以用于清理线程池模式下，非活跃状态的会话。 pg_cancel_invalid_query() 描述：取消一个后端的无效查询。 返回值类型：Boolean 备注：只有系统管理员才有权限取消连接到降级的GTM的后端中运行的查询。 pg_reload_conf() 描述：导致所有服务器进程重新装载它们的配置文件。 返回值类型：Boolean 备注：pg_reload_conf给服务器发送一个SIGHUP信号，导致所有服务器进程重新装载配置文件。 pg_rotate_logfile() 描述：滚动服务器的日志文件。 返回值类型：Boolean 备注：pg_rotate_logfile给日志文件管理器发送信号，告诉它立即切换到一个新的输出文件。这个函数只有在redirect_stderr用于日志输出的时候才有用，否则不会产生日志文件管理器子进程。 pg_terminate_session(pid bigint, sessionid bigint) 描述：终止一个后台会话。 返回值类型：Boolean 备注：本函数的入参可以通过pg_stat_activity中的pid字段和sessionid的字段查询。可以用于清理线程池模式下，非活跃状态的会话。具有SYSADMIN权限的用户、会话所连接的数据库的属主、会话的属主、或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。 pg_terminate_active_session_socket(pid int64, sessionid int64) 描述：关闭一个活跃session和客户端的socket连接。 返回值类型：Boolean 备注：如果成功，函数返回true，否则返回false。仅限初始化用户才可使用该函数。 pg_terminate_backend(pid int) 描述：终止一个后台线程。仅系统管理员和线程所有者可执行该函数。 返回值类型：Boolean 备注：如果成功，函数返回true，否则返回false。具有SYSADMIN权限的用户，后端线程所连接的数据库的属主，后端线程的属主或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。 示例： 1 2 3 4 5 6 7 8 91011 gaussdb=# SELECT pid from pg_stat_activity; pid ----------------- 140657876268816(1 rows)gaussdb=# SELECT pg_terminate_backend(140657876268816); pg_terminate_backend ---------------------- t(1 row) 父主题： 系统管理函数

示例 byteawithoutorderwithequalcolin、byteawithoutorderwithequalcolout等密态等值函数为数据库内核中数据类型byteawithoutorderwithequalcol指定的in、out、send、recv等读写格式转换函数，具体可参考bytea类型的byteain、byteaout等函数，但会对本地的cek进行验证，需要密文字段中有本地存在的cekoid才能执行成功。 1 2 3 4 5 6 7 8 9101112131415 -- 例如存在加密表int_type，int_col2为其加密列-- 使用非密态客户端连接数据库，查询加密列密文gaussdb=# select int_col2 from int_type; int_col2------------------------------------------------------------------------------------------------------------------------------------------------------ \x01c35301bf421c8edf38c34704bcc82838742917778ccb402a1b7452ad4a6ac7371acc0ac33100000035fe3424919854c86194f1aa5bb4e1ca656e8fc6d05324a1419b69f488bdc3c6(1 row)-- 将加密列密文当做byteawithoutorderwithequalcolin入参，格式从cstring输入转码转化成内部byteawithoutorderwithequalcol形式gaussdb=# select byteawithoutorderwithequalcolin('\x01c35301bf421c8edf38c34704bcc82838742917778ccb402a1b7452ad4a6ac7371acc0ac33100000035fe3424919854c86194f1aa5bb4e1ca656e8fc6d05324a1419b69f488bdc3c6'); byteawithoutorderwithequalcolin------------------------------------------------------------------------------------------------------------------------------------------------------ \x01c35301bf421c8edf38c34704bcc82838742917778ccb402a1b7452ad4a6ac7371acc0ac33100000035fe3424919854c86194f1aa5bb4e1ca656e8fc6d05324a1419b69f488bdc3c6(1 row) 由于byteawithoutorderwithequalcolin等的实现会对cek进行查找，并且判断是否为正常加密后的数据类型。 因此如果用户输入数据的格式不是加密后的数据格式，并且在本地不存在对应cek的情况下，会返回错误。 1 2 3 4 5 6 7 8 9101112131415 gaussdb=# SELECT * FROM byteawithoutorderwithequalcolsend('\x907219912381298461289346129'::byteawithoutorderwithequalcol);ERROR: cek with OID 596711794 not foundLINE 1: SELECT * FROM byteawithoutorderwithequalcolsend('\x907219912... ^gaussdb=# SELECT * FROM byteawithoutordercolout('\x90721901999999999999912381298461289346129');ERROR: cek with OID 2566986098 not foundLINE 1: SELECT * FROM byteawithoutordercolout('\x9072190199999999999... SELECT * FROM byteawithoutorderwithequalcolrecv('\x90721901999999999999912381298461289346129'::byteawithoutorderwithequalcol);ERROR: cek with OID 2566986098 not found ^gaussdb=# SELECT * FROM byteawithoutorderwithequalcolsend('\x90721901999999999999912381298461289346129'::byteawithoutorderwithequalcol);ERROR: cek with OID 2566986098 not foundLINE 1: SELECT * FROM byteawithoutorderwithequalcolsend('\x907219019... ^

配置设置函数 配置设置函数是可以用于查询以及修改运行时配置参数的函数。 current_setting(setting_name) 描述：当前的设置值。 返回值类型：text 备注：current_setting用于以查询形式获取setting_name的当前值。和SQL语句SHOW是等效的。比如： 123456 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，则新值将只应用于当前事务。如果希望新值应用于当前会话，可以使用false，和SQL语句SET是等效的。 示例： 123456 gaussdb=# SELECT set_config('log_statement_stats', 'off', false); set_config------------ off(1 row) 父主题： 系统管理函数

date_part date_part函数是在传统的Ingres函数的基础上制作的（该函数等效于SQL标准函数extract）： date_part('field', source) 这里的field参数必须是一个字符串，而不是一个名称。有效的field与extract一样，详细信息请参见EXTRACT。 示例： 12345 gaussdb=# SELECT date_part('day', TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 16(1 row) 12345 gaussdb=# SELECT date_part('hour', INTERVAL '4 hours 3 minutes'); date_part ----------- 4(1 row)

EXTRACT EXTRACT(field FROM source) extract函数从日期或时间的数值里抽取子域，比如年、小时等。source必须是一个timestamp、time或interval类型的值表达式（类型为date的表达式转换为timestamp，因此也可以用）。field是一个标识符或者字符串，它指定从源数据中抽取的域。extract函数返回类型为double precision的数值。field的取值范围如下所示。 century 世纪。 第一个世纪从0001-01-01 00:00:00 AD开始。这个定义适用于所有使用阳历的国家。没有0世纪，直接从公元前1世纪到公元1世纪。 示例： 12345 gaussdb=# SELECT EXTRACT(CENTURY FROM TIMESTAMP '2000-12-16 12:21:13'); date_part ----------- 20(1 row) day 如果source为timestamp，表示月份里的日期（1-31）。 12345 gaussdb=# SELECT EXTRACT(DAY FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 16(1 row) 如果source为interval，表示天数。 12345 gaussdb=# SELECT EXTRACT(DAY FROM INTERVAL '40 days 1 minute'); date_part ----------- 40(1 row) decade 年份除以10。 12345 gaussdb=# SELECT EXTRACT(DECADE FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 200(1 row) dow 每周的星期几，星期天（0）到星期六（6）。 12345 gaussdb=# SELECT EXTRACT(DOW FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 5(1 row) doy 一年的第几天（1~365/366）。 12345 gaussdb=# SELECT EXTRACT(DOY FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 47(1 row) epoch 如果source为timestamp with time zone，表示自1970-01-01 00:00:00-00 UTC以来的秒数（结果可能是负数）； 如果source为date和timestamp，表示自1970-01-01 00:00:00-00当地时间以来的秒数； 如果source为interval，表示时间间隔的总秒数。 12345 gaussdb=# SELECT EXTRACT(EPOCH FROM TIMESTAMP WITH TIME ZONE '2001-02-16 20:38:40.12-08'); date_part -------------- 982384720.12(1 row) 12345 gaussdb=# SELECT EXTRACT(EPOCH FROM INTERVAL '5 days 3 hours'); date_part ----------- 442800(1 row) 将epoch值转换为时间戳的方法。 12345 gaussdb=# SELECT TIMESTAMP WITH TIME ZONE 'epoch' + 982384720.12 * INTERVAL '1 second' AS RESULT; result --------------------------- 2001-02-17 12:38:40.12+08(1 row) hour 小时域（0-23）。 12345 gaussdb=# SELECT EXTRACT(HOUR FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 20(1 row) isodow 一周的第几天（1-7）。 星期一为1，星期天为7。 除了星期天外，都与dow相同。 12345 gaussdb=# SELECT EXTRACT(ISODOW FROM TIMESTAMP '2001-02-18 20:38:40'); date_part ----------- 7(1 row) isoyear 日期中的ISO 8601标准年（不适用于间隔）。 每个带有星期一开始的周中包含1月4日的ISO年，所以在年初的1月或12月下旬的ISO年可能会不同于阳历的年。详细信息请参见后续的week描述。 12345 gaussdb=# SELECT EXTRACT(ISOYEAR FROM DATE '2006-01-01'); date_part ----------- 2005(1 row) 12345 gaussdb=# SELECT EXTRACT(ISOYEAR FROM DATE '2006-01-02'); date_part ----------- 2006(1 row) microseconds 秒域（包括小数部分）乘以1,000,000。 12345 gaussdb=# SELECT EXTRACT(MICROSECONDS FROM TIME '17:12:28.5'); date_part ----------- 28500000(1 row) millennium 千年。 20世纪（19xx年）里面的年份在第二个千年里。第三个千年从2001年1月1日零时开始。 12345 gaussdb=# SELECT EXTRACT(MILLENNIUM FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 3(1 row) milliseconds 秒域（包括小数部分）乘以1000。请注意它包括完整的秒。 12345 gaussdb=# SELECT EXTRACT(MILLISECONDS FROM TIME '17:12:28.5'); date_part ----------- 28500(1 row) minute 分钟域（0-59）。 12345 gaussdb=# SELECT EXTRACT(MINUTE FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 38(1 row) month 如果source为timestamp，表示一年里的月份数（1-12）。 12345 gaussdb=# SELECT EXTRACT(MONTH FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 2(1 row) 如果source为interval，表示月的数目，然后对12取模（0-11）。 12345 gaussdb=# SELECT EXTRACT(MONTH FROM INTERVAL '2 years 13 months'); date_part ----------- 1(1 row) quarter 该天所在的该年的季度（1-4）。 12345 gaussdb=# SELECT EXTRACT(QUARTER FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 1(1 row) second 秒域，包括小数部分（0-59）。 12345 gaussdb=# SELECT EXTRACT(SECOND FROM TIME '17:12:28.5'); date_part ----------- 28.5(1 row) timezone 与UTC的时区偏移量，单位为秒。正数对应UTC东边的时区，负数对应UTC西边的时区。 timezone_hour 时区偏移量的小时部分。 timezone_minute 时区偏移量的分钟部分。 week 该天在所在的年份里是第几周。ISO 8601定义一年的第一周包含该年的一月四日（ISO-8601 的周从星期一开始）。换句话说，一年的第一个星期四在第一周。 在ISO定义里，一月的头几天可能是前一年的第52或者第53周，十二月的后几天可能是下一年第一周。比如，2005-01-01是2004年的第53周，而2006-01-01是2005年的第52周，2012-12-31是2013年的第一周。建议isoyear字段和week一起使用以得到一致的结果。 12345 gaussdb=# SELECT EXTRACT(WEEK FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 7(1 row) year 年份域。 12345 gaussdb=# SELECT EXTRACT(YEAR FROM TIMESTAMP '2001-02-16 20:38:40'); date_part ----------- 2001(1 row)

TIMESTAMPDIFF TIMESTAMPDIFF(unit , timestamp_expr1, timestamp_expr2) timestampdiff函数是计算两个日期时间之间(timestamp_expr2-timestamp_expr1)的差值，并以unit形式范围结果。timestamp_expr1，timestamp_expr2必须是一个timestamp、timestamptz、date类型的值表达式。unit表示的是两个日期差的单位。 等效于timestamp_diff(text, timestamp, timestamp)。 该函数仅在GaussDB兼容MySQL类型时（即dbcompatibility = 'MYSQL'）有效，其他类型不支持该函数。 year 年份。 12345 gaussdb=# SELECT TIMESTAMPDIFF(YEAR, '2018-01-01', '2020-01-01'); timestamp_diff---------------- 2(1 row)

时间/日期函数 age(timestamp, timestamp) 描述：将两个参数相减，并以年、月、日作为返回值。若相减值为负，则函数返回亦为负，入参可以都带timezone或都不带timezone。 返回值类型：interval 示例： 12345 gaussdb=# SELECT age(timestamp '2001-04-10', timestamp '1957-06-13'); age ------------------------- 43 years 9 mons 27 days(1 row) age(timestamp) 描述：当前时间和参数相减，入参可以带或者不带timezone。 返回值类型：interval 示例： 12345 gaussdb=# SELECT age(timestamp '1957-06-13'); age ------------------------- 60 years 2 mons 18 days(1 row) clock_timestamp() 描述：实时时钟的当前时间戳。volatile函数，每次扫描都会取最新的时间戳，因此在一次查询中每次调用结果不相同。 返回值类型：timestamp with time zone 示例： 12345 gaussdb=# SELECT clock_timestamp(); clock_timestamp ------------------------------- 2017-09-01 16:57:36.636205+08(1 row) current_date 描述：当前日期。 返回值类型：date 示例： 12345 gaussdb=# SELECT current_date; date ------------ 2017-09-01(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下返回值类型为timestamp。 current_time 描述：当前时间。 返回值类型：time with time zone 示例： 12345 gaussdb=# SELECT current_time; timetz -------------------- 16:58:07.086215+08(1 row) current_timestamp 描述：当前日期及时间。语句级别时间，同一个语句内返回结果不变。 返回值类型：timestamp with time zone 示例： 12345 gaussdb=# SELECT current_timestamp; pg_systimestamp ------------------------------ 2017-09-01 16:58:19.22173+08(1 row) current_timestamp(precision) 描述：当前日期及时间，并将结果的微秒圆整为指定小数位。 返回值类型：timestamp with time zone 示例： 12345 gaussdb=# SELECT current_timestamp(1); timestamptz ------------------------------ 2017-09-01 16:58:19.2+08(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下，precision参数支持numeric类型的整值，否则仅支持int输入。 微秒末位的0不显示，如2017-09-01 10:32:19.212000输出显示为2017-09-01 10:32:19.212。 date_part(text, timestamp) 描述： 获取日期或者时间值中子域的值，例如年或者小时的值。 等效于extract(field from timestamp)。 timestamp类型：abstime、date、interval、reltime、time with time zone、time without time zone、timestamp with time zone、timestamp without time zone。 返回值类型：double precision 示例： 12345 gaussdb=# SELECT date_part('hour', timestamp '2001-02-16 20:38:40'); date_part ----------- 20(1 row) date_part(text, interval) 描述：获取月份的值。如果大于12，则取与12的模。等效于extract(field from timestamp)。 返回值类型：double precision 示例： 12345 gaussdb=# SELECT date_part('month', interval '2 years 3 months'); date_part ----------- 3(1 row) timestamp_diff(text, timestamp, timestamp) 描述：计算两个日期时间之间的差值，截取到参数text指定的精度。 返回值类型：int64 示例： 1 2 3 4 5 6 7 8 9101112131415161718192021222324252627282930313233343536373839404142434445 gaussdb=# SELECT timestamp_diff('year','2018-01-01','2020-04-01'); timestamp_diff ---------------- 2(1 row)gaussdb=# SELECT timestamp_diff('month','2018-01-01','2020-04-01'); timestamp_diff ---------------- 27(1 row)gaussdb=# SELECT timestamp_diff('quarter','2018-01-01','2020-04-01'); timestamp_diff ---------------- 9(1 row)gaussdb=# SELECT timestamp_diff('week','2018-01-01','2020-04-01'); timestamp_diff ---------------- 117(1 row)gaussdb=# SELECT timestamp_diff('day','2018-01-01','2020-04-01'); timestamp_diff ---------------- 821(1 row)gaussdb=# SELECT timestamp_diff('hour','2018-01-01 10:10:10','2018-01-01 12:12:12'); timestamp_diff ---------------- 2(1 row)gaussdb=# SELECT timestamp_diff('minute','2018-01-01 10:10:10','2018-01-01 12:12:12'); timestamp_diff ---------------- 122(1 row)gaussdb=# SELECT timestamp_diff('second','2018-01-01 10:10:10','2018-01-01 10:12:12'); timestamp_diff ---------------- 122(1 row)gaussdb=# SELECT timestamp_diff('microsecond','2018-01-01 10:10:10','2018-01-01 10:12:12'); timestamp_diff ---------------- 122000000(1 row) date_trunc(text, timestamp) 描述：截取到参数text指定的精度。 返回值类型：interval、timestamp with time zone、timestamp without time zone 示例： 12345 gaussdb=# SELECT date_trunc('hour', timestamp '2001-02-16 20:38:40'); date_trunc --------------------- 2001-02-16 20:00:00(1 row) trunc(timestamp) 描述：默认按天截取。 示例： 1234 gaussdb=# SELECT trunc(timestamp '2001-02-16 20:38:40'); trunc---------------------2001-02-16 00:00:00(1 row) trunc(arg1, arg2) 描述：截取到arg2指定的精度。 arg1类型：interval、timestamp with time zone、timestamp without time zone arg2类型：text 返回值类型：interval、timestamp with time zone、timestamp without time zone 示例： 1234 gaussdb=# SELECT trunc(timestamp '2001-02-16 20:38:40', 'hour'); trunc---------------------2001-02-16 20:00:00(1 row) round(arg1, arg2) 描述：四舍五入到arg2指定的精度。 arg1类型：timestamp without time zone arg2类型：text 返回值类型：timestamp without time zone 示例： 1234 gaussdb=# SELECT round(timestamp '2001-02-16 20:38:40', 'hour'); round---------------------2001-02-16 21:00:00(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下有效。 daterange(arg1, arg2) 描述：获取时间边界信息。 arg1类型：date arg2类型：date 返回值类型：daterange 示例： 12345 gaussdb=# select daterange('2000-05-06','2000-08-08'); daterange ------------------------- [2000-05-06,2000-08-08)(1 row) daterange(arg1, arg2, text) 描述：获取时间边界信息。 arg1类型：date arg2类型：date text类型：text 返回值类型：daterange 示例： 12345 gaussdb=# select daterange('2000-05-06','2000-08-08','[]'); daterange ------------------------- [2000-05-06,2000-08-09)(1 row) extract(field from timestamp) 描述：获取小时的值。 返回值类型：double precision 示例： 12345 gaussdb=# SELECT extract(hour from timestamp '2001-02-16 20:38:40'); date_part ----------- 20(1 row) extract(field from interval) 描述：获取月份的值。如果大于12，则取与12的模。 返回值类型：double precision 示例： 12345 gaussdb=# SELECT extract(month from interval '2 years 3 months'); date_part ----------- 3(1 row) isfinite(date) 描述：测试是否为有效日期。 返回值类型：Boolean 示例： 12345 gaussdb=# SELECT isfinite(date '2001-02-16'); isfinite ---------- t(1 row) isfinite(timestamp) 描述：测试判断是否为有效时间。 返回值类型：Boolean 示例： 12345 gaussdb=# SELECT isfinite(timestamp '2001-02-16 21:28:30'); isfinite ---------- t(1 row) isfinite(interval) 描述：测试是否为有效区间。 返回值类型：Boolean 示例： 12345 gaussdb=# SELECT isfinite(interval '4 hours'); isfinite ---------- t(1 row) justify_days(interval) 描述：将时间间隔以月（30天为一月）为单位。 返回值类型：interval 示例： 12345 gaussdb=# SELECT justify_days(interval '35 days'); justify_days -------------- 1 mon 5 days(1 row) justify_hours(interval) 描述：将时间间隔以天（24小时为一天）为单位。 返回值类型：interval 示例： 12345 gaussdb=# SELECT JUSTIFY_HOURS(INTERVAL '27 HOURS'); justify_hours ---------------- 1 day 03:00:00(1 row) justify_interval(interval) 描述：结合justify_days和justify_hours，调整interval。 返回值类型：interval 示例： 12345 gaussdb=# SELECT JUSTIFY_INTERVAL(INTERVAL '1 MON -1 HOUR'); justify_interval ------------------ 29 days 23:00:00(1 row) localtime 描述：当前时间。 返回值类型：time 示例： 12345 gaussdb=# SELECT localtime AS RESULT; result---------------- 16:05:55.664681(1 row) localtimestamp 描述：当前日期及时间。 返回值类型：timestamp 示例： 12345 gaussdb=# SELECT localtimestamp; timestamp ---------------------------- 2017-09-01 17:03:30.781902(1 row) now() 描述：当前日期及时间。事务级别时间，同一个事务内返回结果相同。 返回值类型：timestamp with time zone 示例： 12345 gaussdb=# SELECT now(); now ------------------------------- 2017-09-01 17:03:42.549426+08(1 row) timenow() 描述：当前日期及时间。 返回值类型：abstime 示例： 12345 gaussdb=# select timenow(); timenow------------------------ 2020-06-23 20:36:56+08(1 row) numtodsinterval(num, interval_unit) 描述：将数字转换为interval类型。num为numeric类型数字，interval_unit为固定格式字符串（'DAY' | 'HOUR' | 'MINUTE' | 'SECOND'）。 可以通过设置GUC参数IntervalStyle为oracle，兼容该函数在Oracle中的interval输出格式。 返回值类型：interval 示例： 1 2 3 4 5 6 7 8 910111213 gaussdb=# SELECT numtodsinterval(100, 'HOUR'); numtodsinterval ----------------- 100:00:00(1 row)gaussdb=# SET intervalstyle = oracle;SETgaussdb=# SELECT numtodsinterval(100, 'HOUR'); numtodsinterval------------------------------- +000000004 04:00:00.000000000(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下：当参数interval_unit为 'DAY' 时，参数num超过1000000000会报错。 numtoyminterval(num, interval_unit) 描述：将数字转换为interval类型。num为numeric类型数字，interval_unit为固定格式字符串（'YEAR' | 'MONTH'）。 可以通过设置GUC参数IntervalStyle为oracle，兼容该函数在Oracle中的interval输出格式。 返回值类型：interval 示例： 1 2 3 4 5 6 7 8 910111213 gaussdb=# SELECT numtoyminterval(100, 'MONTH'); numtoyminterval ----------------- 8 years 4 mons(1 row)gaussdb=# SET intervalstyle = oracle;SETgaussdb=# SELECT numtodsinterval(100, 'MONTH'); numtoyminterval ----------------- 8-4(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下有效。 new_time(date, timezone1,timezone2) 描述：当timezone1所表示时区的日期时间为date的时候，返回此时timezone2所表示时区的日期时间值。 返回值类型：timestamp 示例： 1 2 3 4 5 6 7 8 910 gaussdb=# select new_time('1997-10-10','AST','EST'); new_time --------------------- 1997-10-09 23:00:00(1 row)gaussdb=# SELECT NEW_TIME(TO_TIMESTAMP ('10-Sep-02 14:10:10.123000','DD-Mon-RR HH24:MI:SS.FF'), 'AST', 'PST'); new_time ------------------------- 2002-09-10 10:10:10.123(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下生效。 sessiontimezone 描述：当前会话的时区，无入参。 返回值类型：text 示例： 1 2 3 4 5 6 7 8 910 gaussdb=# SELECT SESSIONTIMEZONE; session_time_zone ------------------- PST8PDT(1 row)gaussdb=# SELECT LOWER(SESSIONTIMEZONE); lower ----------- @ 8 hours(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下生效。 sys_extract_utc(timestamp| timestamptz) 描述：从具有时区偏移量或时区区域名称的日期时间值中提取UTC（协调世界时-以前称为格林威治平均时间）。如果未指定时区，则日期时间与会话时区关联。入参有timestmp和timestamp两种形式。 返回值类型：timestamp。 示例： 1 2 3 4 5 6 7 8 910 gaussdb=# SELECT SYS_EXTRACT_UTC(TIMESTAMP '2000-03-28 11:30:00.00'); sys_extract_utc --------------------- 2000-03-28 03:30:00(1 row)gaussdb=# SELECT SYS_EXTRACT_UTC(TIMESTAMPTZ '2000-03-28 11:30:00.00 -08:00'); sys_extract_utc --------------------- 2000-03-28 19:30:00(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下生效。 tz_offset('time_zone_name' | '(+/-)hh:mi' | SESSIONTIMEZONE | DBTIMEZONE) 描述：入参有以上四种形式，返回入参所表示时区的UTC偏移量。 返回值类型：text。 示例： 1 2 3 4 5 6 7 8 910 gaussdb=# SELECT TZ_OFFSET('US/Pacific'); tz_offset ----------- -08:00(1 row)gaussdb=# SELECT TZ_OFFSET(sessiontimezone); tz_offset ----------- +08:00(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s2的情况下生效。 pg_sleep(seconds) 描述：服务器线程延迟时间，单位为秒。注意，当数据库调用该函数时，会获取相应的事务快照，相当于一个长事务，如果入参时间过长可能导致数据库oldestxmin无法推进，影响表的回收和查询性能。 返回值类型：void 示例： 12345 gaussdb=# SELECT pg_sleep(10); pg_sleep ----------(1 row) statement_timestamp() 描述：当前日期及时间。 返回值类型：timestamp with time zone 示例： 12345 gaussdb=# SELECT statement_timestamp(); statement_timestamp ------------------------------- 2017-09-01 17:04:39.119267+08(1 row) sysdate 描述：当前日期及时间。 返回值类型：timestamp 示例： 12345 gaussdb=# SELECT sysdate; sysdate --------------------- 2017-09-01 17:04:49(1 row) current_sysdate 描述：当前日期及时间。 返回值类型：timestamp 示例： 12345 gaussdb=# SELECT current_sysdate(); current_sysdate --------------------- 2023-06-20 20:09:02(1 row) timeofday() 描述：当前日期及时间（像clock_timestamp，但是返回时为text）。 返回值类型：text 示例： 12345 gaussdb=# SELECT timeofday(); timeofday ------------------------------------- Fri Sep 01 17:05:01.167506 2017 CST(1 row) transaction_timestamp() 描述：当前日期及时间，与current_timestamp等效。 返回值类型：timestamp with time zone 示例： 12345 gaussdb=# SELECT transaction_timestamp(); transaction_timestamp ------------------------------- 2017-09-01 17:05:13.534454+08(1 row) add_months(d,n) 描述：用于计算时间点d再加上n个月的时间。 d：timestamp类型的值，以及可以隐式转换为timestamp类型的值。 n：INTEGER类型的值，以及可以隐式转换为INTEGER类型的值。 返回值类型：timestamp 示例： 12345 gaussdb=# SELECT add_months(to_date('2017-5-29', 'yyyy-mm-dd'), 11) FROM sys_dummy; add_months --------------------- 2018-04-29 00:00:00(1 row) 此函数在参数a_format_version值为10c和a_format_dev_version值为s1的情况下： 当计算结果大于公元9999年时会报错。 参数n若入参为小数则不会被四舍五入，而是被截断。 last_day(d) 描述：用于计算时间点d当月最后一天的时间。 返回值类型：timestamp 示例： 12345 gaussdb=# select last_day(to_date('2017-01-01', 'YYYY-MM-DD')) AS cal_result; cal_result --------------------- 2017-01-31 00:00:00(1 row)

序列号生成函数 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

操作符 = 描述：比较hll或hll_hashval的值是否相等。 返回值类型：bool 示例： 1 2 3 4 5 6 7 8 910111213 --hllgaussdb=# select (hll_empty() || hll_hash_integer(1)) = (hll_empty() || hll_hash_integer(1));column ---------- t(1 row)--hll_hashvalgaussdb=# select hll_hash_integer(1) = hll_hash_integer(1); ?column? ---------- t(1 row)