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

pv_compute_pool_workload()

描述：提供云上加速数据库实例当前负载信息。（由于规格变更，当前版本已经不再支持本特性，请不要使用）

返回值类型：record

locktag_decode(locktag text)

描述：从locktag中解析锁的具体信息。

返回值类型：text

smgreq(a smgr, b smgr)

描述：比较两个smgr是否一样。

参数：smgr、smgr

返回值类型：boolean

smgrne(a smgr, b smgr)

描述：判断两个smgr是否不一样。

参数：smgr、smgr

返回值类型：boolean

xidin4

描述：输入4字节的xid。

参数：cstring

返回值类型：xid32

set_hashbucket_info

描述：设置哈希桶信息。

参数：text

返回值类型：boolean

int1send

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

参数：tinyint

返回值类型：bytea

listagg

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

参数：smallint、text

返回值类型：text

log_fdw_validator

描述：验证函数。

参数：text[]、oid

返回值类型：void

nvarchar2typmodin

描述：获取varchar的typmod信息。

参数：cstring[]

返回值类型：integer

nvarchar2typmodout

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

参数：integer

返回值类型：cstring

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

描述：读取共享缓冲区的状态数据。多租场景下，在PDB内部仅返回本PDB的数据，在Non-PDB返回全局的数据。

参数：nan

返回值类型：setof record，返回字段说明如表1所示。

表1 返回字段说明
名称	类型	描述
bufferid	integer	缓冲区的内部ID。
relfilenode	oid	缓冲区中页面所属关系的OID。
bucketid	integer	缓冲区所处的哈希桶号。
storage_type	bigint	缓冲区中数据的存储类型。
reltablespace	oid	缓冲区中数据所处的表空间的OID。
reldatabase	oid	缓冲区中数据所处的数据库的OID。
relforknumber	integer	缓冲区中数据所在的关系文件分支类型。
relblocknumber	integer	缓冲区中数据在其所属关系文件中的文件块号。
isdirty	boolean	缓冲区是否为脏。
isvalid	boolean	缓冲区是否有效。
usage_count	smallint	缓冲区的使用计数。
pinning_backends	integer	正在使用缓冲区的后端数。

pg_check_xidlimit

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

参数：nan

返回值类型：boolean

gs_static_threadpool_ctrl_status()

描述：查询线程池中静态池线程相关统计信息。集中式不支持查询，返回报错。

参数：nan

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

表2 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：等待的会话数。

gs_validate_ext_listen_ip

描述：清理DN实例上连接无效IP的业务。

参数：详见表3。

返回值：bigint pid、text node_name

表3 GS_VALIDATE_EXT_LISTEN_IP字段
名称	类型	描述
clear	IN cstring	是否清理DN实例上连接无效IP的业务。当前环境查询该函数时，仅支持输入normal，无返回值，表示清理DN实例上连接无效IP的业务。
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。返回字段如表4所示。

注意：当前不支持查询该函数。

表4 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_libcomm_fd_info()

描述：查询libcomm通信库socket长连接信息。集中式中不支持使用。

参数：nan

返回值：如表5所示。

表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所示。

表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_get_global_listen_address_ext_info

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

参数：详见表7。

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

注意：当前不支持查询该函数。

表7 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()

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

参数：nan

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

注意：当前不支持查询该函数。

表8 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。

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)

描述：当前版本集中式不支持hashbucket 表，该接口函数调用报错。

pg_pool_ping

描述：设置PoolerPing。

参数：boolean

返回值类型：SETOF boolean

pg_resume_bkp_flag

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

参数：slot_name name

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

pgfadvise_DONTNEED

描述: 这个函数为当前关系设置DONTNEED标记。这意味着如果需要释放一些内存，操作系统会首先卸载该文件的页。主要思想是卸载不再使用的文件（而不是可能会被使用的页面）。

示例：

cedric=# SELECT * FROM pgfadvise_dontneed('pgbench_accounts');
      relpath       | os_page_size | rel_os_pages | os_pages_free
--------------------+--------------+--------------+---------------
 base/11874/16447   |         4096 |       262144 |        342071
 base/11874/16447.1 |         4096 |        65726 |        408103

pgfadvise_WILLNEED

描述：这个函数为当前关系设置WILLNEED标记。这意味着操作系统将尝试加载该关系尽可能多的页面。主要思想是在服务器启动时预加载文件，预加载文件时可能使用缓存命中率/失误率以及最可能被使用的关系/索引等信息。

示例：

cedric=# SELECT * FROM pgfadvise_willneed('pgbench_accounts');
relpath       | os_page_size | rel_os_pages | os_pages_free 
--------------------+--------------+--------------+---------------
base/11874/16447   |         4096 |       262144 |         80650
base/11874/16447.1 |         4096 |        65726 |         80650

pgfadvise_NORMAL

描述：这个函数为当前关系设置NORMAL标记。

pgfadvise_SEQUENTIAL

