华为云用户手册

PG_DEFAULT_ACL PG_DEFAULT_ACL系统表存储为新建对象设置的初始权限。 表1 PG_DEFAULT_ACL字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 defaclrole oid 与此权限相关的角色ID。 defaclnamespace oid 与此权限相关的名称空间，如果没有，则为0。 defaclobjtype "char" 此权限的对象类型。 r表示表或视图。 S表示序列。 f表示函数。 T表示类型。 K表示客户端主密钥。 k表示列加密密钥。 defaclacl aclitem[] 创建该类型时所拥有的访问权限。 父主题： 系统表

STAT_ALL_INDEXES 显示数据库当前节点中的每个索引的访问信息。 表1 STAT_ALL_INDEXES字段 名称 类型 描述 relid oid 这个索引的表的OID。 indexrelid oid 索引的OID。 schemaname name 索引所在的Schema名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan bigint 该索引上执行的索引扫描次数。 idx_tup_read bigint 该索引上扫描返回的索引项数。 idx_tup_fetch bigint 使用该索引的简单索引扫描在原表中抓取的活跃行数。 父主题： Object

注意事项 当在OPTIONS中出现password选项时，需要保证 GaussDB 每个节点的$GAUSSHOME/bin目录下存在usermapping.key.cipher和usermapping.key.rand文件，如果不存在这两个文件，请使用gs\_guc工具生成并使用gs\_ssh工具发布到每个节点的$GAUSSHOME/bin目录下。具体操作请参考OPTIONS中的说明。 OPTIONS中的敏感字段（如password）在使用多层引号时，语义和不带引号的场景是不同的，因此不会被识别为敏感字段进行脱敏。

语法格式 ALTER USER MAPPING FOR { user_name | USER | CURRENT_USER | PUBLIC } SERVER server_name OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ] ) 在OPTIONS选项里，ADD、SET和DROP指定要执行的操作，未指定时默认为ADD操作。option和value为对应操作的参数及参数值。

参数说明 user_name 该映射的用户名。 CURRENT_USER和USER匹配当前用户的名称。PUBLIC被用来匹配系统中所有当前以及未来的用户名。 server_name 该用户映射的服务器名。 OPTIONS 为该用户映射更改选项。新选项会覆盖任何之前指定的选项。ADD、 SET和DROP指定要被执行的动作。如果没有显式地指定操作，将假定为ADD。选项名称必须为唯一，该服务器的外部数据包装器也会验证选项。 用户的密码会加密后保存到系统表PG_USER_MAPPING中，加密时需要使用usermapping.key.cipher和usermapping.key.rand作为加密密码文件和加密因子。首次使用前需要通过如下命令创建这两个文件，并将这两个文件放入各节点的$GAUSSHOME/bin目录，且确保具有读权限。gs_ssh工具可以协助您快速将文件放入各节点对应目录下。 gs_ssh -c "gs_guc generate -o usermapping -S default -D $GAUSSHOME/bin" 其中-S参数指定default时会随机生成密码，用户也可为-S参数指定密码，此密码用于保证生成密码文件的安全性和唯一性，用户无需保存或记忆。其他参数详见工具参考中gs_guc工具说明。

MY_JOBS MY_JOBS视图显示当前用户拥有的定时任务的详细信息。该视图同时存在于PG_CATA LOG 和SYS Schema下。 表1 MY_JOBS字段 名称 类型 描述 job bigint 作业ID。 log_user name 创建者的UserName。 priv_user name 作业执行者的UserName。 dbname name 创建作业的数据库名称。 schema_user name 定时任务的默认模式名。 start_date timestamp without time zone 作业第一次开始执行的时间。 start_suc text 作业第一次成功执行的时间。 last_date timestamp without time zone 上次运行的开始时间。 last_suc text 上次成功运行的开始时间。 last_sec text 上次成功运行的开始时间，提供兼容性支持。 this_date timestamp without time zone 正在运行任务的此次开始时间。 this_suc text 正在运行任务的此次开始时间。 this_sec text 正在运行任务的此次开始时间，提供兼容性支持。 next_date timestamp without time zone 任务下次执行时间。 next_suc text 任务下次执行时间。 next_sec text 任务下次执行时间，提供兼容性支持。 total_time numeric 任务最近一次的执行时长。 broken text 如果任务状态为d，则为'y'，否则为'n'。 status "char" 本步骤的执行状态，取值范围：（'r'、's'、'f'、'd'），默认为'r'，取值含义： r：运行中。 s：执行成功。 f：执行失败。 d：取消执行。 interval text 用来计算下次运行时间的时间表达式，如果为null则表示定时任务只执行一次。 failures smallint 失败计数，若作业连续执行失败16次，则不再继续执行。 what text 可执行的作业。 nls_env character varying(4000) 暂不支持，值为NULL。 misc_env raw 暂不支持，值为NULL。 instance numeric 暂不支持，值为NULL。 父主题： 系统视图

