华为云用户手册

enable_control_group 参数说明：是否开启Cgroups功能。此参数需在CN和DN同时应用。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示打开Cgroups管理。 off表示关闭Cgroups管理。 默认值：on 当使用表1中的方式二来修改参数值时，新参数值只能对更改操作执行后启动的线程生效。此外，对于后台线程以及线程复用执行的新作业，该值的改动不会生效。如果希望这类线程即时识别参数变化，可以使用kill session或重启节点的方式来实现。

参数概览 创建外表语法提供了多个参数，常用参数分类如下。 必需参数 table_name column_name type_name SERVER gsmpp_server OPTIONS可选参数 可选参数 外表的数据源位置参数location 数据格式参数 format header（仅支持 CS V，FIXED格式） fileheader（仅支持CSV，FIXED格式） out_filename_prefix delimiter quote（仅支持CSV格式） escape（仅支持CSV格式） null noescaping（仅支持TEXT格式） encoding eol 容错性参数 fill_missing_fields ignore_extra_data reject_limit compatible_illegal_chars WITH error_table_name LOG INTO error_table_nam... REMOTE LOG 'name' PER NODE REJECT LIMIT 'v...

示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 --建立外表，用来以TEXT格式导入GDS服务器192.168.0.90和192.168.0.91上的数据，导入过程错误信息将记录到err_HR_staffS中。 openGauss=# CREATE FOREIGN TABLE foreign_HR_staffS ( staff_ID NUMBER(6) , FIRST_NAME VARCHAR2(20), LAST_NAME VARCHAR2(25), EMAIL VARCHAR2(25), PHONE_NUMBER VARCHAR2(20), HIRE_DATE DATE, employment_ID VARCHAR2(10), SALARY NUMBER(8,2), COMMISSION_PCT NUMBER(2,2), MANAGER_ID NUMBER(6), section_ID NUMBER(4) ) SERVER gsmpp_server OPTIONS (location 'gsfs://192.168.0.90:5000/* | gsfs://192.168.0.91:5000/*', format 'TEXT', delimiter E'\x20', null '') WITH err_HR_staffS; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 --建立外表，用来以TEXT格式导入GDS服务器192.168.0.90和192.168.0.91上的数据，导入过程错误信息将记录到err_HR_staffS中。本次数据导入允许出现的数据格式错误个数为2。 CREATE FOREIGN TABLE foreign_HR_staffS_ft3 ( staff_ID NUMBER(6) , FIRST_NAME VARCHAR2(20), LAST_NAME VARCHAR2(25), EMAIL VARCHAR2(25), PHONE_NUMBER VARCHAR2(20), HIRE_DATE DATE, employment_ID VARCHAR2(10), SALARY NUMBER(8,2), COMMISSION_PCT NUMBER(2,2), MANAGER_ID NUMBER(6), section_ID NUMBER(4) ) SERVER gsmpp_server OPTIONS (location 'gsfs://192.168.0.90:5000/* | gsfs://192.168.0.91:5000/*', format 'TEXT', delimiter E'\x20', null '',reject_limit '2') WITH err_HR_staffS_ft3; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 --建立外表，用来以CSV格式导入input_data目录下存放在各个节点名文件下的所有文件。 openGauss=# CREATE FOREIGN TABLE foreign_HR_staffS_ft1 ( staff_ID NUMBER(6) , FIRST_NAME VARCHAR2(20), LAST_NAME VARCHAR2(25), EMAIL VARCHAR2(25), PHONE_NUMBER VARCHAR2(20), HIRE_DATE DATE, employment_ID VARCHAR2(10), SALARY NUMBER(8,2), COMMISSION_PCT NUMBER(2,2), MANAGER_ID NUMBER(6), section_ID NUMBER(4) ) SERVER gsmpp_server OPTIONS (location 'file:///input_data/*', format 'csv', mode 'private', delimiter ',') WITH err_HR_staffS_ft1; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 --建立外表，用来以CSV格式导出数据到output_data目录下。 openGauss=# CREATE FOREIGN TABLE foreign_HR_staffS_ft2 ( staff_ID NUMBER(6) , FIRST_NAME VARCHAR2(20), LAST_NAME VARCHAR2(25), EMAIL VARCHAR2(25), PHONE_NUMBER VARCHAR2(20), HIRE_DATE DATE, employment_ID VARCHAR2(10), SALARY NUMBER(8,2), COMMISSION_PCT NUMBER(2,2), MANAGER_ID NUMBER(6), section_ID NUMBER(4) ) SERVER gsmpp_server OPTIONS (location 'file:///output_data/', format 'csv', delimiter '|', header 'on') WRITE ONLY; 1 2 3 4 5 --删除外表。 openGauss=# DROP FOREIGN TABLE foreign_HR_staffS; openGauss=# DROP FOREIGN TABLE foreign_HR_staffS_ft1; openGauss=# DROP FOREIGN TABLE foreign_HR_staffS_ft2; openGauss=# DROP FOREIGN TABLE foreign_HR_staffS_ft3;

语法格式 1 2 3 4 5 6 7 8 9 CREATE FOREIGN TABLE [ IF NOT EXISTS ] table_name ( [ { column_name type_name POSITION ( offset, length ) | LIKE source_table } [, ...] ] ) SERVER gsmpp_server OPTIONS ( { option_name ' value ' } [, ...] ) [ { WRITE ONLY | READ ONLY }] [ WITH error_table_name | LOG INTO error_table_name] [REMOTE LOG 'name'] [PER NODE REJECT LIMIT 'value'] [ TO { GROUP groupname | NODE ( nodename [, ... ] ) } ];

废弃函数 由于版本升级，HLL（HyperLogLog）有一些旧的函数废弃，用户可以用类似的函数进行替代。 hll_schema_version(hll) 描述：查看当前hll中的schema version。旧版本schema version是常值1，用来进行hll字段的头部校验，重构后的hll在头部增加字段“HLL”进行校验，schema version不再使用。 hll_regwidth(hll) 描述：查看hll数据结构中桶的位数大小。旧版本桶的位数regwidth取值1~5，会存在较大的误差，也限制了基数估计上限。 重构后regwidth为固定值6，不再使用regwidth变量。 hll_expthresh(hll) 描述：得到当前hll中expthresh大小。采用hll_log2explicit(hll)替代类似功能。 hll_sparseon(hll) 描述：是否启用Sparse模式。采用hll_log2sparse(hll)替代类似功能，0表示关闭Sparse模式。

聚合函数 hll_add_agg(hll_hashval) 描述：把哈希后的数据按照分组放到hll中。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 --准备数据 openGauss=# create table t_id(id int); openGauss=# insert into t_id values(generate_series(1,500)); openGauss=# create table t_data(a int, c text); openGauss=# insert into t_data select mod(id,2), id from t_id; --创建表并指定列为hll openGauss=# create table t_a_c_hll(a int, c hll); --根据a列group by对数据分组，把各组数据加到hll中 openGauss=# insert into t_a_c_hll select a, hll_add_agg(hll_hash_text(c)) from t_data group by a; --得到每组数据中hll的Distinct值 openGauss=# select a, #c as cardinality from t_a_c_hll order by a; a | cardinality ---+------------------ 0 | 247.862354346299 1 | 250.908710610377 (2 rows)

操作符 = 描述：比较hll或hll_hashval的值是否相等。 返回值类型：bool 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 --hll openGauss=# select (hll_empty() || hll_hash_integer(1)) = (hll_empty() || hll_hash_integer(1)); column ---------- t (1 row) --hll_hashval openGauss=# select hll_hash_integer(1) = hll_hash_integer(1); ?column? ---------- t (1 row)

日志函数 hll主要存在三种模式Explicit，Sparse，Full。当数据规模比较小的时候会使用Explicit模式，这种模式下distinct值的计算是没有误差的；随着distinct值越来越多，hll会先后转换为Sparse模式和Full模式，这两种模式在计算结果上没有任何区别，只影响hll函数的计算效率和hll对象的存储空间。下面的函数可以用于查看hll的一些参数。 hll_print(hll) 描述：打印hll的一些debug参数信息。 示例： 1 2 3 4 5 openGauss=# select hll_print(hll_empty()); hll_print ------------------------------------------------------------------------------- type=1(HLL_EMPTY), log2m=14, log2explicit=10, log2sparse=12, duplicatecheck=0 (1 row)

