relation_stats.c File Reference

#include "postgres.h"
#include "access/heapam.h"
#include "catalog/indexing.h"
#include "statistics/stat_utils.h"
#include "utils/fmgroids.h"
#include "utils/fmgrprotos.h"
#include "utils/syscache.h"

Include dependency graph for relation_stats.c:

Go to the source code of this file.

Macros
#define	DEFAULT_RELPAGES   Int32GetDatum(0)
#define	DEFAULT_RELTUPLES   Float4GetDatum(-1.0)
#define	DEFAULT_RELALLVISIBLE   Int32GetDatum(0)

Enumerations
enum	relation_stats_argnum {   RELATION_ARG = 0 , RELPAGES_ARG , RELTUPLES_ARG , RELALLVISIBLE_ARG ,   NUM_RELATION_STATS_ARGS }

Functions
static bool	relation_statistics_update (FunctionCallInfo fcinfo, int elevel, bool inplace)
Datum	pg_set_relation_stats (PG_FUNCTION_ARGS)
Datum	pg_clear_relation_stats (PG_FUNCTION_ARGS)
Datum	pg_restore_relation_stats (PG_FUNCTION_ARGS)

Variables
static struct StatsArgInfo	relarginfo []

Macro Definition Documentation

DEFAULT_RELALLVISIBLE

#define DEFAULT_RELALLVISIBLE   Int32GetDatum(0)

Definition at line 29 of file relation_stats.c.

DEFAULT_RELPAGES

#define DEFAULT_RELPAGES   Int32GetDatum(0)

Definition at line 27 of file relation_stats.c.

DEFAULT_RELTUPLES

#define DEFAULT_RELTUPLES   Float4GetDatum(-1.0)

Definition at line 28 of file relation_stats.c.

Enumeration Type Documentation

relation_stats_argnum

enum relation_stats_argnum

Enumerator
RELATION_ARG
RELPAGES_ARG
RELTUPLES_ARG
RELALLVISIBLE_ARG
NUM_RELATION_STATS_ARGS

Definition at line 36 of file relation_stats.c.

{
    RELATION_ARG = 0,
    RELPAGES_ARG,
    RELTUPLES_ARG,
    RELALLVISIBLE_ARG,
    NUM_RELATION_STATS_ARGS
};

Function Documentation

pg_clear_relation_stats()

Datum pg_clear_relation_stats

(

PG_FUNCTION_ARGS

)

Definition at line 258 of file relation_stats.c.

{
    LOCAL_FCINFO(newfcinfo, 4);
 
    InitFunctionCallInfoData(*newfcinfo, NULL, 4, InvalidOid, NULL, NULL);
 
    newfcinfo->args[0].value = PG_GETARG_OID(0);
    newfcinfo->args[0].isnull = PG_ARGISNULL(0);
    newfcinfo->args[1].value = DEFAULT_RELPAGES;
    newfcinfo->args[1].isnull = false;
    newfcinfo->args[2].value = DEFAULT_RELTUPLES;
    newfcinfo->args[2].isnull = false;
    newfcinfo->args[3].value = DEFAULT_RELALLVISIBLE;
    newfcinfo->args[3].isnull = false;
 
    relation_statistics_update(newfcinfo, ERROR, false);
    PG_RETURN_VOID();
}

References DEFAULT_RELALLVISIBLE, DEFAULT_RELPAGES, DEFAULT_RELTUPLES, ERROR, InitFunctionCallInfoData, InvalidOid, LOCAL_FCINFO, PG_ARGISNULL, PG_GETARG_OID, PG_RETURN_VOID, and relation_statistics_update().

pg_restore_relation_stats()

Datum pg_restore_relation_stats

(

PG_FUNCTION_ARGS

)

Definition at line 278 of file relation_stats.c.

{
    LOCAL_FCINFO(positional_fcinfo, NUM_RELATION_STATS_ARGS);
    bool        result = true;
 
    InitFunctionCallInfoData(*positional_fcinfo, NULL,
                             NUM_RELATION_STATS_ARGS,
                             InvalidOid, NULL, NULL);
 
    if (!stats_fill_fcinfo_from_arg_pairs(fcinfo, positional_fcinfo,
                                          relarginfo, WARNING))
        result = false;
 
    if (!relation_statistics_update(positional_fcinfo, WARNING, true))
        result = false;
 
    PG_RETURN_BOOL(result);
}