示例 逻辑复制类PGReplicationStream为非线程安全类，并发调用可能导致数据异常。 代码运行的前提条件： 添加JDBC用户机器IP（假设IP为10.11.12.34）到复制数据权限的白名单里，命令如下： gs_guc reload -Z datanode -N all -I all -h 'host replication all 10.11.12.34/32 sha256' 将wal_level参数设置为logical，设置方法请联系管理员处理。 创建表t1和t2，并且对该表进行DDL或DML操作。 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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 // 以下用例以opengaussjdbc.jar为例。 // 认证用的用户名和密码直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中存放（密码应密文存放，使用时解密），确保安全。 // 本示例以用户名和密码保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量（环境变量名称请根据自身情况进行设置）EXAMPLE_USERNAME_ENV和EXAMPLE_PASSWORD_ENV。 // $ip、$port、database需要用户自行修改。 import com.huawei.opengauss.jdbc.PGProperty; import com.huawei.opengauss.jdbc.jdbc.PgConnection; import com.huawei.opengauss.jdbc.replication.LogSequenceNumber; import com.huawei.opengauss.jdbc.replication.PGReplicationStream; import java.nio.ByteBuffer; import java.sql.DriverManager; import java.util.Properties; import java.util.concurrent.TimeUnit; public class LogicalReplicationDemo { private static PgConnection conn = null; public static void main(String[] args) { String driver = "com.huawei.opengauss.jdbc.Driver"; // 此处配置数据库IP以及端口，这里的端口为haPort，通常默认是所连接DN的port+1端口 String sourceURL = "jdbc:opengauss://$ip:$port/database"; // 默认逻辑复制槽的名称是：replication_slot // 测试模式：创建逻辑复制槽 int TEST_MODE_CREATE_SLOT = 1; // 测试模式：开启逻辑复制（前提条件是逻辑复制槽已经存在） int TEST_MODE_START_REPL = 2; // 测试模式：删除逻辑复制槽 int TEST_MODE_DROP_SLOT = 3; // 开启不同的测试模式 int testMode = TEST_MODE_START_REPL; try { Class.forName(driver); } catch (Exception e) { e.printStackTrace(); return; } try { Properties properties = new Properties(); PGProperty.USER.set(properties, System.getenv("EXAMPLE_USERNAME_ENV")); PGProperty.PASSWORD.set(properties, System.getenv("EXAMPLE_PASSWORD_ENV")); // 对于逻辑复制，以下三个属性是必须配置项 PGProperty.ASSUME_MIN_SERVER_VERSION.set(properties, "9.4"); PGProperty.REPLICATION.set(properties, "database"); PGProperty.PREFER_QUERY_MODE.set(properties, "simple"); conn = (PgConnection) DriverManager.getConnection(sourceURL, properties); System.out.println("connection success!"); if(testMode == TEST_MODE_CREATE_SLOT){ conn.getReplicationAPI() .createReplicationSlot() .logical() .withSlotName("replication_slot") // 这里字符串如包含大写字母则会自动转化为小写字母 .withOutputPlugin("mppdb_decoding") .make(); }else if(testMode == TEST_MODE_START_REPL) { // 开启此模式前需要创建复制槽 LogSequenceNumber waitLSN = LogSequenceNumber.valueOf("6F/E3C53568"); // LSN需要用户根据实际情况进行修改 PGReplicationStream stream = conn .getReplicationAPI() .replicationStream() .logical() .withSlotName("replication_slot") .withSlotOption("include-xids", true) .withSlotOption("skip-empty-xacts", true) .withStartPosition(waitLSN) .withSlotOption("parallel-decode-num", 10) // 解码线程并行度 .withSlotOption("white-table-list", "public.t1,public.t2") // 白名单列表 // .withSlotOption("standby-connection", true) // 强制备机解码 .withSlotOption("decode-style", "t") // 解码格式 .withSlotOption("sending-batch", 0) // 批量发送解码结果 .withSlotOption("max-txn-in-memory", 100) // 单个解码事务落盘内存阈值为100MB .withSlotOption("max-reorderbuffer-in-memory", 2) // 正在处理的解码事务落盘内存阈值为2GB .withSlotOption("exclude-users", "userA") // 不返回用户userA执行事务的逻辑日志 .withSlotOption("include-user", false) // 事务BEGIN逻辑日志不携带用户名 .withSlotOption("enable-heartbeat", true) // 开启心跳日志 .start(); while (true) { ByteBuffer byteBuffer = stream.readPending(); if (byteBuffer == null) { TimeUnit.MILLISECONDS.sleep(10L); continue; } int offset = byteBuffer.arrayOffset(); byte[] source = byteBuffer.array(); int length = source.length - offset; System.out.println(new String(source, offset, length)); // 如果需要flush lsn，根据业务实际情况调用以下接口，该接口会触发数据库复制槽落盘，对服务端解码性能有一定影响，建议调用间隔大于10s。 // LogSequenceNumber lastRecv = stream.getLastReceiveLSN(); // stream.setFlushedLSN(lastRecv); // stream.forceUpdateStatus(); } }else if(testMode == TEST_MODE_DROP_SLOT){ conn.getReplicationAPI() .dropReplicationSlot("replication_slot"); } } catch (Exception e) { e.printStackTrace(); return; } finally { try { conn.close(); } catch (Exception e) { e.printStackTrace(); } } } } text格式（即't'格式）解码结果示例如下： BEGIN CS N: 2014 first_lsn: 0/2816A28 table public t1 INSERT: a[integer]:1 b[integer]:2 c[text]:'hello' COMMIT XID: 15504 BEGIN CSN: 2015 first_lsn: 0/2816C20 table public t1 UPDATE: old-key: a[integer]:1 b[integer]:2 c[text]:'hello' new-tuple: a[integer]:1 b[integer]:5 c[text]:'hello' COMMIT XID: 15505 BEGIN CSN: 2016 first_lsn: 0/2816D60 table public t1 DELETE: a[integer]:1 b[integer]:5 c[text]:'hello' COMMIT XID: 15506 json格式（即'j'格式）解码结果示例如下： BEGIN CSN: 2014 first_lsn: 0/2816A28 {"table_name":"public.t1","op_type":"INSERT","columns_name":["a","b","c"],"columns_type":["integer","integer","text"],"columns_val":["1","2","'hello'"],"old_keys_name":[],"old_keys_type":[],"old_keys_val":[]} COMMIT XID: 15504 BEGIN CSN: 2015 first_lsn: 0/2816C20 {"table_name":"public.t1","op_type":"UPDATE","columns_name":["a","b","c"],"columns_type":["integer","integer","text"],"columns_val":["1","5","'hello'"],"old_keys_name":["a","b","c"],"old_keys_type":["integer","integer","text"],"old_keys_val":["1","2","'hello'"]} COMMIT XID: 15505 BEGIN CSN: 2016 first_lsn: 0/2816D60 {"table_name":"public.t1","op_type":"DELETE","columns_name":[],"columns_type":[],"columns_val":[],"old_keys_name":["a","b","c"],"old_keys_type":["integer","integer","text"],"old_keys_val":["1","5","'hello'"]} COMMIT XID: 15506

