pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feeddoc: clarify "pg_signal_backend" default role
4+ messages / 3 participants
[nested] [flat]
Commits from this thread:
2019-08-27 458f01e254 11f6271b87 8635d73e2f e872432d62 Doc: improve documentation of pg_signal_backend default role.
* doc: clarify "pg_signal_backend" default role
@ 2019-06-10 02:06 Ian Barwick <ian.barwick@2ndquadrant.com>
0 siblings, 2 replies; 4+ messages in thread
From: Ian Barwick @ 2019-06-10 02:06 UTC (permalink / raw)
To: pgsql-hackers@postgresql.org <pgsql-hackers@postgresql.org>; +Cc: pgsql-docs
Hi
Currently the documentation for the default role "pg_signal_backend" states,
somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
giving the impression other signals (e.g. SIGHUP) can be sent too, which is
currently not the case.
Attached patch clarifies this, adds a descriptive paragraph (similar to what
the other default roles have) and a link to the "Server Signaling Functions"
section.
Patch applies cleanly to HEAD and REL_11_STABLE.
Regards
Ian Barwick
--
Ian Barwick https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services
Attachments:
doc-pg_signal_backend.patch (text/x-patch, 1.5K) download
diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml
new file mode 100644
index 6106244..76b6ddb
*** a/doc/src/sgml/user-manag.sgml
--- b/doc/src/sgml/user-manag.sgml
*************** DROP ROLE doomed_role;
*** 532,538 ****
</row>
<row>
<entry>pg_signal_backend</entry>
! <entry>Send signals to other backends (eg: cancel query, terminate).</entry>
</row>
<row>
<entry>pg_read_server_files</entry>
--- 532,538 ----
</row>
<row>
<entry>pg_signal_backend</entry>
! <entry>Signal another backend to cancel a query or terminate the backend.</entry>
</row>
<row>
<entry>pg_read_server_files</entry>
*************** DROP ROLE doomed_role;
*** 561,566 ****
--- 561,573 ----
</table>
<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 the
+ backend. A user granted this role cannot however send signals to a backend owned by a superuser.
+ See also <xref linkend="functions-admin-signal"/>.
+ </para>
+ <para>
The <literal>pg_read_server_files</literal>, <literal>pg_write_server_files</literal> and
<literal>pg_execute_server_program</literal> roles are intended to allow administrators to have
trusted, but non-superuser, roles which are able to access files and run programs on the
* Re: doc: clarify "pg_signal_backend" default role
@ 2019-06-10 05:35 Michael Paquier <michael@paquier.xyz>
parent: Ian Barwick <ian.barwick@2ndquadrant.com>
1 sibling, 0 replies; 4+ messages in thread
From: Michael Paquier @ 2019-06-10 05:35 UTC (permalink / raw)
To: Ian Barwick <ian.barwick@2ndquadrant.com>; +Cc: pgsql-docs
On Mon, Jun 10, 2019 at 11:06:54AM +0900, Ian Barwick wrote:
> Currently the documentation for the default role "pg_signal_backend" states,
> somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
> giving the impression other signals (e.g. SIGHUP) can be sent too, which is
> currently not the case.
(Perhaps you should avoid cross-posting?)
OK, I can see your point.
> Attached patch clarifies this, adds a descriptive paragraph (similar to what
> the other default roles have) and a link to the "Server Signaling Functions"
> section.
+1 for being more descriptive here.
--
Michael
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: doc: clarify "pg_signal_backend" default role
@ 2019-08-27 22:04 Tom Lane <tgl@sss.pgh.pa.us>
parent: Ian Barwick <ian.barwick@2ndquadrant.com>
1 sibling, 1 reply; 4+ messages in thread
From: Tom Lane @ 2019-08-27 22:04 UTC (permalink / raw)
To: Ian Barwick <ian.barwick@2ndquadrant.com>; +Cc: pgsql-hackers@postgresql.org <pgsql-hackers@postgresql.org>; pgsql-docs
Ian Barwick <ian.barwick@2ndquadrant.com> writes:
> Currently the documentation for the default role "pg_signal_backend" states,
> somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
> giving the impression other signals (e.g. SIGHUP) can be sent too, which is
> currently not the case.
> Attached patch clarifies this, adds a descriptive paragraph (similar to what
> the other default roles have) and a link to the "Server Signaling Functions"
> section.
Pushed with minor tweaking.
(Note: patches are less likely to fall through the cracks if you
add them to the commitfest page.)
regards, tom lane
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: doc: clarify "pg_signal_backend" default role
@ 2019-08-28 01:13 Ian Barwick <ian.barwick@2ndquadrant.com>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 0 replies; 4+ messages in thread
From: Ian Barwick @ 2019-08-28 01:13 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: pgsql-hackers@postgresql.org <pgsql-hackers@postgresql.org>; pgsql-docs
On 8/28/19 7:04 AM, Tom Lane wrote:
> Ian Barwick <ian.barwick@2ndquadrant.com> writes:
>> Currently the documentation for the default role "pg_signal_backend" states,
>> somewhat ambiguously, "Send signals to other backends (eg: cancel query, terminate)",
>> giving the impression other signals (e.g. SIGHUP) can be sent too, which is
>> currently not the case.
>> Attached patch clarifies this, adds a descriptive paragraph (similar to what
>> the other default roles have) and a link to the "Server Signaling Functions"
>> section.
>
> Pushed with minor tweaking.
Thanks!
> (Note: patches are less likely to fall through the cracks if you
> add them to the commitfest page.)
Yup, though I was intending to add that one together with a couple of
related minor doc patches to the next CF.
Regards
Ian Barwick
--
Ian Barwick https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2019-08-28 01:13 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2019-06-10 02:06 doc: clarify "pg_signal_backend" default role Ian Barwick <ian.barwick@2ndquadrant.com>
2019-06-10 05:35 ` Michael Paquier <michael@paquier.xyz>
2019-08-27 22:04 ` Tom Lane <tgl@sss.pgh.pa.us>
2019-08-28 01:13 ` Ian Barwick <ian.barwick@2ndquadrant.com>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox