华为云用户手册

返回值 SQL_SUC CES S：表示调用正确。 SQL_SUCCESS_WITH_INFO：表示会有一些警告信息。 SQL_NEED_DATA：表示在执行SQL语句前没有提供足够的参数。 SQL_ERROR：表示比较严重的错误，如：内存分配失败、建立连接失败等。 SQL_INVALID_HANDLE：表示调用无效句柄。其他API的返回值同理。 SQL_STILL_EXECUTING：表示语句正在执行。 SQL_NO_DATA：表示SQL语句不返回结果集。

PKG_SERVICE PKG_SERVICE支持的所有接口请参见表1。 表1 PKG_SERVICE 接口名称 描述 PKG_SERVICE.SQL_IS_CONTEXT_ACTIVE 确认该CONTEXT是否已注册。 PKG_SERVICE.SQL_CLEAN_ALL_CONTEXTS 取消所有注册的CONTEXT。 PKG_SERVICE.SQL_REGISTER_CONTEXT 注册一个CONTEXT。 PKG_SERVICE.SQL_UNREGISTER_CONTEXT 取消注册该CONTEXT。 PKG_SERVICE.SQL_SET_SQL 向CONTEXT设置一条SQL语句，目前只支持SELECT。 PKG_SERVICE.SQL_RUN 在一个CONTEXT上执行设置的SQL语句。 PKG_SERVICE.SQL_NEXT_ROW 读取该CONTEXT中的下一行数据。 PKG_SERVICE.SQL_GET_VALUE 读取该CONTEXT中动态定义的列值 PKG_SERVICE.SQL_SET_RESULT_TYPE 根据类型OID动态定义该CONTEXT的一个列。 PKG_SERVICE.JOB_CANCEL 通过任务ID来删除定时任务。 PKG_SERVICE.JOB_FINISH 禁用或者启用定时任务。 PKG_SERVICE.JOB_SUBMIT 提交一个定时任务。作业号由系统自动生成或由用户指定。 PKG_SERVICE.JOB_UPDATE 修改定时任务的属性，包括任务内容、下次执行时间、执行间隔。 PKG_SERVICE.SUBMIT_ON_NODES 提交一个任务到所有节点，作业号由系统自动生成。 PKG_SERVICE.ISUBMIT_ON_NODES 提交一个任务到所有节点，作业号由用户指定。 PKG_SERVICE.SQL_GET_ARRAY_RESULT 获取该CONTEXT中返回的数组值。 PKG_SERVICE.SQL_GET_VARIABLE_RESULT 获取该CONTEXT中返回的列值。 PKG_SERVICE.SQL_IS_CONTEXT_ACTIVE 该函数用来确认一个CONTEXT是否已注册。该函数传入想查找的CONTEXT ID，如果该CONTEXT存在返回TRUE，反之返回FALSE。 PKG_SERVICE.SQL_IS_CONTEXT_ACTIVE函数原型为： 1 2 3 4 PKG_SERVICE.SQL_IS_CONTEXT_ACTIVE( context_id IN INTEGER ) RETURN BOOLEAN; 表2 PKG_SERVICE.SQL_IS_CONTEXT_ACTIVE接口说明 参数名称 描述 context_id 想查找的CONTEXT ID号 PKG_SERVICE.SQL_CLEAN_ALL_CONTEXTS 该函数用来取消所有CONTEXT PKG_SERVICE.SQL_CLEAN_ALL_CONTEXTS函数原型为： 1 2 3 PKG_SERVICE.SQL_CLEAN_ALL_CONTEXTS( ) RETURN VOID; PKG_SERVICE.SQL_REGISTER_CONTEXT 该函数用来打开一个CONTEXT，是后续对该CONTEXT进行各项操作的前提。该函数不传入任何参数，内部自动递增生成CONTEXT ID，并作为返回值返回给integer定义的变量。 PKG_SERVICE.SQL_REGISTER_CONTEXT函数原型为： 1 2 3 DBE_SQL.REGISTER_CONTEXT( ) RETURN INTEGER; PKG_SERVICE.SQL_UNREGISTER_CONTEXT 该函数用来关闭一个CONTEXT，是该CONTEXT中各项操作的结束。如果在存储过程结束时没有调用该函数，则该CONTEXT占用的内存仍然会保存，因此关闭CONTEXT非常重要。由于异常情况的发生会中途退出存储过程，导致CONTEXT未能关闭，因此建议存储过程中有异常处理，将该接口包含在内。 PKG_SERVICE.SQL_UNREGISTER_CONTEXT函数原型为： 1 2 3 4 PKG_SERVICE.SQL_UNREGISTER_CONTEXT( context_id IN INTEGER ) RETURN INTEGER; 表3 PKG_SERVICE.SQL_UNREGISTER_CONTEXT接口说明 参数名称 描述 context_id 打算关闭的CONTEXT ID号 PKG_SERVICE.SQL_SET_SQL 该函数用来解析给定游标的查询语句，被传入的查询语句会立即执行。目前仅支持SELECT查询语句的解析，且语句参数仅可通过text类型传递，长度不大于1G。 PKG_SERVICE.SQL_SET_SQL函数的原型为： 1 2 3 4 5 6 PKG_SERVICE.SQL_SET_SQL( context_id IN INTEGER, query_string IN TEXT, language_flag IN INTEGER ) RETURN BOOLEAN; 表4 PKG_SERVICE.SQL_SET_SQL接口说明 参数名称 描述 context_id 执行查询语句解析的CONTEXT ID query_string 执行的查询语句 language_flag 版本语言号，目前只支持1 PKG_SERVICE.SQL_RUN 该函数用来执行一个给定的CONTEXT。该函数接收一个CONTEXT ID，运行后获得的数据用于后续操作。目前仅支持SELECT查询语句的执行。 PKG_SERVICE.SQL_RUN函数的原型为： 1 2 3 4 PKG_SERVICE.SQL_RUN( context_id IN INTEGER, ) RETURN INTEGER; 表5 PKG_SERVICE.SQL_RUN接口说明 参数名称 描述 context_id 执行查询语句解析的CONTEXT ID PKG_SERVICE.SQL_NEXT_ROW 该函数返回执行SQL实际返回的数据行数，每一次运行该接口都会获取到新的行数的集合，直到数据读取完毕获取不到新行为止。 PKG_SERVICE.SQL_NEXT_ROW函数的原型为： 1 2 3 4 PKG_SERVICE.SQL_NEXT_ROW( context_id IN INTEGER, ) RETURN INTEGER; 表6 PKG_SERVICE.SQL_NEXT_ROW接口说明 参数名称 描述 context_id 执行的CONTEXT ID PKG_SERVICE.SQL_GET_VALUE 该函数用来返回给定CONTEXT中给定位置的CONTEXT元素值，该接口访问的是PKG_SERVICE.SQL_NEXT_ROW获取的数据。 PKG_SERVICE.SQL_GET_VALUE函数的原型为： 1 2 3 4 5 6 PKG_SERVICE.SQL_GET_VALUE( context_id IN INTEGER, pos IN INTEGER, col_type IN ANYELEMENT ) RETURN ANYELEMENT; 表7 PKG_SERVICE.SQL_GET_VALUE接口说明 参数名称 描述 context_id 执行的CONTEXT ID pos 动态定义列在查询中的位置 col_type 任意类型变量，定义列的返回值类型 PKG_SERVICE.SQL_SET_RESULT_TYPE 该函数用来定义从给定CONTEXT返回的列，该接口只能应用于SELECT定义的CONTEXT中。定义的列通过查询列表的相对位置来标识，PKG_SERVICE.SQL_SET_RESULT_TYPE函数的原型为： 1 2 3 4 5 6 7 PKG_SERVICE.SQL_SET_RESULT_TYPE( context_id IN INTEGER, pos IN INTEGER, coltype_oid IN ANYELEMENT, maxsize IN INTEGER ) RETURN INTEGER; 表8 PKG_SERVICE.SQL_SET_RESULT_TYPE接口说明 参数名称 描述 context_id 执行的CONTEXT ID。 pos 动态定义列在查询中的位置。 coltype_oid 任意类型的变量，可根据变量类型得到对应类型OID。 maxsize 定义的列的长度。 PKG_SERVICE.JOB_CANCEL 存储过程CANCEL删除指定的定时任务。 PKG_SERVICE.JOB_CANCEL函数原型为： 1 2 PKG_SERVICE.JOB_CANCEL( job IN INTEGER); 表9 PKG_SERVICE.JOB_CANCEL接口参数说明 参数 类型 入参/出参 是否可以为空 描述 id integer IN 否 指定的作业号。 示例： CALL PKG_SERVICE.JOB_CANCEL(101); PKG_SERVICE.JOB_FINISH 存储过程FINISH禁用或者启用定时任务。 PKG_SERVICE.JOB_FINISH函数原型为： 1 2 3 4 PKG_SERVICE.JOB_FINISH( id IN INTEGER, broken IN BOOLEAN, next_time IN TIMESTAMP DEFAULT sysdate); 表10 PKG_SERVICE.JOB_FINISH接口参数说明 参数 类型 入参/出参 是否可以为空 描述 id integer IN 否 指定的作业号。 broken Boolean IN 否 状态标志位，true代表禁用，false代表启用。根据true或false值更新当前job；如果为空值，则不改变原有job的状态。 next_time timestamp IN 是 下次运行时间，默认为当前系统时间。如果参数broken状态为true，则更新该参数为'4000-1-1'；如果参数broken状态为false，且如果参数next_time不为空值，则更新指定job的next_time值，如果next_time为空值，则不更新next_time值。该参数可以省略，为默认值。 PKG_SERVICE.JOB_SUBMIT 存储过程JOB_SUBMIT提交一个系统提供的定时任务。 PKG_SERVICE.JOB_SUBMIT函数原型为： 1 2 3 4 5 6 PKG_SERVICE.JOB_SUBMIT( id IN BIGINT, content IN TEXT, next_date IN TIMESTAMP DEFAULT sysdate, interval_time IN TEXT DEFAULT 'null', job OUT INTEGER); 当创建一个定时任务（JOB）时，系统默认将当前数据库和用户名与当前创建的定时任务绑定起来。该接口函数可以通过call或select调用，如果通过select调用，可以不填写出参。如果在存储过程中，则需要通过perform调用该接口函数。如果提交的sql语句任务使用到非public的schema，应该指定表或者函数的schema，或者在sql语句前添加set current_schema = xxx;语句。 表11 PKG_SERVICE.JOB_SUBMIT接口参数说明 参数 类型 入参/出参 是否可以为空 描述 id bigint IN 否 作业号。如果传入id为NULL，则内部会生成作业ID。 context text IN 否 要执行的SQL语句。支持一个或多个‘DML’，‘匿名块’，‘调用存储过程的语句’或3种混合的场景。 next_time timestamp IN 否 下次作业运行时间。默认值为当前系统时间（sysdate）。如果是过去时间，在提交作业时表示立即执行。 interval_time text IN 是 用来计算下次作业运行时间的时间表达式，可以是interval表达式，也可以是sysdate加上一个numeric值（例如：sysdate+1.0/24）。如果为空值或字符串"null"表示只执行一次，执行后JOB状态STATUS变成'd' 不再执行。 job integer OUT 否 作业号。范围为1～32767。当使用select调用pkg_service.job_submit时，该参数可以省略。 示例： 1 2 3 4 5 6 7 SELECT PKG_SERVICE.JOB_SUBMIT(NULL, 'call pro_xxx();', to_date('20180101','yyyymmdd'),'sysdate+1'); SELECT PKG_SERVICE.JOB_SUBMIT(NULL, 'call pro_xxx();', to_date('20180101','yyyymmdd'),'sysdate+1.0/24'); CALL PKG_SERVICE.JOB_SUBMIT(NULL, 'INSERT INTO T_JOB VALUES(1); call pro_1(); call pro_2();', add_months(to_date('201701','yyyymm'),1), 'date_trunc(''day'',SYSDATE) + 1 +(8*60+30.0)/(24*60)' ,:jobid); SELECT PKG_SERVICE.JOB_SUBMIT (101, 'insert_msg_statistic1;', sysdate, 'sysdate+3.0/24'); PKG_SERVICE.JOB_UPDATE 存储过程UPDATE修改定时任务的属性，包括任务内容、下次执行时间、执行间隔。 PKG_SERVICE.JOB_UPDATE函数原型为： 1 2 3 4 5 PKG_SERVICE.JOB_UPDATE( id IN BIGINT, next_time IN TIMESTAMP, interval_time IN TEXT, content IN TEXT); 表12 PKG_SERVICE.JOB_UPDATE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 id integer IN 否 指定的作业号。 next_time timestamp IN 是 下次运行时间。如果该参数为空值，则不更新指定job的next_time值，否则更新指定job的next_time值。 interval_time text IN 是 用来计算下次作业运行时间的时间表达式。如果该参数为空值，则不更新指定job的interval_time值；如果该参数不为空值，会校验interval_time是否为有效的时间类型或interval类型，则更新指定job的interval_time值。如果为字符串"null"表示只执行一次，执行后JOB状态STATUS变成'd' 不再执行。 content text IN 是 执行的存储过程名或者sql语句块。如果该参数为空值，则不更新指定job的content值，否则更新指定job的content值。 示例： 1 2 CALL PKG_SERVICE.JOB_UPDATE(101, sysdate, 'sysdate + 1.0/1440', 'call userproc();'); CALL PKG_SERVICE.JOB_UPDATE(101, sysdate, 'sysdate + 1.0/1440', 'insert into tbl_a values(sysdate);'); PKG_SERVICE.SUBMIT_ON_NODES 存储过程SUBMIT_ON_NODES创建一个节点上的定时任务，仅sysadmin/monitor admin有此权限。 PKG_SERVICE.SUBMIT_ON_NODES函数原型为： 1 2 3 4 5 6 7 PKG_SERVICE.SUBMIT_ON_NODES( node_name IN NAME, database IN NAME, what IN TEXT, next_date IN TIMESTAMP WITHOUT TIME ZONE, job_interval IN TEXT, job OUT INTEGER); 表13 PKG_SERVICE.SUBMIT_ON_NODES接口参数说明 参数 类型 入参/出参 是否可以为空 描述 node_name text IN 否 指定作业的执行节点，当前仅支持值为'ALL_NODE'（在所有节点执行）与'CCN'（注：CCN在集中式/小型化环境下无意义）。 database text IN 否 数据库实例作业所使用的database，节点类型为'ALL_NODE'时仅支持值为'postgres'。 what text IN 否 要执行的SQL语句。支持一个或多个‘DML’，‘匿名块’，‘调用存储过程的语句’或3种混合的场景。 nextdate timestamp IN 否 下次作业运行时间。默认值为当前系统时间（sysdate）。如果是过去时间，在提交作业时表示立即执行。 job_interval text IN 否 用来计算下次作业运行时间的时间表达式，可以是interval表达式，也可以是sysdate加上一个numeric值（例如：sysdate+1.0/24）。如果为空值或字符串"null"表示只执行一次，执行后JOB状态STATUS变成'd'不再执行。 job integer OUT 否 作业号。范围为1～32767。当使用select调用dbms.submit_on_nodes时，该参数可以省略。 示例： 1 2 select pkg_service.submit_on_nodes('ALL_NODE', 'postgres', 'select capture_view_to_json(''dbe_perf.statement'', 0);', sysdate, 'interval ''60 second'''); select pkg_service.submit_on_nodes('CCN', 'postgres', 'select capture_view_to_json(''dbe_perf.statement'', 0);', sysdate, 'interval ''60 second'''); PKG_SERVICE.ISUBMIT_ON_NODES ISUBMIT_ON_NODES与SUBMIT_ON_NODES语法功能相同，但其第一个参数是入参，即指定的作业号，SUBMIT最后一个参数是出参，表示系统自动生成的作业号。仅sysadmin/monitor admin有此权限。 PKG_SERVICE.SQL_GET_ARRAY_RESULT 该函数用来返回绑定的数组类型的OUT参数的值，可以用来获取存储过程中的OUT参数。 PKG_SERVICE.SQL_GET_ARRAY_RESULT函数原型为： 1 2 3 4 5 6 PKG_SERVICE.SQL_GET_ARRAY_RESULT( context_id in int, pos in VARCHAR2, column_value inout anyarray, result_type in anyelement ); 表14 PKG_SERVICE.SQL_GET_ARRAY_RESULT接口说明 参数名称 描述 context_id 想查找的CONTEXT ID号。 pos 绑定的参数名。 column_value 返回值。 result_type 返回值类型。 PKG_SERVICE.SQL_GET_VARIABLE_RESULT 该函数用来返回绑定的非数组类型的OUT参数的值，可以用来获取存储过程中的OUT参数。 PKG_SERVICE.SQL_GET_VARIABLE_RESULT函数原型为： 1 2 3 4 5 6 PKG_SERVICE.SQL_GET_VARIABLE_RESULT( context_id in int, pos in VARCHAR2, result_type in anyelement ) RETURNS anyelement; 表15 PKG_SERVICE.SQL_GET_VARIABLE_RESULT接口说明 参数名称 描述 context_id 想查找的CONTEXT ID号。 pos 绑定的参数名。 result_type 返回值类型。 父主题： 基础接口

