支持的版本: 当前 (17) / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3

CREATE CAST

CREATE CAST — 定义新的类型转换

概要

CREATE CAST (source_type AS target_type)
    WITH FUNCTION function_name [ (argument_type [, ...]) ]
    [ AS ASSIGNMENT | AS IMPLICIT ]

CREATE CAST (source_type AS target_type)
    WITHOUT FUNCTION
    [ AS ASSIGNMENT | AS IMPLICIT ]

CREATE CAST (source_type AS target_type)
    WITH INOUT
    [ AS ASSIGNMENT | AS IMPLICIT ]

描述

CREATE CAST 定义一个新的类型转换。类型转换指定如何在两种数据类型之间执行转换。例如,

SELECT CAST(42 AS float8);

通过调用先前指定的函数,在本例中是 float8(int4),将整数常量 42 转换为 float8 类型。(如果没有定义合适的类型转换,则转换失败。)

两种类型可以是二进制强制转换的,这意味着转换可以免费执行,而无需调用任何函数。这要求相应的值使用相同的内部表示形式。例如,textvarchar 类型在两个方向上都是二进制强制转换的。二进制强制转换不一定是对称关系。例如,从 xmltext 的类型转换在当前实现中可以免费执行,但反方向需要一个至少执行语法检查的函数。(两个在两个方向上都是二进制强制转换的类型也称为二进制兼容。)

您可以使用 WITH INOUT 语法将类型转换定义为I/O 转换类型转换。I/O 转换类型转换是通过调用源数据类型的输出函数,并将结果字符串传递给目标数据类型的输入函数来执行的。在许多常见情况下,此功能避免了为转换编写单独的类型转换函数的需要。I/O 转换类型转换的作用与常规的基于函数的类型转换相同;只是实现方式不同。

默认情况下,类型转换只能通过显式的类型转换请求来调用,即显式的 CAST(x AS typename)x::typename 构造。

如果类型转换标记为 AS ASSIGNMENT,则在将值分配给目标数据类型的列时可以隐式调用它。例如,假设 foo.f1text 类型的列,则

INSERT INTO foo (f1) VALUES (42);

如果从 integer 类型到 text 类型的类型转换标记为 AS ASSIGNMENT,则允许这样做,否则不允许。(我们通常使用术语赋值类型转换来描述这种类型的类型转换。)

如果类型转换标记为 AS IMPLICIT,则可以在任何上下文中隐式调用它,无论是赋值还是在表达式内部。(我们通常使用术语隐式类型转换来描述这种类型的类型转换。)例如,考虑以下查询

SELECT 2 + 4.0;

解析器最初将常量标记为 integernumeric 类型。系统目录中没有 integer + numeric 运算符,但有一个 numeric + numeric 运算符。因此,如果存在从 integernumeric 的类型转换,并且标记为 AS IMPLICIT,则查询将成功 — 实际上它是这样的。解析器将应用隐式类型转换,并将查询解析为好像它是这样编写的

SELECT CAST ( 2 AS numeric ) + 4.0;

现在,目录还提供了从 numericinteger 的类型转换。如果该类型转换标记为 AS IMPLICIT — 实际上不是这样 — 则解析器将面临在上述解释和将 numeric 常量转换为 integer 并应用 integer + integer 运算符的替代方案之间进行选择。由于缺乏对首选哪种选择的任何了解,它将放弃并声明查询不明确。两种类型转换中只有一种是隐式的事实是我们教解析器首选将混合的 numericinteger 表达式解析为 numeric 的方式;没有关于此的内置知识。

明智的做法是对将类型转换标记为隐式保持保守。过多的隐式类型转换路径可能会导致 PostgreSQL 选择令人惊讶的命令解释,或者由于存在多种可能的解释而无法完全解析命令。一个好的经验法则是仅对同一通用类型类别中类型之间的信息保留转换使类型转换隐式调用。例如,从 int2int4 的类型转换可以合理地是隐式的,但是从 float8int4 的类型转换可能应该仅限赋值。跨类型类别的类型转换,例如 textint4,最好仅设置为显式的。

注意

有时,出于可用性或标准合规性的原因,需要在类型集合之间提供多个隐式类型转换,从而导致无法像上面那样避免的歧义。解析器具有基于类型类别首选类型的回退启发式,可以帮助在此类情况下提供所需的行为。有关更多信息,请参见 CREATE TYPE

要创建类型转换,您必须拥有源或目标数据类型,并且具有对另一类型的 USAGE 权限。要创建二进制强制类型转换,您必须是超级用户。(做出此限制的原因是错误的二进制强制类型转换可能会轻易导致服务器崩溃。)

参数

source_type

类型转换的源数据类型的名称。

target_type

类型转换的目标数据类型的名称。

function_name[(argument_type [, ...])]

用于执行类型转换的函数。函数名称可以用模式限定。如果没有,则将在模式搜索路径中查找该函数。函数的返回值数据类型必须与类型转换的目标类型匹配。它的参数在下面讨论。如果未指定参数列表,则函数名称在其模式中必须是唯一的。

