华为云用户手册

其它函数 pgxc_pool_check() 描述：检查连接池中缓存的连接数据是否与pgxc_node一致。 返回值类型：Boolean pgxc_pool_reload() 描述：更新连接池中缓存的连接信息。 返回值类型：Boolean reload_active_coordinator() 描述：对所有存活的CN，更新连接池中缓存的连接信息。 返回值类型：void pgxc_lock_for_backup() 描述：为备份操作给集群加锁，这些备份是为在新增节点上做恢复。 返回值类型：Boolean pgxc_lock_for_backup是在使用gs_dump或gs_dumpall工具备份集群前，用来给集群加锁的。当给集群加锁后，不允许有改变系统结构的操作。该函数不影响DML语句。 pg_pool_validate(clear bool, node_name text) 描述：显示CN到节点node_name之间pooler中无效连接，当clear为true时清理无效连接。 返回值类型：record pgxc_pool_connection_status() 描述：检查pooler连接状态是否正常。 返回值类型：boolean pg_nodes_memory() 描述：查看所有节点的内存占用。 返回值类型：record table_skewness(text) 描述：查看表数据在所有节点的占比。 参数：表示待查询表的表名，为text类型。 返回值类型：record table_skewness(text, text, text) 描述：查看表数据指定列在所有节点的占比。 参数：表示待查询表的表名、指定列名、指定的表的记录数（默认值为0，查询所有记录），都为text类型。 返回值类型：record 返回值说明：节点编号，指定列的数据行数，当前节点数据量相对总数据量的占比。 示例： 返回't'表'a'字段前5行数据在节点上的分布。 openGauss=# select table_skewness('t', 'a',5); table_skewness ---------------- (1,3,60.000%) (2,2,40.000%) (2 rows) 返回't'表'a'字段所有数据在节点上的分布。 openGauss=# select table_skewness('t', 'a'); table_skewness ---------------- (1,7,70.000%) (2,2,20.000%) (0,1,10.000%) (3 rows) table_skewness_with_schema(text, text) 描述：查看表数据在所有节点的占比，与table_skewness(text)作用相同。 参数：表示待查询表的schema名称和表名，为text类型。 返回值类型：record table_data_skewness(colrecord, type) 描述：查看表数据所在节点。 参数说明： colrecord：表示待查询表的列名记录，为record类型。 type：hash分布类型 返回值类型：smallint 示例： openGauss=# select table_data_skewness(row(index), 'R') from test1; table_data_skewness --------------------- 4 3 1 2 (4 rows) table_distribution(schemaname text, tablename text) 描述：查看指定表在各个节点上占用的存储空间。 参数：表示待查询表的模式名和表名，均为text类型。 返回值类型：record 使用本函数查询指定表存储分布信息，需要具备指定表的SELECT权限。 table_distribution性能比table_skewness更优，尤其是在大数据量场景下，请优先考虑使用table_distribution函数。 当使用table_distribution并希望直观的看到空间占比时，可使用dnsize/(sum(dnsize) over ())的方式查看出具体的占比情况。 table_distribution() 描述：查看当前库中所有表在各节点的存储空间分布情况。 返回值类型：record 使用本函数涉及全库表信息查询，需要具备管理员权限。 当前基于table_distribution()函数， GaussDB 提供视图PGXC_GET_TABLE_SKEWNESS进行数据倾斜查询，建议在数据库中表数量（小于10000）较少的场景直接使用。 plan_seed 描述：获取前一次查询语句的seed值（内部使用）。 返回值类型：int pg_stat_get_env 描述：获取当前节点的环境变量信息，仅sysadmin和monitor admin可以访问。 返回值类型：record 示例： openGauss=# select pg_stat_get_env(); pg_stat_get_env --------------------------------------------------------------------------------------------------------------------------------------- (coordinator1,localhost,144773,49100,/data1/GaussDB_Kernel_TRUNK/install,/data1/GaussDB_Kernel_TRUNK/install/data/coordinator1,pg_log) (1 row) pg_catalog.plancache_clean() 描述：清理节点上无人使用的全局计划缓存。 返回值类型：bool pg_stat_get_thread 描述：提供当前节点下线程的状态信息，sysadmin和monitor admin用户可以查看所有线程的信息，普通用户只能查看本用户的线程信息。 返回值类型：record pgxc_get_os_threads 描述：提供整个集群中所有正常节点下的线程状态信息。 返回值类型：record pg_stat_get_sql_count 描述：提供当前节点中用户执行的SELECT/UPDATE/INSERT/DELETE/MERGE INTO语句的计数结果，sysadmin和monitor admin用户可以查看所有用户的信息，普通用户只能查看本用户的统计信息。 返回值类型：record pgxc_get_sql_count 描述：提供整个集群所有节点中所有用户执行的SELECT/UPDATE/INSERT/DELETE/MERGE INTO语句的计数结果。 返回值类型：record pgxc_get_node_env 描述：提供获取集群中所有节点的环境变量信息。 返回值类型：record pgxc_disaster_read_set(text) 描述：设置灾备集群的节点信息到ETCD上。仅灾备集群可用，仅初始用户可调用。 返回值类型：Boolean pgxc_disaster_read_init 描述：初始化灾备可读的资源和状态信息。仅灾备集群可用，仅初始用户可调用。 返回值类型：Boolean pgxc_disaster_read_clear 描述：清理灾备可读的资源和状态信息。仅灾备集群可用，仅初始用户可调用。 返回值类型：Boolean pgxc_disaster_read_status 描述：提供灾备集群的节点信息，仅灾备集群可用。 返回值类型：record gs_switch_relfilenode 描述：交换两个表或分区的元信息（重分布工具内部使用，用户直接使用会有错误信息提示）。 返回值类型：int pg_catalog.plancache_clean() 描述：清理当前节点上无人使用的全局计划缓存。 返回值类型：boolean DBE_PERF.global_plancache_clean() 描述：清理所有节点上无人使用的全局计划缓存。 返回值类型：Boolean copy_error_log_create() 描述：创建COPY FROM容错机制所需要的错误表（public.pgxc_copy_error_log）。 返回值类型：Boolean 此函数会尝试创建public.pgxc_copy_error_log表，表的详细信息请参见表1。 在relname列上创建B-tree索引，并REVOKE ALL on public.pgxc_copy_error_log FROM public对错误表进行权限控制（与COPY语句权限一致）。 由于尝试创建的public.pgxc_copy_error_log定义是一张行存表，因此集群上必须支持行存表的创建才能够正常运行此函数，并使用后续的COPY容错功能。需要特别注意的是，enable_hadoop_env这个GUC参数开启后会禁止在集群内创建行存表（GaussDB默认为off）。 此函数自身权限为Sysadmin及以上（与错误表、COPY权限一致）。 若创建前public.pgxc_copy_error_log表已存在或者copy_error_log_relname_idx索引已存在，则此函数会报错回滚。 表1 错误表public.pgxc_copy_error_log信息 列名称 类型 描述 relname character varying 表名称。以模式名.表名形式显示。 begintime timestamp with time zone 出现数据格式错误的时间。 filename character varying 出现数据格式错误的数据源文件名。 lineno bigint 在数据源文件中，出现数据格式错误的行号。 rawrecord text 在数据源文件中，出现数据格式错误的原始记录。 detail text 详细错误信息。 pg_stat_get_data_senders() 描述：提供当前活跃的数据复制发送线程的详细信息。 返回值类型：record textlen() 描述：提供查询text的逻辑长度的方法。 返回值类型：int threadpool_status() 描述：显示线程池中工作线程及会话的状态信息。 返回值类型：record get_local_active_session() 描述：提供当前节点保存在内存中的历史活跃session状态的采样记录，sysadmin和monitor admin权限能查看当前节点所有的历史活跃session记录，普通用户查看本会话的历史活跃session记录。 返回值类型：record dbe_perf.get_global_active_session() 描述：提供所有节点保存在内存中的历史活跃session状态的采样记录。 返回值类型：record dbe_perf.get_global_gs_asp(timestamp,timestamp) 描述：提供所有节点保存在系统表gs_asp中的历史活跃session状态的采样记录。 返回值类型：record get_wait_event_info() 描述：提供wait event事件的具体信息。 返回值类型：record dbe_perf.get_datanode_active_session(text) 描述：提供从CN查询DN上保存在内存中的历史活跃session状态的采样记录。 返回值类型：record 备注：该函数查询目标DN上local_active_session视图中记录并和所有CN上的local_active_session中的记录进行匹配获取query string，所以会占用大量的内存。 dbe_perf.get_datanode_active_session_hist(text,timestamp,timestamp) 描述：提供从CN查询DN上保存在系统表gs_asp中的历史活跃session状态的采样记录。 返回值类型：record 备注：该函数查询目标DN上指定时间段的gs_asp记录，如果指定时间段过长造成查询的记录过多，会耗费大量时间。 generate_wdr_report(bigint, bigint, cstring, cstring,cstring) 描述：基于两个snapshot生成系统诊断报告，默认初始化用户或监控管理员用户可以访问。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：text 表2 generate_wdr_report参数说明 参数 说明 取值范围 begin_snap_id 生成某段时间内性能诊断报告的开始snapshotid。 - end_snap_id 结束snapshot的id，默认end_snap_id大于begin_snap_id。 - report_type 指定生成report的类型。 summary detail all，即同时包含summary和detail。 report_scope 指定生成report的范围。 cluster：数据库级别的信息 node：节点级别的信息。 node_name 在“report_scope”指定为“node”时，需要把该参数指定为对应节点的名称。 在“report_scope”为“cluster”时，该参数可以省略，或指定为NULL。 node：GaussDB中的节点名称。 cluster：省略/空/NULL。 create_wdr_snapshot() 描述：手工生成系统诊断快照，该函数需要sysadmin权限，且只能在CCN上执行。 返回值类型：text kill_snapshot() 描述：kill后台的WDR snapshot线程，调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 返回值类型：void capture_view_to_json(text,integer) 描述：将视图的结果存入GUC: perf_directory所指定的目录，如果is_crossdb为1，则表示对于所有的database都会访问一次view；如果is_crossdb为0，则表示仅对当前database进行一次视图访问。该函数只有sysadmin和monitor admin用户可以执行。 返回值类型：int reset_unique_sql(text,text,bigint) 描述：用来清理CN/DN内存中的Unique SQL（需要sysadmin/monitor admin权限）。 返回值类型：Boolean 表3 reset_unique_sql参数说明 参数 类型 描述 scope text 清理范围类型： 'GLOBAL' - 清理所有的CN/DN节点，如果是'GLOBAL'，则只可以为CN节点执行此函数。 'LOCAL' - 清理本节点。 clean_type text 'BY_USERID' - 按用户ID来进行清理Unique SQL。 'BY_CNID' - 按CN的ID来进行清理Unique SQL。 'ALL' - 全部清理。 clean_value int8 具体清理type对应的清理值。如果第二个参数为ALL，则第三个参数不起作用，可以取任意值。 wdr_xdb_query(db_name_str text, query text) 描述：提供本地跨数据库执行query的能力。例如: 在连接到testdb库时, 访问test库下的表。只有系统管理员才有权限执行。 select col1 from wdr_xdb_query('dbname=test','select col1 from t1') as dd(col1 int); 返回值类型：record pg_wlm_jump_queue(pid int) 描述：调整任务到CN队列的最前端。 返回值类型：boolean true：成功。 false：失败。 gs_wlm_switch_cgroup(pid int, cgroup text) 描述：调整作业的优先级到新控制组。 返回值类型：boolean true：成功。 false：失败。 pv_session_memctx_detail(threadid tid, MemoryContextName text) 描述：将线程tid的MemoryContextName内存上下文信息记录到“$GAUSS LOG /pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。其中threadid可通过查询表PV_SESSION_MEMORY_DETAIL中的sessid字段获得。在正式发布的版本中仅接受MemoryContextName为空串（两个单引号表示输入为空串，即''）的输入，此时会记录所有的内存上下文信息，否则不会有任何操作。该函数需要管理员权限的用户才能执行。 返回值类型：boolean true：成功。 false：失败。 pg_shared_memctx_detail(MemoryContextName text) 描述：将MemoryContextName内存上下文信息记录到“$GAUSSLOG/pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。在正式发布版本中调用该函数不会有任何操作。该函数需要管理员权限的用户才能执行。 返回值类型：boolean true：成功。 false：失败。 local_bgwriter_stat() 描述：显示本实例的bgwriter线程刷页信息，候选buffer链中页面个数，buffer淘汰信息。 返回值类型：record local_candidate_stat() 描述：显示本实例的候选buffer链中页面个数，buffer淘汰信息，包含normal buffer pool和segment buffer pool。 返回值类型：record local_ckpt_stat() 描述：显示本实例的检查点信息和各类日志刷页情况。 返回值类型：record local_double_write_stat() 描述：显示本实例的双写文件的情况。 返回值类型：record 表4 local_double_write_stat参数说明 参数 类型 描述 node_name text 实例名称。 curr_dwn int8 当前双写文件的序列号。 curr_start_page int8 当前双写文件恢复起始页面。 file_trunc_num int8 当前双写文件复用的次数。 file_reset_num int8 当前双写文件写满后发生重置的次数。 total_writes int8 当前双写文件总的I/O次数。 low_threshold_writes int8 低效率写双写文件的I/O次数（一次I/O刷页数量少于16页面）。 high_threshold_writes int8 高效率写双写文件的I/O次数（一次I/O刷页数量多于一批，421个页面）。 total_pages int8 当前刷页到双写文件区的总的页面个数。 low_threshold_pages int8 低效率刷页的页面个数。 high_threshold_pages int8 高效率刷页的页面个数。 file_id int8 当前双写文件的id号 local_single_flush_dw_stat() 描述：显示本实例的单页面淘汰双写文件的情况。 返回值类型：record local_pagewriter_stat() 描述：显示本实例的刷页信息和检查点信息。 返回值类型：record local_redo_stat() 描述：显示本实例的备机的当前回放状态。 返回值类型：record 备注：返回的回放状态主要包括当前回放位置，回放最小恢复点位置等信息。 local_recovery_status() 描述：显示本实例的主机和备机的日志流控信息。 返回值类型：record local_rto_status() 描述：显示本实例的主机和备机的日志流控信息。 返回值类型：record gs_cgroup_map_ng_conf(group name) 描述：读取指定Node group的cgroup配置文件。该函数只有sysadmin权限的用户可以执行。 返回值类型：record pgxc_cgroup_map_ng_conf(group name) 描述：在所有节点上读取指定Node group的cgroup配置文件。该函数只有sysadmin权限的用户可以执行。 返回值类型：bool gs_wlm_switch_cgroup(sess_id int8, cgroup name) 描述：切换指定会话的控制组。 返回值类型：record comm_client_info() 描述：用于查询单个节点活跃的客户端连接信息，返回结果解释见COMM_CLIENT_INFO。 返回值类型：setof record pg_get_flush_lsn() 描述：返回当前节点flush的xLog位置。 返回值类型：text pg_get_sync_flush_lsn() 描述：返回当前节点多数派flush的xLog位置。 返回值类型：text pgxc_wlm_rebuild_user_resource_pool() 描述：重新构建用户及资源池缓存信息。需要系统管理员权限才可以执行该函数。 返回值类型：boolean locktag_decode(locktag text) 描述：从locktag中解析锁的具体信息。 示例： openGauss=# select locktag_decode('271b:0:0:0:0:6'); locktag_decode --------------------------------------------- locktype:transactionid, transactionid:10011 (1 row) 返回值类型：text disable_conn(disconn_mode text, host text, port integer) 描述：CM Agent处理CM Server下发的命令，在DN进行选主时设置该DN拒绝连接所有DN、强制连接某个DN或轮询连接所有DN。只有初始化用户和系统管理员才可以调用该函数。 返回值类型：void 表5 disable_conn参数说明 参数 类型 描述 disconn_mode text DN连接模式： 'prohibit_connection' - 拒绝连接所有DN。 'specify_connection' - 强制连接某个DN。 'polling_connection' - 轮询连接所有DN。 host text DN的IP。 port integer DN的端口号。 dbe_perf.get_global_full_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone) 描述：获取集群级的全量SQL(Full SQL)信息。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：record 表6 dbe_perf.get_global_full_sql_by_timestamp参数说明 参数 类型 描述 start_timestamp timestamp with time zone SQL启动时间范围的开始时间点。 end_timestamp timestamp with time zone SQL启动时间范围的结束时间点。 dbe_perf.get_global_slow_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone) 描述：获取集群级的慢SQL(Slow SQL)信息。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：record 表7 dbe_perf.get_global_slow_sql_by_timestamp参数说明 参数 类型 描述 start_timestamp timestamp with time zone SQL启动时间范围的开始时间点。 end_timestamp timestamp with time zone SQL启动时间范围的结束时间点。 statement_detail_decode(detail text, format text, pretty boolean) 描述：解析全量/慢SQL语句中的details字段的信息。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：text 表8 statement_detail_decode参数说明 参数 类型 描述 detail text SQL语句产生的事件的集合（不可读）。 format text 解析输出格式，取值为plaintext。 pretty boolean 当format为plaintext时，是否以优雅的格式展示： true表示通过“\n”分隔事件。 false表示通过“，”分隔事件。 pgxc_get_csn(tid) 描述：返回给定的事务id对应的事务提交序号（ CS N）。 返回值类型：int8 get_global_user_transaction() 描述：返回所有节点上各用户的事务相关信息。 返回值类型：node_name name, usename name, commit_counter bigint, rollback_counter bigint, resp_min bigint, resp_max bigint, resp_avg bigint, resp_total bigint, bg_commit_counter bigint, bg_rollback_counter bigint, bg_resp_min bigint, bg_resp_max bigint, bg_resp_avg bigint, bg_resp_total bigint pg_collation_for 描述：返回入参字符串对应的排序规则 参数：any（如果是常量必须进行显式类型转换） 返回值类型：text pgxc_unlock_for_sp_database(name Name) 描述：释放指定数据库锁。 参数：数据库名 返回值类型：布尔 pgxc_lock_for_sp_database(name Name) 描述：对指定的数据库加锁。 参数：数据库名 返回值类型：布尔 pgxc_unlock_for_transfer(name Name) 描述：释放用于数据传输（数据重分布）锁。 参数：数据库名 返回值类型：布尔 pgxc_lock_for_transfer(name Name) 描述：对数据库枷锁，用于数据传输（数据重分布）。 参数：数据库名 返回值类型：布尔 gs_catalog_attribute_records() 描述：对于指定的系统表oid，返回该系统表对应的各个字段的定义。仅支持oid小于10000的普通系统表（不支持索引、toast表等）。 参数：系统表oid 返回值类型：record dynamic_func_control(scope text, function_name text, action text, "{params}" text[]) 描述：动态开启内置的功能，当前仅支持动态开启全量SQL。 返回值类型：record 表9 dynamic_func_control参数说明 参数 类型 描述 scope text 动态开启功能的范围，当前仅支持'GLOBAL/LOCAL'。 function_name text 功能的名称，当前仅支持'STMT'。 action text 当function_name为'STMT'时，action仅支持TRACK/UNTRACK/LIST/CLEAN： TRACK - 开始记录归一化SQL的全量SQL信息。 UNTRACK - 取消记录归一化SQL的全量SQL信息。 LIST - 列取当前TRACK的归一化SQL的信息。 CLEAN - 清理记录当前归一化SQL的信息。 params text[] 当function_name为'STMT'时，对应不同的action时，对应的params设置如下： TRACK - '{"归一化SQLID", "L0/L1/L2"}' UNTRACK - '{"归一化SQLID"}' LIST - '{}' CLEAN - '{}' gs_parse_page_bypath(path text, blocknum bigint, relation_type text, read_memory boolean) 描述：用于解析指定表页面，并返回存放解析内容的路径。 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 表10 gs_parse_page_bypath参数说明 参数 类型 描述 path text 对于普通表或段页式的普通表，相对路径为：tablespace name/database oid/表的relfilenode(物理文件名)；例如：base/16603/16394 对于段页式的hashbucket表，相对路径为：tablespace name/database oid/Segment Head的逻辑页号_b(bucketid)。例如：base/16603/16394_b1437 表文件的相对路径可以通过pg_relation_filepath(table_name text)查找。分区表的路径可以查看pg_partition系统表和调用pg_partition_filepath(partition_oid)。 合法的path格式列举： global/relNode base/dbNode/relNode pg_tblspc/spcNode/version_dir/dbNode/relNode 对于hashbucket表，在此格式基础上，路径末尾加上_b段页式的逻辑页号。 blocknum bigint -1：所有block的信息（强制从磁盘解析）。 0~MaxBlockNumber：对应block的信息。 relation_type text heap(astore表) btree(BTree索引) segment(段页式) read_memory boolean false，从磁盘文件解析； true，首先尝试从共享缓冲区中解析该页面；如果共享缓冲区中不存在，则从磁盘文件解析。 gs_xlogdump_lsn(start_lsn text, end_lsn text) 描述：用于解析指定lsn范围之内的xLog日志，并返回存放解析内容的路径。可以通过pg_current_xlog_location()获取当前xLog位置。 参数：LSN起始位置，LSN结束位置 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 gs_xlogdump_xid(c_xid xid) 描述：用于解析指定xid的xLog日志，并返回存放解析内容的路径。可以通过txid_current()获取当前事务ID。 参数：事务ID 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 gs_xlogdump_tablepath(path text, blocknum bigint, relation_type text) 描述：用于解析指定表页面对应的日志，并返回存放解析内容的路径。 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 表11 gs_xlogdump_tablepath参数说明 参数 类型 描述 path text 对于普通表或段页式的普通表，相对路径为：tablespace name/database oid/表的relfilenode(物理文件名)。例如：base/16603/16394。 对于段页式的hashbucket表，相对路径为：tablespace name/database oid/Segment Head的逻辑页号_b(bucketid)。例如：base/16603/16394_b1437 表文件的相对路径可以通过pg_relation_filepath(table_name text)查找。分区表的路径可以查看pg_partition系统表和调用pg_partition_filepath(partition_oid)。 合法的path格式列举： global/relNode base/dbNode/relNode pg_tblspc/spcNode/version_dir/dbNode/relNode 对于hashbucket表，在此格式基础上，路径末尾加上_b段页式的逻辑页号。 blocknum bigint -1：所有block的信息（强制从磁盘解析）。 0~MaxBlockNumber：对应block的信息。 relation_type text heap(astore 表) btree(BTree 索引) segment(段页式) gs_xlogdump_parsepage_tablepath(path text, blocknum bigint, relation_type text, read_memory boolean) 描述：用于解析指定表页面和表页面对应的日志，并返回存放解析内容的路径。可以看做一次执行gs_parse_page_bypath和gs_xlogdump_tablepath。该函数执行的前置条件是表文件存在。如果想查看已删除的表的相关日志，请直接调用gs_xlogdump_tablepath。 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 表12 gs_xlogdump_parsepage_tablepath参数说明 参数 类型 描述 path text 对于普通表或段页式的普通表，相对路径为：tablespace name/database oid/表的relfilenode(物理文件名)；例如：base/16603/16394 对于段页式的hashbucket表，相对路径为：tablespace name/database oid/Segment Head的逻辑页号_b(bucketid)。例如：base/16603/16394_b1437 表文件的相对路径可以通过pg_relation_filepath(table_name text)查找。分区表的路径可以查看pg_partition系统表和调用pg_partition_filepath(partition_oid)。 合法的path格式列举： global/relNode base/dbNode/relNode pg_tblspc/spcNode/version_dir/dbNode/relNode 对于hashbucket表，在此格式基础上，路径末尾加上_b段页式的逻辑页号。 blocknum bigint -1：所有block的信息（强制从磁盘解析）。 0~MaxBlockNumber：对应block的信息。 relation_type text heap(astore 表) btree(BTree 索引) segment(段页式) read_memory boolean false，从磁盘文件解析； true，首先尝试从共享缓冲区中解析该页面；如果共享缓冲区中不存在，则从磁盘文件解析。 gs_index_recycle_queue(Oid oid, int type, uint32 blkno) 描述：用于解析UBtree索引回收队列信息。 返回值类型：record 表13 gs_index_recycle_queue参数说明 参数 类型 描述 oid Oid 索引文件relfilenode,可以通过select relfilenode from pg_class where relname='name'查询，其中name表示对应的索引文件名字 type int 0，表示解析整个待回收队列 1，表示解析整个空页队列 2，表示解析单个页面 blkno uint32 回收队列页面编号，该参数只有在type=2的时候有效，blkno有效取值范围为1~4294967294。 该函数功能在分布式版本上不支持，有报错提示。 gs_stat_wal_entrytable(int64 idx) 描述：用于输出xLog中预写日志插入状态表的内容。 返回值类型：record 表14 gs_stat_wal_entrytable参数说明 参数类型 参数名 类型 描述 输入参数 idx int64 -1：查询数组所有元素。 0-最大值：具体某个数组元素内容。 输出参数 idx uint64 记录对应数组中的下标 输出参数 endlsn uint64 记录的LSN标签 输出参数 lrc int32 记录对应的LRC 输出参数 status uint32 标识当前entry对应的xLog是否已经完全拷贝到wal buffer中 0：非COPIED 1: COPIED gs_walwriter_flush_position() 描述：输出预写日志的刷新位置。 返回值类型：record 表15 gs_walwriter_flush_position参数说明 参数类型 参数名 类型 描述 输出参数 last_flush_status_entry int32 xLog flush上一个刷盘的tblEntry下标索引。 输出参数 last_scanned_lrc int32 xLog flush上一次扫描到的最后一个tblEntry记录的LRC。 输出参数 curr_lrc int32 WALInsertStatusEntry状态表中LRC最新的使用情况，该LRC表示下一个xLog记录写入时在WALInsertStatusEntry对应的LRC值。 输出参数 curr_byte_pos uint64 xLog记录写入WAL 文件，最新分配的位置，下一个xLog记录插入点。 输出参数 prev_byte_size uint32 上一个xLog记录的长度。 输出参数 flush_result uint64 当前全局xLog刷盘的位置。 输出参数 send_result uint64 当前主机上xLog发送位置。 输出参数 shm_rqst_write_pos uint64 共享内存中记录的XLogCtl中LogwrtRqst请求的write位置。 输出参数 shm_rqst_flush_pos uint64 共享内存中记录的XLogCtl中LogwrtRqst请求的flush位置。 输出参数 shm_result_write_pos uint64 共享内存中记录的XLogCtl中LogwrtResult的write位置。 输出参数 shm_result_flush_pos uint64 共享内存中记录的XLogCtl中LogwrtResult的flush位置。 输出参数 curr_time text 当前时间。 gs_walwriter_flush_stat(int operation) 描述：用于统计预写日志write与sync的次数频率与数据量，以及xLog文件的信息。 返回值类型：record 表16 gs_walwriter_flush_stat参数说明 参数类型 参数名 类型 描述 输入参数 operation int -1： 关闭统计开关(默认状态为关闭)。 0：打开统计开关。 1：查询统计信息。 2：重置统计信息。 输出参数 write_times uint64 xLog调用write接口的次数 输出参数 sync_times uint64 xLog调用sync接口次数 输出参数 total_xlog_sync_bytes uint64 Backend线程请求写入xLog总量统计值 输出参数 total_actual_xlog_sync_bytes uint64 调用sync接口实际刷盘的xLog总量统计值 输出参数 avg_write_bytes uint32 每次调用XLogWrite接口请求写的xLog量 输出参数 avg_actual_write_bytes uint32 实际每次调用write接口写的xLog量 输出参数 avg_sync_bytes uint32 平均每次请求sync的xLog量 输出参数 avg_actual_sync_bytes uint32 实际每次调用sync刷盘xLog量 输出参数 total_write_time uint64 调用write操作总时间统计(单位：us) 输出参数 total_sync_time uint64 调用sync操作总时间统计(单位：us) 输出参数 avg_write_time uint32 每次调用write接口平均时间(单位：us) 输出参数 avg_sync_time uint32 每次调用sync接口平均时间(单位：us) 输出参数 curr_init_xlog_segno uint64 当前最新创建的xLog段文件编号 输出参数 curr_open_xlog_segno uint64 当前正在写的xLog段文件编号 输出参数 last_reset_time text 上一次重置统计信息的时间 输出参数 curr_time text 当前时间 pg_ls_tmpdir() 描述：返回默认表空间下临时目录（pgsql_tmp）中每个文件的名称、大小和最后修改时间。 参数：nan 返回值类型：record 备注：必须是系统管理员或者监控管理员才能执行此函数。 参数类型 参数名 类型 描述 输出参数 name text 文件名称 输出参数 size int8 文件大小（单位：byte） 输出参数 modification timestamptz 文件最后修改时间 pg_ls_tmpdir(oid) 描述：返回指定表空间下临时目录（pgsql_tmp）中每个文件的名称、大小和最后修改时间。 参数：oid 返回值类型：record 备注：必须是系统管理员或者监控管理员才能执行此函数。 参数类型 参数名 类型 描述 输入参数 oid oid 表空间id 输出参数 name text 文件名称 输出参数 size int8 文件大小（单位：byte） 输出参数 modification timestamptz 文件最后修改时间 pg_ls_waldir() 描述：返回预写日志(WAL)目录中每个文件的名称、大小和最后修改时间。 参数：nan 返回值类型：record 备注：必须是系统管理员或者监控管理员才能执行此函数。 参数类型 参数名 类型 描述 输出参数 name text 文件名称 输出参数 size int8 文件大小（单位：byte） 输出参数 modification timestamptz 文件最后修改时间 gs_undo_dump_xid(undo_xid xid) 描述：根据xid解析undo记录 返回值类型：record 表17 gs_undo_dump_xid参数说明 参数类型 参数名 类型 描述 输入参数 undo_xid xid 事务xid 输出参数 undoptr xid 需要解析的undo记录起始位置 输出参数 xactid text 事务id 输出参数 cid text command id 输出参数 reloid text relation oid 输出参数 relfilenode text 文件的relfinode 输出参数 utype text undo记录类型 输出参数 blkprev text 同一个块前一条undo记录的位置 输出参数 blockno text 块号 输出参数 uoffset text undo记录偏移 输出参数 prevurp text 前一条undo记录位置 输出参数 payloadlen text undo记录数据部分长度 输出参数 oldxactid text 前一个事务id 输出参数 partitionoid text 分区oid 输出参数 tablespace text 表空间 输出参数 alreadyread_bytes text 读取到的undo记录长度 输出参数 prev_undorec_len text 前一条undo记录长度 输出参数 td_id text Transaction Directory的id 输出参数 reserved text 是否保存 输出参数 flag text 标识1 输出参数 flag2 text 标识2 输出参数 t_hoff text Undo记录数据头的长度 gs_write_term_log(void) 描述：写入一条日志记录DN节点当前的term值。备DN节点返回false，主DN节点写入成功后返回true。 返回值类型：Boolean 父主题： 系统管理函数

