选择 打开 改范围 完整检索页
受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10
当前 PostgreSQL 版本不在支持生命周期内。
您可以参阅当前版本的对应页面,或其他在上面列出的活跃大版本。

CREATE OPERATOR

CREATE OPERATOR — 定义一个新的操作符

Synopsis

CREATE OPERATOR name (
    PROCEDURE = function_name
    [, LEFTARG = left_type ] [, RIGHTARG = right_type ]
    [, COMMUTATOR = com_op ] [, NEGATOR = neg_op ]
    [, RESTRICT = res_proc ] [, JOIN = join_proc ]
    [, HASHES ] [, MERGES ]
)

描述

CREATE OPERATOR定义一个新的操作符 name。定义该操作符 的用户将成为其拥有者。如果给出了模式名,该操作符将在指定的模式中创建; 否则将在当前模式中创建。

操作符名称是一个字符序列,最多包含 NAMEDATALEN-1 个字符(默认为 63 个),字符取自以下列表:

+ - * / < > = ~ ! @ # % ^ & | ` ?

名称的选择有以下几项限制:

  • --/*不能出现在操作符名称的 任何位置,因为它们会被视为注释的开始。

  • 多字符操作符名称不能以+- 结尾,除非该名称中还至少包含下列字符之一:

    ~ ! @ # % ^ & | ` ?

    例如,@-是允许的操作符名称,而 *-则不允许。这一限制使 PostgreSQL能够在不要求记号之间必须有空格 的情况下解析符合 SQL 规范的命令。

  • 使用=>作为操作符名称的做法已被弃用。未来版本可能完全禁止这种用法。

输入!=时会被映射为<>, 因此这两个名称始终等效。

必须至少定义LEFTARGRIGHTARG中的一个。对于二元操作符,必须同时定义两者。对于右一元操作符,只应定义LEFTARG;对于左一元操作符,只应定义RIGHTARG

Note

右一元操作符(也称后缀操作符)已被弃用,将在PostgreSQL 14 中移除。

function_name过程必须事先已用CREATE FUNCTION定义,并且其定义必须接受正确数量(一个或两个)的指定类型参数。

其他子句用于指定可选的操作符优化属性。其含义详见 Section 37.13

要创建操作符,你必须在参数类型和返回类型上具有 USAGE权限,并在底层函数上具有 EXECUTE权限。如果指定了交换子或求反器操作符, 你还必须拥有这些操作符。

参数

name

要定义的操作符名称。允许使用的字符请见上文。该名称可以带模式限定, 例如CREATE OPERATOR myschema.+ (...)。如果不带 模式限定,该操作符将在当前模式中创建。同一模式中的两个操作符如果 针对不同的数据类型进行操作,可以具有相同的名称。这被称为 重载

function_name

用于实现该操作符的函数。

left_type

该操作符左操作数的数据类型(如果有)。对于左一元操作符,应省略此选项。

right_type

该操作符右操作数的数据类型(如果有)。对于右一元操作符,应省略此选项。

com_op

该操作符的交换子。

neg_op

该操作符的求反器。

res_proc

该操作符的限制选择度估计函数。

join_proc

该操作符的连接选择度估算函数。

HASHES

表示该操作符可以支持哈希连接。

MERGES

表示该操作符可以支持归并连接。

要在com_op或其他可选参数中给出带模式限定 的操作符名称,请使用OPERATOR()语法,例如:

COMMUTATOR = OPERATOR(myschema.===) ,

注解

更多信息请参见Section 37.12

无法在CREATE OPERATOR中指定一个操作符的 词法优先级,因为解析器的优先级行为是硬写在代码中的。详见 Section 4.1.6

废弃的选项SORT1SORT2LTCMP以及GTCMP以前被用来指定与 可归并连接的操作符相关联的排序操作符名称。现在已不再需要这样做,因 为相关操作符的信息会通过查找 B-树操作符族来获得。如果给出这些选项 中的任意一个,除了会隐式将MERGES设为真之外,其余 都会被忽略。

使用DROP OPERATOR从数据库中删除用户定义的操作符。 使用ALTER OPERATOR修改数据库中的操作符。

示例

以下命令定义一个新的面积相等操作符,适用的数据类型为 box

CREATE OPERATOR === (
    LEFTARG = box,
    RIGHTARG = box,
    PROCEDURE = area_equal_procedure,
    COMMUTATOR = ===,
    NEGATOR = !==,
    RESTRICT = area_restriction_procedure,
    JOIN = area_join_procedure,
    HASHES, MERGES
);

兼容性

CREATE OPERATORPostgreSQL扩展。在 SQL 标准中没有用户定义操作符的规定。