mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc fixes:

Browse Source 
- remove excessive table cells
- moving function parameters into function tags rather than having
  them being considered separate
- add return type column on XML2 contrib module functions list and
  removing return types from function
- add table header to XML2 contrib parameter table

Thom Brown

Backpatch to 9.0.X.
This commit is contained in:
Bruce Momjian 2010-09-09 00:48:22 +00:00
parent 8586306048
commit 152c626105
6 changed files with 447 additions and 396 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/sgml/datatype.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.257 2010/08/17 04:37:20 petere Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.258 2010/09/09 00:48:22 momjian Exp $ -->
<chapter id="datatype">
<title>Data Types</title>
@ -3413,7 +3413,7 @@ SELECT person.name, holidays.num_weeks FROM person, holidays
<row>
<entry><type>cidr</type> Input</entry>
<entry><type>cidr</type> Output</entry>
<entry><literal><function>abbrev</function>(<type>cidr</type>)</literal></entry>
<entry><literal><function>abbrev(<type>cidr</type>)</function></literal></entry>
</row>
</thead>
<tbody>

673
doc/src/sgml/func.sgml
View File

File diff suppressed because it is too large Load Diff

24
doc/src/sgml/monitoring.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/monitoring.sgml,v 1.85 2010/08/21 10:59:17 mha Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/monitoring.sgml,v 1.86 2010/09/09 00:48:22 momjian Exp $ -->
<chapter id="monitoring">
<title>Monitoring Database Activity</title>
@ -832,7 +832,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
<row>
<!-- See also the entry for this in func.sgml -->
<entry><literal><function>pg_backend_pid</function>()</literal></entry>
<entry><literal><function>pg_backend_pid()</function></literal></entry>
<entry><type>integer</type></entry>
<entry>
Process ID of the server process attached to the current session
@ -904,7 +904,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_backend_idset</function>()</literal></entry>
<entry><literal><function>pg_stat_get_backend_idset()</function></literal></entry>
<entry><type>setof integer</type></entry>
<entry>
Set of currently active server process numbers (from 1 to the
@ -1015,7 +1015,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_bgwriter_timed_checkpoints</function>()</literal></entry>
<entry><literal><function>pg_stat_get_bgwriter_timed_checkpoints()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>
Number of times the background writer has started timed checkpoints
@ -1024,7 +1024,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_bgwriter_requested_checkpoints</function>()</literal></entry>
<entry><literal><function>pg_stat_get_bgwriter_requested_checkpoints()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>
Number of times the background writer has started checkpoints based
@ -1035,7 +1035,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_bgwriter_buf_written_checkpoints</function>()</literal></entry>
<entry><literal><function>pg_stat_get_bgwriter_buf_written_checkpoints()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>
Number of buffers written by the background writer during checkpoints
@ -1043,7 +1043,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_bgwriter_buf_written_clean</function>()</literal></entry>
<entry><literal><function>pg_stat_get_bgwriter_buf_written_clean()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>
Number of buffers written by the background writer for routine cleaning of
@ -1052,7 +1052,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_bgwriter_maxwritten_clean</function>()</literal></entry>
<entry><literal><function>pg_stat_get_bgwriter_maxwritten_clean()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>
Number of times the background writer has stopped its cleaning scan because
@ -1062,7 +1062,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_buf_written_backend</function>()</literal></entry>
<entry><literal><function>pg_stat_get_buf_written_backend()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>
Number of buffers written by backends because they needed
@ -1071,7 +1071,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_get_buf_alloc</function>()</literal></entry>
<entry><literal><function>pg_stat_get_buf_alloc()</function></literal></entry>
<entry><type>bigint</type></entry>
<entry>
Total number of buffer allocations
@ -1079,7 +1079,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_clear_snapshot</function>()</literal></entry>
<entry><literal><function>pg_stat_clear_snapshot()</function></literal></entry>
<entry><type>void</type></entry>
<entry>
Discard the current statistics snapshot
@ -1087,7 +1087,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
</row>
<row>
<entry><literal><function>pg_stat_reset</function>()</literal></entry>
<entry><literal><function>pg_stat_reset()</function></literal></entry>
<entry><type>void</type></entry>
<entry>
Reset all statistics counters for the current database to zero

36
doc/src/sgml/plperl.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/plperl.sgml,v 2.88 2010/08/17 04:37:21 petere Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/plperl.sgml,v 2.89 2010/09/09 00:48:22 momjian Exp $ -->
<chapter id="plperl">
<title>PL/Perl - Perl Procedural Language</title>
@ -445,9 +445,9 @@ SELECT * FROM test_munge();
</varlistentry>
<varlistentry>
<term><literal><function>spi_query</>(<replaceable>command</replaceable>)</literal></term>
<term><literal><function>spi_fetchrow</>(<replaceable>cursor</replaceable>)</literal></term>
<term><literal><function>spi_cursor_close</>(<replaceable>cursor</replaceable>)</literal></term>
<term><literal><function>spi_query(<replaceable>command</replaceable>)</function></literal></term>
<term><literal><function>spi_fetchrow(<replaceable>cursor</replaceable>)</function></literal></term>
<term><literal><function>spi_cursor_close(<replaceable>cursor</replaceable>)</function></literal></term>
<listitem>
<para>
@ -503,10 +503,10 @@ SELECT * from lotsa_md5(500);
</varlistentry>
<varlistentry>
<term><literal><function>spi_prepare</>(<replaceable>command</replaceable>, <replaceable>argument types</replaceable>)</literal></term>
<term><literal><function>spi_query_prepared</>(<replaceable>plan</replaceable>, <replaceable>arguments</replaceable>)</literal></term>
<term><literal><function>spi_exec_prepared</>(<replaceable>plan</replaceable> [, <replaceable>attributes</replaceable>], <replaceable>arguments</replaceable>)</literal></term>
<term><literal><function>spi_freeplan</>(<replaceable>plan</replaceable>)</literal></term>
<term><literal><function>spi_prepare(<replaceable>command</replaceable>, <replaceable>argument types</replaceable>)</function></literal></term>
<term><literal><function>spi_query_prepared(<replaceable>plan</replaceable>, <replaceable>arguments</replaceable>)</function></literal></term>
<term><literal><function>spi_exec_prepared(<replaceable>plan</replaceable> [, <replaceable>attributes</replaceable>], <replaceable>arguments</replaceable>)</function></literal></term>
<term><literal><function>spi_freeplan(<replaceable>plan</replaceable>)</function></literal></term>
<listitem>
<para>
@ -611,7 +611,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>elog</>(<replaceable>level</replaceable>, <replaceable>msg</replaceable>)</literal></term>
<term><literal><function>elog(<replaceable>level</replaceable>, <replaceable>msg</replaceable>)</function></literal></term>
<listitem>
<para>
Emit a log or error message. Possible levels are
@ -640,7 +640,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>quote_literal</>(<replaceable>string</replaceable>)</literal></term>
<term><literal><function>quote_literal(<replaceable>string</replaceable>)</function></literal></term>
<listitem>
<para>
Return the given string suitably quoted to be used as a string literal in an SQL
@ -657,7 +657,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>quote_nullable</>(<replaceable>string</replaceable>)</literal></term>
<term><literal><function>quote_nullable(<replaceable>string</replaceable>)</function></literal></term>
<listitem>
<para>
Return the given string suitably quoted to be used as a string literal in an SQL
@ -673,7 +673,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>quote_ident</>(<replaceable>string</replaceable>)</literal></term>
<term><literal><function>quote_ident(<replaceable>string</replaceable>)</function></literal></term>
<listitem>
<para>
Return the given string suitably quoted to be used as an identifier in
@ -690,7 +690,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>decode_bytea</>(<replaceable>string</replaceable>)</literal></term>
<term><literal><function>decode_bytea(<replaceable>string</replaceable>)</function></literal></term>
<listitem>
<para>
Return the unescaped binary data represented by the contents of the given string,
@ -705,7 +705,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>encode_bytea</>(<replaceable>string</replaceable>)</literal></term>
<term><literal><function>encode_bytea(<replaceable>string</replaceable>)</function></literal></term>
<listitem>
<para>
Return the <type>bytea</type> encoded form of the binary data contents of the given string.
@ -719,8 +719,8 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>encode_array_literal</>(<replaceable>array</replaceable>)</literal></term>
<term><literal><function>encode_array_literal</>(<replaceable>array</replaceable>, <replaceable>delimiter</replaceable>)</literal></term>
<term><literal><function>encode_array_literal(<replaceable>array</replaceable>)</function></literal></term>
<term><literal><function>encode_array_literal(<replaceable>array</replaceable>, <replaceable>delimiter</replaceable>)</function></literal></term>
<listitem>
<para>
Returns the contents of the referenced array as a string in array literal format
@ -738,7 +738,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>encode_array_constructor</>(<replaceable>array</replaceable>)</literal></term>
<term><literal><function>encode_array_constructor(<replaceable>array</replaceable>)</function></literal></term>
<listitem>
<para>
Returns the contents of the referenced array as a string in array constructor format
@ -756,7 +756,7 @@ SELECT release_hosts_query();
<secondary>in PL/Perl</secondary>
</indexterm>
<term><literal><function>looks_like_number</>(<replaceable>string</replaceable>)</literal></term>
<term><literal><function>looks_like_number(<replaceable>string</replaceable>)</function></literal></term>
<listitem>
<para>
Returns a true value if the content of the given string looks like a

4
doc/src/sgml/sources.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.37 2010/07/10 18:37:00 tgl Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.38 2010/09/09 00:48:22 momjian Exp $ -->
<chapter id="source">
<title>PostgreSQL Coding Conventions</title>
@ -419,7 +419,7 @@ Hint: the addendum
<para>
There are functions in the backend that will double-quote their own output
at need (for example, <function>format_type_be</>()). Do not put
at need (for example, <function>format_type_be()</function>). Do not put
additional quotes around the output of such functions.
</para>

102
doc/src/sgml/xml2.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/xml2.sgml,v 1.11 2010/08/17 04:37:21 petere Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/xml2.sgml,v 1.12 2010/09/09 00:48:22 momjian Exp $ -->
<sect1 id="xml2">
<title>xml2</title>
@ -41,13 +41,23 @@
<table id="xml2-functions-table">
<title>Functions</title>
<tgroup cols="2">
<tgroup cols="3">
<thead>
<row>
<entry>Function</entry>
<entry>Returns</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<synopsis>
xml_is_well_formed(document) returns bool
</synopsis>
<function>
xml_is_well_formed(document)
</function>
</entry>
<entry>
<type>bool</type>
</entry>
<entry>
<para>
@ -61,13 +71,14 @@ xml_is_well_formed(document) returns bool
</row>
<row>
<entry>
<synopsis>
xpath_string(document, query) returns text
xpath_number(document, query) returns float4
xpath_bool(document, query) returns bool
</synopsis>
<function>
xpath_string(document, query)
</function>
</entry>
<entry>
<type>text</type>
</entry>
<entry morerows="2">
<para>
These functions evaluate the XPath query on the supplied document, and
cast the result to the specified type.
@ -76,9 +87,32 @@ xpath_bool(document, query) returns bool
</row>
<row>
<entry>
<synopsis>
xpath_nodeset(document, query, toptag, itemtag) returns text
</synopsis>
<function>
xpath_number(document, query)
</function>
</entry>
<entry>
<type>float4</type>
</entry>
</row>
<row>
<entry>
<function>
xpath_bool(document, query)
</function>
</entry>
<entry>
<type>bool</type>
</entry>
</row>
<row>
<entry>
<function>
xpath_nodeset(document, query, toptag, itemtag)
</function>
</entry>
<entry>
<type>text</type>
</entry>
<entry>
<para>
@ -96,9 +130,12 @@ xpath_nodeset(document, query, toptag, itemtag) returns text
</row>
<row>
<entry>
<synopsis>
xpath_nodeset(document, query) returns text
</synopsis>
<function>
xpath_nodeset(document, query)
</function>
</entry>
<entry>
<type>text</type>
</entry>
<entry>
<para>
@ -108,9 +145,12 @@ xpath_nodeset(document, query) returns text
</row>
<row>
<entry>
<synopsis>
xpath_nodeset(document, query, itemtag) returns text
</synopsis>
<function>
xpath_nodeset(document, query, itemtag)
</function>
</entry>
<entry>
<type>text</type>
</entry>
<entry>
<para>
@ -120,9 +160,12 @@ xpath_nodeset(document, query, itemtag) returns text
</row>
<row>
<entry>
<synopsis>
xpath_list(document, query, separator) returns text
</synopsis>
<function>
xpath_list(document, query, separator)
</function>
</entry>
<entry>
<type>text</type>
</entry>
<entry>
<para>
@ -134,9 +177,12 @@ xpath_list(document, query, separator) returns text
</row>
<row>
<entry>
<synopsis>
xpath_list(document, query) returns text
</synopsis>
<function>
xpath_list(document, query)
</function>
</entry>
<entry>
<type>text</type>
</entry>
<entry>
This is a wrapper for the above function that uses <literal>,</>
@ -167,6 +213,12 @@ xpath_table(text key, text document, text relation, text xpaths, text criteria)
<table id="xml2-xpath-table-parameters">
<title><function>xpath_table</function> Parameters</title>
<tgroup cols="2">
<thead>
<row>
<entry>Parameter</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><parameter>key</parameter></entry>