PG_ATTRDEF PG_ATTRDEF系统表存储列的默认值。 表1 PG_ATTRDEF字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 adrelid oid 该列的所属表。 adnum smallint 该列的数目。 adbin pg_node_tree 字段缺省值或生成表达式的内部表现形式。 adsrc text 可读缺省值或生成表达式的内部表现形式。 adgencol "char" 标识该列是否为生成列。取值为's'表示该列为生成列，取值为'\0'表示该列为普通列，默认值为'\0'。 父主题： 系统表

MY_PART_INDEXES MY_PART_INDEXES视图存储当前用户下分区表索引的信息。该视图同时存在于PG_CATA LOG 和SYS schema下。 表1 MY_PART_INDEXES字段 名称 类型 描述 def_tablespace_name name 分区表索引的表空间名称。 index_owner character varying(64) 分区表索引的所有者名称。 index_name character varying(64) 分区表索引的名称。 partition_count bigint 分区表索引的索引分区的个数。 partitioning_key_count integer 分区表的分区键个数。 partitioning_type text 分区表的分区策略。 说明： 当前分区表策略支持范围见CREATE TABLE PARTITION。 schema character varying(64) 分区表索引的模式。 table_name character varying(64) 分区表索引所属的分区表名称。 subpartitioning_type text 二级分区表的分区策略。如果分区表是一级分区表，则显示NONE。 说明： 当前二级分区表策略支持范围见CREATE TABLE SUBPARTITION。 def_subpartition_count integer 默认创建二级分区的个数，二级分区表为1，一级分区表为0。 subpartitioning_key_count integer 分区表二级分区键的个数。 父主题： 系统视图

