华为云用户手册

功能描述 在当前数据库中定义一种新的数据类型。定义数据类型的用户将成为该数据类型的拥有者。类型只适用于行存表。 有五种形式的CREATE TYPE，分别为：基本类型、shell类型、枚举类型和集合类型。 基本类型 用户可以自定义一种新的基本类型（标量类型）。通常来说这些函数必须是用C或者另外一种低层语言所编写。 shell类型 shell类型是一种用于后面要定义的类型的占位符，通过发出一个不带除类型名之外其他参数的CREATE TYPE命令可以创建这种类型。在创建基本类型时，需要shell类型作为一种向前引用。 枚举类型 由若干个标签构成的列表，每一个标签值都是一个非空字符串，且字符串长度必须不超过64个字节。 被授予CREATE ANY TYPE权限的用户，可以在public模式和用户模式下创建类型。

数据库连接控制函数 数据库连接控制函数控制与GaussDB服务器的连接。一个应用程序一次可以与多个服务器建立连接，如一个客户端连接多个数据库的场景。每个连接都是用一个从函数PQconnectdb、PQconnectdbParams或PQsetdbLogin获得的PGconn对象表示。注意，这些函数总是返回一个非空的对象指针，除非内存分配失败，会返回一个空的指针。连接建立的接口保存在PGconn对象中，可以调用PQstatus函数来检查一下返回值查看连接是否成功。 PQconnectdbParams PQconnectdb PQbackendPID PQsetdbLogin PQfinish PQreset PQstatus 父主题： libpq接口参考

STREAMING_CONT_QUERY STREAMING_CONT_QUERY系统表存储所有CONTVIEW对象的元数据信息。 表1 STREAMING_CONT_QUERY字段 名称 类型 描述 id integer CONTVIEW对象唯一的标识符，不可重复。 type "char" 标识CONTVIEW的类型。 'r'表示该CONTVIEW是基于行存存储模型。 relid oid CONTVIEW对象的标识。 defrelid oid CONTVIEW对应的持续计算规则VIEW的标识。 active boolean 标识CONTVIEW是否处于持续计算状态。 t（true）：表示是。 f（false）：表示不是。 streamrelid oid CONTVIEW对应的STREAM的标识。 matrelid oid CONTVIEW对应物化表的标识。 lookupidxid oid CONTVIEW对应GROUP LOOK UP INDEX的标识，此字段内部使用，仅行存具有。 step_factor smallint 标识CONTVIEW的步进模式。主要取值为0（无重叠窗口）和1（滑动窗口，步长为1）。 ttl integer CONTVIEW设置的ttl_interval参数值。 ttl_attno smallint CONTVIEW设置的TTL功能对应时间列的字段编号。 dictrelid oid CONTVIEW对应字典表的标识。 grpnum smallint CONTVIEW持续计算规则中维度列的个数，此字段内部使用。 grpidx int2vector CONTVIEW持续计算规则中维度列在TARGET LIST的索引，此字段内部使用。 父主题： 系统表

GS_DB_PRIVILEGE GS_DB_PRIVILEGE系统表记录ANY权限的授予情况，每条记录对应一条授权信息。 表1 GS_DB_PRIVILEGE字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 roleid oid 用户标识。 privilege_type text 用户拥有的ANY权限，取值参考表1。 admin_option boolean 是否具有privilege_type列记录的ANY权限的再授权权限。 t：表示具有。 f：表示不具有。 父主题： 系统表

背景信息 数据库审计功能对数据库系统的安全性至关重要。数据库审计管理员可以利用审计日志信息，重现导致数据库现状的一系列事件，找出非法操作的用户、时间和内容等。 关于审计功能，用户需要了解以下几点内容： 审计总开关GUC参数audit_enabled支持动态加载。在数据库运行期间修改该配置项的值会立即生效，无需重启数据库。默认值为on，表示开启审计功能。 除了审计总开关，各个审计项也有对应的开关。只有开关开启，对应的审计功能才能生效。 各审计项的开关支持动态加载。在数据库运行期间修改审计开关的值，不需要重启数据库便可生效。 目前，GaussDB支持以下审计项如表1所示。如需要修改具体的审计配置项，请联系管理员进行处理。 表1 配置审计项 配置项 描述 用户登录、注销审计 参数：audit_login_logout 默认值为7，表示开启用户登录、退出的审计功能。设置为0表示关闭用户登录、退出的审计功能。不推荐设置除0和7之外的值。 数据库启动、停止、恢复和切换审计 参数：audit_database_process 默认值为1，表示开启数据库启动、停止、恢复和切换的审计功能。 用户锁定和解锁审计 参数：audit_user_locked 默认值为1，表示开启审计用户锁定和解锁功能。 用户访问越权审计 参数：audit_user_violation 默认值为0，表示关闭用户越权操作审计功能。 授权和回收权限审计 参数：audit_grant_revoke 默认值为1，表示开启审计用户权限授予和回收功能。 对用户操作进行全量审计 参数：full_audit_users 默认值为空字符串，表示采用默认配置，未配置全量审计用户。 不需要审计的客户端名称及IP地址 参数：no_audit_client 默认值为空字符串，表示采用默认配置，未将客户端及IP加入审计黑名单。 数据库对象的CREATE，ALTER，DROP操作审计 参数：audit_system_object 默认值为67121159，表示对DATABASE、SCHEMA、USER、NODE GROUP这四类数据库对象的CREATE、ALTER、DROP操作进行审计。 具体表的INSERT、UPDATE和DELETE操作审计 参数：audit_dml_state 默认值为0，表示关闭具体表的DML操作（SELECT除外）审计功能。 SELECT操作审计 参数：audit_dml_state_select 默认值为0，表示关闭SELECT操作审计功能。 COPY审计 参数：audit_copy_exec 默认值为1，表示开启copy操作审计功能。 执行存储过程和自定义函数的审计 参数：audit_function_exec 默认值为0，表示不记录执行存储过程和自定义函数的审计日志。 执行白名单内的系统函数审计 参数：audit_system_function_exec 默认值为0，表示不记录执行系统函数的审计日志。 SET审计 参数：audit_set_parameter 默认值为0，表示不记录set操作审计日志 事务ID记录 参数：audit_xid_info 默认值为0，表示关闭审计日志记录事务ID功能。

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

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

