华为云用户手册

pg_stat_file(filename text) 描述：返回一个文本文件的状态信息。 返回值类型：record 备注：pg_stat_file返回一条记录，其中包含：文件大小、最后访问时间戳、最后更改时间戳、最后文件状态修改时间戳以及标识传入参数是否为目录的boolean值。典型的用法： 1 SELECT * FROM pg_stat_file('filename'); 1 SELECT (pg_stat_file('filename')).modification; 示例： 1 2 3 4 5 6 7 8 9 SELECT * FROM pg_stat_file('postmaster.pid'); size | access | modification | change | creation | isdir ------+------------------------+------------------------+------------------------ +----------+------- 117 | 2017-06-05 11:06:34+08 | 2017-06-01 17:18:08+08 | 2017-06-01 17:18:08+08 | | f (1 row) 1 2 3 4 5 SELECT (pg_stat_file('postmaster.pid')).modification; modification ------------------------ 2017-06-01 17:18:08+08 (1 row)

pg_ls_dir(dirname text) 描述：列出目录中的文件。 返回值类型：setof text 备注：pg_ls_dir返回指定目录里面的除了特殊项“.”和“..”之外所有名字。 示例： 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 SELECT pg_ls_dir('./'); pg_ls_dir ---------------------- .postgresql.conf.swp postgresql.conf pg_tblspc PG_VERSION pg_ident.conf core server.crt pg_serial pg_twophase postgresql.conf.lock pg_stat_tmp pg_notify pg_subtrans pg_ctl.lock pg_xlog pg_clog base pg_snapshots postmaster.opts postmaster.pid server.key.rand server.key.cipher pg_multixact pg_errorinfo server.key pg_hba.conf pg_replslot .pg_hba.conf.swp cacert.pem pg_hba.conf.lock global gaussdb.state (32 rows)

|| 描述：数组与数组进行连接 示例： 1 2 3 4 5 SELECT ARRAY[1,2,3] || ARRAY[4,5,6] AS RESULT; result --------------- {1,2,3,4,5,6} (1 row) 1 2 3 4 5 SELECT ARRAY[1,2,3] || ARRAY[[4,5,6],[7,8,9]] AS RESULT; result --------------------------- {{1,2,3},{4,5,6},{7,8,9}} (1 row)

创建索引 为了加速文本搜索，可以创建GIN索引。 1 CREATE INDEX pgweb_idx_1 ON tsearch.pgweb USING gin(to_tsvector('english', body)); to_tsvector()函数有两个版本，只输一个参数的版本和输两个参数的版本。 只输一个参数时，系统默认采用default_text_search_config所指定的分词器。 创建索引时必须使用to_tsvector的两参数版本，否则索引内容可能不一致。只有指定了分词器名称的全文检索函数才可以在索引表达式中使用。因为索引的内容不受default_text_search_config的影响。由于default_text_search_config的值可以随时调整，从而导致不同条目生成的tsvector采用了不同的分词器，并且无法区分究竟使用了哪个分词器。正确地转储和恢复这样的索引也是不支持的。 在上述创建索引中to_tsvector使用了两个参数，只有当查询时也使用了两个参数，且参数值与索引中相同时，才会使用该索引。例如，WHERE to_tsvector('english', body) @@ 'a & b' 可以使用索引，但WHERE to_tsvector(body) @@ 'a & b'不能使用索引。这确保索引各条目是使用相同的分词器创建的。 索引中的分词器名称由另一列指定时可以建立更复杂的表达式索引。例如： 1 CREATE INDEX pgweb_idx_2 ON tsearch.pgweb USING gin(to_tsvector('zhparser', body)); 本示例中zhparser仅支持UTF8/GBK的数据库编码格式，在Encoding为SQL_ASCII下会报错。 其中body是pgweb表中的一列。当对索引的各条目使用了哪个分词器进行记录时，允许在同一索引中存在混合分词器。在某些场景下这将是有用的。例如，文档集合中包含不同语言的文档时。再次强调，打算使用索引的查询必须措辞匹配，例如，WHERE to_tsvector(config_name, body) @@ 'a & b'与索引中的to_tsvector措辞匹配。 索引甚至可以连接列： 1 CREATE INDEX pgweb_idx_3 ON tsearch.pgweb USING gin(to_tsvector('english', title || ' ' || body)); 另一个方法是创建一个单独的tsvector列控制to_tsvector的输出。下面的例子是title和body的连接， 当其它是NULL的时候，使用coalesce确保一个字段仍然会被索引： 1 2 ALTER TABLE tsearch.pgweb ADD COLUMN textsearchable_index_col tsvector; UPDATE tsearch.pgweb SET textsearchable_index_col = to_tsvector('english', coalesce(title,'') || ' ' || coalesce(body,'')); 然后为加速搜索创建一个GIN索引： 1 CREATE INDEX textsearch_idx_4 ON tsearch.pgweb USING gin(textsearchable_index_col); 现在，就可以执行一个快速全文搜索了： 1 2 3 4 5 6 7 8 9 10 11 SELECT title FROM tsearch.pgweb WHERE textsearchable_index_col @@ to_tsquery('science & Computer') ORDER BY last_mod_date DESC LIMIT 10; title -------- Computer science (1 rows) 相比于一个表达式索引，单独列方法的一个优势是：它没有必要在查询时明确指定分词器以便能使用索引。正如上面例子所示，查询可以依赖于default_text_search_config。另一个优势是搜索比较快速，因为它没有必要重新利用to_tsvector调用来验证索引匹配。表达式索引方法更容易建立，且它需要较少的磁盘空间，因为tsvector形式没有明确存储。 父主题： 表和索引

