华为云用户手册

enable_stream_replication 参数说明：控制主备是否进行数据和日志同步。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 此参数属于性能测试参数，用于测试带有DN备机和不带DN备机的性能参数。关闭参数后，不能进行切换、故障等异常场景测试。 此参数属于受控参数，不建议正常业务场景下关闭此参数。 取值范围：布尔型 on表示打开主备同步。 off表示关闭主备同步。 默认值：on

hadr_recovery_time_target 参数说明：在流式容灾模式下设置hadr_recovery_time_target能够让备数据库实例完成日志写入和回放。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0~3600 （秒） 0是指不开启日志流控，1~3600是指备机能够在hadr_recovery_time_target时间内完成日志的写入和回放，可以保证主数据库实例与备数据库实例切换时能够在hadr_recovery_time_target秒完成日志写入和回放，保证备数据库实例能够快速升主。hadr_recovery_time_target设置时间过小会影响主机的性能，设置过大会失去流控效果。 默认值：60（金融版（数据计算型））

enable_data_replicate 参数说明：当数据库在数据导入行存表时，主机与备机的数据同步方式可以进行选择。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示导入数据行存表时主备数据采用数据页的方式进行同步。当replication_type参数为1时，不允许设置为on，如果此时用guc工具设置成on，会强制改为off。 off表示导入数据行存表时主备数据采用日志（xLog）方式进行同步。 默认值：off

catchup2normal_wait_time 参数说明：单同步备机情况下，控制备机数据追赶（catchup）阻塞主机的最长时间。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，范围-1~10000，单位为毫秒。 -1表示主机阻塞直到备机数据追赶完成。 0表示备机数据追赶时始终不阻塞主机。 其余值表示备机数据追赶时阻塞主机的最长时间。例如，取值5000，表示当备机数据追赶完成时间还剩5s时，阻塞主机等待其完成。 默认值：-1