References InitFunctionCallInfoData, InvalidOid, LOCAL_FCINFO, NUM_RELATION_STATS_ARGS, PG_RETURN_BOOL, relarginfo, relation_statistics_update(), stats_fill_fcinfo_from_arg_pairs(), and WARNING.

pg_set_relation_stats()

Datum pg_set_relation_stats

(

PG_FUNCTION_ARGS

)

Definition at line 247 of file relation_stats.c.

{
    relation_statistics_update(fcinfo, ERROR, false);
    PG_RETURN_VOID();
}

References ERROR, PG_RETURN_VOID, and relation_statistics_update().

relation_statistics_update()

static bool relation_statistics_update ( FunctionCallInfo  fcinfo, int  elevel, bool  inplace  )

static

Definition at line 61 of file relation_stats.c.

{
    Oid         reloid;
    Relation    crel;
    int32       relpages = DEFAULT_RELPAGES;
    bool        update_relpages = false;
    float       reltuples = DEFAULT_RELTUPLES;
    bool        update_reltuples = false;
    int32       relallvisible = DEFAULT_RELALLVISIBLE;
    bool        update_relallvisible = false;
    bool        result = true;
 
    if (!PG_ARGISNULL(RELPAGES_ARG))
    {
        relpages = PG_GETARG_INT32(RELPAGES_ARG);
 
        /*
         * Partitioned tables may have relpages=-1. Note: for relations with
         * no storage, relpages=-1 is not used consistently, but must be
         * supported here.
         */
        if (relpages < -1)
        {
            ereport(elevel,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("relpages cannot be < -1")));
            result = false;
        }
        else
            update_relpages = true;
    }
 
    if (!PG_ARGISNULL(RELTUPLES_ARG))
    {
        reltuples = PG_GETARG_FLOAT4(RELTUPLES_ARG);
 
        if (reltuples < -1.0)
        {
            ereport(elevel,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("reltuples cannot be < -1.0")));
            result = false;
        }
        else
            update_reltuples = true;
    }
 
    if (!PG_ARGISNULL(RELALLVISIBLE_ARG))
    {
        relallvisible = PG_GETARG_INT32(RELALLVISIBLE_ARG);
 
        if (relallvisible < 0)
        {
            ereport(elevel,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("relallvisible cannot be < 0")));
            result = false;
        }
        else
            update_relallvisible = true;
    }
 
    stats_check_required_arg(fcinfo, relarginfo, RELATION_ARG);
    reloid = PG_GETARG_OID(RELATION_ARG);
 
    if (RecoveryInProgress())
        ereport(ERROR,
                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                 errmsg("recovery is in progress"),
                 errhint("Statistics cannot be modified during recovery.")));
 
    stats_lock_check_privileges(reloid);
 
    /*
     * Take RowExclusiveLock on pg_class, consistent with
     * vac_update_relstats().
     */
    crel = table_open(RelationRelationId, RowExclusiveLock);
 
    if (inplace)
    {
        HeapTuple   ctup = NULL;
        ScanKeyData key[1];
        Form_pg_class pgcform;
        void       *inplace_state = NULL;
        bool        dirty = false;
 
        ScanKeyInit(&key[0], Anum_pg_class_oid, BTEqualStrategyNumber, F_OIDEQ,
                    ObjectIdGetDatum(reloid));
        systable_inplace_update_begin(crel, ClassOidIndexId, true, NULL, 1, key,
                                      &ctup, &inplace_state);
        if (!HeapTupleIsValid(ctup))
            elog(ERROR, "pg_class entry for relid %u vanished while updating statistics",
                 reloid);
        pgcform = (Form_pg_class) GETSTRUCT(ctup);
 
        if (update_relpages && pgcform->relpages != relpages)
        {
            pgcform->relpages = relpages;
            dirty = true;
        }
        if (update_reltuples && pgcform->reltuples != reltuples)
        {
            pgcform->reltuples = reltuples;
            dirty = true;
        }
        if (update_relallvisible && pgcform->relallvisible != relallvisible)
        {
            pgcform->relallvisible = relallvisible;
            dirty = true;
        }
 
        if (dirty)
            systable_inplace_update_finish(inplace_state, ctup);
        else
            systable_inplace_update_cancel(inplace_state);
 
        heap_freetuple(ctup);
    }
    else
    {
        TupleDesc   tupdesc = RelationGetDescr(crel);
        HeapTuple   ctup;
        Form_pg_class pgcform;
        int         replaces[3] = {0};
        Datum       values[3] = {0};
        bool        nulls[3] = {0};
        int         nreplaces = 0;
 
        ctup = SearchSysCache1(RELOID, ObjectIdGetDatum(reloid));
        if (!HeapTupleIsValid(ctup))
        {
            ereport(elevel,
                    (errcode(ERRCODE_OBJECT_IN_USE),
                     errmsg("pg_class entry for relid %u not found", reloid)));
            table_close(crel, RowExclusiveLock);
            return false;
        }
        pgcform = (Form_pg_class) GETSTRUCT(ctup);
 
        if (update_relpages && relpages != pgcform->relpages)
        {
            replaces[nreplaces] = Anum_pg_class_relpages;
            values[nreplaces] = Int32GetDatum(relpages);
            nreplaces++;
        }
 
        if (update_reltuples && reltuples != pgcform->reltuples)
        {
            replaces[nreplaces] = Anum_pg_class_reltuples;
            values[nreplaces] = Float4GetDatum(reltuples);
            nreplaces++;
        }
 
        if (update_relallvisible && relallvisible != pgcform->relallvisible)
        {
            replaces[nreplaces] = Anum_pg_class_relallvisible;
            values[nreplaces] = Int32GetDatum(relallvisible);
            nreplaces++;
        }
 
        if (nreplaces > 0)
        {
            HeapTuple   newtup;
 
            newtup = heap_modify_tuple_by_cols(ctup, tupdesc, nreplaces,
                                               replaces, values, nulls);
            CatalogTupleUpdate(crel, &newtup->t_self, newtup);
            heap_freetuple(newtup);
        }
 
        ReleaseSysCache(ctup);
    }
 
    /* release the lock, consistent with vac_update_relstats() */
    table_close(crel, RowExclusiveLock);
 
    CommandCounterIncrement();
 
    return result;
}

