plancat.h File Reference

#include "nodes/pathnodes.h"
#include "utils/relcache.h"

Include dependency graph for plancat.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef void(*	get_relation_info_hook_type) (PlannerInfo *root, Oid relationObjectId, bool inhparent, RelOptInfo *rel)

Functions
void	get_relation_info (PlannerInfo *root, Oid relationObjectId, bool inhparent, RelOptInfo *rel)
void	get_relation_notnullatts (PlannerInfo *root, Relation relation)
Bitmapset *	find_relation_notnullatts (PlannerInfo *root, Oid relid)
List *	infer_arbiter_indexes (PlannerInfo *root)
void	estimate_rel_size (Relation rel, int32 *attr_widths, BlockNumber *pages, double *tuples, double *allvisfrac)
int32	get_rel_data_width (Relation rel, int32 *attr_widths)
int32	get_relation_data_width (Oid relid, int32 *attr_widths)
bool	relation_excluded_by_constraints (PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
List *	build_physical_tlist (PlannerInfo *root, RelOptInfo *rel)
bool	has_unique_index (RelOptInfo *rel, AttrNumber attno)
Selectivity	restriction_selectivity (PlannerInfo *root, Oid operatorid, List *args, Oid inputcollid, int varRelid)
Selectivity	join_selectivity (PlannerInfo *root, Oid operatorid, List *args, Oid inputcollid, JoinType jointype, SpecialJoinInfo *sjinfo)
Selectivity	function_selectivity (PlannerInfo *root, Oid funcid, List *args, Oid inputcollid, bool is_join, int varRelid, JoinType jointype, SpecialJoinInfo *sjinfo)
void	add_function_cost (PlannerInfo *root, Oid funcid, Node *node, QualCost *cost)
double	get_function_rows (PlannerInfo *root, Oid funcid, Node *node)
bool	has_row_triggers (PlannerInfo *root, Index rti, CmdType event)
bool	has_transition_tables (PlannerInfo *root, Index rti, CmdType event)
bool	has_stored_generated_columns (PlannerInfo *root, Index rti)
Bitmapset *	get_dependent_generated_columns (PlannerInfo *root, Index rti, Bitmapset *target_cols)

Variables
PGDLLIMPORT get_relation_info_hook_type	get_relation_info_hook

Typedef Documentation

get_relation_info_hook_type

typedef void(* get_relation_info_hook_type) (PlannerInfo *root, Oid relationObjectId, bool inhparent, RelOptInfo *rel)

Definition at line 21 of file plancat.h.

Function Documentation

add_function_cost()

void add_function_cost ( PlannerInfo *  root, Oid  funcid, Node *  node, QualCost *  cost  )

extern

Definition at line 2360 of file plancat.c.

{
    HeapTuple   proctup;
    Form_pg_proc procform;
 
    proctup = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcid));
    if (!HeapTupleIsValid(proctup))
        elog(ERROR, "cache lookup failed for function %u", funcid);
    procform = (Form_pg_proc) GETSTRUCT(proctup);
 
    if (OidIsValid(procform->prosupport))
    {
        SupportRequestCost req;
        SupportRequestCost *sresult;
 
        req.type = T_SupportRequestCost;
        req.root = root;
        req.funcid = funcid;
        req.node = node;
 
        /* Initialize cost fields so that support function doesn't have to */
        req.startup = 0;
        req.per_tuple = 0;
 
        sresult = (SupportRequestCost *)
            DatumGetPointer(OidFunctionCall1(procform->prosupport,
                                             PointerGetDatum(&req)));
 
        if (sresult == &req)
        {
            /* Success, so accumulate support function's estimate into *cost */
            cost->startup += req.startup;
            cost->per_tuple += req.per_tuple;
            ReleaseSysCache(proctup);
            return;
        }
    }
 
    /* No support function, or it failed, so rely on procost */
    cost->per_tuple += procform->procost * cpu_operator_cost;
 
    ReleaseSysCache(proctup);
}

References cpu_operator_cost, DatumGetPointer(), elog, ERROR, fb(), GETSTRUCT(), HeapTupleIsValid, ObjectIdGetDatum(), OidFunctionCall1, OidIsValid, QualCost::per_tuple, PointerGetDatum(), ReleaseSysCache(), root, SearchSysCache1(), QualCost::startup, and SupportRequestCost::type.

Referenced by cost_qual_eval_walker(), cost_windowagg(), and get_agg_clause_costs().

build_physical_tlist()

List * build_physical_tlist ( PlannerInfo *  root, RelOptInfo *  rel  )

extern

Definition at line 2044 of file plancat.c.

{
    List       *tlist = NIL;
    Index       varno = rel->relid;
    RangeTblEntry *rte = planner_rt_fetch(varno, root);
    Relation    relation;
    Query      *subquery;
    Var        *var;
    ListCell   *l;
    int         attrno,
                numattrs;
    List       *colvars;
 
    switch (rte->rtekind)
    {
        case RTE_RELATION:
            /* Assume we already have adequate lock */
            relation = table_open(rte->relid, NoLock);
 
            numattrs = RelationGetNumberOfAttributes(relation);
            for (attrno = 1; attrno <= numattrs; attrno++)
            {
                Form_pg_attribute att_tup = TupleDescAttr(relation->rd_att,
                                                          attrno - 1);
 
                if (att_tup->attisdropped || att_tup->atthasmissing)
                {
                    /* found a dropped or missing col, so punt */
                    tlist = NIL;
                    break;
                }
 
                var = makeVar(varno,
                              attrno,
                              att_tup->atttypid,
                              att_tup->atttypmod,
                              att_tup->attcollation,
                              0);
 
                tlist = lappend(tlist,
                                makeTargetEntry((Expr *) var,
                                                attrno,
                                                NULL,
                                                false));
            }
 
            table_close(relation, NoLock);
            break;
 
        case RTE_SUBQUERY:
            subquery = rte->subquery;
            foreach(l, subquery->targetList)
            {
                TargetEntry *tle = (TargetEntry *) lfirst(l);
 
                /*
                 * A resjunk column of the subquery can be reflected as
                 * resjunk in the physical tlist; we need not punt.
                 */
                var = makeVarFromTargetEntry(varno, tle);
 
                tlist = lappend(tlist,
                                makeTargetEntry((Expr *) var,
                                                tle->resno,
                                                NULL,
                                                tle->resjunk));
            }
            break;
 
        case RTE_FUNCTION:
        case RTE_TABLEFUNC:
        case RTE_VALUES:
        case RTE_CTE:
        case RTE_NAMEDTUPLESTORE:
        case RTE_RESULT:
            /* Not all of these can have dropped cols, but share code anyway */
            expandRTE(rte, varno, 0, VAR_RETURNING_DEFAULT, -1,
                      true /* include dropped */ , NULL, &colvars);
            foreach(l, colvars)
            {
                var = (Var *) lfirst(l);
 
                /*
                 * A non-Var in expandRTE's output means a dropped column;
                 * must punt.
                 */
                if (!IsA(var, Var))
                {
                    tlist = NIL;
                    break;
                }
 
                tlist = lappend(tlist,
                                makeTargetEntry((Expr *) var,
                                                var->varattno,
                                                NULL,
                                                false));
            }
            break;
 
        default:
            /* caller error */
            elog(ERROR, "unsupported RTE kind %d in build_physical_tlist",
                 (int) rte->rtekind);
            break;
    }
 
    return tlist;
}

References elog, ERROR, expandRTE(), fb(), IsA, lappend(), lfirst, makeTargetEntry(), makeVar(), makeVarFromTargetEntry(), NIL, NoLock, planner_rt_fetch, RelationData::rd_att, RelationGetNumberOfAttributes, RelOptInfo::relid, root, RTE_CTE, RTE_FUNCTION, RTE_NAMEDTUPLESTORE, RTE_RELATION, RTE_RESULT, RTE_SUBQUERY, RTE_TABLEFUNC, RTE_VALUES, table_close(), table_open(), Query::targetList, TupleDescAttr(), and VAR_RETURNING_DEFAULT.

Referenced by create_scan_plan().

estimate_rel_size()

void estimate_rel_size ( Relation  rel, int32 *  attr_widths, BlockNumber *  pages, double *  tuples, double *  allvisfrac  )

extern

Definition at line 1310 of file plancat.c.

