华为云用户手册

define和undef指令 嵌入式 SQL具有类似于C语言中#define指令： EXEC SQL DEFINE name; EXEC SQL DEFINE name value; EXEC SQL UNDEF name; 示例如下： /* 定义名称 */ EXEC SQL DEFINE HAVE_FEATURE; /* 定义常量 */ EXEC SQL DEFINE MYNUMBER 12; EXEC SQL DEFINE MYSTRING 'abc'; /* 使用 UNDEF 移除定义 */ EXEC SQL UNDEF MYNUMBER; 在嵌入式SQL程序中也可以使用C语言版本的#define和#undef。区别在于定义的值会在哪里被计算，如果使用EXEC SQL DEFINE，那么ecpg预处理阶段会计算这些定义并替换值。如下示例，ecpg对其进行替换并且编译器不会解析名为MYNUMBER的任何名称或标识符： EXEC SQL DEFINE MYNUMBER 12; ... EXEC SQL UPDATE Tbl SET col = MYNUMBER; 不能把#define用于一个将要在嵌入式SQL查询中使用的变量，因为在这种情况下嵌入式SQL预编译器不能看到这个声明。 父主题： 预处理指令

对象访问编程规范 【规则】用户在操作对象时，应该拥有该对象的操作权限。 权限说明请参考用户及权限章节，并遵循权限设计规范。 【规则】访问对象（表，函数等）时建议带上SCHEMA名称，即使用schemaname.tablename进行访问。 如果不追加SCHEMA名称前缀，会根据当前search_path中表空间列表，依次搜索所有表空间直到找到匹配的表，造成不必要的性能开销。 父主题： 数据库编程规范

注意事项 TRUNCATE TABLE在功能上与不带WHERE子句DELETE语句相同：二者均删除表中的全部行。 TRUNCATE TABLE比DELETE速度快且使用系统和事务日志资源少： DELETE语句每次删除一行，并在事务日志中为所删除每行记录一项。 TRUNCATE TABLE通过释放存储表数据所用数据页来删除数据，并且只在事务日志中记录页的释放。 TRUNCATE，DELETE，DROP三者的差异如下： TRUNCATE TABLE，删除内容，释放空间，但不删除定义。 DELETE TABLE，删除内容，不删除定义，不释放空间。 DROP TABLE，删除内容和定义，释放空间。

语法格式 清理表数据。 TRUNCATE [ TABLE ] [ ONLY ] {table_name [ * ]} [, ... ] [ CONTINUE IDENTITY ] [ CASCADE | RESTRICT] [ PURGE ]}; 清理表分区的数据。 ALTER TABLE [ IF EXISTS ] { [ ONLY ] table_name | table_name * | ONLY ( table_name ) } TRUNCATE PARTITION { partition_name | FOR ( partition_value [, ...] ) } [ UPDATE GLOBAL INDEX ];

参数说明 ONLY 如果声明ONLY，只有指定的表会被清空。如果没有声明ONLY，这个表以及其所有子表（若有）会被清空。 table_name 目标表的名称（可以有模式修饰）。 取值范围：已存在的表名。 CONTINUE IDENTITY 不改变序列的值。这是缺省值。 CASCADE | RESTRICT CASCADE：级联清空所有由于CASCADE而被添加到组中的表。 RESTRICT（缺省值）：如果其他表在该表上有外键引用则拒绝清空。 PURGE 默认将表数据放入回收站中，PURGE直接清理。 partition_name 目标分区表的分区名。 取值范围：已存在的分区名。 partition_value 指定的分区键值。 通过PARTITION FOR子句指定的这一组值，可以唯一确定一个分区。 取值范围：需要进行删除数据分区的分区键的取值范围。 使用PARTITION FOR子句时，partition_value所在的整个分区会被清空。

