选择 打开 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
测试与开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0
历史版本PostgreSQL 9.0 已于 2015 年 10 月结束社区维护,本页译文保留供仍在使用旧版本的读者参考。新系统请看当前版本

35.11. User-Defined Types #

第 35.2 节中所述, PostgreSQL可以扩展以支持新的数据类型。本节描述 如何定义新的基础类型,也就是在SQL语言层之下定义的 数据类型。创建新的基础类型需要用底层语言(通常是 C)实现操作该类型的 函数。

本节中的示例位于源码分发包的src/tutorial目录中的 complex.sqlcomplex.c。关于 如何运行这些示例,请参见该目录中的README文件。

用户定义类型必须始终有输入和输出函数。 这些函数决定该类型以字符串形式出现(供用户输入和向用户输出) 的方式,以及该类型在内存中如何组织。输入函数接受一个以空字符 结尾的字符串作为参数,并返回该类型的内部(内存中)表示。输出 函数接受该类型的内部表示作为参数,并返回一个以空字符结尾的 字符串。如果我们希望该类型除了存储之外还能做别的事情,就必须 提供额外的函数来实现我们希望该类型支持的各种操作。

假设我们要定义一种表示复数的类型complex。在内存中表示复 数的一种自然方式是下面这个 C 结构体:

typedef struct Complex {
    double      x;
    double      y;
} Complex;

我们需要把它做成按引用传递的类型,因为它太大了,无法放进单个 Datum值中。

作为该类型的外部字符串表示,我们选择形如(x,y)的 字符串。

输入和输出函数通常不难编写,尤其是输出函数。但在定义该类型的 外部字符串表示时,请记住,你最终必须为该表示编写一个完整而 健壮的解析器作为输入函数。例如:

PG_FUNCTION_INFO_V1(complex_in);

Datum
complex_in(PG_FUNCTION_ARGS)
{
    char       *str = PG_GETARG_CSTRING(0);
    double      x,
                y;
    Complex    *result;

    if (sscanf(str, " ( %lf , %lf )", &x, &y) != 2)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
                 errmsg("invalid input syntax for complex: \"%s\"",
                        str)));

    result = (Complex *) palloc(sizeof(Complex));
    result->x = x;
    result->y = y;
    PG_RETURN_POINTER(result);
}

输出函数可以简单地写成:

PG_FUNCTION_INFO_V1(complex_out);

Datum
complex_out(PG_FUNCTION_ARGS)
{
    Complex    *complex = (Complex *) PG_GETARG_POINTER(0);
    char       *result;

    result = (char *) palloc(100);
    snprintf(result, 100, "(%g,%g)", complex->x, complex->y);
    PG_RETURN_CSTRING(result);
}

应当注意让输入函数和输出函数互为逆运算。如果不是这样,当你需要把数据 转储到文件中再读回时,就会遇到严重问题。这在涉及浮点数时尤为常见。

可选地,用户定义类型还可以提供二进制输入和输出例程。二进制 I/O 通常 比文本 I/O 更快,但可移植性较差。与文本 I/O 一样,外部二进制表示的精 确定义完全由你决定。大多数内置数据类型都尽量提供与机器无关的二进制表 示。对于complex,我们将借助类型float8的二 进制 I/O 转换器:

PG_FUNCTION_INFO_V1(complex_recv);

Datum
complex_recv(PG_FUNCTION_ARGS)
{
    StringInfo  buf = (StringInfo) PG_GETARG_POINTER(0);
    Complex    *result;

    result = (Complex *) palloc(sizeof(Complex));
    result->x = pq_getmsgfloat8(buf);
    result->y = pq_getmsgfloat8(buf);
    PG_RETURN_POINTER(result);
}

PG_FUNCTION_INFO_V1(complex_send);

