华为云用户手册

算子说明 在 GaussDB 中，Foreign Scan是一种用于访问外部数据源的扫描器。它可以将外部数据源中的数据作为关系型数据库中的表来处理，从而实现对外部数据源的查询和操作。在GaussDB中，Foreign Scan可以通过扩展API来实现。用户可以编写自己的扩展程序，以实现对外部数据源的访问和操作。同时，GaussDB还提供了一些常用的扩展程序，如FDW（Foreign Data Wrapper），可以用于访问其他关系型数据库中的数据。

ADM_IND_COLUMNS ADM_IND_COLUMNS视图显示数据库中索引字段的信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATA LOG 和SYS Schema下。 表1 ADM_IND_COLUMNS字段 名称 类型 描述 index_owner character varying(64) 索引的所有者。 index_name character varying(64) 索引名。 table_owner character varying(64) 表的所有者。 table_name character varying(64) 表名。 column_name name 列名。 column_position smallint 索引中列的位置。 column_length numeric 列的长度，如果列是变长类型，该字段取值为NULL。 char_length numeric 列的最大字节长度。 descend character varying(4) 列是降序（DESC）排序还是升序（ASC）排序。 collated_column_id numeric 暂不支持，值为NULL。 父主题： 其他系统视图

参数说明 参数 参数说明 ctx 表示给定的上下文。 query 被执行的SQL语句。 args 被执行SQL语句需要绑定的参数。支持按位置绑定和按名称绑定，详情见DB类型中的示例。 Query类接口Query()、QueryContext()、QueryRow()、QueryRowContext()通常用于查询语句，如SELECT语句。操作语句使用Exec()接口执行，若非查询语句通过Query类接口执行，则执行结果可能与预期不符，因此不建议使用Query类接口执行非查询语句，例如UPDATE/INSERT等。 使用Query类接口执行查询语句的结果需要通过type Rows中Next()接口获取，若不通过Next()接口获取，可能会产生不可预期的错误。

_PG_FOREIGN_SERVERS 显示外部服务器的信息，如表1所示。该视图只有sysadmin权限可以查看。 表1 _PG_FOREIGN_SERVERS字段 名称 类型 描述 oid oid 外部服务器的oid。 srvoptions text[] 外部服务器指定选项，使用“keyword=value”格式的字符串。 foreign_server_catalog information_schema.sql_identifier 外部服务器所在database名称（永远为当前数据库）。 foreign_server_name information_schema.sql_identifier 外部服务器名称。 foreign_data_wrapper_catalog information_schema.sql_identifier 外部数据封装器所在database名称（永远为当前数据库）。 foreign_data_wrapper_name information_schema.sql_identifier 外部数据封装器名称。 foreign_server_type information_schema.character_data 外部服务器的类型。 foreign_server_version information_schema.character_data 外部服务器的版本。 authorization_identifier information_schema.sql_identifier 外部服务器的所有者的角色名称。 父主题： Information Schema

列级字符集字符序 每个字符串类型（即类型为CHAR 、VARCHAR、 TEXT等字符串类型）的列都可以设置列的字符集和列的字符序。 CREATE TABLE table_name ( column_name data_type [ CHARACTER SET | CHARSET charset ] [ COLLATE collation ] ); 语法说明： table_name 表名称。 data_type 字段的数据类型，字符串类型支持字符集、字符序语法。 CHARACTER SET | CHARSET charset 指定表字段的字符集，单独指定时会将字段的字符序设置为指定的字符集的默认字符序。 COLLATE collation COLLATE子句指定列的字符序（该列的数据类型必须支持字符序）。如果没有指定，则使用默认的排序规则。 GaussDB通过以下方式选择表字段的字符集和字符序： 如果同时指定了charset和collation ，则使用字符集charset和字符序collation，且charset和collation需要对应，不对应会产生报错。 如果仅指定了charset，则使用字符集charset及其默认字符序。 如果仅指定了collation，则使用与collation关联的字符集和指定的字符序。 如果既不指定charset也不指定collation，则使用表的默认字符集和默认字符序。 default_charset仅支持指定为带有默认字符序的字符集，如果指定的字符集没有默认字符序则报错。 default_collation仅支持指定为B模式下的字符序，指定其他字符序报错。 如果表字段为文本类型且指定的字符序为binary，则文本类型会转换为对应的二进制类型，字符序为指定的binary 字符序。 分区表的分区键的字符集必须与数据库字符集相同。 暂不支持设置表字段的默认字符集与数据库字符集server_encoding不同。 示例： 1 2 3 4 5 6 7 8 -- 仅设置字符集，字符序为字符集的默认字符序。 gaussdb=# CREATE TABLE test(c1 text CHARSET utf8); -- 仅设置字符序，字符集为字符序关联的字符集。 gaussdb=# CREATE TABLE test(c1 text COLLATE utf8_bin); -- 同时设置字符集与字符序，字符集和字符序需对应。 gaussdb=# CREATE TABLE test(c1 text CHARSET utf8 COLLATE utf8_bin); 父主题： 字符集与字符序

