| Server IP : 103.119.228.120 / Your IP : 18.222.20.30 Web Server : Apache System : Linux v8.techscape8.com 3.10.0-1160.119.1.el7.tuxcare.els2.x86_64 #1 SMP Mon Jul 15 12:09:18 UTC 2024 x86_64 User : nobody ( 99) PHP Version : 5.6.40 Disable Function : shell_exec,symlink,system,exec,proc_get_status,proc_nice,proc_terminate,define_syslog_variables,syslog,openlog,closelog,escapeshellcmd,passthru,ocinum cols,ini_alter,leak,listen,chgrp,apache_note,apache_setenv,debugger_on,debugger_off,ftp_exec,dl,dll,myshellexec,proc_open,socket_bind,proc_close,escapeshellarg,parse_ini_filepopen,fpassthru,exec,passthru,escapeshellarg,escapeshellcmd,proc_close,proc_open,ini_alter,popen,show_source,proc_nice,proc_terminate,proc_get_status,proc_close,pfsockopen,leak,apache_child_terminate,posix_kill,posix_mkfifo,posix_setpgid,posix_setsid,posix_setuid,dl,symlink,shell_exec,system,dl,passthru,escapeshellarg,escapeshellcmd,myshellexec,c99_buff_prepare,c99_sess_put,fpassthru,getdisfunc,fx29exec,fx29exec2,is_windows,disp_freespace,fx29sh_getupdate,fx29_buff_prepare,fx29_sess_put,fx29shexit,fx29fsearch,fx29ftpbrutecheck,fx29sh_tools,fx29sh_about,milw0rm,imagez,sh_name,myshellexec,checkproxyhost,dosyayicek,c99_buff_prepare,c99_sess_put,c99getsource,c99sh_getupdate,c99fsearch,c99shexit,view_perms,posix_getpwuid,posix_getgrgid,posix_kill,parse_perms,parsesort,view_perms_color,set_encoder_input,ls_setcheckboxall,ls_reverse_all,rsg_read,rsg_glob,selfURL,dispsecinfo,unix2DosTime,addFile,system,get_users,view_size,DirFiles,DirFilesWide,DirPrintHTMLHeaders,GetFilesTotal,GetTitles,GetTimeTotal,GetMatchesCount,GetFileMatchesCount,GetResultFiles,fs_copy_dir,fs_copy_obj,fs_move_dir,fs_move_obj,fs_rmdir,SearchText,getmicrotime MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/postgresql-9.2.24/html/ |
Upload File : |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>CREATE OPERATOR</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.2.24 Documentation"
HREF="index.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 OPERATOR CLASS"
HREF="sql-createopclass.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2017-11-06T22:43:11"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.2.24 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="CREATE LANGUAGE"
HREF="sql-createlanguage.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="sql-commands.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="CREATE OPERATOR CLASS"
HREF="sql-createopclass.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SQL-CREATEOPERATOR"
></A
>CREATE OPERATOR</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN69336"
></A
><H2
>Name</H2
>CREATE OPERATOR -- define a new operator</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN69341"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>CREATE OPERATOR <TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
> (
PROCEDURE = <TT
CLASS="REPLACEABLE"
><I
>function_name</I
></TT
>
[, LEFTARG = <TT
CLASS="REPLACEABLE"
><I
>left_type</I
></TT
> ] [, RIGHTARG = <TT
CLASS="REPLACEABLE"
><I
>right_type</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
> ] [, JOIN = <TT
CLASS="REPLACEABLE"
><I
>join_proc</I
></TT
> ]
[, HASHES ] [, MERGES ]
)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN69351"
></A
><H2
>Description</H2
><P
> <TT
CLASS="COMMAND"
>CREATE OPERATOR</TT
> defines a new operator,
<TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
>. The user who
defines an operator becomes its owner. If a schema name is given
then the operator is created in the specified schema. Otherwise it
is created in the current schema.
</P
><P
> The operator name is a sequence of up to <TT
CLASS="SYMBOL"
>NAMEDATALEN</TT
>-1
(63 by default) characters from the following list:
<P
CLASS="LITERALLAYOUT"
>+ - * / < > = ~ ! @ # % ^ & | ` ?</P
>
There are a few restrictions on your choice of name:
<P
></P
></P><UL
><LI
><P
><TT
CLASS="LITERAL"
>--</TT
> and <TT
CLASS="LITERAL"
>/*</TT
> cannot appear anywhere in an operator name,
since they will be taken as the start of a comment.
</P
></LI
><LI
><P
> A multicharacter operator name cannot end in <TT
CLASS="LITERAL"
>+</TT
> or
<TT
CLASS="LITERAL"
>-</TT
>,
unless the name also contains at least one of these characters:
<P
CLASS="LITERALLAYOUT"
>~ ! @ # % ^ & | ` ?</P
>
For example, <TT
CLASS="LITERAL"
>@-</TT
> is an allowed operator name,
but <TT
CLASS="LITERAL"
>*-</TT
> is not.
This restriction allows <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> to
parse SQL-compliant commands without requiring spaces between tokens.
</P
></LI
><LI
><P
> The use of <TT
CLASS="LITERAL"
>=></TT
> as an operator name is deprecated. It may
be disallowed altogether in a future release.
</P
></LI
></UL
><P>
</P
><P
> The operator <TT
CLASS="LITERAL"
>!=</TT
> is mapped to
<TT
CLASS="LITERAL"
><></TT
> on input, so these two names are always
equivalent.
</P
><P
> At least one of <TT
CLASS="LITERAL"
>LEFTARG</TT
> and <TT
CLASS="LITERAL"
>RIGHTARG</TT
> must be defined. For
binary operators, both must be defined. For right unary
operators, only <TT
CLASS="LITERAL"
>LEFTARG</TT
> should be defined, while for left
unary operators only <TT
CLASS="LITERAL"
>RIGHTARG</TT
> should be defined.
</P
><P
> The <TT
CLASS="REPLACEABLE"
><I
>function_name</I
></TT
>
procedure must have been previously defined using <TT
CLASS="COMMAND"
>CREATE
FUNCTION</TT
> and must be defined to accept the correct number
of arguments (either one or two) of the indicated types.
</P
><P
> The other clauses specify optional operator optimization clauses.
Their meaning is detailed in <A
HREF="xoper-optimization.html"
>Section 35.13</A
>.
</P
><P
> To be able to create an operator, you must have <TT
CLASS="LITERAL"
>USAGE</TT
>
privilege on the argument types and the return type, as well
as <TT
CLASS="LITERAL"
>EXECUTE</TT
> privilege on the underlying function. If a
commutator or negator operator is specified, you must own these operators.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN69391"
></A
><H2
>Parameters</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
></DT
><DD
><P
> The name of the operator to be defined. See above for allowable
characters. The name can be schema-qualified, for example
<TT
CLASS="LITERAL"
>CREATE OPERATOR myschema.+ (...)</TT
>. If not, then
the operator is created in the current schema. Two operators
in the same schema can have the same name if they operate on
different data types. This is called
<I
CLASS="FIRSTTERM"
>overloading</I
>.
</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>function_name</I
></TT
></DT
><DD
><P
> The function used to implement this operator.
</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>left_type</I
></TT
></DT
><DD
><P
> The data type of the operator's left operand, if any.
This option would be omitted for a left-unary operator.
</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>right_type</I
></TT
></DT
><DD
><P
> The data type of the operator's right operand, if any.
This option would be omitted for a right-unary operator.
</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>com_op</I
></TT
></DT
><DD
><P
> The commutator of this operator.
</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>neg_op</I
></TT
></DT
><DD
><P
> The negator of this operator.
</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>res_proc</I
></TT
></DT
><DD
><P
> The restriction selectivity estimator function for this operator.
</P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>join_proc</I
></TT
></DT
><DD
><P
> The join selectivity estimator function for this operator.
</P
></DD
><DT
><TT
CLASS="LITERAL"
>HASHES</TT
></DT
><DD
><P
> Indicates this operator can support a hash join.
</P
></DD
><DT
><TT
CLASS="LITERAL"
>MERGES</TT
></DT
><DD
><P
> Indicates this operator can support a merge join.
</P
></DD
></DL
></DIV
><P
> To give a schema-qualified operator name in <TT
CLASS="REPLACEABLE"
><I
>com_op</I
></TT
> or the other optional
arguments, use the <TT
CLASS="LITERAL"
>OPERATOR()</TT
> syntax, for example:
</P><PRE
CLASS="PROGRAMLISTING"
>COMMUTATOR = OPERATOR(myschema.===) ,</PRE
><P></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN69450"
></A
><H2
>Notes</H2
><P
> Refer to <A
HREF="xoper.html"
>Section 35.12</A
> for further information.
</P
><P
> It is not possible to specify an operator's lexical precedence in
<TT
CLASS="COMMAND"
>CREATE OPERATOR</TT
>, because the parser's precedence behavior
is hard-wired. See <A
HREF="sql-syntax-lexical.html#SQL-PRECEDENCE"
>Section 4.1.6</A
> for precedence details.
</P
><P
> The obsolete options <TT
CLASS="LITERAL"
>SORT1</TT
>, <TT
CLASS="LITERAL"
>SORT2</TT
>,
<TT
CLASS="LITERAL"
>LTCMP</TT
>, and <TT
CLASS="LITERAL"
>GTCMP</TT
> were formerly used to
specify the names of sort operators associated with a merge-joinable
operator. This is no longer necessary, since information about
associated operators is found by looking at B-tree operator families
instead. If one of these options is given, it is ignored except
for implicitly setting <TT
CLASS="LITERAL"
>MERGES</TT
> true.
</P
><P
> Use <A
HREF="sql-dropoperator.html"
>DROP OPERATOR</A
> to delete user-defined operators
from a database. Use <A
HREF="sql-alteroperator.html"
>ALTER OPERATOR</A
> to modify operators in a
database.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN69466"
></A
><H2
>Examples</H2
><P
> The following command defines a new operator, area-equality, for
the data type <TT
CLASS="TYPE"
>box</TT
>:
</P><PRE
CLASS="PROGRAMLISTING"
>CREATE OPERATOR === (
LEFTARG = box,
RIGHTARG = box,
PROCEDURE = area_equal_procedure,
COMMUTATOR = ===,
NEGATOR = !==,
RESTRICT = area_restriction_procedure,
JOIN = area_join_procedure,
HASHES, MERGES
);</PRE
><P></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN69471"
></A
><H2
>Compatibility</H2
><P
> <TT
CLASS="COMMAND"
>CREATE OPERATOR</TT
> is a
<SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> extension. There are no
provisions for user-defined operators in the SQL standard.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN69476"
></A
><H2
>See Also</H2
><A
HREF="sql-alteroperator.html"
>ALTER OPERATOR</A
>, <A
HREF="sql-createopclass.html"
>CREATE OPERATOR CLASS</A
>, <A
HREF="sql-dropoperator.html"
>DROP OPERATOR</A
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sql-createlanguage.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sql-createopclass.html"
ACCESSKEY="N"
>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"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>CREATE OPERATOR CLASS</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>