File: sql-createoperator.html

package info (click to toggle)
mpsql 2.1-2
links: PTS
area: non-free
in suites: potato
size: 3,528 kB
ctags: 4,886
sloc: ansic: 35,184; makefile: 3,761; sh: 44
file content (672 lines) | stat: -rw-r--r-- 12,258 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>   CREATE OPERATOR
  </TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet version 1.19"><LINK
REL="HOME"
TITLE="PostgreSQL User's Guide"
HREF="user.html"><LINK
REL="UP"
TITLE="SQL Commands"
HREF="sql-commands.html"><LINK
REL="PREVIOUS"
TITLE="   CREATE LANGUAGE
  "
HREF="sql-createlanguage.html"><LINK
REL="NEXT"
TITLE="   CREATE RULE
  "
HREF="sql-createrule.html"></HEAD
><BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PostgreSQL User's Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sql-createlanguage.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sql-createrule.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
>CREATE OPERATOR</H1
><DIV
CLASS="REFNAMEDIV"
><H2
>Name</H2
>   CREATE OPERATOR
   &#8212;    Defines a new user operator
  </DIV
><DIV
CLASS="REFSYNOPSISDIV"
><PRE
CLASS="SYNOPSIS"
>CREATE OPERATOR <TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
> (
        PROCEDURE  = <TT
CLASS="REPLACEABLE"
><I
>func_name</I
></TT
>
     [, LEFTARG    = <TT
CLASS="REPLACEABLE"
><I
>type1</I
></TT
> ]
     [, RIGHTARG   = <TT
CLASS="REPLACEABLE"
><I
>type2</I
></TT
> ]
     [, COMMUTATOR = <TT
CLASS="REPLACEABLE"
><I
>com_op</I
></TT
> ]
     [, NEGATOR    = <TT
CLASS="REPLACEABLE"
><I
>neg_op</I
></TT
> ]
     [, RESTRICT   = <TT
CLASS="REPLACEABLE"
><I
>res_proc</I
></TT
> ]
     [, HASHES ]
     [, JOIN       = <TT
CLASS="REPLACEABLE"
><I
>join_proc</I
></TT
> ]
     [, SORT       = <TT
CLASS="REPLACEABLE"
><I
>sort_op</I
></TT
> [, ...] ]
    )
  </PRE
><DIV
CLASS="REFSECT2"
><H3
>    Inputs
   </H3
><P
>   </P
><P
></P
><DL
><DT
><TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
></DT
><DD
><P
>	   The operator to be defined. See below for allowable characters.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>func_name</I
></TT
></DT
><DD
><P
>The function used to implement this operator.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>type1</I
></TT
></DT
><DD
><P
>The type for the left-hand side of the operator, if any. This option would be
omitted for a right-unary operator.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>type2</I
></TT
></DT
><DD
><P
>The type for the right-hand side of the operator, if any. This option would be
omitted for a left-unary operator.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>com_op</I
></TT
></DT
><DD
><P
>The corresponding commutative operator.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>neg_op</I
></TT
></DT
><DD
><P
>The corresponding negation operator.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>res_proc</I
></TT
></DT
><DD
><P
>The corresponding restriction operator.
	  </P
></DD
><DT
>HASHES</DT
><DD
><P
>This operator can support a hash-join algorithm.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>join_proc</I
></TT
></DT
><DD
><P
>Procedure supporting table joins.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>sort_op</I
></TT
></DT
><DD
><P
>Operator to use for sorting.
	  </P
></DD
></DL
></DIV
><DIV
CLASS="REFSECT2"
><H3
>    Outputs
   </H3
><P
>       <P
></P
></P><DL
><DT
><SPAN
CLASS="RETURNVALUE"
>CREATE</SPAN
></DT
><DD
><P
>	   Message returned if the operator is successfully created.

   </P
></DD
></DL
><P>
  </P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><H2
>   Description
  </H2
><P
><B
CLASS="COMMAND"
>CREATE OPERATOR</B
>  defines a new operator,
 <TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>.
    The user who defines an operator becomes its owner.
   </P
