#include "postgres.h"
#include "access/relation.h"
#include "catalog/pg_database.h"
#include "funcapi.h"
#include "miscadmin.h"
#include "statistics/stat_utils.h"
#include "utils/acl.h"
#include "utils/array.h"
#include "utils/builtins.h"
#include "utils/rel.h"

Include dependency graph for stat_utils.c:

Functions
void	stats_check_required_arg (FunctionCallInfo fcinfo, struct StatsArgInfo *arginfo, int argnum)

bool	stats_check_arg_array (FunctionCallInfo fcinfo, struct StatsArgInfo *arginfo, int argnum, int elevel)

bool	stats_check_arg_pair (FunctionCallInfo fcinfo, struct StatsArgInfo *arginfo, int argnum1, int argnum2, int elevel)

void	stats_lock_check_privileges (Oid reloid)

static int	get_arg_by_name (const char argname, struct StatsArgInfo arginfo, int elevel)

static bool	stats_check_arg_type (const char *argname, Oid argtype, Oid expectedtype, int elevel)

bool	stats_fill_fcinfo_from_arg_pairs (FunctionCallInfo pairs_fcinfo, FunctionCallInfo positional_fcinfo, struct StatsArgInfo *arginfo, int elevel)

Function Documentation

◆ get_arg_by_name()

static int get_arg_by_name	(	const char *	argname,
		struct StatsArgInfo *	arginfo,
		int	elevel
	)

static

Definition at line 175 of file stat_utils.c.

 {
     int         argnum;
  
     for (argnum = 0; arginfo[argnum].argname != NULL; argnum++)
         if (pg_strcasecmp(argname, arginfo[argnum].argname) == 0)
             return argnum;
  
     ereport(elevel,
             (errmsg("unrecognized argument name: \"%s\"", argname)));
  
     return -1;
 }

References StatsArgInfo::argname, ereport, errmsg(), and pg_strcasecmp().

Referenced by stats_fill_fcinfo_from_arg_pairs().

◆ stats_check_arg_array()

bool stats_check_arg_array	(	FunctionCallInfo	fcinfo,
		struct StatsArgInfo *	arginfo,
		int	argnum,
		int	elevel
	)

Definition at line 52 of file stat_utils.c.

 {
     ArrayType  *arr;
  
     if (PG_ARGISNULL(argnum))
         return true;
  
     arr = DatumGetArrayTypeP(PG_GETARG_DATUM(argnum));
  
     if (ARR_NDIM(arr) != 1)
     {
         ereport(elevel,
                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                  errmsg("\"%s\" cannot be a multidimensional array",
                         arginfo[argnum].argname)));
         return false;
     }
  
     if (array_contains_nulls(arr))
     {
         ereport(elevel,
                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                  errmsg("\"%s\" array cannot contain NULL values",
                         arginfo[argnum].argname)));
         return false;
     }
  
     return true;
 }

References ARR_NDIM, array_contains_nulls(), DatumGetArrayTypeP, ereport, errcode(), errmsg(), PG_ARGISNULL, and PG_GETARG_DATUM.

Referenced by attribute_statistics_update().

◆ stats_check_arg_pair()

bool stats_check_arg_pair	(	FunctionCallInfo	fcinfo,
		struct StatsArgInfo *	arginfo,
		int	argnum1,
		int	argnum2,
		int	elevel
	)

Definition at line 93 of file stat_utils.c.

 {
     if (PG_ARGISNULL(argnum1) && PG_ARGISNULL(argnum2))
         return true;
  
     if (PG_ARGISNULL(argnum1) || PG_ARGISNULL(argnum2))
     {
         int         nullarg = PG_ARGISNULL(argnum1) ? argnum1 : argnum2;
         int         otherarg = PG_ARGISNULL(argnum1) ? argnum2 : argnum1;
  
         ereport(elevel,
                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                  errmsg("\"%s\" must be specified when \"%s\" is specified",
                         arginfo[nullarg].argname,
                         arginfo[otherarg].argname)));
  
         return false;
     }
  
     return true;
 }

References ereport, errcode(), errmsg(), and PG_ARGISNULL.

Referenced by attribute_statistics_update().

◆ stats_check_arg_type()

static bool stats_check_arg_type	(	const char *	argname,
		Oid	argtype,
		Oid	expectedtype,
		int	elevel
	)

static

Definition at line 193 of file stat_utils.c.

 {
     if (argtype != expectedtype)
     {
         ereport(elevel,
                 (errmsg("argument \"%s\" has type \"%s\", expected type \"%s\"",
                         argname, format_type_be(argtype),
                         format_type_be(expectedtype))));
         return false;
     }
  
     return true;
 }

References ereport, errmsg(), and format_type_be().

Referenced by stats_fill_fcinfo_from_arg_pairs().

◆ stats_check_required_arg()

void stats_check_required_arg	(	FunctionCallInfo	fcinfo,
		struct StatsArgInfo *	arginfo,
		int	argnum
	)

Definition at line 33 of file stat_utils.c.

 {
     if (PG_ARGISNULL(argnum))
         ereport(ERROR,
                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                  errmsg("\"%s\" cannot be NULL",
                         arginfo[argnum].argname)));
 }

