diff options
author | Tom Lane <tgl@sss.pgh.pa.us> | 2019-09-27 11:01:36 -0400 |
---|---|---|
committer | Tom Lane <tgl@sss.pgh.pa.us> | 2019-09-27 11:01:47 -0400 |
commit | 4fa1d89cba0f1feb5120e99eb01c152ba276c4e9 (patch) | |
tree | c51104a00572861fe68de0388472b9a2972dd30d | |
parent | 775578a445bbbbfc43b1dcc1c3e2d3b4bdb35962 (diff) | |
download | postgresql-4fa1d89cba0f1feb5120e99eb01c152ba276c4e9.tar.gz postgresql-4fa1d89cba0f1feb5120e99eb01c152ba276c4e9.zip |
Doc: clean up markup for jsonb_set and related functions.
The markup for optional parameters was neither correct nor consistent.
In passing, fix a spelling mistake.
Per report from Alex Macy. Some of these mistakes are old, so
back-patch as appropriate.
Discussion: https://postgr.es/m/156953522258.1204.12736099368284950578@wrigleys.postgresql.org
-rw-r--r-- | doc/src/sgml/func.sgml | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 48df9f869a7..0aa399dc2f0 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -12497,7 +12497,7 @@ table2-mapping <entry><literal>[{"f1":1},2,null,3]</literal></entry> </row> <row> - <entry><para><literal>jsonb_set(target jsonb, path text[], new_value jsonb<optional>, <parameter>create_missing</parameter> <type>boolean</type></optional>)</literal> + <entry><para><literal>jsonb_set(target jsonb, path text[], new_value jsonb <optional>, create_missing boolean</optional>)</literal> </para></entry> <entry><para><type>jsonb</type></para></entry> <entry> @@ -12505,10 +12505,10 @@ table2-mapping with the section designated by <replaceable>path</replaceable> replaced by <replaceable>new_value</replaceable>, or with <replaceable>new_value</replaceable> added if - <replaceable>create_missing</replaceable> is true ( default is + <replaceable>create_missing</replaceable> is true (default is <literal>true</literal>) and the item designated by <replaceable>path</replaceable> does not exist. - As with the path orientated operators, negative integers that + As with the path oriented operators, negative integers that appear in <replaceable>path</replaceable> count from the end of JSON arrays. </entry> @@ -12522,7 +12522,7 @@ table2-mapping <row> <entry> <para><literal> - jsonb_insert(target jsonb, path text[], new_value jsonb, <optional><parameter>insert_after</parameter> <type>boolean</type></optional>) + jsonb_insert(target jsonb, path text[], new_value jsonb <optional>, insert_after boolean</optional>) </literal></para> </entry> <entry><para><type>jsonb</type></para></entry> @@ -12537,7 +12537,7 @@ table2-mapping designated by <replaceable>path</replaceable> is in JSONB object, <replaceable>new_value</replaceable> will be inserted only if <replaceable>target</replaceable> does not exist. As with the path - orientated operators, negative integers that appear in + oriented operators, negative integers that appear in <replaceable>path</replaceable> count from the end of JSON arrays. </entry> <entry> @@ -12578,10 +12578,10 @@ table2-mapping <row> <entry> <para><literal> - jsonb_path_exists(target jsonb, path jsonpath [, vars jsonb [, silent bool]]) + jsonb_path_exists(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> <para><literal> - jsonb_path_exists_tz(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_exists_tz(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> </entry> <entry><type>boolean</type></entry> @@ -12601,10 +12601,10 @@ table2-mapping <row> <entry> <para><literal> - jsonb_path_match(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_match(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> <para><literal> - jsonb_path_match_tz(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_match_tz(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> </entry> <entry><type>boolean</type></entry> @@ -12625,10 +12625,10 @@ table2-mapping <row> <entry> <para><literal> - jsonb_path_query(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_query(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> <para><literal> - jsonb_path_query_tz(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_query_tz(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> </entry> <entry><type>setof jsonb</type></entry> @@ -12656,10 +12656,10 @@ table2-mapping <row> <entry> <para><literal> - jsonb_path_query_array(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_query_array(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> <para><literal> - jsonb_path_query_array_tz(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_query_array_tz(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> </entry> <entry><type>jsonb</type></entry> @@ -12679,10 +12679,10 @@ table2-mapping <row> <entry> <para><literal> - jsonb_path_query_first(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_query_first(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> <para><literal> - jsonb_path_query_first_tz(target jsonb, path jsonpath [, vars jsonb, silent bool]) + jsonb_path_query_first_tz(target jsonb, path jsonpath <optional>, vars jsonb <optional>, silent bool</optional></optional>) </literal></para> </entry> <entry><type>jsonb</type></entry> |