示例 --创建SCHEMA。 gaussdb=# CREATE SCHEMA tpcds; --创建表tpcds.reason。 gaussdb=# CREATE TABLE tpcds.reason ( r_reason_sk integer, r_reason_id character(16), r_reason_desc character(100) ); --向表中插入多条记录。 gaussdb=# INSERT INTO tpcds.reason values(1,'AAAAAAAABAAAAAAA','reason 1'),(5,'AAAAAAAABAAAAAAA','reason 2'),(15,'AAAAAAAABAAAAAAA','reason 3'),(25,'AAAAAAAABAAAAAAA','reason 4'),(35,'AAAAAAAABAAAAAAA','reason 5'),(45,'AAAAAAAACAAAAAAA','reason 6'),(55,'AAAAAAAACAAAAAAA','reason 7'); --创建表。 gaussdb=# CREATE TABLE tpcds.reason_t1 AS TABLE tpcds.reason; --清空表tpcds.reason_t1。 gaussdb=# TRUNCATE TABLE tpcds.reason_t1; --删除表。 gaussdb=# DROP TABLE tpcds.reason_t1; --创建分区表。 gaussdb=# CREATE TABLE tpcds.reason_p ( r_reason_sk integer, r_reason_id character(16), r_reason_desc character(100) )PARTITION BY RANGE (r_reason_sk) ( partition p_05_before values less than (05), partition p_15 values less than (15), partition p_25 values less than (25), partition p_35 values less than (35), partition p_45_after values less than (MAXVALUE) ); --插入数据。 gaussdb=# INSERT INTO tpcds.reason_p SELECT * FROM tpcds.reason; --清空分区p_05_before。 gaussdb=# ALTER TABLE tpcds.reason_p TRUNCATE PARTITION p_05_before; --清空分区p_15。 gaussdb=# ALTER TABLE tpcds.reason_p TRUNCATE PARTITION for (13); --清空分区表。 gaussdb=# TRUNCATE TABLE tpcds.reason_p; --删除表。 gaussdb=# DROP TABLE tpcds.reason_p; --删除表。 gaussdb=# DROP TABLE tpcds.reason; --删除SCHEMA。 gaussdb=# DROP SCHEMA tpcds CASCADE;

ADM_TAB_PARTITIONS ADM_TAB_PARTITIONS视图显示数据库下所有的一级分区信息（包括二级分区表）。默认只有系统管理员权限才可以访问此系统视图，普通用户需要授权才可以访问。该视图同时存在于PG_CATA LOG 和SYS Schema下。 表1 ADM_TAB_PARTITIONS字段 名称 类型 描述 table_owner character varying(64) 表的所有者。 table_name character varying(64) 关系表名称。 partition_name character varying(64) 分区名称。 high_value text 分区的边界值。 对于范围分区和间隔分区，显示各分区的上边界值。 对于列表分区，显示各分区的取值列表。 对于哈希分区，显示各分区的编号。 tablespace_name name 分区表的表空间名称。 schema character varying(64) 名称空间的名称。 subpartition_count bigint 二级分区的个数。 high_value_length integer 分区绑定值表达式长度。 composite character varying(3) 表是否为二级分区表。 partition_position numeric 分区在表中的位置。 pct_free numeric 块中可用空间的最小百分比。 pct_used numeric 暂不支持，值为NULL。 ini_trans numeric 初始事务数，默认值为4，非USTORE分区表时为NULL。 max_trans numeric 最大事务数，默认值为128，非USTORE分区表时为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extent numeric 暂不支持，值为NULL。 max_extent numeric 暂不支持，值为NULL。 max_size numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 logging character varying(7) 是否记录对表的更改。 compression character varying(8) 表分区的实际压缩属性。 compress_for character varying(30) 暂不支持，值为NULL。 num_rows numeric 分区中的行数统计值。 blocks numeric 暂不支持，值为NULL。 empty_blocks numeric 暂不支持，值为NULL。 avg_space numeric 暂不支持，值为NULL。 chain_cnt numeric 暂不支持，值为NULL。 avg_row_len numeric 暂不支持，值为NULL。 sample_size numeric 暂不支持，值为NULL。 last_analyzed timestamp with time zone 最近分析此分区的日期。 buffer_pool character varying(7) 用于分区块的缓冲池。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 is_nested character varying(3) 是否是嵌套表分区。 parent_table_partition character varying(128) 暂不支持，值为NULL。 interval character varying(3) 分区是否在间隔分区表的间隔节中。 segment_created character varying(4) 表分区是否创建了段或未创建。 indexing character varying(4) 暂不支持，值为NULL。 read_only character varying(4) 暂不支持，值为NULL。 inmemory character varying(8) 暂不支持，值为NULL。 inmemory_priority character varying(8) 暂不支持，值为NULL。 inmemory_distribute character varying(15) 暂不支持，值为NULL。 inmemory_compression character varying(17) 暂不支持，值为NULL。 inmemory_duplicate character varying(13) 暂不支持，值为NULL。 cellmemory character varying(24) 暂不支持，值为NULL。 inmemory_service character varying(12) 暂不支持，值为NULL。 inmemory_service_name character varying(100) 暂不支持，值为NULL。 memoptimize_read character varying(8) 暂不支持，值为NULL。 memoptimize_write character varying(8) 暂不支持，值为NULL。 父主题： 系统视图

示例 //本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）。 package main /* Go驱动依赖包位置根据配置的go.mod设置。 */ import ( "database/sql" _ "gitee.com/opengauss/openGauss-connector-go-pq" "log" ) func main() { hostip := os.Getenv("GOHOSTIP") //GOHOSTIP为写入环境变量的IP地址。 port := os.Getenv("GOPORT") //GOPORT为写入环境变量的port。 usrname := os.Getenv("GOUSRNAME") //GOUSRNAME为写入环境变量的用户名。 passwd := os.Getenv("GOPASSWD") //GOPASSWDW为写入环境变量的用户密码。 str := "host=" + hostip + " port=" + port + " user=" + usrname + " password=" + passwd + " dbname=postgres sslmode=disable" db, err:= sql.Open("opengauss", str) if err != nil { log.Fatal(err) } defer db.Close() err = db.Ping() if err != nil { log.Fatal(err) } _, err = db.Exec("drop table if exists testuser.test") _, err = db.Exec("create table test(id int, name char(10))") // 按位置绑定 _, err = db.Exec("insert into test(id, name) values(:1, :2)", 1, "张三") if err != nil { log.Fatal(err) } // 按名称绑定 _, err = db.Exec("insert into test(id, name) values(:id, :name)", sql.Named("id", 1), sql.Named("name", "张三")) if err != nil { log.Fatal(err) } }

参数说明 参数 参数说明 ctx 表示给定的上下文。 query 被执行的SQL语句。 args 被执行SQL语句需要绑定的参数。支持按位置绑定和按名称绑定，详情见如下示例。 opts 事务隔离级别和事务访问模式，其中事务隔离级别（opts.Isolation）支持范围为sql.LevelReadUncommitted,sql.LevelReadCommitted,sql.LevelRepeatableRead,sql.LevelSerializable。事务访问模式（opts.ReadOnly）支持范围为true（read only）和false（read write）。

DB4AI.PURGE_SNAPSHOT_INTERNAL PURGE_SNAPSHOT_INTERNAL是DB4AI.PURGE_SNAPSHOT函数的内置执行函数。函数存在信息校验，无法直接调用 表1 DB4AI.PURGE_SNAPSHOT_INTERNAL入参和返回值列表 参数 类型 描述 i_schema IN NAME 快照存储的模式名字 i_name IN NAME 快照名称 父主题： DB4AI Schema

示例 请参见CREATE PACKAGE中示例。 重编译示例： --开启依赖功能。 gaussdb=# set behavior_compat_options ='plpgsql_dependency'; --创建函数。 gaussdb=# create or replace package test_pkg as pkg_var int := 1; procedure test_pkg_proc(var int); end test_pkg; / gaussdb=# create or replace package body test_pkg as procedure test_pkg_proc(var int) is begin pkg_var := 1; end; end test_pkg; / --重编译包。 gaussdb=# alter package test_pkg compile;

MY_OBJE CTS MY_OBJECTS视图描述了当前用户所属的数据库对象信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_OBJECTS字段 名称 类型 描述 object_name name 对象的名称。 object_id oid 对象的OID。 object_type name 对象的类型，包括TABLE、INDEX、SEQUENCE、VIEW。 namespace oid 对象所属的名称空间。 temporary character(1) 对象是否为临时对象。 status character varying(7) 对象的状态。 subobject_name name 对象的子对象名称。 generated character(1) 对象名称是否是系统生成。 created timestamp with time zone 对象的创建时间。 last_ddl_time timestamp with time zone 对象的最后修改时间。 default_collation character varying(100) 对象的默认排序规则。 data_object_id numeric 暂不支持，值为NULL。 timestamp character varying(19) 暂不支持，值为NULL。 secondary character varying(1) 暂不支持，值为NULL。 edition_name character varying(128) 暂不支持，值为NULL。 sharing character varying(18) 暂不支持，值为NULL。 editionable character varying(1) 暂不支持，值为NULL。 oracle_maintained character varying(1) 暂不支持，值为NULL。 application character varying(1) 暂不支持，值为NULL。 duplicated character varying(1) 暂不支持，值为NULL。 sharded character varying(1) 暂不支持，值为NULL。 created_appid numeric 暂不支持，值为NULL。 modified_appid numeric 暂不支持，值为NULL。 created_vsnid numeric 暂不支持，值为NULL。 modified_vsnid numeric 暂不支持，值为NULL。 created和last_ddl_time支持的范围参见PG_OBJECT中的记录范围。 父主题： 系统视图

