华为云用户手册

参数说明 function_name 要修改的函数名称。 取值范围：已存在的函数名。 argmode 标识该参数是输入、输出参数。 取值范围： IN：声明入参。 OUT：声明出参。 INOUT：声明出入参。 VARIADIC：声明数组类型的参数。 argname 参数名称。 取值范围：字符串，符合标识符命名规范。 argtype 参数类型。 取值范围：有效的类型，请参考数据类型。 CALLED ON NULL INPUT 表明该函数的某些参数是NULL的时候可以按照正常的方式调用。缺省时与指定此参数的作用相同。 RETURNS NULL ON NULL INPUT STRICT STRICT用于指定如果函数的某个参数是NULL，此函数总是返回NULL。如果声明了这个参数，则如果存在NULL参数时不会执行该函数，而只是自动假设一个NULL结果。 RETURNS NULL ON NULL INPUT和STRICT的功能相同。 IMMUTABLE 表示该函数在给出同样的参数值时总是返回同样的结果。 STABLE 表示该函数不能修改数据库，对相同参数值，在同一次表扫描里，该函数的返回值不变，但是返回值可能在不同SQL语句之间变化。 VOLATILE 表示该函数值可以在一次表扫描内改变，不会做任何优化。 SHIPPABLE NOT SHIPPABLE 表示该函数是否可以下推到DN上执行。 对于IMMUTABLE类型的函数，函数始终可以下推到DN上执行。 对于STABLE/VOLATILE类型的函数，仅当函数的属性是SHIPPABLE的时候，函数可以下推到DN执行。 LEAKPROOF 表示该函数没有副作用，指出参数只包括返回值。LEAKPROOF只能由系统管理员设置。 EXTERNAL （可选）目的是和SQL兼容，这个特性适合于所有函数，而不仅是外部函数 SECURITY INVOKER AUTHID CURRENT_USER 表明该函数将以调用它的用户的权限执行。缺省时与指定此参数的作用相同。 SECURITY INVOKER和AUTHID CURRENT_USER的功能相同。 SECURITY DEFINER AUTHID DEFINER 声明该函数将以创建它的用户的权限执行。 AUTHID DEFINER和SECURITY DEFINER的功能相同。 COST execution_cost 用来估计函数的执行成本。 execution_cost以cpu_operator_cost为单位。 取值范围：正数。 ROWS result_rows 估计函数返回的行数。用于函数返回的是一个集合。 取值范围：正数，默认值是1000行。 configuration_parameter value 把指定的数据库会话参数值设置为给定的值。如果value是DEFAULT或者RESET，则在新的会话中使用系统的缺省设置。OFF关闭设置。 取值范围：字符串。 DEFAULT OFF RESET 用户指定的值：需要满足修改参数的取值限制。 FROM CURRENT 取当前会话中的值设置为configuration_parameter的值。 new_name 函数的新名称。要修改函数的所属模式，必须拥有新模式的CREATE权限。 取值范围：字符串，符合标识符命名规范。 new_owner 函数的新所有者。要修改函数的所有者，新所有者必须拥有该函数所属模式的CREATE权限。需要注意注意的是：仅有初始化用户才可以将函数的owner设置为初始化用户。 取值范围：已存在的用户角色。 new_schema 函数的新模式。 取值范围：已存在的模式。

语法格式 修改自定义函数的附加参数。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) action [ ... ] [ RESTRICT ]; 其中附加参数action子句语法为： 1 2 3 4 5 6 7 8 9 10 11 {CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT} | {IMMUTABLE | STABLE | VOLATILE} | {SHIPPABLE | NOT SHIPPABLE} | {NOT FENCED | FENCED} | [ NOT ] LEAKPROOF | { [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER } | AUTHID { DEFINER | CURRENT_USER } | COST execution_cost | ROWS result_rows | SET configuration_parameter { { TO | = } { value | DEFAULT }| FROM CURRENT} | RESET {configuration_parameter | ALL} 修改自定义函数的名称。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) RENAME TO new_name; 修改自定义函数的所有者。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) OWNER TO new_owner; 修改自定义函数的模式。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) SET SCHEMA new_schema;

注意事项 只有函数的所有者或者被授予了函数ALTER权限的用户才能执行ALTER FUNCTION命令，系统管理员默认拥有该权限。针对所要修改属性的不同，对其还有以下权限约束： 如果函数中涉及对临时表相关的操作，则无法使用ALTER FUNCTION。 修改函数的所有者或修改函数的模式，当前用户必须是该函数的所有者或者系统管理员，且该用户是新所有者角色的成员。 只有系统管理员和初始化用户可以将function的schema修改成public。

DBE_PLDEBUGGER.info_code debug端调试过程中，调用info_code，查看指定存储过程的源语句和各行对应的行号，行号从函数体开始，函数头部分行号为空，如表1所示。 表1 info_code入参和返回值列表 名称 类型 描述 funcoid IN oid 函数id。 lineno OUT integer 行号。 query OUT text 源语句。 canbreak OUT bool 当前行是否支持断点。 父主题： DBE_PLDEBUGGER Schema

