F.1. adminpack
adminpack provides a number of support functions whichpgAdmin and other administration and management tools can use to provide additional functionality, such as remote management of server log files. Use of all these functions is restricted to superusers.
The functions shown inTable F.1 provide write access to files on the machine hosting the server. (See also the functions inTable 9.88, which provide read-only access.) Only files within the database cluster directory can be accessed, but either a relative or absolute path is allowable.
Table F.1. adminpack Functions
| Name | Return Type | Description |
|---|---|---|
pg_catalog.pg_file_write(filename text, data text, append boolean) | bigint | Write, or append to, a text file |
pg_catalog.pg_file_rename(oldname text, newname text [, archivename text]) | boolean | Rename a file |
pg_catalog.pg_file_unlink(filename text) | boolean | Remove a file |
pg_catalog.pg_logdir_ls() | setof record | List the log files in thelog_directory directory |
pg_file_write writes the specifieddata into the file named byfilename. Ifappend is false, the file must not already exist. Ifappend is true, the file can already exist, and will be appended to if so. Returns the number of bytes written.
pg_file_rename renames a file. Ifarchivename is omitted or NULL, it simply renamesoldname tonewname (which must not already exist). Ifarchivename is provided, it first renamesnewname toarchivename (which must not already exist), and then renamesoldname tonewname. In event of failure of the second rename step, it will try to renamearchivename back tonewname before reporting the error. Returns true on success, false if the source file(s) are not present or not writable; other cases throw errors.
pg_file_unlink removes the specified file. Returns true on success, false if the specified file is not present or theunlink() call fails; other cases throw errors.
pg_logdir_ls returns the start timestamps and path names of all the log files in thelog_directory directory. Thelog_filename parameter must have its default setting (postgresql-%Y-%m-%d_%H%M%S.log) to use this function.
The functions shown inTable F.2 are deprecated and should not be used in new applications; instead use those shown inTable 9.78 andTable 9.88. These functions are provided inadminpack only for compatibility with old versions ofpgAdmin.
Table F.2. Deprecatedadminpack Functions
| Name | Return Type | Description |
|---|---|---|
pg_catalog.pg_file_read(filename text, offset bigint, nbytes bigint) | text | Alternate name forpg_read_file() |
pg_catalog.pg_file_length(filename text) | bigint | Same assize column returned bypg_stat_file() |
pg_catalog.pg_logfile_rotate() | integer | Alternate name forpg_rotate_logfile(), but note that it returns integer 0 or 1 rather thanboolean |