华为云用户手册

GaussDB 中模式、用户和角色如何理解？ 答：模式是对数据库做一个逻辑分割，所有的数据库对象都建立在模式下面。模式和用户是弱绑定的，弱绑定是指虽然创建用户的同时会自动创建一个同名模式，但用户也可以单独创建模式，并且为用户指定其他的模式。 用户和角色是用来控制对数据库的访问。一个数据库可能有很多的用户需要访问，为了方便管理这些用户，将用户组成一个数据库角色。根据角色自身的设置不同，一个角色可以看做是一个数据库用户，或者一组数据库用户。角色和用户之间的区别只在于角色默认是没有 LOG IN权限的。在业务设计中，仅建议通过ROLE来配置权限，而不是用来访问数据库。 父主题： FAQ

连接数据库（UDS方式） Unix domain socket用于同一主机上不同进程间的数据交换，通过添加junixsocket获取套接字工厂使用。 需要引用的jar包有junixsocket-core-XXX.jar、junixsocket-common-XXX.jar、junixsocket-native-common-XXX.jar。同时需要在URL连接串中添加：socketFactory=org.newsclub.net.unix.AFUNIXSocketFactory$FactoryArg&socketFactoryArg=[path-to-the-unix-socket]。 示例： // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 import java.sql.Connection; import java.sql.DriverManager; import java.sql.Statement; import java.util.Properties; public class Test { public static void main(String[] args) { String driver = "com.huawei.gaussdb.jdbc.Driver"; String userName = System.getenv("EXAMPLE_USERNAME_ENV"); String password = System.getenv("EXAMPLE_PASSWORD_ENV"); Connection conn; try { Class.forName(driver).newInstance(); Properties properties = new Properties(); properties.setProperty("user", userName); properties.setProperty("password", password); conn = DriverManager.getConnection("jdbc:gaussdb://$ip:$port/database?socketFactory=org.newsclub" + ".net.unix" + ".AFUNIXSocketFactory$FactoryArg&socketFactoryArg=/data/tmp/.s.PGSQL.8000", properties); System.out.println("Connection Successful!"); Statement statement = conn.createStatement(); statement.executeQuery("select 1"); } catch (Exception e) { e.printStackTrace(); } } } socketFactoryArg参数配置根据真实路径进行配置，与GUC参数unix_socket_directory的值保持一致。 连接主机名必须设置为“localhost”。 父主题： 基于JDBC开发

PG_PARTITION PG_PARTITION系统表存储数据库内所有分区表（partitioned table）、分区（table partition）和分区索引（index partition）三类对象的信息。分区表索引（partitioned index）的信息不在PG_PARTITION系统表中保存。由于分区表（partitioned table）没有实际的物理文件，所以在pg_partition中不会记录其relfilenode、relpages、reltuples、reltoastrelid、reltoastidxid等信息。 表1 PG_PARTITION字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 relname name 分区表、分区、分区上toast表和分区索引的名称。 parttype "char" 对象类型： 'r'：partitioned table 'p'：table partition 's'：table subpartition 'x'：index partition parentid oid 当对象为分区表或分区时，此字段表示分区表在PG_CLASS中的OID。 当对象为二级分区时，此字段表示其一级分区在PG_PARTITION中的OID。 当对象为index partition时，此字段表示所属分区表索引（partitioned index）的OID。 rangenum integer 保留字段。 intervalnum integer 保留字段。 partstrategy "char" 分区表分区策略，现在仅支持： 'r'：范围分区。 'i'：间隔分区。 'l'：list分区。 'a'：自动扩展的list分区。 'h'：hash分区。 'n'：无分区策略，该对象不是表分区。 relfilenode oid table partition、index partition、分区上toast表的物理存储位置。 reltablespace oid table partition、index partition、分区上toast表所属表空间的OID。 relpages double precision 统计信息：table partition、index partition的数据页数量。 reltuples double precision 统计信息：table partition、index partition的元组数。 relallvisible integer 统计信息：table partition、index partition的可见数据页数。 reltoastrelid oid table partition所对应toast表的OID。 reltoastidxid oid table partition所对应toast表的索引的OID。 indextblid oid index partition对应table partition的OID。 indisusable boolean 分区索引是否可用。 relfrozenxid xid32 冻结事务ID号。 为保持前向兼容，保留此字段，新增relfrozenxid64用于记录此信息。 intspnum integer 间隔分区所属表空间的个数。 partkey int2vector 分区键的列号。 intervaltablespace oidvector 间隔分区所属的表空间，间隔分区以round-robin方式落在这些表空间内。 interval text[] 间隔分区的间隔值。 boundaries text[] 范围分区和间隔分区的上边界。 transit text[] 间隔分区的跳转点。 reloptions text[] 设置partition的存储属性，与pg_class.reloptions的形态一样，用“keyword=value”格式的字符串来表示 ，目前用于在线扩容的信息搜集。 relfrozenxid64 xid 冻结事务ID号。 relminmxid xid 冻结多事务ID号。 partitionno integer 用于维护分区表中的分区Map结构。 当对象为分区时，此字段表示分区ID，从1开始自增。 当对象为分区表时，此字段表示分区ID的最大值，并使用负值来特殊标记，该值会随着部分分区DDL语法不断递增。 当对象为其他类型时，此字段为空值，没有任何含义。 partitionno是一个永久自增列，可以通过语法ALTER TABLE t_name RESET PARTITION命令重置/回收。 subpartitionno integer 用于维护分区表中的二级分区Map结构。 当对象为二级分区时，此字段表示二级分区ID，从1开始自增。 当对象为二级分区表的一级分区时，此字段表示二级分区ID的最大值，并使用负值来特殊标记，该值会随着部分分区DDL语法不断递增。 当对象为其他类型时，此字段为空值，没有任何含义。 subpartitionno是一个永久自增列，可以通过语法ALTER TABLE t_name RESET PARTITION命令重置/回收。 父主题： 分区表

