Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit b2fd8eb

Browse files
committed
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.
1 parent c265ed9 commit b2fd8eb

16 files changed

+3645
-2338
lines changed

doc/src/sgml/adminpack.sgml

+63-43
Original file line numberDiff line numberDiff line change
@@ -29,49 +29,69 @@
2929

3030
<table id="functions-adminpack-table">
3131
<title><filename>adminpack</filename> Functions</title>
32-
<tgroup cols="3">
33-
<thead>
34-
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
35-
</row>
36-
</thead>
37-
38-
<tbody>
39-
<row>
40-
<entry><function>pg_catalog.pg_file_write(filename text, data text, append boolean)</function></entry>
41-
<entry><type>bigint</type></entry>
42-
<entry>
43-
Write, or append to, a text file
44-
</entry>
45-
</row>
46-
<row>
47-
<entry><function>pg_catalog.pg_file_sync(filename text)</function></entry>
48-
<entry><type>void</type></entry>
49-
<entry>
50-
Flush a file or directory to disk
51-
</entry>
52-
</row>
53-
<row>
54-
<entry><function>pg_catalog.pg_file_rename(oldname text, newname text <optional>, archivename text</optional>)</function></entry>
55-
<entry><type>boolean</type></entry>
56-
<entry>
57-
Rename a file
58-
</entry>
59-
</row>
60-
<row>
61-
<entry><function>pg_catalog.pg_file_unlink(filename text)</function></entry>
62-
<entry><type>boolean</type></entry>
63-
<entry>
64-
Remove a file
65-
</entry>
66-
</row>
67-
<row>
68-
<entry><function>pg_catalog.pg_logdir_ls()</function></entry>
69-
<entry><type>setof record</type></entry>
70-
<entry>
71-
List the log files in the <varname>log_directory</varname> directory
72-
</entry>
73-
</row>
74-
</tbody>
32+
<tgroup cols="1">
33+
<thead>
34+
<row>
35+
<entry role="func_table_entry"><para role="func_signature">
36+
Function
37+
</para>
38+
<para>
39+
Description
40+
</para></entry>
41+
</row>
42+
</thead>
43+
44+
<tbody>
45+
<row>
46+
<entry role="func_table_entry"><para role="func_signature">
47+
<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> )
48+
<returnvalue>bigint</returnvalue>
49+
</para>
50+
<para>
51+
Writes, or appends to, a text file.
52+
</para></entry>
53+
</row>
54+
55+
<row>
56+
<entry role="func_table_entry"><para role="func_signature">
57+
<function>pg_catalog.pg_file_sync</function> ( <parameter>filename</parameter> <type>text</type> )
58+
<returnvalue>void</returnvalue>
59+
</para>
60+
<para>
61+
Flushes a file or directory to disk.
62+
</para></entry>
63+
</row>
64+
65+
<row>
66+
<entry role="func_table_entry"><para role="func_signature">
67+
<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> )
68+
<returnvalue>boolean</returnvalue>
69+
</para>
70+
<para>
71+
Renames a file.
72+
</para></entry>
73+
</row>
74+
75+
<row>
76+
<entry role="func_table_entry"><para role="func_signature">
77+
<function>pg_catalog.pg_file_unlink</function> ( <parameter>filename</parameter> <type>text</type> )
78+
<returnvalue>boolean</returnvalue>
79+
</para>
80+
<para>
81+
Removes a file.
82+
</para></entry>
83+
</row>
84+
85+
<row>
86+
<entry role="func_table_entry"><para role="func_signature">
87+
<function>pg_catalog.pg_logdir_ls</function> ()
88+
<returnvalue>setof record</returnvalue>
89+
</para>
90+
<para>
91+
Lists the log files in the <varname>log_directory</varname> directory.
92+
</para></entry>
93+
</row>
94+
</tbody>
7595
</tgroup>
7696
</table>
7797

0 commit comments

Comments
 (0)