GS_SPM_SQL_PA RAM GS_SPM_SQL_PARAM是用于查看当前用户SQL参数信息的视图，普通用户以上权限均可以访问该视图。 表1 GS_SPM_SQL_PARAM字段 名称 类型 描述 sql_namespace oid Schema的OID。 sql_hash bigint 当前Schema中SQL的唯一标识。 sql_text text SQL的文本串。 position integer 参数在SQL中的位置索引，从0开始。 datatype integer 参数类型的OID。 datatype_string text 参数类型的字符串形式。 value_string text 参数值的字符串形式。 is_null boolean 参数值是否是NULL。 hash_value bigint 参数值的哈希值 。 creation_time timestamp with time zone 本记录的创建时间。 父主题： SPM计划管理

原型 1 2 3 4 5 6 7 8 9 10 SQLRETURN SQLBindParameter(SQLHSTMT StatementHandle, SQLUSMALLINT ParameterNumber, SQLSMALLINT InputOutputType, SQLSMALLINT ValuetType, SQLSMALLINT ParameterType, SQLULEN ColumnSize, SQLSMALLINT DecimalDigits, SQLPOINTER ParameterValuePtr, SQLLEN BufferLength, SQLLEN *StrLen_or_IndPtr);

参数 表1 SQLBindParameter 关键词 参数说明 StatementHandle 语句句柄。 ParameterNumber 参数序号，起始为1，依次递增。 InputOutputType 输入输出参数类型。可以是SQL_PARAM_INPUT、SQL_PARAM_OUTPUT、SQL_PARAM_INPUT_OUTPUT。 ValueType 参数的C数据类型。可以是SQL_C_CHAR、SQL_C_LONG、SQL_C_DOUBLE等。 ParameterType 参数的SQL数据类型。可以是SQL_CHAR、SQL_INTEGER、SQL_DOUBLE等。 ColumnSize 相应参数标记的列或表达式的大小。 DecimalDigits 相应参数标记的列或表达式的十进制数字。 ParameterValuePtr 指向存储参数数据缓冲区的指针。 BufferLength ParameterValuePtr指向缓冲区的长度，以字节为单位。 StrLen_or_IndPtr 缓冲区的长度或指示器指针。若为空值，则未使用任何长度或指示器值。

PG_OBJECT PG_OBJECT系统表存储限定类型对象（普通表，索引，序列，视图，存储过程和函数）的创建用户、创建时间和最后修改时间。 表1 PG_OBJECT字段 名称 类型 描述 object_oid oid 对象标识符。 object_type "char" 对象类型： r ：表示普通表 i ：表示索引 s ：表示序列 v ：表示视图 P ：表示存储过程和函数 S ：表示包头 B ：表示包体 creator oid 对象的所有者。 ctime timestamp with time zone 对象的创建时间。 mtime timestamp with time zone 对象的最后修改时间，修改行为包括ALTER操作和GRANT、REVOKE操作。 createcsn bigint 对象创建时的 CS N。 changecsn bigint 对表或索引执行DDL操作时的CSN。 valid boolean 对象的有效性，t为有效，f为无效。 无法记录初始化数据库（initdb）过程中所创建或修改的对象，即PG_OBJECT无法查询到该对象记录。 对于升级前创建的对象，再次修改时会记录其修改时间（mtime），对表或索引执行DDL操作时会记录其所属事务的事务提交序列号（changecsn）。由于无法得知该对象创建时间，因此ctime和createcsn为空。 ctime和mtime所记录的时间为用户当次操作所属事务的起始时间。 由扩容引起的对象修改时间也会被记录。 createcsn和changecsn记录的是用户当次操作所属事务的事务提交序列号。 enable_gtt_concurrent_truncate开启时，truncate全局临时表不会刷新mtime字段。 执行对象创建语句时，存在未定义的对象，或所依赖的对象有修改或删除动作时，对象会为无效状态。 父主题： 其他系统表