注意事项 当前会话的用户必须是指定的rolename角色的成员，当三权分立关闭时，系统管理员可以选择任何角色。 使用这条命令，它可能会增加一个用户的权限，也可能会限制一个用户的权限。如果会话用户的角色有INHERITS属性，则它自动拥有它能SET ROLE变成的角色的所有权限；在这种情况下，SET ROLE实际上是删除了所有直接赋予会话用户的权限，以及它的所属角色的权限，只剩下指定角色的权限。另一方面，如果会话用户的角色有NOINHERITS属性，SET ROLE删除直接赋予会话用户的权限，而获取指定角色的权限。

PG_STAT_DATABASE PG_STAT_DATABASE视图显示集群中每个数据库的统计信息。 表1 PG_STAT_DATABASE字段 名称 类型 描述 datid oid 数据库的OID。 datname name 数据库的名称。 numbackends integer 当前连接到该数据库的后端数。 这是该视图中唯一一个返回当前状态值的字段，其他字段返回的都是自上次重置之后的累计值。 xact_commit bigint 该数据库中已经提交的事务数。 xact_rollback bigint 该数据库中已经回滚的事务数。 blks_read bigint 在该数据库中读取的磁盘块的数量。 blks_hit bigint 已在缓冲区缓存中找到磁盘块的次数，因此不需要读取（只统计在缓冲区缓存找到的，不包括在操作系统的文件系统缓存中找到的）。 tup_returned bigint 通过数据库查询返回的行数。 tup_fetched bigint 通过数据库查询抓取的行数。 tup_inserted bigint 通过数据库查询插入的行数。 tup_updated bigint 通过数据库查询更新的行数。 tup_deleted bigint 通过数据库查询删除的行数。 conflicts bigint 由于数据库恢复冲突取消的查询数量（只在备用服务器发生的冲突）。请参见PG_STAT_DATABASE_CONFLI CTS 获取更多信息。 temp_files bigint 通过数据库查询创建的临时文件数量。计算所有临时文件， 无论该临时文件为什么创建（比如排序或者哈希）， 也不管log_temp_files参数如何设置。 temp_bytes bigint 通过数据库查询写入临时文件的数据总量。计算所有临时文件，无论该临时文件为什么创建，也不管log_temp_files参数如何设置。 deadlocks bigint 该数据库中检测到的死锁数。 blk_read_time double precision 通过数据库后端读取数据文件块花费的时间，以毫秒计算。 blk_write_time double precision 通过数据库后端写入数据文件块花费的时间，以毫秒计算。 stats_reset timestamp with time zone 当前状态统计被重置的时间。 父主题： 系统视图