PGXC_NODE PGXC_NODE系统表存储集群节点信息。 PGXC_NODE系统表存储数据库实例节点信息。PGXC_NODE系统表仅在CN下有具体含义且数据有效正确。 在DN节点查询PGXC_NODE系统表结果数据中只有node_id字段是有意义，其他字段值没有意义且为无效数据。 表1 PGXC_NODE字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 node_name name 节点名称。 node_type "char" 节点类型。 C：协调节点。 D：数据节点。 S：数据节点的备节点。 node_port integer 节点的端口号。 node_host name 节点的主机名称或者IP（如配置为虚拟IP，则为虚拟IP）。 node_port1 integer 复制节点的端口号。 node_host1 name 复制节点的主机名称或者IP（如配置为虚拟IP，则为虚拟IP）。 hostis_primary boolean 表明当前节点是否发生主备切换。 t（true）：表示发生。 f（false）：表示不发生。 nodeis_primary boolean 在replication表下，是否优选当前节点作为优先执行的节点进行非查询操作。 t（true）：表示优选。 f（false）：表示不优选。 nodeis_preferred boolean 在replication表下，是否优选当前节点作为首选的节点进行查询。 t（true）：表示优选。 f（false）：表示不优选。 node_id integer 节点标识符。由node_name经过哈希函数计算后得到。 sctp_port integer 主节点使用TCP代理通信库的数据通道侦听端口（当前版本已经不再支持SCTP通信库）。 control_port integer 主节点使用TCP代理通信库的控制通道侦听端口。 sctp_port1 integer 备节点使用TCP代理通信库的数据通道侦听端口（当前版本已经不再支持SCTP通信库）。 control_port1 integer 备节点使用TCP代理通信库的控制通道侦听端口。 nodeis_central boolean 表明当前节点是否为中心控制节点，只用于CN，对DN无效。 t（true）：表示是。 f（false）：表示不是。 nodeis_active boolean 表明当前节点是否是正常状态，用于标记CN是否被剔除，对DN无效。 t（true）：表示是。 f（false）：表示不是。 父主题： 通信

GS_COMM_PROXY_THREAD_STATUS GS_COMM_PROXY_THREAD_STATUS视图用来显示代理通信库comm_proxy的数据收发包统计信息。只有集中式数据库在安装阶段启动用户态网络部署形态，同时comm_proxy_attr参数的enable_dfx配置为true，才会具体显示数据comm_proxy的数据收发统计，其他场景下，该视图不支持查询。 表1 GS_COMM_PROXY_THREAD_STATUS字段 名称 类型 描述 ProxyThreadId bigint 当前网络代理线程comm_proxy的线程id。 ProxyCpuAffinity text 当前网络代理线程comm_proxy的NUMA-CPU亲和性，表示所在NUMA和CPU ID。 ThreadStartTime text 当前网络代理线程comm_proxy的启动时间。 RxPckNums bigint 当前网络代理线程comm_proxy收包数量。 TxPckNums bigint 当前网络代理线程comm_proxy发包数量。 RxPcks double precision 当前网络代理线程comm_proxy每秒收包数量。 TxPcks double precision 当前网络代理线程comm_proxy每秒发包数量。 父主题： 其他系统视图

MY_TAB_COLUMNS MY_TAB_COLUMNS视图显示当前用户拥有的表和视图的字段信息。该视图同时存在于PG_CATALOG和SYS Schema下。该视图所有用户可访问，仅显示该用户所属的信息。具体字段信息如表1所示。 表1 MY_TAB_COLUMNS字段 名称 类型 描述 owner character varying(64) 表的所有者。 table_name character varying(64) 表名称。 column_name character varying(64) 列名。 data_type character varying(128) 列的数据类型。 data_type_mod character varying(3) 暂不支持，值为NULL。 data_type_owner character varying(128) 列的数据类型的所有者。 data_length integer 列的字节长度。 data_precision integer 数据类型的精度，对于numeric数据类型有效，其他类型为NULL。 data_scale integer 小数点右边的位数，对于numeric数据类型有效，其他类型为0。 nullable bpchar 该列是否允许为空，对于主键约束和非空约束，该值为n。 column_id integer 创建表时列的序号。 default_length numeric 列的默认值字节长度。 data_default text 列的默认值。 num_distinct numeric 列中不同值的数量。 low_value raw 列中的最小值。 high_value raw 列中的最大值。 density numeric 列密度。 num_nulls numeric 列中空值数。 num_buckets numeric 列的直方图的桶数。 last_analyzed date 上次分析的日期。 sample_size numeric 用于分析此列的样本量。 character_set_name character varying(44) 暂不支持，值为NULL。 char_col_decl_length numeric 字符类型列的声明长度。 global_stats character varying(3) 暂不支持，值为NO。 user_stats character varying(3) 暂不支持，值为NO。 avg_col_len numeric 列的平均长度（单位字节）。 char_length numeric 列的长度（单位字符），只对varchar，nvarchar2，bpchar，char类型有效。 char_used character varying(1) 暂不支持，varchar、bpchar与char类型值为B；nvarchar2类型值为C；其余值为NULL。 v80_fmt_image character varying(3) 暂不支持，值为NULL。 data_upgraded character varying(3) 暂不支持，值为YES。 histogram character varying(15) 表示直方图是否存在，如果存在的话是什么类型： NONE：表示不存在直方图。 FREQUENCY：表示频率直方图。 EQUI_W IDT H：表示等宽直方图。 default_on_null character varying(3) 暂不支持，值为NULL。 identity_column character varying(3) 暂不支持，值为NULL。 sensitive_column character varying(3) 暂不支持，值为NULL。 evaluation_edition character varying(128) 暂不支持，值为NULL。 unusable_before character varying(128) 暂不支持，值为NULL。 unusable_beginning character varying(128) 暂不支持，值为NULL。 collation character varying(100) 列的排序规则。因该字段与保留关键字冲突，调用该字段需加视图名。 comments text 列的注释。 schema character varying(64) 列所属的名称空间的名称。 父主题： 其他系统视图

