华为云用户手册

示例 EXEC SQL SET DESCRIPTOR indesc COUNT = 1; EXEC SQL SET DESCRIPTOR indesc VALUE 1 DATA = 2; EXEC SQL SET DESCRIPTOR indesc VALUE 1 DATA = :val1; EXEC SQL SET DESCRIPTOR indesc VALUE 2 INDICATOR = :val1, DATA = 'some string'; EXEC SQL SET DESCRIPTOR indesc VALUE 2 INDICATOR = :val2null, DATA = :val2;

PV_SESSION_MEMORY_CONTEXT PV_SESSION_MEMORY_CONTEXT视图显示所有会话的内存使用情况，以MemoryContext节点来统计。该视图仅在开启线程池（enable_thread_pool = on）时生效。 其中内存上下文“TempSmallContextGroup”，记录当前线程中所有内存上下文字段“totalsize”小于8192字节的信息汇总，并且内存上下文统计计数记录到“usedsize”字段中。所以在视图中，“TempSmallContextGroup”内存上下文中的“totalsize”和“freesize”是该线程中所有内存上下文“totalsize”小于8192字节的汇总总和，“usedsize”字段表示统计的内存上下文个数。具体字段信息如表1所示。 表1 PV_SESSION_MEMORY_CONTEXT字段 名称 类型 描述 sessid text 会话启动时间+会话标识（字符串信息为timestamp.sessionid）。 threadid bigint 会话绑定的线程标识，如果未绑定线程，该值为-1。 contextname text 内存上下文名称。 level smallint 当前上下文在整体内存上下文中的层级。 parent text 父内存上下文名称。 totalsize bigint 当前内存上下文的内存总数，单位Byte。 freesize bigint 当前内存上下文中已释放的内存总数，单位Byte。 usedsize bigint 当前内存上下文中已使用的内存总数，单位Byte；“TempSmallContextGroup”内存上下文中该字段含义为统计计数。 该视图为运维视图，用于定位内存问题时使用，不要并发查询该视图，并发查询该视图会随着并发数的增多导致新连接接入等待时间增加，长时间无法接入。 父主题： 其他系统视图

示例 注：示例1和示例2选择其一。 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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 import java.sql.Connection; import java.sql.DriverManager; import java.util.Properties; public class SSL{ public static void main(String[] args) { Properties urlProps = new Properties(); String urls = "jdbc:gaussdb://$ip:$port/database"; String userName = System.getenv("EXAMPLE_USERNAME_ENV"); String password = System.getenv("EXAMPLE_PASSWORD_ENV"); /** * ================== 示例1 使用NonValidatingFactory通道 */ urlProps.setProperty("sslfactory","com.huawei.gaussdb.jdbc.ssl.NonValidatingFactory"); urlProps.setProperty("user", userName); urlProps.setProperty("password", password); urlProps.setProperty("ssl", "true"); /** * ================== 示例2 使用证书 */ urlProps.setProperty("sslcert", "client.crt"); urlProps.setProperty("sslkey", "client.key.pk8"); urlProps.setProperty("sslrootcert", "cacert.pem"); urlProps.setProperty("user", userName); urlProps.setProperty("password", password); urlProps.setProperty("ssl", "true"); /* sslmode可配置为：require、verify-ca、verify-full，以下三个示例选择其一*/ /* ================== 示例2.1 设置sslmode为require，使用证书 */ urlProps.setProperty("sslmode", "require"); /* ================== 示例2.2 设置sslmode为verify-ca，使用证书 */ urlProps.setProperty("sslmode", "verify-ca"); /* ================== 示例2.3 设置sslmode为verify-full，使用证书（Linux下验证） */ urls = "jdbc:gaussdb://world:8000/database"; urlProps.setProperty("sslmode", "verify-full"); try { Class.forName("com.huawei.gaussdb.jdbc.Driver").newInstance(); } catch (Exception e) { e.printStackTrace(); } try { Connection conn; conn = DriverManager.getConnection(urls,urlProps); conn.close(); } catch (Exception e) { e.printStackTrace(); } } } /** * 注：将客户端密钥转化为DER格式: * openssl pkcs8 -topk8 -outform DER -in client.key -out client.key.pk8 -nocrypt * openssl pkcs8 -topk8 -inform PEM -in client.key -outform DER -out client.key.der -v1 PBE-MD5-DES * openssl pkcs8 -topk8 -inform PEM -in client.key -outform DER -out client.key.der -v1 PBE-SHA1-3DES * 以上算法由于安全级别较低，不推荐使用。 * 如果客户需要采用更高级别的私钥加密算法，启用bouncycastle或者其他第三方私钥解密密码包后可以使用的私钥加密算法如下： * openssl pkcs8 -in client.key -topk8 -outform DER -out client.key.der -v2 AES128 * openssl pkcs8 -in client.key -topk8 -outform DER -out client.key.der -v2 aes-256-cbc -iter 1000000 * openssl pkcs8 -in client.key -topk8 -out client.key.der -outform Der -v2 aes-256-cbc -v2prf hmacWithSHA512 * 启用bouncycastle：使用jdbc的项目引入依赖：bcpkix-jdk15on.jar包，版本建议：1.65以上。 */ JDBC使用SSL方式建立连接时，会在客户端获取强随机数，建立连接过程中可能出现下图中的报错信息。 原因在于客户端环境随机数产生的速度太慢，无法满足产品要求，熵源不足，导致服务启动失败。当前已知在一些Linux环境中存在此问题。 建议处理方案：启动客户端环境中的haveged服务，增加系统熵池熵值以提高读取随机数的速度。启动命令为： systemctl start haveged