{
    BlockNumber curpages;
    BlockNumber relpages;
    double      reltuples;
    BlockNumber relallvisible;
    double      density;
 
    if (RELKIND_HAS_TABLE_AM(rel->rd_rel->relkind))
    {
        table_relation_estimate_size(rel, attr_widths, pages, tuples,
                                     allvisfrac);
    }
    else if (rel->rd_rel->relkind == RELKIND_INDEX)
    {
        /*
         * XXX: It'd probably be good to move this into a callback, individual
         * index types e.g. know if they have a metapage.
         */
 
        /* it has storage, ok to call the smgr */
        curpages = RelationGetNumberOfBlocks(rel);
 
        /* report estimated # pages */
        *pages = curpages;
        /* quick exit if rel is clearly empty */
        if (curpages == 0)
        {
            *tuples = 0;
            *allvisfrac = 0;
            return;
        }
 
        /* coerce values in pg_class to more desirable types */
        relpages = (BlockNumber) rel->rd_rel->relpages;
        reltuples = (double) rel->rd_rel->reltuples;
        relallvisible = (BlockNumber) rel->rd_rel->relallvisible;
 
        /*
         * Discount the metapage while estimating the number of tuples. This
         * is a kluge because it assumes more than it ought to about index
         * structure.  Currently it's OK for btree, hash, and GIN indexes but
         * suspect for GiST indexes.
         */
        if (relpages > 0)
        {
            curpages--;
            relpages--;
        }
 
        /* estimate number of tuples from previous tuple density */
        if (reltuples >= 0 && relpages > 0)
            density = reltuples / (double) relpages;
        else
        {
            /*
             * If we have no data because the relation was never vacuumed,
             * estimate tuple width from attribute datatypes.  We assume here
             * that the pages are completely full, which is OK for tables
             * (since they've presumably not been VACUUMed yet) but is
             * probably an overestimate for indexes.  Fortunately
             * get_relation_info() can clamp the overestimate to the parent
             * table's size.
             *
             * Note: this code intentionally disregards alignment
             * considerations, because (a) that would be gilding the lily
             * considering how crude the estimate is, and (b) it creates
             * platform dependencies in the default plans which are kind of a
             * headache for regression testing.
             *
             * XXX: Should this logic be more index specific?
             */
            int32       tuple_width;
 
            tuple_width = get_rel_data_width(rel, attr_widths);
            tuple_width += MAXALIGN(SizeofHeapTupleHeader);
            tuple_width += sizeof(ItemIdData);
            /* note: integer division is intentional here */
            density = (BLCKSZ - SizeOfPageHeaderData) / tuple_width;
        }
        *tuples = rint(density * (double) curpages);
 
        /*
         * We use relallvisible as-is, rather than scaling it up like we do
         * for the pages and tuples counts, on the theory that any pages added
         * since the last VACUUM are most likely not marked all-visible.  But
         * costsize.c wants it converted to a fraction.
         */
        if (relallvisible == 0 || curpages <= 0)
            *allvisfrac = 0;
        else if ((double) relallvisible >= curpages)
            *allvisfrac = 1;
        else
            *allvisfrac = (double) relallvisible / curpages;
    }
    else
    {
        /*
         * Just use whatever's in pg_class.  This covers foreign tables,
         * sequences, and also relkinds without storage (shouldn't get here?);
         * see initializations in AddNewRelationTuple().  Note that FDW must
         * cope if reltuples is -1!
         */
        *pages = rel->rd_rel->relpages;
        *tuples = rel->rd_rel->reltuples;
        *allvisfrac = 0;
    }
}

References fb(), get_rel_data_width(), MAXALIGN, RelationData::rd_rel, RelationGetNumberOfBlocks, SizeofHeapTupleHeader, SizeOfPageHeaderData, and table_relation_estimate_size().

Referenced by get_relation_info(), hashbuild(), and plan_create_index_workers().

find_relation_notnullatts()

Bitmapset * find_relation_notnullatts ( PlannerInfo *  root, Oid  relid  )

extern

Definition at line 777 of file plancat.c.

{
    NotnullHashEntry *hentry;
    bool        found;
 
    if (root->glob->rel_notnullatts_hash == NULL)
        return NULL;
 
    hentry = (NotnullHashEntry *) hash_search(root->glob->rel_notnullatts_hash,
                                              &relid,
                                              HASH_FIND,
                                              &found);
    if (!found)
        return NULL;
 
    return hentry->notnullattnums;
}

References fb(), HASH_FIND, hash_search(), NotnullHashEntry::notnullattnums, and root.

Referenced by get_relation_info(), and var_is_nonnullable().

function_selectivity()

Selectivity function_selectivity ( PlannerInfo *  root, Oid  funcid, List *  args, Oid  inputcollid, bool  is_join, int  varRelid, JoinType  jointype, SpecialJoinInfo *  sjinfo  )

extern

Definition at line 2306 of file plancat.c.

{
    RegProcedure prosupport = get_func_support(funcid);
    SupportRequestSelectivity req;
    SupportRequestSelectivity *sresult;
 
    if (!prosupport)
        return (Selectivity) -1;    /* no support function */
 
    req.type = T_SupportRequestSelectivity;
    req.root = root;
    req.funcid = funcid;
    req.args = args;
    req.inputcollid = inputcollid;
    req.is_join = is_join;
    req.varRelid = varRelid;
    req.jointype = jointype;
    req.sjinfo = sjinfo;
    req.selectivity = -1;       /* to catch failure to set the value */
 
    sresult = (SupportRequestSelectivity *)
        DatumGetPointer(OidFunctionCall1(prosupport,
                                         PointerGetDatum(&req)));
 
    if (sresult != &req)
        return (Selectivity) -1;    /* function did not honor request */
 
    if (req.selectivity < 0.0 || req.selectivity > 1.0)
        elog(ERROR, "invalid function selectivity: %f", req.selectivity);
 
    return (Selectivity) req.selectivity;
}

References DatumGetPointer(), elog, ERROR, fb(), get_func_support(), OidFunctionCall1, PointerGetDatum(), root, and SupportRequestSelectivity::type.

Referenced by clause_selectivity_ext().

get_dependent_generated_columns()

Bitmapset * get_dependent_generated_columns ( PlannerInfo *  root, Index  rti, Bitmapset *  target_cols  )

extern

Definition at line 2642 of file plancat.c.

{
    Bitmapset  *dependentCols = NULL;
    RangeTblEntry *rte = planner_rt_fetch(rti, root);
    Relation    relation;
    TupleDesc   tupdesc;
    TupleConstr *constr;
 
    /* Assume we already have adequate lock */
    relation = table_open(rte->relid, NoLock);
 
    tupdesc = RelationGetDescr(relation);
    constr = tupdesc->constr;
 
    if (constr && constr->has_generated_stored)
    {
        for (int i = 0; i < constr->num_defval; i++)
        {
            AttrDefault *defval = &constr->defval[i];
            Node       *expr;
            Bitmapset  *attrs_used = NULL;
 
            /* skip if not generated column */
            if (!TupleDescCompactAttr(tupdesc, defval->adnum - 1)->attgenerated)
                continue;
 
            /* identify columns this generated column depends on */
            expr = stringToNode(defval->adbin);
            pull_varattnos(expr, 1, &attrs_used);
 
            if (bms_overlap(target_cols, attrs_used))
                dependentCols = bms_add_member(dependentCols,
                                               defval->adnum - FirstLowInvalidHeapAttributeNumber);
        }
    }
 
    table_close(relation, NoLock);
 
    return dependentCols;
}

References AttrDefault::adbin, AttrDefault::adnum, CompactAttribute::attgenerated, bms_add_member(), bms_overlap(), TupleDescData::constr, TupleConstr::defval, fb(), FirstLowInvalidHeapAttributeNumber, TupleConstr::has_generated_stored, i, NoLock, TupleConstr::num_defval, planner_rt_fetch, pull_varattnos(), RelationGetDescr, root, stringToNode(), table_close(), table_open(), and TupleDescCompactAttr().

Referenced by get_rel_all_updated_cols().

get_function_rows()

double get_function_rows ( PlannerInfo *  root, Oid  funcid, Node *  node  )

extern

Definition at line 2421 of file plancat.c.

{
    HeapTuple   proctup;
    Form_pg_proc procform;
    double      result;
 
    proctup = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcid));
    if (!HeapTupleIsValid(proctup))
        elog(ERROR, "cache lookup failed for function %u", funcid);
    procform = (Form_pg_proc) GETSTRUCT(proctup);
 
    Assert(procform->proretset);    /* else caller error */
 
    if (OidIsValid(procform->prosupport))
    {
        SupportRequestRows req;
        SupportRequestRows *sresult;
 
        req.type = T_SupportRequestRows;
        req.root = root;
        req.funcid = funcid;
        req.node = node;
 
        req.rows = 0;           /* just for sanity */
 
        sresult = (SupportRequestRows *)
            DatumGetPointer(OidFunctionCall1(procform->prosupport,
                                             PointerGetDatum(&req)));
 
        if (sresult == &req)
        {
            /* Success */
            ReleaseSysCache(proctup);
            return req.rows;
        }
    }
 
    /* No support function, or it failed, so rely on prorows */
    result = procform->prorows;
 
    ReleaseSysCache(proctup);
 
    return result;
}