功能函数 hll_empty() 描述：创建一个空的hll。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# select hll_empty(); hll_empty ------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m) 描述：创建空的hll并指定参数log2m，取值范围是10到16。若输入-1，则采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select hll_empty(10); hll_empty ------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000 (1 row) openGauss=# select hll_empty(-1); hll_empty ------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit) 描述：创建空的hll并依次指定参数log2m、log2explicit。log2explicit取值范围是0到12，0表示直接跳过Explicit模式。该参数可以用来设置Explicit模式的阈值大小，在数据段长度达到2log2explicit后切换为Sparse模式或者Full模式。若输入-1，则log2explicit采用内置默认值。 返回值类型: hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select hll_empty(10, 4); hll_empty ------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000 (1 row) openGauss=# select hll_empty(10, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse。log2sparse取值范围是0到14，0表示直接跳过Sparse模式。该参数可以用来设置Sparse模式的阈值大小，在数据段长度达到2log2sparse后切换为Full模式。若输入-1，则log2sparse采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select hll_empty(10, 4, 8); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) openGauss=# select hll_empty(10, 4, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000 (1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse, int32 duplicatecheck) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse、duplicatecheck。duplicatecheck取0或者1，表示是否开启该模式，默认情况下该模式会关闭。若输入-1，则duplicatecheck采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select hll_empty(10, 4, 8, 0); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) openGauss=# select hll_empty(10, 4, 8, -1); hll_empty ------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000 (1 row) hll_add(hll, hll_hashval) 描述：把hll_hashval加入到hll中。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# select hll_add(hll_empty(), hll_hash_integer(1)); hll_add ---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00 (1 row) hll_add_rev(hll_hashval, hll) 描述：把hll_hashval加入到hll中，和hll_add功能一样，只是参数位置进行了交换。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# select hll_add_rev(hll_hash_integer(1), hll_empty()); hll_add_rev ---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00 (1 row) hll_eq(hll, hll) 描述：比较两个hll是否相等。 返回值类型：bool 示例： 1 2 3 4 5 openGauss=# select hll_eq(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_eq -------- f (1 row) hll_ne(hll, hll) 描述：比较两个hll是否不相等。 返回值类型：bool 示例： 1 2 3 4 5 openGauss=# select hll_ne(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_ne -------- t (1 row) hll_cardinality(hll) 描述：计算hll的distinct值。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# select hll_cardinality(hll_empty() || hll_hash_integer(1)); hll_cardinality ----------------- 1 (1 row) hll_union(hll, hll) 描述：把两个hll数据结构union成一个。 返回值类型：hll 示例： 1 2 3 4 5 openGauss=# select hll_union(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_union -------------------------------------------------------------------------------------------- \x484c4c10002000002b090000000000000000400000000000000000b3ccc49320cca1ae3e2921ff133fbaed00 (1 row)

示例 openGauss=# DECLARE my_id integer; BEGIN select id into my_id from customers limit 1; -- 赋值 END; / openGauss=# DECLARE type id_list is varray(6) of customers.id%type; id_arr id_list; BEGIN select id bulk collect into id_arr from customers order by id DESC limit 20; -- 批量赋值 END; / BULK COLLECT INTO 只支持批量赋值给数组。合理使用LIMIT字段避免操作过量数据导致性能下降。

参数说明 client_master_key_name 该参数作为密钥对象名，在同一命名空间下，需满足命名唯一性约束。 取值范围：字符串，需符合标识符的命名规范。 KEY_STORE 独立管理密钥的工具/服务。目前，仅支持由 GaussDB 提供的密钥管理工具gs_ktool，以及由华为云提供的在线密钥管理服务huawei_kms。取值范围为：gs_ktool，huawei_kms。 由于我们仅在客户端与KEY_STORE进行交互，当使用不同的客户端时，本语法中KEY_STORE参数支持的类型也不尽相同。当使用gsql执行本语法时，KEY_STORE仅支持gs_ktool，当使用JDBC执行本语法时，KEY_STORE仅支持huawei_kms。 KEY_PATH 用于指定密钥管理工具/服务中的一个密钥。通过KEY_STORE和KEY_PATH参数可唯一确定一个密钥实体。当KEY_STORE = gs_ktool时，取值范围为：gs_ktool/KEY_ID；当KEY_STORE = huawei_kms时，取值范围为：36字节的密钥ID。 由该语法创建的CMK对象中，存储了KEY_STORE和KEY_PATH信息。当需要读取密钥实体时，GaussDB能够根据CMK对象中存储的信息，自动地从指定KEY_STORE中读取指定的密钥实体。因此，在本语法中，KEY_PATH参数应指向一个已经存在的密钥实体。 ALGORITHM 用于指定该密钥实体将用于何种加密算法。当KEY_STORE = gs_ktool时，取值范围为：AES_256_CBC，SM4；当KEY_STORE = huawei_kms时，取值为：AES_256。

示例（在使用JDBC连接数据库服务器的场景下） 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 /* * (1) 登录华为云官网（https://www.huaweicloud.com），进入“控制台”-“服务列表”-“ 数据加密 服务 DEW”- “密钥管理”页面，创建一个密钥。 * 该服务即由华为云提供的密钥管理服务——KMS。当然，你还可通过编程接口进行密钥管理，详情请参考华为云公开文档 ： * （https://support.huaweicloud.com/dew_faq/dew_01_0053.html） */ /* *（2）与数据库服务器建立连接并执行本语法，在url中需开启全密态数据库的开关：enable_ce=1 * 说明：本部分代码作为示例代码，仅考虑通过最少代码实现最基本的功能 */ import java.sql.*; public class CrtCmkTest { public static void main(String[] args) { String driver = "org.postgresql.Driver"; try { Class.forName(driver); } catch (Exception e) { e.printStackTrace(); return; } /* 用于与数据库服务器建立连接的信息 */ String dbUrl = "jdbc:postgresql://localhost:19900/postgres?enable_ce=1"; String dbUser = "alice"; String dbPassword = "********"; /* * 用于访问华为云KMS的身份认证信息与KMS项目信息 * 说明：本部分所有参数，均可在华为云官网“控制台”-“我的凭证”页面找到 */ String iamUser = "alice_for_kms"; String iamPassword = "********"; String kmsDomain = "hw00000000"; String kmsProjectName = "cn-east-3"; String kmsProjectId = "00000000000000000000000000000000"; /* 用于创建CMK密钥对象的SQL语句 */ String sql = "CREATE CLIENT MASTER KEY alice_cmk WITH ( " + "KEY_STORE = huawei_kms, KEY_PATH = \"00000000-0000-0000-0000-000000000000\" , ALGORITHM = AES_256);"; try { Connection conn = DriverManager.getConnection(dbUrl, dbUser, dbPassword); conn.setClientInfo("iamUser", iamUser); conn.setClientInfo("iamPassword", iamPassword); conn.setClientInfo("kmsDomain", kmsDomain); conn.setClientInfo("kmsProjectName", kmsProjectName); conn.setClientInfo("kmsProjectId", kmsProjectId ); Statement stmt = conn.createStatement(); System.out.println("results: " + stmt.executeUpdate(sql)); } catch (SQLException e) { e.printStackTrace(); } } }

示例 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 --创建外部表。 openGauss=# CREATE FOREIGN TABLE tpcds.customer_ft ( c_customer_sk integer , c_customer_id char(16) , c_current_cdemo_sk integer , c_current_hdemo_sk integer , c_current_addr_sk integer , c_first_shipto_date_sk integer , c_first_sales_date_sk integer , c_salutation char(10) , c_first_name char(20) , c_last_name char(30) , c_preferred_cust_flag char(1) , c_birth_day integer , c_birth_month integer , c_birth_year integer , c_birth_country varchar(20) , c_login char(13) , c_email_address char(50) , c_last_review_date char(10) ) SERVER gsmpp_server OPTIONS ( location 'gsfs://10.185.179.143:5000/customer1*.dat', FORMAT 'TEXT' , DELIMITER '|', encoding 'utf8', mode 'Normal') READ ONLY; --修改外表属性，删除mode选项。 openGauss=# ALTER FOREIGN TABLE tpcds.customer_ft options(drop mode); --删除外部表。 openGauss=# DROP FOREIGN TABLE tpcds.customer_ft;

语法格式 设置外表属性 1 2 ALTER FOREIGN TABLE [ IF EXISTS ] table_name OPTIONS ( {[ ADD | SET | DROP ] option ['value']}[, ... ]); 设置新的所有者 1 2 ALTER FOREIGN TABLE [ IF EXISTS ] tablename OWNER TO new_owner;