GS_CLUSTER_RESOURCE_INFO GS_CLUSTER_RESOURCE_INFO视图显示的是所有DN资源的汇总信息。该视图需要设置enable_dynamic_workload=on才能查询，并且该视图不支持在DN执行。查询该视图需要sysadmin权限。 表1 GS_CLUSTER_RESOURCE_INFO字段 名称 类型 描述 min_mem_util integer DN最小内存使用率。 max_mem_util integer DN最大内存使用率。 min_cpu_util integer DN最小CPU使用率。 max_cpu_util integer DN最大CPU使用率。 min_io_util integer DN最小I/O使用率。 max_io_util integer DN最大I/O使用率。 used_mem_rate integer 物理节点最大内存使用率。 父主题： 系统视图

执行计划显示格式 GaussDB对执行计划提供了normal、pretty、summary、run四种显示格式： normal：代表使用默认的打印格式。图1中即为此显示格式。 pretty：代表使用GaussDB改进后的新显示格式。新的格式层次清晰，计划包含了plan node id，性能分析简单直接。如图2。 summary：是在pretty的基础上增加了对打印信息的分析。 run：在summary的基础上，将统计的信息输出到csv格式的文件中，以便于进一步分析。

执行计划显示信息 除了设置不同的执行计划显示格式外，还可以通过不同的EXPLAIN用法，显示不同详细程度的执行计划信息。常见有如下几种，关于更多用法请参见EXPLAIN语法说明。 EXPLAIN statement： 只生成执行计划，不实际执行。其中statement代表SQL语句。 EXPLAIN ANALYZE statement：生成执行计划，进行执行，并显示执行的概要信息。显示中加入了实际的运行时间统计，包括在每个规划节点内部花掉的总时间(以毫秒计)和它实际返回的行数。 EXPLAIN PERFORMANCE statement：生成执行计划，进行执行，并显示执行期间的全部信息。 为了测量运行时在执行计划中每个节点的开销，EXPLAIN ANALYZE或EXPLAIN PERFORMANCE会在当前查询执行上增加性能分析的开销。在一个查询上运行EXPLAIN ANALYZE或EXPLAIN PERFORMANCE有时会比普通查询明显地花费更多的时间。超支的数量依赖于查询的本质和使用的平台。 因此，当定位SQL运行慢问题时，如果SQL长时间运行未结束，建议通过EXPLAIN命令查看执行计划，进行初步定位。如果SQL可以运行出来，则推荐使用EXPLAIN ANALYZE或EXPLAIN PERFORMANCE查看执行计划及其实际的运行信息，以便更精准地定位问题原因。

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