PG_AVAILABLE_EXTENSION_VERSIONS PG_AVAILABLE_EXTENSION_VERSIONS视图显示数据库中某些特性的扩展版本信息。该视图为内部使用，不建议用户使用。 表1 PG_AVAILABLE_EXTENSION_VERSIONS字段 名称 类型 描述 name name 扩展名。 version text 版本名。 installed boolean 如果这个扩展的版本是当前已经安装了的则为真。 superuser boolean 如果只允许系统管理员安装这个扩展则为真。 relocatable boolean 如果扩展可以重新加载到另一个模式则为真。 schema name 扩展必须安装到的模式名，如果部分或全部可重新定位则为NULL。 requires name[] 先决条件扩展的名称，如果没有则为NULL。 comment text 扩展的控制文件中的评论。 父主题： 系统视图

GLOBAL_STAT_XACT_SYS_TABLES 显示数据库各节点Schema中系统表的事务状态信息（不同节点下表的事务状态信息不进行汇总求和）。 表1 GLOBAL_STAT_XACT_SYS_TABLES字段 名称 类型 描述 node_name name 节点名称。 relid oid 表的OID。 schemaname name 此表所在的Schema名。 relname name 表名。 seq_scan bigint 此表发起的顺序扫描数。 seq_tup_read bigint 顺序扫描抓取的活跃行数。 idx_scan bigint 此表发起的索引扫描数。 idx_tup_fetch bigint 索引扫描抓取的活跃行数。 n_tup_ins bigint 插入行数。 n_tup_upd bigint 更新行数。 n_tup_del bigint 删除行数。 n_tup_hot_upd bigint HOT更新行数（即没有更新索引列的行数）。 父主题： Object

MY_TABLES MY_TABLES视图显示当前用户拥有的表的信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_TABLES字段 名称 类型 描述 owner character varying(64) 表的所有者。 table_name character varying(64) 表名称。 tablespace_name character varying(64) 存储表的表空间名称。 dropped character varying 当前记录是否已删除： yes表示已删除。 no表示未删除。 num_rows numeric 表的估计行数。 status character varying(8) 当前记录是否有效： valid表示有效。 sample_size numeric 分析表使用的样本数量。 temporary character(1) 是否为临时表。 y表示是临时表。 n表示不是临时表。 pct_free numeric 块中空闲空间的最小比例。 ini_trans numeric 事务的初始数量。 max_trans numeric 事务数量的最大值。 avg_row_len integer 平均每行的字节数。 partitioned character varying(3) 表是否为分区表。 last_analyzed timestamp with time zone 上次分析表的时间。数据库重启后，数据会丢失。 row_movement character varying(8) 是否允许分区行移动。 compression character varying(8) 是否启用表压缩。 duration character varying(15) 临时表的期限。 logical_replication character varying(8) 表是否启用逻辑复制。 external character varying(3) 表是否为外表。 logging character varying(3) 表的更改是否记入日志。 default_collation character varying(100) 表的默认排序规则。 degree character varying(10) 扫描表的实例数量。 table_lock character varying(8) 是否启用表级锁。 nested character varying(3) 是否为嵌套表。 buffer_pool character varying(7) 表的默认缓冲池。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 skip_corrupt character varying(8) 扫描表是否跳过损坏的块。 has_identity character varying(3) 表是否具有标识列。 segment_created character varying(3) 表段是否已被创建。 monitoring character varying(3) 是否跟踪表的修改。 cluster_name character varying(128) 暂不支持，值为NULL。 iot_name character varying(128) 暂不支持，值为NULL。 pct_used numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extents numeric 暂不支持，值为NULL。 max_extents numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 backed_up character varying(1) 暂不支持，值为NULL。 blocks numeric 暂不支持，值为NULL。 empty_blocks numeric 暂不支持，值为NULL。 avg_space numeric 暂不支持，值为NULL。 chain_cnt numeric 暂不支持，值为NULL。 avg_space_freelist_blocks numeric 暂不支持，值为NULL。 num_freelist_blocks numeric 暂不支持，值为NULL。 instances character varying(10) 暂不支持，值为NULL。 cache character varying(5) 暂不支持，值为NULL。 iot_type character varying(12) 暂不支持，值为NULL。 secondary character varying(1) 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 cluster_owner character varying(30) 暂不支持，值为NULL。 dependencies character varying(8) 暂不支持，值为NULL。 compression_for character varying(30) 暂不支持，值为NULL。 read_only character varying(3) 暂不支持，值为NULL。 result_cache character varying(7) 暂不支持，值为NULL。 clustering character varying(3) 暂不支持，值为NULL。 activity_tracking character varying(23) 暂不支持，值为NULL。 dml_timestamp character varying(25) 暂不支持，值为NULL。 container_data character varying(3) 暂不支持，值为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。 duplicated character varying(1) 暂不支持，值为NULL。 sharded character varying(1) 暂不支持，值为NULL。 hybrid character varying(3) 暂不支持，值为NULL。 cellmemory character varying(24) 暂不支持，值为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。 inmemory_service character varying(12) 暂不支持，值为NULL。 inmemory_service_name character varying(1000) 暂不支持，值为NULL。 container_map_object character varying(3) 暂不支持，值为NULL。 memoptimize_read character varying(8) 暂不支持，值为NULL。 memoptimize_write character varying(8) 暂不支持，值为NULL。 has_sensitive_column character varying(3) 暂不支持，值为NULL。 admit_null character varying(3) 暂不支持，值为NULL。 data_link_dml_enabled character varying(3) 暂不支持，值为NULL 。 object_id_type character varying(16) 暂不支持，值为NULL。 table_type_owner character varying(128) 暂不支持，值为NULL。 table_type character varying(128) 暂不支持，值为NULL。 compress_for character varying(30) 暂不支持，值为NULL。 父主题： 系统视图

