public inbox for [email protected]  
help / color / mirror / Atom feed
"System roles" mentioned in psql documentation
5+ messages / 3 participants
[nested] [flat]

* "System roles" mentioned in psql documentation
@ 2018-08-23 07:58  Michael Paquier <[email protected]>
  0 siblings, 2 replies; 5+ messages in thread

From: Michael Paquier @ 2018-08-23 07:58 UTC (permalink / raw)
  To: pgsql-docs

Hi all,

I have noticed that psql documentation mentions "system roles", however
in all other parts of the docs, we use the term "default roles".
Shouldn't we make this term more consistent and also add a link to the
table describing those roles?  Please see the attached.

Thanks,
--
Michael


Attachments:

  [text/x-diff] psql-system-roles.patch (1.4K, 2-psql-system-roles.patch)
  download | inline diff:
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index eb9d93a168..df762b811c 100644
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -1521,7 +1521,8 @@ testdb=&gt;
         unified into <quote>roles</quote>, this command is now equivalent to
         <literal>\du</literal>.)
         By default, only user-created roles are shown; supply the
-        <literal>S</literal> modifier to include system roles.
+        <literal>S</literal> modifier to include default roles described in
+        <xref linkend="default-roles-table"/>.
         If <replaceable class="parameter">pattern</replaceable> is specified,
         only those roles whose names match the pattern are listed.
         If the form <literal>\dg+</literal> is used, additional information
@@ -1711,7 +1712,8 @@ testdb=&gt;
         unified into <quote>roles</quote>, this command is now equivalent to
         <literal>\dg</literal>.)
         By default, only user-created roles are shown; supply the
-        <literal>S</literal> modifier to include system roles.
+        <literal>S</literal> modifier to include default roles described
+        in <xref linkend="default-roles-table"/>.
         If <replaceable class="parameter">pattern</replaceable> is specified,
         only those roles whose names match the pattern are listed.
         If the form <literal>\du+</literal> is used, additional information


  [application/pgp-signature] signature.asc (833B, 3-signature.asc)
  download

^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* Re: "System roles" mentioned in psql documentation
@ 2018-08-23 08:53  Jürgen Purtz <[email protected]>
  parent: Michael Paquier <[email protected]>
  1 sibling, 1 reply; 5+ messages in thread

From: Jürgen Purtz @ 2018-08-23 08:53 UTC (permalink / raw)
  To: [email protected]

This inconsistency is part of the more general problem that we miss a 
chapter, where our basic terms like 'database', 'cluster', 'segment', 
'catalog', 'schema', ... are explicitly defined.

Kind regards

Jürgen Purtz






^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* Re: "System roles" mentioned in psql documentation
@ 2018-08-23 15:28  Jonathan S. Katz <[email protected]>
  parent: Michael Paquier <[email protected]>
  1 sibling, 0 replies; 5+ messages in thread

From: Jonathan S. Katz @ 2018-08-23 15:28 UTC (permalink / raw)
  To: Michael Paquier <[email protected]>; +Cc: pgsql-docs


> On Aug 23, 2018, at 3:58 AM, Michael Paquier <[email protected]> wrote:
> 
> Hi all,
> 
> I have noticed that psql documentation mentions "system roles", however
> in all other parts of the docs, we use the term "default roles".
> Shouldn't we make this term more consistent and also add a link to the
> table describing those roles?  Please see the attached.

I did a quick search for other cases of “system roles” with nothing coming
up, so it looks like you caught the only reference. LGTM.

Thanks!

Jonathan



Attachments:

  [application/pgp-signature] signature.asc (833B, 2-signature.asc)
  download

^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* Re: "System roles" mentioned in psql documentation
@ 2018-08-24 00:21  Michael Paquier <[email protected]>
  parent: Jürgen Purtz <[email protected]>
  0 siblings, 1 reply; 5+ messages in thread

From: Michael Paquier @ 2018-08-24 00:21 UTC (permalink / raw)
  To: Jürgen Purtz <[email protected]>; +Cc: [email protected]

On Thu, Aug 23, 2018 at 10:53:35AM +0200, Jürgen Purtz wrote:
> This inconsistency is part of the more general problem that we miss a
> chapter, where our basic terms like 'database', 'cluster', 'segment',
> 'catalog', 'schema', ... are explicitly defined.

You may have a point here, not in the way of reworking entirely the
documentation, but in the fact that we may want to use "system objects"
instead of "system roles".  I am not personally sure that it is a better
improvement than using "default roles", but that's a point to raise.
--
Michael


Attachments:

  [application/pgp-signature] signature.asc (833B, 2-signature.asc)
  download

^ permalink  raw  reply  [nested|flat] 5+ messages in thread

* Re: "System roles" mentioned in psql documentation
@ 2018-08-24 09:40  Jürgen Purtz <[email protected]>
  parent: Michael Paquier <[email protected]>
  0 siblings, 0 replies; 5+ messages in thread

From: Jürgen Purtz @ 2018-08-24 09:40 UTC (permalink / raw)
  To: [email protected]

On 24.08.2018 02:21, Michael Paquier wrote:

> On Thu, Aug 23, 2018 at 10:53:35AM +0200, Jürgen Purtz wrote:
>> This inconsistency is part of the more general problem that we miss a
>> chapter, where our basic terms like 'database', 'cluster', 'segment',
>> 'catalog', 'schema', ... are explicitly defined.
> You may have a point here, not in the way of reworking entirely the
> documentation, but in the fact that we may want to use "system objects"
> instead of "system roles".  I am not personally sure that it is a better
> improvement than using "default roles", but that's a point to raise.
> --
> Michael

First, the intention of my note was to improve the complete 
documentation by defining the meaning of important terms in a separate 
chapter. The discussion about "system roles" and "default roles" is only 
one of many points where we use terms in a fuzzy way.

Second (and this seems to be the point of your mail), the term "role" is 
loosely described at the beginning of chapter 21 "A role can be thought 
of as either a database user, or ... ". In contrast to this description 
chapter 21.5 and table 21.1. use the term "role" very differently. Here 
it is used in the sense of a "capability", a "right", a "permission", an 
"allowed access" ... . This cumulates in the example at the bottom: 
"GRANT pg_signal_backend TO admin_user;"  What is the "role", the 
"pg_signal_backend" or the "admin_user"?

Kind regards
Jürgen Purtz






^ permalink  raw  reply  [nested|flat] 5+ messages in thread


end of thread, other threads:[~2018-08-24 09:40 UTC | newest]

Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2018-08-23 07:58 "System roles" mentioned in psql documentation Michael Paquier <[email protected]>
2018-08-23 08:53 ` Jürgen Purtz <[email protected]>
2018-08-24 00:21   ` Michael Paquier <[email protected]>
2018-08-24 09:40     ` Jürgen Purtz <[email protected]>
2018-08-23 15:28 ` Jonathan S. Katz <[email protected]>

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox