Sophie: postgresql9.4-docs-9.4.15-1.mga6 noarch

postgresql9.4-docs-9.4.15-1.mga6.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>pg_proc</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.4.15 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="System Catalogs"
HREF="catalogs.html"><LINK
REL="PREVIOUS"
TITLE="pg_pltemplate"
HREF="catalog-pg-pltemplate.html"><LINK
REL="NEXT"
TITLE="pg_range"
HREF="catalog-pg-range.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-10T00:43:05"></HEAD
><BODY
CLASS="SECT1"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="4"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.4.15 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="pg_pltemplate"
HREF="catalog-pg-pltemplate.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="catalogs.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
>Chapter 48. System Catalogs</TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="pg_range"
HREF="catalog-pg-range.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CATALOG-PG-PROC"
>48.36. <TT
CLASS="STRUCTNAME"
>pg_proc</TT
></A
></H1
><P
>   The catalog <TT
CLASS="STRUCTNAME"
>pg_proc</TT
> stores information about functions (or procedures).
   See <A
HREF="sql-createfunction.html"
>CREATE FUNCTION</A
>
   and <A
HREF="xfunc.html"
>Section 35.3</A
> for more information.
  </P
><P
>   The table contains data for aggregate functions as well as plain functions.
   If <TT
CLASS="STRUCTFIELD"
>proisagg</TT
> is true, there should be a matching
   row in <TT
CLASS="STRUCTFIELD"
>pg_aggregate</TT
>.
  </P
><DIV
CLASS="TABLE"
><A
NAME="AEN99159"
></A
><P
><B
>Table 48-36. <TT
CLASS="STRUCTNAME"
>pg_proc</TT
> Columns</B
></P
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><COL><COL><THEAD
><TR
><TH
>Name</TH
><TH
>Type</TH
><TH
>References</TH
><TH
>Description</TH
></TR
></THEAD
><TBODY
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>oid</TT
></TD
><TD
><TT
CLASS="TYPE"
>oid</TT
></TD
><TD
>&nbsp;</TD
><TD
>Row identifier (hidden attribute; must be explicitly selected)</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proname</TT
></TD
><TD
><TT
CLASS="TYPE"
>name</TT
></TD
><TD
>&nbsp;</TD
><TD
>Name of the function</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>pronamespace</TT
></TD
><TD
><TT
CLASS="TYPE"
>oid</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-namespace.html"
><TT
CLASS="STRUCTNAME"
>pg_namespace</TT
></A
>.oid</TT
></TD
><TD
>       The OID of the namespace that contains this function
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proowner</TT
></TD
><TD
><TT
CLASS="TYPE"
>oid</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-authid.html"
><TT
CLASS="STRUCTNAME"
>pg_authid</TT
></A
>.oid</TT
></TD
><TD
>Owner of the function</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>prolang</TT
></TD
><TD
><TT
CLASS="TYPE"
>oid</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-language.html"
><TT
CLASS="STRUCTNAME"
>pg_language</TT
></A
>.oid</TT
></TD
><TD
>Implementation language or call interface of this function</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>procost</TT
></TD
><TD
><TT
CLASS="TYPE"
>float4</TT
></TD
><TD
>&nbsp;</TD
><TD
>Estimated execution cost (in units of
       <A
HREF="runtime-config-query.html#GUC-CPU-OPERATOR-COST"
>cpu_operator_cost</A
>); if <TT
CLASS="STRUCTFIELD"
>proretset</TT
>,
       this is cost per row returned</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>prorows</TT
></TD
><TD
><TT
CLASS="TYPE"
>float4</TT
></TD
><TD
>&nbsp;</TD
><TD
>Estimated number of result rows (zero if not <TT
CLASS="STRUCTFIELD"
>proretset</TT
>)</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>provariadic</TT
></TD
><TD
><TT
CLASS="TYPE"
>oid</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-type.html"
><TT
CLASS="STRUCTNAME"
>pg_type</TT
></A
>.oid</TT
></TD
><TD
>Data type of the variadic array parameter's elements,
       or zero if the function does not have a variadic parameter</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>protransform</TT