注意事项 所有该角色在当前数据库里和共享对象（数据库，表空间） 上的所有对象上的权限都将被撤销。 DROP OWNED常常被用来为移除一个或者多个角色做准备。因为DROP OWNED只影响当前数据库中的对象，通常需要在包含将被移除角色所拥有的对象的每一个数据库中都执行这个命令。 使用CASCADE选项可能导致这个命令递归去删除由其他用户所拥有的对象。 角色所拥有的数据库、表空间将不会被移除。 角色所拥有的私有DATABASE LINK连接需要添加CASCADE才可删除。

MY_TAB_STATS_HISTORY MY_TAB_STATS_HISTORY视图提供当前用户所拥有的表的表统计信息历史。所有用户都可以访问该视图。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_TAB_STATS_HISTORY字段 名称 类型 描述 table_name character varying(128) 表名。 partition_name character varying(128) 暂不支持，值为NULL。 subpartition_name character varying(128) 暂不支持，值为NULL。 stats_update_time timestamp(6) with time zone 统计信息更新的时间，数据库重启后，数据会丢失。 父主题： 系统视图

V_SESSION V_SESSION视图显示当前所有会话的信息，该视图只有系统管理员可以访问，普通用户需要授权才能访问，该视图同时存在于PG_CATALOG和SYS Schema下。 表1 V_SESSION字段 名称 类型 描述 saddr raw 暂不支持，值为NULL。 sid bigint 会话ID。 serial# integer 当前活动的后台线程的序号，在GaussDB中为0。 audsid numeric 暂不支持，值为NULL。 paddr raw 暂不支持，值为NULL。 schema# numeric 暂不支持，值为NULL。 schemaname name 登录该后台的用户名。 user# oid 登录此后台线程的用户的OID。oid 为0表示此后台线程为全局辅助线程（auxiliary）。 username name 登录此后台线程的用户名。username为空表示此后台线程为全局辅助线程（auxiliary）。 command numeric 暂不支持，值为NULL。 ownerid numeric 暂不支持，值为NULL。 taddr character varying(16) 暂不支持，值为NULL。 lockwait character varying(16) 暂不支持，值为NULL。 machine text 客户端的主机名，这个字段是通过client_addr的反向DNS查找得到。这个字段只有在启动log_hostname且使用IP连接时才非空。 sql_id bigint 查询语句的ID。 client_info text 客户端信息。 event text 语句当前排队状态。可能值是： waiting in queue：表示语句在排队中。 空：表示语句正在运行。 sql_exec_start timestamp with time zone 开始当前活跃查询的时间，如果state的值不是active，则这个值是上一个查询的开始时间。 program text 连接到该后台的应用名。 status text 该后台当前总体状态。可能值是： active：后台正在执行一个查询。 idle：后台正在等待一个新的客户端命令。 idle in transaction：后台在事务中，但事务中没有语句在执行。 idle in transaction (aborted)：后台在事务中，但事务中有语句执行失败。 fastpath function call：后台正在执行一个fast-path函数。 disabled：如果后台禁用track_activities，则报告这个状态。 server character varying(9) 暂不支持，值为NULL。 pdml_status character varying(8) 当前会话是否启用DML的并行执行。 port numeric 当前会话的端口号。 process character varying(24) 当前会话的进程号。 logon_time timestamp(0) without time zone 当前会话的登录时间。 last_call_et integer 当前会话上次状态发生改变的时长。 osuser character varying(128) 暂不支持，值为NULL。 terminal character varying(30） 暂不支持，值为NULL。 type character varying(10) 暂不支持，值为NULL。 sql_address raw 暂不支持，值为NULL。 sql_hash_value numeric 暂不支持，值为NULL。 sql_child_number numeric 暂不支持，值为NULL。 sql_exec_id numeric 暂不支持，值为NULL。 prev_sql_addr raw 暂不支持，值为NULL。 prev_hash_value numeric 暂不支持，值为NULL。 prev_sql_id character varying(13) 暂不支持，值为NULL。 prev_child_number numeric 暂不支持，值为NULL。 prev_exec_start timestamp(0) without time zone 暂不支持，值为NULL。 prev_exec_id numeric 暂不支持，值为NULL。 plsql_entry_object_id numeric 暂不支持，值为NULL。 plsql_entry_subprogram_id numeric 暂不支持，值为NULL。 plsql_object_id numeric 暂不支持，值为NULL。 plsql_subprogram_id numeric 暂不支持，值为NULL。 module character varying(64) 暂不支持，值为NULL。 module_hash numeric 暂不支持，值为NULL。 action character varying(64) 暂不支持，值为NULL。 action_hash numeric 暂不支持，值为NULL。 fixed_table_sequence numeric 暂不支持，值为NULL。 row_wait_obj# numeric 暂不支持，值为NULL。 row_wait_file# numeric 暂不支持，值为NULL。 row_wait_block# numeric 暂不支持，值为NULL。 row_wait_row# numeric 暂不支持，值为NULL。 top_level_call# numeric 暂不支持，值为NULL。 pdml_enabled character varying(3) 暂不支持，值为NULL。 failover_type character varying(13) 暂不支持，值为NULL。 failover_method character varying(10) 暂不支持，值为NULL。 failed_over character varying(3) 暂不支持，值为NULL。 resource_consumer_group character varying(32) 暂不支持，值为NULL。 pddl_status character varying(8) 暂不支持，值为NULL。 pq_status character varying(8) 暂不支持，值为NULL。 current_queue_duration numeric 暂不支持，值为NULL。 client_identifier character varying(64) 暂不支持，值为NULL。 blocking_session_status character varying(11) 暂不支持，值为NULL。 blocking_instance numeric 暂不支持，值为NULL。 blocking_session numeric 暂不支持，值为NULL。 final_blocking_session_status character varying(11) 暂不支持，值为NULL。 final_blocking_instance numeric 暂不支持，值为NULL。 final_blocking_session numeric 暂不支持，值为NULL。 seq# numeric 暂不支持，值为NULL。 event# numeric 暂不支持，值为NULL。 p1text character varying(64) 暂不支持，值为NULL。 p1 numeric 暂不支持，值为NULL。 p1raw raw 暂不支持，值为NULL。 p2text character varying(64) 暂不支持，值为NULL。 p2 numeric 暂不支持，值为NULL。 p2raw raw 暂不支持，值为NULL。 p3text character varying(64) 暂不支持，值为NULL。 p3 numeric 暂不支持，值为NULL。 p3raw raw 暂不支持，值为NULL。 wait_class_id numeric 暂不支持，值为NULL。 wait_class# numeric 暂不支持，值为NULL。 wait_class character varying(64) 暂不支持，值为NULL。 wait_time numeric 暂不支持，值为NULL。 seconds_in_wait numeric 暂不支持，值为NULL。 state character varying(19) 暂不支持，值为NULL。 wait_time_micro numeric 暂不支持，值为NULL。 time_remaining_micro numeric 暂不支持，值为NULL。 time_since_last_wait_micro numeric 暂不支持，值为NULL。 service_name character varying(64) 暂不支持，值为NULL。 sql_trace character varying(8) 暂不支持，值为NULL。 sql_trace_waits character varying(5) 暂不支持，值为NULL。 sql_trace_binds character varying(5) 暂不支持，值为NULL。 sql_trace_plan_stats character varying(10) 暂不支持，值为NULL。 session_edition_id numeric 暂不支持，值为NULL。 creator_addr raw 暂不支持，值为NULL。 creator_serial# numeric 暂不支持，值为NULL。 ecid character varying(64) 暂不支持，值为NULL。 sql_translation_profile_id numeric 暂不支持，值为NULL。 pga_tunable_mem numeric 暂不支持，值为NULL。 shard_ddl_status character varying(8) 暂不支持，值为NULL。 con_id numeric 暂不支持，值为NULL。 external_name character varying(1024) 暂不支持，值为NULL。 plsql_debugger_connected character varying(5) 暂不支持，值为NULL。 父主题： 系统视图