字符集与字符序 字符集（Character Set）是字符的编码规则，字符序（Collation）是字符的排序规则，本章主要对GaussDB的B模式（即sql_compatibility = 'B'）下的字符集、字符序进行介绍，以下介绍的字符集、字符序规则和语法仅在B模式下支持。 GaussDB目前所支持的字符集可以参考CREATE DATABASE章节中ENCODING部分介绍，所支持的字符序可以通过查询系统表PG_COLLATION。 其中，部分字符集在B模式下存在默认字符序，可以参考表1。 字符集和字符序存在以下说明： 每一个字符集都有一个或多个字符序，只有一个字符序为字符集的默认字符序。 每一个字符序仅有一个相关联的字符集。 相同数据使用不同的字符序排序结果可能会不同。 在GaussDB中，utf8mb4与utf8为同一字符集。 在GaussDB的B模式（即sql_compatibility = 'B'）下，binary字符集与SQL_ASCII字符集为同一字符集。 建议表字段和server_encoding选择相同字符集，避免转码带来的性能损耗。 GaussDB数据库 支持以下功能： 支持多种字符集存储字符串。 支持使用字符序比较字符串。 支持数据库级、模式级、表级、字段级字符集和字符序。 暂不支持在同服务器、同数据库、同一个表、同一条SQL语句中混合使用不同字符集和字符序的字符串。 客户端连接的字符集和字符序 数据库级字符集和字符序 模式级字符集和字符序 表级字符集和字符序 列级字符集字符序 字符类型表达式的字符集和字符序 字符集和字符序合并规则 父主题： SQL参考

背景 一个数据库可能有很多的用户需要访问，为了方便管理这些用户，将用户组成一个数据库角色。一个数据库角色可以视为一个数据库用户或者一组数据库用户。 对于数据库来说，用户和角色是基本相同的概念，不同之处在于，使用CREATE ROLE创建角色，不会创建同名的SCHEMA，并且默认没有LOGIN权限；而使用CREATE USER创建用户，会自动创建同名的SCHEMA，默认有LOGIN权限。换句话说，一个拥有LOGIN权限的角色可以被认为是一个用户。在业务设计中，仅建议通过ROLE来组织权限，而不是用来访问数据库。

