PostgreSQL Source Code  git master
json.h File Reference
#include "lib/stringinfo.h"
Include dependency graph for json.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void escape_json (StringInfo buf, const char *str)
 
char * JsonEncodeDateTime (char *buf, Datum value, Oid typid, const int *tzp)
 
bool to_json_is_immutable (Oid typoid)
 
Datum json_build_object_worker (int nargs, const Datum *args, const bool *nulls, const Oid *types, bool absent_on_null, bool unique_keys)
 
Datum json_build_array_worker (int nargs, const Datum *args, const bool *nulls, const Oid *types, bool absent_on_null)
 
bool json_validate (text *json, bool check_unique_keys, bool throw_error)
 

Function Documentation

◆ escape_json()

void escape_json ( StringInfo  buf,
const char *  str 
)

Definition at line 1526 of file json.c.

1527 {
1528  const char *p;
1529 
1531  for (p = str; *p; p++)
1532  {
1533  switch (*p)
1534  {
1535  case '\b':
1536  appendStringInfoString(buf, "\\b");
1537  break;
1538  case '\f':
1539  appendStringInfoString(buf, "\\f");
1540  break;
1541  case '\n':
1542  appendStringInfoString(buf, "\\n");
1543  break;
1544  case '\r':
1545  appendStringInfoString(buf, "\\r");
1546  break;
1547  case '\t':
1548  appendStringInfoString(buf, "\\t");
1549  break;
1550  case '"':
1551  appendStringInfoString(buf, "\\\"");
1552  break;
1553  case '\\':
1554  appendStringInfoString(buf, "\\\\");
1555  break;
1556  default:
1557  if ((unsigned char) *p < ' ')
1558  appendStringInfo(buf, "\\u%04x", (int) *p);
1559  else
1561  break;
1562  }
1563  }
1565 }
static char * buf
Definition: pg_test_fsync.c:73
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:97
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:182
#define appendStringInfoCharMacro(str, ch)
Definition: stringinfo.h:203

References appendStringInfo(), appendStringInfoCharMacro, appendStringInfoString(), buf, and generate_unaccent_rules::str.

Referenced by AddFileToBackupManifest(), appendJSONKeyValue(), composite_to_json(), datum_to_json_internal(), escape_yaml(), ExplainDummyGroup(), ExplainOpenGroup(), ExplainProperty(), ExplainPropertyList(), ExplainPropertyListNested(), hstore_to_json(), hstore_to_json_loose(), json_object(), json_object_two_arg(), jsonb_put_escaped_value(), populate_scalar(), printJsonPathItem(), sn_object_field_start(), sn_scalar(), transform_string_values_object_field_start(), transform_string_values_scalar(), and write_jsonlog().

◆ json_build_array_worker()

Datum json_build_array_worker ( int  nargs,
const Datum args,
const bool nulls,
const Oid types,
bool  absent_on_null 
)

Definition at line 1298 of file json.c.

1300 {
1301  int i;
1302  const char *sep = "";
1303  StringInfo result;
1304 
1305  result = makeStringInfo();
1306 
1307  appendStringInfoChar(result, '[');
1308 
1309  for (i = 0; i < nargs; i++)
1310  {
1311  if (absent_on_null && nulls[i])
1312  continue;
1313 
1314  appendStringInfoString(result, sep);
1315  sep = ", ";
1316  add_json(args[i], nulls[i], result, types[i], false);
1317  }
1318 
1319  appendStringInfoChar(result, ']');
1320 
1321  return PointerGetDatum(cstring_to_text_with_len(result->data, result->len));
1322 }
struct typedefs * types
Definition: ecpg.c:29
int i
Definition: isn.c:73
static void add_json(Datum val, bool is_null, StringInfo result, Oid val_type, bool key_scalar)
Definition: json.c:570
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
StringInfo makeStringInfo(void)
Definition: stringinfo.c:41
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:194
text * cstring_to_text_with_len(const char *s, int len)
Definition: varlena.c:196

References add_json(), appendStringInfoChar(), appendStringInfoString(), generate_unaccent_rules::args, cstring_to_text_with_len(), StringInfoData::data, i, StringInfoData::len, makeStringInfo(), PointerGetDatum(), and types.

Referenced by ExecEvalJsonConstructor(), and json_build_array().

◆ json_build_object_worker()

