"GRANT on Roles" supports multiple options

From: Andrei Polushin <polushin(at)gmail(dot)com>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: "GRANT on Roles" supports multiple options
Date: 2025-05-08 14:58:11
Message-ID: ECA41A7A-3F47-4AC8-80AC-2F3C8E2149A1@gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

(resending with correct formatting)

Hi!

In the documentation of the GRANT[1] command, the Synopsis for "GRANT on Roles" command is incomplete. Quoting from the current docs:

GRANT role_name [, ...] TO role_specification [, ...]
[ WITH { ADMIN | INHERIT | SET } { OPTION | TRUE | FALSE } ]
[ GRANTED BY role_specification ]

The "GRANT on Roles" command is documented as if it expects a single option after "WITH", but it actually supports multiple options, separated by comma, e.g.

GRANT created_user TO creating_user WITH ADMIN TRUE, SET FALSE, INHERIT FALSE

The example is taken from section "21.2. Role Attributes"[2] of the documentation.

More examples can be found by searching the codebase:

git grep -Pi '\bGRANT\b.+\bTO\b.+,\s*(ADMIN|INHERIT|SET)\s+\w+'

The parser is implemented here:

src/backend/commands/user.c:1480:GrantRole(ParseState *pstate, GrantRoleStmt *stmt)

The documentation is to be corrected for v16, v17, and later versions.

[1]: https://www.postgresql.org/docs/17/sql-grant.html
[2]: https://www.postgresql.org/docs/17/role-attributes.html

diff --git a/doc/src/sgml/ref/grant.sgml b/doc/src/sgml/ref/grant.sgml
index 999f657d5c0..9796e9a49d7 100644
--- a/doc/src/sgml/ref/grant.sgml
+++ b/doc/src/sgml/ref/grant.sgml
@@ -100,3 +100,3 @@ GRANT { USAGE | ALL [ PRIVILEGES ] }
GRANT <replaceable class="parameter">role_name</replaceable> [, ...] TO <replaceable class="parameter">role_specification</replaceable> [, ...]
- [ WITH { ADMIN | INHERIT | SET } { OPTION | TRUE | FALSE } ]
+ [ WITH [ { ADMIN | INHERIT | SET } { OPTION | TRUE | FALSE } ] [, ...] ]
[ GRANTED BY <replaceable class="parameter">role_specification</replaceable> ]

--
Andrei Polushin

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2025-05-09 15:15:49 Wrong documentation link for a newcomer
Previous Message PG Doc comments form 2025-05-08 14:53:15 "GRANT on Roles" supports multiple options