8000 Doc: add a summary table to the CREATE POLICY docs. · bytian/postgres@87c2a17 · GitHub
[go: up one dir, main page]
Skip to content

Commit 87c2a17

Browse files
deanrasheeddeanrasheed
committed
Doc: add a summary table to the CREATE POLICY docs.
This table summarizes which RLS policy expressions apply to each command type, and whether they apply to the old or new tuples (or both), which saves reading through a lot of text. Rod Taylor, hacked on by me. Reviewed by Fabien Coelho. Discussion: https://postgr.es/m/CAHz80e4HxJShm6m9ZWFrHW=pgd2KP=RZmfFnEccujtPMiAOW5Q@mail.gmail.com
1 parent e842791 commit 87c2a17

File tree

1 file changed

+103
-1
lines changed

1 file changed

+103
-1
lines changed

‎doc/src/sgml/ref/create_policy.sgml

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,10 @@ CREATE POLICY <replaceable class="parameter">name</replaceable> ON <replaceable
7373
<para>
7474
Policies can be applied for specific commands or for specific roles. The
7575
default for newly created policies is that they apply for all commands and
76-
roles, unless otherwise specified.
76+
roles, unless otherwise specified. Multiple policies may apply to a single
77+
command; see below for more details.
78+
<xref linkend="sql-createpolicy-summary"> summarizes how the different types
79+
of policy apply to specific commands.
7780
</para>
7881

7982
<para>
@@ -391,6 +394,105 @@ CREATE POLICY <replaceable class="parameter">name</replaceable> ON <replaceable
391394
</varlistentry>
392395

393396
</variablelist>
397+
398+
<table id="sql-createpolicy-summary">
399+
<title>Policies Applied by Command Type</title>
400+
<tgroup cols="6">
401+
<colspec colnum="4" colname="update-using">
402+
<colspec colnum="5" colname="update-check">
403+
<spanspec namest="update-using" nameend="update-check" spanname="update">
404+
<thead>
405+
<row>
406+
<entry morerows="1">Command</entry>
407+
<entry><literal>SELECT/ALL policy</literal></entry>
408+
<entry><literal>INSERT/ALL policy</literal></entry>
409+
<entry spanname="update"><literal>UPDATE/ALL policy</literal></entry>
410+
<entry><literal>DELETE/ALL policy</literal></entry>
411+
</row>
412+
<row>
413+
<entry><literal>USING expression</literal></entry>
414+
<entry><literal>WITH CHECK expression</literal></entry>
415+
<entry><literal>USING expression</literal></entry>
416+
<entry><literal>WITH CHECK expression</literal></entry>
417+
<entry><literal>USING expression</literal></entry>
418+
</row>
419+
</thead>
420+
<tbody>
421+
<row>
422+
<entry><command>SELECT</command></entry>
423+
<entry>Existing row</entry>
424+
<entry>&mdash;</entry>
425+
<entry>&mdash;</entry>
426+
<entry>&mdash;</entry>
427+
<entry>&mdash;</entry>
428+
</row>
429+
<row>
430+
<entry><command>SELECT FOR UPDATE/SHARE</command></entry>
431+
<entry>Existing row</entry>
432+
<entry>&mdash;</entry>
433+
<entry>Existing row</entry>
434+
<entry>&mdash;</entry>
435+
<entry>&mdash;</entry>
436+
</row>
437+
<row>
438+
<entry><command>INSERT</command></entry>
439+
<entry>&mdash;</entry>
440+
<entry>New row</entry>
441+
<entry>&mdash;</entry>
442+
<entry>&mdash;</entry>
443+
<entry>&mdash;</entry>
444+
</row>
445+
<row>
446+
<entry><command>INSERT ... RETURNING</command></entry>
447+
<entry>
448+
New row
449+
<footnote id="rls-select-priv">
450+
<para>
451+
If read access is required to the existing or new row (for example,
452+
a <literal>WHERE</literal> or <literal>RETURNING</literal> clause
453+
that refers to columns from the relation).
454+
</para>
455+
</footnote>
456+
</entry>
457+
<entry>New row</entry>
458+
<entry>&mdash;</entry>
459+
<entry>&mdash;</entry>
460+
<entry>&mdash;</entry>
461+
</row>
462+
<row>
463+
<entry><command>UPDATE</command></entry>
464+
<entry>
465+
Existing &amp; new rows
466+
<footnoteref linkend="rls-select-priv">
467+
</entry>
468+
<entry>&mdash;</entry>
469+
<entry>Existing row</entry>
470+
<entry>New row</entry>
471+
<entry>&mdash;</entry>
472+
</row>
473+
<row>
474+
<entry><command>DELETE</command></entry>
475+
<entry>
476+
Existing row
477+
<footnoteref linkend="rls-select-priv">
478+
</entry>
479+
<entry>&mdash;</entry>
480+
<entry>&mdash;</entry>
481+
<entry>&mdash;</entry>
482+
<entry>Existing row</entry>
483+
</row>
484+
<row>
485+
<entry><command>ON CONFLICT DO UPDATE</command></entry>
486+
<entry>Existing &amp; new rows</entry>
487+
<entry>&mdash;</entry>
488+
<entry>Existing row</entry>
489+
<entry>New row</entry>
490+
<entry>&mdash;</entry>
491+
</row>
492+
</tbody>
493+
</tgroup>
494+
</table>
495+
394496
</refsect2>
395497

396498
<refsect2>

0 commit comments

Comments
 (0)
0