示例 数据准备。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 gaussdb=# create database db1 encoding='UTF-8' LC_COLLATE='en_US.UTF-8' LC_CTYPE ='en_US.UTF-8' dbcompatibility = 'A'; CREATE DATABASE gaussdb=# \c db1 Non-SSL connection (SSL connection is recommended when requiring high-security) You are now connected to database "db1" as user "omm". db1=# CREATE TABLE test_copy(id int, name text); CREATE TABLE db1=# insert into test_copy values(1, 'aaa'); INSERT 0 1 db1=# insert into test_copy values(3, e'cc\tc'); INSERT 0 1 db1=# insert into test_copy(name) values('ddd'); INSERT 0 1 db1=# insert into test_copy values(5, e'ee\\e'); INSERT 0 1 db1=# insert into test_copy values(6, ','); INSERT 0 1 db1=# insert into test_copy values(7, '"'); INSERT 0 1 db1=# SELECT * FROM test_copy; id | name ----+----------- 1 | aaa 3 | cc c | ddd 5 | ee\e 6 | , 7 | " (6 rows) 数据导出。 1 2 3 4 db1=# set client_encoding = 'UTF-8'; SET db1=# COPY test_copy TO '/home/xy/test.bin' BINARY; COPY 6 数据导入。 db1=# truncate test_copy; TRUNCATE TABLE db1=# set client_encoding = 'UTF-8'; SET db1=# copy test_copy from '/home/xy/test.bin' BINARY; COPY 6

PG_STAT_ALL_INDEXES PG_STAT_ALL_INDEXES视图可用来查询当前数据库中的每个索引行，显示访问特定索引的统计。 索引可以通过简单的索引扫描或位图索引扫描进行使用。位图扫描中几个索引的输出可以通过AND或者OR规则进行组合，因此当使用位图扫描的时候，很难将独立堆行抓取与特定索引进行组合，因此，每一次位图扫描都会增加pg_stat_all_indexes.idx_tup_read使用索引的计数，并且增加pg_stat_all_tables.idx_tup_fetch表的计数，但不影响pg_stat_all_indexes.idx_tup_fetch。 表1 PG_STAT_ALL_INDEXES字段 名称 类型 描述 relid oid 索引所在的表的OID。 indexrelid oid 索引的OID。 schemaname name 索引的模式名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan bigint 索引上开始的索引扫描数。 idx_tup_read bigint 该索引上扫描返回的索引项数。 idx_tup_fetch bigint 使用该索引的简单索引扫描在原表中抓取的活跃行数。 父主题： 其他系统视图

SUMMARY_STATIO_ALL_TABLES SUMMARY_STATIO_ALL_TABLES视图显示数据库内各节点每张表（包括TOAST表）的I/O状态信息的汇总结果，如表1所示。 表1 SUMMARY_STATIO_ALL_TABLES字段 名称 类型 描述 schemaname name 该表模式名。 relname name 表名。 heap_blks_read numeric 从该表中读取的磁盘块数。 heap_blks_hit numeric 此表缓存命中数。 idx_blks_read numeric 从表中所有索引读取的磁盘块数。 idx_blks_hit numeric 表中所有索引命中缓存数。 toast_blks_read numeric 此表的TOAST表读取的磁盘块数（如果存在）。 toast_blks_hit numeric 此表的TOAST表命中缓冲区数（如果存在）。 tidx_blks_read numeric 此表的TOAST表索引读取的磁盘块数（如果存在）。 tidx_blks_hit numeric 此表的TOAST表索引命中缓冲区数（如果存在）。 last_updated timestamp with time zone 视图中该表监控数据最后一次更新的时间。 父主题： Cache/IO

SESSION_MEMORY_RUNTIME SESSION_MEMORY_RUNTIME视图显示和当前用户执行复杂作业正在运行时的负载管理内存使用的信息，如表1所示。 表1 SESSION_MEMORY_RUNTIME字段 名称 类型 描述 datid oid 连接后端的数据库OID。 usename name 登录到该后端的用户名。 pid bigint 后端线程ID。 start_time timestamp with time zone 语句执行的开始时间。如果是存储过程、函数、package，则查询的是第一个查询时间，不会随着存储过程内语句运行而改变。 min_peak_memory integer 语句在数据库节点上的最小内存峰值大小，单位MB。 max_peak_memory integer 语句在数据库节点上的最大内存峰值大小，单位MB。 spill_info text 语句在数据库节点上的下盘信息： None：数据库节点均未下盘。 All：数据库节点均下盘。 [a:b]：数量为b个数据库节点中有a个数据库节点下盘。 query text 正在执行的语句。 top_mem_dn text mem使用量topN信息。 父主题： Session/Thread

V$LOCK V$LOCK视图显示各打开事务所持有的锁信息。默认只有系统管理员权限才可以访问此系统视图，普通用户若要访问需要得到授权。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 V$LOCK字段 名称 类型 描述 addr raw 暂不支持，值为NULL。 kaddr raw 暂不支持，值为NULL。 sid numeric 拥有锁的sessionid。 type character varying(2) TM或TX。 TM对应pg_locks中的relation锁。 TX对应其余锁。 id1 numeric TM锁：对象号对应relationId。 TX锁：暂不支持，值为0。 id2 numeric TM锁：默认为0。 TX锁：暂不支持，值为0。 lmode numeric 见表2。 request numeric 见表2。 ctime numeric 暂不支持，值为NULL。 block numeric 是否被其余session阻塞，1表示阻塞，0表示未阻塞。 con_id numeric 暂不支持，值为NULL。 blocksid bigint 当前线程阻塞的另一个线程ID。 表2 锁模式 级别 GaussDB - NULL 0 INVALID 1 AccessShare 2 RowShare 3 RowExclusive 4 ShareUpdateExclusive 5 Share 6 ShareRowExclusive 7 Exclusive 8 AccessExclusive 父主题： 其他系统视图