方式二：对接应用程序使用的JdkLogger日志框架 两种方式：采用logging.properties配置文件、直接在示例代码中进行配置。 默认的Java日志记录框架将其配置存储在名为logging.properties的文件中。Java会在Java安装目录的文件夹中安装全局配置文件。logging.properties文件也可以创建并与单个项目一起存储。 logging.properties配置文件： # 指定处理程序为文件。 handlers= java.util.logging.FileHandler # 指定默认全局日志级别。 .level= ALL # 指定日志输出管控标准。 java.util.logging.FileHandler.level=ALL java.util.logging.FileHandler.pattern=gsjdbc.log java.util.logging.FileHandler.limit=500000 java.util.logging.FileHandler.count=30 java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter java.util.logging.FileHandler.append=false 直接在示例代码中进行配置： System.setProperty("java.util.logging.FileHandler.pattern","jdbc.log"); FileHandler fileHandler = new FileHandler(System.getProperty("java.util.logging.FileHandler.pattern")); Formatter formatter = new SimpleFormatter(); fileHandler.setFormatter(formatter); Logger logger = Logger.getLogger("com.huawei.opengauss.jdbc"); logger.addHandler(fileHandler); logger.setLevel(Level.ALL); logger.setUseParentHandlers(false);

双数据库实例容灾控制函数 gs_streaming_dr_in_switchover() 描述：基于流式复制的异地容灾解决方案中主数据库实例在执行计划内switchover过程中截断业务的接口。 返回值类型：Boolean，表明此次业务截断是否成功，是否可以正常进行switchover流程。 gaussdb=# SELECT * FROM gs_streaming_dr_in_switchover(); is_in_switchover ------------------ f (1 row) 父主题： 系统管理函数

PG_VARIABLE_INFO PG_VARIABLE_INFO视图用于查询数据库中当前节点的xid、oid的状态。 表1 PG_VARIABLE_INFO字段 名称 类型 描述 node_name text 节点名称。 next_oid oid 该节点下一次生成的oid。 next_xid xid 该节点下一次生成的事务号。 oldest_xid xid 该节点最旧的事务号。 xid_vac_limit xid 强制autovacuum的临界点。 oldest_xid_db oid 该节点datafrozenxid最小的数据库oid。 last_extend_csn_logpage xid 最后一次扩展csnlog的页面号。 start_extend_csn_logpage xid csnlog扩展的起始页面号。 next_commit_seqno xid 该节点下次生成的csn号。 latest_completed_xid xid 该节点提交或者回滚后节点上的最新事务号。 startup_max_xid xid 该节点关机前的最后一个事务号。 父主题： 系统视图

语法格式 修改用户的权限等信息。 ALTER USER user_name [ [ WITH ] option [ ... ] ]; 其中option子句为。 { CREATEDB | NOCREATEDB } | { CREATEROLE | NOCREATEROLE } | { INHERIT | NOINHERIT } | { AUDITADMIN | NOAUDITADMIN } | { SYSADMIN | NOSYSADMIN } | {MONADMIN | NOMONADMIN} | {OPRADMIN | NOOPRADMIN} | {POLADMIN | NOPOLADMIN} | { USEFT | NOUSEFT } | { LOGIN | NOLOGIN } | { REPLICATION | NOREPLICATION } | {VCADMIN | NOVCADMIN} | {PERSISTENCE | NOPERSISTENCE} | CONNECTION LIMIT connlimit | [ ENCRYPTED | UNENCRYPTED ] PASSWORD { 'password' [EXPIRED] | DISABLE | EXPIRED } | [ ENCRYPTED | UNENCRYPTED ] IDENTIFIED BY { 'password' [ REPLACE 'old_password' | EXPIRED ] | DISABLE } | VALID BEGIN 'timestamp' | VALID UNTIL 'timestamp' | RESOURCE POOL 'respool' | PERM SPACE 'spacelimit' | PGUSER 修改用户名。 ALTER USER user_name RENAME TO new_name; 锁定或解锁。 ALTER USER user_name ACCOUNT { LOCK | UNLOCK }; 修改与用户关联的指定会话参数值。 ALTER USER user_name SET configuration_parameter { { TO | = } { value | DEFAULT } | FROM CURRENT }; 重置与用户关联的指定会话参数值。 ALTER USER user_name RESET { configuration_parameter | ALL };

示例 --创建用户jim，登录密码为********。 gaussdb=# CREATE USER jim PASSWORD '********'; --修改用户jim的登录密码。 gaussdb=# ALTER USER jim IDENTIFIED BY '**********' REPLACE '********'; --将enable_seqscan的值设置为on， 设置成功后，在下一会话中生效。 gaussdb=# ALTER USER jim SET enable_seqscan TO on; --重置jim的enable_seqscan参数。 gaussdb=# ALTER USER jim RESET enable_seqscan; --锁定jim账户。 gaussdb=# ALTER USER jim ACCOUNT LOCK; --解锁jim账户。 gaussdb=# ALTER USER jim ACCOUNT UNLOCK; --修改用户名。 gaussdb=# ALTER USER jim RENAME TO lisa; --删除用户。 gaussdb=# DROP USER lisa CASCADE;