解决方案 数据库用户 数据库用户的主要用途是使用该用户账号连接数据库、访问数据库对象和执行SQL语句。在连接数据库时，必须使用一个已经存在的数据库用户。因此，作为数据库管理员，需要为每一个需要连接数据库的使用者规划一个数据库用户。 在创建数据库用户时，至少需要指定用户名和密码。 默认情况下，数据库用户可以分为两大类，详细信息请参见表1。 表1 用户分类 分类 描述 初始用户 具有数据库的最高权限，并且具有所有的系统权限和对象权限。初始用户不受对象的权限设置影响。这个特点类似Unix系统的root的权限。从安全角度考虑，除了必要的情况，建议尽量避免以初始用户身份操作。 在安装数据库或者初始化数据库时，可以指定初始用户名和密码。如果不指定用户名则会自动生成一个与安装数据库的OS用户同名的初始用户。如果不指定密码则安装后初始用户密码为空，需要通过gsql客户端设置初始用户的密码后才能执行其他操作。 说明： 基于安全性考虑，GaussDB Kernel禁止了所有用户trust方式的远程登录方式，禁止了初始用户的任何方式的远程登录。 普通用户 默认可以访问数据库的默认系统表和视图（pg_authid、pg_largeobject、pg_user_status和pg_auth_history除外），可以连接默认的数据库postgres以及使用public模式下的对象（包括表、视图和函数等）。 可以通过CREATE USER、ALTER USER指定系统权限，或者通过GRANT ALL PRIVILEGE授予SYSADMIN权限。 可以通过GRANT语句授予某些对象的权限。 可以通过GRANT语法将其他角色或用户的权限授权给该用户。 数据库权限分类 通过权限和角色，可以控制用户访问指定的数据，以及执行指定类型的SQL语句。详细信息请参见表2。 系统权限只能通过CREATE/ALTER USER、CREATE/ALTER ROLE语句指定（其中SYSADMIN还可以通过GRANT/REVOKE ALL PRIVILEGES的方式赋予、回收），无法从角色继承。 表2 权限分类 分类 描述 系统权限 系统权限又称为用户属性，可以在创建用户和修改用户时指定，包括SYSADMIN、MONADMIN、OPRADMIN、POLADMIN、CREATEDB、CREATEROLE、AUDITADMIN和LOGIN。 系统权限一般通过CREATE/ALTER USER语句指定。除了SYSADMIN外的其他系统权限，无法通过GRANT/REVOKE进行授予和撤销。并且，系统权限无法通过ROLE被继承。 对象权限 对象权限是指在表、视图、索引和函数等数据库对象上执行各种操作的权限，对象权限包括SELECT、INSERT、UPDATE和DELETE等。 只有对象的所有者或者系统管理员才可以执行GRANT/REVOKE语句来分配/撤销对象权限。 角色 角色是一组权限的集合，可以将一个角色的权限赋予其他角色和用户。 由于无法给其他角色和用户赋予系统权限，所以角色只有是对象权限的集合时才有意义。 数据库权限模型 系统权限模型 默认权限机制 图1 权限架构 权限架构如图1，默认权限机制下sysadmin具有大多数的权限。 初始安装用户：集群安装过程中自动生成的账户，拥有系统的最高权限，能够执行所有的操作。 SYSADMIN：系统管理员权限，权限仅次于初始安装用户，默认具有与对象所有者相同的权限，但不包括监控管理员权限和运维管理员权限。 MONADMIN：监控管理员权限，具有监控模式dbe_perf及模式下视图和函数的访问权限和授予权限。 OPRADMIN：运维管理员权限，具有使用Roach工具执行备份恢复的权限。 CREATEROLE：安全管理员权限，具有创建、修改、删除用户/角色的权限。 AUDITADMIN：审计管理员权限，具有查看和维护数据库审计日志的权限。 CREATEDB：具有创建数据库的权限。 POLADMIN：安全策略管理员权限，具有创建资源标签，数据动态脱敏策略和统一审计策略的权限。 三权分立机制 图2 三权分立机制 SYSADMIN：系统管理员权限，不再具有创建、修改、删除用户/角色的权限，也不再具有查看和维护数据库审计日志的权限。 CREATEROLE：安全管理员权限，具有创建、修改、删除用户/角色的权限。 AUDITADMIN：审计管理员权限，具有查看和维护数据库审计日志的权限。 一个用户/角色只能具有SYSADMIN、CREATEROLE和AUDITADMIN中的一项系统权限。 对象权限模型 对象权限：指在数据库、模式、表等数据库对象上执行特定动作的权限，比如：SELECT、INSERT、UPDATE、DELETE和CONNECT等。 针对不同的数据库对象有不同的对象权限，相应地可以被授予用户/角色。 通过GRANT/REVOKE来传递对象权限，对象权限可以通过角色被继承。 角色权限模型 GaussDB Kernel提供了一组默认角色，以gs_role_开头命名。它们提供对特定的、通常需要高权限操作的访问，可以将这些角色GRANT给数据库内的其他用户或角色，让这些用户能够使用特定的功能。在授予这些角色时应当非常小心，以确保它们被用在需要的地方。表3描述了内置角色允许的权限范围。 表3 内置角色权限 角色 权限描述 gs_role_copy_files 具有执行copy … to/from filename的权限，但需要先打开GUC参数enable_copy_server_files。 gs_role_signal_backend 具有调用函数pg_cancel_backend()、pg_terminate_backend()和pg_terminate_session()来取消或终止其他会话的权限，但不能操作属于初始用户和PERSISTENCE用户的会话。 gs_role_tablespace 具有创建表空间（tablespace）的权限。 gs_role_replication 具有调用逻辑复制相关函数的权限，例如kill_snapshot()、pg_create_logical_replication_slot()、pg_create_physical_replication_slot()、pg_drop_replication_slot()、pg_replication_slot_advance()、pg_create_physical_replication_slot_extern()、pg_logical_slot_get_changes()、pg_logical_slot_peek_changes()，pg_logical_slot_get_binary_changes()、pg_logical_slot_peek_binary_changes()。 gs_role_account_lock 具有加解锁用户的权限，但不能加解锁初始用户和PERSISTENCE用户。 gs_role_pldebugger 具有执行dbe_pldebugger下调试函数的权限。 gs_role_directory_create 具有执行创建directory对象的权限，但需要先打开GUC参数enable_access_server_directory。 gs_role_directory_drop 具有执行删除directory对象的权限，但需要先打开GUC参数enable_access_server_directory。 系统权限配置 默认权限机制配置方法 初始用户 数据库安装过程中自动生成的账户称为初始用户。初始用户也是系统管理员、监控管理员、运维管理员和安全策略管理员，拥有系统的最高权限，能够执行所有的操作。如果安装时不指定初始用户名称则该账户与进行数据库安装的操作系统用户同名。如果在安装时不指定初始用户的密码，安装完成后密码为空，在执行其他操作前需要通过gsql客户端修改初始用户的密码。如果初始用户密码为空，则除修改密码外无法执行其他SQL操作以及升级、扩容和节点替换等操作。 初始用户会绕过所有权限检查。建议仅将此初始用户作为DBA管理用途，而非业务用途。 系统管理员 gaussdb=#CREATE USER u_sysadmin WITH SYSADMIN password '********'; --或者使用如下SQL，效果一样，需要该用户已存在。 gaussdb=#ALTER USER u_sysadmin01 SYSADMIN; 监控管理员 gaussdb=#CREATE USER u_monadmin WITH MONADMIN password '********'; --或者使用如下SQL，效果一样，需要该用户已存在。 gaussdb=#ALTER USER u_monadmin01 MONADMIN; 运维管理员 gaussdb=#CREATE USER u_opradmin WITH OPRADMIN password "xxxxxxxxx"; --或者使用如下SQL，效果一样，需要该用户已存在。 gaussdb=#ALTER USER u_opradmin01 OPRADMIN; 安全策略管理员 gaussdb=#CREATE USER u_poladmin WITH POLADMIN password "xxxxxxxxx"; --或者使用如下SQL，效果一样，需要该用户已存在。 gaussdb=#ALTER USER u_poladmin01 POLADMIN; 三权分立机制配置方式 此模式需要设置guc参数“enableSeparationOfDut”y的值为“on”，该参数为POSTMASTER类型参数，修该完之后需要重启数据库。 gs_guc set -Z datanode -N all -I all -c "enableSeparationOfDuty=on" gs_om -t stop gs_om -t start 创建和配置相应的用户权限的语法和默认权限一致。 角色权限配置 --创建数据库test gaussdb=#CREATE DATABASE test; --创建角色role1，创建用户user1 gaussdb=#CREATE ROLE role1 PASSWORD '********'; gaussdb=#CREATE USER user1 PASSWORD '********'; --赋予CREATE ANY TABLE权限角色role1 gaussdb=#GRANT CREATE ON DATABASE test TO role1; --将角色role1赋予给用户user1,则用户user1属于组role1,继承role1的相应权限可以在test数据库中创建模式。 gaussdb=#GRANT role1 TO user1; --查询用户和角色信息 gaussdb=#\du role1|user1; List of roles Role name | Attributes | Member of -----------+--------------+----------- role1 | Cannot login | {} user1 | | {role1}