References Assert, DatumGetPointer(), elog, ERROR, fb(), GETSTRUCT(), HeapTupleIsValid, ObjectIdGetDatum(), OidFunctionCall1, OidIsValid, PointerGetDatum(), ReleaseSysCache(), root, SearchSysCache1(), and SupportRequestRows::type.

Referenced by expression_returns_set_rows().

get_rel_data_width()

int32 get_rel_data_width ( Relation  rel, int32 *  attr_widths  )

extern

Definition at line 1435 of file plancat.c.

{
    int64       tuple_width = 0;
    int         i;
 
    for (i = 1; i <= RelationGetNumberOfAttributes(rel); i++)
    {
        Form_pg_attribute att = TupleDescAttr(rel->rd_att, i - 1);
        int32       item_width;
 
        if (att->attisdropped)
            continue;
 
        /* use previously cached data, if any */
        if (attr_widths != NULL && attr_widths[i] > 0)
        {
            tuple_width += attr_widths[i];
            continue;
        }
 
        /* This should match set_rel_width() in costsize.c */
        item_width = get_attavgwidth(RelationGetRelid(rel), i);
        if (item_width <= 0)
        {
            item_width = get_typavgwidth(att->atttypid, att->atttypmod);
            Assert(item_width > 0);
        }
        if (attr_widths != NULL)
            attr_widths[i] = item_width;
        tuple_width += item_width;
    }
 
    return clamp_width_est(tuple_width);
}

References Assert, clamp_width_est(), fb(), get_attavgwidth(), get_typavgwidth(), i, RelationData::rd_att, RelationGetNumberOfAttributes, RelationGetRelid, and TupleDescAttr().

Referenced by estimate_rel_size(), get_relation_data_width(), and table_block_relation_estimate_size().

get_relation_data_width()

int32 get_relation_data_width ( Oid  relid, int32 *  attr_widths  )

extern

Definition at line 1477 of file plancat.c.

{
    int32       result;
    Relation    relation;
 
    /* As above, assume relation is already locked */
    relation = table_open(relid, NoLock);
 
    result = get_rel_data_width(relation, attr_widths);
 
    table_close(relation, NoLock);
 
    return result;
}

References fb(), get_rel_data_width(), NoLock, table_close(), and table_open().

Referenced by plan_cluster_use_sort(), and set_rel_width().

get_relation_info()

void get_relation_info ( PlannerInfo *  root, Oid  relationObjectId, bool  inhparent, RelOptInfo *  rel  )

extern

Definition at line 124 of file plancat.c.

