rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
postgresql/doc/src/sgml/func.sgml

11190 lines
386 KiB
Plaintext
Raw Normal View History

Update documentation for pg_get_serial_sequence() function.
2007-01-30 03:39:27 +01:00
<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.354 2007/01/30 02:39:27 momjian Exp $ -->
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<chapter id="functions">
<title>Functions and Operators</title>
<indexterm zone="functions">
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>function</primary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<indexterm zone="functions">
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>operator</primary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
<para>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<productname>PostgreSQL</productname> provides a large number of
functions and operators for the built-in data types. Users can also
Merge documentation into one book. (Build with "make html".) Replace vague cross-references with real links.
2003-03-25 17:15:44 +01:00
define their own functions and operators, as described in
<xref linkend="server-programming">. The
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<application>psql</application> commands <command>\df</command> and
<command>\do</command> can be used to show the list of all actually
available functions and operators, respectively.
</para>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
If you are concerned about portability then take note that most of
the functions and operators described in this chapter, with the
exception of the most trivial arithmetic and comparison operators
and some explicitly marked functions, are not specified by the
Random copy-editing.
2003-11-04 10:55:39 +01:00
<acronym>SQL</acronym> standard. Some of the extended functionality
is present in other <acronym>SQL</acronym> database management
systems, and in many cases this functionality is compatible and
Add mention that not all functions are listed. Update Chinese FAQ for HTML.
2005-05-11 15:36:14 +02:00
consistent between the various implementations. This chapter is also
Fix newly introduced spelling error.
2005-05-11 15:58:50 +02:00
not exhaustive; additional functions appear in relevant sections of
Add mention that not all functions are listed. Update Chinese FAQ for HTML.
2005-05-11 15:36:14 +02:00
the manual.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<sect1 id="functions-logical">
<title>Logical Operators</title>
<indexterm zone="functions-logical">
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>operator</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<secondary>logical</secondary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
<indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<primary>Boolean</primary>
<secondary>operators</secondary>
<see>operators, logical</see>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
The usual logical operators are available:
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>AND (operator)</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</indexterm>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>OR (operator)</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</indexterm>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>NOT (operator)</primary>
</indexterm>
<indexterm>
<primary>conjunction</primary>
</indexterm>
<indexterm>
<primary>disjunction</primary>
</indexterm>
<indexterm>
<primary>negation</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</indexterm>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<simplelist>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<member><literal>AND</></member>
<member><literal>OR</></member>
<member><literal>NOT</></member>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</simplelist>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<acronym>SQL</acronym> uses a three-valued Boolean logic where the null value represents
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<quote>unknown</quote>. Observe the following truth tables:
<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry><replaceable>a</replaceable></entry>
<entry><replaceable>b</replaceable></entry>
<entry><replaceable>a</replaceable> AND <replaceable>b</replaceable></entry>
<entry><replaceable>a</replaceable> OR <replaceable>b</replaceable></entry>
</row>
</thead>
<tbody>
<row>
<entry>TRUE</entry>
<entry>TRUE</entry>
<entry>TRUE</entry>
<entry>TRUE</entry>
</row>
<row>
<entry>TRUE</entry>
<entry>FALSE</entry>
<entry>FALSE</entry>
<entry>TRUE</entry>
</row>
<row>
<entry>TRUE</entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>TRUE</entry>
</row>
<row>
<entry>FALSE</entry>
<entry>FALSE</entry>
<entry>FALSE</entry>
<entry>FALSE</entry>
</row>
<row>
<entry>FALSE</entry>
<entry>NULL</entry>
<entry>FALSE</entry>
<entry>NULL</entry>
</row>
<row>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>NULL</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry><replaceable>a</replaceable></entry>
<entry>NOT <replaceable>a</replaceable></entry>
</row>
</thead>
<tbody>
<row>
<entry>TRUE</entry>
<entry>FALSE</entry>
</row>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry>FALSE</entry>
<entry>TRUE</entry>
</row>
<row>
<entry>NULL</entry>
<entry>NULL</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
Add a note that AND and OR are commutative. Apparently, they are not in certain other products.
2003-08-04 16:00:14 +02:00
<para>
The operators <literal>AND</literal> and <literal>OR</literal> are
commutative, that is, you can switch the left and right operand
without affecting the result. But see <xref
linkend="syntax-express-eval"> for more information about the
order of evaluation of subexpressions.
</para>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</sect1>
<sect1 id="functions-comparison">
<title>Comparison Operators</title>
<indexterm zone="functions-comparison">
<primary>comparison</primary>
<secondary>operators</secondary>
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
The usual comparison operators are available, shown in <xref
linkend="functions-comparison-table">.
</para>
<table id="functions-comparison-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title>Comparison Operators</title>
<tgroup cols="2">
<thead>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>Operator</entry>
<entry>Description</entry>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</thead>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tbody>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>&lt;</literal> </entry>
<entry>less than</entry>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
</row>
AND/OR truth table needs another row IMHO.
2001-02-19 01:01:18 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>&gt;</literal> </entry>
<entry>greater than</entry>
AND/OR truth table needs another row IMHO.
2001-02-19 01:01:18 +01:00
</row>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>&lt;=</literal> </entry>
<entry>less than or equal to</entry>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
</row>
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>&gt;=</literal> </entry>
<entry>greater than or equal to</entry>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
</row>
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>=</literal> </entry>
<entry>equal</entry>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
</row>
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>&lt;&gt;</literal> or <literal>!=</literal> </entry>
<entry>not equal</entry>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
</row>
</tbody>
</tgroup>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<note>
<para>
The <literal>!=</literal> operator is converted to
<literal>&lt;&gt;</literal> in the parser stage. It is not
possible to implement <literal>!=</literal> and
<literal>&lt;&gt;</literal> operators that do different things.
</para>
</note>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Minor updates for release.
1999-06-14 09:36:12 +02:00
<para>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Comparison operators are available for all data types where this
makes sense. All comparison operators are binary operators that
return values of type <type>boolean</type>; expressions like
<literal>1 &lt; 2 &lt; 3</literal> are not valid (because there is
no <literal>&lt;</literal> operator to compare a Boolean value with
<literal>3</literal>).
Minor updates for release.
1999-06-14 09:36:12 +02:00
</para>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
<indexterm>
Be a little more consistent about which terms are uppercased in index entries.
2003-12-26 22:30:48 +01:00
<primary>BETWEEN</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</indexterm>
In addition to the comparison operators, the special
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<token>BETWEEN</token> construct is available.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Document BETWEEN.
2001-02-05 20:21:45 +01:00
<replaceable>a</replaceable> BETWEEN <replaceable>x</replaceable> AND <replaceable>y</replaceable>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
is equivalent to
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Fix markup, Alvaro Herrera.
2002-08-21 07:25:49 +02:00
<replaceable>a</replaceable> &gt;= <replaceable>x</replaceable> AND <replaceable>a</replaceable> &lt;= <replaceable>y</replaceable>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Similarly,
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Document BETWEEN.
2001-02-05 20:21:45 +01:00
<replaceable>a</replaceable> NOT BETWEEN <replaceable>x</replaceable> AND <replaceable>y</replaceable>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
is equivalent to
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Fix markup, Alvaro Herrera.
2002-08-21 07:25:49 +02:00
<replaceable>a</replaceable> &lt; <replaceable>x</replaceable> OR <replaceable>a</replaceable> &gt; <replaceable>y</replaceable>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
There is no difference between the two respective forms apart from
the <acronym>CPU</acronym> cycles required to rewrite the first one
into the second one internally.
Add BETWEEN SYMMETRIC. Pavel Stehule
2005-06-15 01:47:39 +02:00
<indexterm>
<primary>BETWEEN SYMETRIC</primary>
</indexterm>
<token>BETWEEN SYMMETRIC</> is the same as <literal>BETWEEN</>
except there is no requirement that the argument to the left of <literal>AND</> be less than
or equal to the argument on the right; the proper range is automatically determined.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
Document BETWEEN.
2001-02-05 20:21:45 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<indexterm>
<primary>IS NULL</primary>
</indexterm>
<indexterm>
<primary>IS NOT NULL</primary>
</indexterm>
<indexterm>
<primary>ISNULL</primary>
</indexterm>
<indexterm>
<primary>NOTNULL</primary>
</indexterm>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
To check whether a value is or is not null, use the constructs
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Description of table expressions, including join syntax, from Robert B. Easter <reaster@comptechnews.com>, heavily massaged by me. Also cleaned up value expressions a bit.
2001-01-21 23:02:01 +01:00
<replaceable>expression</replaceable> IS NULL
<replaceable>expression</replaceable> IS NOT NULL
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
or the equivalent, but nonstandard, constructs
<synopsis>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
<replaceable>expression</replaceable> ISNULL
<replaceable>expression</replaceable> NOTNULL
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<indexterm><primary>null value</primary><secondary>comparing</secondary></indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Do <emphasis>not</emphasis> write
<literal><replaceable>expression</replaceable> = NULL</literal>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
because <literal>NULL</> is not <quote>equal to</quote>
<literal>NULL</>. (The null value represents an unknown value,
Editorialization of some text discussing 'IS NULL' vs. '= NULL'.
2004-03-07 02:01:44 +01:00
and it is not known whether two unknown values are equal.) This
behavior conforms to the SQL standard.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
Add IS UNKNOWN, IS NOT UNKNOWN boolean tests, fix the existing boolean tests to return the correct results per SQL9x when given NULL inputs. Reimplement these tests as well as IS [NOT] NULL to have their own expression node types, instead of depending on special functions. From Joe Conway, with a little help from Tom Lane.
2001-06-20 00:39:12 +02:00
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<tip>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Editorialization of some text discussing 'IS NULL' vs. '= NULL'.
2004-03-07 02:01:44 +01:00
Some applications may expect that
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<literal><replaceable>expression</replaceable> = NULL</literal>
returns true if <replaceable>expression</replaceable> evaluates to
Editorialization of some text discussing 'IS NULL' vs. '= NULL'.
2004-03-07 02:01:44 +01:00
the null value. It is highly recommended that these applications
be modified to comply with the SQL standard. However, if that
Refer to GUC variables using <xref> tags rather than <varname> tags, where appropriate. Add "id" and "xreflabel" tags to the descriptions of the GUC variables to facilitate this. Also make a few minor docs cleanups.
2004-03-09 17:57:47 +01:00
cannot be done the <xref linkend="guc-transform-null-equals">
Editorialization of some text discussing 'IS NULL' vs. '= NULL'.
2004-03-07 02:01:44 +01:00
configuration variable is available. If it is enabled,
<productname>PostgreSQL</productname> will convert <literal>x =
NULL</literal> clauses to <literal>x IS NULL</literal>. This was
the default behavior in <productname>PostgreSQL</productname>
releases 6.5 through 7.1.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
</tip>
Provide tunable knob for x = NULL -> x IS NULL transformation, default to off.
2001-09-20 16:20:28 +02:00
Fix IS NULL and IS NOT NULL tests on row-valued expressions to conform to the SQL spec, viz IS NULL is true if all the row's fields are null, IS NOT NULL is true if all the row's fields are not null. The former coding got this right for a limited number of cases with IS NULL (ie, those where it could disassemble a ROW constructor at parse time), but was entirely wrong for IS NOT NULL. Per report from Teodor. I desisted from changing the behavior for arrays, since on closer inspection it's not clear that there's any support for that in the SQL spec. This probably needs more consideration.
2006-09-28 22:51:43 +02:00
<note>
<para>
If the <replaceable>expression</replaceable> is row-valued, then
<literal>IS NULL</> is true when the row expression itself is null
or when all the row's fields are null, while
<literal>IS NOT NULL</> is true when the row expression itself is non-null
and all the row's fields are non-null.
This definition conforms to the SQL standard, and is a change from the
inconsistent behavior exhibited by <productname>PostgreSQL</productname>
versions prior to 8.2.
</para>
</note>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<indexterm>
<primary>IS DISTINCT FROM</primary>
</indexterm>
Implement IS NOT DISTINCT FROM, update the regression tests and docs. Patch from Pavel Stehule, minor fixups by myself.
2005-12-11 11:54:28 +01:00
<indexterm>
<primary>IS NOT DISTINCT FROM</primary>
</indexterm>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
The ordinary comparison operators yield null (signifying <quote>unknown</>)
when either input is null. Another way to do comparisons is with the
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
<literal>IS <optional> NOT </> DISTINCT FROM</literal> construct:
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<synopsis>
<replaceable>expression</replaceable> IS DISTINCT FROM <replaceable>expression</replaceable>
Implement IS NOT DISTINCT FROM, update the regression tests and docs. Patch from Pavel Stehule, minor fixups by myself.
2005-12-11 11:54:28 +01:00
<replaceable>expression</replaceable> IS NOT DISTINCT FROM <replaceable>expression</replaceable>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
</synopsis>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
For non-null inputs, <literal>IS DISTINCT FROM</literal> is
Implement IS NOT DISTINCT FROM, update the regression tests and docs. Patch from Pavel Stehule, minor fixups by myself.
2005-12-11 11:54:28 +01:00
the same as the <literal>&lt;&gt;</> operator. However, when both
inputs are null it will return false, and when just one input is
null it will return true. Similarly, <literal>IS NOT DISTINCT
FROM</literal> is identical to <literal>=</literal> for non-null
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
inputs, but it returns true when both inputs are null, and false when only
one input is null. Thus, these constructs effectively act as though null
Implement IS NOT DISTINCT FROM, update the regression tests and docs. Patch from Pavel Stehule, minor fixups by myself.
2005-12-11 11:54:28 +01:00
were a normal data value, rather than <quote>unknown</>.
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
</para>
<para>
<indexterm>
<primary>IS TRUE</primary>
</indexterm>
<indexterm>
<primary>IS NOT TRUE</primary>
</indexterm>
<indexterm>
<primary>IS FALSE</primary>
</indexterm>
<indexterm>
<primary>IS NOT FALSE</primary>
</indexterm>
<indexterm>
<primary>IS UNKNOWN</primary>
</indexterm>
<indexterm>
<primary>IS NOT UNKNOWN</primary>
</indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Boolean values can also be tested using the constructs
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Add IS UNKNOWN, IS NOT UNKNOWN boolean tests, fix the existing boolean tests to return the correct results per SQL9x when given NULL inputs. Reimplement these tests as well as IS [NOT] NULL to have their own expression node types, instead of depending on special functions. From Joe Conway, with a little help from Tom Lane.
2001-06-20 00:39:12 +02:00
<replaceable>expression</replaceable> IS TRUE
<replaceable>expression</replaceable> IS NOT TRUE
<replaceable>expression</replaceable> IS FALSE
<replaceable>expression</replaceable> IS NOT FALSE
<replaceable>expression</replaceable> IS UNKNOWN
<replaceable>expression</replaceable> IS NOT UNKNOWN
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
These will always return true or false, never a null value, even when the
operand is null.
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
A null input is treated as the logical value <quote>unknown</>.
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
Notice that <literal>IS UNKNOWN</> and <literal>IS NOT UNKNOWN</> are
effectively the same as <literal>IS NULL</literal> and
<literal>IS NOT NULL</literal>, respectively, except that the input
expression must be of Boolean type.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
</sect1>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<sect1 id="functions-math">
<title>Mathematical Functions and Operators</title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Mathematical operators are provided for many
<productname>PostgreSQL</productname> types. For types without
common mathematical conventions for all possible permutations
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
(e.g., date/time types) we
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
describe the actual behavior in subsequent sections.
</para>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="functions-math-op-table"> shows the available mathematical operators.
</para>
<table id="functions-math-op-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title>Mathematical Operators</title>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tgroup cols="4">
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
<thead>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry>Operator</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>Description</entry>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
<tbody>
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>+</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>addition</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>2 + 3</literal></entry>
<entry><literal>5</literal></entry>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>-</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>subtraction</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>2 - 3</literal></entry>
<entry><literal>-1</literal></entry>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>*</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>multiplication</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>2 * 3</literal></entry>
<entry><literal>6</literal></entry>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>/</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>division (integer division truncates results)</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>4 / 2</literal></entry>
<entry><literal>2</literal></entry>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>%</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>modulo (remainder)</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>5 % 4</literal></entry>
<entry><literal>1</literal></entry>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
<row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <literal>^</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>exponentiation</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>2.0 ^ 3.0</literal></entry>
<entry><literal>8</literal></entry>
Add information about bit types. Adjust some other things to promote SQL type names over internal type names.
2001-01-13 19:34:51 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>|/</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>square root</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>|/ 25.0</literal></entry>
<entry><literal>5</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>||/</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>cube root</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>||/ 27.0</literal></entry>
<entry><literal>3</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>!</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>factorial</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>5 !</literal></entry>
<entry><literal>120</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>!!</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>factorial (prefix operator)</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>!! 5</literal></entry>
<entry><literal>120</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>@</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>absolute value</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>@ -5.0</literal></entry>
<entry><literal>5</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>&amp;</literal> </entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry>bitwise AND</entry>
<entry><literal>91 &amp; 15</literal></entry>
<entry><literal>11</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>|</literal> </entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry>bitwise OR</entry>
<entry><literal>32 | 3</literal></entry>
<entry><literal>35</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>#</literal> </entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry>bitwise XOR</entry>
<entry><literal>17 # 5</literal></entry>
<entry><literal>20</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>~</literal> </entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry>bitwise NOT</entry>
<entry><literal>~1</literal></entry>
<entry><literal>-2</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry> <literal>&lt;&lt;</literal> </entry>
Fix a batch of speling misteaks identified by Peter's spell-checker tool.
2003-09-20 22:12:05 +02:00
<entry>bitwise shift left</entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>1 &lt;&lt; 4</literal></entry>
<entry><literal>16</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry> <literal>&gt;&gt;</literal> </entry>
<entry>bitwise shift right</entry>
<entry><literal>8 &gt;&gt; 2</literal></entry>
<entry><literal>2</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</tbody>
</tgroup>
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Represent type-specific length coercion functions as pg_cast entries, eliminating the former hard-wired convention about their names. Allow pg_cast entries to represent both type coercion and length coercion in a single step --- this is represented by a function that takes an extra typmod argument, just like a length coercion function. This nicely merges the type and length coercion mechanisms into something at least a little cleaner than we had before. Make use of the single- coercion-step behavior to fix integer-to-bit coercion so that coercing to bit(n) yields the rightmost n bits of the integer instead of the leftmost n bits. This should fix recurrent complaints about the odd behavior of this coercion. Clean up the documentation of the bit string functions, and try to put it where people might actually find it. Also, get rid of the unreliable heuristics in ruleutils.c about whether to display nested coercion steps; instead require parse_coerce.c to label them properly in the first place.
2004-06-16 03:27:00 +02:00
The bitwise operators work only on integral data types, whereas
the others are available for all numeric data types. The bitwise
operators are also available for the bit
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
string types <type>bit</type> and <type>bit varying</type>, as
Represent type-specific length coercion functions as pg_cast entries, eliminating the former hard-wired convention about their names. Allow pg_cast entries to represent both type coercion and length coercion in a single step --- this is represented by a function that takes an extra typmod argument, just like a length coercion function. This nicely merges the type and length coercion mechanisms into something at least a little cleaner than we had before. Make use of the single- coercion-step behavior to fix integer-to-bit coercion so that coercing to bit(n) yields the rightmost n bits of the integer instead of the leftmost n bits. This should fix recurrent complaints about the odd behavior of this coercion. Clean up the documentation of the bit string functions, and try to put it where people might actually find it. Also, get rid of the unreliable heuristics in ruleutils.c about whether to display nested coercion steps; instead require parse_coerce.c to label them properly in the first place.
2004-06-16 03:27:00 +02:00
shown in <xref linkend="functions-bit-string-op-table">.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="functions-math-func-table"> shows the available
mathematical functions. In the table, <literal>dp</literal>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
indicates <type>double precision</type>. Many of these functions
are provided in multiple forms with different argument types.
Except where noted, any given form of a function returns the same
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
data type as its argument.
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
The functions working with <type>double precision</type> data are mostly
implemented on top of the host system's C library; accuracy and behavior in
boundary cases may therefore vary depending on the host system.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>abs</primary>
</indexterm>
<indexterm>
<primary>cbrt</primary>
</indexterm>
<indexterm>
<primary>ceiling</primary>
</indexterm>
<indexterm>
<primary>degrees</primary>
</indexterm>
<indexterm>
<primary>exp</primary>
</indexterm>
<indexterm>
<primary>floor</primary>
</indexterm>
<indexterm>
<primary>ln</primary>
</indexterm>
<indexterm>
<primary>log</primary>
</indexterm>
<indexterm>
<primary>mod</primary>
</indexterm>
<indexterm>
<primary>&pi;</primary>
</indexterm>
<indexterm>
<primary>power</primary>
</indexterm>
<indexterm>
<primary>radians</primary>
</indexterm>
<indexterm>
<primary>random</primary>
</indexterm>
<indexterm>
<primary>round</primary>
</indexterm>
<indexterm>
<primary>setseed</primary>
</indexterm>
<indexterm>
<primary>sign</primary>
</indexterm>
<indexterm>
<primary>sqrt</primary>
</indexterm>
<indexterm>
<primary>trunc</primary>
</indexterm>
<indexterm>
<primary>width_bucket</primary>
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<table id="functions-math-func-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title>Mathematical Functions</title>
<tgroup cols="5">
<thead>
<row>
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
<tbody>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>abs</>(<replaceable>x</replaceable>)</literal></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>(same as <replaceable>x</>)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>absolute value</entry>
<entry><literal>abs(-17.4)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>17.4</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>cbrt</function>(<type>dp</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>dp</type></entry>
<entry>cube root</entry>
<entry><literal>cbrt(27.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>3</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>ceil</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>smallest integer not less than argument</entry>
<entry><literal>ceil(-42.8)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>-42</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Add ceiling() as an alias for ceil(), and power() as an alias for pow(). Regression tests and documentation have both been updated. SQL2003 requires that both ceiling() and ceil() be present, so I have documented both spellings. SQL2003 doesn't mention pow() as far as I can see, so I decided to replace pow() with power() in the documentation: there is little reason to encourage the continued usage of a function that isn't compliant with the standard, given a standard-compliant alternative. RELEASE NOTES: should state that pow() is considered deprecated (although I don't see the need to ever remove it.)
2004-04-23 22:32:20 +02:00
<row>
<entry><literal><function>ceiling</function>(<type>dp</type> or <type>numeric</type>)</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>
<entry><literal>-95</literal></entry>
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>degrees</function>(<type>dp</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>dp</type></entry>
<entry>radians to degrees</entry>
<entry><literal>degrees(0.5)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>28.6478897565412</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>exp</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>exponential</entry>
<entry><literal>exp(1.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>2.71828182845905</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>floor</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>largest integer not greater than argument</entry>
<entry><literal>floor(-42.8)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>-43</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>ln</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>natural logarithm</entry>
<entry><literal>ln(2.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>0.693147180559945</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>log</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>base 10 logarithm</entry>
<entry><literal>log(100.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>2</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>log</function>(<parameter>b</parameter> <type>numeric</type>,
<parameter>x</parameter> <type>numeric</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>numeric</type></entry>
<entry>logarithm to base <parameter>b</parameter></entry>
<entry><literal>log(2.0, 64.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>6.0000000000</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>mod</function>(<parameter>y</parameter>,
<parameter>x</parameter>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>(same as argument types)</entry>
<entry>remainder of <parameter>y</parameter>/<parameter>x</parameter></entry>
<entry><literal>mod(9,4)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>1</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>pi</function>()</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>dp</type></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><quote>&pi;</quote> constant</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>pi()</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>3.14159265358979</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Add ceiling() as an alias for ceil(), and power() as an alias for pow(). Regression tests and documentation have both been updated. SQL2003 requires that both ceiling() and ceil() be present, so I have documented both spellings. SQL2003 doesn't mention pow() as far as I can see, so I decided to replace pow() with power() in the documentation: there is little reason to encourage the continued usage of a function that isn't compliant with the standard, given a standard-compliant alternative. RELEASE NOTES: should state that pow() is considered deprecated (although I don't see the need to ever remove it.)
2004-04-23 22:32:20 +02:00
<entry><literal><function>power</function>(<parameter>a</parameter> <type>dp</type>,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<parameter>b</parameter> <type>dp</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>dp</type></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><parameter>a</> raised to the power of <parameter>b</parameter></entry>
Add ceiling() as an alias for ceil(), and power() as an alias for pow(). Regression tests and documentation have both been updated. SQL2003 requires that both ceiling() and ceil() be present, so I have documented both spellings. SQL2003 doesn't mention pow() as far as I can see, so I decided to replace pow() with power() in the documentation: there is little reason to encourage the continued usage of a function that isn't compliant with the standard, given a standard-compliant alternative. RELEASE NOTES: should state that pow() is considered deprecated (although I don't see the need to ever remove it.)
2004-04-23 22:32:20 +02:00
<entry><literal>power(9.0, 3.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>729</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<row>
Add ceiling() as an alias for ceil(), and power() as an alias for pow(). Regression tests and documentation have both been updated. SQL2003 requires that both ceiling() and ceil() be present, so I have documented both spellings. SQL2003 doesn't mention pow() as far as I can see, so I decided to replace pow() with power() in the documentation: there is little reason to encourage the continued usage of a function that isn't compliant with the standard, given a standard-compliant alternative. RELEASE NOTES: should state that pow() is considered deprecated (although I don't see the need to ever remove it.)
2004-04-23 22:32:20 +02:00
<entry><literal><function>power</function>(<parameter>a</parameter> <type>numeric</type>,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<parameter>b</parameter> <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry><type>numeric</type></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><parameter>a</> raised to the power of <parameter>b</parameter></entry>
Add ceiling() as an alias for ceil(), and power() as an alias for pow(). Regression tests and documentation have both been updated. SQL2003 requires that both ceiling() and ceil() be present, so I have documented both spellings. SQL2003 doesn't mention pow() as far as I can see, so I decided to replace pow() with power() in the documentation: there is little reason to encourage the continued usage of a function that isn't compliant with the standard, given a standard-compliant alternative. RELEASE NOTES: should state that pow() is considered deprecated (although I don't see the need to ever remove it.)
2004-04-23 22:32:20 +02:00
<entry><literal>power(9.0, 3.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>729</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>radians</function>(<type>dp</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>dp</type></entry>
<entry>degrees to radians</entry>
<entry><literal>radians(45.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>0.785398163397448</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>random</function>()</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>dp</type></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>random value between 0.0 and 1.0</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>random()</literal></entry>
<entry></entry>
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>round</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>round to nearest integer</entry>
<entry><literal>round(42.4)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>42</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal><function>round</function>(<parameter>v</parameter> <type>numeric</type>, <parameter>s</parameter> <type>int</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>numeric</type></entry>
<entry>round to <parameter>s</parameter> decimal places</entry>
<entry><literal>round(42.4382, 2)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>42.44</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
The "random" regression test uses a function called oidrand(), which takes two parameters, an OID x and an integer y, and returns "true" with probability 1/y (the OID argument is ignored). This can be useful -- for example, it can be used to select a random sampling of the rows in a table (which is what the "random" regression test uses it for). This patch removes that function, because it was old and messy. The old function had the following problems: - it was undocumented - it was poorly named - it was designed to workaround an optimizer bug that no longer exists (the OID argument is to ensure that the optimizer won't optimize away calls to the function; AFAIK marking the function as 'volatile' suffices nowadays) - it used a different random-number generation technique than the other PSRNG-related functions in the backend do (it called random() like they do, but it had its own logic for setting a set and deciding when to reseed the RNG). Ok, this patch removes oidrand(), oidsrand(), and userfntest(), and improves the SGML docs a little bit (un-commenting the setseed() documentation). Neil Conway
2003-02-13 06:24:04 +01:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>setseed</function>(<type>dp</type>)</literal></entry>
Update docs for recent change to setseed() return value.
2007-01-20 22:59:34 +01:00
<entry><type>void</type></entry>
Update setseed() documentation.
2006-09-04 23:47:25 +02:00
<entry>set seed for subsequent <literal>random()</literal> calls (value between 0 and 1.0)</entry>
The "random" regression test uses a function called oidrand(), which takes two parameters, an OID x and an integer y, and returns "true" with probability 1/y (the OID argument is ignored). This can be useful -- for example, it can be used to select a random sampling of the rows in a table (which is what the "random" regression test uses it for). This patch removes that function, because it was old and messy. The old function had the following problems: - it was undocumented - it was poorly named - it was designed to workaround an optimizer bug that no longer exists (the OID argument is to ensure that the optimizer won't optimize away calls to the function; AFAIK marking the function as 'volatile' suffices nowadays) - it used a different random-number generation technique than the other PSRNG-related functions in the backend do (it called random() like they do, but it had its own logic for setting a set and deciding when to reseed the RNG). Ok, this patch removes oidrand(), oidsrand(), and userfntest(), and improves the SGML docs a little bit (un-commenting the setseed() documentation). Neil Conway
2003-02-13 06:24:04 +01:00
<entry><literal>setseed(0.54823)</literal></entry>
Update docs for recent change to setseed() return value.
2007-01-20 22:59:34 +01:00
<entry></entry>
The "random" regression test uses a function called oidrand(), which takes two parameters, an OID x and an integer y, and returns "true" with probability 1/y (the OID argument is ignored). This can be useful -- for example, it can be used to select a random sampling of the rows in a table (which is what the "random" regression test uses it for). This patch removes that function, because it was old and messy. The old function had the following problems: - it was undocumented - it was poorly named - it was designed to workaround an optimizer bug that no longer exists (the OID argument is to ensure that the optimizer won't optimize away calls to the function; AFAIK marking the function as 'volatile' suffices nowadays) - it used a different random-number generation technique than the other PSRNG-related functions in the backend do (it called random() like they do, but it had its own logic for setting a set and deciding when to reseed the RNG). Ok, this patch removes oidrand(), oidsrand(), and userfntest(), and improves the SGML docs a little bit (un-commenting the setseed() documentation). Neil Conway
2003-02-13 06:24:04 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>sign</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>sign of the argument (-1, 0, +1)</entry>
<entry><literal>sign(-8.4)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>-1</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Document the sign() function.
2001-09-20 18:41:26 +02:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>sqrt</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>square root</entry>
<entry><literal>sqrt(2.0)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>1.4142135623731</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>trunc</function>(<type>dp</type> or <type>numeric</type>)</literal></entry>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry>(same as input)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>truncate toward zero</entry>
<entry><literal>trunc(42.8)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>42</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal><function>trunc</function>(<parameter>v</parameter> <type>numeric</type>, <parameter>s</parameter> <type>int</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>numeric</type></entry>
<entry>truncate to <parameter>s</parameter> decimal places</entry>
<entry><literal>trunc(42.4382, 2)</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>42.43</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement the width_bucket() function, per SQL2003. This commit only adds a variant of the function for the 'numeric' datatype; it would be possible to add additional variants for other datatypes, but I haven't done so yet. This commit includes regression tests and minimal documentation; if we want developers to actually use this function in applications, we'll probably need to document what it does more fully.
2004-05-14 23:42:30 +02:00
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<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><type>int</type></entry>
Implement the width_bucket() function, per SQL2003. This commit only adds a variant of the function for the 'numeric' datatype; it would be possible to add additional variants for other datatypes, but I haven't done so yet. This commit includes regression tests and minimal documentation; if we want developers to actually use this function in applications, we'll probably need to document what it does more fully.
2004-05-14 23:42:30 +02:00
<entry>return the bucket to which <parameter>operand</> would
be assigned in an equidepth histogram with <parameter>count</>
Generalize width_bucket() documentation because b1/b2 can be interchanged.
2006-08-22 02:49:19 +02:00
buckets, in the range <parameter>b1</> to <parameter>b2</></entry>
Implement the width_bucket() function, per SQL2003. This commit only adds a variant of the function for the 'numeric' datatype; it would be possible to add additional variants for other datatypes, but I haven't done so yet. This commit includes regression tests and minimal documentation; if we want developers to actually use this function in applications, we'll probably need to document what it does more fully.
2004-05-14 23:42:30 +02:00
<entry><literal>width_bucket(5.35, 0.024, 10.06, 5)</literal></entry>
<entry><literal>3</literal></entry>
</row>
Implement width_bucket() for the float8 data type. The implementation is somewhat ugly logic-wise, but I don't see an easy way to make it more concise. When writing this, I noticed that my previous implementation of width_bucket() doesn't handle NaN correctly: postgres=# select width_bucket('NaN', 1, 5, 5); width_bucket -------------- 6 (1 row) AFAICS SQL:2003 does not define a NaN value, so it doesn't address how width_bucket() should behave here. The patch changes width_bucket() so that ereport(ERROR) is raised if NaN is specified for the operand or the lower or upper bounds to width_bucket(). For float8, NaN is disallowed for any of the floating-point inputs, and +/- infinity is disallowed for the histogram bounds (but allowed for the operand). Update docs and regression tests, bump the catversion.
2007-01-16 22:41:14 +01:00
<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><type>int</type></entry>
<entry>return the bucket to which <parameter>operand</> would
be assigned in an equidepth histogram with <parameter>count</>
buckets, in the range <parameter>b1</> to <parameter>b2</></entry>
<entry><literal>width_bucket(5.35, 0.024, 10.06, 5)</literal></entry>
<entry><literal>3</literal></entry>
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</tbody>
</tgroup>
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Finally, <xref linkend="functions-math-trig-table"> shows the
available trigonometric functions. All trigonometric functions
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
take arguments and return values of type <type>double
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
precision</type>.
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>acos</primary>
</indexterm>
<indexterm>
<primary>asin</primary>
</indexterm>
<indexterm>
<primary>atan</primary>
</indexterm>
<indexterm>
<primary>atan2</primary>
</indexterm>
<indexterm>
<primary>cos</primary>
</indexterm>
<indexterm>
<primary>cot</primary>
</indexterm>
<indexterm>
<primary>sin</primary>
</indexterm>
<indexterm>
<primary>tan</primary>
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<table id="functions-math-trig-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title>Trigonometric Functions</title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tgroup cols="2">
<thead>
<row>
<entry>Function</entry>
<entry>Description</entry>
</row>
</thead>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tbody>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>acos</function>(<replaceable>x</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>inverse cosine</entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>asin</function>(<replaceable>x</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>inverse sine</entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>atan</function>(<replaceable>x</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>inverse tangent</entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>atan2</function>(<replaceable>x</replaceable>,
<replaceable>y</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>inverse tangent of
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal><replaceable>x</replaceable>/<replaceable>y</replaceable></literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>cos</function>(<replaceable>x</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>cosine</entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>cot</function>(<replaceable>x</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>cotangent</entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>sin</function>(<replaceable>x</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>sine</entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>tan</function>(<replaceable>x</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>tangent</entry>
</row>
</tbody>
</tgroup>
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<sect1 id="functions-string">
<title>String Functions and Operators</title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
This section describes functions and operators for examining and
manipulating string values. Strings in this context include values
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
of all the types <type>character</type>, <type>character
varying</type>, and <type>text</type>. Unless otherwise noted, all
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
of the functions listed below work on all of these types, but be
wary of potential effects of the automatic padding when using the
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<type>character</type> type. Generally, the functions described
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
here also work on data of non-string types by converting that data
to a string representation first. Some functions also exist
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
natively for the bit-string types.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
<acronym>SQL</acronym> defines some string functions with a special syntax where
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
certain key words rather than commas are used to separate the
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
arguments. Details are in <xref linkend="functions-string-sql">.
These functions are also implemented using the regular syntax for
function invocation. (See <xref linkend="functions-string-other">.)
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>bit_length</primary>
</indexterm>
<indexterm>
<primary>char_length</primary>
</indexterm>
<indexterm>
<primary>convert</primary>
</indexterm>
<indexterm>
<primary>lower</primary>
</indexterm>
<indexterm>
<primary>octet_length</primary>
</indexterm>
<indexterm>
<primary>overlay</primary>
</indexterm>
<indexterm>
<primary>position</primary>
</indexterm>
<indexterm>
<primary>substring</primary>
</indexterm>
<indexterm>
<primary>trim</primary>
</indexterm>
<indexterm>
<primary>upper</primary>
</indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<table id="functions-string-sql">
<title><acronym>SQL</acronym> String Functions and Operators</title>
<tgroup cols="5">
<thead>
<row>
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tbody>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><parameter>string</parameter> <literal>||</literal>
<parameter>string</parameter></literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <type>text</type> </entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
String concatenation
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>character string</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<secondary>concatenation</secondary>
</indexterm>
</entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry><literal>'Post' || 'greSQL'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>PostgreSQL</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>bit_length</function>(<parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>Number of bits in string</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>bit_length('jose')</literal></entry>
<entry><literal>32</literal></entry>
</row>
SQL function bit_length
2001-05-24 11:29:29 +02:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>char_length</function>(<parameter>string</parameter>)</literal> or <literal><function>character_length</function>(<parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Number of characters in string
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>character string</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<secondary>length</secondary>
</indexterm>
<indexterm>
<primary>length</primary>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<secondary sortas="character string">of a character string</secondary>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<see>character string, length</see>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</indexterm>
</entry>
<entry><literal>char_length('jose')</literal></entry>
<entry><literal>4</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>convert</function>(<parameter>string</parameter>
using <parameter>conversion_name</parameter>)</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<entry><type>text</type></entry>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry>
Change encoding using specified conversion name. Conversions
can be defined by <command>CREATE CONVERSION</command>. Also
there are some pre-defined conversion names. See <xref
linkend="conversion-names"> for available conversion
names.
</entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>convert('PostgreSQL' using iso_8859_1_to_utf8)</literal></entry>
<entry><literal>'PostgreSQL'</literal> in UTF8 (Unicode, 8-bit) encoding</entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>lower</function>(<parameter>string</parameter>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>text</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>Convert string to lower case</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>lower('TOM')</literal></entry>
<entry><literal>tom</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>octet_length</function>(<parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>Number of bytes in string</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>octet_length('jose')</literal></entry>
<entry><literal>4</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal><function>overlay</function>(<parameter>string</parameter> placing <parameter>string</parameter> from <type>int</type> <optional>for <type>int</type></optional>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>text</type></entry>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Replace substring
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</entry>
<entry><literal>overlay('Txxxxas' placing 'hom' from 2 for 4)</literal></entry>
<entry><literal>Thomas</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>position</function>(<parameter>substring</parameter> in <parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>Location of specified substring</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>position('om' in 'Thomas')</literal></entry>
<entry><literal>3</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal><function>substring</function>(<parameter>string</parameter> <optional>from <type>int</type></optional> <optional>for <type>int</type></optional>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Extract substring
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</entry>
<entry><literal>substring('Thomas' from 2 for 3)</literal></entry>
<entry><literal>hom</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>substring</function>(<parameter>string</parameter> from <replaceable>pattern</replaceable>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>text</type></entry>
<entry>
Add regexp_replace() to string functions section. Joachim Wieland
2006-05-30 13:54:51 +02:00
Extract substring matching POSIX regular expression. See
<xref linkend="functions-matching"> for more information on pattern
matching.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>substring('Thomas' from '...$')</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>mas</literal></entry>
</row>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>substring</function>(<parameter>string</parameter> from <replaceable>pattern</replaceable> for <replaceable>escape</replaceable>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>
Add regexp_replace() to string functions section. Joachim Wieland
2006-05-30 13:54:51 +02:00
Extract substring matching <acronym>SQL</acronym> regular expression.
See <xref linkend="functions-matching"> for more information on
pattern matching.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><literal>substring('Thomas' from '%#"o_a#"_' for '#')</literal></entry>
<entry><literal>oma</literal></entry>
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal><function>trim</function>(<optional>leading | trailing | both</optional>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<optional><parameter>characters</parameter></optional> from
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<parameter>string</parameter>)</literal>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</entry>
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Remove the longest string containing only the
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<parameter>characters</parameter> (a space by default) from the
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
start/end/both ends of the <parameter>string</parameter>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</entry>
<entry><literal>trim(both 'x' from 'xTomxx')</literal></entry>
<entry><literal>Tom</literal></entry>
</row>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>upper</function>(<parameter>string</parameter>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>text</type></entry>
Fix a few omissions in the initcap() documentation & source code comments, make some unrelated improvements to the functions documentation, and perform some minor consistency cleanup elsewhere. Original initcap() change from Dennis B., additional changes by Neil C.
2004-02-27 04:59:23 +01:00
<entry>Convert string to uppercase</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>upper('tom')</literal></entry>
<entry><literal>TOM</literal></entry>
</row>
</tbody>
</tgroup>
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<para>
Additional string manipulation functions are available and are
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
listed in <xref linkend="functions-string-other">. Some of them are used internally to implement the
<acronym>SQL</acronym>-standard string functions listed in <xref linkend="functions-string-sql">.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</para>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>ascii</primary>
</indexterm>
<indexterm>
<primary>btrim</primary>
</indexterm>
<indexterm>
<primary>chr</primary>
</indexterm>
<indexterm>
<primary>decode</primary>
</indexterm>
<indexterm>
<primary>encode</primary>
</indexterm>
<indexterm>
<primary>initcap</primary>
</indexterm>
<indexterm>
<primary>lpad</primary>
</indexterm>
<indexterm>
<primary>ltrim</primary>
</indexterm>
<indexterm>
<primary>md5</primary>
</indexterm>
<indexterm>
<primary>pg_client_encoding</primary>
</indexterm>
<indexterm>
<primary>quote_ident</primary>
</indexterm>
<indexterm>
<primary>quote_literal</primary>
</indexterm>
<indexterm>
<primary>repeat</primary>
</indexterm>
<indexterm>
<primary>replace</primary>
</indexterm>
<indexterm>
<primary>rpad</primary>
</indexterm>
<indexterm>
<primary>rtrim</primary>
</indexterm>
<indexterm>
<primary>split_part</primary>
</indexterm>
<indexterm>
<primary>strpos</primary>
</indexterm>
<indexterm>
<primary>substr</primary>
</indexterm>
<indexterm>
<primary>to_ascii</primary>
</indexterm>
<indexterm>
<primary>to_hex</primary>
</indexterm>
<indexterm>
<primary>translate</primary>
</indexterm>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<table id="functions-string-other">
<title>Other String Functions</title>
<tgroup cols="5">
<thead>
<row>
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
<tbody>
<row>
Change <type>string</> to <parameter>string</>.
2006-05-18 05:18:24 +02:00
<entry><literal><function>ascii</function>(<parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
in the docs, the function "ascii(text)" is described as returning "ASCII code of the first character of the argument" (see http://www.postgresql.org/docs/8.1/interactive/functions-string.html, Table 9-6. "Other String Functions"). Presumably this should read "ASCII code of the first byte of the argument", which is what is returned when the argument is a multi-byte character (although then with UTF-8 at least that might not necessarily be an ASCII code). Ian Barwick
2006-03-06 05:53:50 +01:00
<entry><acronym>ASCII</acronym> code of the first byte of the argument</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>ascii('x')</literal></entry>
<entry><literal>120</literal></entry>
</row>
<row>
Document that btrim()'s second parameter is optional, and defaults to spaces.
2004-12-02 18:14:54 +01:00
<entry><literal><function>btrim</function>(<parameter>string</parameter> <type>text</type>
<optional>, <parameter>characters</parameter> <type>text</type></optional>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Remove the longest string consisting only of characters
Wording improvement.
2004-12-02 18:39:54 +01:00
in <parameter>characters</parameter> (a space by default)
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
from the start and end of <parameter>string</parameter>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>btrim('xyxtrimyyx', 'xy')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>trim</literal></entry>
</row>
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal><function>chr</function>(<type>int</type>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>Character with the given <acronym>ASCII</acronym> code</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>chr(65)</literal></entry>
<entry><literal>A</literal></entry>
</row>
<row>
<entry>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
<literal><function>convert</function>(<parameter>string</parameter> <type>text</type>,
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<optional><parameter>src_encoding</parameter> <type>name</type>,</optional>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<parameter>dest_encoding</parameter> <type>name</type>)</literal>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Convert string to <parameter>dest_encoding</parameter>.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
The original encoding is specified by
<parameter>src_encoding</parameter>. If
<parameter>src_encoding</parameter> is omitted, database
encoding is assumed.
</entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>convert( 'text_in_utf8', 'UTF8', 'LATIN1')</literal></entry>
<entry><literal>text_in_utf8</literal> represented in ISO 8859-1 encoding</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</row>
<row>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal><function>decode</function>(<parameter>string</parameter> <type>text</type>,
<parameter>type</parameter> <type>text</type>)</literal>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><type>bytea</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Decode binary data from <parameter>string</parameter> previously
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
encoded with <function>encode</>. Parameter type is same as in <function>encode</>.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><literal>decode('MTIzAAE=', 'base64')</literal></entry>
<entry><literal>123\000\001</literal></entry>
</row>
<row>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal><function>encode</function>(<parameter>data</parameter> <type>bytea</type>,
<parameter>type</parameter> <type>text</type>)</literal>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Encode binary data to <acronym>ASCII</acronym>-only representation. Supported
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
types are: <literal>base64</>, <literal>hex</>, <literal>escape</>.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>encode( '123\\000\\001', 'base64')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>MTIzAAE=</literal></entry>
</row>
<row>
Change <type>string</> to <parameter>string</>.
2006-05-18 05:18:24 +02:00
<entry><literal><function>initcap</function>(<parameter>string</parameter>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
Fix a few omissions in the initcap() documentation & source code comments, make some unrelated improvements to the functions documentation, and perform some minor consistency cleanup elsewhere. Original initcap() change from Dennis B., additional changes by Neil C.
2004-02-27 04:59:23 +01:00
<entry>
Convert the first letter of each word to uppercase and the
rest to lowercase. Words are sequences of alphanumeric
characters separated by non-alphanumeric characters.
</entry>
<entry><literal>initcap('hi THOMAS')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>Hi Thomas</literal></entry>
</row>
<row>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
<entry><literal><function>length</function>(<parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry>
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
Number of characters in <parameter>string</parameter>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><literal>length('jose')</literal></entry>
<entry><literal>4</literal></entry>
</row>
<row>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal><function>lpad</function>(<parameter>string</parameter> <type>text</type>,
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<parameter>length</parameter> <type>int</type>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<optional>, <parameter>fill</parameter> <type>text</type></optional>)</literal>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Fix a few omissions in the initcap() documentation & source code comments, make some unrelated improvements to the functions documentation, and perform some minor consistency cleanup elsewhere. Original initcap() change from Dennis B., additional changes by Neil C.
2004-02-27 04:59:23 +01:00
<entry><type>text</type></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Fill up the <parameter>string</parameter> to length
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<parameter>length</parameter> by prepending the characters
<parameter>fill</parameter> (a space by default). If the
<parameter>string</parameter> is already longer than
<parameter>length</parameter> then it is truncated (on the
right).
</entry>
<entry><literal>lpad('hi', 5, 'xy')</literal></entry>
<entry><literal>xyxhi</literal></entry>
</row>
<row>
The trim function doc did not say that the second argument could be be omitted. This patch fixes that. It also fixes a bug where the type text was not wrapped as <type>text</type>.
2004-03-04 21:09:29 +01:00
<entry><literal><function>ltrim</function>(<parameter>string</parameter> <type>text</type>
<optional>, <parameter>characters</parameter> <type>text</type></optional>)</literal>
</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Remove the longest string containing only characters from
The trim function doc did not say that the second argument could be be omitted. This patch fixes that. It also fixes a bug where the type text was not wrapped as <type>text</type>.
2004-03-04 21:09:29 +01:00
<parameter>characters</parameter> (a space by default) from the start of
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
<parameter>string</parameter>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>ltrim('zzzytrim', 'xyz')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>trim</literal></entry>
</row>
Attached are two small patches to expose md5 as a user function -- including documentation and regression test mods. It seemed small and unobtrusive enough to not require a specific proposal on the hackers list -- but if not, let me know and I'll make a pitch. Otherwise, if there are no objections please apply. Joe Conway
2002-12-06 06:20:28 +01:00
<row>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
<entry><literal><function>md5</function>(<parameter>string</parameter>)</literal></entry>
Attached are two small patches to expose md5 as a user function -- including documentation and regression test mods. It seemed small and unobtrusive enough to not require a specific proposal on the hackers list -- but if not, let me know and I'll make a pitch. Otherwise, if there are no objections please apply. Joe Conway
2002-12-06 06:20:28 +01:00
<entry><type>text</type></entry>
<entry>
Fix a few omissions in the initcap() documentation & source code comments, make some unrelated improvements to the functions documentation, and perform some minor consistency cleanup elsewhere. Original initcap() change from Dennis B., additional changes by Neil C.
2004-02-27 04:59:23 +01:00
Calculates the MD5 hash of <parameter>string</parameter>,
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
returning the result in hexadecimal
Attached are two small patches to expose md5 as a user function -- including documentation and regression test mods. It seemed small and unobtrusive enough to not require a specific proposal on the hackers list -- but if not, let me know and I'll make a pitch. Otherwise, if there are no objections please apply. Joe Conway
2002-12-06 06:20:28 +01:00
</entry>
<entry><literal>md5('abc')</literal></entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>900150983cd24fb0 d6963f7d28e17f72</literal></entry>
Attached are two small patches to expose md5 as a user function -- including documentation and regression test mods. It seemed small and unobtrusive enough to not require a specific proposal on the hackers list -- but if not, let me know and I'll make a pitch. Otherwise, if there are no objections please apply. Joe Conway
2002-12-06 06:20:28 +01:00
</row>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>pg_client_encoding</function>()</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>name</type></entry>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Current client encoding name
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><literal>pg_client_encoding()</literal></entry>
<entry><literal>SQL_ASCII</literal></entry>
</row>
<row>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
<entry><literal><function>quote_ident</function>(<parameter>string</parameter>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Return the given string suitably quoted to be used as an identifier
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
in an <acronym>SQL</acronym> statement string.
Quotes are added only if necessary (i.e., if the string contains
non-identifier characters or would be case-folded).
Embedded quotes are properly doubled.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Replace incorrect example for quote_ident Greg Sabino Mullan
2004-08-18 05:06:56 +02:00
<entry><literal>quote_ident('Foo bar')</literal></entry>
<entry><literal>"Foo bar"</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</row>
<row>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
<entry><literal><function>quote_literal</function>(<parameter>string</parameter>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Return the given string suitably quoted to be used as a string literal
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
in an <acronym>SQL</acronym> statement string.
Embedded quotes and backslashes are properly doubled.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>quote_literal( 'O\'Reilly')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>'O''Reilly'</literal></entry>
</row>
<row>
Add regexp_replace() to string functions section. Joachim Wieland
2006-05-30 13:54:51 +02:00
<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><type>text</type></entry>
<entry>
Replace substring matching POSIX regular expression. See
<xref linkend="functions-matching"> for more information on pattern
matching.
</entry>
<entry><literal>regexp_replace('Thomas', '.[mN]a.', 'M')</literal></entry>
<entry><literal>ThM</literal></entry>
</row>
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal><function>repeat</function>(<parameter>string</parameter> <type>text</type>, <parameter>number</parameter> <type>int</type>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
Fix a few omissions in the initcap() documentation & source code comments, make some unrelated improvements to the functions documentation, and perform some minor consistency cleanup elsewhere. Original initcap() change from Dennis B., additional changes by Neil C.
2004-02-27 04:59:23 +01:00
<entry>Repeat <parameter>string</parameter> the specified
<parameter>number</parameter> of times</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>repeat('Pg', 4)</literal></entry>
<entry><literal>PgPgPgPg</literal></entry>
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>replace</function>(<parameter>string</parameter> <type>text</type>,
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<parameter>from</parameter> <type>text</type>,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<parameter>to</parameter> <type>text</type>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>Replace all occurrences in <parameter>string</parameter> of substring
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
<parameter>from</parameter> with substring <parameter>to</parameter>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>replace( 'abcdefabcdef', 'cd', 'XX')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>abXXefabXXef</literal></entry>
</row>
<row>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal><function>rpad</function>(<parameter>string</parameter> <type>text</type>,
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<parameter>length</parameter> <type>int</type>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<optional>, <parameter>fill</parameter> <type>text</type></optional>)</literal>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Fill up the <parameter>string</parameter> to length
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<parameter>length</parameter> by appending the characters
<parameter>fill</parameter> (a space by default). If the
<parameter>string</parameter> is already longer than
<parameter>length</parameter> then it is truncated.
</entry>
<entry><literal>rpad('hi', 5, 'xy')</literal></entry>
<entry><literal>hixyx</literal></entry>
</row>
<row>
The trim function doc did not say that the second argument could be be omitted. This patch fixes that. It also fixes a bug where the type text was not wrapped as <type>text</type>.
2004-03-04 21:09:29 +01:00
<entry><literal><function>rtrim</function>(<parameter>string</parameter> <type>text</type>
<optional>, <parameter>characters</parameter> <type>text</type></optional>)</literal>
</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Remove the longest string containing only characters from
The trim function doc did not say that the second argument could be be omitted. This patch fixes that. It also fixes a bug where the type text was not wrapped as <type>text</type>.
2004-03-04 21:09:29 +01:00
<parameter>characters</parameter> (a space by default) from the end of
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
<parameter>string</parameter>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>rtrim('trimxxxx', 'x')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>trim</literal></entry>
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>split_part</function>(<parameter>string</parameter> <type>text</type>,
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<parameter>delimiter</parameter> <type>text</type>,
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<parameter>field</parameter> <type>int</type>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>Split <parameter>string</parameter> on <parameter>delimiter</parameter>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
and return the given field (counting from one)
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal>split_part('abc~@~def~@~ghi', '~@~', 2)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>def</literal></entry>
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>strpos</function>(<parameter>string</parameter>, <parameter>substring</parameter>)</literal></entry>
Properly document return value of strpos().
2005-11-16 04:56:16 +01:00
<entry><type>int</type></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Location of specified substring (same as
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<literal>position(<parameter>substring</parameter> in
<parameter>string</parameter>)</literal>, but note the reversed
argument order)
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>strpos('high', 'ig')</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>2</literal></entry>
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>substr</function>(<parameter>string</parameter>, <parameter>from</parameter> <optional>, <parameter>count</parameter></optional>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Extract substring (same as
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<literal>substring(<parameter>string</parameter> from <parameter>from</parameter> for <parameter>count</parameter>)</literal>)
</entry>
<entry><literal>substr('alphabet', 3, 2)</literal></entry>
<entry><literal>ph</literal></entry>
</row>
<row>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
<entry><literal><function>to_ascii</function>(<parameter>string</parameter> <type>text</type>
<optional>, <parameter>encoding</parameter> <type>text</type></optional>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
Convert <parameter>string</parameter> to <acronym>ASCII</acronym> from another encoding
Move list of supported to_ascii() encodings from footnote to main description. Nis Jorgensen
2006-06-15 19:38:26 +02:00
(only supports conversion from <literal>LATIN1</>, <literal>LATIN2</>, <literal>LATIN9</>,
Fix to_ascii() markup error.
2006-06-15 19:52:48 +02:00
and <literal>WIN1250</> encodings)
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>to_ascii('Karel')</literal></entry>
<entry><literal>Karel</literal></entry>
</row>
<row>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><literal><function>to_hex</function>(<parameter>number</parameter> <type>int</type>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
or <type>bigint</type>)</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><type>text</type></entry>
<entry>Convert <parameter>number</parameter> to its equivalent hexadecimal
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
representation
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>to_hex(2147483647)</literal></entry>
<entry><literal>7fffffff</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</row>
<row>
<entry>
Make function param_name/type documentation more consistent.
2006-05-18 02:50:08 +02:00
<literal><function>translate</function>(<parameter>string</parameter> <type>text</type>,
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<parameter>from</parameter> <type>text</type>,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<parameter>to</parameter> <type>text</type>)</literal>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><type>text</type></entry>
<entry>
Any character in <parameter>string</parameter> that matches a
character in the <parameter>from</parameter> set is replaced by
the corresponding character in the <parameter>to</parameter>
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
set
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</entry>
<entry><literal>translate('12345', '14', 'ax')</literal></entry>
<entry><literal>a23x5</literal></entry>
</row>
</tbody>
</tgroup>
</table>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<table id="conversion-names">
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<title>Built-in Conversions</title>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<tgroup cols="3">
<thead>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry>Conversion Name
<footnote>
<para>
The conversion names follow a standard naming scheme: The
official name of the source encoding with all
non-alphanumeric characters replaced by underscores followed
by <literal>_to_</literal> followed by the equally processed
destination encoding name. Therefore the names might deviate
from the customary encoding names.
</para>
</footnote>
</entry>
<entry>Source Encoding</entry>
<entry>Destination Encoding</entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
</thead>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<tbody>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ascii_to_mic</literal></entry>
<entry><literal>SQL_ASCII</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>ascii_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>SQL_ASCII</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>big5_to_euc_tw</literal></entry>
<entry><literal>BIG5</literal></entry>
<entry><literal>EUC_TW</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>big5_to_mic</literal></entry>
<entry><literal>BIG5</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>big5_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>BIG5</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>euc_cn_to_mic</literal></entry>
<entry><literal>EUC_CN</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>euc_cn_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_CN</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>euc_jp_to_mic</literal></entry>
<entry><literal>EUC_JP</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>euc_jp_to_sjis</literal></entry>
<entry><literal>EUC_JP</literal></entry>
<entry><literal>SJIS</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>euc_jp_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_JP</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>euc_kr_to_mic</literal></entry>
<entry><literal>EUC_KR</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>euc_kr_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_KR</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>euc_tw_to_big5</literal></entry>
<entry><literal>EUC_TW</literal></entry>
<entry><literal>BIG5</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>euc_tw_to_mic</literal></entry>
<entry><literal>EUC_TW</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>euc_tw_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_TW</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>gb18030_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>GB18030</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>gbk_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>GBK</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_10_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN6</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_13_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN7</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_14_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN8</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_15_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN9</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_16_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN10</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>iso_8859_1_to_mic</literal></entry>
<entry><literal>LATIN1</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_1_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN1</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>iso_8859_2_to_mic</literal></entry>
<entry><literal>LATIN2</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_2_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN2</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>iso_8859_2_to_windows_1250</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN2</literal></entry>
<entry><literal>WIN1250</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>iso_8859_3_to_mic</literal></entry>
<entry><literal>LATIN3</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_3_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN3</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>iso_8859_4_to_mic</literal></entry>
<entry><literal>LATIN4</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_4_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN4</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>iso_8859_5_to_koi8_r</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_5</literal></entry>
<entry><literal>KOI8</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>iso_8859_5_to_mic</literal></entry>
<entry><literal>ISO_8859_5</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_5_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_5</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>iso_8859_5_to_windows_1251</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_5</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN1251</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>iso_8859_5_to_windows_866</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_5</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN866</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_6_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_6</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_7_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_7</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_8_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_8</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>iso_8859_9_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN5</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>johab_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>JOHAB</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>koi8_r_to_iso_8859_5</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>KOI8</literal></entry>
<entry><literal>ISO_8859_5</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>koi8_r_to_mic</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>KOI8</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>koi8_r_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>KOI8</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>koi8_r_to_windows_1251</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>KOI8</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN1251</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>koi8_r_to_windows_866</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>KOI8</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN866</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_ascii</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>SQL_ASCII</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_big5</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>BIG5</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_euc_cn</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>EUC_CN</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_euc_jp</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>EUC_JP</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_euc_kr</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>EUC_KR</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_euc_tw</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>EUC_TW</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_iso_8859_1</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>LATIN1</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_iso_8859_2</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>LATIN2</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_iso_8859_3</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>LATIN3</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_iso_8859_4</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>LATIN4</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_iso_8859_5</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>ISO_8859_5</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>mic_to_koi8_r</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>KOI8</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>mic_to_sjis</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>SJIS</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>mic_to_windows_1250</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>MULE_INTERNAL</literal></entry>
<entry><literal>WIN1250</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>mic_to_windows_1251</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>MULE_INTERNAL</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN1251</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>mic_to_windows_866</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>MULE_INTERNAL</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN866</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>sjis_to_euc_jp</literal></entry>
<entry><literal>SJIS</literal></entry>
<entry><literal>EUC_JP</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>sjis_to_mic</literal></entry>
<entry><literal>SJIS</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>sjis_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>SJIS</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>tcvn_to_utf8</literal></entry>
<entry><literal>WIN1258</literal></entry>
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>uhc_to_utf8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>UHC</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_ascii</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>SQL_ASCII</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_big5</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>BIG5</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_euc_cn</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_CN</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_euc_jp</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_JP</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_euc_kr</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_KR</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_euc_tw</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>EUC_TW</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_gb18030</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>GB18030</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_gbk</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>GBK</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_1</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN1</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_10</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN6</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_13</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN7</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_14</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_15</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN9</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_16</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN10</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_2</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN2</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_3</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN3</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_4</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN4</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_5</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_5</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_6</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_6</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_7</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_7</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_8</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>ISO_8859_8</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_iso_8859_9</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>LATIN5</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_johab</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>JOHAB</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_koi8_r</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>KOI8</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_sjis</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>SJIS</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_tcvn</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1258</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_uhc</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>UHC</literal></entry>
Add SQL99 CONVERT() function.
2002-08-06 07:40:47 +02:00
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_windows_1250</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>WIN1250</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_windows_1251</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1251</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
Add support for Win1252 encoding. Roland Volkmann
2005-03-14 19:31:25 +01:00
<row>
<entry><literal>utf8_to_windows_1252</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1252</literal></entry>
</row>
Add support for Windows codepages 1253, 1254, 1255, and 1257 and clean up a bunch of the support utilities. In src/backend/utils/mb/Unicode remove nearly duplicate copies of the UCS_to_XXX perl script and replace with one version to handle all generic files. Update the Makefile so that it knows about all the map files. This produces a slight difference in some of the map files, using a uniform naming convention and not mapping the null character. In src/backend/utils/mb/conversion_procs create a master utf8<->win codepage function like the ISO 8859 versions instead of having a separate handler for each conversion. There is an externally visible change in the name of the win1258 to utf8 conversion. According to the documentation notes, it was named incorrectly and this changes it to a standard name. Running the Unicode mapping perl scripts has shown some additional mapping changes in koi8r and iso8859-7.
2006-02-18 17:15:23 +01:00
<row>
<entry><literal>utf8_to_windows_1253</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1253</literal></entry>
</row>
<row>
<entry><literal>utf8_to_windows_1254</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1254</literal></entry>
</row>
<row>
<entry><literal>utf8_to_windows_1255</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1255</literal></entry>
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_windows_1256</literal></entry>
<entry><literal>UTF8</literal></entry>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<entry><literal>WIN1256</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
Add support for Windows codepages 1253, 1254, 1255, and 1257 and clean up a bunch of the support utilities. In src/backend/utils/mb/Unicode remove nearly duplicate copies of the UCS_to_XXX perl script and replace with one version to handle all generic files. Update the Makefile so that it knows about all the map files. This produces a slight difference in some of the map files, using a uniform naming convention and not mapping the null character. In src/backend/utils/mb/conversion_procs create a master utf8<->win codepage function like the ISO 8859 versions instead of having a separate handler for each conversion. There is an externally visible change in the name of the win1258 to utf8 conversion. According to the documentation notes, it was named incorrectly and this changes it to a standard name. Running the Unicode mapping perl scripts has shown some additional mapping changes in koi8r and iso8859-7.
2006-02-18 17:15:23 +01:00
<row>
<entry><literal>utf8_to_windows_1257</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN1257</literal></entry>
</row>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_windows_866</literal></entry>
<entry><literal>UTF8</literal></entry>
<entry><literal>WIN866</literal></entry>
Add Cyrillic and other encodings for encoding conversion. Patches submitted by Kaori Inaba (i-kaori@sra.co.jp).
2002-08-14 04:45:10 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>utf8_to_windows_874</literal></entry>
<entry><literal>UTF8</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>WIN874</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_1250_to_iso_8859_2</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>WIN1250</literal></entry>
<entry><literal>LATIN2</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Document quote_ident and quote_literal in the main list of string functions, as suggested by Josh Berkus.
2002-06-25 00:17:01 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_1250_to_mic</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>WIN1250</literal></entry>
<entry><literal>MULE_INTERNAL</literal></entry>
Document quote_ident and quote_literal in the main list of string functions, as suggested by Josh Berkus.
2002-06-25 00:17:01 +02:00
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>windows_1250_to_utf8</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>WIN1250</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Document quote_ident and quote_literal in the main list of string functions, as suggested by Josh Berkus.
2002-06-25 00:17:01 +02:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_1251_to_iso_8859_5</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN1251</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>ISO_8859_5</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Here's a doc patch for the new string functions recently committed -- replace, split, and to_hex. The patch also moves encode and decode into alphabetical order (since everything else in the table was). Joe Conway
2002-09-02 07:53:23 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_1251_to_koi8_r</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN1251</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>KOI8</literal></entry>
Here's a doc patch for the new string functions recently committed -- replace, split, and to_hex. The patch also moves encode and decode into alphabetical order (since everything else in the table was). Joe Conway
2002-09-02 07:53:23 +02:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_1251_to_mic</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN1251</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>MULE_INTERNAL</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>windows_1251_to_utf8</literal></entry>
<entry><literal>WIN1251</literal></entry>
<entry><literal>UTF8</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Here's a doc patch for the new string functions recently committed -- replace, split, and to_hex. The patch also moves encode and decode into alphabetical order (since everything else in the table was). Joe Conway
2002-09-02 07:53:23 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_1251_to_windows_866</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN1251</literal></entry>
<entry><literal>WIN866</literal></entry>
Here's a doc patch for the new string functions recently committed -- replace, split, and to_hex. The patch also moves encode and decode into alphabetical order (since everything else in the table was). Joe Conway
2002-09-02 07:53:23 +02:00
</row>
Add support for Win1252 encoding. Roland Volkmann
2005-03-14 19:31:25 +01:00
<row>
<entry><literal>windows_1252_to_utf8</literal></entry>
<entry><literal>WIN1252</literal></entry>
<entry><literal>UTF8</literal></entry>
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>windows_1256_to_utf8</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>WIN1256</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_866_to_iso_8859_5</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN866</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>ISO_8859_5</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
> > Put encode() into base system. Used part of Alex' patch > > for docs, hope he does not mind ;) Marko Kreen
2001-07-12 00:14:03 +02:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_866_to_koi8_r</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN866</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>KOI8</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Here's a doc patch for the new string functions recently committed -- replace, split, and to_hex. The patch also moves encode and decode into alphabetical order (since everything else in the table was). Joe Conway
2002-09-02 07:53:23 +02:00
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_866_to_mic</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN866</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>MULE_INTERNAL</literal></entry>
Here's a doc patch for the new string functions recently committed -- replace, split, and to_hex. The patch also moves encode and decode into alphabetical order (since everything else in the table was). Joe Conway
2002-09-02 07:53:23 +02:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>windows_866_to_utf8</literal></entry>
<entry><literal>WIN866</literal></entry>
<entry><literal>UTF8</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</row>
<row>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<entry><literal>windows_866_to_windows_1251</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>WIN866</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>WIN</literal></entry>
</row>
<row>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>windows_874_to_utf8</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<entry><literal>WIN874</literal></entry>
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
<entry><literal>UTF8</literal></entry>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</tbody>
</tgroup>
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<sect1 id="functions-binarystring">
<title>Binary String Functions and Operators</title>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<indexterm zone="functions-binarystring">
<primary>binary data</primary>
<secondary>functions</secondary>
</indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
This section describes functions and operators for examining and
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
manipulating values of type <type>bytea</type>.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
<acronym>SQL</acronym> defines some string functions with a
special syntax where
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
certain key words rather than commas are used to separate the
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
arguments. Details are in
<xref linkend="functions-binarystring-sql">.
Some functions are also implemented using the regular syntax for
function invocation.
(See <xref linkend="functions-binarystring-other">.)
</para>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<table id="functions-binarystring-sql">
<title><acronym>SQL</acronym> Binary String Functions and Operators</title>
<tgroup cols="5">
<thead>
<row>
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tbody>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><parameter>string</parameter> <literal>||</literal>
<parameter>string</parameter></literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry> <type>bytea</type> </entry>
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
String concatenation
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>binary string</primary>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<secondary>concatenation</secondary>
</indexterm>
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>'\\\\Post'::bytea || '\\047gres\\000'::bytea</literal></entry>
<entry><literal>\\Post'gres\000</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><function>get_bit</function>(<parameter>string</parameter>, <parameter>offset</parameter>)</entry>
<entry><type>int</type></entry>
<entry>
Extract bit from string
<indexterm>
<primary>get_bit</primary>
</indexterm>
</entry>
<entry><literal>get_bit('Th\\000omas'::bytea, 45)</literal></entry>
<entry><literal>1</literal></entry>
</row>
<row>
<entry><function>get_byte</function>(<parameter>string</parameter>, <parameter>offset</parameter>)</entry>
<entry><type>int</type></entry>
<entry>
Extract byte from string
<indexterm>
<primary>get_byte</primary>
</indexterm>
</entry>
<entry><literal>get_byte('Th\\000omas'::bytea, 4)</literal></entry>
<entry><literal>109</literal></entry>
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>octet_length</function>(<parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>Number of bytes in binary string</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>octet_length( 'jo\\000se'::bytea)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>5</literal></entry>
</row>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>position</function>(<parameter>substring</parameter> in <parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>Location of specified substring</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>position('\\000om'::bytea in 'Th\\000omas'::bytea)</literal></entry>
<entry><literal>3</literal></entry>
</row>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><function>set_bit</function>(<parameter>string</parameter>,
<parameter>offset</parameter>, <parameter>newvalue</>)</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>bytea</type></entry>
<entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
Set bit in string
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
<indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>set_bit</primary>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
</indexterm>
</entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal>set_bit('Th\\000omas'::bytea, 45, 0)</literal></entry>
<entry><literal>Th\000omAs</literal></entry>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
</row>
<row>
Update 'Mathematical Functions' table to reflect 7.3 addition of float8 forms of ceil(), floor(), sign(). Back-patch this and other recent doc fixes in this file to the 7.3 branch.
2003-01-23 02:22:59 +01:00
<entry><function>set_byte</function>(<parameter>string</parameter>,
<parameter>offset</parameter>, <parameter>newvalue</>)</entry>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
<entry><type>bytea</type></entry>
<entry>
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
Set byte in string
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
<indexterm>
<primary>set_byte</primary>
</indexterm>
</entry>
<entry><literal>set_byte('Th\\000omas'::bytea, 4, 64)</literal></entry>
<entry><literal>Th\000o@as</literal></entry>
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>substring</function>(<parameter>string</parameter> <optional>from <type>int</type></optional> <optional>for <type>int</type></optional>)</literal></entry>
<entry><type>bytea</type></entry>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
<entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
Extract substring
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
<indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>substring</primary>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
</indexterm>
</entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal>substring('Th\\000omas'::bytea from 2 for 3)</literal></entry>
<entry><literal>h\000o</literal></entry>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>
<literal><function>trim</function>(<optional>both</optional>
<parameter>bytes</parameter> from
<parameter>string</parameter>)</literal>
</entry>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
<entry><type>bytea</type></entry>
<entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
Remove the longest string containing only the bytes in
<parameter>bytes</parameter> from the start
and end of <parameter>string</parameter>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
</entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal>trim('\\000'::bytea from '\\000Tom\\000'::bytea)</literal></entry>
<entry><literal>Tom</literal></entry>
Document get/set bit/byte functions.
2002-12-05 05:38:30 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</tbody>
</tgroup>
</table>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Additional binary string manipulation functions are available and
are listed in <xref linkend="functions-binarystring-other">. Some
of them are used internally to implement the
<acronym>SQL</acronym>-standard string functions listed in <xref
linkend="functions-binarystring-sql">.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<table id="functions-binarystring-other">
<title>Other Binary String Functions</title>
<tgroup cols="5">
<thead>
<row>
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tbody>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>btrim</function>(<parameter>string</parameter>
Fix a typo in the documentation.
2004-05-05 11:33:38 +02:00
<type>bytea</type>, <parameter>bytes</parameter> <type>bytea</type>)</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><type>bytea</type></entry>
<entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Remove the longest string consisting only of bytes
in <parameter>bytes</parameter> from the start and end of
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
<parameter>string</parameter>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
</entry>
Marginal hacks to make tables format more nicely.
2003-09-13 02:19:43 +02:00
<entry><literal>btrim('\\000trim\\000'::bytea, '\\000'::bytea)</literal></entry>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
<entry><literal>trim</literal></entry>
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry>
<literal><function>decode</function>(<parameter>string</parameter> <type>text</type>,
<parameter>type</parameter> <type>text</type>)</literal>
</entry>
<entry><type>bytea</type></entry>
<entry>
Decode binary string from <parameter>string</parameter> previously
encoded with <function>encode</>. Parameter type is same as in <function>encode</>.
</entry>
<entry><literal>decode('123\\000456', 'escape')</literal></entry>
<entry><literal>123\000456</literal></entry>
</row>
<row>
<entry>
<literal><function>encode</function>(<parameter>string</parameter> <type>bytea</type>,
<parameter>type</parameter> <type>text</type>)</literal>
</entry>
<entry><type>text</type></entry>
<entry>
Encode binary string to <acronym>ASCII</acronym>-only representation. Supported
types are: <literal>base64</>, <literal>hex</>, <literal>escape</>.
</entry>
<entry><literal>encode('123\\000456'::bytea, 'escape')</literal></entry>
<entry><literal>123\000456</literal></entry>
</row>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>length</function>(<parameter>string</parameter>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
<entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Length of binary string
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>binary string</primary>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<secondary>length</secondary>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
</indexterm>
<indexterm>
<primary>length</primary>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<secondary sortas="binary string">of a binary string</secondary>
<see>binary strings, length</see>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
</indexterm>
</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<entry><literal>length('jo\\000se'::bytea)</literal></entry>
<entry><literal>5</literal></entry>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
</row>
Implement md5(bytea), update regression tests and documentation. Patch from Abhijit Menon-Sen, minor editorialization from Neil Conway. Also, improve md5(text) to allocate a constant-sized buffer on the stack rather than via palloc. Catalog version bumped.
2005-05-20 03:29:56 +02:00
<row>
<entry><literal><function>md5</function>(<parameter>string</parameter>)</literal></entry>
<entry><type>text</type></entry>
<entry>
Calculates the MD5 hash of <parameter>string</parameter>,
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
returning the result in hexadecimal
Implement md5(bytea), update regression tests and documentation. Patch from Abhijit Menon-Sen, minor editorialization from Neil Conway. Also, improve md5(text) to allocate a constant-sized buffer on the stack rather than via palloc. Catalog version bumped.
2005-05-20 03:29:56 +02:00
</entry>
<entry><literal>md5('Th\\000omas'::bytea)</literal></entry>
<entry><literal>8ab2d3c9689aaf18 b4958c334c82d8b1</literal></entry>
</row>
I've created a new section to func.sgml, "Binary String Functions and Operators", plagiarized shamelessly from the "String Functions and Operators" section. There were enough differences that it made sense (at least to me) to give this its own section instead of cramming it in with normal string functions. This way I could also make the examples relevant, which is particularly important for bytea. One thing I think worth mentioning: while documenting the trim() function I realized that I never implemented the bytea equivalent of rtrim and ltrim. Therefore, the 'leading' and 'trailing' forms of trim, available with text, are not available with bytea (I'd be happy to correct this, but since it would require an initdb, I guess not until 7.3) -- the submitted doc accurately reflects this. I will look for other areas of the docs that need mention of bytea, but any guidance would be much appreciated. -- Here's a second bytea documentation patch. This one significantly expands the "Binary Data" section added by Bruce recently. Joe Conway
2001-11-20 16:42:44 +01:00
</tbody>
</tgroup>
</table>
</sect1>
Represent type-specific length coercion functions as pg_cast entries, eliminating the former hard-wired convention about their names. Allow pg_cast entries to represent both type coercion and length coercion in a single step --- this is represented by a function that takes an extra typmod argument, just like a length coercion function. This nicely merges the type and length coercion mechanisms into something at least a little cleaner than we had before. Make use of the single- coercion-step behavior to fix integer-to-bit coercion so that coercing to bit(n) yields the rightmost n bits of the integer instead of the leftmost n bits. This should fix recurrent complaints about the odd behavior of this coercion. Clean up the documentation of the bit string functions, and try to put it where people might actually find it. Also, get rid of the unreliable heuristics in ruleutils.c about whether to display nested coercion steps; instead require parse_coerce.c to label them properly in the first place.
2004-06-16 03:27:00 +02:00
<sect1 id="functions-bitstring">
<title>Bit String Functions and Operators</title>
<indexterm zone="functions-bitstring">
<primary>bit strings</primary>
<secondary>functions</secondary>
</indexterm>
<para>
This section describes functions and operators for examining and
manipulating bit strings, that is values of the types
<type>bit</type> and <type>bit varying</type>. Aside from the
usual comparison operators, the operators
shown in <xref linkend="functions-bit-string-op-table"> can be used.
Bit string operands of <literal>&amp;</literal>, <literal>|</literal>,
and <literal>#</literal> must be of equal length. When bit
shifting, the original length of the string is preserved, as shown
in the examples.
</para>
<table id="functions-bit-string-op-table">
<title>Bit String Operators</title>
<tgroup cols="4">
<thead>
<row>
<entry>Operator</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>||</literal> </entry>
<entry>concatenation</entry>
<entry><literal>B'10001' || B'011'</literal></entry>
<entry><literal>10001011</literal></entry>
</row>
<row>
<entry> <literal>&amp;</literal> </entry>
<entry>bitwise AND</entry>
<entry><literal>B'10001' &amp; B'01101'</literal></entry>
<entry><literal>00001</literal></entry>
</row>
<row>
<entry> <literal>|</literal> </entry>
<entry>bitwise OR</entry>
<entry><literal>B'10001' | B'01101'</literal></entry>
<entry><literal>11101</literal></entry>
</row>
<row>
<entry> <literal>#</literal> </entry>
<entry>bitwise XOR</entry>
<entry><literal>B'10001' # B'01101'</literal></entry>
<entry><literal>11100</literal></entry>
</row>
<row>
<entry> <literal>~</literal> </entry>
<entry>bitwise NOT</entry>
<entry><literal>~ B'10001'</literal></entry>
<entry><literal>01110</literal></entry>
</row>
<row>
<entry> <literal>&lt;&lt;</literal> </entry>
<entry>bitwise shift left</entry>
<entry><literal>B'10001' &lt;&lt; 3</literal></entry>
<entry><literal>01000</literal></entry>
</row>
<row>
<entry> <literal>&gt;&gt;</literal> </entry>
<entry>bitwise shift right</entry>
<entry><literal>B'10001' &gt;&gt; 2</literal></entry>
<entry><literal>00100</literal></entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The following <acronym>SQL</acronym>-standard functions work on bit
strings as well as character strings:
<literal><function>length</function></literal>,
<literal><function>bit_length</function></literal>,
<literal><function>octet_length</function></literal>,
<literal><function>position</function></literal>,
<literal><function>substring</function></literal>.
</para>
<para>
In addition, it is possible to cast integral values to and from type
<type>bit</>.
Some examples:
<programlisting>
44::bit(10) <lineannotation>0000101100</lineannotation>
44::bit(3) <lineannotation>100</lineannotation>
cast(-44 as bit(12)) <lineannotation>111111010100</lineannotation>
'1110'::bit(4)::integer <lineannotation>14</lineannotation>
</programlisting>
Note that casting to just <quote>bit</> means casting to
<literal>bit(1)</>, and so it will deliver only the least significant
bit of the integer.
</para>
<note>
<para>
Label CVS tip as 8.0devel instead of 7.5devel. Adjust various comments and documentation to reference 8.0 instead of 7.5.
2004-08-04 23:34:35 +02:00
Prior to <productname>PostgreSQL</productname> 8.0, casting an
Represent type-specific length coercion functions as pg_cast entries, eliminating the former hard-wired convention about their names. Allow pg_cast entries to represent both type coercion and length coercion in a single step --- this is represented by a function that takes an extra typmod argument, just like a length coercion function. This nicely merges the type and length coercion mechanisms into something at least a little cleaner than we had before. Make use of the single- coercion-step behavior to fix integer-to-bit coercion so that coercing to bit(n) yields the rightmost n bits of the integer instead of the leftmost n bits. This should fix recurrent complaints about the odd behavior of this coercion. Clean up the documentation of the bit string functions, and try to put it where people might actually find it. Also, get rid of the unreliable heuristics in ruleutils.c about whether to display nested coercion steps; instead require parse_coerce.c to label them properly in the first place.
2004-06-16 03:27:00 +02:00
integer to <type>bit(n)</> would copy the leftmost <literal>n</>
bits of the integer, whereas now it copies the rightmost <literal>n</>
bits. Also, casting an integer to a bit string width wider than
the integer itself will sign-extend on the left.
</para>
</note>
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<sect1 id="functions-matching">
<title>Pattern Matching</title>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<indexterm zone="functions-matching">
<primary>pattern matching</primary>
</indexterm>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Update of conformance information to SQL:2003 by Troels Arvin, Simon Riggs, Elein Mustain Make spelling of SQL standard names uniform.
2004-11-27 22:27:08 +01:00
There are three separate approaches to pattern matching provided
by <productname>PostgreSQL</productname>: the traditional
<acronym>SQL</acronym> <function>LIKE</function> operator, the
Avoid referring to a specific version of the SQL standard except where necessary, and be careful to refer to the right version where it is useful to do so. This partially reverts an ill-considered search and replace from a few months ago.
2005-11-04 03:56:31 +01:00
more recent <function>SIMILAR TO</function> operator (added in
SQL:1999), and <acronym>POSIX</acronym>-style regular
expressions.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Additionally, a pattern matching function,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<function>substring</function>, is available, using either
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
<function>SIMILAR TO</function>-style or POSIX-style regular
Update of conformance information to SQL:2003 by Troels Arvin, Simon Riggs, Elein Mustain Make spelling of SQL standard names uniform.
2004-11-27 22:27:08 +01:00
expressions.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</para>
<tip>
<para>
If you have pattern matching needs that go beyond this,
consider writing a user-defined function in Perl or Tcl.
</para>
</tip>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<sect2 id="functions-like">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title><function>LIKE</function></title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>LIKE</primary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<replaceable>string</replaceable> LIKE <replaceable>pattern</replaceable> <optional>ESCAPE <replaceable>escape-character</replaceable></optional>
<replaceable>string</replaceable> NOT LIKE <replaceable>pattern</replaceable> <optional>ESCAPE <replaceable>escape-character</replaceable></optional>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Include mention of CASE, COALESCE, and IFNULL. Add date/time parsing procedure (perhaps should be in appendix). Add time zone information (ditto). Update keyword list.
1999-05-12 09:32:47 +02:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<para>
Every <replaceable>pattern</replaceable> defines a set of strings.
The <function>LIKE</function> expression returns true if the
<replaceable>string</replaceable> is contained in the set of
strings represented by <replaceable>pattern</replaceable>. (As
expected, the <function>NOT LIKE</function> expression returns
false if <function>LIKE</function> returns true, and vice versa.
An equivalent expression is
<literal>NOT (<replaceable>string</replaceable> LIKE
<replaceable>pattern</replaceable>)</literal>.)
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
If <replaceable>pattern</replaceable> does not contain percent
signs or underscore, then the pattern only represents the string
itself; in that case <function>LIKE</function> acts like the
equals operator. An underscore (<literal>_</literal>) in
<replaceable>pattern</replaceable> stands for (matches) any single
character; a percent sign (<literal>%</literal>) matches any string
of zero or more characters.
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Some examples:
<programlisting>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
'abc' LIKE 'abc' <lineannotation>true</lineannotation>
'abc' LIKE 'a%' <lineannotation>true</lineannotation>
'abc' LIKE '_b_' <lineannotation>true</lineannotation>
'abc' LIKE 'c' <lineannotation>false</lineannotation>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</programlisting>
</para>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<function>LIKE</function> pattern matches always cover the entire
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
string. To match a sequence anywhere within a string, the
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
pattern must therefore start and end with a percent sign.
Minor updates for release.
1999-06-14 09:36:12 +02:00
</para>
Add exp(), ln(), and some other functions to numeric-functions table.
2000-03-20 05:20:52 +01:00
<para>
A little wordsmithing in the pattern-matching section.
2000-12-16 20:33:23 +01:00
To match a literal underscore or percent sign without matching
other characters, the respective character in
<replaceable>pattern</replaceable> must be
preceded by the escape character. The default escape
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
character is the backslash but a different one may be selected by
A little wordsmithing in the pattern-matching section.
2000-12-16 20:33:23 +01:00
using the <literal>ESCAPE</literal> clause. To match the escape
character itself, write two escape characters.
</para>
<para>
Note that the backslash already has a special meaning in string
literals, so to write a pattern constant that contains a backslash
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
you must write two backslashes in an SQL statement. Thus, writing a pattern
Mention that LIKE ... ESCAPE '' is allowed to specify no escape character.
2001-11-18 22:17:10 +01:00
that actually matches a literal backslash means writing four backslashes
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
in the statement. You can avoid this by selecting a different escape
character with <literal>ESCAPE</literal>; then a backslash is not special
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
to <function>LIKE</function> anymore. (But it is still special to the string
Mention that LIKE ... ESCAPE '' is allowed to specify no escape character.
2001-11-18 22:17:10 +01:00
literal parser, so you still need two of them.)
</para>
<para>
It's also possible to select no escape character by writing
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<literal>ESCAPE ''</literal>. This effectively disables the
Fix for documention: >>" It's also possible to select no escape character by writing ESCAPE ''. >>In this case there is no way to turn off the special meaning of >>underscore and percent signs in the pattern." Joe Conway
2002-08-22 06:56:44 +02:00
escape mechanism, which makes it impossible to turn off the
special meaning of underscore and percent signs in the pattern.
Add exp(), ln(), and some other functions to numeric-functions table.
2000-03-20 05:20:52 +01:00
</para>
Fix path to initdb in installation instructions. General cleanup for 7.0.
2000-04-07 15:30:58 +02:00
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The key word <token>ILIKE</token> can be used instead of
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
<token>LIKE</token> to make the match case-insensitive according
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
to the active locale. This is not in the <acronym>SQL</acronym> standard but is a
Deprecate 'current' for date/time input. Fix up references to "PostgreSQL" rather than "Postgres". Was roughly evenly split between the two before. ref/ files not yet done.
2001-11-21 06:53:41 +01:00
<productname>PostgreSQL</productname> extension.
Update some porting info. Add mention of transcendental functions.
2000-04-08 04:16:08 +02:00
</para>
Fix path to initdb in installation instructions. General cleanup for 7.0.
2000-04-07 15:30:58 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
The operator <literal>~~</literal> is equivalent to
A little wordsmithing in the pattern-matching section.
2000-12-16 20:33:23 +01:00
<function>LIKE</function>, and <literal>~~*</literal> corresponds to
<function>ILIKE</function>. There are also
<literal>!~~</literal> and <literal>!~~*</literal> operators that
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
represent <function>NOT LIKE</function> and <function>NOT
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
ILIKE</function>, respectively. All of these operators are
Deprecate 'current' for date/time input. Fix up references to "PostgreSQL" rather than "Postgres". Was roughly evenly split between the two before. ref/ files not yet done.
2001-11-21 06:53:41 +01:00
<productname>PostgreSQL</productname>-specific.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
</sect2>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Update of conformance information to SQL:2003 by Troels Arvin, Simon Riggs, Elein Mustain Make spelling of SQL standard names uniform.
2004-11-27 22:27:08 +01:00
<sect2 id="functions-similarto-regexp">
<title><function>SIMILAR TO</function> Regular Expressions</title>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>regular expression</primary>
Tweak conversion names to follow the established naming scheme, and document that scheme.
2002-09-24 22:14:59 +02:00
<!-- <seealso>pattern matching</seealso> breaks index build -->
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</indexterm>
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>SIMILAR TO</primary>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</indexterm>
<indexterm>
<primary>substring</primary>
</indexterm>
Code review for regexp_replace patch. Improve documentation and comments, fix problems with replacement-string backslashes that aren't followed by one of the expected characters, avoid giving the impression that replace_text_regexp() is meant to be called directly as a SQL function, etc.
2005-10-18 22:38:58 +02:00
<indexterm>
<primary>regexp_replace</primary>
</indexterm>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<replaceable>string</replaceable> SIMILAR TO <replaceable>pattern</replaceable> <optional>ESCAPE <replaceable>escape-character</replaceable></optional>
<replaceable>string</replaceable> NOT SIMILAR TO <replaceable>pattern</replaceable> <optional>ESCAPE <replaceable>escape-character</replaceable></optional>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<para>
Update of conformance information to SQL:2003 by Troels Arvin, Simon Riggs, Elein Mustain Make spelling of SQL standard names uniform.
2004-11-27 22:27:08 +01:00
The <function>SIMILAR TO</function> operator returns true or
false depending on whether its pattern matches the given string.
It is much like <function>LIKE</function>, except that it
interprets the pattern using the SQL standard's definition of a
regular expression. SQL regular expressions are a curious cross
between <function>LIKE</function> notation and common regular
expression notation.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</para>
<para>
Like <function>LIKE</function>, the <function>SIMILAR TO</function>
operator succeeds only if its pattern matches the entire string;
this is unlike common regular expression practice, wherein the pattern
may match any part of the string.
Also like
<function>LIKE</function>, <function>SIMILAR TO</function> uses
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal>_</> and <literal>%</> as wildcard characters denoting
any single character and any string, respectively (these are
comparable to <literal>.</> and <literal>.*</> in POSIX regular
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
expressions).
</para>
<para>
In addition to these facilities borrowed from <function>LIKE</function>,
<function>SIMILAR TO</function> supports these pattern-matching
metacharacters borrowed from POSIX regular expressions:
<itemizedlist>
<listitem>
<para>
<literal>|</literal> denotes alternation (either of two alternatives).
</para>
</listitem>
<listitem>
<para>
<literal>*</literal> denotes repetition of the previous item zero
or more times.
</para>
</listitem>
<listitem>
<para>
<literal>+</literal> denotes repetition of the previous item one
or more times.
</para>
</listitem>
<listitem>
<para>
Parentheses <literal>()</literal> may be used to group items into
a single logical item.
</para>
</listitem>
<listitem>
<para>
A bracket expression <literal>[...]</literal> specifies a character
class, just as in POSIX regular expressions.
</para>
</listitem>
</itemizedlist>
Notice that bounded repetition (<literal>?</> and <literal>{...}</>)
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
are not provided, though they exist in POSIX. Also, the dot (<literal>.</>)
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
is not a metacharacter.
</para>
<para>
As with <function>LIKE</>, a backslash disables the special meaning
of any of these metacharacters; or a different escape character can
be specified with <literal>ESCAPE</>.
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Some examples:
<programlisting>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
'abc' SIMILAR TO 'abc' <lineannotation>true</lineannotation>
'abc' SIMILAR TO 'a' <lineannotation>false</lineannotation>
'abc' SIMILAR TO '%(b|d)%' <lineannotation>true</lineannotation>
'abc' SIMILAR TO '(b|c)%' <lineannotation>false</lineannotation>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</programlisting>
</para>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The <function>substring</> function with three parameters,
Trivial markup improvement.
2005-06-06 18:29:01 +02:00
<function>substring(<replaceable>string</replaceable> from
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<replaceable>pattern</replaceable> for
<replaceable>escape-character</replaceable>)</function>, provides
Update of conformance information to SQL:2003 by Troels Arvin, Simon Riggs, Elein Mustain Make spelling of SQL standard names uniform.
2004-11-27 22:27:08 +01:00
extraction of a substring that matches an SQL
The "random" regression test uses a function called oidrand(), which takes two parameters, an OID x and an integer y, and returns "true" with probability 1/y (the OID argument is ignored). This can be useful -- for example, it can be used to select a random sampling of the rows in a table (which is what the "random" regression test uses it for). This patch removes that function, because it was old and messy. The old function had the following problems: - it was undocumented - it was poorly named - it was designed to workaround an optimizer bug that no longer exists (the OID argument is to ensure that the optimizer won't optimize away calls to the function; AFAIK marking the function as 'volatile' suffices nowadays) - it used a different random-number generation technique than the other PSRNG-related functions in the backend do (it called random() like they do, but it had its own logic for setting a set and deciding when to reseed the RNG). Ok, this patch removes oidrand(), oidsrand(), and userfntest(), and improves the SGML docs a little bit (un-commenting the setseed() documentation). Neil Conway
2003-02-13 06:24:04 +01:00
regular expression pattern. As with <literal>SIMILAR TO</>, the
specified pattern must match to the entire data string, else the
function fails and returns null. To indicate the part of the
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
pattern that should be returned on success, the pattern must contain
two occurrences of the escape character followed by a double quote
The "random" regression test uses a function called oidrand(), which takes two parameters, an OID x and an integer y, and returns "true" with probability 1/y (the OID argument is ignored). This can be useful -- for example, it can be used to select a random sampling of the rows in a table (which is what the "random" regression test uses it for). This patch removes that function, because it was old and messy. The old function had the following problems: - it was undocumented - it was poorly named - it was designed to workaround an optimizer bug that no longer exists (the OID argument is to ensure that the optimizer won't optimize away calls to the function; AFAIK marking the function as 'volatile' suffices nowadays) - it used a different random-number generation technique than the other PSRNG-related functions in the backend do (it called random() like they do, but it had its own logic for setting a set and deciding when to reseed the RNG). Ok, this patch removes oidrand(), oidsrand(), and userfntest(), and improves the SGML docs a little bit (un-commenting the setseed() documentation). Neil Conway
2003-02-13 06:24:04 +01:00
(<literal>"</>). The text matching the portion of the pattern
between these markers is returned.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Some examples:
<programlisting>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
substring('foobar' from '%#"o_b#"%' for '#') <lineannotation>oob</lineannotation>
substring('foobar' from '#"o_b#"%' for '#') <lineannotation>NULL</lineannotation>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</programlisting>
</para>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</sect2>
<sect2 id="functions-posix-regexp">
<title><acronym>POSIX</acronym> Regular Expressions</title>
<indexterm zone="functions-posix-regexp">
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>regular expression</primary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
<seealso>pattern matching</seealso>
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="functions-posix-table"> lists the available
operators for pattern matching using POSIX regular expressions.
</para>
<table id="functions-posix-table">
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<title>Regular Expression Match Operators</title>
<tgroup cols="3">
<thead>
<row>
<entry>Operator</entry>
<entry>Description</entry>
<entry>Example</entry>
</row>
</thead>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<tbody>
<row>
<entry> <literal>~</literal> </entry>
<entry>Matches regular expression, case sensitive</entry>
<entry><literal>'thomas' ~ '.*thomas.*'</literal></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>~*</literal> </entry>
<entry>Matches regular expression, case insensitive</entry>
<entry><literal>'thomas' ~* '.*Thomas.*'</literal></entry>
</row>
A little wordsmithing in the pattern-matching section.
2000-12-16 20:33:23 +01:00
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
<entry> <literal>!~</literal> </entry>
<entry>Does not match regular expression, case sensitive</entry>
<entry><literal>'thomas' !~ '.*Thomas.*'</literal></entry>
</row>
<row>
<entry> <literal>!~*</literal> </entry>
<entry>Does not match regular expression, case insensitive</entry>
<entry><literal>'thomas' !~* '.*vadim.*'</literal></entry>
</row>
</tbody>
</tgroup>
</table>
<para>
<acronym>POSIX</acronym> regular expressions provide a more
powerful means for
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
pattern matching than the <function>LIKE</function> and
<function>SIMILAR TO</> operators.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Many Unix tools such as <command>egrep</command>,
<command>sed</command>, or <command>awk</command> use a pattern
matching language that is similar to the one described here.
</para>
<para>
A regular expression is a character sequence that is an
abbreviated definition of a set of strings (a <firstterm>regular
Code review for regexp_replace patch. Improve documentation and comments, fix problems with replacement-string backslashes that aren't followed by one of the expected characters, avoid giving the impression that replace_text_regexp() is meant to be called directly as a SQL function, etc.
2005-10-18 22:38:58 +02:00
set</firstterm>). A string is said to match a regular expression
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
if it is a member of the regular set described by the regular
expression. As with <function>LIKE</function>, pattern characters
match string characters exactly unless they are special characters
Replace "--" and "---" with "&mdash;" as appropriate, for better-looking output.
2004-11-15 07:32:15 +01:00
in the regular expression language &mdash; but regular expressions use
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
different special characters than <function>LIKE</function> does.
Unlike <function>LIKE</function> patterns, a
regular expression is allowed to match anywhere within a string, unless
the regular expression is explicitly anchored to the beginning or
end of the string.
</para>
A little wordsmithing in the pattern-matching section.
2000-12-16 20:33:23 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Some examples:
<programlisting>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
'abc' ~ 'abc' <lineannotation>true</lineannotation>
'abc' ~ '^a' <lineannotation>true</lineannotation>
'abc' ~ '(b|d)' <lineannotation>true</lineannotation>
'abc' ~ '^(b|c)' <lineannotation>false</lineannotation>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</programlisting>
</para>
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The <function>substring</> function with two parameters,
Trivial markup improvement.
2005-06-06 18:29:01 +02:00
<function>substring(<replaceable>string</replaceable> from
Code review for regexp_replace patch. Improve documentation and comments, fix problems with replacement-string backslashes that aren't followed by one of the expected characters, avoid giving the impression that replace_text_regexp() is meant to be called directly as a SQL function, etc.
2005-10-18 22:38:58 +02:00
<replaceable>pattern</replaceable>)</function>, provides extraction of a
substring
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
that matches a POSIX regular expression pattern. It returns null if
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
there is no match, otherwise the portion of the text that matched the
pattern. But if the pattern contains any parentheses, the portion
of the text that matched the first parenthesized subexpression (the
one whose left parenthesis comes first) is
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
returned. You can put parentheses around the whole expression
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
if you want to use parentheses within it without triggering this
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
exception. If you need parentheses in the pattern before the
subexpression you want to extract, see the non-capturing parentheses
described below.
Bring SIMILAR TO and SUBSTRING into some semblance of conformance with the SQL99 standard. (I'm not sure that the character-class features are quite right, but that can be fixed later.) Document SQL99 and POSIX regexps as being different features; provide variants of SUBSTRING for each.
2002-09-22 19:27:25 +02:00
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Some examples:
<programlisting>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
substring('foobar' from 'o.b') <lineannotation>oob</lineannotation>
substring('foobar' from 'o(.)b') <lineannotation>o</lineannotation>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</programlisting>
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Code review for regexp_replace patch. Improve documentation and comments, fix problems with replacement-string backslashes that aren't followed by one of the expected characters, avoid giving the impression that replace_text_regexp() is meant to be called directly as a SQL function, etc.
2005-10-18 22:38:58 +02:00
<para>
The <function>regexp_replace</> function provides substitution of
new text for substrings that match POSIX regular expression patterns.
It has the syntax
<function>regexp_replace</function>(<replaceable>source</>,
<replaceable>pattern</>, <replaceable>replacement</>
<optional>, <replaceable>flags</> </optional>).
The <replaceable>source</> string is returned unchanged if
there is no match to the <replaceable>pattern</>. If there is a
match, the <replaceable>source</> string is returned with the
<replaceable>replacement</> string substituted for the matching
substring. The <replaceable>replacement</> string can contain
<literal>\</><replaceable>n</>, where <replaceable>n</> is <literal>1</>
through <literal>9</>, to indicate that the source substring matching the
<replaceable>n</>'th parenthesized subexpression of the pattern should be
inserted, and it can contain <literal>\&amp;</> to indicate that the
substring matching the entire pattern should be inserted. Write
<literal>\\</> if you need to put a literal backslash in the replacement
text. (As always, remember to double backslashes written in literal
constant strings.)
The <replaceable>flags</> parameter is an optional text
string containing zero or more single-letter flags that change the
function's behavior. Flag <literal>i</> specifies case-insensitive
matching, while flag <literal>g</> specifies replacement of each matching
substring rather than only the first one.
</para>
<para>
Some examples:
<programlisting>
regexp_replace('foobarbaz', 'b..', 'X')
<lineannotation>fooXbaz</lineannotation>
regexp_replace('foobarbaz', 'b..', 'X', 'g')
<lineannotation>fooXX</lineannotation>
regexp_replace('foobarbaz', 'b(..)', 'X\\1Y', 'g')
<lineannotation>fooXarYXazY</lineannotation>
</programlisting>
</para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<para>
<productname>PostgreSQL</productname>'s regular expressions are implemented
using a package written by Henry Spencer. Much of
the description of regular expressions below is copied verbatim from his
manual entry.
</para>
<!-- derived from the re_syntax.n man page -->
<sect3 id="posix-syntax-details">
<title>Regular Expression Details</title>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<para>
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
Regular expressions (<acronym>RE</acronym>s), as defined in
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<acronym>POSIX</acronym> 1003.2, come in two forms:
<firstterm>extended</> <acronym>RE</acronym>s or <acronym>ERE</>s
(roughly those of <command>egrep</command>), and
<firstterm>basic</> <acronym>RE</acronym>s or <acronym>BRE</>s
(roughly those of <command>ed</command>).
<productname>PostgreSQL</productname> supports both forms, and
also implements some extensions
that are not in the POSIX standard, but have become widely used anyway
due to their availability in programming languages such as Perl and Tcl.
<acronym>RE</acronym>s using these non-POSIX extensions are called
<firstterm>advanced</> <acronym>RE</acronym>s or <acronym>ARE</>s
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
in this documentation. AREs are almost an exact superset of EREs,
but BREs have several notational incompatibilities (as well as being
much more limited).
We first describe the ARE and ERE forms, noting features that apply
only to AREs, and then describe how BREs differ.
Minor updates for release.
1999-06-14 09:36:12 +02:00
</para>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
<note>
<para>
Refer to GUC variables using <xref> tags rather than <varname> tags, where appropriate. Add "id" and "xreflabel" tags to the descriptions of the GUC variables to facilitate this. Also make a few minor docs cleanups.
2004-03-09 17:57:47 +01:00
The form of regular expressions accepted by
<productname>PostgreSQL</> can be chosen by setting the <xref
linkend="guc-regex-flavor"> run-time parameter. The usual
setting is <literal>advanced</>, but one might choose
<literal>extended</> for maximum backwards compatibility with
pre-7.4 releases of <productname>PostgreSQL</>.
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
</para>
</note>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
A regular expression is defined as one or more
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<firstterm>branches</firstterm>, separated by
<literal>|</literal>. It matches anything that matches one of the
branches.
Minor updates for release.
1999-06-14 09:36:12 +02:00
</para>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Include mention of CASE, COALESCE, and IFNULL. Add date/time parsing procedure (perhaps should be in appendix). Add time zone information (ditto). Update keyword list.
1999-05-12 09:32:47 +02:00
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
A branch is zero or more <firstterm>quantified atoms</> or
<firstterm>constraints</>, concatenated.
It matches a match for the first, followed by a match for the second, etc;
an empty branch matches the empty string.
Include mention of CASE, COALESCE, and IFNULL. Add date/time parsing procedure (perhaps should be in appendix). Add time zone information (ditto). Update keyword list.
1999-05-12 09:32:47 +02:00
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
* to_char: - full support for IW (ISO week) and vice versa conversion for IW too (the to_char 'week' support is now complete and I hope correct). Thomas, I use for IW code from timestamp.c, for this I create separate function date2isoweek() from original 'case DTK_WEEK:' code in the timestamp_part(). I mean will better use one code for same feature in date_part() and in to_char(). The isoweek2date() is added to timestamp.c too. Right? IMHO in 7.1 will all to_char's features complete. It is cca 41 templates for date/time and cca 21 for numbers. * to_ascii: - gcc, is it correct now? :-) In the patch is documentation for to_char's IW and for to_ascii(). Karel
2000-08-29 06:41:48 +02:00
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
A quantified atom is an <firstterm>atom</> possibly followed
by a single <firstterm>quantifier</>.
Without a quantifier, it matches a match for the atom.
With a quantifier, it can match some number of matches of the atom.
An <firstterm>atom</firstterm> can be any of the possibilities
shown in <xref linkend="posix-atoms-table">.
The possible quantifiers and their meanings are shown in
<xref linkend="posix-quantifiers-table">.
* to_char: - full support for IW (ISO week) and vice versa conversion for IW too (the to_char 'week' support is now complete and I hope correct). Thomas, I use for IW code from timestamp.c, for this I create separate function date2isoweek() from original 'case DTK_WEEK:' code in the timestamp_part(). I mean will better use one code for same feature in date_part() and in to_char(). The isoweek2date() is added to timestamp.c too. Right? IMHO in 7.1 will all to_char's features complete. It is cca 41 templates for date/time and cca 21 for numbers. * to_ascii: - gcc, is it correct now? :-) In the patch is documentation for to_char's IW and for to_ascii(). Karel
2000-08-29 06:41:48 +02:00
</para>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
A <firstterm>constraint</> matches an empty string, but matches only when
specific conditions are met. A constraint can be used where an atom
could be used, except it may not be followed by a quantifier.
The simple constraints are shown in
<xref linkend="posix-constraints-table">;
some more constraints are described later.
</para>
<table id="posix-atoms-table">
<title>Regular Expression Atoms</title>
<tgroup cols="2">
<thead>
<row>
<entry>Atom</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>(</><replaceable>re</><literal>)</> </entry>
<entry> (where <replaceable>re</> is any regular expression)
matches a match for
<replaceable>re</>, with the match noted for possible reporting </entry>
</row>
<row>
<entry> <literal>(?:</><replaceable>re</><literal>)</> </entry>
<entry> as above, but the match is not noted for reporting
(a <quote>non-capturing</> set of parentheses)
(AREs only) </entry>
</row>
<row>
<entry> <literal>.</> </entry>
<entry> matches any single character </entry>
</row>
<row>
<entry> <literal>[</><replaceable>chars</><literal>]</> </entry>
<entry> a <firstterm>bracket expression</>,
matching any one of the <replaceable>chars</> (see
<xref linkend="posix-bracket-expressions"> for more detail) </entry>
</row>
<row>
<entry> <literal>\</><replaceable>k</> </entry>
<entry> (where <replaceable>k</> is a non-alphanumeric character)
matches that character taken as an ordinary character,
e.g. <literal>\\</> matches a backslash character </entry>
</row>
<row>
<entry> <literal>\</><replaceable>c</> </entry>
<entry> where <replaceable>c</> is alphanumeric
(possibly followed by other characters)
is an <firstterm>escape</>, see <xref linkend="posix-escape-sequences">
(AREs only; in EREs and BREs, this matches <replaceable>c</>) </entry>
</row>
<row>
<entry> <literal>{</> </entry>
<entry> when followed by a character other than a digit,
matches the left-brace character <literal>{</>;
when followed by a digit, it is the beginning of a
<replaceable>bound</> (see below) </entry>
</row>
<row>
<entry> <replaceable>x</> </entry>
<entry> where <replaceable>x</> is a single character with no other
significance, matches that character </entry>
</row>
</tbody>
</tgroup>
</table>
<para>
An RE may not end with <literal>\</>.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
<note>
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
Remember that the backslash (<literal>\</literal>) already has a special
meaning in <productname>PostgreSQL</> string literals.
To write a pattern constant that contains a backslash,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
you must write two backslashes in the statement.
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
</para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</note>
<table id="posix-quantifiers-table">
<title>Regular Expression Quantifiers</title>
<tgroup cols="2">
<thead>
<row>
<entry>Quantifier</entry>
<entry>Matches</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>*</> </entry>
<entry> a sequence of 0 or more matches of the atom </entry>
</row>
<row>
<entry> <literal>+</> </entry>
<entry> a sequence of 1 or more matches of the atom </entry>
</row>
<row>
<entry> <literal>?</> </entry>
<entry> a sequence of 0 or 1 matches of the atom </entry>
</row>
<row>
<entry> <literal>{</><replaceable>m</><literal>}</> </entry>
<entry> a sequence of exactly <replaceable>m</> matches of the atom </entry>
</row>
<row>
<entry> <literal>{</><replaceable>m</><literal>,}</> </entry>
<entry> a sequence of <replaceable>m</> or more matches of the atom </entry>
</row>
<row>
<entry>
<literal>{</><replaceable>m</><literal>,</><replaceable>n</><literal>}</> </entry>
<entry> a sequence of <replaceable>m</> through <replaceable>n</>
(inclusive) matches of the atom; <replaceable>m</> may not exceed
<replaceable>n</> </entry>
</row>
<row>
<entry> <literal>*?</> </entry>
<entry> non-greedy version of <literal>*</> </entry>
</row>
<row>
<entry> <literal>+?</> </entry>
<entry> non-greedy version of <literal>+</> </entry>
</row>
<row>
<entry> <literal>??</> </entry>
<entry> non-greedy version of <literal>?</> </entry>
</row>
<row>
<entry> <literal>{</><replaceable>m</><literal>}?</> </entry>
<entry> non-greedy version of <literal>{</><replaceable>m</><literal>}</> </entry>
</row>
<row>
<entry> <literal>{</><replaceable>m</><literal>,}?</> </entry>
<entry> non-greedy version of <literal>{</><replaceable>m</><literal>,}</> </entry>
</row>
<row>
<entry>
<literal>{</><replaceable>m</><literal>,</><replaceable>n</><literal>}?</> </entry>
<entry> non-greedy version of <literal>{</><replaceable>m</><literal>,</><replaceable>n</><literal>}</> </entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The forms using <literal>{</><replaceable>...</><literal>}</>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
are known as <firstterm>bounds</>.
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
The numbers <replaceable>m</> and <replaceable>n</> within a bound are
unsigned decimal integers with permissible values from 0 to 255 inclusive.
</para>
<para>
<firstterm>Non-greedy</> quantifiers (available in AREs only) match the
same possibilities as their corresponding normal (<firstterm>greedy</>)
counterparts, but prefer the smallest number rather than the largest
number of matches.
See <xref linkend="posix-matching-rules"> for more detail.
</para>
<note>
<para>
A quantifier cannot immediately follow another quantifier.
A quantifier cannot
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
begin an expression or subexpression or follow
<literal>^</literal> or <literal>|</literal>.
</para>
</note>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<table id="posix-constraints-table">
<title>Regular Expression Constraints</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constraint</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>^</> </entry>
<entry> matches at the beginning of the string </entry>
</row>
<row>
<entry> <literal>$</> </entry>
<entry> matches at the end of the string </entry>
</row>
<row>
<entry> <literal>(?=</><replaceable>re</><literal>)</> </entry>
<entry> <firstterm>positive lookahead</> matches at any point
where a substring matching <replaceable>re</> begins
(AREs only) </entry>
</row>
<row>
<entry> <literal>(?!</><replaceable>re</><literal>)</> </entry>
<entry> <firstterm>negative lookahead</> matches at any point
where no substring matching <replaceable>re</> begins
(AREs only) </entry>
</row>
</tbody>
</tgroup>
</table>
Include mention of CASE, COALESCE, and IFNULL. Add date/time parsing procedure (perhaps should be in appendix). Add time zone information (ditto). Update keyword list.
1999-05-12 09:32:47 +02:00
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
Lookahead constraints may not contain <firstterm>back references</>
(see <xref linkend="posix-escape-sequences">),
and all parentheses within them are considered non-capturing.
A little wordsmithing in the pattern-matching section.
2000-12-16 20:33:23 +01:00
</para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</sect3>
<sect3 id="posix-bracket-expressions">
<title>Bracket Expressions</title>
A little wordsmithing in the pattern-matching section.
2000-12-16 20:33:23 +01:00
Minor updates for release.
1999-06-14 09:36:12 +02:00
<para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
A <firstterm>bracket expression</firstterm> is a list of
characters enclosed in <literal>[]</literal>. It normally matches
any single character from the list (but see below). If the list
begins with <literal>^</literal>, it matches any single character
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<emphasis>not</> from the rest of the list.
If two characters
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
in the list are separated by <literal>-</literal>, this is
shorthand for the full range of characters between those two
(inclusive) in the collating sequence,
e.g. <literal>[0-9]</literal> in <acronym>ASCII</acronym> matches
any decimal digit. It is illegal for two ranges to share an
endpoint, e.g. <literal>a-c-e</literal>. Ranges are very
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
collating-sequence-dependent, so portable programs should avoid
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
relying on them.
Minor updates for release.
1999-06-14 09:36:12 +02:00
</para>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Minor updates for release.
1999-06-14 09:36:12 +02:00
<para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
To include a literal <literal>]</literal> in the list, make it the
first character (following a possible <literal>^</literal>). To
include a literal <literal>-</literal>, make it the first or last
character, or the second endpoint of a range. To use a literal
<literal>-</literal> as the first endpoint of a range, enclose it
in <literal>[.</literal> and <literal>.]</literal> to make it a
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
collating element (see below). With the exception of these characters,
some combinations using <literal>[</literal>
(see next paragraphs), and escapes (AREs only), all other special
characters lose their special significance within a bracket expression.
In particular, <literal>\</literal> is not special when following
ERE or BRE rules, though it is special (as introducing an escape)
in AREs.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
<para>
Within a bracket expression, a collating element (a character, a
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
multiple-character sequence that collates as if it were a single
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
character, or a collating-sequence name for either) enclosed in
<literal>[.</literal> and <literal>.]</literal> stands for the
sequence of characters of that collating element. The sequence is
a single element of the bracket expression's list. A bracket
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
expression containing a multiple-character collating element can thus
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
match more than one character, e.g. if the collating sequence
includes a <literal>ch</literal> collating element, then the RE
<literal>[[.ch.]]*c</literal> matches the first five characters of
<literal>chchcc</literal>.
</para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<note>
<para>
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
<productname>PostgreSQL</> currently has no multicharacter collating
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
elements. This information describes possible future behavior.
</para>
</note>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Within a bracket expression, a collating element enclosed in
<literal>[=</literal> and <literal>=]</literal> is an equivalence
class, standing for the sequences of characters of all collating
elements equivalent to that one, including itself. (If there are
no other equivalent collating elements, the treatment is as if the
enclosing delimiters were <literal>[.</literal> and
<literal>.]</literal>.) For example, if <literal>o</literal> and
<literal>^</literal> are the members of an equivalence class, then
<literal>[[=o=]]</literal>, <literal>[[=^=]]</literal>, and
<literal>[o^]</literal> are all synonymous. An equivalence class
may not be an endpoint of a range.
</para>
<para>
Within a bracket expression, the name of a character class
enclosed in <literal>[:</literal> and <literal>:]</literal> stands
for the list of all characters belonging to that class. Standard
character class names are: <literal>alnum</literal>,
<literal>alpha</literal>, <literal>blank</literal>,
<literal>cntrl</literal>, <literal>digit</literal>,
<literal>graph</literal>, <literal>lower</literal>,
<literal>print</literal>, <literal>punct</literal>,
<literal>space</literal>, <literal>upper</literal>,
<literal>xdigit</literal>. These stand for the character classes
defined in
<citerefentry><refentrytitle>ctype</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
A locale may provide others. A character class may not be used as
an endpoint of a range.
</para>
<para>
There are two special cases of bracket expressions: the bracket
Add more documentation about CURRENT_TIMESTAMP. Also, code < and > as &lt;/&gt; for cleaner SGML.
2002-10-05 21:03:16 +02:00
expressions <literal>[[:&lt;:]]</literal> and
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<literal>[[:&gt;:]]</literal> are constraints,
matching empty strings at the beginning
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
and end of a word respectively. A word is defined as a sequence
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
of word characters that is neither preceded nor followed by word
characters. A word character is an <literal>alnum</> character (as
defined by
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<citerefentry><refentrytitle>ctype</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
or an underscore. This is an extension, compatible with but not
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
specified by <acronym>POSIX</acronym> 1003.2, and should be used with
caution in software intended to be portable to other systems.
The constraint escapes described below are usually preferable (they
are no more standard, but are certainly easier to type).
</para>
</sect3>
<sect3 id="posix-escape-sequences">
<title>Regular Expression Escapes</title>
<para>
<firstterm>Escapes</> are special sequences beginning with <literal>\</>
followed by an alphanumeric character. Escapes come in several varieties:
character entry, class shorthands, constraint escapes, and back references.
A <literal>\</> followed by an alphanumeric character but not constituting
a valid escape is illegal in AREs.
In EREs, there are no escapes: outside a bracket expression,
a <literal>\</> followed by an alphanumeric character merely stands for
that character as an ordinary character, and inside a bracket expression,
<literal>\</> is an ordinary character.
(The latter is the one actual incompatibility between EREs and AREs.)
</para>
<para>
<firstterm>Character-entry escapes</> exist to make it easier to specify
non-printing and otherwise inconvenient characters in REs. They are
shown in <xref linkend="posix-character-entry-escapes-table">.
</para>
<para>
<firstterm>Class-shorthand escapes</> provide shorthands for certain
commonly-used character classes. They are
shown in <xref linkend="posix-class-shorthand-escapes-table">.
</para>
<para>
A <firstterm>constraint escape</> is a constraint,
matching the empty string if specific conditions are met,
written as an escape. They are
shown in <xref linkend="posix-constraint-escapes-table">.
</para>
<para>
A <firstterm>back reference</> (<literal>\</><replaceable>n</>) matches the
same string matched by the previous parenthesized subexpression specified
by the number <replaceable>n</>
(see <xref linkend="posix-constraint-backref-table">). For example,
<literal>([bc])\1</> matches <literal>bb</> or <literal>cc</>
but not <literal>bc</> or <literal>cb</>.
The subexpression must entirely precede the back reference in the RE.
Subexpressions are numbered in the order of their leading parentheses.
Non-capturing parentheses do not define subexpressions.
</para>
<note>
<para>
Keep in mind that an escape's leading <literal>\</> will need to be
Please find enclosed a patch exemplifying typical use of the ARE Class-Shorthand Escapes<C2><AE>. I believe it will help intrepid regex users. :) David Fetter
2003-12-18 04:59:07 +01:00
doubled when entering the pattern as an SQL string constant. For example:
<programlisting>
'123' ~ '^\\d{3}' <lineannotation>true</lineannotation>
</programlisting>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</para>
</note>
<table id="posix-character-entry-escapes-table">
<title>Regular Expression Character-Entry Escapes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Escape</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>\a</> </entry>
<entry> alert (bell) character, as in C </entry>
</row>
<row>
<entry> <literal>\b</> </entry>
<entry> backspace, as in C </entry>
</row>
<row>
<entry> <literal>\B</> </entry>
<entry> synonym for <literal>\</> to help reduce the need for backslash
doubling </entry>
</row>
<row>
<entry> <literal>\c</><replaceable>X</> </entry>
<entry> (where <replaceable>X</> is any character) the character whose
low-order 5 bits are the same as those of
<replaceable>X</>, and whose other bits are all zero </entry>
</row>
<row>
<entry> <literal>\e</> </entry>
<entry> the character whose collating-sequence name
is <literal>ESC</>,
or failing that, the character with octal value 033 </entry>
</row>
<row>
<entry> <literal>\f</> </entry>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
<entry> form feed, as in C </entry>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</row>
<row>
<entry> <literal>\n</> </entry>
<entry> newline, as in C </entry>
</row>
<row>
<entry> <literal>\r</> </entry>
<entry> carriage return, as in C </entry>
</row>
<row>
<entry> <literal>\t</> </entry>
<entry> horizontal tab, as in C </entry>
</row>
<row>
<entry> <literal>\u</><replaceable>wxyz</> </entry>
<entry> (where <replaceable>wxyz</> is exactly four hexadecimal digits)
Rename canonical encodings, per Peter: UNICODE => UTF8 ALT => WIN866 WIN => WIN1251 TCVN => WIN1258 The old codes continue to work.
2005-03-07 05:30:55 +01:00
the UTF16 (Unicode, 16-bit) character <literal>U+</><replaceable>wxyz</>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
in the local byte ordering </entry>
</row>
<row>
<entry> <literal>\U</><replaceable>stuvwxyz</> </entry>
<entry> (where <replaceable>stuvwxyz</> is exactly eight hexadecimal
digits)
reserved for a somewhat-hypothetical Unicode extension to 32 bits
</entry>
</row>
<row>
<entry> <literal>\v</> </entry>
<entry> vertical tab, as in C </entry>
</row>
<row>
<entry> <literal>\x</><replaceable>hhh</> </entry>
<entry> (where <replaceable>hhh</> is any sequence of hexadecimal
digits)
the character whose hexadecimal value is
<literal>0x</><replaceable>hhh</>
(a single character no matter how many hexadecimal digits are used)
</entry>
</row>
<row>
<entry> <literal>\0</> </entry>
<entry> the character whose value is <literal>0</> </entry>
</row>
<row>
<entry> <literal>\</><replaceable>xy</> </entry>
<entry> (where <replaceable>xy</> is exactly two octal digits,
and is not a <firstterm>back reference</>)
the character whose octal value is
<literal>0</><replaceable>xy</> </entry>
</row>
<row>
<entry> <literal>\</><replaceable>xyz</> </entry>
<entry> (where <replaceable>xyz</> is exactly three octal digits,
and is not a <firstterm>back reference</>)
the character whose octal value is
<literal>0</><replaceable>xyz</> </entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Hexadecimal digits are <literal>0</>-<literal>9</>,
<literal>a</>-<literal>f</>, and <literal>A</>-<literal>F</>.
Octal digits are <literal>0</>-<literal>7</>.
</para>
<para>
The character-entry escapes are always taken as ordinary characters.
For example, <literal>\135</> is <literal>]</> in ASCII, but
<literal>\135</> does not terminate a bracket expression.
</para>
<table id="posix-class-shorthand-escapes-table">
<title>Regular Expression Class-Shorthand Escapes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Escape</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>\d</> </entry>
<entry> <literal>[[:digit:]]</> </entry>
</row>
<row>
<entry> <literal>\s</> </entry>
<entry> <literal>[[:space:]]</> </entry>
</row>
<row>
<entry> <literal>\w</> </entry>
<entry> <literal>[[:alnum:]_]</>
(note underscore is included) </entry>
</row>
<row>
<entry> <literal>\D</> </entry>
<entry> <literal>[^[:digit:]]</> </entry>
</row>
<row>
<entry> <literal>\S</> </entry>
<entry> <literal>[^[:space:]]</> </entry>
</row>
<row>
<entry> <literal>\W</> </entry>
<entry> <literal>[^[:alnum:]_]</>
(note underscore is included) </entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Within bracket expressions, <literal>\d</>, <literal>\s</>,
and <literal>\w</> lose their outer brackets,
and <literal>\D</>, <literal>\S</>, and <literal>\W</> are illegal.
(So, for example, <literal>[a-c\d]</> is equivalent to
<literal>[a-c[:digit:]]</>.
Also, <literal>[a-c\D]</>, which is equivalent to
<literal>[a-c^[:digit:]]</>, is illegal.)
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<table id="posix-constraint-escapes-table">
<title>Regular Expression Constraint Escapes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Escape</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>\A</> </entry>
<entry> matches only at the beginning of the string
(see <xref linkend="posix-matching-rules"> for how this differs from
<literal>^</>) </entry>
</row>
<row>
<entry> <literal>\m</> </entry>
<entry> matches only at the beginning of a word </entry>
</row>
<row>
<entry> <literal>\M</> </entry>
<entry> matches only at the end of a word </entry>
</row>
<row>
<entry> <literal>\y</> </entry>
<entry> matches only at the beginning or end of a word </entry>
</row>
<row>
<entry> <literal>\Y</> </entry>
<entry> matches only at a point that is not the beginning or end of a
word </entry>
</row>
<row>
<entry> <literal>\Z</> </entry>
<entry> matches only at the end of the string
(see <xref linkend="posix-matching-rules"> for how this differs from
<literal>$</>) </entry>
</row>
</tbody>
</tgroup>
</table>
<para>
A word is defined as in the specification of
<literal>[[:&lt;:]]</> and <literal>[[:&gt;:]]</> above.
Constraint escapes are illegal within bracket expressions.
</para>
<table id="posix-constraint-backref-table">
<title>Regular Expression Back References</title>
<tgroup cols="2">
<thead>
<row>
<entry>Escape</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>\</><replaceable>m</> </entry>
<entry> (where <replaceable>m</> is a nonzero digit)
a back reference to the <replaceable>m</>'th subexpression </entry>
</row>
<row>
<entry> <literal>\</><replaceable>mnn</> </entry>
<entry> (where <replaceable>m</> is a nonzero digit, and
<replaceable>nn</> is some more digits, and the decimal value
<replaceable>mnn</> is not greater than the number of closing capturing
parentheses seen so far)
a back reference to the <replaceable>mnn</>'th subexpression </entry>
</row>
</tbody>
</tgroup>
</table>
<note>
<para>
There is an inherent historical ambiguity between octal character-entry
escapes and back references, which is resolved by heuristics,
as hinted at above.
A leading zero always indicates an octal escape.
A single non-zero digit, not followed by another digit,
is always taken as a back reference.
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
A multidigit sequence not starting with a zero is taken as a back
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
reference if it comes after a suitable subexpression
(i.e. the number is in the legal range for a back reference),
and otherwise is taken as octal.
</para>
</note>
</sect3>
<sect3 id="posix-metasyntax">
<title>Regular Expression Metasyntax</title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
In addition to the main syntax described above, there are some special
forms and miscellaneous syntactic facilities available.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
<para>
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
Normally the flavor of RE being used is determined by
Consistenly lowercase GUC variable names, in docs and error messages.
2003-09-11 20:30:39 +02:00
<varname>regex_flavor</>.
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
However, this can be overridden by a <firstterm>director</> prefix.
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
If an RE begins with <literal>***:</>,
the rest of the RE is taken as an ARE regardless of
<varname>regex_flavor</>.
If an RE begins with <literal>***=</>,
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
the rest of the RE is taken to be a literal string,
with all characters considered ordinary characters.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
<para>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
An ARE may begin with <firstterm>embedded options</>:
a sequence <literal>(?</><replaceable>xyz</><literal>)</>
(where <replaceable>xyz</> is one or more alphabetic characters)
specifies options affecting the rest of the RE.
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
These options override any previously determined options (including
both the RE flavor and case sensitivity).
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
The available option letters are
shown in <xref linkend="posix-embedded-options-table">.
</para>
<table id="posix-embedded-options-table">
<title>ARE Embedded-Option Letters</title>
<tgroup cols="2">
<thead>
<row>
<entry>Option</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry> <literal>b</> </entry>
<entry> rest of RE is a BRE </entry>
</row>
<row>
<entry> <literal>c</> </entry>
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
<entry> case-sensitive matching (overrides operator type) </entry>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</row>
<row>
<entry> <literal>e</> </entry>
<entry> rest of RE is an ERE </entry>
</row>
<row>
<entry> <literal>i</> </entry>
<entry> case-insensitive matching (see
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
<xref linkend="posix-matching-rules">) (overrides operator type) </entry>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</row>
<row>
<entry> <literal>m</> </entry>
<entry> historical synonym for <literal>n</> </entry>
</row>
<row>
<entry> <literal>n</> </entry>
<entry> newline-sensitive matching (see
<xref linkend="posix-matching-rules">) </entry>
</row>
<row>
<entry> <literal>p</> </entry>
<entry> partial newline-sensitive matching (see
<xref linkend="posix-matching-rules">) </entry>
</row>
<row>
<entry> <literal>q</> </entry>
<entry> rest of RE is a literal (<quote>quoted</>) string, all ordinary
characters </entry>
</row>
<row>
<entry> <literal>s</> </entry>
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
<entry> non-newline-sensitive matching (default) </entry>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</row>
<row>
<entry> <literal>t</> </entry>
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
<entry> tight syntax (default; see below) </entry>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</row>
<row>
<entry> <literal>w</> </entry>
<entry> inverse partial newline-sensitive (<quote>weird</>) matching
(see <xref linkend="posix-matching-rules">) </entry>
</row>
<row>
<entry> <literal>x</> </entry>
<entry> expanded syntax (see below) </entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Embedded options take effect at the <literal>)</> terminating the sequence.
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
They may appear only at the start of an ARE (after the
<literal>***:</> director if any).
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</para>
<para>
In addition to the usual (<firstterm>tight</>) RE syntax, in which all
characters are significant, there is an <firstterm>expanded</> syntax,
available by specifying the embedded <literal>x</> option.
In the expanded syntax,
white-space characters in the RE are ignored, as are
all characters between a <literal>#</>
and the following newline (or the end of the RE). This
permits paragraphing and commenting a complex RE.
There are three exceptions to that basic rule:
<itemizedlist>
<listitem>
<para>
a white-space character or <literal>#</> preceded by <literal>\</> is
retained
</para>
</listitem>
<listitem>
<para>
white space or <literal>#</> within a bracket expression is retained
</para>
</listitem>
<listitem>
<para>
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
white space and comments cannot appear within multicharacter symbols,
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
such as <literal>(?:</>
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</para>
</listitem>
</itemizedlist>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
For this purpose, white-space characters are blank, tab, newline, and
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
any character that belongs to the <replaceable>space</> character class.
</para>
<para>
Finally, in an ARE, outside bracket expressions, the sequence
<literal>(?#</><replaceable>ttt</><literal>)</>
(where <replaceable>ttt</> is any text not containing a <literal>)</>)
is a comment, completely ignored.
Again, this is not allowed between the characters of
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
multicharacter symbols, like <literal>(?:</>.
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
Such comments are more a historical artifact than a useful facility,
and their use is deprecated; use the expanded syntax instead.
</para>
<para>
<emphasis>None</> of these metasyntax extensions is available if
an initial <literal>***=</> director
has specified that the user's input be treated as a literal string
rather than as an RE.
</para>
</sect3>
<sect3 id="posix-matching-rules">
<title>Regular Expression Matching Rules</title>
<para>
In the event that an RE could match more than one substring of a given
string, the RE matches the one starting earliest in the string.
If the RE could match more than one substring starting at that point,
Clarify description of greedy and non-greedy POSIX regular expressions, per discussion in Nov 2004 with Ken Tanzer.
2005-01-09 21:08:50 +01:00
either the longest possible match or the shortest possible match will
be taken, depending on whether the RE is <firstterm>greedy</> or
<firstterm>non-greedy</>.
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</para>
<para>
Clarify description of greedy and non-greedy POSIX regular expressions, per discussion in Nov 2004 with Ken Tanzer.
2005-01-09 21:08:50 +01:00
Whether an RE is greedy or not is determined by the following rules:
<itemizedlist>
<listitem>
<para>
Most atoms, and all constraints, have no greediness attribute (because
they cannot match variable amounts of text anyway).
</para>
</listitem>
<listitem>
<para>
Adding parentheses around an RE does not change its greediness.
</para>
</listitem>
<listitem>
<para>
A quantified atom with a fixed-repetition quantifier
(<literal>{</><replaceable>m</><literal>}</>
or
<literal>{</><replaceable>m</><literal>}?</>)
has the same greediness (possibly none) as the atom itself.
</para>
</listitem>
<listitem>
<para>
A quantified atom with other normal quantifiers (including
<literal>{</><replaceable>m</><literal>,</><replaceable>n</><literal>}</>
with <replaceable>m</> equal to <replaceable>n</>)
is greedy (prefers longest match).
</para>
</listitem>
<listitem>
<para>
A quantified atom with a non-greedy quantifier (including
<literal>{</><replaceable>m</><literal>,</><replaceable>n</><literal>}?</>
with <replaceable>m</> equal to <replaceable>n</>)
is non-greedy (prefers shortest match).
</para>
</listitem>
<listitem>
<para>
A branch &mdash; that is, an RE that has no top-level
<literal>|</> operator &mdash; has the same greediness as the first
quantified atom in it that has a greediness attribute.
</para>
</listitem>
<listitem>
<para>
An RE consisting of two or more branches connected by the
<literal>|</> operator is always greedy.
</para>
</listitem>
</itemizedlist>
</para>
<para>
The above rules associate greediness attributes not only with individual
quantified atoms, but with branches and entire REs that contain quantified
atoms. What that means is that the matching is done in such a way that
the branch, or whole RE, matches the longest or shortest possible
substring <emphasis>as a whole</>. Once the length of the entire match
is determined, the part of it that matches any particular subexpression
is determined on the basis of the greediness attribute of that
subexpression, with subexpressions starting earlier in the RE taking
priority over ones starting later.
</para>
<para>
An example of what this means:
<screen>
SELECT SUBSTRING('XY1234Z', 'Y*([0-9]{1,3})');
<lineannotation>Result: </lineannotation><computeroutput>123</computeroutput>
SELECT SUBSTRING('XY1234Z', 'Y*?([0-9]{1,3})');
<lineannotation>Result: </lineannotation><computeroutput>1</computeroutput>
</screen>
In the first case, the RE as a whole is greedy because <literal>Y*</>
is greedy. It can match beginning at the <literal>Y</>, and it matches
the longest possible string starting there, i.e., <literal>Y123</>.
The output is the parenthesized part of that, or <literal>123</>.
In the second case, the RE as a whole is non-greedy because <literal>Y*?</>
is non-greedy. It can match beginning at the <literal>Y</>, and it matches
the shortest possible string starting there, i.e., <literal>Y1</>.
The subexpression <literal>[0-9]{1,3}</> is greedy but it cannot change
the decision as to the overall match length; so it is forced to match
just <literal>1</>.
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</para>
<para>
Clarify description of greedy and non-greedy POSIX regular expressions, per discussion in Nov 2004 with Ken Tanzer.
2005-01-09 21:08:50 +01:00
In short, when an RE contains both greedy and non-greedy subexpressions,
the total match length is either as long as possible or as short as
possible, according to the attribute assigned to the whole RE. The
attributes assigned to the subexpressions only affect how much of that
match they are allowed to <quote>eat</> relative to each other.
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</para>
<para>
The quantifiers <literal>{1,1}</> and <literal>{1,1}?</>
Clarify description of greedy and non-greedy POSIX regular expressions, per discussion in Nov 2004 with Ken Tanzer.
2005-01-09 21:08:50 +01:00
can be used to force greediness or non-greediness, respectively,
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
on a subexpression or a whole RE.
</para>
<para>
Match lengths are measured in characters, not collating elements.
An empty string is considered longer than no match at all.
For example:
<literal>bb*</>
matches the three middle characters of <literal>abbbc</>;
<literal>(week|wee)(night|knights)</>
matches all ten characters of <literal>weeknights</>;
when <literal>(.*).*</>
is matched against <literal>abc</> the parenthesized subexpression
matches all three characters; and when
<literal>(a*)*</> is matched against <literal>bc</>
both the whole RE and the parenthesized
subexpression match an empty string.
</para>
<para>
If case-independent matching is specified,
the effect is much as if all case distinctions had vanished from the
alphabet.
When an alphabetic that exists in multiple cases appears as an
ordinary character outside a bracket expression, it is effectively
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
transformed into a bracket expression containing both cases,
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
e.g. <literal>x</> becomes <literal>[xX]</>.
When it appears inside a bracket expression, all case counterparts
of it are added to the bracket expression, e.g.
<literal>[x]</> becomes <literal>[xX]</>
and <literal>[^x]</> becomes <literal>[^xX]</>.
</para>
<para>
If newline-sensitive matching is specified, <literal>.</>
and bracket expressions using <literal>^</>
will never match the newline character
(so that matches will never cross newlines unless the RE
explicitly arranges it)
and <literal>^</>and <literal>$</>
will match the empty string after and before a newline
respectively, in addition to matching at beginning and end of string
respectively.
But the ARE escapes <literal>\A</> and <literal>\Z</>
continue to match beginning or end of string <emphasis>only</>.
</para>
<para>
If partial newline-sensitive matching is specified,
this affects <literal>.</> and bracket expressions
as with newline-sensitive matching, but not <literal>^</>
and <literal>$</>.
</para>
<para>
If inverse partial newline-sensitive matching is specified,
this affects <literal>^</> and <literal>$</>
as with newline-sensitive matching, but not <literal>.</>
and bracket expressions.
This isn't very useful but is provided for symmetry.
</para>
</sect3>
<sect3 id="posix-limits-compatibility">
<title>Limits and Compatibility</title>
<para>
No particular limit is imposed on the length of REs in this
implementation. However,
programs intended to be highly portable should not employ REs longer
than 256 bytes,
as a POSIX-compliant implementation can refuse to accept such REs.
</para>
<para>
The only feature of AREs that is actually incompatible with
POSIX EREs is that <literal>\</> does not lose its special
significance inside bracket expressions.
All other ARE features use syntax which is illegal or has
undefined or unspecified effects in POSIX EREs;
the <literal>***</> syntax of directors likewise is outside the POSIX
syntax for both BREs and EREs.
</para>
<para>
Many of the ARE extensions are borrowed from Perl, but some have
been changed to clean them up, and a few Perl extensions are not present.
Incompatibilities of note include <literal>\b</>, <literal>\B</>,
the lack of special treatment for a trailing newline,
the addition of complemented bracket expressions to the things
affected by newline-sensitive matching,
the restrictions on parentheses and back references in lookahead
constraints, and the longest/shortest-match (rather than first-match)
matching semantics.
</para>
<para>
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
Two significant incompatibilities exist between AREs and the ERE syntax
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
recognized by pre-7.4 releases of <productname>PostgreSQL</>:
<itemizedlist>
<listitem>
<para>
In AREs, <literal>\</> followed by an alphanumeric character is either
an escape or an error, while in previous releases, it was just another
way of writing the alphanumeric.
This should not be much of a problem because there was no reason to
write such a sequence in earlier releases.
</para>
</listitem>
<listitem>
<para>
In AREs, <literal>\</> remains a special character within
<literal>[]</>, so a literal <literal>\</> within a bracket
expression must be written <literal>\\</>.
</para>
</listitem>
</itemizedlist>
Create a GUC variable REGEX_FLAVOR to control the type of regular expression accepted by the regex operators, per discussion yesterday. Along the way, reduce deadlock_timeout from PGC_POSTMASTER to PGC_SIGHUP category. It is probably best to insist that all backends share the same setting, but that doesn't mean it has to be frozen at startup.
2003-02-06 21:25:33 +01:00
While these differences are unlikely to create a problem for most
applications, you can avoid them if necessary by
Consistenly lowercase GUC variable names, in docs and error messages.
2003-09-11 20:30:39 +02:00
setting <varname>regex_flavor</> to <literal>extended</>.
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
</para>
</sect3>
<sect3 id="posix-basic-regexes">
<title>Basic Regular Expressions</title>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Replace regular expression package with Henry Spencer's latest version (extracted from Tcl 8.4.1 release, as Henry still hasn't got round to making it a separate library). This solves a performance problem for multibyte, as well as upgrading our regexp support to match recent Tcl and nearly match recent Perl.
2003-02-05 18:41:33 +01:00
<para>
BREs differ from EREs in several respects.
<literal>|</>, <literal>+</>, and <literal>?</>
are ordinary characters and there is no equivalent
for their functionality.
The delimiters for bounds are
<literal>\{</> and <literal>\}</>,
with <literal>{</> and <literal>}</>
by themselves ordinary characters.
The parentheses for nested subexpressions are
<literal>\(</> and <literal>\)</>,
with <literal>(</> and <literal>)</> by themselves ordinary characters.
<literal>^</> is an ordinary character except at the beginning of the
RE or the beginning of a parenthesized subexpression,
<literal>$</> is an ordinary character except at the end of the
RE or the end of a parenthesized subexpression,
and <literal>*</> is an ordinary character if it appears at the beginning
of the RE or the beginning of a parenthesized subexpression
(after a possible leading <literal>^</>).
Finally, single-digit back references are available, and
<literal>\&lt;</> and <literal>\&gt;</>
are synonyms for
<literal>[[:&lt;:]]</> and <literal>[[:&gt;:]]</>
respectively; no other escapes are available.
</para>
</sect3>
<!-- end re_syntax.n man page -->
</sect2>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</sect1>
<sect1 id="functions-formatting">
Bunch of copy fitting and style sheet tweakage to get decent looking print output (from pdfjadetex). Also updated instructions to install documentation processing toolchain.
2001-10-09 20:46:00 +02:00
<title>Data Type Formatting Functions</title>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
<primary>formatting</primary>
</indexterm>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>to_char</primary>
</indexterm>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>to_date</primary>
</indexterm>
<indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>to_number</primary>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
</indexterm>
<indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>to_timestamp</primary>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
</indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<para>
Deprecate 'current' for date/time input. Fix up references to "PostgreSQL" rather than "Postgres". Was roughly evenly split between the two before. ref/ files not yet done.
2001-11-21 06:53:41 +01:00
The <productname>PostgreSQL</productname> formatting functions
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
provide a powerful set of tools for converting various data types
(date/time, integer, floating point, numeric) to formatted strings
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
and for converting from formatted strings to specific data types.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<xref linkend="functions-formatting-table"> lists them.
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
These functions all follow a common calling convention: the first
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
argument is the value to be formatted and the second argument is a
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
template that defines the output or input format.
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</para>
Please find attached a patch (diff -c against cvs HEAD) to add a function that accepts a double precision argument assumed to be a Unix epoch timestamp and returns timestamp with time zone, and accompanying documentation. Usage: test=# select to_timestamp(200120400); to_timestamp ------------------------ 1976-05-05 14:00:00+09 (1 row) Michael Glaesemann
2005-06-09 18:35:09 +02:00
<para>
The <function>to_timestamp</function> function can also take a single
<type>double precision</type> argument to convert from Unix epoch to
<type>timestamp with time zone</type>.
(<type>Integer</type> Unix epochs are implicitly cast to
<type>double precision</type>.)
</para>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<table id="functions-formatting-table">
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<title>Formatting Functions</title>
<tgroup cols="4">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>to_char</function>(<type>timestamp</type>, <type>text</type>)</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>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>to_char</function>(<type>interval</type>, <type>text</type>)</literal></entry>
<entry><type>text</type></entry>
<entry>convert interval to string</entry>
<entry><literal>to_char(interval '15h&nbsp;2m&nbsp;12s', 'HH24:MI:SS')</literal></entry>
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>to_char</function>(<type>int</type>, <type>text</type>)</literal></entry>
<entry><type>text</type></entry>
<entry>convert integer to string</entry>
<entry><literal>to_char(125, '999')</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>to_char</function>(<type>double precision</type>,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<type>text</type>)</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>text</type></entry>
<entry>convert real/double precision to string</entry>
<entry><literal>to_char(125.8::real, '999D9')</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>to_char</function>(<type>numeric</type>, <type>text</type>)</literal></entry>
<entry><type>text</type></entry>
<entry>convert numeric to string</entry>
<entry><literal>to_char(-125.8, '999D99S')</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>to_date</function>(<type>text</type>, <type>text</type>)</literal></entry>
<entry><type>date</type></entry>
<entry>convert string to date</entry>
<entry><literal>to_date('05&nbsp;Dec&nbsp;2000', 'DD&nbsp;Mon&nbsp;YYYY')</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>to_number</function>(<type>text</type>, <type>text</type>)</literal></entry>
<entry><type>numeric</type></entry>
<entry>convert string to numeric</entry>
<entry><literal>to_number('12,454.8-', '99G999D9S')</literal></entry>
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>to_timestamp</function>(<type>text</type>, <type>text</type>)</literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>convert string to time stamp</entry>
<entry><literal>to_timestamp('05&nbsp;Dec&nbsp;2000', 'DD&nbsp;Mon&nbsp;YYYY')</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
Please find attached a patch (diff -c against cvs HEAD) to add a function that accepts a double precision argument assumed to be a Unix epoch timestamp and returns timestamp with time zone, and accompanying documentation. Usage: test=# select to_timestamp(200120400); to_timestamp ------------------------ 1976-05-05 14:00:00+09 (1 row) Michael Glaesemann
2005-06-09 18:35:09 +02:00
<row>
<entry><literal><function>to_timestamp</function>(<type>double precision</type>)</literal></entry>
<entry><type>timestamp with time zone</type></entry>
<entry>convert UNIX epoch to time stamp</entry>
<entry><literal>to_timestamp(200120400)</literal></entry>
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</tbody>
</tgroup>
</table>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
In an output template string (for <function>to_char</>), there are certain patterns that are
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
recognized and replaced with appropriately-formatted data from the value
to be formatted. Any text that is not a template pattern is simply
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
copied verbatim. Similarly, in an input template string (for anything but <function>to_char</>), template patterns
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
identify the parts of the input data string to be looked at and the
values to be found there.
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="functions-formatting-datetime-table"> shows the
template patterns available for formatting date and time values.
</para>
<table id="functions-formatting-datetime-table">
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title>Template Patterns for Date/Time Formatting</title>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<tgroup cols="2">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Pattern</entry>
<entry>Description</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>HH</literal></entry>
<entry>hour of day (01-12)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>HH12</literal></entry>
<entry>hour of day (01-12)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
Fixups in content and markup for 7.0 release.
2000-05-02 22:02:03 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>HH24</literal></entry>
<entry>hour of day (00-23)</entry>
Fixups in content and markup for 7.0 release.
2000-05-02 22:02:03 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>MI</literal></entry>
<entry>minute (00-59)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>SS</literal></entry>
<entry>second (00-59)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>MS</literal></entry>
<entry>millisecond (000-999)</entry>
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>US</literal></entry>
<entry>microsecond (000000-999999)</entry>
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>SSSS</literal></entry>
<entry>seconds past midnight (0-86399)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
Update create_rule manual page.
2000-04-07 21:17:51 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>AM</literal> or <literal>A.M.</literal> or
<literal>PM</literal> or <literal>P.M.</literal></entry>
<entry>meridian indicator (uppercase)</entry>
Update create_rule manual page.
2000-04-07 21:17:51 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>am</literal> or <literal>a.m.</literal> or
<literal>pm</literal> or <literal>p.m.</literal></entry>
<entry>meridian indicator (lowercase)</entry>
Update create_rule manual page.
2000-04-07 21:17:51 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>Y,YYY</literal></entry>
<entry>year (4 and more digits) with comma</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>YYYY</literal></entry>
<entry>year (4 and more digits)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>YYY</literal></entry>
<entry>last 3 digits of year</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>YY</literal></entry>
<entry>last 2 digits of year</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>Y</literal></entry>
<entry>last digit of year</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
> > I have no idea if this in Oracle or not. But it's something I > > needed, and other people in the past asked about it too. > > It is in Oracle, but you aren't exactly on the spot. It should be > > IYYY - 4 digits ('2003') > IYY - 3 digits ('003') > IY - 2 digits ('03') > I - 1 digit ('3') Here is an updated patch that does that. Kurt Roeckx
2003-12-25 04:36:24 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>IYYY</literal></entry>
<entry>ISO year (4 and more digits)</entry>
> > I have no idea if this in Oracle or not. But it's something I > > needed, and other people in the past asked about it too. > > It is in Oracle, but you aren't exactly on the spot. It should be > > IYYY - 4 digits ('2003') > IYY - 3 digits ('003') > IY - 2 digits ('03') > I - 1 digit ('3') Here is an updated patch that does that. Kurt Roeckx
2003-12-25 04:36:24 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>IYY</literal></entry>
<entry>last 3 digits of ISO year</entry>
> > I have no idea if this in Oracle or not. But it's something I > > needed, and other people in the past asked about it too. > > It is in Oracle, but you aren't exactly on the spot. It should be > > IYYY - 4 digits ('2003') > IYY - 3 digits ('003') > IY - 2 digits ('03') > I - 1 digit ('3') Here is an updated patch that does that. Kurt Roeckx
2003-12-25 04:36:24 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>IY</literal></entry>
<entry>last 2 digits of ISO year</entry>
> > I have no idea if this in Oracle or not. But it's something I > > needed, and other people in the past asked about it too. > > It is in Oracle, but you aren't exactly on the spot. It should be > > IYYY - 4 digits ('2003') > IYY - 3 digits ('003') > IY - 2 digits ('03') > I - 1 digit ('3') Here is an updated patch that does that. Kurt Roeckx
2003-12-25 04:36:24 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>I</literal></entry>
<entry>last digits of ISO year</entry>
> > I have no idea if this in Oracle or not. But it's something I > > needed, and other people in the past asked about it too. > > It is in Oracle, but you aren't exactly on the spot. It should be > > IYYY - 4 digits ('2003') > IYY - 3 digits ('003') > IY - 2 digits ('03') > I - 1 digit ('3') Here is an updated patch that does that. Kurt Roeckx
2003-12-25 04:36:24 +01:00
</row>
Update create_rule manual page.
2000-04-07 21:17:51 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>BC</literal> or <literal>B.C.</literal> or
<literal>AD</literal> or <literal>A.D.</literal></entry>
<entry>era indicator (uppercase)</entry>
Update create_rule manual page.
2000-04-07 21:17:51 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>bc</literal> or <literal>b.c.</literal> or
<literal>ad</literal> or <literal>a.d.</literal></entry>
<entry>era indicator (lowercase)</entry>
Update create_rule manual page.
2000-04-07 21:17:51 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>MONTH</literal></entry>
<entry>full uppercase month name (blank-padded to 9 chars)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>Month</literal></entry>
<entry>full mixed-case month name (blank-padded to 9 chars)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>month</literal></entry>
<entry>full lowercase month name (blank-padded to 9 chars)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>MON</literal></entry>
For to_char() day/month abbrevitions, mention "3 chars in English, localized lengths vary".
2006-11-20 21:20:18 +01:00
<entry>abbreviated uppercase month name (3 chars in English, localized lengths vary)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>Mon</literal></entry>
For to_char() day/month abbrevitions, mention "3 chars in English, localized lengths vary".
2006-11-20 21:20:18 +01:00
<entry>abbreviated mixed-case month name (3 chars in English, localized lengths vary)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>mon</literal></entry>
For to_char() day/month abbrevitions, mention "3 chars in English, localized lengths vary".
2006-11-20 21:20:18 +01:00
<entry>abbreviated lowercase month name (3 chars in English, localized lengths vary)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>MM</literal></entry>
<entry>month number (01-12)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>DAY</literal></entry>
<entry>full uppercase day name (blank-padded to 9 chars)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>Day</literal></entry>
<entry>full mixed-case day name (blank-padded to 9 chars)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>day</literal></entry>
<entry>full lowercase day name (blank-padded to 9 chars)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>DY</literal></entry>
For to_char() day/month abbrevitions, mention "3 chars in English, localized lengths vary".
2006-11-20 21:20:18 +01:00
<entry>abbreviated uppercase day name (3 chars in English, localized lengths vary)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>Dy</literal></entry>
For to_char() day/month abbrevitions, mention "3 chars in English, localized lengths vary".
2006-11-20 21:20:18 +01:00
<entry>abbreviated mixed-case day name (3 chars in English, localized lengths vary)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>dy</literal></entry>
For to_char() day/month abbrevitions, mention "3 chars in English, localized lengths vary".
2006-11-20 21:20:18 +01:00
<entry>abbreviated lowercase day name (3 chars in English, localized lengths vary)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>DDD</literal></entry>
<entry>day of year (001-366)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>DD</literal></entry>
<entry>day of month (01-31)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>D</literal></entry>
<entry>day of week (1-7; Sunday is 1)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>W</literal></entry>
<entry>week of month (1-5) (The first week starts on the first day of the month.)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>WW</literal></entry>
<entry>week number of year (1-53) (The first week starts on the first day of the year.)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
* to_char: - full support for IW (ISO week) and vice versa conversion for IW too (the to_char 'week' support is now complete and I hope correct). Thomas, I use for IW code from timestamp.c, for this I create separate function date2isoweek() from original 'case DTK_WEEK:' code in the timestamp_part(). I mean will better use one code for same feature in date_part() and in to_char(). The isoweek2date() is added to timestamp.c too. Right? IMHO in 7.1 will all to_char's features complete. It is cca 41 templates for date/time and cca 21 for numbers. * to_ascii: - gcc, is it correct now? :-) In the patch is documentation for to_char's IW and for to_ascii(). Karel
2000-08-29 06:41:48 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>IW</literal></entry>
<entry>ISO week number of year (The first Thursday of the new year is in week 1.)</entry>
* to_char: - full support for IW (ISO week) and vice versa conversion for IW too (the to_char 'week' support is now complete and I hope correct). Thomas, I use for IW code from timestamp.c, for this I create separate function date2isoweek() from original 'case DTK_WEEK:' code in the timestamp_part(). I mean will better use one code for same feature in date_part() and in to_char(). The isoweek2date() is added to timestamp.c too. Right? IMHO in 7.1 will all to_char's features complete. It is cca 41 templates for date/time and cca 21 for numbers. * to_ascii: - gcc, is it correct now? :-) In the patch is documentation for to_char's IW and for to_ascii(). Karel
2000-08-29 06:41:48 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>CC</literal></entry>
Fix handling of CC (century) format spec in to_date/to_char. According to standard convention the 21st century runs from 2001-2100, not 2000-2099, so make it work like that. Per bug #2885 from Akio Iwaasa. Backpatch to 8.2, but no further, since this is really a definitional change; users of older branches are probably more interested in stability.
2007-01-13 00:34:55 +01:00
<entry>century (2 digits) (The twenty-first century starts on 2001-01-01.)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>J</literal></entry>
<entry>Julian Day (days since January 1, 4712 BC)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>Q</literal></entry>
<entry>quarter</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>RM</literal></entry>
<entry>month in Roman numerals (I-XII; I=January) (uppercase)</entry>
Update create_rule manual page.
2000-04-07 21:17:51 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>rm</literal></entry>
<entry>month in Roman numerals (i-xii; i=January) (lowercase)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
In the attache is new (correct) version. I add TZ (timezone) support for to_char() too. Karel
2000-07-03 18:01:33 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>TZ</literal></entry>
<entry>time-zone name (uppercase)</entry>
In the attache is new (correct) version. I add TZ (timezone) support for to_char() too. Karel
2000-07-03 18:01:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>tz</literal></entry>
<entry>time-zone name (lowercase)</entry>
In the attache is new (correct) version. I add TZ (timezone) support for to_char() too. Karel
2000-07-03 18:01:33 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</tbody>
</tgroup>
</table>
<para>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
Certain modifiers may be applied to any template pattern to alter its
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
behavior. For example, <literal>FMMonth</literal>
is the <literal>Month</literal> pattern with the
<literal>FM</literal> modifier.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<xref linkend="functions-formatting-datetimemod-table"> shows the
modifier patterns for date/time formatting.
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<table id="functions-formatting-datetimemod-table">
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title>Template Pattern Modifiers for Date/Time Formatting</title>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<tgroup cols="3">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Modifier</entry>
<entry>Description</entry>
<entry>Example</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>FM</literal> prefix</entry>
<entry>fill mode (suppress padding blanks and zeroes)</entry>
<entry><literal>FMMonth</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>TH</literal> suffix</entry>
<entry>uppercase ordinal number suffix</entry>
<entry><literal>DDTH</literal></entry>
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>th</literal> suffix</entry>
<entry>lowercase ordinal number suffix</entry>
<entry><literal>DDth</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>FX</literal> prefix</entry>
<entry>fixed format global option (see usage notes)</entry>
<entry><literal>FX&nbsp;Month&nbsp;DD&nbsp;Day</literal></entry>
</row>
Allow to_char() to print localized month and day names. Euler Taveira de Oliveira
2006-02-12 05:44:15 +01:00
<row>
<entry><literal>TM</literal> prefix</entry>
Document that to_char() "TM" is controlled by lc_messages.
2006-11-25 01:38:53 +01:00
<entry>translation mode (print localized day and month names based on <varname>lc_messages</>)</entry>
Allow to_char() to print localized month and day names. Euler Taveira de Oliveira
2006-02-12 05:44:15 +01:00
<entry><literal>TMMonth</literal></entry>
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>SP</literal> suffix</entry>
<entry>spell mode (not yet implemented)</entry>
<entry><literal>DDSP</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</tbody>
</tgroup>
</table>
<para>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
Usage notes for date/time formatting:
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<itemizedlist>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
<listitem>
<para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<literal>FM</literal> suppresses leading zeroes and trailing blanks
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
that would otherwise be added to make the output of a pattern be
fixed-width.
</para>
</listitem>
Allow to_char() to print localized month and day names. Euler Taveira de Oliveira
2006-02-12 05:44:15 +01:00
<listitem>
<para>
<literal>TM</literal> does not include trailing blanks.
</para>
</listitem>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<listitem>
<para>
<function>to_timestamp</function> and <function>to_date</function>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
skip multiple blank spaces in the input string if the <literal>FX</literal> option
In the attache is new (correct) version. I add TZ (timezone) support for to_char() too. Karel
2000-07-03 18:01:33 +02:00
is not used. <literal>FX</literal> must be specified as the first item
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
in the template. For example
<literal>to_timestamp('2000&nbsp;&nbsp;&nbsp;&nbsp;JUN', 'YYYY MON')</literal> is correct, but
<literal>to_timestamp('2000&nbsp;&nbsp;&nbsp;&nbsp;JUN', 'FXYYYY MON')</literal> returns an error,
because <function>to_timestamp</function> expects one space only.
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</para>
</listitem>
<listitem>
<para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Ordinary text is allowed in <function>to_char</function>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
templates and will be output literally. You can put a substring
in double quotes to force it to be interpreted as literal text
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
even if it contains pattern key words. For example, in
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<literal>'"Hello Year "YYYY'</literal>, the <literal>YYYY</literal>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
will be replaced by the year data, but the single <literal>Y</literal> in <literal>Year</literal>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
will not be.
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</para>
</listitem>
<listitem>
<para>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
If you want to have a double quote in the output you must
precede it with a backslash, for example <literal>'\\"YYYY
Month\\"'</literal>. <!-- "" font-lock sanity :-) -->
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
(Two backslashes are necessary because the backslash already
has a special meaning in a string constant.)
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</para>
</listitem>
here is a patch for formatting.c (to_char/timestampt()), for 7.1 it fixing Y,YY,YYY,YYYY conversion, the docs and regress tests update are included too. During the patch testing I found small bug in miscadmin.h in convertstr() declaration. Here it's fixed too. Thanks Karel
2000-11-25 06:00:33 +01:00
<listitem>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The <literal>YYYY</literal> conversion from string to <type>timestamp</type> or
<type>date</type> has a restriction if you use a year with more than 4 digits. You must
Repair markup
2000-11-25 14:20:05 +01:00
use some non-digit character or template after <literal>YYYY</literal>,
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
otherwise the year is always interpreted as 4 digits. For example
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
(with the year 20000):
Repair markup
2000-11-25 14:20:05 +01:00
<literal>to_date('200001131', 'YYYYMMDD')</literal> will be
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
interpreted as a 4-digit year; instead use a non-digit
Repair markup
2000-11-25 14:20:05 +01:00
separator after the year, like
<literal>to_date('20000-1131', 'YYYY-MMDD')</literal> or
<literal>to_date('20000Nov31', 'YYYYMonDD')</literal>.
here is a patch for formatting.c (to_char/timestampt()), for 7.1 it fixing Y,YY,YYY,YYYY conversion, the docs and regress tests update are included too. During the patch testing I found small bug in miscadmin.h in convertstr() declaration. Here it's fixed too. Thanks Karel
2000-11-25 06:00:33 +01:00
</para>
Fix to_date to behave reasonably when CC and YY fields are both used. Karel Zak
2005-03-25 17:08:40 +01:00
</listitem>
<listitem>
<para>
In conversions from string to <type>timestamp</type> or
<type>date</type>, the <literal>CC</literal> field is ignored if there
is a <literal>YYY</literal>, <literal>YYYY</literal> or
<literal>Y,YYY</literal> field. If <literal>CC</literal> is used with
<literal>YY</literal> or <literal>Y</literal> then the year is computed
as <literal>(CC-1)*100+YY</literal>.
</para>
here is a patch for formatting.c (to_char/timestampt()), for 7.1 it fixing Y,YY,YYY,YYYY conversion, the docs and regress tests update are included too. During the patch testing I found small bug in miscadmin.h in convertstr() declaration. Here it's fixed too. Thanks Karel
2000-11-25 06:00:33 +01:00
</listitem>
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
<listitem>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Millisecond (<literal>MS</literal>) and microsecond (<literal>US</literal>)
values in a conversion from string to <type>timestamp</type> are used as part of the
proof-reading
2001-11-28 21:49:10 +01:00
seconds after the decimal point. For example
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
<literal>to_timestamp('12:3', 'SS:MS')</literal> is not 3 milliseconds,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
but 300, because the conversion counts it as 12 + 0.3 seconds.
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
This means for the format <literal>SS:MS</literal>, the input values
<literal>12:3</literal>, <literal>12:30</literal>, and <literal>12:300</literal> specify the
proof-reading
2001-11-28 21:49:10 +01:00
same number of milliseconds. To get three milliseconds, one must use
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<literal>12:003</literal>, which the conversion counts as
proof-reading
2001-11-28 21:49:10 +01:00
12 + 0.003 = 12.003 seconds.
</para>
<para>
Here is a more
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
complex example:
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal>to_timestamp('15:12:02.020.001230', 'HH:MI:SS.MS.US')</literal>
proof-reading
2001-11-28 21:49:10 +01:00
is 15 hours, 12 minutes, and 2 seconds + 20 milliseconds +
1230 microseconds = 2.021230 seconds.
- new to_char(interval, text) - new millisecond (ms) and microsecond (us) support - more robus parsing from string - used is separator checking for non-exact formats like to_date('2001-9-1', 'YYYY-MM-DD') - SGML docs are included Karel Zak
2001-09-06 05:22:42 +02:00
</para>
</listitem>
I was recently surprised to find that EXTRACT's day of the week numbering is different than TO_CHAR's ditto. EXTRACT starts at 0==Sunday while TO_CHAR starts at 1==Sunday. A suggestion for two documentation notes is attached as a patch to current CVS HEAD. Troels Arvin
2004-12-21 02:02:28 +01:00
<listitem>
<para><function>to_char</function>'s day of the week numbering
(see the 'D' formatting pattern) is different from that of the
<function>extract</function> function.
</para>
</listitem>
Allow to_char(interval) and to_char(time) to use AM/PM specifications. Map them to a single day, so '30 hours' is 'AM'. Have to_char(interval) and to_char(time) use "HH", "HH12" as 12-hour intervals, rather than bypass and print the full interval hours. This is neeeded because to_char(time) is mapped to interval in this function. Intervals should use "HH24", and document suggestion. Allow "D" format specifiers for interval/time.
2005-12-03 17:45:06 +01:00
<listitem>
<para><function>to_char(interval)</function> formats <literal>HH</> and
<literal>HH12</> as hours in a single day, while <literal>HH24</>
can output hours exceeding a single day, e.g. &gt;24.
</para>
</listitem>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</itemizedlist>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</para>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="functions-formatting-numeric-table"> shows the
template patterns available for formatting numeric values.
</para>
<table id="functions-formatting-numeric-table">
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title>Template Patterns for Numeric Formatting</title>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<tgroup cols="2">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Pattern</entry>
<entry>Description</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>9</literal></entry>
<entry>value with the specified number of digits</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>0</literal></entry>
<entry>value with leading zeros</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>.</literal> (period)</entry>
<entry>decimal point</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>,</literal> (comma)</entry>
<entry>group (thousand) separator</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>PR</literal></entry>
<entry>negative value in angle brackets</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>S</literal></entry>
<entry>sign anchored to number (uses locale)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>L</literal></entry>
<entry>currency symbol (uses locale)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>D</literal></entry>
<entry>decimal point (uses locale)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>G</literal></entry>
<entry>group separator (uses locale)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>MI</literal></entry>
<entry>minus sign in specified position (if number &lt; 0)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>PL</literal></entry>
<entry>plus sign in specified position (if number &gt; 0)</entry>
I'm sending patch with new version of to_char numbers formatting. The PostgreSQL's to_char() is very compatible with Oracle's to_char now. I hope that to_char's 3000 rows of source is without bugs, but will good if anyone test it, for me it works very well :-) Karel ---------------------------------------------------------------------- Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-02-08 16:57:01 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>SG</literal></entry>
<entry>plus/minus sign in specified position</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>RN</literal></entry>
<entry>roman numeral (input between 1 and 3999)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>TH</literal> or <literal>th</literal></entry>
<entry>ordinal number suffix</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>V</literal></entry>
<entry>shift specified number of digits (see notes)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>EEEE</literal></entry>
<entry>scientific notation (not implemented yet)</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</tbody>
</tgroup>
</table>
<para>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
Usage notes for numeric formatting:
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<itemizedlist>
<listitem>
<para>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
A sign formatted using <literal>SG</literal>, <literal>PL</literal>, or
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal>MI</literal> is not anchored to
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
the number; for example,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal>to_char(-12, 'S9999')</literal> produces <literal>'&nbsp;&nbsp;-12'</literal>,
but <literal>to_char(-12, 'MI9999')</literal> produces <literal>'-&nbsp;&nbsp;12'</literal>.
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
The Oracle implementation does not allow the use of
<literal>MI</literal> ahead of <literal>9</literal>, but rather
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
requires that <literal>9</literal> precede
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<literal>MI</literal>.
</para>
</listitem>
<listitem>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal>9</literal> results in a value with the same number of
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
digits as there are <literal>9</literal>s. If a digit is
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
not available it outputs a space.
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</para>
</listitem>
<listitem>
<para>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
<literal>TH</literal> does not convert values less than zero
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
and does not convert fractional numbers.
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</para>
</listitem>
<listitem>
<para>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
<literal>PL</literal>, <literal>SG</literal>, and
Deprecate 'current' for date/time input. Fix up references to "PostgreSQL" rather than "Postgres". Was roughly evenly split between the two before. ref/ files not yet done.
2001-11-21 06:53:41 +01:00
<literal>TH</literal> are <productname>PostgreSQL</productname>
Improve description of to_char templates.
2001-03-15 02:07:51 +01:00
extensions.
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</para>
</listitem>
<listitem>
<para>
<literal>V</literal> effectively
multiplies the input values by
<literal>10^<replaceable>n</replaceable></literal>, where
<replaceable>n</replaceable> is the number of digits following
<literal>V</literal>.
<function>to_char</function> does not support the use of
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<literal>V</literal> combined with a decimal point.
(E.g., <literal>99.9V99</literal> is not allowed.)
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</para>
</listitem>
</itemizedlist>
I'm sending patch with new version of to_char numbers formatting. The PostgreSQL's to_char() is very compatible with Oracle's to_char now. I hope that to_char's 3000 rows of source is without bugs, but will good if anyone test it, for me it works very well :-) Karel ---------------------------------------------------------------------- Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-02-08 16:57:01 +01:00
</para>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="functions-formatting-examples-table"> shows some
examples of the use of the <function>to_char</function> function.
</para>
<table id="functions-formatting-examples-table">
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<title><function>to_char</function> Examples</title>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<tgroup cols="2">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Expression</entry>
<entry>Result</entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</thead>
<tbody>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(current_timestamp, 'Day,&nbsp;DD&nbsp;&nbsp;HH12:MI:SS')</literal></entry>
<entry><literal>'Tuesday&nbsp;&nbsp;,&nbsp;06&nbsp;&nbsp;05:39:18'</literal></entry>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(current_timestamp, 'FMDay,&nbsp;FMDD&nbsp;&nbsp;HH12:MI:SS')</literal></entry>
<entry><literal>'Tuesday,&nbsp;6&nbsp;&nbsp;05:39:18'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-0.1, '99.99')</literal></entry>
to_char fixes, Karel Zak
2003-03-27 17:35:31 +01:00
<entry><literal>'&nbsp;&nbsp;-.10'</literal></entry>
I'm sending patch with new version of to_char numbers formatting. The PostgreSQL's to_char() is very compatible with Oracle's to_char now. I hope that to_char's 3000 rows of source is without bugs, but will good if anyone test it, for me it works very well :-) Karel ---------------------------------------------------------------------- Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-02-08 16:57:01 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-0.1, 'FM9.99')</literal></entry>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<entry><literal>'-.1'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(0.1, '0.9')</literal></entry>
<entry><literal>'&nbsp;0.1'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(12, '9990999.9')</literal></entry>
<entry><literal>'&nbsp;&nbsp;&nbsp;&nbsp;0012.0'</literal></entry>
I'm sending patch with new version of to_char numbers formatting. The PostgreSQL's to_char() is very compatible with Oracle's to_char now. I hope that to_char's 3000 rows of source is without bugs, but will good if anyone test it, for me it works very well :-) Karel ---------------------------------------------------------------------- Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-02-08 16:57:01 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(12, 'FM9990999.9')</literal></entry>
to_char fixes, Karel Zak
2003-03-27 17:35:31 +01:00
<entry><literal>'0012.'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485, '999')</literal></entry>
<entry><literal>'&nbsp;485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-485, '999')</literal></entry>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<entry><literal>'-485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485, '9&nbsp;9&nbsp;9')</literal></entry>
<entry><literal>'&nbsp;4&nbsp;8&nbsp;5'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(1485, '9,999')</literal></entry>
<entry><literal>'&nbsp;1,485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(1485, '9G999')</literal></entry>
<entry><literal>'&nbsp;1&nbsp;485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(148.5, '999.999')</literal></entry>
to_char fixes, Karel Zak
2003-03-27 17:35:31 +01:00
<entry><literal>'&nbsp;148.500'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
to_char fixes, Karel Zak
2003-03-27 17:35:31 +01:00
<row>
<entry><literal>to_char(148.5, 'FM999.999')</literal></entry>
<entry><literal>'148.5'</literal></entry>
</row>
<row>
<entry><literal>to_char(148.5, 'FM999.990')</literal></entry>
<entry><literal>'148.500'</literal></entry>
</row>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(148.5, '999D999')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'&nbsp;148,500'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(3148.5, '9G999D999')</literal></entry>
<entry><literal>'&nbsp;3&nbsp;148,500'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-485, '999S')</literal></entry>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<entry><literal>'485-'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-485, '999MI')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'485-'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485, '999MI')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'485&nbsp;'</literal></entry>
to_char fixes, Karel Zak
2003-03-27 17:35:31 +01:00
</row>
<row>
<entry><literal>to_char(485, 'FM999MI')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485, 'PL999')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'+485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485, 'SG999')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'+485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-485, 'SG999')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'-485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-485, '9SG99')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'4-85'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(-485, '999PR')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'&lt;485&gt;'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485, 'L999')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'DM&nbsp;485</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>to_char(485, 'RN')</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>'&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDLXXXV'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>to_char(485, 'FMRN')</literal></entry>
Start updating for the v7.0 release. Use "generic functions" for math and other routines. Use SQL92 "type 'literal'" syntax rather than Postgres "'literal'::type".
2000-03-27 19:14:43 +02:00
<entry><literal>'CDLXXXV'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(5.2, 'FMRN')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'V'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(482, '999th')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>'&nbsp;482nd'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485, '"Good&nbsp;number:"999')</literal></entry>
<entry><literal>'Good&nbsp;number:&nbsp;485'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(485.8, '"Pre:"999"&nbsp;Post:"&nbsp;.999')</literal></entry>
<entry><literal>'Pre:&nbsp;485&nbsp;Post:&nbsp;.800'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>to_char(12, '99V999')</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>'&nbsp;12000'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>to_char(12.4, '99V999')</literal></entry>
<entry><literal>'&nbsp;12400'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<row>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<entry><literal>to_char(12.45, '99V9')</literal></entry>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal>'&nbsp;125'</literal></entry>
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</row>
</tbody>
</tgroup>
</table>
Don't put empty paragraphs around tables. This messed up JadeTeX somehow, and doesn't make sense strictly speaking.
2002-01-30 22:55:33 +01:00
as attache of this mail is patch (to the main tree) with to_char's family functions. Contain: conversion from a datetype to formatted text: to_char( datetime, text) to_char( timestamp, text) to_char( int4, text) to_char( int8, text) to_char( float4, text) to_char( float8, text) to_char( numeric, text) vice versa: to_date ( text, text) to_datetime ( text, text) to_timestamp ( text, text) to_number ( text, text) (convert to numeric) PostgreSQL to_char is very compatible with Oracle's to_char(), but not total exactly (now). Small differentions are in number formating. It will fix in next to_char() version. ! If will this patch aplly to the main tree, must be delete the current to_char version in contrib (directory "dateformat" and note in contrib's README), this patch not erase it (sorry Bruce). The patch patching files: doc/src/sgml/func.sgml ^^^^^^^^ Hmm, I'm not sure if my English... :( Check it anyone (volunteer)? Thomas, it is right? SGML is not my primary lang and compile the current PG docs tree is very happy job (hard variables setting in docs/sgml/Makefile --> HSTYLE= /home/users/t/thomas/.... :-) What add any definition to global configure.in and set Makefiles in docs tree via ./configure? src/backend/utils/adt/Makefile src/backend/utils/adt/formatting.c src/include/catalog/pg_proc.h src/include/utils/formatting.h Karel Zak <zakkr@zf.jcu.cz> http://home.zf.jcu.cz/~zakkr/
2000-01-26 00:53:56 +01:00
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<sect1 id="functions-datetime">
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
<title>Date/Time Functions and Operators</title>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="functions-datetime-table"> shows the available
functions for date/time value processing, with details appearing in
the following subsections. <xref
linkend="operators-datetime-table"> illustrates the behaviors of
the basic arithmetic operators (<literal>+</literal>,
<literal>*</literal>, etc.). For formatting functions, refer to
<xref linkend="functions-formatting">. You should be familiar with
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
the background information on date/time data types from <xref
linkend="datatype-datetime">.
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</para>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
All the functions and operators described below that take <type>time</type> or <type>timestamp</type>
inputs actually come in two variants: one that takes <type>time with time zone</type> or <type>timestamp
with time zone</type>, and one that takes <type>time without time zone</type> or <type>timestamp without time zone</type>.
Add missing operators of the form interval-plus-datetime, as required for better SQL compliance in this area, per recent discussion. Mark related operators as commutators where possible. (The system doesn't actually care about commutator marking for operators not returning boolean, at the moment, but this seems forward-thinking and besides it made it easier to verify that we hadn't missed any.) Also, remove interval-minus-time and interval-minus-timetz operators. I'm not sure how these got in, but they are nonstandard and had very obviously broken behavior. (minus is not commutative in anyone's book.) I doubt anyone had ever used 'em, because we'd surely have gotten a bug report about it if so.
2004-07-03 00:50:23 +02:00
For brevity, these variants are not shown separately. Also, the
<literal>+</> and <literal>*</> operators come in commutative pairs (for
example both date + integer and integer + date); we show only one of each
such pair.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
<table id="operators-datetime-table">
<title>Date/Time Operators</title>
Bunch of copy fitting and style sheet tweakage to get decent looking print output (from pdfjadetex). Also updated instructions to install documentation processing toolchain.
2001-10-09 20:46:00 +02:00
<tgroup cols="3">
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
<thead>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry>Operator</entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
<entry>Example</entry>
<entry>Result</entry>
</row>
</thead>
<tbody>
<row>
Fix markup to allow compilation. The chapters on failure and recovery need more work, but at least they have something now.
2001-09-28 22:48:17 +02:00
<entry> <literal>+</literal> </entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<entry><literal>date '2001-09-28' + integer '7'</literal></entry>
<entry><literal>date '2001-10-05'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
<row>
Fix markup to allow compilation. The chapters on failure and recovery need more work, but at least they have something now.
2001-09-28 22:48:17 +02:00
<entry> <literal>+</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry><literal>date '2001-09-28' + interval '1 hour'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>timestamp '2001-09-28 01:00:00'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<row>
<entry> <literal>+</literal> </entry>
<entry><literal>date '2001-09-28' + time '03:00'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>timestamp '2001-09-28 03:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
<row>
<entry> <literal>+</literal> </entry>
<entry><literal>interval '1 day' + interval '1 hour'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>interval '1 day 01:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
<row>
<entry> <literal>+</literal> </entry>
<entry><literal>timestamp '2001-09-28 01:00' + interval '23 hours'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>timestamp '2001-09-29 00:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
<row>
Fix markup to allow compilation. The chapters on failure and recovery need more work, but at least they have something now.
2001-09-28 22:48:17 +02:00
<entry> <literal>+</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry><literal>time '01:00' + interval '3 hours'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>time '04:00:00'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
<row>
Fix markup to allow compilation. The chapters on failure and recovery need more work, but at least they have something now.
2001-09-28 22:48:17 +02:00
<entry> <literal>-</literal> </entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<entry><literal>- interval '23 hours'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>interval '-23:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
<row>
<entry> <literal>-</literal> </entry>
<entry><literal>date '2001-10-01' - date '2001-09-28'</literal></entry>
<entry><literal>integer '3'</literal></entry>
</row>
<row>
<entry> <literal>-</literal> </entry>
<entry><literal>date '2001-10-01' - integer '7'</literal></entry>
<entry><literal>date '2001-09-24'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
<row>
Fix markup to allow compilation. The chapters on failure and recovery need more work, but at least they have something now.
2001-09-28 22:48:17 +02:00
<entry> <literal>-</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry><literal>date '2001-09-28' - interval '1 hour'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>timestamp '2001-09-27 23:00:00'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<row>
<entry> <literal>-</literal> </entry>
<entry><literal>time '05:00' - time '03:00'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>interval '02:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
<row>
Fix markup to allow compilation. The chapters on failure and recovery need more work, but at least they have something now.
2001-09-28 22:48:17 +02:00
<entry> <literal>-</literal> </entry>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry><literal>time '05:00' - interval '2 hours'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>time '03:00:00'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<row>
<entry> <literal>-</literal> </entry>
<entry><literal>timestamp '2001-09-28 23:00' - interval '23 hours'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>timestamp '2001-09-28 00:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
<row>
<entry> <literal>-</literal> </entry>
<entry><literal>interval '1 day' - interval '1 hour'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>interval '1 day -01:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
<row>
<entry> <literal>-</literal> </entry>
<entry><literal>timestamp '2001-09-29 03:00' - timestamp '2001-09-27 12:00'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>interval '1 day 15:00:00'</literal></entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</row>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
<row>
<entry> <literal>*</literal> </entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>900 * interval '1 second'</literal></entry>
<entry><literal>interval '00:15:00'</literal></entry>
</row>
Add documentation example of using interval multiplication with 'days'. Backpatch to 8.1.X.
2005-12-22 00:22:55 +01:00
<row>
<entry> <literal>*</literal> </entry>
<entry><literal>21 * interval '1 day'</literal></entry>
<entry><literal>interval '21 days'</literal></entry>
</row>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<row>
<entry> <literal>*</literal> </entry>
<entry><literal>double precision '3.5' * interval '1 hour'</literal></entry>
<entry><literal>interval '03:30:00'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
<row>
<entry> <literal>/</literal> </entry>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<entry><literal>interval '1 hour' / double precision '1.5'</literal></entry>
Add additional example for interval multiplication. Fix example for day and hours interval subtraction for new computation method. Update interval examples to display zero seconds, which is our default. Backpatch to 8.1.X.
2005-12-21 17:02:24 +01:00
<entry><literal>interval '00:40:00'</literal></entry>
Add information on new timestamp and timestamptz data types. Start chapter on recovery techniques. Still needs work for release.
2001-09-28 10:15:35 +02:00
</row>
</tbody>
</tgroup>
</table>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>age</primary>
</indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<indexterm>
<primary>clock_timestamp</primary>
</indexterm>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>current_date</primary>
</indexterm>
<indexterm>
<primary>current_time</primary>
</indexterm>
<indexterm>
<primary>current_timestamp</primary>
</indexterm>
<indexterm>
<primary>date_part</primary>
</indexterm>
<indexterm>
<primary>date_trunc</primary>
</indexterm>
<indexterm>
<primary>extract</primary>
</indexterm>
<indexterm>
<primary>isfinite</primary>
</indexterm>
Attached is the new patch. To summarize: - new function justify_interval(interval) - modified function justify_hours(interval) - modified function justify_days(interval) These functions are defined to meet the requirements as discussed in this thread. Specifically: - justify_hours makes certain the sign bit on the hours matches the sign bit on the days. It only checks the sign bit on the days, and not the months, when determining if the hours should be positive or negative. After the call, -24 < hours < 24. - justify_days makes certain the sign bit on the days matches the sign bit on the months. It's behavior does not depend on the hours, nor does it modify the hours. After the call, -30 < days < 30. - justify_interval makes sure the sign bits on all three fields months, days, and hours are all the same. After the call, -24 < hours < 24 AND -30 < days < 30. Mark Dilger
2006-03-06 23:49:17 +01:00
<indexterm>
<primary>justify_days</primary>
</indexterm>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>justify_hours</primary>
</indexterm>
<indexterm>
Attached is the new patch. To summarize: - new function justify_interval(interval) - modified function justify_hours(interval) - modified function justify_days(interval) These functions are defined to meet the requirements as discussed in this thread. Specifically: - justify_hours makes certain the sign bit on the hours matches the sign bit on the days. It only checks the sign bit on the days, and not the months, when determining if the hours should be positive or negative. After the call, -24 < hours < 24. - justify_days makes certain the sign bit on the days matches the sign bit on the months. It's behavior does not depend on the hours, nor does it modify the hours. After the call, -30 < days < 30. - justify_interval makes sure the sign bits on all three fields months, days, and hours are all the same. After the call, -24 < hours < 24 AND -30 < days < 30. Mark Dilger
2006-03-06 23:49:17 +01:00
<primary>justify_interval</primary>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
</indexterm>
<indexterm>
<primary>localtime</primary>
</indexterm>
<indexterm>
<primary>localtimestamp</primary>
</indexterm>
<indexterm>
<primary>now</primary>
</indexterm>
Add statement_timestamp(), clock_timestamp(), and transaction_timestamp() (just like now()). Also update statement_timeout() to mention it is statement arrival time that is measured. Catalog version updated.
2006-04-25 02:25:22 +02:00
<indexterm>
<primary>statement_timestamp</primary>
</indexterm>
<indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>timeofday</primary>
Add statement_timestamp(), clock_timestamp(), and transaction_timestamp() (just like now()). Also update statement_timeout() to mention it is statement arrival time that is measured. Catalog version updated.
2006-04-25 02:25:22 +02:00
</indexterm>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>transaction_timestamp</primary>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
</indexterm>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<table id="functions-datetime-table">
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<title>Date/Time Functions</title>
Bunch of copy fitting and style sheet tweakage to get decent looking print output (from pdfjadetex). Also updated instructions to install documentation processing toolchain.
2001-10-09 20:46:00 +02:00
<tgroup cols="5">
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
</thead>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>age</function>(<type>timestamp</type>, <type>timestamp</type>)</literal></entry>
<entry><type>interval</type></entry>
<entry>Subtract arguments, producing a <quote>symbolic</> result that
uses years and months</entry>
<entry><literal>age(timestamp '2001-04-10', timestamp '1957-06-13')</literal></entry>
<entry><literal>43 years 9 mons 27 days</literal></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>age</function>(<type>timestamp</type>)</literal></entry>
<entry><type>interval</type></entry>
<entry>Subtract from <function>current_date</function></entry>
<entry><literal>age(timestamp '1957-06-13')</literal></entry>
<entry><literal>43 years 8 mons 3 days</literal></entry>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<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">
</entry>
<entry></entry>
<entry></entry>
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>current_date</function></literal></entry>
<entry><type>date</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Current date;
see <xref linkend="functions-datetime-current">
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
</entry>
<entry></entry>
<entry></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>current_time</function></literal></entry>
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
<entry><type>time with time zone</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Current time of day;
see <xref linkend="functions-datetime-current">
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
</entry>
<entry></entry>
<entry></entry>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>current_timestamp</function></literal></entry>
<entry><type>timestamp with time zone</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Current date and time (start of current transaction);
see <xref linkend="functions-datetime-current">
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
</entry>
<entry></entry>
<entry></entry>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>date_part</function>(<type>text</type>, <type>timestamp</type>)</literal></entry>
<entry><type>double precision</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Get subfield (equivalent to <function>extract</function>);
see <xref linkend="functions-datetime-extract">
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>date_part('hour', timestamp '2001-02-16 20:38:40')</literal></entry>
<entry><literal>20</literal></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>date_part</function>(<type>text</type>, <type>interval</type>)</literal></entry>
<entry><type>double precision</type></entry>
<entry>Get subfield (equivalent to
<function>extract</function>); see <xref linkend="functions-datetime-extract">
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>date_part('month', interval '2 years 3 months')</literal></entry>
<entry><literal>3</literal></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>date_trunc</function>(<type>text</type>, <type>timestamp</type>)</literal></entry>
<entry><type>timestamp</type></entry>
Fix SGML spacing.
2005-07-15 21:02:12 +02:00
<entry>Truncate to specified precision; see also <xref linkend="functions-datetime-trunc">
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>date_trunc('hour', timestamp '2001-02-16 20:38:40')</literal></entry>
<entry><literal>2001-02-16 20:00:00</literal></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>extract</function>(<parameter>field</parameter> from
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<type>timestamp</type>)</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>double precision</type></entry>
<entry>Get subfield; see <xref linkend="functions-datetime-extract">
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>extract(hour from timestamp '2001-02-16 20:38:40')</literal></entry>
<entry><literal>20</literal></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>extract</function>(<parameter>field</parameter> from
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<type>interval</type>)</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>double precision</type></entry>
<entry>Get subfield; see <xref linkend="functions-datetime-extract">
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>extract(month from interval '2 years 3 months')</literal></entry>
<entry><literal>3</literal></entry>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>isfinite</function>(<type>timestamp</type>)</literal></entry>
<entry><type>boolean</type></entry>
<entry>Test for finite time stamp (not equal to infinity)</entry>
<entry><literal>isfinite(timestamp '2001-02-16 21:28:30')</literal></entry>
<entry><literal>true</literal></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>isfinite</function>(<type>interval</type>)</literal></entry>
<entry><type>boolean</type></entry>
<entry>Test for finite interval</entry>
<entry><literal>isfinite(interval '4 hours')</literal></entry>
<entry><literal>true</literal></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Attached is the new patch. To summarize: - new function justify_interval(interval) - modified function justify_hours(interval) - modified function justify_days(interval) These functions are defined to meet the requirements as discussed in this thread. Specifically: - justify_hours makes certain the sign bit on the hours matches the sign bit on the days. It only checks the sign bit on the days, and not the months, when determining if the hours should be positive or negative. After the call, -24 < hours < 24. - justify_days makes certain the sign bit on the days matches the sign bit on the months. It's behavior does not depend on the hours, nor does it modify the hours. After the call, -30 < days < 30. - justify_interval makes sure the sign bits on all three fields months, days, and hours are all the same. After the call, -24 < hours < 24 AND -30 < days < 30. Mark Dilger
2006-03-06 23:49:17 +01:00
<row>
<entry><literal><function>justify_days</function>(<type>interval</type>)</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 '30 days')</literal></entry>
<entry><literal>1 month</literal></entry>
</row>
Add 'day' field to INTERVAL so 1 day interval can be distinguished from 24 hours. This is very helpful for daylight savings time: select '2005-05-03 00:00:00 EST'::timestamp with time zone + '24 hours'; ?column? ---------------------- 2005-05-04 01:00:00-04 select '2005-05-03 00:00:00 EST'::timestamp with time zone + '1 day'; ?column? ---------------------- 2005-05-04 01:00:00-04 Michael Glaesemann
2005-07-20 18:42:32 +02:00
<row>
<entry><literal><function>justify_hours</function>(<type>interval</type>)</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 '24 hours')</literal></entry>
<entry><literal>1 day</literal></entry>
</row>
<row>
Attached is the new patch. To summarize: - new function justify_interval(interval) - modified function justify_hours(interval) - modified function justify_days(interval) These functions are defined to meet the requirements as discussed in this thread. Specifically: - justify_hours makes certain the sign bit on the hours matches the sign bit on the days. It only checks the sign bit on the days, and not the months, when determining if the hours should be positive or negative. After the call, -24 < hours < 24. - justify_days makes certain the sign bit on the days matches the sign bit on the months. It's behavior does not depend on the hours, nor does it modify the hours. After the call, -30 < days < 30. - justify_interval makes sure the sign bits on all three fields months, days, and hours are all the same. After the call, -24 < hours < 24 AND -30 < days < 30. Mark Dilger
2006-03-06 23:49:17 +01:00
<entry><literal><function>justify_interval</function>(<type>interval</type>)</literal></entry>
Add 'day' field to INTERVAL so 1 day interval can be distinguished from 24 hours. This is very helpful for daylight savings time: select '2005-05-03 00:00:00 EST'::timestamp with time zone + '24 hours'; ?column? ---------------------- 2005-05-04 01:00:00-04 select '2005-05-03 00:00:00 EST'::timestamp with time zone + '1 day'; ?column? ---------------------- 2005-05-04 01:00:00-04 Michael Glaesemann
2005-07-20 18:42:32 +02:00
<entry><type>interval</type></entry>
SGML typo fix.
2006-03-06 23:54:14 +01:00
<entry>Adjust interval using <function>justify_days</> and <function>justify_hours</>, with additional sign adjustments</entry>
Attached is the new patch. To summarize: - new function justify_interval(interval) - modified function justify_hours(interval) - modified function justify_days(interval) These functions are defined to meet the requirements as discussed in this thread. Specifically: - justify_hours makes certain the sign bit on the hours matches the sign bit on the days. It only checks the sign bit on the days, and not the months, when determining if the hours should be positive or negative. After the call, -24 < hours < 24. - justify_days makes certain the sign bit on the days matches the sign bit on the months. It's behavior does not depend on the hours, nor does it modify the hours. After the call, -30 < days < 30. - justify_interval makes sure the sign bits on all three fields months, days, and hours are all the same. After the call, -24 < hours < 24 AND -30 < days < 30. Mark Dilger
2006-03-06 23:49:17 +01:00
<entry><literal>justify_interval(interval '1 mon -1 hour')</literal></entry>
<entry><literal>29 days 23:00:00</literal></entry>
Add 'day' field to INTERVAL so 1 day interval can be distinguished from 24 hours. This is very helpful for daylight savings time: select '2005-05-03 00:00:00 EST'::timestamp with time zone + '24 hours'; ?column? ---------------------- 2005-05-04 01:00:00-04 select '2005-05-03 00:00:00 EST'::timestamp with time zone + '1 day'; ?column? ---------------------- 2005-05-04 01:00:00-04 Michael Glaesemann
2005-07-20 18:42:32 +02:00
</row>
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>localtime</function></literal></entry>
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
<entry><type>time</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Current time of day;
see <xref linkend="functions-datetime-current">
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
</entry>
<entry></entry>
<entry></entry>
</row>
<row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<entry><literal><function>localtimestamp</function></literal></entry>
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
<entry><type>timestamp</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Current date and time (start of current transaction);
see <xref linkend="functions-datetime-current">
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
</entry>
<entry></entry>
<entry></entry>
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>now</function>()</literal></entry>
<entry><type>timestamp with time zone</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Current date and time (start of current transaction);
see <xref linkend="functions-datetime-current">
Add statement_timestamp(), clock_timestamp(), and transaction_timestamp() (just like now()). Also update statement_timeout() to mention it is statement arrival time that is measured. Catalog version updated.
2006-04-25 02:25:22 +02:00
</entry>
<entry></entry>
<entry></entry>
</row>
<row>
<entry><literal><function>statement_timestamp</function>()</literal></entry>
<entry><type>timestamp with time zone</type></entry>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<entry>Current date and time (start of current statement);
see <xref linkend="functions-datetime-current">
Add statement_timestamp(), clock_timestamp(), and transaction_timestamp() (just like now()). Also update statement_timeout() to mention it is statement arrival time that is measured. Catalog version updated.
2006-04-25 02:25:22 +02:00
</entry>
<entry></entry>
<entry></entry>
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<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);
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
see <xref linkend="functions-datetime-current">
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
</entry>
<entry></entry>
<entry></entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<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);
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
see <xref linkend="functions-datetime-current">
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
</entry>
<entry></entry>
<entry></entry>
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
</row>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</tbody>
</tgroup>
</table>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<para>
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
In addition to these functions, the SQL <literal>OVERLAPS</> operator is
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
supported:
<synopsis>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
(<replaceable>start1</replaceable>, <replaceable>end1</replaceable>) OVERLAPS (<replaceable>start2</replaceable>, <replaceable>end2</replaceable>)
(<replaceable>start1</replaceable>, <replaceable>length1</replaceable>) OVERLAPS (<replaceable>start2</replaceable>, <replaceable>length2</replaceable>)
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</synopsis>
This expression yields true when two time periods (defined by their
endpoints) overlap, false when they do not overlap. The endpoints
Spell checking, consistent terminology.
2003-11-01 02:56:29 +01:00
can be specified as pairs of dates, times, or time stamps; or as
a date, time, or time stamp followed by an interval.
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
</para>
<screen>
SELECT (DATE '2001-02-16', DATE '2001-12-21') OVERLAPS
(DATE '2001-10-30', DATE '2002-10-30');
<lineannotation>Result: </lineannotation><computeroutput>true</computeroutput>
SELECT (DATE '2001-02-16', INTERVAL '100 days') OVERLAPS
(DATE '2001-10-30', DATE '2002-10-30');
<lineannotation>Result: </lineannotation><computeroutput>false</computeroutput>
</screen>
Fix broken markup and spelling, put paragraph in a somewhat less random place.
2005-07-31 00:53:15 +02:00
<para>
When adding an <type>interval</type> value to (or subtracting an
<type>interval</type> value from) a <type>timestamp with time zone</type>
value, the days component advances (or decrements) the date of the
<type>timestamp with time zone</type> by the indicated number of days.
Across daylight saving time changes (with the session time zone set to a
time zone that recognizes DST), this means <literal>interval '1 day'</literal>
does not necessarily equal <literal>interval '24 hours'</literal>.
For example, with the session time zone set to <literal>CST7CDT</literal>,
<literal>timestamp with time zone '2005-04-02 12:00-07' + interval '1 day' </literal>
will produce <literal>timestamp with time zone '2005-04-03 12:00-06'</literal>,
while adding <literal>interval '24 hours'</literal> to the same initial
<type>timestamp with time zone</type> produces
<literal>timestamp with time zone '2005-04-03 13:00-06'</literal>, as there is
a change in daylight saving time at <literal>2005-04-03 02:00</literal> in time zone
<literal>CST7CDT</literal>.
</para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<sect2 id="functions-datetime-extract">
<title><function>EXTRACT</function>, <function>date_part</function></title>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>date_part</primary>
</indexterm>
<indexterm>
<primary>extract</primary>
</indexterm>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<synopsis>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
EXTRACT(<replaceable>field</replaceable> FROM <replaceable>source</replaceable>)
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</synopsis>
<para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
The <function>extract</function> function retrieves subfields
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
such as year or hour from date/time values.
<replaceable>source</replaceable> must be a value expression of
type <type>timestamp</type>, <type>time</type>, or <type>interval</type>.
(Expressions of type <type>date</type> will
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
be cast to <type>timestamp</type> and can therefore be used as
Final markup for 7.1 hardcopy release. Mostly typo and table-fitting adjustments. Note that many tables are being abused with *really* long description columns. Should probably shrink those columns to be more concise, and move some of the info to follow-on reference notes.
2001-04-20 17:52:33 +02:00
well.) <replaceable>field</replaceable> is an identifier or
string that selects what field to extract from the source value.
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
The <function>extract</function> function returns values of type
<type>double precision</type>.
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The following are valid field names:
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<!-- alphabetical -->
<variablelist>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>century</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
Update documentation to reflect the fact that we now know exactly what time zone names we support.
2004-08-10 02:55:08 +02:00
The century
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</para>
<screen>
Please find a small patch to fix the brain damage "century" and "millennium" date part implementation in postgresql, both in the code and the documentation, so that it conforms to the official definition. If you do not agree with the official definition, please send your complaint to "pope@vatican.org". I'm not responsible for them;-) With the previous version, the centuries and millenniums had a wrong number and started the wrong year. Moreover century number 0, which does not exist in reality, lasted 200 years. Also, millennium number 0 lasted 2000 years. If you want postgresql to have it's own definition of "century" and "millennium" that does not conform to the one of the society, just give them another name. I would suggest "pgCENTURY" and "pgMILLENNIUM";-) IMO, if someone may use the options, it means that postgresql is used for historical data, so it make sense to have an historical definition. Also, I just want to divide the year by 100 or 1000, I can do that quite easily. BACKWARD INCOMPATIBLE CHANGE Fabien Coelho - coelho@cri.ensmp.fr
2004-04-10 20:02:59 +02:00
SELECT EXTRACT(CENTURY FROM TIMESTAMP '2000-12-16 12:21:13');
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<lineannotation>Result: </lineannotation><computeroutput>20</computeroutput>
Please find a small patch to fix the brain damage "century" and "millennium" date part implementation in postgresql, both in the code and the documentation, so that it conforms to the official definition. If you do not agree with the official definition, please send your complaint to "pope@vatican.org". I'm not responsible for them;-) With the previous version, the centuries and millenniums had a wrong number and started the wrong year. Moreover century number 0, which does not exist in reality, lasted 200 years. Also, millennium number 0 lasted 2000 years. If you want postgresql to have it's own definition of "century" and "millennium" that does not conform to the one of the society, just give them another name. I would suggest "pgCENTURY" and "pgMILLENNIUM";-) IMO, if someone may use the options, it means that postgresql is used for historical data, so it make sense to have an historical definition. Also, I just want to divide the year by 100 or 1000, I can do that quite easily. BACKWARD INCOMPATIBLE CHANGE Fabien Coelho - coelho@cri.ensmp.fr
2004-04-10 20:02:59 +02:00
SELECT EXTRACT(CENTURY FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>21</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</screen>
<para>
Update documentation to reflect the fact that we now know exactly what time zone names we support.
2004-08-10 02:55:08 +02:00
The first century starts at 0001-01-01 00:00:00 AD, although
they did not know it at the time. This definition applies to all
Gregorian calendar countries. There is no century number 0,
you go from -1 to 1.
If you disagree with this, please write your complaint to:
Pope, Cathedral Saint-Peter of Roma, Vatican.
Please find a small patch to fix the brain damage "century" and "millennium" date part implementation in postgresql, both in the code and the documentation, so that it conforms to the official definition. If you do not agree with the official definition, please send your complaint to "pope@vatican.org". I'm not responsible for them;-) With the previous version, the centuries and millenniums had a wrong number and started the wrong year. Moreover century number 0, which does not exist in reality, lasted 200 years. Also, millennium number 0 lasted 2000 years. If you want postgresql to have it's own definition of "century" and "millennium" that does not conform to the one of the society, just give them another name. I would suggest "pgCENTURY" and "pgMILLENNIUM";-) IMO, if someone may use the options, it means that postgresql is used for historical data, so it make sense to have an historical definition. Also, I just want to divide the year by 100 or 1000, I can do that quite easily. BACKWARD INCOMPATIBLE CHANGE Fabien Coelho - coelho@cri.ensmp.fr
2004-04-10 20:02:59 +02:00
</para>
<para>
Update documentation to reflect the fact that we now know exactly what time zone names we support.
2004-08-10 02:55:08 +02:00
<productname>PostgreSQL</productname> releases before 8.0 did not
follow the conventional numbering of centuries, but just returned
the year field divided by 100.
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</para>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>day</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The day (of the month) field (1 - 31)
</para>
<screen>
SELECT EXTRACT(DAY FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>16</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>decade</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The year field divided by 10
</para>
<screen>
SELECT EXTRACT(DECADE FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>200</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>dow</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The day of the week (0 - 6; Sunday is 0) (for
<type>timestamp</type> values only)
</para>
<screen>
SELECT EXTRACT(DOW FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>5</computeroutput>
</screen>
I was recently surprised to find that EXTRACT's day of the week numbering is different than TO_CHAR's ditto. EXTRACT starts at 0==Sunday while TO_CHAR starts at 1==Sunday. A suggestion for two documentation notes is attached as a patch to current CVS HEAD. Troels Arvin
2004-12-21 02:02:28 +01:00
<para>
Note that <function>extract</function>'s day of the week numbering is
different from that of the <function>to_char</function> function.
</para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>doy</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The day of the year (1 - 365/366) (for <type>timestamp</type> values only)
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<screen>
SELECT EXTRACT(DOY FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>47</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>epoch</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
For <type>date</type> and <type>timestamp</type> values, the
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
number of seconds since 1970-01-01 00:00:00-00 (can be negative);
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
for <type>interval</type> values, the total number
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
of seconds in the interval
</para>
<screen>
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
SELECT EXTRACT(EPOCH FROM TIMESTAMP WITH TIME ZONE '2001-02-16 20:38:40-08');
<lineannotation>Result: </lineannotation><computeroutput>982384720</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
SELECT EXTRACT(EPOCH FROM INTERVAL '5 days 3 hours');
<lineannotation>Result: </lineannotation><computeroutput>442800</computeroutput>
Add example for converting epoch back to timestamp.
2003-12-16 16:27:58 +01:00
</screen>
<para>
Here is how you can convert an epoch value back to a time
stamp:
</para>
<screen>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
SELECT TIMESTAMP WITH TIME ZONE 'epoch' + 982384720 * INTERVAL '1 second';
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>hour</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The hour field (0 - 23)
</para>
<screen>
SELECT EXTRACT(HOUR FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>20</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>microseconds</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The seconds field, including fractional parts, multiplied by 1
000 000. Note that this includes full seconds.
</para>
<screen>
SELECT EXTRACT(MICROSECONDS FROM TIME '17:12:28.5');
<lineannotation>Result: </lineannotation><computeroutput>28500000</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>millennium</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
Update documentation to reflect the fact that we now know exactly what time zone names we support.
2004-08-10 02:55:08 +02:00
The millennium
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</para>
<screen>
SELECT EXTRACT(MILLENNIUM FROM TIMESTAMP '2001-02-16 20:38:40');
Please find a small patch to fix the brain damage "century" and "millennium" date part implementation in postgresql, both in the code and the documentation, so that it conforms to the official definition. If you do not agree with the official definition, please send your complaint to "pope@vatican.org". I'm not responsible for them;-) With the previous version, the centuries and millenniums had a wrong number and started the wrong year. Moreover century number 0, which does not exist in reality, lasted 200 years. Also, millennium number 0 lasted 2000 years. If you want postgresql to have it's own definition of "century" and "millennium" that does not conform to the one of the society, just give them another name. I would suggest "pgCENTURY" and "pgMILLENNIUM";-) IMO, if someone may use the options, it means that postgresql is used for historical data, so it make sense to have an historical definition. Also, I just want to divide the year by 100 or 1000, I can do that quite easily. BACKWARD INCOMPATIBLE CHANGE Fabien Coelho - coelho@cri.ensmp.fr
2004-04-10 20:02:59 +02:00
<lineannotation>Result: </lineannotation><computeroutput>3</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</screen>
<para>
Update documentation to reflect the fact that we now know exactly what time zone names we support.
2004-08-10 02:55:08 +02:00
Years in the 1900s are in the second millennium.
The third millennium starts January 1, 2001.
</para>
<para>
<productname>PostgreSQL</productname> releases before 8.0 did not
follow the conventional numbering of millennia, but just returned
the year field divided by 1000.
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</para>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>milliseconds</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The seconds field, including fractional parts, multiplied by
1000. Note that this includes full seconds.
</para>
<screen>
SELECT EXTRACT(MILLISECONDS FROM TIME '17:12:28.5');
<lineannotation>Result: </lineannotation><computeroutput>28500</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>minute</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The minutes field (0 - 59)
</para>
<screen>
SELECT EXTRACT(MINUTE FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>38</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>month</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
For <type>timestamp</type> values, the number of the month
within the year (1 - 12) ; for <type>interval</type> values
the number of months, modulo 12 (0 - 11)
</para>
<screen>
SELECT EXTRACT(MONTH FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>2</computeroutput>
SELECT EXTRACT(MONTH FROM INTERVAL '2 years 3 months');
<lineannotation>Result: </lineannotation><computeroutput>3</computeroutput>
SELECT EXTRACT(MONTH FROM INTERVAL '2 years 13 months');
<lineannotation>Result: </lineannotation><computeroutput>1</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>quarter</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The quarter of the year (1 - 4) that the day is in (for
<type>timestamp</type> values only)
</para>
<screen>
SELECT EXTRACT(QUARTER FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>1</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>second</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
The seconds field, including fractional parts (0 -
59<footnote><simpara>60 if leap seconds are
implemented by the operating system</simpara></footnote>)
</para>
<screen>
SELECT EXTRACT(SECOND FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>40</computeroutput>
SELECT EXTRACT(SECOND FROM TIME '17:12:28.5');
<lineannotation>Result: </lineannotation><computeroutput>28.5</computeroutput>
</screen>
</listitem>
</varlistentry>
Remove gratuitous discrepancy between extract() and date_part(), regarding timezone_hour, timezone_minute vs. tz_hour, tz_minute. Document the former.
2001-10-10 02:02:42 +02:00
<varlistentry>
<term><literal>timezone</literal></term>
<listitem>
<para>
Make EXTRACT(TIMEZONE) and SET/SHOW TIMEZONE follow the SQL convention for the sign of timezone offsets, ie, positive is east from UTC. These were previously out of step with other operations that accept or show timezones, such as I/O of timestamptz values.
2003-07-17 02:55:37 +02:00
The time zone offset from UTC, measured in seconds. Positive values
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
correspond to time zones east of UTC, negative values to
zones west of UTC.
Remove gratuitous discrepancy between extract() and date_part(), regarding timezone_hour, timezone_minute vs. tz_hour, tz_minute. Document the former.
2001-10-10 02:02:42 +02:00
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>timezone_hour</literal></term>
<listitem>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The hour component of the time zone offset
Remove gratuitous discrepancy between extract() and date_part(), regarding timezone_hour, timezone_minute vs. tz_hour, tz_minute. Document the former.
2001-10-10 02:02:42 +02:00
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>timezone_minute</literal></term>
<listitem>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The minute component of the time zone offset
Remove gratuitous discrepancy between extract() and date_part(), regarding timezone_hour, timezone_minute vs. tz_hour, tz_minute. Document the former.
2001-10-10 02:02:42 +02:00
</para>
</listitem>
</varlistentry>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>week</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
Fix to_char for 1 BC. Previously it returned 1 AD. Fix to_char(year) for BC dates. Previously it returned one less than the current year. Add documentation mentioning that there is no 0 AD.
2004-03-30 17:53:18 +02:00
The number of the week of the year that the day is in. By definition
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
(<acronym>ISO</acronym> 8601), the first week of a year
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
contains January 4 of that year. (The <acronym>ISO</acronym>-8601
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
week starts on Monday.) In other words, the first Thursday of
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
a year is in week 1 of that year. (for <type>timestamp</type> values only)
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</para>
Fix wrong week returnded by date_trunc('week') for early dates in January --- would return wrong year for 2005-01-01 and 2006-01-01. per report from Robert Creager. Backpatch to 8.0.X.
2005-04-01 16:25:23 +02:00
<para>
Because of this, it is possible for early January dates to be part of the
52nd or 53rd week of the previous year. For example, <literal>2005-01-01</>
is part of the 53rd week of year 2004, and <literal>2006-01-01</> is part of
the 52nd week of year 2005.
</para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<screen>
SELECT EXTRACT(WEEK FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>7</computeroutput>
</screen>
</listitem>
</varlistentry>
<varlistentry>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<term><literal>year</literal></term>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<listitem>
<para>
Fix to_char for 1 BC. Previously it returned 1 AD. Fix to_char(year) for BC dates. Previously it returned one less than the current year. Add documentation mentioning that there is no 0 AD.
2004-03-30 17:53:18 +02:00
The year field. Keep in mind there is no <literal>0 AD</>, so subtracting
<literal>BC</> years from <literal>AD</> years should be done with care.
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</para>
<screen>
SELECT EXTRACT(YEAR FROM TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>2001</computeroutput>
</screen>
</listitem>
</varlistentry>
</variablelist>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
<para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
The <function>extract</function> function is primarily intended
for computational processing. For formatting date/time values for
display, see <xref linkend="functions-formatting">.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<para>
Final markup for 7.1 hardcopy release. Mostly typo and table-fitting adjustments. Note that many tables are being abused with *really* long description columns. Should probably shrink those columns to be more concise, and move some of the info to follow-on reference notes.
2001-04-20 17:52:33 +02:00
The <function>date_part</function> function is modeled on the traditional
<productname>Ingres</productname> equivalent to the
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
<acronym>SQL</acronym>-standard function <function>extract</function>:
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<synopsis>
date_part('<replaceable>field</replaceable>', <replaceable>source</replaceable>)
</synopsis>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
Note that here the <replaceable>field</replaceable> parameter needs to
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
be a string value, not a name. The valid field names for
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<function>date_part</function> are the same as for
<function>extract</function>.
</para>
<screen>
SELECT date_part('day', TIMESTAMP '2001-02-16 20:38:40');
<lineannotation>Result: </lineannotation><computeroutput>16</computeroutput>
Add missing ';'
2001-09-10 04:46:18 +02:00
SELECT date_part('hour', INTERVAL '4 hours 3 minutes');
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<lineannotation>Result: </lineannotation><computeroutput>4</computeroutput>
</screen>
</sect2>
<sect2 id="functions-datetime-trunc">
<title><function>date_trunc</function></title>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>date_trunc</primary>
</indexterm>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<para>
The function <function>date_trunc</function> is conceptually
similar to the <function>trunc</function> function for numbers.
</para>
<para>
<synopsis>
date_trunc('<replaceable>field</replaceable>', <replaceable>source</replaceable>)
</synopsis>
<replaceable>source</replaceable> is a value expression of type
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<type>timestamp</type> or <type>interval</>.
(Values of type <type>date</type> and
<type>time</type> are cast automatically, to <type>timestamp</type> or
<type>interval</> respectively.)
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<replaceable>field</replaceable> selects to which precision to
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
truncate the input value. The return value is of type
<type>timestamp</type> or <type>interval</>
with all fields that are less significant than the
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
selected one set to zero (or one, for day and month).
</para>
<para>
Valid values for <replaceable>field</replaceable> are:
<simplelist>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<member><literal>microseconds</literal></member>
<member><literal>milliseconds</literal></member>
<member><literal>second</literal></member>
<member><literal>minute</literal></member>
<member><literal>hour</literal></member>
<member><literal>day</literal></member>
Per a brief conversation with Tom, I've created a patch for adding support for 'week' within the date_trunc function. Within the patch I added a couple of test cases and associated target output, and changed the documentation to add 'week' appropriately. Robert Creager
2004-03-05 03:41:14 +01:00
<member><literal>week</literal></member>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<member><literal>month</literal></member>
date_trunc also accepts 'quarter'. Noted by Yoshihisa Nakano.
2006-10-01 20:54:31 +02:00
<member><literal>quarter</literal></member>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<member><literal>year</literal></member>
<member><literal>decade</literal></member>
<member><literal>century</literal></member>
<member><literal>millennium</literal></member>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</simplelist>
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Examples:
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<screen>
SELECT date_trunc('hour', TIMESTAMP '2001-02-16 20:38:40');
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<lineannotation>Result: </lineannotation><computeroutput>2001-02-16 20:00:00</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
SELECT date_trunc('year', TIMESTAMP '2001-02-16 20:38:40');
Document a bunch of formerly-undocumented date/time operators, including the SQL-spec OVERLAPS construct.
2003-09-08 21:38:02 +02:00
<lineannotation>Result: </lineannotation><computeroutput>2001-01-01 00:00:00</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</screen>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</sect2>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
<sect2 id="functions-datetime-zoneconvert">
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title><literal>AT TIME ZONE</literal></title>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
<indexterm>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<primary>time zone</primary>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
<secondary>conversion</secondary>
</indexterm>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>AT TIME ZONE</primary>
</indexterm>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The <literal>AT TIME ZONE</literal> construct allows conversions
of time stamps to different time zones. <xref
linkend="functions-datetime-zoneconvert-table"> shows its
variants.
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</para>
<table id="functions-datetime-zoneconvert-table">
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title><literal>AT TIME ZONE</literal> Variants</title>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
<tgroup cols="3">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Expression</entry>
<entry>Return Type</entry>
<entry>Description</entry>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
<literal><type>timestamp without time zone</type> AT TIME ZONE <replaceable>zone</></literal>
</entry>
<entry><type>timestamp with time zone</type></entry>
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
<entry>Treat given time stamp <emphasis>without time zone</> as located in the specified time zone</entry>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
<literal><type>timestamp with time zone</type> AT TIME ZONE <replaceable>zone</></literal>
</entry>
<entry><type>timestamp without time zone</type></entry>
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
<entry>Convert given time stamp <emphasis>with time zone</> to the new time zone</entry>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
<literal><type>time with time zone</type> AT TIME ZONE <replaceable>zone</></literal>
</entry>
<entry><type>time with time zone</type></entry>
Fix AT TIME ZONE for timestamps without time zones: test=> select ('2005-07-20 00:00:00'::timestamp without time zone) at time zone 'Europe/Paris'; timezone ------------------------ 2005-07-19 22:00:00-04 Udpate documentation.
2005-07-22 23:16:15 +02:00
<entry>Convert given time <emphasis>with time zone</> to the new time zone</entry>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</row>
</tbody>
</tgroup>
</table>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
In these expressions, the desired time zone <replaceable>zone</> can be
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
specified either as a text string (e.g., <literal>'PST'</literal>)
or as an interval (e.g., <literal>INTERVAL '-08:00'</literal>).
Update timezone documentation to reflect current reality: instead of giving tables of known timezone names, refer the user to the system views. Joachim Wieland
2006-09-22 18:20:00 +02:00
In the text case, a time zone name may be specified in any of the ways
described in <xref linkend="datatype-timezones">.
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</para>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Examples (supposing that the local time zone is <literal>PST8PDT</>):
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
<screen>
SELECT TIMESTAMP '2001-02-16 20:38:40' AT TIME ZONE 'MST';
<lineannotation>Result: </lineannotation><computeroutput>2001-02-16 19:38:40-08</computeroutput>
SELECT TIMESTAMP WITH TIME ZONE '2001-02-16 20:38:40-05' AT TIME ZONE 'MST';
<lineannotation>Result: </lineannotation><computeroutput>2001-02-16 18:38:40</computeroutput>
</screen>
Fix AT TIME ZONE for timestamps without time zones: test=> select ('2005-07-20 00:00:00'::timestamp without time zone) at time zone 'Europe/Paris'; timezone ------------------------ 2005-07-19 22:00:00-04 Udpate documentation.
2005-07-22 23:16:15 +02:00
The first example takes a time stamp without time zone and interprets it as MST time
(UTC-7), which is then converted to PST (UTC-8) for display. The second example takes
a time stamp specified in EST (UTC-5) and converts it to local time in MST (UTC-7).
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</para>
<para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The function <literal><function>timezone</function>(<replaceable>zone</>,
<replaceable>timestamp</>)</literal> is equivalent to the SQL-conforming construct
<literal><replaceable>timestamp</> AT TIME ZONE
<replaceable>zone</></literal>.
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</para>
</sect2>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<sect2 id="functions-datetime-current">
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<title>Current Date/Time</title>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
<indexterm>
<primary>date</primary>
<secondary>current</secondary>
</indexterm>
<indexterm>
<primary>time</primary>
<secondary>current</secondary>
</indexterm>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<para>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<productname>PostgreSQL</productname> provides a number of functions
that return values related to the current date and time. These
SQL-standard functions all return values based on the start time of
the current transaction:
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<synopsis>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
CURRENT_DATE
Update description of CURRENT_TIMESTAMP and friends.
2001-12-23 21:22:49 +01:00
CURRENT_TIME
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
CURRENT_TIMESTAMP
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
CURRENT_TIME(<replaceable>precision</replaceable>)
CURRENT_TIMESTAMP(<replaceable>precision</replaceable>)
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
LOCALTIME
LOCALTIMESTAMP
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
LOCALTIME(<replaceable>precision</replaceable>)
LOCALTIMESTAMP(<replaceable>precision</replaceable>)
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</synopsis>
Fix breakage in new-in-7.3 timetz_zone() function: was giving random results due to doing arithmetic on uninitialized values. Add some documentation about the AT TIME ZONE construct. Update some other date/time documentation that seemed out of date for 7.3.
2002-11-22 00:31:20 +01:00
</para>
<para>
<function>CURRENT_TIME</function> and
<function>CURRENT_TIMESTAMP</function> deliver values with time zone;
<function>LOCALTIME</function> and
<function>LOCALTIMESTAMP</function> deliver values without time zone.
</para>
<para>
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
<function>CURRENT_TIME</function>,
<function>CURRENT_TIMESTAMP</function>,
<function>LOCALTIME</function>, and
<function>LOCALTIMESTAMP</function>
can optionally be given
a precision parameter, which causes the result to be rounded
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
to that many fractional digits in the seconds field. Without a precision parameter,
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
the result is given to the full available precision.
Update description of CURRENT_TIMESTAMP and friends.
2001-12-23 21:22:49 +01:00
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Some examples:
<screen>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
SELECT CURRENT_TIME;
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<lineannotation>Result: </lineannotation><computeroutput>14:39:53.662522-05</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
SELECT CURRENT_DATE;
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<lineannotation>Result: </lineannotation><computeroutput>2001-12-23</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
SELECT CURRENT_TIMESTAMP;
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<lineannotation>Result: </lineannotation><computeroutput>2001-12-23 14:39:53.662522-05</computeroutput>
Update description of CURRENT_TIMESTAMP and friends.
2001-12-23 21:22:49 +01:00
SELECT CURRENT_TIMESTAMP(2);
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<lineannotation>Result: </lineannotation><computeroutput>2001-12-23 14:39:53.66-05</computeroutput>
Add LOCALTIME and LOCALTIMESTAMP functions per SQL99 standard. Remove ODBC-compatible empty parentheses from calls to SQL99 functions for which these parentheses do not match the standard. Update the ODBC driver to ensure compatibility with the ODBC standard for these functions (e.g. CURRENT_TIMESTAMP, CURRENT_USER, etc). Include a new appendix in the User's Guide which lists the labeled features for SQL99 (the labeled features replaced the "basic", "intermediate", and "advanced" categories from SQL92). features.sgml does not yet split this list into "supported" and "unsupported" lists.
2002-06-15 05:00:09 +02:00
SELECT LOCALTIMESTAMP;
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<lineannotation>Result: </lineannotation><computeroutput>2001-12-23 14:39:53.662522</computeroutput>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</screen>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
<para>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
Since these functions return
the start time of the current transaction, their values do not
Add start time to pg_stat_activity Neil Conway
2003-03-20 04:34:57 +01:00
change during the transaction. This is considered a feature:
the intent is to allow a single transaction to have a consistent
notion of the <quote>current</quote> time, so that multiple
modifications within the same transaction bear the same
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
time stamp.
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
</para>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<note>
<para>
Other database systems may advance these values more
frequently.
</para>
</note>
Add statement_timestamp(), clock_timestamp(), and transaction_timestamp() (just like now()). Also update statement_timeout() to mention it is statement arrival time that is measured. Catalog version updated.
2006-04-25 02:25:22 +02:00
<para>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<productname>PostgreSQL</productname> also provides functions that
return the start time of the current statement, as well as the actual
current time at the instant the function is called. The complete list
of non-SQL-standard time functions is:
<synopsis>
now()
transaction_timestamp()
statement_timestamp()
clock_timestamp()
timeofday()
</synopsis>
Add statement_timestamp(), clock_timestamp(), and transaction_timestamp() (just like now()). Also update statement_timeout() to mention it is statement arrival time that is measured. Catalog version updated.
2006-04-25 02:25:22 +02:00
</para>
Add more documentation about CURRENT_TIMESTAMP. Also, code < and > as &lt;/&gt; for cleaner SGML.
2002-10-05 21:03:16 +02:00
Improve gettimeofday() documentation. Karl O. Pinc
2005-06-29 03:52:56 +02:00
<para>
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<function>now()</> is a traditional <productname>PostgreSQL</productname>
equivalent to <function>CURRENT_TIMESTAMP</function>.
<function>transaction_timestamp()</> is likewise equivalent to
<function>CURRENT_TIMESTAMP</function>, but is named to clearly reflect
what it returns.
<function>statement_timestamp()</> returns the start time of the current
statement (more specifically, the time of receipt of the latest command
message from the client).
<function>statement_timestamp()</> and <function>transaction_timestamp()</>
return the same value during the first command of a transaction, but may
differ during subsequent commands.
<function>clock_timestamp()</> returns the actual current time, and
therefore its value changes even within a single SQL command.
<function>timeofday()</> is a historical
<productname>PostgreSQL</productname> function. Like
<function>clock_timestamp()</>, it returns the actual current time,
but as a formatted <type>text</> string rather than a <type>timestamp
with time zone</> value.
Improve gettimeofday() documentation. Karl O. Pinc
2005-06-29 03:52:56 +02:00
</para>
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
<para>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
All the date/time data types also accept the special literal value
Some editorial work on the documentation of the current-date/time functions.
2006-06-19 18:13:01 +02:00
<literal>now</literal> to specify the current date and time (again,
interpreted as the transaction start time). Thus,
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
the following three all return the same result:
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<programlisting>
SELECT CURRENT_TIMESTAMP;
SELECT now();
Make clearer warning about using 'now' with DEFAULT: SELECT CURRENT_TIMESTAMP; SELECT now(); SELECT TIMESTAMP 'now'; -- incorrect for use with DEFAULT
2005-02-11 05:31:54 +01:00
SELECT TIMESTAMP 'now'; -- incorrect for use with DEFAULT
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</programlisting>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
<tip>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
<para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
You do not want to use the third form when specifying a <literal>DEFAULT</>
clause while creating a table. The system will convert <literal>now</literal>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
to a <type>timestamp</type> as soon as the constant is parsed, so that when
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
the default value is needed,
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
the time of the table creation would be used! The first two
forms will not be evaluated until the default value is used,
Document timeofday(), mention start-of-transaction vs. current-time semantics, a few other small improvements.
2001-02-22 00:15:24 +01:00
because they are function calls. Thus they will give the desired
behavior of defaulting to the time of row insertion.
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</para>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
</tip>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</sect2>
Create a standard function pg_sleep() to sleep for a specified amount of time. Replace the former ad-hoc implementation used in the regression tests. Joachim Wieland
2006-01-11 21:12:43 +01:00
<sect2 id="functions-datetime-delay">
<title>Delaying Execution</title>
<indexterm>
<primary>pg_sleep</primary>
</indexterm>
<indexterm>
<primary>sleep</primary>
</indexterm>
<indexterm>
<primary>delay</primary>
</indexterm>
<para>
The following function is available to delay execution of the server
process:
<synopsis>
pg_sleep(<replaceable>seconds</replaceable>)
</synopsis>
<function>pg_sleep</function> makes the current session's process
sleep until <replaceable>seconds</replaceable> seconds have
elapsed. <replaceable>seconds</replaceable> is a value of type
<type>double precision</>, so fractional-second delays can be specified.
For example:
<programlisting>
SELECT pg_sleep(1.5);
</programlisting>
</para>
<note>
<para>
The effective resolution of the sleep interval is platform-specific;
0.01 seconds is a common value. The sleep delay will be at least as long
as specified. It may be longer depending on factors such as server load.
</para>
</note>
<warning>
<para>
Make sure that your session does not hold more locks than necessary
when calling <function>pg_sleep</function>. Otherwise other sessions
might have to wait for your sleeping process, slowing down the entire
system.
</para>
</warning>
</sect2>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<sect1 id="functions-geometry">
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<title>Geometric Functions and Operators</title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
The geometric types <type>point</type>, <type>box</type>,
<type>lseg</type>, <type>line</type>, <type>path</type>,
<type>polygon</type>, and <type>circle</type> have a large set of
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
native support functions and operators, shown in <xref
linkend="functions-geometry-op-table">, <xref
linkend="functions-geometry-func-table">, and <xref
linkend="functions-geometry-conv-table">.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
Extend r-tree operator classes to handle Y-direction tests equivalent to the existing X-direction tests. An rtree class now includes 4 actual 2-D tests, 4 1-D X-direction tests, and 4 1-D Y-direction tests. This involved adding four new Y-direction test operators for each of box and polygon; I followed the PostGIS project's lead as to the names of these operators. NON BACKWARDS COMPATIBLE CHANGE: the poly_overleft (&<) and poly_overright (&>) operators now have semantics comparable to box_overleft and box_overright. This is necessary to make r-tree indexes work correctly on polygons. Also, I changed circle_left and circle_right to agree with box_left and box_right --- formerly they allowed the boundaries to touch. This isn't actually essential given the lack of any r-tree opclass for circles, but it seems best to sync all the definitions while we are at it.
2005-06-24 22:53:34 +02:00
<caution>
<para>
Note that the <quote>same as</> operator, <literal>~=</>, represents
the usual notion of equality for the <type>point</type>,
<type>box</type>, <type>polygon</type>, and <type>circle</type> types.
Fix some bogosities in geometric-function documentation: add an entry for circle(polygon), which was missing; remove bogus entry for point(lseg, lseg), which does not exist, and the documentation seemed to describe lseg_interpt, which we already document as an operator not a function. Also remove entry for box_intersect, which likewise is preferentially used via the operator #.
2005-07-19 00:34:14 +02:00
Some of these types also have an <literal>=</> operator, but
<literal>=</> compares
Extend r-tree operator classes to handle Y-direction tests equivalent to the existing X-direction tests. An rtree class now includes 4 actual 2-D tests, 4 1-D X-direction tests, and 4 1-D Y-direction tests. This involved adding four new Y-direction test operators for each of box and polygon; I followed the PostGIS project's lead as to the names of these operators. NON BACKWARDS COMPATIBLE CHANGE: the poly_overleft (&<) and poly_overright (&>) operators now have semantics comparable to box_overleft and box_overright. This is necessary to make r-tree indexes work correctly on polygons. Also, I changed circle_left and circle_right to agree with box_left and box_right --- formerly they allowed the boundaries to touch. This isn't actually essential given the lack of any r-tree opclass for circles, but it seems best to sync all the definitions while we are at it.
2005-06-24 22:53:34 +02:00
for equal <emphasis>areas</> only. The other scalar comparison operators
(<literal>&lt;=</> and so on) likewise compare areas for these types.
</para>
</caution>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<table id="functions-geometry-op-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title>Geometric Operators</title>
<tgroup cols="3">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Operator</entry>
<entry>Description</entry>
<entry>Example</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>+</literal> </entry>
<entry>Translation</entry>
<entry><literal>box '((0,0),(1,1))' + point '(2.0,0)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>-</literal> </entry>
<entry>Translation</entry>
<entry><literal>box '((0,0),(1,1))' - point '(2.0,0)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>*</literal> </entry>
<entry>Scaling/rotation</entry>
<entry><literal>box '((0,0),(1,1))' * point '(2.0,0)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>/</literal> </entry>
<entry>Scaling/rotation</entry>
<entry><literal>box '((0,0),(2,2))' / point '(2.0,0)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>#</literal> </entry>
<entry>Point or box of intersection</entry>
<entry><literal>'((1,-1),(-1,1))' # '((1,1),(-1,-1))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>#</literal> </entry>
<entry>Number of points in path or polygon</entry>
<entry><literal># '((1,0),(0,1),(-1,0))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>@-@</literal> </entry>
<entry>Length or circumference</entry>
<entry><literal>@-@ path '((0,0),(1,0))'</literal></entry>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>@@</literal> </entry>
<entry>Center</entry>
<entry><literal>@@ circle '((0,0),10)'</literal></entry>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>##</literal> </entry>
<entry>Closest point to first operand on second operand</entry>
<entry><literal>point '(0,0)' ## lseg '((2,0),(0,2))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;-&gt;</literal> </entry>
<entry>Distance between</entry>
<entry><literal>circle '((0,0),1)' &lt;-&gt; circle '((5,0),1)'</literal></entry>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&amp;&amp;</literal> </entry>
<entry>Overlaps?</entry>
<entry><literal>box '((0,0),(1,1))' &amp;&amp; box '((0,0),(2,2))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Extend r-tree operator classes to handle Y-direction tests equivalent to the existing X-direction tests. An rtree class now includes 4 actual 2-D tests, 4 1-D X-direction tests, and 4 1-D Y-direction tests. This involved adding four new Y-direction test operators for each of box and polygon; I followed the PostGIS project's lead as to the names of these operators. NON BACKWARDS COMPATIBLE CHANGE: the poly_overleft (&<) and poly_overright (&>) operators now have semantics comparable to box_overleft and box_overright. This is necessary to make r-tree indexes work correctly on polygons. Also, I changed circle_left and circle_right to agree with box_left and box_right --- formerly they allowed the boundaries to touch. This isn't actually essential given the lack of any r-tree opclass for circles, but it seems best to sync all the definitions while we are at it.
2005-06-24 22:53:34 +02:00
<row>
<entry> <literal>&lt;&lt;</literal> </entry>
<entry>Is strictly left of?</entry>
<entry><literal>circle '((0,0),1)' &lt;&lt; circle '((5,0),1)'</literal></entry>
</row>
<row>
<entry> <literal>&gt;&gt;</literal> </entry>
<entry>Is strictly right of?</entry>
<entry><literal>circle '((5,0),1)' &gt;&gt; circle '((0,0),1)'</literal></entry>
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&amp;&lt;</literal> </entry>
<entry>Does not extend to the right of?</entry>
<entry><literal>box '((0,0),(1,1))' &amp;&lt; box '((0,0),(2,2))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&amp;&gt;</literal> </entry>
<entry>Does not extend to the left of?</entry>
<entry><literal>box '((0,0),(3,3))' &amp;&gt; box '((0,0),(2,2))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Extend r-tree operator classes to handle Y-direction tests equivalent to the existing X-direction tests. An rtree class now includes 4 actual 2-D tests, 4 1-D X-direction tests, and 4 1-D Y-direction tests. This involved adding four new Y-direction test operators for each of box and polygon; I followed the PostGIS project's lead as to the names of these operators. NON BACKWARDS COMPATIBLE CHANGE: the poly_overleft (&<) and poly_overright (&>) operators now have semantics comparable to box_overleft and box_overright. This is necessary to make r-tree indexes work correctly on polygons. Also, I changed circle_left and circle_right to agree with box_left and box_right --- formerly they allowed the boundaries to touch. This isn't actually essential given the lack of any r-tree opclass for circles, but it seems best to sync all the definitions while we are at it.
2005-06-24 22:53:34 +02:00
<entry> <literal>&lt;&lt;|</literal> </entry>
<entry>Is strictly below?</entry>
<entry><literal>box '((0,0),(3,3))' &lt;&lt;| box '((3,4),(5,5))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Extend r-tree operator classes to handle Y-direction tests equivalent to the existing X-direction tests. An rtree class now includes 4 actual 2-D tests, 4 1-D X-direction tests, and 4 1-D Y-direction tests. This involved adding four new Y-direction test operators for each of box and polygon; I followed the PostGIS project's lead as to the names of these operators. NON BACKWARDS COMPATIBLE CHANGE: the poly_overleft (&<) and poly_overright (&>) operators now have semantics comparable to box_overleft and box_overright. This is necessary to make r-tree indexes work correctly on polygons. Also, I changed circle_left and circle_right to agree with box_left and box_right --- formerly they allowed the boundaries to touch. This isn't actually essential given the lack of any r-tree opclass for circles, but it seems best to sync all the definitions while we are at it.
2005-06-24 22:53:34 +02:00
<entry> <literal>|&gt;&gt;</literal> </entry>
<entry>Is strictly above?</entry>
<entry><literal>box '((3,4),(5,5))' |&gt;&gt; box '((0,0),(3,3))'</literal></entry>
</row>
<row>
<entry> <literal>&amp;&lt;|</literal> </entry>
<entry>Does not extend above?</entry>
<entry><literal>box '((0,0),(1,1))' &amp;&lt;| box '((0,0),(2,2))'</literal></entry>
</row>
<row>
<entry> <literal>|&amp;&gt;</literal> </entry>
<entry>Does not extend below?</entry>
<entry><literal>box '((0,0),(3,3))' |&amp;&gt; box '((0,0),(2,2))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;^</literal> </entry>
Extend r-tree operator classes to handle Y-direction tests equivalent to the existing X-direction tests. An rtree class now includes 4 actual 2-D tests, 4 1-D X-direction tests, and 4 1-D Y-direction tests. This involved adding four new Y-direction test operators for each of box and polygon; I followed the PostGIS project's lead as to the names of these operators. NON BACKWARDS COMPATIBLE CHANGE: the poly_overleft (&<) and poly_overright (&>) operators now have semantics comparable to box_overleft and box_overright. This is necessary to make r-tree indexes work correctly on polygons. Also, I changed circle_left and circle_right to agree with box_left and box_right --- formerly they allowed the boundaries to touch. This isn't actually essential given the lack of any r-tree opclass for circles, but it seems best to sync all the definitions while we are at it.
2005-06-24 22:53:34 +02:00
<entry>Is below (allows touching)?</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>circle '((0,0),1)' &lt;^ circle '((0,5),1)'</literal></entry>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&gt;^</literal> </entry>
Extend r-tree operator classes to handle Y-direction tests equivalent to the existing X-direction tests. An rtree class now includes 4 actual 2-D tests, 4 1-D X-direction tests, and 4 1-D Y-direction tests. This involved adding four new Y-direction test operators for each of box and polygon; I followed the PostGIS project's lead as to the names of these operators. NON BACKWARDS COMPATIBLE CHANGE: the poly_overleft (&<) and poly_overright (&>) operators now have semantics comparable to box_overleft and box_overright. This is necessary to make r-tree indexes work correctly on polygons. Also, I changed circle_left and circle_right to agree with box_left and box_right --- formerly they allowed the boundaries to touch. This isn't actually essential given the lack of any r-tree opclass for circles, but it seems best to sync all the definitions while we are at it.
2005-06-24 22:53:34 +02:00
<entry>Is above (allows touching)?</entry>
More < and > cleanups converted to ampersands.
2005-01-22 23:56:36 +01:00
<entry><literal>circle '((0,5),1)' &gt;^ circle '((0,0),1)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>?#</literal> </entry>
<entry>Intersects?</entry>
<entry><literal>lseg '((-1,0),(1,0))' ?# box '((-2,-2),(2,2))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>?-</literal> </entry>
<entry>Is horizontal?</entry>
<entry><literal>?- lseg '((-1,0),(1,0))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>?-</literal> </entry>
<entry>Are horizontally aligned?</entry>
<entry><literal>point '(1,0)' ?- point '(0,0)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>?|</literal> </entry>
<entry>Is vertical?</entry>
<entry><literal>?| lseg '((-1,0),(1,0))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>?|</literal> </entry>
<entry>Are vertically aligned?</entry>
<entry><literal>point '(0,1)' ?| point '(0,0)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>?-|</literal> </entry>
<entry>Is perpendicular?</entry>
<entry><literal>lseg '((0,0),(0,1))' ?-| lseg '((0,0),(1,0))'</literal></entry>
Improve description of geometric operators.
2003-03-03 04:31:23 +01:00
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>?||</literal> </entry>
<entry>Are parallel?</entry>
<entry><literal>lseg '((-1,0),(1,0))' ?|| lseg '((-1,2),(1,2))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Rename contains/contained-by operators to @> and <@, per discussion that agreed these symbols are less easily confused. I made new pg_operator entries (with new OIDs) for the old names, so as to provide backward compatibility while making it pretty easy to remove the old names in some future release cycle. This commit only touches the core datatypes, contrib will be fixed separately.
2006-09-10 02:29:35 +02:00
<entry> <literal>@&gt;</literal> </entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Contains?</entry>
Rename contains/contained-by operators to @> and <@, per discussion that agreed these symbols are less easily confused. I made new pg_operator entries (with new OIDs) for the old names, so as to provide backward compatibility while making it pretty easy to remove the old names in some future release cycle. This commit only touches the core datatypes, contrib will be fixed separately.
2006-09-10 02:29:35 +02:00
<entry><literal>circle '((0,0),2)' @&gt; point '(1,1)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Rename contains/contained-by operators to @> and <@, per discussion that agreed these symbols are less easily confused. I made new pg_operator entries (with new OIDs) for the old names, so as to provide backward compatibility while making it pretty easy to remove the old names in some future release cycle. This commit only touches the core datatypes, contrib will be fixed separately.
2006-09-10 02:29:35 +02:00
<entry> <literal>&lt;@</literal> </entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Contained in or on?</entry>
Rename contains/contained-by operators to @> and <@, per discussion that agreed these symbols are less easily confused. I made new pg_operator entries (with new OIDs) for the old names, so as to provide backward compatibility while making it pretty easy to remove the old names in some future release cycle. This commit only touches the core datatypes, contrib will be fixed separately.
2006-09-10 02:29:35 +02:00
<entry><literal>point '(1,1)' &lt;@ circle '((0,0),2)'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>~=</literal> </entry>
<entry>Same as?</entry>
<entry><literal>polygon '((0,0),(1,1))' ~= polygon '((1,1),(0,0))'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
</tbody>
</tgroup>
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Rename contains/contained-by operators to @> and <@, per discussion that agreed these symbols are less easily confused. I made new pg_operator entries (with new OIDs) for the old names, so as to provide backward compatibility while making it pretty easy to remove the old names in some future release cycle. This commit only touches the core datatypes, contrib will be fixed separately.
2006-09-10 02:29:35 +02:00
<note>
<para>
Before <productname>PostgreSQL</productname> 8.2, the containment
operators <literal>@&gt;</> and <literal>&lt;@</> were respectively
called <literal>~</> and <literal>@</>. These names are still
available, but are deprecated and will eventually be retired.
</para>
</note>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>area</primary>
</indexterm>
<indexterm>
<primary>center</primary>
</indexterm>
<indexterm>
<primary>diameter</primary>
</indexterm>
<indexterm>
<primary>height</primary>
</indexterm>
<indexterm>
<primary>isclosed</primary>
</indexterm>
<indexterm>
<primary>isopen</primary>
</indexterm>
<indexterm>
<primary>length</primary>
</indexterm>
<indexterm>
<primary>npoints</primary>
</indexterm>
<indexterm>
<primary>pclose</primary>
</indexterm>
<indexterm>
<primary>popen</primary>
</indexterm>
<indexterm>
<primary>radius</primary>
</indexterm>
<indexterm>
<primary>width</primary>
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<table id="functions-geometry-func-table">
Minor updates for release.
1999-06-14 09:36:12 +02:00
<title>Geometric Functions</title>
<tgroup cols="4">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>area</function>(<replaceable>object</>)</literal></entry>
<entry><type>double precision</type></entry>
<entry>area</entry>
<entry><literal>area(box '((0,0),(1,1))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>center</function>(<replaceable>object</>)</literal></entry>
<entry><type>point</type></entry>
<entry>center</entry>
<entry><literal>center(box '((0,0),(1,2))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>diameter</function>(<type>circle</>)</literal></entry>
<entry><type>double precision</type></entry>
<entry>diameter of circle</entry>
<entry><literal>diameter(circle '((0,0),2.0)')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>height</function>(<type>box</>)</literal></entry>
<entry><type>double precision</type></entry>
<entry>vertical size of box</entry>
<entry><literal>height(box '((0,0),(1,1))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>isclosed</function>(<type>path</>)</literal></entry>
<entry><type>boolean</type></entry>
<entry>a closed path?</entry>
<entry><literal>isclosed(path '((0,0),(1,1),(2,0))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>isopen</function>(<type>path</>)</literal></entry>
<entry><type>boolean</type></entry>
<entry>an open path?</entry>
<entry><literal>isopen(path '[(0,0),(1,1),(2,0)]')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>length</function>(<replaceable>object</>)</literal></entry>
<entry><type>double precision</type></entry>
<entry>length</entry>
<entry><literal>length(path '((-1,0),(1,0))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Some improvements in geometric-operators documentation.
2002-08-08 16:29:07 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>npoints</function>(<type>path</>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>number of points</entry>
<entry><literal>npoints(path '[(0,0),(1,1),(2,0)]')</literal></entry>
Some improvements in geometric-operators documentation.
2002-08-08 16:29:07 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>npoints</function>(<type>polygon</>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>number of points</entry>
<entry><literal>npoints(polygon '((1,1),(0,0))')</literal></entry>
Some improvements in geometric-operators documentation.
2002-08-08 16:29:07 +02:00
</row>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>pclose</function>(<type>path</>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
<![IGNORE[
<!-- Not defined by this name. Implements the intersection operator '#' -->
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>point</function>(<type>lseg</>, <type>lseg</>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Markup additions and spell check. (covers User's Guide)
2001-09-09 19:21:59 +02:00
]]>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>popen</function>(<type>path</>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>radius</function>(<type>circle</type>)</literal></entry>
<entry><type>double precision</type></entry>
<entry>radius of circle</entry>
<entry><literal>radius(circle '((0,0),2.0)')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>width</function>(<type>box</>)</literal></entry>
<entry><type>double precision</type></entry>
<entry>horizontal size of box</entry>
<entry><literal>width(box '((0,0),(1,1))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
</tbody>
</tgroup>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</table>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<table id="functions-geometry-conv-table">
Minor updates for release.
1999-06-14 09:36:12 +02:00
<title>Geometric Type Conversion Functions</title>
<tgroup cols="4">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>box</function>(<type>circle</type>)</literal></entry>
<entry><type>box</type></entry>
<entry>circle to box</entry>
<entry><literal>box(circle '((0,0),2.0)')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>box</function>(<type>point</type>, <type>point</type>)</literal></entry>
<entry><type>box</type></entry>
<entry>points to box</entry>
<entry><literal>box(point '(0,0)', point '(1,1)')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>box</function>(<type>polygon</type>)</literal></entry>
<entry><type>box</type></entry>
<entry>polygon to box</entry>
<entry><literal>box(polygon '((0,0),(1,1),(2,0))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>circle</function>(<type>box</type>)</literal></entry>
<entry><type>circle</type></entry>
<entry>box to circle</entry>
<entry><literal>circle(box '((0,0),(1,1))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>circle</function>(<type>point</type>, <type>double precision</type>)</literal></entry>
<entry><type>circle</type></entry>
Add docs for a couple of formerly-undocumented geometric conversion functions.
2005-01-26 21:42:19 +01:00
<entry>center and radius to circle</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>circle(point '(0,0)', 2.0)</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Fix some bogosities in geometric-function documentation: add an entry for circle(polygon), which was missing; remove bogus entry for point(lseg, lseg), which does not exist, and the documentation seemed to describe lseg_interpt, which we already document as an operator not a function. Also remove entry for box_intersect, which likewise is preferentially used via the operator #.
2005-07-19 00:34:14 +02:00
<row>
<entry><literal><function>circle</function>(<type>polygon</type>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>lseg</function>(<type>box</type>)</literal></entry>
<entry><type>lseg</type></entry>
<entry>box diagonal to line segment</entry>
<entry><literal>lseg(box '((-1,0),(1,0))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>lseg</function>(<type>point</type>, <type>point</type>)</literal></entry>
<entry><type>lseg</type></entry>
<entry>points to line segment</entry>
<entry><literal>lseg(point '(-1,0)', point '(1,0)')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>path</function>(<type>polygon</type>)</literal></entry>
<entry><type>point</type></entry>
<entry>polygon to path</entry>
<entry><literal>path(polygon '((0,0),(1,1),(2,0))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Add docs for a couple of formerly-undocumented geometric conversion functions.
2005-01-26 21:42:19 +01:00
<row>
<entry><literal><function>point</function>(<type>double
precision</type>, <type>double precision</type>)</literal></entry>
<entry><type>point</type></entry>
<entry>construct point</entry>
<entry><literal>point(23.4, -44.5)</literal></entry>
</row>
<row>
<entry><literal><function>point</function>(<type>box</type>)</literal></entry>
<entry><type>point</type></entry>
<entry>center of box</entry>
<entry><literal>point(box '((-1,0),(1,0))')</literal></entry>
</row>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>point</function>(<type>circle</type>)</literal></entry>
<entry><type>point</type></entry>
<entry>center of circle</entry>
<entry><literal>point(circle '((0,0),2.0)')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Add docs for a couple of formerly-undocumented geometric conversion functions.
2005-01-26 21:42:19 +01:00
<row>
<entry><literal><function>point</function>(<type>lseg</type>)</literal></entry>
<entry><type>point</type></entry>
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
<entry>center of line segment</entry>
Add docs for a couple of formerly-undocumented geometric conversion functions.
2005-01-26 21:42:19 +01:00
<entry><literal>point(lseg '((-1,0),(1,0))')</literal></entry>
</row>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>point</function>(<type>polygon</type>)</literal></entry>
<entry><type>point</type></entry>
<entry>center of polygon</entry>
<entry><literal>point(polygon '((0,0),(1,1),(2,0))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>polygon</function>(<type>box</type>)</literal></entry>
<entry><type>polygon</type></entry>
<entry>box to 4-point polygon</entry>
<entry><literal>polygon(box '((0,0),(1,1))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>polygon</function>(<type>circle</type>)</literal></entry>
<entry><type>polygon</type></entry>
<entry>circle to 12-point polygon</entry>
<entry><literal>polygon(circle '((0,0),2.0)')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>polygon</function>(<replaceable class="parameter">npts</replaceable>, <type>circle</type>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>polygon</function>(<type>path</type>)</literal></entry>
<entry><type>polygon</type></entry>
<entry>path to polygon</entry>
<entry><literal>polygon(path '((0,0),(1,1),(2,0))')</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
</tbody>
</tgroup>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</table>
Some improvements in geometric-operators documentation.
2002-08-08 16:29:07 +02:00
<para>
It is possible to access the two component numbers of a <type>point</>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
as though it were an array with indices 0 and 1. For example, if
Some improvements in geometric-operators documentation.
2002-08-08 16:29:07 +02:00
<literal>t.p</> is a <type>point</> column then
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal>SELECT p[0] FROM t</> retrieves the X coordinate and
Some improvements in geometric-operators documentation.
2002-08-08 16:29:07 +02:00
<literal>UPDATE t SET p[1] = ...</> changes the Y coordinate.
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
In the same way, a value of type <type>box</> or <type>lseg</> may be treated
as an array of two <type>point</> values.
Some improvements in geometric-operators documentation.
2002-08-08 16:29:07 +02:00
</para>
Small patch that adds some documentation for the area() function. Specifically, point out that intersecting points in a path will yield (most likely), unexpected results. Visually these are identical paths, but mathematically they're not the same. Ex: area | plan ------ +----------------------------------------------------------------------- ------------------- -0 | ((0,0),(0,1),(2,1),(2,2),(1,2),(1,0),(0,0)) 2 | ((0,0),(0,1),(1,1),(1,2),(2,2),(2,1),(1,1),(1,0),(0,0)) The current algorithm for area(PATH) is very quick, but only handles non-intersecting paths. I'm going to work on two other functions for the PATH data type that determines if a PATH is intersecting or not, and a function that returns the area() for an intersecting PATH. The intersecting area() function will be considerably slower (I think it's going to be O(n!) or worse instead of the current O(n), but that comes with the territory). Sean Chittenden
2004-06-02 23:34:49 +02:00
<para>
The <function>area</function> function works for the types
<type>box</type>, <type>circle</type>, and <type>path</type>.
The <function>area</function> function only works on the
<type>path</type> data type if the points in the
<type>path</type> are non-intersecting. For example, the
<type>path</type>
<literal>'((0,0),(0,1),(2,1),(2,2),(1,2),(1,0),(0,0))'::PATH</literal>
won't work, however, the following visually identical
<type>path</type>
<literal>'((0,0),(0,1),(1,1),(1,2),(2,2),(2,1),(1,1),(1,0),(0,0))'::PATH</literal>
will work. If the concept of an intersecting versus
non-intersecting <type>path</type> is confusing, draw both of the
above <type>path</type>s side by side on a piece of graph paper.
</para>
Include mention of CASE, COALESCE, and IFNULL. Add date/time parsing procedure (perhaps should be in appendix). Add time zone information (ditto). Update keyword list.
1999-05-12 09:32:47 +02:00
</sect1>
Split function and operator User Guide info from datatype.sgml into separate files. Add type conversion information. Format historical release notes.
1998-07-08 15:53:15 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<sect1 id="functions-net">
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<title>Network Address Functions and Operators</title>
Include new cidr and inet data types.
1998-10-27 07:14:41 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="cidr-inet-operators-table"> shows the operators
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
available for the <type>cidr</type> and <type>inet</type> types.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
The operators <literal>&lt;&lt;</literal>,
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<literal>&lt;&lt;=</literal>, <literal>&gt;&gt;</literal>, and
<literal>&gt;&gt;=</literal> test for subnet inclusion. They
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
consider only the network parts of the two addresses, ignoring any
host part, and determine whether one network part is identical to
or a subnet of the other.
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<table id="cidr-inet-operators-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title><type>cidr</type> and <type>inet</type> Operators</title>
<tgroup cols="3">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Operator</entry>
<entry>Description</entry>
<entry>Example</entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;</literal> </entry>
<entry>is less than</entry>
<entry><literal>inet '192.168.1.5' &lt; inet '192.168.1.6'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;=</literal> </entry>
<entry>is less than or equal</entry>
<entry><literal>inet '192.168.1.5' &lt;= inet '192.168.1.5'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>=</literal> </entry>
<entry>equals</entry>
<entry><literal>inet '192.168.1.5' = inet '192.168.1.5'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&gt;=</literal> </entry>
<entry>is greater or equal</entry>
<entry><literal>inet '192.168.1.5' &gt;= inet '192.168.1.5'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&gt;</literal> </entry>
<entry>is greater than</entry>
<entry><literal>inet '192.168.1.5' &gt; inet '192.168.1.4'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;&gt;</literal> </entry>
<entry>is not equal</entry>
<entry><literal>inet '192.168.1.5' &lt;&gt; inet '192.168.1.4'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;&lt;</literal> </entry>
<entry>is contained within</entry>
<entry><literal>inet '192.168.1.5' &lt;&lt; inet '192.168.1/24'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;&lt;=</literal> </entry>
<entry>is contained within or equals</entry>
<entry><literal>inet '192.168.1/24' &lt;&lt;= inet '192.168.1/24'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&gt;&gt;</literal> </entry>
<entry>contains</entry>
<entry><literal>inet '192.168.1/24' &gt;&gt; inet '192.168.1.5'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&gt;&gt;=</literal> </entry>
<entry>contains or equals</entry>
<entry><literal>inet '192.168.1/24' &gt;&gt;= inet '192.168.1/24'</literal></entry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</row>
Add INET/CIDR operators: and, or, not, plus int8, minus int8, and inet minus inet. Stephen R. van den Berg
2006-02-11 04:32:41 +01:00
<row>
<entry> <literal>~</literal> </entry>
<entry>bitwise NOT</entry>
<entry><literal>~ inet '192.168.1.6'</literal></entry>
</row>
<row>
<entry> <literal>&amp;</literal> </entry>
<entry>bitwise AND</entry>
<entry><literal>inet '192.168.1.6' &amp; inet '0.0.0.255'</literal></entry>
</row>
<row>
<entry> <literal>|</literal> </entry>
<entry>bitwise OR</entry>
<entry><literal>inet '192.168.1.6' | inet '0.0.0.255'</literal></entry>
</row>
<row>
<entry> <literal>+</literal> </entry>
<entry>addition</entry>
<entry><literal>inet '192.168.1.6' + 25</literal></entry>
</row>
<row>
<entry> <literal>-</literal> </entry>
<entry>subtraction</entry>
<entry><literal>inet '192.168.1.43' - 36</literal></entry>
</row>
<row>
<entry> <literal>-</literal> </entry>
<entry>subtraction</entry>
<entry><literal>inet '192.168.1.43' - inet '192.168.1.19'</literal></entry>
</row>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
</tbody>
</tgroup>
</table>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="cidr-inet-functions-table"> shows the functions
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
available for use with the <type>cidr</type> and <type>inet</type>
types. The <function>host</function>,
<function>text</function>, and <function>abbrev</function>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
functions are primarily intended to offer alternative display
Clean up the INET-vs-CIDR situation. Get rid of the internal is_cidr flag and rely exclusively on the SQL type system to tell the difference between the types. Prevent creation of invalid CIDR values via casting from INET or set_masklen() --- both of these operations now silently zero any bits to the right of the netmask. Remove duplicate CIDR comparison operators, letting the type rely on the INET operators instead.
2006-01-26 03:35:51 +01:00
formats.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<table id="cidr-inet-functions-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title><type>cidr</type> and <type>inet</type> Functions</title>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
<tgroup cols="5">
Minor updates for release.
1999-06-14 09:36:12 +02:00
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
</thead>
<tbody>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>abbrev</function>(<type>inet</type>)</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><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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>broadcast</function>(<type>inet</type>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>family</function>(<type>inet</type>)</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>family('::1')</literal></entry>
<entry><literal>6</literal></entry>
</row>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>host</function>(<type>inet</type>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>hostmask</function>(<type>inet</type>)</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>
Minor updates for release.
1999-06-14 09:36:12 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>masklen</function>(<type>inet</type>)</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>extract netmask length</entry>
<entry><literal>masklen('192.168.1.5/24')</literal></entry>
<entry><literal>24</literal></entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>netmask</function>(<type>inet</type>)</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>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>network</function>(<type>inet</type>)</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>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>set_masklen</function>(<type>inet</type>, <type>int</type>)</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>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
</row>
Change default output formatting for CIDR to be unabbreviated, per recommendation from Paul Vixie. Add a new abbrev() function to produce abbreviated format as text. No forced initdb, but new function is not available unless you do an initdb or add the pg_proc row manually.
2000-12-22 19:00:24 +01:00
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>set_masklen</function>(<type>cidr</type>, <type>int</type>)</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>
Clean up the INET-vs-CIDR situation. Get rid of the internal is_cidr flag and rely exclusively on the SQL type system to tell the difference between the types. Prevent creation of invalid CIDR values via casting from INET or set_masklen() --- both of these operations now silently zero any bits to the right of the netmask. Remove duplicate CIDR comparison operators, letting the type rely on the INET operators instead.
2006-01-26 03:35:51 +01:00
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>text</function>(<type>inet</type>)</literal></entry>
Clean up the INET-vs-CIDR situation. Get rid of the internal is_cidr flag and rely exclusively on the SQL type system to tell the difference between the types. Prevent creation of invalid CIDR values via casting from INET or set_masklen() --- both of these operations now silently zero any bits to the right of the netmask. Remove duplicate CIDR comparison operators, letting the type rely on the INET operators instead.
2006-01-26 03:35:51 +01:00
<entry><type>text</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>extract IP address and netmask length as text</entry>
<entry><literal>text(inet '192.168.1.5')</literal></entry>
<entry><literal>192.168.1.5/32</literal></entry>
Fix a typo in a recent commit to func.sgml that apparently broke the doc build for some versions of OpenJade (unfortunately, my local version of OpenJade didn't report the error...) -- thanks to Andrew Dunstan for the report.
2004-02-29 16:45:53 +01:00
</row>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
</tbody>
</tgroup>
</table>
Clean up the INET-vs-CIDR situation. Get rid of the internal is_cidr flag and rely exclusively on the SQL type system to tell the difference between the types. Prevent creation of invalid CIDR values via casting from INET or set_masklen() --- both of these operations now silently zero any bits to the right of the netmask. Remove duplicate CIDR comparison operators, letting the type rely on the INET operators instead.
2006-01-26 03:35:51 +01:00
<para>
Any <type>cidr</> value can be cast to <type>inet</> implicitly
or explicitly; therefore, the functions shown above as operating on
<type>inet</> also work on <type>cidr</> values. (Where there are
separate functions for <type>inet</> and <type>cidr</>, it is because
the behavior should be different for the two cases.)
Also, it is permitted to cast an <type>inet</> value to <type>cidr</>.
When this is done, any bits to the right of the netmask are silently zeroed
to create a valid <type>cidr</> value.
In addition,
you can cast a text value to <type>inet</> or <type>cidr</>
using normal casting syntax: for example,
<literal>inet(<replaceable>expression</>)</literal> or
<literal><replaceable>colname</>::cidr</literal>.
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
<xref linkend="macaddr-functions-table"> shows the functions
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
available for use with the <type>macaddr</type> type. The function
<literal><function>trunc</function>(<type>macaddr</type>)</literal> returns a MAC
address with the last 3 bytes set to zero. This can be used to
Rename contains/contained-by operators to @> and <@, per discussion that agreed these symbols are less easily confused. I made new pg_operator entries (with new OIDs) for the old names, so as to provide backward compatibility while making it pretty easy to remove the old names in some future release cycle. This commit only touches the core datatypes, contrib will be fixed separately.
2006-09-10 02:29:35 +02:00
associate the remaining prefix with a manufacturer.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<table id="macaddr-functions-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title><type>macaddr</type> Functions</title>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
<tgroup cols="5">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</row>
Adjust INET/CIDR display conventions and reimplement some INET/CIDR functions, per recent discussions on pghackers. For now, I have called the verbose-display formatting function text(), but will reconsider if enough people object. initdb forced.
2000-11-10 21:13:27 +01:00
</thead>
<tbody>
Convert macaddr documentation to DocBook, update outdated information.
2000-10-04 17:47:45 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal><function>trunc</function>(<type>macaddr</type>)</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>
<entry><literal>12:34:56:00:00:00</literal></entry>
Convert macaddr documentation to DocBook, update outdated information.
2000-10-04 17:47:45 +02:00
</row>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</tbody>
</tgroup>
</table>
Convert macaddr documentation to DocBook, update outdated information.
2000-10-04 17:47:45 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
The <type>macaddr</type> type also supports the standard relational
operators (<literal>&gt;</literal>, <literal>&lt;=</literal>, etc.) for
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
lexicographical ordering.
</para>
Minor updates for release.
1999-06-14 09:36:12 +02:00
</sect1>
Include new cidr and inet data types.
1998-10-27 07:14:41 +01:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<sect1 id="functions-sequence">
This patch makes some SGML markup more consistent and makes a small improvement to the SSL auth docs.
2003-12-14 00:59:07 +01:00
<title>Sequence Manipulation Functions</title>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>sequence</primary>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</indexterm>
<indexterm>
<primary>nextval</primary>
</indexterm>
<indexterm>
<primary>currval</primary>
</indexterm>
Add a function lastval(), which returns the value returned by the last nextval() or setval() performed by the current session. Update the docs, add regression tests, and bump the catalog version. Patch from Dennis Björklund, various improvements by Neil Conway.
2005-06-07 09:08:35 +02:00
<indexterm>
<primary>lastval</primary>
</indexterm>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<indexterm>
<primary>setval</primary>
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
This section describes <productname>PostgreSQL</productname>'s functions
for operating on <firstterm>sequence objects</firstterm>.
Sequence objects (also called sequence generators or
just sequences) are special single-row tables created with
<command>CREATE SEQUENCE</command>. A sequence object is usually used to
generate unique identifiers for rows of a table. The sequence functions,
listed in <xref linkend="functions-sequence-table">,
provide simple, multiuser-safe methods for obtaining successive
sequence values from sequence objects.
</para>
<table id="functions-sequence-table">
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<title>Sequence Functions</title>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<tgroup cols="3">
<thead>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<row><entry>Function</entry> <entry>Return Type</entry> <entry>Description</entry></row>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</thead>
<tbody>
<row>
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
<entry><literal><function>currval</function>(<type>regclass</type>)</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>bigint</type></entry>
Add a function lastval(), which returns the value returned by the last nextval() or setval() performed by the current session. Update the docs, add regression tests, and bump the catalog version. Patch from Dennis Björklund, various improvements by Neil Conway.
2005-06-07 09:08:35 +02:00
<entry>Return value most recently obtained with
<function>nextval</function> for specified sequence</entry>
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>nextval</function>(<type>regclass</type>)</literal></entry>
Add a function lastval(), which returns the value returned by the last nextval() or setval() performed by the current session. Update the docs, add regression tests, and bump the catalog version. Patch from Dennis Björklund, various improvements by Neil Conway.
2005-06-07 09:08:35 +02:00
<entry><type>bigint</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>Advance sequence and return new value</entry>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</row>
<row>
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
<entry><literal><function>setval</function>(<type>regclass</type>, <type>bigint</type>)</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>bigint</type></entry>
<entry>Set sequence's current value</entry>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</row>
<row>
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
<entry><literal><function>setval</function>(<type>regclass</type>, <type>bigint</type>, <type>boolean</type>)</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>bigint</type></entry>
<entry>Set sequence's current value and <literal>is_called</literal> flag</entry>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</row>
</tbody>
</tgroup>
</table>
<para>
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
The sequence to be operated on by a sequence-function call is specified by
a <type>regclass</> argument, which is just the OID of the sequence in the
<structname>pg_class</> system catalog. You do not have to look up the
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
OID by hand, however, since the <type>regclass</> data type's input
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
converter will do the work for you. Just write the sequence name enclosed
in single quotes, so that it looks like a literal constant. To
The "random" regression test uses a function called oidrand(), which takes two parameters, an OID x and an integer y, and returns "true" with probability 1/y (the OID argument is ignored). This can be useful -- for example, it can be used to select a random sampling of the rows in a table (which is what the "random" regression test uses it for). This patch removes that function, because it was old and messy. The old function had the following problems: - it was undocumented - it was poorly named - it was designed to workaround an optimizer bug that no longer exists (the OID argument is to ensure that the optimizer won't optimize away calls to the function; AFAIK marking the function as 'volatile' suffices nowadays) - it used a different random-number generation technique than the other PSRNG-related functions in the backend do (it called random() like they do, but it had its own logic for setting a set and deciding when to reseed the RNG). Ok, this patch removes oidrand(), oidsrand(), and userfntest(), and improves the SGML docs a little bit (un-commenting the setseed() documentation). Neil Conway
2003-02-13 06:24:04 +01:00
achieve some compatibility with the handling of ordinary
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
<acronym>SQL</acronym> names, the string will be converted to lowercase
unless it contains double quotes around the sequence name. Thus
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<programlisting>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
nextval('foo') <lineannotation>operates on sequence <literal>foo</literal></>
nextval('FOO') <lineannotation>operates on sequence <literal>foo</literal></>
nextval('"Foo"') <lineannotation>operates on sequence <literal>Foo</literal></>
Add current_schema() and current_schemas() inquiry functions. Update has_table_privilege functions to cope with schema-qualified names in the same way as nextval() and others.
2002-04-26 03:24:08 +02:00
</programlisting>
The sequence name can be schema-qualified if necessary:
<programlisting>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
nextval('myschema.foo') <lineannotation>operates on <literal>myschema.foo</literal></>
nextval('"myschema".foo') <lineannotation>same as above</lineannotation>
nextval('foo') <lineannotation>searches search path for <literal>foo</literal></>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</programlisting>
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
See <xref linkend="datatype-oid"> for more information about
<type>regclass</>.
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</para>
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
<note>
<para>
Before <productname>PostgreSQL</productname> 8.1, the arguments of the
sequence functions were of type <type>text</>, not <type>regclass</>, and
the above-described conversion from a text string to an OID value would
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
happen at run time during each call. For backwards compatibility, this
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
facility still exists, but internally it is now handled as an implicit
coercion from <type>text</> to <type>regclass</> before the function is
invoked.
</para>
<para>
When you write the argument of a sequence function as an unadorned
literal string, it becomes a constant of type <type>regclass</>.
Since this is really just an OID, it will track the originally
identified sequence despite later renaming, schema reassignment,
etc. This <quote>early binding</> behavior is usually desirable for
sequence references in column defaults and views. But sometimes you will
want <quote>late binding</> where the sequence reference is resolved
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
at run time. To get late-binding behavior, force the constant to be
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
stored as a <type>text</> constant instead of <type>regclass</>:
<programlisting>
nextval('foo'::text) <lineannotation><literal>foo</literal> is looked up at runtime</>
</programlisting>
Note that late binding was the only behavior supported in
<productname>PostgreSQL</productname> releases before 8.1, so you
may need to do this to preserve the semantics of old applications.
</para>
<para>
Of course, the argument of a sequence function can be an expression
as well as a constant. If it is a text expression then the implicit
coercion will result in a run-time lookup.
</para>
</note>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<para>
The available sequence functions are:
<variablelist>
<varlistentry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<term><function>nextval</function></term>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<listitem>
<para>
Advance the sequence object to its next value and return that
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
value. This is done atomically: even if multiple sessions
execute <function>nextval</function> concurrently, each will safely receive
a distinct sequence value.
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</para>
</listitem>
</varlistentry>
<varlistentry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<term><function>currval</function></term>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<listitem>
<para>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
Return the value most recently obtained by <function>nextval</function>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
for this sequence in the current session. (An error is
reported if <function>nextval</function> has never been called for this
sequence in this session.) Notice that because this is returning
a session-local value, it gives a predictable answer whether or not
other sessions have executed <function>nextval</function> since the
current session did.
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</para>
</listitem>
</varlistentry>
Add a function lastval(), which returns the value returned by the last nextval() or setval() performed by the current session. Update the docs, add regression tests, and bump the catalog version. Patch from Dennis Björklund, various improvements by Neil Conway.
2005-06-07 09:08:35 +02:00
<varlistentry>
<term><function>lastval</function></term>
<listitem>
<para>
Return the value most recently returned by
<function>nextval</> in the current session. This function is
identical to <function>currval</function>, except that instead
of taking the sequence name as an argument it fetches the
value of the last sequence that <function>nextval</function>
was used on in the current session. It is an error to call
<function>lastval</function> if <function>nextval</function>
has not yet been called in the current session.
</para>
</listitem>
</varlistentry>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<varlistentry>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
<term><function>setval</function></term>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<listitem>
<para>
Reset the sequence object's counter value. The two-parameter
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
form sets the sequence's <literal>last_value</literal> field to the specified
value and sets its <literal>is_called</literal> field to <literal>true</literal>,
meaning that the next <function>nextval</function> will advance the sequence
before returning a value. In the three-parameter form,
<literal>is_called</literal> may be set either <literal>true</literal> or
<literal>false</literal>. If it's set to <literal>false</literal>,
the next <function>nextval</function> will return exactly the specified
value, and sequence advancement commences with the following
<function>nextval</function>. For example,
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<screen>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
SELECT setval('foo', 42); <lineannotation>Next <function>nextval</> will return 43</lineannotation>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
SELECT setval('foo', 42, true); <lineannotation>Same as above</lineannotation>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
SELECT setval('foo', 42, false); <lineannotation>Next <function>nextval</> will return 42</lineannotation>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</screen>
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
The result returned by <function>setval</function> is just the value of its
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
second argument.
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
Change nextval and other sequence functions to specify their sequence argument as a 'regclass' value instead of a text string. The frontend conversion of text string to pg_class OID is now encapsulated as an implicitly-invocable coercion from text to regclass. This provides backwards compatibility to the old behavior when the sequence argument is explicitly typed as 'text'. When the argument is just an unadorned literal string, it will be taken as 'regclass', which means that the stored representation will be an OID. This solves longstanding problems with renaming sequences that are referenced in default expressions, as well as new-in-8.1 problems with renaming such sequences' schemas or moving them to another schema. All per recent discussion. Along the way, fix some rather serious problems in dbmirror's support for mirroring sequence operations (int4 vs int8 confusion for instance).
2005-10-03 01:50:16 +02:00
<para>
If a sequence object has been created with default parameters,
<function>nextval</function> calls on it will return successive values
beginning with 1. Other behaviors can be obtained by using
special parameters in the <xref linkend="sql-createsequence" endterm="sql-createsequence-title"> command;
see its command reference page for more information.
</para>
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
<important>
<para>
To avoid blocking of concurrent transactions that obtain numbers from the
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
same sequence, a <function>nextval</function> operation is never rolled back;
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
that is, once a value has been fetched it is considered used, even if the
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
transaction that did the <function>nextval</function> later aborts. This means
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
that aborted transactions may leave unused <quote>holes</quote> in the
Implement SQL99 OVERLAY(). Allows substitution of a substring in a string. Implement SQL99 SIMILAR TO as a synonym for our existing operator "~". Implement SQL99 regular expression SUBSTRING(string FROM pat FOR escape). Extend the definition to make the FOR clause optional. Define textregexsubstr() to actually implement this feature. Update the regression test to include these new string features. All tests pass. Rename the regular expression support routines from "pg95_xxx" to "pg_xxx". Define CREATE CHARACTER SET in the parser per SQL99. No implementation yet.
2002-06-11 17:32:33 +02:00
sequence of assigned values. <function>setval</function> operations are never
Expand documentation for sequence functions (nextval and friends). Place it in the expected place in the User's Guide, rather than hiding it in the command reference page for CREATE SEQUENCE.
2001-11-17 23:20:34 +01:00
rolled back, either.
</para>
</important>
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<sect1 id="functions-conditional">
<title>Conditional Expressions</title>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>CASE</primary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
<indexterm>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<primary>conditional expression</primary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
This section describes the <acronym>SQL</acronym>-compliant conditional expressions
Deprecate 'current' for date/time input. Fix up references to "PostgreSQL" rather than "Postgres". Was roughly evenly split between the two before. ref/ files not yet done.
2001-11-21 06:53:41 +01:00
available in <productname>PostgreSQL</productname>.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
<tip>
<para>
If your needs go beyond the capabilities of these conditional
expressions you might want to consider writing a stored procedure
in a more expressive programming language.
</para>
</tip>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<sect2>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title><literal>CASE</></title>
<para>
The <acronym>SQL</acronym> <token>CASE</token> expression is a
generic conditional expression, similar to if/else statements in
other languages:
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<synopsis>
CASE WHEN <replaceable>condition</replaceable> THEN <replaceable>result</replaceable>
<optional>WHEN ...</optional>
<optional>ELSE <replaceable>result</replaceable></optional>
END
</synopsis>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<token>CASE</token> clauses can be used wherever
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
an expression is valid. <replaceable>condition</replaceable> is an
Enhance documentation of date/time functions. Add extract, current_date, current_time, current_timestamp. Add more examples. Remove age(), because it doesn't work like it is documented, and no one could explain it to me.
2001-02-18 18:17:17 +01:00
expression that returns a <type>boolean</type> result. If the result is true
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
then the value of the <token>CASE</token> expression is the
<replaceable>result</replaceable> that follows the condition. If the result is false any
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
subsequent <token>WHEN</token> clauses are searched in the same
manner. If no <token>WHEN</token>
<replaceable>condition</replaceable> is true then the value of the
case expression is the <replaceable>result</replaceable> in the
<token>ELSE</token> clause. If the <token>ELSE</token> clause is
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
omitted and no condition matches, the result is null.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
<para>
An example:
<screen>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
SELECT * FROM test;
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
a
---
1
2
3
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
SELECT a,
CASE WHEN a=1 THEN 'one'
WHEN a=2 THEN 'two'
ELSE 'other'
END
FROM test;
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
a | case
---+-------
1 | one
2 | two
3 | other
</screen>
</para>
<para>
Update type-coercion discussions to reflect current reality.
2000-12-17 06:55:26 +01:00
The data types of all the <replaceable>result</replaceable>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
expressions must be convertible to a single output type.
Update type-coercion discussions to reflect current reality.
2000-12-17 06:55:26 +01:00
See <xref linkend="typeconv-union-case"> for more detail.
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<para>
The following <quote>simple</quote> <token>CASE</token> expression is a
specialized variant of the general form above:
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<synopsis>
CASE <replaceable>expression</replaceable>
WHEN <replaceable>value</replaceable> THEN <replaceable>result</replaceable>
<optional>WHEN ...</optional>
<optional>ELSE <replaceable>result</replaceable></optional>
END
</synopsis>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
The
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<replaceable>expression</replaceable> is computed and compared to
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
all the <replaceable>value</replaceable> specifications in the
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<token>WHEN</token> clauses until one is found that is equal. If
no match is found, the <replaceable>result</replaceable> in the
Add more appropriate markup.
2002-09-21 20:32:54 +02:00
<token>ELSE</token> clause (or a null value) is returned. This is similar
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
to the <function>switch</function> statement in C.
</para>
<para>
The example above can be written using the simple
<token>CASE</token> syntax:
<screen>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
SELECT a,
CASE a WHEN 1 THEN 'one'
WHEN 2 THEN 'two'
ELSE 'other'
END
FROM test;
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
a | case
---+-------
1 | one
2 | two
3 | other
</screen>
Update obsolete examples of error messages; various other minor editing.
2003-09-13 00:17:24 +02:00
</para>
<para>
A <token>CASE</token> expression does not evaluate any subexpressions
that are not needed to determine the result. For example, this is a
possible way of avoiding a division-by-zero failure:
<programlisting>
SELECT ... WHERE CASE WHEN x &lt;&gt; 0 THEN y/x &gt; 1.5 ELSE false END;
</programlisting>
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</sect2>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<sect2>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title><literal>COALESCE</></title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add/edit index entries.
2003-08-31 19:32:24 +02:00
<indexterm>
<primary>COALESCE</primary>
</indexterm>
Improve documentation for COALESCE and NULLIF. Add references for NVL and IFNULL. Backpatch to 8.1.X.
2005-11-29 00:18:48 +01:00
<indexterm>
<primary>NVL</primary>
</indexterm>
<indexterm>
<primary>IFNULL</primary>
</indexterm>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<synopsis>
Adjust documentation examples to match recent error message rewordings. A couple other minor fixes.
2003-09-30 05:22:33 +02:00
<function>COALESCE</function>(<replaceable>value</replaceable> <optional>, ...</optional>)
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</synopsis>
<para>
The <function>COALESCE</function> function returns the first of its
Update obsolete examples of error messages; various other minor editing.
2003-09-13 00:17:24 +02:00
arguments that is not null. Null is returned only if all arguments
Improve documentation for COALESCE and NULLIF. Add references for NVL and IFNULL. Backpatch to 8.1.X.
2005-11-29 00:18:48 +01:00
are null. It is often used to substitute a default value for
null values when data is retrieved for display, for example:
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<programlisting>
SELECT COALESCE(description, short_description, '(none)') ...
</programlisting>
</para>
Update obsolete examples of error messages; various other minor editing.
2003-09-13 00:17:24 +02:00
<para>
Like a <token>CASE</token> expression, <function>COALESCE</function> will
not evaluate arguments that are not needed to determine the result;
that is, arguments to the right of the first non-null argument are
Improve documentation for COALESCE and NULLIF. Add references for NVL and IFNULL. Backpatch to 8.1.X.
2005-11-29 00:18:48 +01:00
not evaluated. This SQL-standard function provides capabilities similar
to <function>NVL</> and <function>IFNULL</>, which are used in some other
database systems.
Update obsolete examples of error messages; various other minor editing.
2003-09-13 00:17:24 +02:00
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</sect2>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<sect2>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
<title><literal>NULLIF</></title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
<indexterm>
Be a little more consistent about which terms are uppercased in index entries.
2003-12-26 22:30:48 +01:00
<primary>NULLIF</primary>
Add index. Only some parts of the manual set have index entries so far...
2001-05-13 00:51:36 +02:00
</indexterm>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<synopsis>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<function>NULLIF</function>(<replaceable>value1</replaceable>, <replaceable>value2</replaceable>)
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</synopsis>
<para>
Improve documentation for COALESCE and NULLIF. Add references for NVL and IFNULL. Backpatch to 8.1.X.
2005-11-29 00:18:48 +01:00
The <function>NULLIF</function> function returns a null value if
<replaceable>value1</replaceable> and <replaceable>value2</replaceable>
are equal; otherwise it returns <replaceable>value1</replaceable>.
This can be used to perform the inverse operation of the
<function>COALESCE</function> example given above:
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<programlisting>
SELECT NULLIF(value, '(none)') ...
</programlisting>
</para>
Improve documentation for COALESCE and NULLIF. Add references for NVL and IFNULL. Backpatch to 8.1.X.
2005-11-29 00:18:48 +01:00
<para>
If <replaceable>value1</replaceable> is <literal>(none)</>, return a null,
otherwise return <replaceable>value1</replaceable>.
</para>
Add note that COALESCE and NULLIF are shorthand forms of CASE.
2000-12-16 19:33:13 +01:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</sect2>
Add note that COALESCE and NULLIF are shorthand forms of CASE.
2000-12-16 19:33:13 +01:00
Add Oracle-compatible GREATEST and LEAST functions. Pavel Stehule
2005-06-27 00:05:42 +02:00
<sect2>
<title><literal>GREATEST</literal> and <literal>LEAST</literal></title>
<indexterm>
<primary>GREATEST</primary>
</indexterm>
<indexterm>
<primary>LEAST</primary>
</indexterm>
<synopsis>
<function>GREATEST</function>(<replaceable>value</replaceable> <optional>, ...</optional>)
</synopsis>
<synopsis>
<function>LEAST</function>(<replaceable>value</replaceable> <optional>, ...</optional>)
</synopsis>
<para>
The <function>GREATEST</> and <function>LEAST</> functions select the
largest or smallest value from a list of any number of expressions.
The expressions must all be convertible to a common data type, which
will be the type of the result
(see <xref linkend="typeconv-union-case"> for details). NULL values
in the list are ignored. The result will be NULL only if all the
expressions evaluate to NULL.
</para>
<para>
Note that <function>GREATEST</> and <function>LEAST</> are not in
the SQL standard, but are a common extension.
</para>
</sect2>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</sect1>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect1 id="functions-array">
<title>Array Functions and Operators</title>
Implement differentiation between CURRENT_USER and SESSION_USER as per SQL. There is still no effective difference but it will kick in once setuid functions exist (not included here). Make old getpgusername() alias for current_user.
2000-09-19 20:18:04 +02:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<xref linkend="array-operators-table"> shows the operators
available for <type>array</type> types.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="array-operators-table">
<title><type>array</type> Operators</title>
<tgroup cols="4">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Operator</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>=</literal> </entry>
<entry>equal</entry>
<entry><literal>ARRAY[1.1,2.1,3.1]::int[] = ARRAY[1,2,3]</literal></entry>
<entry><literal>t</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Implement differentiation between CURRENT_USER and SESSION_USER as per SQL. There is still no effective difference but it will kick in once setuid functions exist (not included here). Make old getpgusername() alias for current_user.
2000-09-19 20:18:04 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;&gt;</literal> </entry>
<entry>not equal</entry>
<entry><literal>ARRAY[1,2,3] &lt;&gt; ARRAY[1,2,4]</literal></entry>
<entry><literal>t</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Add current_schema() and current_schemas() inquiry functions. Update has_table_privilege functions to cope with schema-qualified names in the same way as nextval() and others.
2002-04-26 03:24:08 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;</literal> </entry>
<entry>less than</entry>
<entry><literal>ARRAY[1,2,3] &lt; ARRAY[1,2,4]</literal></entry>
<entry><literal>t</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
> > I had great difficulty in finding how to change the search path, so here > > is a patch to add some cross-referencing. Oliver Elphick
2002-08-22 06:52:17 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&gt;</literal> </entry>
<entry>greater than</entry>
<entry><literal>ARRAY[1,4,3] &gt; ARRAY[1,2,4]</literal></entry>
<entry><literal>t</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Code review for recently-added network functions. Get it to work when log_hostname is enabled, clean up documentation.
2004-06-13 21:56:52 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&lt;=</literal> </entry>
<entry>less than or equal</entry>
<entry><literal>ARRAY[1,2,3] &lt;= ARRAY[1,2,3]</literal></entry>
<entry><literal>t</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Code review for recently-added network functions. Get it to work when log_hostname is enabled, clean up documentation.
2004-06-13 21:56:52 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>&gt;=</literal> </entry>
<entry>greater than or equal</entry>
<entry><literal>ARRAY[1,4,3] &gt;= ARRAY[1,4,3]</literal></entry>
<entry><literal>t</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Code review for recently-added network functions. Get it to work when log_hostname is enabled, clean up documentation.
2004-06-13 21:56:52 +02:00
Rename contains/contained-by operators to @> and <@, per discussion that agreed these symbols are less easily confused. I made new pg_operator entries (with new OIDs) for the old names, so as to provide backward compatibility while making it pretty easy to remove the old names in some future release cycle. This commit only touches the core datatypes, contrib will be fixed separately.
2006-09-10 02:29:35 +02:00
<row>
<entry> <literal>@&gt;</literal> </entry>
<entry>contains</entry>
<entry><literal>ARRAY[1,4,3] @&gt; ARRAY[3,1]</literal></entry>
<entry><literal>t</literal></entry>
</row>
<row>
<entry> <literal>&lt;@</literal> </entry>
<entry>is contained by</entry>
<entry><literal>ARRAY[2,7] &lt;@ ARRAY[1,7,4,2,6]</literal></entry>
<entry><literal>t</literal></entry>
</row>
Add missing documentation for new anyarray-overlap operator.
2006-09-10 21:03:57 +02:00
<row>
<entry> <literal>&amp;&amp;</literal> </entry>
<entry>overlap (have elements in common)</entry>
<entry><literal>ARRAY[1,4,3] &amp;&amp; ARRAY[2,1]</literal></entry>
<entry><literal>t</literal></entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>||</literal> </entry>
<entry>array-to-array concatenation</entry>
<entry><literal>ARRAY[1,2,3] || ARRAY[4,5,6]</literal></entry>
<entry><literal>{1,2,3,4,5,6}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Code review for recently-added network functions. Get it to work when log_hostname is enabled, clean up documentation.
2004-06-13 21:56:52 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>||</literal> </entry>
<entry>array-to-array concatenation</entry>
<entry><literal>ARRAY[1,2,3] || ARRAY[[4,5,6],[7,8,9]]</literal></entry>
<entry><literal>{{1,2,3},{4,5,6},{7,8,9}}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Code review for recently-added network functions. Get it to work when log_hostname is enabled, clean up documentation.
2004-06-13 21:56:52 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>||</literal> </entry>
<entry>element-to-array concatenation</entry>
<entry><literal>3 || ARRAY[4,5,6]</literal></entry>
<entry><literal>{3,4,5,6}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Add documentation for pg_get_ruledef and friends.
2001-11-21 23:33:14 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry> <literal>||</literal> </entry>
<entry>array-to-element concatenation</entry>
<entry><literal>ARRAY[4,5,6] || 7</literal></entry>
<entry><literal>{4,5,6,7}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
</tbody>
</tgroup>
</table>
Add documentation for pg_get_ruledef and friends.
2001-11-21 23:33:14 +01:00
Change array comparison rules to consider dimensionality information, not only the array contents, before claiming two arrays are equal. Per recent discussion.
2005-11-19 20:44:55 +01:00
<para>
Array comparisons compare the array contents element-by-element,
Spellchecking and such
2006-10-23 20:10:32 +02:00
using the default B-Tree comparison function for the element data type.
Change array comparison rules to consider dimensionality information, not only the array contents, before claiming two arrays are equal. Per recent discussion.
2005-11-19 20:44:55 +01:00
In multidimensional arrays the elements are visited in row-major order
(last subscript varies most rapidly).
If the contents of two arrays are equal but the dimensionality is
different, the first difference in the dimensionality information
determines the sort order. (This is a change from versions of
<productname>PostgreSQL</> prior to 8.2: older versions would claim
that two arrays with the same contents were equal, even if the
number of dimensions or subscript ranges were different.)
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
See <xref linkend="arrays"> for more details about array operator
behavior.
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<xref linkend="array-functions-table"> shows the functions
available for use with array types. See <xref linkend="arrays">
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
for more discussion and examples of the use of these functions.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Here is a doc patch for the SHOW X changes and new config-settings functions. If there are no objections, please apply. Joe Conway
2002-08-04 05:53:11 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="array-functions-table">
<title><type>array</type> Functions</title>
<tgroup cols="5">
<thead>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
<entry>Example</entry>
<entry>Result</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
</thead>
<tbody>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>array_append</function>(<type>anyarray</type>, <type>anyelement</type>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</literal>
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>anyarray</type></entry>
<entry>append an element to the end of an array</entry>
<entry><literal>array_append(ARRAY[1,2], 3)</literal></entry>
<entry><literal>{1,2,3}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>array_cat</function>(<type>anyarray</type>, <type>anyarray</type>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</literal>
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>anyarray</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>concatenate two arrays</entry>
<entry><literal>array_cat(ARRAY[1,2,3], ARRAY[4,5])</literal></entry>
<entry><literal>{1,2,3,4,5}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>array_dims</function>(<type>anyarray</type>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</literal>
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>text</type></entry>
<entry>returns a text representation of array's dimensions</entry>
Minor consistency improvement to the documentation on array functions.
2005-04-13 02:20:10 +02:00
<entry><literal>array_dims(ARRAY[[1,2,3], [4,5,6]])</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>[1:2][1:3]</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>array_lower</function>(<type>anyarray</type>, <type>int</type>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</literal>
</entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>returns lower bound of the requested array dimension</entry>
Change array_push and array_cat so that they retain the lower bound of the array (for array_push) or higher-dimensional array (for array_cat) rather than decrementing it as before. This avoids generating lower bounds other than one for any array operation within the SQL spec. Per recent discussion. Interestingly, this seems to have been the original behavior, because while updating the docs I noticed that a large fraction of relevant examples were *wrong* for the old behavior and are now right. Is it worth correcting this in the back-branch docs?
2005-11-19 02:50:08 +01:00
<entry><literal>array_lower('[0:2]={1,2,3}'::int[], 1)</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>0</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>array_prepend</function>(<type>anyelement</type>, <type>anyarray</type>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</literal>
</entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><type>anyarray</type></entry>
<entry>append an element to the beginning of an array</entry>
<entry><literal>array_prepend(1, ARRAY[2,3])</literal></entry>
<entry><literal>{1,2,3}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>array_to_string</function>(<type>anyarray</type>, <type>text</type>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</literal>
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>text</type></entry>
<entry>concatenates array elements using provided delimiter</entry>
Minor consistency improvement to the documentation on array functions.
2005-04-13 02:20:10 +02:00
<entry><literal>array_to_string(ARRAY[1, 2, 3], '~^~')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>1~^~2~^~3</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>array_upper</function>(<type>anyarray</type>, <type>int</type>)
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
</literal>
</entry>
<entry><type>int</type></entry>
<entry>returns upper bound of the requested array dimension</entry>
<entry><literal>array_upper(ARRAY[1,2,3,4], 1)</literal></entry>
<entry><literal>4</literal></entry>
</row>
<row>
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>
Minor documentation tweak: in the tables of functions and operators, don't include a space between the function name and the parenthesis that begins its parameter list, for consistency.
2006-07-17 01:59:58 +02:00
<function>string_to_array</function>(<type>text</type>, <type>text</type>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</literal>
</entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><type>text[]</type></entry>
<entry>splits string into array elements using provided delimiter</entry>
Minor consistency improvement to the documentation on array functions.
2005-04-13 02:20:10 +02:00
<entry><literal>string_to_array('xx~^~yy~^~zz', '~^~')</literal></entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<entry><literal>{xx,yy,zz}</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
</tbody>
</tgroup>
</table>
</sect1>
Here is a doc patch for the SHOW X changes and new config-settings functions. If there are no objections, please apply. Joe Conway
2002-08-04 05:53:11 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect1 id="functions-aggregate">
<title>Aggregate Functions</title>
<indexterm zone="functions-aggregate">
<primary>aggregate function</primary>
<secondary>built-in</secondary>
</indexterm>
<para>
<firstterm>Aggregate functions</firstterm> compute a single result
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
value from a set of input values. The built-in aggregate functions
are listed in
<xref linkend="functions-aggregate-table"> and
<xref linkend="functions-aggregate-statistics-table">.
The special syntax considerations for aggregate
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
functions are explained in <xref linkend="syntax-aggregates">.
Consult <xref linkend="tutorial-agg"> for additional introductory
information.
</para>
<table id="functions-aggregate-table">
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
<title>General-Purpose Aggregate Functions</title>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tgroup cols="4">
<thead>
<row>
<entry>Function</entry>
<entry>Argument Type</entry>
<entry>Return Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<indexterm>
<primary>average</primary>
</indexterm>
<function>avg(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<type>smallint</type>, <type>int</type>,
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, <type>numeric</type>, or <type>interval</type>
</entry>
<entry>
<type>numeric</type> for any integer type argument,
<type>double precision</type> for a floating-point argument,
otherwise the same as the argument data type
</entry>
<entry>the average (arithmetic mean) of all input values</entry>
</row>
<row>
<entry>
<indexterm>
<primary>bit_and</primary>
</indexterm>
<function>bit_and(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<type>smallint</type>, <type>int</type>, <type>bigint</type>, or
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<type>bit</type>
</entry>
<entry>
same as argument data type
</entry>
<entry>the bitwise AND of all non-null input values, or null if none</entry>
</row>
<row>
<entry>
<indexterm>
<primary>bit_or</primary>
</indexterm>
<function>bit_or(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<type>smallint</type>, <type>int</type>, <type>bigint</type>, or
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<type>bit</type>
</entry>
<entry>
same as argument data type
</entry>
<entry>the bitwise OR of all non-null input values, or null if none</entry>
</row>
<row>
<entry>
<indexterm>
<primary>bool_and</primary>
</indexterm>
<function>bool_and(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
<type>bool</type>
</entry>
<entry>
<type>bool</type>
</entry>
<entry>true if all input values are true, otherwise false</entry>
</row>
<row>
<entry>
<indexterm>
<primary>bool_or</primary>
</indexterm>
<function>bool_or(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
<type>bool</type>
</entry>
<entry>
<type>bool</type>
</entry>
<entry>true if at least one input value is true, otherwise false</entry>
</row>
<row>
<entry><function>count(*)</function></entry>
<entry></entry>
<entry><type>bigint</type></entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
<entry>number of input rows</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
<entry><function>count(<replaceable class="parameter">expression</replaceable>)</function></entry>
<entry>any</entry>
<entry><type>bigint</type></entry>
<entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
number of input rows for which the value of <replaceable
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
class="parameter">expression</replaceable> is not null
</entry>
</row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
<entry>
<indexterm>
<primary>every</primary>
</indexterm>
<function>every(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
<type>bool</type>
</entry>
<entry>
<type>bool</type>
</entry>
<entry>equivalent to <function>bool_and</function></entry>
</row>
Here is a doc patch for the SHOW X changes and new config-settings functions. If there are no objections, please apply. Joe Conway
2002-08-04 05:53:11 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
<entry><function>max(<replaceable class="parameter">expression</replaceable>)</function></entry>
Implement max() and min() aggregates for array types. Patch from Koju Iijima, reviewed by Neil Conway. Catalog version number bumped, regression tests updated.
2005-02-28 04:45:24 +01:00
<entry>any array, numeric, string, or date/time type</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry>same as argument type</entry>
<entry>
maximum value of <replaceable
class="parameter">expression</replaceable> across all input
values
</entry>
</row>
Here is a doc patch for the SHOW X changes and new config-settings functions. If there are no objections, please apply. Joe Conway
2002-08-04 05:53:11 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
<entry><function>min(<replaceable class="parameter">expression</replaceable>)</function></entry>
Implement max() and min() aggregates for array types. Patch from Koju Iijima, reviewed by Neil Conway. Catalog version number bumped, regression tests updated.
2005-02-28 04:45:24 +01:00
<entry>any array, numeric, string, or date/time type</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry>same as argument type</entry>
<entry>
minimum value of <replaceable
class="parameter">expression</replaceable> across all input
values
</entry>
</row>
Big editing for consistent content and presentation.
2003-03-13 02:30:29 +01:00
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
<row>
<entry><function>sum(<replaceable class="parameter">expression</replaceable>)</function></entry>
<entry>
<type>smallint</type>, <type>int</type>,
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, <type>numeric</type>, or
<type>interval</type>
</entry>
<entry>
<type>bigint</type> for <type>smallint</type> or
<type>int</type> arguments, <type>numeric</type> for
<type>bigint</type> arguments, <type>double precision</type>
for floating-point arguments, otherwise the same as the
argument data type
</entry>
<entry>sum of <replaceable class="parameter">expression</replaceable> across all input values</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
It should be noted that except for <function>count</function>,
these functions return a null value when no rows are selected. In
particular, <function>sum</function> of no rows returns null, not
zero as one might expect. The <function>coalesce</function> function may be
used to substitute zero for null when necessary.
</para>
<note>
<indexterm>
<primary>ANY</primary>
</indexterm>
<indexterm>
<primary>SOME</primary>
</indexterm>
<para>
Boolean aggregates <function>bool_and</function> and
<function>bool_or</function> correspond to standard SQL aggregates
<function>every</function> and <function>any</function> or
<function>some</function>.
As for <function>any</function> and <function>some</function>,
it seems that there is an ambiguity built into the standard syntax:
<programlisting>
SELECT b1 = ANY((SELECT b2 FROM t2 ...)) FROM t1 ...;
</programlisting>
Here <function>ANY</function> can be considered both as leading
to a subquery or as an aggregate if the select expression returns 1 row.
Thus the standard name cannot be given to these aggregates.
</para>
</note>
<note>
<para>
Users accustomed to working with other SQL database management
systems may be surprised by the performance of the
<function>count</function> aggregate when it is applied to the
entire table. A query like:
<programlisting>
SELECT count(*) FROM sometable;
</programlisting>
will be executed by <productname>PostgreSQL</productname> using a
sequential scan of the entire table.
</para>
</note>
<para>
<xref linkend="functions-aggregate-statistics-table"> shows
aggregate functions typically used in statistical analysis.
(These are separated out merely to avoid cluttering the listing
of more-commonly-used aggregates.) Where the description mentions
<replaceable class="parameter">N</replaceable>, it means the
number of input rows for which all the input expressions are non-null.
In all cases, null is returned if the computation is meaningless,
for example when <replaceable class="parameter">N</replaceable> is zero.
</para>
<indexterm>
<primary>statistics</primary>
</indexterm>
<indexterm>
<primary>linear regression</primary>
</indexterm>
<table id="functions-aggregate-statistics-table">
<title>Aggregate Functions for Statistics</title>
<tgroup cols="4">
<thead>
<row>
<entry>Function</entry>
<entry>Argument Type</entry>
<entry>Return Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<indexterm>
<primary>correlation</primary>
</indexterm>
<function>corr(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>correlation coefficient</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<indexterm>
<primary>covariance</primary>
<secondary>population</secondary>
</indexterm>
<function>covar_pop(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>population covariance</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<indexterm>
<primary>covariance</primary>
<secondary>sample</secondary>
</indexterm>
<function>covar_samp(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>sample covariance</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<function>regr_avgx(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>average of the independent variable
(<literal>sum(<replaceable class="parameter">X</replaceable>)/<replaceable class="parameter">N</replaceable></literal>)</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<function>regr_avgy(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>average of the dependent variable
(<literal>sum(<replaceable class="parameter">Y</replaceable>)/<replaceable class="parameter">N</replaceable></literal>)</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<function>regr_count(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>bigint</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>number of input rows in which both expressions are nonnull</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<indexterm>
<primary>regression intercept</primary>
</indexterm>
<function>regr_intercept(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>y-intercept of the least-squares-fit linear equation
determined by the (<replaceable
class="parameter">X</replaceable>, <replaceable
class="parameter">Y</replaceable>) pairs</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<function>regr_r2(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>square of the correlation coefficient</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<indexterm>
<primary>regression slope</primary>
</indexterm>
<function>regr_slope(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry>slope of the least-squares-fit linear equation determined
by the (<replaceable class="parameter">X</replaceable>,
<replaceable class="parameter">Y</replaceable>) pairs</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<function>regr_sxx(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry><literal>sum(<replaceable
class="parameter">X</replaceable>^2) - sum(<replaceable
class="parameter">X</replaceable>)^2/<replaceable
class="parameter">N</replaceable></literal> (<quote>sum of
squares</quote> of the independent variable)</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<function>regr_sxy(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry><literal>sum(<replaceable
class="parameter">X</replaceable>*<replaceable
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
class="parameter">Y</replaceable>) - sum(<replaceable
class="parameter">X</replaceable>) * sum(<replaceable
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
class="parameter">Y</replaceable>)/<replaceable
class="parameter">N</replaceable></literal> (<quote>sum of
products</quote> of independent times dependent
variable)</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
<row>
<entry>
<function>regr_syy(<replaceable class="parameter">Y</replaceable>, <replaceable class="parameter">X</replaceable>)</function>
</entry>
<entry>
<type>double precision</type>
</entry>
<entry>
<type>double precision</type>
</entry>
Add some real descriptions to the multiargument aggregate functions rather than just showing the incomprehensible formulas.
2006-10-23 21:57:37 +02:00
<entry><literal>sum(<replaceable
class="parameter">Y</replaceable>^2) - sum(<replaceable
class="parameter">Y</replaceable>)^2/<replaceable
class="parameter">N</replaceable></literal> (<quote>sum of
squares</quote> of the dependent variable)</entry>
SQL2003-standard statistical aggregates, by Sergey Koposov. I've added only the float8 versions of the aggregates, which is all that the standard requires. Sergey's original patch also provided versions using numeric arithmetic, but given the size and slowness of the code, I doubt we ought to include those in core.
2006-07-28 20:33:04 +02:00
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
<entry>
<indexterm>
<primary>standard deviation</primary>
</indexterm>
<function>stddev(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<type>smallint</type>, <type>int</type>,
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, or <type>numeric</type>
</entry>
<entry>
<type>double precision</type> for floating-point arguments,
otherwise <type>numeric</type>
</entry>
Implement 4 new aggregate functions from SQL2003. Specifically: var_pop(), var_samp(), stddev_pop(), and stddev_samp(). var_samp() and stddev_samp() are just renamings of the historical Postgres aggregates variance() and stddev() -- the latter names have been kept for backward compatibility. This patch includes updates for the documentation and regression tests. The catversion has been bumped. NB: SQL2003 requires that DISTINCT not be specified for any of these aggregates. Per discussion on -patches, I have NOT implemented this restriction: if the user asks for stddev(DISTINCT x), presumably they know what they are doing.
2006-03-10 21:15:28 +01:00
<entry>historical alias for <function>stddev_samp</function></entry>
</row>
<row>
<entry>
<indexterm>
<primary>standard deviation</primary>
<secondary>population</secondary>
</indexterm>
<function>stddev_pop(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
<type>smallint</type>, <type>int</type>,
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, or <type>numeric</type>
</entry>
<entry>
<type>double precision</type> for floating-point arguments,
otherwise <type>numeric</type>
</entry>
<entry>population standard deviation of the input values</entry>
</row>
<row>
<entry>
<indexterm>
<primary>standard deviation</primary>
<secondary>sample</secondary>
</indexterm>
<function>stddev_samp(<replaceable class="parameter">expression</replaceable>)</function>
</entry>
<entry>
<type>smallint</type>, <type>int</type>,
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, or <type>numeric</type>
</entry>
<entry>
<type>double precision</type> for floating-point arguments,
otherwise <type>numeric</type>
</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry>sample standard deviation of the input values</entry>
</row>
Here is a doc patch for the SHOW X changes and new config-settings functions. If there are no objections, please apply. Joe Conway
2002-08-04 05:53:11 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
<entry>
<indexterm>
<primary>variance</primary>
</indexterm>
<function>variance</function>(<replaceable class="parameter">expression</replaceable>)
</entry>
<entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<type>smallint</type>, <type>int</type>,
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, or <type>numeric</type>
</entry>
<entry>
<type>double precision</type> for floating-point arguments,
otherwise <type>numeric</type>
</entry>
Implement 4 new aggregate functions from SQL2003. Specifically: var_pop(), var_samp(), stddev_pop(), and stddev_samp(). var_samp() and stddev_samp() are just renamings of the historical Postgres aggregates variance() and stddev() -- the latter names have been kept for backward compatibility. This patch includes updates for the documentation and regression tests. The catversion has been bumped. NB: SQL2003 requires that DISTINCT not be specified for any of these aggregates. Per discussion on -patches, I have NOT implemented this restriction: if the user asks for stddev(DISTINCT x), presumably they know what they are doing.
2006-03-10 21:15:28 +01:00
<entry>historical alias for <function>var_samp</function></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Here is a doc patch for the SHOW X changes and new config-settings functions. If there are no objections, please apply. Joe Conway
2002-08-04 05:53:11 +02:00
Implement 4 new aggregate functions from SQL2003. Specifically: var_pop(), var_samp(), stddev_pop(), and stddev_samp(). var_samp() and stddev_samp() are just renamings of the historical Postgres aggregates variance() and stddev() -- the latter names have been kept for backward compatibility. This patch includes updates for the documentation and regression tests. The catversion has been bumped. NB: SQL2003 requires that DISTINCT not be specified for any of these aggregates. Per discussion on -patches, I have NOT implemented this restriction: if the user asks for stddev(DISTINCT x), presumably they know what they are doing.
2006-03-10 21:15:28 +01:00
<row>
<entry>
<indexterm>
<primary>variance</primary>
<secondary>population</secondary>
</indexterm>
<function>var_pop</function>(<replaceable class="parameter">expression</replaceable>)
</entry>
<entry>
<type>smallint</type>, <type>int</type>,
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, or <type>numeric</type>
</entry>
<entry>
<type>double precision</type> for floating-point arguments,
otherwise <type>numeric</type>
</entry>
<entry>population variance of the input values (square of the population standard deviation)</entry>
</row>
<row>
<entry>
<indexterm>
<primary>variance</primary>
<secondary>sample</secondary>
</indexterm>
<function>var_samp</function>(<replaceable class="parameter">expression</replaceable>)
</entry>
<entry>
<type>smallint</type>, <type>int</type>,
<type>bigint</type>, <type>real</type>, <type>double
precision</type>, or <type>numeric</type>
</entry>
<entry>
<type>double precision</type> for floating-point arguments,
otherwise <type>numeric</type>
</entry>
<entry>sample variance of the input values (square of the sample standard deviation)</entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</tbody>
</tgroup>
</table>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</sect1>
has_table_privilege spawns scions has_database_privilege, has_function_privilege, has_language_privilege, has_schema_privilege to let SQL queries test all the new privilege types in 7.3. Also, add functions pg_table_is_visible, pg_type_is_visible, pg_function_is_visible, pg_operator_is_visible, pg_opclass_is_visible to test whether objects contained in schemas are visible in the current search path. Do some minor cleanup to centralize accesses to pg_database, as well.
2002-08-09 18:45:16 +02:00
Add has_tablespace_privilege(). Christopher Kings-Lynne
2004-07-12 22:23:59 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect1 id="functions-subquery">
<title>Subquery Expressions</title>
Grant options, and cascading revoke. Grant options are allowed only for users right now, not groups. Extension of has_foo_privileges functions to query the grant options. Extension of aclitem type to store grantor.
2003-01-24 00:39:07 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>EXISTS</primary>
</indexterm>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>IN</primary>
</indexterm>
has_table_privilege spawns scions has_database_privilege, has_function_privilege, has_language_privilege, has_schema_privilege to let SQL queries test all the new privilege types in 7.3. Also, add functions pg_table_is_visible, pg_type_is_visible, pg_function_is_visible, pg_operator_is_visible, pg_opclass_is_visible to test whether objects contained in schemas are visible in the current search path. Do some minor cleanup to centralize accesses to pg_database, as well.
2002-08-09 18:45:16 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>NOT IN</primary>
</indexterm>
has_table_privilege spawns scions has_database_privilege, has_function_privilege, has_language_privilege, has_schema_privilege to let SQL queries test all the new privilege types in 7.3. Also, add functions pg_table_is_visible, pg_type_is_visible, pg_function_is_visible, pg_operator_is_visible, pg_opclass_is_visible to test whether objects contained in schemas are visible in the current search path. Do some minor cleanup to centralize accesses to pg_database, as well.
2002-08-09 18:45:16 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>ANY</primary>
</indexterm>
has_table_privilege spawns scions has_database_privilege, has_function_privilege, has_language_privilege, has_schema_privilege to let SQL queries test all the new privilege types in 7.3. Also, add functions pg_table_is_visible, pg_type_is_visible, pg_function_is_visible, pg_operator_is_visible, pg_opclass_is_visible to test whether objects contained in schemas are visible in the current search path. Do some minor cleanup to centralize accesses to pg_database, as well.
2002-08-09 18:45:16 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>ALL</primary>
</indexterm>
has_table_privilege spawns scions has_database_privilege, has_function_privilege, has_language_privilege, has_schema_privilege to let SQL queries test all the new privilege types in 7.3. Also, add functions pg_table_is_visible, pg_type_is_visible, pg_function_is_visible, pg_operator_is_visible, pg_opclass_is_visible to test whether objects contained in schemas are visible in the current search path. Do some minor cleanup to centralize accesses to pg_database, as well.
2002-08-09 18:45:16 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>SOME</primary>
</indexterm>
<indexterm>
<primary>subquery</primary>
</indexterm>
<para>
This section describes the <acronym>SQL</acronym>-compliant subquery
expressions available in <productname>PostgreSQL</productname>.
All of the expression forms documented in this section return
Boolean (true/false) results.
</para>
<sect2>
<title><literal>EXISTS</literal></title>
<synopsis>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
EXISTS (<replaceable>subquery</replaceable>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</synopsis>
<para>
The argument of <token>EXISTS</token> is an arbitrary <command>SELECT</> statement,
or <firstterm>subquery</firstterm>. The
subquery is evaluated to determine whether it returns any rows.
If it returns at least one row, the result of <token>EXISTS</token> is
<quote>true</>; if the subquery returns no rows, the result of <token>EXISTS</token>
is <quote>false</>.
</para>
has_table_privilege spawns scions has_database_privilege, has_function_privilege, has_language_privilege, has_schema_privilege to let SQL queries test all the new privilege types in 7.3. Also, add functions pg_table_is_visible, pg_type_is_visible, pg_function_is_visible, pg_operator_is_visible, pg_opclass_is_visible to test whether objects contained in schemas are visible in the current search path. Do some minor cleanup to centralize accesses to pg_database, as well.
2002-08-09 18:45:16 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The subquery can refer to variables from the surrounding query,
which will act as constants during any one evaluation of the subquery.
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The subquery will generally only be executed far enough to determine
whether at least one row is returned, not all the way to completion.
It is unwise to write a subquery that has any side effects (such as
calling sequence functions); whether the side effects occur or not
may be difficult to predict.
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Since the result depends only on whether any rows are returned,
and not on the contents of those rows, the output list of the
subquery is normally uninteresting. A common coding convention is
to write all <literal>EXISTS</> tests in the form
<literal>EXISTS(SELECT 1 WHERE ...)</literal>. There are exceptions to
this rule however, such as subqueries that use <token>INTERSECT</token>.
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
This simple example is like an inner join on <literal>col2</>, but
it produces at most one output row for each <literal>tab1</> row,
even if there are multiple matching <literal>tab2</> rows:
<screen>
SELECT col1 FROM tab1
WHERE EXISTS(SELECT 1 FROM tab2 WHERE col2 = tab1.col2);
</screen>
</para>
</sect2>
This patch creates a function named pg_get_triggerdef that takes the oid of a trigger as its parameter. It is basically copied from the pg_dump code. Christopher Kings-Lynne
2003-03-20 19:58:02 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect2>
<title><literal>IN</literal></title>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>expression</replaceable> IN (<replaceable>subquery</replaceable>)
</synopsis>
Add pretty-printing variants of pg_get_viewdef and related functions. Patch from Andreas Pflug.
2003-07-31 00:56:24 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The right-hand side is a parenthesized
subquery, which must return exactly one column. The left-hand expression
is evaluated and compared to each row of the subquery result.
The result of <token>IN</token> is <quote>true</> if any equal subquery row is found.
The result is <quote>false</> if no equal row is found (including the special
case where the subquery returns no rows).
</para>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Note that if the left-hand expression yields null, or if there are
no equal right-hand values and at least one right-hand row yields
null, the result of the <token>IN</token> construct will be null, not false.
This is in accordance with SQL's normal rules for Boolean combinations
of null values.
</para>
Add pg_get_serial_sequence() function, and cause pg_dump to use it. This eliminates the assumption that a serial column's sequence will have the same name on reload that it was given in the original database. Christopher Kings-Lynne
2004-06-25 19:20:29 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
As with <token>EXISTS</token>, it's unwise to assume that the subquery will
be evaluated completely.
</para>
<synopsis>
<replaceable>row_constructor</replaceable> IN (<replaceable>subquery</replaceable>)
</synopsis>
Andreas Pflug wrote: From an idea of Bruce, the attached patch implements the function pg_tablespace_databases(oid) RETURNS SETOF oid which delivers as set of database oids having objects in the selected tablespace, enabling an admin to examine only the databases affecting the tablespace for objects instead of scanning all of them. initdb forced
2004-07-02 20:59:25 +02:00
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
The left-hand side of this form of <token>IN</token> is a row constructor,
as described in <xref linkend="sql-syntax-row-constructors">.
The right-hand side is a parenthesized
subquery, which must return exactly as many columns as there are
expressions in the left-hand row. The left-hand expressions are
evaluated and compared row-wise to each row of the subquery result.
The result of <token>IN</token> is <quote>true</> if any equal subquery row is found.
The result is <quote>false</> if no equal row is found (including the special
case where the subquery returns no rows).
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
As usual, null values in the rows are combined per
the normal rules of SQL Boolean expressions. Two rows are considered
equal if all their corresponding members are non-null and equal; the rows
are unequal if any corresponding members are non-null and unequal;
otherwise the result of that row comparison is unknown (null).
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
If all the per-row results are either unequal or null, with at least one
null, then the result of <token>IN</token> is null.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
</sect2>
A bunch of small doco updates motivated by scanning the comments on the interactive docs.
2001-11-19 04:58:25 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect2>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<title><literal>NOT IN</literal></title>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>expression</replaceable> NOT IN (<replaceable>subquery</replaceable>)
</synopsis>
A bunch of small doco updates motivated by scanning the comments on the interactive docs.
2001-11-19 04:58:25 +01:00
Add pg_get_serial_sequence() function, and cause pg_dump to use it. This eliminates the assumption that a serial column's sequence will have the same name on reload that it was given in the original database. Christopher Kings-Lynne
2004-06-25 19:20:29 +02:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
The right-hand side is a parenthesized
subquery, which must return exactly one column. The left-hand expression
is evaluated and compared to each row of the subquery result.
The result of <token>NOT IN</token> is <quote>true</> if only unequal subquery rows
are found (including the special case where the subquery returns no rows).
The result is <quote>false</> if any equal row is found.
Add pg_get_serial_sequence() function, and cause pg_dump to use it. This eliminates the assumption that a serial column's sequence will have the same name on reload that it was given in the original database. Christopher Kings-Lynne
2004-06-25 19:20:29 +02:00
</para>
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
Note that if the left-hand expression yields null, or if there are
no equal right-hand values and at least one right-hand row yields
null, the result of the <token>NOT IN</token> construct will be null, not true.
This is in accordance with SQL's normal rules for Boolean combinations
of null values.
</para>
<para>
As with <token>EXISTS</token>, it's unwise to assume that the subquery will
be evaluated completely.
</para>
<synopsis>
<replaceable>row_constructor</replaceable> NOT IN (<replaceable>subquery</replaceable>)
</synopsis>
<para>
The left-hand side of this form of <token>NOT IN</token> is a row constructor,
as described in <xref linkend="sql-syntax-row-constructors">.
The right-hand side is a parenthesized
subquery, which must return exactly as many columns as there are
expressions in the left-hand row. The left-hand expressions are
evaluated and compared row-wise to each row of the subquery result.
The result of <token>NOT IN</token> is <quote>true</> if only unequal subquery rows
are found (including the special case where the subquery returns no rows).
The result is <quote>false</> if any equal row is found.
Add pg_get_serial_sequence() function, and cause pg_dump to use it. This eliminates the assumption that a serial column's sequence will have the same name on reload that it was given in the original database. Christopher Kings-Lynne
2004-06-25 19:20:29 +02:00
</para>
Andreas Pflug wrote: From an idea of Bruce, the attached patch implements the function pg_tablespace_databases(oid) RETURNS SETOF oid which delivers as set of database oids having objects in the selected tablespace, enabling an admin to examine only the databases affecting the tablespace for objects instead of scanning all of them. initdb forced
2004-07-02 20:59:25 +02:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
As usual, null values in the rows are combined per
the normal rules of SQL Boolean expressions. Two rows are considered
equal if all their corresponding members are non-null and equal; the rows
are unequal if any corresponding members are non-null and unequal;
otherwise the result of that row comparison is unknown (null).
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
If all the per-row results are either unequal or null, with at least one
null, then the result of <token>NOT IN</token> is null.
Andreas Pflug wrote: From an idea of Bruce, the attached patch implements the function pg_tablespace_databases(oid) RETURNS SETOF oid which delivers as set of database oids having objects in the selected tablespace, enabling an admin to examine only the databases affecting the tablespace for objects instead of scanning all of them. initdb forced
2004-07-02 20:59:25 +02:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</sect2>
Andreas Pflug wrote: From an idea of Bruce, the attached patch implements the function pg_tablespace_databases(oid) RETURNS SETOF oid which delivers as set of database oids having objects in the selected tablespace, enabling an admin to examine only the databases affecting the tablespace for objects instead of scanning all of them. initdb forced
2004-07-02 20:59:25 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect2>
<title><literal>ANY</literal>/<literal>SOME</literal></title>
Modify pg_dump to dump foreign-key constraints as constraints, not as sets of triggers. Also modify psql \d command to show foreign key constraints as such and hide the triggers. pg_get_constraintdef() function added to backend to support these. From Rod Taylor, code review and some editorialization by Tom Lane.
2002-08-17 01:01:21 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>expression</replaceable> <replaceable>operator</replaceable> ANY (<replaceable>subquery</replaceable>)
<replaceable>expression</replaceable> <replaceable>operator</replaceable> SOME (<replaceable>subquery</replaceable>)
</synopsis>
A bunch of small doco updates motivated by scanning the comments on the interactive docs.
2001-11-19 04:58:25 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The right-hand side is a parenthesized
subquery, which must return exactly one column. The left-hand expression
is evaluated and compared to each row of the subquery result using the
given <replaceable>operator</replaceable>, which must yield a Boolean
result.
The result of <token>ANY</token> is <quote>true</> if any true result is obtained.
The result is <quote>false</> if no true result is found (including the special
case where the subquery returns no rows).
</para>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<token>SOME</token> is a synonym for <token>ANY</token>.
<token>IN</token> is equivalent to <literal>= ANY</literal>.
</para>
A bunch of small doco updates motivated by scanning the comments on the interactive docs.
2001-11-19 04:58:25 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Note that if there are no successes and at least one right-hand row yields
null for the operator's result, the result of the <token>ANY</token> construct
will be null, not false.
This is in accordance with SQL's normal rules for Boolean combinations
of null values.
</para>
Document obj_description and col_description functions; expand description of COMMENT command.
2001-12-27 22:36:57 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
As with <token>EXISTS</token>, it's unwise to assume that the subquery will
be evaluated completely.
</para>
Document obj_description and col_description functions; expand description of COMMENT command.
2001-12-27 22:36:57 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>row_constructor</replaceable> <replaceable>operator</> ANY (<replaceable>subquery</replaceable>)
<replaceable>row_constructor</replaceable> <replaceable>operator</> SOME (<replaceable>subquery</replaceable>)
</synopsis>
Document obj_description and col_description functions; expand description of COMMENT command.
2001-12-27 22:36:57 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The left-hand side of this form of <token>ANY</token> is a row constructor,
as described in <xref linkend="sql-syntax-row-constructors">.
The right-hand side is a parenthesized
subquery, which must return exactly as many columns as there are
expressions in the left-hand row. The left-hand expressions are
evaluated and compared row-wise to each row of the subquery result,
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
using the given <replaceable>operator</replaceable>.
The result of <token>ANY</token> is <quote>true</> if the comparison
returns true for any subquery row.
The result is <quote>false</> if the comparison returns false for every
subquery row (including the special case where the subquery returns no
rows).
The result is NULL if the comparison does not return true for any row,
and it returns NULL for at least one row.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Document obj_description and col_description functions; expand description of COMMENT command.
2001-12-27 22:36:57 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
See <xref linkend="row-wise-comparison"> for details about the meaning
of a row-wise comparison.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
</sect2>
Add documentation for pg_cancel_backend and pg_terminate_backend. Magnus Hagander
2004-06-24 21:57:14 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect2>
<title><literal>ALL</literal></title>
Add documentation for pg_cancel_backend and pg_terminate_backend. Magnus Hagander
2004-06-24 21:57:14 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>expression</replaceable> <replaceable>operator</replaceable> ALL (<replaceable>subquery</replaceable>)
</synopsis>
Add documentation for pg_cancel_backend and pg_terminate_backend. Magnus Hagander
2004-06-24 21:57:14 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The right-hand side is a parenthesized
subquery, which must return exactly one column. The left-hand expression
is evaluated and compared to each row of the subquery result using the
given <replaceable>operator</replaceable>, which must yield a Boolean
result.
The result of <token>ALL</token> is <quote>true</> if all rows yield true
(including the special case where the subquery returns no rows).
The result is <quote>false</> if any false result is found.
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
The result is NULL if the comparison does not return false for any row,
and it returns NULL for at least one row.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Add documentation for pg_cancel_backend and pg_terminate_backend. Magnus Hagander
2004-06-24 21:57:14 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<token>NOT IN</token> is equivalent to <literal>&lt;&gt; ALL</literal>.
</para>
Add documentation for pg_cancel_backend and pg_terminate_backend. Magnus Hagander
2004-06-24 21:57:14 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
As with <token>EXISTS</token>, it's unwise to assume that the subquery will
be evaluated completely.
</para>
Implement differentiation between CURRENT_USER and SESSION_USER as per SQL. There is still no effective difference but it will kick in once setuid functions exist (not included here). Make old getpgusername() alias for current_user.
2000-09-19 20:18:04 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>row_constructor</replaceable> <replaceable>operator</replaceable> ALL (<replaceable>subquery</replaceable>)
</synopsis>
Create real array comparison functions (that use the element datatype's comparison functions), replacing the highly bogus bitwise array_eq. Create a btree index opclass for ANYARRAY --- it is now possible to create indexes on array columns. Arrange to cache the results of catalog lookups across multiple array operations, instead of repeating the lookups on every call. Add string_to_array and array_to_string functions. Remove singleton_array, array_accum, array_assign, and array_subscript functions, since these were for proof-of-concept and not intended to become supported functions. Minor adjustments to behavior in some corner cases with empty or zero-dimensional arrays. Joe Conway (with some editorializing by Tom Lane).
2003-06-27 02:33:26 +02:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
The left-hand side of this form of <token>ALL</token> is a row constructor,
as described in <xref linkend="sql-syntax-row-constructors">.
The right-hand side is a parenthesized
subquery, which must return exactly as many columns as there are
expressions in the left-hand row. The left-hand expressions are
evaluated and compared row-wise to each row of the subquery result,
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
using the given <replaceable>operator</replaceable>.
The result of <token>ALL</token> is <quote>true</> if the comparison
returns true for all subquery rows (including the special
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
case where the subquery returns no rows).
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
The result is <quote>false</> if the comparison returns false for any
subquery row.
The result is NULL if the comparison does not return false for any
subquery row, and it returns NULL for at least one row.
Create real array comparison functions (that use the element datatype's comparison functions), replacing the highly bogus bitwise array_eq. Create a btree index opclass for ANYARRAY --- it is now possible to create indexes on array columns. Arrange to cache the results of catalog lookups across multiple array operations, instead of repeating the lookups on every call. Add string_to_array and array_to_string functions. Remove singleton_array, array_accum, array_assign, and array_subscript functions, since these were for proof-of-concept and not intended to become supported functions. Minor adjustments to behavior in some corner cases with empty or zero-dimensional arrays. Joe Conway (with some editorializing by Tom Lane).
2003-06-27 02:33:26 +02:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
See <xref linkend="row-wise-comparison"> for details about the meaning
of a row-wise comparison.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
</sect2>
<sect2>
<title>Row-wise Comparison</title>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<indexterm zone="functions-subquery">
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<primary>comparison</primary>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<secondary>subquery result row</secondary>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</indexterm>
<synopsis>
<replaceable>row_constructor</replaceable> <replaceable>operator</replaceable> (<replaceable>subquery</replaceable>)
</synopsis>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The left-hand side is a row constructor,
as described in <xref linkend="sql-syntax-row-constructors">.
The right-hand side is a parenthesized subquery, which must return exactly
as many columns as there are expressions in the left-hand row. Furthermore,
the subquery cannot return more than one row. (If it returns zero rows,
the result is taken to be null.) The left-hand side is evaluated and
compared row-wise to the single subquery result row.
</para>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
See <xref linkend="row-wise-comparison"> for details about the meaning
of a row-wise comparison.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
</sect2>
</sect1>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect1 id="functions-comparisons">
<title>Row and Array Comparisons</title>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>IN</primary>
</indexterm>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>NOT IN</primary>
</indexterm>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>ANY</primary>
</indexterm>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>ALL</primary>
</indexterm>
Update docs for 7.4 array features and polymorphic functions. This is Joe Conway's patch of 7-Aug plus further editorializing of my own.
2003-08-10 00:50:22 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>SOME</primary>
</indexterm>
Create real array comparison functions (that use the element datatype's comparison functions), replacing the highly bogus bitwise array_eq. Create a btree index opclass for ANYARRAY --- it is now possible to create indexes on array columns. Arrange to cache the results of catalog lookups across multiple array operations, instead of repeating the lookups on every call. Add string_to_array and array_to_string functions. Remove singleton_array, array_accum, array_assign, and array_subscript functions, since these were for proof-of-concept and not intended to become supported functions. Minor adjustments to behavior in some corner cases with empty or zero-dimensional arrays. Joe Conway (with some editorializing by Tom Lane).
2003-06-27 02:33:26 +02:00
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
<indexterm>
<primary>row-wise comparison</primary>
</indexterm>
Document IS DISTINCT FROM in a more obvious place, and add some more index entries for IS-foo constructs.
2004-10-27 00:16:12 +02:00
<indexterm>
<primary>comparison</primary>
<secondary>row-wise</secondary>
</indexterm>
<indexterm>
<primary>IS DISTINCT FROM</primary>
</indexterm>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
<indexterm>
<primary>IS NOT DISTINCT FROM</primary>
</indexterm>
Updates for array documentation, from Joe Conway.
2003-08-19 08:06:48 +02:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
This section describes several specialized constructs for making
multiple comparisons between groups of values. These forms are
syntactically related to the subquery forms of the previous section,
but do not involve subqueries.
The forms involving array subexpressions are
<productname>PostgreSQL</productname> extensions; the rest are
<acronym>SQL</acronym>-compliant.
All of the expression forms documented in this section return
Boolean (true/false) results.
Updates for array documentation, from Joe Conway.
2003-08-19 08:06:48 +02:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect2>
<title><literal>IN</literal></title>
Create real array comparison functions (that use the element datatype's comparison functions), replacing the highly bogus bitwise array_eq. Create a btree index opclass for ANYARRAY --- it is now possible to create indexes on array columns. Arrange to cache the results of catalog lookups across multiple array operations, instead of repeating the lookups on every call. Add string_to_array and array_to_string functions. Remove singleton_array, array_accum, array_assign, and array_subscript functions, since these were for proof-of-concept and not intended to become supported functions. Minor adjustments to behavior in some corner cases with empty or zero-dimensional arrays. Joe Conway (with some editorializing by Tom Lane).
2003-06-27 02:33:26 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
<replaceable>expression</replaceable> IN (<replaceable>value</replaceable> <optional>, ...</optional>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</synopsis>
<para>
The right-hand side is a parenthesized list
of scalar expressions. The result is <quote>true</> if the left-hand expression's
result is equal to any of the right-hand expressions. This is a shorthand
notation for
> Great! Please cc: the docs or hackers mailing lists to make sure the > patches are not lost... Aggregate doc patches: The patches are attached. Be great if you could check them over to make sure all relevant content (and markup) is there... Isaac Wilcox
2000-06-20 20:04:18 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>expression</replaceable> = <replaceable>value1</replaceable>
OR
<replaceable>expression</replaceable> = <replaceable>value2</replaceable>
OR
...
</synopsis>
</para>
> Great! Please cc: the docs or hackers mailing lists to make sure the > patches are not lost... Aggregate doc patches: The patches are attached. Be great if you could check them over to make sure all relevant content (and markup) is there... Isaac Wilcox
2000-06-20 20:04:18 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Note that if the left-hand expression yields null, or if there are
no equal right-hand values and at least one right-hand expression yields
null, the result of the <token>IN</token> construct will be null, not false.
This is in accordance with SQL's normal rules for Boolean combinations
of null values.
</para>
</sect2>
<sect2>
<title><literal>NOT IN</literal></title>
<synopsis>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
<replaceable>expression</replaceable> NOT IN (<replaceable>value</replaceable> <optional>, ...</optional>)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</synopsis>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
The right-hand side is a parenthesized list
of scalar expressions. The result is <quote>true</quote> if the left-hand expression's
result is unequal to all of the right-hand expressions. This is a shorthand
notation for
<synopsis>
<replaceable>expression</replaceable> &lt;&gt; <replaceable>value1</replaceable>
AND
<replaceable>expression</replaceable> &lt;&gt; <replaceable>value2</replaceable>
AND
...
</synopsis>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</para>
Update aggregate-function docs for STDDEV, VARIANCE.
2000-07-17 05:52:28 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Note that if the left-hand expression yields null, or if there are
no equal right-hand values and at least one right-hand expression yields
null, the result of the <token>NOT IN</token> construct will be null, not true
as one might naively expect.
This is in accordance with SQL's normal rules for Boolean combinations
of null values.
</para>
Update aggregate-function docs for STDDEV, VARIANCE.
2000-07-17 05:52:28 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tip>
<para>
<literal>x NOT IN y</literal> is equivalent to <literal>NOT (x IN y)</literal> in all
cases. However, null values are much more likely to trip up the novice when
working with <token>NOT IN</token> than when working with <token>IN</token>.
It's best to express your condition positively if possible.
</para>
</tip>
</sect2>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect2>
<title><literal>ANY</literal>/<literal>SOME</literal> (array)</title>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>expression</replaceable> <replaceable>operator</replaceable> ANY (<replaceable>array expression</replaceable>)
<replaceable>expression</replaceable> <replaceable>operator</replaceable> SOME (<replaceable>array expression</replaceable>)
</synopsis>
The added aggregates are: (1) boolean-and and boolean-or aggregates named bool_and and bool_or. they (SHOULD;-) correspond to standard sql every and some/any aggregates. they do not have the right name as there is a problem with the standard and the parser for some/any. Tom also think that the standard name is misleading because NULL are ignored. Also add 'every' aggregate. (2) bitwise integer aggregates named bit_and and bit_or for int2, int4, int8 and bit types. They are not standard, but I find them useful. I needed them once. The patches adds: - 2 new very short strict functions for boolean aggregates in src/backed/utils/adt/bool.c, src/include/utils/builtins.h and src/include/catalog/pg_proc.h - the new aggregates declared in src/include/catalog/pg_proc.h and src/include/catalog/pg_aggregate.h - some documentation and validation about these new aggregates. Fabien COELHO
2004-05-26 17:26:28 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The right-hand side is a parenthesized expression, which must yield an
array value.
The left-hand expression
is evaluated and compared to each element of the array using the
given <replaceable>operator</replaceable>, which must yield a Boolean
result.
The result of <token>ANY</token> is <quote>true</> if any true result is obtained.
The result is <quote>false</> if no true result is found (including the special
case where the array has zero elements).
</para>
The added aggregates are: (1) boolean-and and boolean-or aggregates named bool_and and bool_or. they (SHOULD;-) correspond to standard sql every and some/any aggregates. they do not have the right name as there is a problem with the standard and the parser for some/any. Tom also think that the standard name is misleading because NULL are ignored. Also add 'every' aggregate. (2) bitwise integer aggregates named bit_and and bit_or for int2, int4, int8 and bit types. They are not standard, but I find them useful. I needed them once. The patches adds: - 2 new very short strict functions for boolean aggregates in src/backed/utils/adt/bool.c, src/include/utils/builtins.h and src/include/catalog/pg_proc.h - the new aggregates declared in src/include/catalog/pg_proc.h and src/include/catalog/pg_aggregate.h - some documentation and validation about these new aggregates. Fabien COELHO
2004-05-26 17:26:28 +02:00
Make SQL arrays support null elements. This commit fixes the core array functionality, but I still need to make another pass looking at places that incidentally use arrays (such as ACL manipulation) to make sure they are null-safe. Contrib needs work too. I have not changed the behaviors that are still under discussion about array comparison and what to do with lower bounds.
2005-11-17 23:14:56 +01:00
<para>
If the array expression yields a null array, the result of
<token>ANY</token> will be null. If the left-hand expression yields null,
the result of <token>ANY</token> is ordinarily null (though a non-strict
comparison operator could possibly yield a different result).
Also, if the right-hand array contains any null elements and no true
comparison result is obtained, the result of <token>ANY</token>
will be null, not false (again, assuming a strict comparison operator).
This is in accordance with SQL's normal rules for Boolean combinations
of null values.
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<token>SOME</token> is a synonym for <token>ANY</token>.
</para>
</sect2>
The added aggregates are: (1) boolean-and and boolean-or aggregates named bool_and and bool_or. they (SHOULD;-) correspond to standard sql every and some/any aggregates. they do not have the right name as there is a problem with the standard and the parser for some/any. Tom also think that the standard name is misleading because NULL are ignored. Also add 'every' aggregate. (2) bitwise integer aggregates named bit_and and bit_or for int2, int4, int8 and bit types. They are not standard, but I find them useful. I needed them once. The patches adds: - 2 new very short strict functions for boolean aggregates in src/backed/utils/adt/bool.c, src/include/utils/builtins.h and src/include/catalog/pg_proc.h - the new aggregates declared in src/include/catalog/pg_proc.h and src/include/catalog/pg_aggregate.h - some documentation and validation about these new aggregates. Fabien COELHO
2004-05-26 17:26:28 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect2>
<title><literal>ALL</literal> (array)</title>
The added aggregates are: (1) boolean-and and boolean-or aggregates named bool_and and bool_or. they (SHOULD;-) correspond to standard sql every and some/any aggregates. they do not have the right name as there is a problem with the standard and the parser for some/any. Tom also think that the standard name is misleading because NULL are ignored. Also add 'every' aggregate. (2) bitwise integer aggregates named bit_and and bit_or for int2, int4, int8 and bit types. They are not standard, but I find them useful. I needed them once. The patches adds: - 2 new very short strict functions for boolean aggregates in src/backed/utils/adt/bool.c, src/include/utils/builtins.h and src/include/catalog/pg_proc.h - the new aggregates declared in src/include/catalog/pg_proc.h and src/include/catalog/pg_aggregate.h - some documentation and validation about these new aggregates. Fabien COELHO
2004-05-26 17:26:28 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>expression</replaceable> <replaceable>operator</replaceable> ALL (<replaceable>array expression</replaceable>)
</synopsis>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The right-hand side is a parenthesized expression, which must yield an
array value.
The left-hand expression
is evaluated and compared to each element of the array using the
given <replaceable>operator</replaceable>, which must yield a Boolean
result.
The result of <token>ALL</token> is <quote>true</> if all comparisons yield true
(including the special case where the array has zero elements).
The result is <quote>false</> if any false result is found.
</para>
Make SQL arrays support null elements. This commit fixes the core array functionality, but I still need to make another pass looking at places that incidentally use arrays (such as ACL manipulation) to make sure they are null-safe. Contrib needs work too. I have not changed the behaviors that are still under discussion about array comparison and what to do with lower bounds.
2005-11-17 23:14:56 +01:00
<para>
If the array expression yields a null array, the result of
<token>ALL</token> will be null. If the left-hand expression yields null,
the result of <token>ALL</token> is ordinarily null (though a non-strict
comparison operator could possibly yield a different result).
Also, if the right-hand array contains any null elements and no false
comparison result is obtained, the result of <token>ALL</token>
will be null, not true (again, assuming a strict comparison operator).
This is in accordance with SQL's normal rules for Boolean combinations
of null values.
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</sect2>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
<sect2 id="row-wise-comparison">
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<title>Row-wise Comparison</title>
<synopsis>
<replaceable>row_constructor</replaceable> <replaceable>operator</replaceable> <replaceable>row_constructor</replaceable>
</synopsis>
<para>
Each side is a row constructor,
as described in <xref linkend="sql-syntax-row-constructors">.
The two row values must have the same number of fields.
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
Each side is evaluated and they are compared row-wise. Row comparisons
are allowed when the <replaceable>operator</replaceable> is
<literal>=</>,
<literal>&lt;&gt;</>,
<literal>&lt;</>,
<literal>&lt;=</>,
<literal>&gt;</> or
<literal>&gt;=</>,
or has semantics similar to one of these. (To be specific, an operator
Spellchecking and such
2006-10-23 20:10:32 +02:00
can be a row comparison operator if it is a member of a B-Tree operator
class, or is the negator of the <literal>=</> member of a B-Tree operator
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
class.)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
<para>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
The <literal>=</> and <literal>&lt;&gt;</> cases work slightly differently
from the others. Two rows are considered
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
equal if all their corresponding members are non-null and equal; the rows
are unequal if any corresponding members are non-null and unequal;
otherwise the result of the row comparison is unknown (null).
</para>
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
<para>
For the <literal>&lt;</>, <literal>&lt;=</>, <literal>&gt;</> and
<literal>&gt;=</> cases, the row elements are compared left-to-right,
stopping as soon as an unequal or null pair of elements is found.
If either of this pair of elements is null, the result of the
row comparison is unknown (null); otherwise comparison of this pair
of elements determines the result. For example,
<literal>ROW(1,2,NULL) &lt; ROW(1,3,0)</>
yields true, not null, because the third pair of elements are not
considered.
</para>
<note>
<para>
Prior to <productname>PostgreSQL</productname> 8.2, the
<literal>&lt;</>, <literal>&lt;=</>, <literal>&gt;</> and <literal>&gt;=</>
cases were not handled per SQL specification. A comparison like
<literal>ROW(a,b) &lt; ROW(c,d)</>
was implemented as
<literal>a &lt; c AND b &lt; d</>
whereas the correct behavior is equivalent to
<literal>a &lt; c OR (a = c AND b &lt; d)</>.
</para>
</note>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<synopsis>
<replaceable>row_constructor</replaceable> IS DISTINCT FROM <replaceable>row_constructor</replaceable>
</synopsis>
<para>
This construct is similar to a <literal>&lt;&gt;</literal> row comparison,
but it does not yield null for null inputs. Instead, any null value is
considered unequal to (distinct from) any non-null value, and any two
Implement SQL-compliant treatment of row comparisons for < <= > >= cases (previously we only did = and <> correctly). Also, allow row comparisons with any operators that are in btree opclasses, not only those with these specific names. This gets rid of a whole lot of indefensible assumptions about the behavior of particular operators based on their names ... though it's still true that IN and NOT IN expand to "= ANY". The patch adds a RowCompareExpr expression node type, and makes some changes in the representation of ANY/ALL/ROWCOMPARE SubLinks so that they can share code with RowCompareExpr. I have not yet done anything about making RowCompareExpr an indexable operator, but will look at that soon. initdb forced due to changes in stored rules.
2005-12-28 02:30:02 +01:00
nulls are considered equal (not distinct). Thus the result will always
be either true or false, never null.
</para>
<synopsis>
<replaceable>row_constructor</replaceable> IS NOT DISTINCT FROM <replaceable>row_constructor</replaceable>
</synopsis>
<para>
This construct is similar to a <literal>=</literal> row comparison,
but it does not yield null for null inputs. Instead, any null value is
considered unequal to (distinct from) any non-null value, and any two
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
nulls are considered equal (not distinct). Thus the result will always
be either true or false, never null.
</para>
</sect2>
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect1 id="functions-srf">
<title>Set Returning Functions</title>
<indexterm zone="functions-srf">
<primary>set returning functions</primary>
<secondary>functions</secondary>
</indexterm>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<indexterm>
<primary>generate_series</primary>
</indexterm>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
This section describes functions that possibly return more than one row.
Currently the only functions in this class are series generating functions,
as detailed in <xref linkend="functions-srf-series">.
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-srf-series">
<title>Series Generating Functions</title>
<tgroup cols="4">
<thead>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry>Function</entry>
<entry>Argument Type</entry>
<entry>Return Type</entry>
<entry>Description</entry>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</thead>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><literal><function>generate_series</function>(<parameter>start</parameter>, <parameter>stop</parameter>)</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>
Merge documentation updates from 7.3 branch.
2002-11-11 21:14:04 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
Generate a series of values, from <parameter>start</parameter> to <parameter>stop</parameter>
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
with a step size of one
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</entry>
</row>
<row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><literal><function>generate_series</function>(<parameter>start</parameter>, <parameter>stop</parameter>, <parameter>step</parameter>)</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>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
Generate a series of values, from <parameter>start</parameter> to <parameter>stop</parameter>
Consistently do not include a terminating period in single-sentence function descriptions in func.sgml; other minor SGML tweaks.
2005-05-23 03:29:54 +02:00
with a step size of <parameter>step</parameter>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</entry>
</row>
</tbody>
</tgroup>
</table>
Update aggregate-function docs for STDDEV, VARIANCE.
2000-07-17 05:52:28 +02:00
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
When <parameter>step</parameter> is positive, zero rows are returned if
<parameter>start</parameter> is greater than <parameter>stop</parameter>.
Conversely, when <parameter>step</parameter> is negative, zero rows are
returned if <parameter>start</parameter> is less than <parameter>stop</parameter>.
Zero rows are also returned for <literal>NULL</literal> inputs. It is an error
for <parameter>step</parameter> to be zero. Some examples follow:
The added aggregates are: (1) boolean-and and boolean-or aggregates named bool_and and bool_or. they (SHOULD;-) correspond to standard sql every and some/any aggregates. they do not have the right name as there is a problem with the standard and the parser for some/any. Tom also think that the standard name is misleading because NULL are ignored. Also add 'every' aggregate. (2) bitwise integer aggregates named bit_and and bit_or for int2, int4, int8 and bit types. They are not standard, but I find them useful. I needed them once. The patches adds: - 2 new very short strict functions for boolean aggregates in src/backed/utils/adt/bool.c, src/include/utils/builtins.h and src/include/catalog/pg_proc.h - the new aggregates declared in src/include/catalog/pg_proc.h and src/include/catalog/pg_aggregate.h - some documentation and validation about these new aggregates. Fabien COELHO
2004-05-26 17:26:28 +02:00
<programlisting>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
select * from generate_series(2,4);
generate_series
-----------------
2
3
4
(3 rows)
The added aggregates are: (1) boolean-and and boolean-or aggregates named bool_and and bool_or. they (SHOULD;-) correspond to standard sql every and some/any aggregates. they do not have the right name as there is a problem with the standard and the parser for some/any. Tom also think that the standard name is misleading because NULL are ignored. Also add 'every' aggregate. (2) bitwise integer aggregates named bit_and and bit_or for int2, int4, int8 and bit types. They are not standard, but I find them useful. I needed them once. The patches adds: - 2 new very short strict functions for boolean aggregates in src/backed/utils/adt/bool.c, src/include/utils/builtins.h and src/include/catalog/pg_proc.h - the new aggregates declared in src/include/catalog/pg_proc.h and src/include/catalog/pg_aggregate.h - some documentation and validation about these new aggregates. Fabien COELHO
2004-05-26 17:26:28 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
select * from generate_series(5,1,-2);
generate_series
-----------------
5
3
1
(3 rows)
This patch adds a note to the documentation describing why the performance of min() and max() is slow when applied to the entire table, and suggesting the simple workaround most experienced Pg users eventually learn about (SELECT xyz ... ORDER BY xyz LIMIT 1). Neil Conway
2003-02-19 04:12:22 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
select * from generate_series(4,3);
generate_series
-----------------
(0 rows)
This patch adds a note to the documentation describing why the performance of min() and max() is slow when applied to the entire table, and suggesting the simple workaround most experienced Pg users eventually learn about (SELECT xyz ... ORDER BY xyz LIMIT 1). Neil Conway
2003-02-19 04:12:22 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
select current_date + s.a as dates from generate_series(0,14,7) as s(a);
dates
------------
2004-02-05
2004-02-12
2004-02-19
(3 rows)
This patch adds a note to the documentation describing why the performance of min() and max() is slow when applied to the entire table, and suggesting the simple workaround most experienced Pg users eventually learn about (SELECT xyz ... ORDER BY xyz LIMIT 1). Neil Conway
2003-02-19 04:12:22 +01:00
</programlisting>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</sect1>
Update aggregate-function docs for STDDEV, VARIANCE.
2000-07-17 05:52:28 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect1 id="functions-info">
<title>System Information Functions</title>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<xref linkend="functions-info-session-table"> shows several
functions that extract session and system information.
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-info-session-table">
<title>Session Information Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry></row>
</thead>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>current_database</function>()</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>name</type></entry>
<entry>name of current database</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>current_schema</function>()</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>name</type></entry>
<entry>name of current schema</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>current_schemas</function>(<type>boolean</type>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>name[]</type></entry>
<entry>names of schemas in search path optionally including implicit schemas</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>current_user</function></literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>name</type></entry>
<entry>user name of current execution context</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>inet_client_addr</function>()</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>inet</type></entry>
<entry>address of the remote connection</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>inet_client_port</function>()</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry>port of the remote connection</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>inet_server_addr</function>()</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>inet</type></entry>
<entry>address of the local connection</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>inet_server_port</function>()</literal></entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry>port of the local connection</entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add a couple of information functions to support direct checks on whether a schema is our own temp schema or another backend's temp schema, and use these in place of some former kluges in information_schema. Per my proposal of yesterday.
2006-09-15 00:05:06 +02:00
<row>
<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><type>boolean</type></entry>
<entry>is schema another session's temporary schema?</entry>
</row>
Add pg_postmaster_start_time() function. Euler Taveira de Oliveira Matthias Schmidt
2005-06-14 23:04:42 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>pg_postmaster_start_time</function>()</literal></entry>
Add pg_postmaster_start_time() function. Euler Taveira de Oliveira Matthias Schmidt
2005-06-14 23:04:42 +02:00
<entry><type>timestamp with time zone</type></entry>
Merge postmaster and postgres command into just postgres. postmaster symlink is kept for now for compatibility. To call single-user mode, use postgres --single.
2006-06-18 17:38:37 +02:00
<entry>server start time</entry>
Add pg_postmaster_start_time() function. Euler Taveira de Oliveira Matthias Schmidt
2005-06-14 23:04:42 +02:00
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>session_user</function></literal></entry>
<entry><type>name</type></entry>
<entry>session user name</entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>user</function></literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>name</type></entry>
<entry>equivalent to <function>current_user</function></entry>
</row>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><literal><function>version</function>()</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<entry><productname>PostgreSQL</> version information</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
</tbody>
</tgroup>
</table>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>user</primary>
<secondary>current</secondary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>schema</primary>
<secondary>current</secondary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>search path</primary>
<secondary>current</secondary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
The <function>session_user</function> is normally the user who initiated
the current database connection; but superusers can change this setting
SGML cleanup: consistently use "endterm" in <xref>s that link to the reference page for SQL commands, so that the link text is italicized.
2005-06-13 04:40:08 +02:00
with <xref linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title">.
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
The <function>current_user</function> is the user identifier
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
that is applicable for permission checking. Normally, it is equal
Add SET ROLE. This is a partial commit of Stephen Frost's recent patch; I'm still working on the has_role function and information_schema changes.
2005-07-26 00:12:34 +02:00
to the session user, but it can be changed with
<xref linkend="sql-set-role" endterm="sql-set-role-title">.
It also changes during the execution of
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
functions with the attribute <literal>SECURITY DEFINER</literal>.
In Unix parlance, the session user is the <quote>real user</quote> and
the current user is the <quote>effective user</quote>.
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<note>
<para>
<function>current_user</function>, <function>session_user</function>, and
<function>user</function> have special syntactic status in <acronym>SQL</acronym>:
they must be called without trailing parentheses.
</para>
</note>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>current_schema</function> returns the name of the schema that is
at the front of the search path (or a null value if the search path is
empty). This is the schema that will be used for any tables or
other named objects that are created without specifying a target schema.
<function>current_schemas(boolean)</function> returns an array of the names of all
schemas presently in the search path. The Boolean option determines whether or not
implicitly included system schemas such as <literal>pg_catalog</> are included in the search
path returned.
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<note>
<para>
The search path may be altered at run time. The command is:
<programlisting>
SET search_path TO <replaceable>schema</> <optional>, <replaceable>schema</>, ...</optional>
</programlisting>
</para>
</note>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>inet_client_addr</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>inet_client_port</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>inet_server_addr</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>inet_server_port</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>inet_client_addr</function> returns the IP address of the
current client, and <function>inet_client_port</function> returns the
port number.
<function>inet_server_addr</function> returns the IP address on which
the server accepted the current connection, and
<function>inet_server_port</function> returns the port number.
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
All these functions return NULL if the current connection is via a
Unix-domain socket.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add pg_postmaster_start_time() function. Euler Taveira de Oliveira Matthias Schmidt
2005-06-14 23:04:42 +02:00
<indexterm zone="functions-info">
Add a couple of information functions to support direct checks on whether a schema is our own temp schema or another backend's temp schema, and use these in place of some former kluges in information_schema. Per my proposal of yesterday.
2006-09-15 00:05:06 +02:00
<primary>pg_my_temp_schema</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>pg_is_other_temp_schema</primary>
</indexterm>
<para>
<function>pg_my_temp_schema</function> returns the OID of the current
session's temporary schema, or 0 if it has none (because it has not
created any temporary tables).
<function>pg_is_other_temp_schema</function> returns true if the
given OID is the OID of any other session's temporary schema.
(This can be useful, for example, to exclude other sessions' temporary
tables from a catalog display.)
</para>
<indexterm zone="functions-info">
Add pg_postmaster_start_time() function. Euler Taveira de Oliveira Matthias Schmidt
2005-06-14 23:04:42 +02:00
<primary>pg_postmaster_start_time</primary>
</indexterm>
<para>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<function>pg_postmaster_start_time</function> returns the
<type>timestamp with time zone</type> when the
Merge postmaster and postgres command into just postgres. postmaster symlink is kept for now for compatibility. To call single-user mode, use postgres --single.
2006-06-18 17:38:37 +02:00
server started.
Add pg_postmaster_start_time() function. Euler Taveira de Oliveira Matthias Schmidt
2005-06-14 23:04:42 +02:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>version</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Minor SGML markup cleanup.
2005-06-15 08:29:25 +02:00
<function>version</function> returns a string describing the
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<productname>PostgreSQL</productname> server's version.
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm>
<primary>privilege</primary>
<secondary>querying</secondary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<xref linkend="functions-info-access-table"> lists functions that
allow the user to query object access privileges programmatically.
See <xref linkend="ddl-priv"> for more information about
privileges.
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-info-access-table">
<title>Access Privilege Inquiry Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry></row>
</thead>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
<row>
<entry><literal><function>has_database_privilege</function>(<parameter>user</parameter>,
<parameter>database</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does user have privilege for database</entry>
</row>
<row>
<entry><literal><function>has_database_privilege</function>(<parameter>database</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does current user have privilege for database</entry>
</row>
<row>
<entry><literal><function>has_function_privilege</function>(<parameter>user</parameter>,
<parameter>function</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does user have privilege for function</entry>
</row>
<row>
<entry><literal><function>has_function_privilege</function>(<parameter>function</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does current user have privilege for function</entry>
</row>
<row>
<entry><literal><function>has_language_privilege</function>(<parameter>user</parameter>,
<parameter>language</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does user have privilege for language</entry>
</row>
<row>
<entry><literal><function>has_language_privilege</function>(<parameter>language</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does current user have privilege for language</entry>
</row>
Add pg_has_role() family of privilege inquiry functions modeled after the existing ones for object privileges. Update the information_schema for roles --- pg_has_role() makes this a whole lot easier, removing the need for most of the explicit joins with pg_user. The views should be a tad faster now, too. Stephen Frost and Tom Lane.
2005-07-26 02:04:19 +02:00
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>has_schema_privilege</function>(<parameter>user</parameter>,
<parameter>schema</parameter>,
Add pg_has_role() family of privilege inquiry functions modeled after the existing ones for object privileges. Update the information_schema for roles --- pg_has_role() makes this a whole lot easier, removing the need for most of the explicit joins with pg_user. The views should be a tad faster now, too. Stephen Frost and Tom Lane.
2005-07-26 02:04:19 +02:00
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>does user have privilege for schema</entry>
Add pg_has_role() family of privilege inquiry functions modeled after the existing ones for object privileges. Update the information_schema for roles --- pg_has_role() makes this a whole lot easier, removing the need for most of the explicit joins with pg_user. The views should be a tad faster now, too. Stephen Frost and Tom Lane.
2005-07-26 02:04:19 +02:00
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>has_schema_privilege</function>(<parameter>schema</parameter>,
Add pg_has_role() family of privilege inquiry functions modeled after the existing ones for object privileges. Update the information_schema for roles --- pg_has_role() makes this a whole lot easier, removing the need for most of the explicit joins with pg_user. The views should be a tad faster now, too. Stephen Frost and Tom Lane.
2005-07-26 02:04:19 +02:00
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>does current user have privilege for schema</entry>
Add pg_has_role() family of privilege inquiry functions modeled after the existing ones for object privileges. Update the information_schema for roles --- pg_has_role() makes this a whole lot easier, removing the need for most of the explicit joins with pg_user. The views should be a tad faster now, too. Stephen Frost and Tom Lane.
2005-07-26 02:04:19 +02:00
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>has_table_privilege</function>(<parameter>user</parameter>,
<parameter>table</parameter>,
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>does user have privilege for table</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>has_table_privilege</function>(<parameter>table</parameter>,
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>does current user have privilege for table</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
<entry><literal><function>has_tablespace_privilege</function>(<parameter>user</parameter>,
<parameter>tablespace</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does user have privilege for tablespace</entry>
</row>
<row>
<entry><literal><function>has_tablespace_privilege</function>(<parameter>tablespace</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does current user have privilege for tablespace</entry>
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>pg_has_role</function>(<parameter>user</parameter>,
<parameter>role</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does user have privilege for role</entry>
</row>
<row>
<entry><literal><function>pg_has_role</function>(<parameter>role</parameter>,
<parameter>privilege</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>does current user have privilege for role</entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</tbody>
</tgroup>
</table>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>has_database_privilege</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>has_function_privilege</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>has_language_privilege</primary>
</indexterm>
Add pg_has_role() family of privilege inquiry functions modeled after the existing ones for object privileges. Update the information_schema for roles --- pg_has_role() makes this a whole lot easier, removing the need for most of the explicit joins with pg_user. The views should be a tad faster now, too. Stephen Frost and Tom Lane.
2005-07-26 02:04:19 +02:00
<indexterm zone="functions-info">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>has_schema_privilege</primary>
Add pg_has_role() family of privilege inquiry functions modeled after the existing ones for object privileges. Update the information_schema for roles --- pg_has_role() makes this a whole lot easier, removing the need for most of the explicit joins with pg_user. The views should be a tad faster now, too. Stephen Frost and Tom Lane.
2005-07-26 02:04:19 +02:00
</indexterm>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>has_table_privilege</primary>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</indexterm>
<indexterm zone="functions-info">
<primary>has_tablespace_privilege</primary>
</indexterm>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<indexterm zone="functions-info">
<primary>pg_has_role</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>has_database_privilege</function> checks whether a user
can access a database in a particular way. The possibilities for its
arguments are analogous to <function>has_table_privilege</function>.
The desired access privilege type must evaluate to
<literal>CREATE</literal>,
Code review for GRANT CONNECT patch. Spell the privilege as CONNECT not CONNECTION, fix a number of places that were missed (eg pg_dump support), avoid executing an extra search of pg_database during startup.
2006-04-30 23:15:33 +02:00
<literal>CONNECT</literal>,
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<literal>TEMPORARY</literal>, or
<literal>TEMP</literal> (which is equivalent to
<literal>TEMPORARY</literal>).
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>has_function_privilege</function> checks whether a user
can access a function in a particular way. The possibilities for its
arguments are analogous to <function>has_table_privilege</function>.
When specifying a function by a text string rather than by OID,
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
the allowed input is the same as for the <type>regprocedure</> data type
(see <xref linkend="datatype-oid">).
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
The desired access privilege type must evaluate to
<literal>EXECUTE</literal>.
An example is:
<programlisting>
SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute');
</programlisting>
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>has_language_privilege</function> checks whether a user
can access a procedural language in a particular way. The possibilities
for its arguments are analogous to <function>has_table_privilege</function>.
The desired access privilege type must evaluate to
<literal>USAGE</literal>.
</para>
<para>
<function>has_schema_privilege</function> checks whether a user
can access a schema in a particular way. The possibilities for its
arguments are analogous to <function>has_table_privilege</function>.
The desired access privilege type must evaluate to
<literal>CREATE</literal> or
<literal>USAGE</literal>.
</para>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<para>
<function>has_table_privilege</function> checks whether a user
can access a table in a particular way. The user can be
specified by name or by OID
(<literal>pg_authid.oid</literal>), or if the argument is
omitted
<function>current_user</function> is assumed. The table can be specified
by name or by OID. (Thus, there are actually six variants of
<function>has_table_privilege</function>, which can be distinguished by
the number and types of their arguments.) When specifying by name,
the name can be schema-qualified if necessary.
The desired access privilege type
is specified by a text string, which must evaluate to one of the
Get rid of the separate RULE privilege for tables: now only a table's owner can create or modify rules for the table. Do setRuleCheckAsUser() while loading rules into the relcache, rather than when defining a rule. This ensures that permission checks for tables referenced in a rule are done with respect to the current owner of the rule's table, whereas formerly ALTER TABLE OWNER would fail to update the permission checking for associated rules. Removal of separate RULE privilege is needed to prevent various scenarios in which a grantee of RULE privilege could effectively have any privilege of the table owner. For backwards compatibility, GRANT/REVOKE RULE is still accepted, but it doesn't do anything. Per discussion here: http://archives.postgresql.org/pgsql-hackers/2006-04/msg01138.php
2006-09-05 23:08:36 +02:00
values <literal>SELECT</literal>, <literal>INSERT</literal>,
<literal>UPDATE</literal>, <literal>DELETE</literal>,
<literal>REFERENCES</literal>, or <literal>TRIGGER</literal>.
(Case of the string is not significant, however.)
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
An example is:
<programlisting>
SELECT has_table_privilege('myschema.mytable', 'select');
</programlisting>
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>has_tablespace_privilege</function> checks whether a user
can access a tablespace in a particular way. The possibilities for its
arguments are analogous to <function>has_table_privilege</function>.
The desired access privilege type must evaluate to
<literal>CREATE</literal>.
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<para>
<function>pg_has_role</function> checks whether a user
can access a role in a particular way. The possibilities for its
arguments are analogous to <function>has_table_privilege</function>.
The desired access privilege type must evaluate to
<literal>MEMBER</literal> or
<literal>USAGE</literal>.
<literal>MEMBER</literal> denotes direct or indirect membership in
the role (that is, the right to do <command>SET ROLE</>), while
<literal>USAGE</literal> denotes whether the privileges of the role
are immediately available without doing <command>SET ROLE</>.
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
<para>
More minor updates and copy-editing.
2004-12-24 00:07:38 +01:00
To test whether a user holds a grant option on the privilege,
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
append <literal>WITH GRANT OPTION</literal> to the privilege key
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
word; for example <literal>'UPDATE WITH GRANT OPTION'</literal>.
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
</para>
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<xref linkend="functions-info-schema-table"> shows functions that
determine whether a certain object is <firstterm>visible</> in the
current schema search path. A table is said to be visible if its
containing schema is in the search path and no table of the same
name appears earlier in the search path. This is equivalent to the
statement that the table can be referenced by name without explicit
schema qualification. For example, to list the names of all
visible tables:
<programlisting>
SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);
</programlisting>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-info-schema-table">
<title>Schema Visibility Inquiry Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry></row>
</thead>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>pg_conversion_is_visible</function>(<parameter>conversion_oid</parameter>)</literal>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</entry>
<entry><type>boolean</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>is conversion visible in search path</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
<entry><literal><function>pg_function_is_visible</function>(<parameter>function_oid</parameter>)</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>
<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>
<entry><type>boolean</type></entry>
<entry>is operator class visible in search path</entry>
</row>
<row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry><literal><function>pg_table_is_visible</function>(<parameter>table_oid</parameter>)</literal>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</entry>
<entry><type>boolean</type></entry>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<entry>is table visible in search path</entry>
</row>
<row>
<entry><literal><function>pg_type_is_visible</function>(<parameter>type_oid</parameter>)</literal>
</entry>
<entry><type>boolean</type></entry>
<entry>is type (or domain) visible in search path</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
</tbody>
</tgroup>
</table>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>pg_conversion_is_visible</primary>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</indexterm>
<indexterm zone="functions-info">
<primary>pg_function_is_visible</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>pg_operator_is_visible</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>pg_opclass_is_visible</primary>
</indexterm>
<indexterm zone="functions-info">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>pg_table_is_visible</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>pg_type_is_visible</primary>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<function>pg_conversion_is_visible</function>,
<function>pg_function_is_visible</function>,
<function>pg_operator_is_visible</function>,
<function>pg_opclass_is_visible</function>,
<function>pg_table_is_visible</function>, and
<function>pg_type_is_visible</function> perform the visibility check for
conversions, functions, operators, operator classes, tables, and
types. Note that <function>pg_table_is_visible</function> can also be used
with views, indexes and sequences; <function>pg_type_is_visible</function>
can also be used with domains. For functions and operators, an object in
the search path is visible if there is no object of the same name
<emphasis>and argument data type(s)</> earlier in the path. For operator
classes, both name and associated index access method are considered.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
All these functions require object OIDs to identify the object to be
checked. If you want to test an object by name, it is convenient to use
the OID alias types (<type>regclass</>, <type>regtype</>,
<type>regprocedure</>, or <type>regoperator</>), for example
<programlisting>
SELECT pg_type_is_visible('myschema.widget'::regtype);
</programlisting>
Note that it would not make much sense to test an unqualified name in
Replace "--" and "---" with "&mdash;" as appropriate, for better-looking output.
2004-11-15 07:32:15 +01:00
this way &mdash; if the name can be recognized at all, it must be visible.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add documentation for format_type(), which somehow escaped it before.
2005-01-29 00:12:59 +01:00
<indexterm zone="functions-info">
<primary>format_type</primary>
</indexterm>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>pg_get_viewdef</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>pg_get_ruledef</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>pg_get_indexdef</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>pg_get_triggerdef</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>pg_get_constraintdef</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>pg_get_expr</primary>
Add/edit index entries.
2003-08-31 19:32:24 +02:00
</indexterm>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>pg_get_userbyid</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>pg_get_serial_sequence</primary>
</indexterm>
<indexterm zone="functions-info">
<primary>pg_tablespace_databases</primary>
</indexterm>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<xref linkend="functions-info-catalog-table"> lists functions that
extract information from the system catalogs.
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-info-catalog-table">
<title>System Catalog Information Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry></row>
</thead>
<tbody>
Add documentation for format_type(), which somehow escaped it before.
2005-01-29 00:12:59 +01:00
<row>
<entry><literal><function>format_type</function>(<parameter>type_oid</parameter>, <parameter>typemod</>)</literal></entry>
<entry><type>text</type></entry>
<entry>get SQL name of a data type</entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_constraintdef</function>(<parameter>constraint_oid</parameter>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>get definition of a constraint</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_constraintdef</function>(<parameter>constraint_oid</parameter>, <parameter>pretty_bool</>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>get definition of a constraint</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_expr</function>(<parameter>expr_text</parameter>, <parameter>relation_oid</>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>decompile internal form of an expression, assuming that any Vars
in it refer to the relation indicated by the second parameter</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_expr</function>(<parameter>expr_text</parameter>, <parameter>relation_oid</>, <parameter>pretty_bool</>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>decompile internal form of an expression, assuming that any Vars
in it refer to the relation indicated by the second parameter</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
<entry><literal><function>pg_get_indexdef</function>(<parameter>index_oid</parameter>)</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><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>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_ruledef</function>(<parameter>rule_oid</parameter>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>get <command>CREATE RULE</> command for rule</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_ruledef</function>(<parameter>rule_oid</parameter>, <parameter>pretty_bool</>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>get <command>CREATE RULE</> command for rule</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_serial_sequence</function>(<parameter>table_name</parameter>, <parameter>column_name</parameter>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>get name of the sequence that a <type>serial</type> or <type>bigserial</type> column
uses</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><function>pg_get_triggerdef</function>(<parameter>trigger_oid</parameter>)</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>get <command>CREATE [ CONSTRAINT ] TRIGGER</> command for trigger</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry><literal><function>pg_get_userbyid</function>(<parameter>roleid</parameter>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>name</type></entry>
Replace pg_shadow and pg_group by new role-capable catalogs pg_authid and pg_auth_members. There are still many loose ends to finish in this patch (no documentation, no regression tests, no pg_dump support for instance). But I'm going to commit it now anyway so that Alvaro can make some progress on shared dependencies. The catalog changes should be pretty much done.
2005-06-28 07:09:14 +02:00
<entry>get role name with given ID</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_viewdef</function>(<parameter>view_name</parameter>)</literal></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry>get underlying <command>SELECT</command> command for view (<emphasis>deprecated</emphasis>)</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
<row>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<entry><literal><function>pg_get_viewdef</function>(<parameter>view_name</parameter>, <parameter>pretty_bool</>)</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><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><type>text</type></entry>
<entry>get underlying <command>SELECT</command> command for view</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>pg_tablespace_databases</function>(<parameter>tablespace_oid</parameter>)</literal></entry>
<entry><type>setof oid</type></entry>
<entry>get the set of database OIDs that have objects in the tablespace</entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</tbody>
</tgroup>
</table>
Add documentation for format_type(), which somehow escaped it before.
2005-01-29 00:12:59 +01:00
<para>
<function>format_type</function> returns the SQL name of a data type that
is identified by its type OID and possibly a type modifier. Pass NULL
for the type modifier if no specific modifier is known.
</para>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
<para>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<function>pg_get_constraintdef</function>,
<function>pg_get_indexdef</function>, <function>pg_get_ruledef</function>,
and <function>pg_get_triggerdef</function>, respectively reconstruct the
creating command for a constraint, index, rule, or trigger. (Note that this
is a decompiled reconstruction, not the original text of the command.)
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<function>pg_get_expr</function> decompiles the internal form of an
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
individual expression, such as the default value for a column. It may be
useful when examining the contents of system catalogs.
<function>pg_get_viewdef</function> reconstructs the <command>SELECT</>
query that defines a view. Most of these functions come in two variants,
one of which can optionally <quote>pretty-print</> the result. The
pretty-printed format is more readable, but the default format is more
likely to be interpreted the same way by future versions of
<productname>PostgreSQL</>; avoid using pretty-printed output for dump
purposes. Passing <literal>false</> for the pretty-print parameter yields
the same result as the variant that does not have the parameter at all.
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
</para>
<para>
Update documentation for pg_get_serial_sequence() function.
2007-01-30 03:39:27 +01:00
<function>pg_get_serial_sequence</function> returns the name of the
sequence associated with a column, or NULL if no sequence is associated
with the column. The first input parameter is a table name with
optional schema, and the second parameter is a column name. Because
the first parameter is potentially a schema and table, it is not treated
as a double-quoted identifier, meaning it is lowercased by default,
while the second parameter, being just a column name, is treated as
double-quoted and has its case preserved. The function returns a value
suitably formatted for passing to the sequence functions (see <xref
linkend="functions-sequence">). This association can be modified or
removed with <command>ALTER SEQUENCE OWNED BY</>. (The function
probably should have been called
Fix all known problems with pg_dump's handling of serial sequences by abandoning the idea that it should say SERIAL in the dump. Instead, dump serial sequences and column defaults just like regular ones. Add a new backend command ALTER SEQUENCE OWNED BY to let pg_dump recreate the sequence-to-column dependency that was formerly created "behind the scenes" by SERIAL. This restores SERIAL to being truly "just a macro" consisting of component operations that can be stated explicitly in SQL. Furthermore, the new command allows sequence ownership to be reassigned, so that old mistakes can be cleaned up. Also, downgrade the OWNED-BY dependency from INTERNAL to AUTO, since there is no longer any very compelling argument why the sequence couldn't be dropped while keeping the column. (This forces initdb, to be sure the right kinds of dependencies are in there.) Along the way, add checks to prevent ALTER OWNER or SET SCHEMA on an owned sequence; you can now only do this indirectly by changing the owning table's owner or schema. This is an oversight in previous releases, but probably not worth back-patching.
2006-08-21 02:57:26 +02:00
<function>pg_get_owned_sequence</function>; its name reflects the fact
that it's typically used with <type>serial</> or <type>bigserial</>
columns.)
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
</para>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<para>
<function>pg_get_userbyid</function> extracts a role's name given
its OID.
</para>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<para>
Correct the description of the pg_get_viewdef() function. Do some nearby SGML cleanup: sort table entries alphabetically.
2006-07-11 21:11:26 +02:00
<function>pg_tablespace_databases</function> allows a tablespace to be
examined. It returns the set of OIDs of databases that have objects stored
in the tablespace. If this function returns any rows, the tablespace is not
empty and cannot be dropped. To display the specific objects populating the
tablespace, you will need to connect to the databases identified by
<function>pg_tablespace_databases</function> and query their
<structname>pg_class</> catalogs.
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>col_description</primary>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</indexterm>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>obj_description</primary>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</indexterm>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
I've created a new shared catalog table pg_shdescription to store comments on cluster global objects like databases, tablespaces, and roles. It touches a lot of places, but not much in the way of big changes. The only design decision I made was to duplicate the query and manipulation functions rather than to try and have them handle both shared and local comments. I believe this is simpler for the code and not an issue for callers because they know what type of object they are dealing with. This has resulted in a shobj_description function analagous to obj_description and backend functions [Create/Delete]SharedComments mirroring the existing [Create/Delete]Comments functions. pg_shdescription.h goes into src/include/catalog/ Kris Jurka
2006-02-12 04:22:21 +01:00
<indexterm zone="functions-info">
<primary>shobj_description</primary>
</indexterm>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-info">
<primary>comment</primary>
<secondary sortas="database objects">about database objects</secondary>
</indexterm>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
The functions shown in <xref linkend="functions-info-comment-table">
extract comments previously stored with the <xref linkend="sql-comment"
endterm="sql-comment-title"> command. A null value is returned if no
comment could be found matching the specified parameters.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-info-comment-table">
<title>Comment Information Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry></row>
</thead>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry><literal><function>col_description</function>(<parameter>table_oid</parameter>, <parameter>column_number</parameter>)</literal></entry>
<entry><type>text</type></entry>
<entry>get comment for a table column</entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<row>
<entry><literal><function>obj_description</function>(<parameter>object_oid</parameter>, <parameter>catalog_name</parameter>)</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><type>text</type></entry>
<entry>get comment for a database object (<emphasis>deprecated</emphasis>)</entry>
</row>
I've created a new shared catalog table pg_shdescription to store comments on cluster global objects like databases, tablespaces, and roles. It touches a lot of places, but not much in the way of big changes. The only design decision I made was to duplicate the query and manipulation functions rather than to try and have them handle both shared and local comments. I believe this is simpler for the code and not an issue for callers because they know what type of object they are dealing with. This has resulted in a shobj_description function analagous to obj_description and backend functions [Create/Delete]SharedComments mirroring the existing [Create/Delete]Comments functions. pg_shdescription.h goes into src/include/catalog/ Kris Jurka
2006-02-12 04:22:21 +01:00
<row>
<entry><literal><function>shobj_description</function>(<parameter>object_oid</parameter>, <parameter>catalog_name</parameter>)</literal></entry>
<entry><type>text</type></entry>
<entry>get comment for a shared database object</entry>
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</tbody>
</tgroup>
</table>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<para>
<function>col_description</function> returns the comment for a table column,
which is specified by the OID of its table and its column number.
<function>obj_description</function> cannot be used for table columns since
columns do not have OIDs of their own.
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The two-parameter form of <function>obj_description</function> returns the
comment for a database object specified by its OID and the name of the
containing system catalog. For example,
<literal>obj_description(123456,'pg_class')</literal>
would retrieve the comment for a table with OID 123456.
The one-parameter form of <function>obj_description</function> requires only
the object OID. It is now deprecated since there is no guarantee that
OIDs are unique across different system catalogs; therefore, the wrong
comment could be returned.
</para>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
I've created a new shared catalog table pg_shdescription to store comments on cluster global objects like databases, tablespaces, and roles. It touches a lot of places, but not much in the way of big changes. The only design decision I made was to duplicate the query and manipulation functions rather than to try and have them handle both shared and local comments. I believe this is simpler for the code and not an issue for callers because they know what type of object they are dealing with. This has resulted in a shobj_description function analagous to obj_description and backend functions [Create/Delete]SharedComments mirroring the existing [Create/Delete]Comments functions. pg_shdescription.h goes into src/include/catalog/ Kris Jurka
2006-02-12 04:22:21 +01:00
<para>
<function>shobj_description</function> is used just like
<function>obj_description</function> only that it is used for retrieving
comments on shared objects. Some system catalogs are global to all
databases within each cluster and their descriptions are stored globally
as well.
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</sect1>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<sect1 id="functions-admin">
<title>System Administration Functions</title>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
<para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<xref linkend="functions-admin-set-table"> shows the functions
available to query and alter run-time configuration parameters.
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-admin-set-table">
<title>Configuration Settings Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry></row>
</thead>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
<row>
<entry>
<literal><function>current_setting</function>(<parameter>setting_name</parameter>)</literal>
</entry>
<entry><type>text</type></entry>
<entry>current value of setting</entry>
</row>
<row>
<entry>
<literal><function>set_config(<parameter>setting_name</parameter>,
<parameter>new_value</parameter>,
<parameter>is_local</parameter>)</function></literal>
</entry>
<entry><type>text</type></entry>
<entry>set parameter and return new value</entry>
</row>
</tbody>
</tgroup>
</table>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-admin">
<primary>SET</primary>
</indexterm>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-admin">
<primary>SHOW</primary>
</indexterm>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-admin">
<primary>configuration</primary>
<secondary sortas="server">of the server</secondary>
<tertiary>functions</tertiary>
</indexterm>
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The function <function>current_setting</function> yields the
current value of the setting <parameter>setting_name</parameter>.
It corresponds to the <acronym>SQL</acronym> command
<command>SHOW</command>. An example:
<programlisting>
SELECT current_setting('datestyle');
Support expressions of the form 'scalar op ANY (array)' and 'scalar op ALL (array)', where the operator is applied between the lefthand scalar and each element of the array. The operator must yield boolean; the result of the construct is the OR or AND of the per-element results, respectively. Original coding by Joe Conway, after an idea of Peter's. Rewritten by Tom to keep the implementation strictly separate from subqueries.
2003-06-29 02:33:44 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
current_setting
-----------------
ISO, MDY
(1 row)
</programlisting>
</para>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>set_config</function> sets the parameter
<parameter>setting_name</parameter> to
<parameter>new_value</parameter>. If
<parameter>is_local</parameter> is <literal>true</literal>, the
new value will only apply to the current transaction. If you want
the new value to apply for the current session, use
<literal>false</literal> instead. The function corresponds to the
SQL command <command>SET</command>. An example:
<programlisting>
SELECT set_config('log_statement_stats', 'off', false);
Promote row expressions to full-fledged citizens of the expression syntax, rather than allowing them only in a few special cases as before. In particular you can now pass a ROW() construct to a function that accepts a rowtype parameter. Internal generation of RowExprs fixes a number of corner cases that used to not work very well, such as referencing the whole-row result of a JOIN or subquery. This represents a further step in the work I started a month or so back to make rowtype values into first-class citizens.
2004-05-11 00:44:49 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
set_config
------------
off
(1 row)
</programlisting>
</para>
Promote row expressions to full-fledged citizens of the expression syntax, rather than allowing them only in a few special cases as before. In particular you can now pass a ROW() construct to a function that accepts a rowtype parameter. Internal generation of RowExprs fixes a number of corner cases that used to not work very well, such as referencing the whole-row result of a JOIN or subquery. This represents a further step in the work I started a month or so back to make rowtype values into first-class citizens.
2004-05-11 00:44:49 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-admin">
<primary>pg_cancel_backend</primary>
</indexterm>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
<indexterm zone="functions-admin">
<primary>pg_reload_conf</primary>
</indexterm>
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
<indexterm zone="functions-admin">
<primary>pg_rotate_logfile</primary>
</indexterm>
Promote row expressions to full-fledged citizens of the expression syntax, rather than allowing them only in a few special cases as before. In particular you can now pass a ROW() construct to a function that accepts a rowtype parameter. Internal generation of RowExprs fixes a number of corner cases that used to not work very well, such as referencing the whole-row result of a JOIN or subquery. This represents a further step in the work I started a month or so back to make rowtype values into first-class citizens.
2004-05-11 00:44:49 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-admin">
<primary>signal</primary>
<secondary sortas="backend">backend processes</secondary>
</indexterm>
Promote row expressions to full-fledged citizens of the expression syntax, rather than allowing them only in a few special cases as before. In particular you can now pass a ROW() construct to a function that accepts a rowtype parameter. Internal generation of RowExprs fixes a number of corner cases that used to not work very well, such as referencing the whole-row result of a JOIN or subquery. This represents a further step in the work I started a month or so back to make rowtype values into first-class citizens.
2004-05-11 00:44:49 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
The functions shown in <xref
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
linkend="functions-admin-signal-table"> send control signals to
other server processes. Use of these functions is restricted
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
to superusers.
</para>
Promote row expressions to full-fledged citizens of the expression syntax, rather than allowing them only in a few special cases as before. In particular you can now pass a ROW() construct to a function that accepts a rowtype parameter. Internal generation of RowExprs fixes a number of corner cases that used to not work very well, such as referencing the whole-row result of a JOIN or subquery. This represents a further step in the work I started a month or so back to make rowtype values into first-class citizens.
2004-05-11 00:44:49 +02:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-admin-signal-table">
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<title>Server Signalling Functions</title>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
</row>
</thead>
Provide some documentation for EXISTS, IN, NOT IN, ANY/SOME/ALL, and row comparisons. How'd this manage to slip through the cracks?
2001-12-01 05:19:20 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_cancel_backend</function>(<parameter>pid</parameter> <type>int</>)</literal>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
</entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry><type>boolean</type></entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry>Cancel a backend's current query</entry>
</row>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
<row>
<entry>
<literal><function>pg_reload_conf</function>()</literal>
</entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry><type>boolean</type></entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<entry>Cause server processes to reload their configuration files</entry>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</row>
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
<row>
<entry>
<literal><function>pg_rotate_logfile</function>()</literal>
</entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry><type>boolean</type></entry>
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
<entry>Rotate server's log file</entry>
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</tbody>
</tgroup>
</table>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
Each of these functions returns <literal>true</literal> if
successful and <literal>false</literal> otherwise.
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
</para>
<para>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<function>pg_cancel_backend</> sends a query cancel
(<systemitem>SIGINT</>) signal to a backend process identified by
process ID. The process ID of an active backend can be found from
the <structfield>procpid</structfield> column in the
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
<structname>pg_stat_activity</structname> view, or by listing the
<command>postgres</command> processes on the server with
<application>ps</>.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
<para>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<function>pg_reload_conf</> sends a <systemitem>SIGHUP</> signal
Merge postmaster and postgres command into just postgres. postmaster symlink is kept for now for compatibility. To call single-user mode, use postgres --single.
2006-06-18 17:38:37 +02:00
to the server, causing the configuration files
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
to be reloaded by all server processes.
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</para>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
<para>
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
<function>pg_rotate_logfile</> signals the log-file manager to switch
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
to a new output file immediately. This works only when
<varname>redirect_stderr</> is used for logging, since otherwise there
Spellchecking run, final cleanups
2005-11-05 00:14:02 +01:00
is no log-file manager subprocess.
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-admin">
<primary>pg_start_backup</primary>
</indexterm>
<indexterm zone="functions-admin">
<primary>pg_stop_backup</primary>
</indexterm>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
<indexterm zone="functions-admin">
<primary>pg_switch_xlog</primary>
</indexterm>
<indexterm zone="functions-admin">
<primary>pg_current_xlog_location</primary>
</indexterm>
Implement archive_timeout feature to force xlog file switches to occur no more than N seconds apart. This allows a simple, if not very high performance, means of guaranteeing that a PITR archive is no more than N seconds behind real time. Also make pg_current_xlog_location return the WAL Write pointer, add pg_current_xlog_insert_location to return the Insert pointer, and fix pg_xlogfile_name_offset to return its results as a two-element record instead of a smashed-together string, as per recent discussion. Simon Riggs
2006-08-18 01:04:10 +02:00
<indexterm zone="functions-admin">
<primary>pg_current_xlog_insert_location</primary>
</indexterm>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
<indexterm zone="functions-admin">
<primary>pg_xlogfile_name_offset</primary>
</indexterm>
<indexterm zone="functions-admin">
<primary>pg_xlogfile_name</primary>
</indexterm>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<indexterm zone="functions-admin">
<primary>backup</primary>
</indexterm>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
The functions shown in <xref
linkend="functions-admin-backup-table"> assist in making on-line backups.
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
Use of the first three functions is restricted to superusers.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<table id="functions-admin-backup-table">
<title>Backup Control Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
</row>
</thead>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<tbody>
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_start_backup</function>(<parameter>label</> <type>text</>)</literal>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
<entry>Set up for performing on-line backup</entry>
</row>
<row>
<entry>
Some small docs improvements motivated by reading the comments for the 7.4 7.4 interactive docs.
2005-01-08 06:19:18 +01:00
<literal><function>pg_stop_backup</function>()</literal>
</entry>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<entry><type>text</type></entry>
<entry>Finish performing on-line backup</entry>
</row>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
<row>
<entry>
<literal><function>pg_switch_xlog</function>()</literal>
</entry>
<entry><type>text</type></entry>
Spellchecking and such
2006-10-23 20:10:32 +02:00
<entry>Force switch to a new transaction log file</entry>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</row>
<row>
<entry>
<literal><function>pg_current_xlog_location</function>()</literal>
</entry>
<entry><type>text</type></entry>
Spellchecking and such
2006-10-23 20:10:32 +02:00
<entry>Get current transaction log write location</entry>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</row>
<row>
<entry>
Implement archive_timeout feature to force xlog file switches to occur no more than N seconds apart. This allows a simple, if not very high performance, means of guaranteeing that a PITR archive is no more than N seconds behind real time. Also make pg_current_xlog_location return the WAL Write pointer, add pg_current_xlog_insert_location to return the Insert pointer, and fix pg_xlogfile_name_offset to return its results as a two-element record instead of a smashed-together string, as per recent discussion. Simon Riggs
2006-08-18 01:04:10 +02:00
<literal><function>pg_current_xlog_insert_location</function>()</literal>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</entry>
<entry><type>text</type></entry>
Spellchecking and such
2006-10-23 20:10:32 +02:00
<entry>Get current transaction log insert location</entry>
Implement archive_timeout feature to force xlog file switches to occur no more than N seconds apart. This allows a simple, if not very high performance, means of guaranteeing that a PITR archive is no more than N seconds behind real time. Also make pg_current_xlog_location return the WAL Write pointer, add pg_current_xlog_insert_location to return the Insert pointer, and fix pg_xlogfile_name_offset to return its results as a two-element record instead of a smashed-together string, as per recent discussion. Simon Riggs
2006-08-18 01:04:10 +02:00
</row>
<row>
<entry>
<literal><function>pg_xlogfile_name_offset</function>(<parameter>location</> <type>text</>)</literal>
</entry>
<entry><type>text</>, <type>integer</></entry>
Spellchecking and such
2006-10-23 20:10:32 +02:00
<entry>Convert transaction log location string to file name and decimal byte offset within file</entry>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</row>
<row>
<entry>
<literal><function>pg_xlogfile_name</function>(<parameter>location</> <type>text</>)</literal>
</entry>
<entry><type>text</type></entry>
Spellchecking and such
2006-10-23 20:10:32 +02:00
<entry>Convert transaction log location string to file name</entry>
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</row>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</tbody>
</tgroup>
</table>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>pg_start_backup</> accepts a single parameter which is an
arbitrary user-defined label for the backup. (Typically this would be
the name under which the backup dump file will be stored.) The function
writes a backup label file into the database cluster's data directory,
Spellchecking and such
2006-10-23 20:10:32 +02:00
and then returns the backup's starting transaction log location as text. The user
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
need not pay any attention to this result value, but it is provided in
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
case it is of use.
<programlisting>
postgres=# select pg_start_backup('label_goes_here');
pg_start_backup
-----------------
0/D4445B8
(1 row)
</programlisting>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
<function>pg_stop_backup</> removes the label file created by
<function>pg_start_backup</>, and instead creates a backup history file in
Spellchecking and such
2006-10-23 20:10:32 +02:00
the transaction log archive area. The history file includes the label given to
<function>pg_start_backup</>, the starting and ending transaction log locations for
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
the backup, and the starting and ending times of the backup. The return
Spellchecking and such
2006-10-23 20:10:32 +02:00
value is the backup's ending transaction log location (which again may be of little
interest). After noting the ending location, the current transaction log insertion
point is automatically advanced to the next transaction log file, so that the
ending transaction log file can be archived immediately to complete the backup.
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</para>
<para>
Spellchecking and such
2006-10-23 20:10:32 +02:00
<function>pg_switch_xlog</> moves to the next transaction log file, allowing the
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
current file to be archived (assuming you are using continuous archiving).
Spellchecking and such
2006-10-23 20:10:32 +02:00
The result is the ending transaction log location within the just-completed transaction log file.
If there has been no transaction log activity since the last transaction log switch,
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
<function>pg_switch_xlog</> does nothing and returns the end location
Spellchecking and such
2006-10-23 20:10:32 +02:00
of the previous transaction log file.
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</para>
<para>
Spellchecking and such
2006-10-23 20:10:32 +02:00
<function>pg_current_xlog_location</> displays the current transaction log write
Implement archive_timeout feature to force xlog file switches to occur no more than N seconds apart. This allows a simple, if not very high performance, means of guaranteeing that a PITR archive is no more than N seconds behind real time. Also make pg_current_xlog_location return the WAL Write pointer, add pg_current_xlog_insert_location to return the Insert pointer, and fix pg_xlogfile_name_offset to return its results as a two-element record instead of a smashed-together string, as per recent discussion. Simon Riggs
2006-08-18 01:04:10 +02:00
location in the same format used by the above functions. Similarly
Spellchecking and such
2006-10-23 20:10:32 +02:00
<function>pg_current_xlog_insert_location</> displays the current transaction log
insertion point. The insertion point is the <quote>logical</> end of transaction log
Implement archive_timeout feature to force xlog file switches to occur no more than N seconds apart. This allows a simple, if not very high performance, means of guaranteeing that a PITR archive is no more than N seconds behind real time. Also make pg_current_xlog_location return the WAL Write pointer, add pg_current_xlog_insert_location to return the Insert pointer, and fix pg_xlogfile_name_offset to return its results as a two-element record instead of a smashed-together string, as per recent discussion. Simon Riggs
2006-08-18 01:04:10 +02:00
at any instant, while the write location is the end of what has actually
been written out from the server's internal buffers. The write location
is the end of what can be examined from outside the server, and is usually
Spellchecking and such
2006-10-23 20:10:32 +02:00
what you want if you are interested in archiving partially-complete transaction log
Implement archive_timeout feature to force xlog file switches to occur no more than N seconds apart. This allows a simple, if not very high performance, means of guaranteeing that a PITR archive is no more than N seconds behind real time. Also make pg_current_xlog_location return the WAL Write pointer, add pg_current_xlog_insert_location to return the Insert pointer, and fix pg_xlogfile_name_offset to return its results as a two-element record instead of a smashed-together string, as per recent discussion. Simon Riggs
2006-08-18 01:04:10 +02:00
files. The insertion point is made available primarily for server
debugging purposes. These are both read-only operations and do not
require superuser permissions.
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
</para>
<para>
You can use <function>pg_xlogfile_name_offset</> to extract the
Spellchecking and such
2006-10-23 20:10:32 +02:00
corresponding transaction log file name and byte offset from the results of any of the
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
above functions. For example:
<programlisting>
Implement archive_timeout feature to force xlog file switches to occur no more than N seconds apart. This allows a simple, if not very high performance, means of guaranteeing that a PITR archive is no more than N seconds behind real time. Also make pg_current_xlog_location return the WAL Write pointer, add pg_current_xlog_insert_location to return the Insert pointer, and fix pg_xlogfile_name_offset to return its results as a two-element record instead of a smashed-together string, as per recent discussion. Simon Riggs
2006-08-18 01:04:10 +02:00
postgres=# select * from pg_xlogfile_name_offset(pg_stop_backup());
file_name | file_offset
--------------------------+-------------
00000001000000000000000D | 4039624
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
(1 row)
</programlisting>
Spellchecking and such
2006-10-23 20:10:32 +02:00
Similarly, <function>pg_xlogfile_name</> extracts just the transaction log file name.
When the given transction log location is exactly at an transaction log file boundary, both
these functions return the name of the preceding transaction log file.
This is usually the desired behavior for managing transaction log archiving
Add support for forcing a switch to a new xlog file; cause such a switch to happen automatically during pg_stop_backup(). Add some functions for interrogating the current xlog insertion point and for easily extracting WAL filenames from the hex WAL locations displayed by pg_stop_backup and friends. Simon Riggs with some editorialization by Tom Lane.
2006-08-06 05:53:44 +02:00
behavior, since the preceding file is the last one that currently
needs to be archived.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Documentation for generate_series() functions committed a few days ago.
2004-02-05 23:54:36 +01:00
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
<para>
For details about proper usage of these functions, see
Rename Online Backup to Continuous Archiving.
2006-03-03 23:02:08 +01:00
<xref linkend="continuous-archiving">.
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</para>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
<para>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
The functions shown in <xref linkend="functions-admin-dbsize"> calculate
the actual disk space usage of database objects.
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</para>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<indexterm zone="functions-admin">
<primary>pg_column_size</primary>
</indexterm>
<indexterm zone="functions-admin">
<primary>pg_database_size</primary>
</indexterm>
<indexterm zone="functions-admin">
<primary>pg_relation_size</primary>
</indexterm>
<indexterm zone="functions-admin">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>pg_size_pretty</primary>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
</indexterm>
<indexterm zone="functions-admin">
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<primary>pg_tablespace_size</primary>
</indexterm>
<indexterm zone="functions-admin">
<primary>pg_total_relation_size</primary>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
</indexterm>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
<table id="functions-admin-dbsize">
<title>Database Object Size Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
</row>
</thead>
<tbody>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<row>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<entry><function>pg_column_size</function>(<type>any</type>)</entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<entry><type>int</type></entry>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<entry>Number of bytes used to store a particular value (possibly compressed)</entry>
</row>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_database_size</function>(<type>oid</type>)</literal>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</entry>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<entry><type>bigint</type></entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry>Disk space used by the database with the specified OID</entry>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</row>
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_database_size</function>(<type>name</type>)</literal>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</entry>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<entry><type>bigint</type></entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry>Disk space used by the database with the specified name</entry>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</row>
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_relation_size</function>(<type>oid</type>)</literal>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</entry>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<entry><type>bigint</type></entry>
<entry>Disk space used by the table or index with the specified OID</entry>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</row>
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_relation_size</function>(<type>text</type>)</literal>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</entry>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<entry><type>bigint</type></entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry>
Disk space used by the table or index with the specified name.
The table name may be qualified with a schema name
</entry>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</row>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<row>
<entry>
<literal><function>pg_size_pretty</function>(<type>bigint</type>)</literal>
</entry>
<entry><type>text</type></entry>
<entry>Converts a size in bytes into a human-readable format with size units</entry>
</row>
<row>
<entry>
<literal><function>pg_tablespace_size</function>(<type>oid</type>)</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>
</entry>
<entry><type>bigint</type></entry>
<entry>Disk space used by the tablespace with the specified name</entry>
</row>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
<row>
<entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<literal><function>pg_total_relation_size</function>(<type>oid</type>)</literal>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</entry>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<entry><type>bigint</type></entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry>
Total disk space used by the table with the specified OID,
including indexes and toasted data
</entry>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</row>
<row>
<entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<literal><function>pg_total_relation_size</function>(<type>text</type>)</literal>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</entry>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<entry><type>bigint</type></entry>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<entry>
Total disk space used by the table with the specified name,
including indexes and toasted data. The table name may be
qualified with a schema name
</entry>
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</row>
</tbody>
</tgroup>
</table>
<para>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<function>pg_column_size</> shows the space used to store any individual
data value.
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</para>
<para>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<function>pg_database_size</function> and <function>pg_tablespace_size</>
accept the OID or name of a database or tablespace, and return the total
disk space used therein.
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
</para>
<para>
<function>pg_relation_size</> accepts the OID or name of a table, index or
Fix broken markup and spelling, put paragraph in a somewhat less random place.
2005-07-31 00:53:15 +02:00
toast table, and returns the size in bytes.
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</para>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
<para>
Code and docs review for pg_column_size() patch.
2005-08-02 18:11:57 +02:00
<function>pg_size_pretty</> can be used to format the result of one of
the other functions in a human-readable way, using kB, MB, GB or TB as
appropriate.
Move dbsize functions into the backend. New functions: pg_tablespace_size pg_database_size pg_relation_size pg_complete_relation_size pg_size_pretty Remove /contrib/dbsize. Dave Page
2005-07-29 16:47:04 +02:00
</para>
Reorder the entries in the function section of the manual, to ensure they are alphabetically ordered. I believe the tables were correctly ordered in the past, but some of them had subsequently regressed.
2006-07-14 01:59:47 +02:00
<para>
<function>pg_total_relation_size</> accepts the OID or name of a
table or toast table, and returns the size in bytes of the data
and all associated indexes and toast tables.
</para>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
<para>
The functions shown in <xref
linkend="functions-admin-genfile"> provide native file access to
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
files on the machine hosting the server. Only files within the
database cluster directory and the <varname>log_directory</> may be
accessed. Use a relative path for files within the cluster directory,
and a path matching the <varname>log_directory</> configuration setting
for log files. Use of these functions is restricted to superusers.
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</para>
<table id="functions-admin-genfile">
<title>Generic File Access Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_ls_dir</function>(<parameter>dirname</> <type>text</>)</literal>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</entry>
<entry><type>setof text</type></entry>
<entry>List the contents of a directory</entry>
</row>
<row>
<entry>
Various documentation improvements. Add a lot of index entries for the builtin functions (although some more entries are still needed), and remove the duplicate index entries that have been causing collateindex.pl warnings. Consistently use "int" and "bigint", rather than a mix of "int", "integer", "int4", "bigint", and "int8". Make parenthesis style in syntax examples more consistent. Various copy-editing for newly-added documentation and SGML markup fixes.
2005-09-14 23:14:26 +02:00
<literal><function>pg_read_file</function>(<parameter>filename</> <type>text</>, <parameter>offset</> <type>bigint</>, <parameter>length</> <type>bigint</>)</literal>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</entry>
<entry><type>text</type></entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<entry>Return the contents of a text file</entry>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</row>
<row>
<entry>
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<literal><function>pg_stat_file</function>(<parameter>filename</> <type>text</>)</literal>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</entry>
<entry><type>record</type></entry>
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
<entry>Return information about a file</entry>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</row>
</tbody>
</tgroup>
</table>
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
<indexterm zone="functions-admin">
<primary>pg_ls_dir</primary>
</indexterm>
<para>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<function>pg_ls_dir</> returns all the names in the specified
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
directory, except the special entries <quote><literal>.</></> and
<quote><literal>..</></>.
</para>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
<indexterm zone="functions-admin">
<primary>pg_read_file</primary>
</indexterm>
<para>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<function>pg_read_file</> returns part of a text file, starting
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
at the given <parameter>offset</>, returning at most <parameter>length</>
bytes (less if the end of file is reached first). If <parameter>offset</>
is negative, it is relative to the end of the file.
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</para>
<indexterm zone="functions-admin">
<primary>pg_stat_file</primary>
</indexterm>
<para>
Rename pg_complete_relation_size() to pg_total_relation_size(), for the sake of brevity and clarity. Make pg_reload_conf(), pg_rotate_logfile(), and pg_cancel_backend() return a boolean rather than an integer to indicate success or failure. Along the way, make some minor cleanups to dbsize.c -- in particular, use elog() rather than ereport() for "shouldn't happen" error conditions, and remove some of the more flagrant violations of the Postgres indentation conventions. Catalog version bumped.
2005-09-16 07:35:41 +02:00
<function>pg_stat_file</> returns a record containing the file
Add documentation for new in-core advisory lock functions. Merlin Moncure
2006-09-21 01:43:22 +02:00
size, last accessed time stamp, last modified time stamp,
last file status change time stamp (Unix platforms only),
Spellchecking and such
2006-10-23 20:10:32 +02:00
file creation time stamp (Windows only), and a <type>boolean</type>
Add documentation for new in-core advisory lock functions. Merlin Moncure
2006-09-21 01:43:22 +02:00
indicating if it is a directory. Typical usages include:
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
<programlisting>
Make pg_stat_file() use OUT parameters so that the user doesn't have to remember the output parameter set for himself. It's a bit of a kluge but fixing array_in to work in bootstrap mode looks worse. I removed the separate pg_file_length() function, as it no longer has any real notational advantage --- you can write (pg_stat_file(...)).length.
2005-08-13 21:02:34 +02:00
SELECT * FROM pg_stat_file('filename');
Rename pg_stat_file columns to be more consistent. Split apart change and creation columns to behave for Unix or Win32.
2005-08-16 01:00:14 +02:00
SELECT (pg_stat_file('filename')).modification;
Code & docs review for server instrumentation patch. File timestamps should surely be timestamptz not timestamp; fix some but not all of the holes in check_and_make_absolute(); other minor cleanup. Also put in the missed catversion bump.
2005-08-12 20:23:56 +02:00
</programlisting>
Add files to do read I/O on the cluster directory: pg_stat_file() pg_read_file() pg_ls_dir() pg_reload_conf() pg_rotate_logfile() Dave Page Andreas Pflug
2005-08-12 05:25:13 +02:00
</para>
Add documentation for new in-core advisory lock functions. Merlin Moncure
2006-09-21 01:43:22 +02:00
<para>
The functions shown in <xref linkend="functions-advisory-locks"> manage
advisory locks. For details about proper usage of these functions, see
<xref linkend="advisory-locks">.
</para>
<table id="functions-advisory-locks">
<title>Advisory Lock Functions</title>
<tgroup cols="3">
<thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<literal><function>pg_advisory_lock</function>(<parameter>key</> <type>bigint</>)</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>
</entry>
<entry><type>void</type></entry>
<entry>Obtain exclusive advisory lock</entry>
</row>
<row>
<entry>
<literal><function>pg_advisory_lock_shared</function>(<parameter>key</> <type>bigint</>)</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>
</entry>
<entry><type>void</type></entry>
<entry>Obtain shared advisory lock</entry>
</row>
<row>
<entry>
<literal><function>pg_try_advisory_lock</function>(<parameter>key</> <type>bigint</>)</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>
</entry>
<entry><type>boolean</type></entry>
<entry>Obtain exclusive advisory lock if available</entry>
</row>
<row>
<entry>
<literal><function>pg_try_advisory_lock_shared</function>(<parameter>key</> <type>bigint</>)</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>
</entry>
<entry><type>boolean</type></entry>
<entry>Obtain shared advisory lock if available</entry>
</row>
<row>
<entry>
<literal><function>pg_advisory_unlock</function>(<parameter>key</> <type>bigint</>)</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>
</entry>
<entry><type>boolean</type></entry>
<entry>Release an exclusive advisory lock</entry>
</row>
<row>
<entry>
<literal><function>pg_advisory_unlock_shared</function>(<parameter>key</> <type>bigint</>)</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>
</entry>
<entry><type>boolean</type></entry>
<entry>Release a shared advisory lock</entry>
</row>
<row>
<entry>
<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>
</row>
</tbody>
</tgroup>
</table>
<indexterm zone="functions-admin">
<primary>pg_advisory_lock</primary>
</indexterm>
<para>
<function>pg_advisory_lock</> locks an application-defined resource,
which may be identified either by a single 64-bit key value or two
32-bit key values (note that these two key spaces do not overlap). If
another session already holds a lock on the same resource, the
function will wait until the resource becomes available. The lock
is exclusive. Multiple lock requests stack, so that if the same resource
is locked three times it must be also unlocked three times to be
released for other sessions' use.
</para>
<indexterm zone="functions-admin">
<primary>pg_advisory_lock_shared</primary>
</indexterm>
<para>
<function>pg_advisory_lock_shared</> works the same as
<function>pg_advisory_lock</>,
except the lock can be shared with other sessions requesting shared locks.
Only would-be exclusive lockers are locked out.
</para>
<indexterm zone="functions-admin">
<primary>pg_try_advisory_lock</primary>
</indexterm>
<para>
<function>pg_try_advisory_lock</> is similar to
<function>pg_advisory_lock</>, except the function will not wait for the
lock to become available. It will either obtain the lock immediately and
return <literal>true</>, or return <literal>false</> if the lock cannot be
acquired now.
</para>
<indexterm zone="functions-admin">
<primary>pg_try_advisory_lock_shared</primary>
</indexterm>
<para>
<function>pg_try_advisory_lock_shared</> works the same as
<function>pg_try_advisory_lock</>, except it attempts to acquire
shared rather than exclusive lock.
</para>
<indexterm zone="functions-admin">
<primary>pg_advisory_unlock</primary>
</indexterm>
<para>
<function>pg_advisory_unlock</> will release a previously-acquired
exclusive advisory lock. It
will return <literal>true</> if the lock is successfully released.
If the lock was in fact not held, it will return <literal>false</>,
and in addition, an SQL warning will be raised by the server.
</para>
<indexterm zone="functions-admin">
<primary>pg_advisory_unlock_shared</primary>
</indexterm>
<para>
<function>pg_advisory_unlock_shared</> works the same as
<function>pg_advisory_unlock</>,
except to release a shared advisory lock.
</para>
<indexterm zone="functions-admin">
<primary>pg_advisory_unlock_all</primary>
</indexterm>
<para>
<function>pg_advisory_unlock_all</> will release all advisory locks
held by the current session. (This function is implicitly invoked
at session end, even if the client disconnects ungracefully.)
</para>
Add functions pg_start_backup, pg_stop_backup to create backup label and history files as per recent discussion. While at it, remove pg_terminate_backend, since we have decided we do not have time during this release cycle to address the reliability concerns it creates. Split the 'Miscellaneous Functions' documentation section into 'System Information Functions' and 'System Administration Functions', which hopefully will draw the eyes of those looking for such things.
2004-08-03 22:32:36 +02:00
</sect1>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<sect1 id="functions-xml">
<title>XML Functions</title>
<para>
The functions and function-like expressions described in this
section operate on values of type <type>xml</type>. Check <xref
linkend="datatype-xml"> for information about the <type>xml</type>
type. The function-like expressions <function>xmlparse</function>
and <function>xmlserialize</function> for converting to and from
type <type>xml</type> are not repeated here.
</para>
<sect2>
<title>Producing XML Content</title>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
A set of functions and function-like expressions are available for
producing XML content from SQL data. As such, they are
particularly suitable for formatting query results into XML
documents for processing in client applications.
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<title><literal>xmlcomment</literal></title>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<indexterm>
<primary>xmlcomment</primary>
</indexterm>
<synopsis>
<function>xmlcomment</function>(<replaceable>text</replaceable>)
</synopsis>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
The function <function>xmlcomment</function> creates an XML value
containing an XML comment with the specified text as content.
The text may not contain <literal>--</literal> or end with a
<literal>-</literal> so that the resulting construct is a valid
XML comment. If the argument is null, the result is null.
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<para>
Example:
<screen><![CDATA[
SELECT xmlcomment('hello');
xmlcomment
--------------
<!--hello-->
]]></screen>
</para>
</sect3>
<sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<title><literal>xmlconcat</literal></title>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<indexterm>
<primary>xmlconcat</primary>
</indexterm>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<synopsis>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<function>xmlconcat</function>(<replaceable>xml</replaceable><optional>, ...</optional>)
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</synopsis>
<para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
The function <function>xmlconcat</function> concatenates a list
of individual XML values to create a single value containing an
XML content fragment. Null values are omitted; the result is
only null if there are no nonnull arguments.
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<para>
Example:
<screen><![CDATA[
SELECT xmlconcat('<abc/>', '<bar>foo</bar>');
xmlconcat
----------------------
<abc/><bar>foo</bar>
]]></screen>
</para>
<para>
XML declarations, if present are combined as follows. If all
argument values have the same XML version declaration, that
version is used in the result, else no version is used. If all
argument values have the standalone declaration value
<quote>yes</quote>, then that value is used in the result. If
all argument values have a standalone declaration value and at
least one is <quote>no</quote>, then that is used in the result.
Else the result will have no standalone declaration. If the
result is determined to require a standalone declaration but no
version declaration, a version declaration with version 1.0 will
be used because XML requires an XML declaration to contain a
version declaration. Encoding declarations are ignored and
removed in all cases.
</para>
<para>
Example:
<screen><![CDATA[
SELECT xmlconcat('<?xml version="1.1"?><foo/>', '<?xml version="1.1" standalone="no"?><bar/>');
xmlconcat
-----------------------------------
<?xml version="1.1"?><foo/><bar/>
]]></screen>
</para>
</sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<title><literal>xmlelement</literal></title>
<indexterm>
<primary>xmlelement</primary>
</indexterm>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<synopsis>
<function>xmlelement</function>(name <replaceable>name</replaceable> <optional>, xmlattributes(<replaceable>value</replaceable> <optional>AS <replaceable>attname</replaceable></optional> <optional>, ... </optional>)</optional> <optional><replaceable>, content, ...</replaceable></optional>)
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</synopsis>
<para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
The <function>xmlelement</function> expression produces an XML
element with the given name, attributes, and content.
</para>
<para>
Examples:
<screen><![CDATA[
SELECT xmlelement(name foo);
xmlelement
------------
<foo/>
SELECT xmlelement(name foo, xmlattributes('xyz' as bar));
xmlelement
------------------
<foo bar="xyz"/>
SELECT xmlelement(name foo, xmlattributes(current_date as bar), 'cont', 'ent');
xmlelement
-------------------------------------
<foo bar="2007-01-26">content</foo>
]]></screen>
</para>
<para>
Element and attribute names that are not valid XML names are
escaped by replacing the offending characters by the sequence
<literal>_x<replaceable>HHHH</replaceable>_</literal>, where
<replaceable>HHHH</replaceable> is the character's Unicode
codepoint in hexadecimal notation. For example:
<screen><![CDATA[
SELECT xmlelement(name "foo$bar", xmlattributes('xyz' as "a&b"));
xmlelement
----------------------------------
<foo_x0024_bar a_x0026_b="xyz"/>
]]></screen>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<para>
An explicit attribute name need not be specified if the attribute
value is a column reference, in which case the column's name will
be used as attribute name by default. In any other case, the
attribute must be given an explicit name. So this example is
valid:
<screen>
CREATE TABLE test (a xml, b xml);
SELECT xmlelement(name test, xmlattributes(a, b)) FROM test;
</screen>
But these are not:
<screen>
SELECT xmlelement(name test, xmlattributes('constant'), a, b) FROM test;
SELECT xmlelement(name test, xmlattributes(func(a, b))) FROM test;
</screen>
</para>
<para>
Element content, if specified, will be formatted according to
data type. If the content is itself of type <type>xml</type>,
complex XML documents can be constructed. For example:
<screen><![CDATA[
SELECT xmlelement(name foo, xmlattributes('xyz' as bar),
xmlelement(name abc),
xmlcomment('test'),
xmlelement(name xyz));
xmlelement
----------------------------------------------
<foo bar="xyz"><abc/><!--test--><xyz/></foo>
]]></screen>
Content of other types will be formatted into valid XML character
data. This means in particular that the characters &lt;, &gt;,
and &amp; will be converted to entities. Binary data (data type
<type>bytea</type>) will be represented in base64 or hex
encoding, depending on the setting of the configuration parameter
<xref linkend="guc-xmlbinary">. The particular behavior for
individual data types is expected evolve in order to align the
SQL and PostgreSQL data types with the XML Schema specification,
at which point a more precise description will appear.
</para>
</sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<title><literal>xmlforest</literal></title>
<indexterm>
<primary>xmlforest</primary>
</indexterm>
<synopsis>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<function>xmlforest</function>(<replaceable>content</replaceable> <optional>AS <replaceable>name</replaceable></optional> <optional>, ...</optional>)
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</synopsis>
<para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
The <function>xmlforest</function> expression produces an XML
forest (sequence) of elements using the given names and content.
</para>
<para>
Examples:
<screen><![CDATA[
SELECT xmlforest('abc' AS foo, 123 AS bar);
xmlforest
------------------------------
<foo>abc</foo><bar>123</bar>
SELECT xmlforest(table_name, column_name) FROM information_schema.columns WHERE table_schema = 'pg_catalog';
xmlforest
-------------------------------------------------------------------------------------------
<table_name>pg_authid</table_name><column_name>rolname</column_name>
<table_name>pg_authid</table_name><column_name>rolsuper</column_name>
...
]]></screen>
As seen in the second example, the element name can be omitted if
the content value is a column reference, in which case the column
name is used by default. Otherwise, a name must be specified.
</para>
<para>
Element names that are not valid XML names are escaped as shown
for <function>xmlelement</function> above. Similarly, content
data is escaped to make valid XML content, unless it is already
of type <type>xml</type>.
</para>
<para>
Note that XML forests are not valid XML documents if they consist
of more than one element. So it might be useful to wrap
<function>xmlforest</function> expressions in
<function>xmlelement</function>.
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
</sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<title><literal>xmlpi</literal></title>
<indexterm>
<primary>xmlpi</primary>
</indexterm>
<synopsis>
<function>xmlpi</function>(name <replaceable>target</replaceable> <optional>, <replaceable>content</replaceable></optional>)
</synopsis>
<para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
The <function>xmlpi</function> expression creates an XML
processing instruction. The content, if present, must not
contain the character sequence <literal>?&lt;</literal>.
</para>
<para>
Example:
<screen><![CDATA[
SELECT xmlpi(name php, 'echo "hello world";');
xmlpi
-----------------------------
<?php echo "hello world";?>
]]></screen>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
</sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<sect3>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
<title><literal>xmlroot</literal></title>
<indexterm>
<primary>xmlroot</primary>
</indexterm>
<synopsis>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
<function>xmlroot</function>(<replaceable>xml</replaceable>, version <replaceable>text</replaceable>|no value <optional>, standalone yes|no|no value</optional>)
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</synopsis>
<para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
The <function>xmlroot</function> expression alters the properties
of the root node of an XML value. If a version is specified,
this replaces the value in the version declaration, if a
standalone value is specified, this replaces the value in the
standalone declaration.
</para>
<para>
<screen><![CDATA[
SELECT xmlroot(xmlparse(document '<?xml version="1.1"?><content>abc</content>'), version '1.0', standalone yes);
xmlroot
----------------------------------------
<?xml version="1.0" standalone="yes"?>
<content>abc</content>
]]></screen>
</para>
</sect3>
<sect3>
<title>XML Predicates</title>
<indexterm>
<primary>IS DOCUMENT</primary>
</indexterm>
<synopsis>
<replaceable>xml</replaceable> IS DOCUMENT
</synopsis>
<para>
The expression <literal>IS DOCUMENT</literal> returns true if the
argument XML value is a proper XML document, false if it is not
(that is, it is a content fragment), or null if the argument is
null. See <xref linkend="datatype-xml"> about the difference
between documents and content fragments.
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</para>
Update documentation on XML functions
2007-01-29 14:24:30 +01:00
</sect3>
</sect2>
<sect2>
<title>Processing XML</title>
<para>
<acronym>XML</> support is not just the existence of an
<type>xml</type> data type, but a variety of features supported by
a database system. These capabilities include import/export,
indexing, searching, transforming, and <acronym>XML</> to
<acronym>SQL</> mapping. <productname>PostgreSQL</> supports some
but not all of these <acronym>XML</> capabilities. For an
overview of <acronym>XML</> use in databases, see <ulink
url="http://www.rpbourret.com/xml/XMLAndDatabases.htm"></>.
</para>
<variablelist>
<varlistentry>
<term>Import/Export</term>
<listitem>
<para>
There is no facility for mapping <acronym>XML</> to relational
tables. An external tool must be used for this. One simple way
to export <acronym>XML</> is to use <application>psql</> in
<acronym>HTML</> mode (<literal>\pset format html</>), and
convert the <acronym>XHTML</> output to XML using an external
tool.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Indexing</term>
<listitem>
<para>
<filename>contrib/xml2/</> functions can be used in expression
indexes to index specific <acronym>XML</> fields. To index the
full contents of <acronym>XML</> documents, the full-text
indexing tool <filename>contrib/tsearch2/</> can be used. Of
course, Tsearch2 indexes have no <acronym>XML</> awareness so
additional <filename>contrib/xml2/</> checks should be added to
queries.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Searching</term>
<listitem>
<para>
XPath searches are implemented using <filename>contrib/xml2/</>.
It processes <acronym>XML</> text documents and returns results
based on the requested query.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Transforming</term>
<listitem>
<para>
<filename>contrib/xml2/</> supports <acronym>XSLT</> (Extensible
Stylesheet Language Transformation).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>XML to SQL Mapping</term>
<listitem>
<para>
This involves converting <acronym>XML</> data to and from
relational structures. <productname>PostgreSQL</> has no
internal support for such mapping, and relies on external tools
to do such conversions.
</para>
</listitem>
</varlistentry>
</variablelist>
Initial SQL/XML support: xml data type and initial set of functions.
2006-12-21 17:05:16 +01:00
</sect2>
</sect1>
Merge functions and operators chapters. Lots of updates.
2000-12-14 23:30:56 +01:00
</chapter>