Datum json_build_object_worker ( int  nargs,
const Datum args,
const bool nulls,
const Oid types,
bool  absent_on_null,
bool  unique_keys 
)

Definition at line 1185 of file json.c.

1187 {
1188  int i;
1189  const char *sep = "";
1190  StringInfo result;
1191  JsonUniqueBuilderState unique_check;
1192 
1193  if (nargs % 2 != 0)
1194  ereport(ERROR,
1195  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1196  errmsg("argument list must have even number of elements"),
1197  /* translator: %s is a SQL function name */
1198  errhint("The arguments of %s must consist of alternating keys and values.",
1199  "json_build_object()")));
1200 
1201  result = makeStringInfo();
1202 
1203  appendStringInfoChar(result, '{');
1204 
1205  if (unique_keys)
1206  json_unique_builder_init(&unique_check);
1207 
1208  for (i = 0; i < nargs; i += 2)
1209  {
1210  StringInfo out;
1211  bool skip;
1212  int key_offset;
1213 
1214  /* Skip null values if absent_on_null */
1215  skip = absent_on_null && nulls[i + 1];
1216 
1217  if (skip)
1218  {
1219  /* If key uniqueness check is needed we must save skipped keys */
1220  if (!unique_keys)
1221  continue;
1222 
1223  out = json_unique_builder_get_throwawaybuf(&unique_check);
1224  }
1225  else
1226  {
1227  appendStringInfoString(result, sep);
1228  sep = ", ";
1229  out = result;
1230  }
1231 
1232  /* process key */
1233  if (nulls[i])
1234  ereport(ERROR,
1235  (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
1236  errmsg("null value not allowed for object key")));
1237 
1238  /* save key offset before appending it */
1239  key_offset = out->len;
1240 
1241  add_json(args[i], false, out, types[i], true);
1242 
1243  if (unique_keys)
1244  {
1245  /* check key uniqueness after key appending */
1246  const char *key = &out->data[key_offset];
1247 
1248  if (!json_unique_check_key(&unique_check.check, key, 0))
1249  ereport(ERROR,
1250  errcode(ERRCODE_DUPLICATE_JSON_OBJECT_KEY_VALUE),
1251  errmsg("duplicate JSON object key value: %s", key));
1252 
1253  if (skip)
1254  continue;
1255  }
1256 
1257  appendStringInfoString(result, " : ");
1258 
1259  /* process value */
1260  add_json(args[i + 1], nulls[i + 1], result, types[i + 1], false);
1261  }
1262 
1263  appendStringInfoChar(result, '}');
1264 
1265  return PointerGetDatum(cstring_to_text_with_len(result->data, result->len));
1266 }
int errhint(const char *fmt,...)
Definition: elog.c:1316
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
static StringInfo json_unique_builder_get_throwawaybuf(JsonUniqueBuilderState *cxt)
Definition: json.c:946
static bool json_unique_check_key(JsonUniqueCheckState *cxt, const char *key, int object_id)
Definition: json.c:926
static void json_unique_builder_init(JsonUniqueBuilderState *cxt)
Definition: json.c:918
static const struct exclude_list_item skip[]
Definition: pg_checksums.c:108
JsonUniqueCheckState check
Definition: json.c:69

References add_json(), appendStringInfoChar(), appendStringInfoString(), generate_unaccent_rules::args, JsonUniqueBuilderState::check, cstring_to_text_with_len(), StringInfoData::data, ereport, errcode(), errhint(), errmsg(), ERROR, i, json_unique_builder_get_throwawaybuf(), json_unique_builder_init(), json_unique_check_key(), sort-test::key, StringInfoData::len, makeStringInfo(), PointerGetDatum(), skip, and types.

Referenced by ExecEvalJsonConstructor(), and json_build_object().

◆ json_validate()

bool json_validate ( text json,
bool  check_unique_keys,
bool  throw_error 
)

Definition at line 1627 of file json.c.