解析器测试 函数ts_parse可以直接测试文本搜索解析器。 1 2 ts_parse(parser_name text, document text, OUT tokid integer, OUT token text) returns setof record ts_parse解析指定的document并返回一系列的记录，一条记录代表一个解析生成的token。每条记录包括标识token类型的tokid，及token文本。比如： 1 2 3 4 5 6 7 8 9 10 SELECT * FROM ts_parse('default', '123 - a number'); tokid | token -------+-------- 22 | 123 12 | 12 | - 1 | a 12 | 1 | number (6 rows) 1 2 ts_token_type(parser_name text, OUT tokid integer, OUT alias text, OUT description text) returns setof record ts_token_type返回一个表，这个表描述了指定解析器可以识别的每种token类型。对于每个token类型，表中给出了整数类型的tokid--用于解析器标记对应的token类型；alias——命名分词器命令中的token类型；及简单描述。比如： 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 SELECT * FROM ts_token_type('default'); tokid | alias | description -------+-----------------+------------------------------------------ 1 | asciiword | Word, all ASCII 2 | word | Word, all letters 3 | numword | Word, letters and digits 4 | email | Email address 5 | url | URL 6 | host | Host 7 | sfloat | Scientific notation 8 | version | Version number 9 | hword_numpart | Hyphenated word part, letters and digits 10 | hword_part | Hyphenated word part, all letters 11 | hword_asciipart | Hyphenated word part, all ASCII 12 | blank | Space symbols 13 | tag | XML tag 14 | protocol | Protocol head 15 | numhword | Hyphenated word, letters and digits 16 | asciihword | Hyphenated word, all ASCII 17 | hword | Hyphenated word, all letters 18 | url_path | URL path 19 | file | File or path name 20 | float | Decimal notation 21 | int | Signed integer 22 | uint | Unsigned integer 23 | entity | XML entity (23 rows) 父主题： 测试和调试文本搜索

IN expression IN (value [, ...]) 右侧括号中的是一个表达式列表。左侧表达式的结果与表达式列表的内容进行比较。如果列表中的内容符合左侧表达式的结果，则IN的结果为true。如果没有相符的结果，则IN的结果为false。 示例如下： 1 2 3 4 5 SELECT 8000+500 IN (10000, 9000) AS RESULT; result ---------- f (1 row)