GS_SQL_COUNT GS_SQL_COUNT视图显示数据库当前节点当前时刻执行的五类语句（SELECT、INSERT、UPDATE、DELETE、MERGE INTO）统计信息。 普通用户查询GS_SQL_COUNT视图仅能看到该用户当前节点的统计信息；管理员权限用户查询GS_SQL_COUNT视图则能看到所有用户当前节点的统计信息。 当集群或该节点重启时，计数将清零，并重新开始计数 。 计数以节点收到的查询数为准，包括集群内部进行的查询。例如，CN收到一条查询，若下发多条查询DN，那将在DN上进行相应次数的计数。 表1 GS_SQL_COUNT字段 名称 类型 描述 node_name name 节点名称。 user_name name 用户名。 select_count bigint SELECT语句统计结果。 update_count bigint UPDATE语句统计结果。 insert_count bigint INSERT语句统计结果。 delete_count bigint DELETE语句统计结果。 mergeinto_count bigint MERGE INTO语句统计结果。 ddl_count bigint DDL语句的数量。 dml_count bigint DML语句的数量。 dcl_count bigint DCL语句的数量。 total_select_elapse bigint 总SELECT的时间花费（单位：微秒）。 avg_select_elapse bigint 平均SELECT的时间花费（单位：微秒）。 max_select_elapse bigint 最大SELECT的时间花费（单位：微秒）。 min_select_elapse bigint 最小SELECT的时间花费（单位：微秒）。 total_update_elapse bigint 总UPDATE的时间花费（单位：微秒）。 avg_update_elapse bigint 平均UPDATE的时间花费（单位：微秒）。 max_update_elapse bigint 最大UPDATE的时间花费（单位：微秒）。 min_update_elapse bigint 最小UPDATE的时间花费（单位：微秒）。 total_insert_elapse bigint 总INSERT的时间花费（单位：微秒）。 avg_insert_elapse bigint 平均INSERT的时间花费（单位：微秒）。 max_insert_elapse bigint 最大INSERT的时间花费（单位：微秒）。 min_insert_elapse bigint 最小INSERT的时间花费（单位：微秒）。 total_delete_elapse bigint 总DELETE的时间花费（单位：微秒）。 avg_delete_elapse bigint 平均DELETE的时间花费（单位：微秒）。 max_delete_elapse bigint 最大DELETE的时间花费（单位：微秒）。 min_delete_elapse bigint 最小DELETE的时间花费（单位：微秒）。 父主题： 系统视图

背景信息 索引可以提高数据的访问速度，但同时也增加了插入、更新和删除操作的处理时间。所以是否要为表增加索引，索引建立在哪些字段上，是创建索引前必须要考虑的问题。需要分析应用程序的业务处理、数据使用、经常被用作查询的条件或者被要求排序的字段来确定是否建立索引。 索引建立在数据库表中的某些列上。因此，在创建索引时，应该仔细考虑在哪些列上创建索引。 在经常需要搜索查询的列上创建索引，可以加快搜索的速度。 在作为主键的列上创建索引，强制该列的唯一性和组织表中数据的排列结构。 在经常使用连接的列上创建索引，可以加快连接的速度。 在经常需要根据范围进行搜索的列上创建索引，因为索引已经排序，其指定的范围是连续的。 在经常需要排序的列上创建索引，因为索引已经排序，这样查询可以利用索引的排序，加快排序查询时间。 在经常使用WHERE子句的列上创建索引，加快条件的判断速度。 在经常出现关键字ORDER BY、GROUP BY、DISTINCT后面的字段建立索引。 索引创建成功后，系统会自动判断何时引用索引。当系统认为使用索引比顺序扫描更快时，就会使用索引。 索引创建成功后，必须和表保持同步以保证能够准确地找到新数据，这样就增加了数据操作的负荷。因此请定期删除无用的索引。 分区表索引分为LOCAL索引与GLOBAL索引，一个LOCAL索引对应一个具体分区，而GLOBAL索引则对应整个分区表。