job_queue_processes 参数说明：表示系统可以并发执行的job数目。该参数为postmaster级别，通过gs_guc设置，需要重启gaussdb才能生效。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：0～1000 功能： 当job_queue_processes设置为0值，表示不启用定时任务功能，任何job都不会被执行（因为开启定时任务的功能会对系统的性能有影响，有些局点可能不需要定时任务的功能，可以通过设置为0不启用定时任务功能）。 当job_queue_processes为大于0时，表示启用定时任务功能且系统能够并发处理的最大任务数。 启用定时任务功能后，job_scheduler线程会在定时时间间隔轮询pg_job系统表，系统设置定时任务检查周期默认为1s。 由于并行运行的任务数太多会消耗更多的系统资源，因此需要设置系统并发处理的任务数，当前并发的任务数达到job_queue_processes时，且此时又有任务到期，那么这些任务本次得不到执行而延期到下一轮询周期。因此，建议用户需要根据每个任务的执行时长合理地设置任务的时间间隔（即submit接口中的interval参数），来避免由于任务执行时间太长而导致下个轮询周期无法正常执行。 注：如果同一时间内并行的job数很多，过小的参数值会导致job等待。而过大的参数值则消耗更多的系统资源，建议设置此参数为100，用户可以根据系统资源情况合理调整。 默认值：10