ROLE_ROLE_PRIVS ROLE_ROLE_PRIVS视图显示授予其他角色的角色，仅提供用户有权访问的角色的信息。默认所有用户都可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ROLE_ROLE_PRIVS字段 名称 类型 描述 role character varying(128) 角色名称。 granted_role character varying(128) 被授予的角色。 admin_option character varying(3) 该授权是否包含ADMIN选项。 YES：包含ADMIN选项。 NO：不包含ADMIN选项。 common character varying(3) 暂不支持，值为NULL。 inherited character varying(3) 暂不支持，值为NULL。 父主题： 用户和权限管理

USER_TRANSACTION USER_TRANSACTION用来统计用户执行的事务信息，如表1所示。monadmin用户能看到所有用户执行事务的信息。 表1 USER_TRANSACTION字段 名称 类型 描述 username name 用户的名称。 commit_counter bigint 用户事务commit数量。 rollback_counter bigint 用户事务rollback数量。 resp_min bigint 用户事务最小响应时间（单位：微秒）。 resp_max bigint 用户事务最大响应时间（单位：微秒）。 resp_avg bigint 用户事务平均响应时间（单位：微秒）。 resp_total bigint 用户事务总响应时间（单位：微秒）。 bg_commit_counter bigint 后台事务commit数量。 bg_rollback_counter bigint 后台事务rollback数量。 bg_resp_min bigint 后台事务最小响应时间（单位：微秒）。 bg_resp_max bigint 后台事务最大响应时间（单位：微秒）。 bg_resp_avg bigint 后台事务平均响应时间（单位：微秒）。 bg_resp_total bigint 后台事务总响应时间（单位：微秒）。 父主题： Workload

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。 父主题： 错误处理

存储过程 商业规则和业务逻辑可以通过程序存储在GaussDB中，这个程序就是存储过程。 存储过程是SQL、PL/SQL和Java语句的组合。存储过程使执行商业规则的代码可以从应用程序中移动到数据库。从而，代码存储一次能够被多个程序使用。 存储过程的创建及调用办法请参考CREATE PROCEDURE。 PL/SQL语言函数节所提到的PL/SQL语言创建的函数与存储过程的应用方法相通。下面各节中，除非特别声明，否则内容通用于存储过程和PL/SQL语言函数。 父主题： 存储过程

