↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5
历史版本。 PostgreSQL 12 已结束支持。 2024-11-21. 请参阅 当前版本手册.

CREATE TRANSFORM

CREATE TRANSFORM — 定义一个新的转换

大纲

CREATE [ OR REPLACE ] TRANSFORM FOR type_name LANGUAGE lang_name (
    FROM SQL WITH FUNCTION from_sql_function_name [ (argument_type [, ...]) ],
    TO SQL WITH FUNCTION to_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 和语言 plpythonu 创建转换时,首先设置该类型和语言:

CREATE TYPE hstore ...;

CREATE EXTENSION plpythonu;

然后创建所需的函数:

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 plpythonu (
    FROM SQL WITH FUNCTION hstore_to_plpython(internal),
    TO SQL WITH FUNCTION plpython_to_hstore(internal)
);

实际上,这些命令会被封装在扩展中。

contrib 部分包含若干提供转换的扩展,可以作为实际示例。

兼容性

这种形式的 CREATE TRANSFORM 是 PostgreSQL 的一种扩展。SQL 标准中也有 CREATE TRANSFORM 命令,但它用于将数据类型适配到客户端语言。PostgreSQL 不支持那种用法。

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.