描述：这个函数为当前关系设置SEQUENTIAL标记。

pgfadvise_RANDOM

描述：这个函数为当前关系设置RANDOM标记。

pgfadvise_loader

描述：这个函数允许直接与页面缓存交互。它可以用于根据表示要加载/卸载的页面映射的varbit从内存加载和/或卸载页面。

示例：该示例使用的关系名称为pgbench_accounts，段号为0以及任意的varbit映射。

--加载与卸载。
cedric=# SELECT * FROM pgfadvise_loader('pgbench_accounts', 0, true, true, B'111000');
relpath      | os_page_size | os_pages_free | pages_loaded | pages_unloaded 
------------------+--------------+---------------+--------------+----------------
     base/11874/16447 |         4096 |        408376 |            3 |              3

--加载。
cedric=# SELECT * FROM pgfadvise_loader('pgbench_accounts', 0, true, false, B'111000');
relpath      | os_page_size | os_pages_free | pages_loaded | pages_unloaded 
------------------+--------------+---------------+--------------+----------------
 base/11874/16447 |         4096 |        408370 |            3 |              0

--卸载。
cedric=# SELECT * FROM pgfadvise_loader('pgbench_accounts', 0, false, true, B'111000');
relpath      | os_page_size | os_pages_free | pages_loaded | pages_unloaded 
------------------+--------------+---------------+--------------+----------------
base/11874/16447 |         4096 |        408370 |            0 |              3

pgfincore

描述：这个函数提供关于文件系统缓存(页面缓存)的信息。

示例:

cedric=# SELECT * FROM pgfincore('pgbench_accounts');
 relpath       | segment | os_page_size | rel_os_pages | pages_mem | group_mem | os_pages_free | databit | pages_dirty | group_dirty  
--------------------+---------+--------------+--------------+-----------+-----------+---------------+---------+-------------+-------------
base/11874/16447   |       0 |         4096 |       262144 |         3 |         1 |        408444 |         |           0 |           0
base/11874/16447.1 |       1 |         4096 |        65726 |         0 |         0 |        408444 |         |           0 |           0

对于一个指定的关系，该函数返回包括以下字段：

relpath : 该关系的路径。
segment : 被分析的段号。
os_page_size : 一个页面的大小。
rel_os_pages : 该关系的总页面数。
pages_mem : 关系在页面缓存中的页面总数。 (不是来自PostgreSQL的共享缓冲区，而是操作系统缓存) 。
group_mem : 相邻pages_mem的组数。
os_page_free : 操作系统页面缓存中空闲的页面数。
databit : 该文件的varbit映射，因为该字段的大小关系，若需要输出该字段，需要使用pgfincore('pgbench_accounts'，true)来激活它。
pages_dirty : 如果定义了HAVE_FINCORE常量，平台将提供相关的信息，和pages_mem类似，只不过是对于脏页面的。
group_dirty : 如果定义了HAVE_FINCORE常量，平台将提供相关的信息，和group_mem类似，只不过是对于脏页面的。

pgsysconf

描述: 这个函数输出操作系统块的大小，操作系统页面缓冲区中空闲页面的数量。

示例：

cedric=# SELECT * FROM pgsysconf();
 os_page_size | os_pages_free | os_total_pages 
--------------+---------------+----------------
         4096 |         80431 |        4094174

pgsysconf_pretty

描述：该函数的功能同上，不同之处在于该函数进行了单位转换，便于阅读。

示例：

cedric=# SELECT * FROM pgsysconf_pretty();
 os_page_size | os_pages_free | os_total_pages 
--------------+---------------+----------------
 4096 bytes   | 314 MB        | 16 GB

pgfincore_drawer

描述：一个非常简单的渲染器。这个函数需要一个varbit类型的参数。通常，这个参数的值来源于pgfincore函数的databit返回字段。databit字段的值由0和1组成，如果是0，意味着该页不在操作系统页面缓存中，如果是1，则意味着该页在操作系统页面缓存中。

示例：

 cedric=# SELECT * FROM pgfincore_drawer(B'000111');
  drawer       
 --------------
    ...     

cedric=# SELECT * FROM pgfincore_drawer(B'111000');
  drawer       
--------------
   ...

psortoptions

描述：返回psort属性。

参数：text[]、boolean

返回值类型：bytea

xideq4

描述：对比两个xid类型的值是否相等。

参数：xid32、xid32

返回值类型：boolean

xideqint8

描述：对比xid类型和int8类型的值是否相等。

参数：xid、bigint

返回值类型：boolean

xidlt

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

参数：xid、xid

返回值类型：boolean

xidlt4

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

参数：xid32、xid32

返回值类型：boolean

gs_shutdown_cross_region_walsenders

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

参数：nan

返回值类型：void

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

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

copy_summary_create

描述：由于COPY FROM容错机制所需要的summary表已变更为在初始化阶段创建的系统表，因此当前函数改为始终返回true，仅做兼容。

参数：无

返回值类型：boolean