Datum
complex_send(PG_FUNCTION_ARGS)
{
    Complex    *complex = (Complex *) PG_GETARG_POINTER(0);
    StringInfoData buf;

    pq_begintypsend(&buf);
    pq_sendfloat8(&buf, complex->x);
    pq_sendfloat8(&buf, complex->y);
    PG_RETURN_BYTEA_P(pq_endtypsend(&buf));
}

一旦我们写好了 I/O 函数并将它们编译进共享库,就可以在 SQL 中定义 complex类型。首先将其声明为一种 shell 类型:

CREATE TYPE complex;

这会建立一个占位符,使我们可以在定义其 I/O 函数时引用该类型。现在我们 可以定义这些 I/O 函数:

CREATE FUNCTION complex_in(cstring)
    RETURNS complex
    AS 'filename'
    LANGUAGE C IMMUTABLE STRICT;

CREATE FUNCTION complex_out(complex)
    RETURNS cstring
    AS 'filename'
    LANGUAGE C IMMUTABLE STRICT;

CREATE FUNCTION complex_recv(internal)
   RETURNS complex
   AS 'filename'
   LANGUAGE C IMMUTABLE STRICT;

CREATE FUNCTION complex_send(complex)
   RETURNS bytea
   AS 'filename'
   LANGUAGE C IMMUTABLE STRICT;

最后,我们可以给出该数据类型的完整定义:

CREATE TYPE complex (
   internallength = 16,
   input = complex_in,
   output = complex_out,
   receive = complex_recv,
   send = complex_send,
   alignment = double
);

当你定义一种新的基本类型时,PostgreSQL 会自动提供对该类型数组的支持。 该数组类型的名称通常与基本类型相同, 只是在前面加一个下划线字符(_)。

一旦该数据类型存在,我们就可以声明额外的函数,为该数据类型提供有用的 操作。随后可以在这些函数之上定义操作符;如果需要,还可以创建操作符类 以支持该数据类型的索引。这些附加层会在后续各节中讨论。

如果你的数据类型的值在内部形式上的大小可变,就应该让该数据类型 支持 TOAST(见 第 54.2 节)。即使这些值总是小到不需要压缩或外部 存储,也应该这样做,因为 TOAST 还可以通过减少头部 overhead.

为此,内部表示必须遵循可变长度数据的标准布局:前四个字节必须是一个 从不直接访问的char[4]字段(惯例上命名为 vl_len_)。必须使用 SET_VARSIZE()在该字段中存储该 datum 的大小,并使用 VARSIZE()取回它。操作该数据类型的 C 级函数必须始 终使用PG_DETOAST_DATUM对传给它们的任何 TOAST 化 值执行去 TOAST 化处理。(这一细节通常通过定义特定于该类型的 GETARG_DATATYPE_P宏来隐藏。)然后,在执行 CREATE TYPE命令时,把内部长度指定为 variable并选择合适的存储选项。

如果数据对齐并不重要(无论只是对某个特定函数而言,还是因为该数据类型 本来就指定了字节对齐),那么就有可能避免 PG_DETOAST_DATUM的一部分开销。你可以改用 PG_DETOAST_DATUM_PACKED(通常通过定义 GETARG_DATATYPE_PP宏来隐藏),并使用 VARSIZE_ANY_EXHDRVARDATA_ANY 宏访问一个可能采用打包形式的 datum。再次注意,即使数据类型定义指定了 对齐方式,这些宏返回的数据也不是对齐的。如果对齐很重要,就必须使用常 规的PG_DETOAST_DATUM接口。

注意

较旧的代码常把vl_len_声明为 int32字段,而不是char[4]字段。只要结构体定 义中还有其他至少按int32对齐的字段,这样做是可以的。但 在处理可能未对齐的 datum 时使用这种结构体定义就很危险;编译器可能据此假定该 datum 实际上是对齐的,从而在对齐要求严格的体系结构上导致核心转储。

更多细节见CREATE TYPE命令的说明。

提交更正

译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。