数值类型 表1列出了所有的可用类型。数字操作符和相关的内置函数请参见数字操作函数和操作符。 表1 整数类型 名称 描述 存储空间 范围 TINYINT 微整数，别名为INT1。 1字节 0 ~ +255 SMALLINT 小范围整数，别名为INT2。 2字节 -32,768 ~ +32,767 INTEGER 常用的整数，别名为INT4。 4字节 -2,147,483,648 ~ +2,147,483,647 BINARY_INTEGER 常用的整数INTEGER的别名。 4字节 -2,147,483,648 ~ +2,147,483,647 BIGINT 大范围的整数，别名为INT8。 8字节 -9,223,372,036,854,775,808 ~ +9,223,372,036,854,775,807 int16 十六字节的大范围整数，目前不支持用户用于建表等使用。 16字节 -170,141,183,460,469,231,731,687,303,715,884,105,728 ~ +170,141,183,460,469,231,731,687,303,715,884,105,727 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 --创建具有TINYINT类型数据的表。 gaussdb=# CREATE TABLE int_type_t1 ( IT_COL1 TINYINT ); --向创建的表中插入数据。 gaussdb=# INSERT INTO int_type_t1 VALUES(10); --查看数据。 gaussdb=# SELECT * FROM int_type_t1; it_col1 --------- 10 (1 row) --删除表。 gaussdb=# DROP TABLE int_type_t1; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 --创建具有TINYINT,INTEGER,BIGINT类型数据的表。 gaussdb=# CREATE TABLE int_type_t2 ( a TINYINT, b TINYINT, c INTEGER, d BIGINT ); --插入数据。 gaussdb=# INSERT INTO int_type_t2 VALUES(100, 10, 1000, 10000); --查看数据。 gaussdb=# SELECT * FROM int_type_t2; a | b | c | d -----+----+------+------- 100 | 10 | 1000 | 10000 (1 row) --删除表。 gaussdb=# DROP TABLE int_type_t2; TINYINT、SMALLINT、INTEGER、BIGINT和INT16类型存储各种范围的数字，也就是整数。如果存储超出范围以外的数值将会导致错误。 常用的类型是INTEGER，因为它提供了在范围、存储空间、性能之间的最佳平衡。一般只有取值范围确定不超过SMALLINT的情况下，才会使用SMALLINT类型。而只有在INTEGER的范围不够的时候才使用BIGINT，因为INTEGER的处理速度相对快得多。 表2 任意精度类型 名称 描述 存储空间 范围 NUMERIC[(p[,s])], DECIMAL[(p[,s])] 精度p取值范围为[1,1000]，标度s取值范围为[0,p]。 说明： p为总位数，s为小数位数。 用户声明精度。每四位（十进制位）占用两个字节，然后在整个数据上加上八个字节的额外开销。 未指定精度的情况下，小数点前最大131,072位，小数点后最大16,383位。 NUMBER[(p[,s])] NUMERIC类型的别名。 用户声明精度。每四位（十进制位）占用两个字节，然后在整个数据上加上八个字节的额外开销。 未指定精度的情况下，小数点前最大131,072位，小数点后最大16,383位。 示例： --创建表。 gaussdb=# CREATE TABLE decimal_type_t1 ( DT_COL1 DECIMAL(10,4) ); --插入数据。 gaussdb=# INSERT INTO decimal_type_t1 VALUES(123456.122331); --查询表中的数据。 gaussdb=# SELECT * FROM decimal_type_t1; dt_col1 ------------- 123456.1223 (1 row) --删除表。 gaussdb=# DROP TABLE decimal_type_t1; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 --创建表。 gaussdb=# CREATE TABLE numeric_type_t1 ( NT_COL1 NUMERIC(10,4) ); --插入数据。 gaussdb=# INSERT INTO numeric_type_t1 VALUES(123456.12354); --查询表中的数据。 gaussdb=# SELECT * FROM numeric_type_t1; nt_col1 ------------- 123456.1235 (1 row) --删除表。 gaussdb=# DROP TABLE numeric_type_t1; 与整数类型相比，任意精度类型需要更大的存储空间，其存储效率、运算效率以及压缩比效果都要差一些。在进行数值类型定义时，优先选择整数类型。当数值超出整数可表示最大范围时，再选用任意精度类型。 使用NUMERIC/DECIMAL进行列定义时，建议指定该列的精度p以及标度s。 表3 序列整型 名称 描述 存储空间 范围 SMALLSERIAL 二字节序列整型。 2字节。 -32,768 ~ +32,767。 SERIAL 四字节序列整型。 4字节。 -2,147,483,648 ~ +2,147,483,647。 BIGSERIAL 八字节序列整型。 8字节。 -9,223,372,036,854,775,808 ~ +9,223,372,036,854,775,807。 LARGESERIAL 默认插入十六字节序列整型，实际数值类型和NUMERIC相同。 变长类型，每四位（十进制位）占用两个字节，然后在整个数据上加上八个字节的额外开销。 小数点前最大131,072位，小数点后最大16,383位。 示例： 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 65 66 67 68 69 70 71 72 73 74 --创建表。 gaussdb=# CREATE TABLE smallserial_type_tab(a SMALLSERIAL); --插入数据。 gaussdb=# INSERT INTO smallserial_type_tab VALUES(default); --再次插入数据。 gaussdb=# INSERT INTO smallserial_type_tab VALUES(default); --查看数据。 gaussdb=# SELECT * FROM smallserial_type_tab; a --- 1 2 (2 rows) --创建表。 gaussdb=# CREATE TABLE serial_type_tab(b SERIAL); --插入数据。 gaussdb=# INSERT INTO serial_type_tab VALUES(default); --再次插入数据。 gaussdb=# INSERT INTO serial_type_tab VALUES(default); --查看数据。 gaussdb=# SELECT * FROM serial_type_tab; b --- 1 2 (2 rows) --创建表。 gaussdb=# CREATE TABLE bigserial_type_tab(c BIGSERIAL); --插入数据。 gaussdb=# INSERT INTO bigserial_type_tab VALUES(default); --再次插入数据。 gaussdb=# INSERT INTO bigserial_type_tab VALUES(default); --查看数据。 gaussdb=# SELECT * FROM bigserial_type_tab; c --- 1 2 (2 rows) --创建表。 gaussdb=# CREATE TABLE largeserial_type_tab(c LARGESERIAL); --插入数据。 gaussdb=# INSERT INTO largeserial_type_tab VALUES(default); --再次插入数据。 gaussdb=# INSERT INTO largeserial_type_tab VALUES(default); --查看数据。 gaussdb=# SELECT * FROM largeserial_type_tab; c --- 1 2 (2 rows) --删除表。 gaussdb=# DROP TABLE smallserial_type_tab; gaussdb=# DROP TABLE serial_type_tab; gaussdb=# DROP TABLE bigserial_type_tab; SMALLSERIAL、SERIAL、BIGSERIAL和LARGESERIAL类型不是真正的类型，只是为在表中设置唯一标识做的概念上的便利。因此，创建一个整数字段，并且把它的缺省数值安排为从一个序列发生器读取。应用了一个NOT NULL约束以确保NULL不会被插入。在大多数情况下用户可能还希望附加一个UNIQUE或PRIMARY KEY约束避免意外地插入重复的数值，但这个不是自动的。最后，序列发生器将从属于该字段，这样当该字段或表被删除的时候也一并删除它。目前支持在创建表时候指定SERIAL列，也支持在PG兼容模式下的普通表增加SERIAL列。另外临时表也不支持创建SERIAL列。因为SERIAL不是真正的类型，所以也不可以将表中存在的列类型转化为SERIAL。 表4 浮点类型 名称 描述 存储空间 范围 REAL, FLOAT4 单精度浮点数，不精准。 4字节。 -3.402E+38~+3.402E+38，6位十进制数字精度。 DOUBLE PRECISION, FLOAT8 双精度浮点数，不精准。 8字节。 -1.79E+308~+1.79E+308，15位十进制数字精度。 FLOAT[(p)] 浮点数，不精准。精度p取值范围为[1,53]。 4字节或8字节。 根据精度p不同选择REAL或DOUBLE PRECISION作为内部表示。如不指定精度，内部用DOUBLE PRECISION表示。 BINARY_DOUBLE 是DOUBLE PRECISION的别名，为兼容Oracle数据类型。 8字节。 -1.79E+308~+1.79E+308，15位十进制数字精度。 DEC[(p[,s])] 精度p取值范围为[1,1000]，标度s取值范围为[0,p]。 用户声明精度。每四位（十进制位）占用两个字节，然后在整个数据上加上八个字节的额外开销。 在精度和标度指定最大的情况下，小数点前最大131,072位，小数点后最大16,383位。 INTEGER[(p[,s])] 精度p取值范围为[1,1000]，标度s取值范围为[0,p]。 在未指定精度和标度的情况下，默认精度p为10，标度s为0。 未指定精度和标度的情况下，该类型映射为INTEGER。指定精度和标度的情况下，该类型映射为NUMERIC。 用户声明精度。每四位（十进制位）占用两个字节，然后在整个数据上加上八个字节的额外开销。 在精度和标度指定最大的情况下，小数点前最大131,072位，小数点后最大16,383位。 未指定精度和标度的情况下，范围是-2,147,483,648 ~ +2,147,483,647。 表4中描述的p为精度，表示整数位最低可以接受的总位数；s为小数位位数。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 --创建表。 gaussdb=# CREATE TABLE float_type_t2 ( FT_COL1 INTEGER, FT_COL2 FLOAT4, FT_COL3 FLOAT8, FT_COL4 FLOAT(3), FT_COL5 BINARY_DOUBLE, FT_COL6 DECIMAL(10,4), FT_COL7 INTEGER(6,3) ); --插入数据。 gaussdb=# INSERT INTO float_type_t2 VALUES(10,10.365456,123456.1234,10.3214, 321.321, 123.123654, 123.123654); --查看数据。 gaussdb=# SELECT * FROM float_type_t2 ; ft_col1 | ft_col2 | ft_col3 | ft_col4 | ft_col5 | ft_col6 | ft_col7 ---------+---------+-------------+---------+---------+----------+--------- 10 | 10.3655 | 123456.1234 | 10.3214 | 321.321 | 123.1237 | 123.124 (1 row) --删除表。 gaussdb=# DROP TABLE float_type_t2; 父主题： 数据类型