NOT IN expression NOT IN (value [, ...]) 右侧括号中的是一个表达式列表。左侧表达式的结果与表达式列表的内容进行比较。如果在列表中的内容没有符合左侧表达式结果的内容，则NOT IN的结果为true。如果有符合的内容，则NOT IN的结果为false。 示例如下： 1 2 3 4 5 SELECT 8000+500 NOT IN (10000, 9000) AS RESULT; result ---------- t (1 row) 如果查询语句返回结果为空，或者表达式列表不符合表达式的条件且右侧表达式列表返回结果至少一处为空，则NOT IN的返回结果为null，而不是false。这样的处理方式和SQL返回空值的布尔组合规则是一致的。 提示：在所有情况下X NOT IN Y等价于NOT(X IN Y)。

XMLSERIALIZE ( { DOCUMENT | CONTENT } value AS type 描述：从XML类型的值生成一个字符串。 返回值类型：type，可以是character，character varying或text（或其别名） 示例： 1 2 3 4 5 SELECT xmlserialize(content 'good' AS CHAR(10)); xmlserialize -------------- good (1 row)

示例 设置music数据库的连接数为10： 1 ALTER DATABASE music CONNECTION LIMIT= 10; 将music名称改为music1： 1 ALTER DATABASE music RENAME TO music1; 将数据库music1的所属者改为tom： 1 ALTER DATABASE music1 OWNER TO tom; 设置music1的表空间为PG_DEFAULT： 1 ALTER DATABASE music1 SET TABLESPACE PG_DEFAULT; 关闭在数据库music1上缺省的索引扫描： 1 ALTER DATABASE music1 SET enable_indexscan TO off; 重置enable_indexscan参数： 1 ALTER DATABASE music1 RESET enable_indexscan;

注意事项 只有拥有数据库所有者权限的用户才能执行ALTER DATABASE命令，系统管理员默认拥有此权限。如果是非系统管理员，针对所要修改属性的不同，对其还有以下权限约束： 修改数据库名称，必须拥有CREATEDB权限。 修改数据库所有者，当前用户必须是该数据库的所有者，且拥有CREATEDB权限，并确保该用户是新所有者角色的成员。 修改数据库默认表空间，该用户必须是该数据库的所有者或系统管理员，且拥有新表空间的CREATE权限。该语法会从物理上将一个数据库原来缺省表空间上的表和索引移至新的表空间。注意不在缺省表空间的表和索引不受此影响。 修改某个按数据库设置的相关参数，只有数据库所有者或者系统管理员可以改变这些设置。 修改某个数据库对象隔离属性，只有数据库所有者或者系统管理员可以执行此操作。 不能重命名当前使用的数据库，如果需要重新命名，须连接至其他数据库上。 不支持修改现有数据库的兼容模式，只能在创建数据库时指定兼容模式，详情请参见CREATE DATABASE。

参数说明 database_name 需要修改属性的数据库名称。 取值范围：字符串，要符合标识符的命名规范。 connlimit 数据库可以接收的最大并发连接数（管理员用户连接除外）。 取值范围：整数，建议填写1~50的整数。-1（缺省）表示没有限制。 new_name 数据库的新名称。 取值范围：字符串，要符合标识符的命名规范。 new_owner 数据库的新所有者。 取值范围：字符串，有效的用户名。 configuration_parameter value 把指定的数据库会话参数值设置为给定的值。如果value是DEFAULT或者RESET，则在新的会话中使用系统的缺省设置。OFF关闭设置。 取值范围：字符串， DEFAULT OFF RESET FROM CURRENT 根据当前会话连接的数据库设置该参数的值。 RESET configuration_parameter 重置指定的数据库会话参数值。 RESET ALL 重置全部的数据库会话参数值。 修改数据库默认表空间，会将旧表空间中的所有表和索引转移到新表空间中，该操作不会影响其他非默认表空间中的表和索引。 修改的数据库会话参数值，将在下一次会话中生效。

语法格式 修改数据库的最大连接数。 1 2 ALTER DATABASE database_name [ [ WITH ] CONNECTION LIMIT connlimit ]; 修改数据库名称。 1 2 ALTER DATABASE database_name RENAME TO new_name; 若该数据库中有OBS冷热表，则不支持修改数据库名。 修改数据库所属者。 1 2 ALTER DATABASE database_name OWNER TO new_owner; 修改数据库默认表空间。 1 2 ALTER DATABASE database_name SET TABLESPACE new_tablespace; 修改数据库的表空间时不能修改为OBS表空间。 修改数据库指定会话参数值。 1 2 ALTER DATABASE database_name SET configuration_parameter { { TO | = } { value | DEFAULT } | FROM CURRENT }; 数据库配置参数重置。 1 2 ALTER DATABASE database_name RESET { configuration_parameter | ALL };

语法格式 向用户组中添加用户。 1 2 ALTER GROUP group_name ADD USER user_name [, ... ]; 从用户组中删除用户。 1 2 ALTER GROUP group_name DROP USER user_name [, ... ]; 修改用户组的名称。 1 2 ALTER GROUP group_name RENAME TO new_name;

示例 创建一个异常规则集except_rule1并指定其blocktime规则阈值为3000秒，下盘空间为4000MB。 1 CREATE EXCEPT RULE except_rule1 WITH (blocktime=3000, spillsize=4000, action=abort); 创建一个异常规则集except_rule2并指定其memsize规则阈值为5000MB，默认所采取的异常规则操作为abort。 1 CREATE EXCEPT RULE except_rule2 WITH (memsize=3000); 创建一个资源池并绑定异常规则集except_rule3。 1 CREATE resource pool resource_pool_a1 WITH (except_rule='except_rule3');

语法格式 1 CREATE EXCEPT RULE rule_name WITH ({BLOCKTIME=value | ALLCPUTIME=value | ELAPSEDTIME=value | CPUSKEWPERCENT=value | SPILLSIZE=value | BROADCASTSIZE=value | MEMSIZE=value | CPUAVGPERCENT=value}[, ... ]);

参数说明 rule_name 异常规则集名称。 取值范围：字符串（1-64个字符），要符合标识符的命名规范。 blocktime 作业排队阻塞的最大时间，单位：秒。 取值范围：数值型，-1，1~INT64_MAX。 elapsedtime 作业执行的最大时间，单位：秒。 取值范围：数值型，-1，1~INT64_MAX。 allcputime 作业运行中使用的最大CPU时间，单位：秒。 取值范围：数值型，-1，1~INT64_MAX。 cpuskewpercent 作业执行时的平均CPU使用率，单位：百分比。 取值范围：数值型，-1，1~100。 cpuavgpercent 作业执行时的CPU使用倾斜率，单位：百分比。 取值范围：数值型，-1，1~100。 spillsize 作业执行的最大下盘大小，单位：MB。 取值范围：数值型，-1，1~INT64_MAX。 broadcastsize 作业执行的最大广播大小，单位：MB。 取值范围：数值型，-1，1~INT64_MAX。 memsize 作业执行使用的最大内存大小，单位：MB。 取值范围：数值型，-1，1~INT64_MAX。

参数说明 CHECK 仅在节点列表为TO ALL时可以指定。如果指定该参数，会在清理连接之前检查数据库是否被其他会话连接访问。此参数主要用于DROP DATABASE之前的连接访问检查，如果发现有其他会话连接，则将报错并停止删除数据库。 FORCE 仅在节点列表为TO ALL时可以指定，如果指定该参数，所有和指定dbname和username相关的线程都会收到SIGTERM信号，然后被强制关闭。 COORDINATOR ( nodename [, ... ] } ) | NODE ( nodename [, ... ] ) | ALL 删除指定节点上的连接。有三种场景： 删除指定CN上的连接。 删除指定DN上的连接。 删除所有节点上的连接，包括CN和DN。 取值范围：可替换其中的nodename为已存在的节点名。 dbname 删除指定数据库上的连接。如果不指定，则删除所有数据库的连接。 取值范围：已存在数据库名。 username 删除指定用户上的连接。如果不指定，则删除所有用户的连接。 取值范围：已存在的用户。 参数dbname和username必须至少指定一个。