STATIO_SYS_INDEXES STATIO_SYS_INDEXES显示命名空间中所有系统表索引的I/O状态信息，如表1所示。 表1 STATIO_SYS_INDEXES字段 名称 类型 描述 relid oid 索引的表的OID。 indexrelid oid 该索引的OID。 schemaname name 该索引的模式名。 relname name 该索引的表名。 indexrelname name 索引名称。 idx_blks_read bigint 从索引中读取的磁盘块数。 idx_blks_hit bigint 索引命中缓存数。 last_updated timestamp with time zone 视图中该对象监控数据最后一次更新的时间。 父主题： Cache/IO

参数说明 mv_name 要创建的物化视图的名称（可以被模式限定）。 取值范围：字符串，要符合标识符命名规范。 column_name 新物化视图中的一个列名。物化视图支持指定列，指定列需要和后面的查询语句结果的列在数量上保持一致；如果没有提供列名，会从查询的输出列名中获取列名。 取值范围：字符串，要符合标识符命名规范。 WITH ( storage_parameter [= value] [, ... ] ) 该子句为表或索引指定一个可选的存储参数。详见CREATE TABLE。 TABLESPACE tablespace_name 指定新建物化视图所属表空间。如果没有声明，将使用默认表空间。 AS query 一个SELECT、TABLE或者VALUES命令。这个查询将在一个安全受限的操作中运行。

示例 --修改默认表类型。 gaussdb=# set enable_default_ustore_table=off; --创建表空间。 gaussdb=# CREATE TABLESPACE tbs_data1 RELATIVE LOCATION 'tablespace1/tbs_data1'; --创建一个普通表。 gaussdb=# CREATE TABLE my_table (c1 int, c2 int); --创建全量物化视图。 gaussdb=# CREATE MATERIALIZED VIEW my_mv TABLESPACE tbs_data1 AS SELECT * FROM my_table; --基表写入数据。 gaussdb=# INSERT INTO my_table VALUES(1,1),(2,2); --查询全量物化视图。 gaussdb=# SELECT * FROM my_mv; c1 | c2 ----+---- (0 rows) --对全量物化视图my_mv进行全量刷新。 gaussdb=# REFRESH MATERIALIZED VIEW my_mv; --查询全量物化视图。 gaussdb=# SELECT * FROM my_mv; c1 | c2 ----+---- 1 | 1 2 | 2 (2 rows) --删除全量物化视图。 gaussdb=# DROP MATERIALIZED VIEW my_mv; --删除普通表my_table。 gaussdb=# DROP TABLE my_table; --删除表空间。 gaussdb=# DROP TABLESPACE tbs_data1;

NLS_INSTANCE_PARAMETERS NLS_INSTANCE_PARAMETERS列出数据库客户端的永久NLS参数。该视图同时存在于PG_CATALOG和SYS Schema下。所有用户都可以访问。由于数据库内核不同、参数的设置格式不同等原因，该视图对相同参数的查询结果中可能会和ORA数据库有明显差异。具体字段信息如表1所示。 表1 NLS_INSTANCE_PARAMETERS字段 名称 类型 描述 parameter character varying(128) 参数名。 value character varying(64) 参数值。 父主题： 其他系统视图

DBE_PLDEBUGGER.backtrace server端因为存储过程报错断住，可以在debug端调用error_backtrace，查看当前的函数调用堆栈（限制报错断住时使用），如表1所示。 表1 error_backtrace返回值列表 名称 类型 描述 frameno OUT integer 调用栈编号。 funcname OUT text 函数名。 lineno OUT integer 行号。 query OUT text 断点内容。 funcoid OUT oid 函数oid。 父主题： DBE_PLDEBUGGER Schema

