-<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.532 2010/09/03 01:34:54 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.533 2010/09/09 00:48:22 momjian Exp $ -->
<chapter id="functions">
<title>Functions and Operators</title>
<tbody>
<row>
- <entry><literal><function>abs</>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>abs(<replaceable>x</replaceable>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>absolute value</entry>
<entry><literal>abs(-17.4)</literal></entry>
</row>
<row>
- <entry><literal><function>cbrt</function>(<type>dp</type>)</literal></entry>
+ <entry><literal><function>cbrt(<type>dp</type>)</function></literal></entry>
<entry><type>dp</type></entry>
<entry>cube root</entry>
<entry><literal>cbrt(27.0)</literal></entry>
</row>
<row>
- <entry><literal><function>ceil</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>ceil(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>smallest integer not less than argument</entry>
<entry><literal>ceil(-42.8)</literal></entry>
</row>
<row>
- <entry><literal><function>ceiling</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>ceiling(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>smallest integer not less than argument (alias for <function>ceil</function>)</entry>
<entry><literal>ceiling(-95.3)</literal></entry>
</row>
<row>
- <entry><literal><function>degrees</function>(<type>dp</type>)</literal></entry>
+ <entry><literal><function>degrees(<type>dp</type>)</function></literal></entry>
<entry><type>dp</type></entry>
<entry>radians to degrees</entry>
<entry><literal>degrees(0.5)</literal></entry>
</row>
<row>
- <entry><literal><function>div
</function>(<parameter>y</parameter> <type>numeric</>,
- <parameter>x</parameter> <type>numeric</>)</literal></entry>
+ <entry><literal><function>div(<parameter>y</parameter> <type>numeric</>,
+ <parameter>x</parameter> <type>numeric</>)</function></literal></entry>
<entry><type>numeric</></entry>
<entry>integer quotient of <parameter>y</parameter>/<parameter>x</parameter></entry>
<entry><literal>div(9,4)</literal></entry>
</row>
<row>
- <entry><literal><function>exp</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>exp(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>exponential</entry>
<entry><literal>exp(1.0)</literal></entry>
</row>
<row>
- <entry><literal><function>floor</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>floor(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>largest integer not greater than argument</entry>
<entry><literal>floor(-42.8)</literal></entry>
</row>
<row>
- <entry><literal><function>ln</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>ln(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>natural logarithm</entry>
<entry><literal>ln(2.0)</literal></entry>
</row>
<row>
- <entry><literal><function>log</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>log(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>base 10 logarithm</entry>
<entry><literal>log(100.0)</literal></entry>
</row>
<row>
- <entry><literal><function>log
</function>(<parameter>b</parameter> <type>numeric</type>,
- <parameter>x</parameter> <type>numeric</type>)</literal></entry>
+ <entry><literal><function>log(<parameter>b</parameter> <type>numeric</type>,
+ <parameter>x</parameter> <type>numeric</type>)</function></literal></entry>
<entry><type>numeric</type></entry>
<entry>logarithm to base <parameter>b</parameter></entry>
<entry><literal>log(2.0, 64.0)</literal></entry>
</row>
<row>
- <entry><literal><function>mod
</function>(<parameter>y</parameter>,
- <parameter>x</parameter>)</literal></entry>
+ <entry><literal><function>mod(<parameter>y</parameter>,
+ <parameter>x</parameter>)</function></literal></entry>
<entry>(same as argument types)</entry>
<entry>remainder of <parameter>y</parameter>/<parameter>x</parameter></entry>
<entry><literal>mod(9,4)</literal></entry>
</row>
<row>
- <entry><literal><function>pi</function>()</literal></entry>
+ <entry><literal><function>pi()</function></literal></entry>
<entry><type>dp</type></entry>
<entry><quote>π</quote> constant</entry>
<entry><literal>pi()</literal></entry>
</row>
<row>
- <entry><literal><function>power
</function>(<parameter>a</parameter> <type>dp</type>,
- <parameter>b</parameter> <type>dp</type>)</literal></entry>
+ <entry><literal><function>power(<parameter>a</parameter> <type>dp</type>,
+ <parameter>b</parameter> <type>dp</type>)</function></literal></entry>
<entry><type>dp</type></entry>
<entry><parameter>a</> raised to the power of <parameter>b</parameter></entry>
<entry><literal>power(9.0, 3.0)</literal></entry>
</row>
<row>
- <entry><literal><function>power
</function>(<parameter>a</parameter> <type>numeric</type>,
- <parameter>b</parameter> <type>numeric</type>)</literal></entry>
+ <entry><literal><function>power(<parameter>a</parameter> <type>numeric</type>,
+ <parameter>b</parameter> <type>numeric</type>)</function></literal></entry>
<entry><type>numeric</type></entry>
<entry><parameter>a</> raised to the power of <parameter>b</parameter></entry>
<entry><literal>power(9.0, 3.0)</literal></entry>
</row>
<row>
- <entry><literal><function>radians</function>(<type>dp</type>)</literal></entry>
+ <entry><literal><function>radians(<type>dp</type>)</function></literal></entry>
<entry><type>dp</type></entry>
<entry>degrees to radians</entry>
<entry><literal>radians(45.0)</literal></entry>
</row>
<row>
- <entry><literal><function>random</function>()</literal></entry>
+ <entry><literal><function>random()</function></literal></entry>
<entry><type>dp</type></entry>
<entry>random value in the range 0.0 <= x < 1.0</entry>
<entry><literal>random()</literal></entry>
</row>
<row>
- <entry><literal><function>round</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>round(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>round to nearest integer</entry>
<entry><literal>round(42.4)</literal></entry>
</row>
<row>
- <entry><literal><function>round</function>(<parameter>v</parameter> <type>numeric</type>, <parameter>s</parameter> <type>int</type>)</literal></entry>
+ <entry><literal><function>round(<parameter>v</parameter> <type>numeric</type>, <parameter>s</parameter> <type>int</type>)</function></literal></entry>
<entry><type>numeric</type></entry>
<entry>round to <parameter>s</parameter> decimal places</entry>
<entry><literal>round(42.4382, 2)</literal></entry>
</row>
<row>
- <entry><literal><function>setseed</function>(<type>dp</type>)</literal></entry>
+ <entry><literal><function>setseed(<type>dp</type>)</function></literal></entry>
<entry><type>void</type></entry>
<entry>set seed for subsequent <literal>random()</literal> calls (value between -1.0 and
1.0, inclusive)</entry>
</row>
<row>
- <entry><literal><function>sign</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>sign(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>sign of the argument (-1, 0, +1)</entry>
<entry><literal>sign(-8.4)</literal></entry>
</row>
<row>
- <entry><literal><function>sqrt</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>sqrt(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>square root</entry>
<entry><literal>sqrt(2.0)</literal></entry>
</row>
<row>
- <entry><literal><function>trunc</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
+ <entry><literal><function>trunc(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry>
<entry>truncate toward zero</entry>
<entry><literal>trunc(42.8)</literal></entry>
</row>
<row>
- <entry><literal><function>trunc</function>(<parameter>v</parameter> <type>numeric</type>, <parameter>s</parameter> <type>int</type>)</literal></entry>
+ <entry><literal><function>trunc(<parameter>v</parameter> <type>numeric</type>, <parameter>s</parameter> <type>int</type>)</function></literal></entry>
<entry><type>numeric</type></entry>
<entry>truncate to <parameter>s</parameter> decimal places</entry>
<entry><literal>trunc(42.4382, 2)</literal></entry>
</row>
<row>
- <entry><literal><function>width_bucket</function>(<parameter>op</parameter> <type>numeric</type>, <parameter>b1</parameter> <type>numeric</type>, <parameter>b2</parameter> <type>numeric</type>, <parameter>count</parameter> <type>int</type>)</literal></entry>
+ <entry><literal><function>width_bucket(<parameter>op</parameter> <type>numeric</type>, <parameter>b1</parameter> <type>numeric</type>, <parameter>b2</parameter> <type>numeric</type>, <parameter>count</parameter> <type>int</type>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>return the bucket to which <parameter>operand</> would
be assigned in an equidepth histogram with <parameter>count</>
</row>
<row>
- <entry><literal><function>width_bucket</function>(<parameter>op</parameter> <type>dp</type>, <parameter>b1</parameter> <type>dp</type>, <parameter>b2</parameter> <type>dp</type>, <parameter>count</parameter> <type>int</type>)</literal></entry>
+ <entry><literal><function>width_bucket(<parameter>op</parameter> <type>dp</type>, <parameter>b1</parameter> <type>dp</type>, <parameter>b2</parameter> <type>dp</type>, <parameter>count</parameter> <type>int</type>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>return the bucket to which <parameter>operand</> would
be assigned in an equidepth histogram with <parameter>count</>
precision</type>. Trigonometric functions arguments are expressed
in radians. Inverse functions return values are expressed in
radians. See unit transformation functions
- <literal><function>radians</function>()</literal> and
- <literal><function>degrees</function>()</literal> above.
+ <literal><function>radians()</function></literal> and
+ <literal><function>degrees()</function></literal> above.
</para>
<indexterm>
<tbody>
<row>
- <entry><literal><function>acos</function>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>acos(<replaceable>x</replaceable>)</function></literal></entry>
<entry>inverse cosine</entry>
</row>
<row>
- <entry><literal><function>asin</function>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>asin(<replaceable>x</replaceable>)</function></literal></entry>
<entry>inverse sine</entry>
</row>
<row>
- <entry><literal><function>atan</function>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>atan(<replaceable>x</replaceable>)</function></literal></entry>
<entry>inverse tangent</entry>
</row>
<row>
- <entry><literal><function>atan2</function>(<replaceable>y</replaceable>,
- <replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>atan2(<replaceable>y</replaceable>,
+ <replaceable>x</replaceable>)</function></literal></entry>
<entry>inverse tangent of
<literal><replaceable>y</replaceable>/<replaceable>x</replaceable></literal></entry>
</row>
<row>
- <entry><literal><function>cos</function>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>cos(<replaceable>x</replaceable>)</function></literal></entry>
<entry>cosine</entry>
</row>
<row>
- <entry><literal><function>cot</function>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>cot(<replaceable>x</replaceable>)</function></literal></entry>
<entry>cotangent</entry>
</row>
<row>
- <entry><literal><function>sin</function>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>sin(<replaceable>x</replaceable>)</function></literal></entry>
<entry>sine</entry>
</row>
<row>
- <entry><literal><function>tan</function>(<replaceable>x</replaceable>)</literal></entry>
+ <entry><literal><function>tan(<replaceable>x</replaceable>)</function></literal></entry>
<entry>tangent</entry>
</row>
</tbody>
</row>
<row>
- <entry><literal><function>bit_length</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>bit_length(<parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>Number of bits in string</entry>
<entry><literal>bit_length('jose')</literal></entry>
</row>
<row>
- <entry><literal><function>char_length</function>(<parameter>string</parameter>)</literal> or <literal><function>character_length</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>char_length(<parameter>string</parameter>)</function></literal> or <literal><function>character_length(<parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>
Number of characters in string
</row>
<row>
- <entry><literal><function>lower</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>lower(<parameter>string</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>Convert string to lower case</entry>
<entry><literal>lower('TOM')</literal></entry>
</row>
<row>
- <entry><literal><function>octet_length</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>octet_length(<parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>Number of bytes in string</entry>
<entry><literal>octet_length('jose')</literal></entry>
</row>
<row>
- <entry><literal><function>overlay</function>(<parameter>string</parameter> placing <parameter>string</parameter> from <type>int</type> <optional>for <type>int</type></optional>)</literal></entry>
+ <entry><literal><function>overlay(<parameter>string</parameter> placing <parameter>string</parameter> from <type>int</type> <optional>for <type>int</type></optional>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Replace substring
</row>
<row>
- <entry><literal><function>position</function>(<parameter>substring</parameter> in <parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>position(<parameter>substring</parameter> in <parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>Location of specified substring</entry>
<entry><literal>position('om' in 'Thomas')</literal></entry>
</row>
<row>
- <entry><literal><function>substring</function>(<parameter>string</parameter> <optional>from <type>int</type></optional> <optional>for <type>int</type></optional>)</literal></entry>
+ <entry><literal><function>substring(<parameter>string</parameter> <optional>from <type>int</type></optional> <optional>for <type>int</type></optional>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Extract substring
</row>
<row>
- <entry><literal><function>substring</function>(<parameter>string</parameter> from <replaceable>pattern</replaceable>)</literal></entry>
+ <entry><literal><function>substring(<parameter>string</parameter> from <replaceable>pattern</replaceable>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Extract substring matching POSIX regular expression. See
</row>
<row>
- <entry><literal><function>substring</function>(<parameter>string</parameter> from <replaceable>pattern</replaceable> for <replaceable>escape</replaceable>)</literal></entry>
+ <entry><literal><function>substring(<parameter>string</parameter> from <replaceable>pattern</replaceable> for <replaceable>escape</replaceable>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Extract substring matching <acronym>SQL</acronym> regular expression.
<row>
<entry>
- <literal><function>trim</function>(<optional>leading | trailing | both</optional>
+ <literal><function>trim(<optional>leading | trailing | both</optional>
<optional><parameter>characters</parameter></optional> from
- <parameter>string</parameter>)</literal>
+ <parameter>string</parameter>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>upper</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>upper(<parameter>string</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>Convert string to upper case</entry>
<entry><literal>upper('tom')</literal></entry>
<tbody>
<row>
- <entry><literal><function>ascii</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>ascii(<parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>
<acronym>ASCII</acronym> code of the first character of the
</row>
<row>
- <entry><literal><function>btrim
</function>(<parameter>string</parameter> <type>text</type>
- <optional>, <parameter>characters</parameter> <type>text</type></optional>)</literal></entry>
+ <entry><literal><function>btrim(<parameter>string</parameter> <type>text</type>
+ <optional>, <parameter>characters</parameter> <type>text</type></optional>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Remove the longest string consisting only of characters
</row>
<row>
- <entry><literal><function>chr</function>(<type>int</type>)</literal></entry>
+ <entry><literal><function>chr(<type>int</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Character with the given code. For <acronym>UTF8</acronym> the
<row>
<entry>
- <literal><function>concat
</function>(<parameter>str</parameter> <type>"any"</type>
- [, <parameter>str</parameter> <type>"any"</type> [, ...] ])</literal>
+ <literal><function>concat(<parameter>str</parameter> <type>"any"</type>
+ [, <parameter>str</parameter> <type>"any"</type> [, ...] ])</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
<row>
<entry>
- <literal><function>concat_ws
</function>(<parameter>sep</parameter> <type>text</type>,
+ <literal><function>concat_ws(<parameter>sep</parameter> <type>text</type>,
<parameter>str</parameter> <type>"any"</type>
- [, <parameter>str</parameter> <type>"any"</type> [, ...] ])</literal>
+ [, <parameter>str</parameter> <type>"any"</type> [, ...] ])</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
<row>
<entry>
- <literal><function>convert
</function>(<parameter>string</parameter> <type>bytea</type>,
+ <literal><function>convert(<parameter>string</parameter> <type>bytea</type>,
<parameter>src_encoding</parameter> <type>name</type>,
- <parameter>dest_encoding</parameter> <type>name</type>)</literal>
+ <parameter>dest_encoding</parameter> <type>name</type>)</function></literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
<row>
<entry>
- <literal><function>convert_from
</function>(<parameter>string</parameter> <type>bytea</type>,
- <parameter>src_encoding</parameter> <type>name</type>)</literal>
+ <literal><function>convert_from(<parameter>string</parameter> <type>bytea</type>,
+ <parameter>src_encoding</parameter> <type>name</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
<row>
<entry>
- <literal><function>convert_to
</function>(<parameter>string</parameter> <type>text</type>,
- <parameter>dest_encoding</parameter> <type>name</type>)</literal>
+ <literal><function>convert_to(<parameter>string</parameter> <type>text</type>,
+ <parameter>dest_encoding</parameter> <type>name</type>)</function></literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
<row>
<entry>
- <literal><function>decode
</function>(<parameter>string</parameter> <type>text</type>,
- <parameter>type</parameter> <type>text</type>)</literal>
+ <literal><function>decode(<parameter>string</parameter> <type>text</type>,
+ <parameter>type</parameter> <type>text</type>)</function></literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
<row>
<entry>
- <literal><function>encode
</function>(<parameter>data</parameter> <type>bytea</type>,
- <parameter>type</parameter> <type>text</type>)</literal>
+ <literal><function>encode(<parameter>data</parameter> <type>bytea</type>,
+ <parameter>type</parameter> <type>text</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>initcap</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>initcap(<parameter>string</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Convert the first letter of each word to upper case and the
<row>
<entry>
- <literal><function>left
</function>(<parameter>str</parameter> <type>text</type>,
- <parameter>n</parameter> <type>int</type>)</literal>
+ <literal><function>left(<parameter>str</parameter> <type>text</type>,
+ <parameter>n</parameter> <type>int</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>length</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>length(<parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>
Number of characters in <parameter>string</parameter>
</row>
<row>
- <entry><literal><function>length
</function>(<parameter>string</parameter><type>bytea</type>,
- <parameter>encoding</parameter> <type>name</type> )</literal></entry>
+ <entry><literal><function>length(<parameter>string</parameter><type>bytea</type>,
+ <parameter>encoding</parameter> <type>name</type> )</function></literal></entry>
<entry><type>int</type></entry>
<entry>
Number of characters in <parameter>string</parameter> in the given
<row>
<entry>
- <literal><function>lpad
</function>(<parameter>string</parameter> <type>text</type>,
+ <literal><function>lpad(<parameter>string</parameter> <type>text</type>,
<parameter>length</parameter> <type>int</type>
- <optional>, <parameter>fill</parameter> <type>text</type></optional>)</literal>
+ <optional>, <parameter>fill</parameter> <type>text</type></optional>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>ltrim
</function>(<parameter>string</parameter> <type>text</type>
- <optional>, <parameter>characters</parameter> <type>text</type></optional>)</literal>
+ <entry><literal><function>ltrim(<parameter>string</parameter> <type>text</type>
+ <optional>, <parameter>characters</parameter> <type>text</type></optional>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>md5</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>md5(<parameter>string</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Calculates the MD5 hash of <parameter>string</parameter>,
</row>
<row>
- <entry><literal><function>pg_client_encoding</function>()</literal></entry>
+ <entry><literal><function>pg_client_encoding()</function></literal></entry>
<entry><type>name</type></entry>
<entry>
Current client encoding name
</row>
<row>
- <entry><literal><function>quote_ident</function>(<parameter>string</parameter> <type>text</type>)</literal></entry>
+ <entry><literal><function>quote_ident(<parameter>string</parameter> <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Return the given string suitably quoted to be used as an identifier
</row>
<row>
- <entry><literal><function>quote_literal</function>(<parameter>string</parameter> <type>text</type>)</literal></entry>
+ <entry><literal><function>quote_literal(<parameter>string</parameter> <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Return the given string suitably quoted to be used as a string literal
</row>
<row>
- <entry><literal><function>quote_literal</function>(<parameter>value</parameter> <type>anyelement</type>)</literal></entry>
+ <entry><literal><function>quote_literal(<parameter>value</parameter> <type>anyelement</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Coerce the given value to text and then quote it as a literal.
</row>
<row>
- <entry><literal><function>quote_nullable</function>(<parameter>string</parameter> <type>text</type>)</literal></entry>
+ <entry><literal><function>quote_nullable(<parameter>string</parameter> <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Return the given string suitably quoted to be used as a string literal
</row>
<row>
- <entry><literal><function>quote_nullable</function>(<parameter>value</parameter> <type>anyelement</type>)</literal></entry>
+ <entry><literal><function>quote_nullable(<parameter>value</parameter> <type>anyelement</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Coerce the given value to text and then quote it as a literal;
</row>
<row>
- <entry><literal><function>regexp_matches</function>(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type>])</literal></entry>
+ <entry><literal><function>regexp_matches(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type>])</function></literal></entry>
<entry><type>setof text[]</type></entry>
<entry>
Return all captured substrings resulting from matching a POSIX regular
</row>
<row>
- <entry><literal><function>regexp_replace</function>(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type>, <parameter>replacement</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type>])</literal></entry>
+ <entry><literal><function>regexp_replace(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type>, <parameter>replacement</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type>])</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Replace substring(s) matching a POSIX regular expression. See
</row>
<row>
- <entry><literal><function>regexp_split_to_array</function>(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type> ])</literal></entry>
+ <entry><literal><function>regexp_split_to_array(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type> ])</function></literal></entry>
<entry><type>text[]</type></entry>
<entry>
Split <parameter>string</parameter> using a POSIX regular expression as
</row>
<row>
- <entry><literal><function>regexp_split_to_table</function>(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type>])</literal></entry>
+ <entry><literal><function>regexp_split_to_table(<parameter>string</parameter> <type>text</type>, <parameter>pattern</parameter> <type>text</type> [, <parameter>flags</parameter> <type>text</type>])</function></literal></entry>
<entry><type>setof text</type></entry>
<entry>
Split <parameter>string</parameter> using a POSIX regular expression as
</row>
<row>
- <entry><literal><function>repeat</function>(<parameter>string</parameter> <type>text</type>, <parameter>number</parameter> <type>int</type>)</literal></entry>
+ <entry><literal><function>repeat(<parameter>string</parameter> <type>text</type>, <parameter>number</parameter> <type>int</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>Repeat <parameter>string</parameter> the specified
<parameter>number</parameter> of times</entry>
</row>
<row>
- <entry><literal><function>replace
</function>(<parameter>string</parameter> <type>text</type>,
+ <entry><literal><function>replace(<parameter>string</parameter> <type>text</type>,
<parameter>from</parameter> <type>text</type>,
- <parameter>to</parameter> <type>text</type>)</literal></entry>
+ <parameter>to</parameter> <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>Replace all occurrences in <parameter>string</parameter> of substring
<parameter>from</parameter> with substring <parameter>to</parameter>
<row>
<entry>
- <literal><function>reverse</function>(<parameter>str</parameter>)</literal>
+ <literal><function>reverse(<parameter>str</parameter>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
<row>
<entry>
- <literal><function>right
</function>(<parameter>str</parameter> <type>text</type>,
- <parameter>n</parameter> <type>int</type>)</literal>
+ <literal><function>right(<parameter>str</parameter> <type>text</type>,
+ <parameter>n</parameter> <type>int</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
<row>
<entry>
- <literal><function>rpad
</function>(<parameter>string</parameter> <type>text</type>,
+ <literal><function>rpad(<parameter>string</parameter> <type>text</type>,
<parameter>length</parameter> <type>int</type>
- <optional>, <parameter>fill</parameter> <type>text</type></optional>)</literal>
+ <optional>, <parameter>fill</parameter> <type>text</type></optional>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>rtrim
</function>(<parameter>string</parameter> <type>text</type>
- <optional>, <parameter>characters</parameter> <type>text</type></optional>)</literal>
+ <entry><literal><function>rtrim(<parameter>string</parameter> <type>text</type>
+ <optional>, <parameter>characters</parameter> <type>text</type></optional>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>split_part
</function>(<parameter>string</parameter> <type>text</type>,
+ <entry><literal><function>split_part(<parameter>string</parameter> <type>text</type>,
<parameter>delimiter</parameter> <type>text</type>,
- <parameter>field</parameter> <type>int</type>)</literal></entry>
+ <parameter>field</parameter> <type>int</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>Split <parameter>string</parameter> on <parameter>delimiter</parameter>
and return the given field (counting from one)
</row>
<row>
- <entry><literal><function>strpos</function>(<parameter>string</parameter>, <parameter>substring</parameter>)</literal></entry>
+ <entry><literal><function>strpos(<parameter>string</parameter>, <parameter>substring</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>
Location of specified substring (same as
</row>
<row>
- <entry><literal><function>substr</function>(<parameter>string</parameter>, <parameter>from</parameter> <optional>, <parameter>count</parameter></optional>)</literal></entry>
+ <entry><literal><function>substr(<parameter>string</parameter>, <parameter>from</parameter> <optional>, <parameter>count</parameter></optional>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Extract substring (same as
</row>
<row>
- <entry><literal><function>to_ascii
</function>(<parameter>string</parameter> <type>text</type>
- <optional>, <parameter>encoding</parameter> <type>text</type></optional>)</literal></entry>
+ <entry><literal><function>to_ascii(<parameter>string</parameter> <type>text</type>
+ <optional>, <parameter>encoding</parameter> <type>text</type></optional>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>to_hex
</function>(<parameter>number</parameter> <type>int</type>
- or <type>bigint</type>)</literal></entry>
+ <entry><literal><function>to_hex(<parameter>number</parameter> <type>int</type>
+ or <type>bigint</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>Convert <parameter>number</parameter> to its equivalent hexadecimal
representation
<row>
<entry>
- <literal><function>translate
</function>(<parameter>string</parameter> <type>text</type>,
+ <literal><function>translate(<parameter>string</parameter> <type>text</type>,
<parameter>from</parameter> <type>text</type>,
- <parameter>to</parameter> <type>text</type>)</literal>
+ <parameter>to</parameter> <type>text</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>octet_length</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>octet_length(<parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>Number of bytes in binary string</entry>
<entry><literal>octet_length(E'jo\\000se'::bytea)</literal></entry>
</row>
<row>
- <entry><literal><function>overlay</function>(<parameter>string</parameter> placing <parameter>string</parameter> from <type>int</type> <optional>for <type>int</type></optional>)</literal></entry>
+ <entry><literal><function>overlay(<parameter>string</parameter> placing <parameter>string</parameter> from <type>int</type> <optional>for <type>int</type></optional>)</function></literal></entry>
<entry><type>bytea</type></entry>
<entry>
Replace substring
</row>
<row>
- <entry><literal><function>position</function>(<parameter>substring</parameter> in <parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>position(<parameter>substring</parameter> in <parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>Location of specified substring</entry>
<entry><literal>position(E'\\000om'::bytea in E'Th\\000omas'::bytea)</literal></entry>
</row>
<row>
- <entry><literal><function>substring</function>(<parameter>string</parameter> <optional>from <type>int</type></optional> <optional>for <type>int</type></optional>)</literal></entry>
+ <entry><literal><function>substring(<parameter>string</parameter> <optional>from <type>int</type></optional> <optional>for <type>int</type></optional>)</function></literal></entry>
<entry><type>bytea</type></entry>
<entry>
Extract substring
<row>
<entry>
- <literal><function>trim</function>(<optional>both</optional>
+ <literal><function>trim(<optional>both</optional>
<parameter>bytes</parameter> from
- <parameter>string</parameter>)</literal>
+ <parameter>string</parameter>)</function></literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
<tbody>
<row>
- <entry><literal><function>btrim
</function>(<parameter>string</parameter>
- <type>bytea</type>, <parameter>bytes</parameter> <type>bytea</type>)</literal></entry>
+ <entry><literal><function>btrim(<parameter>string</parameter>
+ <type>bytea</type>, <parameter>bytes</parameter> <type>bytea</type>)</function></literal></entry>
<entry><type>bytea</type></entry>
<entry>
Remove the longest string consisting only of bytes
<row>
<entry>
- <literal><function>decode
</function>(<parameter>string</parameter> <type>text</type>,
- <parameter>type</parameter> <type>text</type>)</literal>
+ <literal><function>decode(<parameter>string</parameter> <type>text</type>,
+ <parameter>type</parameter> <type>text</type>)</function></literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
<row>
<entry>
- <literal><function>encode
</function>(<parameter>string</parameter> <type>bytea</type>,
- <parameter>type</parameter> <type>text</type>)</literal>
+ <literal><function>encode(<parameter>string</parameter> <type>bytea</type>,
+ <parameter>type</parameter> <type>text</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
<row>
<entry>
- <literal><function>get_bit</function>(<parameter>string</parameter>, <parameter>offset</parameter>)</literal>
+ <literal><function>get_bit(<parameter>string</parameter>, <parameter>offset</parameter>)</function></literal>
</entry>
<entry><type>int</type></entry>
<entry>
<row>
<entry>
- <literal><function>get_byte</function>(<parameter>string</parameter>, <parameter>offset</parameter>)</literal>
+ <literal><function>get_byte(<parameter>string</parameter>, <parameter>offset</parameter>)</function></literal>
</entry>
<entry><type>int</type></entry>
<entry>
</row>
<row>
- <entry><literal><function>length</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>length(<parameter>string</parameter>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>
Length of binary string
</row>
<row>
- <entry><literal><function>md5</function>(<parameter>string</parameter>)</literal></entry>
+ <entry><literal><function>md5(<parameter>string</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>
Calculates the MD5 hash of <parameter>string</parameter>,
<row>
<entry>
- <literal><function>set_bit
</function>(<parameter>string</parameter>,
- <parameter>offset</parameter>, <parameter>newvalue</>)</literal>
+ <literal><function>set_bit(<parameter>string</parameter>,
+ <parameter>offset</parameter>, <parameter>newvalue</>)</function></literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
<row>
<entry>
- <literal><function>set_byte
</function>(<parameter>string</parameter>,
- <parameter>offset</parameter>, <parameter>newvalue</>)</literal>
+ <literal><function>set_byte(<parameter>string</parameter>,
+ <parameter>offset</parameter>, <parameter>newvalue</>)</function></literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
</thead>
<tbody>
<row>
- <entry><literal><function>to_char</function>(<type>timestamp</type>, <type>text</type>)</literal></entry>
+ <entry><literal><function>to_char(<type>timestamp</type>, <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>convert time stamp to string</entry>
<entry><literal>to_char(current_timestamp, 'HH12:MI:SS')</literal></entry>
</row>
<row>
- <entry><literal><function>to_char</function>(<type>interval</type>, <type>text</type>)</literal></entry>
+ <entry><literal><function>to_char(<type>interval</type>, <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>convert interval to string</entry>
<entry><literal>to_char(interval '15h 2m 12s', 'HH24:MI:SS')</literal></entry>
</row>
<row>
- <entry><literal><function>to_char</function>(<type>int</type>, <type>text</type>)</literal></entry>
+ <entry><literal><function>to_char(<type>int</type>, <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>convert integer to string</entry>
<entry><literal>to_char(125, '999')</literal></entry>
<entry><literal>to_char(125.8::real, '999D9')</literal></entry>
</row>
<row>
- <entry><literal><function>to_char</function>(<type>numeric</type>, <type>text</type>)</literal></entry>
+ <entry><literal><function>to_char(<type>numeric</type>, <type>text</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>convert numeric to string</entry>
<entry><literal>to_char(-125.8, '999D99S')</literal></entry>
</row>
<row>
- <entry><literal><function>to_date</function>(<type>text</type>, <type>text</type>)</literal></entry>
+ <entry><literal><function>to_date(<type>text</type>, <type>text</type>)</function></literal></entry>
<entry><type>date</type></entry>
<entry>convert string to date</entry>
<entry><literal>to_date('05 Dec 2000', 'DD Mon YYYY')</literal></entry>
</row>
<row>
- <entry><literal><function>to_number</function>(<type>text</type>, <type>text</type>)</literal></entry>
+ <entry><literal><function>to_number(<type>text</type>, <type>text</type>)</function></literal></entry>
<entry><type>numeric</type></entry>
<entry>convert string to numeric</entry>
<entry><literal>to_number('12,454.8-', '99G999D9S')</literal></entry>
</row>
<row>
- <entry><literal><function>to_timestamp</function>(<type>text</type>, <type>text</type>)</literal></entry>
+ <entry><literal><function>to_timestamp(<type>text</type>, <type>text</type>)</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>convert string to time stamp</entry>
<entry><literal>to_timestamp('05 Dec 2000', 'DD Mon YYYY')</literal></entry>
</row>
<row>
- <entry><literal><function>to_timestamp</function>(<type>double precision</type>)</literal></entry>
+ <entry><literal><function>to_timestamp(<type>double precision</type>)</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>convert Unix epoch to time stamp</entry>
<entry><literal>to_timestamp(1284352323)</literal></entry>
<tbody>
<row>
- <entry><literal><function>age</function>(<type>timestamp</type>, <type>timestamp</type>)</literal></entry>
+ <entry><literal><function>age(<type>timestamp</type>, <type>timestamp</type>)</function></literal></entry>
<entry><type>interval</type></entry>
<entry>Subtract arguments, producing a <quote>symbolic</> result that
uses years and months</entry>
</row>
<row>
- <entry><literal><function>age</function>(<type>timestamp</type>)</literal></entry>
+ <entry><literal><function>age(<type>timestamp</type>)</function></literal></entry>
<entry><type>interval</type></entry>
<entry>Subtract from <function>current_date</function> (at midnight)</entry>
<entry><literal>age(timestamp '1957-06-13')</literal></entry>
</row>
<row>
- <entry><literal><function>clock_timestamp</function>()</literal></entry>
+ <entry><literal><function>clock_timestamp()</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>Current date and time (changes during statement execution);
see <xref linkend="functions-datetime-current">
</row>
<row>
- <entry><literal><function>date_part</function>(<type>text</type>, <type>timestamp</type>)</literal></entry>
+ <entry><literal><function>date_part(<type>text</type>, <type>timestamp</type>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>Get subfield (equivalent to <function>extract</function>);
see <xref linkend="functions-datetime-extract">
</row>
<row>
- <entry><literal><function>date_part</function>(<type>text</type>, <type>interval</type>)</literal></entry>
+ <entry><literal><function>date_part(<type>text</type>, <type>interval</type>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>Get subfield (equivalent to
<function>extract</function>); see <xref linkend="functions-datetime-extract">
</row>
<row>
- <entry><literal><function>date_trunc</function>(<type>text</type>, <type>timestamp</type>)</literal></entry>
+ <entry><literal><function>date_trunc(<type>text</type>, <type>timestamp</type>)</function></literal></entry>
<entry><type>timestamp</type></entry>
<entry>Truncate to specified precision; see also <xref linkend="functions-datetime-trunc">
</entry>
</row>
<row>
- <entry><literal><function>isfinite</function>(<type>date</type>)</literal></entry>
+ <entry><literal><function>isfinite(<type>date</type>)</function></literal></entry>
<entry><type>boolean</type></entry>
<entry>Test for finite date (not +/-infinity)</entry>
<entry><literal>isfinite(date '2001-02-16')</literal></entry>
</row>
<row>
- <entry><literal><function>isfinite</function>(<type>timestamp</type>)</literal></entry>
+ <entry><literal><function>isfinite(<type>timestamp</type>)</function></literal></entry>
<entry><type>boolean</type></entry>
<entry>Test for finite time stamp (not +/-infinity)</entry>
<entry><literal>isfinite(timestamp '2001-02-16 21:28:30')</literal></entry>
</row>
<row>
- <entry><literal><function>isfinite</function>(<type>interval</type>)</literal></entry>
+ <entry><literal><function>isfinite(<type>interval</type>)</function></literal></entry>
<entry><type>boolean</type></entry>
<entry>Test for finite interval</entry>
<entry><literal>isfinite(interval '4 hours')</literal></entry>
</row>
<row>
- <entry><literal><function>justify_days</function>(<type>interval</type>)</literal></entry>
+ <entry><literal><function>justify_days(<type>interval</type>)</function></literal></entry>
<entry><type>interval</type></entry>
<entry>Adjust interval so 30-day time periods are represented as months</entry>
<entry><literal>justify_days(interval '35 days')</literal></entry>
</row>
<row>
- <entry><literal><function>justify_hours</function>(<type>interval</type>)</literal></entry>
+ <entry><literal><function>justify_hours(<type>interval</type>)</function></literal></entry>
<entry><type>interval</type></entry>
<entry>Adjust interval so 24-hour time periods are represented as days</entry>
<entry><literal>justify_hours(interval '27 hours')</literal></entry>
</row>
<row>
- <entry><literal><function>justify_interval</function>(<type>interval</type>)</literal></entry>
+ <entry><literal><function>justify_interval(<type>interval</type>)</function></literal></entry>
<entry><type>interval</type></entry>
<entry>Adjust interval using <function>justify_days</> and <function>justify_hours</>, with additional sign adjustments</entry>
<entry><literal>justify_interval(interval '1 mon -1 hour')</literal></entry>
</row>
<row>
- <entry><literal><function>now</function>()</literal></entry>
+ <entry><literal><function>now()</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>Current date and time (start of current transaction);
see <xref linkend="functions-datetime-current">
</row>
<row>
- <entry><literal><function>statement_timestamp</function>()</literal></entry>
+ <entry><literal><function>statement_timestamp()</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>Current date and time (start of current statement);
see <xref linkend="functions-datetime-current">
</row>
<row>
- <entry><literal><function>timeofday</function>()</literal></entry>
+ <entry><literal><function>timeofday()</function></literal></entry>
<entry><type>text</type></entry>
<entry>Current date and time
(like <function>clock_timestamp</>, but as a <type>text</> string);
</row>
<row>
- <entry><literal><function>transaction_timestamp</function>()</literal></entry>
+ <entry><literal><function>transaction_timestamp()</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>Current date and time (start of current transaction);
see <xref linkend="functions-datetime-current">
</thead>
<tbody>
<row>
- <entry><literal><function>area</function>(<replaceable>object</>)</literal></entry>
+ <entry><literal><function>area(<replaceable>object</>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>area</entry>
<entry><literal>area(box '((0,0),(1,1))')</literal></entry>
</row>
<row>
- <entry><literal><function>center</function>(<replaceable>object</>)</literal></entry>
+ <entry><literal><function>center(<replaceable>object</>)</function></literal></entry>
<entry><type>point</type></entry>
<entry>center</entry>
<entry><literal>center(box '((0,0),(1,2))')</literal></entry>
</row>
<row>
- <entry><literal><function>diameter</function>(<type>circle</>)</literal></entry>
+ <entry><literal><function>diameter(<type>circle</>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>diameter of circle</entry>
<entry><literal>diameter(circle '((0,0),2.0)')</literal></entry>
</row>
<row>
- <entry><literal><function>height</function>(<type>box</>)</literal></entry>
+ <entry><literal><function>height(<type>box</>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>vertical size of box</entry>
<entry><literal>height(box '((0,0),(1,1))')</literal></entry>
</row>
<row>
- <entry><literal><function>isclosed</function>(<type>path</>)</literal></entry>
+ <entry><literal><function>isclosed(<type>path</>)</function></literal></entry>
<entry><type>boolean</type></entry>
<entry>a closed path?</entry>
<entry><literal>isclosed(path '((0,0),(1,1),(2,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>isopen</function>(<type>path</>)</literal></entry>
+ <entry><literal><function>isopen(<type>path</>)</function></literal></entry>
<entry><type>boolean</type></entry>
<entry>an open path?</entry>
<entry><literal>isopen(path '[(0,0),(1,1),(2,0)]')</literal></entry>
</row>
<row>
- <entry><literal><function>length</function>(<replaceable>object</>)</literal></entry>
+ <entry><literal><function>length(<replaceable>object</>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>length</entry>
<entry><literal>length(path '((-1,0),(1,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>npoints</function>(<type>path</>)</literal></entry>
+ <entry><literal><function>npoints(<type>path</>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>number of points</entry>
<entry><literal>npoints(path '[(0,0),(1,1),(2,0)]')</literal></entry>
</row>
<row>
- <entry><literal><function>npoints</function>(<type>polygon</>)</literal></entry>
+ <entry><literal><function>npoints(<type>polygon</>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>number of points</entry>
<entry><literal>npoints(polygon '((1,1),(0,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>pclose</function>(<type>path</>)</literal></entry>
+ <entry><literal><function>pclose(<type>path</>)</function></literal></entry>
<entry><type>path</type></entry>
<entry>convert path to closed</entry>
<entry><literal>pclose(path '[(0,0),(1,1),(2,0)]')</literal></entry>
<![IGNORE[
<!-- Not defined by this name. Implements the intersection operator '#' -->
<row>
- <entry><literal><function>point</function>(<type>lseg</>, <type>lseg</>)</literal></entry>
+ <entry><literal><function>point(<type>lseg</>, <type>lseg</>)</function></literal></entry>
<entry><type>point</type></entry>
<entry>intersection</entry>
<entry><literal>point(lseg '((-1,0),(1,0))',lseg '((-2,-2),(2,2))')</literal></entry>
</row>
]]>
<row>
- <entry><literal><function>popen</function>(<type>path</>)</literal></entry>
+ <entry><literal><function>popen(<type>path</>)</function></literal></entry>
<entry><type>path</type></entry>
<entry>convert path to open</entry>
<entry><literal>popen(path '((0,0),(1,1),(2,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>radius</function>(<type>circle</type>)</literal></entry>
+ <entry><literal><function>radius(<type>circle</type>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>radius of circle</entry>
<entry><literal>radius(circle '((0,0),2.0)')</literal></entry>
</row>
<row>
- <entry><literal><function>width</function>(<type>box</>)</literal></entry>
+ <entry><literal><function>width(<type>box</>)</function></literal></entry>
<entry><type>double precision</type></entry>
<entry>horizontal size of box</entry>
<entry><literal>width(box '((0,0),(1,1))')</literal></entry>
</thead>
<tbody>
<row>
- <entry><literal><function>box</function>(<type>circle</type>)</literal></entry>
+ <entry><literal><function>box(<type>circle</type>)</function></literal></entry>
<entry><type>box</type></entry>
<entry>circle to box</entry>
<entry><literal>box(circle '((0,0),2.0)')</literal></entry>
</row>
<row>
- <entry><literal><function>box</function>(<type>point</type>, <type>point</type>)</literal></entry>
+ <entry><literal><function>box(<type>point</type>, <type>point</type>)</function></literal></entry>
<entry><type>box</type></entry>
<entry>points to box</entry>
<entry><literal>box(point '(0,0)', point '(1,1)')</literal></entry>
</row>
<row>
- <entry><literal><function>box</function>(<type>polygon</type>)</literal></entry>
+ <entry><literal><function>box(<type>polygon</type>)</function></literal></entry>
<entry><type>box</type></entry>
<entry>polygon to box</entry>
<entry><literal>box(polygon '((0,0),(1,1),(2,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>circle</function>(<type>box</type>)</literal></entry>
+ <entry><literal><function>circle(<type>box</type>)</function></literal></entry>
<entry><type>circle</type></entry>
<entry>box to circle</entry>
<entry><literal>circle(box '((0,0),(1,1))')</literal></entry>
</row>
<row>
- <entry><literal><function>circle</function>(<type>point</type>, <type>double precision</type>)</literal></entry>
+ <entry><literal><function>circle(<type>point</type>, <type>double precision</type>)</function></literal></entry>
<entry><type>circle</type></entry>
<entry>center and radius to circle</entry>
<entry><literal>circle(point '(0,0)', 2.0)</literal></entry>
</row>
<row>
- <entry><literal><function>circle</function>(<type>polygon</type>)</literal></entry>
+ <entry><literal><function>circle(<type>polygon</type>)</function></literal></entry>
<entry><type>circle</type></entry>
<entry>polygon to circle</entry>
<entry><literal>circle(polygon '((0,0),(1,1),(2,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>lseg</function>(<type>box</type>)</literal></entry>
+ <entry><literal><function>lseg(<type>box</type>)</function></literal></entry>
<entry><type>lseg</type></entry>
<entry>box diagonal to line segment</entry>
<entry><literal>lseg(box '((-1,0),(1,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>lseg</function>(<type>point</type>, <type>point</type>)</literal></entry>
+ <entry><literal><function>lseg(<type>point</type>, <type>point</type>)</function></literal></entry>
<entry><type>lseg</type></entry>
<entry>points to line segment</entry>
<entry><literal>lseg(point '(-1,0)', point '(1,0)')</literal></entry>
</row>
<row>
- <entry><literal><function>path</function>(<type>polygon</type>)</literal></entry>
+ <entry><literal><function>path(<type>polygon</type>)</function></literal></entry>
<entry><type>point</type></entry>
<entry>polygon to path</entry>
<entry><literal>path(polygon '((0,0),(1,1),(2,0))')</literal></entry>
<entry><literal>point(23.4, -44.5)</literal></entry>
</row>
<row>
- <entry><literal><function>point</function>(<type>box</type>)</literal></entry>
+ <entry><literal><function>point(<type>box</type>)</function></literal></entry>
<entry><type>point</type></entry>
<entry>center of box</entry>
<entry><literal>point(box '((-1,0),(1,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>point</function>(<type>circle</type>)</literal></entry>
+ <entry><literal><function>point(<type>circle</type>)</function></literal></entry>
<entry><type>point</type></entry>
<entry>center of circle</entry>
<entry><literal>point(circle '((0,0),2.0)')</literal></entry>
</row>
<row>
- <entry><literal><function>point</function>(<type>lseg</type>)</literal></entry>
+ <entry><literal><function>point(<type>lseg</type>)</function></literal></entry>
<entry><type>point</type></entry>
<entry>center of line segment</entry>
<entry><literal>point(lseg '((-1,0),(1,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>point</function>(<type>polygon</type>)</literal></entry>
+ <entry><literal><function>point(<type>polygon</type>)</function></literal></entry>
<entry><type>point</type></entry>
<entry>center of polygon</entry>
<entry><literal>point(polygon '((0,0),(1,1),(2,0))')</literal></entry>
</row>
<row>
- <entry><literal><function>polygon</function>(<type>box</type>)</literal></entry>
+ <entry><literal><function>polygon(<type>box</type>)</function></literal></entry>
<entry><type>polygon</type></entry>
<entry>box to 4-point polygon</entry>
<entry><literal>polygon(box '((0,0),(1,1))')</literal></entry>
</row>
<row>
- <entry><literal><function>polygon</function>(<type>circle</type>)</literal></entry>
+ <entry><literal><function>polygon(<type>circle</type>)</function></literal></entry>
<entry><type>polygon</type></entry>
<entry>circle to 12-point polygon</entry>
<entry><literal>polygon(circle '((0,0),2.0)')</literal></entry>
</row>
<row>
- <entry><literal><function>polygon</function>(<replaceable class="parameter">npts</replaceable>, <type>circle</type>)</literal></entry>
+ <entry><literal><function>polygon(<replaceable class="parameter">npts</replaceable>, <type>circle</type>)</function></literal></entry>
<entry><type>polygon</type></entry>
<entry>circle to <replaceable class="parameter">npts</replaceable>-point polygon</entry>
<entry><literal>polygon(12, circle '((0,0),2.0)')</literal></entry>
</row>
<row>
- <entry><literal><function>polygon</function>(<type>path</type>)</literal></entry>
+ <entry><literal><function>polygon(<type>path</type>)</function></literal></entry>
<entry><type>polygon</type></entry>
<entry>path to polygon</entry>
<entry><literal>polygon(path '((0,0),(1,1),(2,0))')</literal></entry>
</thead>
<tbody>
<row>
- <entry><literal><function>abbrev</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>abbrev(<type>inet</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>abbreviated display format as text</entry>
<entry><literal>abbrev(inet '10.1.0.0/16')</literal></entry>
<entry><literal>10.1.0.0/16</literal></entry>
</row>
<row>
- <entry><literal><function>abbrev</function>(<type>cidr</type>)</literal></entry>
+ <entry><literal><function>abbrev(<type>cidr</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>abbreviated display format as text</entry>
<entry><literal>abbrev(cidr '10.1.0.0/16')</literal></entry>
<entry><literal>10.1/16</literal></entry>
</row>
<row>
- <entry><literal><function>broadcast</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>broadcast(<type>inet</type>)</function></literal></entry>
<entry><type>inet</type></entry>
<entry>broadcast address for network</entry>
<entry><literal>broadcast('192.168.1.5/24')</literal></entry>
<entry><literal>192.168.1.255/24</literal></entry>
</row>
<row>
- <entry><literal><function>family</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>family(<type>inet</type>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>extract family of address; <literal>4</literal> for IPv4,
<literal>6</literal> for IPv6</entry>
<entry><literal>6</literal></entry>
</row>
<row>
- <entry><literal><function>host</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>host(<type>inet</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>extract IP address as text</entry>
<entry><literal>host('192.168.1.5/24')</literal></entry>
<entry><literal>192.168.1.5</literal></entry>
</row>
<row>
- <entry><literal><function>hostmask</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>hostmask(<type>inet</type>)</function></literal></entry>
<entry><type>inet</type></entry>
<entry>construct host mask for network</entry>
<entry><literal>hostmask('192.168.23.20/30')</literal></entry>
<entry><literal>0.0.0.3</literal></entry>
</row>
<row>
- <entry><literal><function>masklen</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>masklen(<type>inet</type>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>extract netmask length</entry>
<entry><literal>masklen('192.168.1.5/24')</literal></entry>
<entry><literal>24</literal></entry>
</row>
<row>
- <entry><literal><function>netmask</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>netmask(<type>inet</type>)</function></literal></entry>
<entry><type>inet</type></entry>
<entry>construct netmask for network</entry>
<entry><literal>netmask('192.168.1.5/24')</literal></entry>
<entry><literal>255.255.255.0</literal></entry>
</row>
<row>
- <entry><literal><function>network</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>network(<type>inet</type>)</function></literal></entry>
<entry><type>cidr</type></entry>
<entry>extract network part of address</entry>
<entry><literal>network('192.168.1.5/24')</literal></entry>
<entry><literal>192.168.1.0/24</literal></entry>
</row>
<row>
- <entry><literal><function>set_masklen</function>(<type>inet</type>, <type>int</type>)</literal></entry>
+ <entry><literal><function>set_masklen(<type>inet</type>, <type>int</type>)</function></literal></entry>
<entry><type>inet</type></entry>
<entry>set netmask length for <type>inet</type> value</entry>
<entry><literal>set_masklen('192.168.1.5/24', 16)</literal></entry>
<entry><literal>192.168.1.5/16</literal></entry>
</row>
<row>
- <entry><literal><function>set_masklen</function>(<type>cidr</type>, <type>int</type>)</literal></entry>
+ <entry><literal><function>set_masklen(<type>cidr</type>, <type>int</type>)</function></literal></entry>
<entry><type>cidr</type></entry>
<entry>set netmask length for <type>cidr</type> value</entry>
<entry><literal>set_masklen('192.168.1.0/24'::cidr, 16)</literal></entry>
<entry><literal>192.168.0.0/16</literal></entry>
</row>
<row>
- <entry><literal><function>text</function>(<type>inet</type>)</literal></entry>
+ <entry><literal><function>text(<type>inet</type>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>extract IP address and netmask length as text</entry>
<entry><literal>text(inet '192.168.1.5')</literal></entry>
<para>
<xref linkend="macaddr-functions-table"> shows the functions
available for use with the <type>macaddr</type> type. The function
- <literal><function>trunc</function>(<type>macaddr</type>)</literal> returns a MAC
+ <literal><function>trunc(<type>macaddr</type>)</function></literal> returns a MAC
address with the last 3 bytes set to zero. This can be used to
associate the remaining prefix with a manufacturer.
</para>
</thead>
<tbody>
<row>
- <entry><literal><function>trunc</function>(<type>macaddr</type>)</literal></entry>
+ <entry><literal><function>trunc(<type>macaddr</type>)</function></literal></entry>
<entry><type>macaddr</type></entry>
<entry>set last 3 bytes to zero</entry>
<entry><literal>trunc(macaddr '12:34:56:78:90:ab')</literal></entry>
</thead>
<tbody>
<row>
- <entry><literal><function>to_tsvector</function>(<optional> <replaceable class="PARAMETER">config</> <type>regconfig</> , </optional> <replaceable class="PARAMETER">document</> <type>text</type>)</literal></entry>
+ <entry><literal><function>to_tsvector(<optional> <replaceable class="PARAMETER">config</> <type>regconfig</> , </optional> <replaceable class="PARAMETER">document</> <type>text</type>)</function></literal></entry>
<entry><type>tsvector</type></entry>
<entry>reduce document text to <type>tsvector</></entry>
<entry><literal>to_tsvector('english', 'The Fat Rats')</literal></entry>
<entry><literal>'fat':2 'rat':3</literal></entry>
</row>
<row>
- <entry><literal><function>length</function>(<type>tsvector</>)</literal></entry>
+ <entry><literal><function>length(<type>tsvector</>)</function></literal></entry>
<entry><type>integer</type></entry>
<entry>number of lexemes in <type>tsvector</></entry>
<entry><literal>length('fat:2,4 cat:3 rat:5A'::tsvector)</literal></entry>
<entry><literal>3</literal></entry>
</row>
<row>
- <entry><literal><function>setweight</function>(<type>tsvector</>, <type>"char"</>)</literal></entry>
+ <entry><literal><function>setweight(<type>tsvector</>, <type>"char"</>)</function></literal></entry>
<entry><type>tsvector</type></entry>
<entry>assign weight to each element of <type>tsvector</></entry>
<entry><literal>setweight('fat:2,4 cat:3 rat:5B'::tsvector, 'A')</literal></entry>
<entry><literal>'cat':3A 'fat':2A,4A 'rat':5A</literal></entry>
</row>
<row>
- <entry><literal><function>strip</function>(<type>tsvector</>)</literal></entry>
+ <entry><literal><function>strip(<type>tsvector</>)</function></literal></entry>
<entry><type>tsvector</type></entry>
<entry>remove positions and weights from <type>tsvector</></entry>
<entry><literal>strip('fat:2,4 cat:3 rat:5A'::tsvector)</literal></entry>
<entry><literal>'cat' 'fat' 'rat'</literal></entry>
</row>
<row>
- <entry><literal><function>to_tsquery</function>(<optional> <replaceable class="PARAMETER">config</> <type>regconfig</> , </optional> <replaceable class="PARAMETER">query</> <type>text</type>)</literal></entry>
+ <entry><literal><function>to_tsquery(<optional> <replaceable class="PARAMETER">config</> <type>regconfig</> , </optional> <replaceable class="PARAMETER">query</> <type>text</type>)</function></literal></entry>
<entry><type>tsquery</type></entry>
<entry>normalize words and convert to <type>tsquery</></entry>
<entry><literal>to_tsquery('english', 'The & Fat & Rats')</literal></entry>
<entry><literal>'fat' & 'rat'</literal></entry>
</row>
<row>
- <entry><literal><function>plainto_tsquery</function>(<optional> <replaceable class="PARAMETER">config</> <type>regconfig</> , </optional> <replaceable class="PARAMETER">query</> <type>text</type>)</literal></entry>
+ <entry><literal><function>plainto_tsquery(<optional> <replaceable class="PARAMETER">config</> <type>regconfig</> , </optional> <replaceable class="PARAMETER">query</> <type>text</type>)</function></literal></entry>
<entry><type>tsquery</type></entry>
<entry>produce <type>tsquery</> ignoring punctuation</entry>
<entry><literal>plainto_tsquery('english', 'The Fat Rats')</literal></entry>
<entry><literal>'fat' & 'rat'</literal></entry>
</row>
<row>
- <entry><literal><function>numnode</function>(<type>tsquery</>)</literal></entry>
+ <entry><literal><function>numnode(<type>tsquery</>)</function></literal></entry>
<entry><type>integer</type></entry>
<entry>number of lexemes plus operators in <type>tsquery</></entry>
<entry><literal> numnode('(fat & rat) | cat'::tsquery)</literal></entry>
<entry><literal>5</literal></entry>
</row>
<row>
- <entry><literal><function>querytree</function>(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>)</literal></entry>
+ <entry><literal><function>querytree(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get indexable part of a <type>tsquery</></entry>
<entry><literal>querytree('foo & ! bar'::tsquery)</literal></entry>
<entry><literal>'foo'</literal></entry>
</row>
<row>
- <entry><literal><function>ts_rank</function>(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>)</literal></entry>
+ <entry><literal><function>ts_rank(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>)</function></literal></entry>
<entry><type>float4</type></entry>
<entry>rank document for query</entry>
<entry><literal>ts_rank(textsearch, query)</literal></entry>
<entry><literal>0.818</literal></entry>
</row>
<row>
- <entry><literal><function>ts_rank_cd</function>(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>)</literal></entry>
+ <entry><literal><function>ts_rank_cd(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>)</function></literal></entry>
<entry><type>float4</type></entry>
<entry>rank document for query using cover density</entry>
<entry><literal>ts_rank_cd('{0.1, 0.2, 0.4, 1.0}', textsearch, query)</literal></entry>
<entry><literal>2.01317</literal></entry>
</row>
<row>
- <entry><literal><function>ts_headline</function>(<optional> <replaceable class="PARAMETER">config</replaceable> <type>regconfig</>, </optional> <replaceable class="PARAMETER">document</replaceable> <type>text</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">options</replaceable> <type>text</> </optional>)</literal></entry>
+ <entry><literal><function>ts_headline(<optional> <replaceable class="PARAMETER">config</replaceable> <type>regconfig</>, </optional> <replaceable class="PARAMETER">document</replaceable> <type>text</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">options</replaceable> <type>text</> </optional>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>display a query match</entry>
<entry><literal>ts_headline('x y z', 'z'::tsquery)</literal></entry>
<entry><literal>x y <b>z</b></literal></entry>
</row>
<row>
- <entry><literal><function>ts_rewrite</function>(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">target</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">substitute</replaceable> <type>tsquery</>)</literal></entry>
+ <entry><literal><function>ts_rewrite(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">target</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">substitute</replaceable> <type>tsquery</>)</function></literal></entry>
<entry><type>tsquery</type></entry>
<entry>replace target with substitute within query</entry>
<entry><literal>ts_rewrite('a & b'::tsquery, 'a'::tsquery, 'foo|bar'::tsquery)</literal></entry>
<entry><literal>'b' & ( 'foo' | 'bar' )</literal></entry>
</row>
<row>
- <entry><literal><function>ts_rewrite</function>(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">select</replaceable> <type>text</>)</literal></entry>
+ <entry><literal><function>ts_rewrite(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">select</replaceable> <type>text</>)</function></literal></entry>
<entry><type>tsquery</type></entry>
<entry>replace using targets and substitutes from a <command>SELECT</> command</entry>
<entry><literal>SELECT ts_rewrite('a & b'::tsquery, 'SELECT t,s FROM aliases')</literal></entry>
<entry><literal>'b' & ( 'foo' | 'bar' )</literal></entry>
</row>
<row>
- <entry><literal><function>get_current_ts_config</function>()</literal></entry>
+ <entry><literal><function>get_current_ts_config()</function></literal></entry>
<entry><type>regconfig</type></entry>
<entry>get default text search configuration</entry>
<entry><literal>get_current_ts_config()</literal></entry>
<entry><literal>english</literal></entry>
</row>
<row>
- <entry><literal><function>tsvector_update_trigger</function>()</literal></entry>
+ <entry><literal><function>tsvector_update_trigger()</function></literal></entry>
<entry><type>trigger</type></entry>
<entry>trigger function for automatic <type>tsvector</> column update</entry>
<entry><literal>CREATE TRIGGER ... tsvector_update_trigger(tsvcol, 'pg_catalog.swedish', title, body)</literal></entry>
<entry><literal></literal></entry>
</row>
<row>
- <entry><literal><function>tsvector_update_trigger_column</function>()</literal></entry>
+ <entry><literal><function>tsvector_update_trigger_column()</function></literal></entry>
<entry><type>trigger</type></entry>
<entry>trigger function for automatic <type>tsvector</> column update</entry>
<entry><literal>CREATE TRIGGER ... tsvector_update_trigger_column(tsvcol, configcol, title, body)</literal></entry>
<entry><literal></literal></entry>
- <entry><literal></literal></entry>
</row>
</tbody>
</tgroup>
</thead>
<tbody>
<row>
- <entry><literal><function>ts_debug</function>(<optional> <replaceable class="PARAMETER">config</replaceable> <type>regconfig</>, </optional> <replaceable class="PARAMETER">document</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">alias</> <type>text</>, OUT <replaceable class="PARAMETER">description</> <type>text</>, OUT <replaceable class="PARAMETER">token</> <type>text</>, OUT <replaceable class="PARAMETER">dictionaries</> <type>regdictionary[]</>, OUT <replaceable class="PARAMETER">dictionary</> <type>regdictionary</>, OUT <replaceable class="PARAMETER">lexemes</> <type>text[]</>)</literal></entry>
+ <entry><literal><function>ts_debug(<optional> <replaceable class="PARAMETER">config</replaceable> <type>regconfig</>, </optional> <replaceable class="PARAMETER">document</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">alias</> <type>text</>, OUT <replaceable class="PARAMETER">description</> <type>text</>, OUT <replaceable class="PARAMETER">token</> <type>text</>, OUT <replaceable class="PARAMETER">dictionaries</> <type>regdictionary[]</>, OUT <replaceable class="PARAMETER">dictionary</> <type>regdictionary</>, OUT <replaceable class="PARAMETER">lexemes</> <type>text[]</>)</function></literal></entry>
<entry><type>setof record</type></entry>
<entry>test a configuration</entry>
<entry><literal>ts_debug('english', 'The Brightest supernovaes')</literal></entry>
<entry><literal>(asciiword,"Word, all ASCII",The,{english_stem},english_stem,{}) ...</literal></entry>
</row>
<row>
- <entry><literal><function>ts_lexize</function>(<replaceable class="PARAMETER">dict</replaceable> <type>regdictionary</>, <replaceable class="PARAMETER">token</replaceable> <type>text</>)</literal></entry>
+ <entry><literal><function>ts_lexize(<replaceable class="PARAMETER">dict</replaceable> <type>regdictionary</>, <replaceable class="PARAMETER">token</replaceable> <type>text</>)</function></literal></entry>
<entry><type>text[]</type></entry>
<entry>test a dictionary</entry>
<entry><literal>ts_lexize('english_stem', 'stars')</literal></entry>
<entry><literal>{star}</literal></entry>
</row>
<row>
- <entry><literal><function>ts_parse</function>(<replaceable class="PARAMETER">parser_name</replaceable> <type>text</>, <replaceable class="PARAMETER">document</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">token</> <type>text</>)</literal></entry>
+ <entry><literal><function>ts_parse(<replaceable class="PARAMETER">parser_name</replaceable> <type>text</>, <replaceable class="PARAMETER">document</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">token</> <type>text</>)</function></literal></entry>
<entry><type>setof record</type></entry>
<entry>test a parser</entry>
<entry><literal>ts_parse('default', 'foo - bar')</literal></entry>
<entry><literal>(1,foo) ...</literal></entry>
</row>
<row>
- <entry><literal><function>ts_parse</function>(<replaceable class="PARAMETER">parser_oid</replaceable> <type>oid</>, <replaceable class="PARAMETER">document</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">token</> <type>text</>)</literal></entry>
+ <entry><literal><function>ts_parse(<replaceable class="PARAMETER">parser_oid</replaceable> <type>oid</>, <replaceable class="PARAMETER">document</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">token</> <type>text</>)</function></literal></entry>
<entry><type>setof record</type></entry>
<entry>test a parser</entry>
<entry><literal>ts_parse(3722, 'foo - bar')</literal></entry>
<entry><literal>(1,foo) ...</literal></entry>
</row>
<row>
- <entry><literal><function>ts_token_type</function>(<replaceable class="PARAMETER">parser_name</> <type>text</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">alias</> <type>text</>, OUT <replaceable class="PARAMETER">description</> <type>text</>)</literal></entry>
+ <entry><literal><function>ts_token_type(<replaceable class="PARAMETER">parser_name</> <type>text</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">alias</> <type>text</>, OUT <replaceable class="PARAMETER">description</> <type>text</>)</function></literal></entry>
<entry><type>setof record</type></entry>
<entry>get token types defined by parser</entry>
<entry><literal>ts_token_type('default')</literal></entry>
<entry><literal>(1,asciiword,"Word, all ASCII") ...</literal></entry>
</row>
<row>
- <entry><literal><function>ts_token_type</function>(<replaceable class="PARAMETER">parser_oid</> <type>oid</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">alias</> <type>text</>, OUT <replaceable class="PARAMETER">description</> <type>text</>)</literal></entry>
+ <entry><literal><function>ts_token_type(<replaceable class="PARAMETER">parser_oid</> <type>oid</>, OUT <replaceable class="PARAMETER">tokid</> <type>integer</>, OUT <replaceable class="PARAMETER">alias</> <type>text</>, OUT <replaceable class="PARAMETER">description</> <type>text</>)</function></literal></entry>
<entry><type>setof record</type></entry>
<entry>get token types defined by parser</entry>
<entry><literal>ts_token_type(3722)</literal></entry>
<entry><literal>(1,asciiword,"Word, all ASCII") ...</literal></entry>
</row>
<row>
- <entry><literal><function>ts_stat</function>(<replaceable class="PARAMETER">sqlquery</replaceable> <type>text</>, <optional> <replaceable class="PARAMETER">weights</replaceable> <type>text</>, </optional> OUT <replaceable class="PARAMETER">word</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">ndoc</replaceable> <type>integer</>, OUT <replaceable class="PARAMETER">nentry</replaceable> <type>integer</>)</literal></entry>
+ <entry><literal><function>ts_stat(<replaceable class="PARAMETER">sqlquery</replaceable> <type>text</>, <optional> <replaceable class="PARAMETER">weights</replaceable> <type>text</>, </optional> OUT <replaceable class="PARAMETER">word</replaceable> <type>text</>, OUT <replaceable class="PARAMETER">ndoc</replaceable> <type>integer</>, OUT <replaceable class="PARAMETER">nentry</replaceable> <type>integer</>)</function></literal></entry>
<entry><type>setof record</type></entry>
<entry>get statistics of a <type>tsvector</> column</entry>
<entry><literal>ts_stat('SELECT vector from apod')</literal></entry>
<tbody>
<row>
- <entry><literal><function>currval</function>(<type>regclass</type>)</literal></entry>
+ <entry><literal><function>currval(<type>regclass</type>)</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>Return value most recently obtained with
<function>nextval</function> for specified sequence</entry>
</row>
<row>
- <entry><literal><function>lastval</function>()</literal></entry>
+ <entry><literal><function>lastval()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>Return value most recently obtained with
<function>nextval</function> for any sequence</entry>
</row>
<row>
- <entry><literal><function>nextval</function>(<type>regclass</type>)</literal></entry>
+ <entry><literal><function>nextval(<type>regclass</type>)</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>Advance sequence and return new value</entry>
</row>
<row>
- <entry><literal><function>setval</function>(<type>regclass</type>, <type>bigint</type>)</literal></entry>
+ <entry><literal><function>setval(<type>regclass</type>, <type>bigint</type>)</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>Set sequence's current value</entry>
</row>
<row>
- <entry><literal><function>setval</function>(<type>regclass</type>, <type>bigint</type>, <type>boolean</type>)</literal></entry>
+ <entry><literal><function>setval(<type>regclass</type>, <type>bigint</type>, <type>boolean</type>)</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>Set sequence's current value and <literal>is_called</literal> flag</entry>
</row>
<tbody>
<row>
- <entry><literal><function>generate_series</function>(<parameter>start</parameter>, <parameter>stop</parameter>)</literal></entry>
+ <entry><literal><function>generate_series(<parameter>start</parameter>, <parameter>stop</parameter>)</function></literal></entry>
<entry><type>int</type> or <type>bigint</type></entry>
<entry><type>setof int</type> or <type>setof bigint</type> (same as argument type)</entry>
<entry>
</row>
<row>
- <entry><literal><function>generate_series</function>(<parameter>start</parameter>, <parameter>stop</parameter>, <parameter>step</parameter>)</literal></entry>
+ <entry><literal><function>generate_series(<parameter>start</parameter>, <parameter>stop</parameter>, <parameter>step</parameter>)</function></literal></entry>
<entry><type>int</type> or <type>bigint</type></entry>
<entry><type>setof int</type> or <type>setof bigint</type> (same as argument type)</entry>
<entry>
</row>
<row>
- <entry><literal><function>generate_series</function>(<parameter>start</parameter>, <parameter>stop</parameter>, <parameter>step</parameter> <type>interval</>)</literal></entry>
+ <entry><literal><function>generate_series(<parameter>start</parameter>, <parameter>stop</parameter>, <parameter>step</parameter> <type>interval</>)</function></literal></entry>
<entry><type>timestamp</type> or <type>timestamp with time zone</type></entry>
<entry><type>setof timestamp</type> or <type>setof timestamp with time zone</type> (same as argument type)</entry>
<entry>
<tbody>
<row>
- <entry><literal><function>generate_subscripts</function>(<parameter>array anyarray</parameter>, <parameter>dim int</parameter>)</literal></entry>
+ <entry><literal><function>generate_subscripts(<parameter>array anyarray</parameter>, <parameter>dim int</parameter>)</function></literal></entry>
<entry><type>setof int</type></entry>
<entry>
Generate a series comprising the given array's subscripts.
</row>
<row>
- <entry><literal><function>generate_subscripts</function>(<parameter>array anyarray</parameter>, <parameter>dim int</parameter>, <parameter>reverse boolean</parameter>)</literal></entry>
+ <entry><literal><function>generate_subscripts(<parameter>array anyarray</parameter>, <parameter>dim int</parameter>, <parameter>reverse boolean</parameter>)</function></literal></entry>
<entry><type>setof int</type></entry>
<entry>
Generate a series comprising the given array's subscripts. When
</row>
<row>
- <entry><literal><function>current_database</function>()</literal></entry>
+ <entry><literal><function>current_database()</function></literal></entry>
<entry><type>name</type></entry>
<entry>name of current database</entry>
</row>
</row>
<row>
- <entry><literal><function>current_schemas</function>(<type>boolean</type>)</literal></entry>
+ <entry><literal><function>current_schemas(<type>boolean</type>)</function></literal></entry>
<entry><type>name[]</type></entry>
<entry>names of schemas in search path, optionally including implicit schemas</entry>
</row>
</row>
<row>
- <entry><literal><function>current_query</function>()</literal></entry>
+ <entry><literal><function>current_query()</function></literal></entry>
<entry><type>text</type></entry>
<entry>text of the currently executing query, as submitted
by the client (might contain more than one statement)</entry>
<row>
<!-- See also the entry for this in monitoring.sgml -->
- <entry><literal><function>pg_backend_pid</function>()</literal></entry>
+ <entry><literal><function>pg_backend_pid()</function></literal></entry>
<entry><type>int</type></entry>
<entry>
Process ID of the server process attached to the current session
</row>
<row>
- <entry><literal><function>pg_listening_channels</function>()</literal></entry>
+ <entry><literal><function>pg_listening_channels()</function></literal></entry>
<entry><type>setof text</type></entry>
<entry>channel names that the session is currently listening on</entry>
</row>
<row>
- <entry><literal><function>inet_client_addr</function>()</literal></entry>
+ <entry><literal><function>inet_client_addr()</function></literal></entry>
<entry><type>inet</type></entry>
<entry>address of the remote connection</entry>
</row>
<row>
- <entry><literal><function>inet_client_port</function>()</literal></entry>
+ <entry><literal><function>inet_client_port()</function></literal></entry>
<entry><type>int</type></entry>
<entry>port of the remote connection</entry>
</row>
<row>
- <entry><literal><function>inet_server_addr</function>()</literal></entry>
+ <entry><literal><function>inet_server_addr()</function></literal></entry>
<entry><type>inet</type></entry>
<entry>address of the local connection</entry>
</row>
<row>
- <entry><literal><function>inet_server_port</function>()</literal></entry>
+ <entry><literal><function>inet_server_port()</function></literal></entry>
<entry><type>int</type></entry>
<entry>port of the local connection</entry>
</row>
<row>
- <entry><literal><function>pg_my_temp_schema</function>()</literal></entry>
+ <entry><literal><function>pg_my_temp_schema()</function></literal></entry>
<entry><type>oid</type></entry>
<entry>OID of session's temporary schema, or 0 if none</entry>
</row>
<row>
- <entry><literal><function>pg_is_other_temp_schema</function>(<type>oid</type>)</literal></entry>
+ <entry><literal><function>pg_is_other_temp_schema(<type>oid</type>)</function></literal></entry>
<entry><type>boolean</type></entry>
<entry>is schema another session's temporary schema?</entry>
</row>
<row>
- <entry><literal><function>pg_postmaster_start_time</function>()</literal></entry>
+ <entry><literal><function>pg_postmaster_start_time()</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>server start time</entry>
</row>
<row>
- <entry><literal><function>pg_conf_load_time</function>()</literal></entry>
+ <entry><literal><function>pg_conf_load_time()</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>configuration load time</entry>
</row>
</row>
<row>
- <entry><literal><function>version</function>()</literal></entry>
+ <entry><literal><function>version()</function></literal></entry>
<entry><type>text</type></entry>
<entry><productname>PostgreSQL</> version information</entry>
</row>
<tbody>
<row>
- <entry><literal><function>pg_conversion_is_visible</function>(<parameter>conversion_oid</parameter>)</literal>
+ <entry><literal><function>pg_conversion_is_visible(<parameter>conversion_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is conversion visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_function_is_visible</function>(<parameter>function_oid</parameter>)</literal>
+ <entry><literal><function>pg_function_is_visible(<parameter>function_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is function visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_operator_is_visible</function>(<parameter>operator_oid</parameter>)</literal>
+ <entry><literal><function>pg_operator_is_visible(<parameter>operator_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is operator visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_opclass_is_visible</function>(<parameter>opclass_oid</parameter>)</literal>
+ <entry><literal><function>pg_opclass_is_visible(<parameter>opclass_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is operator class visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_table_is_visible</function>(<parameter>table_oid</parameter>)</literal>
+ <entry><literal><function>pg_table_is_visible(<parameter>table_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is table visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_ts_config_is_visible</function>(<parameter>config_oid</parameter>)</literal>
+ <entry><literal><function>pg_ts_config_is_visible(<parameter>config_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is text search configuration visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_ts_dict_is_visible</function>(<parameter>dict_oid</parameter>)</literal>
+ <entry><literal><function>pg_ts_dict_is_visible(<parameter>dict_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is text search dictionary visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_ts_parser_is_visible</function>(<parameter>parser_oid</parameter>)</literal>
+ <entry><literal><function>pg_ts_parser_is_visible(<parameter>parser_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is text search parser visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_ts_template_is_visible</function>(<parameter>template_oid</parameter>)</literal>
+ <entry><literal><function>pg_ts_template_is_visible(<parameter>template_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is text search template visible in search path</entry>
</row>
<row>
- <entry><literal><function>pg_type_is_visible</function>(<parameter>type_oid</parameter>)</literal>
+ <entry><literal><function>pg_type_is_visible(<parameter>type_oid</parameter>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is type (or domain) visible in search path</entry>
<tbody>
<row>
- <entry><literal><function>format_type</function>(<parameter>type_oid</parameter>, <parameter>typemod</>)</literal></entry>
+ <entry><literal><function>format_type(<parameter>type_oid</parameter>, <parameter>typemod</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get SQL name of a data type</entry>
</row>
<row>
- <entry><literal><function>pg_get_keywords</function>()</literal></entry>
+ <entry><literal><function>pg_get_keywords()</function></literal></entry>
<entry><type>setof record</type></entry>
<entry>get list of SQL keywords and their categories</entry>
</row>
<row>
- <entry><literal><function>pg_get_constraintdef</function>(<parameter>constraint_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_constraintdef(<parameter>constraint_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get definition of a constraint</entry>
</row>
<row>
- <entry><literal><function>pg_get_constraintdef</function>(<parameter>constraint_oid</parameter>, <parameter>pretty_bool</>)</literal></entry>
+ <entry><literal><function>pg_get_constraintdef(<parameter>constraint_oid</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get definition of a constraint</entry>
</row>
<row>
- <entry><literal><function>pg_get_expr</function>(<parameter>pg_node_tree</parameter>, <parameter>relation_oid</>)</literal></entry>
+ <entry><literal><function>pg_get_expr(<parameter>pg_node_tree</parameter>, <parameter>relation_oid</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>decompile internal form of an expression, assuming that any Vars
in it refer to the relation indicated by the second parameter</entry>
</row>
<row>
- <entry><literal><function>pg_get_expr</function>(<parameter>pg_node_tree</parameter>, <parameter>relation_oid</>, <parameter>pretty_bool</>)</literal></entry>
+ <entry><literal><function>pg_get_expr(<parameter>pg_node_tree</parameter>, <parameter>relation_oid</>, <parameter>pretty_bool</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>decompile internal form of an expression, assuming that any Vars
in it refer to the relation indicated by the second parameter</entry>
</row>
<row>
- <entry><literal><function>pg_get_functiondef</function>(<parameter>func_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_functiondef(<parameter>func_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get definition of a function</entry>
</row>
<row>
- <entry><literal><function>pg_get_function_arguments</function>(<parameter>func_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_function_arguments(<parameter>func_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get argument list of function's definition (with default values)</entry>
</row>
<row>
- <entry><literal><function>pg_get_function_identity_arguments</function>(<parameter>func_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_function_identity_arguments(<parameter>func_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get argument list to identify a function (without default values)</entry>
</row>
<row>
- <entry><literal><function>pg_get_function_result</function>(<parameter>func_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_function_result(<parameter>func_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get <literal>RETURNS</> clause for function</entry>
</row>
<row>
- <entry><literal><function>pg_get_indexdef</function>(<parameter>index_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_indexdef(<parameter>index_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get <command>CREATE INDEX</> command for index</entry>
</row>
<row>
- <entry><literal><function>pg_get_indexdef</function>(<parameter>index_oid</parameter>, <parameter>column_no</>, <parameter>pretty_bool</>)</literal></entry>
+ <entry><literal><function>pg_get_indexdef(<parameter>index_oid</parameter>, <parameter>column_no</>, <parameter>pretty_bool</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get <command>CREATE INDEX</> command for index,
or definition of just one index column when
<parameter>column_no</> is not zero</entry>
</row>
<row>
- <entry><literal><function>pg_get_ruledef</function>(<parameter>rule_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_ruledef(<parameter>rule_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get <command>CREATE RULE</> command for rule</entry>
</row>
<row>
- <entry><literal><function>pg_get_ruledef</function>(<parameter>rule_oid</parameter>, <parameter>pretty_bool</>)</literal></entry>
+ <entry><literal><function>pg_get_ruledef(<parameter>rule_oid</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get <command>CREATE RULE</> command for rule</entry>
</row>
<row>
- <entry><literal><function>pg_get_serial_sequence</function>(<parameter>table_name</parameter>, <parameter>column_name</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_serial_sequence(<parameter>table_name</parameter>, <parameter>column_name</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get name of the sequence that a <type>serial</type> or <type>bigserial</type> column
uses</entry>
<entry>get <command>CREATE [ CONSTRAINT ] TRIGGER</> command for trigger</entry>
</row>
<row>
- <entry><literal><function>pg_get_userbyid</function>(<parameter>role_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_userbyid(<parameter>role_oid</parameter>)</function></literal></entry>
<entry><type>name</type></entry>
<entry>get role name with given OID</entry>
</row>
<row>
- <entry><literal><function>pg_get_viewdef</function>(<parameter>view_name</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_viewdef(<parameter>view_name</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get underlying <command>SELECT</command> command for view (<emphasis>deprecated</emphasis>)</entry>
</row>
<row>
- <entry><literal><function>pg_get_viewdef</function>(<parameter>view_name</parameter>, <parameter>pretty_bool</>)</literal></entry>
+ <entry><literal><function>pg_get_viewdef(<parameter>view_name</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get underlying <command>SELECT</command> command for view (<emphasis>deprecated</emphasis>)</entry>
</row>
<row>
- <entry><literal><function>pg_get_viewdef</function>(<parameter>view_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get underlying <command>SELECT</command> command for view</entry>
</row>
<row>
- <entry><literal><function>pg_get_viewdef</function>(<parameter>view_oid</parameter>, <parameter>pretty_bool</>)</literal></entry>
+ <entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get underlying <command>SELECT</command> command for view</entry>
</row>
<row>
- <entry><literal><function>pg_tablespace_databases</function>(<parameter>tablespace_oid</parameter>)</literal></entry>
+ <entry><literal><function>pg_tablespace_databases(<parameter>tablespace_oid</parameter>)</function></literal></entry>
<entry><type>setof oid</type></entry>
<entry>get the set of database OIDs that have objects in the tablespace</entry>
</row>
<row>
- <entry><literal><function>pg_typeof</function>(<parameter>any</parameter>)</literal></entry>
+ <entry><literal><function>pg_typeof(<parameter>any</parameter>)</function></literal></entry>
<entry><type>regtype</type></entry>
<entry>get the data type of any value</entry>
</row>
<tbody>
<row>
- <entry><literal><function>col_description</function>(<parameter>table_oid</parameter>, <parameter>column_number</parameter>)</literal></entry>
+ <entry><literal><function>col_description(<parameter>table_oid</parameter>, <parameter>column_number</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get comment for a table column</entry>
</row>
<row>
- <entry><literal><function>obj_description</function>(<parameter>object_oid</parameter>, <parameter>catalog_name</parameter>)</literal></entry>
+ <entry><literal><function>obj_description(<parameter>object_oid</parameter>, <parameter>catalog_name</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get comment for a database object</entry>
</row>
<row>
- <entry><literal><function>obj_description</function>(<parameter>object_oid</parameter>)</literal></entry>
+ <entry><literal><function>obj_description(<parameter>object_oid</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get comment for a database object (<emphasis>deprecated</emphasis>)</entry>
</row>
<row>
- <entry><literal><function>shobj_description</function>(<parameter>object_oid</parameter>, <parameter>catalog_name</parameter>)</literal></entry>
+ <entry><literal><function>shobj_description(<parameter>object_oid</parameter>, <parameter>catalog_name</parameter>)</function></literal></entry>
<entry><type>text</type></entry>
<entry>get comment for a shared database object</entry>
</row>
<tbody>
<row>
- <entry><literal><function>txid_current</function>()</literal></entry>
+ <entry><literal><function>txid_current()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>get current transaction ID</entry>
</row>
<row>
- <entry><literal><function>txid_current_snapshot</function>()</literal></entry>
+ <entry><literal><function>txid_current_snapshot()</function></literal></entry>
<entry><type>txid_snapshot</type></entry>
<entry>get current snapshot</entry>
</row>
<row>
- <entry><literal><function>txid_snapshot_xmin</function>(<parameter>txid_snapshot</parameter>)</literal></entry>
+ <entry><literal><function>txid_snapshot_xmin(<parameter>txid_snapshot</parameter>)</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>get xmin of snapshot</entry>
</row>
<row>
- <entry><literal><function>txid_snapshot_xmax</function>(<parameter>txid_snapshot</parameter>)</literal></entry>
+ <entry><literal><function>txid_snapshot_xmax(<parameter>txid_snapshot</parameter>)</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>get xmax of snapshot</entry>
</row>
<row>
- <entry><literal><function>txid_snapshot_xip</function>(<parameter>txid_snapshot</parameter>)</literal></entry>
+ <entry><literal><function>txid_snapshot_xip(<parameter>txid_snapshot</parameter>)</function></literal></entry>
<entry><type>setof bigint</type></entry>
<entry>get in-progress transaction IDs in snapshot</entry>
</row>
<row>
- <entry><literal><function>txid_visible_in_snapshot</function>(<parameter>bigint</parameter>, <parameter>txid_snapshot</parameter>)</literal></entry>
+ <entry><literal><function>txid_visible_in_snapshot(<parameter>bigint</parameter>, <parameter>txid_snapshot</parameter>)</function></literal></entry>
<entry><type>boolean</type></entry>
<entry>is transaction ID visible in snapshot? (do not use with subtransaction ids)</entry>
</row>
<tbody>
<row>
<entry>
- <literal><function>current_setting</function>(<parameter>setting_name</parameter>)</literal>
+ <literal><function>current_setting(<parameter>setting_name</parameter>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>get current value of setting</entry>
<tbody>
<row>
<entry>
- <literal><function>pg_cancel_backend</function>(<parameter>pid</parameter> <type>int</>)</literal>
+ <literal><function>pg_cancel_backend(<parameter>pid</parameter> <type>int</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Cancel a backend's current query</entry>
</row>
<row>
<entry>
- <literal><function>pg_terminate_backend</function>(<parameter>pid</parameter> <type>int</>)</literal>
+ <literal><function>pg_terminate_backend(<parameter>pid</parameter> <type>int</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Terminate a backend</entry>
</row>
<row>
<entry>
- <literal><function>pg_reload_conf</function>()</literal>
+ <literal><function>pg_reload_conf()</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Cause server processes to reload their configuration files</entry>
</row>
<row>
<entry>
- <literal><function>pg_rotate_logfile</function>()</literal>
+ <literal><function>pg_rotate_logfile()</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Rotate server's log file</entry>
<tbody>
<row>
<entry>
- <literal><function>pg_start_backup</function>(<parameter>label</> <type>text</> <optional>, <parameter>fast</> <type>boolean</> </optional>)</literal>
+ <literal><function>pg_start_backup(<parameter>label</> <type>text</> <optional>, <parameter>fast</> <type>boolean</> </optional>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Prepare for performing on-line backup</entry>
</row>
<row>
<entry>
- <literal><function>pg_stop_backup</function>()</literal>
+ <literal><function>pg_stop_backup()</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Finish performing on-line backup</entry>
</row>
<row>
<entry>
- <literal><function>pg_switch_xlog</function>()</literal>
+ <literal><function>pg_switch_xlog()</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Force switch to a new transaction log file</entry>
</row>
<row>
<entry>
- <literal><function>pg_current_xlog_location</function>()</literal>
+ <literal><function>pg_current_xlog_location()</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Get current transaction log write location</entry>
</row>
<row>
<entry>
- <literal><function>pg_current_xlog_insert_location</function>()</literal>
+ <literal><function>pg_current_xlog_insert_location()</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Get current transaction log insert location</entry>
</row>
<row>
<entry>
- <literal><function>pg_xlogfile_name_offset</function>(<parameter>location</> <type>text</>)</literal>
+ <literal><function>pg_xlogfile_name_offset(<parameter>location</> <type>text</>)</function></literal>
</entry>
<entry><type>text</>, <type>integer</></entry>
<entry>Convert transaction log location string to file name and decimal byte offset within file</entry>
</row>
<row>
<entry>
- <literal><function>pg_xlogfile_name</function>(<parameter>location</> <type>text</>)</literal>
+ <literal><function>pg_xlogfile_name(<parameter>location</> <type>text</>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Convert transaction log location string to file name</entry>
<tbody>
<row>
<entry>
- <literal><function>pg_is_in_recovery</function>()</literal>
+ <literal><function>pg_is_in_recovery()</function></literal>
</entry>
<entry><type>bool</type></entry>
<entry>True if recovery is still in progress.
</row>
<row>
<entry>
- <literal><function>pg_last_xlog_receive_location</function>()</literal>
+ <literal><function>pg_last_xlog_receive_location()</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Get last transaction log location received and synced to disk by
</row>
<row>
<entry>
- <literal><function>pg_last_xlog_replay_location</function>()</literal>
+ <literal><function>pg_last_xlog_replay_location()</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Get last transaction log location replayed during recovery.
<tbody>
<row>
- <entry><literal><function>pg_column_size</function>(<type>any</type>)</literal></entry>
+ <entry><literal><function>pg_column_size(<type>any</type>)</function></literal></entry>
<entry><type>int</type></entry>
<entry>Number of bytes used to store a particular value (possibly compressed)</entry>
</row>
<row>
<entry>
- <literal><function>pg_total_relation_size</function>(<type>regclass</type>)</literal>
+ <literal><function>pg_total_relation_size(<type>regclass</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>
</row>
<row>
<entry>
- <literal><function>pg_table_size</function>(<type>regclass</type>)</literal>
+ <literal><function>pg_table_size(<type>regclass</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>
</row>
<row>
<entry>
- <literal><function>pg_indexes_size</function>(<type>regclass</type>)</literal>
+ <literal><function>pg_indexes_size(<type>regclass</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>
</row>
<row>
<entry>
- <literal><function>pg_database_size</function>(<type>oid</type>)</literal>
+ <literal><function>pg_database_size(<type>oid</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>Disk space used by the database with the specified OID</entry>
</row>
<row>
<entry>
- <literal><function>pg_database_size</function>(<type>name</type>)</literal>
+ <literal><function>pg_database_size(<type>name</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>Disk space used by the database with the specified name</entry>
</row>
<row>
<entry>
- <literal><function>pg_tablespace_size</function>(<type>oid</type>)</literal>
+ <literal><function>pg_tablespace_size(<type>oid</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>Disk space used by the tablespace with the specified OID</entry>
</row>
<row>
<entry>
- <literal><function>pg_tablespace_size</function>(<type>name</type>)</literal>
+ <literal><function>pg_tablespace_size(<type>name</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>Disk space used by the tablespace with the specified name</entry>
</row>
<row>
<entry>
- <literal><function>pg_relation_size</function>(<parameter>relation</parameter> <type>regclass</type>, <parameter>fork</parameter> <type>text</type>)</literal>
+ <literal><function>pg_relation_size(<parameter>relation</parameter> <type>regclass</type>, <parameter>fork</parameter> <type>text</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>
</row>
<row>
<entry>
- <literal><function>pg_relation_size</function>(<parameter>relation</parameter> <type>regclass</type>)</literal>
+ <literal><function>pg_relation_size(<parameter>relation</parameter> <type>regclass</type>)</function></literal>
</entry>
<entry><type>bigint</type></entry>
<entry>
</row>
<row>
<entry>
- <literal><function>pg_size_pretty</function>(<type>bigint</type>)</literal>
+ <literal><function>pg_size_pretty(<type>bigint</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Converts a size in bytes into a human-readable format with size units</entry>
<tbody>
<row>
<entry>
- <literal><function>pg_relation_filenode</function>(<parameter>relation</parameter> <type>regclass</type>)</literal>
+ <literal><function>pg_relation_filenode(<parameter>relation</parameter> <type>regclass</type>)</function></literal>
</entry>
<entry><type>oid</type></entry>
<entry>
</row>
<row>
<entry>
- <literal><function>pg_relation_filepath</function>(<parameter>relation</parameter> <type>regclass</type>)</literal>
+ <literal><function>pg_relation_filepath(<parameter>relation</parameter> <type>regclass</type>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>
<tbody>
<row>
<entry>
- <literal><function>pg_ls_dir</function>(<parameter>dirname</> <type>text</>)</literal>
+ <literal><function>pg_ls_dir(<parameter>dirname</> <type>text</>)</function></literal>
</entry>
<entry><type>setof text</type></entry>
<entry>List the contents of a directory</entry>
</row>
<row>
<entry>
- <literal><function>pg_read_file</function>(<parameter>filename</> <type>text</>, <parameter>offset</> <type>bigint</>, <parameter>length</> <type>bigint</>)</literal>
+ <literal><function>pg_read_file(<parameter>filename</> <type>text</>, <parameter>offset</> <type>bigint</>, <parameter>length</> <type>bigint</>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>Return the contents of a text file</entry>
</row>
<row>
<entry>
- <literal><function>pg_stat_file</function>(<parameter>filename</> <type>text</>)</literal>
+ <literal><function>pg_stat_file(<parameter>filename</> <type>text</>)</function></literal>
</entry>
<entry><type>record</type></entry>
<entry>Return information about a file</entry>
<tbody>
<row>
<entry>
- <literal><function>pg_advisory_lock</function>(<parameter>key</> <type>bigint</>)</literal>
+ <literal><function>pg_advisory_lock(<parameter>key</> <type>bigint</>)</function></literal>
</entry>
<entry><type>void</type></entry>
<entry>Obtain exclusive advisory lock</entry>
</row>
<row>
<entry>
- <literal><function>pg_advisory_lock</function>(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</literal>
+ <literal><function>pg_advisory_lock(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</function></literal>
</entry>
<entry><type>void</type></entry>
<entry>Obtain exclusive advisory lock</entry>
<row>
<entry>
- <literal><function>pg_advisory_lock_shared</function>(<parameter>key</> <type>bigint</>)</literal>
+ <literal><function>pg_advisory_lock_shared(<parameter>key</> <type>bigint</>)</function></literal>
</entry>
<entry><type>void</type></entry>
<entry>Obtain shared advisory lock</entry>
</row>
<row>
<entry>
- <literal><function>pg_advisory_lock_shared</function>(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</literal>
+ <literal><function>pg_advisory_lock_shared(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</function></literal>
</entry>
<entry><type>void</type></entry>
<entry>Obtain shared advisory lock</entry>
<row>
<entry>
- <literal><function>pg_try_advisory_lock</function>(<parameter>key</> <type>bigint</>)</literal>
+ <literal><function>pg_try_advisory_lock(<parameter>key</> <type>bigint</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Obtain exclusive advisory lock if available</entry>
</row>
<row>
<entry>
- <literal><function>pg_try_advisory_lock</function>(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</literal>
+ <literal><function>pg_try_advisory_lock(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Obtain exclusive advisory lock if available</entry>
<row>
<entry>
- <literal><function>pg_try_advisory_lock_shared</function>(<parameter>key</> <type>bigint</>)</literal>
+ <literal><function>pg_try_advisory_lock_shared(<parameter>key</> <type>bigint</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Obtain shared advisory lock if available</entry>
</row>
<row>
<entry>
- <literal><function>pg_try_advisory_lock_shared</function>(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</literal>
+ <literal><function>pg_try_advisory_lock_shared(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Obtain shared advisory lock if available</entry>
<row>
<entry>
- <literal><function>pg_advisory_unlock</function>(<parameter>key</> <type>bigint</>)</literal>
+ <literal><function>pg_advisory_unlock(<parameter>key</> <type>bigint</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Release an exclusive advisory lock</entry>
</row>
<row>
<entry>
- <literal><function>pg_advisory_unlock</function>(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</literal>
+ <literal><function>pg_advisory_unlock(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Release an exclusive advisory lock</entry>
<row>
<entry>
- <literal><function>pg_advisory_unlock_shared</function>(<parameter>key</> <type>bigint</>)</literal>
+ <literal><function>pg_advisory_unlock_shared(<parameter>key</> <type>bigint</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Release a shared advisory lock</entry>
</row>
<row>
<entry>
- <literal><function>pg_advisory_unlock_shared</function>(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</literal>
+ <literal><function>pg_advisory_unlock_shared(<parameter>key1</> <type>int</>, <parameter>key2</> <type>int</>)</function></literal>
</entry>
<entry><type>boolean</type></entry>
<entry>Release a shared advisory lock</entry>
<row>
<entry>
- <literal><function>pg_advisory_unlock_all</function>()</literal>
+ <literal><function>pg_advisory_unlock_all()</function></literal>
</entry>
<entry><type>void</type></entry>
<entry>Release all advisory locks held by the current session</entry>
projects / postgresql / commitdiff