SQL COMMAND · 函数与过程
CREATE TRANSFORM
定义一个新的转换
CREATE函数与过程引入 10(基线)现存至 20 devel0 次语法变更
- 动词
CREATE- 对象
TRANSFORM- 分组
- 函数与过程
- 引入版本
- 10(基线)
- 状态
- 现存
- 语法变更次数
- 0
- 手册小节数
- 6
版本轨迹
相对 PostgreSQL 17 无变化。
语法铁道图 PostgreSQL 18
沿轨道从左向右阅读,分岔表示选择,绕行表示可选,回环表示重复。方框为参数,点击带下划线的参数可展开子规则。
语法概要
CREATE [ OR REPLACE ] TRANSFORM FORtype_nameLANGUAGElang_name( FROM SQL WITH FUNCTIONfrom_sql_function_name[ (argument_type[, ...]) ], TO SQL WITH FUNCTIONto_sql_function_name[ (argument_type[, ...]) ] );
描述
CREATE TRANSFORM定义一种新的转换。 CREATE OR REPLACE TRANSFORM会创建一种新的转换, 或替换现有定义。
转换指定如何将一种数据类型适配到某种过程语言。例如,在用 PL/Python 编写一个使用hstore类型的函数时,PL/Python 事先并不知道该如何在 Python 环境中表示hstore值。语言 实现通常默认使用文本表示,但这并不方便,例如在更适合使用关联数组或 列表时就是如此。
转换指定两个函数:
一个“from SQL”函数,用于将该类型从 SQL 环境转换到该 语言。该函数会作用于用这种语言编写的函数的参数。
一个“to SQL”函数,用于将该类型从该语言转换到 SQL 环 境。该函数会作用于用这种语言编写的函数的返回值。
不必同时提供这两个函数。如果其中一个未指定,则会在需要时使用该语言相 关的默认行为。(若要彻底阻止某一方向上的转换,也可以编写一个总是报错 的转换函数。)
要创建一种转换,你必须拥有该类型并具有其上的 USAGE权限,具有该语言上的 USAGE权限,并且在指定了 from-SQL 和 to-SQL 函数时, 还必须拥有这些函数并具有其上的EXECUTE权限。
参数
type_name该转换的数据类型名称。
lang_name该转换所用语言的名称。
from_sql_function_name[(argument_type[, ...])]用于将该类型从 SQL 环境转换到该语言的函数名称。它必须接受一个
internal类型参数,并返回internal类型。 实际传入的参数将是该转换对应的类型,因此编写该函数时应按这一点 处理。(但不允许声明一个返回internal、却没有至少一个internal类型参数的 SQL 层函数。)实际返回值将是语言 实现特有的某个对象。如果未指定参数列表,则函数名在其所在模式中必 须唯一。to_sql_function_name[(argument_type[, ...])]用于将该类型从该语言转换到 SQL 环境的函数名称。它必须接受一个
internal类型参数,并返回该转换对应的类型。实际参数值 将是语言实现特有的某个对象。如果未指定参数列表,则函数名在其所在 模式中必须唯一。
注解
使用DROP TRANSFORM删除转换。
示例
要为类型hstore和语言plpython3u创建转 换,首先准备好该类型和该语言:
CREATE TYPE hstore ...; CREATE EXTENSION plpython3u;
然后创建必要的函数:
CREATE FUNCTION hstore_to_plpython(val internal) RETURNS internal LANGUAGE C STRICT IMMUTABLE AS ...; CREATE FUNCTION plpython_to_hstore(val internal) RETURNS hstore LANGUAGE C STRICT IMMUTABLE AS ...;
最后创建把它们连接在一起的转换:
CREATE TRANSFORM FOR hstore LANGUAGE plpython3u (
FROM SQL WITH FUNCTION hstore_to_plpython(internal),
TO SQL WITH FUNCTION plpython_to_hstore(internal)
);
在实际使用中,这些命令通常会封装在一个扩展中。
contrib部分包含若干提供转换的扩展,可以作为实 际示例。
兼容性
这种形式的CREATE TRANSFORM是 PostgreSQL的一种扩展。 SQL标准中也有CREATE TRANSFORM命令,但它用于将数据类型适配到客户端语言。 PostgreSQL不支持那种用法。
另见
语法演化
相邻大版本之间的差异,新的在前。版本号链接到对应快照。
PostgreSQL 14← 13正文更新
正文更新PostgreSQL 11← 10正文更新
正文更新
同组命令
| 命令 | 动词 | 对象 | 版本变动 | 最近变更 |
|---|---|---|---|---|
CALL | CALL | — | — | |
| 调用一个过程 | 现存 | |||
DO | DO | — | — | |
| 执行匿名代码块 | 现存 | |||
CREATE AGGREGATE | CREATE | AGGREGATE | 203 次 | |
| 定义一个新的聚合函数 | 现存 | |||
ALTER AGGREGATE | ALTER | AGGREGATE | 141 次 | |
| 更改一个聚合函数的定义 | 现存 | |||
DROP AGGREGATE | DROP | AGGREGATE | — | |
| 移除一个聚合函数 | 现存 | |||
CREATE FUNCTION | CREATE | FUNCTION | 143 次 | |
| 定义一个新函数 | 现存 | |||
ALTER FUNCTION | ALTER | FUNCTION | 143 次 | |
| 更改函数的定义 | 现存 | |||
DROP FUNCTION | DROP | FUNCTION | — | |
| 移除一个函数 | 现存 | |||
CREATE LANGUAGE | CREATE | LANGUAGE | 131 次 | |
| 定义一种新的过程语言 | 现存 | |||
ALTER LANGUAGE | ALTER | LANGUAGE | 141 次 | |
| 更改一种过程语言的定义 | 现存 | |||
DROP LANGUAGE | DROP | LANGUAGE | — | |
| 移除一种过程语言 | 现存 | |||
CREATE PROCEDURE | CREATE | PROCEDURE | 141 次 | |
| 定义一个新过程 | 现存 | |||
ALTER PROCEDURE | ALTER | PROCEDURE | 142 次 | |
| 更改过程的定义 | 现存 | |||
DROP PROCEDURE | DROP | PROCEDURE | — | |
| 移除一个过程 | 现存 | |||
ALTER ROUTINE | ALTER | ROUTINE | 142 次 | |
| 更改一个例程的定义 | 现存 | |||
DROP ROUTINE | DROP | ROUTINE | — | |
| 移除一个例程 | 现存 | |||
CREATE TRANSFORM | CREATE | TRANSFORM | — | |
| 定义一个新的转换 | 现存 | |||
DROP TRANSFORM | DROP | TRANSFORM | — | |
| 移除一个转换 | 现存 | |||