1628 {
1629  JsonLexContext lex;
1630  JsonSemAction uniqueSemAction = {0};
1632  JsonParseErrorType result;
1633 
1634  makeJsonLexContext(&lex, json, check_unique_keys);
1635 
1636  if (check_unique_keys)
1637  {
1638  state.lex = &lex;
1639  state.stack = NULL;
1640  state.id_counter = 0;
1641  state.unique = true;
1642  json_unique_check_init(&state.check);
1643 
1644  uniqueSemAction.semstate = &state;
1645  uniqueSemAction.object_start = json_unique_object_start;
1647  uniqueSemAction.object_end = json_unique_object_end;
1648  }
1649 
1650  result = pg_parse_json(&lex, check_unique_keys ? &uniqueSemAction : &nullSemAction);
1651 
1652  if (result != JSON_SUCCESS)
1653  {
1654  if (throw_error)
1655  json_errsave_error(result, &lex, NULL);
1656 
1657  return false; /* invalid json */
1658  }
1659 
1660  if (check_unique_keys && !state.unique)
1661  {
1662  if (throw_error)
1663  ereport(ERROR,
1664  (errcode(ERRCODE_DUPLICATE_JSON_OBJECT_KEY_VALUE),
1665  errmsg("duplicate JSON object key value")));
1666 
1667  return false; /* not unique keys */
1668  }
1669 
1670  if (check_unique_keys)
1671  freeJsonLexContext(&lex);
1672 
1673  return true; /* ok */
1674 }
static JsonParseErrorType json_unique_object_start(void *_state)
Definition: json.c:1569
static void json_unique_check_init(JsonUniqueCheckState *cxt)
Definition: json.c:900
static JsonParseErrorType json_unique_object_field_start(void *_state, char *field, bool isnull)
Definition: json.c:1602
static JsonParseErrorType json_unique_object_end(void *_state)
Definition: json.c:1587
JsonSemAction nullSemAction
Definition: jsonapi.c:57
JsonParseErrorType pg_parse_json(JsonLexContext *lex, JsonSemAction *sem)
Definition: jsonapi.c:205
void freeJsonLexContext(JsonLexContext *lex)
Definition: jsonapi.c:183
JsonParseErrorType
Definition: jsonapi.h:37
@ JSON_SUCCESS
Definition: jsonapi.h:38
JsonLexContext * makeJsonLexContext(JsonLexContext *lex, text *json, bool need_escapes)
Definition: jsonfuncs.c:529
void json_errsave_error(JsonParseErrorType error, JsonLexContext *lex, Node *escontext)
Definition: jsonfuncs.c:630
json_struct_action object_start
Definition: jsonapi.h:120
json_ofield_action object_field_start
Definition: jsonapi.h:124
void * semstate
Definition: jsonapi.h:119
json_struct_action object_end
Definition: jsonapi.h:121
Definition: regguts.h:323

References ereport, errcode(), errmsg(), ERROR, freeJsonLexContext(), json_errsave_error(), JSON_SUCCESS, json_unique_check_init(), json_unique_object_end(), json_unique_object_field_start(), json_unique_object_start(), makeJsonLexContext(), nullSemAction, JsonSemAction::object_end, JsonSemAction::object_field_start, JsonSemAction::object_start, pg_parse_json(), and JsonSemAction::semstate.

Referenced by ExecEvalJsonConstructor(), and ExecEvalJsonIsPredicate().

◆ JsonEncodeDateTime()

char* JsonEncodeDateTime ( char *  buf,
Datum  value,
Oid  typid,
const int *  tzp 
)

Definition at line 284 of file json.c.