><P
>    The operator <TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>
 is a sequence of up to thirty two (32) characters in any combination
from the following:
<P
CLASS="LITERALLAYOUT"
>;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+&nbsp;-&nbsp;*&nbsp;/&nbsp;&lt;&nbsp;&gt;&nbsp;=&nbsp;~&nbsp;!&nbsp;@&nbsp;#&nbsp;%&nbsp;^&nbsp;&#38;&nbsp;|&nbsp;`&nbsp;?&nbsp;$&nbsp;:&nbsp;</P
>
<BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>No  alphabetic characters are allowed in an operator name.
This enables <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> to parse SQL input
into tokens without requiring spaces between each token.</P
></BLOCKQUOTE
>

   </P
><P
>   The operator "!=" is mapped to "&lt;&gt;" on input, so they are
   therefore equivalent.
  </P
><P
>   At least one of LEFTARG and RIGHTARG must be defined.  For
   binary operators, both should be defined. For right  unary
   operators,  only  LEFTARG  should  be defined, while for left
   unary operators only RIGHTARG should be defined.
  </P
><P
>Also, the
 <TT
CLASS="REPLACEABLE"
><I
>func_name</I
></TT
> procedure must have
   been previously defined using <B
CLASS="COMMAND"
>CREATE FUNCTION</B
> and  must
   be defined to accept the correct number of arguments
 (either  one or two).
  </P
><P
>   The  commutator  operator  is present so that
 <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> can
   reverse the order of the operands if it wishes.
  For example, the operator area-less-than, &lt;&lt;&lt;,
 would have a commutator
 operator, area-greater-than, &gt;&gt;&gt;.
  Hence, the query optimizer could freely  convert:
   <PRE
CLASS="PROGRAMLISTING"
>"0,0,1,1"::box  &gt;&gt;&gt; MYBOXES.description
   </PRE
>
   to
   <PRE
CLASS="PROGRAMLISTING"
>MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box</PRE
>
  </P
><P
>   This  allows  the  execution code to always use the latter
   representation and simplifies the  query  optimizer  some
   what.
  </P
><P
>  Suppose  that  an
   operator,  area-equal, ===, exists, as well as an area not
   equal, !==.
   The negator operator allows the query optimizer to convert
   <PRE
CLASS="PROGRAMLISTING"
>NOT MYBOXES.description === "0,0,1,1"::box
   </PRE
>
   to
   <PRE
CLASS="PROGRAMLISTING"
>MYBOXES.description !== "0,0,1,1"::box
   </PRE
>
  </P
><P
>   If  a  commutator  operator  name  is  supplied,  
<SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
>
   searches  for  it  in  the catalog.  If it is found and it
   does not yet have a commutator itself, then  the  commutator's
   entry is updated to have the current (new) operator
   as its commutator.  This applies to the negator, as  well.
  </P
><P
>   This  is to allow the definition of two operators that are
   the commutators or the negators of each other.  The  first
   operator should be defined without a commutator or negator
   (as appropriate).  When the second  operator  is  defined,
   name  the  first  as the commutator or negator.  The first
   will be updated as a side effect.
  </P
><P
>   The next two specifications are  present  to  support  the
   query  optimizer in performing joins.  
<SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> can always
   evaluate a join (i.e., processing a clause with two  tuple
   variables separated by an operator that returns a boolean)
   by iterative substitution [WONG76].  
In addition, <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
>
   is  planning  on  implementing a hash-join algorithm along
   the lines of [SHAP86]; however, it must know whether  this
   strategy  is  applicable.   
For example, a hash-join
   algorithm is usable for a clause of the form:
   <PRE
CLASS="PROGRAMLISTING"
>MYBOXES.description === MYBOXES2.description
   </PRE
>
   but not for a clause of the form:
   <PRE
CLASS="PROGRAMLISTING"
>MYBOXES.description &lt;&lt;&lt; MYBOXES2.description.
   </PRE
>
   The HASHES flag gives the needed information to the  query
   optimizer  concerning  whether  a  hash  join  strategy is
   usable for the operator in question.</P
