diff options
| author | Michael Paquier <michael@paquier.xyz> | 2018-10-09 22:29:09 +0900 |
|---|---|---|
| committer | Michael Paquier <michael@paquier.xyz> | 2018-10-09 22:29:09 +0900 |
| commit | c48101620151f78ee184e5f81766cbac347d9a11 (patch) | |
| tree | 86396a88627f0de5bcd0052dcde7dea3af5e748d /doc/src | |
| parent | bfa6c5a0c974b14601b689efa4e52f6a372aee0c (diff) | |
Add pg_ls_archive_statusdir function
This function lists the contents of the WAL archive status directory,
and is intended to be used by monitoring tools. Unlike pg_ls_dir(),
access to it can be granted to non-superusers so that those monitoring
tools can observe the principle of least privilege. Access is also
given by default to members of pg_monitor.
Author: Christoph Moench-Tegeder
Reviewed-by: Aya Iwata
Discussion: https://postgr.es/m/20180930205920.GA64534@elch.exwg.net
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/func.sgml | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index f984d069e1f..5193df33666 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -20357,6 +20357,18 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup()); </row> <row> <entry> + <literal><function>pg_ls_archive_statusdir()</function></literal> + </entry> + <entry><type>setof record</type></entry> + <entry> + List the name, size, and last modification time of files in the WAL + archive status directory. Access is granted to members of the + <literal>pg_monitor</literal> role and may be granted to other + non-superuser roles. + </entry> + </row> + <row> + <entry> <literal><function>pg_ls_tmpdir(<optional><parameter>tablespace</parameter> <type>oid</type></optional>)</function></literal> </entry> <entry><type>setof record</type></entry> @@ -20443,6 +20455,18 @@ postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup()); </para> <indexterm> + <primary>pg_ls_archive_statusdir</primary> + </indexterm> + <para> + <function>pg_ls_archive_statusdir</function> returns the name, size, and + last modified time (mtime) of each file in the WAL archive status + directory <literal>pg_wal/archive_status</literal>. By default only + superusers and members of the <literal>pg_monitor</literal> role can + use this function. Access may be granted to others using + <command>GRANT</command>. + </para> + + <indexterm> <primary>pg_ls_tmpdir</primary> </indexterm> <para> |