GS_JOB_ARGUMENT GS_JOB_ARGUMENT系统表提供了DBE_SCHEDULER定时任务和程序的参数属性。 表1 GS_JOB_ARGUMENT字段 名称 类型 描述 oid oid 行标识符（隐含字段）。 argument_position integer 定时任务或程序的参数位置。 argument_type name 定时任务或程序的参数类型。 job_name text 定时任务或程序名。 argument_name text 定时任务或程序的参数名（定时任务继承了程序的参数名，所以为空）。 argument_value text 定时任务的参数值（程序本身无法绑定值）。 default_value text 程序的参数默认值。 父主题： 系统表

执行SQL语句 为了帮助用户实现与数据库的交互，ODBC提供执行SQL语句的相关API如表1所示。 表1 相关API说明 功能 API 设置语句属性 SQLSetStmtAttr 为执行SQL语句做准备 SQLPrepare 执行一条准备好的SQL语句 SQLExecute 绑定SQL语句的参数标志和缓冲区 SQLBindParameter 直接执行SQL语句 SQLExecDirect ODBC为应用程序与数据库的中心层，负责把应用程序发出的SQL指令传到数据库当中，自身并不解析SQL语法。故在应用程序中写入带有保密信息的SQL语句时（如明文密码），保密信息会被暴露在驱动日志中。 数据库中收到的一次执行请求（不在事务块中），如果含有多条语句，将会被打包成一个事务，如果其中有一个语句失败，那么整个请求都将会被回滚。 示例如下（完整示例请参考获取和处理数据库中的数据）： // 设置语句属性。 SQLSetStmtAttr(V_OD_hstmt, SQL_ATTR_QUERY_TIMEOUT, (SQLPOINTER *)3, 0); // 申请语句句柄。 SQLAllocHandle(SQL_HANDLE_STMT, V_OD_hdbc, &V_OD_hstmt); // 直接执行SQL语句。 SQLExecDirect(V_OD_hstmt, "drop table IF EXISTS customer_t1", SQL_NTS); SQLExecDirect(V_OD_hstmt, "CREATE TABLE customer_t1(c_customer_sk INTEGER, c_customer_name VARCHAR(32));", SQL_NTS); SQLExecDirect(V_OD_hstmt, "insert into customer_t1 values(25, 'li')", SQL_NTS); // 准备执行。 SQLPrepare(V_OD_hstmt, "insert into customer_t1 values(?)", SQL_NTS); // 绑定参数。 SQLBindParameter(V_OD_hstmt,1, SQL_PA RAM _INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &value, 0, NULL); // 执行准备好的语句。 SQLExecute(V_OD_hstmt); SQLExecDirect(V_OD_hstmt, "select c_customer_sk from customer_t1", SQL_NTS); 父主题： 开发步骤