PG_RESOURCE_POOL PG_RESOURCE_POOL系统表提供了数据库资源池的信息。 表1 PG_RESOURCE_POOL字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 respool_name name 资源池名称。 mem_percent integer 内存配置的百分比。 cpu_affinity bigint CPU绑定core的数值。 control_group name 资源池所在的control group名称。 active_statements integer 资源池上最大的并发数。 max_dop integer 最大并发度。用作扩容的接口，表示数据重分布时，扫描并发度。 memory_limit name 资源池最大的内存。 parentid oid 父资源池OID。 io_limits integer 每秒触发I/O的次数上限。行存单位是万次/s。 io_priority name I/O利用率高达90%时，重消耗I/O作业进行I/O资源管控时关联的优先级等级。 nodegroup name 表示资源池所在的Node group的名称。 is_foreign boolean 表示资源池是否用于Node group之外的用户。如果为true，表示资源池用来控制不属于当前资源池的普通用户的资源。如果为false，表示不控制不属于当前资源池的普通用户的资源。 max_worker integer 只用于扩容的接口，表示扩容数据重分布时，表内插入并发度。 父主题： 系统表

DB_TAB_COMMENTS DB_TAB_COMMENTS视图显示当前用户可访问的所有表和视图的注释信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 DB_TAB_COMMENTS字段 名称 类型 描述 owner character varying(64) 表或视图的所有者。 table_name character varying(64) 表或视图的名称。 comments text 注释。 父主题： 系统视图