WITHOUT FUNCTION

表示源类型可以二进制强制转换为目标类型,因此不需要函数来执行类型转换。

WITH INOUT

表示类型转换是 I/O 转换类型转换,通过调用源数据类型的输出函数,并将结果字符串传递给目标数据类型的输入函数来执行。

AS ASSIGNMENT

表示类型转换可以在赋值上下文中隐式调用。

AS IMPLICIT

表示类型转换可以在任何上下文中隐式调用。

类型转换实现函数可以有一个到三个参数。第一个参数类型必须与类型转换的源类型相同或可以二进制强制转换。第二个参数(如果存在)必须是 integer 类型;它接收与目标类型关联的类型修饰符,如果没有修饰符则接收 -1。第三个参数(如果存在)必须是 boolean 类型;如果类型转换是显式的,则它接收 true,否则接收 false。(奇怪的是,SQL 标准在某些情况下要求显式和隐式类型转换具有不同的行为。提供此参数是为了必须实现此类类型转换的函数。不建议您设计自己的数据类型,以至于这很重要。)

类型转换函数的返回类型必须与类型转换的目标类型相同或可以二进制强制转换。

通常,类型转换必须具有不同的源数据类型和目标数据类型。但是,如果类型转换具有多个参数的类型转换实现函数,则允许声明具有相同源类型和目标类型的类型转换。这用于表示系统目录中的特定于类型的长度强制转换函数。命名函数用于将类型的值强制转换为其第二个参数给定的类型修饰符值。

当类型转换具有不同的源类型和目标类型,且函数接受多个参数时,它支持在单个步骤中完成从一种类型到另一种类型的转换,并应用长度强制转换。如果没有可用的条目,则对使用类型修饰符的类型进行强制转换涉及两个转换步骤:一个用于在数据类型之间进行转换,第二个用于应用修饰符。

目前,转换为或从域类型的转换没有任何效果。转换为或从域的转换使用与其底层类型关联的转换。

注意

使用 DROP CAST 来删除用户定义的转换。

请记住,如果要能够双向转换类型,则需要显式地声明双向转换。

通常情况下,不需要在用户定义的类型和标准字符串类型(textvarcharchar(n),以及定义为字符串类别的用户定义类型)之间创建转换。PostgreSQL 为此提供了自动 I/O 转换。自动转换为字符串类型的转换被视为赋值转换,而从字符串类型进行的自动转换仅为显式转换。您可以通过声明自己的转换来覆盖自动转换的行为,但通常这样做的唯一原因是您希望转换比标准的仅赋值或仅显式设置更容易调用。另一个可能的原因是您希望转换的行为与类型的 I/O 函数不同;但这非常令人惊讶,您应该仔细考虑这样做是否是一个好主意。(少量内置类型的转换行为确实不同,这主要是由于 SQL 标准的要求。)

虽然不是必需的,但建议您继续遵循这种旧的约定,即以目标数据类型命名转换实现函数。许多用户习惯于使用函数式表示法转换数据类型,即 typename(x)。实际上,这种表示法仅仅是调用转换实现函数,而没有被特殊地视为转换。如果您的转换函数没有被命名为支持此约定,那么您将会让用户感到惊讶。由于 PostgreSQL 允许使用不同的参数类型重载相同的函数名称,因此从不同类型到使用目标类型名称的转换函数没有困难。

注意

实际上,前面的段落过于简单化了:在两种情况下,函数调用结构将被视为转换请求,而无需将其与实际函数匹配。如果函数调用 name(x) 与任何现有函数都不完全匹配,但 name 是数据类型的名称,并且 pg_cast 提供了从 x 的类型到此类型的二进制强制转换,则该调用将被解释为二进制强制转换。之所以进行此例外,是为了可以使用函数语法调用二进制强制转换,即使它们没有任何函数。同样,如果没有 pg_cast 条目,但转换将是到或从字符串类型的转换,则该调用将被解释为 I/O 转换。此例外允许使用函数语法调用 I/O 转换。

注意

对于例外情况,还有一个例外:从复合类型到字符串类型的 I/O 转换不能使用函数语法调用,必须使用显式转换语法(CAST:: 表示法)。添加此例外是因为在引入自动提供的 I/O 转换之后,发现当预期使用函数或列引用时,很容易意外调用此类转换。

示例

要使用函数 int4(bigint) 创建从类型 bigint 到类型 int4 的赋值转换

CREATE CAST (bigint AS int4) WITH FUNCTION int4(bigint) AS ASSIGNMENT;

(此转换已在系统中预定义。)

兼容性

CREATE CAST 命令符合SQL标准,但 SQL 没有为二进制强制转换类型或实现函数的额外参数提供规定。AS IMPLICIT 也是 PostgreSQL 的扩展。

提交更正

如果您在文档中看到任何不正确、与您使用特定功能的经验不符或需要进一步澄清的内容,请使用此表单报告文档问题。