diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2015-07-02 16:40:55 -0400 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2015-07-02 16:41:07 -0400 |
| commit | 10fb48d66de76e7dc1e36ef18af502ed9600352f (patch) | |
| tree | dbe8d354065a8342d8e4f34aa976a62ef785d815 /doc | |
| parent | 726117243022178e72966cbffdfb9147ec6dbbcc (diff) | |
| download | postgresql-10fb48d66de76e7dc1e36ef18af502ed9600352f.tar.gz postgresql-10fb48d66de76e7dc1e36ef18af502ed9600352f.zip | |
Add an optional missing_ok argument to SQL function current_setting().
This allows convenient checking for existence of a GUC from SQL, which is
particularly useful when dealing with custom variables.
David Christensen, reviewed by Jeevan Chalke
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/sgml/func.sgml | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 99923f46bca..76f77cb0fcf 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -16444,7 +16444,7 @@ SELECT collation for ('foo' COLLATE "de_DE"); <indexterm> <primary>current_setting</primary> </indexterm> - <literal><function>current_setting(<parameter>setting_name</parameter>)</function></literal> + <literal><function>current_setting(<parameter>setting_name</parameter> [, <parameter>missing_ok</parameter> ])</function></literal> </entry> <entry><type>text</type></entry> <entry>get current value of setting</entry> @@ -16492,6 +16492,11 @@ SELECT current_setting('datestyle'); ISO, MDY (1 row) </programlisting> + + If there is no setting named <parameter>setting_name</parameter>, + <function>current_setting</function> throws an error + unless <parameter>missing_ok</parameter> is supplied and is + <literal>true</literal>. </para> <para> |