ADM_COL_PRIVS ADM_COL_PRIVS视图显示所有的列权限授予信息。默认只有系统管理员权限才可以访问此系统视图，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_COL_PRIVS字段 名称 类型 描述 grantor character varying(128) 执行授权的用户名。 owner character varying(128) 对象的所有者。 grantee character varying(128) 被授予权限的用户或角色的名称。 table_schema character varying(128) 对象的Schema。 table_name character varying(128) 对象的名称。 column_name character varying(128) 列的名称。 privilege character varying(40) 列的权限。 grantable character varying(3) 是否授予特权。 YES：授予。 NO：不授予。 common character varying(3) 暂不支持，值为NULL。 inherited character varying(3) 暂不支持，值为NULL。 父主题： 系统视图

示例 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 --创建dev_mask和bob_mask用户。 gaussdb=# CREATE USER dev_mask PASSWORD '********'; gaussdb=# CREATE USER bob_mask PASSWORD '********'; --创建一个表tb_for_masking。 gaussdb=# CREATE TABLE tb_for_masking(col1 text, col2 text, col3 text); --创建资源标签标记敏感列col1。 gaussdb=# CREATE RESOURCE LABEL mask_lb1 ADD COLUMN(tb_for_masking.col1); --创建资源标签标记敏感列col2。 gaussdb=# CREATE RESOURCE LABEL mask_lb2 ADD COLUMN(tb_for_masking.col2); --对访问敏感列col1的操作创建脱敏策略。 gaussdb=# CREATE MASKING POLICY maskpol1 maskall ON LABEL(mask_lb1); --为脱敏策略maskpol1添加描述。 gaussdb=# ALTER MASKING POLICY maskpol1 COMMENTS 'masking policy for tb_for_masking.col1'; --修改脱敏策略maskpol1，新增一项脱敏方式。 gaussdb=# ALTER MASKING POLICY maskpol1 ADD randommasking ON LABEL(mask_lb2); --修改脱敏策略maskpol1，移除一项脱敏方式。 gaussdb=# ALTER MASKING POLICY maskpol1 REMOVE randommasking ON LABEL(mask_lb2); --修改脱敏策略maskpol1，修改一项脱敏方式。 gaussdb=# ALTER MASKING POLICY maskpol1 MODIFY randommasking ON LABEL(mask_lb1); --修改脱敏策略maskpol1使之仅对用户dev_mask和bob_mask,客户端工具为gsql，IP地址为'10.20.30.40', '127.0.0.0/24'场景生效。 gaussdb=# ALTER MASKING POLICY maskpol1 MODIFY (FILTER ON ROLES(dev_mask, bob_mask), APP(gsql), IP('10.20.30.40', '127.0.0.0/24')); --修改脱敏策略maskpol1，使之对所有用户场景生效。 gaussdb=# ALTER MASKING POLICY maskpol1 DROP FILTER; --禁用脱敏策略maskpol1。 gaussdb=# ALTER MASKING POLICY maskpol1 DISABLE; --删除脱敏策略。 gaussdb=# DROP MASKING POLICY maskpol1; --删除资源标签。 gaussdb=# DROP RESOURCE LABEL mask_lb1, mask_lb2; --删除表tb_for_masking。 gaussdb=# DROP TABLE tb_for_masking; --删除用户dev_mask,和bob_mask。 gaussdb=# DROP USER dev_mask, bob_mask;

参数说明 policy_name 脱敏策略名称，需要唯一，不可重复。 取值范围：字符串，要符合标识符命名规范。 policy_comments 需要为脱敏策略添加或修改的描述信息。 masking_function 指的是预置的八种脱敏方式或者用户自定义的函数，支持模式。 maskall不是预置函数，硬编码在代码中，不支持\df展示。 预置是脱敏方式如下： maskall | randommasking | creditcardmasking | basicemailmasking | fullemailmasking | shufflemasking | alldigitsmasking | regepmasking label_name 资源标签名称。 FILTER_TYPE 指定脱敏策略的过滤信息，过滤类型包括：IP、ROLES、APP。 filter_value 指具体过滤信息内容，例如具体的IP，具体的APP名称，具体的用户名。 ENABLE|DISABLE 可以打开或关闭脱敏策略。若不指定ENABLE|DISABLE，语句默认为ENABLE。

语法格式 修改策略描述： 1 ALTER MASKING POLICY policy_name COMMENTS policy_comments; 修改脱敏方式： 1 2 3 ALTER MASKING POLICY policy_name [ADD | REMOVE | MODIFY] masking_actions[, ...]; 其中masking_action: masking_function ON LABEL(label_name[, ...]) 修改脱敏策略生效场景： 1 ALTER MASKING POLICY policy_name MODIFY(FILTER ON FILTER_TYPE(filter_value[, ...])[, ...]); 移除脱敏策略生效场景，使策略对所用场景生效： 1 ALTER MASKING POLICY policy_name DROP FILTER; 修改脱敏策略开启/关闭： 1 ALTER MASKING POLICY policy_name [ENABLE | DISABLE];