PKG_UTIL PKG_UTIL支持的所有接口请参见表1： 表1 PKG_UTIL 接口名称 描述 PKG_UTIL.LOB_GET_LENGTH 获取lob的长度。 PKG_UTIL.LOB_READ 读取lob对象的一部分。 PKG_UTIL.LOB_WRITE 将源对象按照指定格式写入到目标对象。 PKG_UTIL.LOB_APPEND 将lob源对象指定个数的字符追加到目标lob对象。 PKG_UTIL.LOB_COMPARE 根据指定长度比较两个lob对象。 PKG_UTIL.LOB_MATCH 返回一个字符串在LOB中第N次出现的位置。 PKG_UTIL.LOB_RESET 将lob的指定位置重置为指定字符。 PKG_UTIL.IO_PRINT 将字符串打印输出。 PKG_UTIL.RAW_GET_LENGTH 获取raw的长度。 PKG_UTIL.RAW_CAST_FROM_VARCHAR2 将varchar2转化为raw。 PKG_UTIL.RAW_CAST_FROM_BINARY_INTEGER 将binary integer转化为raw。 PKG_UTIL.RAW_CAST_TO_BINARY_INTEGER 将raw转化为binary integer。 PKG_UTIL.SET_RANDOM_SEED 设置随机种子。 PKG_UTIL.RANDOM_GET_VALUE 返回随机值。 PKG_UTIL.FILE_SET_DIRNAME 设置当前操作的目录。 PKG_UTIL.FILE_OPEN 根据指定文件名和设置的目录打开一个文件。 PKG_UTIL.FILE_SET_MAX_LINE_SIZE 设置写入文件一行的最大长度。 PKG_UTIL.FILE_IS_CLOSE 检测一个文件句柄是否关闭。 PKG_UTIL.FILE_READ 从一个打开的文件句柄中读取指定长度的数据。 PKG_UTIL.FILE_REA DLI NE 从一个打开的文件句柄中读取一行数据。 PKG_UTIL.FILE_WRITE 将BUFFER中的数据写入到文件中。 PKG_UTIL.FILE_WRITELINE 将buffer写入文件，并追加换行符。 PKG_UTIL.FILE_NEWLINE 新起一行。 PKG_UTIL.FILE_READ_RAW 从一个打开的文件句柄中读取指定长度的二进制数据。 PKG_UTIL.FILE_WRITE_RAW 将二进制数据写入到文件中。 PKG_UTIL.FILE_FLUSH 将一个文件句柄中的数据写入到物理文件中。 PKG_UTIL.FILE_CLOSE 关闭一个打开的文件句柄。 PKG_UTIL.FILE_REMOVE 删除一个物理文件，操作需要有对应权限。 PKG_UTIL.FILE_RENAME 对于磁盘上的文件进行重命名，类似Unix的mv。 PKG_UTIL.FILE_SIZE 返回文件大小。 PKG_UTIL.FILE_BLOCK_SIZE 返回文件含有的块数量。 PKG_UTIL.FILE_EXISTS 判断文件是否存在。 PKG_UTIL.FILE_GETPOS 返回文件的偏移量，单位字节。 PKG_UTIL.FILE_SEEK 设置文件位置为指定偏移。 PKG_UTIL.FILE_CLOSE_ALL 关闭一个会话中打开的所有文件句柄。 PKG_UTIL.EXCEPTION_REPORT_ERROR 抛出一个异常。 PKG_UTIL.LOB_GET_LENGTH 该函数LOB_GET_LENGTH获取输入数据的长度。 PKG_UTIL.LOB_GET_LENGTH函数原型为： 1 2 3 4 PKG_UTIL.LOB_GET_LENGTH( lob IN anyelement ) RETURN INTEGER; 表2 PKG_UTIL.LOB_GET_LENGTH接口参数说明 参数 类型 入参/出参 是否可以为空 描述 lob clob/blob IN 否 待获取长度的对象。 PKG_UTIL.LOB_READ 该函数LOB_READ读取一个对象，并返回指定部分。 PKG_UTIL.LOB_READ函数原型为： 1 2 3 4 5 6 7 PKG_UTIL.LOB_READ( lob IN anyelement, len IN int, start IN int, mode IN int ) RETURN ANYELEMENT 表3 PKG_UTIL.LOB_READ接口参数说明 参数 类型 入参/出参 是否可以为空 描述 lob clob/blob IN 否 clob或者blob类型数据。 len int IN 否 返回结果长度。 start int IN 否 相较于第一个字符的偏移量。 mode int IN 否 判断读取操作的类型， 0 ：read; 1 : trim; 2 : substr。 PKG_UTIL.LOB_WRITE 该函数LOB_WRITE将源对象按照指定的参数写入目标对象，并返回目标对象。 PKG_UTIL.LOB_WRITE函数原型为： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 PKG_UTIL.LOB_WRITE( dest_lob INOUT blob, src_lob IN raw len IN int, start_pos IN int ) RETURN BLOB; PKG_UTIL.LOB_WRITE( dest_lob INOUT clob, src_lob IN varchar2 len IN int, start_pos IN int ) RETURN CLOB; 表4 PKG_UTIL.LOB_WRITE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 dest_lob clob/blob INOUT 否 写入的目标对象。 src_lob clob/blob IN 否 被写入的源对象。 len int IN 否 源对象的写入长度。 start_pos int IN 否 目标对象的写入起始位置。 PKG_UTIL.LOB_APPEND 该函数LOB_APPEND将源blob/clob对象追加到目标blob/clob对象, 并返回目标对象。 PKG_UTIL.LOB_APPEND函数原型为： 1 2 3 4 5 6 7 8 9 10 11 12 13 PKG_UTIL.LOB_APPEND( dest_lob INOUT blob, src_lob IN blob, len IN int default NULL ) RETURN BLOB; PKG_UTIL.LOB_APPEND( dest_lob INOUT clob, src_lob IN clob, len IN int default NULL ) RETURN CLOB; 表5 PKG_UTIL.LOB_APPEND接口参数说明 参数 类型 入参/出参 是否可以为空 描述 dest_lob blob/clob INOUT 否 写入的目标blob/clob对象。 src_lob blob/clob IN 否 被写入的源blob/clob对象。 len int IN 是 写入源对象的长度，为NULL则默认写入源对象全部。 PKG_UTIL.LOB_COMPARE 该函数LOB_COMPARE按照指定的起始位置、个数比较对象是否相同，lob1大则返回1，lob2大返回-1，相等返回0。 PKG_UTIL.LOB_COMPARE函数原型为： 1 2 3 4 5 6 7 8 PKG_UTIL.LOB_COMPARE( lob1 IN anyelement, lob2 IN anyelement, len IN int default 1073741771, start_pos1 IN int default 1, start_pos2 IN int default 1 ) RETURN INTEGER; 表6 PKG_UTIL.LOB_COMPARE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 lob1 clob/blob IN 否 待比较的字符串。 lob2 clob/blob IN 否 待比较的字符串。 len int IN 否 比较的长度。 start_pos1 int IN 否 lob1起始偏移量。 start_pos2 int IN 否 lob2起始偏移量。 PKG_UTIL.LOB_MATCH 该函数LOB_MATCH返回pattern出现在lob对象中第match_nth次的位置。 PKG_UTIL.LOB_MATCH函数原型为： 1 2 3 4 5 6 7 PKG_UTIL.LOB_MATCH( lob IN anyelement, pattern IN anyelement, start IN int, match_nth IN int default 1 ) RETURN INTEGER; 表7 PKG_UTIL.LOB_MATCH接口参数说明 参数 类型 入参/出参 是否可以为空 描述 lob clob/blob IN 否 待比较的字符串。 pattern clob/blob IN 否 待匹配的pattern。 start int IN 否 lob的起始比较位置。 match_nth int IN 否 第几次匹配到。 PKG_UTIL.LOB_RESET 该函数LOB_RESET清除一段数据为字符value。 PKG_UTIL.LOB_RESET函数原型为： 1 2 3 4 5 6 7 PKG_UTIL.LOB_RESET( lob IN blob, len IN int, start IN int， value IN int default 0 ) RETURN record; 表8 PKG_UTIL.LOB_RESET接口参数说明 参数 类型 入参/出参 是否可以为空 描述 lob blob IN 否 待重置的字符串。 len int IN 否 重置的长度。 start int IN 否 重置的起始位置。 value int IN 是 设置的字符。默认值‘0’。 PKG_UTIL.IO_PRINT 该函数IO_PRINT将一段字符串打印输出。 PKG_UTIL.IO_PRINT函数原型为： 1 2 3 4 5 PKG_UTIL.IO_PRINT( format IN text, is_one_line IN boolean ) RETURN void; 表9 PKG_UTIL.IO_PRINT接口参数说明 参数 类型 入参/出参 是否可以为空 描述 format text IN 否 待打印输出的字符串。 is_one_line boolean IN 否 是否输出为一行。 PKG_UTIL.RAW_GET_LENGTH 该函数RAW_GET_LENGTH获取raw的长度。 PKG_UTIL.RAW_GET_LENGTH函数原型为： 1 2 3 4 PKG_UTIL.RAW_GET_LENGTH( value IN raw ) RETURN integer; 表10 PKG_UTIL.RAW_GET_LENGTH接口参数说明 参数 类型 入参/出参 是否可以为空 描述 raw raw IN 否 待获取长度的对象。 PKG_UTIL.RAW_CAST_FROM_VARCHAR2 该函数RAW_CAST_FROM_VARCHAR2将varchar2转化为raw。 PKG_UTIL.RAW_CAST_FROM_VARCHAR2函数原型为： 1 2 3 4 PKG_UTIL.RAW_CAST_FROM_VARCHAR2( str IN varchar2 ) RETURN raw; 表11 PKG_UTIL.RAW_CAST_FROM_VARCHAR2接口参数说明 参数 类型 入参/出参 是否可以为空 描述 str varchar2 IN 否 需要转化的源数据。 PKG_UTIL.RANDOM_SET_SEED 该函数RANDOM_SET_SEED设置随机数种子。 PKG_UTIL.RANDOM_SET_SEED函数原型为： 1 2 3 4 PKG_UTIL.RANDOM_SET_SEED( seed IN int ) RETURN integer; 表12 PKG_UTIL.RANDOM_SET_SEED接口参数说明 参数 类型 入参/出参 是否可以为空 描述 seed int IN 否 随机数种子。 PKG_UTIL.RANDOM_GET_VALUE 该函数RANDOM_GET_VALUE返回0~1区间的一个随机数，其有效数字为15位。 PKG_UTIL.RANDOM_GET_VALUE函数原型为： 1 2 3 PKG_UTIL.RANDOM_GET_VALUE( ) RETURN numeric; PKG_UTIL.FILE_SET_DIRNAME 设置当前操作的目录，基本上所有涉及单个目录的操作，都需要调用此方法先设置操作的目录。 PKG_UTIL.FILE_SET_DIRNAME函数原型为： 1 2 3 4 PKG_UTIL.FILE_SET_DIRNAME( dir IN text ) RETURN bool 表13 PKG_UTIL.FILE_SET_DIRNAME接口参数说明 参数 描述 dirname 文件的目录位置，这个字符串是一个目录对象名。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误， 下面的涉及location作为参数的函数也是同样的情况。 PKG_UTIL.FILE_OPEN 该函数用来打开一个文件，最多可以同时打开50个文件。并且该函数返回INTEGER类型的一个句柄。 PKG_UTIL.FILE_OPEN函数原型为： 1 2 3 PKG_UTIL.FILE_OPEN( file_name IN text, open_mode IN integer) 表14 PKG_UTIL.FILE_OPEN接口参数说明 参数 描述 file_name 文件名，包含扩展（文件类型），不包括路径名。如果文件名中包含路径，在OPEN中会被忽略，在Unix系统中，文件名不能以/.结尾。 open_mode 指定文件的打开模式，包含r：read text，w: write text和a: append text。 说明： 对于写操作，会检测文件类型，如果写入elf文件，将会报错并退出。 PKG_UTIL.FILE_SET_MAX_LINE_SIZE 设置写入文件一行的最大长度。 PKG_UTIL.FILE_SET_MAX_LINE_SIZE函数原型为： 1 2 3 PKG_UTIL.FILE_SET_MAX_LINE_SIZE( max_line_size in integer) RETURN BOOL 表15 PKG_UTIL.FILE_SET_MAX_LINE_SIZE接口参数说明 参数 描述 max_line_size 每行最大字符数，包含换行符（最小值是1，最大值是32767）。如果没有指定，会指定一个默认值1024。 PKG_UTIL.FILE_IS_CLOSE 检测一个文件句柄是否关闭。 PKG_UTIL.FILE_IS_CLOSE函数原型为： 1 2 3 4 PKG_UTIL.FILE_IS_CLOSE( file in integer ) RETURN BOOL 表16 PKG_UTIL.FILE_IS_CLOSE接口参数说明 参数 描述 file 一个打开的文件句柄。 PKG_UTIL.FILE_READ 根据指定的长度从一个打开的文件句柄中读取出数据。 PKG_UTIL.FILE_READ函数原型为： 1 2 3 4 PKG_UTIL.FILE_READ( file IN integer, buffer OUT text, len IN bigint default 1024) 表17 PKG_UTIL.FILE_READ接口参数说明 参数 描述 file 通过调用OPEN打开的文件句柄，文件必须以读的模式打开，否则会抛出INVALID_OPERATION的异常。 buffer 用于接收数据的BUFFER。 len 从文件中读取的字节数。 PKG_UTIL.FILE_READLINE 根据指定的长度从一个打开的文件句柄中读取出一行数据。 PKG_UTIL.FILE_READLINE函数原型为： 1 2 3 4 PKG_UTIL.FILE_READLINE( file IN integer, buffer OUT text, len IN integer default NULL) 表18 PKG_UTIL.FILE_READLINE接口参数说明 参数 描述 file 通过调用OPEN打开的文件句柄，文件必须以读的模式打开，否则会抛出INVALID_OPERATION的异常。 buffer 用于接收数据的BUFFER。 len 从文件中读取的字节数，默认是NULL。如果是默认NULL，会使用max_line_size来指定大小。 PKG_UTIL.FILE_WRITE 将BUFFER中指定的数据写入到文件中。 PKG_UTIL.FILE_WRITE函数原型为： 1 2 3 4 5 PKG_UTIL.FILE_WRITE( file in integer, buffer in text ) RETURN BOOL 表19 PKG_UTIL.FILE_WRITE接口参数说明 参数 描述 file 一个打开的文件句柄。 buffer 要写入文件的文本数据，BUFFER的最大值是32767个字节。如果没有指定值，默认是1024个字节，没有刷新到文件之前，一系列的PUT操作的BUFFER总和不能超过32767个字节。 说明： 对于写操作，会检测文件类型，如果写入elf文件，将会报错并退出。 PKG_UTIL.FILE_NEWLINE 向一个打开的文件中写入一个行终结符。行终结符和平台相关。 PKG_UTIL.FILE_NEWLINE函数原型为： 1 2 3 4 PKG_UTIL.FILE_NEWLINE( file in integer ) RETURN BOOL 表20 PKG_UTIL.FILE_NEWLINE接口参数说明 参数 描述 file 一个打开的文件句柄。 PKG_UTIL.FILE_WRITELINE 向一个打开的文件中写入一行。 PKG_UTIL.FILE_WRITELINE函数原型为： 1 2 3 4 5 PKG_UTIL.FILE_WRITELINE( file in integer, buffer in text ) RETURN BOOL 表21 PKG_UTIL.FILE_WRITELINE接口参数说明 参数 描述 file 一个打开的文件句柄。 buffer 要写入的内容 PKG_UTIL.FILE_READ_RAW 从一个打开的文件句柄中读取指定长度的二进制数据，返回读取的二进制数据，返回类型为raw。 PKG_UTIL.FILE_READ_RAW函数原型为： 1 2 3 4 5 PKG_UTIL.FILE_READ_RAW( file in integer, length in integer default NULL ) RETURN raw 表22 PKG_UTIL.FILE_READ_RAW接口参数说明 参数 描述 file 一个打开的文件句柄。 length 要读取的长度，默认为NULL。默认情况下读取文件中所有数据，最大为1G。 PKG_UTIL.FILE_WRITE_RAW 向一个打开的文件中写入传入二进制对象RAW。插入成功返回true。 PKG_UTIL.FILE_WRITE_RAW函数原型为： 1 2 3 4 5 PKG_UTIL.FILE_WRITE_RAW( file in integer, r in raw ) RETURN BOOL 表23 PKG_UTIL.FILE_WRITE_RAW接口参数说明 参数 描述 file 一个打开的文件句柄。 r 准备传入文件的数据 说明： 对于写操作，会检测文件类型，如果写入elf文件，将会报错并退出。 PKG_UTIL.FILE_FLUSH 一个文件句柄中的数据要写入到物理文件中，缓冲区中的数据必须要有一个行终结符。当文件必须在打开时读取，刷新非常有用。例如，调试信息可以刷新到文件中，以便立即读取。 PKG_UTIL.FILE_FLUSH函数原型为： 1 2 3 4 PKG_UTIL.FILE_FLUSH（ file in integer ） RETURN VOID 表24 PKG_UTIL.FILE_FLUSH接口参数说明 参数 描述 file 一个打开的文件句柄。 PKG_UTIL.FILE_CLOSE 关闭一个打开的文件句柄。 PKG_UTIL.FILE_CLOSE函数原型为： 1 2 3 4 PKG_UTIL.FILE_CLOSE（ file in integer ） RETURN BOOL 表25 PKG_UTIL.FILE_CLOSE接口参数说明 参数 描述 file 一个打开的文件句柄。 PKG_UTIL.FILE_REMOVE 删除一个磁盘文件，操作的时候需要有充分的权限。 PKG_UTIL.FILE_REMOVE函数原型为： 1 2 3 4 PKG_UTIL.FILE_REMOVE( file_name in text ) RETURN VOID 表26 PKG_UTIL.FILE_REMOVE接口参数说明 参数 描述 filen_ame 要删除的文件名 PKG_UTIL.FILE_RENAME 对于磁盘上的文件进行重命名，类似Unix的mv。 PKG_UTIL.FILE_RENAME函数原型为： 1 2 3 4 5 6 PKG_UTIL.FILE_RENAME( src_dir in text, src_file_name in text, dest_dir in text, dest_file_name in text, overwrite boolean default false) 表27 PKG_UTIL.FILE_RENAME接口参数说明 参数 描述 src_dir 源文件目录（大小写敏感）。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 src_file_name 源文件名。 dest_dir 目标文件目录（大小写敏感）。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 dest_file_name 目标文件名。 overwrite 默认是false，如果目的目录下存在一个同名的文件，不会进行重写。 PKG_UTIL.FILE_SIZE 返回指定的文件大小。 PKG_UTIL.FILE_SIZE函数原型为： 1 2 3 bigint PKG_UTIL.FILE_SIZE( file_name in text )return bigint 表28 PKG_UTIL.FILE_SIZE接口参数说明 参数 描述 file_name 文件名 PKG_UTIL.FILE_BLOCK_SIZE 返回指定的文件含有的块数量。 PKG_UTIL.FILE_BLOCK_SIZE函数原型为： 1 2 3 bigint PKG_UTIL.FILE_BLOCK_SIZE( file_name in text )return bigint 表29 PKG_UTIL.FILE_BLOCK_SIZE接口参数说明 参数 描述 file_name 文件名 PKG_UTIL.FILE_EXISTS 判断指定的文件是否存在。 PKG_UTIL.FILE_EXISTS函数原型为： 1 2 3 4 PKG_UTIL.FILE_EXISTS( file_name in text ) RETURN BOOL 表30 PKG_UTIL.FILE_EXISTS接口参数说明 参数 描述 file_name 文件名 PKG_UTIL.FILE_GETPOS 返回文件的偏移量，单位字节。 PKG_UTIL.FILE_GETPOS函数原型为： 1 2 3 4 PKG_UTIL.FILE_GETPOS( file in integer ) RETURN BIGINT 表31 PKG_UTIL.FILE_GETPOS接口参数说明 参数 描述 file 一个打开的文件句柄。 PKG_UTIL.FILE_SEEK 根据用户指定的字节数向前或者向后调整文件指针的位置。 PKG_UTIL.FILE_SEEK函数原型为： 1 2 3 4 5 void PKG_UTIL.FILE_SEEK( file in integer, start in bigint ) RETURN VOID 表32 PKG_UTIL.FILE_SEEK接口参数说明 参数 描述 file 一个打开的文件句柄。 start 文件偏移，字节。 PKG_UTIL.FILE_CLOSE_ALL 关闭一个会话中打开的所有的文件句柄。 PKG_UTIL.FILE_CLOSE_ALL函数原型为： PKG_UTIL.FILE_CLOSE_ALL( ) RETURN VOID↵ 表33 PKG_UTIL.FILE_CLOSE_ALL接口参数说明 参数 描述 无 无 PKG_UTIL.EXCEPTION_REPORT_ERROR 抛出一个异常。 PKG_UTIL.EXCEPTION_REPORT_ERROR函数原型为： 1 2 3 4 5 6 PKG_UTIL.EXCEPTION_REPORT_ERROR( code integer， log text, flag boolean DEFAULT false ) RETURN INTEGER 表34 PKG_UTIL.EXCEPTION_REPORT_ERROR接口参数说明 参数 描述 code 抛异常所打印的错误码。 log 抛异常所打印的日志提示信息。 flag 保留字段，默认为false。 PKG_UTIL.app_read_client_info 读取client_info信息 PKG_UTIL.app_read_client_info函数原型为： 1 2 3 PKG_UTIL.app_read_client_info( OUT buffer text )return text 表35 PKG_UTIL.app_read_client_info接口参数说明 参数 描述 buffer 返回的client_info信息 PKG_UTIL.app_set_client_info 设置client_info信息 PKG_UTIL.app_set_client_info函数原型为： 1 2 3 PKG_UTIL.app_set_client_info( str text ) 表36 PKG_UTIL.app_set_client_info接口参数说明 参数 描述 str 要设置的client_info信息 PKG_UTIL.lob_converttoblob 将clob转成blob，amout为要转换的长度 PKG_UTIL.lob_converttoblob函数原型为： 1 2 3 4 5 6 7 PKG_UTIL.lob_converttoblob( dest_lob blob, src_clob clob, amount integer, dest_offset integer, src_offset integer )return raw 表37 PKG_UTIL.lob_converttoblob接口参数说明 参数 描述 dest_lob 目标lob src_clob 要转换的clob amount 转换的长度 dest_offset 目标lob的起始位置 src_offset 源clob的起始位置 PKG_UTIL.lob_converttoclob 将blob转成clob，amout为要转换的长度 PKG_UTIL.lob_converttoclob函数原型为： 1 2 3 4 5 6 7 PKG_UTIL.lob_converttoclob( dest_lob clob, src_blob blob, amount integer, dest_offset integer, src_offset integer )return text 表38 PKG_UTIL.lob_converttoclob接口参数说明 参数 描述 dest_lob 目标lob src_blob 要转换的blob amount 转换的长度 dest_offset 目标lob的起始位置 src_offset 源clob的起始位置 PKG_UTIL.lob_texttoraw 将text转成raw PKG_UTIL.lob_texttoraw函数原型为： 1 2 3 4 PKG_UTIL.lob_texttoraw( src_lob clob ) RETURN raw 表39 PKG_UTIL.lob_texttoraw接口参数说明 参数 描述 src_lob 要转换的lob数据 PKG_UTIL.match_edit_distance_similarity 计算两个字符串的差别 PKG_UTIL.match_edit_distance_similarity函数原型为： 1 2 3 4 5 PKG_UTIL.match_edit_distance_similarity( str1 text, str2 text ) RETURN INTEGER 表40 PKG_UTIL.match_edit_distance_similarity接口参数说明 参数 描述 str1 第一个字符串 str2 第二个字符串 PKG_UTIL.raw_cast_to_varchar2 raw类型转成varchar2。 PKG_UTIL.raw_cast_to_varchar2函数原型为： 1 2 3 4 PKG_UTIL.raw_cast_to_varchar2( str raw ) RETURN varchar2 表41 PKG_UTIL.raw_cast_to_varchar2接口参数说明 参数 描述 str 十六进制字符串 PKG_UTIL.session_clear_context 清除session_context信息 PKG_UTIL.session_clear_context函数原型为： 1 2 3 4 5 6 PKG_UTIL.session_clear_context( namespace text, client_identifier text, attribute text ) RETURN INTEGER 表42 PKG_UTIL.session_clear_context接口参数说明 参数 描述 namespace 属性的命名空间 client_identifier client_identifier，一般与namespace即可，当为null时，默认修改所有namesapce attribute 要清除的属性值 PKG_UTIL.session_search_context 查找属性值 PKG_UTIL.session_clear_context函数原型为： 1 2 3 4 5 PKG_UTIL.session_clear_context( namespace text, attribute text ) RETURN INTEGER 表43 PKG_UTIL.session_clear_context接口参数说明 参数 描述 namespace 属性的命名空间 attribute 要清除的属性值 PKG_UTIL.session_set_context 设置属性值 PKG_UTIL.session_set_context函数原型为： 1 2 3 4 5 6 PKG_UTIL.session_set_context( namespace text, attribute text, value text ) RETURN INTEGER 表44 PKG_UTIL.session_set_context接口参数说明 参数 描述 namespace 属性的命名空间 attribute 要设置的属性 value 属性对应的值 PKG_UTIL.utility_get_time 打印unix时间戳。 PKG_UTIL.utility_get_time函数原型为： 1 2 PKG_UTIL.utility_get_time() RETURN bigint PKG_UTIL.utility_format_error_backtrace 查看存储过程的错误堆栈。 PKG_UTIL.utility_format_error_backtrace函数原型为： 1 2 PKG_UTIL.utility_format_error_backtrace() RETURN text PKG_UTIL.utility_format_error_stack 查看存储过程的报错信息。 PKG_UTIL.utility_format_error_stack函数原型为： 1 2 PKG_UTIL.utility_format_error_stack() RETURN text PKG_UTIL.utility_format_call_stack 查看存储过程调用堆栈。 PKG_UTIL.utility_format_call_stack函数原型为： 1 2 PKG_UTIL.utility_format_call_stack() RETURN text 父主题： 基础接口

