<primary>brin_summarize_new_values</primary>

</indexterm>

<indexterm>

<primary>gin_clean_pending_list</primary>

</indexterm>

<para>

<xref linkend="functions-admin-index-table"> shows the functions

available for index maintenance tasks.

These functions cannot be executed during recovery.

Use of these functions is restricted to superusers and the owner

of the given index.

</para>

<table id="functions-admin-index-table">

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

<entry>summarize page ranges not already summarized</entry>

</row>

<row>

<entry>

<literal><function>gin_clean_pending_list(<parameter>index</> <type>regclass</>)</function></literal>

</entry>

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

<entry>move GIN pending list entries into main index structure</entry>

</row>

</tbody>

</tgroup>

</table>

into the index.

</para>

<para>

<function>gin_clean_pending_list</> accepts the OID or name of

a GIN index and cleans up the pending list of the specified GIN index

by moving entries in it to the main GIN data structure in bulk.

It returns the number of pages cleaned up from the pending list.

Note that if the argument is a GIN index built with <literal>fastupdate</>

option disabled, the cleanup does not happen and the return value is 0

because the index doesn't have a pending list.

Please see <xref linkend="gin-fast-update"> and <xref linkend="gin-tips">

for details of the pending list and <literal>fastupdate</> option.

</para>

</sect2>

<sect2 id="functions-admin-genfile">

from the indexed item). As of <productname>PostgreSQL</productname> 8.4,

<acronym>GIN</> is capable of postponing much of this work by inserting

new tuples into a temporary, unsorted list of pending entries.

When the table is vacuumed, or if the pending list becomes larger than

When the table is vacuumed or autoanalyzed, or when

<function>gin_clean_pending_list</function> function is called, or if the

pending list becomes larger than

<xref linkend="guc-gin-pending-list-limit">, the entries are moved to the

main <acronym>GIN</acronym> data structure using the same bulk insert

techniques used during initial index creation. This greatly improves

Turning <literal>fastupdate</> off via <command>ALTER INDEX</> prevents

future insertions from going into the list of pending index entries,

but does not in itself flush previous entries. You might want to

<command>VACUUM</> the tableafterward to ensure the pending list is

emptied.

<command>VACUUM</> the tableor call <function>gin_clean_pending_list</>

function afterward to ensure the pending list isemptied.

</para>

</note>

</listitem>

MemoryContextSwitchTo(oldCtx);

MemoryContextDelete(opCtx);

}

gin_clean_pending_list(PG_FUNCTION_ARGS)

{

Oidindexoid=PG_GETARG_OID(0);

RelationindexRel=index_open(indexoid,AccessShareLock);

IndexBulkDeleteResultstats;

GinStateginstate;

if (RecoveryInProgress())

ereport(ERROR,

(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),

errmsg("recovery is in progress"),

errhint("GIN pending list cannot be cleaned up during recovery.")));

if (indexRel->rd_rel->relkind!=RELKIND_INDEX||

indexRel->rd_rel->relam!=GIN_AM_OID)

ereport(ERROR,

(errcode(ERRCODE_WRONG_OBJECT_TYPE),

errmsg("\"%s\" is not a GIN index",

RelationGetRelationName(indexRel))));

if (RELATION_IS_OTHER_TEMP(indexRel))

ereport(ERROR,

(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),

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

if (!pg_class_ownercheck(indexoid,GetUserId()))

aclcheck_error(ACLCHECK_NOT_OWNER,ACL_KIND_CLASS,

RelationGetRelationName(indexRel));

memset(&stats,0,sizeof(stats));

initGinState(&ginstate,indexRel);

ginInsertCleanup(&ginstate, true,&stats);

index_close(indexRel,AccessShareLock);

PG_RETURN_INT64((int64)stats.pages_deleted);

}

externint64gingetbitmap(IndexScanDescscan,TIDBitmap*tbm);

externDatumgin_clean_pending_list(PG_FUNCTION_ARGS);

externvoidginInitConsistentFunction(GinState*ginstate,GinScanKeykey);

DESCR("GIN tsvector support (obsolete)");

DATA(insert OID = 3088 ( gin_tsquery_consistent PGNSP PGUID 12 1 0 0 0 f f f f t f i s 6 0 16 "2281 21 3615 23 2281 2281" _null_ _null_ _null_ _null_ _null_ gin_tsquery_consistent_6args _null_ _null_ _null_ ));

DESCR("GIN tsvector support (obsolete)");

DATA(insert OID = 3789 ( gin_clean_pending_list PGNSP PGUID 12 1 0 0 0 f f f f t f v s 1 0 20 "2205" _null_ _null_ _null_ _null_ _null_ gin_clean_pending_list _null_ _null_ _null_ ));

DESCR("clean up GIN pending list");

DATA(insert OID = 3662 ( tsquery_ltPGNSP PGUID 12 1 0 0 0 f f f f t f i s 2 0 16 "3615 3615" _null_ _null_ _null_ _null_ _null_ tsquery_lt _null_ _null_ _null_ ));

DATA(insert OID = 3663 ( tsquery_lePGNSP PGUID 12 1 0 0 0 f f f f t f i s 2 0 16 "3615 3615" _null_ _null_ _null_ _null_ _null_ tsquery_le _null_ _null_ _null_ ));

create index gin_test_idx on gin_test_tbl using gin (i) with (fastupdate = on);

insert into gin_test_tbl select array[1, 2, g] from generate_series(1, 20000) g;

insert into gin_test_tbl select array[1, 3, g] from generate_series(1, 1000) g;

select gin_clean_pending_list('gin_test_idx')>10 as many; -- flush the fastupdate buffers

many

------

t

(1 row)

insert into gin_test_tbl select array[3, 1, g] from generate_series(1, 1000) g;

vacuum gin_test_tbl; -- flush the fastupdate buffers

select gin_clean_pending_list('gin_test_idx'); -- nothing to flush

gin_clean_pending_list

------------------------

0

(1 row)

-- Test vacuuming

delete from gin_test_tbl where i @> array[2];

vacuum gin_test_tbl;

insert into gin_test_tblselect array[1,2, g]from generate_series(1,20000) g;

insert into gin_test_tblselect array[1,3, g]from generate_series(1,1000) g;

select gin_clean_pending_list('gin_test_idx')>10as many;-- flush the fastupdate buffers

insert into gin_test_tblselect array[3,1, g]from generate_series(1,1000) g;

vacuum gin_test_tbl;-- flush the fastupdate buffers

select gin_clean_pending_list('gin_test_idx');-- nothing to flush

deletefrom gin_test_tblwhere i @> array[2];

vacuum gin_test_tbl;