示例 删除数据库template1在dn1和dn2节点上的连接。 1 CLEAN CONNECTION TO NODE (dn1,dn2) FOR DATABASE template1; 删除用户jack在dn1节点上的连接。 1 CLEAN CONNECTION TO NODE (dn1) TO USER jack; 删除在数据库gaussdb上的所有连接。 1 CLEAN CONNECTION TO ALL FORCE FOR DATABASE gaussdb;

hll_expthresh(hll) 描述：得到当前hll中expthresh大小，hll通常会由Explicit模式到Sparse模式再到Full模式，这个过程称为promotion hierarchy策略。可以通过调整expthresh值的大小改变策略，比如expthresh为0的时候就会跳过Explicit模式而直接进入Sparse模式。当显式指定expthresh的取值为1-7之间时，该函数得到的是 2expthresh。 返回值类型：record 示例： 1 2 3 4 5 6 7 8 9 10 11 SELECT hll_expthresh(hll_empty()); hll_expthresh --------------- (-1,160) (1 row) SELECT hll_expthresh(hll_empty(11,5,3)); hll_expthresh --------------- (8,8) (1 row)

pg_lifecycle_node_data_distribute() 描述：查看所有冷热表数据分布情况。 返回值：record 示例：数据库中当前存在两个冷热表，其数据分布情况如下。 1 2 3 4 5 6 SELECT * FROM pg_catalog.pg_lifecycle_node_data_distribute(); schemaname | tablename | nodename | hotpartition | coldpartition | switchablepartition | hotdatasize | colddatasize | switchabledatasize ------------+-----------+----------+--------------+---------------+---------------------+-------------+--------------+-------------------- public | w1 | dn_1 | p2 | p1 | | 81920 | 0 | 0 public | w2 | dn_1 | p2 | p1 | | 81920 | 0 | 0 (2 rows)