示例 强制使用Custom Plan 1 2 3 4 set enable_fast_query_shipping = off; create table t (a int, b int, c int); prepare p as select /*+ use_cplan */ * from t where a = $1; explain execute p(1); 计划如下。可以看到过滤条件为入参的实际值，即此计划为Custom Plan。 强制使用Generic Plan 1 2 3 deallocate p; prepare p as select /*+ use_gplan */ * from t where a = $1; explain execute p(1); 计划如下。可以看到过滤条件为待填充的入参，即此计划为Generic Plan。

算子级调优介绍 一个查询语句要经过多个算子步骤才会输出最终的结果。由于各别算子耗时过长导致整体查询性能下降的情况比较常见。这些算子是整个查询的瓶颈算子。通用的优化手段是EXPLAIN ANALYZE/PERFORMANCE命令查看执行过程的瓶颈算子，然后进行针对性优化。 如下面的执行过程信息中，Hashagg算子的执行时间占总时间的：(51016-13535)/ 56476 ≈66%，此处Hashagg算子就是这个查询的瓶颈算子，在进行性能优化时应当优先考虑此算子的优化。

文档概念 文档是全文搜索系统的搜索单元，例如：杂志上的一篇文章或电子邮件消息。文本搜索引擎必须能够解析文档，而且可以存储父文档的关联词素（关键词）。后续，这些关联词素用来搜索包含查询词的文档。 在GaussDB中，文档通常是一个数据库表中一行的文本字段，或者这些字段的可能组合（级联）。文档可能存储在多个表中或者需动态获取。换句话说，一个文档由被索引化的不同部分构成，因此无法存储为一个整体。比如： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# SELECT d_dow || '-' || d_dom || '-' || d_fy_week_seq AS identify_serials FROM tpcds.date_dim WHERE d_fy_week_seq = 1; identify_serials ------------------ 5-6-1 0-8-1 2-3-1 3-4-1 4-5-1 1-2-1 6-7-1 (7 rows) 实际上，在这些示例查询中，应该使用coalesce防止一个独立的NULL属性导致整个文档的NULL结果。 另外一种可能是：文档在文件系统中作为简单的文本文件存储。在这种情况下，数据库可以用于存储全文索引并且执行搜索，同时可以使用一些唯一标识从文件系统中检索文档。然而，从数据库外部检索文件需要拥有系统管理员权限或者特殊函数支持。因此，还是将所有数据保存在数据库中比较方便。同时，将所有数据保存在数据库中可以方便地访问文档元数据以便于索引和显示。 为了实现文本搜索目的，必须将每个文档减少至预处理后的tsvector格式。搜索和相关性排序都是在tsvector形式的文档上执行的。原始文档只有在被选中要呈现给用户时才会被检索。因此，我们常将tsvector说成文档，但是很显然其实它只是完整文档的一种紧凑表示。 父主题： 介绍