接口介绍 根据输入的参数，评估指定数据对象的采样压缩率或者获取指定行数据的压缩类型。 表1 DBE_COMPRESSION 接口名称 描述 GET_COMPRESSION_RATIO 根据输入参数评估指定数据对象的采样压缩率。 GET_COMPRESSION_TYPE 根据输入参数获取指定行数据的压缩类型。 DBE_COMPRESSION.GET_COMPRESSION_RATIO 根据输入参数评估指定数据对象的采样压缩率，原型为： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 DBE_COMPRESSION.GET_COMPRESSION_RATIO( SCRATCHTBSNAME IN VARCHAR2, OWNNAME IN VARCHAR2, OBJNAME IN VARCHAR2, SUBOBJNAME IN VARCHAR2, COMPTYPE IN NUMBER, BLKCNT_CMP OUT INTEGER, BLKCNT_UNCMP OUT INTEGER, ROW_CMP OUT INTEGER, ROW_UNCMP OUT INTEGER, CMP_RATIO OUT NUMBER, COMPTYPE_STR OUT VARCHAR2, SAMPLE_RATIO IN NUMBER DEFAULT 20, OBJTYPE IN INTEGER DEFAULT 1); 表2 DBE_COMPRESSION.GET_COMPRESSION_RATIO接口参数说明 参数 描述 SCRATCHTBSNAME 数据对象所属表空间。 OWNNAME 数据对象所有者（所属模式）。 OBJNAME 数据对象名称。 SUBOBJNAME 数据子对象名称。 COMPTYPE 压缩类型，支持： 1：未压缩 2：高级压缩 BLKCNT_CMP 样本被压缩后占用的块数。 BLKCNT_UNCMP 样本未压缩占用的块数。 ROW_CMP 样本被压缩后单个块内可容纳的行数。 ROW_UNCMP 样本未被压缩时单个数据块可容纳的行数。 CMP_RATIO 压缩比，BLKCNT_UNCMP除以BLKCNT_CMP。 COMPTYPE_STR 描述压缩类型的字符串。 SAMPLE_RATIO 采样比例，输入为0-100的整数或浮点数，对应为百分之n的采样比例。默认为20，即对20%的行数进行采样。 OBJTYPE 对象类型，支持： 1：表对象 DBE_COMPRESSION.GET_COMPRESSION_TYPE 根据输入参数获取指定行数据的压缩类型，该接口属于运维类接口，不做可见性判断，即传入的ctid为已删除的行时，该接口依然会返回当前行在页面上最新的状态。原型为： 1 2 3 4 5 DBE_COMPRESSION.GET_COMPRESSION_TYPE( OWNNAME IN VARCHAR2, TABNAME IN VARCHAR2, CTID IN TEXT, SUBOBJNAME IN VARCHAR2 DEFAULT NULL); 表3 DBE_COMPRESSION.GET_COMPRESSION_TYPE接口参数说明 参数 描述 OWNNAME 数据对象所有者（所属模式）。 TABNAME 数据对象名称。 CTID 目标行ctid。 SUBOBJNAME 数据子对象名称。