其它函数 plan_seed() 描述：获取前一次查询语句的seed值（内部使用）。 返回值类型：int pg_stat_get_env() 描述：获取当前节点的环境变量信息，仅sysadmin和monitor admin可以访问。 返回值类型：record 示例： openGauss=# select pg_stat_get_env(); pg_stat_get_env --------------------------------------------------------------------------------------------------------------------------------------- (sgnode,"localhost,XXX.XXX.XXX.XXX",28589,26000,/home/omm,/home/omm/data/single_node,pg_log) (1 row) pg_catalog.plancache_clean() 描述：清理节点上无人使用的全局计划缓存。 返回值类型：bool pg_catalog.plancache_status() 描述：显示节点上全局计划缓存的信息，函数返回信息和GLOBAL_PLANCACHE_STATUS一致。 返回值类型：record textlen(text) 描述：提供查询text的逻辑长度的方法。 返回值类型：int threadpool_status() 描述：显示线程池中工作线程及会话的状态信息。 返回值类型：record get_local_active_session() 描述：提供当前节点保存在内存中的历史活跃session状态的采样记录。 返回值类型：record pg_stat_get_thread() 描述：提供当前节点下所有线程的状态信息，sysadmin和monitor admin用户可以查看所有线程信息，普通用户查看本用户的线程信息。 返回值类型：record pg_stat_get_sql_count() 描述：提供当前节点中用户执行的SELECT/UPDATE/INSERT/DELETE/MERGE INTO语句的计数结果，sysadmin和monitor admin用户可以查看所有用户的信息，普通用户查看本用户的统计信息。 返回值类型：record pg_stat_get_data_senders() 描述：提供当前活跃的数据复制发送线程的详细信息。 返回值类型：record get_wait_event_info() 描述：提供wait event事件的具体信息。 返回值类型：record generate_wdr_report(begin_snap_id bigint, end_snap_id bigint, report_type cstring, report_scope cstring, node_name cstring) 描述：基于两个snapshot生成系统诊断报告。需要在系统库下执行，默认初始化用户或monadmin用户可以访问。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：record 表1 generate_wdr_report 参数说明 参数 说明 取值范围 begin_snap_id 生成某段时间内性能诊断报告的开始snapshotid。 - end_snap_id 结束snapshot的id，默认end_snap_id大于begin_snap_id。 - report_type 指定生成report的类型。 summary detail all，即同时包含summary 和 detail。 report_scope 指定生成report的范围。 cluster：数据库级别的信息 node：节点级别的信息 node_name 在report_scope指定为node时，需要把该参数指定为对应节点的名称。（节点名称可以执行select * from pg_node_env;查询）。 在report_scope为cluster时，该值可以省略或者指定为空或NULL。 cluster：省略/空/NULL node： GaussDB 中的节点名称 create_wdr_snapshot() 描述：手工生成系统诊断快照，该函数需要sysadmin权限。 返回值类型：text kill_snapshot() 描述：kill后台的WDR snapshot线程，调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 返回值类型：void capture_view_to_json(text,integer) 描述：将视图的结果存入GUC: perf_directory所指定的目录，如果is_crossdb为1，则表示对于所有的database都会访问一次view；如果is_crossdb为0，则表示仅对当前database进行一次视图访问。该函数只有sysadmin和monitor admin用户可以执行。 返回值类型：int reset_unique_sql 描述：用来清理数据库节点内存中的Unique SQL（需要sysadmin权限）。 返回值类型：bool 表2 reset_unique_sql参数说明 参数 类型 描述 scope text 清理范围类型： 'GLOBAL'：清理所有的节点，如果是'GLOBAL'，则只可以为主节点执行此函数。 'LOCAL'：清理本节点。 clean_type text 'BY_USERID'：按用户ID来进行清理Unique SQL。 'BY_CNID'：按主节点的ID来进行清理Unique SQL。 'ALL'：全部清理。 clean_value int8 具体清理type对应的清理值。如果第二个参数为ALL，则第三个参数不起作用，可以取任意值。 wdr_xdb_query(db_name_str text, query text) 描述：提供本地跨数据库执行query的能力。例如: 在连接到testdb库时, 访问test库下的表。 select col1 from wdr_xdb_query('dbname=test','select col1 from t1') as dd(col1 int); 返回值类型：record pg_wlm_jump_queue(pid int) 描述：调整任务到数据库主节点队列的最前端。 返回值类型：boolean true：成功。 false：失败。 gs_wlm_switch_cgroup(pid int, cgroup text) 描述：调整作业的优先级到新控制组。 返回值类型：boolean true：成功。 false：失败。 pv_session_memctx_detail(threadid tid, MemoryContextName text) 描述：将线程tid的MemoryContextName内存上下文信息记录到“$GAUSS LOG /pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。其中threadid可通过视图GS_SESSION_MEMORY_DETAIL中的sessid后获得。在正式发布的版本中仅接受MemoryContextName为空串（两个单引号表示输入为空串，即''）的输入，此时会记录所有的内存上下文信息，否则不会有任何操作。对供内部开发人员和测试人员调试用的DEBUG版本，可以指定需要统计的MemoryContextName，此时会将该Context所有的内存使用情况记录到指定文件。该函数需要管理员权限的用户才能执行。 返回值类型：boolean true：成功。 false：失败。 pg_shared_memctx_detail(MemoryContextName text) 描述：将MemoryContextName内存上下文信息记录到“$GAUSSLOG/pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。该函数功能仅在DEBUG版本中供内部开发人员和测试人员调试使用，在正式发布版本中调用该函数不会有任何操作。该函数需要管理员权限的用户才能执行。 返回值类型：boolean true：成功。 false：失败。 local_bgwriter_stat() 描述：显示本实例的bgwriter线程刷页信息，候选buffer链中页面个数，buffer淘汰信息。 返回值类型：record local_candidate_stat() 描述：显示本实例的候选buffer链中页面个数，buffer淘汰信息，包含normal buffer pool和segment buffer pool。 返回值类型：record local_ckpt_stat() 描述：显示本实例的检查点信息和各类日志刷页情况。 返回值类型：record local_double_write_stat() 描述：显示本实例的双写文件的情况。 返回值类型：record 表3 local_double_write_stat参数说明 参数 类型 描述 node_name text 实例名称。 curr_dwn int8 当前双写文件的序列号。 curr_start_page int8 当前双写文件恢复起始页面。 file_trunc_num int8 当前双写文件复用的次数。 file_reset_num int8 当前双写文件写满后发生重置的次数。 total_writes int8 当前双写文件总的I/O次数。 low_threshold_writes int8 低效率写双写文件的I/O次数（一次I/O刷页数量少于16页面）。 high_threshold_writes int8 高效率写双写文件的I/O次数（一次I/O刷页数量多于一批，421个页面）。 total_pages int8 当前刷页到双写文件区的总的页面个数。 low_threshold_pages int8 低效率刷页的页面个数。 high_threshold_pages int8 高效率刷页的页面个数。 file_id int8 当前双写文件的id号。 local_single_flush_dw_stat() 描述：显示本实例的单页面淘汰双写文件的情况。 返回值类型：record local_pagewriter_stat() 描述：显示本实例的刷页信息和检查点信息。 返回值类型：record local_redo_stat() 描述：显示本实例的备机的当前回放状态。 返回值类型：record 备注：返回的回放状态主要包括当前回放位置，回放最小恢复点位置等信息。 local_recovery_status() 描述：显示本实例的主机和备机的日志流控信息。 返回值类型：record gs_wlm_node_recover(boolean isForce) 描述：获取当前内存中记录的TopSQL查询语句级别相关统计信息，当传入的参数不为0时，会将这部分信息从内存中清理掉。 返回值类型：record gs_cgroup_map_ng_conf(group name) 描述：读取指定逻辑数据库的cgroup配置文件。 返回值类型：record gs_wlm_switch_cgroup(sess_id int8, cgroup name) 描述：切换指定会话的控制组。 返回值类型：record comm_client_info() 描述：用于查询单个节点活跃的客户端连接信息。 返回值类型：setof record pg_get_flush_lsn() 描述：返回当前节点flush的xLog位置。 返回值类型：text pg_get_sync_flush_lsn() 描述：返回当前节点多数派flush的xLog位置。 返回值类型：text dbe_perf.get_global_full_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone) 描述：获取数据库级的全量SQL(Full SQL)信息。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：record 表4 dbe_perf.get_global_full_sql_by_timestamp参数说明 参数 类型 描述 start_timestamp timestamp with time zone SQL启动时间范围的开始时间点。 end_timestamp timestamp with time zone SQL启动时间范围的结束时间点。 dbe_perf.get_global_slow_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone) 描述：获取数据库级的慢SQL(Slow SQL)信息。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：record 表5 dbe_perf.get_global_slow_sql_by_timestamp参数说明 参数 类型 描述 start_timestamp timestamp with time zone SQL启动时间范围的开始时间点。 end_timestamp timestamp with time zone SQL启动时间范围的结束时间点。 statement_detail_decode(detail text, format text, pretty boolean) 描述：解析全量/慢SQL语句中的details字段的信息。只可在系统库中查询到结果，用户库中无法查询。 返回值类型：text 表6 statement_detail_decode参数说明 参数 类型 描述 detail text SQL语句产生的事件的集合（不可读）。 format text 解析输出格式，取值为 plaintext。 pretty boolean 当format为plaintext时，是否以优雅的格式展示： true表示通过“\n”分隔事件。 false表示通过“，”分隔事件。 pg_control_system() 描述：返回系统控制文件状态。 返回类型：SETOF record pg_control_checkpoint() 描述：返回系统检查点状态。 返回类型：SETOF record get_prepared_pending_xid 描述：当恢复完成时，返回nextxid。 参数：nan 返回值类型：text pg_clean_region_info 描述：清理regionmap。 参数：nan 返回值类型：character varying pg_get_delta_info 描述：从单个dn获取delta info。 参数：rel text, schema_name text 返回值类型：part_name text, live_tuple bigint, data_size bigint, blocknum bigint pg_get_replication_slot_name 描述：获取slot name。 参数：nan 返回值类型：text pg_get_running_xacts 描述：获取运行中的xact。 参数：nan 返回值类型：handle integer, gxid xid, state tinyint, node text, xmin xid, vacuum boolean, timeline bigint, prepare_xid xid, pid bigint, next_xid xid pg_get_variable_info 描述：获取共享内存变量cache。 参数：nan 返回值类型：node_name text, nextOid oid, nextXid xid, oldestXid xid, xidVacLimit xid, oldestXidDB oid, lastExtend CS NLogpage xid, startExtendCSNLogpage xid, nextCommitSeqNo xid, latestCompletedXid xid, startupMaxXid xid pg_get_xidlimit 描述：从共享内存获取事物id信息。 参数：nan 返回值类型：nextXid xid, oldestXid xid, xidVacLimit xid, xidWarnLimit xid, xidStopLimit xid, xidWrapLimit xid, oldestXidDB oid pg_stat_file_recursive 描述：列出路径下所有文件。 参数：location text 返回值类型：path text, filename text, size bigint, isdir boolean pg_stat_get_activity_for_temptable 描述：返回临时表相关的后台进程的记录。 参数：nan 返回值类型：datid oid, timelineid integer, tempid integer, sessionid bigint pg_stat_get_activity_ng 描述：返回nodegroup相关的后台进程的记录。 参数：pid bigint 返回值类型：datid oid, pid bigint, sessionid bigint, node_group text pg_stat_get_cgroup_info 描述：返回cgroup信息。 参数：nan 返回值类型：cgroup_name text, percent integer, usage_percent integer, shares bigint, usage bigint, cpuset text, relpath text, valid text, node_group text pg_stat_get_realtime_info_internal 描述：返回实时信息，当前该接口已不可用，返回FailedToGetSessionInfo。 参数：oid, oid, bigint, cstring, oid 返回值类型：text pg_test_err_contain_err 描述：测试错误类型和返回信息。 参数：integer 返回值类型：void get_global_user_transaction() 描述：返回所有节点上各用户的事务相关信息。 返回值类型：node_name name, usename name, commit_counter bigint, rollback_counter bigint, resp_min bigint, resp_max bigint, resp_avg bigint, resp_total bigint, bg_commit_counter bigint, bg_rollback_counter bigint, bg_resp_min bigint, bg_resp_max bigint, bg_resp_avg bigint, bg_resp_total bigint pg_collation_for 描述：返回入参字符串对应的排序规则。 参数：any（如果是常量必须进行显式类型转换） 返回值类型：text pgxc_unlock_for_sp_database(name Name) 描述：释放指定数据库锁。 参数：数据库名 返回值类型：布尔 pgxc_lock_for_sp_database(name Name) 描述：对指定的数据库加锁。 参数：数据库名 返回值类型：布尔 copy_error_log_create() 描述：创建COPY FROM容错机制所需要的错误表（public.pgxc_copy_error_log）。 返回值类型：Boolean 此函数会尝试创建public.pgxc_copy_error_log表，表的详细信息请参见表7。 在relname列上创建B-tree索引，并REVOKE ALL on public.pgxc_copy_error_log FROM public对错误表进行权限控制（与COPY语句权限一致）。 由于尝试创建的public.pgxc_copy_error_log定义是一张行存表，因此数据库实例上必须支持行存表的创建才能够正常运行此函数，并使用后续的COPY容错功能。需要特别注意的是，enable_hadoop_env这个GUC参数开启后会禁止在数据库实例内创建行存表（GaussDB默认为off）。 此函数自身权限为Sysadmin及以上（与错误表、COPY权限一致）。 若创建前public.pgxc_copy_error_log表已存在或者copy_error_log_relname_idx索引已存在，则此函数会报错回滚。 表7 错误表public.pgxc_copy_error_log信息 列名称 类型 描述 relname character varying 表名称。以模式名.表名形式显示。 begintime timestamp with time zone 出现数据格式错误的时间。 filename character varying 出现数据格式错误的数据源文件名。 lineno bigint 在数据源文件中，出现数据格式错误的行号。 rawrecord text 在数据源文件中，出现数据格式错误的原始记录。 detail text 详细错误信息。 dynamic_func_control(scope text, function_name text, action text, "{params}" text[]) 描述：动态开启内置的功能，当前仅支持动态开启全量SQL。 返回值类型：record 表8 dynamic_func_control参数说明 参数 类型 描述 scope text 动态开启功能的范围，当前仅支持'LOCAL'。 function_name text 功能的名称，当前仅支持'STMT'。 action text 当function_name为'STMT'时，action仅支持TRACK/UNTRACK/LIST/CLEAN： TRACK - 开始记录归一化SQL的全量SQL信息。 UNTRACK - 取消记录归一化SQL的全量SQL信息。 LIST - 列取当前TRACK的归一化SQL的信息。 CLEAN - 清理记录当前归一化SQL的信息。 params text[] 当function_name为'STMT'时，对应不同的action时，对应的params设置如下： TRACK - '{"归一化SQLID", "L0/L1/L2"}' UNTRACK - '{"归一化SQLID"}' LIST - '{}' CLEAN - '{}' gs_parse_page_bypath(path text, blocknum bigint, relation_type text, read_memory boolean) 描述：用于解析指定表页面，并返回存放解析内容的路径。 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 表9 gs_parse_page_bypath参数说明 参数 类型 描述 path text 对于普通表或段页式表，相对路径为：tablespace name/database oid/表的relfilenode(物理文件名)。例如：base/16603/16394。 表文件的相对路径可以通过pg_relation_filepath(table_name text)查找。分区表的路径可以查看pg_partition系统表和调用pg_partition_filepath(partition_oid)。 合法的path格式列举： global/relNode base/dbNode/relNode pg_tblspc/spcNode/version_dir/dbNode/relNode blocknum bigint -1：所有block的信息（强制从磁盘解析）。 0~MaxBlockNumber：对应block的信息。 relation_type text heap(astore 表) uheap(ustore 表) btree(BTree 索引) ubtree(UBTree 索引) segment(段页式) indexurq(ustore 回收队列) read_memory boolean false，从磁盘文件解析。 true，首先尝试从共享缓冲区中解析该页面；如果共享缓冲区中不存在，则从磁盘文件解析。 gs_xlogdump_lsn(start_lsn text, end_lsn text) 描述：用于解析指定lsn范围之内的xLog日志，并返回存放解析内容的路径。可以通过pg_current_xlog_location()获取当前xLog位置。 返回值类型：text 参数：LSN起始位置，LSN结束位置 备注：必须是系统管理员或运维管理员才能执行此函数。 gs_xlogdump_xid(c_xid xid) 描述：用于解析指定xid的xLog日志，并返回存放解析内容的路径。可以通过txid_current()获取当前事务ID。 参数：事务ID 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 gs_xlogdump_tablepath(path text, blocknum bigint, relation_type text) 描述：用于解析指定表页面对应的日志，并返回存放解析内容的路径。 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 表10 gs_xlogdump_tablepath参数说明 参数 类型 描述 path text 对于普通表或段页式表，相对路径为：tablespace name/database oid/表的relfilenode(物理文件名)。例如：base/16603/16394。 表文件的相对路径可以通过pg_relation_filepath(table_name text)查找。分区表的路径可以查看pg_partition系统表和调用pg_partition_filepath(partition_oid)。 合法的path格式列举： global/relNode base/dbNode/relNode pg_tblspc/spcNode/version_dir/dbNode/relNode blocknum bigint -1：所有block的信息（强制从磁盘解析）。 0~MaxBlockNumber：对应block的信息。 relation_type text heap(astore 表) uheap(ustore 表) btree(BTree 索引) ubtree(UBTree 索引) segment(段页式) indexurq(ustore 回收队列) gs_xlogdump_parsepage_tablepath(path text, blocknum bigint, relation_type text, read_memory boolean) 描述：用于解析指定表页面和表页面对应的日志，并返回存放解析内容的路径。可以看做一次执行gs_parse_page_bypath和gs_xlogdump_tablepath。该函数执行的前置条件是表文件存在。如果想查看已删除的表的相关日志，请直接调用gs_xlogdump_tablepath。 返回值类型：text 备注：必须是系统管理员或运维管理员才能执行此函数。 表11 gs_xlogdump_parsepage_tablepath参数说明 参数 类型 描述 path text 对于普通表或段页式表，相对路径为：tablespace name/database oid/表的relfilenode(物理文件名)；例如：base/16603/16394 表文件的相对路径可以通过pg_relation_filepath(table_name text)查找。分区表的路径可以查看pg_partition系统表和调用pg_partition_filepath(partition_oid)。 合法的path格式列举： global/relNode base/dbNode/relNode pg_tblspc/spcNode/version_dir/dbNode/relNode blocknum bigint -1：所有block的信息（强制从磁盘解析）。 0~MaxBlockNumber：对应block的信息。 relation_type text heap(astore 表) uheap(ustore 表) btree(BTree 索引) ubtree(UBTree 索引) segment(段页式) indexurq(ustore 回收队列) read_memory boolean false，从磁盘文件解析 true，首先尝试从共享缓冲区中解析该页面；如果共享缓冲区中不存在，则从磁盘文件解析 gs_index_verify(Oid oid, uint32 blkno) 描述：用于校验UBtree索引页面或者索引树上key的顺序是否正确。 返回值类型：record 表12 gs_index_verify参数说明 参数 类型 描述 oid Oid 索引文件relfilenode,可以通过select relfilenode from pg_class where relname='name'查询，其中name表示对应的索引文件名字。 blkno uint32 0 ，表示检验整个索引树上所有页面。 大于0，表示校验页面编码等于blkno的索引页面。 gs_index_recycle_queue(Oid oid, int type, uint32 blkno) 描述：用于解析UBtree索引回收队列信息。 返回值类型：record 表13 gs_index_recycle_queue参数说明 参数 类型 描述 oid Oid 索引文件relfilenode,可以通过select relfilenode from pg_class where relname='name'查询，其中name表示对应的索引文件名字。 type int 0，表示解析整个待回收队列。 1，表示解析整个空页队列。 2，表示解析单个页面。 blkno uint32 回收队列页面编号，该参数只有在type=2的时候有效，blkno有效取值范围为1~4294967294。 gs_stat_wal_entrytable(int64 idx) 描述：用于输出xLog中预写日志插入状态表的内容。 返回值类型：record 表14 gs_stat_wal_entrytable参数说明 参数类型 参数名 类型 描述 输入参数 idx int64 -1：查询数组所有元素。 0-最大值：具体某个数组元素内容。 输出参数 idx uint64 记录对应数组中的下标。 输出参数 endlsn uint64 记录的LSN标签。 输出参数 lrc int32 记录对应的LRC。 输出参数 status uint32 标识当前entry对应的xLog是否已经完全拷贝到wal buffer中： 0：非COPIED 1：COPIED gs_walwriter_flush_position() 描述：输出预写日志的刷新位置。 返回值类型：record 表15 gs_walwriter_flush_position参数说明 参数类型 参数名 类型 描述 输出参数 last_flush_status_entry int32 xLog flush上一个刷盘的tblEntry下标索引。 输出参数 last_scanned_lrc int32 xLog flush上一次扫描到的最后一个tblEntry记录的LRC。 输出参数 curr_lrc int32 WALInsertStatusEntry状态表中LRC最新的使用情况，该LRC表示下一个xLog记录写入时在WALInsertStatusEntry对应的LRC值。 输出参数 curr_byte_pos uint64 xLog记录写入WAL文件，最新分配的位置，下一个xLog记录插入点。 输出参数 prev_byte_size uint32 上一个xLog记录的长度。 输出参数 flush_result uint64 当前全局xLog刷盘的位置。 输出参数 send_result uint64 当前主机上xLog发送位置。 输出参数 shm_rqst_write_pos uint64 共享内存中记录的XLogCtl中LogwrtRqst请求的write位置。 输出参数 shm_rqst_flush_pos uint64 共享内存中记录的XLogCtl中LogwrtRqst请求的flush位置。 输出参数 shm_result_write_pos uint64 共享内存中记录的XLogCtl中LogwrtResult的write位置。 输出参数 shm_result_flush_pos uint64 共享内存中记录的XLogCtl中LogwrtResult的flush位置。 输出参数 curr_time text 当前时间。 gs_walwriter_flush_stat(int operation) 描述：用于统计预写日志write与sync的次数频率与数据量，以及xLog文件的信息。 返回值类型：record 表16 gs_walwriter_flush_stat参数说明 参数类型 参数名 类型 描述 输入参数 operation int -1：关闭统计开关(默认状态为关闭)。 0：打开统计开关。 1：查询统计信息。 2：重置统计信息。 输出参数 write_times uint64 xLog调用write接口的次数。 输出参数 sync_times uint64 xLog调用sync接口次数。 输出参数 total_xlog_sync_bytes uint64 Backend线程请求写入xLog总量统计值。 输出参数 total_actual_xlog_sync_bytes uint64 调用sync接口实际刷盘的xLog总量统计值。 输出参数 avg_write_bytes uint32 每次调用XLogWrite接口请求写的xLog量。 输出参数 avg_actual_write_bytes uint32 实际每次调用write接口写的xLog量。 输出参数 avg_sync_bytes uint32 平均每次请求sync的xLog量。 输出参数 avg_actual_sync_bytes uint32 实际每次调用sync刷盘xLog量。 输出参数 total_write_time uint64 调用write操作总时间统计(单位：us)。 输出参数 total_sync_time uint64 调用sync操作总时间统计(单位：us)。 输出参数 avg_write_time uint32 每次调用write接口平均时间(单位：us)。 输出参数 avg_sync_time uint32 每次调用sync接口平均时间(单位：us)。 输出参数 curr_init_xlog_segno uint64 当前最新创建的xLog段文件编号。 输出参数 curr_open_xlog_segno uint64 当前正在写的xLog段文件编号。 输出参数 last_reset_time text 上一次重置统计信息的时间。 输出参数 curr_time text 当前时间。 gs_catalog_attribute_records() 描述：对于指定的系统表oid，返回该系统表对应的各个字段的定义。仅支持oid小于10000的普通系统表（不支持索引、toast表等）。 参数：系统表oid 返回值类型：record gs_comm_proxy_thread_status() 描述：用于在数据库实例配置用户态网络的场景下，代理通信库comm_proxy收发数据包统计。 参数：nan 返回值类型：record 此函数的查询仅在集中式环境开始部署用户态网络，且comm_proxy_attr参数中enable_dfx配置为true的条件下显示具体信息。其他场景报错不支持查询。 pg_ls_tmpdir() 描述：返回默认表空间下临时目录（pgsql_tmp）中每个文件的名称、大小和最后修改时间。 参数：nan 返回值类型：record 备注：必须是系统管理员或者监控管理员才能执行此函数。 参数类型 参数名 类型 描述 输出参数 name text 文件名称 输出参数 size int8 文件大小（单位：byte） 输出参数 modification timestamptz 文件最后修改时间 pg_ls_tmpdir(oid) 描述：返回指定表空间下临时目录（pgsql_tmp）中每个文件的名称、大小和最后修改时间。 参数：oid 返回值类型：record 备注：必须是系统管理员或者监控管理员才能执行此函数。 参数类型 参数名 类型 描述 输入参数 oid oid 表空间id 输出参数 name text 文件名称 输出参数 size int8 文件大小（单位：byte） 输出参数 modification timestamptz 文件最后修改时间 pg_ls_waldir() 描述：返回预写日志(WAL)目录中每个文件的名称、大小和最后修改时间。 参数：nan 返回值类型：record 备注：必须是系统管理员或者监控管理员才能执行此函数。 参数类型 参数名 类型 描述 输出参数 name text 文件名称 输出参数 size int8 文件大小（单位：byte） 输出参数 modification timestamptz 文件最后修改时间 gs_write_term_log(void) 描述：写入一条日志记录DN节点当前的term值。备DN节点返回false，主DN节点写入成功后返回true。 返回值类型：Boolean 父主题： 系统管理函数

