|
8 | 8 | </indexterm> |
9 | 9 |
|
10 | 10 | <para> |
11 | | - <filename>adminpack</> provides a number of support functions which |
12 | | - <application>pgAdmin</> and other administration and management tools can |
| 11 | + <filename>adminpack</filename> provides a number of support functions which |
| 12 | + <application>pgAdmin</application> and other administration and management tools can |
13 | 13 | use to provide additional functionality, such as remote management |
14 | 14 | of server log files. |
15 | 15 | Use of all these functions is restricted to superusers. |
|
25 | 25 | </para> |
26 | 26 |
|
27 | 27 | <table id="functions-adminpack-table"> |
28 | | - <title><filename>adminpack</> Functions</title> |
| 28 | + <title><filename>adminpack</filename> Functions</title> |
29 | 29 | <tgroup cols="3"> |
30 | 30 | <thead> |
31 | 31 | <row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry> |
|
58 | 58 | <entry><function>pg_catalog.pg_logdir_ls()</function></entry> |
59 | 59 | <entry><type>setof record</type></entry> |
60 | 60 | <entry> |
61 | | - List the log files in the <varname>log_directory</> directory |
| 61 | + List the log files in the <varname>log_directory</varname> directory |
62 | 62 | </entry> |
63 | 63 | </row> |
64 | 64 | </tbody> |
|
69 | 69 | <primary>pg_file_write</primary> |
70 | 70 | </indexterm> |
71 | 71 | <para> |
72 | | - <function>pg_file_write</> writes the specified <parameter>data</> into |
73 | | - the file named by <parameter>filename</>. If <parameter>append</> is |
74 | | - false, the file must not already exist. If <parameter>append</> is true, |
| 72 | + <function>pg_file_write</function> writes the specified <parameter>data</parameter> into |
| 73 | + the file named by <parameter>filename</parameter>. If <parameter>append</parameter> is |
| 74 | + false, the file must not already exist. If <parameter>append</parameter> is true, |
75 | 75 | the file can already exist, and will be appended to if so. |
76 | 76 | Returns the number of bytes written. |
77 | 77 | </para> |
|
80 | 80 | <primary>pg_file_rename</primary> |
81 | 81 | </indexterm> |
82 | 82 | <para> |
83 | | - <function>pg_file_rename</> renames a file. If <parameter>archivename</> |
84 | | - is omitted or NULL, it simply renames <parameter>oldname</> |
85 | | - to <parameter>newname</> (which must not already exist). |
86 | | - If <parameter>archivename</> is provided, it first |
87 | | - renames <parameter>newname</> to <parameter>archivename</> (which must |
88 | | - not already exist), and then renames <parameter>oldname</> |
89 | | - to <parameter>newname</>. In event of failure of the second rename step, |
90 | | - it will try to rename <parameter>archivename</> back |
91 | | - to <parameter>newname</> before reporting the error. |
| 83 | + <function>pg_file_rename</function> renames a file. If <parameter>archivename</parameter> |
| 84 | + is omitted or NULL, it simply renames <parameter>oldname</parameter> |
| 85 | + to <parameter>newname</parameter> (which must not already exist). |
| 86 | + If <parameter>archivename</parameter> is provided, it first |
| 87 | + renames <parameter>newname</parameter> to <parameter>archivename</parameter> (which must |
| 88 | + not already exist), and then renames <parameter>oldname</parameter> |
| 89 | + to <parameter>newname</parameter>. In event of failure of the second rename step, |
| 90 | + it will try to rename <parameter>archivename</parameter> back |
| 91 | + to <parameter>newname</parameter> before reporting the error. |
92 | 92 | Returns true on success, false if the source file(s) are not present or |
93 | 93 | not writable; other cases throw errors. |
94 | 94 | </para> |
|
97 | 97 | <primary>pg_file_unlink</primary> |
98 | 98 | </indexterm> |
99 | 99 | <para> |
100 | | - <function>pg_file_unlink</> removes the specified file. |
| 100 | + <function>pg_file_unlink</function> removes the specified file. |
101 | 101 | Returns true on success, false if the specified file is not present |
102 | | - or the <function>unlink()</> call fails; other cases throw errors. |
| 102 | + or the <function>unlink()</function> call fails; other cases throw errors. |
103 | 103 | </para> |
104 | 104 |
|
105 | 105 | <indexterm> |
106 | 106 | <primary>pg_logdir_ls</primary> |
107 | 107 | </indexterm> |
108 | 108 | <para> |
109 | | - <function>pg_logdir_ls</> returns the start timestamps and path |
| 109 | + <function>pg_logdir_ls</function> returns the start timestamps and path |
110 | 110 | names of all the log files in the <xref linkend="guc-log-directory"> |
111 | 111 | directory. The <xref linkend="guc-log-filename"> parameter must have its |
112 | | - default setting (<literal>postgresql-%Y-%m-%d_%H%M%S.log</>) to use this |
| 112 | + default setting (<literal>postgresql-%Y-%m-%d_%H%M%S.log</literal>) to use this |
113 | 113 | function. |
114 | 114 | </para> |
115 | 115 |
|
|
119 | 119 | and should not be used in new applications; instead use those shown |
120 | 120 | in <xref linkend="functions-admin-signal-table"> |
121 | 121 | and <xref linkend="functions-admin-genfile-table">. These functions are |
122 | | - provided in <filename>adminpack</> only for compatibility with old |
123 | | - versions of <application>pgAdmin</>. |
| 122 | + provided in <filename>adminpack</filename> only for compatibility with old |
| 123 | + versions of <application>pgAdmin</application>. |
124 | 124 | </para> |
125 | 125 |
|
126 | 126 | <table id="functions-adminpack-deprecated-table"> |
127 | | - <title>Deprecated <filename>adminpack</> Functions</title> |
| 127 | + <title>Deprecated <filename>adminpack</filename> Functions</title> |
128 | 128 | <tgroup cols="3"> |
129 | 129 | <thead> |
130 | 130 | <row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry> |
|
136 | 136 | <entry><function>pg_catalog.pg_file_read(filename text, offset bigint, nbytes bigint)</function></entry> |
137 | 137 | <entry><type>text</type></entry> |
138 | 138 | <entry> |
139 | | - Alternate name for <function>pg_read_file()</> |
| 139 | + Alternate name for <function>pg_read_file()</function> |
140 | 140 | </entry> |
141 | 141 | </row> |
142 | 142 | <row> |
143 | 143 | <entry><function>pg_catalog.pg_file_length(filename text)</function></entry> |
144 | 144 | <entry><type>bigint</type></entry> |
145 | 145 | <entry> |
146 | | - Same as <structfield>size</> column returned |
147 | | - by <function>pg_stat_file()</> |
| 146 | + Same as <structfield>size</structfield> column returned |
| 147 | + by <function>pg_stat_file()</function> |
148 | 148 | </entry> |
149 | 149 | </row> |
150 | 150 | <row> |
151 | 151 | <entry><function>pg_catalog.pg_logfile_rotate()</function></entry> |
152 | 152 | <entry><type>integer</type></entry> |
153 | 153 | <entry> |
154 | | - Alternate name for <function>pg_rotate_logfile()</>, but note that it |
| 154 | + Alternate name for <function>pg_rotate_logfile()</function>, but note that it |
155 | 155 | returns integer 0 or 1 rather than <type>boolean</type> |
156 | 156 | </entry> |
157 | 157 | </row> |
|
0 commit comments