Age Owner Branch data TLA Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * extended_stats_funcs.c
4 : : * Functions for manipulating extended statistics.
5 : : *
6 : : * This file includes the set of facilities required to support the direct
7 : : * manipulations of extended statistics objects.
8 : : *
9 : : * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
10 : : * Portions Copyright (c) 1994, Regents of the University of California
11 : : *
12 : : * IDENTIFICATION
13 : : * src/backend/statistics/extended_stats_funcs.c
14 : : *
15 : : *-------------------------------------------------------------------------
16 : : */
17 : : #include "postgres.h"
18 : :
19 : : #include "access/heapam.h"
20 : : #include "catalog/indexing.h"
21 : : #include "catalog/namespace.h"
22 : : #include "catalog/pg_collation_d.h"
23 : : #include "catalog/pg_database.h"
24 : : #include "catalog/pg_operator.h"
25 : : #include "catalog/pg_statistic_ext.h"
26 : : #include "catalog/pg_statistic_ext_data.h"
27 : : #include "miscadmin.h"
28 : : #include "nodes/makefuncs.h"
29 : : #include "nodes/nodeFuncs.h"
30 : : #include "optimizer/optimizer.h"
31 : : #include "statistics/extended_stats_internal.h"
32 : : #include "statistics/stat_utils.h"
33 : : #include "utils/acl.h"
34 : : #include "utils/array.h"
35 : : #include "utils/builtins.h"
36 : : #include "utils/fmgroids.h"
37 : : #include "utils/jsonb.h"
38 : : #include "utils/lsyscache.h"
39 : : #include "utils/syscache.h"
40 : : #include "utils/typcache.h"
41 : :
42 : :
43 : : /*
44 : : * Index of the arguments for the SQL functions.
45 : : */
46 : : enum extended_stats_argnum
47 : : {
48 : : RELSCHEMA_ARG = 0,
49 : : RELNAME_ARG,
50 : : STATSCHEMA_ARG,
51 : : STATNAME_ARG,
52 : : INHERITED_ARG,
53 : : NDISTINCT_ARG,
54 : : DEPENDENCIES_ARG,
55 : : MOST_COMMON_VALS_ARG,
56 : : MOST_COMMON_FREQS_ARG,
57 : : MOST_COMMON_BASE_FREQS_ARG,
58 : : EXPRESSIONS_ARG,
59 : : NUM_EXTENDED_STATS_ARGS,
60 : : };
61 : :
62 : : /*
63 : : * The argument names and type OIDs of the arguments for the SQL
64 : : * functions.
65 : : */
66 : : static struct StatsArgInfo extarginfo[] =
67 : : {
68 : : [RELSCHEMA_ARG] = {"schemaname", TEXTOID},
69 : : [RELNAME_ARG] = {"relname", TEXTOID},
70 : : [STATSCHEMA_ARG] = {"statistics_schemaname", TEXTOID},
71 : : [STATNAME_ARG] = {"statistics_name", TEXTOID},
72 : : [INHERITED_ARG] = {"inherited", BOOLOID},
73 : : [NDISTINCT_ARG] = {"n_distinct", PG_NDISTINCTOID},
74 : : [DEPENDENCIES_ARG] = {"dependencies", PG_DEPENDENCIESOID},
75 : : [MOST_COMMON_VALS_ARG] = {"most_common_vals", TEXTARRAYOID},
76 : : [MOST_COMMON_FREQS_ARG] = {"most_common_freqs", FLOAT8ARRAYOID},
77 : : [MOST_COMMON_BASE_FREQS_ARG] = {"most_common_base_freqs", FLOAT8ARRAYOID},
78 : : [EXPRESSIONS_ARG] = {"exprs", JSONBOID},
79 : : [NUM_EXTENDED_STATS_ARGS] = {0},
80 : : };
81 : :
82 : : /*
83 : : * An index of the elements of a stxdexpr Datum, which repeat for each
84 : : * expression in the extended statistics object.
85 : : */
86 : : enum extended_stats_exprs_element
87 : : {
88 : : NULL_FRAC_ELEM = 0,
89 : : AVG_WIDTH_ELEM,
90 : : N_DISTINCT_ELEM,
91 : : MOST_COMMON_VALS_ELEM,
92 : : MOST_COMMON_FREQS_ELEM,
93 : : HISTOGRAM_BOUNDS_ELEM,
94 : : CORRELATION_ELEM,
95 : : MOST_COMMON_ELEMS_ELEM,
96 : : MOST_COMMON_ELEM_FREQS_ELEM,
97 : : ELEM_COUNT_HISTOGRAM_ELEM,
98 : : RANGE_LENGTH_HISTOGRAM_ELEM,
99 : : RANGE_EMPTY_FRAC_ELEM,
100 : : RANGE_BOUNDS_HISTOGRAM_ELEM,
101 : : NUM_ATTRIBUTE_STATS_ELEMS
102 : : };
103 : :
104 : : /*
105 : : * The argument names of the repeating arguments for stxdexpr.
106 : : */
107 : : static const char *extexprargname[NUM_ATTRIBUTE_STATS_ELEMS] =
108 : : {
109 : : "null_frac",
110 : : "avg_width",
111 : : "n_distinct",
112 : : "most_common_vals",
113 : : "most_common_freqs",
114 : : "histogram_bounds",
115 : : "correlation",
116 : : "most_common_elems",
117 : : "most_common_elem_freqs",
118 : : "elem_count_histogram",
119 : : "range_length_histogram",
120 : : "range_empty_frac",
121 : : "range_bounds_histogram"
122 : : };
123 : :
124 : : static bool extended_statistics_update(FunctionCallInfo fcinfo);
125 : :
126 : : static HeapTuple get_pg_statistic_ext(Relation pg_stext, Oid nspoid,
127 : : const char *stxname);
128 : : static bool delete_pg_statistic_ext_data(Oid stxoid, bool inherited);
129 : :
130 : : /*
131 : : * Track the extended statistics kinds expected for a pg_statistic_ext
132 : : * tuple.
133 : : */
134 : : typedef struct
135 : : {
136 : : bool ndistinct;
137 : : bool dependencies;
138 : : bool mcv;
139 : : bool expressions;
140 : : } StakindFlags;
141 : :
142 : : static void expand_stxkind(HeapTuple tup, StakindFlags *enabled);
143 : : static void upsert_pg_statistic_ext_data(const Datum *values,
144 : : const bool *nulls,
145 : : const bool *replaces);
146 : :
147 : : static bool check_mcvlist_array(const ArrayType *arr, int argindex,
148 : : int required_ndims, int mcv_length);
149 : : static Datum import_expressions(Relation pgsd, int numexprs,
150 : : Oid *atttypids, int32 *atttypmods,
151 : : Oid *atttypcolls, Jsonb *exprs_jsonb,
152 : : bool *exprs_is_perfect);
153 : : static Datum import_mcv(const ArrayType *mcv_arr,
154 : : const ArrayType *freqs_arr,
155 : : const ArrayType *base_freqs_arr,
156 : : Oid *atttypids, int32 *atttypmods,
157 : : Oid *atttypcolls, int numattrs,
158 : : bool *ok);
159 : :
160 : : static char *jbv_string_get_cstr(JsonbValue *jval);
161 : : static bool jbv_to_infunc_datum(JsonbValue *jval, PGFunction func,
162 : : AttrNumber exprnum, const char *argname,
163 : : Datum *datum);
164 : : static bool key_in_expr_argnames(JsonbValue *key);
165 : : static bool check_all_expr_argnames_valid(JsonbContainer *cont, AttrNumber exprnum);
166 : : static Datum array_in_safe(FmgrInfo *array_in, const char *s, Oid typid,
167 : : int32 typmod, AttrNumber exprnum,
168 : : const char *element_name, bool *ok);
169 : : static Datum import_pg_statistic(Relation pgsd, JsonbContainer *cont,
170 : : AttrNumber exprnum, FmgrInfo *array_in_fn,
171 : : Oid typid, int32 typmod, Oid typcoll,
172 : : bool *pg_statistic_ok);
173 : :
174 : : /*
175 : : * Fetch a pg_statistic_ext row by name and namespace OID.
176 : : */
177 : : static HeapTuple
165 michael@paquier.xyz 178 :GNC 300 : get_pg_statistic_ext(Relation pg_stext, Oid nspoid, const char *stxname)
179 : : {
180 : : ScanKeyData key[2];
181 : : SysScanDesc scan;
182 : : HeapTuple tup;
183 : 300 : Oid stxoid = InvalidOid;
184 : :
185 : 300 : ScanKeyInit(&key[0],
186 : : Anum_pg_statistic_ext_stxname,
187 : : BTEqualStrategyNumber,
188 : : F_NAMEEQ,
189 : : CStringGetDatum(stxname));
190 : 300 : ScanKeyInit(&key[1],
191 : : Anum_pg_statistic_ext_stxnamespace,
192 : : BTEqualStrategyNumber,
193 : : F_OIDEQ,
194 : : ObjectIdGetDatum(nspoid));
195 : :
196 : : /*
197 : : * Try to find matching pg_statistic_ext row.
198 : : */
199 : 300 : scan = systable_beginscan(pg_stext,
200 : : StatisticExtNameIndexId,
201 : : true,
202 : : NULL,
203 : : 2,
204 : : key);
205 : :
206 : : /* Lookup is based on a unique index, so we get either 0 or 1 tuple. */
207 : 300 : tup = systable_getnext(scan);
208 : :
209 [ + + ]: 300 : if (HeapTupleIsValid(tup))
210 : 292 : stxoid = ((Form_pg_statistic_ext) GETSTRUCT(tup))->oid;
211 : :
212 : 300 : systable_endscan(scan);
213 : :
214 [ + + ]: 300 : if (!OidIsValid(stxoid))
215 : 8 : return NULL;
216 : :
217 : 292 : return SearchSysCacheCopy1(STATEXTOID, ObjectIdGetDatum(stxoid));
218 : : }
219 : :
220 : : /*
221 : : * Decode the stxkind column so that we know which stats types to expect,
222 : : * returning a StakindFlags set depending on the stats kinds expected by
223 : : * a pg_statistic_ext tuple.
224 : : */
225 : : static void
155 226 : 272 : expand_stxkind(HeapTuple tup, StakindFlags *enabled)
227 : : {
228 : : Datum datum;
229 : : ArrayType *arr;
230 : : char *kinds;
231 : :
232 : 272 : datum = SysCacheGetAttrNotNull(STATEXTOID,
233 : : tup,
234 : : Anum_pg_statistic_ext_stxkind);
235 : 272 : arr = DatumGetArrayTypeP(datum);
236 [ + - + - : 272 : if (ARR_NDIM(arr) != 1 || ARR_HASNULL(arr) || ARR_ELEMTYPE(arr) != CHAROID)
- + ]
155 michael@paquier.xyz 237 [ # # ]:UNC 0 : elog(ERROR, "stxkind is not a one-dimension char array");
238 : :
155 michael@paquier.xyz 239 [ - + ]:GNC 272 : kinds = (char *) ARR_DATA_PTR(arr);
240 : :
241 [ + + ]: 1105 : for (int i = 0; i < ARR_DIMS(arr)[0]; i++)
242 : : {
243 [ + + + + : 833 : switch (kinds[i])
- ]
244 : : {
245 : 204 : case STATS_EXT_NDISTINCT:
246 : 204 : enabled->ndistinct = true;
247 : 204 : break;
248 : 205 : case STATS_EXT_DEPENDENCIES:
249 : 205 : enabled->dependencies = true;
250 : 205 : break;
251 : 223 : case STATS_EXT_MCV:
252 : 223 : enabled->mcv = true;
253 : 223 : break;
254 : 201 : case STATS_EXT_EXPRESSIONS:
255 : 201 : enabled->expressions = true;
256 : 201 : break;
155 michael@paquier.xyz 257 :UNC 0 : default:
258 [ # # ]: 0 : elog(ERROR, "incorrect stxkind %c found", kinds[i]);
259 : : break;
260 : : }
261 : : }
155 michael@paquier.xyz 262 :GNC 272 : }
263 : :
264 : : /*
265 : : * Perform the actual storage of a pg_statistic_ext_data tuple.
266 : : */
267 : : static void
268 : 272 : upsert_pg_statistic_ext_data(const Datum *values, const bool *nulls,
269 : : const bool *replaces)
270 : : {
271 : : Relation pg_stextdata;
272 : : HeapTuple stxdtup;
273 : : HeapTuple newtup;
274 : :
275 : 272 : pg_stextdata = table_open(StatisticExtDataRelationId, RowExclusiveLock);
276 : :
277 : 272 : stxdtup = SearchSysCache2(STATEXTDATASTXOID,
278 : : values[Anum_pg_statistic_ext_data_stxoid - 1],
279 : 272 : values[Anum_pg_statistic_ext_data_stxdinherit - 1]);
280 : :
281 [ + + ]: 272 : if (HeapTupleIsValid(stxdtup))
282 : : {
283 : 248 : newtup = heap_modify_tuple(stxdtup,
284 : : RelationGetDescr(pg_stextdata),
285 : : values,
286 : : nulls,
287 : : replaces);
288 : 248 : CatalogTupleUpdate(pg_stextdata, &newtup->t_self, newtup);
289 : 248 : ReleaseSysCache(stxdtup);
290 : : }
291 : : else
292 : : {
293 : 24 : newtup = heap_form_tuple(RelationGetDescr(pg_stextdata), values, nulls);
294 : 24 : CatalogTupleInsert(pg_stextdata, newtup);
295 : : }
296 : :
297 : 272 : heap_freetuple(newtup);
298 : :
299 : 272 : CommandCounterIncrement();
300 : :
301 : 272 : table_close(pg_stextdata, RowExclusiveLock);
302 : 272 : }
303 : :
304 : : /*
305 : : * Insert or update an extended statistics object.
306 : : *
307 : : * Major errors, such as the table not existing or permission errors, are
308 : : * reported as ERRORs. There are a couple of paths that generate a WARNING,
309 : : * like when the statistics object or its schema do not exist, a conversion
310 : : * failure on one statistic kind, or when other statistic kinds may still
311 : : * be updated.
312 : : */
313 : : static bool
314 : 316 : extended_statistics_update(FunctionCallInfo fcinfo)
315 : : {
316 : : char *relnspname;
317 : : char *relname;
318 : : Oid nspoid;
319 : : char *nspname;
320 : : char *stxname;
321 : : bool inherited;
322 : 316 : Relation pg_stext = NULL;
323 : 316 : HeapTuple tup = NULL;
324 : :
325 : 316 : StakindFlags enabled = {false, false, false, false};
326 : 316 : StakindFlags has = {false, false, false, false};
327 : :
328 : : Form_pg_statistic_ext stxform;
329 : :
330 : 316 : Datum values[Natts_pg_statistic_ext_data] = {0};
331 : 316 : bool nulls[Natts_pg_statistic_ext_data] = {0};
332 : 316 : bool replaces[Natts_pg_statistic_ext_data] = {0};
333 : 316 : bool success = true;
334 : : Datum exprdatum;
335 : : bool isnull;
152 336 : 316 : List *exprs = NIL;
337 : 316 : int numattnums = 0;
155 338 : 316 : int numexprs = 0;
152 339 : 316 : int numattrs = 0;
340 : :
341 : : /* arrays of type info, if we need them */
342 : 316 : Oid *atttypids = NULL;
343 : 316 : int32 *atttypmods = NULL;
344 : 316 : Oid *atttypcolls = NULL;
345 : : Oid relid;
155 346 : 316 : Oid locked_table = InvalidOid;
347 : :
348 : : /*
349 : : * Fill out the StakindFlags "has" structure based on which parameters
350 : : * were provided to the function.
351 : : *
352 : : * The MCV stats composite value is an array of record type, but this is
353 : : * externally represented as three arrays that must be interleaved into
354 : : * the array of records (pg_stats_ext stores four arrays,
355 : : * most_common_val_nulls is built from the contents of most_common_vals).
356 : : * Therefore, none of the three array values is meaningful unless the
357 : : * other two are also present and in sync in terms of array length.
358 : : */
152 359 : 687 : has.mcv = (!PG_ARGISNULL(MOST_COMMON_VALS_ARG) &&
360 [ + + + + ]: 367 : !PG_ARGISNULL(MOST_COMMON_FREQS_ARG) &&
361 [ + + ]: 51 : !PG_ARGISNULL(MOST_COMMON_BASE_FREQS_ARG));
155 362 : 316 : has.ndistinct = !PG_ARGISNULL(NDISTINCT_ARG);
154 363 : 316 : has.dependencies = !PG_ARGISNULL(DEPENDENCIES_ARG);
119 364 : 316 : has.expressions = !PG_ARGISNULL(EXPRESSIONS_ARG);
365 : :
155 366 [ - + ]: 316 : if (RecoveryInProgress())
367 : : {
155 michael@paquier.xyz 368 [ # # ]:UNC 0 : ereport(WARNING,
369 : : errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
370 : : errmsg("recovery is in progress"),
371 : : errhint("Statistics cannot be modified during recovery."));
372 : 0 : return false;
373 : : }
374 : :
375 : : /* relation arguments */
155 michael@paquier.xyz 376 :GNC 316 : stats_check_required_arg(fcinfo, extarginfo, RELSCHEMA_ARG);
377 : 312 : relnspname = TextDatumGetCString(PG_GETARG_DATUM(RELSCHEMA_ARG));
378 : 312 : stats_check_required_arg(fcinfo, extarginfo, RELNAME_ARG);
379 : 308 : relname = TextDatumGetCString(PG_GETARG_DATUM(RELNAME_ARG));
380 : :
381 : : /* extended statistics arguments */
382 : 308 : stats_check_required_arg(fcinfo, extarginfo, STATSCHEMA_ARG);
383 : 304 : nspname = TextDatumGetCString(PG_GETARG_DATUM(STATSCHEMA_ARG));
384 : 304 : stats_check_required_arg(fcinfo, extarginfo, STATNAME_ARG);
385 : 300 : stxname = TextDatumGetCString(PG_GETARG_DATUM(STATNAME_ARG));
386 : 300 : stats_check_required_arg(fcinfo, extarginfo, INHERITED_ARG);
387 : 296 : inherited = PG_GETARG_BOOL(INHERITED_ARG);
388 : :
389 : : /*
390 : : * First open the relation where we expect to find the statistics. This
391 : : * is similar to relation and attribute statistics, so as ACL checks are
392 : : * done before any locks are taken, even before any attempts related to
393 : : * the extended stats object.
394 : : */
395 : 296 : relid = RangeVarGetRelidExtended(makeRangeVar(relnspname, relname, -1),
396 : : ShareUpdateExclusiveLock, 0,
397 : : RangeVarCallbackForStats, &locked_table);
398 : :
399 : 284 : nspoid = get_namespace_oid(nspname, true);
400 [ + + ]: 284 : if (nspoid == InvalidOid)
401 : : {
402 [ + - ]: 4 : ereport(WARNING,
403 : : errcode(ERRCODE_UNDEFINED_OBJECT),
404 : : errmsg("could not find schema \"%s\"", nspname));
405 : 4 : success = false;
406 : 4 : goto cleanup;
407 : : }
408 : :
409 : 280 : pg_stext = table_open(StatisticExtRelationId, RowExclusiveLock);
410 : 280 : tup = get_pg_statistic_ext(pg_stext, nspoid, stxname);
411 : :
412 [ + + ]: 280 : if (!HeapTupleIsValid(tup))
413 : : {
414 [ + - ]: 4 : ereport(WARNING,
415 : : errcode(ERRCODE_UNDEFINED_OBJECT),
416 : : errmsg("could not find extended statistics object \"%s.%s\"",
417 : : nspname, stxname));
418 : 4 : success = false;
419 : 4 : goto cleanup;
420 : : }
421 : :
422 : 276 : stxform = (Form_pg_statistic_ext) GETSTRUCT(tup);
423 : :
424 : : /*
425 : : * The relation tracked by the stats object has to match with the relation
426 : : * we have already locked.
427 : : */
428 [ + + ]: 276 : if (stxform->stxrelid != relid)
429 : : {
430 [ + - ]: 4 : ereport(WARNING,
431 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
432 : : errmsg("could not restore extended statistics object \"%s.%s\": incorrect relation \"%s.%s\" specified",
433 : : nspname, stxname,
434 : : relnspname, relname));
435 : :
436 : 4 : success = false;
437 : 4 : goto cleanup;
438 : : }
439 : :
440 : : /* Find out what extended statistics kinds we should expect. */
441 : 272 : expand_stxkind(tup, &enabled);
152 442 : 272 : numattnums = stxform->stxkeys.dim1;
443 : :
444 : : /* decode expression (if any) */
153 445 : 272 : exprdatum = SysCacheGetAttr(STATEXTOID,
446 : : tup,
447 : : Anum_pg_statistic_ext_stxexprs,
448 : : &isnull);
449 [ + + ]: 272 : if (!isnull)
450 : : {
451 : : char *s;
452 : :
453 : 201 : s = TextDatumGetCString(exprdatum);
454 : 201 : exprs = (List *) stringToNode(s);
455 : 201 : pfree(s);
456 : :
457 : : /*
458 : : * Run the expressions through eval_const_expressions(). This is not
459 : : * just an optimization, but is necessary, because the planner will be
460 : : * comparing them to similarly-processed qual clauses, and may fail to
461 : : * detect valid matches without this.
462 : : *
463 : : * We must not use canonicalize_qual(), however, since these are not
464 : : * qual expressions.
465 : : */
466 : 201 : exprs = (List *) eval_const_expressions(NULL, (Node *) exprs);
467 : :
468 : : /* May as well fix opfuncids too */
469 : 201 : fix_opfuncids((Node *) exprs);
470 : :
471 : : /* Compute the number of expression, for input validation. */
472 : 201 : numexprs = list_length(exprs);
473 : : }
474 : :
152 475 : 272 : numattrs = numattnums + numexprs;
476 : :
477 : : /*
478 : : * If the object cannot support ndistinct, we should not have data for it.
479 : : */
155 480 [ + + + + ]: 272 : if (has.ndistinct && !enabled.ndistinct)
481 : : {
482 [ + - ]: 4 : ereport(WARNING,
483 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
484 : : errmsg("cannot specify parameter \"%s\"",
485 : : extarginfo[NDISTINCT_ARG].argname),
486 : : errhint("Extended statistics object \"%s.%s\" does not support statistics of this type.",
487 : : nspname, stxname));
488 : :
489 : 4 : has.ndistinct = false;
490 : 4 : success = false;
491 : : }
492 : :
493 : : /*
494 : : * If the object cannot support dependencies, we should not have data for
495 : : * it.
496 : : */
154 497 [ + + + + ]: 272 : if (has.dependencies && !enabled.dependencies)
498 : : {
499 [ + - ]: 4 : ereport(WARNING,
500 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
501 : : errmsg("cannot specify parameter \"%s\"",
502 : : extarginfo[DEPENDENCIES_ARG].argname),
503 : : errhint("Extended statistics object \"%s.%s\" does not support statistics of this type.",
504 : : nspname, stxname));
505 : 4 : has.dependencies = false;
506 : 4 : success = false;
507 : : }
508 : :
509 : : /*
510 : : * If the object cannot hold an MCV value, but any of the MCV parameters
511 : : * are set, then issue a WARNING and ensure that we do not try to load MCV
512 : : * stats later. In pg_stats_ext, most_common_val_nulls, most_common_freqs
513 : : * and most_common_base_freqs are NULL if most_common_vals is NULL.
514 : : */
152 515 [ + + ]: 272 : if (!enabled.mcv)
516 : : {
517 [ + + ]: 49 : if (!PG_ARGISNULL(MOST_COMMON_VALS_ARG) ||
518 [ + - ]: 45 : !PG_ARGISNULL(MOST_COMMON_FREQS_ARG) ||
519 [ - + ]: 45 : !PG_ARGISNULL(MOST_COMMON_BASE_FREQS_ARG))
520 : : {
521 [ + - ]: 4 : ereport(WARNING,
522 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
523 : : errmsg("cannot specify parameters \"%s\", \"%s\", or \"%s\"",
524 : : extarginfo[MOST_COMMON_VALS_ARG].argname,
525 : : extarginfo[MOST_COMMON_FREQS_ARG].argname,
526 : : extarginfo[MOST_COMMON_BASE_FREQS_ARG].argname),
527 : : errhint("Extended statistics object \"%s.%s\" does not support statistics of this type.",
528 : : nspname, stxname));
529 : :
530 : 4 : has.mcv = false;
531 : 4 : success = false;
532 : : }
533 : : }
534 [ + + ]: 223 : else if (!has.mcv)
535 : : {
536 : : /*
537 : : * If we do not have all of the MCV arrays set while the extended
538 : : * statistics object expects something, something is wrong. This
539 : : * issues a WARNING if a partial input has been provided.
540 : : */
541 [ + + ]: 180 : if (!PG_ARGISNULL(MOST_COMMON_VALS_ARG) ||
542 [ + + ]: 172 : !PG_ARGISNULL(MOST_COMMON_FREQS_ARG) ||
543 [ - + ]: 168 : !PG_ARGISNULL(MOST_COMMON_BASE_FREQS_ARG))
544 : : {
545 [ + - ]: 12 : ereport(WARNING,
546 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
547 : : errmsg("could not use \"%s\", \"%s\", and \"%s\": missing one or more parameters",
548 : : extarginfo[MOST_COMMON_VALS_ARG].argname,
549 : : extarginfo[MOST_COMMON_FREQS_ARG].argname,
550 : : extarginfo[MOST_COMMON_BASE_FREQS_ARG].argname));
551 : 12 : success = false;
552 : : }
553 : : }
554 : :
555 : : /*
556 : : * If the object cannot support expressions, we should not have data for
557 : : * them.
558 : : */
119 559 [ + + + + ]: 272 : if (has.expressions && !enabled.expressions)
560 : : {
561 [ + - ]: 4 : ereport(WARNING,
562 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
563 : : errmsg("cannot specify parameter \"%s\"",
564 : : extarginfo[EXPRESSIONS_ARG].argname),
565 : : errhint("Extended statistics object \"%s.%s\" does not support statistics of this type.",
566 : : nspname, stxname));
567 : :
568 : 4 : has.expressions = false;
569 : 4 : success = false;
570 : : }
571 : :
572 : : /*
573 : : * Either of these statistic types requires that we supply a semi-filled
574 : : * VacAttrStatsP array.
575 : : *
576 : : * It is not possible to use the existing lookup_var_attr_stats() and
577 : : * examine_attribute() because these functions will skip attributes where
578 : : * attstattarget is 0, and we may have statistics data to import for those
579 : : * attributes.
580 : : */
581 [ + + + + ]: 272 : if (has.mcv || has.expressions)
582 : : {
152 583 : 208 : atttypids = palloc0_array(Oid, numattrs);
584 : 208 : atttypmods = palloc0_array(int32, numattrs);
585 : 208 : atttypcolls = palloc0_array(Oid, numattrs);
586 : :
587 : : /*
588 : : * The leading stxkeys are attribute numbers up through numattnums.
589 : : * These keys must be in ascending AttrNumber order, but we do not
590 : : * rely on that.
591 : : */
592 [ + + ]: 565 : for (int i = 0; i < numattnums; i++)
593 : : {
594 : 357 : AttrNumber attnum = stxform->stxkeys.values[i];
595 : 357 : HeapTuple atup = SearchSysCache2(ATTNUM,
596 : : ObjectIdGetDatum(relid),
597 : : Int16GetDatum(attnum));
598 : :
599 : : Form_pg_attribute attr;
600 : :
601 : : /* Attribute not found */
602 [ - + ]: 357 : if (!HeapTupleIsValid(atup))
152 michael@paquier.xyz 603 [ # # ]:UNC 0 : elog(ERROR, "stxkeys references nonexistent attnum %d", attnum);
604 : :
152 michael@paquier.xyz 605 :GNC 357 : attr = (Form_pg_attribute) GETSTRUCT(atup);
606 : :
607 [ - + ]: 357 : if (attr->attisdropped)
152 michael@paquier.xyz 608 [ # # ]:UNC 0 : elog(ERROR, "stxkeys references dropped attnum %d", attnum);
609 : :
152 michael@paquier.xyz 610 :GNC 357 : atttypids[i] = attr->atttypid;
611 : 357 : atttypmods[i] = attr->atttypmod;
612 : 357 : atttypcolls[i] = attr->attcollation;
613 : 357 : ReleaseSysCache(atup);
614 : : }
615 : :
616 : : /*
617 : : * After all the positive number attnums in stxkeys come the negative
618 : : * numbers (if any) which represent expressions in the order that they
619 : : * appear in stxdexpr. Because the expressions are always
620 : : * monotonically decreasing from -1, there is no point in looking at
621 : : * the values in stxkeys, it's enough to know how many of them there
622 : : * are.
623 : : */
624 [ + + ]: 503 : for (int i = numattnums; i < numattrs; i++)
625 : : {
626 : 295 : Node *expr = list_nth(exprs, i - numattnums);
627 : :
628 : 295 : atttypids[i] = exprType(expr);
629 : 295 : atttypmods[i] = exprTypmod(expr);
630 : 295 : atttypcolls[i] = exprCollation(expr);
631 : : }
632 : : }
633 : :
634 : : /*
635 : : * Populate the pg_statistic_ext_data result tuple.
636 : : */
637 : :
638 : : /* Primary Key: cannot be NULL or replaced. */
155 639 : 272 : values[Anum_pg_statistic_ext_data_stxoid - 1] = ObjectIdGetDatum(stxform->oid);
640 : 272 : nulls[Anum_pg_statistic_ext_data_stxoid - 1] = false;
641 : 272 : values[Anum_pg_statistic_ext_data_stxdinherit - 1] = BoolGetDatum(inherited);
642 : 272 : nulls[Anum_pg_statistic_ext_data_stxdinherit - 1] = false;
643 : :
644 : : /* All unspecified parameters will be left unmodified */
645 : 272 : nulls[Anum_pg_statistic_ext_data_stxdndistinct - 1] = true;
646 : 272 : nulls[Anum_pg_statistic_ext_data_stxddependencies - 1] = true;
647 : 272 : nulls[Anum_pg_statistic_ext_data_stxdmcv - 1] = true;
648 : 272 : nulls[Anum_pg_statistic_ext_data_stxdexpr - 1] = true;
649 : :
650 : : /*
651 : : * For each stats kind, deserialize the data at hand and perform a round
652 : : * of validation. The resulting tuple is filled with a set of updated
653 : : * values.
654 : : */
655 : :
656 [ + + ]: 272 : if (has.ndistinct)
657 : : {
658 : 32 : Datum ndistinct_datum = PG_GETARG_DATUM(NDISTINCT_ARG);
659 : 32 : bytea *data = DatumGetByteaPP(ndistinct_datum);
660 : 32 : MVNDistinct *ndistinct = statext_ndistinct_deserialize(data);
661 : :
662 [ + + ]: 32 : if (statext_ndistinct_validate(ndistinct, &stxform->stxkeys,
663 : : numexprs, WARNING))
664 : : {
665 : 24 : values[Anum_pg_statistic_ext_data_stxdndistinct - 1] = ndistinct_datum;
666 : 24 : nulls[Anum_pg_statistic_ext_data_stxdndistinct - 1] = false;
667 : 24 : replaces[Anum_pg_statistic_ext_data_stxdndistinct - 1] = true;
668 : : }
669 : : else
670 : 8 : success = false;
671 : :
672 : 32 : statext_ndistinct_free(ndistinct);
673 : : }
674 : :
154 675 [ + + ]: 272 : if (has.dependencies)
676 : : {
677 : 29 : Datum dependencies_datum = PG_GETARG_DATUM(DEPENDENCIES_ARG);
678 : 29 : bytea *data = DatumGetByteaPP(dependencies_datum);
679 : 29 : MVDependencies *dependencies = statext_dependencies_deserialize(data);
680 : :
153 681 [ + + ]: 29 : if (statext_dependencies_validate(dependencies, &stxform->stxkeys,
682 : : numexprs, WARNING))
683 : : {
154 684 : 21 : values[Anum_pg_statistic_ext_data_stxddependencies - 1] = dependencies_datum;
685 : 21 : nulls[Anum_pg_statistic_ext_data_stxddependencies - 1] = false;
686 : 21 : replaces[Anum_pg_statistic_ext_data_stxddependencies - 1] = true;
687 : : }
688 : : else
689 : 8 : success = false;
690 : :
691 : 29 : statext_dependencies_free(dependencies);
692 : : }
693 : :
152 694 [ + + ]: 272 : if (has.mcv)
695 : : {
696 : : Datum datum;
697 : 43 : bool val_ok = false;
698 : :
699 : 43 : datum = import_mcv(PG_GETARG_ARRAYTYPE_P(MOST_COMMON_VALS_ARG),
700 : 43 : PG_GETARG_ARRAYTYPE_P(MOST_COMMON_FREQS_ARG),
701 : 43 : PG_GETARG_ARRAYTYPE_P(MOST_COMMON_BASE_FREQS_ARG),
702 : : atttypids, atttypmods, atttypcolls, numattrs,
703 : : &val_ok);
704 : :
705 [ + + ]: 43 : if (val_ok)
706 : : {
707 [ - + ]: 23 : Assert(datum != (Datum) 0);
708 : 23 : values[Anum_pg_statistic_ext_data_stxdmcv - 1] = datum;
709 : 23 : nulls[Anum_pg_statistic_ext_data_stxdmcv - 1] = false;
710 : 23 : replaces[Anum_pg_statistic_ext_data_stxdmcv - 1] = true;
711 : : }
712 : : else
713 : 20 : success = false;
714 : : }
715 : :
119 716 [ + + ]: 272 : if (has.expressions)
717 : : {
718 : : Datum datum;
719 : : Relation pgsd;
720 : 177 : bool ok = false;
721 : :
722 : 177 : pgsd = table_open(StatisticRelationId, RowExclusiveLock);
723 : :
724 : : /*
725 : : * Generate the expressions array.
726 : : *
727 : : * The atttypids, atttypmods, and atttypcolls arrays have all the
728 : : * regular attributes listed first, so we can pass those arrays with a
729 : : * start point after the last regular attribute. There are numexprs
730 : : * elements remaining.
731 : : */
732 : 177 : datum = import_expressions(pgsd, numexprs,
733 : 177 : &atttypids[numattnums],
734 : 177 : &atttypmods[numattnums],
735 : 177 : &atttypcolls[numattnums],
736 : : PG_GETARG_JSONB_P(EXPRESSIONS_ARG),
737 : : &ok);
738 : :
739 : 177 : table_close(pgsd, RowExclusiveLock);
740 : :
741 [ + + ]: 177 : if (ok)
742 : : {
743 [ - + ]: 37 : Assert(datum != (Datum) 0);
744 : 37 : values[Anum_pg_statistic_ext_data_stxdexpr - 1] = datum;
745 : 37 : replaces[Anum_pg_statistic_ext_data_stxdexpr - 1] = true;
746 : 37 : nulls[Anum_pg_statistic_ext_data_stxdexpr - 1] = false;
747 : : }
748 : : else
749 : 140 : success = false;
750 : : }
751 : :
155 752 : 272 : upsert_pg_statistic_ext_data(values, nulls, replaces);
753 : :
754 : 284 : cleanup:
755 [ + + ]: 284 : if (HeapTupleIsValid(tup))
756 : 276 : heap_freetuple(tup);
757 [ + + ]: 284 : if (pg_stext != NULL)
758 : 280 : table_close(pg_stext, RowExclusiveLock);
152 759 [ + + ]: 284 : if (atttypids != NULL)
760 : 208 : pfree(atttypids);
761 [ + + ]: 284 : if (atttypmods != NULL)
762 : 208 : pfree(atttypmods);
763 [ + + ]: 284 : if (atttypcolls != NULL)
764 : 208 : pfree(atttypcolls);
155 765 : 284 : return success;
766 : : }
767 : :
768 : : /*
769 : : * Consistency checks to ensure that other mcvlist arrays are in alignment
770 : : * with the mcv array.
771 : : */
772 : : static bool
152 773 : 58 : check_mcvlist_array(const ArrayType *arr, int argindex, int required_ndims,
774 : : int mcv_length)
775 : : {
776 [ - + ]: 58 : if (ARR_NDIM(arr) != required_ndims)
777 : : {
152 michael@paquier.xyz 778 [ # # ]:UNC 0 : ereport(WARNING,
779 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
780 : : errmsg("could not parse array \"%s\": incorrect number of dimensions (%d required)",
781 : : extarginfo[argindex].argname, required_ndims));
782 : 0 : return false;
783 : : }
784 : :
152 michael@paquier.xyz 785 [ - + ]:GNC 58 : if (array_contains_nulls(arr))
786 : : {
152 michael@paquier.xyz 787 [ # # ]:UNC 0 : ereport(WARNING,
788 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
789 : : errmsg("could not parse array \"%s\": NULL value found",
790 : : extarginfo[argindex].argname));
791 : 0 : return false;
792 : : }
793 : :
152 michael@paquier.xyz 794 [ + + ]:GNC 58 : if (ARR_DIMS(arr)[0] != mcv_length)
795 : : {
796 [ + - ]: 8 : ereport(WARNING,
797 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
798 : : errmsg("could not parse array \"%s\": incorrect number of elements (same as \"%s\" required)",
799 : : extarginfo[argindex].argname,
800 : : extarginfo[MOST_COMMON_VALS_ARG].argname));
801 : 8 : return false;
802 : : }
803 : :
804 : 50 : return true;
805 : : }
806 : :
807 : : /*
808 : : * Create the stxdmcv datum from the equal-sized arrays of most common values,
809 : : * their null flags, and the frequency and base frequency associated with
810 : : * each value.
811 : : */
812 : : static Datum
813 : 43 : import_mcv(const ArrayType *mcv_arr, const ArrayType *freqs_arr,
814 : : const ArrayType *base_freqs_arr, Oid *atttypids, int32 *atttypmods,
815 : : Oid *atttypcolls, int numattrs, bool *ok)
816 : : {
817 : : int nitems;
818 : : Datum *mcv_elems;
819 : : bool *mcv_nulls;
820 : : int check_nummcv;
821 : 43 : Datum mcv = (Datum) 0;
822 : :
823 : 43 : *ok = false;
824 : :
825 : : /*
826 : : * mcv_arr is an array of arrays. Each inner array must have the same
827 : : * number of elements "numattrs".
828 : : */
829 [ + + ]: 43 : if (ARR_NDIM(mcv_arr) != 2)
830 : : {
831 [ + - ]: 4 : ereport(WARNING,
832 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
833 : : errmsg("could not parse array \"%s\": incorrect number of dimensions (%d required)",
834 : : extarginfo[MOST_COMMON_VALS_ARG].argname, 2));
835 : 4 : goto mcv_error;
836 : : }
837 : :
838 [ + + ]: 39 : if (ARR_DIMS(mcv_arr)[1] != numattrs)
839 : : {
840 [ + - ]: 4 : ereport(WARNING,
841 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
842 : : errmsg("could not parse array \"%s\": found %d attributes but expected %d",
843 : : extarginfo[MOST_COMMON_VALS_ARG].argname,
844 : : ARR_DIMS(mcv_arr)[1], numattrs));
845 : 4 : goto mcv_error;
846 : : }
847 : :
848 : : /*
849 : : * "most_common_freqs" and "most_common_base_freqs" arrays must be of the
850 : : * same length, one-dimension and cannot contain NULLs. We use mcv_arr as
851 : : * the reference array for determining their length.
852 : : */
853 : 35 : nitems = ARR_DIMS(mcv_arr)[0];
854 : :
855 : : /*
856 : : * Reject a MCV list larger than what statext_mcv_deserialize() is able to
857 : : * accept.
858 : : */
14 859 [ + + ]: 35 : if (nitems > STATS_MCVLIST_MAX_ITEMS)
860 : : {
861 [ + - ]: 4 : ereport(WARNING,
862 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
863 : : errmsg("could not parse array \"%s\": number of items (%d) exceeds maximum (%d)",
864 : : extarginfo[MOST_COMMON_VALS_ARG].argname,
865 : : nitems, STATS_MCVLIST_MAX_ITEMS));
866 : 4 : goto mcv_error;
867 : : }
868 : :
152 869 [ + + ]: 31 : if (!check_mcvlist_array(freqs_arr, MOST_COMMON_FREQS_ARG, 1, nitems) ||
870 [ + + ]: 27 : !check_mcvlist_array(base_freqs_arr, MOST_COMMON_BASE_FREQS_ARG, 1, nitems))
871 : : {
872 : : /* inconsistent input arrays found */
873 : 8 : goto mcv_error;
874 : : }
875 : :
876 : : /*
877 : : * This part builds the contents for "most_common_val_nulls", based on the
878 : : * values from "most_common_vals".
879 : : */
880 : 23 : deconstruct_array_builtin(mcv_arr, TEXTOID, &mcv_elems,
881 : : &mcv_nulls, &check_nummcv);
882 : :
883 : 23 : mcv = statext_mcv_import(WARNING, numattrs,
884 : : atttypids, atttypmods, atttypcolls,
885 : : nitems, mcv_elems, mcv_nulls,
886 [ - + ]: 23 : (float8 *) ARR_DATA_PTR(freqs_arr),
887 [ - + ]: 23 : (float8 *) ARR_DATA_PTR(base_freqs_arr));
888 : :
889 : 23 : *ok = (mcv != (Datum) 0);
890 : :
891 : 43 : mcv_error:
892 : 43 : return mcv;
893 : : }
894 : :
895 : : /*
896 : : * Check if key is found in the list of expression argnames.
897 : : */
898 : : static bool
119 899 : 674 : key_in_expr_argnames(JsonbValue *key)
900 : : {
901 [ - + ]: 674 : Assert(key->type == jbvString);
902 [ + + ]: 3962 : for (int i = 0; i < NUM_ATTRIBUTE_STATS_ELEMS; i++)
903 : : {
43 904 [ + + ]: 3954 : if (strlen(extexprargname[i]) == key->val.string.len &&
905 [ + + ]: 945 : strncmp(extexprargname[i], key->val.string.val, key->val.string.len) == 0)
119 906 : 666 : return true;
907 : : }
908 : 8 : return false;
909 : : }
910 : :
911 : : /*
912 : : * Verify that all of the keys in the object are valid argnames.
913 : : */
914 : : static bool
915 : 219 : check_all_expr_argnames_valid(JsonbContainer *cont, AttrNumber exprnum)
916 : : {
917 : 219 : bool all_keys_valid = true;
918 : :
919 : : JsonbIterator *jbit;
920 : : JsonbIteratorToken jitok;
921 : : JsonbValue jkey;
922 : :
923 [ - + ]: 219 : Assert(JsonContainerIsObject(cont));
924 : :
925 : 219 : jbit = JsonbIteratorInit(cont);
926 : :
927 : : /* We always start off with a BEGIN OBJECT */
928 : 219 : jitok = JsonbIteratorNext(&jbit, &jkey, false);
929 [ + - ]: 219 : Assert(jitok == WJB_BEGIN_OBJECT);
930 : :
931 : : while (true)
932 : 710 : {
933 : : JsonbValue jval;
934 : :
935 : 929 : jitok = JsonbIteratorNext(&jbit, &jkey, false);
936 : :
937 : : /*
938 : : * We have run of keys. This is the only condition where it is
939 : : * memory-safe to break out of the loop.
940 : : */
941 [ + + ]: 929 : if (jitok == WJB_END_OBJECT)
942 : 219 : break;
943 : :
944 : : /* We can only find keys inside an object */
945 [ - + ]: 710 : Assert(jitok == WJB_KEY);
946 [ - + ]: 710 : Assert(jkey.type == jbvString);
947 : :
948 : : /* A value must follow the key */
949 : 710 : jitok = JsonbIteratorNext(&jbit, &jval, false);
950 [ - + ]: 710 : Assert(jitok == WJB_VALUE);
951 : :
952 : : /*
953 : : * If we have already found an invalid key, there is no point in
954 : : * looking for more, because additional WARNINGs are just clutter. We
955 : : * must continue iterating over the json to ensure that we clean up
956 : : * all allocated memory.
957 : : */
958 [ + + ]: 710 : if (!all_keys_valid)
959 : 36 : continue;
960 : :
961 [ + + ]: 674 : if (!key_in_expr_argnames(&jkey))
962 : : {
963 : 8 : char *bad_element_name = jbv_string_get_cstr(&jkey);
964 : :
965 [ + - ]: 8 : ereport(WARNING,
966 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
967 : : errmsg("could not import element in expression %d: invalid key name",
968 : : exprnum));
969 : :
970 : 8 : pfree(bad_element_name);
971 : 8 : all_keys_valid = false;
972 : : }
973 : : }
974 : 219 : return all_keys_valid;
975 : : }
976 : :
977 : : /*
978 : : * Simple conversion of jbvString to cstring
979 : : */
980 : : static char *
981 : 466 : jbv_string_get_cstr(JsonbValue *jval)
982 : : {
983 : : char *s;
984 : :
985 [ - + ]: 466 : Assert(jval->type == jbvString);
986 : :
987 : 466 : s = palloc0(jval->val.string.len + 1);
988 : 466 : memcpy(s, jval->val.string.val, jval->val.string.len);
989 : :
990 : 466 : return s;
991 : : }
992 : :
993 : : /*
994 : : * Apply a jbvString value to a safe scalar input function.
995 : : */
996 : : static bool
997 : 232 : jbv_to_infunc_datum(JsonbValue *jval, PGFunction func, AttrNumber exprnum,
998 : : const char *argname, Datum *datum)
999 : : {
1000 : 232 : ErrorSaveContext escontext = {
1001 : : .type = T_ErrorSaveContext,
1002 : : .details_wanted = true
1003 : : };
1004 : :
1005 : 232 : char *s = jbv_string_get_cstr(jval);
1006 : : bool ok;
1007 : :
1008 : 232 : ok = DirectInputFunctionCallSafe(func, s, InvalidOid, -1,
1009 : : (Node *) &escontext, datum);
1010 : :
1011 : : /*
1012 : : * If we got a type import error, use the report generated and add an
1013 : : * error hint before throwing a warning.
1014 : : */
1015 [ + + ]: 232 : if (!ok)
1016 : : {
1017 : : StringInfoData hint_str;
1018 : :
1019 : 16 : initStringInfo(&hint_str);
1020 : 16 : appendStringInfo(&hint_str,
1021 : : "Element \"%s\" in expression %d could not be parsed.",
1022 : : argname, exprnum);
1023 : :
1024 : 16 : escontext.error_data->elevel = WARNING;
1025 : 16 : escontext.error_data->hint = hint_str.data;
1026 : :
1027 : 16 : ThrowErrorData(escontext.error_data);
1028 : 16 : pfree(hint_str.data);
1029 : : }
1030 : :
1031 : 232 : pfree(s);
1032 : 232 : return ok;
1033 : : }
1034 : :
1035 : : /*
1036 : : * Build an array datum with element type elemtypid from a text datum, used as
1037 : : * value of an attribute in a pg_statistic tuple.
1038 : : *
1039 : : * If an error is encountered, capture it, and reduce the elevel to WARNING.
1040 : : *
1041 : : * This is an adaptation of statatt_build_stavalues().
1042 : : */
1043 : : static Datum
1044 : 226 : array_in_safe(FmgrInfo *array_in, const char *s, Oid typid, int32 typmod,
1045 : : AttrNumber exprnum, const char *element_name, bool *ok)
1046 : : {
1047 : 226 : LOCAL_FCINFO(fcinfo, 3);
1048 : : Datum result;
1049 : :
1050 : 226 : ErrorSaveContext escontext = {
1051 : : .type = T_ErrorSaveContext,
1052 : : .details_wanted = true
1053 : : };
1054 : :
1055 : 226 : *ok = false;
1056 : 226 : InitFunctionCallInfoData(*fcinfo, array_in, 3, InvalidOid,
1057 : : (Node *) &escontext, NULL);
1058 : :
1059 : 226 : fcinfo->args[0].value = CStringGetDatum(s);
1060 : 226 : fcinfo->args[0].isnull = false;
1061 : 226 : fcinfo->args[1].value = ObjectIdGetDatum(typid);
1062 : 226 : fcinfo->args[1].isnull = false;
1063 : 226 : fcinfo->args[2].value = Int32GetDatum(typmod);
1064 : 226 : fcinfo->args[2].isnull = false;
1065 : :
1066 : 226 : result = FunctionCallInvoke(fcinfo);
1067 : :
1068 : : /*
1069 : : * If the array_in function returned an error, we will want to report that
1070 : : * ERROR as a WARNING, and add some location context to the error message.
1071 : : * Overwriting the existing hint (if any) is not ideal, and an error
1072 : : * context would only work for level >= ERROR.
1073 : : */
1074 [ + + ]: 226 : if (escontext.error_occurred)
1075 : : {
1076 : : StringInfoData hint_str;
1077 : :
1078 : 24 : initStringInfo(&hint_str);
1079 : 24 : appendStringInfo(&hint_str,
1080 : : "Element \"%s\" in expression %d could not be parsed.",
1081 : : element_name, exprnum);
1082 : 24 : escontext.error_data->elevel = WARNING;
1083 : 24 : escontext.error_data->hint = hint_str.data;
1084 : 24 : ThrowErrorData(escontext.error_data);
1085 : 24 : pfree(hint_str.data);
1086 : 24 : return (Datum) 0;
1087 : : }
1088 : :
50 1089 [ + + ]: 202 : if (ARR_NDIM(DatumGetArrayTypeP(result)) != 1)
1090 : : {
1091 [ + - ]: 4 : ereport(WARNING,
1092 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1093 : : errmsg("could not import element \"%s\" in expression %d: must be a one-dimensional array",
1094 : : element_name, exprnum)));
1095 : 4 : return (Datum) 0;
1096 : : }
1097 : :
119 1098 [ - + ]: 198 : if (array_contains_nulls(DatumGetArrayTypeP(result)))
1099 : : {
119 michael@paquier.xyz 1100 [ # # ]:UNC 0 : ereport(WARNING,
1101 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1102 : : errmsg("could not import element \"%s\" in expression %d: null value found",
1103 : : element_name, exprnum));
1104 : 0 : return (Datum) 0;
1105 : : }
1106 : :
119 michael@paquier.xyz 1107 :GNC 198 : *ok = true;
1108 : 198 : return result;
1109 : : }
1110 : :
1111 : : /*
1112 : : * Create a pg_statistic tuple from an expression JSONB container.
1113 : : *
1114 : : * The pg_statistic tuple is pre-populated with acceptable defaults, therefore
1115 : : * even if there is an issue with all of the keys in the container, we can
1116 : : * still return a legit tuple datum.
1117 : : *
1118 : : * Set pg_statistic_ok to true if all of the values found in the container
1119 : : * were imported without issue. pg_statistic_ok is switched to "true" once
1120 : : * the full pg_statistic tuple has been built and validated.
1121 : : */
1122 : : static Datum
1123 : 227 : import_pg_statistic(Relation pgsd, JsonbContainer *cont,
1124 : : AttrNumber exprnum, FmgrInfo *array_in_fn,
1125 : : Oid typid, int32 typmod, Oid typcoll,
1126 : : bool *pg_statistic_ok)
1127 : : {
1128 : 227 : const char *argname = extarginfo[EXPRESSIONS_ARG].argname;
1129 : : TypeCacheEntry *typcache;
1130 : : Datum values[Natts_pg_statistic];
1131 : : bool nulls[Natts_pg_statistic];
1132 : : bool replaces[Natts_pg_statistic];
1133 : 227 : HeapTuple pgstup = NULL;
1134 : 227 : Datum pgstdat = (Datum) 0;
1135 : 227 : Oid elemtypid = InvalidOid;
1136 : 227 : Oid elemeqopr = InvalidOid;
1137 : 227 : bool found[NUM_ATTRIBUTE_STATS_ELEMS] = {0};
1138 : 227 : JsonbValue val[NUM_ATTRIBUTE_STATS_ELEMS] = {0};
1139 : :
1140 : : /* Assume the worst by default. */
1141 : 227 : *pg_statistic_ok = false;
1142 : :
1143 [ + + ]: 227 : if (!JsonContainerIsObject(cont))
1144 : : {
1145 [ + - ]: 4 : ereport(WARNING,
1146 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1147 : : errmsg("could not parse \"%s\": invalid element in expression %d",
1148 : : argname, exprnum));
1149 : 4 : goto pg_statistic_error;
1150 : : }
1151 : :
1152 : : /*
1153 : : * Loop through all keys that we need to look up. If any value found is
1154 : : * neither a string nor a NULL, there is not much we can do, so just give
1155 : : * on the entire tuple for this expression.
1156 : : */
1157 [ + + ]: 3070 : for (int i = 0; i < NUM_ATTRIBUTE_STATS_ELEMS; i++)
1158 : : {
1159 : 2851 : const char *s = extexprargname[i];
1160 : 2851 : int len = strlen(s);
1161 : :
1162 [ + + ]: 2851 : if (getKeyJsonValueFromContainer(cont, s, len, &val[i]) == NULL)
1163 : 2145 : continue;
1164 : :
1165 [ + + + ]: 706 : switch (val[i].type)
1166 : : {
1167 : 582 : case jbvString:
1168 : 582 : found[i] = true;
1169 : 582 : break;
1170 : :
1171 : 120 : case jbvNull:
1172 : 120 : break;
1173 : :
1174 : 4 : default:
1175 [ + - ]: 4 : ereport(WARNING,
1176 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1177 : : errmsg("could not parse \"%s\": invalid element in expression %d", argname, exprnum),
1178 : : errhint("Value of element \"%s\" must be a null or a string.", s));
1179 : 4 : goto pg_statistic_error;
1180 : : }
1181 : : }
1182 : :
1183 : : /* Look for invalid keys */
1184 [ + + ]: 219 : if (!check_all_expr_argnames_valid(cont, exprnum))
1185 : 8 : goto pg_statistic_error;
1186 : :
1187 : : /*
1188 : : * There are two arg pairs, MCV+MCF and MCEV+MCEF. Both values must
1189 : : * either be found or not be found. Any disagreement is a warning. Once
1190 : : * we have ruled out disagreeing pairs, we can use either found flag as a
1191 : : * proxy for the other.
1192 : : */
1193 [ + + ]: 211 : if (found[MOST_COMMON_VALS_ELEM] != found[MOST_COMMON_FREQS_ELEM])
1194 : : {
1195 [ + - ]: 16 : ereport(WARNING,
1196 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1197 : : errmsg("could not parse \"%s\": invalid element in expression %d",
1198 : : argname, exprnum),
1199 : : errhint("\"%s\" and \"%s\" must be both either strings or nulls.",
1200 : : extexprargname[MOST_COMMON_VALS_ELEM],
1201 : : extexprargname[MOST_COMMON_FREQS_ELEM]));
1202 : 16 : goto pg_statistic_error;
1203 : : }
1204 [ + + ]: 195 : if (found[MOST_COMMON_ELEMS_ELEM] != found[MOST_COMMON_ELEM_FREQS_ELEM])
1205 : : {
1206 [ + - ]: 16 : ereport(WARNING,
1207 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1208 : : errmsg("could not parse \"%s\": invalid element in expression %d",
1209 : : argname, exprnum),
1210 : : errhint("\"%s\" and \"%s\" must be both either strings or nulls.",
1211 : : extexprargname[MOST_COMMON_ELEMS_ELEM],
1212 : : extexprargname[MOST_COMMON_ELEM_FREQS_ELEM]));
1213 : 16 : goto pg_statistic_error;
1214 : : }
1215 : :
1216 : : /*
1217 : : * Range types may expect three values to be set. All three of them must
1218 : : * either be found or not be found. Any disagreement is a warning.
1219 : : */
1220 [ + + ]: 179 : if (found[RANGE_LENGTH_HISTOGRAM_ELEM] != found[RANGE_EMPTY_FRAC_ELEM] ||
1221 [ + + ]: 171 : found[RANGE_LENGTH_HISTOGRAM_ELEM] != found[RANGE_BOUNDS_HISTOGRAM_ELEM])
1222 : : {
1223 [ + - ]: 16 : ereport(WARNING,
1224 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1225 : : errmsg("could not parse \"%s\": invalid element in expression %d",
1226 : : argname, exprnum),
1227 : : errhint("\"%s\", \"%s\", and \"%s\" must be all either strings or all nulls.",
1228 : : extexprargname[RANGE_LENGTH_HISTOGRAM_ELEM],
1229 : : extexprargname[RANGE_EMPTY_FRAC_ELEM],
1230 : : extexprargname[RANGE_BOUNDS_HISTOGRAM_ELEM]));
1231 : 16 : goto pg_statistic_error;
1232 : : }
1233 : :
1234 : : /* This finds the right operators even if atttypid is a domain */
1235 : 163 : typcache = lookup_type_cache(typid, TYPECACHE_LT_OPR | TYPECACHE_EQ_OPR);
1236 : :
1237 : 163 : statatt_init_empty_tuple(InvalidOid, InvalidAttrNumber, false,
1238 : : values, nulls, replaces);
1239 : :
1240 : : /*
1241 : : * Special case: collation for tsvector is DEFAULT_COLLATION_OID. See
1242 : : * compute_tsvector_stats().
1243 : : */
1244 [ + + ]: 163 : if (typid == TSVECTOROID)
1245 : 4 : typcoll = DEFAULT_COLLATION_OID;
1246 : :
1247 : : /*
1248 : : * We only need to fetch element type and eq operator if we have a stat of
1249 : : * type MCELEM or DECHIST, otherwise the values are unnecessary and not
1250 : : * meaningful.
1251 : : */
1252 [ + + + + ]: 163 : if (found[MOST_COMMON_ELEMS_ELEM] || found[ELEM_COUNT_HISTOGRAM_ELEM])
1253 : : {
1254 [ + + ]: 28 : if (!statatt_get_elem_type(typid, typcache->typtype,
1255 : : &elemtypid, &elemeqopr))
1256 : : {
1257 [ + - ]: 8 : ereport(WARNING,
1258 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1259 : : errmsg("could not parse \"%s\": invalid element type in expression %d",
1260 : : argname, exprnum));
1261 : 8 : goto pg_statistic_error;
1262 : : }
1263 : : }
1264 : :
1265 : : /*
1266 : : * These three fields can only be set if dealing with a range or
1267 : : * multi-range type.
1268 : : */
1269 [ + + ]: 155 : if (found[RANGE_LENGTH_HISTOGRAM_ELEM] ||
1270 [ + - ]: 143 : found[RANGE_EMPTY_FRAC_ELEM] ||
1271 [ - + ]: 143 : found[RANGE_BOUNDS_HISTOGRAM_ELEM])
1272 : : {
1273 [ + - ]: 12 : if (typcache->typtype != TYPTYPE_RANGE &&
1274 [ + + ]: 12 : typcache->typtype != TYPTYPE_MULTIRANGE)
1275 : : {
1276 [ + - ]: 4 : ereport(WARNING,
1277 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1278 : : errmsg("could not parse \"%s\": invalid data in expression %d",
1279 : : argname, exprnum),
1280 : : errhint("\"%s\", \"%s\", and \"%s\" can only be set for a range type.",
1281 : : extexprargname[RANGE_LENGTH_HISTOGRAM_ELEM],
1282 : : extexprargname[RANGE_EMPTY_FRAC_ELEM],
1283 : : extexprargname[RANGE_BOUNDS_HISTOGRAM_ELEM]));
1284 : 4 : goto pg_statistic_error;
1285 : : }
1286 : : }
1287 : :
1288 : : /* null_frac */
1289 [ + + ]: 151 : if (found[NULL_FRAC_ELEM])
1290 : : {
1291 : : Datum datum;
1292 : :
1293 [ + + ]: 63 : if (jbv_to_infunc_datum(&val[NULL_FRAC_ELEM], float4in, exprnum,
1294 : : extexprargname[NULL_FRAC_ELEM], &datum))
1295 : 59 : values[Anum_pg_statistic_stanullfrac - 1] = datum;
1296 : : else
1297 : 4 : goto pg_statistic_error;
1298 : : }
1299 : :
1300 : : /* avg_width */
1301 [ + + ]: 147 : if (found[AVG_WIDTH_ELEM])
1302 : : {
1303 : : Datum datum;
1304 : :
1305 [ + + ]: 59 : if (jbv_to_infunc_datum(&val[AVG_WIDTH_ELEM], int4in, exprnum,
1306 : : extexprargname[AVG_WIDTH_ELEM], &datum))
1307 : 55 : values[Anum_pg_statistic_stawidth - 1] = datum;
1308 : : else
1309 : 4 : goto pg_statistic_error;
1310 : : }
1311 : :
1312 : : /* n_distinct */
1313 [ + + ]: 143 : if (found[N_DISTINCT_ELEM])
1314 : : {
1315 : : Datum datum;
1316 : :
1317 [ + + ]: 59 : if (jbv_to_infunc_datum(&val[N_DISTINCT_ELEM], float4in, exprnum,
1318 : : extexprargname[N_DISTINCT_ELEM], &datum))
1319 : 55 : values[Anum_pg_statistic_stadistinct - 1] = datum;
1320 : : else
1321 : 4 : goto pg_statistic_error;
1322 : : }
1323 : :
1324 : : /*
1325 : : * The STAKIND statistics are the same as the ones found in attribute
1326 : : * stats. However, these are all derived from json strings, whereas the
1327 : : * ones derived for attribute stats are a mix of datatypes. This limits
1328 : : * the opportunities for code sharing between the two.
1329 : : *
1330 : : * Some statistic kinds have both a stanumbers and a stavalues components.
1331 : : * In those cases, both values must either be NOT NULL or both NULL, and
1332 : : * if they aren't then we need to reject that stakind completely.
1333 : : * Currently we go a step further and reject the expression array
1334 : : * completely.
1335 : : */
1336 : :
1337 [ + + ]: 139 : if (found[MOST_COMMON_VALS_ELEM])
1338 : : {
1339 : : Datum stavalues;
1340 : : Datum stanumbers;
1341 : 75 : bool val_ok = false;
1342 : 75 : bool num_ok = false;
1343 : : char *s;
1344 : :
1345 : 75 : s = jbv_string_get_cstr(&val[MOST_COMMON_VALS_ELEM]);
1346 : 75 : stavalues = array_in_safe(array_in_fn, s, typid, typmod, exprnum,
1347 : : extexprargname[MOST_COMMON_VALS_ELEM],
1348 : : &val_ok);
1349 : :
1350 : 75 : pfree(s);
1351 : :
1352 : 75 : s = jbv_string_get_cstr(&val[MOST_COMMON_FREQS_ELEM]);
1353 : 75 : stanumbers = array_in_safe(array_in_fn, s, FLOAT4OID, -1, exprnum,
1354 : : extexprargname[MOST_COMMON_FREQS_ELEM],
1355 : : &num_ok);
1356 : 75 : pfree(s);
1357 : :
1358 : : /* Only set the slot if both datums have been built */
1359 [ + + + + ]: 75 : if (val_ok && num_ok)
50 1360 : 59 : {
1361 : 63 : ArrayType *vals_arr = DatumGetArrayTypeP(stavalues);
1362 : 63 : ArrayType *nums_arr = DatumGetArrayTypeP(stanumbers);
1363 : 63 : int nvals = ARR_DIMS(vals_arr)[0];
1364 : 63 : int nnums = ARR_DIMS(nums_arr)[0];
1365 : :
1366 [ + + ]: 63 : if (nvals != nnums)
1367 : : {
1368 [ + - ]: 4 : ereport(WARNING,
1369 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1370 : : errmsg("could not parse \"%s\": incorrect number of elements (same as \"%s\" required)",
1371 : : "most_common_vals",
1372 : : "most_common_freqs")));
1373 : 16 : goto pg_statistic_error;
1374 : : }
1375 : :
119 1376 : 59 : statatt_set_slot(values, nulls, replaces,
1377 : : STATISTIC_KIND_MCV,
1378 : : typcache->eq_opr, typcoll,
1379 : : stanumbers, false, stavalues, false);
1380 : : }
1381 : : else
1382 : 12 : goto pg_statistic_error;
1383 : : }
1384 : :
1385 : : /* STATISTIC_KIND_HISTOGRAM */
1386 [ + + ]: 123 : if (found[HISTOGRAM_BOUNDS_ELEM])
1387 : : {
1388 : : Datum stavalues;
1389 : 20 : bool val_ok = false;
1390 : 20 : char *s = jbv_string_get_cstr(&val[HISTOGRAM_BOUNDS_ELEM]);
1391 : :
1392 : 20 : stavalues = array_in_safe(array_in_fn, s, typid, typmod, exprnum,
1393 : : extexprargname[HISTOGRAM_BOUNDS_ELEM],
1394 : : &val_ok);
1395 : 20 : pfree(s);
1396 : :
1397 [ + + ]: 20 : if (val_ok)
1398 : 16 : statatt_set_slot(values, nulls, replaces,
1399 : : STATISTIC_KIND_HISTOGRAM,
1400 : : typcache->lt_opr, typcoll,
1401 : : 0, true, stavalues, false);
1402 : : else
1403 : 4 : goto pg_statistic_error;
1404 : : }
1405 : :
1406 : : /* STATISTIC_KIND_CORRELATION */
1407 [ + + ]: 119 : if (found[CORRELATION_ELEM])
1408 : : {
1409 : 43 : Datum corr[] = {(Datum) 0};
1410 : :
1411 [ + + ]: 43 : if (jbv_to_infunc_datum(&val[CORRELATION_ELEM], float4in, exprnum,
1412 : : extexprargname[CORRELATION_ELEM], &corr[0]))
1413 : : {
1414 : 39 : ArrayType *arry = construct_array_builtin(corr, 1, FLOAT4OID);
1415 : 39 : Datum stanumbers = PointerGetDatum(arry);
1416 : :
1417 : 39 : statatt_set_slot(values, nulls, replaces,
1418 : : STATISTIC_KIND_CORRELATION,
1419 : : typcache->lt_opr, typcoll,
1420 : : stanumbers, false, 0, true);
1421 : : }
1422 : : else
1423 : 4 : goto pg_statistic_error;
1424 : : }
1425 : :
1426 : : /* STATISTIC_KIND_MCELEM */
1427 [ + + ]: 115 : if (found[MOST_COMMON_ELEMS_ELEM])
1428 : : {
1429 : : Datum stavalues;
1430 : : Datum stanumbers;
1431 : 16 : bool val_ok = false;
1432 : 16 : bool num_ok = false;
1433 : : char *s;
1434 : :
1435 : 16 : s = jbv_string_get_cstr(&val[MOST_COMMON_ELEMS_ELEM]);
1436 : 16 : stavalues = array_in_safe(array_in_fn, s, elemtypid, typmod, exprnum,
1437 : : extexprargname[MOST_COMMON_ELEMS_ELEM],
1438 : : &val_ok);
1439 : 16 : pfree(s);
1440 : :
1441 : :
1442 : 16 : s = jbv_string_get_cstr(&val[MOST_COMMON_ELEM_FREQS_ELEM]);
1443 : 16 : stanumbers = array_in_safe(array_in_fn, s, FLOAT4OID, -1, exprnum,
1444 : : extexprargname[MOST_COMMON_ELEM_FREQS_ELEM],
1445 : : &num_ok);
1446 : 16 : pfree(s);
1447 : :
1448 : : /* Only set the slot if both datums have been built */
1449 [ + + + + ]: 16 : if (val_ok && num_ok)
1450 : 8 : statatt_set_slot(values, nulls, replaces,
1451 : : STATISTIC_KIND_MCELEM,
1452 : : elemeqopr, typcoll,
1453 : : stanumbers, false, stavalues, false);
1454 : : else
1455 : 8 : goto pg_statistic_error;
1456 : : }
1457 : :
1458 : : /* STATISTIC_KIND_DECHIST */
1459 [ + + ]: 107 : if (found[ELEM_COUNT_HISTOGRAM_ELEM])
1460 : : {
1461 : : Datum stanumbers;
1462 : 8 : bool num_ok = false;
1463 : : char *s;
1464 : :
1465 : 8 : s = jbv_string_get_cstr(&val[ELEM_COUNT_HISTOGRAM_ELEM]);
1466 : 8 : stanumbers = array_in_safe(array_in_fn, s, FLOAT4OID, -1, exprnum,
1467 : : extexprargname[ELEM_COUNT_HISTOGRAM_ELEM],
1468 : : &num_ok);
1469 : 8 : pfree(s);
1470 : :
1471 [ + + ]: 8 : if (num_ok)
1472 : 4 : statatt_set_slot(values, nulls, replaces, STATISTIC_KIND_DECHIST,
1473 : : elemeqopr, typcoll, stanumbers, false, 0, true);
1474 : : else
1475 : 4 : goto pg_statistic_error;
1476 : : }
1477 : :
1478 : : /*
1479 : : * STATISTIC_KIND_BOUNDS_HISTOGRAM
1480 : : *
1481 : : * This stakind appears before STATISTIC_KIND_RANGE_LENGTH_HISTOGRAM even
1482 : : * though it is numerically greater, and all other stakinds appear in
1483 : : * numerical order.
1484 : : */
1485 [ + + ]: 103 : if (found[RANGE_BOUNDS_HISTOGRAM_ELEM])
1486 : : {
1487 : : Datum stavalues;
1488 : 8 : bool val_ok = false;
1489 : : char *s;
1490 : 8 : Oid rtypid = typid;
1491 : :
1492 : : /*
1493 : : * If it's a multirange, step down to the range type, as is done by
1494 : : * multirange_typanalyze().
1495 : : */
1496 [ + - ]: 8 : if (type_is_multirange(typid))
1497 : 8 : rtypid = get_multirange_range(typid);
1498 : :
1499 : 8 : s = jbv_string_get_cstr(&val[RANGE_BOUNDS_HISTOGRAM_ELEM]);
1500 : :
1501 : 8 : stavalues = array_in_safe(array_in_fn, s, rtypid, typmod, exprnum,
1502 : : extexprargname[RANGE_BOUNDS_HISTOGRAM_ELEM],
1503 : : &val_ok);
1504 : :
1505 [ + - ]: 8 : if (val_ok)
1506 : 8 : statatt_set_slot(values, nulls, replaces,
1507 : : STATISTIC_KIND_BOUNDS_HISTOGRAM,
1508 : : InvalidOid, InvalidOid,
1509 : : 0, true, stavalues, false);
1510 : : else
119 michael@paquier.xyz 1511 :UNC 0 : goto pg_statistic_error;
1512 : : }
1513 : :
1514 : : /* STATISTIC_KIND_RANGE_LENGTH_HISTOGRAM */
119 michael@paquier.xyz 1515 [ + + ]:GNC 103 : if (found[RANGE_LENGTH_HISTOGRAM_ELEM])
1516 : : {
1517 : 8 : Datum empty_frac[] = {(Datum) 0};
1518 : : Datum stavalues;
1519 : : Datum stanumbers;
1520 : 8 : bool val_ok = false;
1521 : : char *s;
1522 : :
1523 [ + - ]: 8 : if (jbv_to_infunc_datum(&val[RANGE_EMPTY_FRAC_ELEM], float4in, exprnum,
1524 : : extexprargname[RANGE_EMPTY_FRAC_ELEM], &empty_frac[0]))
1525 : : {
1526 : 8 : ArrayType *arry = construct_array_builtin(empty_frac, 1, FLOAT4OID);
1527 : :
1528 : 8 : stanumbers = PointerGetDatum(arry);
1529 : : }
1530 : : else
119 michael@paquier.xyz 1531 :UNC 0 : goto pg_statistic_error;
1532 : :
119 michael@paquier.xyz 1533 :GNC 8 : s = jbv_string_get_cstr(&val[RANGE_LENGTH_HISTOGRAM_ELEM]);
1534 : 8 : stavalues = array_in_safe(array_in_fn, s, FLOAT8OID, -1, exprnum,
1535 : : extexprargname[RANGE_LENGTH_HISTOGRAM_ELEM],
1536 : : &val_ok);
1537 : :
1538 [ + - ]: 8 : if (val_ok)
1539 : 8 : statatt_set_slot(values, nulls, replaces,
1540 : : STATISTIC_KIND_RANGE_LENGTH_HISTOGRAM,
1541 : : Float8LessOperator, InvalidOid,
1542 : : stanumbers, false, stavalues, false);
1543 : : else
119 michael@paquier.xyz 1544 :UNC 0 : goto pg_statistic_error;
1545 : : }
1546 : :
119 michael@paquier.xyz 1547 :GNC 103 : pgstup = heap_form_tuple(RelationGetDescr(pgsd), values, nulls);
1548 : 103 : pgstdat = heap_copy_tuple_as_datum(pgstup, RelationGetDescr(pgsd));
1549 : :
116 1550 : 103 : heap_freetuple(pgstup);
1551 : :
119 1552 : 103 : *pg_statistic_ok = true;
1553 : :
1554 : 103 : return pgstdat;
1555 : :
1556 : 124 : pg_statistic_error:
1557 : 124 : return (Datum) 0;
1558 : : }
1559 : :
1560 : : /*
1561 : : * Create the stxdexpr datum, which is an array of pg_statistic rows with all
1562 : : * of the object identification fields left at defaults, using the json array
1563 : : * of objects/nulls referenced against the datatypes for the expressions.
1564 : : *
1565 : : * The exprs_is_perfect will be set to true if all pg_statistic rows were
1566 : : * imported cleanly. If any of them experienced a problem (and thus were
1567 : : * set as if they were null), then the expression is kept but exprs_is_perfect
1568 : : * will be marked as false.
1569 : : *
1570 : : * This datum is needed to fill out a complete pg_statistic_ext_data tuple.
1571 : : */
1572 : : static Datum
1573 : 177 : import_expressions(Relation pgsd, int numexprs,
1574 : : Oid *atttypids, int32 *atttypmods,
1575 : : Oid *atttypcolls, Jsonb *exprs_jsonb,
1576 : : bool *exprs_is_perfect)
1577 : : {
1578 : 177 : const char *argname = extarginfo[EXPRESSIONS_ARG].argname;
1579 : 177 : Oid pgstypoid = get_rel_type_id(StatisticRelationId);
1580 : 177 : ArrayBuildState *astate = NULL;
1581 : 177 : Datum result = (Datum) 0;
1582 : 177 : int num_import_ok = 0;
1583 : : JsonbContainer *root;
1584 : : int num_root_elements;
1585 : :
1586 : : FmgrInfo array_in_fn;
1587 : :
1588 : 177 : *exprs_is_perfect = false;
1589 : :
1590 : : /* Json schema must be [{expr},...] */
1591 [ + + ]: 177 : if (!JB_ROOT_IS_ARRAY(exprs_jsonb))
1592 : : {
1593 [ + - ]: 4 : ereport(WARNING,
1594 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1595 : : errmsg("could not parse \"%s\": root-level array required", argname));
1596 : 4 : goto exprs_error;
1597 : : }
1598 : :
1599 : 173 : root = &exprs_jsonb->root;
1600 : :
1601 : : /*
1602 : : * The number of elements in the array must match the number of
1603 : : * expressions in the stats object definition.
1604 : : */
1605 : 173 : num_root_elements = JsonContainerSize(root);
1606 [ + + ]: 173 : if (numexprs != num_root_elements)
1607 : : {
1608 [ + - ]: 8 : ereport(WARNING,
1609 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1610 : : errmsg("could not parse \"%s\": incorrect number of elements (%d required)",
1611 : : argname, numexprs));
1612 : 8 : goto exprs_error;
1613 : : }
1614 : :
1615 : 165 : fmgr_info(F_ARRAY_IN, &array_in_fn);
1616 : :
1617 : : /*
1618 : : * Iterate over each expected expression object in the array. Some of
1619 : : * them could be null. If the element is a completely wrong data type,
1620 : : * give a WARNING and then treat the element like a NULL element in the
1621 : : * result array.
1622 : : *
1623 : : * Each expression *MUST* have a value appended in the result pg_statistic
1624 : : * array.
1625 : : */
1626 [ + + ]: 420 : for (int i = 0; i < numexprs; i++)
1627 : : {
1628 : 259 : Datum pgstdat = (Datum) 0;
1629 : 259 : bool isnull = false;
1630 : 259 : AttrNumber exprattnum = -1 - i;
1631 : :
1632 : 259 : JsonbValue *elem = getIthJsonbValueFromContainer(root, i);
1633 : :
1634 [ + + + ]: 259 : switch (elem->type)
1635 : : {
1636 : 227 : case jbvBinary:
1637 : : {
1638 : 227 : bool sta_ok = false;
1639 : :
1640 : : /* a real stats object */
1641 : 227 : pgstdat = import_pg_statistic(pgsd, elem->val.binary.data,
1642 : : exprattnum, &array_in_fn,
1643 : 227 : atttypids[i], atttypmods[i],
1644 : 227 : atttypcolls[i], &sta_ok);
1645 : :
1646 : : /*
1647 : : * If some incorrect data has been found, assign NULL for
1648 : : * this expression as a mean to give up.
1649 : : */
1650 [ + + ]: 227 : if (sta_ok)
1651 : 103 : num_import_ok++;
1652 : : else
1653 : : {
1654 : 124 : isnull = true;
1655 : 124 : pgstdat = (Datum) 0;
1656 : : }
1657 : : }
1658 : 227 : break;
1659 : :
1660 : 28 : case jbvNull:
1661 : : /* NULL placeholder for invalid data, still fine */
1662 : 28 : isnull = true;
1663 : 28 : num_import_ok++;
1664 : 28 : break;
1665 : :
1666 : 4 : default:
1667 : : /* cannot possibly be valid */
1668 [ + - ]: 4 : ereport(WARNING,
1669 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1670 : : errmsg("could not parse \"%s\": invalid element in expression %d",
1671 : : argname, exprattnum));
1672 : 4 : goto exprs_error;
1673 : : }
1674 : :
1675 : 255 : astate = accumArrayResult(astate, pgstdat, isnull, pgstypoid,
1676 : : CurrentMemoryContext);
1677 : : }
1678 : :
1679 : : /*
1680 : : * The expressions datum is perfect *if and only if* all of the
1681 : : * pg_statistic elements were also ok, for a number of elements equal to
1682 : : * the number of expressions. Anything else means a failure in restoring
1683 : : * the data of this statistics object.
1684 : : */
1685 : 161 : *exprs_is_perfect = (num_import_ok == numexprs);
1686 : :
1687 [ + - ]: 161 : if (astate != NULL)
1688 : 161 : result = makeArrayResult(astate, CurrentMemoryContext);
1689 : :
1690 : 161 : return result;
1691 : :
1692 : 16 : exprs_error:
1693 [ - + ]: 16 : if (astate != NULL)
119 michael@paquier.xyz 1694 :UNC 0 : pfree(astate);
119 michael@paquier.xyz 1695 :GNC 16 : return (Datum) 0;
1696 : : };
1697 : :
1698 : : /*
1699 : : * Remove an existing pg_statistic_ext_data row for a given pg_statistic_ext
1700 : : * row and "inherited" pair.
1701 : : */
1702 : : static bool
165 1703 : 12 : delete_pg_statistic_ext_data(Oid stxoid, bool inherited)
1704 : : {
1705 : 12 : Relation sed = table_open(StatisticExtDataRelationId, RowExclusiveLock);
1706 : : HeapTuple oldtup;
1707 : 12 : bool result = false;
1708 : :
1709 : : /* Is there already a pg_statistic_ext_data tuple for this attribute? */
1710 : 12 : oldtup = SearchSysCache2(STATEXTDATASTXOID,
1711 : : ObjectIdGetDatum(stxoid),
1712 : : BoolGetDatum(inherited));
1713 : :
1714 [ + + ]: 12 : if (HeapTupleIsValid(oldtup))
1715 : : {
1716 : 8 : CatalogTupleDelete(sed, &oldtup->t_self);
1717 : 8 : ReleaseSysCache(oldtup);
1718 : 8 : result = true;
1719 : : }
1720 : :
1721 : 12 : table_close(sed, RowExclusiveLock);
1722 : :
1723 : 12 : CommandCounterIncrement();
1724 : :
1725 : 12 : return result;
1726 : : }
1727 : :
1728 : : /*
1729 : : * Restore (insert or replace) statistics for the given statistics object.
1730 : : *
1731 : : * This function accepts variadic arguments in key-value pairs, which are
1732 : : * given to stats_fill_fcinfo_from_arg_pairs to be mapped into positional
1733 : : * arguments.
1734 : : */
1735 : : Datum
155 1736 : 316 : pg_restore_extended_stats(PG_FUNCTION_ARGS)
1737 : : {
1738 : 316 : LOCAL_FCINFO(positional_fcinfo, NUM_EXTENDED_STATS_ARGS);
1739 : 316 : bool result = true;
1740 : :
1741 : 316 : InitFunctionCallInfoData(*positional_fcinfo, NULL, NUM_EXTENDED_STATS_ARGS,
1742 : : InvalidOid, NULL, NULL);
1743 : :
1744 [ - + ]: 316 : if (!stats_fill_fcinfo_from_arg_pairs(fcinfo, positional_fcinfo, extarginfo))
155 michael@paquier.xyz 1745 :UNC 0 : result = false;
1746 : :
155 michael@paquier.xyz 1747 [ + + ]:GNC 316 : if (!extended_statistics_update(positional_fcinfo))
1748 : 216 : result = false;
1749 : :
1750 : 284 : PG_RETURN_BOOL(result);
1751 : : }
1752 : :
1753 : : /*
1754 : : * Delete statistics for the given statistics object.
1755 : : */
1756 : : Datum
165 1757 : 56 : pg_clear_extended_stats(PG_FUNCTION_ARGS)
1758 : : {
1759 : : char *relnspname;
1760 : : char *relname;
1761 : : char *nspname;
1762 : : Oid nspoid;
1763 : : Oid relid;
1764 : : char *stxname;
1765 : : bool inherited;
1766 : : Relation pg_stext;
1767 : : HeapTuple tup;
1768 : : Form_pg_statistic_ext stxform;
1769 : 56 : Oid locked_table = InvalidOid;
1770 : :
1771 : : /* relation arguments */
1772 : 56 : stats_check_required_arg(fcinfo, extarginfo, RELSCHEMA_ARG);
1773 : 52 : relnspname = TextDatumGetCString(PG_GETARG_DATUM(RELSCHEMA_ARG));
1774 : 52 : stats_check_required_arg(fcinfo, extarginfo, RELNAME_ARG);
1775 : 48 : relname = TextDatumGetCString(PG_GETARG_DATUM(RELNAME_ARG));
1776 : :
1777 : : /* extended statistics arguments */
1778 : 48 : stats_check_required_arg(fcinfo, extarginfo, STATSCHEMA_ARG);
1779 : 44 : nspname = TextDatumGetCString(PG_GETARG_DATUM(STATSCHEMA_ARG));
1780 : 44 : stats_check_required_arg(fcinfo, extarginfo, STATNAME_ARG);
1781 : 40 : stxname = TextDatumGetCString(PG_GETARG_DATUM(STATNAME_ARG));
1782 : 40 : stats_check_required_arg(fcinfo, extarginfo, INHERITED_ARG);
1783 : 36 : inherited = PG_GETARG_BOOL(INHERITED_ARG);
1784 : :
1785 [ - + ]: 36 : if (RecoveryInProgress())
1786 : : {
165 michael@paquier.xyz 1787 [ # # ]:UNC 0 : ereport(WARNING,
1788 : : errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
1789 : : errmsg("recovery is in progress"),
1790 : : errhint("Statistics cannot be modified during recovery."));
1791 : 0 : PG_RETURN_VOID();
1792 : : }
1793 : :
1794 : : /*
1795 : : * First open the relation where we expect to find the statistics. This
1796 : : * is similar to relation and attribute statistics, so as ACL checks are
1797 : : * done before any locks are taken, even before any attempts related to
1798 : : * the extended stats object.
1799 : : */
165 michael@paquier.xyz 1800 :GNC 36 : relid = RangeVarGetRelidExtended(makeRangeVar(relnspname, relname, -1),
1801 : : ShareUpdateExclusiveLock, 0,
1802 : : RangeVarCallbackForStats, &locked_table);
1803 : :
1804 : : /* Now check if the namespace of the stats object exists. */
1805 : 24 : nspoid = get_namespace_oid(nspname, true);
1806 [ + + ]: 24 : if (nspoid == InvalidOid)
1807 : : {
1808 [ + - ]: 4 : ereport(WARNING,
1809 : : errcode(ERRCODE_UNDEFINED_OBJECT),
1810 : : errmsg("could not find schema \"%s\"", nspname));
1811 : 4 : PG_RETURN_VOID();
1812 : : }
1813 : :
1814 : 20 : pg_stext = table_open(StatisticExtRelationId, RowExclusiveLock);
1815 : 20 : tup = get_pg_statistic_ext(pg_stext, nspoid, stxname);
1816 : :
1817 [ + + ]: 20 : if (!HeapTupleIsValid(tup))
1818 : : {
1819 : 4 : table_close(pg_stext, RowExclusiveLock);
1820 [ + - ]: 4 : ereport(WARNING,
1821 : : errcode(ERRCODE_UNDEFINED_OBJECT),
1822 : : errmsg("could not find extended statistics object \"%s.%s\"",
1823 : : nspname, stxname));
1824 : 4 : PG_RETURN_VOID();
1825 : : }
1826 : :
1827 : 16 : stxform = (Form_pg_statistic_ext) GETSTRUCT(tup);
1828 : :
1829 : : /*
1830 : : * This should be consistent, based on the lock taken on the table when we
1831 : : * started.
1832 : : */
1833 [ + + ]: 16 : if (stxform->stxrelid != relid)
1834 : : {
43 1835 : 4 : heap_freetuple(tup);
165 1836 : 4 : table_close(pg_stext, RowExclusiveLock);
1837 [ + - ]: 4 : ereport(WARNING,
1838 : : errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1839 : : errmsg("could not clear extended statistics object \"%s.%s\": incorrect relation \"%s.%s\" specified",
1840 : : get_namespace_name(nspoid), stxname,
1841 : : relnspname, relname));
1842 : 4 : PG_RETURN_VOID();
1843 : : }
1844 : :
1845 : 12 : delete_pg_statistic_ext_data(stxform->oid, inherited);
1846 : 12 : heap_freetuple(tup);
1847 : :
1848 : 12 : table_close(pg_stext, RowExclusiveLock);
1849 : :
1850 : 12 : PG_RETURN_VOID();
1851 : : }
|