PG_STAT_XACT_USER_TABLES PG_STAT_XACT_USER_TABLES视图显示命名空间中用户表的事务状态信息。 表1 PG_STAT_XACT_USER_TABLES字段 名称 类型 描述 relid oid 表的OID。 schemaname name 该表的模式名。 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更新行数（比如没有更新所需的单独索引）。 父主题： 系统视图

PG_STATIO_USER_TABLES PG_STATIO_USER_TABLES视图显示命名空间中所有用户关系表的I/O状态信息。 表1 PG_STATIO_USER_TABLES字段 名称 类型 描述 relid oid 表OID。 schemaname name 该表的模式名。 relname 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表索引命中缓存数（如果存在）。 父主题： 系统视图

PG_SECLABELS PG_SECLABELS视图显示安全标签的信息。 表1 PG_SECLABELS字段 名称 类型 引用 描述 objoid oid 任意OID属性 该安全标签所属的对象的OID。 classoid oid PG_CLASS.oid 该安全标签所属的对象所在系统表的OID。 objsubid integer - 对于一个在表字段上的安全标签，该字段是字段序号（引用表本身的objoid和classoid）。 对于所有其他对象类型，该字段为0。 objtype text - 该标签所属的对象的类型，文本格式。例如： table：表类型。 column：列类型。 objnamespace oid PG_NAMESPACE.oid 该对象的名称空间的OID，如果不适用，取值为NULL。 objname text - 该标签所属的对象的名称，文本格式。 provider text PG_SECLABEL.provider 该标签的提供者。 label text PG_SECLABEL.label 安全标签名称。 父主题： 系统视图