PG_STAT_USER_FUNCTIONS PG_STAT_USER_FUNCTIONS视图显示命名空间中用户自定义函数（函数语言为非内部语言）的状态信息。 表1 PG_STAT_USER_FUNCTIONS字段 名称 类型 描述 funcid oid 函数标识。 schemaname name 模式的名称。 funcname name 函数名称。 calls bigint 函数被调用的次数。 total_time double precision 函数的总执行时长。 self_time double precision 当前线程调用函数的总的时长。 父主题： 其他系统视图

PG_OPERATOR PG_OPERATOR系统表存储有关操作符的信息。 表1 PG_OPERATOR字段 名称 类型 引用 描述 oid oid - 行标识符（隐含属性，必须明确选择）。 oprname name - 操作符的名称。 oprnamespace oid PG_NAMESPACE.oid 包含此操作符的名称空间的OID。 oprowner oid PG_AUTHID.oid 操作符所有者。 oprkind "char" - b：表示中缀(“两边”）。 l：表示前缀(“左边”)。 r：表示后缀(“右边”)。 oprcanmerge boolean - 这个操作符是否支持合并连接。 t（true）：表示支持合并连接。 f（false）：表示不支持合并连接。 oprcanhash boolean - 这个操作符是否支持Hash连接。 t（true）：表示支持Hash连接。 f（false）：表示不支持Hash连接。 oprleft oid PG_TYPE.oid 左操作数的类型。 oprright oid PG_TYPE.oid 右操作数的类型。 oprresult oid PG_TYPE.oid 结果类型。 oprcom oid PG_OPERATOR.oid 如果存在的话，值为此操作符的交换符。不存在的话，值为0。 oprnegate oid PG_OPERATOR.oid 如果存在的话，值为此操作符的反转器。不存在的话，值为0。 oprcode regproc PG_PROC.proname 实现这个操作符的函数。 oprrest regproc PG_PROC.proname 此操作符的约束选择性计算函数。 oprjoin regproc PG_PROC.proname 此操作符的连接选择性计算函数。 父主题： 其他系统表

示例 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 gaussdb=# CALL DBE_ILM_ADMIN.CUSTOMIZE_ILM(1, 15); customize_ilm --------------- (1 row) gaussdb=# SELECT * FROM gs_adm_ilmparameters; name | value ----------------------------------+------- EXECUTION_INTERVAL | 15 RETENTION_TIME | 30 ENABLED | 1 POLICY_TIME | 0 ABS_JOBLIMIT | 10 JOB_SIZELIMIT | 1024 WIND_DURATION | 240 BLOCK_LIMITS | 40 ENABLE_META_COMPRESSION | 0 SAMPLE_MIN | 10 SAMPLE_MAX | 10 CONST_PRIO | 40 CONST_THRESHOLD | 90 EQVALUE_PRIO | 60 EQVALUE_THRESHOLD | 80 ENABLE_DELTA_ENCODE_SWITCH | 1 LZ4_COMPRESSION_LEVEL | 0 ENABLE_LZ4_PARTIAL_DECOMPRESSION | 1 (18 rows)

接口介绍 服务于ILM策略实施，实现ADO的后台调度以及各个限流参数的控制。 表1 DBE_ILM_ADMIN 接口名称 描述 CUSTOMIZE_ILM 根据输入参数定制ILM策略属性。 DISABLE_ILM 关闭后台调度。 ENABLE_ILM 开启后台调度。 当并发量较大时，执行DBE_ILM_ADMIN.DISABLE_ILM或DBE_ILM_ADMIN.ENABLE_ILM可能会提示资源繁忙，稍后重试即可。提示内容为“Resources are busy, please try again later.”。 DBE_ILM_ADMIN.CUSTOMIZE_ILM 根据输入参数定制ILM策略属性，原型为： 1 2 3 DBE_ILM_ADMIN.CUSTOMIZE_ILM( PA RAM IN NUMBER, VAL IN NUMBER); 表2 DBE_ILM_ADMIN.CUSTOMIZE_ILM接口参数说明 参数 描述 PARAM 参数序号。 VAL 参数取值。 表3 DBE_ILM_ADMIN.CUSTOMIZE_ILM接口参数范围 参数编号 参数值 描述 1 EXECUTION_INTERVAL ADO Task的执行频率，单位分钟，默认值15。取值范围为大于等于1小于等于2147483647的整数或浮点数，作用时向下取整。 2 RETENTION_TIME ADO相关历史的保留时长，单位天，默认值30。取值范围为大于等于1小于等于2147483647的整数或浮点数，作用时向下取整。 7 ENABLE 后台调度的状态，不支持在该接口中修改，提示Invalid argument value, ENABLED should be change by calling DBE_ILM_ADMIN.ENABLE_ILM and DBE_ILM_ADMIN.DISABLE_ILM。应使用disable_ilm()和enable()修改。 11 POLICY_TIME 控制ADO的条件单位是天还是秒，秒仅用来做测试用。取值为： 0: ILM_POLICY_IN_DAYS（默认值） 1:ILM_POLICY_IN_SECONDS 12 ABS_JOBLIMIT 控制一次ADO Task最多生成多少个ADO Job。取值范围为大于等于0小于等于2147483647的整数或浮点数，作用时向下取整。 13 JOB_SIZELIMIT 控制单个ADO Job可以处理的最大字节数，单位兆。取值范围为大于等于1小于等于2147483647的整数或浮点数，作用时向下取整。 14 WIND_DURATION 维护窗口持续时长，单位分钟，默认240分钟（4小时）；取值范围为大于等于0小于1440（24小时）的整数。 15 BLOCK_LIMITS 控制实例级的行存压缩速率上限，默认是40；取值范围是0到10000（0表示不限制）；单位是block/ms，表示每毫秒最多压缩多少个block。 16 ENABLE_META_COMPRESSION 是否开启header压缩，默认为0，取值范围为0(关闭)和1(开启)。 说明： 设置此参数为1时，对于单行数据较短的表，压缩率会有一定提升，但是访问压缩行的性能会有较大幅度的下降。若数据库多是单行数据较长的表，不建议开启此参数。 17 SAMPLE_MIN 常量编码和等值编码采样步长最小值，默认为10，取值范围[1, 100]，支持小数输入，小数会自动向下取整。 18 SAMPLE_MAX 常量编码和等值编码采样步长最大值，默认为10，取值范围[1, 100]，支持小数输入，小数会自动向下取整。 19 CONST_PRIO 常量编码优先级，默认为40，取值范围[0, 100]，100表示关闭常量编码，支持小数输入，小数会自动向下取整。 20 CONST_THRESHOLD 常量编码阈值，默认为90，取值范围[1, 100]，表示一列常量值的占比超过该阈值时进行常量编码，支持小数输入，小数会自动向下取整。 21 EQVALUE_PRIO 等值编码优先级，默认为60，取值范围[0, 100]，100表示关闭等值编码，支持小数输入，小数会自动向下取整。 22 EQVALUE_THRESHOLD 等值编码阈值，默认为80，取值范围[1, 100]，表示两列数据的等值比例超过该阈值时进行等值编码，支持小数输入，小数会自动向下取整。 23 ENABLE_DELTA_ENCODE_SWITCH 差值编码开关，默认为1，支持小数输入，0表示关闭，1表示开启，小数会自动向下取整。 24 LZ4_COMPRESSION_LEVEL lz4压缩等级，默认为0，取值范围[0, 16]，支持小数输入，小数会自动向下取整。 25 ENABLE_LZ4_PARTIAL_DECOMPRESSION 部分解压开关，默认为1，支持小数输入，0表示关闭，1表示开启，小数会自动向下取整。 DBE_ILM_ADMIN.DISABLE_ILM 关闭后台调度，原型为： 1 gaussdb=# DBE_ILM_ADMIN.DISABLE_ILM(); DBE_ILM_ADMIN.ENABLE_ILM 开启后台调度，原型为： 1 gaussdb=# DBE_ILM_ADMIN.ENABLE_ILM(); 注意：后台调度生效需要先在数据库运维平台打开guc参数：enable_ilm。

数据库连接控制函数 数据库连接控制函数控制与数据库服务器的连接。一个应用程序一次可以与多个服务器建立连接，如一个客户端连接多个数据库的场景。支持每个连接都是用一个从函数PQconnectdb、PQconnectdbParams或PQsetdbLogin获得的PGconn对象表示。也可以支持PQconnectStart接口结合异步PQconnectPoll轮询方式获得连接对象。注意，这些函数总是返回一个非空的对象指针，除非内存分配失败，会返回一个空的指针。连接建立的接口保存在PGconn对象中，可以调用PQstatus函数来检查返回值查看连接是否成功。由于PGconn对象将SSL上下文存储在线程本地，所以PGconn的释放线程应与申请线程一致。 PQconnectdbParams PQconnectdb PQconninfoParse PQconnectStart PQerrorMessage PQsetdbLogin PQfinish PQreset PQstatus 父主题： libpq接口参考

DBE_SQL_UTIL.create_remote_abort_sql_patch create_remote_abort_sql_patch是用于指定CN创建避险SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.create_remote_abort_sql_patch入参和返回值列表 参数 类型 描述 node_name IN text 目标节点名。 patch_name IN name PATCH名称。 unique_sql_id IN bigint 查询全局唯一id。 description IN text PATCH的备注，默认值为NULL。 enabled IN bool PATCH是否生效，默认值为true。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

MY_TABLESPA CES MY_TABLESPACES视图显示用户拥有存储对象的表空间的描述信息。默认所有用户都可以访问。该视图同时存在于PG_CATA LOG 和SYS Schema下。A数据库与 GaussDB 逻辑结构特性不一致。 表1 MY_TABLESPACES字段 名称 类型 描述 tablespace_name character varying(64) 表空间名称。 block_size numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extents numeric 暂不支持，值为NULL。 max_extents numeric 暂不支持，值为NULL。 max_size numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 min_extlen numeric 暂不支持，值为NULL。 contents character varying(9) 暂不支持，值为NULL。 status character varying(9) 表空间状态，默认为ONLINE（在线）。 logging character varying(9) 暂不支持，值为NULL。 force_logging character varying(3) 暂不支持，值为NULL。 extent_management character varying(10) 暂不支持，值为NULL。 allocation_type character varying(9) 暂不支持，值为NULL。 segment_space_management character varying(6) 暂不支持，值为NULL。 def_tab_compression character varying(8) 暂不支持，值为NULL。 retention character varying(11) 暂不支持，值为NULL。 bigfile character varying(3) 暂不支持，值为NULL。 predicate_evaluation character varying(7) 暂不支持，值为NULL。 encrypted character varying(3) 暂不支持，值为NULL。 compress_for character varying(30) 暂不支持，值为NULL。 def_inmemory character varying(8) 暂不支持，值为NULL。 def_inmemory_priority character varying(8) 暂不支持，值为NULL。 def_inmemory_distribute character varying(15) 暂不支持，值为NULL。 def_inmemory_compression character varying(17) 暂不支持，值为NULL。 def_inmemory_duplicate character varying(13) 暂不支持，值为NULL。 shared character varying(12) 暂不支持，值为NULL。 def_index_compression character varying(8) 暂不支持，值为NULL。 index_compress_for character varying(13) 暂不支持，值为NULL。 def_cellmemory character varying(14) 暂不支持，值为NULL。 def_inmemory_service character varying(12) 暂不支持，值为NULL。 def_inmemory_service_name character varying(1000) 暂不支持，值为NULL。 lost_write_protect character varying(7) 暂不支持，值为NULL。 chunk_tablespace character varying(1) 暂不支持，值为NULL。 父主题： 其他系统视图

长查询和长事务调优 长查询或长事务将影响autovacuum对旧版本的清理，数据更新操作产生的旧版本将不能被及时清理。 数据访问时，需要遍历旧版本进行可见性判断，以便确定对当前查询快照可见的版本。长查询或长事务持续的时间越久，不能及时清理的旧版本就越多，对访问性能的影响也越大。极端场景下，例如考察基于较小数据量的索引点查吞吐的场景，旧版本增多将导致吞吐下降明显，性能受损可能在50%以上。 另外，不能及时清理旧版本，也会导致额外的存储空间占用，出现表膨胀、索引膨胀现象，数据访问时，额外的IO增加，也将会对性能产生一定影响。 Astore索引和表数据都采用非原地更新，更新索引键或非索引键，将产生索引旧版本和数据旧版本。Ustore索引采用非原地更新、数据采用原地更新，更新索引键将产生索引旧版本和数据旧版本，更新非索引键只产生数据旧版本。 长查询和长事务会Astore和Ustore的访问性能都会产生影响。 用户在业务实现上，应尽量避免长查询或长事务，可通过访问pg_stat_activity、pg_running_xacts观察系统中是否存在长查询或长事务，然后利用pg_cancel_backend(pid int)、pg_terminate_backend(pid int)函数取消掉长查询或长事务。 父主题： 典型SQL调优点

javax.naming.Context javax.naming.Context是连接配置的上下文接口。 表1 对javax.naming.Context的支持情况 方法名 返回值类型 支持JDBC4 支持计划外ALT bind(Name name, Object obj) void Yes Yes bind(String name, Object obj) void Yes Yes lookup(Name name) Object Yes Yes lookup(String name) Object Yes Yes rebind(Name name, Object obj) void Yes Yes rebind(String name, Object obj) void Yes Yes rename(Name oldName, Name newName) void Yes Yes rename(String oldName, String newName) void Yes Yes unbind(Name name) void Yes Yes unbind(String name) void Yes Yes 父主题： JDBC接口参考

注意事项 当分配的句柄并非环境句柄时，如果SQLAllocHandle返回的值为SQL_ERROR，则它会将OutputHandlePtr的值设置为SQL_NULL_HDBC、SQL_NULL_HSTMT或SQL_NULL_HDESC。之后，通过调用带有适当参数的SQLGetDiagRec，其中HandleType和Handle被设置为IntputHandle的值，可得到相关的SQLSTATE值，通过SQLSTATE值可以查出调用此函数的具体信息。

参数 表1 SQLAllocHandle参数 关键字 参数说明 HandleType 由SQLAllocHandle分配的句柄类型。必须为下列值之一： SQL_HANDLE_ENV（环境句柄） SQL_HANDLE_DBC（连接句柄） SQL_HANDLE_STMT（语句句柄） SQL_HANDLE_DESC（描述句柄） 申请句柄顺序为，先申请环境句柄，再申请连接句柄，最后申请语句句柄。后申请的句柄依赖它前面申请的句柄。 InputHandle 将要分配的新句柄的类型。InputHandle参数用于指定创建句柄的父句柄，以建立句柄之间的层次关系。不同类型的句柄有不同的层次关系，InputHandle参数用于指定这种关系。 如果HandleType为SQL_HANDLE_ENV，则该值为SQL_NULL_HANDLE，表示没有父句柄。 如果HandleType为SQL_HANDLE_DBC，则它一定是一个环境句柄，表示该连接句柄是在该环境下创建的。 如果HandleType为SQL_HANDLE_STMT或SQL_HANDLE_DESC，则它一定是一个连接句柄，表示该语句句柄是在该连接下创建的。 OutputHandlePtr 输出参数：OutputHandlePtr是一个指向SQLHANDLE类型的指针，用于返回分配的新句柄。

参数 表1 PQsetdbLogin参数 关键字 参数说明 pghost 要连接的主机名，请参见连接参数描述的host字段。 pgport 主机服务器的端口号，请参见连接参数描述的port字段。 pgoptions 添加命令行选项以在运行时发送到服务器，请参见连接参数描述的options字段。 pgtty 忽略（以前该选项声明服务器日志的输出方向）。 dbName 要连接的数据库名，请参见连接参数描述的dbname字段。 login 要连接的用户名，请参见连接参数描述的user字段。 pwd 如果服务器要求密码认证，所用的密码，请参见连接参数描述的password字段。

参数说明 client_master_key_name 该参数作为密钥对象名，在同一命名空间下，需满足命名唯一性约束。 取值范围：字符串，需符合标识符命名规范。 KEY_STORE 外部密钥管理者。取值见表1。 当KEY_STORE为user_token时，无需用户提供KEY_PATH参数。 KEY_PATH 由外部密钥管理者管理某个的密钥，不同密钥管理者格式不同。取值为字符串，详见表1。字符串由单引号或双引号包含，如果字符串长度超过64，则只能使用单引号包含。 ALGORITHM 密钥用于何种加密算法。取值见表1。 表1 针对不同密钥管理者的参数值 KEY_STORE KEY_PATH ALGORITHM huawei_kms 格式：‘{KmsApiUrl}/{密钥ID}' 参考：'https://kms.{项目}.myhuaweicloud.com/v1.0/{项目ID}/kms/{密钥ID}' 示例：'https://kms.cn-north-4.myhuaweicloud.com/v1.0/00000000000000000000000000000000/kms/00000000-0000-0000-0000-000000000000' AES_256 SM4 user_token 不需用户提供KEY_PATH AES_256_CBC AES_256_GCM SM4

字符类型 GaussDB支持的字符类型如表1所示 。字符串操作符和相关的内置函数请参见字符处理函数和操作符。 表1 字符类型 名称 描述 存储空间 CHAR(n) CHARACTER(n) NCHAR(n) 定长字符串，不足补空格。n是指字节长度，如不带精度n，默认精度为1。 n最大为10485760（即10MB）。 当sql_compatibility = 'MYSQL'时，设置参数b_format_version = '5.7'、b_format_dev_version = 's1'后： 类型：n指字符长度，区间[0,10485760]。如不带精度n，默认精度为1。定长字符串，不足补充空格。 输入： 作为表列和临时变量的数据类型：输入字符串字符个数在范围内可以正常输入，sql_mode参数值包含“strict_trans_tables”时，超过范围直接报错，否则按n最大字符长度截断处理并告警。 输出： 作为表列和临时变量的数据类型：sql_mode参数值包含“pad_char_to_full_length”时，输出带有尾部空格的字符串，否则输出不带尾部空格的字符串。 作为函数参数和返回值，存储过程的参数：不支持长度校验（例如：自定义函数入参为CHAR(5)类型，输入一个字符串'123456'，不校验长度，可以直接传入参数）。 最大为10M个字符。 VARCHAR(n) CHARACTER VARYING(n) 变长字符串。PG兼容模式下，n是字符长度。其他兼容模式下，n是指字节长度。 n最大为10485760（即10MB）。 不带n时，最大存储字节长度为1GB-85-4(存储长度参数的空间)-其余列长度，比如(a int, b varchar, c int)，varchar最大长度为1GB-85-4(存储长度参数的空间)-4(a列int的长度)-4(c列int的长度)=1,073,741,727‬。 当sql_compatibility = 'MYSQL'时，设置参数b_format_version = '5.7'、b_format_dev_version = 's1'后： n指字符长度，区间[0,10485760]，如不带精度n，默认为不限制长度，长度与TEXT类型相同。 输入： 作为表列和临时变量的数据类型：输入字符串字符个数在范围内可以正常输入，sql_mode参数值包含“strict_trans_tables”时，超过范围直接报错，否则按n最大字符长度截断处理并告警。 输出：原字符串输出。 n最大为10485760（即10MB）。 不带n时，最大存储字节长度为1GB-85-4(存储长度参数的空间)-其余列长度，比如(a int, b varchar, c int)，varchar最大长度为1GB-85-4(存储长度参数的空间)-4(a列int的长度)-4(c列int的长度)=1,073,741,727‬。 VARCHAR2(n) 变长字符串。是VARCHAR(n)类型的别名。 n最大为10485760（即10MB）。 不带n时，最大存储字节长度为1GB-85-4(存储长度参数的空间)-其余列长度，比如(a int, b varchar2, c int)，varchar2最大长度为1GB-85-4(存储长度参数的空间)-4(a列int的长度)-4(c列int的长度)=1,073,741,727‬。 NVARCHAR2(n) 变长字符串。在SQL_ASCII字符集下，n表示的字节；在非SQL_ASCII字符集下，n表示的是字符。 n最大为10485760（即10MB）。 不带n时，最大存储字节长度为1GB-85-4(存储长度参数的空间)-其余列长度，比如(a int, b nvarchar2, c int)，nvarchar2最大长度为1GB-85-4(存储长度参数的空间)-4(a列int的长度)-4(c列int的长度)=1,073,741,727‬。 TEXT 变长字符串。 最大存储字节长度为1GB-85-4(存储长度参数的空间)-其余列长度，比如(a int, b text, c int)，text最大长度为1GB-85-4(存储长度参数的空间)-4(a列int的长度)-4(c列int的长度)=1,073,741,727‬。 CLOB 文本大对象。 在ustore下，最大为1GB-1，但还需要考虑到列描述头信息的大小，以及列所在元组的大小限制（也小于1GB-1），因此CLOB类型最大值可能小于1GB-1。 TINYTEXT MEDIUMTEXT LONGTEXT 当sql_compatibility = 'MYSQL'时，设置参数b_format_version = '5.7'、b_format_dev_version = 's1'后可以使用这些类型。 类型转换成TEXT类型，使用场景与TEXT类型相同。 最大为1GB-1，但还需要考虑到列描述头信息的大小，以及列所在元组的大小限制（也小于1GB-1），因此TEXT类型最大值可能小于1GB-1。 除了每列的大小限制以外，每个元组的总大小也不可超过1GB-1字节，主要受列的控制头信息、元组控制头信息以及元组中是否存在NULL字段等影响。 NCHAR为bpchar类型的别名，VARCHAR2(n)为VARCHAR(n)类型的别名。 超过1GB的clob只有dbe_lob相关高级包支持，系统函数不支持大于1GB clob。 在A兼容模式下，默认将接收到的空字符串转换为null。 GaussDB还支持另外两种定长字符类型，如表2所示。name类型只用在内部系统表中，作为存储标识符，不建议普通用户使用。该类型长度当前定为64字节（63可用字符加结束符）。类型“char”只用了一个字节的存储空间，在系统内部主要用于系统表，主要作为简单化的枚举类型使用。 表2 特殊字符类型 名称 描述 存储空间 name 用于对象名的内部类型。 64字节。 "char" 单字节内部类型。 1字节。 父主题： 数据类型

PG_TS_CONFIG PG_TS_CONFIG系统表包含表示文本搜索配置的记录。其中的每一条配置包含一个特定的文本搜索解析器和字典映射的列表。 解析器在PG_TS_CONFIG记录中显示，但是字典映射的标记是由PG_TS_CONFIG_MAP里面的辅助记录定义的。 表1 PG_TS_CONFIG字段 名称 类型 引用 描述 oid oid - 行标识符（隐含属性，必须明确选择）。 cfgname name - 文本搜索配置名。 cfgnamespace oid PG_NAMESPACE.oid 包含这个配置的名称空间的OID。 cfgowner oid PG_AUTHID.oid 配置的所有者。 cfgparser oid PG_TS_PARSER.oid 这个配置的文本搜索解析器的OID。 cfoptions text[] - 分词相关配置选项。 父主题： 其他系统表

简单查询 简单查询指从一个或多个表或视图中检索一个或多个列数据的操作。 --建表并插入数据。 gaussdb=# CREATE TABLE student( sid INT PRIMARY KEY, class INT, name VARCHAR(50), sex INT CHECK(sex = 0 OR sex = 1) --性别，1为男，0为女 ); gaussdb=# INSERT INTO student (sid, class, name, sex) VALUES (1, 1, 'Michael', 0); gaussdb=# INSERT INTO student (sid, class, name, sex) VALUES (2, 2, 'Bob', 1); gaussdb=# INSERT INTO student (sid, class, name, sex) VALUES (3, 2, 'Gary', 0); --查询部分列。 gaussdb=# SELECT sid, name FROM student; sid | name -----+--------- 1 | michael 2 | bob 3 | Gary (3 rows) --查询所有列。 gaussdb=# SELECT * FROM student; sid | class | name | sex -----+-------+---------+----- 1 | 1 | michael | 0 2 | 2 | bob | 1 3 | 2 | Gary | 0 (3 rows) --给列取别名。 gaussdb=# SELECT sid student_id, name FROM student; student_id | name ------------+--------- 1 | michael 2 | bob 3 | Gary (3 rows) --删除。 gaussdb=# DROP TABLE student; 父主题： SELECT

PG_APP_WORKLOADGROUP_MAPPING PG_APP_WORKLOADGROUP_MAPPING系统表提供了数据库负载映射组的信息。 表1 PG_APP_WORKLOADGROUP_MAPPING字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 appname name 应用名称。 workload_gpname name 映射到的负载组名称。 父主题： 负载管理

MY_AUDIT_TRAIL MY_AUDIT_TRAIL视图显示与当前用户有关的标准审计跟踪条目，GaussDB审计信息主要通过gs_query_audit()函数。该视图同时存在于PG_CATALOG和SYS Schema下，仅拥有AUDITADMIN属性及MY_AUDIT_TRAIL的SELECT权限的用户才可以查看审计信息；三权分立未开启时，拥有SYSADMIN属性的用户也可以查看审计信息。GaussDB的action_name字段与A数据库审计动作不一致，transactionid字段与A数据库中transactionid数据的类型保持一致，GaussDB的sql_text字段为解析后SQL描述语句，不完全与执行的SQL语句相同。 表1 MY_AUDIT_TRAIL字段 名称 类型 描述 os_username character varying(255) 暂不支持，值为NULL。 username character varying(128) 操作被审计的用户的名称，不是用户ID。 userhost character varying(128) 暂不支持，值为NULL。 terminal character varying(255) 暂不支持，值为NULL。 timestamp timestamp(0) without time zone 在本地数据库会话时区中创建审计跟踪条目的日期和时间（由审计会话创建的条目的用户登录日期和时间）。 owner character varying(128) 受操作影响的对象的创建者。 obj_name character varying(128) 受操作影响的对象的名称。 action numeric 暂不支持，值为NULL。 action_name character varying(28) action列中的数字代码对应的action类型名称。 new_owner character varying(128) 暂不支持，值为NULL。 new_name character varying(128) 暂不支持，值为NULL。 obj_privilege character varying(32) 暂不支持，值为NULL。 sys_privilege character varying(40) 暂不支持，值为NULL。 admin_option character varying(1) 暂不支持，值为NULL。 grantee character varying(128) 暂不支持，值为NULL。 audit_option character varying(40) 暂不支持，值为NULL。 ses_actions character varying(19) 暂不支持，值为NULL。 logoff_time timestamp(0) without time zone 暂不支持，值为NULL。 logoff_lread numeric 暂不支持，值为NULL。 logoff_pread numeric 暂不支持，值为NULL。 logoff_lwrite numeric 暂不支持，值为NULL。 logoff_dlock character varying(40) 暂不支持，值为NULL。 comment_text character varying(4000) 暂不支持，值为NULL。 sessionid numeric 暂不支持，值为NULL。 entryid numeric 暂不支持，值为NULL。 statementid numeric 暂不支持，值为NULL。 returncode numeric 暂不支持，值为NULL。 priv_used character varying(40) 暂不支持，值为NULL。 client_id character varying(128) 暂不支持，值为NULL。 econtext_id character varying(64) 暂不支持，值为NULL。 session_cpu numeric 暂不支持，值为NULL。 extended_timestamp timestamp(6) with time zone 创建审计跟踪条目的时间戳（由创建的条目的用户登录时间戳UTC（协调通用）中的审计会话时间）时区。 proxy_sessionid numeric 暂不支持，值为NULL。 global_uid character varying(32) 暂不支持，值为NULL。 instance_number numeric 暂不支持，值为NULL。 os_process character varying(16) 暂不支持，值为NULL。 transactionid text 访问或修改对象的事务的事务标识符。 scn numeric 暂不支持，值为NULL。 sql_bind nvarchar2(2000) 暂不支持，值为NULL。 sql_text nvarchar2 查询的SQL文本。 obj_edition_name character varying(128) 暂不支持，值为NULL。 dbid numeric 暂不支持，值为NULL。 rls_info clob 暂不支持，值为NULL。 current_user character varying(128) 暂不支持，值为NULL。 父主题： 其他系统视图

GS_GET_CONTROL_GROUP_INFO GS_GET_CONTROL_GROUP_INFO视图显示所有控制组的信息。默认只有系统管理员权限才可以访问。 表1 GS_GET_CONTROL_GROUP_INFO字段 名称 类型 描述 group_name text 控制组的名称。 group_type text 控制组的类型。 GROUP_NONE：无分组。 GROUP_TOP：顶级分组。 GROUP_CLASS：该资源的类分组，不控制任何线程。 GROUP_BAKWD：后端线程控制组。 GROUP_DEFWD：默认控制组，仅控制该级别的查询线程。 GROUP_TSWD：每个用户的分时控制组，控制最底层的查询线程。 gid bigint 控制组ID。 classgid bigint Workload所属Class的控制组ID。 class text Class控制组。 group_workload text Workload控制组。 shares bigint 控制组分配的CPU资源配额。 limits bigint 控制组分配的CPU资源限额。 wdlevel bigint Workload控制组层级。 cpucores text 控制组使用的CPU核的信息。 nodegroup text node group的名称。 group_kind text node group的类型，取值包括i，n，v，e。 i：表示installation node group。 n：表示普通集群node group。 e：表示弹性集群。 父主题： 其他系统视图

原因分析 A模式数据库能够插入成功并通过校验：Hibernate框架在校验数据时，通过判断插入数据类型java.lang.long的TypeCode，与表结构的number类型的TypeCode进行对比，结果不一致，随后会把插入数据的long类型的sqlType与表结构的Type作比较，将long类型转成number(19,0)（对应关系由org.hibernate.dialect.OracleDialect进行维护），因为表结构的type是number类型，number(19,0)以number开头，所以校验可以通过。使用A模式数据库时，业务代码涉及整数类型的数据，可以使用Java中的Long类型插入。 GaussDB数据库 校验不同，关闭校验后数据插入成功：Hibernate框架在插入数据做校验时，业务代码是java.lang.long类型，和表数据类型bigint的TypeCode是对应的，因此不报错。但是表数据类型是Integer时无法对应，首先判断业务代码java.lang.long类型的TypeCode，与表数据Integer的TypeCode比较，结果不一致，再根据org.hibernate.dialect.PostgreSQLDialect对应关系，会将Long类型转换为int8，将表数据类型Integer转换为int4，无法对应，所以校验失败。使用GaussDB数据库时，业务代码涉及整数类型的数据，必须使用表类型对应的Java整型。

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

GS_SEG_SPC_REMAIN_EXTENTS GS_SEG_SPC_REMAIN_EXTENTS获取索引表空间残留的孤立的扩展信息。这些扩展信息不包含在残留段中，可以作为独立的清理单元。只支持管理员权限用户查询。 表1 GS_SEG_SPC_REMAIN_EXTENTS字段 名称 类型 描述 node_name text 节点名称。 tablespace_name name 表空间名称。 file_id integer 数据文件标识。取值范围：[1,5]的int4值。 bucketnode integer 0~1023表示hash bucket表的bucketnode。 1024表示段页式普通表的bucketnode。 1025表示段页式全局临时表的bucketnode。 1026表示段页式unlogged表的bucketnode。 1027表示段页式本地临时表的bucketnode。 forknum integer 段对象的分支类型。取值范围： 0表示main fork。 1表示fsm fork。 2表示vm fork。 block_id bigint 数据扩展的起始页面号。 blocks integer 数据扩展大小。取值：1、8、128、1024、4096。 contents text 数据文件的存储内容。取值范围： permanent：永久。 unlogged：不记录日志。 temporary：全局临时。 temporary2：本地临时。 in_used text 是否已分配。取值Y/N。 mapblock_location text 扩展在map block中的位置，格式（page_id, offset）。 head_file_id integer 段头文件标识。 head_block_id bigint 段头页面号。 usage_type text 扩展的使用类型。取值范围： segment head表示段头。 fork head表示分支头。 level1 page表示level页面。 data extent表示数据扩展。 remain_flag text 是否为shrink残留扩展。取值Y/N。 special_data integer 扩展对应反向指针的特殊数据区。 ipblock_location text 扩展反向指针位置，格式：（block_id，offset）。 父主题： 段页式存储

GLOBAL_RECOVERY_STATUS GLOBAL_RECOVERY_STATUS视图显示关于主机和备机的日志流控信息，如表1所示。多租场景下，non-PDB访问该视图时返回全部信息，PDB访问该视图时返回空列表。 表1 GLOBAL_RECOVERY_STATUS字段 名称 类型 描述 node_name text 节点名称，包含主机和备机。 standby_node_name text 备机节点的名称。 source_ip text 主机的IP地址。 source_port integer 主机的端口号。 dest_ip text 备机的IP地址。 dest_port integer 备机的端口号。 current_rto bigint 备机当前的日志流控时间，单位秒。 target_rto bigint 备机通过GUC参数设置的预期流控时间，单位秒。 current_sleep_time bigint 为了达到此RTO预期，主机所需要执行的睡眠时间，单位微秒。 父主题： Utility

算子级调优介绍 一个查询语句要经过多个算子步骤才会输出最终的结果。由于个别算子耗时过长导致整体查询性能下降的情况比较常见。这些算子是整个查询的瓶颈算子。通用的优化手段是EXPLAIN ANALYZE/PERFORMANCE命令查看执行过程的瓶颈算子，然后进行针对性优化。 如下面的执行过程信息中，Hashagg算子的执行时间占总时间的：(51016-13535)/ 56476 ≈66%，此处Hashagg算子就是这个查询的瓶颈算子，在进行性能优化时应当优先考虑此算子的优化。

查询结果集 返回单行结果的SELECT语句可以直接使用EXEC SQL执行，请参见执行SQL语句章节。 示例： /* 首先建立一个表并插入数据 */ EXEC SQL CREATE TABLE test_table (number1 integer, number2 integer); EXEC SQL INSERT INTO test_table (number1, number2) VALUES (2, 1); /* 查询结果为单行,:num 为宿主变量 */ EXEC SQL SELECT number1 INTO :num FROM test_table WHERE number2 = 1; 若要处理多行结果集，则必须使用游标，请参见使用游标章节（特殊情况下，应用程序可以一次取出多行结果写入到数组类型的宿主变量中，请参见使用非初级类型的宿主变量章节）。 示例： /* 首先建立一个表并插入数据 */ EXEC SQL CREATE TABLE test_table (number1 integer, number2 integer); EXEC SQL INSERT INTO test_table (number1, number2) VALUES (2, 1); EXEC SQL INSERT INTO test_table (number1, number2) VALUES (3, 1); EXEC SQL INSERT INTO test_table (number1, number2) VALUES (4,1); EXEC SQL INSERT INTO test_table (number1, number2) VALUES (5, 1); /* 定义宿主变量 */ EXEC SQL BEGIN DECLARE SECTION; int v1; int v2; EXEC SQL END DECLARE SECTION; /* 声明游标 */ EXEC SQL DECLARE test_bar CURSOR FOR SELECT number1, number2 FROM test_table ORDER BY number1; /* 打开游标 */ EXEC SQL OPEN test_bar; /* 当游标到达结果集末尾时跳出循环 */ EXEC SQL WHENEVER NOT FOUND DO BREAK; /* 获取查询结果集 */ while(1) { EXEC SQL FETCH NEXT FROM test_bar INTO :v1, :v2; printf("number1 = %d, number2 = %d\n",v1,v2); } /* 关闭游标 */ EXEC SQL CLOSE test_bar; 父主题： 基于ecpg开发

PG_CONVERSION PG_CONVERSION系统表描述编码转换信息。 表1 PG_CONVERSION字段 名称 类型 引用 描述 oid oid - 行标识符（隐含属性，必须明确选择）。 conname name - 转换名称（在一个名称空间里是唯一的）。 connamespace oid PG_NAMESPACE.oid 包含这个转换的名称空间的OID。 conowner oid PG_AUTHID.oid 编码转换的属主。 conforencoding integer - 源编码ID。 contoencoding integer - 目的编码ID。 conproc regproc PG_PROC.proname 转换过程。 condefault boolean - 如果这是缺省转换则为真，否则为假。 父主题： 其他系统表