最新动态
功能总览
服务公告
- 产品公告
- 版本支持公告
- 集群版本公告
产品介绍
- 图解数据仓库服务
- 什么是数据仓库服务
- 数据仓库类型
- 数据仓库规格
- 产品优势
- 应用场景
- 产品功能
- 基本概念
- 与其他云服务的关系
- 安全
- GaussDB(DWS)权限管理
- 如何访问GaussDB(DWS)
- 使用限制
- 技术支持
- 配额说明
- GaussDB(DWS)技术指标
计费说明
- GaussDB(DWS)计费概述
- 计费模式
- 计费项
- 计费样例
- 变更计费模式
- 续费
  - 续费概述
  - 手动续费
- 费用账单
- 欠费说明
- 停止计费
- 成本管理
- 计费FAQ
快速入门
- 免费体验GaussDB(DWS)
- 快速创建GaussDB(DWS)集群并导入数据进行查询
- GaussDB(DWS)数据开发SQL入门操作
- GaussDB(DWS)入门实践
用户指南
- GaussDB(DWS)使用流程
- 准备工作
- 创建GaussDB(DWS)集群
- 连接GaussDB(DWS)集群
- 创建GaussDB(DWS)数据库和用户
- 迁移业务数据至GaussDB(DWS)集群
  - 使用GDS-Kafka工具迁移数据至GaussDB(DWS)集群
  - 管理数据源
- GaussDB(DWS)集群数据安全与加密
- GaussDB(DWS)集群管理
- GaussDB(DWS)集群运维
最佳实践
- DWS最佳实践汇总
- 导入导出
- 数据迁移
- 数据分析
- 存算分离
  - DWS 3.0 存算分离使用建议及性能优化
- 数据开发
- 数据库管理
- 性能调优
- 集群管理
  - 为两种作业绑定不同资源池以实现DWS资源负载能力
  - DWS存算一体架构弹性伸缩系统性介绍
- 安全管理
  - DWS安全最佳实践
数据迁移与同步
- 迁移数据到GaussDB(DWS)
- 导入数据
- 整库迁移
  - 使用CDM迁移数据到GaussDB(DWS)
  - 使用DSC工具迁移SQL脚本
- 实时入库
  - Kafka实时入库到GaussDB(DWS)
- 元数据迁移
  - 使用gs_dump和gs_dumpall命令导出元数据
  - 使用gs_restore导入数据
- 导出数据
- 其他操作
开发指南
- 开发指南(9.1.0.x)
- 开发指南(9.1.1.x)
- 历史版本
SQL语法参考
- SQL语法参考(9.1.0.x)
- SQL语法参考(9.1.1.x)
- 历史版本
工具指南
- 工具简介
- 工具下载
- gsql
- GDS
- DSC
- DataCheck
- DWS-Connector
- 服务端工具
  - gs_dump
  - gs_dumpall
  - gs_restore
  - gds_check
  - gds_install
  - gds_uninstall
  - gds_ctl
API参考
- 使用前必读
- API概述
- 如何调用API
- 快速入门
- API说明
- 应用示例
  - 使用Postman调用创建集群接口
  - 使用Postman调用创建快照接口
- 权限及授权项说明
- 附录
SDK参考
- SDK概述
场景代码示例
错误码参考
- 控制台错误码
  - 管理控制台错误码
- 错误码(8.2.0及以下版本)
- 8.2.1及以上版本
  - 错误码命名规范
  - 行列存
    - 行存
    - 列存
    - GIN索引
    - Btree索引
    - 行存vacuum
    - SP-GiST索引
    - Hash索引
  - 事务
    - 锁
    - GTM
    - xlog
    - checkpoint
  - HA
  - SQL on Anywhere
    - SQL on hudi
    - OBS / HDFS / DLI
  - GDS/Copy
    - 公共机制（选项参数、任务分配、压缩）
    - 导入
  - 解析器
    - 词法分析
    - 语法分析
    - DDL
    - DML
    - 表达式
    - 元数据
  - 优化器
  - 执行器
  - 安全
    - 授权
    - 脱敏
  - 通信
  - WLM
  - 逻辑集群
  - 其他
常见问题
- Top问题汇总
- 产品咨询
- 数据库连接
- 数据迁移
- 数据库使用
- 集群管理
- 账户与权限
- 数据库性能
- 备份恢复
  1. 为什么DWS自动快照创建很慢，很长时间都没有创建好？
  2. DWS快照是否与EVS快照功能相同？