></TD
><TD
><TT
CLASS="TYPE"
>regproc</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-proc.html"
><TT
CLASS="STRUCTNAME"
>pg_proc</TT
></A
>.oid</TT
></TD
><TD
>Calls to this function can be simplified by this other function
       (see <A
HREF="xfunc-c.html#XFUNC-TRANSFORM-FUNCTIONS"
>Section 35.9.11</A
>)</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proisagg</TT
></TD
><TD
><TT
CLASS="TYPE"
>bool</TT
></TD
><TD
>&nbsp;</TD
><TD
>Function is an aggregate function</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proiswindow</TT
></TD
><TD
><TT
CLASS="TYPE"
>bool</TT
></TD
><TD
>&nbsp;</TD
><TD
>Function is a window function</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>prosecdef</TT
></TD
><TD
><TT
CLASS="TYPE"
>bool</TT
></TD
><TD
>&nbsp;</TD
><TD
>Function is a security definer (i.e., a <SPAN
CLASS="QUOTE"
>"setuid"</SPAN
>
      function)</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proleakproof</TT
></TD
><TD
><TT
CLASS="TYPE"
>bool</TT
></TD
><TD
>&nbsp;</TD
><TD
>       The function has no side effects.  No information about the
       arguments is conveyed except via the return value.  Any function
       that might throw an error depending on the values of its arguments
       is not leak-proof.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proisstrict</TT
></TD
><TD
><TT
CLASS="TYPE"
>bool</TT
></TD
><TD
>&nbsp;</TD
><TD
>       Function returns null if any call argument is null.  In that
       case the function won't actually be called at all.  Functions
       that are not <SPAN
CLASS="QUOTE"
>"strict"</SPAN
> must be prepared to handle
       null inputs.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proretset</TT
></TD
><TD
><TT
CLASS="TYPE"
>bool</TT
></TD
><TD
>&nbsp;</TD
><TD
>Function returns a set (i.e., multiple values of the specified
      data type)</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>provolatile</TT
></TD
><TD
><TT
CLASS="TYPE"
>char</TT
></TD
><TD
>&nbsp;</TD
><TD
>       <TT
CLASS="STRUCTFIELD"
>provolatile</TT
> tells whether the function's
       result depends only on its input arguments, or is affected by outside
       factors.
       It is <TT
CLASS="LITERAL"
>i</TT
> for <SPAN
CLASS="QUOTE"
>"immutable"</SPAN
> functions,
       which always deliver the same result for the same inputs.
       It is <TT
CLASS="LITERAL"
>s</TT
> for <SPAN
CLASS="QUOTE"
>"stable"</SPAN
> functions,
       whose results (for fixed inputs) do not change within a scan.
       It is <TT
CLASS="LITERAL"
>v</TT
> for <SPAN
CLASS="QUOTE"
>"volatile"</SPAN
> functions,
       whose results might change at any time.  (Use <TT
CLASS="LITERAL"
>v</TT
> also
       for functions with side-effects, so that calls to them cannot get
       optimized away.)
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>pronargs</TT
></TD
><TD
><TT
CLASS="TYPE"
>int2</TT
></TD
><TD
>&nbsp;</TD
><TD
>Number of input arguments</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>pronargdefaults</TT
></TD
><TD
><TT
CLASS="TYPE"
>int2</TT
></TD
><TD
>&nbsp;</TD
><TD
>Number of arguments that have defaults</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>prorettype</TT
></TD
><TD
><TT
CLASS="TYPE"
>oid</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-type.html"
><TT
CLASS="STRUCTNAME"
>pg_type</TT
></A
>.oid</TT
></TD
><TD
>Data type of the return value</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proargtypes</TT
></TD
><TD
><TT
CLASS="TYPE"
>oidvector</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-type.html"
><TT
CLASS="STRUCTNAME"
>pg_type</TT
></A
>.oid</TT
></TD
><TD
>       An array with the data types of the function arguments.  This includes
       only input arguments (including <TT
CLASS="LITERAL"
>INOUT</TT
> and
       <TT
CLASS="LITERAL"
>VARIADIC</TT
> arguments), and thus represents
       the call signature of the function.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proallargtypes</TT
></TD
><TD
><TT
CLASS="TYPE"
>oid[]</TT
></TD
><TD
><TT
CLASS="LITERAL"
><A
HREF="catalog-pg-type.html"
><TT
CLASS="STRUCTNAME"
>pg_type</TT
></A
>.oid</TT
></TD
><TD
>       An array with the data types of the function arguments.  This includes
       all arguments (including <TT
CLASS="LITERAL"
>OUT</TT
> and
       <TT
CLASS="LITERAL"
>INOUT</TT
> arguments); however, if all the
       arguments are <TT
CLASS="LITERAL"
>IN</TT
> arguments, this field will be null.
       Note that subscripting is 1-based, whereas for historical reasons
       <TT
CLASS="STRUCTFIELD"
>proargtypes</TT
> is subscripted from 0.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proargmodes</TT
></TD
><TD
><TT
CLASS="TYPE"
>char[]</TT
></TD
><TD
>&nbsp;</TD
><TD
>        An array with the modes of the function arguments, encoded as
        <TT
CLASS="LITERAL"
>i</TT
> for <TT
CLASS="LITERAL"
>IN</TT
> arguments,
        <TT
CLASS="LITERAL"
>o</TT
> for <TT
CLASS="LITERAL"
>OUT</TT
> arguments,
        <TT
CLASS="LITERAL"
>b</TT
> for <TT
CLASS="LITERAL"
>INOUT</TT
> arguments,
        <TT
CLASS="LITERAL"
>v</TT
> for <TT
CLASS="LITERAL"
>VARIADIC</TT
> arguments,
        <TT
CLASS="LITERAL"
>t</TT
> for <TT
CLASS="LITERAL"
>TABLE</TT
> arguments.
        If all the arguments are <TT
CLASS="LITERAL"
>IN</TT
> arguments,
        this field will be null.
        Note that subscripts correspond to positions of
        <TT
CLASS="STRUCTFIELD"
>proallargtypes</TT
> not <TT
CLASS="STRUCTFIELD"
>proargtypes</TT
>.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proargnames</TT
></TD
><TD
><TT
CLASS="TYPE"
>text[]</TT
></TD
><TD
>&nbsp;</TD
><TD
>        An array with the names of the function arguments.
        Arguments without a name are set to empty strings in the array.
        If none of the arguments have a name, this field will be null.
        Note that subscripts correspond to positions of
        <TT
CLASS="STRUCTFIELD"
>proallargtypes</TT
> not <TT
CLASS="STRUCTFIELD"
>proargtypes</TT
>.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proargdefaults</TT
></TD
><TD
><TT
CLASS="TYPE"
>pg_node_tree</TT
></TD
><TD
>&nbsp;</TD
><TD
>       Expression trees (in <CODE
CLASS="FUNCTION"
>nodeToString()</CODE
> representation)
       for default values.  This is a list with
       <TT
CLASS="STRUCTFIELD"
>pronargdefaults</TT
> elements, corresponding to the last
       <TT
CLASS="REPLACEABLE"
><I
>N</I
></TT
> <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>input</I
></SPAN
> arguments (i.e., the last
       <TT
CLASS="REPLACEABLE"
><I
>N</I
></TT
> <TT
CLASS="STRUCTFIELD"
>proargtypes</TT
> positions).
       If none of the arguments have defaults, this field will be null.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>prosrc</TT
></TD
><TD
><TT
CLASS="TYPE"
>text</TT
></TD
><TD
>&nbsp;</TD
><TD
>       This tells the function handler how to invoke the function.  It
       might be the actual source code of the function for interpreted
       languages, a link symbol, a file name, or just about anything
       else, depending on the implementation language/call convention.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>probin</TT
></TD
><TD
><TT
CLASS="TYPE"
>text</TT
></TD
><TD
>&nbsp;</TD
><TD
>       Additional information about how to invoke the function.
       Again, the interpretation is language-specific.
      </TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proconfig</TT
></TD
><TD
><TT
CLASS="TYPE"
>text[]</TT
></TD
><TD
>&nbsp;</TD
><TD
>Function's local settings for run-time configuration variables</TD
></TR
><TR
><TD
><TT
CLASS="STRUCTFIELD"
>proacl</TT
></TD
><TD
><TT
CLASS="TYPE"
>aclitem[]</TT
></TD
><TD
>&nbsp;</TD
><TD
>       Access privileges; see
       <A
HREF="sql-grant.html"
>GRANT</A
> and
       <A
HREF="sql-revoke.html"
>REVOKE</A
>
       for details
      </TD
></TR
></TBODY
></TABLE
></DIV
><P
>   For compiled functions, both built-in and dynamically loaded,
   <TT
CLASS="STRUCTFIELD"
>prosrc</TT
> contains the function's C-language
   name (link symbol).  For all other currently-known language types,
   <TT
CLASS="STRUCTFIELD"
>prosrc</TT
> contains the function's source
   text.  <TT
CLASS="STRUCTFIELD"
>probin</TT
> is unused except for
   dynamically-loaded C functions, for which it gives the name of the
   shared library file containing the function.
  </P
></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="catalog-pg-pltemplate.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="catalog-pg-range.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><TT
CLASS="STRUCTNAME"
>pg_pltemplate</TT
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="catalogs.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><TT
CLASS="STRUCTNAME"
>pg_range</TT
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>