OBJS= pgstattuple.o pgstatindex.o

EXTENSION = pgstattuple

DATA = pgstattuple--1.0.sql pgstattuple--unpackaged--1.0.sql

DATA = pgstattuple--1.1.sql pgstattuple--1.0--1.1.sql pgstattuple--unpackaged--1.0.sql

REGRESS = pgstattuple

-- the pgstattuple functions, but the results for empty tables and

-- indexes should be that.

--

create table test (a int primary key);

create table test (a int primary key, b int[]);

select * from pgstattuple('test'::text);

table_len | tuple_count | tuple_len | tuple_percent | dead_tuple_count | dead_tuple_len | dead_tuple_percent | free_space | free_percent

-----------+-------------+-----------+---------------+------------------+----------------+--------------------+------------+--------------

1

(1 row)

create index test_ginidx on test using gin (b);

select * from pgstatginindex('test_ginidx');

version | pending_pages | pending_tuples

---------+---------------+----------------

1 | 0 | 0

(1 row)

externDatumpgstatindex(PG_FUNCTION_ARGS);

externDatumpg_relpages(PG_FUNCTION_ARGS);

externDatumpgstatginindex(PG_FUNCTION_ARGS);

PG_FUNCTION_INFO_V1(pgstatindex);

PG_FUNCTION_INFO_V1(pg_relpages);

PG_FUNCTION_INFO_V1(pgstatginindex);

#defineIS_INDEX(r) ((r)->rd_rel->relkind == RELKIND_INDEX)

#defineIS_BTREE(r) ((r)->rd_rel->relam == BTREE_AM_OID)

#defineIS_GIN(r) ((r)->rd_rel->relam == GIN_AM_OID)

#defineCHECK_PAGE_OFFSET_RANGE(pg,offnum) { \

if ( !(FirstOffsetNumber <= (offnum) && \

uint64fragments;

}BTIndexStat;

{

int32version;

BlockNumberpending_pages;

int64pending_tuples;

}GinIndexStat;

PG_RETURN_INT64(relpages);

}

pgstatginindex(PG_FUNCTION_ARGS)

{

Oidrelid=PG_GETARG_OID(0);

Relationrel;

Bufferbuffer;

Pagepage;

GinMetaPageData*metadata;

GinIndexStatstats;

HeapTupletuple;

TupleDesctupleDesc;

Datumvalues[3];

boolnulls[3]= {false, false, false};

Datumresult;

if (!superuser())

ereport(ERROR,

(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),

(errmsg("must be superuser to use pgstattuple functions"))));

rel=relation_open(relid,AccessShareLock);

if (!IS_INDEX(rel)|| !IS_GIN(rel))

elog(ERROR,"relation \"%s\" is not a GIN index",

RelationGetRelationName(rel));

if (RELATION_IS_OTHER_TEMP(rel))

ereport(ERROR,

(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),

errmsg("cannot access temporary indexes of other sessions")));

buffer=ReadBuffer(rel,GIN_METAPAGE_BLKNO);

LockBuffer(buffer,GIN_SHARE);

page=BufferGetPage(buffer);

metadata=GinPageGetMeta(page);

stats.version=metadata->ginVersion;

stats.pending_pages=metadata->nPendingPages;

stats.pending_tuples=metadata->nPendingHeapTuples;

UnlockReleaseBuffer(buffer);

relation_close(rel,AccessShareLock);

if (get_call_result_type(fcinfo,NULL,&tupleDesc)!=TYPEFUNC_COMPOSITE)

elog(ERROR,"return type must be a row type");

values[0]=Int32GetDatum(stats.version);

values[1]=UInt32GetDatum(stats.pending_pages);

values[2]=Int64GetDatum(stats.pending_tuples);

tuple=heap_form_tuple(tupleDesc,values,nulls);

result=HeapTupleGetDatum(tuple);

PG_RETURN_DATUM(result);

}

\echo Use"ALTER EXTENSION pgstattuple UPDATE TO '1.1'" to load this file. \quit

CREATEFUNCTIONpgstatginindex(IN relname regclass,

OUT version INT4,

OUT pending_pages INT4,

OUT pending_tuplesBIGINT)

AS'MODULE_PATHNAME','pgstatginindex'

LANGUAGE C STRICT;

\echo Use"CREATE EXTENSION pgstattuple" to load this file. \quit

RETURNSBIGINT

AS'MODULE_PATHNAME','pg_relpages'

LANGUAGE C STRICT;

CREATEFUNCTIONpgstatginindex(IN relname regclass,

OUT version INT4,

OUT pending_pages INT4,

OUT pending_tuplesBIGINT)

AS'MODULE_PATHNAME','pgstatginindex'

LANGUAGE C STRICT;

# pgstattuple extension

comment = 'show tuple-level statistics'

default_version = '1.0'

default_version = '1.1'

module_pathname = '$libdir/pgstattuple'

relocatable = true

createtabletest (aintprimary key);

createtabletest (aintprimary key, bint[]);

select*from pgstattuple('test'::text);

select*from pgstattuple('test'::regclass);

select pg_relpages('test');

select pg_relpages('test_pkey');

createindextest_ginidxon test using gin (b);

select*from pgstatginindex('test_ginidx');

</listitem>

</varlistentry>

<varlistentry>

<term>

<function>pgstatginindex(regclass) returns record</>

</term>

<listitem>

<para>

<function>pgstatginindex</function> returns a record showing information

about a GIN index. For example:

<programlisting>

test=> SELECT * FROM pgstatginindex('test_gin_index');

-[ RECORD 1 ]--+--

version | 1

pending_pages | 0

pending_tuples | 0

</programlisting>

</para>

<para>

The output columns are:

<informaltable>

<tgroup cols="3">

<thead>

<row>

<entry>Column</entry>

<entry>Type</entry>

<entry>Description</entry>

</row>

</thead>

<tbody>

<row>

<entry><structfield>version</structfield></entry>

<entry><type>integer</type></entry>

<entry>GIN version number</entry>

</row>

<row>

<entry><structfield>pending_pages</structfield></entry>

<entry><type>integer</type></entry>

<entry>Number of pages in the pending list</entry>

</row>

<row>

<entry><structfield>pending_tuples</structfield></entry>

<entry><type>bigint</type></entry>

<entry>Number of tuples in the pending list</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<function>pg_relpages(text) returns bigint</>