><P
>   Similarly, the two sort operators indicate  to  the  query
   optimizer whether merge-sort is a usable join strategy and
   what operators should be used  to  sort  the  two  operand
   classes.   For  the  ===  clause above, the optimizer must
   sort both relations using the operator, &lt;&lt;&lt;.  On the other
   hand, merge-sort is not usable with the clause:
   <PRE
CLASS="PROGRAMLISTING"
>MYBOXES.description &lt;&lt;&lt; MYBOXES2.description
   </PRE
>
  </P
><P
>   If  other join strategies are found to be practical,
<SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
>
 will change the optimizer and run-time system to  use
   them  and  will  require  additional specification when an
   operator is defined.  Fortunately, the research  community
   invents  new  join  strategies infrequently, and the added
   generality of user-defined join strategies was not felt to
   be worth the complexity involved.
  </P
><P
>   The  last  two  pieces of the specification are present so
   the query optimizer  can  estimate  result  sizes.   If  a
   clause of the form:
   <PRE
CLASS="PROGRAMLISTING"
>MYBOXES.description &lt;&lt;&lt; "0,0,1,1"::box
   </PRE
>
   is present in the qualification,
 then <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> may have to
   estimate the fraction of the  instances  in  MYBOXES  that
   satisfy  the clause.  The function
 <TT
CLASS="REPLACEABLE"
><I
>res_proc</I
></TT
>
 must be a registered function (meaning  it  is  already  defined  using
   define function(l)) which accepts one argument of the correct
   data type and returns a floating point  number.   The
   query  optimizer  simply  calls this function, passing the
   parameter "0,0,1,1" and multiplies the result by the relation
   size to get the desired expected number of instances.
  </P
><P
>   Similarly, when the operands of the operator both  contain
   instance  variables, the query optimizer must estimate the
   size of the resulting join.  The function  join_proc  will
   return  another floating point number which will be multiplied
   by the cardinalities of the two classes involved  to
   compute the desired expected result size.
  </P
><P
>   The difference between the function
   <PRE
CLASS="PROGRAMLISTING"
>my_procedure_1 (MYBOXES.description, "0,0,1,1"::box)
   </PRE
>
   and the operator
   <PRE
CLASS="PROGRAMLISTING"
>MYBOXES.description === "0,0,1,1"::box
   </PRE
>
   is  that  <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
>
  attempts to optimize operators and can
   decide to use an index to restrict the search  space  when
   operators  are  involved.  However, there is no attempt to
   optimize functions, and they are performed by brute force.
   Moreover, functions can have any number of arguments while
   operators are restricted to one or two.
  </P
><DIV
CLASS="REFSECT2"
><H3
>    Notes
   </H3
><P
>    Refer to the chapter on operators in the
<I
CLASS="CITETITLE"
>PostgreSQL User's Guide</I
>
    for further information.
    Refer to <B
CLASS="COMMAND"
>DROP OPERATOR</B
> to delete
user-defined operators from a database.
    
  </P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><H2
>   Usage
  </H2
><P
>The following command defines a new operator,
   area-equality, for the BOX data type.
  </P
><PRE
CLASS="PROGRAMLISTING"
>CREATE OPERATOR === (
    LEFTARG = box,
    RIGHTARG = box,
    PROCEDURE = area_equal_procedure,
    COMMUTATOR = ===,
    NEGATOR = !==,
    RESTRICT = area_restriction_procedure,
    HASHES,
    JOIN = area-join-procedure,
    SORT = &#60;&#60;&#60;, &#60;&#60;&#60;)
  </PRE
></DIV
><DIV
CLASS="REFSECT1"
><H2
>   Compatibility
  </H2
><P
>   CREATE OPERATOR is a <SPAN
CLASS="PRODUCTNAME"
>Postgres</SPAN
> extension.
  </P
><DIV
CLASS="REFSECT2"
><H3
>    SQL92
   </H3
><P
>    There is no CREATE OPERATOR statement in <SPAN
CLASS="ACRONYM"
>SQL92</SPAN
>.
   </P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sql-createlanguage.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="user.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sql-createrule.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>CREATE LANGUAGE</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="sql-commands.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>CREATE RULE</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>