select open change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

FUNCTIONS / SYSTEM ADMINISTRATION FUNCTIONS

gin_clean_pending_list

Read PG 18 manual ↗

Cleans up the “pending” list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure.

Signatures & examples

gin_clean_pending_list ( index regclass ) → bigint
Cleans up the pending list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the fastupdate option disabled, no cleanup happens and the result is zero, because the index doesn't have a pending list. See Section 65.4.4.1 and Section 65.4.5 for details about the pending list and fastupdate option.
Version history 6
  1. PG 17 → 18changed
  2. PG 16 → 17changed
  3. PG 14 → 15changed
  4. PG 13 → 14changed
  5. PG 12 → 13changed
  6. PG 9.5 → 9.6added

Definition snapshot: 2026-09-14T13:14:25.684213+00:00@99e6866c · English manual source