{
    Index       varno = rel->relid;
    Relation    relation;
    bool        hasindex;
    List       *indexinfos = NIL;
 
    /*
     * We need not lock the relation since it was already locked, either by
     * the rewriter or when expand_inherited_rtentry() added it to the query's
     * rangetable.
     */
    relation = table_open(relationObjectId, NoLock);
 
    /*
     * Relations without a table AM can be used in a query only if they are of
     * special-cased relkinds.  This check prevents us from crashing later if,
     * for example, a view's ON SELECT rule has gone missing.  Note that
     * table_open() already rejected indexes and composite types; spell the
     * error the same way it does.
     */
    if (!relation->rd_tableam)
    {
        if (!(relation->rd_rel->relkind == RELKIND_FOREIGN_TABLE ||
              relation->rd_rel->relkind == RELKIND_PARTITIONED_TABLE))
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("cannot open relation \"%s\"",
                            RelationGetRelationName(relation)),
                     errdetail_relkind_not_supported(relation->rd_rel->relkind)));
    }
 
    /* Temporary and unlogged relations are inaccessible during recovery. */
    if (!RelationIsPermanent(relation) && RecoveryInProgress())
        ereport(ERROR,
                (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                 errmsg("cannot access temporary or unlogged relations during recovery")));
 
    rel->min_attr = FirstLowInvalidHeapAttributeNumber + 1;
    rel->max_attr = RelationGetNumberOfAttributes(relation);
    rel->reltablespace = RelationGetForm(relation)->reltablespace;
 
    Assert(rel->max_attr >= rel->min_attr);
    rel->attr_needed = (Relids *)
        palloc0((rel->max_attr - rel->min_attr + 1) * sizeof(Relids));
    rel->attr_widths = (int32 *)
        palloc0((rel->max_attr - rel->min_attr + 1) * sizeof(int32));
 
    /*
     * Record which columns are defined as NOT NULL.  We leave this
     * unpopulated for non-partitioned inheritance parent relations as it's
     * ambiguous as to what it means.  Some child tables may have a NOT NULL
     * constraint for a column while others may not.  We could work harder and
     * build a unioned set of all child relations notnullattnums, but there's
     * currently no need.  The RelOptInfo corresponding to the !inh
     * RangeTblEntry does get populated.
     */
    if (!inhparent || relation->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
        rel->notnullattnums = find_relation_notnullatts(root, relationObjectId);
 
    /*
     * Estimate relation size --- unless it's an inheritance parent, in which
     * case the size we want is not the rel's own size but the size of its
     * inheritance tree.  That will be computed in set_append_rel_size().
     */
    if (!inhparent)
        estimate_rel_size(relation, rel->attr_widths - rel->min_attr,
                          &rel->pages, &rel->tuples, &rel->allvisfrac);
 
    /* Retrieve the parallel_workers reloption, or -1 if not set. */
    rel->rel_parallel_workers = RelationGetParallelWorkers(relation, -1);
 
    /*
     * Make list of indexes.  Ignore indexes on system catalogs if told to.
     * Don't bother with indexes from traditional inheritance parents.  For
     * partitioned tables, we need a list of at least unique indexes as these
     * serve as unique proofs for certain planner optimizations.  However,
     * let's not discriminate here and just record all partitioned indexes
     * whether they're unique indexes or not.
     */
    if ((inhparent && relation->rd_rel->relkind != RELKIND_PARTITIONED_TABLE)
        || (IgnoreSystemIndexes && IsSystemRelation(relation)))
        hasindex = false;
    else
        hasindex = relation->rd_rel->relhasindex;
 
    if (hasindex)
    {
        List       *indexoidlist;
        LOCKMODE    lmode;
        ListCell   *l;
 
        indexoidlist = RelationGetIndexList(relation);
 
        /*
         * For each index, we get the same type of lock that the executor will
         * need, and do not release it.  This saves a couple of trips to the
         * shared lock manager while not creating any real loss of
         * concurrency, because no schema changes could be happening on the
         * index while we hold lock on the parent rel, and no lock type used
         * for queries blocks any other kind of index operation.
         */
        lmode = root->simple_rte_array[varno]->rellockmode;
 
        foreach(l, indexoidlist)
        {
            Oid         indexoid = lfirst_oid(l);
            Relation    indexRelation;
            Form_pg_index index;
            const IndexAmRoutine *amroutine = NULL;
            IndexOptInfo *info;
            int         ncolumns,
                        nkeycolumns;
            int         i;
 
            /*
             * Extract info from the relation descriptor for the index.
             */
            indexRelation = index_open(indexoid, lmode);
            index = indexRelation->rd_index;
 
            /*
             * Ignore invalid indexes, since they can't safely be used for
             * queries.  Note that this is OK because the data structure we
             * are constructing is only used by the planner --- the executor
             * still needs to insert into "invalid" indexes, if they're marked
             * indisready.
             */
            if (!index->indisvalid)
            {
                index_close(indexRelation, NoLock);
                continue;
            }
 
            /*
             * If the index is valid, but cannot yet be used, ignore it; but
             * mark the plan we are generating as transient. See
             * src/backend/access/heap/README.HOT for discussion.
             */
            if (index->indcheckxmin &&
                !TransactionIdPrecedes(HeapTupleHeaderGetXmin(indexRelation->rd_indextuple->t_data),
                                       TransactionXmin))
            {
                root->glob->transientPlan = true;
                index_close(indexRelation, NoLock);
                continue;
            }
 
            info = makeNode(IndexOptInfo);
 
            info->indexoid = index->indexrelid;
            info->reltablespace =
                RelationGetForm(indexRelation)->reltablespace;
            info->rel = rel;
            info->ncolumns = ncolumns = index->indnatts;
            info->nkeycolumns = nkeycolumns = index->indnkeyatts;
 
            info->indexkeys = palloc_array(int, ncolumns);
            info->indexcollations = palloc_array(Oid, nkeycolumns);
            info->opfamily = palloc_array(Oid, nkeycolumns);
            info->opcintype = palloc_array(Oid, nkeycolumns);
            info->canreturn = palloc_array(bool, ncolumns);
 
            for (i = 0; i < ncolumns; i++)
            {
                info->indexkeys[i] = index->indkey.values[i];
                info->canreturn[i] = index_can_return(indexRelation, i + 1);
            }
 
            for (i = 0; i < nkeycolumns; i++)
            {
                info->opfamily[i] = indexRelation->rd_opfamily[i];
                info->opcintype[i] = indexRelation->rd_opcintype[i];
                info->indexcollations[i] = indexRelation->rd_indcollation[i];
            }
 
            info->relam = indexRelation->rd_rel->relam;
 
            /*
             * We don't have an AM for partitioned indexes, so we'll just
             * NULLify the AM related fields for those.
             */
            if (indexRelation->rd_rel->relkind != RELKIND_PARTITIONED_INDEX)
            {
                /* We copy just the fields we need, not all of rd_indam */
                amroutine = indexRelation->rd_indam;
                info->amcanorderbyop = amroutine->amcanorderbyop;
                info->amoptionalkey = amroutine->amoptionalkey;
                info->amsearcharray = amroutine->amsearcharray;
                info->amsearchnulls = amroutine->amsearchnulls;
                info->amcanparallel = amroutine->amcanparallel;
                info->amhasgettuple = (amroutine->amgettuple != NULL);
                info->amhasgetbitmap = amroutine->amgetbitmap != NULL &&
                    relation->rd_tableam->scan_bitmap_next_tuple != NULL;
                info->amcanmarkpos = (amroutine->ammarkpos != NULL &&
                                      amroutine->amrestrpos != NULL);
                info->amcostestimate = amroutine->amcostestimate;
                Assert(info->amcostestimate != NULL);
 
                /* Fetch index opclass options */
                info->opclassoptions = RelationGetIndexAttOptions(indexRelation, true);
 
                /*
                 * Fetch the ordering information for the index, if any.
                 */
                if (info->relam == BTREE_AM_OID)
                {
                    /*
                     * If it's a btree index, we can use its opfamily OIDs
                     * directly as the sort ordering opfamily OIDs.
                     */
                    Assert(amroutine->amcanorder);
 
                    info->sortopfamily = info->opfamily;
                    info->reverse_sort = palloc_array(bool, nkeycolumns);
                    info->nulls_first = palloc_array(bool, nkeycolumns);
 
                    for (i = 0; i < nkeycolumns; i++)
                    {
                        int16       opt = indexRelation->rd_indoption[i];
 
                        info->reverse_sort[i] = (opt & INDOPTION_DESC) != 0;
                        info->nulls_first[i] = (opt & INDOPTION_NULLS_FIRST) != 0;
                    }
                }
                else if (amroutine->amcanorder)
                {
                    /*
                     * Otherwise, identify the corresponding btree opfamilies
                     * by trying to map this index's "<" operators into btree.
                     * Since "<" uniquely defines the behavior of a sort
                     * order, this is a sufficient test.
                     *
                     * XXX This method is rather slow and complicated.  It'd
                     * be better to have a way to explicitly declare the
                     * corresponding btree opfamily for each opfamily of the
                     * other index type.
                     */
                    info->sortopfamily = palloc_array(Oid, nkeycolumns);
                    info->reverse_sort = palloc_array(bool, nkeycolumns);
                    info->nulls_first = palloc_array(bool, nkeycolumns);
 
                    for (i = 0; i < nkeycolumns; i++)
                    {
                        int16       opt = indexRelation->rd_indoption[i];
                        Oid         ltopr;
                        Oid         opfamily;
                        Oid         opcintype;
                        CompareType cmptype;
 
                        info->reverse_sort[i] = (opt & INDOPTION_DESC) != 0;
                        info->nulls_first[i] = (opt & INDOPTION_NULLS_FIRST) != 0;
 
                        ltopr = get_opfamily_member_for_cmptype(info->opfamily[i],
                                                                info->opcintype[i],
                                                                info->opcintype[i],
                                                                COMPARE_LT);
                        if (OidIsValid(ltopr) &&
                            get_ordering_op_properties(ltopr,
                                                       &opfamily,
                                                       &opcintype,
                                                       &cmptype) &&
                            opcintype == info->opcintype[i] &&
                            cmptype == COMPARE_LT)
                        {
                            /* Successful mapping */
                            info->sortopfamily[i] = opfamily;
                        }
                        else
                        {
                            /* Fail ... quietly treat index as unordered */
                            info->sortopfamily = NULL;
                            info->reverse_sort = NULL;
                            info->nulls_first = NULL;
                            break;
                        }
                    }
                }
                else
                {
                    info->sortopfamily = NULL;
                    info->reverse_sort = NULL;
                    info->nulls_first = NULL;
                }
            }
            else
            {
                info->amcanorderbyop = false;
                info->amoptionalkey = false;
                info->amsearcharray = false;
                info->amsearchnulls = false;
                info->amcanparallel = false;
                info->amhasgettuple = false;
                info->amhasgetbitmap = false;
                info->amcanmarkpos = false;
                info->amcostestimate = NULL;
 
                info->sortopfamily = NULL;
                info->reverse_sort = NULL;
                info->nulls_first = NULL;
            }
 
            /*
             * Fetch the index expressions and predicate, if any.  We must
             * modify the copies we obtain from the relcache to have the
             * correct varno for the parent relation, so that they match up
             * correctly against qual clauses.
             *
             * After fixing the varnos, we need to run the index expressions
             * and predicate through const-simplification again, using a valid
             * "root".  This ensures that NullTest quals for Vars can be
             * properly reduced.
             */
            info->indexprs = RelationGetIndexExpressions(indexRelation);
            info->indpred = RelationGetIndexPredicate(indexRelation);
            if (info->indexprs)
            {
                if (varno != 1)
                    ChangeVarNodes((Node *) info->indexprs, 1, varno, 0);
 
                info->indexprs = (List *)
                    eval_const_expressions(root, (Node *) info->indexprs);
            }
            if (info->indpred)
            {
                if (varno != 1)
                    ChangeVarNodes((Node *) info->indpred, 1, varno, 0);
 
                info->indpred = (List *)
                    eval_const_expressions(root,
                                           (Node *) make_ands_explicit(info->indpred));
                info->indpred = make_ands_implicit((Expr *) info->indpred);
            }
 
            /* Build targetlist using the completed indexprs data */
            info->indextlist = build_index_tlist(root, info, relation);
 
            info->indrestrictinfo = NIL;    /* set later, in indxpath.c */
            info->predOK = false;   /* set later, in indxpath.c */
            info->unique = index->indisunique;
            info->nullsnotdistinct = index->indnullsnotdistinct;
            info->immediate = index->indimmediate;
            info->hypothetical = false;
 
            /*
             * Estimate the index size.  If it's not a partial index, we lock
             * the number-of-tuples estimate to equal the parent table; if it
             * is partial then we have to use the same methods as we would for
             * a table, except we can be sure that the index is not larger
             * than the table.  We must ignore partitioned indexes here as
             * there are not physical indexes.
             */
            if (indexRelation->rd_rel->relkind != RELKIND_PARTITIONED_INDEX)
            {
                if (info->indpred == NIL)
                {
                    info->pages = RelationGetNumberOfBlocks(indexRelation);
                    info->tuples = rel->tuples;
                }
                else
                {
                    double      allvisfrac; /* dummy */
 
                    estimate_rel_size(indexRelation, NULL,
                                      &info->pages, &info->tuples, &allvisfrac);
                    if (info->tuples > rel->tuples)
                        info->tuples = rel->tuples;
                }
 
                /*
                 * Get tree height while we have the index open
                 */
                if (amroutine->amgettreeheight)
                {
                    info->tree_height = amroutine->amgettreeheight(indexRelation);
                }
                else
                {
                    /* For other index types, just set it to "unknown" for now */
                    info->tree_height = -1;
                }
            }
            else
            {
                /* Zero these out for partitioned indexes */
                info->pages = 0;
                info->tuples = 0.0;
                info->tree_height = -1;
            }
 
            index_close(indexRelation, NoLock);
 
            /*
             * We've historically used lcons() here.  It'd make more sense to
             * use lappend(), but that causes the planner to change behavior
             * in cases where two indexes seem equally attractive.  For now,
             * stick with lcons() --- few tables should have so many indexes
             * that the O(N^2) behavior of lcons() is really a problem.
             */
            indexinfos = lcons(info, indexinfos);
        }
 
        list_free(indexoidlist);
    }
 
    rel->indexlist = indexinfos;
 
    rel->statlist = get_relation_statistics(root, rel, relation);
 
    /* Grab foreign-table info using the relcache, while we have it */
    if (relation->rd_rel->relkind == RELKIND_FOREIGN_TABLE)
    {
        /* Check if the access to foreign tables is restricted */
        if (unlikely((restrict_nonsystem_relation_kind & RESTRICT_RELKIND_FOREIGN_TABLE) != 0))
        {
            /* there must not be built-in foreign tables */
            Assert(RelationGetRelid(relation) >= FirstNormalObjectId);
 
            ereport(ERROR,
                    (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                     errmsg("access to non-system foreign table is restricted")));
        }
 
        rel->serverid = GetForeignServerIdByRelId(RelationGetRelid(relation));
        rel->fdwroutine = GetFdwRoutineForRelation(relation, true);
    }
    else
    {
        rel->serverid = InvalidOid;
        rel->fdwroutine = NULL;
    }
 
    /* Collect info about relation's foreign keys, if relevant */
    get_relation_foreign_keys(root, rel, relation, inhparent);
 
    /* Collect info about functions implemented by the rel's table AM. */
    if (relation->rd_tableam &&
        relation->rd_tableam->scan_set_tidrange != NULL &&
        relation->rd_tableam->scan_getnextslot_tidrange != NULL)
        rel->amflags |= AMFLAG_HAS_TID_RANGE;
 
    /*
     * Collect info about relation's partitioning scheme, if any. Only
     * inheritance parents may be partitioned.
     */
    if (inhparent && relation->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
        set_relation_partition_info(root, rel, relation);
 
    table_close(relation, NoLock);
 
    /*
     * Allow a plugin to editorialize on the info we obtained from the
     * catalogs.  Actions might include altering the assumed relation size,
     * removing an index, or adding a hypothetical index to the indexlist.
     *
     * An extension can also modify rel->pgs_mask here to control path
     * generation.
     */
    if (get_relation_info_hook)
        (*get_relation_info_hook) (root, relationObjectId, inhparent, rel);
}

References RelOptInfo::allvisfrac, IndexOptInfo::amcanmarkpos, IndexOptInfo::amcanorderbyop, IndexOptInfo::amcanparallel, IndexOptInfo::amcostestimate, AMFLAG_HAS_TID_RANGE, RelOptInfo::amflags, IndexOptInfo::amhasgetbitmap, IndexOptInfo::amhasgettuple, IndexOptInfo::amoptionalkey, IndexOptInfo::amsearcharray, IndexOptInfo::amsearchnulls, Assert, build_index_tlist(), ChangeVarNodes(), COMPARE_LT, ereport, errcode(), errdetail_relkind_not_supported(), errmsg(), ERROR, estimate_rel_size(), eval_const_expressions(), fb(), find_relation_notnullatts(), FirstLowInvalidHeapAttributeNumber, FirstNormalObjectId, get_opfamily_member_for_cmptype(), get_ordering_op_properties(), get_relation_foreign_keys(), get_relation_info_hook, get_relation_statistics(), GetFdwRoutineForRelation(), GetForeignServerIdByRelId(), HeapTupleHeaderGetXmin(), IndexOptInfo::hypothetical, i, IgnoreSystemIndexes, IndexOptInfo::immediate, index_can_return(), index_close(), index_open(), RelOptInfo::indexlist, IndexOptInfo::indexoid, IndexOptInfo::indextlist, IndexOptInfo::indpred, IndexOptInfo::indrestrictinfo, InvalidOid, IsSystemRelation(), lcons(), lfirst_oid, list_free(), make_ands_explicit(), make_ands_implicit(), makeNode, RelOptInfo::max_attr, RelOptInfo::min_attr, IndexOptInfo::ncolumns, NIL, IndexOptInfo::nkeycolumns, NoLock, RelOptInfo::notnullattnums, IndexOptInfo::nullsnotdistinct, OidIsValid, RelOptInfo::pages, IndexOptInfo::pages, palloc0(), palloc_array, IndexOptInfo::predOK, RelationData::rd_indam, RelationData::rd_indcollation, RelationData::rd_index, RelationData::rd_indextuple, RelationData::rd_indoption, RelationData::rd_opcintype, RelationData::rd_opfamily, RelationData::rd_rel, RelationData::rd_tableam, RecoveryInProgress(), RelOptInfo::rel_parallel_workers, IndexOptInfo::relam, RelationGetForm, RelationGetIndexAttOptions(), RelationGetIndexExpressions(), RelationGetIndexList(), RelationGetIndexPredicate(), RelationGetNumberOfAttributes, RelationGetNumberOfBlocks, RelationGetParallelWorkers, RelationGetRelationName, RelationGetRelid, RelationIsPermanent, RelOptInfo::relid, RelOptInfo::reltablespace, IndexOptInfo::reltablespace, restrict_nonsystem_relation_kind, RESTRICT_RELKIND_FOREIGN_TABLE, root, TableAmRoutine::scan_bitmap_next_tuple, TableAmRoutine::scan_getnextslot_tidrange, TableAmRoutine::scan_set_tidrange, RelOptInfo::serverid, set_relation_partition_info(), RelOptInfo::statlist, HeapTupleData::t_data, table_close(), table_open(), TransactionIdPrecedes(), TransactionXmin, IndexOptInfo::tree_height, RelOptInfo::tuples, IndexOptInfo::tuples, IndexOptInfo::unique, and unlikely.

Referenced by build_simple_rel().

get_relation_notnullatts()

void get_relation_notnullatts ( PlannerInfo *  root, Relation  relation  )

extern

Definition at line 704 of file plancat.c.

{
    Oid         relid = RelationGetRelid(relation);
    NotnullHashEntry *hentry;
    bool        found;
    Bitmapset  *notnullattnums = NULL;
 
    /* bail out if the relation has no not-null constraints */
    if (relation->rd_att->constr == NULL ||
        !relation->rd_att->constr->has_not_null)
        return;
 
    /* create the hash table if it hasn't been created yet */
    if (root->glob->rel_notnullatts_hash == NULL)
    {
        HTAB       *hashtab;
        HASHCTL     hash_ctl;
 
        hash_ctl.keysize = sizeof(Oid);
        hash_ctl.entrysize = sizeof(NotnullHashEntry);
        hash_ctl.hcxt = CurrentMemoryContext;
 
        hashtab = hash_create("Relation NOT NULL attnums",
                              64L,  /* arbitrary initial size */
                              &hash_ctl,
                              HASH_ELEM | HASH_BLOBS | HASH_CONTEXT);
 
        root->glob->rel_notnullatts_hash = hashtab;
    }
 
    /*
     * Create a hash entry for this relation OID, if we don't have one
     * already.
     */
    hentry = (NotnullHashEntry *) hash_search(root->glob->rel_notnullatts_hash,
                                              &relid,
                                              HASH_ENTER,
                                              &found);
 
    /* bail out if a hash entry already exists for this relation OID */
    if (found)
        return;
 
    /* collect the column not-null constraint information for this relation */
    for (int i = 0; i < relation->rd_att->natts; i++)
    {
        CompactAttribute *attr = TupleDescCompactAttr(relation->rd_att, i);
 
        Assert(attr->attnullability != ATTNULLABLE_UNKNOWN);
 
        if (attr->attnullability == ATTNULLABLE_VALID)
        {
            notnullattnums = bms_add_member(notnullattnums, i + 1);
 
            /*
             * Per RemoveAttributeById(), dropped columns will have their
             * attnotnull unset, so we needn't check for dropped columns in
             * the above condition.
             */
            Assert(!attr->attisdropped);
        }
    }
 
    /* ... and initialize the new hash entry */
    hentry->notnullattnums = notnullattnums;
}

References Assert, CompactAttribute::attisdropped, CompactAttribute::attnullability, ATTNULLABLE_UNKNOWN, ATTNULLABLE_VALID, bms_add_member(), TupleDescData::constr, CurrentMemoryContext, fb(), TupleConstr::has_not_null, HASH_BLOBS, HASH_CONTEXT, hash_create(), HASH_ELEM, HASH_ENTER, hash_search(), i, HASHCTL::keysize, TupleDescData::natts, RelationData::rd_att, RelationGetRelid, root, and TupleDescCompactAttr().

Referenced by expand_single_inheritance_child(), and preprocess_relation_rtes().

has_row_triggers()

bool has_row_triggers ( PlannerInfo *  root, Index  rti, CmdType  event  )

extern

Definition at line 2511 of file plancat.c.

{
    RangeTblEntry *rte = planner_rt_fetch(rti, root);
    Relation    relation;
    TriggerDesc *trigDesc;
    bool        result = false;
 
    /* Assume we already have adequate lock */
    relation = table_open(rte->relid, NoLock);
 
    trigDesc = relation->trigdesc;
    switch (event)
    {
        case CMD_INSERT:
            if (trigDesc &&
                (trigDesc->trig_insert_after_row ||
                 trigDesc->trig_insert_before_row))
                result = true;
            break;
        case CMD_UPDATE:
            if (trigDesc &&
                (trigDesc->trig_update_after_row ||
                 trigDesc->trig_update_before_row))
                result = true;
            break;
        case CMD_DELETE:
            if (trigDesc &&
                (trigDesc->trig_delete_after_row ||
                 trigDesc->trig_delete_before_row))
                result = true;
            break;
            /* There is no separate event for MERGE, only INSERT/UPDATE/DELETE */
        case CMD_MERGE:
            result = false;
            break;
        default:
            elog(ERROR, "unrecognized CmdType: %d", (int) event);
            break;
    }
 
    table_close(relation, NoLock);
    return result;
}

References CMD_DELETE, CMD_INSERT, CMD_MERGE, CMD_UPDATE, elog, ERROR, fb(), NoLock, planner_rt_fetch, root, table_close(), table_open(), and RelationData::trigdesc.

Referenced by make_modifytable().

has_stored_generated_columns()

bool has_stored_generated_columns ( PlannerInfo *  root, Index  rti  )

extern

Definition at line 2615 of file plancat.c.

{
    RangeTblEntry *rte = planner_rt_fetch(rti, root);
    Relation    relation;
    TupleDesc   tupdesc;
    bool        result = false;
 
    /* Assume we already have adequate lock */
    relation = table_open(rte->relid, NoLock);
 
    tupdesc = RelationGetDescr(relation);
    result = tupdesc->constr && tupdesc->constr->has_generated_stored;
 
    table_close(relation, NoLock);
 
    return result;
}

References TupleDescData::constr, fb(), TupleConstr::has_generated_stored, NoLock, planner_rt_fetch, RelationGetDescr, root, table_close(), and table_open().

Referenced by make_modifytable().

has_transition_tables()

bool has_transition_tables ( PlannerInfo *  root, Index  rti, CmdType  event  )

extern

Definition at line 2561 of file plancat.c.

{
    RangeTblEntry *rte = planner_rt_fetch(rti, root);
    Relation    relation;
    TriggerDesc *trigDesc;
    bool        result = false;
 
    Assert(rte->rtekind == RTE_RELATION);
 
    /* Currently foreign tables cannot have transition tables */
    if (rte->relkind == RELKIND_FOREIGN_TABLE)
        return result;
 
    /* Assume we already have adequate lock */
    relation = table_open(rte->relid, NoLock);
 
    trigDesc = relation->trigdesc;
    switch (event)
    {
        case CMD_INSERT:
            if (trigDesc &&
                trigDesc->trig_insert_new_table)
                result = true;
            break;
        case CMD_UPDATE:
            if (trigDesc &&
                (trigDesc->trig_update_old_table ||
                 trigDesc->trig_update_new_table))
                result = true;
            break;
        case CMD_DELETE:
            if (trigDesc &&
                trigDesc->trig_delete_old_table)
                result = true;
            break;
            /* There is no separate event for MERGE, only INSERT/UPDATE/DELETE */
        case CMD_MERGE:
            result = false;
            break;
        default:
            elog(ERROR, "unrecognized CmdType: %d", (int) event);
            break;
    }
 
    table_close(relation, NoLock);
    return result;
}

References Assert, CMD_DELETE, CMD_INSERT, CMD_MERGE, CMD_UPDATE, elog, ERROR, fb(), NoLock, planner_rt_fetch, root, RTE_RELATION, table_close(), table_open(), and RelationData::trigdesc.

Referenced by make_modifytable().

has_unique_index()

bool has_unique_index ( RelOptInfo *  rel, AttrNumber  attno  )

extern

Definition at line 2479 of file plancat.c.

{
    ListCell   *ilist;
 
    foreach(ilist, rel->indexlist)
    {
        IndexOptInfo *index = (IndexOptInfo *) lfirst(ilist);
 
        /*
         * Note: ignore partial indexes, since they don't allow us to conclude
         * that all attr values are distinct, *unless* they are marked predOK
         * which means we know the index's predicate is satisfied by the
         * query. We don't take any interest in expressional indexes either.
         * Also, a multicolumn unique index doesn't allow us to conclude that
         * just the specified attr is unique.
         */
        if (index->unique &&
            index->nkeycolumns == 1 &&
            index->indexkeys[0] == attno &&
            (index->indpred == NIL || index->predOK))
            return true;
    }
    return false;
}

References fb(), RelOptInfo::indexlist, lfirst, and NIL.

Referenced by examine_variable().

infer_arbiter_indexes()

List * infer_arbiter_indexes ( PlannerInfo *  root )

extern

Definition at line 816 of file plancat.c.

{
    OnConflictExpr *onconflict = root->parse->onConflict;
 
    /* Iteration state */
    Index       varno;
    RangeTblEntry *rte;
    Relation    relation;
    Oid         indexOidFromConstraint = InvalidOid;
    List       *indexList;
    List       *indexRelList = NIL;
 
    /*
     * Required attributes and expressions used to match indexes to the clause
     * given by the user.  In the ON CONFLICT ON CONSTRAINT case, we compute
     * these from that constraint's index to match all other indexes, to
     * account for the case where that index is being concurrently reindexed.
     */
    List       *inferIndexExprs = (List *) onconflict->arbiterWhere;
    Bitmapset  *inferAttrs = NULL;
    List       *inferElems = NIL;
 
    /* Results */
    List       *results = NIL;
    bool        foundValid = false;
 
    /*
     * Quickly return NIL for ON CONFLICT DO NOTHING without an inference
     * specification or named constraint.  ON CONFLICT DO UPDATE statements
     * must always provide one or the other (but parser ought to have caught
     * that already).
     */
    if (onconflict->arbiterElems == NIL &&
        onconflict->constraint == InvalidOid)
        return NIL;
 
    /*
     * We need not lock the relation since it was already locked, either by
     * the rewriter or when expand_inherited_rtentry() added it to the query's
     * rangetable.
     */
    varno = root->parse->resultRelation;
    rte = rt_fetch(varno, root->parse->rtable);
 
    relation = table_open(rte->relid, NoLock);
 
    /*
     * Build normalized/BMS representation of plain indexed attributes, as
     * well as a separate list of expression items.  This simplifies matching
     * the cataloged definition of indexes.
     */
    foreach_ptr(InferenceElem, elem, onconflict->arbiterElems)
    {
        Var        *var;
        int         attno;
 
        /* we cannot also have a constraint name, per grammar */
        Assert(!OidIsValid(onconflict->constraint));
 
        if (!IsA(elem->expr, Var))
        {
            /* If not a plain Var, just shove it in inferElems for now */
            inferElems = lappend(inferElems, elem->expr);
            continue;
        }
 
        var = (Var *) elem->expr;
        attno = var->varattno;
 
        if (attno == 0)
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("whole row unique index inference specifications are not supported")));
 
        inferAttrs = bms_add_member(inferAttrs,
                                    attno - FirstLowInvalidHeapAttributeNumber);
    }
 
    /*
     * Next, open all the indexes.  We need this list for two things: first,
     * if an ON CONSTRAINT clause was given, and that constraint's index is
     * undergoing REINDEX CONCURRENTLY, then we need to consider all matches
     * for that index.  Second, if an attribute list was specified in the ON
     * CONFLICT clause, we use the list to find the indexes whose attributes
     * match that list.
     */
    indexList = RelationGetIndexList(relation);
    foreach_oid(indexoid, indexList)
    {
        Relation    idxRel;
 
        /* obtain the same lock type that the executor will ultimately use */
        idxRel = index_open(indexoid, rte->rellockmode);
        indexRelList = lappend(indexRelList, idxRel);
    }
 
    /*
     * If a constraint was named in the command, look up its index.  We don't
     * return it immediately because we need some additional sanity checks,
     * and also because we need to include other indexes as arbiters to
     * account for REINDEX CONCURRENTLY processing it.
     */
    if (onconflict->constraint != InvalidOid)
    {
        /* we cannot also have an explicit list of elements, per grammar */
        Assert(onconflict->arbiterElems == NIL);
 
        indexOidFromConstraint = get_constraint_index(onconflict->constraint);
        if (indexOidFromConstraint == InvalidOid)
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("constraint in ON CONFLICT clause has no associated index")));
 
        /*
         * Find the named constraint index to extract its attributes and
         * predicates.
         */
        foreach_ptr(RelationData, idxRel, indexRelList)
        {
            Form_pg_index idxForm = idxRel->rd_index;
 
            if (indexOidFromConstraint == idxForm->indexrelid)
            {
                /* Found it. */
                Assert(idxForm->indisready);
 
                /*
                 * Set up inferElems and inferIndexExprs to match the
                 * constraint index, so that we can match them in the loop
                 * below.
                 */
                for (int natt = 0; natt < idxForm->indnkeyatts; natt++)
                {
                    int         attno;
 
                    attno = idxRel->rd_index->indkey.values[natt];
                    if (attno != InvalidAttrNumber)
                        inferAttrs =
                            bms_add_member(inferAttrs,
                                           attno - FirstLowInvalidHeapAttributeNumber);
                }
 
                inferElems = RelationGetIndexExpressions(idxRel);
                inferIndexExprs = RelationGetIndexPredicate(idxRel);
                break;
            }
        }
    }
 
    /*
     * Using that representation, iterate through the list of indexes on the
     * target relation to find matches.
     */
    foreach_ptr(RelationData, idxRel, indexRelList)
    {
        Form_pg_index idxForm;
        Bitmapset  *indexedAttrs;
        List       *idxExprs;
        List       *predExprs;
        AttrNumber  natt;
        bool        match;
 
        /*
         * Extract info from the relation descriptor for the index.
         *
         * Let executor complain about !indimmediate case directly, because
         * enforcement needs to occur there anyway when an inference clause is
         * omitted.
         */
        idxForm = idxRel->rd_index;
 
        /*
         * Ignore indexes that aren't indisready, because we cannot trust
         * their catalog structure yet.  However, if any indexes are marked
         * indisready but not yet indisvalid, we still consider them, because
         * they might turn valid while we're running.  Doing it this way
         * allows a concurrent transaction with a slightly later catalog
         * snapshot infer the same set of indexes, which is critical to
         * prevent spurious 'duplicate key' errors.
         *
         * However, another critical aspect is that a unique index that isn't
         * yet marked indisvalid=true might not be complete yet, meaning it
         * wouldn't detect possible duplicate rows.  In order to prevent false
         * negatives, we require that we include in the set of inferred
         * indexes at least one index that is marked valid.
         */
        if (!idxForm->indisready)
            continue;
 
        /*
         * Ignore invalid indexes for partitioned tables.  It's possible that
         * some partitions don't have the index (yet), and then we would not
         * find a match during ExecInitPartitionInfo.
         */
        if (relation->rd_rel->relkind == RELKIND_PARTITIONED_TABLE &&
            !idxForm->indisvalid)
            continue;
 
        /*
         * Note that we do not perform a check against indcheckxmin (like e.g.
         * get_relation_info()) here to eliminate candidates, because
         * uniqueness checking only cares about the most recently committed
         * tuple versions.
         */
 
        /*
         * Look for match for "ON constraint_name" variant, which may not be a
         * unique constraint.  This can only be a constraint name.
         */
        if (indexOidFromConstraint == idxForm->indexrelid)
        {
            if (idxForm->indisexclusion && onconflict->action == ONCONFLICT_UPDATE)
                ereport(ERROR,
                        (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                         errmsg("ON CONFLICT DO UPDATE not supported with exclusion constraints")));
 
            /* Consider this one a match already */
            results = lappend_oid(results, idxForm->indexrelid);
            foundValid |= idxForm->indisvalid;
            continue;
        }
        else if (indexOidFromConstraint != InvalidOid)
        {
            /*
             * In the case of "ON constraint_name DO UPDATE" we need to skip
             * non-unique candidates.
             */
            if (!idxForm->indisunique && onconflict->action == ONCONFLICT_UPDATE)
                continue;
        }
        else
        {
            /*
             * Only considering conventional inference at this point (not
             * named constraints), so index under consideration can be
             * immediately skipped if it's not unique.
             */
            if (!idxForm->indisunique)
                continue;
        }
 
        /*
         * So-called unique constraints with WITHOUT OVERLAPS are really
         * exclusion constraints, so skip those too.
         */
        if (idxForm->indisexclusion)
            continue;
 
        /* Build BMS representation of plain (non expression) index attrs */
        indexedAttrs = NULL;
        for (natt = 0; natt < idxForm->indnkeyatts; natt++)
        {
            int         attno = idxRel->rd_index->indkey.values[natt];
 
            if (attno != 0)
                indexedAttrs = bms_add_member(indexedAttrs,
                                              attno - FirstLowInvalidHeapAttributeNumber);
        }
 
        /* Non-expression attributes (if any) must match */
        if (!bms_equal(indexedAttrs, inferAttrs))
            continue;
 
        /* Expression attributes (if any) must match */
        idxExprs = RelationGetIndexExpressions(idxRel);
        if (idxExprs)
        {
            if (varno != 1)
                ChangeVarNodes((Node *) idxExprs, 1, varno, 0);
 
            idxExprs = (List *) eval_const_expressions(root, (Node *) idxExprs);
        }
 
        /*
         * If arbiterElems are present, check them.  (Note that if a
         * constraint name was given in the command line, this list is NIL.)
         */
        match = true;
        foreach_ptr(InferenceElem, elem, onconflict->arbiterElems)
        {
            /*
             * Ensure that collation/opclass aspects of inference expression
             * element match.  Even though this loop is primarily concerned
             * with matching expressions, it is a convenient point to check
             * this for both expressions and ordinary (non-expression)
             * attributes appearing as inference elements.
             */
            if (!infer_collation_opclass_match(elem, idxRel, idxExprs))
            {
                match = false;
                break;
            }
 
            /*
             * Plain Vars don't factor into count of expression elements, and
             * the question of whether or not they satisfy the index
             * definition has already been considered (they must).
             */
            if (IsA(elem->expr, Var))
                continue;
 
            /*
             * Might as well avoid redundant check in the rare cases where
             * infer_collation_opclass_match() is required to do real work.
             * Otherwise, check that element expression appears in cataloged
             * index definition.
             */
            if (elem->infercollid != InvalidOid ||
                elem->inferopclass != InvalidOid ||
                list_member(idxExprs, elem->expr))
                continue;
 
            match = false;
            break;
        }
        if (!match)
            continue;
 
        /*
         * In case of inference from an attribute list, ensure that the
         * expression elements from inference clause are not missing any
         * cataloged expressions.  This does the right thing when unique
         * indexes redundantly repeat the same attribute, or if attributes
         * redundantly appear multiple times within an inference clause.
         *
         * In case a constraint was named, ensure the candidate has an equal
         * set of expressions as the named constraint's index.
         */
        if (list_difference(idxExprs, inferElems) != NIL)
            continue;
 
        predExprs = RelationGetIndexPredicate(idxRel);
        if (predExprs)
        {
            if (varno != 1)
                ChangeVarNodes((Node *) predExprs, 1, varno, 0);
 
            predExprs = (List *)
                eval_const_expressions(root,
                                       (Node *) make_ands_explicit(predExprs));
            predExprs = make_ands_implicit((Expr *) predExprs);
        }
 
        /*
         * Partial indexes affect each form of ON CONFLICT differently: if a
         * constraint was named, then the predicates must be identical.  In
         * conventional inference, the index's predicate must be implied by
         * the WHERE clause.
         */
        if (OidIsValid(indexOidFromConstraint))
        {
            if (list_difference(predExprs, inferIndexExprs) != NIL)
                continue;
        }
        else
        {
            if (!predicate_implied_by(predExprs, inferIndexExprs, false))
                continue;
        }
 
        /* All good -- consider this index a match */
        results = lappend_oid(results, idxForm->indexrelid);
        foundValid |= idxForm->indisvalid;
    }
 
    /* Close all indexes */
    foreach_ptr(RelationData, idxRel, indexRelList)
    {
        index_close(idxRel, NoLock);
    }
 
    list_free(indexList);
    list_free(indexRelList);
    table_close(relation, NoLock);
 
    /* We require at least one indisvalid index */
    if (results == NIL || !foundValid)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
                 errmsg("there is no unique or exclusion constraint matching the ON CONFLICT specification")));
 
    return results;
}