原型 1 2 3 4 5 6 7 SQLRETURN SQLColAttibute(SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLUSMALLINT FieldIdentifier, SQLPOINTER CharacterAtrriburePtr, SQLSMALLINT BufferLength, SQLSMALLINT *StringLengthPtr, SQLPOINTE NumericAttributePtr);

参数 表1 SQLColAttribute参数 关键字 参数说明 StatementHandle 语句句柄。 ColumnNumber 要检索字段的列号，起始为1，依次递增。 FieldIdentifier IRD中ColumnNumber行的字段。 CharacterAttributePtr 输出参数：一个缓冲区指针，返回FieldIdentifier字段值。 BufferLength 如果FieldIdentifier是一个ODBC定义的字段，而且CharacterAttributePtr指向一个字符串或二进制缓冲区，则此参数为该缓冲区的长度。 如果FieldIdentifier是一个ODBC定义的字段，而且CharacterAttributePtr指向一个整数，则会忽略该字段。 StringLengthPtr 输出参数：缓冲区指针，存放*CharacterAttributePtr中字符类型数据的字节总数，对于非字符类型，忽略BufferLength的值。 NumericAttributePtr 输出参数：指向一个整型缓冲区的指针，返回IRD中ColumnNumber行FieldIdentifier字段的值。

