README: remove duplicate download link & mention related softw.
[pgsql.git] / contrib / hstore / hstore_op.c
blob0d4ec16d1e5401ebbbd9d414798dc667e078e83e
1 /*
2 * contrib/hstore/hstore_op.c
3 */
4 #include "postgres.h"
6 #include "access/htup_details.h"
7 #include "catalog/pg_type.h"
8 #include "common/hashfn.h"
9 #include "funcapi.h"
10 #include "hstore.h"
11 #include "utils/builtins.h"
12 #include "utils/memutils.h"
14 /* old names for C functions */
15 HSTORE_POLLUTE(hstore_fetchval, fetchval);
16 HSTORE_POLLUTE(hstore_exists, exists);
17 HSTORE_POLLUTE(hstore_defined, defined);
18 HSTORE_POLLUTE(hstore_delete, delete);
19 HSTORE_POLLUTE(hstore_concat, hs_concat);
20 HSTORE_POLLUTE(hstore_contains, hs_contains);
21 HSTORE_POLLUTE(hstore_contained, hs_contained);
22 HSTORE_POLLUTE(hstore_akeys, akeys);
23 HSTORE_POLLUTE(hstore_avals, avals);
24 HSTORE_POLLUTE(hstore_skeys, skeys);
25 HSTORE_POLLUTE(hstore_svals, svals);
26 HSTORE_POLLUTE(hstore_each, each);
30 * We're often finding a sequence of keys in ascending order. The
31 * "lowbound" parameter is used to cache lower bounds of searches
32 * between calls, based on this assumption. Pass NULL for it for
33 * one-off or unordered searches.
35 int
36 hstoreFindKey(HStore *hs, int *lowbound, char *key, int keylen)
38 HEntry *entries = ARRPTR(hs);
39 int stopLow = lowbound ? *lowbound : 0;
40 int stopHigh = HS_COUNT(hs);
41 int stopMiddle;
42 char *base = STRPTR(hs);
44 while (stopLow < stopHigh)
46 int difference;
48 stopMiddle = stopLow + (stopHigh - stopLow) / 2;
50 if (HSTORE_KEYLEN(entries, stopMiddle) == keylen)
51 difference = memcmp(HSTORE_KEY(entries, base, stopMiddle), key, keylen);
52 else
53 difference = (HSTORE_KEYLEN(entries, stopMiddle) > keylen) ? 1 : -1;
55 if (difference == 0)
57 if (lowbound)
58 *lowbound = stopMiddle + 1;
59 return stopMiddle;
61 else if (difference < 0)
62 stopLow = stopMiddle + 1;
63 else
64 stopHigh = stopMiddle;
67 if (lowbound)
68 *lowbound = stopLow;
69 return -1;
72 Pairs *
73 hstoreArrayToPairs(ArrayType *a, int *npairs)
75 Datum *key_datums;
76 bool *key_nulls;
77 int key_count;
78 Pairs *key_pairs;
79 int bufsiz;
80 int i,
83 deconstruct_array_builtin(a, TEXTOID, &key_datums, &key_nulls, &key_count);
85 if (key_count == 0)
87 *npairs = 0;
88 return NULL;
92 * A text array uses at least eight bytes per element, so any overflow in
93 * "key_count * sizeof(Pairs)" is small enough for palloc() to catch.
94 * However, credible improvements to the array format could invalidate
95 * that assumption. Therefore, use an explicit check rather than relying
96 * on palloc() to complain.
98 if (key_count > MaxAllocSize / sizeof(Pairs))
99 ereport(ERROR,
100 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
101 errmsg("number of pairs (%d) exceeds the maximum allowed (%d)",
102 key_count, (int) (MaxAllocSize / sizeof(Pairs)))));
104 key_pairs = palloc(sizeof(Pairs) * key_count);
106 for (i = 0, j = 0; i < key_count; i++)
108 if (!key_nulls[i])
110 key_pairs[j].key = VARDATA(key_datums[i]);
111 key_pairs[j].keylen = VARSIZE(key_datums[i]) - VARHDRSZ;
112 key_pairs[j].val = NULL;
113 key_pairs[j].vallen = 0;
114 key_pairs[j].needfree = 0;
115 key_pairs[j].isnull = 1;
116 j++;
120 *npairs = hstoreUniquePairs(key_pairs, j, &bufsiz);
122 return key_pairs;
126 PG_FUNCTION_INFO_V1(hstore_fetchval);
127 Datum
128 hstore_fetchval(PG_FUNCTION_ARGS)
130 HStore *hs = PG_GETARG_HSTORE_P(0);
131 text *key = PG_GETARG_TEXT_PP(1);
132 HEntry *entries = ARRPTR(hs);
133 text *out;
134 int idx = hstoreFindKey(hs, NULL,
135 VARDATA_ANY(key), VARSIZE_ANY_EXHDR(key));
137 if (idx < 0 || HSTORE_VALISNULL(entries, idx))
138 PG_RETURN_NULL();
140 out = cstring_to_text_with_len(HSTORE_VAL(entries, STRPTR(hs), idx),
141 HSTORE_VALLEN(entries, idx));
143 PG_RETURN_TEXT_P(out);
147 PG_FUNCTION_INFO_V1(hstore_exists);
148 Datum
149 hstore_exists(PG_FUNCTION_ARGS)
151 HStore *hs = PG_GETARG_HSTORE_P(0);
152 text *key = PG_GETARG_TEXT_PP(1);
153 int idx = hstoreFindKey(hs, NULL,
154 VARDATA_ANY(key), VARSIZE_ANY_EXHDR(key));
156 PG_RETURN_BOOL(idx >= 0);
160 PG_FUNCTION_INFO_V1(hstore_exists_any);
161 Datum
162 hstore_exists_any(PG_FUNCTION_ARGS)
164 HStore *hs = PG_GETARG_HSTORE_P(0);
165 ArrayType *keys = PG_GETARG_ARRAYTYPE_P(1);
166 int nkeys;
167 Pairs *key_pairs = hstoreArrayToPairs(keys, &nkeys);
168 int i;
169 int lowbound = 0;
170 bool res = false;
173 * we exploit the fact that the pairs list is already sorted into strictly
174 * increasing order to narrow the hstoreFindKey search; each search can
175 * start one entry past the previous "found" entry, or at the lower bound
176 * of the last search.
178 for (i = 0; i < nkeys; i++)
180 int idx = hstoreFindKey(hs, &lowbound,
181 key_pairs[i].key, key_pairs[i].keylen);
183 if (idx >= 0)
185 res = true;
186 break;
190 PG_RETURN_BOOL(res);
194 PG_FUNCTION_INFO_V1(hstore_exists_all);
195 Datum
196 hstore_exists_all(PG_FUNCTION_ARGS)
198 HStore *hs = PG_GETARG_HSTORE_P(0);
199 ArrayType *keys = PG_GETARG_ARRAYTYPE_P(1);
200 int nkeys;
201 Pairs *key_pairs = hstoreArrayToPairs(keys, &nkeys);
202 int i;
203 int lowbound = 0;
204 bool res = true;
207 * we exploit the fact that the pairs list is already sorted into strictly
208 * increasing order to narrow the hstoreFindKey search; each search can
209 * start one entry past the previous "found" entry, or at the lower bound
210 * of the last search.
212 for (i = 0; i < nkeys; i++)
214 int idx = hstoreFindKey(hs, &lowbound,
215 key_pairs[i].key, key_pairs[i].keylen);
217 if (idx < 0)
219 res = false;
220 break;
224 PG_RETURN_BOOL(res);
228 PG_FUNCTION_INFO_V1(hstore_defined);
229 Datum
230 hstore_defined(PG_FUNCTION_ARGS)
232 HStore *hs = PG_GETARG_HSTORE_P(0);
233 text *key = PG_GETARG_TEXT_PP(1);
234 HEntry *entries = ARRPTR(hs);
235 int idx = hstoreFindKey(hs, NULL,
236 VARDATA_ANY(key), VARSIZE_ANY_EXHDR(key));
237 bool res = (idx >= 0 && !HSTORE_VALISNULL(entries, idx));
239 PG_RETURN_BOOL(res);
243 PG_FUNCTION_INFO_V1(hstore_delete);
244 Datum
245 hstore_delete(PG_FUNCTION_ARGS)
247 HStore *hs = PG_GETARG_HSTORE_P(0);
248 text *key = PG_GETARG_TEXT_PP(1);
249 char *keyptr = VARDATA_ANY(key);
250 int keylen = VARSIZE_ANY_EXHDR(key);
251 HStore *out = palloc(VARSIZE(hs));
252 char *bufs,
253 *bufd,
254 *ptrd;
255 HEntry *es,
256 *ed;
257 int i;
258 int count = HS_COUNT(hs);
259 int outcount = 0;
261 SET_VARSIZE(out, VARSIZE(hs));
262 HS_SETCOUNT(out, count); /* temporary! */
264 bufs = STRPTR(hs);
265 es = ARRPTR(hs);
266 bufd = ptrd = STRPTR(out);
267 ed = ARRPTR(out);
269 for (i = 0; i < count; ++i)
271 int len = HSTORE_KEYLEN(es, i);
272 char *ptrs = HSTORE_KEY(es, bufs, i);
274 if (!(len == keylen && memcmp(ptrs, keyptr, keylen) == 0))
276 int vallen = HSTORE_VALLEN(es, i);
278 HS_COPYITEM(ed, bufd, ptrd, ptrs, len, vallen,
279 HSTORE_VALISNULL(es, i));
280 ++outcount;
284 HS_FINALIZE(out, outcount, bufd, ptrd);
286 PG_RETURN_POINTER(out);
290 PG_FUNCTION_INFO_V1(hstore_delete_array);
291 Datum
292 hstore_delete_array(PG_FUNCTION_ARGS)
294 HStore *hs = PG_GETARG_HSTORE_P(0);
295 HStore *out = palloc(VARSIZE(hs));
296 int hs_count = HS_COUNT(hs);
297 char *ps,
298 *bufd,
299 *pd;
300 HEntry *es,
301 *ed;
302 int i,
304 int outcount = 0;
305 ArrayType *key_array = PG_GETARG_ARRAYTYPE_P(1);
306 int nkeys;
307 Pairs *key_pairs = hstoreArrayToPairs(key_array, &nkeys);
309 SET_VARSIZE(out, VARSIZE(hs));
310 HS_SETCOUNT(out, hs_count); /* temporary! */
312 ps = STRPTR(hs);
313 es = ARRPTR(hs);
314 bufd = pd = STRPTR(out);
315 ed = ARRPTR(out);
317 if (nkeys == 0)
319 /* return a copy of the input, unchanged */
320 memcpy(out, hs, VARSIZE(hs));
321 HS_FIXSIZE(out, hs_count);
322 HS_SETCOUNT(out, hs_count);
323 PG_RETURN_POINTER(out);
327 * this is in effect a merge between hs and key_pairs, both of which are
328 * already sorted by (keylen,key); we take keys from hs only
331 for (i = j = 0; i < hs_count;)
333 int difference;
335 if (j >= nkeys)
336 difference = -1;
337 else
339 int skeylen = HSTORE_KEYLEN(es, i);
341 if (skeylen == key_pairs[j].keylen)
342 difference = memcmp(HSTORE_KEY(es, ps, i),
343 key_pairs[j].key,
344 key_pairs[j].keylen);
345 else
346 difference = (skeylen > key_pairs[j].keylen) ? 1 : -1;
349 if (difference > 0)
350 ++j;
351 else if (difference == 0)
352 ++i, ++j;
353 else
355 HS_COPYITEM(ed, bufd, pd,
356 HSTORE_KEY(es, ps, i), HSTORE_KEYLEN(es, i),
357 HSTORE_VALLEN(es, i), HSTORE_VALISNULL(es, i));
358 ++outcount;
359 ++i;
363 HS_FINALIZE(out, outcount, bufd, pd);
365 PG_RETURN_POINTER(out);
369 PG_FUNCTION_INFO_V1(hstore_delete_hstore);
370 Datum
371 hstore_delete_hstore(PG_FUNCTION_ARGS)
373 HStore *hs = PG_GETARG_HSTORE_P(0);
374 HStore *hs2 = PG_GETARG_HSTORE_P(1);
375 HStore *out = palloc(VARSIZE(hs));
376 int hs_count = HS_COUNT(hs);
377 int hs2_count = HS_COUNT(hs2);
378 char *ps,
379 *ps2,
380 *bufd,
381 *pd;
382 HEntry *es,
383 *es2,
384 *ed;
385 int i,
387 int outcount = 0;
389 SET_VARSIZE(out, VARSIZE(hs));
390 HS_SETCOUNT(out, hs_count); /* temporary! */
392 ps = STRPTR(hs);
393 es = ARRPTR(hs);
394 ps2 = STRPTR(hs2);
395 es2 = ARRPTR(hs2);
396 bufd = pd = STRPTR(out);
397 ed = ARRPTR(out);
399 if (hs2_count == 0)
401 /* return a copy of the input, unchanged */
402 memcpy(out, hs, VARSIZE(hs));
403 HS_FIXSIZE(out, hs_count);
404 HS_SETCOUNT(out, hs_count);
405 PG_RETURN_POINTER(out);
409 * this is in effect a merge between hs and hs2, both of which are already
410 * sorted by (keylen,key); we take keys from hs only; for equal keys, we
411 * take the value from hs unless the values are equal
414 for (i = j = 0; i < hs_count;)
416 int difference;
418 if (j >= hs2_count)
419 difference = -1;
420 else
422 int skeylen = HSTORE_KEYLEN(es, i);
423 int s2keylen = HSTORE_KEYLEN(es2, j);
425 if (skeylen == s2keylen)
426 difference = memcmp(HSTORE_KEY(es, ps, i),
427 HSTORE_KEY(es2, ps2, j),
428 skeylen);
429 else
430 difference = (skeylen > s2keylen) ? 1 : -1;
433 if (difference > 0)
434 ++j;
435 else if (difference == 0)
437 int svallen = HSTORE_VALLEN(es, i);
438 int snullval = HSTORE_VALISNULL(es, i);
440 if (snullval != HSTORE_VALISNULL(es2, j) ||
441 (!snullval && (svallen != HSTORE_VALLEN(es2, j) ||
442 memcmp(HSTORE_VAL(es, ps, i),
443 HSTORE_VAL(es2, ps2, j),
444 svallen) != 0)))
446 HS_COPYITEM(ed, bufd, pd,
447 HSTORE_KEY(es, ps, i), HSTORE_KEYLEN(es, i),
448 svallen, snullval);
449 ++outcount;
451 ++i, ++j;
453 else
455 HS_COPYITEM(ed, bufd, pd,
456 HSTORE_KEY(es, ps, i), HSTORE_KEYLEN(es, i),
457 HSTORE_VALLEN(es, i), HSTORE_VALISNULL(es, i));
458 ++outcount;
459 ++i;
463 HS_FINALIZE(out, outcount, bufd, pd);
465 PG_RETURN_POINTER(out);
469 PG_FUNCTION_INFO_V1(hstore_concat);
470 Datum
471 hstore_concat(PG_FUNCTION_ARGS)
473 HStore *s1 = PG_GETARG_HSTORE_P(0);
474 HStore *s2 = PG_GETARG_HSTORE_P(1);
475 HStore *out = palloc(VARSIZE(s1) + VARSIZE(s2));
476 char *ps1,
477 *ps2,
478 *bufd,
479 *pd;
480 HEntry *es1,
481 *es2,
482 *ed;
483 int s1idx;
484 int s2idx;
485 int s1count = HS_COUNT(s1);
486 int s2count = HS_COUNT(s2);
487 int outcount = 0;
489 SET_VARSIZE(out, VARSIZE(s1) + VARSIZE(s2) - HSHRDSIZE);
490 HS_SETCOUNT(out, s1count + s2count);
492 if (s1count == 0)
494 /* return a copy of the input, unchanged */
495 memcpy(out, s2, VARSIZE(s2));
496 HS_FIXSIZE(out, s2count);
497 HS_SETCOUNT(out, s2count);
498 PG_RETURN_POINTER(out);
501 if (s2count == 0)
503 /* return a copy of the input, unchanged */
504 memcpy(out, s1, VARSIZE(s1));
505 HS_FIXSIZE(out, s1count);
506 HS_SETCOUNT(out, s1count);
507 PG_RETURN_POINTER(out);
510 ps1 = STRPTR(s1);
511 ps2 = STRPTR(s2);
512 bufd = pd = STRPTR(out);
513 es1 = ARRPTR(s1);
514 es2 = ARRPTR(s2);
515 ed = ARRPTR(out);
518 * this is in effect a merge between s1 and s2, both of which are already
519 * sorted by (keylen,key); we take s2 for equal keys
522 for (s1idx = s2idx = 0; s1idx < s1count || s2idx < s2count; ++outcount)
524 int difference;
526 if (s1idx >= s1count)
527 difference = 1;
528 else if (s2idx >= s2count)
529 difference = -1;
530 else
532 int s1keylen = HSTORE_KEYLEN(es1, s1idx);
533 int s2keylen = HSTORE_KEYLEN(es2, s2idx);
535 if (s1keylen == s2keylen)
536 difference = memcmp(HSTORE_KEY(es1, ps1, s1idx),
537 HSTORE_KEY(es2, ps2, s2idx),
538 s1keylen);
539 else
540 difference = (s1keylen > s2keylen) ? 1 : -1;
543 if (difference >= 0)
545 HS_COPYITEM(ed, bufd, pd,
546 HSTORE_KEY(es2, ps2, s2idx), HSTORE_KEYLEN(es2, s2idx),
547 HSTORE_VALLEN(es2, s2idx), HSTORE_VALISNULL(es2, s2idx));
548 ++s2idx;
549 if (difference == 0)
550 ++s1idx;
552 else
554 HS_COPYITEM(ed, bufd, pd,
555 HSTORE_KEY(es1, ps1, s1idx), HSTORE_KEYLEN(es1, s1idx),
556 HSTORE_VALLEN(es1, s1idx), HSTORE_VALISNULL(es1, s1idx));
557 ++s1idx;
561 HS_FINALIZE(out, outcount, bufd, pd);
563 PG_RETURN_POINTER(out);
567 PG_FUNCTION_INFO_V1(hstore_slice_to_array);
568 Datum
569 hstore_slice_to_array(PG_FUNCTION_ARGS)
571 HStore *hs = PG_GETARG_HSTORE_P(0);
572 HEntry *entries = ARRPTR(hs);
573 char *ptr = STRPTR(hs);
574 ArrayType *key_array = PG_GETARG_ARRAYTYPE_P(1);
575 ArrayType *aout;
576 Datum *key_datums;
577 bool *key_nulls;
578 Datum *out_datums;
579 bool *out_nulls;
580 int key_count;
581 int i;
583 deconstruct_array_builtin(key_array, TEXTOID, &key_datums, &key_nulls, &key_count);
585 if (key_count == 0)
587 aout = construct_empty_array(TEXTOID);
588 PG_RETURN_POINTER(aout);
591 out_datums = palloc(sizeof(Datum) * key_count);
592 out_nulls = palloc(sizeof(bool) * key_count);
594 for (i = 0; i < key_count; ++i)
596 text *key = (text *) DatumGetPointer(key_datums[i]);
597 int idx;
599 if (key_nulls[i])
600 idx = -1;
601 else
602 idx = hstoreFindKey(hs, NULL, VARDATA(key), VARSIZE(key) - VARHDRSZ);
604 if (idx < 0 || HSTORE_VALISNULL(entries, idx))
606 out_nulls[i] = true;
607 out_datums[i] = (Datum) 0;
609 else
611 out_datums[i] =
612 PointerGetDatum(cstring_to_text_with_len(HSTORE_VAL(entries, ptr, idx),
613 HSTORE_VALLEN(entries, idx)));
614 out_nulls[i] = false;
618 aout = construct_md_array(out_datums, out_nulls,
619 ARR_NDIM(key_array),
620 ARR_DIMS(key_array),
621 ARR_LBOUND(key_array),
622 TEXTOID, -1, false, TYPALIGN_INT);
624 PG_RETURN_POINTER(aout);
628 PG_FUNCTION_INFO_V1(hstore_slice_to_hstore);
629 Datum
630 hstore_slice_to_hstore(PG_FUNCTION_ARGS)
632 HStore *hs = PG_GETARG_HSTORE_P(0);
633 HEntry *entries = ARRPTR(hs);
634 char *ptr = STRPTR(hs);
635 ArrayType *key_array = PG_GETARG_ARRAYTYPE_P(1);
636 HStore *out;
637 int nkeys;
638 Pairs *key_pairs = hstoreArrayToPairs(key_array, &nkeys);
639 Pairs *out_pairs;
640 int bufsiz;
641 int lastidx = 0;
642 int i;
643 int out_count = 0;
645 if (nkeys == 0)
647 out = hstorePairs(NULL, 0, 0);
648 PG_RETURN_POINTER(out);
651 /* hstoreArrayToPairs() checked overflow */
652 out_pairs = palloc(sizeof(Pairs) * nkeys);
653 bufsiz = 0;
656 * we exploit the fact that the pairs list is already sorted into strictly
657 * increasing order to narrow the hstoreFindKey search; each search can
658 * start one entry past the previous "found" entry, or at the lower bound
659 * of the last search.
662 for (i = 0; i < nkeys; ++i)
664 int idx = hstoreFindKey(hs, &lastidx,
665 key_pairs[i].key, key_pairs[i].keylen);
667 if (idx >= 0)
669 out_pairs[out_count].key = key_pairs[i].key;
670 bufsiz += (out_pairs[out_count].keylen = key_pairs[i].keylen);
671 out_pairs[out_count].val = HSTORE_VAL(entries, ptr, idx);
672 bufsiz += (out_pairs[out_count].vallen = HSTORE_VALLEN(entries, idx));
673 out_pairs[out_count].isnull = HSTORE_VALISNULL(entries, idx);
674 out_pairs[out_count].needfree = false;
675 ++out_count;
680 * we don't use hstoreUniquePairs here because we know that the pairs list
681 * is already sorted and uniq'ed.
684 out = hstorePairs(out_pairs, out_count, bufsiz);
686 PG_RETURN_POINTER(out);
690 PG_FUNCTION_INFO_V1(hstore_akeys);
691 Datum
692 hstore_akeys(PG_FUNCTION_ARGS)
694 HStore *hs = PG_GETARG_HSTORE_P(0);
695 Datum *d;
696 ArrayType *a;
697 HEntry *entries = ARRPTR(hs);
698 char *base = STRPTR(hs);
699 int count = HS_COUNT(hs);
700 int i;
702 if (count == 0)
704 a = construct_empty_array(TEXTOID);
705 PG_RETURN_POINTER(a);
708 d = (Datum *) palloc(sizeof(Datum) * count);
710 for (i = 0; i < count; ++i)
712 text *t = cstring_to_text_with_len(HSTORE_KEY(entries, base, i),
713 HSTORE_KEYLEN(entries, i));
715 d[i] = PointerGetDatum(t);
718 a = construct_array_builtin(d, count, TEXTOID);
720 PG_RETURN_POINTER(a);
724 PG_FUNCTION_INFO_V1(hstore_avals);
725 Datum
726 hstore_avals(PG_FUNCTION_ARGS)
728 HStore *hs = PG_GETARG_HSTORE_P(0);
729 Datum *d;
730 bool *nulls;
731 ArrayType *a;
732 HEntry *entries = ARRPTR(hs);
733 char *base = STRPTR(hs);
734 int count = HS_COUNT(hs);
735 int lb = 1;
736 int i;
738 if (count == 0)
740 a = construct_empty_array(TEXTOID);
741 PG_RETURN_POINTER(a);
744 d = (Datum *) palloc(sizeof(Datum) * count);
745 nulls = (bool *) palloc(sizeof(bool) * count);
747 for (i = 0; i < count; ++i)
749 if (HSTORE_VALISNULL(entries, i))
751 d[i] = (Datum) 0;
752 nulls[i] = true;
754 else
756 text *item = cstring_to_text_with_len(HSTORE_VAL(entries, base, i),
757 HSTORE_VALLEN(entries, i));
759 d[i] = PointerGetDatum(item);
760 nulls[i] = false;
764 a = construct_md_array(d, nulls, 1, &count, &lb,
765 TEXTOID, -1, false, TYPALIGN_INT);
767 PG_RETURN_POINTER(a);
771 static ArrayType *
772 hstore_to_array_internal(HStore *hs, int ndims)
774 HEntry *entries = ARRPTR(hs);
775 char *base = STRPTR(hs);
776 int count = HS_COUNT(hs);
777 int out_size[2] = {0, 2};
778 int lb[2] = {1, 1};
779 Datum *out_datums;
780 bool *out_nulls;
781 int i;
783 Assert(ndims < 3);
785 if (count == 0 || ndims == 0)
786 return construct_empty_array(TEXTOID);
788 out_size[0] = count * 2 / ndims;
789 out_datums = palloc(sizeof(Datum) * count * 2);
790 out_nulls = palloc(sizeof(bool) * count * 2);
792 for (i = 0; i < count; ++i)
794 text *key = cstring_to_text_with_len(HSTORE_KEY(entries, base, i),
795 HSTORE_KEYLEN(entries, i));
797 out_datums[i * 2] = PointerGetDatum(key);
798 out_nulls[i * 2] = false;
800 if (HSTORE_VALISNULL(entries, i))
802 out_datums[i * 2 + 1] = (Datum) 0;
803 out_nulls[i * 2 + 1] = true;
805 else
807 text *item = cstring_to_text_with_len(HSTORE_VAL(entries, base, i),
808 HSTORE_VALLEN(entries, i));
810 out_datums[i * 2 + 1] = PointerGetDatum(item);
811 out_nulls[i * 2 + 1] = false;
815 return construct_md_array(out_datums, out_nulls,
816 ndims, out_size, lb,
817 TEXTOID, -1, false, TYPALIGN_INT);
820 PG_FUNCTION_INFO_V1(hstore_to_array);
821 Datum
822 hstore_to_array(PG_FUNCTION_ARGS)
824 HStore *hs = PG_GETARG_HSTORE_P(0);
825 ArrayType *out = hstore_to_array_internal(hs, 1);
827 PG_RETURN_POINTER(out);
830 PG_FUNCTION_INFO_V1(hstore_to_matrix);
831 Datum
832 hstore_to_matrix(PG_FUNCTION_ARGS)
834 HStore *hs = PG_GETARG_HSTORE_P(0);
835 ArrayType *out = hstore_to_array_internal(hs, 2);
837 PG_RETURN_POINTER(out);
841 * Common initialization function for the various set-returning
842 * funcs. fcinfo is only passed if the function is to return a
843 * composite; it will be used to look up the return tupledesc.
844 * we stash a copy of the hstore in the multi-call context in
845 * case it was originally toasted. (At least I assume that's why;
846 * there was no explanatory comment in the original code. --AG)
849 static void
850 setup_firstcall(FuncCallContext *funcctx, HStore *hs,
851 FunctionCallInfo fcinfo)
853 MemoryContext oldcontext;
854 HStore *st;
856 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
858 st = (HStore *) palloc(VARSIZE(hs));
859 memcpy(st, hs, VARSIZE(hs));
861 funcctx->user_fctx = (void *) st;
863 if (fcinfo)
865 TupleDesc tupdesc;
867 /* Build a tuple descriptor for our result type */
868 if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
869 elog(ERROR, "return type must be a row type");
871 funcctx->tuple_desc = BlessTupleDesc(tupdesc);
874 MemoryContextSwitchTo(oldcontext);
878 PG_FUNCTION_INFO_V1(hstore_skeys);
879 Datum
880 hstore_skeys(PG_FUNCTION_ARGS)
882 FuncCallContext *funcctx;
883 HStore *hs;
884 int i;
886 if (SRF_IS_FIRSTCALL())
888 hs = PG_GETARG_HSTORE_P(0);
889 funcctx = SRF_FIRSTCALL_INIT();
890 setup_firstcall(funcctx, hs, NULL);
893 funcctx = SRF_PERCALL_SETUP();
894 hs = (HStore *) funcctx->user_fctx;
895 i = funcctx->call_cntr;
897 if (i < HS_COUNT(hs))
899 HEntry *entries = ARRPTR(hs);
900 text *item;
902 item = cstring_to_text_with_len(HSTORE_KEY(entries, STRPTR(hs), i),
903 HSTORE_KEYLEN(entries, i));
905 SRF_RETURN_NEXT(funcctx, PointerGetDatum(item));
908 SRF_RETURN_DONE(funcctx);
912 PG_FUNCTION_INFO_V1(hstore_svals);
913 Datum
914 hstore_svals(PG_FUNCTION_ARGS)
916 FuncCallContext *funcctx;
917 HStore *hs;
918 int i;
920 if (SRF_IS_FIRSTCALL())
922 hs = PG_GETARG_HSTORE_P(0);
923 funcctx = SRF_FIRSTCALL_INIT();
924 setup_firstcall(funcctx, hs, NULL);
927 funcctx = SRF_PERCALL_SETUP();
928 hs = (HStore *) funcctx->user_fctx;
929 i = funcctx->call_cntr;
931 if (i < HS_COUNT(hs))
933 HEntry *entries = ARRPTR(hs);
935 if (HSTORE_VALISNULL(entries, i))
937 ReturnSetInfo *rsi;
939 /* ugly ugly ugly. why no macro for this? */
940 (funcctx)->call_cntr++;
941 rsi = (ReturnSetInfo *) fcinfo->resultinfo;
942 rsi->isDone = ExprMultipleResult;
943 PG_RETURN_NULL();
945 else
947 text *item;
949 item = cstring_to_text_with_len(HSTORE_VAL(entries, STRPTR(hs), i),
950 HSTORE_VALLEN(entries, i));
952 SRF_RETURN_NEXT(funcctx, PointerGetDatum(item));
956 SRF_RETURN_DONE(funcctx);
960 PG_FUNCTION_INFO_V1(hstore_contains);
961 Datum
962 hstore_contains(PG_FUNCTION_ARGS)
964 HStore *val = PG_GETARG_HSTORE_P(0);
965 HStore *tmpl = PG_GETARG_HSTORE_P(1);
966 bool res = true;
967 HEntry *te = ARRPTR(tmpl);
968 char *tstr = STRPTR(tmpl);
969 HEntry *ve = ARRPTR(val);
970 char *vstr = STRPTR(val);
971 int tcount = HS_COUNT(tmpl);
972 int lastidx = 0;
973 int i;
976 * we exploit the fact that keys in "tmpl" are in strictly increasing
977 * order to narrow the hstoreFindKey search; each search can start one
978 * entry past the previous "found" entry, or at the lower bound of the
979 * search
982 for (i = 0; res && i < tcount; ++i)
984 int idx = hstoreFindKey(val, &lastidx,
985 HSTORE_KEY(te, tstr, i),
986 HSTORE_KEYLEN(te, i));
988 if (idx >= 0)
990 bool nullval = HSTORE_VALISNULL(te, i);
991 int vallen = HSTORE_VALLEN(te, i);
993 if (nullval != HSTORE_VALISNULL(ve, idx) ||
994 (!nullval && (vallen != HSTORE_VALLEN(ve, idx) ||
995 memcmp(HSTORE_VAL(te, tstr, i),
996 HSTORE_VAL(ve, vstr, idx),
997 vallen) != 0)))
998 res = false;
1000 else
1001 res = false;
1004 PG_RETURN_BOOL(res);
1008 PG_FUNCTION_INFO_V1(hstore_contained);
1009 Datum
1010 hstore_contained(PG_FUNCTION_ARGS)
1012 PG_RETURN_DATUM(DirectFunctionCall2(hstore_contains,
1013 PG_GETARG_DATUM(1),
1014 PG_GETARG_DATUM(0)
1019 PG_FUNCTION_INFO_V1(hstore_each);
1020 Datum
1021 hstore_each(PG_FUNCTION_ARGS)
1023 FuncCallContext *funcctx;
1024 HStore *hs;
1025 int i;
1027 if (SRF_IS_FIRSTCALL())
1029 hs = PG_GETARG_HSTORE_P(0);
1030 funcctx = SRF_FIRSTCALL_INIT();
1031 setup_firstcall(funcctx, hs, fcinfo);
1034 funcctx = SRF_PERCALL_SETUP();
1035 hs = (HStore *) funcctx->user_fctx;
1036 i = funcctx->call_cntr;
1038 if (i < HS_COUNT(hs))
1040 HEntry *entries = ARRPTR(hs);
1041 char *ptr = STRPTR(hs);
1042 Datum res,
1043 dvalues[2];
1044 bool nulls[2] = {false, false};
1045 text *item;
1046 HeapTuple tuple;
1048 item = cstring_to_text_with_len(HSTORE_KEY(entries, ptr, i),
1049 HSTORE_KEYLEN(entries, i));
1050 dvalues[0] = PointerGetDatum(item);
1052 if (HSTORE_VALISNULL(entries, i))
1054 dvalues[1] = (Datum) 0;
1055 nulls[1] = true;
1057 else
1059 item = cstring_to_text_with_len(HSTORE_VAL(entries, ptr, i),
1060 HSTORE_VALLEN(entries, i));
1061 dvalues[1] = PointerGetDatum(item);
1064 tuple = heap_form_tuple(funcctx->tuple_desc, dvalues, nulls);
1065 res = HeapTupleGetDatum(tuple);
1067 SRF_RETURN_NEXT(funcctx, res);
1070 SRF_RETURN_DONE(funcctx);
1075 * btree sort order for hstores isn't intended to be useful; we really only
1076 * care about equality versus non-equality. we compare the entire string
1077 * buffer first, then the entry pos array.
1080 PG_FUNCTION_INFO_V1(hstore_cmp);
1081 Datum
1082 hstore_cmp(PG_FUNCTION_ARGS)
1084 HStore *hs1 = PG_GETARG_HSTORE_P(0);
1085 HStore *hs2 = PG_GETARG_HSTORE_P(1);
1086 int hcount1 = HS_COUNT(hs1);
1087 int hcount2 = HS_COUNT(hs2);
1088 int res = 0;
1090 if (hcount1 == 0 || hcount2 == 0)
1093 * if either operand is empty, and the other is nonempty, the nonempty
1094 * one is larger. If both are empty they are equal.
1096 if (hcount1 > 0)
1097 res = 1;
1098 else if (hcount2 > 0)
1099 res = -1;
1101 else
1103 /* here we know both operands are nonempty */
1104 char *str1 = STRPTR(hs1);
1105 char *str2 = STRPTR(hs2);
1106 HEntry *ent1 = ARRPTR(hs1);
1107 HEntry *ent2 = ARRPTR(hs2);
1108 size_t len1 = HSE_ENDPOS(ent1[2 * hcount1 - 1]);
1109 size_t len2 = HSE_ENDPOS(ent2[2 * hcount2 - 1]);
1111 res = memcmp(str1, str2, Min(len1, len2));
1113 if (res == 0)
1115 if (len1 > len2)
1116 res = 1;
1117 else if (len1 < len2)
1118 res = -1;
1119 else if (hcount1 > hcount2)
1120 res = 1;
1121 else if (hcount2 > hcount1)
1122 res = -1;
1123 else
1125 int count = hcount1 * 2;
1126 int i;
1128 for (i = 0; i < count; ++i)
1129 if (HSE_ENDPOS(ent1[i]) != HSE_ENDPOS(ent2[i]) ||
1130 HSE_ISNULL(ent1[i]) != HSE_ISNULL(ent2[i]))
1131 break;
1132 if (i < count)
1134 if (HSE_ENDPOS(ent1[i]) < HSE_ENDPOS(ent2[i]))
1135 res = -1;
1136 else if (HSE_ENDPOS(ent1[i]) > HSE_ENDPOS(ent2[i]))
1137 res = 1;
1138 else if (HSE_ISNULL(ent1[i]))
1139 res = 1;
1140 else if (HSE_ISNULL(ent2[i]))
1141 res = -1;
1145 else
1147 res = (res > 0) ? 1 : -1;
1152 * this is a btree support function; this is one of the few places where
1153 * memory needs to be explicitly freed.
1155 PG_FREE_IF_COPY(hs1, 0);
1156 PG_FREE_IF_COPY(hs2, 1);
1157 PG_RETURN_INT32(res);
1161 PG_FUNCTION_INFO_V1(hstore_eq);
1162 Datum
1163 hstore_eq(PG_FUNCTION_ARGS)
1165 int res = DatumGetInt32(DirectFunctionCall2(hstore_cmp,
1166 PG_GETARG_DATUM(0),
1167 PG_GETARG_DATUM(1)));
1169 PG_RETURN_BOOL(res == 0);
1172 PG_FUNCTION_INFO_V1(hstore_ne);
1173 Datum
1174 hstore_ne(PG_FUNCTION_ARGS)
1176 int res = DatumGetInt32(DirectFunctionCall2(hstore_cmp,
1177 PG_GETARG_DATUM(0),
1178 PG_GETARG_DATUM(1)));
1180 PG_RETURN_BOOL(res != 0);
1183 PG_FUNCTION_INFO_V1(hstore_gt);
1184 Datum
1185 hstore_gt(PG_FUNCTION_ARGS)
1187 int res = DatumGetInt32(DirectFunctionCall2(hstore_cmp,
1188 PG_GETARG_DATUM(0),
1189 PG_GETARG_DATUM(1)));
1191 PG_RETURN_BOOL(res > 0);
1194 PG_FUNCTION_INFO_V1(hstore_ge);
1195 Datum
1196 hstore_ge(PG_FUNCTION_ARGS)
1198 int res = DatumGetInt32(DirectFunctionCall2(hstore_cmp,
1199 PG_GETARG_DATUM(0),
1200 PG_GETARG_DATUM(1)));
1202 PG_RETURN_BOOL(res >= 0);
1205 PG_FUNCTION_INFO_V1(hstore_lt);
1206 Datum
1207 hstore_lt(PG_FUNCTION_ARGS)
1209 int res = DatumGetInt32(DirectFunctionCall2(hstore_cmp,
1210 PG_GETARG_DATUM(0),
1211 PG_GETARG_DATUM(1)));
1213 PG_RETURN_BOOL(res < 0);
1216 PG_FUNCTION_INFO_V1(hstore_le);
1217 Datum
1218 hstore_le(PG_FUNCTION_ARGS)
1220 int res = DatumGetInt32(DirectFunctionCall2(hstore_cmp,
1221 PG_GETARG_DATUM(0),
1222 PG_GETARG_DATUM(1)));
1224 PG_RETURN_BOOL(res <= 0);
1228 PG_FUNCTION_INFO_V1(hstore_hash);
1229 Datum
1230 hstore_hash(PG_FUNCTION_ARGS)
1232 HStore *hs = PG_GETARG_HSTORE_P(0);
1233 Datum hval = hash_any((unsigned char *) VARDATA(hs),
1234 VARSIZE(hs) - VARHDRSZ);
1237 * This (along with hstore_hash_extended) is the only place in the code
1238 * that cares whether the overall varlena size exactly matches the true
1239 * data size; this assertion should be maintained by all the other code,
1240 * but we make it explicit here.
1242 Assert(VARSIZE(hs) ==
1243 (HS_COUNT(hs) != 0 ?
1244 CALCDATASIZE(HS_COUNT(hs),
1245 HSE_ENDPOS(ARRPTR(hs)[2 * HS_COUNT(hs) - 1])) :
1246 HSHRDSIZE));
1248 PG_FREE_IF_COPY(hs, 0);
1249 PG_RETURN_DATUM(hval);
1252 PG_FUNCTION_INFO_V1(hstore_hash_extended);
1253 Datum
1254 hstore_hash_extended(PG_FUNCTION_ARGS)
1256 HStore *hs = PG_GETARG_HSTORE_P(0);
1257 uint64 seed = PG_GETARG_INT64(1);
1258 Datum hval;
1260 hval = hash_any_extended((unsigned char *) VARDATA(hs),
1261 VARSIZE(hs) - VARHDRSZ,
1262 seed);
1264 /* See comment in hstore_hash */
1265 Assert(VARSIZE(hs) ==
1266 (HS_COUNT(hs) != 0 ?
1267 CALCDATASIZE(HS_COUNT(hs),
1268 HSE_ENDPOS(ARRPTR(hs)[2 * HS_COUNT(hs) - 1])) :
1269 HSHRDSIZE));
1271 PG_FREE_IF_COPY(hs, 0);
1272 PG_RETURN_DATUM(hval);