GLOBAL_GS_SEG_EXTENTS GLOBAL_GS_SEG_EXTTENTS在CN上执行，查看所有节点所有表空间的扩展信息。该视图输出用户段对象的所有扩展，包含1号文件中的segment head、fork head、level1 page，2~5号文件中的data extent。只支持管理员权限用户查询。 表1 GLOBAL_GS_SEG_EXTTENTS字段 名称 类型 描述 node_name text 节点名称。 tablespace_name name 段对象所属的表空间。 bucketnode integer 0~1023表示hashbucket表的bucketnode。 1024表示段页式普通表的bucketnode。 1025表示段页式全局临时表的bucketnode。 1026表示段页式unlogged表的bucketnode。 1027表示段页式本地临时表的bucketnode。 head_block_id bigint 段头页面号。 extent_id integer 逻辑扩展号。 file_id integer 扩展所在的数据文件标识。 forknum integer 段对象的分支。取值范围： 0表示main。 1表示fsm。 2表示vm。 block_id bigint 扩展所在的数据文件中的起始页面号。 blocks integer 扩展大小。取值：1，8，128，1024，4096。 usage_type text 扩展的使用类型。取值范围： segment head表示段头。 fork head表示分支头。 level1 page表示level页面。 data extent表示数据扩展。 父主题： 段页式存储

Global SysCache特性函数 gs_gsc_table_detail(database_id default NULL, rel_id default NULL) 描述：查看数据库里全局系统缓存的表元数据。调用该函数的用户需要具有SYSADMIN权限。 参数：指定需要查看全局系统缓存的数据库和表，database_id默认值NULL或者-1表示所有的数据库，0表示共享表，其他数字表示指定数据库及共享表，rel_id表示指定表的oid，默认值NULL或者-1表示所有的表，其他值表示指定的表，database_id不存在会报错，rel_id 不存在查询结果为空。 返回值类型：Tuple gaussdb=# 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_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不存在结果为空。 返回值类型：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不存在会报错。 返回值类型：Boolean 示例： gaussdb=# SELECT * FROM gs_gsc_clean(); gs_gsc_clean -------------- t (1 row) 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不存在会报错。 返回值类型：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) 父主题： 函数和操作符

PG_FOREIGN_DATA_WRAPPER PG_FOREIGN_DATA_WRAPPER系统表存储外部数据封装器定义。一个外部数据封装器是在外部服务器上驻留外部数据的机制，是可以访问的。 表1 PG_FOREIGN_DATA_WRAPPER字段 名称 类型 引用 描述 oid oid - 行标识符（隐含字段，必须明确选择）。 fdwname name - 外部数据封装器名。 fdwowner oid PG_AUTHID.oid 外部数据封装器的所有者。 fdwhandler oid PG_PROC.oid 引用一个负责为外部数据封装器提供扩展例程的处理函数。如果没有提供处理函数则为零。 fdwvalidator oid PG_PROC.oid 引用一个验证器函数，这个验证器函数负责验证给予外部数据封装器的选项、外部服务器选项和使用外部数据封装器的用户映射的有效性。如果没有提供验证器函数则为零。 fdwacl aclitem[] - 访问权限。 fdwoptions text[] - 外部数据封装器指定选项，使用“keyword=value”格式的字符串。 父主题： 其他系统表

PG_LANGUAGE PG_LANGUAGE系统表登记编程语言，用户可以用这些语言或接口写函数或者存储过程。 表1 PG_LANGUAGE字段 名称 类型 引用 描述 oid oid - 行标识符（隐含字段；必须明确选择）。 lanname name - 语言的名称。 lanowner oid PG_AUTHID.oid 语言的所有者。 lanispl boolean - true：表示用户定义的语言。 false：表示内部语言，比如SQL。 目前，gs_dump仍然使用该字段判断哪种语言需要转储，但是这些可能在将来被其它机制取代。 lanpltrusted boolean - true：这是可信语言，意味着系统相信它不会被授予任何正常SQL执行环境之外的权限。 false：这是不可信语言。只有初始用户可以用不可信语言创建函数。 lanplcallfoid oid PG_PROC.oid 对于非内部语言，这是指向该语言处理器的引用，语言处理器是一个特殊函数， 负责执行以某种语言写的所有函数。 laninline oid PG_PROC.oid 这个字段引用一个负责执行“inline”匿名代码块的函数（DO块）。如果不支持内联块则为零。 lanvalidator oid PG_PROC.oid 这个字段引用一个语言校验器函数，它负责检查新创建的函数的语法和有效性。如果没有提供校验器，则为零。 lanacl aclitem[] - 访问权限。 父主题： 其他系统表

ADM_TAB_COLS ADM_TAB_COLS视图显示表和视图列的相关信息。数据库中每个表和视图的每一个字段在ADM_TAB_COLS里各有一行对应的数据。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。该视图与ADM_TAB_COLUMNS视图显示行数相同，仅存在字段差异。 表1 ADM_TAB_COLS字段 名称 类型 描述 owner character varying(64) 表或视图的所有者。 table_name character varying(128) 表或视图的名称。 column_name character varying(128) 列名。 data_type character varying(128) 列的数据类型，可以是用户自定义的数据类型。 data_type_mod character varying(3) 暂不支持，值为NULL。 data_type_owner character varying(128) 列的数据类型的所有者。 data_length numeric 列的字节长度。 data_precision numeric 数据类型的精度。对于numeric数据类型有效，其他类型为NULL。 data_scale numeric 小数点右边的位数。对于numeric数据类型有效，其他类型为0。 nullable character varying(1) 该列是否允许为空。对于主键约束和非空约束，该值为n。 column_id numeric 创建表时列的序号。 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) 暂不支持。 B：varchar，nvarchar2，bpchar，char类型。 NULL：其余类型。 v80_fmt_image character varying(3) 暂不支持，值为NULL。 data_upgraded character varying(3) 暂不支持，值为YES。 hidden_column character varying(3) 暂不支持，值为NULL。 virtual_column character varying 列是否为虚拟列（即生成列）： YES：是。 NO：不是。 segment_column_id numeric 暂不支持，值为NULL。 internal_column_id numeric 列的内部序列号，内容同COLUMN_ID。 histogram character varying(15) 直方图是否存在以及存在的类型： NONE：不存在直方图。 FREQUENCY：频率直方图。 EQUI_WIDTH：等宽直方图。 qualified_col_name character varying(64) 限定列名，同COLUMN_NAME。 user_generated character varying(3) 暂不支持，值为YES。 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) 列的排序规则。因该字段与保留关键字冲突，调用该字段需加视图名。 collated_column_id numeric 暂不支持，值为NULL。 schema character varying(64) 列所属的名称空间的名称。 父主题： 其他系统视图

DBE_SQL_UTIL.create_hint_sql_patch create_hint_sql_patch是用于创建调优SQL PATCH的接口函数，返回执行是否成功。本函数是原函数的重载函数，支持通过parent_unique_sql_id值限制hint patch的生效范围，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.create_hint_sql_patch重载函数入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 unique_sql_id IN bigint 查询全局唯一id。 parent_unique_sql_id IN bigint 标识外层SQL语句的全局唯一id，值为0时表示限制存储过程外语句SQL PATCH生效；非0值表示限制特定存储过程生效。 hint_string IN text Hint文本。 description IN text PATCH的备注，默认值为NULL。 enabled IN bool PATCH是否生效，默认值为true。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

MEMORY_NODE_NG_DETAIL nodegroup内存使用情况，如表1所示。 表1 MEMORY_NODE_NG_DETAIL字段 名称 类型 描述 ngname text node group名称。 memorytype text 内存使用的名称： ng_total_memory：node group中设置的总内存。 ng_used_memory：已经用的内存。 ng_estimate_memory：优化器评估已经用的内存。 ng_foreignrp_memsize：外部资源池设置的内存大小。 ng_foreignrp_usedsize：外部资源池当前已用内存。 ng_foreignrp_peaksize：外部资源池已使用的内存峰值。 ng_foreignrp_mempct：外部资源池属性中设置的占用系统总内存的百分比。 ng_foreignrp_estmsize：外部资源池执行作业优化器评估的内存使用。 memorymbytes integer 内存使用的大小（单位：MB）。 父主题： Memory