References ereport, errcode(), errmsg(), ERROR, and PG_ARGISNULL.

Referenced by attribute_statistics_update(), pg_clear_attribute_stats(), and relation_statistics_update().

◆ stats_fill_fcinfo_from_arg_pairs()

bool stats_fill_fcinfo_from_arg_pairs	(	FunctionCallInfo	pairs_fcinfo,
		FunctionCallInfo	positional_fcinfo,
		struct StatsArgInfo *	arginfo,
		int	elevel
	)

Definition at line 217 of file stat_utils.c.

 {
     Datum      *args;
     bool       *argnulls;
     Oid        *types;
     int         nargs;
     bool        result = true;
  
     /* clear positional args */
     for (int i = 0; arginfo[i].argname != NULL; i++)
     {
         positional_fcinfo->args[i].value = (Datum) 0;
         positional_fcinfo->args[i].isnull = true;
     }
  
     nargs = extract_variadic_args(pairs_fcinfo, 0, true,
                                   &args, &types, &argnulls);
  
     if (nargs % 2 != 0)
         ereport(ERROR,
                 errmsg("variadic arguments must be name/value pairs"),
                 errhint("Provide an even number of variadic arguments that can be divided into pairs."));
  
     /*
      * For each argument name/value pair, find corresponding positional
      * argument for the argument name, and assign the argument value to
      * postitional_fcinfo.
      */
     for (int i = 0; i < nargs; i += 2)
     {
         int         argnum;
         char       *argname;
  
         if (argnulls[i])
             ereport(ERROR,
                     (errmsg("name at variadic position %d is NULL", i + 1)));
  
         if (types[i] != TEXTOID)
             ereport(ERROR,
                     (errmsg("name at variadic position %d has type \"%s\", expected type \"%s\"",
                             i + 1, format_type_be(types[i]),
                             format_type_be(TEXTOID))));
  
         if (argnulls[i + 1])
             continue;
  
         argname = TextDatumGetCString(args[i]);
  
         /*
          * The 'version' argument is a special case, not handled by arginfo
          * because it's not a valid positional argument.
          *
          * For now, 'version' is accepted but ignored. In the future it can be
          * used to interpret older statistics properly.
          */
         if (pg_strcasecmp(argname, "version") == 0)
             continue;
  
         argnum = get_arg_by_name(argname, arginfo, elevel);
  
         if (argnum < 0 || !stats_check_arg_type(argname, types[i + 1],
                                                 arginfo[argnum].argtype,
                                                 elevel))
         {
             result = false;
             continue;
         }
  
         positional_fcinfo->args[argnum].value = args[i + 1];
         positional_fcinfo->args[argnum].isnull = false;
     }
  
     return result;
 }

References StatsArgInfo::argname, generate_unaccent_rules::args, FunctionCallInfoBaseData::args, ereport, errhint(), errmsg(), ERROR, extract_variadic_args(), format_type_be(), get_arg_by_name(), i, NullableDatum::isnull, pg_strcasecmp(), stats_check_arg_type(), TextDatumGetCString, types, and NullableDatum::value.

Referenced by pg_restore_attribute_stats(), and pg_restore_relation_stats().

◆ stats_lock_check_privileges()

void stats_lock_check_privileges ( Oid reloid )

Definition at line 127 of file stat_utils.c.

 {
     Relation    rel = relation_open(reloid, ShareUpdateExclusiveLock);
     const char  relkind = rel->rd_rel->relkind;
  
     /* All of the types that can be used with ANALYZE, plus indexes */
     switch (relkind)
     {
         case RELKIND_RELATION:
         case RELKIND_INDEX:
         case RELKIND_MATVIEW:
         case RELKIND_FOREIGN_TABLE:
         case RELKIND_PARTITIONED_TABLE:
         case RELKIND_PARTITIONED_INDEX:
             break;
         default:
             ereport(ERROR,
                     (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                      errmsg("cannot modify statistics for relation \"%s\"",
                             RelationGetRelationName(rel)),
                      errdetail_relkind_not_supported(rel->rd_rel->relkind)));
     }
  
     if (rel->rd_rel->relisshared)
         ereport(ERROR,
                 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                  errmsg("cannot modify statistics for shared relation")));
  
     if (!object_ownercheck(DatabaseRelationId, MyDatabaseId, GetUserId()))
     {
         AclResult   aclresult = pg_class_aclcheck(RelationGetRelid(rel),
                                                   GetUserId(),
                                                   ACL_MAINTAIN);
  
         if (aclresult != ACLCHECK_OK)
             aclcheck_error(aclresult,
                            get_relkind_objtype(rel->rd_rel->relkind),
                            NameStr(rel->rd_rel->relname));
     }
  
     relation_close(rel, NoLock);
 }

References ACL_MAINTAIN, aclcheck_error(), ACLCHECK_OK, ereport, errcode(), errdetail_relkind_not_supported(), errmsg(), ERROR, get_relkind_objtype(), GetUserId(), MyDatabaseId, NameStr, NoLock, object_ownercheck(), pg_class_aclcheck(), RelationData::rd_rel, relation_close(), relation_open(), RelationGetRelationName, RelationGetRelid, and ShareUpdateExclusiveLock.