LOCAL_REL_IOSTAT 获取当前节点中数据文件I/O状态的累计值，显示为所有数据文件I/O状态的总和。 表1 LOCAL_REL_IOSTAT字段 名称 类型 描述 phyrds bigint 读物理文件的数目。 phywrts bigint 写物理文件的数目。 phyblkrd bigint 读物理文件的块的数目。 phyblkwrt bigint 写物理文件的块的数目。 父主题： File

选择分布列 Hash分布表的分布列选取至关重要，需要满足以下原则： 列值应比较离散，以便数据能够均匀分布到各个DN。例如，考虑选择表的主键为分布列，如在人员信息表中选择身份证号码为分布列。 在满足上述条件的情况下，考虑选择查询中的连接条件为分布列，以便Join任务能够下推到DN中执行，且减少DN之间的通信数据量。 对于Hash分表策略，如果分布列选择不当，可能导致数据倾斜，查询时出现部分DN的I/O短板，从而影响整体查询性能。因此在采用Hash分表策略之后需对表的数据进行数据倾斜性检查，以确保数据在各个DN上是均匀分布的。可以使用以下SQL检查数据倾斜性。 1 2 3 4 5 select xc_node_id, count(1) from tablename group by xc_node_id order by xc_node_id desc; 示例如下： CREATE TABLE t1(c1 int) distribute by hash(c1); INSERT INTO t1 values(generate_series(1,100)); select xc_node_id, count(1) from t1 group by xc_node_id order by xc_node_id desc; DROP TABLE t1; 其中xc_node_id对应DN，一般来说，不同DN的数据量相差5%以上即可视为倾斜，如果相差10%以上就必须要调整分布列。 GaussDB支持多分布列特性，可以更好地满足数据分布的均匀性要求。 Range/List分布表的分布列由用户根据实际需要进行选择。除了需选择合适的分布列，还需要注意分布规则对数据分布的影响。 父主题： 表设计最佳实践

