</replaceable> in parentesis is not usual on DOCs
This page has 3 items that are between parentheses, there is an explanation
why they are used this way ?
https://www.postgresql.org/docs/devel/functions-json.html#FUNCTIONS-SQLJSON-TABLE
Each syntax element is described below in more detail.
*context_item*, *path_expression* [ AS *json_path_name* ] [ PASSING {
*value* AS *varname* } [, ...]]
The input data to query (*context_item*), the JSON path expression defining
the query (*path_expression*) with an optional name (*json_path_name*), and
an optional PASSING clause, which can provide data
Why (*context_item*), (*path_expression*) and (*json_path_name*) are inside
a parentheses ? This is not usual when explaining any other feature.
regards
Marcos
On 15 May 2024, at 14:04, Marcos Pegoraro <marcos@f10.com.br> wrote:
Why (context_item), (path_expression) and (json_path_name) are inside a parentheses ? This is not usual when explaining any other feature.
Agreed, that's inconsisent with how for example json_table_column is documented
in the next list item under COLUMNS. Unless objected to I will remove these
parenthesis.
--
Daniel Gustafsson
On Wed, May 15, 2024 at 8:34 PM Daniel Gustafsson <daniel@yesql.se> wrote:
On 15 May 2024, at 14:04, Marcos Pegoraro <marcos@f10.com.br> wrote:
Why (context_item), (path_expression) and (json_path_name) are inside a parentheses ? This is not usual when explaining any other feature.
Agreed, that's inconsisent with how for example json_table_column is documented
in the next list item under COLUMNS. Unless objected to I will remove these
parenthesis.
The input data to query (context_item), the JSON path expression defining the query (path_expression) with an optional name (json_path_name)
i think the parentheses is for explaining that
context_item refers "The input data to query";
path_expression refers "the JSON path expression defining the query";
json_path_name refers to "an optional name";
removing parentheses means we need to rephrase this sentence?
So I come up with the following rephrase:
The context_item specifies the input data to query, the
path_expression is a JSON path expression defining the query,
json_path_name is an optional name for the path_expression. The
optional PASSING clause can provide data values to the
path_expression.
On Thu, May 16, 2024 at 12:14 PM jian he <jian.universality@gmail.com> wrote:
On Wed, May 15, 2024 at 8:34 PM Daniel Gustafsson <daniel@yesql.se> wrote:
On 15 May 2024, at 14:04, Marcos Pegoraro <marcos@f10.com.br> wrote:
Why (context_item), (path_expression) and (json_path_name) are inside a parentheses ? This is not usual when explaining any other feature.
Agreed, that's inconsisent with how for example json_table_column is documented
in the next list item under COLUMNS. Unless objected to I will remove these
parenthesis.The input data to query (context_item), the JSON path expression defining the query (path_expression) with an optional name (json_path_name)
i think the parentheses is for explaining that
context_item refers "The input data to query";
path_expression refers "the JSON path expression defining the query";
json_path_name refers to "an optional name";
removing parentheses means we need to rephrase this sentence?
So I come up with the following rephrase:The context_item specifies the input data to query, the
path_expression is a JSON path expression defining the query,
json_path_name is an optional name for the path_expression. The
optional PASSING clause can provide data values to the
path_expression.
Based on this, write a simple patch.
Attachments:
minor_fix_json_table_doc.difftext/x-patch; charset=US-ASCII; name=minor_fix_json_table_doc.diffDownload
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 17c44bc3..f9047a8e 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -18956,10 +18956,10 @@ where <replaceable class="parameter">json_table_column</replaceable> is:
</term>
<listitem>
<para>
- The input data to query (<replaceable>context_item</replaceable>),
- the JSON path expression defining the query (<replaceable>path_expression</replaceable>)
- with an optional name (<replaceable>json_path_name</replaceable>), and an
- optional <literal>PASSING</literal> clause, which can provide data values
+The <replaceable>context_item</replaceable> specifies the input data to query,
+the <replaceable>path_expression</replaceable> is a JSON path expression defining the query,
+<replaceable>json_path_name</replaceable> is an optional name for the <replaceable>path_expression</replaceable>.
+The optional <literal>PASSING</literal> clause can provide data values
to the <replaceable>path_expression</replaceable>. The result of the input
data evaluation using the aforementioned elements is called the
<firstterm>row pattern</firstterm>, which is used as the source for row
On 20.05.24 02:00, jian he wrote:
removing parentheses means we need to rephrase this sentence?
So I come up with the following rephrase:The context_item specifies the input data to query, the
path_expression is a JSON path expression defining the query,
json_path_name is an optional name for the path_expression. The
optional PASSING clause can provide data values to the
path_expression.Based on this, write a simple patch.
Your patch kind of messes up the indentation of the text you are
changing. Please check that.
On Wed, May 22, 2024 at 7:14 PM Peter Eisentraut <peter@eisentraut.org> wrote:
On 20.05.24 02:00, jian he wrote:
removing parentheses means we need to rephrase this sentence?
So I come up with the following rephrase:The context_item specifies the input data to query, the
path_expression is a JSON path expression defining the query,
json_path_name is an optional name for the path_expression. The
optional PASSING clause can provide data values to the
path_expression.Based on this, write a simple patch.
Your patch kind of messes up the indentation of the text you are
changing. Please check that.
please check attached.
Attachments:
doc_fix_json_table_v2.difftext/x-patch; charset=US-ASCII; name=doc_fix_json_table_v2.diffDownload
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 17c44bc3..485f1822 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -18956,10 +18956,10 @@ where <replaceable class="parameter">json_table_column</replaceable> is:
</term>
<listitem>
<para>
- The input data to query (<replaceable>context_item</replaceable>),
- the JSON path expression defining the query (<replaceable>path_expression</replaceable>)
- with an optional name (<replaceable>json_path_name</replaceable>), and an
- optional <literal>PASSING</literal> clause, which can provide data values
+ The <replaceable>context_item</replaceable> specifies the input data to query,
+ the <replaceable>path_expression</replaceable> is a JSON path expression defining the query,
+ <replaceable>json_path_name</replaceable> is an optional name for the <replaceable>path_expression</replaceable>.
+ The optional <literal>PASSING</literal> clause can provide data values
to the <replaceable>path_expression</replaceable>. The result of the input
data evaluation using the aforementioned elements is called the
<firstterm>row pattern</firstterm>, which is used as the source for row
On Wed, May 22, 2024 at 8:22 PM jian he <jian.universality@gmail.com> wrote:
On Wed, May 22, 2024 at 7:14 PM Peter Eisentraut <peter@eisentraut.org> wrote:
On 20.05.24 02:00, jian he wrote:
removing parentheses means we need to rephrase this sentence?
So I come up with the following rephrase:The context_item specifies the input data to query, the
path_expression is a JSON path expression defining the query,
json_path_name is an optional name for the path_expression. The
optional PASSING clause can provide data values to the
path_expression.Based on this, write a simple patch.
Your patch kind of messes up the indentation of the text you are
changing. Please check that.please check attached.
Sorry about not noticing this earlier.
Thanks for the patch and the reviews. I've pushed it now after minor changes.
--
Thanks, Amit Langote