References OnConflictExpr::action, OnConflictExpr::arbiterElems, OnConflictExpr::arbiterWhere, Assert, bms_add_member(), bms_equal(), ChangeVarNodes(), OnConflictExpr::constraint, ereport, errcode(), errmsg(), ERROR, eval_const_expressions(), fb(), FirstLowInvalidHeapAttributeNumber, foreach_oid, foreach_ptr, get_constraint_index(), index_close(), index_open(), infer_collation_opclass_match(), InvalidAttrNumber, InvalidOid, IsA, lappend(), lappend_oid(), list_difference(), list_free(), list_member(), make_ands_explicit(), make_ands_implicit(), NIL, NoLock, OidIsValid, ONCONFLICT_UPDATE, predicate_implied_by(), RelationData::rd_rel, RelationGetIndexExpressions(), RelationGetIndexList(), RelationGetIndexPredicate(), root, rt_fetch, table_close(), table_open(), and Var::varattno.

Referenced by make_modifytable().

join_selectivity()

Selectivity join_selectivity ( PlannerInfo *  root, Oid  operatorid, List *  args, Oid  inputcollid, JoinType  jointype, SpecialJoinInfo *  sjinfo  )

extern

Definition at line 2266 of file plancat.c.

{
    RegProcedure oprjoin = get_oprjoin(operatorid);
    float8      result;
 
    /*
     * if the oprjoin procedure is missing for whatever reason, use a
     * selectivity of 0.5
     */
    if (!oprjoin)
        return (Selectivity) 0.5;
 
    result = DatumGetFloat8(OidFunctionCall5Coll(oprjoin,
                                                 inputcollid,
                                                 PointerGetDatum(root),
                                                 ObjectIdGetDatum(operatorid),
                                                 PointerGetDatum(args),
                                                 Int16GetDatum(jointype),
                                                 PointerGetDatum(sjinfo)));
 
    if (result < 0.0 || result > 1.0)
        elog(ERROR, "invalid join selectivity: %f", result);
 
    return (Selectivity) result;
}