pg_lifecycle_table_data_distribute(table_name) 描述：查看某个冷热表的数据分布情况。 table_name为表名，不可缺省。 返回值：record 示例：根据节点数量形成多条记录，如下示例为只有一个dn节点时w1表数据分布情况。 1 2 3 4 5 SELECT * FROM pg_catalog.pg_lifecycle_table_data_distribute('w1'); schemaname | tablename | nodename | hotpartition | coldpartition | switchablepartition | hotdatasize | colddatasize | switchabledatasize ------------+-----------+----------+--------------+---------------+---------------------+-------------+--------------+-------------------- public | w1 | dn_1 | p2 | p1 | | 80 KB | 0 bytes | 0 bytes (1 row)

pg_refresh_storage() 描述：切换所有冷热表，将符合冷热切换规则的数据由热数据切换至冷数据（OBS中）。 返回值类型：int 返回值字段： success_count int：切换成功的表个数 failed_count int：切换失败的表个数 示例： 1 2 3 4 5 SELECT * FROM pg_refresh_storage(); success_count | failed_count ---------------+-------------- 1 | 0 (1 row)

pg_obs_cold_refresh_time(table_name, time) 描述：用来修改冷热表的冷数据切换至OBS上的时间，默认为每日0点。 table_name为冷热表表名，类型为name，time为数据切换任务调度时间，类型为Time。 返回值：SUC CES S，任务时间修改成功。 示例： 1 2 3 4 5 SELECT * FROM pg_obs_cold_refresh_time('lifecycle_table', '06:30:00'); pg_obs_cold_refresh_time -------------------------- SUCCESS (1 row)

collation for (any) 描述：获取参数的排序。 返回类型：text 备注： 表达式collation for返回传递给他的值的排序。示例： 1 2 3 4 5 SELECT collation for (description) FROM pg_description LIMIT 1; pg_collation_for ------------------ "default" (1 row) 值可能是引号括起来的并且模式限制的。如果没有为参数表达式排序，则返回一个null值。如果参数不是排序的类型，则抛出一个错误。