PG_REWRITE PG_REWRITE系统表存储表和视图定义的重写规则。 表1 PG_REWRITE字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 rulename name 规则名称。 ev_class oid 使用这条规则的表名称。 ev_attr smallint 这条规则适用的字段（目前总是为零，表示整个表）。 ev_type "char" 规则适用的事件类型。 1：SELECT 2：UPDATE 3：INSERT 4：DELETE ev_enabled "char" 用于控制复制的触发。 O：“origin”和“local”模式时触发。 D：禁用触发。 R：“replica”时触发。 A：任何模式是都会触发。 is_instead boolean 如果该规则是INSTEAD规则，则为真，否则为假。 ev_qual pg_node_tree 规则的资格条件的表达式树（以nodeToString() 形式存在）。 ev_action pg_node_tree 规则动作的查询树（以nodeToString() 形式存在）。 父主题： 系统表

参数说明 @queryblock 见指定Hint所处的查询块Queryblock章节，可省略，表示在当前查询块生效，该hint只在指定为最外层的queryblock时才会生效。 param：表示参数名。 value：表示参数的取值。 目前支持使用Hint设置生效的参数有： 布尔类： enable_bitmapscan、enable_hashagg、enable_hashjoin、enable_indexscan、enable_indexonlyscan、enable_gsiscan、enable_material、enable_mergejoin、enable_nestloop、enable_index_nestloop、enable_seqscan、enable_sort、enable_tidscan、enable_stream_operator、enable_stream_recursive、enable_broadcast、enable_fast_query_shipping、enable_trigger_shipping、enable_remotejoin、enable_remotegroup、enable_remotelimit、enable_remotesort、enable_inner_unique_opt 整型类： best_agg_plan，query_dop 浮点类： cost_weight_index、default_limit_rows、seq_page_cost、random_page_cost、cpu_tuple_cost、cpu_index_tuple_cost、cpu_operator_cost、effective_cache_size 字符串类： node_name 通过设置node_name可以指定当前的sql下发到node_name对应的dn上去执行。 示例： select /*+ set(node_name datanode1) */ from table_name; 其中，datanode1是从 pgxc_node 系统表里查询出来的数据节点的名称（不用加引号），table_name 是表名。该查询表示直接去datanode1上执行查询。 node_name只支持在select语句里设置，如果在其他语句里设置将会不生效。 node_name只支持设置data node名字，不支持设置coodninator名字。 node_name不支持通过SET语句进行修改，只能用在plan hint里。 node_name不支持通过gs_guc进行修改。 node_name仅支持简单查询语句，不支持带union，union all子查询，多表关联等复杂查询语句。 支持普通用户执行。 不支持与行级访问控制同时使用，同时使用会报错。 设置不在白名单中的参数，参数取值不合法，或hint语法错误时，不会影响查询执行的正确性。使用explain(verbose on)执行可以看到hint解析错误的报错提示。 GUC参数的hint只在最外层查询生效，子查询内的GUC参数hint不生效。 视图定义内的GUC参数hint不生效。 CREATE TABLE ... AS ... 查询最外层的GUC参数hint可以生效。

MY_IND_PARTITIONS MY_IND_PARTITIONS视图存储当前用户下的一级分区表Local索引的索引分区信息（不包含分区表全局索引）。所有用户都可以访问。该视图同时存在于PG_CATALOG和SYS schema下。 表1 MY_IND_PARTITIONS字段 名称 类型 描述 index_owner character varying(64) 索引分区所属分区表索引的所有者的名称。 index_name character varying(64) 索引分区所属分区表索引的名称。 partition_name character varying(64) 索引分区的名称。 def_tablespace_name name 索引分区的表空间名称 high_value text 索引分区所对应分区的上边界。 对于范围分区和间隔分区，显示各分区的上边界值。 对于列表分区，显示各分区的取值列表。 对于哈希分区，显示各分区的编号。 index_partition_usable boolean 索引分区是否可用。 t（true）：表示可用。 f（false）：表示不可用。 schema character varying(64) 索引分区所属分区表索引的模式。 high_value_length integer 索引分区所对应分区的边界的字符长度。 composite character varying(3) 指示索引是否属于二级分区表上的本地索引，该表不存储二级分区信息，所以该值为NO。 subpartition_count numeric 分区中的二级分区数，该表不存储二级分区信息，所以该值为0。 partition_position numeric 索引分区在索引中的位置。 status character varying(8) 指示索引分区是否可用。 tablespace_name name 分区所在表空间的名称。 pct_free numeric 块中最小可用空间百分比。 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(13) 指示分区索引是否启用索引压缩。 blevel numeric 暂不支持，值为NULL。 leaf_blocks numeric 暂不支持，值为NULL。 distinct_keys numeric 暂不支持，值为NULL。 avg_leaf_blocks_per_key numeric 暂不支持，值为NULL。 avg_data_blocks_per_key numeric 暂不支持，值为NULL。 clustering_factor numeric 根据索引的值指示表中行的顺序。需要通过执行analyze进行统计。 num_rows 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。 user_stats character varying(3) 暂不支持，值为NULL。 pct_direct_access numeric 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 domidx_opstatus character varying(6) 暂不支持，值为NULL。 parameters character varying(1000) 暂不支持，值为NULL。 interval character varying(3) 指示分区是否在间隔分区表的间隔节中。分布式暂不支持间隔分区，该字段值为NO。 segment_created character varying(3) 指示索引分区段是否已创建。 orphaned_entries character varying(3) 暂不支持，值为NULL。 父主题： 系统视图