失效重编译概述 失效重编译提供一次性入库、失效重编译和级联失效功能。 一次性入库：新建存储过程、函数和PACKAGE使用未定义的对象。例如表、函数或类型不存在，可新建成功，打印告警。系统表pg_object对应的valid字段为false。 失效重编译功能：当未定义的对象都存在时，运行失效重编译高级包pkg_util.gs_compile_schema或者alter compile功能时，把对象变为有效，然后正常执行存储过程、函数和PACKAGE。 级联失效功能：当被依赖的对象被删除时，不再级联删除依赖对象，而是失效依赖对象，例如函数出入参依赖表，删除表时，函数失效，但函数未被级联删除。 重新创建包头，不删除原有包体功能：当使用CREATE OR REPLACE PACKAGE覆盖原有包头定义时，已经存在的包体定义不会被删除，而是被失效。支持使用ALTER COMPILE功能，尝试将包体变为有效。 使用该功能，推荐开启如下GUC参数: enable_force_create_obj=on，提供一次性入库功能。 ddl_invalid_mode='invalid'，提供级联失效功能。 集中式A兼容模式数据库支持。 开启失效重编参数后，数据库存在用户自定义函数失效对象时，将无法使用\df全量查询或查询单个失效函数，提示存在失效对象报错。 视图依赖函数的场景，重建被依赖函数仅支持自动重建与函数相同schema的视图，其他场景需要手动重建视图。 不支持记录同义词的依赖关系，记录同义词指向的原始对象依赖关系。 不支持记录临时表的依赖关系。 不支持记录物化视图的依赖关系。 PACKAGE和FUNCTION的执行块访问其他对象时，直接调用FUNCTION，直接调用PACKAGE内FUNCTION，直接访问PACKAGE变量记录依赖关系，其他场景不支持记录依赖关系。 PACKAGE和FUNCTION变量的默认值、表达式右值，直接调用FUNCTION，直接调用PACKAGE内FUNCTION，直接访问PACKAGE变量记录依赖关系，其他场景不支持记录依赖关系。 自治事务函数调用，触发依赖对象嵌套编译，依赖对象状态不更新，需要手动ALTER PACKAGE刷新。 匿名块和函数参数的CAST类型转换使用失效PACKAGE的类型时，需要手动ALTER PACKAGE刷新。 父主题： 失效重编译

语法格式 1 2 3 4 predpush_same_level(src, dest) predpush_same_level(src1 src2 ..., dest) [no] nestloop_index([@queryblock] dest[, index_list]) -- 索引方式 [no] nestloop_index([@queryblock] dest[,(src1 src2 ...)]) -- 表名方式 predpush_same_level参数仅在rewrite_rule中的predpushforce选项打开时生效。 nestloop_index对rewrite_rule不做要求。

WLM_USER_RESOURCE_RUNTIME WLM_USER_RESOURCE_RUNTIME视图显示所有用户资源使用情况，需要使用管理员用户进行查询，如表1所示。此视图在GUC参数“use_workload_manager”为“on”时才有效。 表1 WLM_USER_RESOURCE_RUNTIME字段 名称 类型 描述 username name 用户名。 used_memory integer 正在使用的内存大小，单位MB。 total_memory integer 可以使用的内存大小，单位MB。值为0表示未限制最大可用内存，其限制取决于数据库最大可用内存。 used_cpu integer 正在使用的CPU核数。 total_cpu integer 在该机器节点上，用户关联控制组的CPU核数总和。 used_space bigint 已使用的存储空间大小，单位KB。 total_space bigint 可使用的存储空间大小，单位KB。值为-1表示未限制最大存储空间。 used_temp_space bigint 已使用的临时空间大小（预留字段，暂未使用），单位KB。 total_temp_space bigint 可使用的临时空间大小（预留字段，暂未使用），单位KB。值为-1表示未限制最大临时存储空间。 used_spill_space bigint 已使用的下盘空间大小（预留字段，暂未使用），单位KB。 total_spill_space bigint 可使用的下盘空间大小（预留字段，暂未使用），单位KB。值为-1表示未限制最大下盘空间。 父主题： Workload Manager

GLOBAL_STAT_ALL_INDEXES 显示数据库各节点中的每个索引的访问信息（每个索引在每个节点下的状态信息不汇总），如表1所示。 表1 GLOBAL_STAT_ALL_INDEXES字段 名称 类型 描述 node_name name 节点名称。 relid oid 这个索引的表的OID。 indexrelid oid 索引的OID。 schemaname name 索引所在的Schema名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan bigint 该索引上执行的索引扫描次数。 idx_tup_read bigint 该索引上扫描返回的索引项数。 idx_tup_fetch bigint 使用该索引的简单索引扫描在原表中抓取的活跃行数。 last_updated timestamp with time zone 视图中该索引监控数据最后一次更新的时间。 父主题： Object

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不存在会报错。 多租场景下，PDB内仅能查看本PDB数据，Non-PDB仅能查看Non-PDB数据。 返回值类型：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_mis s | rel_count | rel_dead | rel_memory | part_searches | part_hits | part_miss | part_count | part_dead | part_memory | total_memory | swa pout_count | refcount -------------+---------------+--------------+----------+----------+-----------+----------+------------+--------------+----------+-------- --+-----------+----------+------------+---------------+-----------+-----------+------------+-----------+-------------+--------------+---- -----------+---------- 0 | | 300 | 235 | 31 | 22 | 2 | 9752 | 598 | 108 | 1 8 | 18 | 0 | 77720 | 0 | 0 | 0 | 0 | 0 | 0 | 752912 | 0 | 0 16574 | testdb | 3368 | 2289 | 329 | 273 | 0 | 92593 | 1113 | 524 | 4 8 | 48 | 0 | 340456 | 0 | 0 | 0 | 0 | 0 | 0 | 4124792 | 0 | 10 (2 rows)

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不存在结果为空。多租场景下，PDB内仅能查看本PDB数据，Non-PDB仅能查看Non-PDB数据。 返回值类型：Tuple 示例： --首先通过pg_database获取特定数据库的oid，查询语句一般为：SELECT oid, * FROM pg_database; --返回元组中通过datname列找到对应的oid列的值，然后执行如下查询，示例获取的oid为16574。 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不存在会报错。PDB内仅能清理本PDB数据，Non-PDB仅能清理Non-PDB数据。 返回值类型：Boolean 示例： gaussdb=# SELECT * FROM gs_gsc_clean(); gs_gsc_clean -------------- t (1 row)