故障排除
- 数据库连接管理
- JDBC/ODBC类
- 数据导入/导出
- 数据库参数修改
- 账号/权限/密码
- 集群性能
- 集群异常
  - 磁盘监控告警阈值太低，告警频繁
- 数据库使用
视频帮助
性能白皮书
- 性能白皮书(9.1.0.x)
- 性能白皮书(8.1.3.x)
文档下载
通用参考
- 产品术语
- 云服务等级协议（SLA）
- 白皮书资源
- 支持区域
- 系统权限

本文导读

功能描述
注意事项
语法格式
参数说明
示例：创建一个求两个整数求和的SQL函数
示例：创建一个处理整数自增的PL/pgSQL语言函数
示例：创建一个返回RECORD类型的PL/pgSQL语言函数：
示例：创建一个返回结果包含多个输出参数的SQL语言函数
示例：创建package属性的重载函数：
函数下推逻辑及示例
相关链接

展开导读

文档首页/ 数据仓库服务 GaussDB(DWS)/ SQL语法参考/ SQL语法参考(9.1.0.x)/ DDL语法/ CREATE FUNCTION

CREATE FUNCTION

更新时间：2025-07-08 GMT+08:00

查看PDF

功能描述

FUNCTION（函数）是一段可重用的代码块，它接受输入参数，执行特定操作，并返回一个值或结果集。CREATE FUNCTION语句用于在数据库中创建用户自定义函数（UDF），实现DWS当前内置的系统函数中还未支持的其他计算功能，覆盖用户特定的复杂计算场景。

函数的主要特点包括：

支持输入参数，可根据不同条件返回结果。
需声明返回值的数据类型，执行结果返回单一值（标量函数）或表（表值函数）。
将复杂逻辑封装为单一函数，可以在SQL语句中像内置函数一样调用，提高代码的复用性。

GaussDB(DWS)函数易变属性的三种行为

SQL中函数的行为特性通常分为三类，包括immutable（不可变函数）、stable（稳定函数）、volatile（易变函数），三者关系如表1所示：

表1 函数的易变属性
易变属性	定义	典型场景
immutable	immutable函数的结果仅由输入参数决定，与任何外部状态（如数据库当前数据、时间、事务上下文等）无关。无论何时、何地调用，只要输入参数相同，返回结果永远一致。且函数不会修改数据库中的数据。	数学计算、哈希、字符串操作，例如ABS(x), POWER(a, b)，MD5(str)。
stable	stable函数的结果在单次查询执行期间保持稳定。即在同一个查询的多次调用中，只要输入参数相同，结果一致。但结果可能依赖数据库的当前状态（如表数据、会话变量等），因此在不同查询或事务中可能返回不同结果。	基于当前数据的过滤、聚合，例如部分聚合函数：MAX(col), MIN(col)（在单次扫描中结果稳定）。
volatile	volatile函数是最“不稳定”的类型。其结果可能在每次调用时变化，或可能修改数据库状态（如写入数据）。优化器无法预测其行为，必须每次调用都重新计算。	随机数、时间戳、DML操作，例如随机数函数：RANDOM()（每次调用返回不同值）。

查看函数属于哪种属性，可以查看PG_PROC系统表的provolatile字段（i表示immutable，s表示stable，v表示volatile）。

函数是否下推到DN（数据节点）执行（SHIPPABLE和NOT SHIPPABLE介绍）

CREATE FUNCTION语法中，通过SHIPPABLE（下推）和NOT SHIPPABLE（不下推）来控制该函数是否下推到数据节点（DN）执行。

对于IMMUTABLE类型的函数，函数始终可以下推到DN上执行。
对于STABLE/VOLATILE类型的函数，仅当函数的属性是SHIPPABLE的时候，函数可以下推到DN执行。
用户在定义函数的SHIPPABLE属性时也需特别慎重，SHIPPABLE意味着整个函数会下推到DN上执行，如果设置不当，会导致结果错误等严重问题。

与定义IMMUTABLE属性一样，SHIPPABLE属性的定义也有诸多约束，简单来说就是函数内不能有不可下推的因素，函数下推到单DN执行后，函数内部的计算逻辑仅依赖当前DN的数据集合。

不能定义为IMMUTABLE的情况，举例如下：

