pg_statistic_ext.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * pg_statistic_ext.h
 *    definition of the "extended statistics" system catalog
 *    (pg_statistic_ext)
 *
 * Note that pg_statistic_ext contains the definitions of extended statistics
 * objects, created by CREATE STATISTICS, but not the actual statistical data,
 * created by running ANALYZE.
 *
 * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/catalog/pg_statistic_ext.h
 *
 * NOTES
 *    The Catalog.pm module reads this file and derives schema
 *    information.
 *
 *-------------------------------------------------------------------------
 */
#ifndef PG_STATISTIC_EXT_H
#define PG_STATISTIC_EXT_H
 
#include "catalog/genbki.h"
#include "catalog/pg_statistic_ext_d.h" /* IWYU pragma: export */
 
/* ----------------
 *      pg_statistic_ext definition.  cpp turns this into
 *      typedef struct FormData_pg_statistic_ext
 * ----------------
 */
CATALOG(pg_statistic_ext,3381,StatisticExtRelationId)
{
    Oid         oid;            /* oid */
 
    Oid         stxrelid BKI_LOOKUP(pg_class);  /* relation containing
                                                 * attributes */
 
    /* These two fields form the unique key for the entry: */
    NameData    stxname;        /* statistics object name */
    Oid         stxnamespace BKI_LOOKUP(pg_namespace);  /* OID of statistics
                                                         * object's namespace */
 
    Oid         stxowner BKI_LOOKUP(pg_authid); /* statistics object's owner */
 
    /*
     * variable-length/nullable fields start here, but we allow direct access
     * to stxkeys
     */
    int2vector  stxkeys BKI_FORCE_NOT_NULL; /* array of column keys */
 
#ifdef CATALOG_VARLEN
    int16       stxstattarget BKI_DEFAULT(_null_) BKI_FORCE_NULL;   /* statistics target */
    char        stxkind[1] BKI_FORCE_NOT_NULL;  /* statistics kinds requested
                                                 * to build */
    pg_node_tree stxexprs;      /* A list of expression trees for stats
                                 * attributes that are not simple column
                                 * references. */
#endif
 
} FormData_pg_statistic_ext;
 
/* ----------------
 *      Form_pg_statistic_ext corresponds to a pointer to a tuple with
 *      the format of pg_statistic_ext relation.
 * ----------------
 */
typedef FormData_pg_statistic_ext *Form_pg_statistic_ext;
 
DECLARE_TOAST(pg_statistic_ext, 3439, 3440);
 
DECLARE_UNIQUE_INDEX_PKEY(pg_statistic_ext_oid_index, 3380, StatisticExtOidIndexId, pg_statistic_ext, btree(oid oid_ops));
DECLARE_UNIQUE_INDEX(pg_statistic_ext_name_index, 3997, StatisticExtNameIndexId, pg_statistic_ext, btree(stxname name_ops, stxnamespace oid_ops));
DECLARE_INDEX(pg_statistic_ext_relid_index, 3379, StatisticExtRelidIndexId, pg_statistic_ext, btree(stxrelid oid_ops));
 
MAKE_SYSCACHE(STATEXTOID, pg_statistic_ext_oid_index, 4);
MAKE_SYSCACHE(STATEXTNAMENSP, pg_statistic_ext_name_index, 4);
 
DECLARE_ARRAY_FOREIGN_KEY((stxrelid, stxkeys), pg_attribute, (attrelid, attnum));
 
#ifdef EXPOSE_TO_CLIENT_CODE
 
#define STATS_EXT_NDISTINCT         'd'
#define STATS_EXT_DEPENDENCIES      'f'
#define STATS_EXT_MCV               'm'
#define STATS_EXT_EXPRESSIONS       'e'
 
#endif                          /* EXPOSE_TO_CLIENT_CODE */
 
#endif                          /* PG_STATISTIC_EXT_H */