高性能场景 某客户对于相同sql可能多次执行，仅是传参不同的情况，为了提升执行效率，可开启prepareThreshold参数，避免重复生成执行计划，url可参考如下命令进行配置。 jdbc:gaussdb://node1/database?prepareThreshold=5 某客户一次查询1000万数据，为避免同时返回造成内存溢出，可使用defaultRowFetchSize，url可参考如下命令进行配置。 jdbc:gaussdb://node1/database?defaultRowFetchSize=50000 某客户需要批量插入1000万数据，为提升效率，可使用batchMode，url可参考如下命令进行配置。 jdbc:gaussdb://node1/database?batchMode=on

容灾场景 某客户有两套数据库集群，其中A集群为生产集群，B集群为容灾集群。当客户执行容灾切换时，A集群将降为容灾集群，B集群将升为生产集群。此时为了避免修改配置文件导致的应用重启或重新发版，客户可在初始配置文件时，即将A、B集群写入连接串中。此时在主集群不可连接时，驱动将尝试对容灾集群建连。例如A集群为{node1,node2,node3}。B集群为{node4,node5,node6}。 以Dorado双集群为例，url可参考如下配置进行设置，当主备切换后只会连接新的主集群。 jdbc:gaussdb://node1,node2,node3,node4,node5,node6/database

负载均衡场景 某客户存在一套数据库集群，包含如下节点{node1,node2,node3,node4,node5,node6,node7,node8,node9,node10,node11,node12}。 客户在应用程序A中建立了120个长连接，并期望应用程序A上的连接可以均匀分布在当前集群各节点上，则url可参考如下命令进行配置。 jdbc:gaussdb://node1,node2,node3/database?autoBalance=true 客户新开发了两个应用程序B、C，希望当前这三个应用程序均匀分布在指定节点，如应用程序A的连接分布在{node1,node2,node3,node4}，应用程序B的连接分布在{node5,node6,node7,node8}，应用程序C的连接分布在{node9,node10,node11,node12}；则url可参考如下命令进行配置（若url中前四个节点都不可连，应用会连接第五个节点，根据pgxc_node表中的信息，在集群中所有可用节点之间进行轮询连接）。 应用程序A：jdbc:gaussdb://node1,node2,node3,node4,node5/database?autoBalance=priority4 应用程序B：jdbc:gaussdb://node5,node6,node7,node8,node9/database?autoBalance=priority4 应用程序C：jdbc:gaussdb://node9,node10,node11,node12,node1/database?autoBalance=priority4 客户开发了一些应用程序，并且使用相同的连接配置串，同时期望各应用连接能较均匀的分布在集群各节点上，则url可参考如下命令进行配置。 jdbc:gaussdb://node1,node2,node3,node4/database?autoBalance=shuffle 客户开发了一些应用程序，想通过单节点会话模式建立连接，则url可参考如下命令进行配置。 jdbc:gaussdb://node1,node2,node3,node4/database?sessionType=singleNode&execTargetNode=your_dn_name 客户不想要使用负载均衡功能，则url可参考如下命令进行配置。 jdbc:gaussdb://node1/database 或： jdbc:gaussdb://node1/database?autoBalance=false 在开启autoBalance参数时，JDBC刷新可用CN列表的周期默认为10S，可使用refreshCNIpListTime进行设置，示例如下： jdbc:gaussdb://node1,node2,node3,node4/database?autoBalance=true&refreshCNIpListTime=3

连接数据库（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开发

SQL语法格式说明 表1 SQL语法格式说明 格式 意义 [ ] 表示用“[ ]”括起来的部分是可选的。 ... 表示前面的元素可重复出现。 [ x | y | ... ] 表示从两个或多个选项中选取一个或者不选。 { x | y | ... } 表示从两个或多个选项中选取一个。 [x | y | ... ] [ ... ] 表示可选多个参数或者不选，如果选择多个参数，则参数之间用空格分隔。 [ x | y | ... ] [ ,... ] 表示可选多个参数或者不选，如果选择多个参数，则参数之间用逗号分隔。 { x | y | ... } [ ... ] 表示可选多个参数，至少选一个，如果选择多个参数，则参数之间以空格分隔。 { x | y | ... } [ ,... ] 表示可选多个参数，至少选一个，如果选择多个参数，则参数之间用逗号分隔。 父主题： SQL语法

