其它函数

  • pgxc_pool_check()

    描述：检查连接池中缓存的连接数据是否与pgxc_node一致。

    返回值类型：Boolean

  • pgxc_pool_reload()

    描述：更新连接池中缓存的连接信息。

    返回值类型：Boolean

  • pgxc_lock_for_backup()

    描述：为备份操作给openGauss加锁，这些备份是为在新增节点上做恢复。

    返回值类型：Boolean

    其它函数 - 图1 说明： pgxc_lock_for_backup是在使用gs_dump或gs_dumpall工具备份集群前，用来给集群加锁的。当给集群加锁后，不允许有改变系统结构的操作。该函数不影响DML语句。

  • table_data_skewness(colrecord, type)

    描述：查看表数据所在节点。

    参数说明：

    • colrecord: 表示待查询表的列名记录，为record类型。
    • type: hash分布类型

    返回值类型：smallint

    示例：

    1. postgres=# select table_data_skewness(row(index), 'R') from test1;
    2.  table_data_skewness
    3. ---------------------
    4.                    4
    5.                    3
    6.                    1
    7.                    2
    8. (4 rows)

  • plan_seed()

    描述：获取前一次查询语句的seed值（内部使用）。

    返回值类型：int

  • pg_stat_get_env()

    描述：获取当前节点的环境变量信息，仅sysadmin和monitor admin可以访问。

    返回值类型：record

    示例：

    1. postgres=# select pg_stat_get_env();
    2.                                                                               pg_stat_get_env
    3. ---------------------------------------------------------------------------------------------------------------------------------------
    4.  (coordinator1,localhost,144773,49100,/data1/GaussDB_Kernel_TRUNK/install,/data1/GaussDB_Kernel_TRUNK/install/data/coordinator1,pg_log)
    5. (1 row)

  • DBE_PERF.global_plancache_clean()

    描述：清理所有节点上无人使用的全局计划缓存。

    返回值类型：bool

  • textlen()

    描述：提供查询text的逻辑长度的方法。

    返回值类型：int

  • threadpool_status()

    描述：显示线程池中工作线程及会话的状态信息。

    返回值类型：record

  • get_local_active_session()

    描述：提供当前节点保存在内存中的历史活跃session状态的采样记录。

    返回值类型：record

  • get_global_active_session()

    描述：提供所有节点保存在内存中的历史活跃session状态的采样记录。

    返回值类型：record

  • get_global_gs_asp()

    描述：提供所有节点保存在系统表gs_asp中的历史活跃session状态的采样记录。

    返回值类型：record

  • get_datanode_active_session()

    描述：提供从主节点查询数据库其它节点上保存在内存中的历史活跃session状态的采样记录。

    返回值类型：record

  • get_datanode_active_session_hist()

    描述：提供从主节点查询数据库其它节点上保存在系统表gs_asp中的历史活跃session状态的采样记录。

    返回值类型：record

  • pg_stat_get_thread()

    描述：提供当前节点下所有线程的状态信息。

    返回值类型：record

  • pg_stat_get_sql_count()

    描述：提供当前节点中所有用户执行的SELECT/UPDATE/INSERT/DELETE/MERGE INTO语句的计数结果。

    返回值类型：record

  • copy_error_log_create()

    描述：创建COPY FROM容错机制所需要的错误表（public.pgxc_copy_error_log）。

    返回值类型：Boolean

    其它函数 - 图2 说明： - 此函数会尝试创建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定义是一张行存表，因此openGauss上必须支持行存表的创建才能够正常运行此函数，并使用后续的COPY容错功能。需要特别注意的是，enable_hadoop_env这个GUC参数开启后会禁止在openGauss内创建行存表（openGauss默认为off）。 - 此函数自身权限为Sysadmin及以上（与错误表、COPY权限一致）。 - 若创建前public.pgxc_copy_error_log表已存在或者copy_error_log_relname_idx索引已存在，则此函数会报错回滚。

    表 1 错误表public.pgxc_copy_error_log信息

    列名称

    类型

    描述

    relname

    varchar

    表名称。以模式名.表名形式显示。

    begintime

    timestamp with time zone

    出现数据格式错误的时间。

    filename

    character varying

    出现数据格式错误的数据源文件名。

    rownum

    bigint

    在数据源文件中，出现数据格式错误的行号。

    rawrecord

    text

    在数据源文件中，出现数据格式错误的原始记录。

    detail

    text

    详细错误信息。

  • pg_stat_get_data_senders()

    描述：提供当前活跃的数据复制发送线程的详细信息。

    返回值类型：record

  • generate_wdr_report(begin_snap_id Oid, end_snap_id Oid, int report_type, int report_scope, int node_name)

    描述：基于两个snapshot生成系统诊断报告。

    返回值类型：record

    表 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的范围。

    node：openGauss中的节点。

    node_name

    在“report_scope”指定为“node”时，需要把该参数指定为对应节点的名称。

    -

  • create_wdr_snapshot(stat text, dbid Oid)

    描述：手工生成系统诊断快照。

    返回值类型：record

    表 3 create_wdr_snapshot参数说明

    参数

    描述

    stat

    表示每次snapshot时节点的名称，默认为收集所有节点的状态信息。

    dbid

    表示数据库的ID，收集指定数据库的状态信息。

  • reset_unique_sql

    描述：用来清理数据库节点内存中的Unique SQL（需要sysadmin权限）。

    返回值类型：bool

    表 4 reset_unique_sql参数说明

    参数

    类型

    描述

    scope

    text

    清理范围类型：

    • ‘GLOBAL’：清理所有的节点，如果是’GLOBAL’，则只可以为主节点执行此函数。
    • ‘LOCAL’：清理本节点。

    clean_type

    text

    • ‘BY_USERID’：按用户ID来进行清理Unique SQL。
    • ‘BY_CNID’：按主节点的ID来进行清理Unique SQL。
    • ‘ALL’：全部清理。

    clean_value

    int8

    具体清理type对应的清理值。

  • wdr_xdb_query(db_name_str text, query text)

    描述：提供本地跨数据库执行query的能力。例如: 在连接到postgres库时, 访问test库下的表。

    1. select col1 from wdr_xdb_query('dbname=test','select col1 from t1') as dd(col1 int);

    返回值类型：record

  • pg_wlm_jump_queue(pid int)

    描述：调整任务到数据库主节点队列的最前端。

    返回值类型：boolean

    • true：成功。
    • false：失败。

  • gs_wlm_switch_cgroup(pid int, cgroup text)

    描述：调整作业的优先级到新控制组。

    返回值类型：boolean

    • true：成功。
    • false：失败。

  • pv_session_memctx_detail(threadid tid, MemoryContextName text)

    描述：将线程tid的MemoryContextName内存上下文信息记录到“$GAUSSLOG/pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。其中threadid可通过表PV_SESSION_MEMORY_DETAIL中的sessid后获得。在正式发布的版本中仅接受MemoryContextName为空串（两个单引号表示输入为空串，即”）的输入，此时会记录所有的内存上下文信息，否则不会有任何操作。对供内部开发人员和测试人员调试用的DEBUG版本，可以指定需要统计的MemoryContextName，此时会将该Context所有的内存使用情况记录到指定文件。该函数需要管理员权限的用户才能执行。

    返回值类型：boolean

    • true：成功。
    • false：失败。

  • pg_shared_memctx_detail(MemoryContextName text)

    描述：将MemoryContextName内存上下文信息记录到“$GAUSSLOG/pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。该函数功能仅在DEBUG版本中供内部开发人员和测试人员调试使用，在正式发布版本中调用该函数不会有任何操作。该函数需要管理员权限的用户才能执行。

    返回值类型：boolean

    • true：成功。
    • false：失败。

  • local_bgwriter_stat()

    描述：显示本实例的bgwriter线程刷页信息，候选buffer链中页面个数，buffer淘汰信息。

    返回值类型：record

  • local_ckpt_stat()

    描述：显示本实例的检查点信息和各类日志刷页情况。

    返回值类型：record

  • local_double_write_stat()

    描述：显示本实例的双写文件的情况。

    返回值类型：record

  • local_pagewriter_stat()

    描述：显示本实例的刷页信息和检查点信息。

    返回值类型：record

  • local_redo_stat()

    描述：显示本实例的备机的当前回放状态。

    返回值类型：record

    备注：返回的回放状态主要包括当前回放位置，回放最小恢复点位置等信息。

  • local_recovery_status()

    描述：显示本实例的主机和备机的日志流控信息。

    返回值类型：record

  • local_rto_status()

    描述：显示本实例的主机和备机的日志流控信息。

    返回值类型：record

  • gs_wlm_node_recover(boolean isForce)

    描述：获取当前内存中记录的TopSQL查询语句级别相关统计信息，当传入的参数不为0时，会将这部分信息从内存中清理掉。

    返回值类型：record

  • gs_cgroup_map_ng_conf(group name)

    描述：读取指定逻辑集群的cgroup配置文件。

    返回值类型：record

  • gs_wlm_switch_cgroup(sess_id int8, cgroup name)

    描述：切换指定会话的控制组。

    返回值类型：record

  • hdfs_fdw_handler()

    描述：用于外表重写功能，定义外表时需要定义的函数。

    返回值类型：record

  • hdfs_fdw_validator(text[], oid)

    描述：用于外表重写功能，定义外表时需要定义的函数。

    返回值类型：record

  • comm_client_info()

    描述：用于查询单个节点活跃的客户端连接信息。

    返回值类型：setof record

  • pg_sync_cstore_delta(text)

    描述：同步指定列存表的delta表表结构，使其与列存表主表一致。

    返回值类型：bigint

  • pg_sync_cstore_delta()

    描述：同步所有列存表的delta表表结构，使其与列存表主表一致。

    返回值类型：bigint

  • gs_create_log_tables()

    描述：用于创建运行日志和性能日志的外表和视图。

    返回值类型：void

    示例：

    1. postgres=# select gs_create_log_tables();
    2.  gs_create_log_tables
    3. ----------------------
    5. (1 row)

  • pgxc_wlm_rebuild_user_resource_pool()

    描述：重新构建用户及资源池缓存信息。需要系统管理员权限才可以执行该函数。

    返回值类型：boolean