Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit495cadd

Browse files
committed
Further cleanup of JSON-specific error messages.
Fix an obvious typo in json_build_object()'s complaint about invalidnumber of arguments, and make the errhint a bit more sensible too.Per discussion about how to word the improved hint, change the few placesin the documentation that refer to JSON object field names as "names" tosay "keys" instead, since that's what we've said in the vast majority ofplaces in the docs. Arguably "name" is more correct, since that's theterminology used in RFC 7159; but we're stuck with "key" in view of thenaming of json_object_keys() so let's at least be self-consistent.I adjusted a few code comments to match this as well, and failed toresist the temptation to clean up some odd whitespace choices in thesame area, as well as a useless duplicate PG_ARGISNULL() check. There'sstill quite a bit of code that uses the phrase "field name" in non-user-visible ways, so I left those usages alone.
1 parent9da8675 commit495cadd

File tree

2 files changed

+15
-23
lines changed

2 files changed

+15
-23
lines changed

‎doc/src/sgml/func.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10317,7 +10317,7 @@ table2-mapping
1031710317
<entry>
1031810318
Builds a JSON object out of a variadic argument list. By
1031910319
convention, the argument list consists of alternating
10320-
names and values.
10320+
keys and values.
1032110321
</entry>
1032210322
<entry><literal>json_build_object('foo',1,'bar',2)</literal></entry>
1032310323
<entry><literal>{"foo": 1, "bar": 2}</literal></entry>
@@ -10329,9 +10329,9 @@ table2-mapping
1032910329
<entry>
1033010330
Builds a JSON object out of a text array. The array must have either
1033110331
exactly one dimension with an even number of members, in which case
10332-
they are taken as alternatingname/value pairs, or two dimensions
10332+
they are taken as alternatingkey/value pairs, or two dimensions
1033310333
such that each inner array has exactly two elements, which
10334-
are taken as aname/value pair.
10334+
are taken as akey/value pair.
1033510335
</entry>
1033610336
<entry><para><literal>json_object('{a, 1, b, "def", c, 3.5}')</></para>
1033710337
<para><literal>json_object('{{a, 1},{b, "def"},{c, 3.5}}')</></para></entry>
@@ -10715,9 +10715,9 @@ table2-mapping
1071510715
<function>json_to_record</> and <function>json_to_recordset</>,
1071610716
type coercion from the JSON is <quote>best effort</> and may not result
1071710717
in desired values for some types. JSON keys are matched to
10718-
identicalfield names in the target row type, andfields that do
10719-
not existin theJSON will simplybeNULL. JSON keys that do not
10720-
appear in the target row type will be omitted from the output.
10718+
identicalcolumn names in the target row type. JSONfields that do not
10719+
appearin thetarget row type willbeomitted from the output, and
10720+
target columns that do not match any JSON field will simply be NULL.
1072110721
</para>
1072210722
</note>
1072310723

‎src/backend/utils/adt/json.c

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -354,8 +354,9 @@ static void
354354
parse_object_field(JsonLexContext*lex,JsonSemAction*sem)
355355
{
356356
/*
357-
* an object field is "fieldname" : value where value can be a scalar,
358-
* object or array
357+
* An object field is "fieldname" : value where value can be a scalar,
358+
* object or array. Note: in user-facing docs and error messages, we
359+
* generally call a field name a "key".
359360
*/
360361

361362
char*fname=NULL;/* keep compiler quiet */
@@ -1890,7 +1891,6 @@ json_object_agg_transfn(PG_FUNCTION_ARGS)
18901891
(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
18911892
errmsg("field name must not be null")));
18921893

1893-
18941894
val_type=get_fn_expr_argtype(fcinfo->flinfo,1);
18951895

18961896
/*
@@ -1976,20 +1976,18 @@ json_build_object(PG_FUNCTION_ARGS)
19761976
StringInforesult;
19771977
Oidval_type;
19781978

1979-
19801979
if (nargs %2!=0)
19811980
ereport(ERROR,
19821981
(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1983-
errmsg("invalidnumberor arguments"),
1984-
errhint("Objectmustbe matched key value pairs.")));
1982+
errmsg("argument list must have evennumberof elements"),
1983+
errhint("The arguments of json_build_object()mustconsist of alternating keys and values.")));
19851984

19861985
result=makeStringInfo();
19871986

19881987
appendStringInfoChar(result,'{');
19891988

19901989
for (i=0;i<nargs;i+=2)
19911990
{
1992-
19931991
/* process key */
19941992

19951993
if (PG_ARGISNULL(i))
@@ -2006,10 +2004,7 @@ json_build_object(PG_FUNCTION_ARGS)
20062004
if (val_type==UNKNOWNOID&&get_fn_expr_arg_stable(fcinfo->flinfo,i))
20072005
{
20082006
val_type=TEXTOID;
2009-
if (PG_ARGISNULL(i))
2010-
arg= (Datum)0;
2011-
else
2012-
arg=CStringGetTextDatum(PG_GETARG_POINTER(i));
2007+
arg=CStringGetTextDatum(PG_GETARG_POINTER(i));
20132008
}
20142009
else
20152010
{
@@ -2048,12 +2043,11 @@ json_build_object(PG_FUNCTION_ARGS)
20482043
errmsg("could not determine data type for argument %d",
20492044
i+2)));
20502045
add_json(arg,PG_ARGISNULL(i+1),result,val_type, false);
2051-
20522046
}
2047+
20532048
appendStringInfoChar(result,'}');
20542049

20552050
PG_RETURN_TEXT_P(cstring_to_text_with_len(result->data,result->len));
2056-
20572051
}
20582052

20592053
/*
@@ -2127,9 +2121,8 @@ json_build_array_noargs(PG_FUNCTION_ARGS)
21272121
/*
21282122
* SQL function json_object(text[])
21292123
*
2130-
* take a one or two dimensional array of text asname vale pairs
2124+
* take a one or two dimensional array of text askey/value pairs
21312125
* for a json object.
2132-
*
21332126
*/
21342127
Datum
21352128
json_object(PG_FUNCTION_ARGS)
@@ -2219,7 +2212,7 @@ json_object(PG_FUNCTION_ARGS)
22192212
/*
22202213
* SQL function json_object(text[], text[])
22212214
*
2222-
* take separatename and value arrays of text to construct a json object
2215+
* take separatekey and value arrays of text to construct a json object
22232216
* pairwise.
22242217
*/
22252218
Datum
@@ -2299,7 +2292,6 @@ json_object_two_arg(PG_FUNCTION_ARGS)
22992292
pfree(result.data);
23002293

23012294
PG_RETURN_TEXT_P(rval);
2302-
23032295
}
23042296

23052297

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp