summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2019-08-27 18:03:09 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2019-08-27 18:03:09 -0400
commite872432d629d9c4f0995a1e527dcddbcacbb7590 (patch)
treea2e310c3357cc780b3b3360f861e70ce7a817536 /doc/src
parentf2cf22a59a49ddbe93dd231992d537f822d1b3c1 (diff)
Doc: improve documentation of pg_signal_backend default role.
Give it an explanatory para like the other default roles have. Don't imply that it can send any signal whatever. In passing, reorder the table entries and explanatory paras for the default roles into some semblance of consistency. Ian Barwick, tweaked a bit by me. Discussion: https://postgr.es/m/89907e32-76f3-7282-a89c-ea19c722fe5d@2ndquadrant.com
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/user-manag.sgml21
1 files changed, 15 insertions, 6 deletions
diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml
index 357f25df0df..cf41baa2063 100644
--- a/doc/src/sgml/user-manag.sgml
+++ b/doc/src/sgml/user-manag.sgml
@@ -531,16 +531,16 @@ DROP ROLE doomed_role;
potentially for a long time.</entry>
</row>
<row>
- <entry>pg_signal_backend</entry>
- <entry>Send signals to other backends (eg: cancel query, terminate).</entry>
- </row>
- <row>
<entry>pg_monitor</entry>
<entry>Read/execute various monitoring views and functions.
This role is a member of <literal>pg_read_all_settings</literal>,
<literal>pg_read_all_stats</literal> and
<literal>pg_stat_scan_tables</literal>.</entry>
</row>
+ <row>
+ <entry>pg_signal_backend</entry>
+ <entry>Signal another backend to cancel a query or terminate its session.</entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -555,13 +555,22 @@ DROP ROLE doomed_role;
</para>
<para>
+ The <literal>pg_signal_backend</literal> role is intended to allow
+ administrators to enable trusted, but non-superuser, roles to send signals
+ to other backends. Currently this role enables sending of signals for
+ canceling a query on another backend or terminating its session. A user
+ granted this role cannot however send signals to a backend owned by a
+ superuser. See <xref linkend="functions-admin-signal">.
+ </para>
+
+ <para>
Care should be taken when granting these roles to ensure they are only used where
needed to perform the desired monitoring.
</para>
<para>
- Administrators can grant access to these roles to users using the GRANT
- command:
+ Administrators can grant access to these roles to users using the
+ <xref linkend="sql-grant"> command, for example:
<programlisting>
GRANT pg_signal_backend TO admin_user;