cidr和inet函数 函数abbrev，host，text主要是为了提供可选的显示格式。 abbrev(inet) 描述：缩写显示格式文本。 返回类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT abbrev(inet '10.1.0.0/16') AS RESULT; result ------------- 10.1.0.0/16 (1 row) abbrev(cidr) 描述：缩写显示格式文本。 返回类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT abbrev(cidr '10.1.0.0/16') AS RESULT; result --------- 10.1/16 (1 row) broadcast(inet) 描述：网络广播地址。 返回类型：inet 示例： 1 2 3 4 5 gaussdb=# SELECT broadcast('192.168.1.5/24') AS RESULT; result ------------------ 192.168.1.255/24 (1 row) family(inet) 描述：抽取地址族，4为IPv4。 返回类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT family('127.0.0.1') AS RESULT; result -------- 4 (1 row) host(inet) 描述：将主机地址类型抽出为文本。 返回类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT host('192.168.1.5/24') AS RESULT; result ------------- 192.168.1.5 (1 row) hostmask(inet) 描述：为网络构造主机掩码。 返回类型：inet 示例： 1 2 3 4 5 gaussdb=# SELECT hostmask('192.168.23.20/30') AS RESULT; result --------- 0.0.0.3 (1 row) masklen(inet) 描述：抽取子网掩码长度。 返回类型：int 示例： 1 2 3 4 5 gaussdb=# SELECT masklen('192.168.1.5/24') AS RESULT; result -------- 24 (1 row) netmask(inet) 描述：为网络构造子网掩码。 返回类型：inet 示例： 1 2 3 4 5 gaussdb=# SELECT netmask('192.168.1.5/24') AS RESULT; result --------------- 255.255.255.0 (1 row) network(inet) 描述：抽取地址的网络部分。 返回类型：cidr 示例： 1 2 3 4 5 gaussdb=# SELECT network('192.168.1.5/24') AS RESULT; result ---------------- 192.168.1.0/24 (1 row) set_masklen(inet, int) 描述：为inet数值设置子网掩码长度。 返回类型：inet 示例： 1 2 3 4 5 gaussdb=# SELECT set_masklen('192.168.1.5/24', 16) AS RESULT; result ---------------- 192.168.1.5/16 (1 row) set_masklen(cidr, int) 描述：为cidr数值设置子网掩码长度。 返回类型：cidr 示例： 1 2 3 4 5 gaussdb=# SELECT set_masklen('192.168.1.0/24'::cidr, 16) AS RESULT; result ---------------- 192.168.0.0/16 (1 row) text(inet) 描述：把IP地址和掩码长度抽取为文本。 返回类型：text 示例： 1 2 3 4 5 gaussdb=# SELECT text(inet '192.168.1.5') AS RESULT; result ---------------- 192.168.1.5/32 (1 row)