ADM_HIST_SNAPSHOT ADM_HIST_SNAPSHOT视图记录当前系统中存储的WDR快照数据信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图位于PG_CATALOG和SYS Schema下。该视图只有在GUC参数enable_wdr_snapshot为on时才可以访问。访问PG_CATALOG.ADM_HIST_SNAPSHOT和SYS.ADM_HIST_SNAPSHOT视图除需要本视图访问权限外，还需要snapshot schema，snapshot table和tables_snap_timestamp表的访问权限。 表1 ADM_HIST_SNAPSHOT字段 名称 类型 描述 snap_id bigint 唯一快照ID。 dbid oid 快照的数据库ID。 instance_number oid 暂不支持，同DBID。 startup_time timestamp(3) without time zone 实例启动时间。 begin_interval_time timestamp without time zone 快照间隔开始的时间（即上次快照的结束时间）。 end_interval_time timestamp without time zone 快照间隔结束的时间。拍摄快照的实际时间（即本次快照的结束时间）。 flush_elapsed interval 执行快照所花费的时间。 snap_level numeric 暂不支持，值为NULL。 error_count numeric 暂不支持，值为NULL。 snap_flag numeric 暂不支持，值为NULL。 snap_timezone interval day to second(0) 快照时区，表示为与UTC（协调世界时）时区的偏移量。 begin_interval_time_tz timestamp with time zone 快照间隔开始的时间（即上次快照的结束时间），带时区。 end_interval_time_tz timestamp with time zone 快照间隔结束的时间。拍摄快照的实际时间（即本次快照的结束时间），带时区。 con_id numeric 暂不支持，值为0。 父主题： 系统视图

示例 --创建一个无用的外部数据封装器dummy。 gaussdb=# CREATE FOREIGN DATA WRAPPER dummy; --创建一个带有处理器函数file_fdw_handler 的外部数据封装器file。 gaussdb=# CREATE FOREIGN DATA WRAPPER file HANDLER file_fdw_handler; --创建一个带有一些选项的外部数据封装器mywrapper。 gaussdb=# CREATE FOREIGN DATA WRAPPER mywrapper OPTIONS (debug 'true');

参数说明 name 要创建的外部数据封装器的名字 HADNLER handler_function handler_function是先前已经注册了的函数的名字，用来为外部表检索执行函数。 处理器函数必须没有参数，并且它的返回类型必须为fdw_handler。 不用处理器函数创建外部数据封装器是可能的，但是使用这种封装器的外部表只能被声明，不能被访问。 VALIDATOR validator_function validator_function 是先前已经注册了的函数的名字用来检查提供给外部数据封装器的通用选项， 还有使用该外部数据封装器的外部服务器、用户映射和外部表的选项。 如果没有验证器函数或声明了NO VALIDATOR， 那么在创建时将不检查选项。（外部数据封装器可能在运行时忽略或拒绝无效的选项说明， 取决于实现。）验证器函数必须接受两个参数：一个类型为text[]， 将包含存储在系统目录中的选项的数组，一个类型为oid， 是包含这些选项的系统目录的OID。忽略返回类型；该函数应该使用 ereport(ERROR)函数报告无效选项。 OPTIONS ( option 'value' [, ... ] ) 这个子句为新的外部数据封装器声明选项。允许的选项名和值是特定于每个外部数据封装器的， 并且是经过外部数据封装器的验证器函数验证了的。选项名必须是唯一的。

ai_watchdog_monitor_status 表1 ai_watchdog_monitor_status参数说明 参数 类型 描述 metric_name text metric指标名称： tps：TPS。 tps_hourly：每小时的TPS均值。 shared_used_mem：共享内存使用量（MB）。 dynamic_used_shrctx：共享内存上下文使用量（MB）。 other_used_mem：其他内存使用量（MB）。 process_used_mem：系统常驻内存使用量（MB）。 dynamic_used_mem：动态内存使用量（MB）。 malloc_failures：每个采集间隔内的内存分配失败次数。 D_state_rate：D状态线程比例。 R_state_rate：R状态线程比例。 S_state_rate：S状态线程比例。 db_state：数据库的状态（68表示D、82表示R、83表示S）。 cpu_usage：CPU使用率，上限100。 disk_io：两个采集间隔内的磁盘IO延迟。 network_io：两个采集间隔内的网络IO延迟。 threadpool_usage：线程池使用率。 threadpool_hang_rate：线程池group处于hang状态的比例。 max_length int 采集队列长度。 current_length int 当前采集到的样本数。 collection_interval int 采集间隔，单位秒。 latest_value int 上次采集到的值，没采集到为null。 last_report timestamp 上次采集时刻。 父主题： AI Watchdog