示例 1 2 3 4 5 6 7 8 9 10 11 12 13 --创建一个角色role1。 openGauss=# CREATE ROLE role1 IDENTIFIED BY 'xxxxxxxxxxx'; -- 为用户role1创建一个同名schema，子命令创建的表films和winners的拥有者为role1。 openGauss=# CREATE SCHEMA AUTHORIZATION role1 CREATE TABLE films (title text, release date, awards text[]) CREATE VIEW winners AS SELECT title, release FROM films WHERE awards IS NOT NULL; --删除schema。 openGauss=# DROP SCHEMA role1 CASCADE; --删除用户。 openGauss=# DROP USER role1 CASCADE;

语法格式 根据指定的名称创建模式。 1 2 CREATE SCHEMA schema_name [ AUTHORIZATION user_name ] [WITH BLOCKCHAIN] [ schema_element [ ... ] ]; 根据用户名创建模式。 1 CREATE SCHEMA AUTHORIZATION user_name [ schema_element [ ... ] ];

参数说明 schema_name 模式名称。 模式名不能和当前数据库里其他的模式重名。 模式的名称不可以“pg_”开头。 取值范围：字符串，要符合标识符的命名规范。 AUTHORIZATION user_name 指定模式的所有者。当不指定schema_name时，把user_name当作模式名，此时user_name只能是角色名。 取值范围：已存在的用户名/角色名。 WITH BLOCKCHAIN 指定模式的防篡改属性。防篡改模式下的普通行存表为防篡改用户表。 schema_element 在模式里创建对象的SQL语句。目前仅支持CREATE TABLE、CREATE VIEW、CREATE INDEX、CREATE PARTITION、GRANT子句。 子命令所创建的对象都被AUTHORIZATION子句指定的用户所拥有。 如果当前搜索路径上的模式中存在同名对象时，需要明确指定引用对象所在的模式。可以通过命令SHOW SEARCH_PATH来查看当前搜索路径上的模式。

恢复控制函数 恢复信息函数提供了当前备机状态的信息。这些函数可能在恢复期间或正常运行中执行。 pg_is_in_recovery() 描述：如果恢复仍然在进行中则返回true。 返回值类型：bool pg_last_xlog_receive_location() 描述：获取最后接收事务日志的位置并通过流复制将其同步到磁盘。当流复制正在进行时，事务日志将持续递增。如果恢复已完成，则最后一次获取的WAL记录会被静态保持并在恢复过程中同步到磁盘。如果流复制不可用，或还没有开始，这个函数返回NULL。 返回值类型：text pg_last_xlog_replay_location() 描述：获取最后一个事务日志在恢复时重放的位置。如果恢复仍在进行，事务日志将持续递增。如果已经完成恢复，则将保持在恢复期间最后接收WAL记录的值。如果未进行恢复但服务器正常启动时，则这个函数返回NULL。 返回值类型：text pg_last_xact_replay_timestamp() 描述：获取最后一个事务在恢复时重放的时间戳。这是为在主节点上生成事务提交或终止WAL记录的时间。如果在恢复时没有事务重放，则这个函数返回NULL。如果恢复仍在进行，则事务日志将持续递增。如果恢复已经完成，则将保持在恢复期间最后接收WAL记录的值。如果服务器无需恢复就已正常启动，则这个函数返回NULL。 返回值类型：timestamp with time zone 恢复控制函数控制恢复的进程。这些函数可能只在恢复时被执行。 pg_is_xlog_replay_paused() 描述：如果恢复暂停则返回true。 返回值类型：bool pg_xlog_replay_pause() 描述：立即暂停恢复。 返回值类型：void pg_xlog_replay_resume() 描述：如果恢复处于暂停状态，则重新启动。 返回值类型：void gs_get_active_archiving_standby() 描述：查询同一分片内归档备机的信息。返回备机名，备机归档位置和已归档日志个数。 返回值类型：text，text，int gs_pitr_get_warning_for_xlog_force_recycle() 描述：查询开启归档后是否因归档槽不推进日志大量堆积导致日志被回收。 返回值类型：bool gs_pitr_clean_history_global_barriers(stop_barrier_timestamp cstring) 描述：清理指定时间之前所有barrier记录。返回最老的barrier记录。入参为cstring类型，linux时间戳。需要管理员角色或运维管理员角色执行。 返回值类型：text gs_pitr_archive_slot_force_advance(stop_barrier_timestamp cstring) 描述：强制推进归档槽，并清理不需要的barrier记录。返回新的归档槽位置。入参为cstring类型，linux时间戳。需要管理员角色或运维管理员角色执行。 返回值类型：text 当恢复暂停时，没有发生数据库更改。如果是在热备里，所有新的查询将看到一致的数据库快照，并且不会有进一步的查询冲突产生，直到恢复继续。 如果不能使用流复制，则暂停状态将无限的延续。当流复制正在进行时，将连续接收WAL记录，最终将填满可用磁盘空间，这个进度取决于暂停的持续时间，WAL生成的速度和可用的磁盘空间。