MY_INDEXES MY_INDEXES视图显示当前用户的索引信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_INDEXES字段 名称 类型 描述 owner character varying(64) 索引的所有者。 index_name character varying(64) 索引名称。 table_name character varying(64) 索引对应的表名。 uniqueness text 表示该索引是否为唯一索引。 UNIQUE：唯一索引。 NONUNIQUE：非唯一索引。 partitioned character(3) 表示该索引是否具有分区表的性质。 Yes：索引具有分区表的性质。 No：索引不具有分区表的性质。 generated character varying(1) 表示该索引的名称是否为系统生成。 y：索引名称为系统生成。 n：索引名称非系统生成。 index_type character varying(27) 索引类型。 NORMAL：索引属性都是简单的引用，表达式树为空。 FUNCTION-BASED NORMAL：存在表达式树用于非简单字段引用的索引属性。 table_owner character varying(128) 索引对象的所有者。 table_type character(11) 索引对象的类型。 TABLE：索引对象为表类型。 tablespace_name character varying(30) 包含索引的表空间名称。 status character varying(8) 非分区索引状态。 VALID：非分区索引可以用于查询。 UNUSABLE：非分区索引不可用。 N/A：索引具有分区表性质。 compression character varying(13) 暂不支持，值为NULL。 prefix_length numeric 暂不支持，值为NULL。 ini_trans numeric 暂不支持，值为NULL。 max_trans numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extents numeric 暂不支持，值为NULL。 max_extents numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 pct_threshold numeric 暂不支持，值为NULL。 include_column numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 pct_free numeric 暂不支持，值为NULL。 logging character varying(3) 暂不支持，值为NULL。 blevel numeric 暂不支持，值为NULL。 leaf_blocks numeric 暂不支持，值为NULL。 distinct_keys numeric 暂不支持，值为NULL。 avg_leaf_blocks_per_key numeric 暂不支持，值为NULL。 avg_data_blocks_per_key numeric 暂不支持，值为NULL。 clustering_factor numeric 暂不支持，值为NULL。 num_rows numeric 暂不支持，值为NULL。 sample_size numeric 暂不支持，值为NULL。 last_analyzed date 暂不支持，值为NULL。 degree character varying(40) 暂不支持，值为NULL。 instances character varying(40) 暂不支持，值为NULL。 temporary character varying(1) 暂不支持，值为NULL。 secondary character varying(1) 暂不支持，值为NULL。 buffer_pool character varying(7) 暂不支持，值为NULL。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 duration character varying(15) 暂不支持，值为NULL。 pct_direct_access numeric 暂不支持，值为NULL。 ityp_owner character varying(128) 暂不支持，值为NULL。 ityp_name character varying(128) 暂不支持，值为NULL。 parameters character varying(1000) 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 domidx_status character varying(12) 暂不支持，值为NULL。 domidx_opstatus character varying(6) 暂不支持，值为NULL。 funcidx_status character varying(8) 暂不支持，值为NULL。 join_index character varying(3) 暂不支持，值为NULL。 iot_redundant_pkey_elim character varying(3) 暂不支持，值为NULL。 dropped character varying(3) 暂不支持，值为NULL。 visibility character varying(9) 暂不支持，值为NULL。 domidx_management character varying(14) 暂不支持，值为NULL。 segment_created character varying(3) 暂不支持，值为NULL。 orphaned_entries character varying(3) 暂不支持，值为NULL。 indexing character varying(7) 暂不支持，值为NULL。 auto character varying(3) 暂不支持，值为NULL。 父主题： 系统视图

审计管理员 审计管理员是指具有AUDITADMIN属性的账户，具有查看和删除审计日志的权限。 要创建新的审计管理员，三权分立关闭时，请以系统管理员或者安全管理员身份连接数据库。三权分立打开时，只能以初始用户身份连接数据库，并使用带AUDITADMIN选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER auditadmin WITH AUDITADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe AUDITADMIN; ALTER USER时，要求用户已存在。

安全策略管理员 安全策略管理员是指具有POLADMIN属性的账户，具有创建资源标签，脱敏策略和统一审计策略的权限。 要创建新的安全策略管理员，请以系统管理员用户身份连接数据库，并使用带POLADMIN选项的CREATE USER语句或ALTER USER语句进行设置。 1 gaussdb=# CREATE USER poladmin WITH POLADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe POLADMIN; ALTER USER时，要求用户已存在。

监控管理员 监控管理员是指具有MONADMIN属性的账户，具有查看dbe_perf模式下视图和函数的权限，亦可以对dbe_perf模式的对象权限进行授予或收回。 要创建新的监控管理员，请以系统管理员身份连接数据库，并使用带MONADMIN选项的CREATE USER语句或ALTER USER语句进行设置。 1 gaussdb=# CREATE USER monadmin WITH MONADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe MONADMIN; ALTER USER时，要求用户已存在。

运维管理员 运维管理员是指具有OPRADMIN属性的账户，具有使用Roach工具执行备份恢复的权限。 要创建新的运维管理员，请以初始用户身份连接数据库，并使用带OPRADMIN选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER opradmin WITH OPRADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe OPRADMIN; ALTER USER时，要求用户已存在。

系统管理员 系统管理员是指具有SYSADMIN属性的账户，默认安装情况下具有与对象所有者相同的权限，但不包括dbe_perf模式的对象权限和使用Roach工具执行备份恢复的权限。 要创建新的系统管理员，请以初始用户或者系统管理员用户身份连接数据库，并使用带SYSADMIN选项的CREATE USER语句或ALTER USER语句进行设置。 1 gaussdb=# CREATE USER sysadmin WITH SYSADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe SYSADMIN; ALTER USER时，要求用户已存在。

安全管理员 安全管理员是指具有CREATEROLE属性的账户，具有创建、修改、删除用户或角色的权限。 要创建新的安全管理员，三权分立关闭时，请以系统管理员或者安全管理员身份连接数据库。三权分立打开时，请以安全管理员身份连接数据库，并使用带CREATEROLE选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER createrole WITH CREATEROLE password "********"; 或者 1 gaussdb=# ALTER USER joe CREATEROLE; ALTER USER时，要求用户已存在。

