华为云用户手册

语法格式 CREATE [ OR REPLACE ] PROCEDURE procedure_name [ ( {[ argname ] [ argmode ] argtype [ { DEFAULT | := | = } expression ]}[,...]) ] [ { IMMUTABLE | STABLE | VOLATILE } | { SHIPPABLE | NOT SHIPPABLE } | {PACKAGE} | [ NOT ] LEAKPROOF | { CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT } | {[ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER | AUTHID DEFINER | AUTHID CURRENT_USER} | COST execution_cost | SET configuration_parameter { [ TO | = ] value | FROM CURRENT } ][ ... ] { IS | AS } plsql_body /

参数说明 OR REPLACE 当存在同名的存储过程时，替换原来的定义。 procedure_name 创建的存储过程名称，可以带有模式名。 取值范围：字符串，要符合标识符命名规范。 创建和系统函数重名的函数时，调用时需要指定函数的schema。 argmode 参数的模式。 VARIADIC用于声明数组类型的参数。 取值范围：IN，OUT，INOUT或VARIADIC。缺省值是IN。只有OUT模式的参数能跟在VARIADIC参数之后。 argname 参数的名称。 取值范围：字符串，要符合标识符命名规范。 argtype 参数的数据类型。可以使用%TYPE或%ROWTYPE间接引用变量或表的类型，详细可参考存储过程章节定义变量。 取值范围：可用的数据类型。 PACKAGE外PROCEDURE argtype中%TYPE不支持引用PACKAGE变量的类型。 expression 参数的默认表达式。 在参数a_format_version值为10c和a_format_dev_version值为s2的情况下，参数为INOUT模式时不支持默认表达式。 推荐使用方式：将所有默认值参数定义在所有非默认值参数后。 调用带有默认参数的函数时，入参从左往右排入函数，如果有非默认参数的入参缺失则报错。 打开 proc_uncheck_default_param 参数，调用带有默认参数的函数时，入参从左往右排入函数，允许缺省默认参数个入参，如果有非默认参数的入参缺失，则会用错位的默认值填充该参数。 在参数a_format_version值为10c、a_format_dev_version值为s1和关闭proc_outparam_override，函数参数同时包括out出参和default时，默认值不可缺省。 configuration_parameter value 把指定的配置参数设置为给定的值。如果value是DEFAULT，则在新的会话中使用系统的缺省设置。OFF关闭设置。 取值范围：字符串 DEFAULT OFF 指定默认值。 from current 取当前会话中的值设置为configuration_parameter的值。 IMMUTABLE、STABLE等 行为约束可选项。各参数的功能与CREATE FUNCTION类似，详细请参见CREATE FUNCTION。 plsql_body PL/SQL存储过程体。 创建一个存储过程时，plsql_body支持以“END;”或“END procedure_name;”两种形式结尾。 以END procedure_name;结尾时遵循以下约束： 仅A兼容模式（数据库级别）下支持使用。 仅支持A风格创建语法。 仅支持END后设置存储过程名称的场景。 存储过程END后名称与实际名称不匹配报错；PACKAGE内存储过程，END后名称与实际名称不匹配报错。 以上两种报错场景，即使参数enable_force_create_obj=on打开，仍会创建失败并提示报错信息。 嵌套子程序END后名称与实际名称不匹配报错场景，如参数enable_force_create_obj=on打开，创建成功，通过WARNING提示报错信息；如参数未打开，存储过程或package创建失败并提示报错信息。 创建的存储过程在DBE_PLDEVELOPER.gs_source、my_source、db_source、adm_source视图中显示与存储过程创建时定义相同（创建时“END+名称”则显示“END+名称”）；在pg_proc视图以及\sf查看时，最外层END后在任何情况下都不跟名称，内部则按照创建时定义（创建时“END+名称”则显示“END+名称”）显示。 gs_dump生成的sql文件，存储过程无法保留最外层END后名称。 以IF/LOOP命名存储过程或嵌套子程序时，不支持以END IF/LOOP结束存储过程。 当在存储过程体中进行创建用户、修改密码或加解密等涉及密码或密钥相关操作时，系统表及日志中会记录密码或密钥的明文信息。为防止敏感信息泄露，不建议用户在存储过程体中进行涉及密码或密钥等敏感信息的相关操作。 argname和argmode的顺序没有严格要求，推荐按照argname、argmode、argtype的顺序使用。

注意事项 如果创建存储过程时参数或返回值带有精度，不进行精度检测。 创建存储过程时，存储过程定义中对表对象的操作建议都显示指定模式，否则可能会导致存储过程执行异常。 创建存储过程时，仅对CREATE的存储过程或PACKAGE本身加写锁，仅对执行过程中编译、执行会对函数和函数依赖的PACKAGE均加读锁。 创建存储过程时，存储过程内部通过SET语句设置current_schema和search_path无效。执行完函数search_path和current_schema与执行函数前的search_path和current_schema保持一致。 SELECT、CALL调用函数时，必须要在出参位置提供实参进行调用，实参不会发生作用。 存储过程指定package属性时支持重载。 不能创建仅形参名字不同（存储过程名和参数列表类型都一样）的重载存储过程。 重载的存储过程在调用时变量需要明确具体的类型。 不能创建与函数拥有相同名称和参数列表的存储过程。 不支持仅默认值不同的存储过程重载。 存储过程仅in、out、inout这三种类型不同的参数，打开guc参数behavior_compat_options='proc_outparam_override'后，不允许重载。关闭该参数后，可以重载。 A兼容模式的数据库，建立A风格的函数；PG兼容的库，建立PG风格的函数。不建议混合创建。 函数如果支持重载，需要添加PACKAGE关键字。 在存储过程内部使用未声明的变量，存储过程被调用时会报错。 在创建procedure时，不能在avg函数外面嵌套其他agg函数，或者其他系统函数。 存储过程中不支持需要return集合的操作。 在存储过程内部调用其它无参数的存储过程时，可以省略括号，直接使用存储过程名进行调用。 在存储过程内部调用其他有出参的函数，如果在赋值表达式中调用时，需要打开guc参数 set behavior_compat_options = 'proc_outparam_override' ，并提前定义与出参类型相同的变量，然后将变量作为出参调用带有出参的其他函数，出参才能生效。否则，被调函数的出参会被忽略。 在表达式中使用out参数作为出参时，如下情况不会生效，例如：使用execute immediate sqlv using func语法执行函数、使用select func into语法执行函数、使用insert、update等DML语句执行以及带out出参的函数作为入参时，fun（func（out b），a），out出参b未生效等。 存储过程支持参数注释的查看与导出、导入。 存储过程支持介于IS/AS与plsql_body之间的注释的查看与导出、导入。 存储过程默认为SECURITY INVOKER权限，如果想将默认行为改为SECURITY DEFINER权限，需要设置guc参数behavior_compat_options='plsql_security_definer'。 被授予CREATE ANY FUNCTION权限的用户，可以在用户模式下创建/替换存储过程。 out/inout参数必须传入变量，不能传入常量。 集中式环境下，想要调用in参数相同，out参数不同的存储过程，需要设置guc参数behavior_compat_options='proc_outparam_override',并且打开参数后，无论使用select还是call调用存储过程，都必须加上out参数。打开参数后，不支持使用perform调用存储过程或函数。 存储过程创建时依赖未定义对象，如参数enable_force_create_obj打开，创建可执行，通过WARNING提示；如参数未打开，存储过程创建不可执行。 当打开三权分立时，对于定义者权限的存储过程，只能由本用户自己重建。 如果将定义者权限的存储过程创建到其他用户Schema下，则会以其他用户的权限执行该存储过程，有越权风险，请谨慎使用。 在存储过程内部函数复杂调用，如：func(x).a，函数调用返回复合类型，支持跨schema调用，不支持通过database.schema.package.func(x).b的方式调用。 调用带out出参的存储过程，设置GUC参数set behavior_compat_options = 'proc_outparam_transfer_length'后可以传递参数长度。规格限制如下： 支持的基本类型包括：CHAR(n)、CHARACTER(n)、NCHAR(n)、VARCHAR(n)、VARYING(n)、VARCHAR2(n)、NVARCHAR2(n)。 out出参不生效的情况下（比如perform）不需要传递长度。 不支持精度传递的基本类型包括：NUMERIC、DECIMAL、NUMBER、FLOAT、DEC、INTEGER、TIME、TIMESTAMP、INTERVAL、TIME WITH TIME ZONE、TIMESTAMP WITH TIME ZONE、TIME WITHOUT TIME ZONE、TIMESTAMP WITHOUT TIME ZONE。 无论GUC参数set behavior_compat_options是否设置为proc_outparam_override都支持传递参数长度。 要传递集合类型的元素长度和被集合类型嵌套的数组类型的元素长度需要在GUC参数behavior_compat_options里同时开启tableof_elem_constraints选项。 函数中存在通过GUC参数控制特性的语法、函数等，如果在会话内更改相关GUC参数，修改参数后，调用函数可能会维持修改前的行为，请谨慎变更GUC参数。

语法格式 对一个表进行聚簇排序。 1 CLUSTER [ VERBOSE ] table_name [ USING index_name ]; 对一个分区进行聚簇排序。 1 CLUSTER [ VERBOSE ] table_name PARTITION ( partition_name ) [ USING index_name ]; 对已做过聚簇的表重新进行聚簇。 1 CLUSTER [ VERBOSE ];

示例 对表进行聚簇排序： 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 --建表并向表中插入数据。 gaussdb=# CREATE TABLE test_c1(id int, name varchar(20)); gaussdb=# CREATE INDEX idx_test_c1_id ON test_c1(id); gaussdb=# INSERT INTO test_c1 VALUES (3,'Joe'),(1,'Jack'),(2,'Scott'); --查看。 gaussdb=# SELECT * FROM test_c1; id | name ----+------- 3 | Joe 1 | Jack 2 | Scott (3 rows) --聚簇排序。 gaussdb=# CLUSTER test_c1 USING idx_test_c1_id; --查看。 gaussdb=# SELECT * FROM test_c1; id | name ----+------- 1 | Jack 2 | Scott 3 | Joe (3 rows) --删除。 gaussdb=# DROP TABLE test_c1; 对已做过聚簇的表重新进行聚簇排序： --建表。 gaussdb=# CREATE TABLE test(col1 int,CONSTRAINT pk_test PRIMARY KEY (col1)); --第一次聚簇排序不带USING关键字报错。 gaussdb=# CLUSTER test; ERROR: there is no previously clustered index for table "test" --聚簇排序。 gaussdb=# CLUSTER test USING pk_test; --插入数据。 gaussdb=# INSERT INTO test VALUES (1),(99),(10),(8); --对已做过聚簇的表重新进行聚簇。 gaussdb=# CLUSTER VERBOSE test; INFO: clustering "public.test" using index scan on "pk_test"(dn_6001 pid=3672) INFO: "test": found 0 removable, 4 nonremovable row versions in 1 pages(dn_6001 pid=3672) DETAIL: 0 dead row versions cannot be removed yet. CPU 0.00s/0.00u sec elapsed 0.01 sec. CLUSTER --删除。 gaussdb=# DROP TABLE test; 对分区进行聚簇排序： --建表并向表中插入数据。 gaussdb=# CREATE TABLE test_c2(id int, info varchar(4)) PARTITION BY RANGE (id)( PARTITION p1 VALUES LESS THAN (11), PARTITION p2 VALUES LESS THAN (21) ); gaussdb=# CREATE INDEX idx_test_c2_id1 ON test_c2(id); gaussdb=# INSERT INTO test_c2 VALUES (6,'ABBB'),(2,'ABAB'),(9,'AAAA'); gaussdb=# INSERT INTO test_c2 VALUES (11,'AAAB'),(19,'BBBA'),(16,'BABA'); --查看。 gaussdb=# SELECT * FROM test_c2; id | info ----+------ 6 | ABBB 2 | ABAB 9 | AAAA 11 | AAAB 19 | BBBA 16 | BABA (6 rows) --对分区p2进行聚簇排序。 gaussdb=# CLUSTER test_c2 PARTITION (p2) USING idx_test_c2_id1; --查看。 gaussdb=# SELECT * FROM test_c2; id | info ----+------ 6 | ABBB 2 | ABAB 9 | AAAA 11 | AAAB 16 | BABA 19 | BBBA (6 rows) --删除。 gaussdb=# DROP TABLE test_c2;

功能描述 根据一个索引对表进行聚簇排序。 CLUSTER指定 GaussDB 通过索引名指定的索引聚簇由表名指定的表。表名上必须已经定义该索引。 当对一个表聚簇后，该表将基于索引信息进行物理存储。聚簇是一次性操作：当表被更新之后，更改的内容不会被聚簇。也就是说，系统不会试图按照索引顺序对新的存储内容及更新记录进行重新聚簇。 在对一个表聚簇之后，GaussDB会记录该表在哪一个索引上建立了聚簇。CLUSTER table_name将在该表之前记录过的聚簇索引上重新聚簇。用户也可以用ALTER TABLE table_name CLUSTER on index_name来设置指定表用于后续聚簇操作的索引，或使用ALTER TABLE table_name SET WITHOUT CLUSTER来清除指定表之前设置的聚簇索引。 不含参数的CLUSTER命令会将当前用户所拥有的数据库中的先前做过聚簇的所有表重新处理。如果系统管理员调用这个命令，则对所有进行过聚簇的表重新聚簇。 在对一个表进行聚簇的时候，会在其上请求一个AC CES S EXCLUSIVE锁，这样就避免了在CLUSTER操作完成之前对该表执行其它的操作（包括读写）。

注意事项 只有行存B-tree索引支持CLUSTER操作。 如果用户只是随机访问表中的行，那么表中数据的实际存储顺序是无关紧要的。但是，如果对某些特定数据的访问次数较多，而且有一个索引将这些数据分组，那么使用CLUSTER索引对性能会有所提升。 如果一个请求从表中查找的索引是一个范围，或者是一个索引值对应多行，CLUSTER也会有助于应用，因为如果索引标识出了第一匹配行所在的存储页，所有其它行也可能也已经在同一个存储页里了，这样便节省了磁盘访问的时间，加速了查询。 在聚簇过程中，系统会先创建一个按照索引顺序建立的表的临时备份，同时也建立表上的每个索引的临时备份。因此，聚簇过程中需要保证磁盘上有足够的剩余空间，至少是表大小与全部索引大小之和。 因为CLUSTER记录着哪些索引曾被用于聚簇，所以用户可以在第一次手动指定索引，对指定表进行聚簇，然后设置一个周期化执行的维护脚本，只需执行不带参数的CLUSTER命令，就可以实现对想要周期性聚簇的表进行自动更新。 因为优化器记录着有关表的排序的统计，在表上执行聚簇操作后，需运行ANALYZE操作以确保优化器具备最新的排序信息，否则，优化器可能会选择非最优的查询规划。 CLUSTER不允许在事务中执行。 如果没有将GUC参数xc_maintenance_mode设置为on，那么CLUSTER会跳过所有系统表。 对于全局二级索引（GSI），当前在单个分区执行CLUSTER或通过CLUSTER [VERBOSE]对以做过聚簇的表重新进行聚簇后，查询语句走全局二级索引会报错，需要执行REINDEX INDEX重建全局二级索引。

参数说明 VERBOSE 可选。启用显示进度信息。 table_name 表名称。 取值范围：已存在的表名称。 [ USING index_name ] 索引名称。 取值范围：已存在的索引名称。 第一次对表进行聚簇排序时必须指定index_name，后续再次对表进行聚簇排序时不指定index_name，将会按照已有记录对表进行聚簇排序。 partition_name 分区名称。 取值范围：已存在的分区名称。

数据库对象位置函数 pg_relation_filenode(relation regclass) 描述：指定关系的文件节点数。 返回值类型：oid 备注：pg_relation_filenode接受一个表、索引、序列或压缩表的OID或者名称，并且返回当前分配给它的“filenode”数。文件节点是关系使用的文件名称的基本组件。对大多数表来说，结果和pg_class.relfilenode相同，但对确定的系统目录来说，relfilenode为0而且这个函数必须用来获取正确的值。如果传递一个没有存储的关系，比如一个视图，那么这个函数返回NULL。 pg_relation_filepath(relation regclass) 描述：指定关系的文件路径名。只能用于非段页式关系。 返回值类型：text 备注：pg_relation_filepath类似于pg_relation_filenode，但是它返回关系的整个文件路径名（相对于数据库的数据目录PGDATA）。 段页式关系建议使用段页式相关函数或视图，例如： SELECT e.*, f.file_name FROM gs_seg_extents e, gs_seg_datafiles f WHERE e.tablespace_name = f.tablespace_name ADN e.bucketnode = f.bucketnode ADN e.file_id = f.file_id ADN e.forknum = f.forknum; pg_filenode_relation(tablespace oid, filenode oid) 描述：获取对应的tablespace和relfilenode所对应的表名。 返回类型：regclass pg_partition_filenode(partition_oid) 描述：获取到指定分区表的oid锁对应的filenode。 返回类型：oid pg_partition_filepath(partition_oid) 描述：指定分区的文件路径名。只能用于非段页式关系。 返回值类型：text 备注：段页式关系建议使用段页式相关函数或视图，例如： SELECT e.*, f.file_name FROM gs_seg_extents e, gs_seg_datafiles f WHERE e.tablespace_name = f.tablespace_name ADN e.bucketnode = f.bucketnode ADN e.file_id = f.file_id ADN e.forknum = f.forknum;

数据库对象尺寸函数 数据库对象尺寸函数计算数据库对象使用的实际磁盘空间。 pg_column_size(any) 描述：存储一个指定的数值需要的字节数（可能压缩过）。 返回值类型：int 备注：pg_column_size显示用于存储某个独立数据值的空间。 1 2 3 4 5 gaussdb=# SELECT pg_column_size(1); pg_column_size ---------------- 4 (1 row) pg_database_size(oid) 描述：指定OID代表的数据库使用的磁盘空间。 返回值类型：bigint pg_database_size(name) 描述：指定名称的数据库使用的磁盘空间。 返回值类型：bigint 备注：pg_database_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 示例： 1 2 3 4 5 gaussdb=# SELECT pg_database_size('testdb'); pg_database_size ------------------ 51590112 (1 row) 备注：pg_database_size(oid/name)对象函数查询耗时与该oid/name所对应库中的对象文件数目相关，基本呈线性关系，如需进行耗时评估，可参考以下步骤： 1）由于耗时与软硬件环境有关，因此需要以某个库（注意所选择库的对象文件数目不宜过多）测试结果为基准，根据查询耗时和库中对象文件数目计算出单对象文件所需耗时database_size_t； 2）使用select oid,* from pg_database where datname = 'database';查询得到需要查询库的oid，在表空间base和pg_tblspc目录下统计该oid目录下的所有对象文件数目database_obj_num，如该oid目录中包含目录，则需要进入查看对象文件数目，依次类推；查询目录下文件数目使用ls | wc -l； 3）根据基准测试结果中单文件数目耗时database_size_t和database下所有对象文件数目database_obj_num计算预估总耗时，总耗时=database_size_t * database_obj_num，如果时延太长需考虑调整执行超时阈值，避免出现不必要的告警。 pg_relation_size(oid) 描述：指定OID代表的表或者索引所使用的磁盘空间。 返回值类型：bigint get_db_source_datasize() 描述：估算当前数据库非压缩态的数据总容量。 返回值类型：bigint 备注：调用该函数前需要做analyze。 示例： 1 2 3 4 5 6 7 gaussdb=# analyze; ANALYZE gaussdb=# SELECT get_db_source_datasize(); get_db_source_datasize ------------------------ 35384925667 (1 row) pg_relation_size(text) 描述：指定名称的表或者索引使用的磁盘空间。表名称可以用模式名修饰。 返回值类型：bigint pg_relation_size(relation regclass, fork text) 描述：指定表或索引的指定分叉树（'main'，'fsm'或'vm'）使用的磁盘空间。 返回值类型：bigint pg_relation_size(relation regclass) 描述：pg_relation_size(..., 'main')的简写。 返回值类型：bigint 备注：pg_relation_size接受一个表、索引、压缩表的OID或者名称，然后返回它们的字节大小。 pg_partition_size(oid, oid) 描述：指定OID代表的分区使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_size(text, text) 描述：指定名称的分区使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_partition_indexes_size(oid, oid) 描述：指定OID代表的分区的索引使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_indexes_size(text, text) 描述：指定名称的分区的索引使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_indexes_size(regclass) 描述：附加到指定表的索引使用的总磁盘空间。 返回值类型：bigint pg_size_pretty(bigint) 描述：将以64位整数表示的字节值转换为具有单位的易读格式。 返回值类型：text pg_size_pretty(numeric) 描述：将以数值表示的字节值转换为具有单位的易读格式。 返回值类型：text 备注：pg_size_pretty用于把其他函数的结果格式化成一种易读的格式，可以根据情况使用kB 、MB 、GB 、TB。 pg_table_size(regclass) 描述：指定的表使用的磁盘空间，不计索引（但是包含TOAST，自由空间映射和可见性映射）。 返回值类型：bigint pg_tablespace_size(oid) 描述：指定OID代表的表空间使用的磁盘空间。 返回值类型：bigint pg_tablespace_size(name) 描述：指定名称的表空间使用的磁盘空间。 返回值类型：bigint 备注： pg_tablespace_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 pg_total_relation_size(oid) 描述：指定OID代表的表使用的磁盘空间，包括索引和压缩数据。 返回值类型：bigint pg_total_relation_size(regclass) 描述：指定的表使用的总磁盘空间，包括所有的索引和TOAST数据。 返回值类型：bigint pg_total_relation_size(text) 描述：指定名称的表所使用的全部磁盘空间，包括索引和压缩数据。表名称可以用模式名修饰。 返回值类型：bigint 备注：pg_total_relation_size接受一个表或者一个压缩表的OID或者名称，然后返回以字节计的数据和所有相关的索引和压缩表的尺寸。 datalength(any) 描述：计算一个指定的数据需要的字节数（不考虑数据的管理空间和数据压缩，数据类型转换等情况）。 返回值类型：int 备注：datalength用于计算某个独立数据值的空间。 示例： gaussdb=# SELECT datalength(1); datalength ------------ 4 (1 row) 目前支持的数据类型及计算方式见下表： 数据类型 存储空间 数值类型 整数类型 TINYINT 1 SMALLINT 2 INTEGER 4 BINARY_INTEGER 4 BIGINT 8 任意精度型 DECIMAL 每4位十进制数占两个字节，小数点前后数字分别计算。 NUMERIC 每4位十进制数占两个字节，小数点前后数字分别计算。 NUMBER 每4位十进制数占两个字节，小数点前后数字分别计算。 序列整型 SMALLSERIAL 2 SERIAL 4 BIGSERIAL 8 LARGESERIAL 每4位十进制数占两个字节，小数点前后数字分别计算。 浮点类型 FLOAT4 4 DOUBLE PRECISION 8 FLOAT8 8 BINARY_DOUBLE 8 FLOAT[(p)] 每4位十进制数占两个字节，小数点前后数字分别计算。 DEC[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算。 INTEGER[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算。 布尔类型 布尔类型 BOOLEAN 1 字符类型 字符类型 CHAR n CHAR(n) n CHARACTER(n) n NCHAR(n) n VARCHAR(n) n CHARACTER 字符实际字节数。 VARYING(n) 字符实际字节数。 VARCHAR2(n) 字符实际字节数。 NVARCHAR(n) 字符实际字节数。 NVARCHAR2(n) 字符实际字节数。 TEXT 字符实际字节数。 CLOB 字符实际字节数。 时间类型 时间类型 DATE 8 TIME 8 TIMEZ 12 TIMESTAMP 8 TIMESTAMPZ 8 SMALLDATETIME 8 INTERVAL DAY TO SECOND 16 INTERVAL 16 RELTIME 4 ABSTIME 4 TINTERVAL 12

示例 --创建源表及触发表。 gaussdb=# CREATE TABLE test_trigger_src_tbl(id1 INT, id2 INT, id3 INT); gaussdb=# CREATE TABLE test_trigger_des_tbl(id1 INT, id2 INT, id3 INT); INSERT触发器的使用。 --创建insert触发器函数。 gaussdb=# CREATE OR REPLACE FUNCTION tri_insert_func() RETURNS TRIGGER AS $$ DECLARE BEGIN INSERT INTO test_trigger_des_tbl VALUES(NEW.id1, NEW.id2, NEW.id3); RETURN NEW; END $$ LANGUAGE plpgsql; --创建INSERT触发器。 gaussdb=# CREATE TRIGGER insert_trigger BEFORE INSERT ON test_trigger_src_tbl FOR EACH ROW EXECUTE PROCEDURE tri_insert_func(); --执行INSERT触发事件并检查触发结果。 gaussdb=# INSERT INTO test_trigger_src_tbl VALUES(100,200,300); gaussdb=# SELECT * FROM test_trigger_src_tbl; id1 | id2 | id3 -----+-----+----- 100 | 200 | 300 (1 row) gaussdb=# SELECT * FROM test_trigger_des_tbl; //查看触发操作是否生效。 id1 | id2 | id3 -----+-----+----- 100 | 200 | 300 (1 row) UPDATE触发器的使用。 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 --创建UPDATE触发器函数。 gaussdb=# CREATE OR REPLACE FUNCTION tri_update_func() RETURNS TRIGGER AS $$ DECLARE BEGIN UPDATE test_trigger_des_tbl SET id3 = NEW.id3 WHERE id1=OLD.id1; RETURN OLD; END $$ LANGUAGE plpgsql; --创建UPDATE触发器。 gaussdb=# CREATE TRIGGER update_trigger AFTER UPDATE ON test_trigger_src_tbl FOR EACH ROW EXECUTE PROCEDURE tri_update_func(); --执行UPDATE触发事件并检查触发结果。 gaussdb=# UPDATE test_trigger_src_tbl SET id3=400 WHERE id1=100; gaussdb=# SELECT * FROM test_trigger_src_tbl; id1 | id2 | id3 -----+-----+----- 100 | 200 | 400 (1 row) gaussdb=# SELECT * FROM test_trigger_des_tbl; //查看触发操作是否生效。 id1 | id2 | id3 -----+-----+----- 100 | 200 | 400 (1 row) DELETE触发器的使用。 --创建DELETE触发器函数。 gaussdb=# CREATE OR REPLACE FUNCTION TRI_DELETE_FUNC() RETURNS TRIGGER AS $$ DECLARE BEGIN DELETE FROM test_trigger_des_tbl WHERE id1=OLD.id1; RETURN OLD; END $$ LANGUAGE plpgsql; --创建DELETE触发器。 gaussdb=# CREATE TRIGGER delete_trigger BEFORE DELETE ON test_trigger_src_tbl FOR EACH ROW EXECUTE PROCEDURE tri_delete_func(); --执行DELETE触发事件并检查触发结果。 gaussdb=# DELETE FROM test_trigger_src_tbl WHERE id1=100; gaussdb=# SELECT * FROM test_trigger_src_tbl; id1 | id2 | id3 -----+-----+----- (0 rows) gaussdb=# SELECT * FROM test_trigger_des_tbl; //查看触发操作是否生效。 id1 | id2 | id3 -----+-----+----- (0 rows) 修改触发器名称。 1 2 --修改触发器的名称。 gaussdb=# ALTER TRIGGER delete_trigger ON test_trigger_src_tbl RENAME TO delete_trigger_renamed; 禁用触发器。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 --禁用insert_trigger触发器。 gaussdb=# ALTER TABLE test_trigger_src_tbl DISABLE TRIGGER insert_trigger; gaussdb=# INSERT INTO test_trigger_src_tbl VALUES(100,200,300); gaussdb=# SELECT * FROM test_trigger_src_tbl; id1 | id2 | id3 -----+-----+----- 100 | 200 | 300 (1 row) gaussdb=# SELECT * FROM test_trigger_des_tbl; //可以看到触发器没有生效。 id1 | id2 | id3 -----+-----+----- (0 rows) --禁用当前表上所有触发器。 gaussdb=# ALTER TABLE test_trigger_src_tbl DISABLE TRIGGER ALL; 删除触发器。 1 2 3 4 5 gaussdb=# DROP TRIGGER insert_trigger ON test_trigger_src_tbl; gaussdb=# DROP TRIGGER update_trigger ON test_trigger_src_tbl; gaussdb=# DROP TRIGGER delete_trigger_renamed ON test_trigger_src_tbl; 删除函数。 1 2 3 4 5 gaussdb=# DROP FUNCTION tri_insert_func; gaussdb=# DROP FUNCTION tri_update_func; gaussdb=# DROP FUNCTION tri_delete_func; 1 2 3 --删除源表及触发表。 gaussdb=# DROP TABLE test_trigger_src_tbl; gaussdb=# DROP TABLE test_trigger_des_tbl;

语法格式 1 2 3 4 5 6 7 CREATE [OR REPLACE] [ CONSTRAINT ] TRIGGER name { BEFORE | AFTER | INSTEAD OF } { event [ OR ... ] } ON table_name [ FROM referenced_table_name ] { NOT DEFERRABLE | [ DEFERRABLE ] { INITIALLY IMMEDIATE | INITIALLY DEFERRED } } [ FOR [ EACH ] { ROW | STATEMENT } ] [ WHEN ( condition ) ] [ EXECUTE PROCEDURE function_name ( arguments ) | AnonyBlock ]; 其中event包含以下几种： 1 INSERT 1 UPDATE [ OF column_name [, ... ] ] 1 DELETE 1 TRUNCATE

参数说明 OR REPLACE 可选项，指定此参数将在TRIGGER已存在的前提下修改已有的TRIGGER。 无法通过OR REPLACE语法创建或修改CONSTRAINT TRIGGER和INTERNAL TRIGGER。CONSTRAINT TRIGGER是指通过CREATE CONSTRAINT TRIGGER创建的TRIGGER，INTERNAL TRIGGER是指某些SQL语句隐式创建的TRIGGER（如给表加上外键约束会隐式创建4个trigger，这4个TRIGGER即为INTERNAL TRIGGER）。 CONSTRAINT 可选项，指定此参数将创建约束触发器，即触发器作为约束来使用。除了可以使用SET CONSTRAINTS调整触发器触发的时间之外，这与常规触发器相同。 约束触发器必须是AFTER ROW触发器。 name 触发器名称，该名称不能限定模式，因为触发器自动继承其所在表的模式，且同一个表的触发器不能重名。 对于约束触发器，使用SET CONSTRAINTS修改触发器行为时也使用此名称。 取值范围：符合标识符命名规范的字符串，且最大长度不超过63个字符。 BEFORE 触发器函数是在触发事件发生前执行。 AFTER 触发器函数是在触发事件发生后执行，约束触发器只能指定为AFTER。 INSTEAD OF 触发器函数直接替代触发事件。 event 启动触发器的事件，取值范围包括：INSERT、UPDATE、DELETE或TRUNCATE，也可以通过OR同时指定多个触发事件。 对于UPDATE事件类型，可以使用下面语法指定列： UPDATE OF column_name1 [, column_name2 ... ] 表示只有这些列作为UPDATE语句的目标列时，才会启动触发器，但是INSTEAD OF UPDATE类型不支持指定列信息。如果UPDATE OF指定的列包含生成列，当生成列依赖的列是UPDATE语句的目标列时，也会启动触发器。 table_name 需要创建触发器的表名称。 取值范围：数据库中已经存在的表名称。 referenced_table_name 约束引用的另一个表的名称。 只能为约束触发器指定，常见于外键约束。由于当前不支持外键，因此不建议使用。 取值范围：数据库中已经存在的表名称。 DEFERRABLE | NOT DEFERRABLE 约束触发器的启动时机，仅作用于约束触发器。这两个关键字设置该约束是否可推迟。 详细介绍请参见CREATE TABLE。 INITIALLY IMMEDIATE | INITIALLY DEFERRED 如果约束是可推迟的，则这个子句声明检查约束的缺省时间，仅作用于约束触发器。 详细介绍请参见CREATE TABLE。 FOR EACH ROW | FOR EACH STATEMENT 触发器的触发频率。 FOR EACH ROW是指该触发器是受触发事件影响的每一行触发一次。 FOR EACH STATEMENT是指该触发器是每个SQL语句只触发一次。 未指定时默认值为FOR EACH STATEMENT。约束触发器只能指定为FOR EACH ROW。 condition 决定是否实际执行触发器函数的条件表达式。当指定WHEN时，只有在条件返回true时才会调用该函数。 在FOR EACH ROW触发器中，WHEN条件可以通过分别写入OLD.column_name或NEW.column_name来引用旧行或新行值的列。INSERT触发器不能引用OLD，DELETE触发器不能引用NEW。 INSTEAD OF触发器不支持WHEN条件。 WHEN表达式不能包含子查询。 对于约束触发器，WHEN条件的评估不会延迟，而是在执行更新操作后立即发生。 如果条件返回值不为true，则触发器不会排队等待延迟执行。 function_name 用户定义的函数，必须声明为不带参数并返回类型为触发器，在触发器触发时执行。 arguments 执行触发器时要提供给函数的可选的以逗号分隔的参数列表。参数是文字字符串常量，简单的名称和数字常量也可以写在这里，但它们都将被转换为字符串。 请检查触发器函数的实现语言的描述，以了解如何在函数内访问这些参数。 关于触发器种类： INSTEAD OF的触发器必须标记为FOR EACH ROW，并且只能在视图上定义。 BEFORE和AFTER触发器作用在视图上时，只能标记为FOR EACH STATEMENT。 TRUNCATE类型触发器仅限FOR EACH STATEMENT。 表1 表和视图上支持的触发器种类： 触发时机 触发事件 行级 语句级 BEFORE INSERT/UPDATE/DELETE 表 表和视图 TRUNCATE 不支持 表 AFTER INSERT/UPDATE/DELETE 表 表和视图 TRUNCATE 不支持 表 INSTEAD OF INSERT/UPDATE/DELETE 视图 不支持 TRUNCATE 不支持 不支持 表2 plpgsql类型触发器函数特殊变量： 变量名 变量含义 NEW INSERT及UPDATE操作涉及tuple信息中的新值，对DELETE为空，并且对于statement级别的触发器此变量也为空。 OLD UPDATE及DELETE操作涉及tuple信息中的旧值，对INSERT为空，并且对于statement级别的触发器此变量也为空。 TG_NAME 触发器名称。 TG_WHEN 触发器触发时机（BEFORE/AFTER/INSTEAD OF）。 TG_LEVEL 触发频率（ROW/STATEMENT）。 TG_OP 触发操作（INSERT/UPDATE/DELETE/TRUNCATE）。 TG_RELID 触发器所在表OID。 TG_RELNAME 触发器所在表名（已废弃，现用TG_TABLE_NAME替代）。 TG_TABLE_NAME 触发器所在表名。 TG_TABLE_SCHEMA 触发器所在表的SCHEMA信息。 TG_NARGS 触发器函数参数个数。 TG_ARGV[] 触发器函数参数列表。

注意事项 当前仅支持在普通行存表上创建触发器，不支持在临时表、unlogged表等类型表上创建触发器。 如果为同一事件定义了多个相同类型的触发器，则按触发器的名称字母顺序触发它们。 触发器常用于多表间数据关联同步场景，对SQL执行性能影响较大，不建议在大数据量同步及对性能要求高的场景中使用。 当触发器满足如下条件时，触发语句能和触发器一起下推到DN执行并提升触发器执行性能： GUC参数enable_trigger_shipping和enable_fast_query_shipping开启。 源表触发器使用的触发器函数为plpgsql类型（推荐类型）。 源表与触发表分布键的类型、数量完全相同，均为行存表，且所属相同的NODEGROUP。 原INSERT/UPDATE/DELETE语句条件中包含所有分布键与NEW/OLD等值比较表达式。 原INSERT/UPDATE/DELETE语句在没有触发器的情况下就能query shipping。 源表上只有BEFORE INSERT FOR EACH ROW、AFTER INSERT FOR EACH ROW、BEFORE UPDATE FOR EACH ROW、AFTER UPDATE FOR EACH ROW、BEFORE DELETE FOR EACH ROW、AFTER DELETE FOR EACH ROW六类触发器，且所有触发器都可下推。 执行触发器语句时是用触发器创建者的身份进行权限判断的。 执行创建触发器操作的用户需要拥有指定表的TRIGGER权限或被授予了CREATE ANY TRIGGER权限。 BEFORE触发的行级触发器函数可以返回一个NULL值，表示忽略对该行的操作，之后的触发器将不再执行，并且不会对该行产生INSERT/UPDATE/DELETE动作。 AFTER触发器函数返回值无影响。 BEFORE DELETE的情况下，触发器函数返回值NEW等于NULL。BEFORE INSERT的情况下，触发器函数返回值OLD等于NULL。BEFORE UPDATE的情况下，触发器函数返回值只有显示为NULL才是NULL值。 对于event为INSERT/UPDATE的触发器函数，正常返回值是NEW。如果返回一个非NULL的行，将修改插入或者更新的行。对于event为DELETE的触发器函数，正常返回值是OLD。 INSTEAD OF触发器只能作用于视图，其触发器函数同样可以返回NULL值，表示随后的触发器将不再执行。

数据库对象位置函数 pg_relation_filenode(relation regclass) 描述：指定关系的文件节点数。 返回值类型：oid 备注：pg_relation_filenode接受一个表、索引、序列或压缩表的OID或者名称，并且返回当前分配给它的“filenode”数。文件节点是关系使用的文件名称的基本组件。对大多数表来说，结果和pg_class.relfilenode相同，但对确定的系统目录来说， relfilenode为0而且这个函数必须用来获取正确的值。如果传递一个没有存储的关系，比如一个视图，那么这个函数返回NULL。 pg_relation_filepath(relation regclass) 描述：指定关系的文件路径名。只能用于非段页式关系。 返回值类型：text 备注：pg_relation_filepath类似于pg_relation_filenode，但是它返回关系的整个文件路径名（相对于数据库集群的数据目录PGDATA）。 段页式关系建议使用段页式相关函数或视图，例如： SELECT e.*, f.file_name FROM gs_seg_extents e, gs_seg_datafiles f WHERE e.tablespace_name = f.tablespace_name AND e.bucketnode = f.bucketnode ADN e.file_id = f.file_id ADN e.forknum = f.forknum; get_large_table_name(relfile_node text, threshold_size_gb int8) 描述：根据表的文件编码（relfile_node）查询对应的表大小（单位为GB）是否超过阈值（threshold_size_gb），如果超过则返回模式名和表名（形式为schemaname.tablename）， 否则返回字符串'null'。 返回值类型：text pg_filenode_relation(tablespacename, relname) 描述：获取对应的tablespace和relfilenode所对应的表名。 返回类型：regclass pg_partition_filenode(partition_oid) 描述：获取到指定分区表的oid锁对应的filenode。 返回类型：oid pg_partition_filepath(partition_oid) 描述：指定分区的文件路径名。只能用于非段页式关系。 返回值类型：text 备注：段页式关系建议使用段页式相关函数或视图，例如： SELECT e.*, f.file_name FROM gs_seg_extents e, gs_seg_datafiles f WHERE e.tablespace_name = f.tablespace_name ADN e.bucketnode = f.bucketnode ADN e.file_id = f.file_id ADN e.forknum = f.forknum;

数据库对象尺寸函数 数据库对象尺寸函数计算数据库对象使用的实际磁盘空间。 pg_column_size(any) 描述：存储一个指定的数值需要的字节数（可能压缩过）。 返回值类型：int 备注：pg_column_size显示用于存储某个独立数据值的空间。 1 2 3 4 5 gaussdb=# SELECT pg_column_size(1); pg_column_size ---------------- 4 (1 row) pg_database_size(oid) 描述：指定OID代表的数据库使用的磁盘空间。 返回值类型：bigint pg_database_size(name) 描述：指定名称的数据库使用的磁盘空间。 返回值类型：bigint 备注：pg_database_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 示例： 1 2 3 4 5 gaussdb=# SELECT pg_database_size('testdb'); pg_database_size ------------------ 51590112 (1 row) 备注：pg_database_size(oid/name)对象函数查询耗时与该oid/name所对应库中的对象文件数目相关，基本呈线性关系，如需进行耗时评估，可参考以下步骤： 1）由于耗时与软硬件环境有关，因此需要以某个库（注意所选择库的对象文件数目不宜过多）测试结果为基准，根据查询耗时和库中对象文件数目计算出单对象文件所需耗时database_size_t； 2）使用select oid,* from pg_database where datname = 'database';查询得到需要查询库的oid，在表空间base和pg_tblspc目录下统计该oid目录下的所有对象文件数目database_obj_num，如该oid目录中包含目录，则需要进入查看对象文件数目，依次类推；查询目录下文件数目使用ls | wc -l； 3）根据基准测试结果中单文件数目耗时database_size_t和database下所有对象文件数目database_obj_num计算预估总耗时，总耗时=database_size_t * database_obj_num，如果时延太长需考虑调整执行超时阈值，避免出现不必要的告警。 4）以上步骤评估的是DN上获取数据库大小的耗时，在分布式下总耗时则取决于DN中对象文件数目最多或耗时最大的。 pg_relation_size(oid) 描述：指定OID代表的表或者索引所使用的磁盘空间。 返回值类型：bigint get_db_source_datasize() 描述：估算当前数据库非压缩态的数据总容量。 返回值类型：bigint 备注：调用该函数前需要做analyze。 示例： 1 2 3 4 5 6 7 gaussdb=# analyze; ANALYZE gaussdb=# SELECT get_db_source_datasize(); get_db_source_datasize ------------------------ 35384925667 (1 row) pg_relation_size(text) 描述：指定名称的表或者索引使用的磁盘空间。表名称可以用模式名修饰。 返回值类型：bigint pg_relation_size(relation regclass, fork text) 描述：指定表或索引的指定分叉树（'main'，'fsm'或'vm'）使用的磁盘空间。 返回值类型：bigint pg_relation_size(relation regclass) 描述：pg_relation_size(..., 'main')的简写。 返回值类型：bigint 备注：pg_relation_size接受一个表、索引、压缩表的OID或者名称，然后返回它们的字节大小。 pg_partition_size(oid, oid) 描述：指定OID代表的分区使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_size(text, text) 描述：指定名称的分区使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_partition_indexes_size(oid, oid) 描述：指定OID代表的分区的索引使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_indexes_size(text, text) 描述：指定名称的分区的索引使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_indexes_size(regclass) 描述：附加到指定表的索引使用的总磁盘空间。 返回值类型：bigint pg_size_pretty(bigint) 描述：将以64位整数表示的字节值转换为具有单位的易读格式。 返回值类型：text pg_size_pretty(numeric) 描述：将以数值表示的字节值转换为具有单位的易读格式。 返回值类型：text 备注：pg_size_pretty用于把其他函数的结果格式化成一种易读的格式，可以根据情况使用kB 、MB 、GB 、TB。 pg_table_size(regclass) 描述：指定的表使用的磁盘空间，不计索引（但是包含TOAST，自由空间映射和可见性映射）。 返回值类型：bigint pg_tablespace_size(oid) 描述：指定OID代表的表空间使用的磁盘空间。 返回值类型：bigint pg_tablespace_size(name) 描述：指定名称的表空间使用的磁盘空间。 返回值类型：bigint 备注： pg_tablespace_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 pg_total_relation_size(oid) 描述：指定OID代表的表使用的磁盘空间，包括索引和压缩数据。 返回值类型：bigint pg_total_relation_size(regclass) 描述：指定的表使用的总磁盘空间，包括所有的索引和TOAST数据。 返回值类型：bigint pg_total_relation_size(text) 描述：指定名称的表所使用的全部磁盘空间，包括索引和压缩数据。表名称可以用模式名修饰。 返回值类型：bigint 备注：pg_total_relation_size接受一个表或者一个压缩表的OID或者名称，然后返回以字节计的数据和所有相关的索引和压缩表的尺寸。 datalength(any) 描述：计算一个指定的数据需要的字节数（不考虑数据的管理空间和数据压缩，数据类型转换等情况）。 返回值类型：int 备注：datalength用于计算某个独立数据值的空间。 示例： gaussdb=# SELECT datalength(1); datalength ------------ 4 (1 row) 目前支持的数据类型及计算方式见下表： 数据类型 存储空间 数值类型 整数类型 TINYINT 1 SMALLINT 2 INTEGER 4 BINARY_INTEGER 4 BIGINT 8 任意精度型 DECIMAL 每4位十进制数占两个字节，小数点前后数字分别计算。 NUMERIC 每4位十进制数占两个字节，小数点前后数字分别计算。 NUMBER 每4位十进制数占两个字节，小数点前后数字分别计算。 序列整型 SMALLSERIAL 2 SERIAL 4 BIGSERIAL 8 浮点类型 FLOAT4 4 DOUBLE PRECISION 8 FLOAT8 8 BINARY_DOUBLE 8 FLOAT[(p)] 每4位十进制数占两个字节，小数点前后数字分别计算。 DEC[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算。 INTEGER[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算。 布尔类型 布尔类型 BOOLEAN 1 字符类型 字符类型 CHAR n CHAR(n) n CHARACTER(n) n NCHAR(n) n VARCHAR(n) n CHARACTER 字符实际字节数。 VARYING(n) 字符实际字节数。 VARCHAR2(n) 字符实际字节数。 NVARCHAR2(n) 字符实际字节数。 TEXT 字符实际字节数。 CLOB 字符实际字节数。 时间类型 时间类型 DATE 8 TIME 8 TIMEZ 12 TIMESTAMP 8 TIMESTAMPZ 8 SMALLDATETIME 8 INTERVAL DAY TO SECOND 16 INTERVAL 16 RELTIME 4 ABSTIME 4 TINTERVAL 12

参数说明 statement 指定要分析的SQL语句。 ANALYZE boolean | ANALYSE boolean 显示实际运行时间和其他统计数据。当两个参数同时使用时，在option中排在后面的一个生效。 取值范围： TRUE（缺省值）：显示实际运行时间和其他统计数据。 FALSE：不显示。 VERBOSE boolean 显示有关计划的额外信息。 取值范围： TRUE（缺省值）：显示额外信息。 FALSE：不显示。 COSTS boolean 包括每个规划节点的估计总成本，以及估计的行数和每行的宽度。 取值范围： TRUE（缺省值）：显示估计总成本和宽度。 FALSE：不显示。 CPU boolean 打印CPU的使用情况的信息。需要结合ANALYZE或ANALYSE选项一起使用。 取值范围： TRUE（缺省值）：显示CPU的使用情况。 FALSE：不显示。 DETAIL boolean 打印数据库节点上的信息。需要结合ANALYZE或ANALYSE选项一起使用。 取值范围： TRUE（缺省值）：打印数据库节点的信息。 FALSE：不打印。 BUFFERS boolean 包括缓冲区的使用情况的信息。需要结合ANALYZE或ANALYSE选项一起使用。 取值范围： TRUE：显示缓冲区的使用情况。 FALSE（缺省值）：不显示。 TIMING boolean 包括实际的启动时间和花费在输出节点上的时间信息。需要结合ANALYZE或ANALYSE选项一起使用。 取值范围： TRUE（缺省值）：显示启动时间和花费在输出节点上的时间信息。 FALSE：不显示。 PLAN boolean 是否将执行计划存储在plan_table中。当该选项开启时，会将执行计划存储在plan_table中，不打印到当前屏幕，因此该选项为on时，不能与其他选项同时使用。 取值范围： ON（缺省值）：将执行计划存储在plan_table中，不打印到当前屏幕。执行成功返回EXPLAIN SUCCESS。 OFF：不存储执行计划，将执行计划打印到当前屏幕。 BLOCKNAME boolean 是否显示计划的每个操作所处于的查询块。当该选项开启时，会将每个操作所处于的查询块的名字输出在Query Block列上，方便用户获取查询块名字，并使用Hint修改执行计划： TRUE（缺省值）：显示计划时，将每个操作所处于的查询块的名字输出在新增列Query Block列上。该选项需要在pretty模式下使用。见指定Hint所处于的查询块Queryblock。 FALSE：不对计划显示产生影响。 OUTLINE boolean 是否显示计划的Outline Hint信息。 ON：显示计划时，将Outline Hint显示在计划下方 。该选项需要在pretty模式下使用。见Outline Hint。 OFF（缺省值）：不显示计划的Outline Hint信息。 ADAPTCOST boolean 在Normal模式下是否显示计划的基数估计方式信息。 ON（缺省值）：Normal模式下，在计划节点上展示基数估计的方式，包含默认方式和反馈方式，不对预备语句生效。 OFF：不展示基数估计的方式信息。 FORMAT 指定输出格式。 取值范围：TEXT，XML，JSON和YAML。 默认值：TEXT。 PERFORMANCE 使用此选项时，即打印执行中的所有相关信息。下述为部分信息描述： ex c/r：代表平均每行使用cpu周期数，等于（ex cyc）/（ex row）。 ex row：执行行数。 ex cyc：代表使用的cpu周期数。 inc cyc：代表包含子节点使用的总cpu周期数。 shared hit：代表算子的share buffer命中情况。 loops：算子循环执行次数。 total_calls：生成元素总数。 remote query poll time stream gather：算子用于侦听各DN数据到达CN的网络poll时间。 deserialize time：反序列化所需时间。 estimated time：估计时间。 OPTEVAL boolean 是否显示SCAN算子（当前仅支持seqscan、indexscan、indexonlyscan、bitmapheapscan）的代价淘汰明细，当开启此开关的时候，会在执行计划中显示一个名字为Cost Evaluation Info (identified by plan id)的计划块，该选项仅仅可以和COSTS、VERBOSE、FORMAT三个选项共存。此计划块中的具体参数明细，请参考示例2。 取值范围： TRUE：显示SCAN算子的代价淘汰明细。 FALSE（缺省值）：不显示。

语法格式 显示SQL语句的执行计划，支持多种选项，对选项顺序无要求。 EXPLAIN [ ( option [, ...] ) ] statement; 其中选项option子句的语法为。 ANALYZE [ boolean ] | ANALYSE [ boolean ] | VERBOSE [ boolean ] | COSTS [ boolean ] | CPU [ boolean ] | DETAIL [ boolean ] | BUFFERS [ boolean ] | TIMING [ boolean ] | PLAN [ boolean ] | BLOCKNAME [ boolean ] | OUTLINE [ boolean ] | ADAPTCOST [ boolean ] | FORMAT { TEXT | XML | JSON | YAML } | OPTEVAL [ boolean ] 显示SQL语句的执行计划，且要按顺序给出选项。 EXPLAIN { [ ANALYZE | ANALYSE ] [ VERBOSE ] | PERFORMANCE } statement;

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

GLOBAL_REPLICATION_SLOTS GLOBAL_REPLICATION_SLOTS视图用于查看集群各节点的复制槽的信息，如表1所示。 表1 GLOBAL_REPLICATION_SLOTS字段 名称 类型 描述 node_name name 节点名称。 slot_name text 复制槽的名称。 plugin text 逻辑复制槽对应的输出插件名称。 slot_type text 复制槽的类型。 physical：物理复制槽。 logical：逻辑复制槽。 datoid oid 复制槽所在的数据库OID。 database name 复制槽所在的数据库名称。 active boolean 复制槽是否为激活状态。 t（true）：表示是。 f（false）：表示不是。 x_min xid 数据库须要为复制槽保留的最早事务的事务号。 catalog_xmin xid 数据库须要为逻辑复制槽保留的最早的涉及系统表的事务的事务号。 restart_lsn text 复制槽需要的最早xlog的物理位置。 dummy_standby boolean 预留参数。 复制槽的连接对端是否为从备。 t（true）：表示是。 f（false）：表示不是。 父主题： Utility

参数说明 IF NOT EXISTS 如果指定IF NOT EXISTS关键字，创建表前会在当前SCHEMA中查找是否已有名字相同的relation。若已有同名relation存在，则不会新建，返回NOTICE提示。未指定IF NOT EXISTS关键字时，若SCHEMA中存在同名relation，返回ERROR告警。 partition_table_name 要创建的分区表名。 取值范围：字符串，要符合标识符命名规范。 column_name 可选。新表中要创建的字段名。如果没有指定字段名，那么新表的字段名和SELECT语句输入的字段名一致。 取值范围：字符串，要符合标识符命名规范。 ENGINE B模式下支持，仅语法适配，且只支持设置InnoDB，无实际效果。 WITH ( storage_parameter [= value] [, ... ] ) 这个子句为表或索引指定一个可选的存储参数。参数的详细说明如下所示。 FILLFACTOR 一个表的填充因子（fillfactor）是一个介于10和100之间的百分数。在Ustore存储引擎下，该值得默认值为92，在Astore存储引擎下默认值为100（完全填充）。如果指定了较小的填充因子，INSERT操作仅按照填充因子指定的百分率填充表页。每个页上的剩余空间将用于在该页上更新行，这就使得UPDATE有机会在同一页上放置同一条记录的新版本，这比把新版本放置在其他页上更有效。对于一个从不更新的表将填充因子设为100是最佳选择，但是对于频繁更新的表，选择较小的填充因子则更加合适。该参数只对行存表有效。 取值范围：10~100 ORIENTATION 取值范围： ROW（缺省值）：表的数据将以行式存储。 COMPRESSION 指定表数据的压缩级别，它决定了表数据的压缩比以及压缩时间。一般来讲，压缩级别越高，压缩比也越大，压缩时间也越长；反之亦然。实际压缩比取决于加载的表数据的分布特征。 取值范围： 该参数仅支持列存压缩。 autovacuum_enabled 自动清理功能是否对该表启用。 取值范围：on/off 默认值：on autovacuum_vacuum_threshold 自动清理功能中，指定在该表中触发VACUUM所需的更新或删除的最小元组数（仅对Astore表生效）。 取值范围：0-2147483647 默认值：-1，缺省时与GUC参数autovacuum_vacuum_threshold一致。 autovacuum_analyze_threshold 自动清理功能中，指定在该表中触发ANALYZE所需的插入、更新或删除的最小元组数。 取值范围：0-2147483647 默认值：-1，缺省时与GUC参数autovacuum_analyze_threshold一致。 autovacuum_vacuum_scale_factor 自动清理功能中，指定在该表中触发VACUUM所需的插入、更新或删除元组的比例（仅对Astore表生效）。 取值范围：0.0-100.0 默认值：-1，缺省时与GUC参数autovacuum_vacuum_scale_factor一致。 autovacuum_analyze_scale_factor 自动清理功能中，指定在该表中触发ANALYZE所需的插入、更新或删除元组的比例。 取值范围：0.0-100.0 默认值：-1，缺省时与GUC参数autovacuum_analyze_scale_factor一致。 autovacuum_freeze_min_age 自动清理功能中，指定在该表参数指定了一个行版本的最小年龄，超过这个年龄的行才会被冻结。 取值范围：0-1000000000 默认值：-1，缺省时与GUC参数vacuum_freeze_min_age一致。 autovacuum_freeze_max_age 自动清理功能中，该表pg_class.relfrozenxid字段在超过多少个事务后，就会强制执行VACUUM操作。即使自动清理被禁用，系统也会启动AUTOVACUUM进程。清理操作还允许从pg_clog/子目录中删除旧文件（仅对Astore表生效）。 取值范围：100000-2000000000 默认值：-1，缺省时与GUC参数autovacuum_freeze_max_age一致。 autovacuum_freeze_table_age 自动清理功能中，该表被标记为不需要自动清理时，它将保持不变的时间。（仅对Astore表生效）。 取值范围：0-2000000000 默认值：-1，缺省时与GUC参数vacuum_freeze_table_age一致。 [ ILM ADD POLICY ROW STORE COMPRESS ADVANCED ROW AFTER n { day | month | year } OF NO MODIFICATION [ ON ( EXPR )]] 创建新表时，可以调用ILM ADD POLICY ROW STORE COMPRESS ADVANCED ROW给行存添加高级压缩策略。 AFTER n { day | month | year } OF NO MODIFICATION ：表示n天/月/年没有修改的行。 ON ( EXPR )：行级表达式，用于判断行的冷热。 TABLESPACE tablespace_name 指定新表将要在tablespace_name表空间内创建。如果没有声明，将使用默认表空间。 PARTITION BY partition_clause与partition_definition_list的各字段详细信息请参见参数说明。 SUBPARTITION BY subpartition_clause与partition_subpartition_definition_list的各字段详细信息请参见参数说明。 AS query 一个SELECT VALUES命令或者一个运行预备好的SELECT或VALUES查询的EXECUTE命令。 [ WITH [ NO ] DATA ] 创建分区表时，是否也插入查询到的数据。默认是要数据，选择“NO”参数时，则不要数据。

示例 创建一级分区表，并使用子查询数据填充分区表。 -- 创建一个源表t1，并插入3条数据。 gaussdb=# CREATE TABLE t1(a int, b int); gaussdb=# INSERT INTO t1 VALUES(8, 2); gaussdb=# INSERT INTO t1 VALUES(18, 3); gaussdb=# INSERT INTO t1 VALUES(28, 4); -- 使用CREATE TABLE PARTITION AS创建一级分区表，并使用子查询数据填充分区表。 gaussdb=# CREATE TABLE t1_part_dup PARTITION BY RANGE(a) ( PARTITION p1 VALUES LESS THAN(10), PARTITION p2 VALUES LESS THAN(20), PARTITION p3 VALUES LESS THAN(MAXVALUE) ) AS SELECT * FROM t1; gaussdb=# \d+ t1_part_dup; Table "create_table_as_partition_by.t1_part_dup" Column | Type | Modifiers | Storage | Stats target | Description --------+---------+-----------+---------+--------------+------------- a | integer | | plain | | b | integer | | plain | | Partition By RANGE(a) Number of partitions: 3 (View pg_partition to check each partition range.) Has OIDs: no Options: orientation=row, compression=no gaussdb=# SELECT a, b FROM t1_part_dup PARTITION(p1) ORDER BY a; a | b ---+--- 8 | 2 (1 row) gaussdb=# SELECT a, b FROM t1_part_dup PARTITION(p2) ORDER BY a; a | b ----+--- 18 | 3 (1 row) gaussdb=# SELECT a, b FROM t1_part_dup PARTITION(p3) ORDER BY a; a | b ----+--- 28 | 4 (1 row) gaussdb=# DROP TABLE t1,t1_part_dup; 创建二级分区表，并使用子查询数据填充分区表。 -- 创建一个源表t1，并插入6条数据 gaussdb=# CREATE TABLE t1(a int, b int, c int, d varchar, e varchar) PARTITION BY RANGE(a) SUBPARTITION BY RANGE(b) ( PARTITION p1 VALUES LESS THAN(200) (SUBPARTITION s1 VALUES LESS THAN (500), SUBPARTITION s2 VALUES LESS THAN (MAXVALUE) ), PARTITION p2 VALUES LESS THAN(500) (SUBPARTITION s3 VALUES LESS THAN (500), SUBPARTITION s4 VALUES LESS THAN (MAXVALUE) ), PARTITION p3 VALUES LESS THAN(MAXVALUE) (SUBPARTITION s5 VALUES LESS THAN (500), SUBPARTITION s6 VALUES LESS THAN (MAXVALUE) ) ); gaussdb=# INSERT INTO t1 VALUES (100, 300, 1, 'aA'); gaussdb=# INSERT INTO t1 VALUES (150, 550, 1, 'bB'); gaussdb=# INSERT INTO t1 VALUES (250, 150, 1, 'cC'); gaussdb=# INSERT INTO t1 VALUES (350, 560, 1, 'dD'); gaussdb=# INSERT INTO t1 VALUES (550, 100, 1, 'eE'); gaussdb=# INSERT INTO t1 VALUES (650, 600, 1, 'fF'); -- 使用CREATE TABLE SUBPARTITION AS创建二级分区表，并使用子查询数据填充分区表。 gaussdb=# CREATE TABLE t1_part_dup PARTITION BY RANGE(a) SUBPARTITION BY RANGE(b) ( PARTITION p1 VALUES LESS THAN(200) (SUBPARTITION s1 VALUES LESS THAN (500), SUBPARTITION s2 VALUES LESS THAN (MAXVALUE) ), PARTITION p2 VALUES LESS THAN(500) (SUBPARTITION s3 VALUES LESS THAN (500), SUBPARTITION s4 VALUES LESS THAN (MAXVALUE) ), PARTITION p3 VALUES LESS THAN(MAXVALUE) (SUBPARTITION s5 VALUES LESS THAN (500), SUBPARTITION s6 VALUES LESS THAN (MAXVALUE) ) ) AS SELECT * FROM t1; gaussdb=# \d+ t1_part_dup; Table "create_table_as_partition_by.t1_part_dup" Column | Type | Modifiers | Storage | Stats target | Description --------+-------------------+-----------+----------+--------------+------------- a | integer | | plain | | b | integer | | plain | | c | integer | | plain | | d | character varying | | extended | | e | character varying | | extended | | Partition By RANGE(a) Subpartition By RANGE(b) Number of partitions: 3 (View pg_partition to check each partition range.) Number of subpartitions: 6 (View pg_partition to check each subpartition range.) Has OIDs: no Options: orientation=row, compression=no gaussdb=# SELECT a, b, c, d, e FROM t1_part_dup ORDER BY a; a | b | c | d | e -----+-----+---+----+--- 100 | 300 | 1 | aA | 150 | 550 | 1 | bB | 250 | 150 | 1 | cC | 350 | 560 | 1 | dD | 550 | 100 | 1 | eE | 650 | 600 | 1 | fF | (6 rows) gaussdb=# SELECT a, b, c, d, e FROM t1_part_dup PARTITION(p1) ORDER BY a; a | b | c | d | e -----+-----+---+----+--- 100 | 300 | 1 | aA | 150 | 550 | 1 | bB | (2 rows) gaussdb=# SELECT a, b, c, d, e FROM t1_part_dup PARTITION(s1) ORDER BY a; a | b | c | d | e -----+-----+---+----+--- 100 | 300 | 1 | aA | (1 row) gaussdb=# DROP TABLE t1, t1_part_dup;

语法格式 使用CREATE TABLE PARTITION AS创建一级分区表，并填充子查询数据： CREATE TABLE [ IF NOT EXISTS ] partition_table_name [ (column_name [, ...] ) ] [ { ENGINE [ = ] { InnoDB | 'InnoDB' | "InnoDB" } } [ [ , ] ... ] ] [ WITH ( {storage_parameter = value} [, ... ] ) ] [ ILM ADD POLICY ROW STORE COMPRESS ADVANCED ROW AFTER n { day | month | year } OF NO MODIFICATION [ ON ( EXPR )]] [ TABLESPACE tablespace_name ] PARTITION BY partition_clause partition_definition_list AS query [ WITH [ NO ] DATA ]; 使用CREATE TABLE SUBPARTITION AS创建二级分区表，并填充子查询数据： CREATE TABLE [ IF NOT EXISTS ] partition_table_name [ (column_name [, ...] ) ] [ { ENGINE [ = ] { InnoDB | 'InnoDB' | "InnoDB" } } [ [ , ] ... ] ] [ WITH ( {storage_parameter = value} [, ... ] ) ] [ ILM ADD POLICY ROW STORE COMPRESS ADVANCED ROW AFTER n { day | month | year } OF NO MODIFICATION [ ON ( EXPR )]] [ TABLESPACE tablespace_name ] PARTITION BY partition_clause SUBPARTITION BY subpartition_clause partition_subpartition_definition_list AS query [ WITH [ NO ] DATA ]; 各个字段详细信息请参见语法格式。

语法格式 CREATE PLUGGABLE DATABASE pdb_name [ [ WITH ] { [ ENCODING [=] 'encoding' ] | [ LC_COLLATE [=] 'lc_collate' ] | [ LC_CTYPE [=] 'lc_ctype' ] | [ DBCOMPATIBILITY [=] 'compatibility_type' ] | [ DBTIMEZONE [=] 'time_zone' ] }];

注意事项 不能在事务块中执行创建PDB的DDL语句，包括CREATE、ALTER、DROP。 只能在GUC参数enable_mtd为on的状态下使用。 只能在非PDB中进行该操作。不支持在M兼容数据库中执行该命令。 操作用户需要为gs_role_create_pdb的角色，或拥有sysadmin权限。 最多可以创建128个用户PDB。 在创建数据库过程中，出现类似“Permission denied”的错误提示，可能是由于文件系统上数据目录的权限不足。出现类似“No space left on device”的错误提示，可能是由于磁盘满引起的。 在兼容性选项缺省的情况下，将创建A兼容模式PDB。 若安装数据库实例时没有指定初始化账户密码，且初始化账户名字区分大小写，且新创建的PDB为M-Compatibility模式数据库的情况下，需要在开启并使用该PDB前，先在命令行执行以下语句，使数据库将双引号中的内容作为对象引用进行处理。语句执行后再开启并使用该PDB，按照提示重置始账户密码。 gs_guc set --pdbname my_pdb -Z datanode -N all -I all -c "sql_mode = 'ansi_quotes'" # my_pdb为新建的PDB名 （该举是为保证能正常为新PDB设置账户密码，后续操作可以按需重置sql_mode参数）

参数说明 pdb_name PDB名称。 取值范围：字符串，要符合标识符命名规范。此外PDB名不能带“$”符号。 ENCODING [ = ] 'encoding' 可选。指定数据库使用的字符编码，可以是字符串（如'SQL_ASCII'）、整数编号。 不指定时，对于M-Compatibility数据库，默认使用utf8编码；其他默认使用模版数据库的编码。模板数据库template0、template1和templatea的编码默认与操作系统环境相关。template1不允许修改字符编码，因此若要变更编码，A兼容模式数据库请使用templatea创建数据库， 非A兼容模式数据库请使用template0创建数据库。 常用取值：GBK、UTF8、Latin1、GB18030等。 LC_COLLATE [ = ] 'lc_collate' 可选。指定新数据库使用的字符集。例如，通过lc_collate = 'zh_CN.gbk'设定该参数。 该参数的使用会影响到对字符串的排序顺序（如使用ORDER BY执行，以及在文本列上使用索引的顺序）。默认是使用模板数据库的字符集。该参数对M-Compatibility数据库不生效。 取值范围：操作系统支持的字符集。 LC_CTYPE [ = ] 'lc_ctype' 可选。指定新数据库使用的字符分类。例如，通过lc_ctype = 'zh_CN.gbk'设定该参数。该参数的使用会影响到字符的分类，如大写、小写和数字。默认是使用模板数据库的字符分类。该参数对M-Compatibility数据库不生效。 取值范围：操作系统支持的字符分类。 DBCOMPATIBILITY [ = ] compatibility_type 可选。指定兼容的数据库的类型，默认兼容O。 取值范围：A、C、PG、M。分别表示兼容O、TD、POSTGRES和M-Compatibility。 DBTIMEZONE [ = ] time_zone 指定新数据库的时区。例如，通过DBTIMEZONE = '+00:00'设定该参数。该参数会影响新数据库的时区。默认设置为PRC时区。 前提条件：当前连接数据库是A兼容、a_format_version='10c'、a_format_dev_version='s2'。 取值范围：操作系统支持的时区名称和缩写或者-15：59到+15：00时间戳范围。

示例 --创建集群节点，在所有CN上执行。 gaussdb=# CREATE NODE datanode1 WITH( TYPE = datanode, PREFERRED = false ); gaussdb=# CREATE NODE datanode2 WITH( TYPE = datanode, PREFERRED = false ); --查询集群DN初始状态。 gaussdb=# SELECT node_name, nodeis_preferred FROM pgxc_node WHERE node_type = 'D' ORDER BY 1; node_name | nodeis_preferred -----------+------------------ datanode1 | f datanode2 | f (2 rows) --将datanode1设为preferred DN。 gaussdb=# ALTER NODE datanode1 WITH(preferred = true); --查询集群DN变更后状态。 gaussdb=# SELECT node_name, nodeis_preferred FROM pgxc_node WHERE node_type = 'D' ORDER BY 1; node_name | nodeis_preferred -----------+------------------ datanode1 | t datanode2 | f (2 rows) --删除集群节点，连接一个CN即可。 gaussdb=# DROP NODE datanode1; gaussdb=# DROP NODE datanode2;

语法格式 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 CREATE NODE nodename WITH ( [ TYPE = nodetype,] [ HOST = hostname,] [ PORT = portnum,] [ HOST1 = 'hostname',] [ PORT1 = portnum,] [ HOSTPRIMARY [ = boolean ],] [ PRIMARY [ = boolean ],] [ PREFERRED [ = boolean ],] [ SCTP_PORT = portnum,] [ CONTROL_PORT = portnum,] [ SCTP_PORT1 = portnum,] [ CONTROL_PORT1 = portnum, ] [ NODEIS_CENTRAL [= boolean], ] [ NODEIS_ACTIVE [= boolean] ] ); PORT选项指定的端口号为节点间内部通信绑定的端口号，不同于外部客户端连接节点的端口号，可通过pgxc_node表查询。

参数说明 nodename 节点名称。 取值范围：字符串，要符合标识符命名规范。 TYPE = nodetype 指定节点的类型。 取值范围： 'coordinator' 'datanode' HOST = hostname 指定节点对应的主机名称或者IP地址。 PORT = portnum 指定节点绑定的主机端口号。 HOST1 = hostname 指定节点对应的备机名称或者IP地址。 PORT1 = portnum 指定节点绑定的备机端口号。 HOSTPRIMARY 声明主机名称或者IP地址是否为主。 取值范围： true false（默认值） PRIMARY = boolean 声明该节点是否为主节点。主节点允许做读写操作，否则只允许读操作。 取值范围： true false（默认值） PREFERRED = boolean 声明该节点是否为读操作的首选节点。 取值范围： true false（默认值） SCTP_PORT = portnum 主机TCP代理通信库使用的数据传输通道侦听端口，使用TCP协议侦听连接。

优化建议 create database 事务中不支持创建database。 ENCODING LC_COLLATE LC_CTYPE 当新建数据库Encoding与模板数据库（SQL_ASCII）不匹配（为'GBK' /'UTF8'/'LATIN1'/'GB18030'/'GB18030_2022/ZHS16GBK'）时，必须指定template [=] template0/templatea。