|
| 1 | +PostgreSQL Administration Functions |
| 2 | +=================================== |
| 3 | + |
| 4 | +This directory is a PostgreSQL 'contrib' module which implements a number of |
| 5 | +support functions which pgAdmin and other administration and management tools |
| 6 | +can use to provide additional functionality if installed on a server. |
| 7 | + |
| 8 | +Installation |
| 9 | +============ |
| 10 | + |
| 11 | +This module is normally distributed as a PostgreSQL 'contrib' module. To |
| 12 | +install it from a pre-configured source tree run the following commands |
| 13 | +as a user with appropriate privileges from the adminpack source directory: |
| 14 | + |
| 15 | +make |
| 16 | +make install |
| 17 | + |
| 18 | +Alternatively, if you have a PostgreSQL 8.2 or higher installation but no |
| 19 | +source tree you can install using PGXS. Simply run the following commands the |
| 20 | +adminpack source directory: |
| 21 | + |
| 22 | +make USE_PGXS=1 |
| 23 | +make USE_PGXS=1 install |
| 24 | + |
| 25 | +pgAdmin will look for the functions in the Maintenance Database (usually |
| 26 | +"postgres" for 8.2 servers) specified in the connection dialogue for the server. |
| 27 | +To install the functions in the database, either run the adminpack.sql script |
| 28 | +using the pgAdmin SQL tool (and then close and reopen the connection to the |
| 29 | +freshly instrumented server), or run the script using psql, eg: |
| 30 | + |
| 31 | +psql -U postgres postgres < adminpack.sql |
| 32 | + |
| 33 | +Other administration tools that use this module may have different requirements, |
| 34 | +please consult the tool's documentation for further details. |
| 35 | + |
| 36 | +Objects implemented (superuser only) |
| 37 | +==================================== |
| 38 | + |
| 39 | +int8 pg_catalog.pg_file_write(fname text, data text, append bool) |
| 40 | +int8 pg_catalog.pg_file_read(fname text, data text, append bool) |
| 41 | +bool pg_catalog.pg_file_rename(oldname text, newname text) |
| 42 | +bool pg_catalog.pg_file_rename(oldname text, newname text, archivname text) |
| 43 | +bool pg_catalog.pg_file_unlink(fname text) |
| 44 | +bigint pg_catalog.pg_file_size(text) |
| 45 | +int4 pg_catalog.pg_logfile_rotate() |
| 46 | +setof record pg_catalog.pg_logdir_ls() |
| 47 | + |