summaryrefslogtreecommitdiff
path: root/doc/src/sgml/adminpack.sgml
diff options
context:
space:
mode:
authorTom Lane2020-05-07 18:25:18 +0000
committerTom Lane2020-05-07 18:25:25 +0000
commitb2fd8ebe239f726b99923f827e908a92f6f4f232 (patch)
treeba7c7ea11cbff01d04f6d3916b595987f2f22b81 /doc/src/sgml/adminpack.sgml
parentc265ed9b355fdd2a80e7af64e88cddabd3d39151 (diff)
Doc: update remaining tables of functions/operators for new layout.
This converts the contrib documentation to the new style, and mops up a couple of function tables that were outside chapter 9 in the main docs. A few contrib modules choose not to present their functions in the standard tabular format. There might be room to rethink those decisions now that the standard format is more friendly to verbose descriptions. But I have not undertaken to do that here; I just converted existing tables.
Diffstat (limited to 'doc/src/sgml/adminpack.sgml')
-rw-r--r--doc/src/sgml/adminpack.sgml106
1 files changed, 63 insertions, 43 deletions
diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml
index 977073f7c8d..0dd89be3534 100644
--- a/doc/src/sgml/adminpack.sgml
+++ b/doc/src/sgml/adminpack.sgml
@@ -29,49 +29,69 @@
<table id="functions-adminpack-table">
<title><filename>adminpack</filename> Functions</title>
- <tgroup cols="3">
- <thead>
- <row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry><function>pg_catalog.pg_file_write(filename text, data text, append boolean)</function></entry>
- <entry><type>bigint</type></entry>
- <entry>
- Write, or append to, a text file
- </entry>
- </row>
- <row>
- <entry><function>pg_catalog.pg_file_sync(filename text)</function></entry>
- <entry><type>void</type></entry>
- <entry>
- Flush a file or directory to disk
- </entry>
- </row>
- <row>
- <entry><function>pg_catalog.pg_file_rename(oldname text, newname text <optional>, archivename text</optional>)</function></entry>
- <entry><type>boolean</type></entry>
- <entry>
- Rename a file
- </entry>
- </row>
- <row>
- <entry><function>pg_catalog.pg_file_unlink(filename text)</function></entry>
- <entry><type>boolean</type></entry>
- <entry>
- Remove a file
- </entry>
- </row>
- <row>
- <entry><function>pg_catalog.pg_logdir_ls()</function></entry>
- <entry><type>setof record</type></entry>
- <entry>
- List the log files in the <varname>log_directory</varname> directory
- </entry>
- </row>
- </tbody>
+ <tgroup cols="1">
+ <thead>
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ Function
+ </para>
+ <para>
+ Description
+ </para></entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <function>pg_catalog.pg_file_write</function> ( <parameter>filename</parameter> <type>text</type>, <parameter>data</parameter> <type>text</type>, <parameter>append</parameter> <type>boolean</type> )
+ <returnvalue>bigint</returnvalue>
+ </para>
+ <para>
+ Writes, or appends to, a text file.
+ </para></entry>
+ </row>
+
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <function>pg_catalog.pg_file_sync</function> ( <parameter>filename</parameter> <type>text</type> )
+ <returnvalue>void</returnvalue>
+ </para>
+ <para>
+ Flushes a file or directory to disk.
+ </para></entry>
+ </row>
+
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <function>pg_catalog.pg_file_rename</function> ( <parameter>oldname</parameter> <type>text</type>, <parameter>newname</parameter> <type>text</type> <optional>, <parameter>archivename</parameter> <type>text</type> </optional> )
+ <returnvalue>boolean</returnvalue>
+ </para>
+ <para>
+ Renames a file.
+ </para></entry>
+ </row>
+
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <function>pg_catalog.pg_file_unlink</function> ( <parameter>filename</parameter> <type>text</type> )
+ <returnvalue>boolean</returnvalue>
+ </para>
+ <para>
+ Removes a file.
+ </para></entry>
+ </row>
+
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <function>pg_catalog.pg_logdir_ls</function> ()
+ <returnvalue>setof record</returnvalue>
+ </para>
+ <para>
+ Lists the log files in the <varname>log_directory</varname> directory.
+ </para></entry>
+ </row>
+ </tbody>
</tgroup>
</table>