示例 --创建用户alice。 openGauss=# CREATE USER alice PASSWORD '********'; --创建用户bob。 openGauss=# CREATE USER bob PASSWORD '********'; --创建数据表all_data。 openGauss=# CREATE TABLE public.all_data(id int, role varchar(100), data varchar(100)); --向数据表插入数据。 openGauss=# INSERT INTO all_data VALUES(1, 'alice', 'alice data'); openGauss=# INSERT INTO all_data VALUES(2, 'bob', 'bob data'); openGauss=# INSERT INTO all_data VALUES(3, 'peter', 'peter data'); --将表all_data的读取权限赋予alice和bob用户。 openGauss=# GRANT SELECT ON all_data TO alice, bob; --打开行访问控制策略开关。 openGauss=# ALTER TABLE all_data ENABLE ROW LEVEL SECURITY; --创建行访问控制策略，当前用户只能查看用户自身的数据。 openGauss=# CREATE ROW LEVEL SECURITY POLICY all_data_rls ON all_data USING(role = CURRENT_USER); --查看表all_data相关信息。 openGauss=# \d+ all_data Table "public.all_data" Column | Type | Modifiers | Storage | Stats target | Description --------+------------------------+-----------+----------+--------------+------------- id | integer | | plain | | role | character varying(100) | | extended | | data | character varying(100) | | extended | | Row Level Security Policies: POLICY "all_data_rls" USING (((role)::name = "current_user"())) Has OIDs: no Options: orientation=row, enable_rowsecurity=true --当前用户执行SELECT操作。 openGauss=# SELECT * FROM all_data; id | role | data ----+-------+------------ 1 | alice | alice data 2 | bob | bob data 3 | peter | peter data (3 rows) openGauss=# EXPLAIN(COSTS OFF) SELECT * FROM all_data; QUERY PLAN ---------------------- Seq Scan on all_data (1 row) --切换至alice用户执行SELECT操作。 openGauss=# SELECT * FROM all_data; id | role | data ----+-------+------------ 1 | alice | alice data (1 row) openGauss=# EXPLAIN(COSTS OFF) SELECT * FROM all_data; QUERY PLAN ---------------------------------------------------------------- Seq Scan on all_data Filter: ((role)::name = 'alice'::name) Notice: This query is influenced by row level security feature (3 rows) --删除行访问控制策略。 openGauss=# DROP ROW LEVEL SECURITY POLICY all_data_rls ON all_data; --删除数据表all_data。 openGauss=# DROP TABLE public.all_data; --删除用户alice, bob。 openGauss=# DROP USER alice, bob;

