实现内部功能的函数_其他系统函数_函数和操作符_SQL参考_开发指南（分布式_V2.0-8.x）

spread_collect()

描述：该函数用于计算某段时间内最大和最小值得差值，用于聚合函数的数据收集过程。

参数：s real[]、v real[]

返回值类型：real[]

spread_final()

描述：该函数用于计算某段时间内最大和最小值得差值，用于聚合函数的数据最终处理过程。

参数：s real[]

返回值类型：real

spread_internal()

描述：该函数用于计算某段时间内最大和最小值得差值，用于聚合函数的数据中间过程。

参数：s real[]、v real

返回值类型：real[]

xidin4()

描述：输入4字节的xid。

参数：cstring

返回值类型：xid32

set_hashbucket_info()

描述：设置哈希桶信息。

参数：text

返回值类型：boolean

gap_fill_internal()

描述：返回参数列表中第一个非NULL的参数值。

参数：s anyelement、v anyelement

返回值类型：anyelement

int1send()

描述：将无符号一字节整数打包放入内部数据缓冲流。

参数：tinyint

返回值类型：bytea

is_contain_namespace()

描述：查找表名和namespace分割的位置，如果不存在namespace，返回0。

参数：relationname name

返回值类型：integer

is_oid_in_group_members()

描述：不支持

参数：node_oid oid、group_members oidvector_extend

返回值类型：boolean

isubmit_on_nodes_internal()

描述：不支持

参数：job bigint、node_name name、database name、what text、next_date timestamp without time zone、job_interval text

返回值类型：integer

listagg()

描述：list类型agg聚集函数。

参数：smallint、text

返回值类型：text

log_fdw_validator()

描述：验证函数。

参数：text[]、oid

返回值类型：void

nvarchar2typmodin()

描述：获取varchar的typmod信息。

参数：cstring[]

返回值类型：integer

nvarchar2typmodout()

描述：获取varchar的typmod信息，并构造字符串返回。

参数：integer

返回值类型：cstring

pg_nodes_memmon()

描述：不支持。

参数：nan

返回值类型：innernname text、innerusedmem bigint、innertopctxt bigint、nname text、usedmem text、sharedbuffercache text、topcontext text

read_disable_conn_file()

描述：读取禁止的连接文件。

参数：nan

返回值类型：disconn_mode text、disconn_host text、disconn_port text、local_host text、local_port text、redo_finished text

regex_like_m()

描述：正则匹配，判断字符串是否符合给定的正则表达式。

参数：text、text

返回值类型：boolean

update_pgjob()

描述：更新job。

参数：bigint、"char"、bigint、timestamp without time zone、timestamp without time zone、timestamp without time zone、timestamp without time zone、timestamp without time zone、smallint、text

返回值类型：void

enum_cmp()

描述：枚举类比较函数，用于判断两个枚举类是否相等，以及相对大小。

参数：anyenum、anyenum

返回值类型：integer

enum_eq()

描述：枚举类比较函数，用于实现=符号。

参数：anyenum、anyenum

返回值类型：boolean

enum_first()

描述：返回枚举类中的第一个元素。

参数：anyenum

返回值类型：anyenum

enum_ge()

描述：枚举类比较函数，用于实现>=符号。

参数：anyenum、anyenum

返回值类型：boolean

enum_gt()

描述：枚举类比较函数，用于实现>符号。

参数：anyenum、anyenum

返回值类型：boolean

enum_in()

描述：枚举类比较函数，用于判断元素是否在枚举类中。

参数：cstring、oid

返回值类型：anyenum

enum_larger()

描述：枚举类比较函数，用于实现>符号。

参数：anyenum、anyenum

返回值类型：anyenum

enum_last()

描述：返回枚举类中的最后一个元素。

参数：anyenum

返回值类型：anyenum

enum_le()

描述：枚举类比较函数，用于实现<=符号。

参数：anyenum、anyenum

返回值类型：boolean

enum_lt()

描述：枚举类比较函数，用于实现<符号。

参数：anyenum、anyenum

返回值类型：boolean

enum_smaller()

描述：枚举类比较函数，用于实现<符号。

参数：anyenum、anyenum

返回值类型：boolean

node_oid_name()