初始用户 集群安装过程中自动生成的账户称为初始用户。初始用户也是系统管理员、安全管理员、审计管理员、监控管理员、运维管理员和安全策略管理员，拥有系统的最高权限，能够执行所有的操作。如果安装时不设置初始用户名称，则该账户与进行集群安装的操作系统用户同名。如果在安装集群时不设置初始用户的密码，安装完成后密码为空，在执行其他操作前需要通过gsql客户端设置初始用户的密码。如果初始用户密码为空，则除修改密码外无法执行其他SQL操作以及升级、扩容、节点替换等操作。 初始用户会绕过所有权限检查。建议仅将此初始用户作为DBA管理用途，而非业务应用。

PG_AMPROC PG_AMPROC系统表存储有关与访问方法操作符族相关联的支持过程的信息。每个属于某个操作符族的支持过程都占有一行。 表1 PG_AMPROC字段 名称 类型 引用 描述 oid oid - 行标识符（隐含字段，必须明确选择）。 amprocfamily oid PG_OPFAMILY.oid 该项的操作符族。 amproclefttype oid PG_TYPE.oid 相关操作符的左输入数据类型。 常见的数据类型请参见数据类型。 amprocrighttype oid PG_TYPE.oid 相关操作符的右输入数据类型。 常见的数据类型请参见数据类型。 amprocnum smallint - 支持过程编号。 amproc regproc PG_PROC .proname 过程的OID。 amproclefttype和amprocrighttype字段的习惯解释，标识一个特定支持过程支持的操作符的左和右输入类型。对于某些访问方式，匹配支持过程本身的输入数据类型，对其他的则不这样。有一个对索引的“缺省”支持过程的概念，amproclefttype和amprocrighttype都等于索引操作符类的opcintype。 父主题： 系统表

DB_TAB_COMMENTS DB_TAB_COMMENTS视图显示当前用户可访问的所有表和视图的注释信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 DB_TAB_COMMENTS字段 名称 类型 描述 owner character varying(128) 表或视图的所有者。 table_name character varying(128) 表或视图的名称。 table_type character varying(11) 对象类型。 comments text 注释。 origin_con_id numeric 暂不支持，值为0。 schema character varying(64) 表所属的名称空间的名称。 父主题： 系统视图

注意事项 PQprepare创建一个为PQexecPrepared执行用的预备语句，本特性支持命令的重复执行，不需要每次都进行解析和规划。PQprepare仅在协议3.0及以后的连接中支持，使用协议2.0时，PQprepare将失败。 该函数从查询字符串创建一个名为stmtName的预备语句，该查询字符串必须包含一个SQL命令。stmtName可以是""来创建一个未命名的语句，在这种情况下，任何预先存在的未命名的语句都将被自动替换，否则，如果在当前会话中已经定义了语句名称，则这是一个错误。如果使用了任何参数，那么在查询中将它们称为$1,$2等。nParams是在paramTypes[]数组中预先指定类型的参数的数量。（当nParams为0时，数组指针可以为NULL）paramTypes[]通过OID指定要分配给参数符号的数据类型。如果paramTypes为NULL，或者数组中的任何特定元素为零，服务器将按照对非类型化字面字符串的相同方式为参数符号分配数据类型。另外，查询可以使用数字高于nParams的参数符号，还将推断这些符号的数据类型。 通过执行SQLPREPARE语句，还可以创建与PQexecPrepared一起使用的预备语句。此外，虽然没有用于删除预备语句的libpq函数，但是SQL DEALLOCATE语句可用于此目的。