函数支持自治事务 自治事务可以在函数中定义，标识符为PRAGMA AUTONOMOUS_TRANSACTION，其余语法与函数语法相同，示例如下。 gaussdb=# create table t4(a int, b int, c text); gaussdb=# CREATE OR REPLACE function autonomous_32(a int ,b int ,c text) RETURN int AS DECLARE PRAGMA AUTONOMOUS_TRANSACTION; BEGIN insert into t4 values(a, b, c); return 1; END; / CREATE FUNCTION gaussdb=# CREATE OR REPLACE function autonomous_33(num1 int) RETURN int AS DECLARE num3 int := 220; tmp int; PRAGMA AUTONOMOUS_TRANSACTION; BEGIN num3 := num3/num1; return num3; EXCEPTION WHEN division_by_zero THEN select autonomous_32(num3, num1, sqlerrm) into tmp; return 0; END; / CREATE FUNCTION gaussdb=# select autonomous_33(0); autonomous_33 --------------- 0 (1 row) gaussdb=# select * from t4; a | b | c -----+---+------------------ 220 | 0 | division by zero (1 row) 父主题： 自治事务

MY_SEQUENCES MY_SEQUENCES视图显示当前用户的序列信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_SEQUENCES字段 名称 类型 描述 sequence_owner name 序列所有者。 sequence_name name 序列的名称。 min_value int16 序列最小值。 max_value int16 序列最大值。 increment_by int16 序列的增量。 cycle_flag character(1) 表示序列是否是循环序列，取值为Y或N： Y表示是循环序列。 N表示不是循环序列。 order_flag character varying(1) 表示序列是否是按照请求顺序发生，暂不支持，值为NULL。 last_number int16 上一序列的值。 cache_size int16 序列磁盘缓存大小。 scale_flag character varying(1) 表示是否为可扩展序列，暂不支持，值为NULL。 extend_flag character varying(1) 表示可扩展序列生成的值是否超出序列最大值、最小值范围，暂不支持，值为NULL。 sharded_flag character varying(1) 表示是否是分片序列，暂不支持，值为NULL。 session_flag character varying(1) 表示序列是否是会话私有，暂不支持，值为NULL。 keep_value character varying(1) 表示在失败后的replay期间是否保留序列值，暂不支持，值为NULL。 父主题： 系统视图

语法格式 开启匿名块。 [DECLARE [declare_statements]] BEGIN execution_statements END; / 开启事务。 BEGIN [ WORK | TRANSACTION ] [ { ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE | REPEATABLE READ } | { READ WRITE | READ ONLY } } [, ...] ];

effective_cache_size 参数说明：设置优化器在一次单一的查询中可用的磁盘缓冲区的有效大小。 设置这个参数，还要考虑 GaussDB 的共享缓冲区以及内核的磁盘缓冲区。另外，还要考虑预计的在不同表之间的并发查询数目，因为它们将共享可用的空间。 这个参数对GaussDB分配的共享内存大小没有影响，它也不会使用内核磁盘缓冲，它只用于估算。数值是用磁盘页来计算的，通常每个页面是8192字节。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，1～2147483647，单位为8KB。 比默认值高的数值可能会导致使用索引扫描，更低的数值可能会导致选择顺序扫描。 默认值： 280GB（196核CPU/1536G内存）；180GB（128核CPU/1024G内存，104核CPU/1024G内存，96核CPU/1024G内存）；135GB（96核CPU/768G内存）；100GB（80核CPU/640G内存）；90GB（64核CPU/512G内存）；80GB（60核CPU/480G内存）；40GB（32核CPU/256G内存）；18GB（16核CPU/128G内存）；8GB（8核CPU/64G内存）；4GB（4核CPU/32G内存）；2GB（4核CPU/16G内存）