描述：不支持

参数：oid

返回值类型：cstring

pg_buffercache_pages()

描述：从共享buffer缓存里读取数据。

参数：nan

返回值类型：bufferid integer、relfilenode oid、bucketid smallint、storage_type oid、reltablespace oid、reldatabase oid、relforknumber smallint、 relblocknumber bigint、isdirty boolean、usage_count smallint

pg_check_xidlimit()

描述：判断nextxid是否>= xidwarnlimit。

参数：nan

返回值类型：boolean

pg_comm_delay()

描述：展示单个DN的通信库时延状态。

参数：nan

返回值类型：text、text、integer、integer、integer、integer

pg_comm_recv_stream()

描述：展示单个DN上所有的通信库接收流状态。

参数：nan

返回值类型：text、bigint、text、bigint、integer、integer、integer、text、bigint、integer、integer、integer、bigint、bigint、bigint、bigint、bigint

pg_comm_send_stream()

描述：展示单个DN上所有的通信库发送流状态。

参数：nan

返回值类型：text、bigint、text、bigint、integer、integer、integer、text、bigint、integer、integer、integer、bigint、bigint、bigint、bigint、bigint

pg_comm_status()

描述：展示单个DN的通信状态。

参数：nan

返回值类型：text、integer、integer、bigint、bigint、bigint、bigint、bigint、integer、integer、integer、integer、integer

pg_log_comm_status()

描述：在dn上打印一些log。

参数：nan

返回值类型：boolean

pg_parse_clog()

描述：解析clog获取普通表的xid的status。

参数：nan

返回值类型：xid xid、status text

pg_parse_clog(bucketid)

描述：解析clog获取指定bucketid的xid的status。

参数：bucketid，hashbucket表的物理bucketid，普通表是-1。

返回值类型：xid xid、status text

pg_pool_ping()

描述：设置PoolerPing。

参数：boolean

返回值类型：SETOF boolean

pg_pool_validate()

描述：通过比较pgxc_node系统表中的字段，验证连接是否可用。

参数：clear boolean、co_node_name cstring

返回值类型：pid bigint、node_name text

pg_resume_bkp_flag()

描述：用于备份恢复获取delay Xlog标志。

参数：slot_name name

返回值类型：start_backup_flag boolean、to_delay boolean、ddl_delay_recycle_ptr text、rewind_time text

gs_static_threadpool_ctrl_status()

描述：查询线程池中静态池线程相关统计信息。CN线程池开启下分布式CN支持查询相关静态池信息，DN返回空行；线程池关闭下返回空行；参数static_thread_pool_num设置为0或小于线程池group数时静态线程池默认值为0。

参数：nan

返回值：text node_name、int group_id、text worker_info，返回字段如表1 GS_STATIC_THREADPOOL_CTRL_STATUS字段所示。

表1 GS_STATIC_THREADPOOL_CTRL_STATUS字段
名称	类型	描述
node_name	OUT text	实例名。
group_id	OUT int	线程池group组id。
worker_info	OUT text	描述当前group组线程池运行中的动态的统计信息。包括如下信息： default、default_s：线程数量。动态线程池默认值，静态线程池默认值。 expect、expect_s：线程数量。动态线程池预期值，静态线程池预期值。 actual：实际运行的线程数量，包括动态池线程和静态池线程。 static threads limit：当前group组配置的静态池线程数。 has static threads：当前group组是否创建静态池。默认为0，表示没有创建。 idle static threads：空闲的静态池线程个数。 wait session num：等待的会话数。

pg_stat_get_pooler_status()

描述：查询pooler中的缓存连接状态。

参数：nan

返回值类型：如表2 pg_stat_get_pooler_status返回值字段所示。