javax.sql.PooledConnection javax.sql.PooledConnection是由连接池创建的连接接口。 表1 对javax.sql.PooledConnection的支持情况 方法名 返回值类型 支持JDBC 4 addConnectionEventListener(ConnectionEventListener listener) void Yes close() void Yes getConnection() Connection Yes removeConnectionEventListener(ConnectionEventListener listener) void Yes 父主题： JDBC接口参考

GS_STATIO_ALL_PARTITIONS GS_STATIO_ALL_PARTITIONS视图包含当前数据库中每个分区表分区的I/O统计信息，此视图信息由gs_statio_get_all_partitions_stats()函数查询得到。 表1 GS_STATIO_ALL_PARTITIONS字段 名称 类型 描述 partition_oid oid 分区OID。 schemaname name 该分区模式名。 relname name 该分区所在表的表名。 partition_name name 该分区所在一级分区名。 sub_partition_name name 该分区所在二级分区名。 heap_blks_read bigint 从该分区中读取的磁盘块数。 heap_blks_hit bigint 该分区缓存命中数。 idx_blks_read bigint 从分区中所有索引读取的磁盘块数。 idx_blks_hit bigint 分区中所有索引命中缓存数。 toast_blks_read bigint 该分区的TOAST表分区读取的磁盘块数（如果存在）。 toast_blks_hit bigint 该分区的TOAST表分区命中缓冲区数（如果存在）。 tidx_blks_read bigint 该分区的TOAST表分区索引读取的磁盘块数（如果存在）。 tidx_blks_hit bigint 该分区的TOAST表分区索引命中缓冲区数（如果存在）。 父主题： 系统视图

什么是SQL SQL是用于访问和处理数据库的标准计算机语言。 SQL提供了各种任务的语句，包括： 查询数据。 在表中插入、更新和删除行。 创建、替换、更改和删除对象。 控制对数据库及其对象的访问。 保证数据库的一致性和完整性。 SQL语言由用于处理数据库和数据库对象的命令和函数组成。该语言还会强制实施有关数据类型、表达式和文本使用的规则。因此在SQL参考章节，除了SQL语法参考外，还介绍了有关数据类型、表达式、函数和操作符等信息。

SQL发展简史 SQL发展简史如下： 1986年，ANSI X3.135-1986，ISO/IEC 9075:1986，SQL-86 1989年，ANSI X3.135-1989，ISO/IEC 9075:1989，SQL-89 1992年，ANSI X3.135-1992，ISO/IEC 9075:1992，SQL-92 1999年，ISO/IEC 9075:1999，SQL:1999 2003年，ISO/IEC 9075:2003，SQL:2003 2011年，ISO/IEC 9075:2011，SQL:2011 2016年，ISO/IEC 9075:2016，SQL:2016 2019年，ISO/IEC 9075:2019，SQL:2019

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

PG_NAMESPACE PG_NAMESPACE系统表存储名称空间，即存储schema相关的信息。 表1 PG_NAMESPACE字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 nspname name 名称空间的名称。 nspowner oid 名称空间的所有者。 nsptimeline bigint 在数据库节点上创建此命名空间时的时间线。此字段为内部使用，仅在数据库节点上有效。 nspacl aclitem[] 访问权限。 in_redistribution "char" 是否处于重发布状态。 nspcollation oid 名称空间的默认字符序（仅在sql_compatibility='b'时可能有值）。 父主题： 系统表

STATIO_ALL_INDEXES STATIO_ALL_INDEXES视图包含数据库中的每个索引行，显示特定索引的I/O的统计。 表1 STATIO_ALL_INDEXES字段 名称 类型 描述 relid oid 索引的表的OID。 indexrelid oid 该索引的OID。 schemaname name 该索引的模式名。 relname name 该索引的表名。 indexrelname name 索引名称。 idx_blks_read bigint 从索引中读取的磁盘块数。 idx_blks_hit bigint 索引命中缓存数。 父主题： Cache/IO

算子说明 Sample Scan是一种扫描表的方式，它可以在查询过程中随机地从表中抽取一部分数据进行查询，而不是扫描整个表。Sample Scan配合TABLESAMPLE关键字使用，使用方式为[ TABLESAMPLE sampling_method ( argument [, ...] ) [ REPEATABLE ( seed ) ] ]。这种技术通常用于大型表或者需要随机抽样的查询场景，可以提高查询效率。