gs_gsc_table_detail(database_id default NULL, rel_id default NULL) 描述：查看数据库里全局系统缓存的表元数据。调用该函数的用户需要具有SYSADMIN权限。多租场景下，PDB内仅能查看本PDB数据，Non-PDB仅能查看Non-PDB数据。 参数：指定需要查看全局系统缓存的数据库和表，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_LOGICAL_AUTHID GS_LOGICAL_AUTHID系统表记录逻辑解码需要使用的用户信息。 表1 GS_LOGICAL_AUTHID字段 字段名称 字段类型 说明 rolid oid 用户ID。 rolname name 用户名称。 createtime timestamp with time zone 插入元组的时间戳。 csnmin bigint 插入元组时的CSN（提交序列号）。 csnmax bigint 更新或删除元组时的CSN。 originid integer 元组的来源标识符。 rolkind "char" 用户类型。 pdbid oid 用户对应的租户ID。 父主题： 逻辑解码

GS_INSTANCE_TIME 提供当前集节点下的各种时间消耗信息，主要分为以下类型: DB_TIME: 作业在多核下的有效时间花销。 CPU_TIME：CPU的时间花销。 EXECUTION_TIME：执行器内的时间花销。 PARSE_TIME：SQL解析的时间花销。 PLAN_TIME：生成Plan的时间花销。 REWRITE_TIME：SQL重写的时间花销。 PL_EXECUTION_TIME ：PL/SQL（存储过程）执行的时间花销。 PL_COMPILATION_TIME：PL/SQL（存储过程）编译的时间花销。 NET_SEND_TIME：网络上的时间花销。 DATA_IO_TIME：I/O的时间花销。 表1 GS_INSTANCE_TIME字段 名称 类型 描述 stat_id integer 统计编号。 stat_name text 类型名称。 value bigint 时间值（单位：微秒）。 父主题： 其他系统视图

MY_SYNONYMS MY_SYNONYMS视图显示当前模式下同义词的信息。该视图所有用户可访问，仅可查看当前用户所属信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_SYNONYMS字段 名称 类型 描述 schema_name text 同义词所属模式名。 synonym_name text 同义词的名称。 table_owner text 关联对象的所有者。尽管该列称为table_owner，但它拥有的该关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 table_name text 关联对象名。尽管该列称为table_name，但此关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 table_schema_name text 关联对象所属模式名。尽管该列称为table_schema_name，但此schema下的该关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 db_link character varying(128) 保留字段，值为NULL。 origin_con_id character varying(256) 暂不支持，值为0。 父主题： 其他系统视图

示例 修改聚合函数的名称。 --创建自定义函数。 gaussdb=# CREATE OR REPLACE FUNCTION int_add(int,int) RETURNS int AS $BODY$ DECLARE BEGIN RETURN $1 + $2; END; $BODY$ language plpgsql; --创建聚合函数。 gaussdb=# CREATE AGGREGATE myavg (int) ( sfunc = int_add, stype = int, initcond = '0' ); --把一个接受int类型参数的聚合函数myavg重命名为my_average。 gaussdb=# ALTER AGGREGATE myavg(int) RENAME TO my_average;

