doc/src/sgml/adminpack.sgml

   1 <!-- $PostgreSQL$ -->
   2
   3 <sect1 id="adminpack">
   4  <title>adminpack</title>
   5
   6  <indexterm zone="adminpack">
   7   <primary>adminpack</primary>
   8  </indexterm>
   9
  10  <para>
  11   <filename>adminpack</> provides a number of support functions which
  12   <application>pgAdmin</> and other administration and management tools can
  13   use to provide additional functionality, such as remote management
  14   of server log files.
  15  </para>
  16
  17  <sect2>
  18   <title>Functions implemented</title>
  19
  20   <para>
  21    The functions implemented by <filename>adminpack</> can only be run by a
  22    superuser. Here's a list of these functions:
  23
  24 <programlisting>
  25 int8 pg_catalog.pg_file_write(fname text, data text, append bool)
  26 bool pg_catalog.pg_file_rename(oldname text, newname text, archivename text)
  27 bool pg_catalog.pg_file_rename(oldname text, newname text)
  28 bool pg_catalog.pg_file_unlink(fname text)
  29 setof record pg_catalog.pg_logdir_ls()
  30
  31 /* Renaming of existing backend functions for pgAdmin compatibility */
  32 int8 pg_catalog.pg_file_read(fname text, data text, append bool)
  33 bigint pg_catalog.pg_file_length(text)
  34 int4 pg_catalog.pg_logfile_rotate()
  35 </programlisting>
  36   </para>
  37
  38  </sect2>
  39
  40 </sect1>