如果自定义函数中引用了表、视图等对象，那么该函数就不能定义为IMMUTABLE，因为当表的数据发生变化的时候，函数的返回值可能发生变化。
如果自定义函数中引用了STABLE/VOLATILE类型的函数，那么该函数不能定义为IMMUTABLE。
如果自定义函数中有不下推的因素，则该函数不能定义成IMMUTABLE，因为IMMUTABLE意味着要下推到DN执行，与函数内部的不下推因素相互冲突。典型场景例如，包含不下推的函数、语法等。
如果自定义函数中含有聚合运算，但聚合运算的运算需要生成STREAM计划才能完成计算的（部分结果在DN计算，部分结果在CN计算，例如listagg函数等）。

不能定义为SHIPPABLE的情况，举例如下：

如果函数内部引用了表，并且表为HASH分布，那么该函数通常不能定义为SHIPPABLE。
函数内部有不可下推的因素，函数，语法等，那么该函数不能定义为SHIPPABLE，可参考语句下推调优章节。
函数内部的计算过程可能需要跨DN数据，这种情况该函数通常不能定义为SHIPPABLE，例如一些聚合运算等。

注意：

用户在使用GaussDB(DWS)时，应该正确指定函数属性，错误指定函数属性不仅会导致查询语句执行效率低，而且可能会导致结果集不稳定的情况。

注意事项

如果创建函数时参数或返回值带有精度，不进行精度检测。
创建函数时，函数定义中对表对象的操作建议都显式指定模式（例如hr.table1，明确指定是hr模式下面的表），否则可能会导致函数执行异常。
在创建函数时，函数内部通过SET语句设置current_schema和search_path无效。函数执行完的search_path和current_schema与函数执行前的search_path和current_schema保持一致。
如果函数参数中带有出参，SELECT调用函数必须缺省出参，CALL调用函数适配Oracle必须指定出参，对于调用重载的带有PACKAGE属性的函数，CALL调用函数可以缺省出参，具体信息参见CALL的示例。
兼容PostgreSQL风格的函数或者带有PACKAGE属性的函数支持重载。在指定REPLACE的时候，如果参数个数、类型、返回值有变化，不会替换原有函数，而是会建立新的函数。
SELECT调用可以指定不同参数来进行同名函数调用。由于语法CALL适配自Oracle，因此不支持调用不带有PACKAGE属性的同名函数。
在创建function时，不能在avg函数外面嵌套其他agg函数，或者其他系统函数。
在非逻辑集群模式下，暂不支持将返回值、参数以及变量设置为建在非系统默认安装Node Group的表，sql function内部语句暂不支持对建在非系统默认安装Node Group的表操作。
在逻辑集群模式下，如果函数返回值和参数是用户表类型，所有涉及表都必须在同一逻辑集群内；如果函数内部涉及对多个逻辑集群表操作，函数定义时不能为IMMUTABLE和SHIPPABLE类型，以避免函数被下推到DN执行。
在逻辑集群模式下，函数参数、返回值不能用%type引用表字段类型，否则会导致函数创建失败。
新创建的函数默认会给PUBLIC授予执行权限（详见GRANT）。用户可以选择收回PUBLIC默认执行权限，然后根据需要将执行权限授予其他用户，为了避免出现新函数能被所有人访问的时间窗口，应在一个事务中创建函数并且设置函数执行权限。
在多个CN的集群中，不能将函数的入参或出参设置为临时表类型，因为在非当前连接CN上执行创建函数过程中，无法单独根据表名获取到正确的临时schema，进而无法获取到准确的表类型。

语法格式

兼容PostgreSQL风格的创建自定义函数语法。

       
        
          
          CREATE [ OR REPLACE  ] FUNCTION function_name 
    ( [  { argname [ argmode  ] argtype [  { DEFAULT  | :=  | =  } expression  ]}  [, ...]  ] )
    [ RETURNS rettype [ DETERMINISTIC  ]  | RETURNS TABLE (  { column_name column_type  }  [, ...] )]
    LANGUAGE lang_name 
    [ 
       {IMMUTABLE  | STABLE  | VOLATILE }
        | {SHIPPABLE | NOT SHIPPABLE}
        | WINDOW
        | [ NOT  ] LEAKPROOF  
        | {CALLED ON NULL INPUT  | RETURNS NULL ON NULL INPUT | STRICT } 
        | {[ EXTERNAL  ] SECURITY INVOKER | [ EXTERNAL  ] SECURITY DEFINER | AUTHID DEFINER  | AUTHID CURRENT_USER} 
        | {FENCED | NOT FENCED}
        | {PACKAGE}

        | COST execution_cost
        | ROWS result_rows
        | SET configuration_parameter { {TO | =} value | FROM CURRENT }}
     ][...]
    {
        AS 'definition'
        | AS 'obj_file', 'link_symbol'
    }

         

       
      