DBE_PLDEBUGGER.info_locals debug端调试过程中，调用info_locals，打印当前存储过程内变量。该函数入参frameno表示查询遍历的栈层数，支持无入参调用，缺省为查看最上层栈变量，如表1所示。 表1 info_locals入参和返回值列表 名称 类型 描述 frameno IN integer （可选） 指定的栈层数，缺省为最顶层。 varname OUT text 变量名。 vartype OUT text 变量类型。 value OUT text 变量值。 package_name OUT text 变量对应的package名，非package时为空。 isconst OUT boolean 是否为常量。 父主题： DBE_PLDEBUGGER Schema

GS_MATVIEW_DEPENDENCY GS_MATVIEW_DEPENDENCY系统表提供了关于数据库中每一个增量物化视图、基表和mlog表的关联信息。全量物化视图不存在与基表对应的mlog表，不会写入记录。 表1 GS_MATVIEW_DEPENDENCY字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 matviewid oid 物化视图的oid。 relid oid 物化视图基表的oid。 mlogid oid 物化视图mlog表的oid，mlog表为物化视图日志表，与基表一一对应。 mxmin integer 保留字段。 父主题： 物化视图

WORKLOAD_SQL_ELAPSE_TIME WORKLOAD_SQL_ELAPSE_TIME用来统计workload（业务负载）上的SUID（查询/更新/插入/删除）信息，如表1所示。 表1 WORKLOAD_SQL_ELAPSE_TIME字段 名称 类型 描述 workload name workload（业务负载）名称。 total_select_elapse bigint 总select的时间花费（单位：微秒）。 max_select_elapse bigint 最大select的时间花费（单位：微秒）。 min_select_elapse bigint 最小select的时间花费（单位：微秒）。 avg_select_elapse bigint 平均select的时间花费（单位：微秒）。 total_update_elapse bigint 总update的时间花费（单位：微秒）。 max_update_elapse bigint 最大update的时间花费（单位：微秒）。 min_update_elapse bigint 最小update的时间花费（单位：微秒）。 avg_update_elapse bigint 平均update的时间花费（单位：微秒）。 total_insert_elapse bigint 总insert的时间花费（单位：微秒）。 max_insert_elapse bigint 最大insert的时间花费（单位：微秒）。 min_insert_elapse bigint 最小insert的时间花费（单位：微秒）。 avg_insert_elapse bigint 平均insert的时间花费（单位：微秒）。 total_delete_elapse bigint 总delete的时间花费（单位：微秒）。 max_delete_elapse bigint 最大delete的时间花费（单位：微秒）。 min_delete_elapse bigint 最小delete的时间花费（单位：微秒）。 avg_delete_elapse bigint 平均delete的时间花费（单位：微秒）。 dbid oid 统计信息所属的数据库id。 父主题： Workload

GLOBAL_DOUBLE_WRITE_STATUS GLOBAL_DOUBLE_WRITE_STATUS视图显示整个集群所有实例的双写文件的情况，如表1所示。 表1 GLOBAL_DOUBLE_WRITE_STATUS字段 名称 类型 描述 node_name text 实例名称。 curr_dwn bigint 当前双写文件的序列号。 curr_start_page bigint 当前双写文件恢复起始页面。 file_trunc_num bigint 当前双写文件复用的次数。 file_reset_num bigint 当前双写文件写满后发生重置的次数。 total_writes bigint 当前双写文件总的I/O次数。 low_threshold_writes bigint 低效率写双写文件的I/O次数。 high_threshold_writes bigint 高效率写双写文件的I/O次数。 total_pages bigint 当前刷页到双写文件区的总的页面个数。 low_threshold_pages bigint 低效率刷页的页面个数。 high_threshold_pages bigint 高效率刷页的页面个数。 file_id bigint 当前双写文件的id号。 父主题： Utility

GLOBAL_REL_IOSTAT 获取集群上所有节点的数据文件I/O统计信息，如表1所示。 表1 GLOBAL_REL_IOSTAT字段 名称 类型 描述 node_name name 节点名称 phyrds bigint 读物理文件的数目。 phywrts bigint 写物理文件的数目。 phyblkrd bigint 读物理文件块的数目。 phyblkwrt bigint 写物理文件块的数目。 dbid oid 在 分布式数据库 中，当前该值始终为0。 父主题： File

GLOBAL_STATIO_USER_INDEXES GLOBAL_STATIO_USER_INDEXES视图显示各节点的命名空间中所有用户关系表索引的I/O状态信息，如表1所示。 表1 GLOBAL_STATIO_USER_INDEXES字段 名称 类型 描述 node_name name 节点名称。 relid oid 索引的表的OID。 indexrelid oid 该索引的OID。 schemaname name 该索引的模式名。 relname name 该索引的表名。 indexrelname name 索引名称。 idx_blks_read numeric 从索引中读取的磁盘块数。 idx_blks_hit numeric 索引命中缓存数。 父主题： Cache/IO