ADM_VIEWS ADM_VIEWS视图显示数据库中的视图信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_VIEWS字段 名称 类型 描述 owner character varying(64) 视图的所有者。 view_name character varying(64) 视图名称。 text text 视图文本。 text_length integer 视图文本长度。 text_vc character varying(4000) 视图创建语句。此列可能会截断视图文本。BEQUEATH子句将不会作为此视图中的TEXT_VC列的一部分出现。 type_text_length numeric 暂不支持，值为NULL。 type_text character varying(4000) 暂不支持，值为NULL。 oid_text_length numeric 暂不支持，值为NULL。 oid_text character varying(4000) 暂不支持，值为NULL。 view_type_owner character varying(128) 暂不支持，值为NULL。 view_type character varying(128) 暂不支持，值为NULL。 superview_name character varying(128) 暂不支持，值为NULL。 editioning_view character varying(1) 暂不支持，值为NULL。 read_only character varying(1) 暂不支持，值为NULL。 container_data character varying(1) 暂不支持，值为NULL。 bequeath character varying(12) 暂不支持，值为NULL。 origin_con_id character varying(256) 暂不支持，值为NULL。 default_collation character varying(100) 暂不支持，值为NULL。 containers_default character varying(3) 暂不支持，值为NULL。 container_map character varying(3) 暂不支持，值为NULL。 extended_data_link character varying(3) 暂不支持，值为NULL。 extended_data_link_map character varying(3) 暂不支持，值为NULL。 has_sensitive_column character varying(3) 暂不支持，值为NULL。 admit_null character varying(3) 暂不支持，值为NULL。 pdb_local_only character varying(3) 暂不支持，值为NULL。 父主题： 其他系统视图

MY_PROCEDURES MY_PROCEDURES视图描述了当前用户拥有的存储过程、函数或触发器的信息。该视图同时存在于PG_CATALOG和SYS Schema下。该视图所有用户可访问，仅可查看当前用户所属信息。具体字段信息如表1所示。 表1 MY_PROCEDURES字段 名称 类型 描述 owner character varying(64) 存储过程、函数、触发器或包的所有者。 object_name character varying(64) 存储过程、函数或触发器的名称，若为包中函数或存储过程，则为包名。 procedure_name character varying(128) 若object_name为包名，则为包中函数或存储过程名称，否则为空。 object_id oid 存储过程、函数、触发器或包的OID。 subprogram_id numeric 包中函数或存储过程的位置。 overload character varying(40) 表示该函数是该名称的第n个重载函数。 object_type character varying(13) 对象的类型。 aggregate character varying(3) 表示是否为聚合函数： YES：表示是。 NO：表示不是。 pipelined character varying(3) 暂不支持，值为NO。 impltypeowner character varying(128) 实现类型的所有者。 impltypename character varying(128) 实现类型的名称。 parallel character varying(3) 暂不支持，值为NO。 interface character varying(3) 暂不支持，值为NO。 deterministic character varying(3) 暂不支持，值为NO。 authid character varying(12) 表示是使用创建者权限还是调用者权限： DEFINER：表示使用创建者权限。 CURRENT_USER：表示使用调用者权限。 因该字段与保留关键字冲突，调用该字段需加视图名。 result_cache character varying(3) 暂不支持，值为NULL。 origin_con_id character varying(256) 暂不支持，值为0。 polymorphic character varying(5) 暂不支持，值为NULL。 argument_number smallint 存储过程入参个数。 父主题： 其他系统视图

