begriffs open source - ai-pg/blob - full-docs/txt/sql-createopfamily.txt

   1
   2 CREATE OPERATOR FAMILY
   3
   4    CREATE OPERATOR FAMILY — define a new operator family
   5
   6 Synopsis
   7
   8 CREATE OPERATOR FAMILY name USING index_method
   9
  10 Description
  11
  12    CREATE OPERATOR FAMILY creates a new operator family. An operator
  13    family defines a collection of related operator classes, and perhaps
  14    some additional operators and support functions that are compatible
  15    with these operator classes but not essential for the functioning of
  16    any individual index. (Operators and functions that are essential to
  17    indexes should be grouped within the relevant operator class, rather
  18    than being “loose” in the operator family. Typically, single-data-type
  19    operators are bound to operator classes, while cross-data-type
  20    operators can be loose in an operator family containing operator
  21    classes for both data types.)
  22
  23    The new operator family is initially empty. It should be populated by
  24    issuing subsequent CREATE OPERATOR CLASS commands to add contained
  25    operator classes, and optionally ALTER OPERATOR FAMILY commands to add
  26    “loose” operators and their corresponding support functions.
  27
  28    If a schema name is given then the operator family is created in the
  29    specified schema. Otherwise it is created in the current schema. Two
  30    operator families in the same schema can have the same name only if
  31    they are for different index methods.
  32
  33    The user who defines an operator family becomes its owner. Presently,
  34    the creating user must be a superuser. (This restriction is made
  35    because an erroneous operator family definition could confuse or even
  36    crash the server.)
  37
  38    Refer to Section 36.16 for further information.
  39
  40 Parameters
  41
  42    name
  43           The name of the operator family to be created. The name can be
  44           schema-qualified.
  45
  46    index_method
  47           The name of the index method this operator family is for.
  48
  49 Compatibility
  50
  51    CREATE OPERATOR FAMILY is a PostgreSQL extension. There is no CREATE
  52    OPERATOR FAMILY statement in the SQL standard.
  53
  54 See Also
  55
  56    ALTER OPERATOR FAMILY, DROP OPERATOR FAMILY, CREATE OPERATOR CLASS,
  57    ALTER OPERATOR CLASS, DROP OPERATOR CLASS