账本数据库的函数 get_dn_hist_relhash(text, text) 描述：返回指定防篡改用户表的表级数据hash值。该函数仅供分布式节点间调用，所有用户调用均提示权限不足。 参数类型：text 返回值类型：hash16 ledger_hist_check(text, text) 描述：校验指定防篡改用户表的表级数据hash值与其对应历史表hash一致性。 参数类型：text 返回值类型：Boolean 示例： 1 2 3 4 5 6 7 8 9 10 11 --创建schema。 gaussdb=# CREATE SCHEMA ledgernsp WITH BLOCKCHAIN; --创建表。 gaussdb=# CREATE TABLE ledgernsp.tab(a int, b text); --插入数据。 gaussdb=# INSERT INTO ledgernsp.tab values(generate_series(1, 10000), 'test'); gaussdb=# SELECT ledger_hist_check('ledgernsp','tab'); ledger_hist_check ------------------- t (1 row) ledger_hist_repair(text, text) 描述：修复指定防篡改用户表对应的历史表hash值，使之与用户表hash一致，返回hash差值。 参数类型：text 返回值类型：hash16 示例： 1 2 3 4 5 gaussdb=# SELECT ledger_hist_repair('ledgernsp','tab'); ledger_hist_repair -------------------- 0000000000000000 (1 row) ledger_hist_archive(text, text) 描述：归档指定防篡改用户表对应的历史表至审计日志目录中hist_back文件夹下。如果用户历史表名称中带有'/'符号，归档所生成的文件名中将会把'/'替换为'_'。 参数类型：text 返回值类型：Boolean 示例： 1 2 3 4 5 gaussdb=# EXECUTE DIRECT ON (datanode1) 'select pg_catalog.ledger_hist_archive(''ledgernsp'', ''tab'');'; ledger_hist_archive --------------------- t (1 row) ledger_gchain_check(text, text) 描述：校验指定防篡改用户表对应的历史表hash与全局历史表对应的relhash一致性。 参数类型：text 返回值类型：Boolean 示例： 1 2 3 4 5 gaussdb=# SELECT ledger_gchain_check('ledgernsp','tab'); ledger_gchain_check --------------------- t (1 row) ledger_gchain_repair(text, text) 描述：修复指定防篡改用户表在全局历史表中的relhash，使之与其历史表hash一致，返回指定表的hash总和。 参数类型：text 返回值类型：hash16 示例： 1 2 3 4 5 gaussdb=# SELECT ledger_gchain_repair('ledgernsp','tab'); ledger_gchain_repair ---------------------- da30c1260af5be50 (1 row) ledger_gchain_archive(void) 描述：归档全局历史表至审计日志目录中hist_back文件夹下。 参数类型：void 返回值类型：Boolean 示例： 1 2 3 4 5 gaussdb=# SELECT ledger_gchain_archive(); ledger_gchain_archive ----------------------- t (1 row) hash16in(cstring) 描述：将输入16进制字符串转化成内部hash16形式。 参数类型：cstring 返回值类型：hash16 hash16out(hash16) 描述：将内部hash16类型的数据转码转化为16进制cstring类型。 参数类型：hash16 返回值类型：cstring hash32in(cstring) 描述：将输入的16进制字符串(32个字符)转化成内部类型hash32形式。 参数类型：cstring 返回值类型：hash32 hash32out(hash32) 描述：将内部hash32类型的数据转码转化为16进制cstring类型。 参数类型：hash32 返回值类型：cstring 父主题： 函数和操作符

GS_TXN_SNAPSHOT GS_TXN_SNAPSHOT是“时间戳- CS N”映射表，周期性采样，并维护适当的时间范围，用于估算范围内的时间戳对应的CSN值。 表1 GS_TXN_SNAPSHOT字段 名称 类型 描述 snptime timestamp with time zone 快照捕获时间。 snpxmin bigint 快照xmin。 snpcsn bigint 快照csn。 snpsnapshot text 快照序列化文本。 父主题： 其他系统表

PG_POOLER_STATUS PG_POOLER_STATUS视图查询pooler中的缓存连接状态。该视图只能在CN上查询，显示本地CN的pooler模块的连接缓存信息。 表1 PG_POOLER_STATUS字段 名称 类型 描述 database text 数据库名称。 user_name text 用户名。 tid bigint 非线程池逻辑下为连接CN的线程id。 线程池逻辑下为连接CN的sessionid。 node_oid bigint 连接的实例节点OID。 node_name name 连接的实例节点名称。 in_use boolean 连接是否正被使用。 t（true）：表示连接正在使用。 f（false）：表示连接没有使用。 local_host text 本端IP。 local_port bigint 本端端口号。 remote_host text 连接的实例节点IP。 node_port bigint 连接的实例节点端口号。 fdsock bigint 对端socket。 remote_pid bigint 对端处于非线程池逻辑下为对端的线程id，对端处于线程池逻辑下为对端的sessionid。 session_params text 由此连接下发的GUC session参数。 used_count bigint 该连接的复用次数。 idx bigint 连接的实例节点逻辑连接id。 streamid bigint 每个逻辑连接对应的流标识id。 父主题： 通信

ADM_COLL_TYPES ADM_COLL_TYPES视图显示所有集合类型的信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_COLL_TYPES字段 名称 类型 描述 owner character varying(128) 集合的所有者。 type_name character varying(128) 集合的名称。 coll_type character varying(128) 集合的描述。 upper_bound numeric 暂不支持，值为NULL。 elem_type_mod character varying(7) 暂不支持，值为NULL。 elem_type_owner character varying(128) 集合基于的元素类型的所有者。该值主要用于用户定义的类型。 elem_type_name character varying(128) 集合所依据的数据类型或用户定义类型的名称。 length numeric 暂不支持，值为NULL。 precision numeric 暂不支持，值为NULL。 scale numeric 暂不支持，值为NULL。 character_set_name character varying(44) 暂不支持，值为NULL。 elem_storage character varying(7) 暂不支持，值为NULL。 nulls_stored character varying(3) 暂不支持，值为NULL。 char_used character varying(1) 暂不支持，值为NULL。 父主题： 其他系统视图