random_page_cost 参数说明：设置优化器计算一次非顺序抓取磁盘页面的开销。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 虽然服务器允许将random_page_cost设置的比seq_page_cost小，但是物理上实际不受影响。如果所有数据库都位于随机访问内存中时，两者设置为相等很合理。因为在此种情况下，非顺序抓取页并没有副作用。同样，在缓冲率很高的数据库上，应该相对于CPU参数同时降低这两个值，因为获取内存中的页要比通常情况下开销小很多。 取值范围：浮点型，0～DBL_MAX。 默认值：4 对于特别表空间中的表和索引，可以通过设置同名的表空间的参数来覆盖这个值。 相对于seq_page_cost，减少这个值将导致系统更倾向于使用索引扫描，而增加这个值使得索引扫描开销比较高。可以通过同时增加或减少这两个值来调整磁盘I/O相对于CPU的开销。

咨询锁函数 咨询锁函数用于管理咨询锁（Advisory Lock）。 pg_advisory_lock(key bigint) 描述：获取会话级别的排他咨询锁。 返回值类型：void 备注：pg_advisory_lock锁定应用程序定义的资源，该资源可以用一个64位或两个不重叠的32位键值标识。如果已经有另外的会话锁定了该资源，则该函数将阻塞到该资源可用为止。这个锁是排他的。多个锁定请求将会被压入栈中，因此，如果同一个资源被锁定了三次，它必须被解锁三次以将资源释放给其他会话使用。 pg_advisory_lock(key1 int, key2 int) 描述：获取会话级别的排他咨询锁。 返回值类型：void 备注：只允许sysadmin对键值对(65535, 65535)加会话级别的排他咨询锁，普通用户无权限。 pg_advisory_lock(lock_id int4, lock_id int4, datebase_name Name) 描述：通过传入锁ID和数据库名字，获取指定数据库的排他咨询锁。 返回值类型：void pg_advisory_lock_shared(key bigint) 描述：获取会话级别的共享咨询锁。 返回值类型：void pg_advisory_lock_shared(key1 int, key2 int) 描述：获取会话级别的共享咨询锁。 返回值类型：void 备注：pg_advisory_lock_shared类似于pg_advisory_lock，不同之处仅在于共享锁会话可以和其他请求共享锁的会话共享资源，但排他锁除外。 pg_advisory_unlock(key bigint) 描述：释放会话级别的排他咨询锁。 返回值类型：Boolean pg_advisory_unlock(key1 int, key2 int) 描述：释放会话级别的排他咨询锁。 返回值类型：Boolean 备注：pg_advisory_unlock释放先前取得的排他咨询锁。如果释放成功则返回true。如果实际上并未持有指定的锁，将返回false并在服务器中产生一条SQL警告信息。 pg_advisory_unlock(lock_id int4, lock_id int4, datebase_name Name) 描述：通过传入锁ID和数据库名字，释放指定数据库上的排他咨询锁。 返回值类型：Boolean 备注：如果释放成功则返回true；如果未持有锁，则返回false。 pg_advisory_unlock_shared(key bigint) 描述：释放会话级别的共享咨询锁。 返回值类型：Boolean pg_advisory_unlock_shared(key1 int, key2 int) 描述：释放会话级别的共享咨询锁。 返回值类型：Boolean 备注：pg_advisory_unlock_shared类似于pg_advisory_unlock，不同之处在于该函数释放的是共享咨询锁。 pg_advisory_unlock_all() 描述：释放当前会话持有的所有咨询锁。 返回值类型：void 备注：pg_advisory_unlock_all将会释放当前会话持有的所有咨询锁，该函数在会话结束的时候被隐含调用，即使客户端异常地断开连接也是一样。 pg_advisory_xact_lock(key bigint) 描述：获取事务级别的排他咨询锁。 返回值类型：void pg_advisory_xact_lock(key1 int, key2 int) 描述：获取事务级别的排他咨询锁。 返回值类型：void 备注：pg_advisory_xact_lock类似于pg_advisory_lock，不同之处在于锁是自动在当前事务结束时释放，而且不能被显式的释放。只允许sysadmin对键值对(65535, 65535)加事务级别的排他咨询锁，普通用户无权限。 pg_advisory_xact_lock_shared(key bigint) 描述：获取事务级别的共享咨询锁。 返回值类型：void pg_advisory_xact_lock_shared(key1 int, key2 int) 描述：获取事务级别的共享咨询锁。 返回值类型：void 备注：pg_advisory_xact_lock_shared类似于pg_advisory_lock_shared，不同之处在于锁是在当前事务结束时自动释放，而且不能被显式的释放。 pg_try_advisory_lock(key bigint) 描述：尝试获取会话级排他咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_lock类似于pg_advisory_lock，不同之处在于该函数不会阻塞以等待资源的释放。它要么立即获得锁并返回true，要么返回false表示目前不能锁定。 pg_try_advisory_lock(key1 int, key2 int) 描述：尝试获取会话级排他咨询锁。 返回值类型：Boolean 备注：只允许sysadmin对键值对(65535, 65535)加会话级别的排他咨询锁，普通用户无权限。 pg_try_advisory_lock_shared(key bigint) 描述：尝试获取会话级共享咨询锁。 返回值类型：Boolean pg_try_advisory_lock_shared(key1 int, key2 int) 描述：尝试获取会话级共享咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_lock_shared类似于pg_try_advisory_lock，不同之处在于该函数尝试获得共享锁而不是排他锁。 pg_try_advisory_xact_lock(key bigint) 描述：尝试获取事务级别的排他咨询锁。 返回值类型：Boolean pg_try_advisory_xact_lock(key1 int, key2 int) 描述：尝试获取事务级别的排他咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_xact_lock类似于pg_try_advisory_lock，不同之处在于如果得到锁，在当前事务的结束时自动释放，而且不能被显式的释放。只允许sysadmin对键值对(65535, 65535)加事务级别的排他咨询锁，普通用户无权限。 pg_try_advisory_xact_lock_shared(key bigint) 描述：尝试获取事务级别的共享咨询锁。 返回值类型：Boolean pg_try_advisory_xact_lock_shared(key1 int, key2 int) 描述：尝试获取事务级别的共享咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_xact_lock_shared类似于pg_try_advisory_lock_shared，不同之处在于如果得到锁，在当前事务结束时自动释放，而且不能被显式的释放。 lock_cluster_ddl() 描述：尝试对数据库内所有存活的数据库主节点获取会话级别的排他咨询锁。 返回值类型：Boolean 备注：只允许sysadmin调用，普通用户无权限。 unlock_cluster_ddl() 描述：尝试对数据库主节点会话级别的排他咨询锁。 返回值类型：Boolean 父主题： 系统管理函数

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 示例: 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不存在会报错。 返回值类型：bool 示例： 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) 父主题： 函数和操作符

检索查询 对于常用的检索查询，嵌入式SQL提供了常规命令SELECT和FETCH的特殊变体。这些命令使用特殊的INTO子句，用以指定检索出来的数值存储在哪些宿主变量里。SELECT用于返回单行的查询，FETCH用于使用游标返回多行的查询。 使用SELECT /* * 假定有这个表： * CREATE TABLE test1 (a int, b varchar(50)); */ EXEC SQL BEGIN DECLARE SECTION; int v1; VARCHAR v2; EXEC SQL END DECLARE SECTION; ... EXEC SQL SELECT a, b INTO :v1, :v2 FROM test; INTO子句出现在选择列表和FROM子句之间。选择列表和INTO后面列表的元素（也叫目标列表）个数必须相同。 使用FETCH EXEC SQL BEGIN DECLARE SECTION; int v1; VARCHAR v2; EXEC SQL END DECLARE SECTION; ... EXEC SQL DECLARE foo CURSOR FOR SELECT a, b FROM test; ... do { ... EXEC SQL FETCH NEXT FROM foo INTO :v1, :v2; ... } while (...); 这里的INTO子句出现在所有SQL子句后面。 父主题： 宿主变量

