diff options
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/catalogs.sgml | 12 | ||||
-rw-r--r-- | doc/src/sgml/ref/alter_function.sgml | 13 | ||||
-rw-r--r-- | doc/src/sgml/ref/create_function.sgml | 19 | ||||
-rw-r--r-- | doc/src/sgml/rules.sgml | 14 |
4 files changed, 56 insertions, 2 deletions
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index ea98cb72aa1..180554b8e39 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -4424,6 +4424,18 @@ </row> <row> + <entry><structfield>proleakproof</structfield></entry> + <entry><type>bool</type></entry> + <entry></entry> + <entry> + The function has no side effects. No information about the + arguments is conveyed except via the return value. Any function + that might throw an error depending on the values of its arguments + is not leakproof. + </entry> + </row> + + <row> <entry><structfield>proisstrict</structfield></entry> <entry><type>bool</type></entry> <entry></entry> diff --git a/doc/src/sgml/ref/alter_function.sgml b/doc/src/sgml/ref/alter_function.sgml index acb3e4fb93f..3ceb6123f4f 100644 --- a/doc/src/sgml/ref/alter_function.sgml +++ b/doc/src/sgml/ref/alter_function.sgml @@ -33,7 +33,7 @@ ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="paramet <phrase>where <replaceable class="PARAMETER">action</replaceable> is one of:</phrase> CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT - IMMUTABLE | STABLE | VOLATILE + IMMUTABLE | STABLE | VOLATILE | LEAKPROOF [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER COST <replaceable class="parameter">execution_cost</replaceable> ROWS <replaceable class="parameter">result_rows</replaceable> @@ -191,6 +191,17 @@ ALTER FUNCTION <replaceable>name</replaceable> ( [ [ <replaceable class="paramet </listitem> </varlistentry> + <varlistentry> + <term><literal>LEAKPROOF</literal></term> + <listitem> + <para> + Change whether the function is considered leakproof or not. + See <xref linkend="sql-createfunction"> for more information about + this capability. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><literal>COST</literal> <replaceable class="parameter">execution_cost</replaceable></term> diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 2a87130356e..7df66ab0e08 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -26,7 +26,7 @@ CREATE [ OR REPLACE ] FUNCTION | RETURNS TABLE ( <replaceable class="parameter">column_name</replaceable> <replaceable class="parameter">column_type</replaceable> [, ...] ) ] { LANGUAGE <replaceable class="parameter">lang_name</replaceable> | WINDOW - | IMMUTABLE | STABLE | VOLATILE + | IMMUTABLE | STABLE | VOLATILE | LEAKPROOF | CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT | [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER | COST <replaceable class="parameter">execution_cost</replaceable> @@ -325,6 +325,23 @@ CREATE [ OR REPLACE ] FUNCTION </varlistentry> <varlistentry> + <term><literal>LEAKPROOF</literal></term> + <listitem> + <para> + <literal>LEAKPROOF</literal> indicates that the function has no side + effects. It reveals no information about its arguments other than by + its return value. For example, a function which throws an error message + for some argument values but not others, or which includes the argument + values in any error message, is not leakproof. The query planner may + push leakproof functions (but not others) into views created with the + <literal>security_barrier</literal> option. See + <xref linkend="sql-createview"> and <xref linkend="rules-privileges">. + This option can only be set by the superuser. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><literal>CALLED ON NULL INPUT</literal></term> <term><literal>RETURNS NULL ON NULL INPUT</literal></term> <term><literal>STRICT</literal></term> diff --git a/doc/src/sgml/rules.sgml b/doc/src/sgml/rules.sgml index 3038fe9adc0..59a32a8e18b 100644 --- a/doc/src/sgml/rules.sgml +++ b/doc/src/sgml/rules.sgml @@ -1891,6 +1891,20 @@ CREATE VIEW phone_number WITH (security_barrier) AS </para> <para> + The query planner has more flexibility when dealing with functions that + have no side effects. Such functions are referred to as LEAKPROOF, and + include many simple, commonly used operators, such as many equality + operators. The query planner can safely allow such functions to be evaluated + at any point in the query execution process, since invoking them on rows + invisible to the user will not leak any information about the unseen rows. + In contrast, a function that might throw an error depending on the values + received as arguments (such as one that throws an error in the event of + overflow or division by zero) are not leak-proof, and could provide + significant information about the unseen rows if applied before the security + view's row filters. +</para> + +<para> It is important to understand that even a view created with the <literal>security_barrier</literal> option is intended to be secure only in the limited sense that the contents of the invisible tuples will not be |