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.

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

Functions
static bool	relation_statistics_update (FunctionCallInfo fcinfo)
Datum	pg_clear_relation_stats (PG_FUNCTION_ARGS)
Datum	pg_restore_relation_stats (PG_FUNCTION_ARGS)

Variables
static struct StatsArgInfo	relarginfo []

Enumeration Type Documentation

relation_stats_argnum

enum relation_stats_argnum

Enumerator
RELATION_ARG
RELPAGES_ARG
RELTUPLES_ARG
RELALLVISIBLE_ARG
RELALLFROZEN_ARG
NUM_RELATION_STATS_ARGS

Definition at line 33 of file relation_stats.c.

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

Function Documentation

pg_clear_relation_stats()

Datum pg_clear_relation_stats

(

PG_FUNCTION_ARGS

)

Definition at line 188 of file relation_stats.c.

{
    LOCAL_FCINFO(newfcinfo, 5);
 
    InitFunctionCallInfoData(*newfcinfo, NULL, 5, InvalidOid, NULL, NULL);
 
    newfcinfo->args[0].value = PG_GETARG_OID(0);
    newfcinfo->args[0].isnull = PG_ARGISNULL(0);
    newfcinfo->args[1].value = UInt32GetDatum(0);
    newfcinfo->args[1].isnull = false;
    newfcinfo->args[2].value = Float4GetDatum(-1.0);
    newfcinfo->args[2].isnull = false;
    newfcinfo->args[3].value = UInt32GetDatum(0);
    newfcinfo->args[3].isnull = false;
    newfcinfo->args[4].value = UInt32GetDatum(0);
    newfcinfo->args[4].isnull = false;
 
    relation_statistics_update(newfcinfo);
    PG_RETURN_VOID();
}

References Float4GetDatum(), InitFunctionCallInfoData, InvalidOid, LOCAL_FCINFO, PG_ARGISNULL, PG_GETARG_OID, PG_RETURN_VOID, relation_statistics_update(), and UInt32GetDatum().

pg_restore_relation_stats()

Datum pg_restore_relation_stats

(

PG_FUNCTION_ARGS

)

Definition at line 210 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))
        result = false;
 
    if (!relation_statistics_update(positional_fcinfo))
        result = false;
 
    PG_RETURN_BOOL(result);
}

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

relation_statistics_update()

static bool relation_statistics_update ( FunctionCallInfo  fcinfo )

static

Definition at line 59 of file relation_stats.c.

{
    bool        result = true;
    Oid         reloid;
    Relation    crel;
    BlockNumber relpages = 0;
    bool        update_relpages = false;
    float       reltuples = 0;
    bool        update_reltuples = false;
    BlockNumber relallvisible = 0;
    bool        update_relallvisible = false;
    BlockNumber relallfrozen = 0;
    bool        update_relallfrozen = false;
    HeapTuple   ctup;
    Form_pg_class pgcform;
    int         replaces[4] = {0};
    Datum       values[4] = {0};
    bool        nulls[4] = {0};
    int         nreplaces = 0;
 
    if (!PG_ARGISNULL(RELPAGES_ARG))
    {
        relpages = PG_GETARG_UINT32(RELPAGES_ARG);
        update_relpages = true;
    }
 
    if (!PG_ARGISNULL(RELTUPLES_ARG))
    {
        reltuples = PG_GETARG_FLOAT4(RELTUPLES_ARG);
        if (reltuples < -1.0)
        {
            ereport(WARNING,
                    (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_UINT32(RELALLVISIBLE_ARG);
        update_relallvisible = true;
    }
 
    if (!PG_ARGISNULL(RELALLFROZEN_ARG))
    {
        relallfrozen = PG_GETARG_UINT32(RELALLFROZEN_ARG);
        update_relallfrozen = 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);
 
    ctup = SearchSysCache1(RELOID, ObjectIdGetDatum(reloid));
    if (!HeapTupleIsValid(ctup))
        elog(ERROR, "pg_class entry for relid %u not found", reloid);
 
    pgcform = (Form_pg_class) GETSTRUCT(ctup);
 
    if (update_relpages && relpages != pgcform->relpages)
    {
        replaces[nreplaces] = Anum_pg_class_relpages;
        values[nreplaces] = UInt32GetDatum(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] = UInt32GetDatum(relallvisible);
        nreplaces++;
    }
 
    if (update_relallfrozen && relallfrozen != pgcform->relallfrozen)
    {
        replaces[nreplaces] = Anum_pg_class_relallfrozen;
        values[nreplaces] = UInt32GetDatum(relallfrozen);
        nreplaces++;
    }
 
    if (nreplaces > 0)
    {
        TupleDesc   tupdesc = RelationGetDescr(crel);
        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 CatalogTupleUpdate(), CommandCounterIncrement(), elog, ereport, errcode(), errhint(), errmsg(), ERROR, Float4GetDatum(), GETSTRUCT(), heap_freetuple(), heap_modify_tuple_by_cols(), HeapTupleIsValid, ObjectIdGetDatum(), PG_ARGISNULL, PG_GETARG_FLOAT4, PG_GETARG_OID, PG_GETARG_UINT32, RecoveryInProgress(), RELALLFROZEN_ARG, RELALLVISIBLE_ARG, relarginfo, RELATION_ARG, RelationGetDescr, ReleaseSysCache(), RELPAGES_ARG, RELTUPLES_ARG, RowExclusiveLock, SearchSysCache1(), stats_check_required_arg(), stats_lock_check_privileges(), HeapTupleData::t_self, table_close(), table_open(), UInt32GetDatum(), values, and WARNING.

Referenced by pg_clear_relation_stats(), and pg_restore_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},
    [RELALLFROZEN_ARG] = {"relallfrozen", INT4OID},
    [NUM_RELATION_STATS_ARGS] = {0}
}

Definition at line 43 of file relation_stats.c.

Referenced by pg_restore_relation_stats(), and relation_statistics_update().