注意事项 支持对行存表、行存分区表、unlogged表、hash表定义行访问控制策略。 不支持外表、本地临时表定义行访问控制策略。 不支持对视图定义行访问控制策略。 同一张表上可以创建多个行访问控制策略，一张表最多创建100个行访问控制策略。 系统管理员不受行访问控制影响，可以查看表的全量数据。 通过SQL语句、视图、函数、存储过程查询包含行访问控制策略的表，都会受影响。 不支持对添加了行级访问控制策略的表字段进行修改数据类型操作。

语法格式 CREATE [ ROW LEVEL SECURITY ] POLICY policy_name ON table_name [ AS { PERMISSIVE | RESTRICTIVE } ] [ FOR { ALL | SELECT | UPDATE | DELETE } ] [ TO { role_name | PUBLIC | CURRENT_USER | SESSION_USER } [, ...] ] USING ( using_expression )

功能描述 对表创建行访问控制策略。 当对表创建了行访问控制策略，只有打开该表的行访问控制开关(ALTER TABLE ... ENABLE ROW LEVEL SECURITY)，策略才能生效。否则不生效。 当前行访问控制影响数据表的读取操作(SELECT、UPDATE、DELETE)，暂不影响数据表的写入操作(INSERT、MERGE INTO)。表所有者或系统管理员可以在USING子句中创建表达式，在客户端执行数据表读取操作时，数据库后台在查询重写阶段会将满足条件的表达式拼接并应用到执行计划中。针对数据表的每一条元组，当USING表达式返回TRUE时，元组对当前用户可见，当USING表达式返回FALSE或NULL时，元组对当前用户不可见。 行访问控制策略名称是针对表的，同一个数据表上不能有同名的行访问控制策略；对不同的数据表，可以有同名的行访问控制策略。 行访问控制策略可以应用到指定的操作(SELECT、UPDATE、DELETE、ALL)，ALL表示会影响SELECT、UPDATE、DELETE三种操作；定义行访问控制策略时，若未指定受影响的相关操作，默认为ALL。 行访问控制策略可以应用到指定的用户(角色)，也可应用到全部用户(PUBLIC)；定义行访问控制策略时，若未指定受影响的用户，默认为PUBLIC。

参数说明 policy_name 行访问控制策略名称，同一个数据表上行访问控制策略名称不能相同。 table_name 行访问控制策略的表名。 PERMISSIVE | RESTRICTIVE PERMISSIVE指定行访问控制策略为宽容性策略，宽容性策略的条件用OR表达式拼接。 RESTRICTIVE指定行访问控制策略为限制性策略，限制性策略的条件用AND表达式拼接。拼接方式如下： (using_expression_permissive_1 OR using_expression_permissive_2 ...) AND (using_expression_restrictive_1 AND using_expression_restrictive_2 ...) 缺省值为PERMISSIVE。 command 当前行访问控制影响的SQL操作，可指定操作包括：ALL、SELECT、UPDATE、DELETE。当未指定时，ALL为默认值，涵盖SELECT、UPDATE、DELETE操作。 当command为SELECT时，SELECT类操作受行访问控制的影响，只能查看到满足条件(using_expression返回值为TRUE)的元组数据，受影响的操作包括SELECT，UPDATE ... RETURNING，DELETE ... RETURNING。 当command为UPDATE时，UPDATE类操作受行访问控制的影响，只能更新满足条件(using_expression返回值为TRUE)的元组数据，受影响的操作包括UPDATE, UPDATE ... RETURNING, SELECT ... FOR UPDATE/SHARE。 当command为DELETE时，DELETE类操作受行访问控制的影响，只能删除满足条件(using_expression返回值为TRUE)的元组数据，受影响的操作包括DELETE, DELETE ... RETURNING。 行访问控制策略与适配的SQL语法关系参见下表： 表1 ROW LEVEL SECURITY策略与适配SQL语法关系 Command SELECT/ALL policy UPDATE/ALL policy DELETE/ALL policy SELECT Existing row No No SELECT FOR UPDATE/SHARE Existing row Existing row No UPDATE No Existing row No UPDATE RETURNING Existing row Existing row No DELETE No No Existing row DELETE RETURNING Existing row No Existing row role_name 行访问控制影响的数据库用户。 CURRENT_USER：表示当前执行环境的用户名。 SESSION_USER：表示会话用户名。 当未指定时，PUBLIC为默认值，PUBLIC表示影响所有数据库用户，可以指定多个受影响的数据库用户。 系统管理员不受行访问控制特性影响。

DB_TAB_PARTITIONS DB_TAB_PARTITIONS视图显示当前用户所能访问的分区表的信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 DB_TAB_PARTITIONS字段 名称 类型 描述 table_owner character varying(64) 角色名称。 table_name character varying(64) 关系表名称。 partition_name character varying(64) 分区名称。 high_value text 分区的边界值。 说明： 对于范围分区和间隔分区，显示各分区的上边界值。 对于列表分区，显示各分区的取值列表。 对于哈希分区，显示各分区的编号。 tablespace_name name 分区表的表空间名称。 schema character varying(64) 名称空间的名称。 subpartition_count bigint 二级分区的个数。 high_value_length integer 分区边界值表达式的长度。 父主题： 系统视图

语法格式 显示SQL语句的执行计划，支持多种选项，对选项顺序无要求。 1 EXPLAIN [ ( option [, ...] ) ] statement; 其中选项option子句的语法为： 1 2 3 4 5 6 7 8 9 10 11 12 ANALYZE [ boolean ] | ANALYSE [ boolean ] | VERBOSE [ boolean ] | COSTS [ boolean ] | CPU [ boolean ] | DETAIL [ boolean ] | NODES [ boolean ] | NUM_NODES [ boolean ] | BUFFERS [ boolean ] | TIMING [ boolean ] | PLAN [ boolean ] | FORMAT { TEXT | XML | JSON | YAML } 显示SQL语句的执行计划，且要按顺序给出选项。 1 EXPLAIN { [ ANALYZE | ANALYSE ] [ VERBOSE ] | PERFORMANCE } statement;