References DatumGetFloat8(), elog, ERROR, fb(), get_oprjoin(), Int16GetDatum(), ObjectIdGetDatum(), OidFunctionCall5Coll(), PointerGetDatum(), and root.

Referenced by clause_selectivity_ext(), rowcomparesel(), and test_support_func().

relation_excluded_by_constraints()

bool relation_excluded_by_constraints ( PlannerInfo *  root, RelOptInfo *  rel, RangeTblEntry *  rte  )

extern

Definition at line 1854 of file plancat.c.

{
    bool        include_noinherit;
    bool        include_notnull;
    bool        include_partition = false;
    List       *safe_restrictions;
    List       *constraint_pred;
    List       *safe_constraints;
    ListCell   *lc;
 
    /* As of now, constraint exclusion works only with simple relations. */
    Assert(IS_SIMPLE_REL(rel));
 
    /*
     * If there are no base restriction clauses, we have no hope of proving
     * anything below, so fall out quickly.
     */
    if (rel->baserestrictinfo == NIL)
        return false;
 
    /*
     * Regardless of the setting of constraint_exclusion, detect
     * constant-FALSE-or-NULL restriction clauses.  Although const-folding
     * will reduce "anything AND FALSE" to just "FALSE", the baserestrictinfo
     * list can still have other members besides the FALSE constant, due to
     * qual pushdown and other mechanisms; so check them all.  This doesn't
     * fire very often, but it seems cheap enough to be worth doing anyway.
     * (Without this, we'd miss some optimizations that 9.5 and earlier found
     * via much more roundabout methods.)
     */
    foreach(lc, rel->baserestrictinfo)
    {
        RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
        Expr       *clause = rinfo->clause;
 
        if (clause && IsA(clause, Const) &&
            (((Const *) clause)->constisnull ||
             !DatumGetBool(((Const *) clause)->constvalue)))
            return true;
    }
 
    /*
     * Skip further tests, depending on constraint_exclusion.
     */
    switch (constraint_exclusion)
    {
        case CONSTRAINT_EXCLUSION_OFF:
            /* In 'off' mode, never make any further tests */
            return false;
 
        case CONSTRAINT_EXCLUSION_PARTITION:
 
            /*
             * When constraint_exclusion is set to 'partition' we only handle
             * appendrel members.  Partition pruning has already been applied,
             * so there is no need to consider the rel's partition constraints
             * here.
             */
            if (rel->reloptkind == RELOPT_OTHER_MEMBER_REL)
                break;          /* appendrel member, so process it */
            return false;
 
        case CONSTRAINT_EXCLUSION_ON:
 
            /*
             * In 'on' mode, always apply constraint exclusion.  If we are
             * considering a baserel that is a partition (i.e., it was
             * directly named rather than expanded from a parent table), then
             * its partition constraints haven't been considered yet, so
             * include them in the processing here.
             */
            if (rel->reloptkind == RELOPT_BASEREL)
                include_partition = true;
            break;              /* always try to exclude */
    }
 
    /*
     * Check for self-contradictory restriction clauses.  We dare not make
     * deductions with non-immutable functions, but any immutable clauses that
     * are self-contradictory allow us to conclude the scan is unnecessary.
     *
     * Note: strip off RestrictInfo because predicate_refuted_by() isn't
     * expecting to see any in its predicate argument.
     */
    safe_restrictions = NIL;
    foreach(lc, rel->baserestrictinfo)
    {
        RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
 
        if (!contain_mutable_functions((Node *) rinfo->clause))
            safe_restrictions = lappend(safe_restrictions, rinfo->clause);
    }
 
    /*
     * We can use weak refutation here, since we're comparing restriction
     * clauses with restriction clauses.
     */
    if (predicate_refuted_by(safe_restrictions, safe_restrictions, true))
        return true;
 
    /*
     * Only plain relations have constraints, so stop here for other rtekinds.
     */
    if (rte->rtekind != RTE_RELATION)
        return false;
 
    /*
     * If we are scanning just this table, we can use NO INHERIT constraints,
     * but not if we're scanning its children too.  (Note that partitioned
     * tables should never have NO INHERIT constraints; but it's not necessary
     * for us to assume that here.)
     */
    include_noinherit = !rte->inh;
 
    /*
     * Currently, attnotnull constraints must be treated as NO INHERIT unless
     * this is a partitioned table.  In future we might track their
     * inheritance status more accurately, allowing this to be refined.
     *
     * XXX do we need/want to change this?
     */
    include_notnull = (!rte->inh || rte->relkind == RELKIND_PARTITIONED_TABLE);
 
    /*
     * Fetch the appropriate set of constraint expressions.
     */
    constraint_pred = get_relation_constraints(root, rte->relid, rel,
                                               include_noinherit,
                                               include_notnull,
                                               include_partition);
 
    /*
     * We do not currently enforce that CHECK constraints contain only
     * immutable functions, so it's necessary to check here. We daren't draw
     * conclusions from plan-time evaluation of non-immutable functions. Since
     * they're ANDed, we can just ignore any mutable constraints in the list,
     * and reason about the rest.
     */
    safe_constraints = NIL;
    foreach(lc, constraint_pred)
    {
        Node       *pred = (Node *) lfirst(lc);
 
        if (!contain_mutable_functions(pred))
            safe_constraints = lappend(safe_constraints, pred);
    }
 
    /*
     * The constraints are effectively ANDed together, so we can just try to
     * refute the entire collection at once.  This may allow us to make proofs
     * that would fail if we took them individually.
     *
     * Note: we use rel->baserestrictinfo, not safe_restrictions as might seem
     * an obvious optimization.  Some of the clauses might be OR clauses that
     * have volatile and nonvolatile subclauses, and it's OK to make
     * deductions with the nonvolatile parts.
     *
     * We need strong refutation because we have to prove that the constraints
     * would yield false, not just NULL.
     */
    if (predicate_refuted_by(safe_constraints, rel->baserestrictinfo, false))
        return true;
 
    return false;
}

