3 * Test jsonb delete and concatenate operator functions for 9.4
5 * Portions Copyright (c) 1996-2015, PostgreSQL Global Development Group
6 * Portions Copyright (c) 1994, Regents of the University of California
7 * Author: Glyn Astill <glyn@8kb.co.uk>
9 * This is purely experimentation and will contain many errors and bad form
10 * DO NOT USE ON PRODUCTION SYSTEMS.
16 #include "utils/array.h"
17 #include "utils/jsonb.h"
18 #include "catalog/pg_type.h"
19 #include "utils/builtins.h"
21 #ifdef PG_MODULE_MAGIC
25 Datum jsonb_delete_text(PG_FUNCTION_ARGS);
27 PG_FUNCTION_INFO_V1(jsonb_delete_text);
30 * Operator function to delete keys from left operand where a match is found in
33 * jsonb, text[] -> jsonb
37 jsonb_delete_text(PG_FUNCTION_ARGS)
42 /* pointers to incoming jsonb and text[] data */
43 Jsonb *input_jsonb = PG_GETARG_JSONB(0);
44 ArrayType *input_array = PG_GETARG_ARRAYTYPE_P(1);
46 /* pointers to return jsonb_value data and state to be converted to jsonb on return */
47 JsonbParseState *state = NULL;
48 JsonbValue *return_jsonb_value = NULL;
50 /* pointer to iterator for input_jsonb and lookup value data */
51 JsonbValue jsonb_lookup_value;
52 JsonbValue *jsonb_value = NULL;
53 JsonbIterator *jsonb_iterator;
54 JsonbValue jsonb_iterator_value;
55 int32 jsonb_iterator_token;
57 /* variables used for skip logic */
60 int32 array_level = 0;
62 /* array element variables for use during deconstruction */
67 /* individual array values values from incoming text[] */
68 text *array_element_text;
71 /* check that supplied jsonb isn't non object, i.e. scalar or array */
72 if (!JB_ROOT_IS_OBJECT(input_jsonb))
74 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
75 errmsg("cannot call on a non-object")));
77 /* assert input_array is a text array type */
78 Assert(ARR_ELEMTYPE(input_array) == TEXTOID);
80 /* check input_array is one-dimensional */
81 if (ARR_NDIM(input_array) > 1)
83 (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
84 errmsg("1 dimensional text array expected")));
86 /* deconstruct array elements */
87 deconstruct_array(input_array, TEXTOID, -1, false, 'i',
88 &datums, &nulls, &count);
90 /* first check to make sure at least one key exists - this is potentially just extra unwanted work */
91 for (i=0; i<count; i++)
96 array_element_text = DatumGetTextP(datums[i]);
98 jsonb_lookup_value.type = jbvString;
99 jsonb_lookup_value.val.string.val = VARDATA_ANY(array_element_text);
100 jsonb_lookup_value.val.string.len = VARSIZE_ANY_EXHDR(array_element_text);
102 jsonb_value = findJsonbValueFromContainer(&input_jsonb->root,
103 JB_FOBJECT | JB_FARRAY, &jsonb_lookup_value);
105 if (jsonb_value != NULL) {
112 PG_RETURN_JSONB(input_jsonb);
115 * If we've been supplied with existing keys iterate round json data matching those keys.
117 * skip_key, nest_level and array_level are crude counts to check if the the value for the key is closed
118 * and ensure we don't match on keys within nested objects. Because we are recursing into nested elements
119 * but blindly just pushing them onto the return value we can get away without deeper knowledge of the json?
122 jsonb_iterator = JsonbIteratorInit(&input_jsonb->root);
124 while ((jsonb_iterator_token = JsonbIteratorNext(&jsonb_iterator, &jsonb_iterator_value, false)) != WJB_DONE) {
126 switch (jsonb_iterator_token)
128 case WJB_BEGIN_ARRAY:
131 return_jsonb_value = pushJsonbValue(&state, WJB_BEGIN_ARRAY, &jsonb_iterator_value);
133 case WJB_BEGIN_OBJECT:
136 return_jsonb_value = pushJsonbValue(&state, WJB_BEGIN_OBJECT, &jsonb_iterator_value);
139 /* Check each key against our array of keys */
143 else if (nest_level == 1){
144 for (i=0; i<count; i++)
149 array_element_text = DatumGetTextP(datums[i]);
151 if (strcmp(VARDATA(array_element_text), pnstrdup(jsonb_iterator_value.val.string.val,jsonb_iterator_value.val.string.len)) == 0) {
159 return_jsonb_value = pushJsonbValue(&state, WJB_KEY, &jsonb_iterator_value);
163 return_jsonb_value = pushJsonbValue(&state, WJB_VALUE, &jsonb_iterator_value);
164 else if (skip_key > 0)
169 return_jsonb_value = pushJsonbValue(&state, WJB_ELEM, &jsonb_iterator_value);
174 return_jsonb_value = pushJsonbValue(&state, WJB_END_ARRAY, NULL);
175 else if (skip_key > 0 && array_level == 0)
181 return_jsonb_value = pushJsonbValue(&state, WJB_END_OBJECT, NULL);
182 else if (skip_key > 0)
186 elog(ERROR, "invalid JsonbIteratorNext rc: %d", jsonb_iterator_token);
189 PG_FREE_IF_COPY(input_jsonb, 0);
190 PG_FREE_IF_COPY(input_array, 1);
192 PG_RETURN_JSONB(JsonbValueToJsonb(return_jsonb_value));
195 Datum jsonb_delete_jsonb(PG_FUNCTION_ARGS);
197 PG_FUNCTION_INFO_V1(jsonb_delete_jsonb);
200 * Operator function to delete keys and values from left operand where a match
201 * is found in the right operand.
203 * jsonb, jsonb -> jsonb
207 jsonb_delete_jsonb(PG_FUNCTION_ARGS)
209 /* pointers to incoming jsonb and text[] data */
210 Jsonb *input_jsonb_a = PG_GETARG_JSONB(0);
211 Jsonb *input_jsonb_b = PG_GETARG_JSONB(1);
213 /* pointers to return jsonb_value data and state to be converted to jsonb on return */
214 JsonbValue *return_jsonb_value = NULL;
215 JsonbParseState *state = NULL;
217 /* pointer to iterator for input_jsonb_a and temporary value data */
218 JsonbIterator *jsonb_iterator;
219 JsonbValue jsonb_iterator_value;
220 JsonbValue jsonb_iterator_key;
221 int32 jsonb_iterator_token;
222 bool skip_nested = false;
224 /* pointer to iterator and container for pushing nested parts of input_jsonb_a */
225 JsonbContainer *nest_jsonb_container_a;
226 JsonbIterator *nest_jsonb_iterator;
229 /* inner iterator for iterating around jbvBinary types */
230 JsonbValue nest_jsonb_iterator_value;
231 int32 nest_jsonb_iterator_token;
233 /* pointer to lookup on input_jsonb_b */
234 JsonbValue *jsonb_lookup_value = NULL;
236 jsonb_iterator = JsonbIteratorInit(&input_jsonb_a->root);
238 while ((jsonb_iterator_token = JsonbIteratorNext(&jsonb_iterator, &jsonb_iterator_value, skip_nested)) != WJB_DONE) {
241 switch (jsonb_iterator_token)
243 case WJB_BEGIN_ARRAY:
244 case WJB_BEGIN_OBJECT:
248 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
251 jsonb_lookup_value = findJsonbValueFromContainer(&input_jsonb_b->root, JB_FOBJECT | JB_FARRAY, &jsonb_iterator_value);
252 jsonb_iterator_key = jsonb_iterator_value;
254 jsonb_iterator_token = JsonbIteratorNext(&jsonb_iterator, &jsonb_iterator_value, skip_nested);
255 if (jsonb_iterator_token != WJB_VALUE)
256 elog(ERROR, "invalid JsonbIteratorNext (expected WJB_VALUE) rc: %d", jsonb_iterator_token);
258 if (jsonb_lookup_value != NULL) {
259 if (jsonb_lookup_value->type == jsonb_iterator_value.type) {
260 switch (jsonb_lookup_value->type) {
263 DatumGetCString(DirectFunctionCall1(numeric_out, PointerGetDatum(jsonb_lookup_value->val.numeric))),
264 DatumGetCString(DirectFunctionCall1(numeric_out, PointerGetDatum(jsonb_iterator_value.val.numeric)))
270 pnstrdup(jsonb_lookup_value->val.string.val,jsonb_lookup_value->val.string.len),
271 pnstrdup(jsonb_iterator_value.val.string.val,jsonb_iterator_value.val.string.len)
277 JsonbToCString(NULL, jsonb_lookup_value->val.binary.data, jsonb_lookup_value->val.binary.len),
278 JsonbToCString(NULL, jsonb_iterator_value.val.binary.data, jsonb_lookup_value->val.binary.len)
283 if (jsonb_lookup_value->val.boolean == jsonb_iterator_value.val.boolean)
287 /* should not be possible? */
289 /* should not be possible? */
291 ereport(NOTICE, (errcode(ERRCODE_SUCCESSFUL_COMPLETION), errmsg("unexpected lookup type")));
297 return_jsonb_value = pushJsonbValue(&state, WJB_KEY, &jsonb_iterator_key);
299 /* if our value is nested binary data, iterate separately pushing each val */
300 if (jsonb_iterator_value.type == jbvBinary) {
301 nest_jsonb_container_a = jsonb_iterator_value.val.binary.data;
303 nest_jsonb_iterator = JsonbIteratorInit(nest_jsonb_container_a);
304 while ((nest_jsonb_iterator_token = JsonbIteratorNext(&nest_jsonb_iterator, &nest_jsonb_iterator_value, false)) != WJB_DONE) {
305 return_jsonb_value = pushJsonbValue(&state, nest_jsonb_iterator_token, &nest_jsonb_iterator_value);
309 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
316 /* should not be possible */
318 elog(ERROR, "invalid JsonbIteratorNext rc: %d", jsonb_iterator_token);
323 PG_FREE_IF_COPY(input_jsonb_a, 0);
324 PG_FREE_IF_COPY(input_jsonb_b, 1);
326 PG_RETURN_JSONB(JsonbValueToJsonb(return_jsonb_value));
329 Datum jsonb_concat_jsonb(PG_FUNCTION_ARGS);
331 PG_FUNCTION_INFO_V1(jsonb_concat_jsonb);
334 * Operator function to concatenate json from left operand where a match
335 * is found in the right operand.
337 * jsonb, jsonb -> jsonb
341 jsonb_concat_jsonb(PG_FUNCTION_ARGS)
343 /* incoming jsonb and text[] data */
344 Jsonb *input_jsonb_a = PG_GETARG_JSONB(0);
345 Jsonb *input_jsonb_b = PG_GETARG_JSONB(1);
347 /* return jsonb_value data to be converted to jsonb on return */
348 JsonbValue *return_jsonb_value = NULL;
350 /* iterator for input_jsonb_b */
351 JsonbIterator *jsonb_iterator;
352 JsonbValue jsonb_iterator_value;
353 int32 jsonb_iterator_token;
355 JsonbParseState *state = NULL;
356 bool skip_nested = false;
358 int32 nest_level = 0;
360 /* check that supplied jsonb isn't non object, i.e. scalar or array */
361 if (!JB_ROOT_IS_OBJECT(input_jsonb_a) || !JB_ROOT_IS_OBJECT(input_jsonb_b))
363 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
364 errmsg("cannot call on a non-object")));
367 * The following is essentially a cut 'n shut job; discarding the closing root
368 * object token from the first jsonb value and the opening one from the second.
369 * Values from each are just blindly pushed onto the return value leaving
370 * deduplication down to lower level jsonb logic.
373 jsonb_iterator = JsonbIteratorInit(&input_jsonb_a->root);
375 while ((jsonb_iterator_token = JsonbIteratorNext(&jsonb_iterator, &jsonb_iterator_value, skip_nested)) != WJB_DONE) {
377 switch (jsonb_iterator_token)
379 case WJB_BEGIN_ARRAY:
384 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
386 case WJB_BEGIN_OBJECT:
387 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
393 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
396 elog(ERROR, "invalid JsonbIteratorNext rc: %d", jsonb_iterator_token);
402 jsonb_iterator = JsonbIteratorInit(&input_jsonb_b->root);
404 while ((jsonb_iterator_token = JsonbIteratorNext(&jsonb_iterator, &jsonb_iterator_value, skip_nested)) != WJB_DONE) {
406 switch (jsonb_iterator_token)
408 case WJB_BEGIN_ARRAY:
413 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
415 case WJB_BEGIN_OBJECT:
417 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
422 return_jsonb_value = pushJsonbValue(&state, jsonb_iterator_token, &jsonb_iterator_value);
425 elog(ERROR, "invalid JsonbIteratorNext rc: %d", jsonb_iterator_token);
430 PG_FREE_IF_COPY(input_jsonb_a, 0);
431 PG_FREE_IF_COPY(input_jsonb_b, 1);
433 PG_RETURN_JSONB(JsonbValueToJsonb(return_jsonb_value));