参数说明 statement 指定要分析的SQL语句。 ANALYZE boolean | ANALYSE boolean 显示实际运行时间和其他统计数据。当两个参数同时使用时，在option中排在后面的参数生效。 取值范围： TRUE（缺省值）：显示实际运行时间和其他统计数据。 FALSE：不显示。 VERBOSE boolean 显示有关计划的额外信息。 取值范围： TRUE（缺省值）：显示额外信息。 FALSE：不显示。 COSTS boolean 包括每个规划节点的估计总成本，以及估计的行数和每行的宽度。 取值范围： TRUE（缺省值）：显示估计总成本和宽度。 FALSE：不显示。 CPU boolean 打印CPU的使用情况的信息。 取值范围： TRUE（缺省值）：显示CPU的使用情况。 FALSE：不显示。 DETAIL boolean 打印DN上的信息。 取值范围： TRUE（缺省值）：打印DN的信息。 FALSE：不打印。 NODES boolean 打印query执行的节点信息。 取值范围： TRUE（缺省值）：打印执行的节点的信息。 FALSE：不打印。 NUM_NODES boolean 打印执行中的节点的个数信息。 取值范围： TRUE（缺省值）：打印DN个数的信息。 FALSE：不打印。 BUFFERS boolean 包括缓冲区的使用情况的信息。 取值范围： TRUE：显示缓冲区的使用情况。 FALSE（缺省值）：不显示。 TIMING boolean 包括实际的启动时间和花费在输出节点上的时间信息。 取值范围： TRUE（缺省值）：显示启动时间和花费在输出节点上的时间信息。 FALSE：不显示。 PLAN boolean 是否将执行计划存储在PLAN_TABLE中。当该选项开启时，会将执行计划存储在PLAN_TABLE中，不打印到当前屏幕，因此该选项为on时，不能与其他选项同时使用。 取值范围： TRUE（缺省值）：将执行计划存储在PLAN_TABLE中，不打印到当前屏幕。执行成功返回EXPLAIN SUC CES S。 FALSE：不存储执行计划，将执行计划打印到当前屏幕。 FORMAT 指定输出格式。 取值范围：TEXT，XML，JSON和YAML。 默认值：TEXT。 PERFORMANCE 使用此选项时，即打印执行中的所有相关信息。

功能描述 显示SQL语句的执行计划。 执行计划将显示SQL语句所引用的表会采用什么样的扫描方式，如：简单的顺序扫描、索引扫描等。如果引用了多个表，执行计划还会显示用到的JOIN算法。 执行计划的最关键的部分是语句的预计执行开销，是指计划生成器估算执行该语句将花费多长的时间。 若指定了ANALYZE选项，则该语句会被执行，然后根据实际的运行结果显示统计数据，包括每个计划节点内时间总开销（毫秒为单位）和实际返回的总行数。这对于判断计划生成器的估计是否接近现实非常有用。

GS_SLOW_QUERY_INFO（废弃） GS_SLOW_QUERY_INFO视图显示当前节点上已经转储的慢查询信息。此数据是从内核中转储到系统表中的数据。当设置GUC参数enable_resource_record为on时，系统会定时（周期为3分钟）将内核中query信息导入GS_WLM_SESSION_QUERY_INFO_ALL系统表，开启此功能会占用系统存储空间并对性能有一定影响。用户通过查询GS_SLOW_QUERY_INFO视图，可以查看已经转储的慢查询信息，本版本中已废弃。 表1 GS_SLOW_QUERY_INFO字段 名称 类型 描述 dbname text 数据库名称。 schemaname text schema名称。 nodename text 节点名称。 username text 用户名。 queryid bigint 归一化ID。 query text 用户语句。 start_time timestamp with time zone 开始执行时间。 finish_time timestamp with time zone 结束执行时间。 duration bigint 执行持续时间（毫秒）。 query_plan text 计划信息。 n_returned_rows bigint Select返回的结果集行数。 n_tuples_fetched bigint 随机扫描行数。 n_tuples_returned bigint 顺序扫描行数。 n_tuples_inserted bigint 插入行数。 n_tuples_updated bigint 更新行数。 n_tuples_deleted bigint 删除行数。 n_blocks_fetched bigint 缓存加载次数。 n_blocks_hit bigint 缓存命中数。 db_time bigint 有效的数据库时间花费，多线程将累加（单位：微秒）。 cpu_time bigint CPU消耗时间（单位：微秒）。 execution_time bigint 执行器内执行时间（单位：微秒）。 parse_time bigint SQL解析时间（单位：微秒）。 plan_time bigint SQL生成计划时间（单位：微秒）。 rewrite_time bigint SQL重写时间（单位：微秒）。 pl_execution_time bigint plpgsql上的执行时间（单位：微秒）。 pl_compilation_time bigint plpgsql上的编译时间（单位：微秒）。 net_send_time bigint 网络上的时间花费（单位：微秒）。 data_io_time bigint I/O上的时间花费(单位：微秒)。 父主题： Query

ADM_SOURCE ADM_SOURCE视图显示数据库中所有存储过程或函数的信息，且提供存储过程或函数定义的字段。默认只有系统管理员权限才可以访问此系统视图，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_SOURCE字段 名称 类型 描述 owner character varying(64) 存储过程或函数的所有者。 name character varying(64) 存储过程或函数名称。 text text 存储过程或函数的定义。 父主题： 系统视图