Oracle风格的创建自定义函数的语法。

       
        
          
          CREATE [ OR REPLACE  ] FUNCTION function_name 
    ( [  { argname [ argmode  ] argtype [  { DEFAULT | := | =  } expression  ] }  [, ...]  ] )
    RETURN rettype [ DETERMINISTIC  ]
    [ 
        {IMMUTABLE  | STABLE  | VOLATILE } 
        | {SHIPPABLE | NOT SHIPPABLE}
        | {PACKAGE}
        | {FENCED | NOT FENCED}
        | [ 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  
        | ROWS result_rows  
        | SET configuration_parameter { {TO | =} value  | FROM CURRENT

    ][...] 

    { 
      IS  | AS
} plsql_body
/

         

       
      

参数说明

表2 CREATE FUNCTION参数说明
参数	描述	取值范围
function_name	要创建的函数名字（可以用模式修饰）。	取值范围：字符串，要符合标识符的命名规范。参见标识符命名规范。注意：如果创建的函数名与系统函数同名，建议指定schema。调用自定义函数时需指定schema，否则系统会优先调用系统函数。
argname	函数参数的名字。	取值范围：字符串，要符合标识符的命名规范。
argmode	函数参数的模式。	取值范围：IN，OUT，INOUT或VARIADIC。 IN：输入参数，缺省值是IN。 OUT：输出参数，只有OUT模式的参数后面能跟VARIADIC。 INOUT：既是输入又是输出参数。 OUT VARIADIC: 表示输出参数，且声明为数组类型。注意： OUT和INOUT模式的参数不能用在RETURNS TABLE的函数定义中。
argtype	函数参数的数据类型。	常用的数据类型参见数据类型。
expression	函数参数的默认表达式。	-
rettype	函数返回值的数据类型。	如果存在OUT或IN OUT参数，可以省略RETURNS子句。如果该子句存在，则必须和输出参数所表示的结果类型一致：如果有多个输出参数，则为RECORD，否则与单个输出参数的类型相同。 SETOF修饰词表示该函数将返回一个集合，而不是单独一项。
DETERMINISTIC	为适配Oracle SQL语法，未实现功能，不推荐使用。	-
column_name	字段名称。	-
column_type	字段类型。	-
definition	一个定义函数的字符串常量，含义取决于语言。它可以是一个内部函数名字、一个指向某个目标文件的路径、一个SQL查询、一个过程语言文本。	-
LANGUAGE lang_name	用于实现函数的语言的名字。可以是SQL，internal，或者是用户定义的过程语言名字。为了保证向下兼容，该名字可以用单引号（包围）。若采用单引号，则引号内必须为大写。	-
WINDOW	表示该函数是窗口函数，替换函数定义时不能改变WINDOW属性。注意：自定义窗口函数只支持LANGUAGE是internal，并且引用的内部函数必须是窗口函数。	-
IMMUTABLE	表示该函数在给出同样的参数值时总是返回同样的结果。	如果函数的入参是常量，会在优化器阶段计算该函数的值。益处是可以尽早获取表达式的值，从而能更准确的进行代价估算，生成的执行计划也更优。用户自定义的IMMUTABLE的函数是会被自动下推到DN执行的，但是这样可能有潜在的风险，即如果用户错误定义了函数的IMMUTABLE属性，但是函数执行的过程并不是IMMUTABLE的，那么可能会导致结果错误等严重问题。因此，用户在指定函数的属性为IMMUTABLE的时候，要特别慎重。举例如下：如果自定义函数中引用了表，视图等对象，那么该函数就不能定义为IMMUTABLE，因为当表的数据发生变化的时候，函数的返回值可能发生变化。如果自定义函数中引用了STABLE/VOLATILE类型的函数，那么该函数不能定义为IMMUTABLE。如果自定义函数中有不下推的因素，则该函数不能定义成IMMUTABLE，因为IMMUTABLE意味着要下推到DN执行，与函数内部的不下推因素相互冲突。典型场景例如，包含不下推的函数、语法等。如果自定义函数中含有聚合运算，但聚合运算的运算需要生成STREAM计划才能完成计算的（部分结果在DN计算，部分结果在CN计算，例如listagg函数等）。同时，为了防止这种情况下可能出现严重问题，数据库内部可以通过设置behavior_compat_options=‘check_function_conflicts’来开启对函数定义冲突的检查，目前可以识别出上述1和2场景。
STABLE	表示该函数不能修改数据库，对相同参数值，在同一次表扫描里，该函数的返回值不变，但是返回值可能在不同SQL语句之间变化。	-
VOLATILE	表示该函数值可以在一次表扫描内改变，因此不会做任何优化。	-
SHIPPABLE NOT SHIPPABLE	表示该函数是否可以下推到DN上执行。	对于IMMUTABLE类型的函数，函数始终可以下推到DN上执行。对于STABLE/VOLATILE类型的函数，仅当函数的属性是SHIPPABLE的时候，函数可以下推到DN执行。用户在定义函数的SHIPPABLE属性时也需特别慎重，SHIPPABLE意味着整个函数会下推到DN上执行，如果设置不当，会导致结果错误等严重问题。与定义IMMUTABLE属性一样，SHIPPABLE属性的定义也有诸多约束，简单来说就是函数内不能有不可下推的因素，函数下推到单DN执行后，函数内部的计算逻辑仅依赖当前DN的数据集合。举例如下：如果函数内部引用了表，并且表为HASH分布，那么该函数通常不能定义为SHIPPABLE。函数内部有不可下推的因素，函数，语法等，那么该函数不能定义为SHIPPABLE，可参考语句下推调优。函数内部的计算过程可能需要跨DN数据，这种情况该函数通常不能定义为SHIPPABLE，例如一些聚合运算等。
PACKAGE	表示该函数是否支持重载。PostgreSQL风格的函数本身就支持重载，此参数主要是针对Oracle风格的函数。	不允许package函数和非package函数重载或者替换。 package函数不支持VARIADIC类型的参数。不允许修改函数的package属性。
LEAKPROOF	指出该函数的参数只包括返回值。LEAKPROOF只能由系统管理员设置。	-
CALLED ON NULL INPUT	表明该函数的某些参数是NULL的时候可以按照正常的方式调用。该参数可以省略。	-
RETURNS NULL ON NULL INPUT STRICT	STRICT用于指定如果函数的某个参数是NULL，此函数总是返回NULL。如果声明了这个参数，当有NULL值参数时该函数不会被执行；而只是自动返回一个NULL结果。 RETURNS NULL ON NULL INPUT和STRICT的功能相同。	-
EXTERNAL	目的是和SQL兼容，是可选的，这个特性适合于所有函数，而不仅是外部函数。	-
SECURITY INVOKER AUTHID CURRENT_USER	表明该函数将带着调用它的用户的权限执行。该参数可以省略。 SECURITY INVOKER和AUTHID CURRENT_USER的功能相同。	-
SECURITY DEFINER AUTHID DEFINER	声明该函数将以创建它的用户的权限执行。 AUTHID DEFINER和SECURITY DEFINER的功能相同。	-
FENCED NOT FENCED	该函数只对用户定义的C函数生效，声明函数是在保护模式还是非保护模式下执行。如果函数声明为NOT FENCED模式，则函数的执行在CN或者DN进程中进行。如果函数声明为FENCED模式，则函数在新fork的进程执行，这样函数的异常不会影响CN或者DN进程。	FENCED/NOT FENCED模式的选择：正在开发或者调试的Function使用FENCED模式。开发测试完成，使用NOT FENCED模式执行，减少fork进程以及通信的开销。复杂的操作系统操作，例：打开文件，信号处理，线程处理等操作，使用FENCED模式。否则可能影响GaussDB(DWS)数据库的执行。默认值为FENCED。
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的值。
plsql_body	PL/SQL存储过程体。	须知：当在函数中创建用户时，日志中会记录密码的明文。因此不建议用户在函数中创建用户。

示例：创建一个求两个整数求和的SQL函数

语法如下：

     
        CREATE  OR REPLACE FUNCTION func_add_sql(
integer,                  --第一个整数参数，未命名，使用位置参数$1引用
integer                   --第二个整数参数，未命名，使用位置参数$2引用
) 
RETURNS integer              --指定函数返回类型为整数
    AS 'select $1 + $2;'     --函数体：使用位置参数$1和$2相加
    LANGUAGE SQL             --使用SQL语言实现该函数
    IMMUTABLE                --函数类型为IMMUTABLE，表示相同输入总是返回相同结果
    RETURNS NULL ON NULL INPUT;       --等同于STRICT，任何参数为NULL时，函数返回NULL

执行函数，返回两个入参的求和值：

     
        SELECT func_add_sql(8,3);

执行函数，输入为Null，返回为Null。

1	SELECT func_add_sql(Null,3);

示例：创建一个处理整数自增的PL/pgSQL语言函数

语法如下：

     
        CREATE OR REPLACE FUNCTION func_increment_plsql(
i integer                                --输入参数，整数类型
) RETURNS integer                        --函数返回值为整数类型
AS $$
        BEGIN                             --表示函数体开始       
                RETURN i + 1;             --返回输入参数加1的结果
        END;
$$ LANGUAGE plpgsql;                     --指定函数使用PL/pgSQL语言编写

执行函数，返回整数自增结果。

1	SELECT func_increment_plsql(5);

入参由一个表numbers的第一列指定，使用函数计算后，将计算结果返回到第二列：

     
        DROP TABLE IF EXISTS numbers;
CREATE TABLE numbers (value integer);
INSERT INTO numbers VALUES (1), (2), (3), (4), (5);
SELECT value, func_increment_plsql(value) AS incremented_value FROM numbers ORDER BY 1;

示例：创建一个返回RECORD类型的PL/pgSQL语言函数：

     
      
        
        CREATE OR REPLACE FUNCTION compute(
i int,                             --输入参数，整数类型
out result_1 bigint,               --输出结果1，大范围整数类型
out result_2 bigint                --输出结果2，大范围整数类型
)
RETURNS SETOF RECORD               --结果返回一组记录
AS $$
BEGIN
    result_1 = i + 1;              --计算第一个结果值，输入值+1
    result_2 = i * 10;             --计算第二个结果值，输入值乘以10
RETURN next;                       --返回当前计算结果并继续（允许返回多行）
END;
$$LANGUAGE plpgsql;                --指定函数使用PL/pgSQL语言编写

       

     
    

单次调用函数，返回结果：

1	SELECT * FROM compute(5);

生成一个包含1到3的序列，并对序列的每个值调用一次compute函数。

     
        SELECT i, (compute(i)).*        --先调用compute函数，再展开函数返回的所有列
FROM generate_series(1, 3)      --生成一个包含1，2，3的临时序列，用于i的赋值
AS t(i);                        --将结果作为临时表，别名为t，列名为i

与一个表test_data的数据结合使用，表中的value列作为函数compute的入参值，计算结果：

     
        DROP TABLE IF EXISTS test_data;
CREATE TABLE test_data (id serial, value int);
INSERT INTO test_data (value) VALUES (2), (4), (6);

SELECT id, value, (compute(value)).* 
FROM test_data ORDER BY 1;

示例：创建一个返回结果包含多个输出参数的SQL语言函数

语法如下：

     
        CREATE OR REPLACE FUNCTION func_dup_sql(
in int,                              --输入参数，整数类型
out f1 int,                          --输出参数1，整数类型 
out f2 text)                         --输出参数2，文本类型
 AS $$ 
SELECT $1, CAST($1 AS text) || ' is text'         --函数体，查询返回两列，第一列是输入参数$1，第二列是将参数转为文本后拼接'is text'
 $$   LANGUAGE SQL;

执行函数

1	SELECT * FROM func_dup_sql(42);

示例：创建package属性的重载函数：

定义了两个重载的函数，名为package_func_overload，它们位于名为package的包中。这两个函数根据参数类型的不同有不同的实现。

     
      
        
        CREATE OR REPLACE FUNCTION package_func_overload(
col int,                                     --输入参数1，整数类型
col2  int                                    --输入参数2，整数类型
)
RETURN integer PACKAGE
AS
DECLARE
    col_type text;                   --声明局部变量
BEGIN
     col := 122;                     --将第一个参数的值固定为122
     dbms_output.put_line('two int parameters ' || col2);
     RETURN 0;                       --返回整数值0
END;
/

CREATE OR REPLACE FUNCTION package_func_overload(
col int, 
col2 smallint
)
RETURN integer PACKAGE
AS
DECLARE
    col_type text;
BEGIN
     col := 122;
     dbms_output.put_line('two smallint parameters ' || col2);
     RETURN 0;
END;
/

       

     
    

函数下推逻辑及示例

函数下推逻辑分为两部分：

函数体是否下推：通过函数属性（SHIPPABLE）判断。
函数体内的语句是否下推：当函数体不下推的时候，函数体内的SQL语句进行独立的下推判断（优化器自动判断）。

调用函数的语句不包含用户表

当调用函数的语句不包含用户表的时候，这个语句总是在CN上执行，函数体不下推，此时执行逻辑如下：

先执行函数：语句中没有用户表，这个语句总是在CN上执行。
接着执行函数体的语句，如果不存在不下推的因素，那么总是可以下推的（走下推框架：FQS 或 stream计划）。

注意：

单独调用函数（调用函数的语句不包含用户表），函数中包含表关联查询的SQL，查询结果是准确的。
函数下推只有在函数调用语句中直接出现用户表的时候才有意义。
函数体里面的执行计划没办法直接对外展示，可以设置enable_track_record_subsql=on记录函数体内部的语句。

示例：函数体为NOT SHIPPABLE，调用函数的语句不包含用户表。

       
        
          
          CREATE TABLE student (               
        id integer,                   
        name character varying(50),   
        age integer                   
)                                     
WITH (orientation=row, compression=no)
DISTRIBUTE BY HASH(id);

CREATE TABLE stuscore(               
        id integer,                   
        score integer
)                                     
WITH (orientation=row, compression=no)
DISTRIBUTE BY HASH(id);

INSERT INTO student(id,name,age) VALUES(1,'bob',17),(3,'peter',18),(4,'david',15),(8,'alice','17');
INSERT INTO stuscore(id,score) VALUES(1,88),(3,68),(8,100),(4,90);

--创建一个NOT SHIPPABLE的函数
CREATE OR REPLACE FUNCTION get_student_id(name character varying)
    RETURNS TABLE(id integer)
    LANGUAGE plpgsql
    VOLATILE NOT FENCED NOT SHIPPABLE
AS $function$
DECLARE
BEGIN
    RETURN QUERY (SELECT id FROM mytest.student WHERE name=$1);
END $function$;

         

       
      

查看单独调用函数的计划：

       
          EXPLAIN VERBOSE SELECT * FROM get_student_id('alice');

从返回结果看，计划中没有函数是否下推的说明，因为函数下推只有在函数调用语句中直接出现用户表的时候才有意义。

调用函数的语句包含用户表

当调用函数的语句包含用户表的时候，语句是否下推由函数属性（SHIPPABLE）决定。

示例：函数属性为NOT SHIPPABLE，调用函数的语句包含用户表。

查看调用函数的计划，函数不可下推：

       
          EXPLAIN VERBOSE SELECT get_student_id('alice') FROM stuscore;

示例：函数属性SHIPPABLE，调用函数的语句包含用户表。

       
          --修改函数属性为SHIPPABLE。
CREATE OR REPLACE FUNCTION get_student_id(name character varying)
    RETURNS TABLE(id integer)
    LANGUAGE plpgsql
    VOLATILE NOT FENCED SHIPPABLE
AS $function$
DECLARE
BEGIN
    RETURN QUERY (SELECT id FROM mytest.student WHERE name=$1);
END $function$;

查看调用函数的计划，函数可下推。

       
          EXPLAIN VERBOSE SELECT get_student_id('alice') FROM stuscore;

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

CREATE FUNCTION

功能描述

GaussDB(DWS)函数易变属性的三种行为

函数是否下推到DN（数据节点）执行（SHIPPABLE和NOT SHIPPABLE介绍）

注意事项

语法格式

参数说明

示例：创建一个求两个整数求和的SQL函数

示例：创建一个处理整数自增的PL/pgSQL语言函数

示例：创建一个返回RECORD类型的PL/pgSQL语言函数：

示例：创建一个返回结果包含多个输出参数的SQL语言函数

示例：创建package属性的重载函数：

函数下推逻辑及示例

调用函数的语句不包含用户表

调用函数的语句包含用户表

相关链接

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