文本检索调试函数 ts_debug([ config regconfig, ] document text, OUT alias text, OUT description text, OUT token text, OUT dictionaries regdictionary[], OUT dictionary regdictionary, OUT lexemes text[]) 描述：测试一个配置。 返回类型：setof record 示例： 1 2 3 4 5 6 7 8 9 gaussdb=# SELECT ts_debug('english', 'The Brightest supernovaes'); ts_debug ----------------------------------------------------------------------------------- (asciiword,"Word, all ASCII",The,{english_stem},english_stem,{}) (blank,"Space symbols"," ",{},,) (asciiword,"Word, all ASCII",Brightest,{english_stem},english_stem,{brightest}) (blank,"Space symbols"," ",{},,) (asciiword,"Word, all ASCII",supernovaes,{english_stem},english_stem,{supernova}) (5 rows) ts_lexize(dict regdictionary, token text) 描述：测试一个数据字典。 返回类型：text[] 示例： 1 2 3 4 5 gaussdb=# SELECT ts_lexize('english_stem', 'stars'); ts_lexize ----------- {star} (1 row) ts_parse(parser_name text, document text, OUT tokid integer, OUT token text) 描述：测试一个解析。 返回类型：setof record 示例： 1 2 3 4 5 6 7 8 gaussdb=# SELECT ts_parse('default', 'foo - bar'); ts_parse ----------- (1,foo) (12," ") (12,"- ") (1,bar) (4 rows) ts_parse(parser_oid oid, document text, OUT tokid integer, OUT token text) 描述：测试一个解析。 返回类型：setof record 示例： 1 2 3 4 5 6 7 8 gaussdb=# SELECT ts_parse(3722, 'foo - bar'); ts_parse ----------- (1,foo) (12," ") (12,"- ") (1,bar) (4 rows) ts_token_type(parser_name text, OUT tokid integer, OUT alias text, OUT description text) 描述：获取分析器定义的记号类型。 返回类型：setof record 示例： 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 gaussdb=# SELECT ts_token_type('default'); ts_token_type -------------------------------------------------------------- (1,asciiword,"Word, all ASCII") (2,word,"Word, all letters") (3,numword,"Word, letters and digits") (4,email,"Email address") (5,url,URL) (6,host,Host) (7,sfloat,"Scientific notation") (8,version,"Version number") (9,hword_numpart,"Hyphenated word part, letters and digits") (10,hword_part,"Hyphenated word part, all letters") (11,hword_asciipart,"Hyphenated word part, all ASCII") (12,blank,"Space symbols") (13,tag,"XML tag") (14,protocol,"Protocol head") (15,numhword,"Hyphenated word, letters and digits") (16,asciihword,"Hyphenated word, all ASCII") (17,hword,"Hyphenated word, all letters") (18,url_path,"URL path") (19,file,"File or path name") (20,float,"Decimal notation") (21,int,"Signed integer") (22,uint,"Unsigned integer") (23,entity,"XML entity") (23 rows) ts_token_type(parser_oid oid, OUT tokid integer, OUT alias text, OUT description text) 描述：获取分析器定义的记号类型。 返回类型：setof record 示例： 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 gaussdb=# SELECT ts_token_type(3722); ts_token_type -------------------------------------------------------------- (1,asciiword,"Word, all ASCII") (2,word,"Word, all letters") (3,numword,"Word, letters and digits") (4,email,"Email address") (5,url,URL) (6,host,Host) (7,sfloat,"Scientific notation") (8,version,"Version number") (9,hword_numpart,"Hyphenated word part, letters and digits") (10,hword_part,"Hyphenated word part, all letters") (11,hword_asciipart,"Hyphenated word part, all ASCII") (12,blank,"Space symbols") (13,tag,"XML tag") (14,protocol,"Protocol head") (15,numhword,"Hyphenated word, letters and digits") (16,asciihword,"Hyphenated word, all ASCII") (17,hword,"Hyphenated word, all letters") (18,url_path,"URL path") (19,file,"File or path name") (20,float,"Decimal notation") (21,int,"Signed integer") (22,uint,"Unsigned integer") (23,entity,"XML entity") (23 rows) ts_stat(sqlquery text, [ weights text, ] OUT word text, OUT ndoc integer, OUT nentry integer) 描述：获取tsvector列的统计数据。 返回类型：setof record 示例： 1 2 3 4 5 6 gaussdb=# SELECT ts_stat('select ''hello world''::tsvector'); ts_stat ------------- (world,1,1) (hello,1,1) (2 rows)

SUMMARY_STAT_SYS_INDEXES 显示数据库各节点pg_catalog、information_schema以及pg_toast模式中所有系统表的索引状态信息的汇总求和结果。 表1 SUMMARY_STAT_SYS_INDEXES字段 名称 类型 描述 schemaname name 索引所在的Schema名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan numeric 该索引上执行的索引扫描次数。 idx_tup_read numeric 该索引上扫描返回的索引项数。 idx_tup_fetch numeric 使用该索引的简单索引扫描在原表中抓取的活跃行数。 父主题： Object

环境类 Go环境配置 用户需要在环境变量中配置以下参数： GO111MODULE：用户使用在线导入的方式安装Go驱动时需要设置GO111MODULE为on。如果不希望进行go mod工程的改造，需将GO111MODULE设置为off，并手动下载依赖包。依赖包与驱动根目录和业务代码保持同级。 GOPROXY：用户使用在线导入时需配置包含Go驱动包的路径。 用户可以根据自己场景参数配置Go其他相关环境变量。 通过go env查看Go环境变量配置结果，并且查看Go版本是否在1.13或以上。 Go驱动安装 从发布包中获取Go驱动包。包名为 GaussDB -Kernel_数据库版本号_操作系统版本号_64bit_Go.tar.gz。解压后为Go驱动源码包。 进入Go驱动代码根路径，执行go mod tidy下载相关依赖，需要在环境变量中配置GOPATH=${Go驱动依赖包存放路径}。 若依赖已下载至本地，可以在go.mod里面添加一行“通过replace将Go驱动包替换为本地Go驱动包地址”，表示代码里面所有的import Go驱动包都是走本地路径， 同时依赖也不会从代理里下载。 数据库提供的Go驱动包依赖Go 1.13及以上版本。 通过go mod tidy下载相关依赖时，可能会下载某个依赖的低版本，如果依赖的低版本存在漏洞，可以通过更改go.mod文件中对应依赖的版本号的方式，更新依赖到漏洞修复后的版本进行规避风险。