参数 表1 SQLFreeHandle参数 关键字 参数说明 HandleType SQLFreeHandle要释放的句柄类型。必须为下列值之一： SQL_HANDLE_ENV SQL_HANDLE_DBC SQL_HANDLE_STMT SQL_HANDLE_DESC 如果HandleType不是这些值之一，SQLFreeHandle返回SQL_INVALID_HANDLE。 Handle 要释放的句柄。

STAT_DATABASE_CONFLICTS 显示当前节点数据库冲突状态的统计信息。 表1 STAT_DATABASE_CONFLICTS字段 名称 类型 描述 datid oid 数据库标识。 datname name 数据库名称。 confl_tablespace bigint 冲突的表空间的数目。 confl_lock bigint 冲突的锁数目。 confl_snapshot bigint 冲突的快照数目。 confl_bufferpin bigint 冲突的缓冲区数目。 confl_deadlock bigint 冲突的死锁数目。 父主题： Object

窗口函数 窗口函数与OVER语句一起使用。OVER语句用于对数据进行分组，并对组内元素进行排序。窗口函数用于给组内的值生成序号。 窗口函数中的order by后面必须跟字段名，若order by后面跟数字，该数字会被按照常量处理，因此对目标列没有起到排序的作用。 RANK() 描述：RANK函数为各组内值生成跳跃排序序号，其中，相同的值具有相同序号。 返回值类型：BIGINT 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE rank_t1(a int, b int); openGauss=# INSERT INTO rank_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,RANK() OVER(PARTITION BY a ORDER BY b) FROM rank_t1; a | b | rank ---+---+------ 1 | 1 | 1 1 | 1 | 1 1 | 2 | 3 1 | 3 | 4 2 | 4 | 1 2 | 5 | 2 3 | 6 | 1 (7 rows) openGauss=# DROP TABLE rank_t1; ROW_NUMBER() 描述：ROW_NUMBER函数为各组内值生成连续排序序号，其中，相同的值其序号也不相同。 返回值类型：BIGINT 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE row_number_t1(a int, b int); openGauss=# INSERT INTO row_number_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,ROW_NUMBER() OVER(PARTITION BY a ORDER BY b) FROM row_number_t1; a | b | row_number ---+---+------------ 1 | 1 | 1 1 | 1 | 2 1 | 2 | 3 1 | 3 | 4 2 | 4 | 1 2 | 5 | 2 3 | 6 | 1 (7 rows) openGauss=# DROP TABLE row_number_t1; DENSE_RANK() 描述：DENSE_RANK函数为各组内值生成连续排序序号，其中，相同的值具有相同序号。 返回值类型：BIGINT 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE dense_rank_t1(a int, b int); openGauss=# INSERT INTO dense_rank_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,DENSE_RANK() OVER(PARTITION BY a ORDER BY b) FROM dense_rank_t1; a | b | dense_rank ---+---+------------ 1 | 1 | 1 1 | 1 | 1 1 | 2 | 2 1 | 3 | 3 2 | 4 | 1 2 | 5 | 2 3 | 6 | 1 (7 rows) openGauss=# DROP TABLE dense_rank_t1; PERCENT_RANK() 描述：PERCENT_RANK函数为各组内对应值生成相对序号，即根据公式 (rank - 1) / (totalrows - 1)计算所得的值。其中rank为该值依据RANK函数所生成的对应序号，totalrows为该分组内的总元素个数。 返回值类型：DOUBLE PRECISION 示例： 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE percent_rank_t1(a int, b int); openGauss=# INSERT INTO percent_rank_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,PERCENT_RANK() OVER(PARTITION BY a ORDER BY b) FROM percent_rank_t1; a | b | percent_rank ---+---+------------------ 1 | 1 | 0 1 | 1 | 0 1 | 2 | .666666666666667 1 | 3 | 1 2 | 4 | 0 2 | 5 | 1 3 | 6 | 0 (7 rows) openGauss=# DROP TABLE percent_rank_t1; CUME_DIST() 描述：CUME_DIST函数为各组内对应值生成累积分布序号。即根据公式(小于等于当前值的数据行数)/(该分组总行数totalrows)计算所得的相对序号。 返回值类型：DOUBLE PRECISION 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE cume_dist_t1(a int, b int); openGauss=# INSERT INTO cume_dist_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,CUME_DIST() OVER(PARTITION BY a ORDER BY b) FROM cume_dist_t1; a | b | cume_dist ---+---+----------- 1 | 1 | .5 1 | 1 | .5 1 | 2 | .75 1 | 3 | 1 2 | 4 | .5 2 | 5 | 1 3 | 6 | 1 (7 rows) openGauss=# DROP TABLE cume_dist_t1; NTILE(num_buckets integer) 描述：NTILE函数根据num_buckets integer将有序的数据集合平均分配到num_buckets所指定数量的桶中，并将桶号分配给每一行。分配时应尽量做到平均分配。 返回值类型：INTEGER 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE ntile_t1(a int, b int); openGauss=# INSERT INTO ntile_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,NTILE(2) OVER(PARTITION BY a ORDER BY b) FROM ntile_t1; a | b | ntile ---+---+------- 1 | 1 | 1 1 | 1 | 1 1 | 2 | 2 1 | 3 | 2 2 | 4 | 1 2 | 5 | 2 3 | 6 | 1 (7 rows) openGauss=# DROP TABLE ntile_t1; LAG(value any [, offset integer [, default any ]]) 描述：LAG函数为各组内对应值生成滞后值。即当前值对应的行数往前偏移offset位后所得行的value值作为序号。若经过偏移后行数不存在，则对应结果取为default值。若无指定，在默认情况下，offset取为1，default值取为NULL。default值的类型需要与value值的类型保持一致。 返回值类型：与参数数据类型相同 示例： -- 建表并插入数据 openGauss=# CREATE TABLE ta1 (hire_date date, last_name varchar(20), department_id int); CREATE TABLE openGauss=# INSERT INTO ta1 values('07-DEC-02', 'Raphaely', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('24-JUL-05', 'Tobias', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('24-DEC-05', 'Baida', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('18-MAY-03', 'Khoo', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('15-NOV-06', 'Himuro', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-AUG-07', 'Colmenares', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-MAY-07', 'yq', 11); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-MAY-08', 'zi', 11); INSERT 0 1 openGauss=# INSERT INTO ta1 values('', 'yq1', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values(null, 'yq2', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-DEC-07', 'yq3', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values(null, null, 11); INSERT 0 1 openGauss=# INSERT INTO ta1 values(null, null, 11); INSERT 0 1 -- 调用LAG,指定offset=3, default=null openGauss=# SELECT hire_date, last_name, department_id, lag(hire_date, 3, null) OVER (PARTITION BY department_id ORDER BY last_name) AS "NextHired" FROM ta1 ORDER BY department_id; hire_date | last_name | department_id | NextHired ---------------------+------------+---------------+--------------------- 2007-05-10 00:00:00 | yq | 11 | 2008-05-10 00:00:00 | zi | 11 | | | 11 | | | 11 | 2007-05-10 00:00:00 2005-12-24 00:00:00 | Baida | 30 | 2007-08-10 00:00:00 | Colmenares | 30 | 2006-11-15 00:00:00 | Himuro | 30 | 2003-05-18 00:00:00 | Khoo | 30 | 2005-12-24 00:00:00 2002-12-07 00:00:00 | Raphaely | 30 | 2007-08-10 00:00:00 2005-07-24 00:00:00 | Tobias | 30 | 2006-11-15 00:00:00 | yq1 | 30 | 2003-05-18 00:00:00 | yq2 | 30 | 2002-12-07 00:00:00 2007-12-10 00:00:00 | yq3 | 30 | 2005-07-24 00:00:00 (13 rows) openGauss=# DROP TABLE ta1; LEAD(value any [, offset integer [, default any ]]) 描述：LEAD函数为各组内对应值生成提前值。即当前值对应的行数向后偏移offset位后所得行的value值作为序号。若经过向后偏移后行数超过当前组内的总行数，则对应结果取为default值。若无指定，在默认情况下，offset取为1，default值取为NULL。default值的类型需要与value值的类型保持一致。 返回值类型：与参数数据类型相同。 示例： openGauss=# CREATE TABLE ta1 (hire_date date, last_name varchar(20), department_id int); CREATE TABLE openGauss=# INSERT INTO ta1 values('07-DEC-02', 'Raphaely', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('24-JUL-05', 'Tobias', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('24-DEC-05', 'Baida', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('18-MAY-03', 'Khoo', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('15-NOV-06', 'Himuro', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-AUG-07', 'Colmenares', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-MAY-07', 'yq', 11); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-MAY-08', 'zi', 11); INSERT 0 1 openGauss=# INSERT INTO ta1 values('', 'yq1', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values(null, 'yq2', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values('10-DEC-07', 'yq3', 30); INSERT 0 1 openGauss=# INSERT INTO ta1 values(null, null, 11); INSERT 0 1 openGauss=# INSERT INTO ta1 values(null, null, 11); INSERT 0 1 -- 调用LEAD,指定offset=2 openGauss=# SELECT hire_date, last_name, department_id, lead(hire_date, 2) OVER (PARTITION BY department_id ORDER BY last_name) AS "NextHired" FROM ta1 ORDER BY department_id; hire_date | last_name | department_id | NextHired ---------------------+------------+---------------+--------------------- 2007-05-10 00:00:00 | yq | 11 | 2008-05-10 00:00:00 | zi | 11 | | | 11 | | | 11 | 2005-12-24 00:00:00 | Baida | 30 | 2006-11-15 00:00:00 2007-08-10 00:00:00 | Colmenares | 30 | 2003-05-18 00:00:00 2006-11-15 00:00:00 | Himuro | 30 | 2002-12-07 00:00:00 2003-05-18 00:00:00 | Khoo | 30 | 2005-07-24 00:00:00 2002-12-07 00:00:00 | Raphaely | 30 | 2005-07-24 00:00:00 | Tobias | 30 | | yq1 | 30 | 2007-12-10 00:00:00 | yq2 | 30 | 2007-12-10 00:00:00 | yq3 | 30 | (13 rows) openGauss=# DROP TABLE ta1; FIRST_VALUE(value any) 描述：FIRST_VALUE函数取各组内的第一个值作为返回结果。 返回值类型：与参数数据类型相同。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE first_value_t1(a int, b int); openGauss=# INSERT INTO first_value_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,FIRST_VALUE(b) OVER(PARTITION BY a ORDER BY b) FROM first_value_t1; a | b | first_value ---+---+------------- 1 | 1 | 1 1 | 1 | 1 1 | 2 | 1 1 | 3 | 1 2 | 4 | 4 2 | 5 | 4 3 | 6 | 6 (7 rows) openGauss=# DROP TABLE first_value_t1; LAST_VALUE(value any) 描述：LAST_VALUE函数取各组内的最后一个值作为返回结果。 返回值类型：与参数数据类型相同。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE last_value_t1(a int, b int); openGauss=# INSERT INTO last_value_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,LAST_VALUE(b) OVER(PARTITION BY a ORDER BY b) FROM last_value_t1; a | b | last_value ---+---+------------ 1 | 1 | 1 1 | 1 | 1 1 | 2 | 2 1 | 3 | 3 2 | 4 | 4 2 | 5 | 5 3 | 6 | 6 (7 rows) openGauss=# DROP TABLE last_value_t1; NTH_VALUE(value any, nth integer) 描述：NTH_VALUE函数返回该组内的第nth行作为结果。若该行不存在，则默认返回NULL。 返回值类型：与参数数据类型相同。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 openGauss=# CREATE TABLE nth_value_t1(a int, b int); openGauss=# INSERT INTO nth_value_t1 VALUES(1,1),(1,1),(1, 2),(1, 3),(2, 4),(2, 5),(3,6); openGauss=# SELECT a,b,NTH_VALUE(b, 2) OVER(PARTITION BY a order by b) FROM nth_value_t1; a | b | nth_value ---+---+----------- 1 | 1 | 1 1 | 1 | 1 1 | 2 | 1 1 | 3 | 1 2 | 4 | 2 | 5 | 5 3 | 6 | (7 rows) openGauss=# DROP TABLE nth_value_t1; delta 描述：返回当前行和前一行的差值。 参数：numeric 返回值类型：numeric spread 描述：该函数用于计算某段时间内最大和最小值得差值。 参数：real 返回值类型：real

