summaryrefslogtreecommitdiff
path: root/doc/src/sgml/adminpack.sgml
diff options
context:
space:
mode:
authorBruce Momjian2007-11-10 23:30:46 +0000
committerBruce Momjian2007-11-10 23:30:46 +0000
commitc3c69ab4fd25a20749b850d34cbc8ce3f1812e3b (patch)
treea7d9b4501297216ac71f597dca3840090ae791d5 /doc/src/sgml/adminpack.sgml
parent6e414a171e8a91966b10ecd14aa367422870bdd2 (diff)
Move most /contrib README files into SGML. Some still need conversion
or will never be converted.
Diffstat (limited to 'doc/src/sgml/adminpack.sgml')
-rw-r--r--doc/src/sgml/adminpack.sgml32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml
new file mode 100644
index 00000000000..10816f5c24d
--- /dev/null
+++ b/doc/src/sgml/adminpack.sgml
@@ -0,0 +1,32 @@
+<sect1>
+ <title>adminpack</title>
+ <para>
+ adminpack is a PostgreSQL standard module that implements a number of
+ support functions which pgAdmin and other administration and management tools
+ can use to provide additional functionality if installed on a server.
+ </para>
+
+ <sect2>
+ <title>Functions implemented</title>
+ <para>
+ Functions implemented by adminpack can only be run by a superuser. Here's a
+ list of these functions:
+ </para>
+ <para>
+ <programlisting>
+ int8 pg_catalog.pg_file_write(fname text, data text, append bool)
+ bool pg_catalog.pg_file_rename(oldname text, newname text, archivname text)
+ bool pg_catalog.pg_file_rename(oldname text, newname text)
+ bool pg_catalog.pg_file_unlink(fname text)
+ setof record pg_catalog.pg_logdir_ls()
+
+ /* Renaming of existing backend functions for pgAdmin compatibility */
+ int8 pg_catalog.pg_file_read(fname text, data text, append bool)
+ bigint pg_catalog.pg_file_length(text)
+ int4 pg_catalog.pg_logfile_rotate()
+ </programlisting>
+ </para>
+ </sect2>
+
+</sect1>
+