References BTEqualStrategyNumber, CatalogTupleUpdate(), CommandCounterIncrement(), DEFAULT_RELALLVISIBLE, DEFAULT_RELPAGES, DEFAULT_RELTUPLES, elog, ereport, errcode(), errhint(), errmsg(), ERROR, Float4GetDatum(), GETSTRUCT, heap_freetuple(), heap_modify_tuple_by_cols(), HeapTupleIsValid, Int32GetDatum(), sort-test::key, ObjectIdGetDatum(), PG_ARGISNULL, PG_GETARG_FLOAT4, PG_GETARG_INT32, PG_GETARG_OID, RecoveryInProgress(), RELALLVISIBLE_ARG, relarginfo, RELATION_ARG, RelationGetDescr, ReleaseSysCache(), RELPAGES_ARG, RELTUPLES_ARG, RowExclusiveLock, ScanKeyInit(), SearchSysCache1(), stats_check_required_arg(), stats_lock_check_privileges(), systable_inplace_update_begin(), systable_inplace_update_cancel(), systable_inplace_update_finish(), HeapTupleData::t_self, table_close(), table_open(), and values.

Referenced by pg_clear_relation_stats(), pg_restore_relation_stats(), and pg_set_relation_stats().

Variable Documentation

relarginfo

struct StatsArgInfo relarginfo[]

static

Initial value:

=
{
    [RELATION_ARG] = {"relation", REGCLASSOID},
    [RELPAGES_ARG] = {"relpages", INT4OID},
    [RELTUPLES_ARG] = {"reltuples", FLOAT4OID},
    [RELALLVISIBLE_ARG] = {"relallvisible", INT4OID},
    [NUM_RELATION_STATS_ARGS] = {0}
}

Definition at line 1 of file relation_stats.c.

Referenced by pg_restore_relation_stats(), and relation_statistics_update().