Psycopg接口参考 Psycopg接口是一套提供给用户的API方法，本节将对部分常用接口做具体描述。 psycopg2.connect() connection.cursor() cursor.execute(query,vars_list) cursor.executemany(query,vars_list) connection.commit() connection.rollback() cursor.fetchone() cursor.fetchall() cursor.close() connection.close() 父主题： 基于Psycopg开发

通用标识符函数 sys_guid() 描述：产生并返回一个全局唯一的标识符，由16个字节组成，生成的标识符有当前机器IP，生成时间戳，随机数生成一个全局唯一的uuid。 参数：无。 返回值类型：raw 示例： 1 2 3 4 5 6 7 8 9 gaussdb=# SET a_format_version='10c'; SET gaussdb=# SET a_format_dev_version='s5'; SET gaussdb=# SELECT sys_guid(); sys_guid ---------------------------------- 9010675E560CB33C1BDAFA163E378F87 (1 row) uuid() 描述：返回一个根据RFC 4122、ISO/IEF 9834-8:2005以及相关标准定义的通用唯一标识符（UUID）。这个标识符是一个小写十六进制数字的字符串，由分字符分成几组，一组8位数字+三组4位数字+一组12位数字，总共32个数字代表128位。 参数：无。 返回值类型：varchar 示例： 1 2 3 4 5 gaussdb=# SELECT uuid(); uuid -------------------------------------- dd8cbe92-1a25-013c-a514-e435c87e9182 (1 row) uuid_short() 描述：返回一个在一定条件下具有唯一性的短通用标识符。这个标识符是一个64位无符号类型的整数。 在满足下列条件时，返回的值是唯一的。 当前集群下的服务节点数不能超过256个。 不能在节点重新启动之间设置服务器主机的系统时间。 在节点重新启动之间平均每秒调用uuid_short() 少于1600万次。 参数：无。 返回值类型：uint64 示例： 1 2 3 4 5 gaussdb=# SELECT uuid_short(); uuid_short -------------------- 100440026956955649 (1 row) 从505.0.0之前的版本升级至最新版本，升级未提交情况下不能使用uuid_short()函数。 父主题： 函数和操作符

PG_STAT_SYS_INDEXES PG_STAT_SYS_INDEXES视图显示pg_catalog、information_schema模式中所有系统表的索引状态信息。 表1 PG_STAT_SYS_INDEXES字段 名称 类型 描述 relid oid 该索引所在的表的OID。 indexrelid oid 索引的OID。 schemaname name 索引的模式名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan bigint 索引上开始的索引扫描数。 idx_tup_read bigint 该索引上扫描返回的索引项数。 idx_tup_fetch bigint 使用该索引的简单索引扫描在原表中抓取的活跃行数。 父主题： 其他系统视图

语法格式 设置外部数据封装属性 ALTER FOREIGN DATA WRAPPER name [ HANDLER handler_function | NO HANDLER ] [ VALIDATOR validator_function | NO VALIDATOR ] [ OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ]) ];

参数说明 name 已有外部数据封装的名称。 HANDLER handler_function 为外部数据封装指定一个新的处理函数。 NO HANDLER 这个参数用来指定外部数据封装不再拥有处理函数。 使用外部数据封装但没有handler的外表不能访问。 VALIDATOR validator_function 为外部数据封装指定一个新的验证函数。 根据新的验证器，外部数据封装器或依赖的服务器、 用户映射或外部表的已经存在的选项是有可能是无效的。用户在使用外部数据封装之前需要保证这些选项是正确的。 不过，ALTER FOREIGN DATA WRAPPER 命令中指定的任何选项都将使用新的验证函数检查。 NO VALIDATOR 这个用来指定外部数据封装不再有验证函数。 OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ] ) 修改外部数据封装的选项。 ADD, SET, 和 DROP 指定表现的动作。如果没有明确指定操作默认是ADD。选项名必须唯一。 使用外部数据封装验证函数时，名字和取值也会被验证。

示例 --创建一个外部数据封装dbi。 gaussdb=# CREATE FOREIGN DATA WRAPPER dbi OPTIONS (bar 'true'); --修改一个外部数据封装dbi，增加选项foo，删除bar。 gaussdb=# ALTER FOREIGN DATA WRAPPER dbi OPTIONS (ADD foo '1', DROP 'bar'); --修改外部数据封装dbi验证器为file_fdw_validator。 gaussdb=# ALTER FOREIGN DATA WRAPPER dbi VALIDATOR file_fdw_validator; --修改外部数据封装dbi处理函数为file_fdw_handler。 gaussdb=# ALTER FOREIGN DATA WRAPPER dbi HANDLER file_fdw_handler;

PG_PLTEMPLATE PG_PLTEMPLATE系统表存储过程语言的“模板”信息。 表1 PG_PLTEMPLATE字段 名称 类型 描述 tmplname name 这个模板所应用的语言的名称。 tmpltrusted boolean 如果语言被认为是可信的，则为真。否则为假。 tmpldbacreate boolean 如果语言是由数据库所有者创建的，则为真。否则为假。 tmplhandler text 调用处理器函数的名称。 tmplinline text 匿名块处理器的名称，若没有则为NULL。 tmplvalidator text 校验函数的名称，如果没有则为NULL。 tmpllibrary text 实现语言的共享库的路径。 tmplacl aclitem[] 模板的访问权限（未使用）。 父主题： 其他系统表