Time Model Time Model名称及描述如下表所示。 表1 Time Model报表主要内容 名称 描述 DB_TIME 所有线程端到端的墙上时间（WALL TIME）消耗总和（单位：微秒）。 EXECUTION_TIME 消耗在执行器上的时间总和（单位：微秒)。 PL_EXECUTION_TIME 消耗在plpgsql执行上的时间总和（单位：微秒）。 CPU_TIME 所有线程CPU时间消耗总和（单位：微秒）。 PLAN_TIME 消耗在执行计划生成上的时间总和（单位：微秒）。 REWRITE_TIME 消耗在查询重写上的时间总和（单位：微秒）。 PL_COMPILATION_TIME 消耗在SQL编译上的时间总和（单位：微秒）。 PARSE_TIME 消耗在SQL解析上的时间总和（单位：微秒）。 NET_SEND_TIME 消耗在网络发送上的时间总和（单位：微秒）。 DATA_IO_TIME 消耗在数据读写上的时间总和（单位：微秒）。 父主题： WDR报告信息介绍

omit_encoding_error 参数说明：设置为on，数据库的客户端字符集编码为UTF-8时，出现的字符编码转换错误将打印在日志中，有转换错误的被转换字符会被忽略，以"?"代替。 该参数属于USERSET类型参数，请参考表2中对应设置方法进行设置。 取值范围：布尔型 on表示有转换错误的字符将被忽略，以"?"代替，打印错误信息到日志中。 off表示有转换错误的字符不能被转换，打印错误信息到终端。 默认值：off

restart_after_crash 参数说明：设置为on，后端进程崩溃时，GaussDB将自动重新初始化此后端进程。 该参数属于SIGHUP类型参数，请参考表2中对应设置方法进行设置。 取值范围：布尔型 on表示能够最大限度地提高数据库的可用性。 在某些情况（比如当采用管理工具（例如xCAT）管理GaussDB时），能够最大限度地提高数据库的可用性。 off表示能够使得管理工具在后端进程崩溃时获取控制权并采取适当的措施进行处理。 默认值：on

data_sync_retry 参数说明：控制当fsync到磁盘失败后是否继续运行数据库。由于在某些操作系统的场景下，fsync失败后重试阶段即使再次fsync失败也不会报错，从而导致数据丢失。 该参数属于POSTMASTER类型参数，请参考表2中对应设置方法进行设置。 取值范围：布尔型 on表示当fsync同步到磁盘失败后采取重试机制，数据库继续运行。 off表示当fsync同步到磁盘失败后直接报panic，停止数据库。 默认值：off

remote_read_mode 参数说明：远程读功能开关。读取主机上的页面失败时可以从备机上读取对应的页面。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：枚举类型 off表示关闭远程读功能。 non_authentication表示开启远程读功能，但不进行证书认证。 authentication表示开启远程读功能，但要进行证书认证。 默认值：authentication

语法格式 [ WITH [ RECURSIVE ] with_query [, ...] ] INSERT [/*+ plan_hint */] INTO table_name [partition_clause] [ AS alias ] [ ( column_name [, ...] ) ] { DEFAULT VALUES | VALUES {( { expression | DEFAULT } [, ...] ) }[, ...] | query } [ ON DUPLICATE KEY UPDATE { NOTHING | { column_name = { expression | DEFAULT } } [, ...] [ WHERE condition ] }] [ RETURNING {* | {output_expression [ [ AS ] output_name ] }[, ...]} ];

参数说明 WITH [ RECURSIVE ] with_query [, ...] 用于声明一个或多个可以在主查询中通过名称引用的子查询，相当于临时表。 如果声明了RECURSIVE，那么允许SELECT子查询通过名称引用它自己。 其中with_query的详细格式为： with_query_name [ ( column_name [, ...] ) ] AS [ [ NOT ] MATERIALIZED ] ( {SELECT | VALUES | INSERT | UPDATE | DELETE} ) – with_query_name指定子查询生成的结果集名称，在查询中可使用该名称访问子查询的结果集。 – column_name指定子查询结果集中显示的列名。 – 每个子查询可以是SELECT，VALUES，INSERT，UPDATE或DELETE语句。 – 用户可以使用MATERIALIZED / NOT MATERIALIZED对CTE进行修饰。 如果声明为MATERIALIZED，WITH查询将被物化，生成一个子查询结果集的拷贝，在引用处直接查询该拷贝，因此WITH子查询无法和主干SELECT语句进行联合优化（如谓词下推、等价类传递等），对于此类场景可以使用NOT MATERIALIZED进行修饰，如果WITH查询语义上可以作为子查询内联执行，则可以进行上述优化。 如果用户没有显示声明物化属性则遵守以下规则：如果CTE只在所属主干语句中被引用一次，且语义上支持内联执行，则会被改写为子查询内联执行，否则以CTE Scan的方式物化执行。 INSERT ON DUPLICATE KEY UPDATE不支持WITH及WITH RECURSIVE子句。 INSERT语句的输出，只会显示最外层query block插入的tuple数量。比如： with cte as (insert into t1 values(1) retunring * ) insert into t1 select * from cte; 只会显示插入一条tuple，但实际上插入了两条。 plan_hint子句 以/*+ */的形式在INSERT关键字后，用于对INSERT对应的语句块生成的计划进行hint调优，详细用法请参见章节使用Plan Hint进行调优。每条语句中只有第一个/*+ plan_hint */注释块会作为hint生效，里面可以写多条hint。 table_name 要插入数据的目标表名。 取值范围：已存在的表名。 支持使用DATABASE LINK方式对远端表进行操作，使用方式详情请见DATABASE LINK。 partition_clause 指定分区插入操作 PARTITION { ( partition_name ) | FOR ( partition_value [, ...] ) } | SUBPARTITION { ( subpartition_name ) | FOR ( subpartition_value [, ...] ) } 关键字详见SELECT一节介绍 如果value子句的值和指定分区不一致，会抛出异常。 示例详见CREATE TABLE SUBPARTITION column_name 目标表中的字段名： 字段名可以有子字段名或者数组下标修饰。 没有在字段列表中出现的每个字段，将由系统默认值，或者声明时的默认值填充，若都没有则用NULL填充。例如，向一个复合类型中的某些字段插入数据的话，其他字段将是NULL。 目标字段（column_name）可以按顺序排列。如果没有列出任何字段，则默认全部字段，且顺序为表声明时的顺序。 如果value子句和query中只提供了N个字段，则目标字段为前N个字段。 value子句和query提供的值在表中从左到右关联到对应列。 取值范围：已存在的字段名。 expression 赋予对应column的一个有效表达式或值： 如果是INSERT ON DUPLICATE KEY UPDATE语句下，expression可以为VALUES(column_name)或EXCLUDED.column_name用来表示引用冲突行对应的column_name字段的值。需注意，其中VALUES(column_name)不支持嵌套在表达式中（例如VALUES(column_name)+1），但EXCLUDED不受此限制。 向表中字段插入单引号 " ' "时需要使用单引号自身进行转义。 如果插入行的表达式不是正确的数据类型，系统试图进行类型转换，若转换不成功，则插入数据失败，系统返回错误信息。 DEFAULT 对应字段名的缺省值。如果没有缺省值，则为NULL。 query 一个查询语句（SELECT语句），将查询结果作为插入的数据。 RETURNING 返回实际插入的行，RETURNING列表的语法与SELECT的输出列表一致。注意：INSERT ON DUPLICATE KEY UPDATE不支持RETURNING子句。 output_expression INSERT命令在每一行都被插入之后用于计算输出结果的表达式。 取值范围：该表达式可以使用table的任意字段。可以使用*返回被插入行的所有字段。 output_name 字段的输出名称。 取值范围：字符串，符合标识符命名规范。 ON DUPLICATE KEY UPDATE 对于带有唯一约束（UNIQUE INDEX或PRIMARY KEY）的表，如果插入数据违反唯一约束，则对冲突行执行UPDATE子句完成更新，对于不带唯一约束的表，则仅执行插入。UPDATE时，若指定NOTHING则忽略此条插入，可通过"EXCLUDE." 或者 "VALUES()" 来选择源数据相应的列。 支持触发器，触发器执行顺序由实际执行流程决定： 执行insert： 触发 before insert、 after insert触发器。 执行update：触发before insert、before update、after update触发器。 执行update nothing： 触发before insert触发器。 不支持延迟生效（DEFERRABLE）的唯一约束或主键。 如果表中存在多个唯一约束，如果所插入数据违反多个唯一约束，对于检测到冲突的第一行进行更新，其他冲突行不更新（检查顺序与索引维护具有强相关性，一般先创建的索引先进行冲突检查）。 如果插入多行，这些行均与表中同一行数据存在唯一约束冲突，则按照顺序，第一条执行插入或更新，之后依次执行更新。 主键、唯一索引列不允许UPDATE。 不支持外表。 expression不支持使用子查询表达式。