数字操作函数 abs(x) 描述：绝对值。 返回值类型：和输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT abs(-17.4); abs ------ 17.4 (1 row) acos(x) 描述：反余弦。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT acos(-1); acos ------------------ 3.14159265358979 (1 row) asin(x) 描述：反正弦。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT asin(0.5); asin ------------------ .523598775598299 (1 row) atan(x) 描述：反正切。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT atan(1); atan ------------------ .785398163397448 (1 row) atan2(y, x) 描述：y/x的反正切。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT atan2(2, 1); atan2 ------------------ 1.10714871779409 (1 row) bitand(integer, integer) 描述：计算两个数字与运算(&)的结果。 返回值类型：bigint类型数字。 示例： 1 2 3 4 5 openGauss=# SELECT bitand(127, 63); bitand -------- 63 (1 row) cbrt(dp) 描述：立方根。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT cbrt(27.0); cbrt ------ 3 (1 row) ceil(x) 描述：不小于参数的最小的整数。 返回值类型：整数。 示例： 1 2 3 4 5 openGauss=# SELECT ceil(-42.8); ceil ------ -42 (1 row) ceiling(dp or numeric) 描述：不小于参数的最小整数（ceil的别名）。 返回值类型：与输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT ceiling(-95.3); ceiling --------- -95 (1 row) cos(x) 描述：余弦。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT cos(-3.1415927); cos ------------------- -.999999999999999 (1 row) cot(x) 描述：余切。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT cot(1); cot ------------------ .642092615934331 (1 row) degrees(dp) 描述：把弧度转为角度。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT degrees(0.5); degrees ------------------ 28.6478897565412 (1 row) div(y numeric, x numeric) 描述：y除以x的商的整数部分。 返回值类型：numeric 示例： 1 2 3 4 5 openGauss=# SELECT div(9,4); div ----- 2 (1 row) exp(x) 描述：自然指数。 返回值类型：与输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT exp(1.0); exp -------------------- 2.7182818284590452 (1 row) floor(x) 描述：不大于参数的最大整数。 返回值类型：与输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT floor(-42.8); floor ------- -43 (1 row) int1(in) 描述：将传入的text参数转换为int1类型值并返回。 返回值类型：int1 示例： 1 2 3 4 5 6 7 8 9 10 openGauss=# select int1('123'); int1 ------ 123 (1 row) openGauss=# select int1('a'); int1 ------ 0 (1 row) int2(in) 描述：将传入参数转换为int2类型值并返回。支持的入参类型包括：bigint，float4，float8，int16，integer，numeric，real，text。 返回值类型：int2 示例： 1 2 3 4 5 6 7 8 9 10 openGauss=# select int2('1234'); int2 ------ 1234 (1 row) openGauss=# select int2(25.3); int2 ------ 25 (1 row) int4(in) 描述：将传入参数转换为int4类型值并返回。支持的入参类型包括：bit，boolean，char，double precision，int16，numeric，real，smallint，text。 返回值类型：int4 示例： 1 2 3 4 5 6 7 8 9 10 openGauss=# select int4('789'); int4 ------ 789 (1 row) openGauss=# select int4(99.9); int4 ------ 99 (1 row) int8(in) 描述：将传入参数转换为int8类型值并返回。支持的入参类型包括：bit，double precision，int16，integer，numeric，oid，real，smallint，text。 返回值类型：int8 示例： 1 2 3 4 5 6 7 8 9 10 openGauss=# select int8('789'); int8 ------ 789 (1 row) openGauss=# select int8(99.9); int8 ------ 99 (1 row) float4(in) 描述：将传入参数转换为float4类型值并返回。支持的入参类型包括：bigint，double precision，int16, integer, numeric，smallint，text。 返回值类型：float4 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select float4('789'); float4 -------- 789 (1 row) openGauss=# select float4(99.9); float4 -------- 99.9 (1 row) float8(in) 描述：将传入参数转换为float8类型值并返回。支持的入参类型包括：bigint，int16, integer, numeric，real，smallint，text。 返回值类型：float8 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select float8('789'); float8 -------- 789 (1 row) openGauss=# select float8(99.9); float8 -------- 99.9 (1 row) int16(in) 描述：将传入参数转换为int16类型值并返回。支持的入参类型包括：bigint，boolean, double precision, integer，numeric，oid，real，smallint，tinyint。 返回值类型：int16 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select int16('789'); int16 -------- 789 (1 row) openGauss=# select int16(99.9); int16 -------- 99 (1 row) numeric(in) 描述：将传入参数转换为numeric类型值并返回。支持的入参类型包括：bigint，boolean, double precision, int16，integer，money，real，smallint。 返回值类型：numeric 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# select "numeric"('789'); numeric --------- 789 (1 row) openGauss=# select "numeric"(99.9); numeric --------- 99.9 (1 row) oid(in) 描述：将传入参数转换为oid类型值并返回。支持的入参类型包括：bigint，int16。 返回值类型：oid radians(dp) 描述：把角度转为弧度。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT radians(45.0); radians ------------------ .785398163397448 (1 row) random() 描述：0.0到1.0之间的随机数。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT random(); random ------------------ .824823560658842 (1 row) multiply(x double precision or text, y double precision or text) 描述：x和y的乘积。 返回值类型：double precision 示例： 1 2 3 4 5 6 7 8 9 10 openGauss=# SELECT multiply(9.0, '3.0'); multiply ------------------- 27 (1 row) openGauss=# SELECT multiply('9.0', 3.0); multiply ------------------- 27 (1 row) ln(x) 描述：自然对数。 返回值类型：与输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT ln(2.0); ln ------------------- .6931471805599453 (1 row) log(x) 描述：以10为底的对数。 返回值类型：与输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT log(100.0); log -------------------- 2.0000000000000000 (1 row) log(b numeric, x numeric) 描述：以b为底的对数。 返回值类型：numeric 示例： 1 2 3 4 5 openGauss=# SELECT log(2.0, 64.0); log -------------------- 6.0000000000000000 (1 row) mod(x,y) 描述： x/y的余数（模） 如果x是0，则返回y。 返回值类型：与参数类型相同。 示例： 1 2 3 4 5 openGauss=# SELECT mod(9,4); mod ----- 1 (1 row) 1 2 3 4 5 openGauss=# SELECT mod(9,0); mod ----- 9 (1 row) pi() 描述：“π”常量。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT pi(); pi ------------------ 3.14159265358979 (1 row) power(a double precision, b double precision) 描述：a的b次幂。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT power(9.0, 3.0); power ---------------------- 729.0000000000000000 (1 row) round(x) 描述：离输入参数最近的整数。 返回值类型：与输入相同。 示例： 1 2 3 4 5 6 7 8 9 10 11 openGauss=# SELECT round(42.4); round ------- 42 (1 row) openGauss=# SELECT round(42.6); round ------- 43 (1 row) round(v numeric, s int) 描述：保留小数点后s位，s后一位进行四舍五入。 返回值类型：numeric 示例： 1 2 3 4 5 openGauss=# SELECT round(42.4382, 2); round ------- 42.44 (1 row) setseed(dp) 描述：为随后的random()调用设置种子(-1.0到1.0之间，包含)。 返回值类型：void 示例： 1 2 3 4 5 openGauss=# SELECT setseed(0.54823); setseed --------- (1 row) sign(x) 描述：输出此参数的符号。 返回值类型：-1表示负数，0表示0，1表示正数。 示例： 1 2 3 4 5 openGauss=# SELECT sign(-8.4); sign ------ -1 (1 row) sin(x) 描述：正弦。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT sin(1.57079); sin ------------------ .999999999979986 (1 row) sqrt(x) 描述：平方根。 返回值类型：与输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT sqrt(2.0); sqrt ------------------- 1.414213562373095 (1 row) tan(x) 描述：正切。 返回值类型：double precision 示例： 1 2 3 4 5 openGauss=# SELECT tan(20); tan ------------------ 2.23716094422474 (1 row) trunc(x) 描述：截断（取整数部分）。 返回值类型：与输入相同。 示例： 1 2 3 4 5 openGauss=# SELECT trunc(42.8); trunc ------- 42 (1 row) trunc(v numeric, s int) 描述：截断为s位小数。 返回值类型：numeric 示例： 1 2 3 4 5 openGauss=# SELECT trunc(42.4382, 2); trunc ------- 42.43 (1 row) width_bucket(op numeric, b1 numeric, b2 numeric, count int) 描述：返回一个桶，这个桶是在一个有count个桶，上界为b1下界为b2的等深柱图中operand将被赋予的那个桶。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# SELECT width_bucket(5.35, 0.024, 10.06, 5); width_bucket -------------- 3 (1 row) width_bucket(op dp, b1 dp, b2 dp, count int) 描述：返回一个桶，这个桶是在一个有count个桶，上界为b1下界为b2的等深柱图中operand将被赋予的那个桶。 返回值类型：int 示例： 1 2 3 4 5 openGauss=# SELECT width_bucket(5.35, 0.024, 10.06, 5); width_bucket -------------- 3 (1 row) int1abs 描述：返回uint8类型数据的绝对值。 参数：tinyint 返回值类型：tinyint int1and 描述：返回两个uint8类型数据按位与的结果。 参数：tinyint, tinyint 返回值类型：tinyint int1cmp 描述：返回两个uint8类型数据比较的结果，若第一个参数大，则返回1；若第二个参数大，则返回-1；若相等，则返回0。 参数：tinyint, tinyint 返回值类型：integer int1div 描述：返回两个uint8类型数据相除的结果，结果为float8类型。 参数：tinyint, tinyint 返回值类型：tinyint int1eq 描述：比较两个uint8类型数据是否相等。 参数：tinyint, tinyint 返回值类型：boolean int1ge 描述：判断两个uint8类型数据是否第一个参数大于等于第二个参数。 参数：tinyint, tinyint 返回值类型：boolean int1gt 描述：无符号1字节整数做大于运算。 参数：tinyint, tinyint 返回值类型：boolean int1larger 描述：返回无符号一字节整数中较大值。 参数：tinyint, tinyint 返回值类型：tinyint int1le 描述：判断无符号一字节整数是否小于等于。 参数：tinyint, tinyint 返回值类型：boolean int1lt 描述：判断无符号一字节整数是否小于。 参数：tinyint, tinyint 返回值类型：boolean int1smaller 描述：返回两个无符号一字节整数中较小的数。 参数：tinyint, tinyint 返回值类型：tinyint int1inc 描述：无符号一字节整数加一。 参数：tinyint 返回值类型：tinyint int1mi 描述：无符号一字节整数做差运算。 参数：tinyint, tinyint 返回值类型：tinyint int1mod 描述：无符号一字节整数做取余运算。 参数：tinyint, tinyint 返回值类型：tinyint int1mul 描述：无符号一字节整数做乘法运算。 参数：tinyint, tinyint 返回值类型：tinyint int1ne 描述：无符号一字节整数不等于运算。 参数：tinyint, tinyint 返回值类型：boolean int1pl 描述：无符号一字节整数加法。 参数：tinyint, tinyint 返回值类型：tinyint int1um 描述：无符号一字节数取相反数并返回有符号二字节整数。 参数：tinyint 返回值类型：smallint int1xor 描述：无符号一字节整数异或操作。 参数：tinyint, tinyint 返回值类型：tinyint cash_div_int1 描述：对money类型进行除法运算。 参数：money, tinyint 返回值类型：money cash_mul_int1 描述：对money类型进行乘法运算。 参数：money, tinyint 返回值类型：money int1not 描述：无符号一字节整数二进制位翻转。 参数：tinyint 返回值类型：tinyint int1or 描述：无符号一字节整数或运算。 参数：tinyint, tinyint 返回值类型：tinyint int1shl 描述：无符号一字节整数左移指定位数。 参数：tinyint, integer 返回值类型：tinyint int1shr 描述：无符号一字节整数右移指定位数。 参数：tinyint, integer 返回值类型：tinyint