SQLSTATE与SQLCODE SQLSTATE是一个由五个字符组成的数组。这五个字符包含数字或大写字母，它表示多种错误或告警情况的代码。SQLSTATE具有一种层次模式：前两个字符表示情况的总体分类，后三个字符表示总体情况的子类。例如：代码00000表示成功状态。 SQLCODE是一个简单的整数形式。值为0表示成功，一个正值表示带附加信息的成功，一个负值表示错误。SQL标准只定义了正值+100，它表示上一个命令返回或者影响了零行，且没有特定的负值。 表1 SQLSTATE与SQLCODE对应关系表 SQLCODE值 SQLSTATE值 含义 0 (ECPG_NO_ERROR) SQLSTATE 00000 表示没有错误。 100 (ECPG_NOT_FOUND) SQLSTATE 02000 一种无害情况，它表示上一个命令检索或者处理了零行，或者已到达游标的末尾。 在循环中处理游标时，可以使用这个代码来检测何时中止该循环，示例如下： while (1) { EXEC SQL FETCH ... ; if (sqlca.sqlcode == ECPG_NOT_FOUND) break; } 实际上WHENEVER NOT FOUND DO BREAK也会在内部这样做，所以一般不会直接使用这种方法。 -12 (ECPG_OUT_OF_MEMORY) SQLSTATE YE001 虚拟内存已被耗尽，数字值被定义为-ENOMEM。 -200 (ECPG_UNSUPPORTED) SQLSTATE YE000 预处理器产生了一些该库无法识别的内容。 -201 (ECPG_TOO_MANY_ARGUMENTS) SQLSTATE 07001 或 07002 表示命令指定的宿主变量数量超过该命令预期。 -202 (ECPG_TOO_FEW_ARGUMENTS) SQLSTATE 07001 或 07002 表示命令指定的宿主变量数量低于该命令的预期。 -203 (ECPG_TOO_MANY_MATCHES) SQLSTATE 21000 表示一个查询已经返回了多行，但是该语句只准备存储一个结果行。 -204 (ECPG_INT_FORMAT) SQLSTATE 42804 宿主变量是类型int而数据库中的数据是一种不同的类型并且含有不能被解释为int的值。该库使用strtol()进行转换。 -205 (ECPG_UINT_FORMAT) SQLSTATE 42804 宿主变量是类型unsigned int而数据库中的数据是一种不同的类型并且含有不能被解释为unsigned int的值。该库使用strtoul()进行转换。 -206 (ECPG_FLOAT_FORMAT) SQLSTATE 42804 宿主变量是类型float而数据库中的数据是另一种类型并且含有不能被解释为float的值。该库使用strtod()进行转换。 -207 (ECPG_NUMERIC_FORMAT) SQLSTATE 42804 宿主变量是类型numeric而数据库中的数据是另一种类型并且含有不能被解释为numeric的值。 -208 (ECPG_INTERVAL_FORMAT) SQLSTATE 42804 宿主变量是类型interval而数据库中的数据是另一种类型并且含有一个不能被解释为interval的值。 -209 (ECPG_DATE_FORMAT) SQLSTATE 42804 宿主变量是类型date而数据库中的数据是另一种类型并且含有不能被解释为date的值。 -210 (ECPG_TIMESTAMP_FORMAT) SQLSTATE 42804 宿主变量是类型timestamp而数据库中的数据是另一种类型并且含有不能被解释为timestamp的值。 -211 (ECPG_CONVERT_BOOL) SQLSTATE 42804 宿主变量是类型boolean而数据库中的数据既不是't'也不是'f'。 -212 (ECPG_EMPTY) SQLSTATE YE000 发送给SQL服务器的语句是空值（通常在一个嵌入式SQL程序中不会发生，因此它可能指向一个内部错误）。 -213 (ECPG_MISSING_INDICATOR) SQLSTATE 22002 返回了一个空值并且没有提供空值指示符。 -214 (ECPG_NO_ARRAY) SQLSTATE 42804 在要求一个数组的地方使用了一个普通变量。 -215 (ECPG_DATA_NOT_ARRAY) SQLSTATE 42804 在一个要求数组值的地方数据库返回了一个普通变量。 -216 (ECPG_ARRAY_INSERT) SQLSTATE 42804 该值不能被插入到数组中。 -220 (ECPG_NO_CONN) SQLSTATE 08003 程序尝试访问一个不存在的连接。 -221 (ECPG_NOT_CONN) SQLSTATE YE000 程序尝试访问一个存在的连接但是它没有打开（这是一个内部错误）。 -230 (ECPG_INVALID_STMT) SQLSTATE 26000 尝试使用的语句还没有被准备好。 -239 (ECPG_INFORMIX_DUPLICATE_KEY) SQLSTATE 23505 重复键错误，违背唯一约束。 -240 (ECPG_UNKNOWN_DESCRIPTOR) SQLSTATE 33000 没有找到指定的描述符，尝试使用的语句还没有被准备好。 -241 (ECPG_INVALID_DESCRIPTOR_INDEX) SQLSTATE 07009 指定的描述符超出范围。 -242 (ECPG_UNKNOWN_DESCRIPTOR_ITEM) SQLSTATE YE000 请求了一个非法的描述符（这是一个内部错误）。 -243 (ECPG_VAR_NOT_NUMERIC) SQLSTATE 07006 在执行一个动态语句期间，数据库返回了一个numeric值而宿主变量不是numeric类型的。 -244 (ECPG_VAR_NOT_CHAR) SQLSTATE 07006 在执行一个动态语句期间，数据库返回了一个非numeric值而宿主变量是numeric类型的。 -284 (ECPG_INFORMIX_SUBSELECT_NOT_ONE) SQLSTATE 21000 子查询的结果不是单一行。 -400 (ECPG_PGSQL) - SQL服务器导致了某个错误。该消息包含来自SQL服务器的错误消息。 -401 (ECPG_TRANS) SQLSTATE 08007 SQL服务器通知不能启动、提交或回滚事务。 -402 (ECPG_CONNECT) SQLSTATE 08001 无法建立数据库连接。 -403 (ECPG_DUPLICATE_KEY) SQLSTATE 23505 重复键错误，违背唯一约束。 -404 (ECPG_SUBSELECT_NOT_ONE) SQLSTATE 21000 子查询的结果不是单一行。 -602 (ECPG_WARNING_UNKNOWN_PORTAL) SQLSTATE 34000 指定了一个非法的游标名。 -603 (ECPG_WARNING_IN_TRANSACTION) SQLSTATE 25001 事务正在进行。 -604 (ECPG_WARNING_NO_TRANSACTION) SQLSTATE 25P01 没有活动（正在进行）的事务。 -605 (ECPG_WARNING_PORTAL_EXISTS) SQLSTATE 42P03 指定了一个现有的游标名。 ecpg为嵌入式SQL新增加的SQLSTATE码有：22002、07001、07002、07006、07009、33000、42601、42804、42P03、YE000和YE001。其余SQLSTATE码沿用内核SQLSTATE码。 SQLSCODE为-400表示ecpg检测到内核服务器返回错误，其SQLSTATE为内核相应错误的SQLSTATE。 父主题： 错误处理