示例 示例：采样查询 --数据准备。 gaussdb=# CREATE TABLE t1 (c1 number, c2 number, c3 number); CREATE TABLE gaussdb=# INSERT INTO t1 VALUES (generate_series(1,100), 2, 3); INSERT 0 100 --执行结果。 gaussdb=# EXPLAIN SELECT c1 FROM t1 tablesample system(10); QUERY PLAN ---------------------------------------------------- Sample Scan on t1 (cost=0.00..272.00 rows=10000 width=6) Sampling: system (10::real) (2 rows) --删除。 gaussdb=# DROP TABLE t1; 上述示例中，Sample Scan算子输出信息如下所示。 信息名称 含义 Sample Scan 算子的名称。 Sampling 算子采样的方式，示例中采用system 作为采样方法，采样的比例为10%

PG_AUTHID PG_AUTHID系统表存储有关数据库认证标识符（角色）的信息。角色把“用户”的概念包含在内。一个用户实际上就是一个rolcanlogin标志被设置的角色。任何角色（不管rolcanlogin设置与否）都能够把其他角色作为成员。 GaussDB中只有一份pg_authid，不是每个数据库有一份。需要有系统管理员权限才可以访问此系统表。 表1 PG_AUTHID字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 rolname name 角色名称。 rolsuper boolean 角色是否是拥有最高权限的初始系统管理员。 t（true）：表示是。 f（false）：表示不是。 rolinherit boolean 角色是否自动继承其所属角色的权限。 t（true）：表示自动继承。 f（false）：表示不自动继承。 rolcreaterole boolean 角色是否可以创建更多角色。 t（true）：表示可以。 f（false）：表示不可以。 rolcreatedb boolean 角色是否可以创建数据库。 t（true）：表示可以。 f（false）：表示不可以。 rolcatupdate boolean 角色是否可以直接更新系统表。只有usesysid=10的初始系统管理员拥有此权限。其他用户无法获得此权限。 t（true）：表示可以。 f（false）：表示不可以。 rolcanlogin boolean 角色是否可以登录，也就是说，这个角色可以给予会话认证标识符。 t（true）：表示可以。 f（false）：表示不可以。 rolreplication boolean 角色是否具有复制权限。 t（true）：表示有。 f（false）：表示没有。 rolauditadmin boolean 角色是否具有审计管理员权限。 t（true）：表示有。 f（false）：表示没有。 rolsystemadmin boolean 角色是否具有系统管理员权限。 t（true）：表示有。 f（false）：表示没有。 rolconnlimit integer 对于可以登录的角色，限制其最大并发连接数量。 -1 表示没有限制。 rolpassword text 密码（可能是加密的），如果没有密码，则为NULL。 rolvalidbegin timestamp with time zone 账户的有效开始时间，如果没有开始时间，则为NULL。 rolvaliduntil timestamp with time zone 账户的有效结束时间，如果没有结束时间，则为NULL。 rolrespool name 用户所能够使用的resource pool。 roluseft boolean 角色是否可以操作外表。 t（true）：表示可以。 f（false）：表示不可以。 rolparentid oid 用户所在组用户的OID。 roltabspace text 用户数据表的最大空间限额。 rolkind "char" 特殊用户种类。 n：表示普通用户。 p：表示永久用户。 rolnodegroup oid 该字段不支持。 roltempspace text 用户临时表的最大空间限额，单位为KB。 rolspillspace text 用户执行作业时下盘数据的最大空间限额，单位为KB。 rolexcpdata text 用户可以设置的查询规则（当前未使用）。 rolmonitoradmin boolean 角色是否具有监控管理员权限。 t（true）：表示有。 f（false）：表示没有。 roloperatoradmin boolean 角色是否具有运维管理员权限。 t（true）：表示有。 f（false）：表示没有。 rolpolicyadmin boolean 角色是否具有安全策略管理员权限。 t（true）：表示有。 f（false）：表示没有。 父主题： 系统表

语法 RAISE语法 有以下五种语法格式： 图1 raise_format::= 图2 raise_condition::= 图3 raise_sqlstate::= 图4 raise_option::= 图5 raise::= 参数说明： level选项用于指定错误级别，有DEBUG，LOG，INFO，NOTICE，WARNING以及EXCEPTION（默认值）。EXCEPTION抛出一个正常终止当前事务的异常，其他的仅产生不同异常级别的信息。特殊级别的错误信息是否报告到客户端、写到服务器日志由log_min_messages和client_min_messages这两个GUC配置参数控制。 format：格式字符串，指定要报告的错误消息文本。格式字符串后可跟表达式，用于向消息文本中插入。在格式字符串中，%由format后面跟着的参数的值替换，%%用于打印出%。例如： --v_job_id 将替换字符串中的 %： RAISE NOTICE 'Calling cs_create_job(%)',v_job_id; option = expression：向错误报告中添加另外的信息。关键字option可以是MESSAGE、DETAIL、HINT以及ERRCODE，并且每一个expression可以是任意的字符串。 MESSAGE，指定错误消息文本，这个选项不能用于在USING前包含一个格式字符串的RAISE语句中。 DETAIL，说明错误的详细信息。 HINT，用于打印出提示信息。 ERRCODE，向报告中指定错误码（SQLSTATE）。可以使用条件名称或者直接用五位字符的SQLSTATE错误码。 condition_name：错误码对应的条件名。 sqlstate：错误码。 如果在RAISE EXCEPTION命令中既没有指定条件名也没有指定SQLSTATE，默认用RAISE EXCEPTION (P0001)。如果没有指定消息文本，默认用条件名或者SQLSTATE作为消息文本。 当由SQLSTATE指定了错误码，则不局限于已定义的错误码，可以选择任意包含五个数字或者大写的ASCII字母的错误码，而不是00000。建议避免使用以三个0结尾的错误码，因为这种错误码是类别码，会被整个种类捕获。 兼容O模式下，SQLCODE等于SQLSTATE。 图5所示的语法不接任何参数。这种形式仅用于一个BEGIN块中的EXCEPTION语句，它使得错误重新被处理。