备份控制函数 备份控制函数可帮助进行在线备份。 pg_create_restore_point(name text) 描述：为执行恢复创建一个命名点。（需要管理员角色） 返回值类型：text 备注：pg_create_restore_point创建了一个可以用作恢复目的、有命名的事务日志记录，并返回相应的事务日志位置。在恢复过程中，recovery_target_name可以通过这个名称定位对应的日志恢复点，并从此处开始执行恢复操作。避免使用相同的名称创建多个恢复点，因为恢复操作将在第一个匹配（恢复目标）的名称上停止。 pg_current_xlog_location() 描述：获取当前事务日志的写入位置。 返回值类型：text 备注：pg_current_xlog_location使用与前面那些函数相同的格式显示当前事务日志的写入位置。如果是只读操作，不需要系统管理员权限。 pg_current_xlog_insert_location() 描述：获取当前事务日志的插入位置。 返回值类型：text 备注：pg_current_xlog_insert_location显示当前事务日志的插入位置。插入点是事务日志在某个瞬间的“逻辑终点”，而实际的写入位置则是从服务器内部缓冲区写出时的终点。写入位置是可以从服务器外部检测到的终点，如果要归档部分完成事务日志文件，则该操作即可实现。插入点主要用于服务器调试目的。如果是只读操作，不需要系统管理员权限。 gs_current_xlog_insert_end_location() 描述：获取当前事务日志的插入位置。 返回值类型：text 备注：gs_current_xlog_insert_end_location显示当前事务日志的实际插入位置。 pg_start_backup(label text, is_full_backup boolean) 描述：开始执行在线备份（需要管理员角色、复制的角色或运维管理员角色打开operate_mode）。以gs_roach开头的label串为保留命名串，只能由内部备份工具GaussRoach使用。 返回值类型：text 备注：pg_start_backup接受一个用户定义的备份标签（通常这是备份转储文件存放地点的名称）。这个函数向数据库集群的数据目录写入一个备份标签文件，然后以文本方式返回备份的事务日志起始位置。 1 2 3 4 5 openGauss=# SELECT pg_start_backup('label_goes_here',true); pg_start_backup ----------------- 0/3000020 (1 row) pg_stop_backup() 描述：完成执行在线备份。需要管理员角色或复制的角色执行。 返回值类型：text 备注：pg_stop_backup删除pg_start_backup创建的标签文件，并且在事务日志归档区里创建一个备份历史文件。这个历史文件包含给予pg_start_backup的标签、备份的事务日志起始与终止位置、备份的起始和终止时间。返回值是备份的事务日志终止位置。计算出中止位置后，当前事务日志的插入点将自动前进到下一个事务日志文件，这样，结束的事务日志文件可以被立即归档从而完成备份。 pg_switch_xlog() 描述：切换到一个新的事务日志文件。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：text 备注：pg_switch_xlog移动到下一个事务日志文件，以允许将当前日志文件归档（假定使用连续归档）。返回值是刚完成的事务日志文件的事务日志结束位置+1。如果从最后一次事务日志切换以来没有活动的事务日志，则pg_switch_xlog什么事也不做，直接返回当前事务日志文件的开始位置。 pg_xlogfile_name(location text) 描述：将事务日志的位置字符串转换为文件名。 返回值类型：text 备注：pg_xlogfile_name仅抽取事务日志文件名称。如果给定的事务日志位置恰好位于事务日志文件的交界上，这两个函数都返回前一个事务日志文件的名称。这对于管理事务日志归档来说是非常有利的，因为前一个文件是当前最后一个需要归档的文件。 pg_xlogfile_name_offset(location text) 描述：将事务日志的位置字符串转换为文件名并返回在文件中的字节偏移量。 返回值类型：text,integer 备注：可以使用pg_xlogfile_name_offset从前述函数的返回结果中抽取相应的事务日志文件名称和字节偏移量。例如： 1 2 3 4 5 6 7 openGauss=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); NOTICE: pg_stop_backup cleanup done, waiting for required WAL segments to be archived NOTICE: pg_stop_backup complete, all required WAL segments have been archived file_name | file_offset --------------------------+------------- 000000010000000000000003 | 272 (1 row) pg_xlog_location_diff(location text, location text) 描述：计算两个事务日志位置之间在字节上的区别。 返回值类型：numeric pg_cbm_tracked_location() 描述：用于查询cbm解析到的lsn位置。 返回值类型：text pg_cbm_get_merged_file(startLSNArg text, endLSNArg text) 描述：用于将指定lsn范围之内的cbm文件合并成一个cbm文件，并返回合并完的cbm文件名。 返回值类型：text 备注：必须是系统管理员或运维管理员才能获取cbm合并文件。 pg_cbm_get_changed_block(startLSNArg text, endLSNArg text) 描述：用于将指定lsn范围之内的cbm文件合并成一个表，并返回表的各行记录。 返回值类型：records 备注：pg_cbm_get_changed_block返回的表字段包含：合并起始的lsn，合并截止的lsn，表空间oid，库oid，表的relfilenode，表的fork number，表是否被删除，表是否被创建，表是否被截断，表被截断后的页面数，有多少页被修改以及被修改的页号的列表。 pg_cbm_recycle_file(targetLSNArg text) 描述：删除不再使用的cbm文件，并返回删除后的第一条lsn。 返回值类型：text pg_cbm_force_track(targetLSNArg text,timeOut int) 描述：强制执行一次cbm追踪到指定的xlog位置，并返回实际追踪结束点的xlog位置。 返回值类型：text pg_enable_delay_ddl_recycle() 描述：开启延迟DDL功能，并返回开启点的xlog位置。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：text pg_disable_delay_ddl_recycle(barrierLSNArg text, isForce bool) 描述：关闭延迟DDL功能，并返回本次延迟DDL生效的xlog范围。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：records pg_enable_delay_xlog_recycle() 描述：开启延迟xlog回收功能，cn修复使用。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：void pg_disable_delay_xlog_recycle() 描述：关闭延迟xlog回收功能，cn修复使用。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：void pg_cbm_rotate_file(rotate_lsn text) 描述：等待cbm解析到rotate_lsn之后，强制切换文件，在build期间调用。 返回值类型：void。 gs_roach_stop_backup(backupid text) 描述：停止一个内部备份工具GaussRoach开启的备份。与pg_stop_backup系统函数类似，但更轻量。 返回值类型：text，内容为当前日志的插入位置。 gs_roach_enable_delay_ddl_recycle(backupid name) 描述：开启延迟DDL功能，并返回开启点的日志位置。与pg_enable_delay_ddl_recycle系统函数类似，但更轻量。并且，通过传入不同的backupid，可以支持并发打开延迟DDL。 返回值类型：text，内容为返回开启点的日志位置。 gs_roach_disable_delay_ddl_recycle(backupid text) 描述：关闭延迟DDL功能，并返回本次延迟DDL生效的日志范围，并删除该范围内被用户删除的列存表物理文件。与pg_enable_delay_ddl_recycle系统函数类似，但更轻量。并且，通过传入不同的backupid，可以支持并发关闭延迟DDL功能。 返回值类型：records，内容为本次延迟DDL生效的日志范围。 gs_roach_switch_xlog(request_ckpt bool) 描述：切换当前使用的日志段文件，并且，如果request_ckpt 为true，则触发一个全量检查点。 返回值类型：text，内容为切段日志的位置。 gs_block_dw_io(timeout int, identifier text) 描述：阻塞双写页面刷盘。 参数说明： timeout 阻塞时长。 取值范围：[0, 3600]（秒），0为阻塞时长为0。 identifier 此次操作的标识。 取值范围：字符串，不支持除大小写字母，数字，以及下划线(_)以外的字符。 返回值类型：bool 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。 gs_is_dw_io_blocked() 描述：查看当前双写页面刷盘是否被阻塞，如果处于阻塞中则返回true。 返回值类型：bool 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。

操作步骤 使用CREATE TABLE AS语句创建表customer_t的临时表副本customer_t_temp。 1 openGauss=# CREATE TEMP TABLE customer_t_temp AS SELECT * FROM customer_t; 与使用永久表相比，使用临时表可以提高性能，但存在丢失数据的风险。临时表只在当前会话可见，本会话结束后将自动删除。如果数据丢失是不可接受的，请使用永久表。 临时表与普通表的存放位置无差，也可指定tablespace存放。本地临时表应用过多可能会导致系统表膨胀，但总体影响在可接受范围内。 截断当前表customer_t。 1 openGauss=# TRUNCATE customer_t; 使用INSERT INTO…SELECT语句从副本中向原始表中填充数据。 1 openGauss=# INSERT INTO customer_t (SELECT * FROM customer_t_temp); 删除临时表副本customer_t_temp。 1 openGauss=# DROP TABLE customer_t_temp;

时间段输入 reltime的输入方式可以采用任何合法的时间段文本格式，包括数字形式（含负数和小数）及时间形式，其中时间形式的输入支持SQL标准格式、ISO-8601格式、POSTGRES格式等。另外，文本输入需要加单引号。 时间段输入的详细信息请参考表6 时间段输入。 表6 时间段输入 输入示例 输出结果 描述 60 2 mons 采用数字表示时间段，默认单位是day，可以是小数或负数。特别的，负数时间段，在语义上，可以理解为“早于多久”。 31.25 1 mons 1 days 06:00:00 -365 -12 mons -5 days 1 years 1 mons 8 days 12:00:00 1 years 1 mons 8 days 12:00:00 采用POSTGRES格式表示时间段，可以正负混用，不区分大小写，输出结果为将输入时间段计算并转换得到的简化POSTGRES格式时间段。 -13 months -10 hours -1 years -25 days -04:00:00 -2 YEARS +5 MONTHS 10 DAYS -1 years -6 mons -25 days -06:00:00 P-1.1Y10M -3 mons -5 days -06:00:00 采用ISO-8601格式表示时间段，可以正负混用，不区分大小写，输出结果为将输入时间段计算并转换得到的简化POSTGRES格式时间段。 -12H -12:00:00 示例： 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 --创建表。 openGauss=# CREATE TABLE reltime_type_tab(col1 character(30), col2 reltime); --插入数据。 openGauss=# INSERT INTO reltime_type_tab VALUES ('90', '90'); openGauss=# INSERT INTO reltime_type_tab VALUES ('-366', '-366'); openGauss=# INSERT INTO reltime_type_tab VALUES ('1975.25', '1975.25'); openGauss=# INSERT INTO reltime_type_tab VALUES ('-2 YEARS +5 MONTHS 10 DAYS', '-2 YEARS +5 MONTHS 10 DAYS'); openGauss=# INSERT INTO reltime_type_tab VALUES ('30 DAYS 12:00:00', '30 DAYS 12:00:00'); openGauss=# INSERT INTO reltime_type_tab VALUES ('P-1.1Y10M', 'P-1.1Y10M'); --查看数据。 openGauss=# SELECT * FROM reltime_type_tab; col1 | col2 --------------------------------+------------------------------------- 1975.25 | 5 years 4 mons 29 days -2 YEARS +5 MONTHS 10 DAYS | -1 years -6 mons -25 days -06:00:00 P-1.1Y10M | -3 mons -5 days -06:00:00 -366 | -1 years -18:00:00 90 | 3 mons 30 DAYS 12:00:00 | 1 mon 12:00:00 (6 rows) --删除表。 openGauss=# DROP TABLE reltime_type_tab;

日期输入 日期和时间的输入几乎可以是任何合理的格式，包括ISO-8601格式、SQL-兼容格式、传统POSTGRES格式或者其它的形式。系统支持按照日、月、年的顺序自定义日期输入。如果把DateStyle参数设置为MDY就按照“月-日-年”解析，设置为DMY就按照“日-月-年”解析，设置为YMD就按照“年-月-日”解析。 日期的文本输入需要加单引号包围，语法如下： type [ ( p ) ] 'value' 可选的精度声明中的p是一个整数，表示在秒域中小数部分的位数。表2显示了date类型的输入方式。 表2 日期输入方式 例子 描述 1999-01-08 ISO 8601格式（建议格式），任何方式下都是1999年1月8号。 January 8, 1999 在任何datestyle输入模式下都无歧义。 1/8/1999 有歧义，在MDY模式下是一月八号，在DMY模式下是八月一号。 1/18/1999 MDY模式下是一月十八日，其它模式下被拒绝。 01/02/03 MDY模式下的2003年1月2日。 DMY模式下的2003年2月1日。 YMD模式下的2001年2月3日。 1999-Jan-08 任何模式下都是1月8日。 Jan-08-1999 任何模式下都是1月8日。 08-Jan-1999 任何模式下都是1月8日。 99-Jan-08 YMD模式下是1月8日，否则错误。 08-Jan-99 一月八日，除了在YMD模式下是错误的之外。 Jan-08-99 一月八日，除了在YMD模式下是错误的之外。 19990108 ISO 8601；任何模式下都是1999年1月8日。 990108 ISO 8601；任何模式下都是1999年1月8日。 1999.008 年和年里的第几天。 J2451187 儒略日。 January 8, 99 BC 公元前99年。 示例： 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 --创建表。 openGauss=# CREATE TABLE date_type_tab(coll date); --插入数据。 openGauss=# INSERT INTO date_type_tab VALUES (date '12-10-2010'); --查看数据。 openGauss=# SELECT * FROM date_type_tab; coll --------------------- 2010-12-10 (1 row) --查看日期格式。 openGauss=# SHOW datestyle; DateStyle ----------- ISO, MDY (1 row) --设置日期格式。 openGauss=# SET datestyle='YMD'; SET --插入数据。 openGauss=# INSERT INTO date_type_tab VALUES(date '2010-12-11'); --查看数据。 openGauss=# SELECT * FROM date_type_tab; coll --------------------- 2010-12-10 2010-12-11 (2 rows) --删除表。 openGauss=# DROP TABLE date_type_tab;