查看和停止正在运行的查询语句 通过视图PG_STAT_ACTIVITY可以查看正在运行的查询语句。方法如下： 设置参数track_activities为on。 1 gaussdb=# SET track_activities = on; 当此参数为on时，数据库系统才会获取当前活动查询的运行信息。 查看正在运行的查询语句。以查看正在运行的查询语句所连接的数据库名、执行查询的用户、查询状态及查询对应的PID为例。 1 gaussdb=# SELECT datname, usename, state, pid FROM pg_stat_activity; 1 2 3 4 5 6 7 8 datname | usename | state | pid ----------+---------+--------+----------------- testdb | Ruby | active | 140298793514752 testdb | Ruby | active | 140298718004992 testdb | Ruby | idle | 140298650908416 testdb | Ruby | idle | 140298625742592 testdb | omm | active | 140298575406848 (5 rows) 如果state字段显示为idle，则表明此连接处于空闲，等待用户输入命令。 如果仅需要查看非空闲的查询语句，则执行如下命令查看。 1 gaussdb=# SELECT datname, usename, state, pid FROM pg_stat_activity WHERE state != 'idle'; 若需要取消运行时间过长的查询，通过pg_terminate_backend(pid int)函数，根据线程ID（即2中查询结果的pid字段）结束会话，请执行如下命令。 1 gaussdb=# SELECT PG_TERMINATE_BACKEND(140298793514752); 显示如下信息，表示结束会话成功。 1 2 3 4 PG_TERMINATE_BACKEND ---------------------- t (1 row) 显示如下信息，表示用户执行了结束当前会话的操作。 1 2 FATAL: terminating connection due to administrator command FATAL: terminating connection due to administrator command 当使用gsql客户端调用pg_terminate_backend(pid int)函数终止当前会话的后台线程时，连接行为取决于用户身份： 初始用户：客户端保持连接并自动重置（提示：The connection to the server was lost. Attempting reset: Succeeded.）。 非初始用户：客户端连接中断且重置失败（提示：The connection to the server was lost. Attempting reset: Failed.）。 原因为：初始用户具备免密码登录权限，而普通用户无此权限。 使用pg_terminate_backend(pid int)函数结束非活跃的后台线程时，如果打开了线程池，此时空闲的会话没有线程ID，无法结束会话。非线程池模式下，结束的会话不会自动重连。 1 2 3 FATAL: terminating connection due to administrator command FATAL: terminating connection due to administrator command The connection to the server was lost. Attempting reset: Succeeded.

查看数据库中包含的表 在public Schema下新建以下表格。 gaussdb=# CREATE TABLE public.search_table_t1(a int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t2(b int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t3(c int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t4(d int); CREATE TABLE gaussdb=# CREATE TABLE public.search_table_t5(e int); CREATE TABLE 在PG_TABLES系统表中查看public Schema中包含的前缀为search_table的表。 1 gaussdb=# SELECT DISTINCT(tablename) FROM pg_tables WHERE SCHEMANAME = 'public' AND TABLENAME LIKE 'search_table%'; 结果如下： 1 2 3 4 5 6 7 8 tablename ----------------- search_table_t1 search_table_t2 search_table_t3 search_table_t4 search_table_t5 (5 rows)