summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane2021-06-23 18:27:13 +0000
committerTom Lane2021-06-23 18:27:13 +0000
commit2031e1668e5577e64cfed29da69a34903d5a5227 (patch)
treeac0f137ee5f943889ee12f9c6489019676c6a295
parent126cdaf47af275f76b2f2ddb023bfdc6f018ae30 (diff)
Doc: fix confusion about LEAKPROOF in syntax summaries.
The syntax summaries for CREATE FUNCTION and allied commands made it look like LEAKPROOF is an alternative to IMMUTABLE/STABLE/VOLATILE, when of course it is an orthogonal option. Improve that. Per gripe from aazamrafeeque0. Thanks to David Johnston for suggestions. Discussion: https://postgr.es/m/[email protected]
-rw-r--r--doc/src/sgml/ref/alter_function.sgml3
-rw-r--r--doc/src/sgml/ref/alter_routine.sgml3
-rw-r--r--doc/src/sgml/ref/create_function.sgml7
3 files changed, 8 insertions, 5 deletions
diff --git a/doc/src/sgml/ref/alter_function.sgml b/doc/src/sgml/ref/alter_function.sgml
index 54e61e7d78..0ee756a94d 100644
--- a/doc/src/sgml/ref/alter_function.sgml
+++ b/doc/src/sgml/ref/alter_function.sgml
@@ -35,7 +35,8 @@ ALTER FUNCTION <replaceable>name</replaceable> [ ( [ [ <replaceable class="param
<phrase>where <replaceable class="parameter">action</replaceable> is one of:</phrase>
CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT
- IMMUTABLE | STABLE | VOLATILE | [ NOT ] LEAKPROOF
+ IMMUTABLE | STABLE | VOLATILE
+ [ NOT ] LEAKPROOF
[ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER
PARALLEL { UNSAFE | RESTRICTED | SAFE }
COST <replaceable class="parameter">execution_cost</replaceable>
diff --git a/doc/src/sgml/ref/alter_routine.sgml b/doc/src/sgml/ref/alter_routine.sgml
index aab4a49793..d6c9dea2eb 100644
--- a/doc/src/sgml/ref/alter_routine.sgml
+++ b/doc/src/sgml/ref/alter_routine.sgml
@@ -34,7 +34,8 @@ ALTER ROUTINE <replaceable>name</replaceable> [ ( [ [ <replaceable class="parame
<phrase>where <replaceable class="parameter">action</replaceable> is one of:</phrase>
- IMMUTABLE | STABLE | VOLATILE | [ NOT ] LEAKPROOF
+ IMMUTABLE | STABLE | VOLATILE
+ [ NOT ] LEAKPROOF
[ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER
PARALLEL { UNSAFE | RESTRICTED | SAFE }
COST <replaceable class="parameter">execution_cost</replaceable>
diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml
index 180e5f5c1f..7e6d52c7dc 100644
--- a/doc/src/sgml/ref/create_function.sgml
+++ b/doc/src/sgml/ref/create_function.sgml
@@ -28,9 +28,10 @@ CREATE [ OR REPLACE ] FUNCTION
{ LANGUAGE <replaceable class="parameter">lang_name</replaceable>
| TRANSFORM { FOR TYPE <replaceable class="parameter">type_name</replaceable> } [, ... ]
| WINDOW
- | IMMUTABLE | STABLE | VOLATILE | [ NOT ] LEAKPROOF
- | CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT
- | [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER
+ | { IMMUTABLE | STABLE | VOLATILE }
+ | [ NOT ] LEAKPROOF
+ | { CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT }
+ | { [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER }
| PARALLEL { UNSAFE | RESTRICTED | SAFE }
| COST <replaceable class="parameter">execution_cost</replaceable>
| ROWS <replaceable class="parameter">result_rows</replaceable>