受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: devel

CREATE TRANSFORM

CREATE TRANSFORM — 定义一个新的转换

Synopsis

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和语言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 TRANSFORMPostgreSQL的一种扩展。 SQL标准中也有CREATE TRANSFORM命令,但它用于将数据类型适配到客户端语言。 PostgreSQL不支持那种用法。

提交更正

如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。