定时任务管理 创建测试表。 1 gaussdb=# CREATE TABLE test(id int, time date); 当结果显示为如下信息，则表示创建成功。 1 CREATE TABLE 创建自定义存储过程。 1 2 3 4 5 6 7 8 9 gaussdb=# CREATE OR REPLACE PROCEDURE PRC_JOB_1() AS N_NUM integer :=1; BEGIN FOR I IN 1..1000 LOOP INSERT INTO test VALUES(I,SYSDATE); END LOOP; END; / 当结果显示为如下信息，则表示创建成功。 1 CREATE PROCEDURE 创建任务。 新创建的任务（未指定job_id）表示每隔1分钟执行一次存储过程PRC_JOB_1。 1 2 3 4 5 gaussdb=# call dbe_task.submit('call public.prc_job_1(); ', sysdate, 'interval ''1 minute''', :a); job ----- 1 (1 row) 指定job_id创建任务，其中job_id可用范围为1~32767。 1 2 3 4 5 gaussdb=# call dbe_task.id_submit(2,'call public.prc_job_1(); ', sysdate, 'interval ''1 minute'''); isubmit --------- (1 row) 通过视图查看当前用户已创建的任务信息。 1 2 3 4 5 gaussdb=# select job,dbname,start_date,last_date,this_date,next_date,broken,status,interval,failures,what from my_jobs; job | dbname | start_date | last_date | this_date | next_date | broken | status | interval | failures | what -----+--------+---------------------+----------------------------+----------------------------+---------------------+--------+--------+---------------------+----------+--------------------------- 1 | testdb | 2017-07-18 11:38:03 | 2017-07-18 13:53:03.607838 | 2017-07-18 13:53:03.607838 | 2017-07-18 13:54:03 | n | s | interval '1 minute' | 0 | call public.prc_job_1(); (1 row) 停止任务。 1 2 3 4 5 gaussdb=# call dbe_task.finish(1,true); broken -------- (1 row) 启动任务。 1 2 3 4 5 gaussdb=# call dbe_task.finish(1,false); broken -------- (1 row) 修改任务属性。 修改JOB的Next_date参数信息。 1 2 3 4 5 6 --修改Job1的Next_date为1小时以后开始执行。 gaussdb=# call dbe_task.next_time(1, sysdate+1.0/24); next_date ----------- (1 row) 修改JOB的Interval参数信息。 1 2 3 4 5 6 --修改Job1的Interval为每隔1小时执行一次。 gaussdb=# call dbe_task.interval(1,'sysdate + 1.0/24'); interval ---------- (1 row) 修改JOB的What参数信息。 1 2 3 4 5 6 --修改Job1的What为执行SQL语句“insert into public.test values(333, sysdate+5);”。 gaussdb=# call dbe_task.content(1,'insert into public.test values(333, sysdate+5);'); what ------ (1 row) 同时修改JOB的Next_date、Interval、What等多个参数信息。 1 2 3 4 5 gaussdb=# call dbe_task.update(1, 'call public.prc_job_1();', sysdate, 'interval ''1 minute'''); change -------- (1 row) 删除JOB。 1 2 3 4 5 gaussdb=# call dbe_task.cancel(1); remove -------- (1 row) 查看JOB执行情况。 当JOB自动执行时，如果JOB执行失败（即job_status状态值为'f'）时，请联系管理员查看pg_log的运行日志来查看JOB的失败信息。 日志信息如下所示，从失败信息（detail error msg）中可以查看失败的具体错误。 LOG: Execute Job Detail: job_id: 1 what: call public.test(); start_date: 2017-07-19 23:30:47.401818 job_status: failed detail error msg: relation "test" does not exist end_date: 2017-07-19 23:30:47.401818 next_run_date: 2017-07-19 23:30:56.855827 JOB的权限控制。 当创建一个JOB时，该JOB会和创建该JOB的数据库和用户绑定（即：pg_job系统表新增的JOB记录中的dbname和log_user）。 如果当前用户是DBA用户、系统管理员或该JOB的创建用户（即：pg_job中的log_user），那么该用户有权限通过高级包接口remove、change、next_data、what、interval删除或修改JOB的参数信息。否则，会提示当前用户没有权限操作该JOB。 如果当前数据库是该JOB创建所属的数据库（即：pg_job系统表中的dbname），那么连接到当前数据库上可以通过高级包接口cancel、update、next_data、content、interval删除或修改JOB的参数信息。 当删除JOB所属的数据库（即：pg_job系统表中的dbname）时，系统会关联删除该数据库从属的JOB记录。 当删除JOB所属的用户（即：pg_job系统表中的log_user）时，系统会关联删除该用户从属的JOB记录。 JOB的并发控制管理。 用户可以通过配置GUC参数job_queue_processes调整并发同时执行的JOB数目。 当job_queue_processes为0时，表示不启用定时任务功能，任何job都不会被执行。 当job_queue_processes为大于0时，表示启用定时任务功能且系统能够并发处理的最大任务数。 由于并行运行的任务数太多会消耗更多的系统资源，因此需要设置系统并发处理的任务数，当前并发的任务数达到job_queue_processes时，且此时又有任务到期，那么这些任务本次得不到执行而延期到下一轮询周期。因此，建议用户需要根据每个任务的执行时长合理的设置任务的时间间隔（即submit接口中的interval参数），来避免由于任务执行时间太长而导致下个轮询周期无法正常执行。 注：对于不使用JOB的集群中，用户可以通过在集群安装初始化完成后，通过设置job_queue_processes为0来关闭JOB功能，减少系统资源的消耗。

背景信息 当客户在使用数据库过程中，如果白天执行一些耗时比较长的任务（例如：统计数据汇总之类或从其他数据库同步数据的任务），会对正常的业务有性能影响，所以客户经常选择在晚上执行，无形中增加了客户的工作量。因此数据库兼容ORA数据库中定时任务的功能，可以由客户创建定时任务，当任务时间点到达后可以自动触发任务的执行，从而可以减少客户运维的工作量。 数据库兼容ORA定时任务功能主要通过DBE_SCHEDULER和DBE_TASK高级包提供的接口，可以实现定时任务的创建、任务到期自动执行、任务删除和修改任务属性（包括：任务id、任务的关闭开启、任务的触发时间、触发时间间隔和任务内容等）。推荐使用DBE_SCHEDULER接口，保证高可用性、高可靠性，并且支持更灵活的任务调度。接口说明、迁移指导示例请参见DBE_SCHEDULER章节。