postgresql/doc/src/sgml/adminpack.sgml

<!-- doc/src/sgml/adminpack.sgml -->

<sect1 id="adminpack">
 <title>adminpack</title>

 <indexterm zone="adminpack">
  <primary>adminpack</primary>
 </indexterm>

 <para>
  <filename>adminpack</> provides a number of support functions which
  <application>pgAdmin</> and other administration and management tools can
  use to provide additional functionality, such as remote management
  of server log files.
 </para>

 <sect2>
  <title>Functions Implemented</title>

  <para>
   The functions implemented by <filename>adminpack</> can only be run by a
   superuser. Here's a list of these functions:

<programlisting>
int8 pg_catalog.pg_file_write(fname text, data text, append bool)
bool pg_catalog.pg_file_rename(oldname text, newname text, archivename 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>