Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit cc22368

Browse files
Revamp documentation for predefined roles.
Presently, the page for predefined roles contains a table with brief descriptions of what each role allows. Below the table, there is a separate section with more detailed information about some of the roles. As the set of predefined roles has grown over the years, this page has (IMHO) become less readable. This commit attempts to improve the predefined roles documentation by abandoning the table in favor of listing each role with its own complete description, similar to how we document GUCs. Besides merging the information that was split between the table and the section below it, this commit also alphabetizes the roles. The alphabetization is imperfect because some of the roles are grouped (e.g., pg_read_all_data and pg_write_all_data), and we order such groups by the first role mentioned, but that seemed like a better choice than breaking the groups apart. Finally, this commit makes some stylistic adjustments to the text. Reviewed-by: David G. Johnston, Robert Haas Discussion: https://postgr.es/m/ZmtM-4-eRtq8DRf6%40nathan
1 parent 0dcf753 commit cc22368

File tree

5 files changed

+197
-168
lines changed

5 files changed

+197
-168
lines changed

doc/src/sgml/config.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@ include_dir 'conf.d'
731731
<para>
732732
Determines the number of connection <quote>slots</quote> that are
733733
reserved for connections by roles with privileges of the
734-
<link linkend="predefined-roles-table"><literal>pg_use_reserved_connections</literal></link>
734+
<xref linkend="predefined-role-pg-use-reserved-connections"/>
735735
role. Whenever the number of free connection slots is greater than
736736
<xref linkend="guc-superuser-reserved-connections"/> but less than or
737737
equal to the sum of <varname>superuser_reserved_connections</varname>

doc/src/sgml/monitoring.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,8 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
286286
other sessions, many columns will be null. Note, however, that the
287287
existence of a session and its general properties such as its sessions user
288288
and database are visible to all users. Superusers and roles with privileges of
289-
built-in role <literal>pg_read_all_stats</literal> (see also <xref
290-
linkend="predefined-roles"/>) can see all the information about all sessions.
289+
built-in role <link linkend="predefined-role-pg-monitor"><literal>pg_read_all_stats</literal></link>
290+
can see all the information about all sessions.
291291
</para>
292292

293293
<table id="monitoring-stats-dynamic-views-table">

doc/src/sgml/ref/checkpoint.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ CHECKPOINT
5353

5454
<para>
5555
Only superusers or users with the privileges of
56-
the <link linkend="predefined-roles-table"><literal>pg_checkpoint</literal></link>
56+
the <xref linkend="predefined-role-pg-checkpoint"/>
5757
role can call <command>CHECKPOINT</command>.
5858
</para>
5959
</refsect1>

doc/src/sgml/ref/reindex.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ REINDEX [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] { DA
305305
partitioned table, such commands skip the privilege checks when processing
306306
the individual partitions. Reindexing a schema or database requires being the
307307
owner of that schema or database or having privileges of the
308-
<link linkend="predefined-roles-table"><literal>pg_maintain</literal></link>
308+
<xref linkend="predefined-role-pg-maintain"/>
309309
role. Note specifically that it's thus
310310
possible for non-superusers to rebuild indexes of tables owned by
311311
other users. However, as a special exception,

0 commit comments

Comments
 (0)