功能描述 创建一个视图。视图与基本表不同，是一个虚拟的表。数据库中仅存放视图的定义，而不存放视图对应的数据，这些数据仍存放在原来的基本表中。若基本表中的数据发生变化，从视图中查询出的数据也随之改变。从这个意义上讲，视图就像一个窗口，透过它可以看到数据库中用户感兴趣的数据及变化。 将经常使用的数据定义为视图，可以将复杂的查询SQL语句进行封装。简化操作。 安全性，用户只能查询视图定义的数据。隐藏基表字段，保护数据库的数据结构。 简化用户权限的管理，只授予用户使用视图的权限。

参数说明 OR REPLACE 可选。如果视图已存在，则重新定义。 TEMP | TEMPORARY 可选。创建一个临时视图。在当前会话结束时会自动删除掉视图。如果视图引用的任何表是临时表，视图将被创建为临时视图（不管SQL中有没有指定TEMP|TEMPORARY）。 view_name 要创建的视图名称。可以用模式修饰。 取值范围：字符串，符合标识符命名规范。 column_name 可选的名称列表，用作视图的字段名。如果没有给出，字段名取自查询中的字段名。 取值范围：字符串，符合标识符命名规范。 view_option_name [= view_option_value] 该子句为视图指定一个可选的参数。 目前view_option_name支持的参数仅有security_barrier和check_option。 security_barrier：当VIEW视图提供行级安全时，应使用该参数。取值范围：Boolean类型（true、false）。 check_option：控制更新视图的行为。取值范围：CASCADED、LOCAL。 query 为视图提供行和列的SELECT或VALUES语句。 若query包含指定分区表分区的子句，创建视图会将所指定分区的OID固化到系统表中。如果使用导致指定分区的OID发生变更的分区DDL语法，如DROP/SPLIT/MERGE该分区，则会导致视图不可用。需要重新创建视图。

语法格式 1 2 3 4 CREATE [ OR REPLACE ] [ TEMP | TEMPORARY ] VIEW view_name [ ( column_name [, ...] ) ] [ WITH ( {view_option_name [= view_option_value]} [, ... ] ) ] AS query [ WITH [ CASCADED | LOCAL ] CHECK OPTION | WITH READ ONLY ]; 创建视图时使用WITH(security_barrier)可以创建一个相对安全的视图，避免攻击者利用低成本函数的RAISE语句打印出基表数据。 当视图创建后，不允许使用REPLACE修改本视图当中的列名，也不允许删除列。

ADM_SEGMENTS ADM_SEGMENTS视图显示数据库中所有段分配的存储空间。同时存在于PG_CATALOG和SYS Schema下。仅系统管理员可访问。信息无法通过系统表获取。该视图为空视图。 表1 ADM_SEGMENTS字段 名称 类型 描述 owner character varying(128) 暂不支持，值为NULL。 segment_name character varying(128) 暂不支持，值为NULL。 partition_name character varying(128) 暂不支持，值为NULL。 segment_type character varying(18) 暂不支持，值为NULL。 segment_subtype character varying(10) 暂不支持，值为NULL。 tablespace_name character varying(30) 暂不支持，值为NULL。 header_file numeric 暂不支持，值为NULL。 header_block numeric 暂不支持，值为NULL。 bytes numeric 暂不支持，值为NULL。 blocks numeric 暂不支持，值为NULL。 extents numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extents numeric 暂不支持，值为NULL。 max_extents numeric 暂不支持，值为NULL。 max_size numeric 暂不支持，值为NULL。 retention character varying(7) 暂不支持，值为NULL。 minretention numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 relative_fno numeric 暂不支持，值为NULL。 buffer_pool character varying(7) 暂不支持，值为NULL。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 inmemory character varying(8) 暂不支持，值为NULL。 inmemory_priority character varying(8) 暂不支持，值为NULL。 inmemory_distribute character varying(15) 暂不支持，值为NULL。 inmemory_duplicate character varying(13) 暂不支持，值为NULL。 inmemory_compression character varying(17) 暂不支持，值为NULL。 cellmemory character varying(24) 暂不支持，值为NULL。 父主题： 其他系统视图