GLOBAL_RECORD_RESET_TIME GLOBAL_RECORD_RESET_TIME用于获取集群中各节点的“重置（重启，主备倒换，数据库删除）时间”的统计信息。 表1 GLOBAL_RECORD_RESET_TIME字段 名称 类型 描述 node_name text 节点名称。 reset_time timestamp with time zone 重置时间点。 父主题： Utility

动态数据脱敏函数 该函数为内部功能调用函数。 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 父主题： 函数和操作符

数据库连接控制函数 数据库连接控制函数控制与GaussDB服务器的连接。一个应用程序一次可以与多个服务器建立连接，如一个客户端连接多个数据库的场景。每个连接都是用一个从函数PQconnectdb、PQconnectdbParams或PQsetdbLogin获得的PGconn对象表示。注意，这些函数总是返回一个非空的对象指针，除非内存分配失败，会返回一个空的指针。连接建立的接口保存在PGconn对象中，可以调用PQstatus函数来检查返回值看看连接是否成功。 PQconnectdbParams PQconnectdb PQbackendPID PQsetdbLogin PQfinish PQreset PQstatus 父主题： libpq接口参考

GLOBAL_STATIO_USER_SEQUEN CES GLOBAL_STATIO_USER_SEQUENCES视图显示各节点的命名空间中所有用户关系表类型为序列的I/O状态信息。 表1 GLOBAL_STATIO_USER_SEQUENCES字段 名称 类型 描述 node_name name 节点名称。 relid oid 序列OID。 schemaname name 序列中模式名。 relname name 序列名。 blks_read bigint 从序列中读取的磁盘块数。 blks_hit bigint 序列中缓存命中数。 父主题： Cache/IO

