Age Owner Branch data TLA Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * tsginidx.c
4 : : * GIN support functions for tsvector_ops
5 : : *
6 : : * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
7 : : *
8 : : *
9 : : * IDENTIFICATION
10 : : * src/backend/utils/adt/tsginidx.c
11 : : *
12 : : *-------------------------------------------------------------------------
13 : : */
14 : : #include "postgres.h"
15 : :
16 : : #include "access/gin.h"
17 : : #include "tsearch/ts_type.h"
18 : : #include "tsearch/ts_utils.h"
19 : : #include "utils/builtins.h"
20 : : #include "varatt.h"
21 : :
22 : :
23 : : Datum
5812 tgl@sss.pgh.pa.us 24 :CBC 905094 : gin_cmp_tslexeme(PG_FUNCTION_ARGS)
25 : : {
5421 bruce@momjian.us 26 : 905094 : text *a = PG_GETARG_TEXT_PP(0);
27 : 905094 : text *b = PG_GETARG_TEXT_PP(1);
28 : : int cmp;
29 : :
4844 tgl@sss.pgh.pa.us 30 [ - + - - : 1810188 : cmp = tsCompareString(VARDATA_ANY(a), VARSIZE_ANY_EXHDR(a),
- - - - +
+ + + ]
5421 bruce@momjian.us 31 [ - + - - : 1810188 : VARDATA_ANY(b), VARSIZE_ANY_EXHDR(b),
- - - - +
+ + + ]
32 : : false);
33 : :
34 [ - + ]: 905094 : PG_FREE_IF_COPY(a, 0);
35 [ - + ]: 905094 : PG_FREE_IF_COPY(b, 1);
36 : 905094 : PG_RETURN_INT32(cmp);
37 : : }
38 : :
39 : : Datum
5812 tgl@sss.pgh.pa.us 40 : 222 : gin_cmp_prefix(PG_FUNCTION_ARGS)
41 : : {
5421 bruce@momjian.us 42 : 222 : text *a = PG_GETARG_TEXT_PP(0);
43 : 222 : text *b = PG_GETARG_TEXT_PP(1);
44 : :
45 : : #ifdef NOT_USED
46 : : StrategyNumber strategy = PG_GETARG_UINT16(2);
47 : : Pointer extra_data = PG_GETARG_POINTER(3);
48 : : #endif
49 : : int cmp;
50 : :
4844 tgl@sss.pgh.pa.us 51 [ - + - - : 444 : cmp = tsCompareString(VARDATA_ANY(a), VARSIZE_ANY_EXHDR(a),
- - - - -
+ - + ]
5421 bruce@momjian.us 52 [ - + - - : 444 : VARDATA_ANY(b), VARSIZE_ANY_EXHDR(b),
- - - - +
- + - ]
53 : : true);
54 : :
55 [ + + ]: 222 : if (cmp < 0)
56 : 6 : cmp = 1; /* prevent continue scan */
57 : :
58 [ - + ]: 222 : PG_FREE_IF_COPY(a, 0);
59 [ - + ]: 222 : PG_FREE_IF_COPY(b, 1);
60 : 222 : PG_RETURN_INT32(cmp);
61 : : }
62 : :
63 : : Datum
6081 tgl@sss.pgh.pa.us 64 : 1548 : gin_extract_tsvector(PG_FUNCTION_ARGS)
65 : : {
66 : 1548 : TSVector vector = PG_GETARG_TSVECTOR(0);
6064 teodor@sigaev.ru 67 : 1548 : int32 *nentries = (int32 *) PG_GETARG_POINTER(1);
6081 tgl@sss.pgh.pa.us 68 : 1548 : Datum *entries = NULL;
69 : :
6060 teodor@sigaev.ru 70 : 1548 : *nentries = vector->size;
6081 tgl@sss.pgh.pa.us 71 [ + + ]: 1548 : if (vector->size > 0)
72 : : {
73 : : int i;
74 : 1521 : WordEntry *we = ARRPTR(vector);
75 : :
76 : 1521 : entries = (Datum *) palloc(sizeof(Datum) * vector->size);
77 : :
78 [ + + ]: 87987 : for (i = 0; i < vector->size; i++)
79 : : {
80 : : text *txt;
81 : :
5864 82 : 86466 : txt = cstring_to_text_with_len(STRPTR(vector) + we->pos, we->len);
6081 83 : 86466 : entries[i] = PointerGetDatum(txt);
84 : :
85 : 86466 : we++;
86 : : }
87 : : }
88 : :
89 [ + + ]: 1548 : PG_FREE_IF_COPY(vector, 0);
90 : 1548 : PG_RETURN_POINTER(entries);
91 : : }
92 : :
93 : : Datum
5982 94 : 225 : gin_extract_tsquery(PG_FUNCTION_ARGS)
95 : : {
6081 96 : 225 : TSQuery query = PG_GETARG_TSQUERY(0);
6064 teodor@sigaev.ru 97 : 225 : int32 *nentries = (int32 *) PG_GETARG_POINTER(1);
98 : :
99 : : /* StrategyNumber strategy = PG_GETARG_UINT16(2); */
5421 bruce@momjian.us 100 : 225 : bool **ptr_partialmatch = (bool **) PG_GETARG_POINTER(3);
101 : 225 : Pointer **extra_data = (Pointer **) PG_GETARG_POINTER(4);
102 : :
103 : : /* bool **nullFlags = (bool **) PG_GETARG_POINTER(5); */
4844 tgl@sss.pgh.pa.us 104 : 225 : int32 *searchMode = (int32 *) PG_GETARG_POINTER(6);
6081 105 : 225 : Datum *entries = NULL;
106 : :
107 : 225 : *nentries = 0;
108 : :
109 [ + - ]: 225 : if (query->size > 0)
110 : : {
4844 111 : 225 : QueryItem *item = GETQUERY(query);
112 : : int32 i,
113 : : j;
114 : : bool *partialmatch;
115 : : int *map_item_operand;
116 : :
117 : : /*
118 : : * If the query doesn't have any required positive matches (for
119 : : * instance, it's something like '! foo'), we have to do a full index
120 : : * scan.
121 : : */
122 [ + + ]: 225 : if (tsquery_requires_match(item))
123 : 165 : *searchMode = GIN_SEARCH_MODE_DEFAULT;
124 : : else
125 : 60 : *searchMode = GIN_SEARCH_MODE_ALL;
126 : :
127 : : /* count number of VAL items */
128 : 225 : j = 0;
6081 129 [ + + ]: 852 : for (i = 0; i < query->size; i++)
130 : : {
6064 teodor@sigaev.ru 131 [ + + ]: 627 : if (item[i].type == QI_VAL)
4844 tgl@sss.pgh.pa.us 132 : 384 : j++;
133 : : }
134 : 225 : *nentries = j;
135 : :
136 : 225 : entries = (Datum *) palloc(sizeof(Datum) * j);
137 : 225 : partialmatch = *ptr_partialmatch = (bool *) palloc(sizeof(bool) * j);
138 : :
139 : : /*
140 : : * Make map to convert item's number to corresponding operand's (the
141 : : * same, entry's) number. Entry's number is used in check array in
142 : : * consistent method. We use the same map for each entry.
143 : : */
144 : 225 : *extra_data = (Pointer *) palloc(sizeof(Pointer) * j);
145 : 225 : map_item_operand = (int *) palloc0(sizeof(int) * query->size);
146 : :
147 : : /* Now rescan the VAL items and fill in the arrays */
148 : 225 : j = 0;
6081 149 [ + + ]: 852 : for (i = 0; i < query->size; i++)
150 : : {
6064 teodor@sigaev.ru 151 [ + + ]: 627 : if (item[i].type == QI_VAL)
152 : : {
5386 peter_e@gmx.net 153 : 384 : QueryOperand *val = &item[i].qoperand;
154 : : text *txt;
155 : :
5864 tgl@sss.pgh.pa.us 156 : 384 : txt = cstring_to_text_with_len(GETOPERAND(query) + val->distance,
157 : 384 : val->length);
4844 158 : 384 : entries[j] = PointerGetDatum(txt);
159 : 384 : partialmatch[j] = val->prefix;
5421 bruce@momjian.us 160 : 384 : (*extra_data)[j] = (Pointer) map_item_operand;
5499 tgl@sss.pgh.pa.us 161 : 384 : map_item_operand[i] = j;
4844 162 : 384 : j++;
163 : : }
164 : : }
165 : : }
166 : :
6081 167 [ - + ]: 225 : PG_FREE_IF_COPY(query, 0);
168 : :
169 : 225 : PG_RETURN_POINTER(entries);
170 : : }
171 : :
172 : : typedef struct
173 : : {
174 : : QueryItem *first_item;
175 : : GinTernaryValue *check;
176 : : int *map_item_operand;
177 : : } GinChkVal;
178 : :
179 : : /*
180 : : * TS_execute callback for matching a tsquery operand to GIN index data
181 : : */
182 : : static TSTernaryValue
1360 183 : 24183 : checkcondition_gin(void *checkval, QueryOperand *val, ExecPhraseData *data)
184 : : {
185 : 24183 : GinChkVal *gcv = (GinChkVal *) checkval;
186 : : int j;
187 : : GinTernaryValue result;
188 : :
189 : : /* convert item's number to corresponding entry's (operand's) number */
5421 bruce@momjian.us 190 : 24183 : j = gcv->map_item_operand[((QueryItem *) val) - gcv->first_item];
191 : :
192 : : /* determine presence of current entry in indexed value */
1153 tgl@sss.pgh.pa.us 193 : 24183 : result = gcv->check[j];
194 : :
195 : : /*
196 : : * If any val requiring a weight is used or caller needs position
197 : : * information then we must recheck, so replace TRUE with MAYBE.
198 : : */
199 [ + + ]: 24183 : if (result == GIN_TRUE)
200 : : {
1360 201 [ + + + + ]: 7827 : if (val->weight != 0 || data != NULL)
1153 202 : 3249 : result = GIN_MAYBE;
203 : : }
204 : :
205 : : /*
206 : : * We rely on GinTernaryValue and TSTernaryValue using equivalent value
207 : : * assignments. We could use a switch statement to map the values if that
208 : : * ever stops being true, but it seems unlikely to happen.
209 : : */
210 : 24183 : return (TSTernaryValue) result;
211 : : }
212 : :
213 : : Datum
5982 214 : 12 : gin_tsquery_consistent(PG_FUNCTION_ARGS)
215 : : {
6081 216 : 12 : bool *check = (bool *) PG_GETARG_POINTER(0);
217 : :
218 : : /* StrategyNumber strategy = PG_GETARG_UINT16(1); */
219 : 12 : TSQuery query = PG_GETARG_TSQUERY(2);
220 : :
221 : : /* int32 nkeys = PG_GETARG_INT32(3); */
5421 bruce@momjian.us 222 : 12 : Pointer *extra_data = (Pointer *) PG_GETARG_POINTER(4);
5499 tgl@sss.pgh.pa.us 223 : 12 : bool *recheck = (bool *) PG_GETARG_POINTER(5);
2433 peter_e@gmx.net 224 : 12 : bool res = false;
225 : :
226 : : /* Initially assume query doesn't require recheck */
5844 tgl@sss.pgh.pa.us 227 : 12 : *recheck = false;
228 : :
6081 229 [ + - ]: 12 : if (query->size > 0)
230 : : {
231 : : GinChkVal gcv;
232 : :
233 : : /*
234 : : * check-parameter array has one entry for each value (operand) in the
235 : : * query.
236 : : */
2676 237 : 12 : gcv.first_item = GETQUERY(query);
2215 peter_e@gmx.net 238 : 12 : gcv.check = (GinTernaryValue *) check;
5421 bruce@momjian.us 239 : 12 : gcv.map_item_operand = (int *) (extra_data[0]);
240 : :
1153 tgl@sss.pgh.pa.us 241 [ - + - - ]: 12 : switch (TS_execute_ternary(GETQUERY(query),
242 : : &gcv,
243 : : TS_EXEC_PHRASE_NO_POS,
244 : : checkcondition_gin))
245 : : {
1153 tgl@sss.pgh.pa.us 246 :UBC 0 : case TS_NO:
247 : 0 : res = false;
248 : 0 : break;
1153 tgl@sss.pgh.pa.us 249 :CBC 12 : case TS_YES:
250 : 12 : res = true;
251 : 12 : break;
1153 tgl@sss.pgh.pa.us 252 :UBC 0 : case TS_MAYBE:
253 : 0 : res = true;
254 : 0 : *recheck = true;
255 : 0 : break;
256 : : }
257 : : }
258 : :
6081 tgl@sss.pgh.pa.us 259 :CBC 12 : PG_RETURN_BOOL(res);
260 : : }
261 : :
262 : : Datum
3686 heikki.linnakangas@i 263 : 18459 : gin_tsquery_triconsistent(PG_FUNCTION_ARGS)
264 : : {
3667 265 : 18459 : GinTernaryValue *check = (GinTernaryValue *) PG_GETARG_POINTER(0);
266 : :
267 : : /* StrategyNumber strategy = PG_GETARG_UINT16(1); */
3686 268 : 18459 : TSQuery query = PG_GETARG_TSQUERY(2);
269 : :
270 : : /* int32 nkeys = PG_GETARG_INT32(3); */
271 : 18459 : Pointer *extra_data = (Pointer *) PG_GETARG_POINTER(4);
3667 272 : 18459 : GinTernaryValue res = GIN_FALSE;
273 : :
3686 274 [ + - ]: 18459 : if (query->size > 0)
275 : : {
276 : : GinChkVal gcv;
277 : :
278 : : /*
279 : : * check-parameter array has one entry for each value (operand) in the
280 : : * query.
281 : : */
2676 tgl@sss.pgh.pa.us 282 : 18459 : gcv.first_item = GETQUERY(query);
3686 heikki.linnakangas@i 283 : 18459 : gcv.check = check;
284 : 18459 : gcv.map_item_operand = (int *) (extra_data[0]);
285 : :
1153 tgl@sss.pgh.pa.us 286 : 18459 : res = TS_execute_ternary(GETQUERY(query),
287 : : &gcv,
288 : : TS_EXEC_PHRASE_NO_POS,
289 : : checkcondition_gin);
290 : : }
291 : :
3667 heikki.linnakangas@i 292 : 18459 : PG_RETURN_GIN_TERNARY_VALUE(res);
293 : : }
294 : :
295 : : /*
296 : : * Formerly, gin_extract_tsvector had only two arguments. Now it has three,
297 : : * but we still need a pg_proc entry with two args to support reloading
298 : : * pre-9.1 contrib/tsearch2 opclass declarations. This compatibility
299 : : * function should go away eventually. (Note: you might say "hey, but the
300 : : * code above is only *using* two args, so let's just declare it that way".
301 : : * If you try that you'll find the opr_sanity regression test complains.)
302 : : */
303 : : Datum
4806 tgl@sss.pgh.pa.us 304 :UBC 0 : gin_extract_tsvector_2args(PG_FUNCTION_ARGS)
305 : : {
306 [ # # ]: 0 : if (PG_NARGS() < 3) /* should not happen */
307 [ # # ]: 0 : elog(ERROR, "gin_extract_tsvector requires three arguments");
308 : 0 : return gin_extract_tsvector(fcinfo);
309 : : }
310 : :
311 : : /*
312 : : * Likewise, we need a stub version of gin_extract_tsquery declared with
313 : : * only five arguments.
314 : : */
315 : : Datum
316 : 0 : gin_extract_tsquery_5args(PG_FUNCTION_ARGS)
317 : : {
318 [ # # ]: 0 : if (PG_NARGS() < 7) /* should not happen */
319 [ # # ]: 0 : elog(ERROR, "gin_extract_tsquery requires seven arguments");
320 : 0 : return gin_extract_tsquery(fcinfo);
321 : : }
322 : :
323 : : /*
324 : : * Likewise, we need a stub version of gin_tsquery_consistent declared with
325 : : * only six arguments.
326 : : */
327 : : Datum
328 : 0 : gin_tsquery_consistent_6args(PG_FUNCTION_ARGS)
329 : : {
330 [ # # ]: 0 : if (PG_NARGS() < 8) /* should not happen */
331 [ # # ]: 0 : elog(ERROR, "gin_tsquery_consistent requires eight arguments");
332 : 0 : return gin_tsquery_consistent(fcinfo);
333 : : }
334 : :
335 : : /*
336 : : * Likewise, a stub version of gin_extract_tsquery declared with argument
337 : : * types that are no longer considered appropriate.
338 : : */
339 : : Datum
2965 340 : 0 : gin_extract_tsquery_oldsig(PG_FUNCTION_ARGS)
341 : : {
342 : 0 : return gin_extract_tsquery(fcinfo);
343 : : }
344 : :
345 : : /*
346 : : * Likewise, a stub version of gin_tsquery_consistent declared with argument
347 : : * types that are no longer considered appropriate.
348 : : */
349 : : Datum
350 : 0 : gin_tsquery_consistent_oldsig(PG_FUNCTION_ARGS)
351 : : {
352 : 0 : return gin_tsquery_consistent(fcinfo);
353 : : }
|