ADM_TRIGGERS ADM_TRIGGERS视图显示数据库中的触发器信息。默认只有系统管理员权限才可以访问此系统视图，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_TRIGGERS字段 名称 类型 描述 owner character varying(128) 触发器的所有者。 trigger_name character varying(64) 触发器名称。 trigger_type character varying 触发器触发的时机。取值范围：before statement、before each row、after statement、after each row、instead of。 triggering_event character varying 触发触发器的事件：update、insert、delete、truncate。 table_owner character varying(64) 定义触发器的表的所有者。 base_object_type character varying(18) 定义触发器的基础对象。取值范围：table、view。 table_name character varying(64) 定义触发器的表或视图名称。 column_name character varying(4000) 暂不支持，值为NULL。 referencing_name character varying(422) 暂不支持，值为referencing new as new old as old。 when_clause character varying(4000) when子句的内容，必须值为true才能执行trigger_body。 status character varying(64) 触发器的触发状态： O：触发器在“origin”和“local”模式下触发。 D：触发器被禁用。 R：触发器在“replica”模式下触发。 A：触发器始终触发。 description character varying(4000) 触发器描述，用于重新创建触发器创建语句。 action_type character varying(11) 触发器的动作类型，仅支持call。 trigger_body text 触发器触发时执行的语句。 crossedition character varying(7) 暂不支持，值为NULL。 before_statement character varying(3) 暂不支持，值为NULL。 before_row character varying(3) 暂不支持，值为NULL。 after_row character varying(3) 暂不支持，值为NULL。 after_statement character varying(3) 暂不支持，值为NULL。 instead_of_row character varying(3) 暂不支持，值为NULL。 fire_once character varying(3) 暂不支持，值为NULL。 apply_server_only character varying(3) 暂不支持，值为NULL。 父主题： 系统视图

CONFIG_SETTINGS CONFIG_SETTINGS视图显示数据库运行时参数的相关信息。 表1 CONFIG_SETTINGS字段 名称 类型 描述 name text 参数名称。 setting text 参数当前值。 unit text 参数的隐式结构。 category text 参数的逻辑组。 short_desc text 参数的简单描述。 extra_desc text 参数的详细描述。 context text 设置参数值的上下文，包括internal，postmaster，sighup，backend，superuser，user。 vartype text 参数类型，包括bool，enum，integer，real，string。 source text 参数的赋值方式。 min_val text 参数最大值。如果参数类型不是数值型，那么该字段值为null。 max_val text 参数最小值。如果参数类型不是数值型，那么该字段值为null。 enumvals text[] enum类型参数合法值。如果参数类型不是enum型，那么该字段值为null。 boot_val text 数据库启动时参数默认值。 reset_val text 数据库重置时参数默认值。 sourcefile text 设置参数值的配置文件。如果参数不是通过配置文件赋值，那么该字段值为null。 sourceline integer 设置参数值的配置文件的行号。如果参数不是通过配置文件赋值，那么该字段值为null。 父主题： Configuration