表2 pg_stat_get_pooler_status返回值字段
名称	类型	描述
database_name	OUT text	数据库名称。
user_name	OUT text	用户名。
tid	OUT bigint	非线程池逻辑下为连接CN的线程id，线程池逻辑下为连接CN的sessionid。
pgoptions	OUT text	数据库连接选项，详见连接参数说明描述的options字段。
node_oid	OUT bigint	连接的实例节点OID。
in_use	OUT boolean	连接是否正被使用。 t（true）：表示连接正在使用。 f（false）：表示连接没有使用。
session_params	OUT text	由此连接下发的GUC session参数。
fdsock	OUT bigint	本端socket。
local_host	OUT text	本端IP。
local_port	OUT bigint	本端端口号。
remote_host	OUT text	对端IP。
remote_port	OUT bigint	对端端口号。
remote_pid	OUT bigint	对端处于非线程池逻辑下为对端的线程id，对端处于线程池逻辑下为对端的sessionid。
used_count	OUT bigint	该连接的复用次数。
idx	OUT bigint	通信对端DN在本CN内的标识编号。
streamid	OUT bigint	通信流在物理连接中的标识编号。

get_node_modulo()

描述：计算节点在group中的下标。

参数：如表3 get_node_modulo入参列表所示。

表3 get_node_modulo入参列表
参数	类型	描述	取值范围
node_oid	IN oid	节点OID。	[0, 2^32-1]
group_oid	IN oid	nodegroup的OID。	[0, 2^32-1]

返回值类型：uint4

check_murmurhash_route_node()

描述：计算key分布的节点是否正确。

参数：如表4 check_murmurhash_route_node入参列表所示。

表4 check_murmurhash_route_node入参列表
参数	类型	描述	取值范围
key	IN text	表示hash键的字符串。	-
node_modulo	IN uint4	节点在nodegroup中的下标。	[0, 2^32-1]
node_num	IN uint4	nodegroup的节点数量。	[0, 2^32-1]

返回值类型：uint4

gs_libcomm_fd_info()

描述：查询libcomm通信库socket长连接信息。

参数：nan

返回值：如表5 gs_libcomm_fd_info返回值字段所示。

表5 gs_libcomm_fd_info返回值字段
名称	类型	描述
node_name	OUT text	DN实例名。
ip	OUT text	DN的IP。
ctrl_port	OUT bigint	控制通道端口。
data_port	OUT bigint	数据通道端口。
remote_name	OUT text	对端DN实例名。
remote_ip	OUT text	对端IP。
remote_port	OUT bigint	对端端口号。
local_ip	OUT text	本地IP。
local_port	OUT bigint	本地端口号。
fd	OUT bigint	socket连接。
type	OUT text	TCP连接通道类型，包括： DATA_SEND_FD：数据通道发送端的socket。 DATA_RECV_FD：数据通道接收端的socket。 CTL_SEND_FD：控制通道发送端的socket。 CTL_RECV_FD：控制通道接收端的socket。

该函数只能在DN上使用。若函数返回空，表示当前DN实例未建立libcomm长连接。

gs_libcomm_memory_info()

描述：查询当前libcomm通信库内部内存使用的基础配置信息。

参数：nan

返回值：如表6 gs_libcomm_memory_info返回值字段所示。

表6 gs_libcomm_memory_info返回值字段
名称	类型	描述
node_name	OUT text	DN实例名。
current_used_memory	OUT bigint	libcomm通信库使用内存，单位为字节（byte）。
current_data_item_num	OUT bigint	libcomm无锁队列数据块个数。
init_mailbox_memory	OUT bigint	libcomm初始化mailbox使用的内存，单位为字节（byte）。
max_datanode	OUT bigint	libcomm通信库支持的最大DN个数。
max_stream	OUT bigint	libcomm单个TCP连接支持的最大数据流个数。
max_quota_size	OUT bigint	libcomm逻辑连接的buffer总大小，单位为字节（byte）。
max_usable_memory	OUT bigint	libcomm通信库缓存最大可使用内存，单位为字节（byte）。
max_memory_pool	OUT bigint	libcomm通信库在每个DN上可以使用的内存资源池总大小，单位为字节（byte）。

gs_validate_ext_listen_ip()

描述：连接DN实例执行，查询连接原扩展IP的无效的DN实例上的业务线程并支持清理。

参数：如表7 GS_VALIDATE_EXT_LISTEN_IP字段所示。

返回值：bigint pid、text node_name

注意：该函数仅用于当扩展IP被reload之后，原扩展IP上仍然存在旧的连接，该函数支持原IP连接所在线程被清理。执行该函数会导致扩展IP通信侦听被清理，运维操作请谨慎使用。当前仅支持连接DN执行，并由管理员下发。