TRANSACTIONS_PREPARED_XA CTS 显示当前节点准备好进行两阶段提交的事务的信息。 表1 TRANSACTIONS_PREPARED_XACTS字段 名称 类型 描述 transaction xid 预备事务的数字事务标识。 gid text 赋予该事务的全局事务标识。 prepared timestamp with time zone 事务准备好提交的时间。 owner name 执行该事务的用户的名称。 database name 执行该事务所在的数据库名。 父主题： Transaction

示例 --创建SCHEMA。 openGauss=# CREATE SCHEMA tpcds; --创建表。 openGauss=# CREATE TABLE tpcds.customer_demographics_t2 ( CD_DEMO_SK INTEGER NOT NULL, CD_GENDER CHAR(1) , CD_MARITAL_STATUS CHAR(1) , CD_EDUCATION_STATUS CHAR(20) , CD_PURCHASE_ESTIMATE INTEGER , CD_CREDIT_RATING CHAR(10) , CD_DEP_COUNT INTEGER , CD_DEP_EMPLOYED_COUNT INTEGER , CD_DEP_COLLEGE_COUNT INTEGER ) ; --开启事务。 openGauss=# START TRANSACTION; --插入数据。 openGauss=# INSERT INTO tpcds.customer_demographics_t2 VALUES(1,'M', 'U', 'DOCTOR DEGREE', 1200, 'GOOD', 1, 0, 0); openGauss=# INSERT INTO tpcds.customer_demographics_t2 VALUES(2,'F', 'U', 'MASTER DEGREE', 300, 'BAD', 1, 0, 0); --提交事务，让所有更改永久化。 openGauss=# COMMIT; --查询数据。 openGauss=# SELECT * FROM tpcds.customer_demographics_t2; --删除表tpcds.customer_demographics_t2。 openGauss=# DROP TABLE tpcds.customer_demographics_t2; --删除SCHEMA。 openGauss=# DROP SCHEMA tpcds CASCADE;

MY_SYNONYMS MY_SYNONYMS视图显示当前用户可访问的同义词的信息。 表1 MY_SYNONYMS字段 名称 类型 描述 schema_name text 同义词所属模式名。 synonym_name text 同义词的名称。 table_owner text 关联对象的所有者。尽管该列称为table_owner，但它拥有的该关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 table_name text 关联对象名。尽管该列称为table_name，但此关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 table_schema_name text 关联对象所属模式名。尽管该列称为table_schema_name，但此schema下的该关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 父主题： 系统视图

log_directory 参数说明：logging_collector设置为on时，log_directory决定存放服务器日志文件的目录。它可以是绝对路径，或者是相对路径（相对于数据目录的路径）。log_directory支持动态修改，可以通过gs_guc reload实现，仅sysadmin用户可以访问。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 当配置文件中log_directory的值为非法路径时，会导致数据库无法重新启动。 通过gs_guc reload动态修改log_directory时，当指定路径为合法路径时，日志输出到新的路径下。当指定路径为非法路径时，日志输出到上一次合法的日志输出路径下而不影响数据库正常运行。此时即使指定的log_directory的值非法，也会写入到配置文件中。 在沙箱环境，路径中不可以包含/var/chroot，例如log的绝对路径是/var/chroot/var/lib/log/Ruby/pg_log/cn_log，则只需要设置为/var/lib/log/Ruby/pg_log/cn_log。 合法路径：用户对此路径有读写权限。 非法路径：用户对此路径无读写权限。 取值范围：字符串 默认值：安装时指定。

log_rotation_size 参数说明：logging_collector设置为on时，log_rotation_size决定服务器日志文件的最大容量。当日志消息的总量超过日志文件容量时，服务器将生成一个新的日志文件。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0 ~ INT_MAX / 1024，单位为kB。 0表示关闭基于容量的新日志文件的创建。 建议该值大小设置级别至少为MB级,利于日志文件的及时划分。 默认值：20MB

log_filename 参数说明：logging_collector设置为on时，log_filename决定服务器运行日志文件的名称。通常日志文件名是按照strftime模式生成，因此可以用系统时间定义日志文件名，用%转义字符实现，仅sysadmin用户可以访问。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 建议使用%转义字符定义日志文件名称，否则难以对日志文件进行有效的管理。 当log_destination设为csvlog时，系统会生成附加了时间戳的日志文件名，文件格式为csv格式，例如“server_log.1093827753.csv”。 取值范围：字符串 默认值：postgresql-%Y-%m-%d_%H%M%S.log

log_truncate_on_rotation 参数说明：logging_collector设置为on时，log_truncate_on_rotation设置日志消息的写入方式。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 示例如下： 假设日志需要保留7天，每天生成一个日志文件，日志文件名设置为server_log.Mon、server_log.Tue等。第二周的周二生成的日志消息会覆盖写入到server_log.Tue。设置方法：将log_filename设置为server_log.%a ，log_truncate_on_rotation设置为on，log_rotation_age设置为1440，即日志有效时间为1天。 取值范围： 布尔型 on表示GaussDB以覆盖写入的方式写服务器日志消息。 off表示GaussDB将日志消息附加到同名的现有日志文件上。 默认值：off

log_file_mode 参数说明：logging_collector设置为on时，log_file_mode设置服务器日志文件的权限。通常log_file_mode的取值是能够被chmod和umask系统调用接受的数字。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 使用此选项前请设置log_directory，将日志存储到数据目录之外的地方。 因日志文件可能含有敏感数据，故不能将其设为对外可读。 取值范围：整型，0000～0777 （8进制计数，转化为十进制 0 ~ 511）。 0600表示只允许服务器管理员读写日志文件。 0640表示允许管理员所在用户组成员只能读日志文件。 默认值：0600

log_rotation_age 参数说明：logging_collector设置为on时，log_rotation_age决定创建一个新日志文件的时间间隔。当现在的时间减去上次创建一个服务器日志的时间超过了log_rotation_age的值时，将生成一个新的日志文件。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0 ~ 35791394，单位为min。其中0表示关闭基于时间的新日志文件的创建。 默认值：1440(min)

log_destination 参数说明：GaussDB支持多种方法记录服务器日志，log_destination的取值为一个逗号分隔开的列表（如log_destination="stderr,csvlog"）。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 有效值为stderr、csvlog、syslog、eventlog。 取值为stderr，表示日志打印到屏幕。 取值为csvlog，表示日志的输出格式为“逗号分隔值”即CSV （Comma Separated Value）格式。使用csvlog记录日志的前提是将logging_collector设置为on，请参见使用CSV格式写日志。 取值为syslog，表示通过操作系统的syslog记录日志。 GaussDB使用 syslog的LOCAL0 ～ LOCAL7记录日志，请参见syslog_facility。使用syslog记录日志需在操作系统后台服务配置文件中添加代码： 1 local0.* /var/log/omm 默认值：stderr