基于ecpg开发 ecpg(embedded SQL C preprocessor for GaussDB Kernel）是一种用于C语言程序的嵌入式SQL预处理器。一个嵌入式SQL程序由一种普通编程语言编写的代码（此处为C语言）和SQL命令共同组成。要构建该程序，源代码（*.pgc）首先通过嵌入式SQL预处理器，将源代码转换成一个普通C语言程序（*.c），然后再通过编译器处理。转换过的ecpg应用通过嵌入式SQL库（ecpglib）调用libpq库中的函数，与GaussDB Kernel服务器使用普通的前端/后端协议通信。 嵌入式SQL程序是插入了数据库相关动作的特殊代码的C语言程序。这种特殊代码形式通常如下： EXEC SQL ...; 这些语句在语法上取代了一个C语句，可以出现在全局或者是一个函数中。嵌入式SQL语句遵循普通SQL代码的大小写敏感规则，也允许嵌套的C语言代码风格注释（SQL标准的一部分）。不过，程序的C语言部分遵循C语言程序的标准，不支持嵌套注释。 开发流程 ecpg组件介绍 ecpg预处理以及编译执行 管理数据库连接 执行SQL命令 查询结果集 关闭数据库连接 宿主变量 执行动态SQL语句 错误处理 预处理指令 使用库函数 SQL描述符区域 常用示例 ecpg与Pro*C兼容性对比 ecpg接口参考 父主题： 应用程序开发教程

功能描述 根据一个索引对表进行聚簇排序。 CLUSTER指定GaussDB通过索引名指定的索引聚簇由表名指定的表。 表名上必须已经定义该索引。 当对一个表聚集后，该表将基于索引信息进行物理存储。聚集是一次性操作：当表被更新之后， 更改的内容不会被聚集。也就是说，系统不会试图按照索引顺序对新的存储内容及更新记录进行重新聚集。 在对一个表聚簇之后，GaussDB会记录该表在哪个索引上建立了聚簇。CLUSTER table_name将在该表之前记录过的聚簇索引上重新聚簇。用户也可以用ALTER TABLE table_name CLUSTER on index_name来设置指定表用于后续聚簇操作的索引，或使用ALTER TABLE table_name SET WITHOUT CLUSTER来清除指定表之前设置的聚簇索引。 不含参数的CLUSTER命令会将当前用户所拥有的数据库中的先前做过聚簇的所有表重新处理，或者系统管理员调用的这些表。 在对一个表进行聚簇的时候，会在其上请求一个AC CES S EXCLUSIVE锁。这样就避免了在CLUSTER完成之前对此表执行其它的操作(包括读写)。

注意事项 只有行存B-tree索引支持CLUSTER操作。 如果用户只是随机访问表中的行，那么表中数据的实际存储顺序是无关紧要的。但是，如果对某些特定数据的访问次数较多，而且有一个索引将这些数据分组，那么使用CLUSTER索引对性能会有所提升。 如果一个请求从表中查找的索引是一个范围，或者是一个索引值对应多行，CLUSTER也会有助于应用，因为如果索引标识出了第一匹配行所在的存储页，所有其它行也可能也已经在同一个存储页里了，这样便节省了磁盘访问的时间，加速了查询。 在聚簇过程中，系统会先创建一个按照索引顺序建立的表的临时备份，同时也建立表上的每个索引的临时备份。因此，聚簇过程中需要保证磁盘上有足够的剩余空间，至少是表大小与全部索引大小之和。 因为CLUSTER记录着哪些索引曾被用于聚簇，所以用户可以在第一次手动指定索引，对指定表进行聚簇，然后设置一个周期化执行的维护脚本，只需执行不带参数的CLUSTER命令，就可以实现对想要周期性聚簇的表进行自动更新。 因为优化器记录着有关表的排序的统计，在表上执行聚簇操作后，需运行ANALYZE操作以确保优化器具备最新的排序信息，否则，优化器可能会选择非最优的查询规划。 CLUSTER不允许在事务中执行。 如果没有打开xc_maintenance_mode参数，那么CLUSTER操作将跳过所有系统表。

语法格式 对一个表进行聚簇排序。 CLUSTER [ VERBOSE ] table_name [ USING index_name ]; 对一个分区进行聚簇排序。 CLUSTER [ VERBOSE ] table_name PARTITION ( partition_name ) [ USING index_name ]; 对已做过聚簇的表重新进行聚簇。 CLUSTER [ VERBOSE ];

示例 --创建SCHEMA。 gaussdb=# CREATE SCHEMA tpcds; --创建一个分区表。 gaussdb=# CREATE TABLE tpcds.inventory_p1 ( INV_DATE_SK INTEGER NOT NULL, INV_ITEM_SK INTEGER NOT NULL, INV_WAREHOUSE_SK INTEGER NOT NULL, INV_QUANTITY_ON_HAND INTEGER ) PARTITION BY RANGE(INV_DATE_SK) ( PARTITION P1 VALUES LESS THAN(2451179), PARTITION P2 VALUES LESS THAN(2451544), PARTITION P3 VALUES LESS THAN(2451910), PARTITION P4 VALUES LESS THAN(2452275), PARTITION P5 VALUES LESS THAN(2452640), PARTITION P6 VALUES LESS THAN(2453005), PARTITION P7 VALUES LESS THAN(MAXVALUE) ); --创建索引ds_inventory_p1_index1。 gaussdb=# CREATE INDEX ds_inventory_p1_index1 ON tpcds.inventory_p1 (INV_ITEM_SK) LOCAL; --对表tpcds.inventory_p1进行聚集。 gaussdb=# CLUSTER tpcds.inventory_p1 USING ds_inventory_p1_index1; --对分区p3进行聚集。 gaussdb=# CLUSTER tpcds.inventory_p1 PARTITION (p3) USING ds_inventory_p1_index1; --对数据库中可以进行聚集的表进聚集。 gaussdb=# CLUSTER; --删除索引。 gaussdb=# DROP INDEX tpcds.ds_inventory_p1_index1; --删除分区表。 gaussdb=# DROP TABLE tpcds.inventory_p1; --删除SCHEMA。 gaussdb=# DROP SCHEMA tpcds CASCADE;

示例 请参见CREATE FUNCTION的示例。 重编译示例： --开启依赖功能。 gaussdb=# set behavior_compat_options ='plpgsql_dependency'; --创建存储过程。 gaussdb=# create or replace procedure test_proc(a int) is proc_var int; begin proc_var := a; end; / --用存储过程名重编译存储过程。 gaussdb=# alter procedure test_proc compile; --用存储过程带类型签名重编译存储过程。 gaussdb=# alter procedure test_proc(int) compile;