STATIO_SYS_SEQUEN CES STATIO_SYS_SEQUENCES显示命名空间中所有系统序列的I/O状态信息，如表1所示。 表1 STATIO_SYS_SEQUENCES字段 名称 类型 描述 relid oid 序列OID。 schemaname name 序列中模式名。 relname name 序列名。 blks_read bigint 从序列中读取的磁盘块数。 blks_hit bigint 序列中缓存命中数。 父主题： Cache/IO

STATEMENT 获得当前节点的执行语句（归一化SQL）的信息，如表1所示。数据库主节点上可以看到此数据库主节点接收到的归一化的SQL的全量统计信息（包含数据库节点）；数据库节点上仅可看到归一化的SQL的此节点执行的统计信息。多租场景下，non-PDB访问该视图时返回全部信息，PDB访问该视图时仅返回该PDB相关信息。 不同的savepoint_name所生成的unique_sql_id不同，大量使用savepoint_name时会导致系统中产生的unique_sql_id信息快速上涨，若unique_sql_id数量高于instr_unique_sql_count数量时，新产生的unique_sql_id信息将不被统计。 当前版本暂不支持对FOR UPDATE关键字进行识别并归一化处理。例如：SELECT * FROM table; 与SELECT * FROM table FOR UPDATE WAIT N; 会被归一化处理为相同的归一化SQL，在query字段中体现。 表1 STATEMENT字段 名称 类型 描述 node_name name 节点名称。 node_id integer 节点的id。 user_name name 用户名称。 user_id oid 用户OID。 unique_sql_id bigint 归一化的SQL id。 query text 归一化的SQL。 备注：长度受track_activity_query_size控制。 n_calls bigint 调用次数。 min_elapse_time bigint SQL在内核内的最小运行时间（单位：微秒）。 max_elapse_time bigint SQL在内核内的最大运行时间（单位：微秒）。 total_elapse_time bigint SQL在内核内的总运行时间（单位：微秒）。 n_returned_rows bigint SELECT返回的结果集行数。 n_tuples_fetched bigint 随机扫描行。 n_tuples_returned bigint 顺序扫描行。 n_tuples_inserted bigint 插入行。 n_tuples_updated bigint 更新行。 n_tuples_deleted bigint 删除行。 n_blocks_fetched bigint 逻辑读次数。 n_blocks_hit bigint 内存中命中次数。 n_soft_parse bigint 软解析次数，n_soft_parse + n_hard_parse可能大于n_calls，因为子查询未计入n_calls。 n_hard_parse bigint 硬解析次数，n_soft_parse + n_hard_parse可能大于n_calls，因为子查询未计入n_calls。 db_time bigint 有效的数据库内部时间花费，多线程将累加（单位：微秒）。 cpu_time bigint CPU时间（单位：微秒）。 execution_time bigint 执行器内执行时间（单位：微秒）。 parse_time bigint SQL解析时间（单位：微秒）。 plan_time bigint SQL生成计划时间（单位：微秒）。 rewrite_time bigint SQL重写时间（单位：微秒）。 pl_execution_time bigint plpgsql上的执行时间（单位：微秒）。 pl_compilation_time bigint plpgsql上的编译时间（单位：微秒）。 data_io_time bigint IO上的时间花费（单位：微秒）。 net_send_info text 通过物理连接发送消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 net_recv_info text 通过物理连接接收消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 net_stream_send_info text 通过逻辑连接发送消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 net_stream_recv_info text 通过逻辑连接接收消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 last_updated timestamp with time zone 最后一次更新该语句的时间。 sort_count bigint 排序执行的次数。 sort_time bigint 排序执行的时间（单位：微秒）。 sort_mem_used bigint 排序过程中使用的work memory大小（单位：KB）。 sort_spill_count bigint 排序过程中，若发生落盘，写文件的次数。 sort_spill_size bigint 排序过程中，若发生落盘，使用的文件大小（单位：KB）。 hash_count bigint hash执行的次数。 hash_time bigint hash执行的时间（单位：微秒）。 hash_mem_used bigint hash过程中使用的work memory大小（单位：KB）。 hash_spill_count bigint hash过程中，若发生落盘，写文件的次数。 hash_spill_size bigint hash过程中，若发生落盘，使用的文件大小（单位：KB）。 parent_unique_sql_id bigint 父语句的unique_sql_id，非存储过程子语句该值为0。 lock_wait_time bigint SQL的等锁时间（单位：微秒）。 total_used_memory bigint 归一化语句的内存使用总量（单位：MB）。 max_used_memory integer 单条语句的最大内存使用量（单位：MB）。 min_used_memory integer 单条语句的最小内存使用量（单位：MB）。 db_name name 连接后端的数据库名称。 db_id oid 连接后端的数据库OID。 n_calls表示实际调用次数，对于存储过程内的fetch语句，fetch语句的实际触发次数，对应该cursor实际执行的语句的n_calls的增加次数。 父主题： Query

示例 --创建表。 gaussdb=# CREATE TABLE my_table (c1 int, c2 int) WITH(STORAGE_TYPE=ASTORE); --创建名为my_mv的物化视图。 gaussdb=# CREATE MATERIALIZED VIEW my_mv AS SELECT * FROM my_table; --删除名为my_mv的物化视图。 gaussdb=# DROP MATERIALIZED VIEW my_mv; --删除表。 gaussdb=# DROP TABLE my_table;

参数 表1 SQLConnect参数 关键字 参数说明 ConnectionHandle 连接句柄，通过SQLAllocHandle获得。 ServerName 要连接数据源的名称。 NameLength1 ServerName的长度。 UserName 数据源中数据库用户名。 NameLength2 UserName的长度。 Authentication 数据源中数据库用户密码。 NameLength3 Authentication的长度。