_PG_FOREIGN_TABLE_COLUMNS 显示外部表的列信息。该视图只有sysadmin权限可以查看。 表1 _PG_FOREIGN_TABLE_COLUMNS字段 名称 类型 描述 nspname name schema名称。 relname name 表名称。 attname name 列名称。 attfdwoptions text[] 外部数据封装器的属性选项，使用“keyword=value”格式的字符串。 父主题： Information Schema

GLOBAL_WAIT_EVENTS GLOBAL_WAIT_EVENTS视图显示各节点wait event的相关统计信息。查询视图必须具有sysadmin权限或者monitor admin权限。 表1 GLOBAL_WAIT_EVENTS字段 名称 类型 描述 nodename text 节点名称。 type text event类型。 event text event名称。 wait bigint 等待次数。 failed_wait bigint 失败的等待次数。 total_wait_time bigint 总等待时间（单位：微秒）。 avg_wait_time bigint 平均等待时间（单位：微秒）。 max_wait_time bigint 最大等待时间（单位：微秒）。 min_wait_time bigint 最小等待时间（单位：微秒）。 last_updated timestamp with time zone 最后一次更新该事件的时间。 父主题： Wait Events

语法格式 开启匿名块 1 2 3 4 5 [DECLARE [declare_statements]] BEGIN execution_statements END; / 开启事务 1 2 3 4 5 6 7 BEGIN [ WORK | TRANSACTION ] [ { ISOLATION LEVEL { READ COMMITTED | READ UNCOMMITTED | SERIALIZABLE | REPEATABLE READ } | { READ WRITE | READ ONLY } } [, ...] ];

GLOBAL_STATIO_SYS_TABLES GLOBAL_STATIO_SYS_TABLES视图显示各节点的命名空间中所有系统表的I/O状态信息。 表1 GLOBAL_STATIO_SYS_TABLES字段 名称 类型 描述 node_name name 节点名称。 relid oid 表OID。 schemaname name 该表模式名。 relname name 表名。 heap_blks_read bigint 从该表中读取的磁盘块数。 heap_blks_hit bigint 该表缓存命中数。 idx_blks_read bigint 从表中所有索引读取的磁盘块数。 idx_blks_hit bigint 表中所有索引命中缓存数。 toast_blks_read bigint 该表的TOAST表读取的磁盘块数（如果存在）。 toast_blks_hit bigint 该表的TOAST表命中缓冲区数（如果存在）。 tidx_blks_read bigint 该表的TOAST表索引读取的磁盘块数（如果存在）。 tidx_blks_hit bigint 该表的TOAST表索引命中缓冲区数（如果存在）。 父主题： Cache/IO

PGXC_COMM_DELAY PGXC_COMM_DELAY视图展示所有DN的通信库时延状态，仅system admin和monitor admin可以查看。 表1 PGXC_COMM_DELAY字段 名称 类型 描述 node_name text 节点名称。 remote_name text 连接对端节点的对端节点名称。 remote_host text 连接对端IP的对端地址。 stream_num integer 当前物理连接使用的stream逻辑连接数量。 min_delay integer 当前物理连接一分钟内探测到的最小时延，单位微秒。 说明： 负数结果无效，请重新等待时延状态更新后再执行查询。 average integer 当前物理连接一分钟内探测时延的平均值，单位微秒。 max_delay integer 当前物理连接一分钟内探测到的最大时延，单位微秒。 父主题： 系统视图

COMM_CLIENT_INFO COMM_CLIENT_INFO视图显示单个节点活跃的客户端连接信息（DN上查询该视图显示 CN连接DN的信息），默认只有系统管理员权限才可以访问此系统视图。 表1 COMM_CLIENT_INFO 字段 名称 类型 描述 node_name text 当前DN节点的名称，如dn_6001_6002_6003。 app text DN上查询该视图，app显示为连接当前DN的客户端，如coordinator(CN)、GTM、DN等。 tid bigint 当前线程的线程号。 lwtid integer 当前线程的轻量级线程号。 query_id bigint 查询ID，对应debug_query_id。 socket integer 如果是物理连接，显示socket fd。 remote_ip text 对端节点IP。 remote_port text 对端节点port。 logic_id integer 如果是逻辑连接，显示sid。 父主题： 系统视图

废弃函数 enable_adio_debug enable_adio_function enable_fast_allocate prefetch_quantity backwrite_quantity cstore_prefetch_quantity cstore_backwrite_quantity cstore_backwrite_max_threshold fast_extend_file_size effective_io_concurrency

PG_TABLESPACE PG_TABLESPACE系统表存储表空间信息。 表1 PG_TABLESPACE字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 spcname name 表空间名称。 spcowner oid 表空间的所有者，通常是创建它的人。 spcacl aclitem[] 访问权限。具体请参见GRANT和REVOKE。 spcoptions text[] 表空间的选项。 spcmaxsize text 可使用的最大磁盘空间大小，单位Byte。 relative boolean 标识表空间指定的存储路径是否为相对路径。 t（true）：表示是。 f（false）：表示不是。 父主题： 系统表

返回值 SQL_SUCCESS：表示调用正确。 SQL_SUCCESS_WITH_INFO：表示会有一些警告信息。 SQL_NEED_DATA：表示在执行SQL语句前没有提供足够的参数。 SQL_ERROR：表示比较严重的错误，如：内存分配失败、建立连接失败等。 SQL_NO_DATA：表示SQL语句不返回结果集。 SQL_INVALID_HANDLE：表示调用无效句柄。其他API的返回值同理。 SQL_STILL_EXECUTING：表示语句正在执行。

MY_TRIGGERS MY_TRIGGERS视图显示当前用户拥有的触发器的信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_TRIGGERS字段 名称 类型 描述 trigger_name character varying(64) 触发器名称。 table_name character varying(64) 关系表名称。 table_owner character varying(64) 角色名称。 status character varying(64) 触发器的状态。 O：触发器在“origin”和“local”模式下触发。 D：触发器被禁用。 R：触发器在“replica”模式下触发。 A：触发器始终触发。 父主题： 系统视图

参数说明 cursor_name 将要创建的游标名。 取值范围：遵循数据库对象命名规范。 BINARY 指明游标以二进制而不是文本格式返回数据。 NO SCROLL 声明游标检索数据行的方式。 NO SCROLL：声明该游标不能用于以倒序的方式检索数据行。 未声明：根据执行计划的不同，自动判断该游标是否可以用于以倒序的方式检索数据行。 WITH HOLD WITHOUT HOLD 声明当创建游标的事务结束后，游标是否能继续使用。 WITH HOLD：声明该游标在创建它的事务结束后仍可继续使用。 WITHOUT HOLD：声明该游标在创建它的事务之外不能再继续使用，此游标将在事务结束时被自动关闭。 如果不指定WITH HOLD或WITHOUT HOLD，默认行为是WITHOUT HOLD。 query 使用SELECT或VALUES子句指定游标返回的行。 取值范围：SELECT或VALUES子句。 declare_statements 声明变量，包括变量名和变量类型，如“sales_cnt int”。 execution_statements 匿名块中要执行的语句。 取值范围：已存在的函数名称。

功能描述 DECLARE命令既可以定义一个游标，用于在一个大的查询里面检索少数几行数据，也可以作为一个匿名块的开始。 本节主要描述定义为游标的用法，定义为匿名块的用法见BEGIN。 为了处理SQL语句，存储过程进程分配一段内存区域来保存上下文联系。游标是指向上下文区域的句柄或指针。借助游标，存储过程可以控制上下文区域的变化。 通常游标和SELECT一样返回文本格式。因为数据在系统内部是用二进制格式存储的，系统必须对数据做一定转换以生成文本格式。一旦数据是以文本形式返回，客户端应用需要把它们转换成二进制进行操作。使用FETCH语句，游标可以返回文本或二进制格式。