285 {
286  if (!buf)
287  buf = palloc(MAXDATELEN + 1);
288 
289  switch (typid)
290  {
291  case DATEOID:
292  {
293  DateADT date;
294  struct pg_tm tm;
295 
297 
298  /* Same as date_out(), but forcing DateStyle */
299  if (DATE_NOT_FINITE(date))
301  else
302  {
304  &(tm.tm_year), &(tm.tm_mon), &(tm.tm_mday));
306  }
307  }
308  break;
309  case TIMEOID:
310  {
311  TimeADT time = DatumGetTimeADT(value);
312  struct pg_tm tt,
313  *tm = &tt;
314  fsec_t fsec;
315 
316  /* Same as time_out(), but forcing DateStyle */
317  time2tm(time, tm, &fsec);
318  EncodeTimeOnly(tm, fsec, false, 0, USE_XSD_DATES, buf);
319  }
320  break;
321  case TIMETZOID:
322  {
324  struct pg_tm tt,
325  *tm = &tt;
326  fsec_t fsec;
327  int tz;
328 
329  /* Same as timetz_out(), but forcing DateStyle */
330  timetz2tm(time, tm, &fsec, &tz);
331  EncodeTimeOnly(tm, fsec, true, tz, USE_XSD_DATES, buf);
332  }
333  break;
334  case TIMESTAMPOID:
335  {
337  struct pg_tm tm;
338  fsec_t fsec;
339 
341  /* Same as timestamp_out(), but forcing DateStyle */
344  else if (timestamp2tm(timestamp, NULL, &tm, &fsec, NULL, NULL) == 0)
345  EncodeDateTime(&tm, fsec, false, 0, NULL, USE_XSD_DATES, buf);
346  else
347  ereport(ERROR,
348  (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
349  errmsg("timestamp out of range")));
350  }
351  break;
352  case TIMESTAMPTZOID:
353  {
355  struct pg_tm tm;
356  int tz;
357  fsec_t fsec;
358  const char *tzn = NULL;
359 
361 
362  /*
363  * If a time zone is specified, we apply the time-zone shift,
364  * convert timestamptz to pg_tm as if it were without a time
365  * zone, and then use the specified time zone for converting
366  * the timestamp into a string.
367  */
368  if (tzp)
369  {
370  tz = *tzp;
372  }
373 
374  /* Same as timestamptz_out(), but forcing DateStyle */
377  else if (timestamp2tm(timestamp, tzp ? NULL : &tz, &tm, &fsec,
378  tzp ? NULL : &tzn, NULL) == 0)
379  {
380  if (tzp)
381  tm.tm_isdst = 1; /* set time-zone presence flag */
382 
383  EncodeDateTime(&tm, fsec, true, tz, tzn, USE_XSD_DATES, buf);
384  }
385  else
386  ereport(ERROR,
387  (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
388  errmsg("timestamp out of range")));
389  }
390  break;
391  default:
392  elog(ERROR, "unknown jsonb value datetime type oid %u", typid);
393  return NULL;
394  }
395 
396  return buf;
397 }
void EncodeTimeOnly(struct pg_tm *tm, fsec_t fsec, bool print_tz, int tz, int style, char *str)
Definition: datetime.c:4227
void j2date(int jd, int *year, int *month, int *day)
Definition: datetime.c:313
void EncodeDateTime(struct pg_tm *tm, fsec_t fsec, bool print_tz, int tz, const char *tzn, int style, char *str)
Definition: datetime.c:4257
void EncodeDateOnly(struct pg_tm *tm, int style, char *str)
Definition: datetime.c:4142
void EncodeSpecialTimestamp(Timestamp dt, char *str)
Definition: timestamp.c:1591
int timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm, fsec_t *fsec, const char **tzn, pg_tz *attimezone)
Definition: timestamp.c:1896
int64 Timestamp
Definition: timestamp.h:38
int64 TimestampTz
Definition: timestamp.h:39
int32 fsec_t
Definition: timestamp.h:41
#define USECS_PER_SEC
Definition: timestamp.h:134
#define TIMESTAMP_NOT_FINITE(j)
Definition: timestamp.h:169
#define POSTGRES_EPOCH_JDATE
Definition: timestamp.h:235
int timetz2tm(TimeTzADT *time, struct pg_tm *tm, fsec_t *fsec, int *tzp)
Definition: date.c:2403
int time2tm(TimeADT time, struct pg_tm *tm, fsec_t *fsec)
Definition: date.c:1488
void EncodeSpecialDate(DateADT dt, char *str)
Definition: date.c:294
#define DATE_NOT_FINITE(j)
Definition: date.h:43
int32 DateADT
Definition: date.h:23
static DateADT DatumGetDateADT(Datum X)
Definition: date.h:54
static TimeADT DatumGetTimeADT(Datum X)
Definition: date.h:60
static TimeTzADT * DatumGetTimeTzADTP(Datum X)
Definition: date.h:66
int64 TimeADT
Definition: date.h:25
#define MAXDATELEN
Definition: datetime.h:200
static struct @148 value
static struct pg_tm tm
Definition: localtime.c:104
void * palloc(Size size)
Definition: mcxt.c:1226
#define USE_XSD_DATES
Definition: miscadmin.h:235
long date
Definition: pgtypes_date.h:9
int64 timestamp
Definition: date.h:28
Definition: pgtime.h:35
int tm_mday
Definition: pgtime.h:39
int tm_mon
Definition: pgtime.h:40
int tm_isdst
Definition: pgtime.h:44
int tm_year
Definition: pgtime.h:41
static Timestamp DatumGetTimestamp(Datum X)
Definition: timestamp.h:28
static TimestampTz DatumGetTimestampTz(Datum X)
Definition: timestamp.h:34