注意事项 只有拥有表INSERT权限的用户，才可以向表中插入数据。用户被授予INSERT ANY TABLE权限，相当于用户对除系统模式之外的任何模式具有USAGE权限，并且拥有这些模式下表的INSERT权限。 如果使用RETURNING子句，用户必须要有该表的SELECT权限。 如果使用ON DUPLICATE KEY UPDATE，用户必须要有该表的INSERT、UPDATE权限，UPDATE子句中列的SELECT权限。 如果使用query子句插入来自查询里的数据行，用户还需要拥有在查询里使用的表的SELECT权限。 生成列不能被直接写入。在INSERT命令中不能为生成列指定值，但是可以指定关键字DEFAULT。 当连接到TD兼容的数据库时，td_compatible_truncation参数设置为on时，将启用超长字符串自动截断功能，在后续的INSERT语句中（不包含外表的场景下），对目标表中CHAR和VARCHAR类型的列上插入超长字符串时，系统会自动按照目标表中相应列定义的最大长度对超长字符串进行截断。 如果向字符集为字节类型编码（SQL_ASCII，LATIN1等）的数据库中插入多字节字符数据（如汉字等），且字符数据跨越截断位置，这种情况下，按照字节长度自动截断，自动截断后会在尾部产生非预期结果。如果用户有对于截断结果正确性的要求，建议用户采用UTF8等能够按照字符截断的输入字符集作为数据库的编码集。

MY_ROLE_PRIVS MY_ROLE_PRIVS视图显示授予当前用户角色（包括public角色）的权限的信息。默认所有用户都可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_ROLE_PRIVS字段 名称 类型 描述 grantee character varying(128) 被授予权限的用户或角色名称。 granted_role character varying(128) 被授予的角色。 admin_option character varying(3) 该授权是否包含ADMIN选项。 YES：包含ADMIN选项。 NO：不包含ADMIN选项。 delegate_option character varying(3) 暂不支持，值为NULL。 default_role character varying(3) 暂不支持，值为NULL。 os_granted character varying(3) 暂不支持，值为NULL。 common character varying(3) 暂不支持，值为NULL。 inherited character varying(3) 暂不支持，值为NULL。 父主题： 系统视图

V$GLOBAL_TRANSACTION V$GLOBAL_TRANSACTION视图显示有关当前活动全局事务的信息。默认只有系统管理员权限才可以访问此系统视图，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS schema下。 表1 V$GLOBAL_TRANSACTION字段 名称 类型 描述 formatid numeric 全局事务格式标识符。暂不支持，值为NULL。 globalid raw 全局事务标识符。 branchid raw 全局事务分支标识符。暂不支持，值为NULL。全局事务的每一个单独事务称为分支。 branches numeric 全局事务分支总数。 refcount numeric 全局事务的同级数（必须与分支相同）。 preparecount numeric 已准备的全局事务分支数。当system_view_version参数大于0时，不存在已准备的全局事务分支时为0，否则为NULL。 state character varying(38) 全局事务的分支的状态。 flags numeric 状态的数字表示形式。 coupling character varying(15) 指示分支是自由(`FREE`)、松散耦合(`LOOSELY COUPLED`)、还是紧密耦合(TIGHTLY COUPLED)。暂不支持，值为NULL。 con_id numeric 与数据相关的容器的 ID。暂不支持，值为0。 父主题： 系统视图

参数说明 IF EXISTS IF EXISTS表示，如果函数存在则执行删除操作，函数不存在也不会报错，只是发出一个notice。 function_name 要删除的函数名称。 取值范围：已存在的函数名。 argmode 函数参数的模式。 argname 函数参数的名称。 argtype 函数参数的类型 CASCADE | RESTRICT CASCADE：级联删除依赖于函数的对象 。 RESTRICT：如果有任何依赖对象存在，则拒绝删除该函数（缺省行为）。

SUMMARY_STAT_SYS_TABLES 显示数据库各节点pg_catalog、information_schema以及pg_toast模式下所有系统表的状态信息的汇总求和结果（对每个节点下系统表的状态信息汇总求和，其中timestamp类型字段不进行求和，仅取所有节点该字段的最新值）。 表1 SUMMARY_STAT_SYS_TABLES字段 名称 类型 描述 schemaname name 此表所在的Schema名。 relname name 表名。 seq_scan numeric 此表发起的顺序扫描数。 seq_tup_read numeric 顺序扫描抓取的活跃行数。 idx_scan numeric 此表发起的索引扫描数。 idx_tup_fetch numeric 索引扫描抓取的活跃行数。 n_tup_ins numeric 插入行数。 n_tup_upd numeric 更新行数。 n_tup_del numeric 删除行数。 n_tup_hot_upd numeric HOT更新行数（即没有更新索引列的行数）。 n_live_tup numeric 估计活跃行数。 n_dead_tup numeric 估计不活跃行数。 last_vacuum timestamp with time zone 最后一次此表是手动清理的（不计算VACUUM FULL）时间。 last_autovacuum timestamp with time zone 上次被autovacuum守护线程清理的时间。 last_analyze timestamp with time zone 上次手动分析这个表的时间。 last_autoanalyze timestamp with time zone 上次被autovacuum守护线程分析的时间。 vacuum_count numeric 这个表被手动清理的次数（不计算VACUUM FULL）。 autovacuum_count numeric 这个表被autovacuum清理的次数。 analyze_count numeric 这个表被手动分析的次数。 autoanalyze_count numeric 这个表被autovacuum守护线程分析的次数。 父主题： Object

time_to_target_rpo 参数说明： 双数据库实例异地灾备模式下，设置主数据库实例发生异常发生时到已归档到OBS的恢复点所允许的time_to_target_rpo秒。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0~3600（秒） 双数据库实例异地灾备模式下，主数据库实例日志将被归档到OBS。0是指不开启日志流控，1~3600是指设置主数据库实例发生异常发生时到已归档到OBS的恢复点所允许的time_to_target_rpo秒，保证主数据库实例因灾难崩溃时，最多可能丢失的数据的时长在允许范围内。time_to_target_rpo设置时间过小会影响主机的性能，设置过大会失去流控效果。 默认值：0

archive_mode 参数说明：表示是否进行归档操作。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 当wal_level设置成minimal时，archive_mode参数无法使用。 无论是同步备机还是异步备机都能够开启归档，归档开启的方式与单机开启归档一致，将archive_mode置为on，并设置正确的archive_dest或者archive_command即可。 若未开启最大可用模式以及有同步备机与主机断开连接时，主机会因为业务阻塞的原因无法给备机发送归档的位置，从而导致归档失败。 取值范围: 布尔型 on表示进行归档。 off表示不进行归档。 默认值：off