References Assert, RelOptInfo::baserestrictinfo, RestrictInfo::clause, constraint_exclusion, CONSTRAINT_EXCLUSION_OFF, CONSTRAINT_EXCLUSION_ON, CONSTRAINT_EXCLUSION_PARTITION, contain_mutable_functions(), DatumGetBool(), fb(), get_relation_constraints(), IS_SIMPLE_REL, IsA, lappend(), lfirst, NIL, predicate_refuted_by(), RELOPT_BASEREL, RELOPT_OTHER_MEMBER_REL, RelOptInfo::reloptkind, root, and RTE_RELATION.

Referenced by set_append_rel_size(), and set_rel_size().

restriction_selectivity()

Selectivity restriction_selectivity ( PlannerInfo *  root, Oid  operatorid, List *  args, Oid  inputcollid, int  varRelid  )

extern

Definition at line 2227 of file plancat.c.

{
    RegProcedure oprrest = get_oprrest(operatorid);
    float8      result;
 
    /*
     * if the oprrest procedure is missing for whatever reason, use a
     * selectivity of 0.5
     */
    if (!oprrest)
        return (Selectivity) 0.5;
 
    result = DatumGetFloat8(OidFunctionCall4Coll(oprrest,
                                                 inputcollid,
                                                 PointerGetDatum(root),
                                                 ObjectIdGetDatum(operatorid),
                                                 PointerGetDatum(args),
                                                 Int32GetDatum(varRelid)));
 
    if (result < 0.0 || result > 1.0)
        elog(ERROR, "invalid restriction selectivity: %f", result);
 
    return (Selectivity) result;
}

References DatumGetFloat8(), elog, ERROR, fb(), get_oprrest(), Int32GetDatum(), ObjectIdGetDatum(), OidFunctionCall4Coll(), PointerGetDatum(), and root.

Referenced by clause_selectivity_ext(), rowcomparesel(), and test_support_func().

Variable Documentation

get_relation_info_hook

PGDLLIMPORT get_relation_info_hook_type get_relation_info_hook

extern

Definition at line 61 of file plancat.c.

Referenced by get_relation_info().