表7 GS_VALIDATE_EXT_LISTEN_IP字段
名称	类型	描述
clear	IN cstring	是否清理，on清理，off不清理。
validate_node_name	IN cstring	指定所要清理扩展IP连接所在DN实例名。
validate_ip	IN cstring	指定所要清理具体的扩展IP。
pid	OUT bigint	被清理的扩展IP连接所在业务线程ID。
node_name	OUT text	被清理的扩展IP连接所在实例名。

gs_comm_listen_address_ext_info()

描述：显示当前实例连接listen_address_ext配置扩展IP的DFX信息。

参数：nan

返回值类型：text node_name、text app、bigint tid、integer lwtid、bigint query_id、integer socket、text remote_ip、text remote_port、text local_ip、text local_port。返回字段如表8 GS_COMM_LISTEN_ADDRESS_EXT_INFO字段所示。

表8 GS_COMM_LISTEN_ADDRESS_EXT_INFO字段
名称	类型	描述
node_name	OUT text	描述当前实例名。
app	OUT text	描述当前连接DN的客户端。
tid	OUT bigint	描述当前线程的线程号。
lwtid	OUT integer	描述当前线程的轻量级线程号。
query_id	OUT bigint	描述当前线程的查询ID。
socket	OUT integer	描述当前物理连接的socket fd。
remote_ip	OUT text	描述当前连接对端IP。
remote_port	OUT text	描述当前连接对端port。
local_ip	OUT text	描述当前连接本端IP。
local_port	OUT text	描述当前连接本端port。

gs_get_global_listen_address_ext_info

描述：CN上提供查询全局扩展IP配置信息。

参数：如表9 GS_GET_GLOBAL_LISTEN_ADDRESS_EXT_INFO字段所示。

返回值类型：text node_name、text host、text port、text ext_listen_ip

注意：若函数入参为“all”，则函数依赖ext_ip_info静态配置文件，若文件异常需要依赖CM/OM工具修复，此时无法实时更新配置。用户可以通过入参为“primary”获取所有主DN相关配置信息。

表9 GS_GET_GLOBAL_LISTEN_ADDRESS_EXT_INFO字段
名称	类型	描述
dn_mode	IN cstring	指定显示的DN范围，null默认查询所有。
node_name	OUT text	DN实例名。
host	OUT text	DN实例侦听IP。
port	OUT text	DN实例侦听port。
ext_listen_ip	OUT text	DN实例侦听扩展IP。

gs_get_listen_address_ext_info()

描述：提供查询当前实例扩展IP配置信息。

参数：nan

返回值类型：text node_name、text host、bigint port、text ext_listen_ip。返回字段如表10 GS_GET_LISTEN_ADDRESS_EXT_INFO所示。

**表10** GS_GET_LISTEN_ADDRESS_EXT_INFO
名称	类型	描述
node_name	OUT text	DN实例名。
host	OUT text	DN实例侦听IP。
port	OUT bigint	DN实例侦听port。
ext_listen_ip	OUT text	DN实例侦听扩展IP。

psortoptions()

描述：返回psort属性。

参数：text[]、boolean

返回值类型：bytea

remove_job_class_depend()

描述：移除job依赖。

参数：oid

返回值类型：void

xideq4()

描述：对比两个xid是否相等。

参数：xid32、xid32

返回值类型：boolean

xideqint8()

描述：对比两个xid是否相等。

参数：xid、bigint

返回值类型：boolean

xidlt()

描述：返回xid1 < xid2是否成立。

参数：xid、xid

返回值类型：boolean

xidlt4()

描述：返回xid1 < xid2是否成立。

参数：xid32、xid32

返回值类型：boolean

get_local_cont_query_stat()

描述：获取本机节点的指定持续计算视图统计信息。

参数：cq_id oid

返回值类型：cq oid、w_in_rows int8、w_in_bytes int8、w_out_rows int8、w_out_bytes int8、w_pendings int8、w_errors int8、r_in_rows int8、r_in_bytes int8、r_out_rows int8、r_out_bytes int8、r_errors int8、c_in_rows int8、c_in_bytes int8、c_out_rows int8、c_out_bytes int8、c_pendings int8、c_errors int8