特殊值 GaussDB支持几个特殊值，在读取的时候将被转换成普通的日期/时间值，请参考表5。 表5 特殊值 输入字符串 适用类型 描述 epoch date，timestamp 1970-01-01 00:00:00+00 （Unix系统零时） infinity timestamp 比任何其他时间戳都晚 -infinity timestamp 比任何其他时间戳都早 now date，time，timestamp 当前事务的开始时间 today date，timestamp 今日午夜 tomorrow date，timestamp 明日午夜 yesterday date，timestamp 昨日午夜 allballs time 00:00:00.00 UTC

参数说明 IF EXISTS 如果不存在相同名称的表，不会抛出一个错误，而会发出一个通知，告知表不存在。 table_name [*] | ONLY table_name | ONLY ( table_name ) table_name是需要修改的表名。 若声明了ONLY选项，则只有那个表被更改。若未声明ONLY，该表及其所有子表都将会被更改。另外，可以在表名称后面显示地增加*选项来指定包括子表，即表示所有后代表都被扫描，这是默认行为。 constraint_name 要删除的现有约束的名称。 index_name 索引名称。 storage_parameter 表的存储参数的名称。 在线扩容新增的三个选项： append_mode(枚举类型) 设置表上扩容方式为在线扩容，离线扩容，非扩容方式。在线扩容时允许对表进行部分的修改操作；离线扩容时，在扩容时不允许对表进行操作。 正在扩容表上需要新增数据要追加方式写入，便于记录增量数据。 on：标记表为在线扩容模式，在线扩容时，设置后后续数据以追加方式写入。 off：关闭扩容模式，设置后表上数据按正常方式写入，并且在pg_class.reloptions中不显示在线扩容相关的选项。 read_only：标记表为离线扩容。离线扩容时，不允许对表进行操作。 end_catchup：最后一轮追增的写报错模式，写业务报错，读业务正常执行。 rel_cn_oid（OID类型） 记录当前CN节点中表的OID，用于在DN节点上生成delete_delta表 当append_mode=on时，必须同时指定rel_cn_oid. 这append_mode ,rel_cn_oid两个选项只在在线扩容工具中使用，不建议用户使用。 exec_step（整形） 记录断点续传的步骤，记录在临时表的relOptions中。 取值范围：[1,4] 只支持数据重分布工具使用。 create_time（长整形） 记录断点续传时临时表创建时间，记录在临时表的relOptions中。 只支持数据重分布工具使用。 wait_clean_cbi (字符串类型) 标记当前全局索引中含有扩容bucket搬迁产生的残留tuple，扩容后会设置 (wait_clean_cbi=y), 在vacuum流程清理残留tuple后设置（wait_clean_cbi=n）。 此选项只在扩容工具中使用，不建议用户使用。 创建索引新增一个选项： parallel_workers（int类型） 表示创建索引时起的bgworker线程数量，例如2就表示将会起2个bgworker线程并发创建索引。 取值范围：[0,32]，0表示关闭该功能。 默认值：不设置该参数，表示未开启并行建索引功能。 复制表新增一个选项： primarynode（bool类型） 默认值：off 当primarynode=on时，将为复制表选择primary node，通常是pgxc_class表nodeoids字段记录的第一个节点。当复制表执行IUD操作时，将先下发到primarynode节点执行，收到结果后再下发到其它DN。 透明数据加密选项： enable_tde（bool类型） 是否开启表的透明数据加密。开启的前提是打开透明数据加密开关GUC参数enable_tde，同时启用了KMS密钥管理服务，并正确配置了集群主密钥ID GUC参数tde_cmk_id。 本参数仅支持行存表。不支持列存表、临时表。不支持ustore存储引擎。只有创建表时指定了enable_tde选项才支持修改此参数配置，切换加密开关状态不会改变加密算法和密钥信息。 取值范围：on/off。on表示开启透明数据加密，从off切换为on后，新数据写入数据页面时会自动加密，旧数据在更新数据页面时会自动加密。当前配置为off时，表示关闭透明数据加密，从on切换为off后，对于新写入的数据不再加密，对于已加密的旧数据在读取时可以自动解密，重新写回数据页面时则不再加密。 默认值：off hasuids（bool类型） 默认值：off 参数开启：更新表元组时，为元组分配表级唯一标识id。 new_owner 表新拥有者的名称。 new_tablespace 表所属新的表空间名称。 column_name，column_1_name， column_2_name 现存的或新字段的名称。 data_type 新字段的类型，或者现存字段的新类型。 compress_mode 表字段的压缩可选项。该子句指定该字段优先使用的压缩算法。行存表不支持压缩。 collation 字段排序规则名称。可选字段COLLATE指定了新字段的排序规则，如果省略，排序规则为新字段的默认类型。排序规则可以使用“select * from pg_collation”命令从pg_collation系统表中查询，默认的排序规则为查询结果中以default开始的行。 USING expression USING子句声明如何从旧的字段值里计算新的字段值；如果省略，缺省从旧类型向新类型的赋值转换。如果从旧数据类型到新类型没有隐含或者赋值的转换，则必须提供一个USING子句。 ALTER TYPE的USING选项实际上可以声明涉及该行旧值的任何表达式，即它可以引用除了正在被转换的字段之外其他的字段。这样，就可以用ALTER TYPE语法做非常普遍性的转换。因为这个灵活性，USING表达式并没有作用于该字段的缺省值（如果有的话），结果可能不是缺省表达式要求的常量表达式。这就意味着如果从旧类型到新类型没有隐含或者赋值转换的话，即使存在USING子句，ALTER TYPE也可能无法把缺省值转换成新的类型。在这种情况下，应该用DROP DEFAULT先删除缺省，执行ALTER TYPE，然后使用SET DEFAULT增加一个合适的新缺省值。类似的考虑也适用于涉及该字段的索引和约束。 NOT NULL | NULL 设置列是否允许空值。 integer 带符号的整数常值。当使用PERCENT时表示按照表数据的百分比收集统计信息，integer的取值范围为0-100。 attribute_option 属性选项。 PLAIN | EXTERNAL | EXTENDED | MAIN 字段存储模式。 PLAIN必需用于定长的数值（比如integer）并且是内联的、不压缩的。 MAIN用于内联、可压缩的数据。 EXTERNAL用于外部保存、不压缩的数据。使用EXTERNAL将令在text和bytea字段上的子字符串操作更快，但付出的代价是增加了存储空间。 EXTENDED用于外部的压缩数据，EXTENDED是大多数支持非PLAIN存储的数据的缺省。 CHECK ( expression ) 每次将要插入的新行或者将要被更新的行必须使表达式结果为真才能成功，否则会抛出一个异常并且不会修改数据库。 声明为字段约束的检查约束应该只引用该字段的数值，而在表约束里出现的表达式可以引用多个字段。 目前，CHECK表达式不能包含子查询也不能引用除当前行字段之外的变量。 DEFAULT default_expr 给字段指定缺省值。 缺省表达式的数据类型必须和字段类型匹配。 缺省表达式将被用于任何未声明该字段数值的插入操作。如果没有指定缺省值则缺省值为NULL 。 UNIQUE index_parameters UNIQUE ( column_name [, ... ] ) index_parameters UNIQUE约束表示表里的一个或多个字段的组合必须在全表范围内唯一。 PRIMARY KEY index_parameters PRIMARY KEY ( column_name [, ... ] ) index_parameters 主键约束表明表中的一个或者一些字段只能包含唯一（不重复）的非NULL值。 DEFERRABLE | NOT DEFERRABLE | INITIALLY DEFERRED | INITIALLY IMMEDIATE 设置该约束是否可推迟。 DEFERRABLE：可以推迟到事务结尾使用SET CONSTRAINTS命令检查。 NOT DEFERRABLE：在每条命令之后马上检查。 INITIALLY IMMEDIATE：在每条语句之后就立即检查它。 INITIALLY DEFERRED：只有在事务结尾才检查它。 WITH ( {storage_parameter = value} [, ... ] ) 为表或索引指定一个可选的存储参数。 tablespace_name 索引所在表空间的名称。 COMPRESS|NOCOMPRESS NOCOMPRESS：如果指定关键字NOCOMPRESS则不会修改表的现有压缩特性。 COMPRESS：如果指定COMPRESS关键字，则对该表进行批量插入元组时触发该特性。行存表不支持压缩。 new_table_name 修改后新的表名称。 new_column_name 表中指定列修改后新的列名称。 new_constraint_name 修改后表约束的新名称。 new_schema 修改后新的模式名称。 CASCADE 级联删除依赖于被依赖字段或者约束的对象（比如引用该字段的视图）。 RESTRICT 如果字段或者约束还有任何依赖的对象，则拒绝删除该字段。这是缺省行为。 schema_name 表所在的模式名称。