pg_get_tabledef(table_oid) 描述：根据table_oid获取表定义。 返回类型：text 示例：先通过系统表pg_class获取表customer_t2的OID，再使用此函数查询表customer_t2的定义，可获取创建表customer_t2时的表字段，表的存储方式（行存或列存）及表的分布方式等信息。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 SELECT oid FROM pg_class WHERE relname ='customer_t2'; oid ------- 17353 (1 row) SELECT * FROM pg_get_tabledef(17353); pg_get_tabledef -------------------------------------------- SET search_path = dbadmin; + CREATE TABLE customer_t2 ( + state_id character(2), + state_name character varying(40), + area_id numeric + ) + WITH (orientation=column, compression=low)+ DISTRIBUTE BY HASH(state_id) + TO GROUP group_version1; (1 row)

pg_typeof(any) 描述：获取任何值的数据类型。 返回类型：regtype 备注： pg_typeof返回传递给他的值的数据类型OID。这可能有助于故障排除或动态构造SQL查询。声明此函数返回regtype，这是一个OID别名类型（请参考对象标识符类型）；这意味着它是一个为了比较而显示类型名字的OID。 示例： 1 2 3 4 5 6 7 8 9 10 11 SELECT pg_typeof(33); pg_typeof ----------- integer (1 row) SELECT typlen FROM pg_type WHERE oid = pg_typeof(33); typlen -------- 4 (1 row)

pg_get_indexdef(index_oid) 描述：获取索引的CREATE INDEX命令。 返回类型：text index_oid为索引的OID，可以通过PG_STATIO_ALL_INDEXES系统视图查询。 示例：查询索引ds_ship_mode_t1_index1的OID及其创建命令。 1 2 3 4 5 6 7 8 9 10 SELECT indexrelid FROM PG_STATIO_ALL_INDEXES WHERE indexrelname = 'ds_ship_mode_t1_index1'; indexrelid ------------ 136035 (1 row) SELECT * FROM pg_get_indexdef(136035); pg_get_indexdef --------------------------------------------------------------------------------------------------------------- CREATE INDEX ds_ship_mode_t1_index1 ON tpcds.ship_mode_t1 USING psort (sm_ship_mode_sk) TABLESPACE pg_default (1 row)

pg_get_indexdef(index_oid, column_no, pretty_bool) 描述：获取索引的CREATE INDEX命令，或者如果column_no不为零，则只获取一个索引字段的定义。 返回类型：text 1 2 3 4 5 6 7 8 9 10 SELECT * FROM pg_get_indexdef(136035,0,false); pg_get_indexdef --------------------------------------------------------------------------------------------------------------- CREATE INDEX ds_ship_mode_t1_index1 ON tpcds.ship_mode_t1 USING psort (sm_ship_mode_sk) TABLESPACE pg_default (1 row) SELECT * FROM pg_get_indexdef(136035,1,false); pg_get_indexdef ----------------- sm_ship_mode_sk (1 row)

pg_get_viewdef(viewname text [, pretty bool [, fullflag bool]]) 描述：为视图获取底层的SELECT命令。 返回类型：text 备注： pg_get_viewdef重构定义视图的SELECT查询。pretty bool参数为true时，显示格式“适合打印”，且该格式易读。pretty bool参数缺省值为false，显示格式不易读。如果用于转储，那么尽可能使用缺省格式。pretty bool参数只对有效视图生效。 fullflag bool参数为true时，显示视图的完整定义。其缺省值为false。

pg_get_functiondef(func_oid) 描述：获取函数的定义。 返回类型：text func_oid为函数的OID，可以通过PG_PROC系统表查询。 示例：查询函数justify_days的OID及其函数定义。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 SELECT oid FROM pg_proc WHERE proname ='justify_days'; oid ------ 1295 (1 row) SELECT * FROM pg_get_functiondef(1295); headerlines | definition -------------+-------------------------------------------------------------- 4 | CREATE OR REPLACE FUNCTION pg_catalog.justify_days(interval)+ | RETURNS interval + | LANGUAGE internal + | IMMUTABLE STRICT NOT FENCED NOT SHIPPABLE + | AS $function$interval_justify_days$function$ + | (1 row)