get_local_cont_query_stats()

描述：获取本机节点的所有持续计算视图统计信息。

参数：nan

返回值类型：cq oid、w_in_rows int8、w_in_bytes int8、w_out_rows int8、w_out_bytes int8、w_pendings int8、w_errors int8、r_in_rows int8、r_in_bytes int8、r_out_rows int8、r_out_bytes int8、r_errors int8、c_in_rows int8、c_in_bytes int8、c_out_rows int8、c_out_bytes int8、c_pendings int8、c_errors int8

get_cont_query_stats()

描述：获取各个DN节点的所有持续计算视图统计信息。

参数：nan

返回值类型：node name、cq oid、w_in_rows int8、w_in_bytes int8、w_out_rows int8、w_out_bytes int8、w_pendings int8、w_errors int8、r_in_rows int8、r_in_bytes int8、r_out_rows int8、r_out_bytes int8、r_errors int8、c_in_rows int8、c_in_bytes int8、c_out_rows int8、c_out_bytes int8、c_pendings int8、c_errors int8

reset_local_cont_query_stat()

描述：复位本机节点的指定持续计算视图统计信息。

参数：cq_id oid

返回值类型：boolean

reset_local_cont_query_stats()

描述：复位本机节点的指定持续计算视图的关联统计信息。

参数：cq_id oid

返回值类型：boolean

reset_cont_query_stats()

描述：复位各个DN节点的STREAM对象对应的持续计算视图统计信息。

参数：stream_id oid

返回值类型：boolean

check_cont_query_schema_changed()

描述：判断指定持续计算视图的schema change状态。

参数：cq_id oid

返回值类型：boolean

gs_get_standby_cluster_barrier_status()

描述：查看备cn/dn的barrier日志回放情况，包括已接收到的最新barrier点、已接收到的最新barrier点的LSN，上一次回放的barrier点，回放的目标barrier点。

参数：nan

返回值类型：barrier_id text、barrier_lsn text、recovery_id text、target_id text

备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。

gs_set_standby_cluster_target_barrier_id()

描述：设置回放的目标barrier点。

参数：barrier_id字符串

返回值类型：target_id text

备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。

gs_query_standby_cluster_barrier_id_exist()

描述：查询指定barrier点备机是否接收到。

参数：barrier_id字符串

返回值类型：boolean

备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。

standby_read_status()

描述：用于“GTM_FREE 分布式备机读”功能，获取集群内部所有DN的csn快照信息和主备差异时长，以及最后一次备机读查询所用的csn快照信息。

参数：nan

返回值类型：text、text、text、integer、bigint、bigint、bigint。返回字段如表11 standby_read_status字段所示。

**表11** standby_read_status字段
名称	类型	描述
name	text	DN节点名称。
type	text	DN节点类型。（主机为primary，备机为standby）
host	text	DN节点所使用的IP。
port	integer	DN节点所使用的PORT。
collected_csn	bigint	该DN的csn快照信息。（主机为0，备机为当前收集到的csn）
delay	bigint	主备DN之间的差异，单位为毫秒。
visited_csn	bigint	最后一次备机读查询使用的csn信息（仅最后一次查询执行的备机有值其余为0）

gs_shutdown_cross_region_walsenders()

描述：中断跨集群流式复制。

参数：nan

返回值类型：void

备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。

以下流函数虽存在但功能尚未支持，不建议使用：

streaming_int8_avg_gather、streaming_numeric_avg_gather、streaming_float8_avg_gather、streaming_interval_avg_gather、streaming_int8_sum_gather、streaming_int2_int4_sum_gather。

is_dblink_in_transaction()

描述：判断当前事务中是否使用了oid对应的DATABASE LINK。

参数：oid

返回值类型：boolean

dblink_has_updatasent()

描述：判断当前事务中是否使用oid对应的DATABASE LINK发送了dml语句且未提交。

参数：oid

返回值类型：boolean

get_last_xmin_by_oid()

描述：通过表的oid获取该表所有字段中最大的xmin值。

参数：oid

返回值类型：xid

get_relid_by_relname()

描述：通过表的表名及relnamespace获取表的oid。

参数：cstring、oid

返回值类型：oid