References buf, DATE_NOT_FINITE, DatumGetDateADT(), DatumGetTimeADT(), DatumGetTimestamp(), DatumGetTimestampTz(), DatumGetTimeTzADTP(), elog(), EncodeDateOnly(), EncodeDateTime(), EncodeSpecialDate(), EncodeSpecialTimestamp(), EncodeTimeOnly(), ereport, errcode(), errmsg(), ERROR, j2date(), MAXDATELEN, palloc(), POSTGRES_EPOCH_JDATE, time2tm(), timestamp2tm(), TIMESTAMP_NOT_FINITE, timetz2tm(), tm, pg_tm::tm_isdst, pg_tm::tm_mday, pg_tm::tm_mon, pg_tm::tm_year, USE_XSD_DATES, USECS_PER_SEC, and value.

Referenced by convertJsonbScalar(), datum_to_json_internal(), and datum_to_jsonb_internal().

◆ to_json_is_immutable()

bool to_json_is_immutable ( Oid  typoid)

Definition at line 668 of file json.c.

669 {
670  JsonTypeCategory tcategory;
671  Oid outfuncoid;
672 
673  json_categorize_type(typoid, false, &tcategory, &outfuncoid);
674 
675  switch (tcategory)
676  {
677  case JSONTYPE_BOOL:
678  case JSONTYPE_JSON:
679  case JSONTYPE_JSONB:
680  case JSONTYPE_NULL:
681  return true;
682 
683  case JSONTYPE_DATE:
684  case JSONTYPE_TIMESTAMP:
686  return false;
687 
688  case JSONTYPE_ARRAY:
689  return false; /* TODO recurse into elements */
690 
691  case JSONTYPE_COMPOSITE:
692  return false; /* TODO recurse into fields */
693 
694  case JSONTYPE_NUMERIC:
695  case JSONTYPE_CAST:
696  case JSONTYPE_OTHER:
697  return func_volatile(outfuncoid) == PROVOLATILE_IMMUTABLE;
698  }
699 
700  return false; /* not reached */
701 }
void json_categorize_type(Oid typoid, bool is_jsonb, JsonTypeCategory *tcategory, Oid *outfuncoid)
Definition: jsonfuncs.c:5705
JsonTypeCategory
Definition: jsonfuncs.h:68
@ JSONTYPE_JSON
Definition: jsonfuncs.h:75
@ JSONTYPE_NULL
Definition: jsonfuncs.h:69
@ JSONTYPE_TIMESTAMP
Definition: jsonfuncs.h:73
@ JSONTYPE_NUMERIC
Definition: jsonfuncs.h:71
@ JSONTYPE_DATE
Definition: jsonfuncs.h:72
@ JSONTYPE_BOOL
Definition: jsonfuncs.h:70
@ JSONTYPE_OTHER
Definition: jsonfuncs.h:80
@ JSONTYPE_CAST
Definition: jsonfuncs.h:79
@ JSONTYPE_COMPOSITE
Definition: jsonfuncs.h:78
@ JSONTYPE_ARRAY
Definition: jsonfuncs.h:77
@ JSONTYPE_TIMESTAMPTZ
Definition: jsonfuncs.h:74
@ JSONTYPE_JSONB
Definition: jsonfuncs.h:76
char func_volatile(Oid funcid)
Definition: lsyscache.c:1784
unsigned int Oid
Definition: postgres_ext.h:31

References func_volatile(), json_categorize_type(), JSONTYPE_ARRAY, JSONTYPE_BOOL, JSONTYPE_CAST, JSONTYPE_COMPOSITE, JSONTYPE_DATE, JSONTYPE_JSON, JSONTYPE_JSONB, JSONTYPE_NULL, JSONTYPE_NUMERIC, JSONTYPE_OTHER, JSONTYPE_TIMESTAMP, and JSONTYPE_TIMESTAMPTZ.

Referenced by contain_mutable_functions_walker().