java.sql.Statement java.sql.Statement是SQL语句接口。 表1 对java.sql.Statement的支持情况 方法名 返回值类型 支持JDBC 4 addBatch(String sql) void Yes clearBatch() void Yes clearWarnings() void Yes close() void Yes closeOnCompletion() void Yes execute(String sql) Boolean Yes execute(String sql, int autoGeneratedKeys) Boolean Yes execute(String sql, int[] columnIndexes) Boolean Yes execute(String sql, String[] columnNames) Boolean Yes executeBatch() Boolean Yes executeQuery(String sql) ResultSet Yes executeUpdate(String sql) int Yes executeUpdate(String sql, int autoGeneratedKeys) int Yes executeUpdate(String sql, int[] columnIndexes) int Yes executeUpdate(String sql, String[] columnNames) int Yes getConnection() Connection Yes getFetchDirection() int Yes getFetchSize() int Yes getGeneratedKeys() ResultSet Yes getMaxFieldSize() int Yes getMaxRows() int Yes getMoreResults() Boolean Yes getMoreResults(int current) Boolean Yes getResultSet() ResultSet Yes getResultSetConcurrency() int Yes getResultSetHoldability() int Yes getResultSetType() int Yes getQueryTimeout() int Yes getUpdateCount() int Yes getWarnings() SQLWarning Yes isClosed() Boolean Yes isCloseOnCompletion() Boolean Yes isPoolable() Boolean Yes setCursorName(String name) void Yes setEscapeProcessing(boolean enable) void Yes setFetchDirection(int direction) void Yes setMaxFieldSize(int max) void Yes setMaxRows(int max) void Yes setPoolable(boolean poolable) void Yes setQueryTimeout(int seconds) void Yes setFetchSize(int rows) void Yes cancel() void Yes executeLargeUpdate(String sql) long No getLargeUpdateCount() long No executeLargeBatch() long No executeLargeUpdate(String sql, int autoGeneratedKeys) long No executeLargeUpdate(String sql, int[] columnIndexes) long No executeLargeUpdate(String sql, String[] columnNames) long No 通过setFetchSize可以减少结果集在客户端的内存占用情况。它的原理是通过将结果集打包成游标，然后分段处理，所以会加大数据库与客户端的通信量，会有性能损耗。 由于数据库游标是事务内有效，所以，在设置setFetchSize的同时，需要将连接设置为非自动提交模式，setAutoCommit(false)。同时在业务数据需要持久化到数据库中时，在连接上执行提交操作。 LargeUpdate相关方法必须在JDBC4.2及以上版本使用。 父主题： JDBC接口参考

ADM_DATA_FILES ADM_DATA_FILES视图显示关于数据库文件的描述。默认只有系统管理员权限才可以访问此视图，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_DATA_FILES字段 名称 类型 描述 tablespace_name name 文件所属的表空间的名称。 bytes double precision 文件的字节长度。 父主题： 系统视图

MY_COLL_TYPES MY_COLL_TYPES视图显示当前用户创建的集合类型信息。默认所有用户都可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_COLL_TYPES字段 名称 类型 描述 owner character varying(128) 集合的所有者。 type_name character varying(128) 集合的名称。 coll_type character varying(128) 集合的描述。 upper_bound numeric 暂不支持，值为NULL。 elem_type_mod character varying(7) 元素的类型修饰。 elem_type_owner character varying(128) 集合基于的元素类型的所有者。该值主要用于用户定义的类型。 elem_type_name character varying(128) 集合所依据的数据类型或用户定义类型的名称。 length numeric 暂不支持，值为NULL。 precision numeric 暂不支持，值为NULL。 scale numeric 暂不支持，值为NULL。 character_set_name character varying(44) 暂不支持，值为NULL。 elem_storage character varying(7) 暂不支持，值为NULL。 nulls_stored character varying(3) 暂不支持，值为NULL。 char_used character varying(1) 暂不支持，值为NULL。 父主题： 系统视图

GS_GLOBAL_ARCHIVE_STATUS GS_GLOBAL_ARCHIVE_STATUS视图描述DN和所有分片的归档进度，获取分片名称（node_name）、归档位置（restart_lsn），实际进行归档的主/备机名称（archive_node）和当前日志位置（current_xlog_location）。查询此视图需要数据库开启归档功能，并从主DN节点进行查询。 表1 GS_GLOBAL_ARCHIVE_STATUS字段 名称 类型 描述 node_name text 分片名称。 restart_lsn text 归档位置。 archive_node text 实际进行归档的主/备机名称。 current_xlog_location text 当前日志位置。 父主题： 系统视图