2025年9月25日: PostgreSQL 18 发布!
支持的版本: 当前 (18) / 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 OPERATOR CLASS

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

概要

CREATE OPERATOR CLASS name [ DEFAULT ] FOR TYPE data_type
  USING index_method [ FAMILY family_name ] AS
  {  OPERATOR strategy_number operator_name [ ( op_type, op_type ) ] [ FOR SEARCH | FOR ORDER BY sort_family_name ]
   | FUNCTION support_number [ ( op_type [ , op_type ] ) ] function_name ( argument_type [, ...] )
   | STORAGE storage_type
  } [, ... ]

描述

CREATE OPERATOR CLASS 用于创建一个新的操作符类。操作符类定义了特定数据类型如何与索引一起使用。操作符类指定某些操作符将在此数据类型和此索引方法中扮演特定角色或 策略。当操作符类被选用于索引列时,操作符类还指定了索引方法将使用的支持函数。操作符类使用的所有操作符和函数必须在创建操作符类之前定义好。

如果给出了模式名,则操作符类将在指定的模式中创建。否则,它将在当前模式中创建。同一模式下的两个操作符类可以拥有相同的名称,前提是它们是为不同的索引方法设计的。

定义操作符类的用户将成为其所有者。目前,创建用户必须是超级用户。(此限制是由于错误的 the operator class 定义可能会混淆甚至导致服务器崩溃。)

CREATE OPERATOR CLASS 目前不会检查操作符类定义是否包含索引方法所需的所有操作符和函数,也不会检查操作符和函数是否构成一个自洽的集合。用户有责任定义一个有效操作符类。

相关的操作符类可以分组到 操作符族 中。要将新的操作符类添加到现有族中,请在 CREATE OPERATOR CLASS 中指定 FAMILY 选项。如果不指定此选项,则新类将被放入一个与新类同名的族中(如果该族尚不存在,则会创建它)。

有关更多信息,请参阅第 36.16 节

参数

name

要创建的操作符类的名称。名称可以带有模式限定。

DEFAULT

如果存在,则该操作符类将成为其数据类型的默认操作符类。对于特定的数据类型和索引方法,最多只能有一个操作符类是默认的。

data_type

此操作符类所针对的列数据类型。

index_method

此操作符类所针对的索引方法的名称。

family_name

要将此操作符类添加到的现有 btree 操作符族的名称。如果未指定,则使用与操作符类同名的族(如果尚不存在,则创建它)。

strategy_number

索引方法中与操作符类关联的操作符的策略编号。

operator_name

与操作符类关联的操作符的名称(可选择带模式限定)。

op_type

OPERATOR 子句中,操作符的操作数数据类型,或 NONE 以表示前缀操作符。在操作数与操作符类的类数据类型相同的一般情况下,可以省略操作数数据类型。

FUNCTION 子句中,函数旨在支持的操作数数据类型(如果与函数的输入数据类型不同(对于 B-tree 比较函数和哈希函数)或与类的类数据类型不同(对于 B-tree 排序支持函数、B-tree 相等镜像函数以及 GiST、SP-GiST、GIN 和 BRIN 操作符类中的所有函数))。这些默认值是正确的,因此 op_typeFUNCTION 子句中不必指定,除非是用于支持跨数据类型比较的 B-tree 排序支持函数。

sort_family_name

描述与排序操作符关联的排序顺序的现有 btree 操作符族的名称(可选择带模式限定)。

如果既没有指定 FOR SEARCH 也没有指定 FOR ORDER BY,则默认为 FOR SEARCH

support_number

索引方法中与操作符类关联的函数的支持函数编号。

function_name

操作符类的索引方法支持函数的名称(可选择带模式限定)。

argument_type

函数的参数数据类型。

storage_type

实际存储在索引中的数据类型。通常这与列的数据类型相同,但某些索引方法(目前是 GiST、GIN、SP-GiST 和 BRIN)允许使用不同的类型。除非索引方法允许使用不同的类型,否则必须省略 STORAGE 子句。如果列 data_type 指定为 anyarray,则 storage_type 可以声明为 anyelement,以指示索引条目是每个特定索引所创建的实际数组类型的元素类型的成员。

OPERATORFUNCTIONSTORAGE 子句可以按任何顺序出现。

注释

由于索引机制在使用函数之前不检查其访问权限,因此将函数或操作符包含在操作符类中等同于授予其公共执行权限。对于在操作符类中有用的函数类型,这通常不是问题。

操作符不应由 SQL 函数定义。SQL 函数很可能会被内联到调用查询中,这将阻止优化器识别查询与索引匹配。

示例

下面的示例命令为 _int4int4 的数组)数据类型定义了一个 GiST 索引操作符类。完整的示例请参阅 intarray 模块。

CREATE OPERATOR CLASS gist__int_ops
    DEFAULT FOR TYPE _int4 USING gist AS
        OPERATOR        3       &&,
        OPERATOR        6       = (anyarray, anyarray),
        OPERATOR        7       @>,
        OPERATOR        8       <@,
        OPERATOR        20      @@ (_int4, query_int),
        FUNCTION        1       g_int_consistent (internal, _int4, smallint, oid, internal),
        FUNCTION        2       g_int_union (internal, internal),
        FUNCTION        3       g_int_compress (internal),
        FUNCTION        4       g_int_decompress (internal),
        FUNCTION        5       g_int_penalty (internal, internal, internal),
        FUNCTION        6       g_int_picksplit (internal, internal),
        FUNCTION        7       g_int_same (_int4, _int4, internal);

兼容性

CREATE OPERATOR CLASSPostgreSQL 的扩展。SQL 标准中没有 CREATE OPERATOR CLASS 语句。

提交更正

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