PostgreSQL Source Code  git master
cluster.h File Reference
#include "nodes/parsenodes.h"
#include "parser/parse_node.h"
#include "storage/lock.h"
#include "utils/relcache.h"
Include dependency graph for cluster.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ClusterParams
 

Macros

#define CLUOPT_VERBOSE   0x01 /* print progress info */
 
#define CLUOPT_RECHECK   0x02 /* recheck relation state */
 
#define CLUOPT_RECHECK_ISCLUSTERED
 

Typedefs

typedef struct ClusterParams ClusterParams
 

Functions

void cluster (ParseState *pstate, ClusterStmt *stmt, bool isTopLevel)
 
void cluster_rel (Oid tableOid, Oid indexOid, ClusterParams *params)
 
void check_index_is_clusterable (Relation OldHeap, Oid indexOid, LOCKMODE lockmode)
 
void mark_index_clustered (Relation rel, Oid indexOid, bool is_internal)
 
Oid make_new_heap (Oid OIDOldHeap, Oid NewTableSpace, Oid NewAccessMethod, char relpersistence, LOCKMODE lockmode)
 
void finish_heap_swap (Oid OIDOldHeap, Oid OIDNewHeap, bool is_system_catalog, bool swap_toast_by_content, bool check_constraints, bool is_internal, TransactionId frozenXid, MultiXactId minMulti, char newrelpersistence)
 

Macro Definition Documentation

◆ CLUOPT_RECHECK

#define CLUOPT_RECHECK   0x02 /* recheck relation state */

Definition at line 24 of file cluster.h.

◆ CLUOPT_RECHECK_ISCLUSTERED

#define CLUOPT_RECHECK_ISCLUSTERED
Value:
0x04 /* recheck relation state for
* indisclustered */

Definition at line 25 of file cluster.h.

◆ CLUOPT_VERBOSE

#define CLUOPT_VERBOSE   0x01 /* print progress info */

Definition at line 23 of file cluster.h.

Typedef Documentation

◆ ClusterParams

typedef struct ClusterParams ClusterParams

Function Documentation

◆ check_index_is_clusterable()

void check_index_is_clusterable ( Relation  OldHeap,
Oid  indexOid,
LOCKMODE  lockmode 
)

Definition at line 498 of file cluster.c.

499 {
500  Relation OldIndex;
501 
502  OldIndex = index_open(indexOid, lockmode);
503 
504  /*
505  * Check that index is in fact an index on the given relation
506  */
507  if (OldIndex->rd_index == NULL ||
508  OldIndex->rd_index->indrelid != RelationGetRelid(OldHeap))
509  ereport(ERROR,
510  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
511  errmsg("\"%s\" is not an index for table \"%s\"",
512  RelationGetRelationName(OldIndex),
513  RelationGetRelationName(OldHeap))));
514 
515  /* Index AM must allow clustering */
516  if (!OldIndex->rd_indam->amclusterable)
517  ereport(ERROR,
518  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
519  errmsg("cannot cluster on index \"%s\" because access method does not support clustering",
520  RelationGetRelationName(OldIndex))));
521 
522  /*
523  * Disallow clustering on incomplete indexes (those that might not index
524  * every row of the relation). We could relax this by making a separate
525  * seqscan pass over the table to copy the missing rows, but that seems
526  * expensive and tedious.
527  */
528  if (!heap_attisnull(OldIndex->rd_indextuple, Anum_pg_index_indpred, NULL))
529  ereport(ERROR,
530  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
531  errmsg("cannot cluster on partial index \"%s\"",
532  RelationGetRelationName(OldIndex))));
533 
534  /*
535  * Disallow if index is left over from a failed CREATE INDEX CONCURRENTLY;
536  * it might well not contain entries for every heap row, or might not even
537  * be internally consistent. (But note that we don't check indcheckxmin;
538  * the worst consequence of following broken HOT chains would be that we
539  * might put recently-dead tuples out-of-order in the new table, and there
540  * is little harm in that.)
541  */
542  if (!OldIndex->rd_index->indisvalid)
543  ereport(ERROR,
544  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
545  errmsg("cannot cluster on invalid index \"%s\"",
546  RelationGetRelationName(OldIndex))));
547 
548  /* Drop relcache refcnt on OldIndex, but keep lock */
549  index_close(OldIndex, NoLock);
550 }
int errcode(int sqlerrcode)
Definition: elog.c:693
int errmsg(const char *fmt,...)
Definition: elog.c:904
#define ERROR
Definition: elog.h:33
#define ereport(elevel,...)
Definition: elog.h:143
bool heap_attisnull(HeapTuple tup, int attnum, TupleDesc tupleDesc)
Definition: heaptuple.c:359
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:132
#define NoLock
Definition: lockdefs.h:34
#define RelationGetRelid(relation)
Definition: rel.h:488
#define RelationGetRelationName(relation)
Definition: rel.h:522
bool amclusterable
Definition: amapi.h:238
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
struct HeapTupleData * rd_indextuple
Definition: rel.h:189
Form_pg_index rd_index
Definition: rel.h:187

References IndexAmRoutine::amclusterable, ereport, errcode(), errmsg(), ERROR, heap_attisnull(), index_close(), index_open(), NoLock, RelationData::rd_indam, RelationData::rd_index, RelationData::rd_indextuple, RelationGetRelationName, and RelationGetRelid.

Referenced by ATExecClusterOn(), cluster(), and cluster_rel().

◆ cluster()

void cluster ( ParseState pstate,
ClusterStmt stmt,
bool  isTopLevel 
)

Definition at line 108 of file cluster.c.

109 {
110  ListCell *lc;
111  ClusterParams params = {0};
112  bool verbose = false;
113  Relation rel = NULL;
114  Oid indexOid = InvalidOid;
115  MemoryContext cluster_context;
116  List *rtcs;
117 
118  /* Parse option list */
119  foreach(lc, stmt->params)
120  {
121  DefElem *opt = (DefElem *) lfirst(lc);
122 
123  if (strcmp(opt->defname, "verbose") == 0)
124  verbose = defGetBoolean(opt);
125  else
126  ereport(ERROR,
127  (errcode(ERRCODE_SYNTAX_ERROR),
128  errmsg("unrecognized CLUSTER option \"%s\"",
129  opt->defname),
130  parser_errposition(pstate, opt->location)));
131  }
132 
133  params.options = (verbose ? CLUOPT_VERBOSE : 0);
134 
135  if (stmt->relation != NULL)
136  {
137  /* This is the single-relation case. */
138  Oid tableOid;
139 
140  /*
141  * Find, lock, and check permissions on the table. We obtain
142  * AccessExclusiveLock right away to avoid lock-upgrade hazard in the
143  * single-transaction case.
144  */
145  tableOid = RangeVarGetRelidExtended(stmt->relation,
147  0,
149  rel = table_open(tableOid, NoLock);
150 
151  /*
152  * Reject clustering a remote temp table ... their local buffer
153  * manager is not going to cope.
154  */
155  if (RELATION_IS_OTHER_TEMP(rel))
156  ereport(ERROR,
157  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
158  errmsg("cannot cluster temporary tables of other sessions")));
159 
160  if (stmt->indexname == NULL)
161  {
162  ListCell *index;
163 
164  /* We need to find the index that has indisclustered set. */
165  foreach(index, RelationGetIndexList(rel))
166  {
167  indexOid = lfirst_oid(index);
168  if (get_index_isclustered(indexOid))
169  break;
170  indexOid = InvalidOid;
171  }
172 
173  if (!OidIsValid(indexOid))
174  ereport(ERROR,
175  (errcode(ERRCODE_UNDEFINED_OBJECT),
176  errmsg("there is no previously clustered index for table \"%s\"",
177  stmt->relation->relname)));
178  }
179  else
180  {
181  /*
182  * The index is expected to be in the same namespace as the
183  * relation.
184  */
185  indexOid = get_relname_relid(stmt->indexname,
186  rel->rd_rel->relnamespace);
187  if (!OidIsValid(indexOid))
188  ereport(ERROR,
189  (errcode(ERRCODE_UNDEFINED_OBJECT),
190  errmsg("index \"%s\" for table \"%s\" does not exist",
191  stmt->indexname, stmt->relation->relname)));
192  }
193 
194  if (rel->rd_rel->relkind != RELKIND_PARTITIONED_TABLE)
195  {
196  /* close relation, keep lock till commit */
197  table_close(rel, NoLock);
198 
199  /* Do the job. */
200  cluster_rel(tableOid, indexOid, &params);
201 
202  return;
203  }
204  }
205 
206  /*
207  * By here, we know we are in a multi-table situation. In order to avoid
208  * holding locks for too long, we want to process each table in its own
209  * transaction. This forces us to disallow running inside a user
210  * transaction block.
211  */
212  PreventInTransactionBlock(isTopLevel, "CLUSTER");
213 
214  /* Also, we need a memory context to hold our list of relations */
215  cluster_context = AllocSetContextCreate(PortalContext,
216  "Cluster",
218 
219  /*
220  * Either we're processing a partitioned table, or we were not given any
221  * table name at all. In either case, obtain a list of relations to
222  * process.
223  *
224  * In the former case, an index name must have been given, so we don't
225  * need to recheck its "indisclustered" bit, but we have to check that it
226  * is an index that we can cluster on. In the latter case, we set the
227  * option bit to have indisclustered verified.
228  *
229  * Rechecking the relation itself is necessary here in all cases.
230  */
231  params.options |= CLUOPT_RECHECK;
232  if (rel != NULL)
233  {
234  Assert(rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE);
236  rtcs = get_tables_to_cluster_partitioned(cluster_context, indexOid);
237 
238  /* close relation, releasing lock on parent table */
240  }
241  else
242  {
243  rtcs = get_tables_to_cluster(cluster_context);
245  }
246 
247  /* Do the job. */
248  cluster_multiple_rels(rtcs, &params);
249 
250  /* Start a new transaction for the cleanup work. */
252 
253  /* Clean up working storage */
254  MemoryContextDelete(cluster_context);
255 }
#define OidIsValid(objectId)
Definition: c.h:710
void cluster_rel(Oid tableOid, Oid indexOid, ClusterParams *params)
Definition: cluster.c:310
void check_index_is_clusterable(Relation OldHeap, Oid indexOid, LOCKMODE lockmode)
Definition: cluster.c:498
static List * get_tables_to_cluster(MemoryContext cluster_context)
Definition: cluster.c:1615
static List * get_tables_to_cluster_partitioned(MemoryContext cluster_context, Oid indexOid)
Definition: cluster.c:1669
static void cluster_multiple_rels(List *rtcs, ClusterParams *params)
Definition: cluster.c:265
#define CLUOPT_VERBOSE
Definition: cluster.h:23
#define CLUOPT_RECHECK_ISCLUSTERED
Definition: cluster.h:25
#define CLUOPT_RECHECK
Definition: cluster.h:24
bool defGetBoolean(DefElem *def)
Definition: define.c:108
Assert(fmt[strlen(fmt) - 1] !='\n')
#define AccessExclusiveLock
Definition: lockdefs.h:43
#define AccessShareLock
Definition: lockdefs.h:36
bool get_index_isclustered(Oid index_oid)
Definition: lsyscache.c:3565
Oid get_relname_relid(const char *relname, Oid relnamespace)
Definition: lsyscache.c:1866
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:218
MemoryContext PortalContext
Definition: mcxt.c:57
#define AllocSetContextCreate
Definition: memutils.h:173
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:197
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, uint32 flags, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:238
int parser_errposition(ParseState *pstate, int location)
Definition: parse_node.c:110
static int verbose
#define lfirst(lc)
Definition: pg_list.h:169
#define lfirst_oid(lc)
Definition: pg_list.h:171
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:642
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4675
bits32 options
Definition: cluster.h:30
char * indexname
Definition: parsenodes.h:3699
RangeVar * relation
Definition: parsenodes.h:3698
List * params
Definition: parsenodes.h:3700
char * defname
Definition: parsenodes.h:765
int location
Definition: parsenodes.h:769
Definition: pg_list.h:51
char * relname
Definition: primnodes.h:68
Form_pg_class rd_rel
Definition: rel.h:109
Definition: type.h:90
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
void RangeVarCallbackOwnsTable(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: tablecmds.c:16923
void PreventInTransactionBlock(bool isTopLevel, const char *stmtType)
Definition: xact.c:3462
void StartTransactionCommand(void)
Definition: xact.c:2925

References AccessExclusiveLock, AccessShareLock, ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert(), check_index_is_clusterable(), CLUOPT_RECHECK, CLUOPT_RECHECK_ISCLUSTERED, CLUOPT_VERBOSE, cluster_multiple_rels(), cluster_rel(), defGetBoolean(), DefElem::defname, ereport, errcode(), errmsg(), ERROR, get_index_isclustered(), get_relname_relid(), get_tables_to_cluster(), get_tables_to_cluster_partitioned(), ClusterStmt::indexname, InvalidOid, lfirst, lfirst_oid, DefElem::location, MemoryContextDelete(), NoLock, OidIsValid, ClusterParams::options, ClusterStmt::params, parser_errposition(), PortalContext, PreventInTransactionBlock(), RangeVarCallbackOwnsTable(), RangeVarGetRelidExtended(), RelationData::rd_rel, ClusterStmt::relation, RELATION_IS_OTHER_TEMP, RelationGetIndexList(), RangeVar::relname, StartTransactionCommand(), table_close(), table_open(), and verbose.

Referenced by adjust_data_dir(), check_bin_dir(), check_data_dir(), check_for_composite_data_type_usage(), check_for_data_type_usage(), check_for_data_types_usage(), check_for_isn_and_int8_passing_mismatch(), check_for_jsonb_9_4_usage(), check_for_pg_role_prefix(), check_for_prepared_transactions(), check_for_reg_data_type_usage(), check_for_tables_with_oids(), check_for_user_defined_encoding_conversions(), check_for_user_defined_postfix_ops(), check_is_install_user(), check_proper_datallowconn(), cluster_conn_opts(), connectToServer(), get_bin_version(), get_control_data(), get_db_and_rel_infos(), get_db_conn(), get_db_infos(), get_major_server_version(), get_rel_infos(), get_sock_dir(), old_11_check_for_sql_identifier_data_type_usage(), old_9_3_check_for_line_data_type_usage(), old_9_6_check_for_unknown_data_type_usage(), old_9_6_invalidate_hash_indexes(), report_extension_updates(), set_tablespace_directory_suffix(), standard_ProcessUtility(), start_postmaster(), and stop_postmaster().

◆ cluster_rel()

void cluster_rel ( Oid  tableOid,
Oid  indexOid,
ClusterParams params 
)

Definition at line 310 of file cluster.c.

311 {
312  Relation OldHeap;
313  Oid save_userid;
314  int save_sec_context;
315  int save_nestlevel;
316  bool verbose = ((params->options & CLUOPT_VERBOSE) != 0);
317  bool recheck = ((params->options & CLUOPT_RECHECK) != 0);
318 
319  /* Check for user-requested abort. */
321 
323  if (OidIsValid(indexOid))
326  else
329 
330  /*
331  * We grab exclusive access to the target rel and index for the duration
332  * of the transaction. (This is redundant for the single-transaction
333  * case, since cluster() already did it.) The index lock is taken inside
334  * check_index_is_clusterable.
335  */
336  OldHeap = try_relation_open(tableOid, AccessExclusiveLock);
337 
338  /* If the table has gone away, we can skip processing it */
339  if (!OldHeap)
340  {
342  return;
343  }
344 
345  /*
346  * Switch to the table owner's userid, so that any index functions are run
347  * as that user. Also lock down security-restricted operations and
348  * arrange to make GUC variable changes local to this command.
349  */
350  GetUserIdAndSecContext(&save_userid, &save_sec_context);
351  SetUserIdAndSecContext(OldHeap->rd_rel->relowner,
352  save_sec_context | SECURITY_RESTRICTED_OPERATION);
353  save_nestlevel = NewGUCNestLevel();
354 
355  /*
356  * Since we may open a new transaction for each relation, we have to check
357  * that the relation still is what we think it is.
358  *
359  * If this is a single-transaction CLUSTER, we can skip these tests. We
360  * *must* skip the one on indisclustered since it would reject an attempt
361  * to cluster a not-previously-clustered index.
362  */
363  if (recheck)
364  {
365  /* Check that the user still owns the relation */
366  if (!pg_class_ownercheck(tableOid, save_userid))
367  {
369  goto out;
370  }
371 
372  /*
373  * Silently skip a temp table for a remote session. Only doing this
374  * check in the "recheck" case is appropriate (which currently means
375  * somebody is executing a database-wide CLUSTER or on a partitioned
376  * table), because there is another check in cluster() which will stop
377  * any attempt to cluster remote temp tables by name. There is
378  * another check in cluster_rel which is redundant, but we leave it
379  * for extra safety.
380  */
381  if (RELATION_IS_OTHER_TEMP(OldHeap))
382  {
384  goto out;
385  }
386 
387  if (OidIsValid(indexOid))
388  {
389  /*
390  * Check that the index still exists
391  */
393  {
395  goto out;
396  }
397 
398  /*
399  * Check that the index is still the one with indisclustered set,
400  * if needed.
401  */
402  if ((params->options & CLUOPT_RECHECK_ISCLUSTERED) != 0 &&
403  !get_index_isclustered(indexOid))
404  {
406  goto out;
407  }
408  }
409  }
410 
411  /*
412  * We allow VACUUM FULL, but not CLUSTER, on shared catalogs. CLUSTER
413  * would work in most respects, but the index would only get marked as
414  * indisclustered in the current database, leading to unexpected behavior
415  * if CLUSTER were later invoked in another database.
416  */
417  if (OidIsValid(indexOid) && OldHeap->rd_rel->relisshared)
418  ereport(ERROR,
419  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
420  errmsg("cannot cluster a shared catalog")));
421 
422  /*
423  * Don't process temp tables of other backends ... their local buffer
424  * manager is not going to cope.
425  */
426  if (RELATION_IS_OTHER_TEMP(OldHeap))
427  {
428  if (OidIsValid(indexOid))
429  ereport(ERROR,
430  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
431  errmsg("cannot cluster temporary tables of other sessions")));
432  else
433  ereport(ERROR,
434  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
435  errmsg("cannot vacuum temporary tables of other sessions")));
436  }
437 
438  /*
439  * Also check for active uses of the relation in the current transaction,
440  * including open scans and pending AFTER trigger events.
441  */
442  CheckTableNotInUse(OldHeap, OidIsValid(indexOid) ? "CLUSTER" : "VACUUM");
443 
444  /* Check heap and index are valid to cluster on */
445  if (OidIsValid(indexOid))
447 
448  /*
449  * Quietly ignore the request if this is a materialized view which has not
450  * been populated from its query. No harm is done because there is no data
451  * to deal with, and we don't want to throw an error if this is part of a
452  * multi-relation request -- for example, CLUSTER was run on the entire
453  * database.
454  */
455  if (OldHeap->rd_rel->relkind == RELKIND_MATVIEW &&
456  !RelationIsPopulated(OldHeap))
457  {
459  goto out;
460  }
461 
462  Assert(OldHeap->rd_rel->relkind == RELKIND_RELATION ||
463  OldHeap->rd_rel->relkind == RELKIND_MATVIEW ||
464  OldHeap->rd_rel->relkind == RELKIND_TOASTVALUE);
465 
466  /*
467  * All predicate locks on the tuples or pages are about to be made
468  * invalid, because we move tuples around. Promote them to relation
469  * locks. Predicate locks on indexes will be promoted when they are
470  * reindexed.
471  */
473 
474  /* rebuild_relation does all the dirty work */
475  rebuild_relation(OldHeap, indexOid, verbose);
476 
477  /* NB: rebuild_relation does table_close() on OldHeap */
478 
479 out:
480  /* Roll back any GUC changes executed by index functions */
481  AtEOXact_GUC(false, save_nestlevel);
482 
483  /* Restore userid and security context */
484  SetUserIdAndSecContext(save_userid, save_sec_context);
485 
487 }
bool pg_class_ownercheck(Oid class_oid, Oid roleid)
Definition: aclchk.c:5171
void pgstat_progress_start_command(ProgressCommandType cmdtype, Oid relid)
void pgstat_progress_update_param(int index, int64 val)
void pgstat_progress_end_command(void)
@ PROGRESS_COMMAND_CLUSTER
static void rebuild_relation(Relation OldHeap, Oid indexOid, bool verbose)
Definition: cluster.c:631
int NewGUCNestLevel(void)
Definition: guc.c:6476
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:6490
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:313
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:603
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:610
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3148
#define PROGRESS_CLUSTER_COMMAND_VACUUM_FULL
Definition: progress.h:75
#define PROGRESS_CLUSTER_COMMAND_CLUSTER
Definition: progress.h:74
#define PROGRESS_CLUSTER_COMMAND
Definition: progress.h:55
#define RelationIsPopulated(relation)
Definition: rel.h:661
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:206
Relation try_relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:89
@ RELOID
Definition: syscache.h:89
#define SearchSysCacheExists1(cacheId, key1)
Definition: syscache.h:188
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:3989

References AccessExclusiveLock, Assert(), AtEOXact_GUC(), CHECK_FOR_INTERRUPTS, check_index_is_clusterable(), CheckTableNotInUse(), CLUOPT_RECHECK, CLUOPT_RECHECK_ISCLUSTERED, CLUOPT_VERBOSE, ereport, errcode(), errmsg(), ERROR, get_index_isclustered(), GetUserIdAndSecContext(), NewGUCNestLevel(), ObjectIdGetDatum, OidIsValid, ClusterParams::options, pg_class_ownercheck(), pgstat_progress_end_command(), pgstat_progress_start_command(), pgstat_progress_update_param(), PROGRESS_CLUSTER_COMMAND, PROGRESS_CLUSTER_COMMAND_CLUSTER, PROGRESS_CLUSTER_COMMAND_VACUUM_FULL, PROGRESS_COMMAND_CLUSTER, RelationData::rd_rel, rebuild_relation(), relation_close(), RELATION_IS_OTHER_TEMP, RelationIsPopulated, RELOID, SearchSysCacheExists1, SECURITY_RESTRICTED_OPERATION, SetUserIdAndSecContext(), TransferPredicateLocksToHeapRelation(), try_relation_open(), and verbose.

Referenced by cluster(), cluster_multiple_rels(), and vacuum_rel().

◆ finish_heap_swap()

void finish_heap_swap ( Oid  OIDOldHeap,
Oid  OIDNewHeap,
bool  is_system_catalog,
bool  swap_toast_by_content,
bool  check_constraints,
bool  is_internal,
TransactionId  frozenXid,
MultiXactId  minMulti,
char  newrelpersistence 
)

Definition at line 1417 of file cluster.c.

1425 {
1426  ObjectAddress object;
1427  Oid mapped_tables[4];
1428  int reindex_flags;
1429  ReindexParams reindex_params = {0};
1430  int i;
1431 
1432  /* Report that we are now swapping relation files */
1435 
1436  /* Zero out possible results from swapped_relation_files */
1437  memset(mapped_tables, 0, sizeof(mapped_tables));
1438 
1439  /*
1440  * Swap the contents of the heap relations (including any toast tables).
1441  * Also set old heap's relfrozenxid to frozenXid.
1442  */
1443  swap_relation_files(OIDOldHeap, OIDNewHeap,
1444  (OIDOldHeap == RelationRelationId),
1445  swap_toast_by_content, is_internal,
1446  frozenXid, cutoffMulti, mapped_tables);
1447 
1448  /*
1449  * If it's a system catalog, queue a sinval message to flush all catcaches
1450  * on the catalog when we reach CommandCounterIncrement.
1451  */
1452  if (is_system_catalog)
1453  CacheInvalidateCatalog(OIDOldHeap);
1454 
1455  /*
1456  * Rebuild each index on the relation (but not the toast table, which is
1457  * all-new at this point). It is important to do this before the DROP
1458  * step because if we are processing a system catalog that will be used
1459  * during DROP, we want to have its indexes available. There is no
1460  * advantage to the other order anyway because this is all transactional,
1461  * so no chance to reclaim disk space before commit. We do not need a
1462  * final CommandCounterIncrement() because reindex_relation does it.
1463  *
1464  * Note: because index_build is called via reindex_relation, it will never
1465  * set indcheckxmin true for the indexes. This is OK even though in some
1466  * sense we are building new indexes rather than rebuilding existing ones,
1467  * because the new heap won't contain any HOT chains at all, let alone
1468  * broken ones, so it can't be necessary to set indcheckxmin.
1469  */
1470  reindex_flags = REINDEX_REL_SUPPRESS_INDEX_USE;
1471  if (check_constraints)
1472  reindex_flags |= REINDEX_REL_CHECK_CONSTRAINTS;
1473 
1474  /*
1475  * Ensure that the indexes have the same persistence as the parent
1476  * relation.
1477  */
1478  if (newrelpersistence == RELPERSISTENCE_UNLOGGED)
1479  reindex_flags |= REINDEX_REL_FORCE_INDEXES_UNLOGGED;
1480  else if (newrelpersistence == RELPERSISTENCE_PERMANENT)
1481  reindex_flags |= REINDEX_REL_FORCE_INDEXES_PERMANENT;
1482 
1483  /* Report that we are now reindexing relations */
1486 
1487  reindex_relation(OIDOldHeap, reindex_flags, &reindex_params);
1488 
1489  /* Report that we are now doing clean up */
1492 
1493  /*
1494  * If the relation being rebuilt is pg_class, swap_relation_files()
1495  * couldn't update pg_class's own pg_class entry (check comments in
1496  * swap_relation_files()), thus relfrozenxid was not updated. That's
1497  * annoying because a potential reason for doing a VACUUM FULL is a
1498  * imminent or actual anti-wraparound shutdown. So, now that we can
1499  * access the new relation using its indices, update relfrozenxid.
1500  * pg_class doesn't have a toast relation, so we don't need to update the
1501  * corresponding toast relation. Not that there's little point moving all
1502  * relfrozenxid updates here since swap_relation_files() needs to write to
1503  * pg_class for non-mapped relations anyway.
1504  */
1505  if (OIDOldHeap == RelationRelationId)
1506  {
1507  Relation relRelation;
1508  HeapTuple reltup;
1509  Form_pg_class relform;
1510 
1511  relRelation = table_open(RelationRelationId, RowExclusiveLock);
1512 
1513  reltup = SearchSysCacheCopy1(RELOID, ObjectIdGetDatum(OIDOldHeap));
1514  if (!HeapTupleIsValid(reltup))
1515  elog(ERROR, "cache lookup failed for relation %u", OIDOldHeap);
1516  relform = (Form_pg_class) GETSTRUCT(reltup);
1517 
1518  relform->relfrozenxid = frozenXid;
1519  relform->relminmxid = cutoffMulti;
1520 
1521  CatalogTupleUpdate(relRelation, &reltup->t_self, reltup);
1522 
1523  table_close(relRelation, RowExclusiveLock);
1524  }
1525 
1526  /* Destroy new heap with old filenode */
1527  object.classId = RelationRelationId;
1528  object.objectId = OIDNewHeap;
1529  object.objectSubId = 0;
1530 
1531  /*
1532  * The new relation is local to our transaction and we know nothing
1533  * depends on it, so DROP_RESTRICT should be OK.
1534  */
1536 
1537  /* performDeletion does CommandCounterIncrement at end */
1538 
1539  /*
1540  * Now we must remove any relation mapping entries that we set up for the
1541  * transient table, as well as its toast table and toast index if any. If
1542  * we fail to do this before commit, the relmapper will complain about new
1543  * permanent map entries being added post-bootstrap.
1544  */
1545  for (i = 0; OidIsValid(mapped_tables[i]); i++)
1546  RelationMapRemoveMapping(mapped_tables[i]);
1547 
1548  /*
1549  * At this point, everything is kosher except that, if we did toast swap
1550  * by links, the toast table's name corresponds to the transient table.
1551  * The name is irrelevant to the backend because it's referenced by OID,
1552  * but users looking at the catalogs could be confused. Rename it to
1553  * prevent this problem.
1554  *
1555  * Note no lock required on the relation, because we already hold an
1556  * exclusive lock on it.
1557  */
1558  if (!swap_toast_by_content)
1559  {
1560  Relation newrel;
1561 
1562  newrel = table_open(OIDOldHeap, NoLock);
1563  if (OidIsValid(newrel->rd_rel->reltoastrelid))
1564  {
1565  Oid toastidx;
1566  char NewToastName[NAMEDATALEN];
1567 
1568  /* Get the associated valid index to be renamed */
1569  toastidx = toast_get_valid_index(newrel->rd_rel->reltoastrelid,
1570  NoLock);
1571 
1572  /* rename the toast table ... */
1573  snprintf(NewToastName, NAMEDATALEN, "pg_toast_%u",
1574  OIDOldHeap);
1575  RenameRelationInternal(newrel->rd_rel->reltoastrelid,
1576  NewToastName, true, false);
1577 
1578  /* ... and its valid index too. */
1579  snprintf(NewToastName, NAMEDATALEN, "pg_toast_%u_index",
1580  OIDOldHeap);
1581 
1582  RenameRelationInternal(toastidx,
1583  NewToastName, true, true);
1584 
1585  /*
1586  * Reset the relrewrite for the toast. The command-counter
1587  * increment is required here as we are about to update the tuple
1588  * that is updated as part of RenameRelationInternal.
1589  */
1591  ResetRelRewrite(newrel->rd_rel->reltoastrelid);
1592  }
1593  relation_close(newrel, NoLock);
1594  }
1595 
1596  /* if it's not a catalog table, clear any missing attribute settings */
1597  if (!is_system_catalog)
1598  {
1599  Relation newrel;
1600 
1601  newrel = table_open(OIDOldHeap, NoLock);
1602  RelationClearMissing(newrel);
1603  relation_close(newrel, NoLock);
1604  }
1605 }
static void swap_relation_files(Oid r1, Oid r2, bool target_is_pg_class, bool swap_toast_by_content, bool is_internal, TransactionId frozenXid, MultiXactId cutoffMulti, Oid *mapped_tables)
Definition: cluster.c:1052
void performDeletion(const ObjectAddress *object, DropBehavior behavior, int flags)
Definition: dependency.c:317
#define PERFORM_DELETION_INTERNAL
Definition: dependency.h:135
#define elog(elevel,...)
Definition: elog.h:218
void RelationClearMissing(Relation rel)
Definition: heap.c:1939
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define GETSTRUCT(TUP)
Definition: htup_details.h:649
bool reindex_relation(Oid relid, int flags, ReindexParams *params)
Definition: index.c:3859
#define REINDEX_REL_FORCE_INDEXES_UNLOGGED
Definition: index.h:158
#define REINDEX_REL_SUPPRESS_INDEX_USE
Definition: index.h:156
#define REINDEX_REL_FORCE_INDEXES_PERMANENT
Definition: index.h:159
#define REINDEX_REL_CHECK_CONSTRAINTS
Definition: index.h:157
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:301
void CacheInvalidateCatalog(Oid catalogId)
Definition: inval.c:1339
int i
Definition: isn.c:73
#define RowExclusiveLock
Definition: lockdefs.h:38
@ DROP_RESTRICT
Definition: parsenodes.h:2207
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
#define NAMEDATALEN
#define snprintf
Definition: port.h:225
#define PROGRESS_CLUSTER_PHASE
Definition: progress.h:56
#define PROGRESS_CLUSTER_PHASE_REBUILD_INDEX
Definition: progress.h:70
#define PROGRESS_CLUSTER_PHASE_FINAL_CLEANUP
Definition: progress.h:71
#define PROGRESS_CLUSTER_PHASE_SWAP_REL_FILES
Definition: progress.h:69
void RelationMapRemoveMapping(Oid relationId)
Definition: relmapper.c:432
ItemPointerData t_self
Definition: htup.h:65
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:179
void ResetRelRewrite(Oid myrelid)
Definition: tablecmds.c:3936
void RenameRelationInternal(Oid myrelid, const char *newrelname, bool is_internal, bool is_index)
Definition: tablecmds.c:3846
Oid toast_get_valid_index(Oid toastoid, LOCKMODE lock)
void CommandCounterIncrement(void)
Definition: xact.c:1074

References CacheInvalidateCatalog(), CatalogTupleUpdate(), CommandCounterIncrement(), DROP_RESTRICT, elog, ERROR, GETSTRUCT, HeapTupleIsValid, i, NAMEDATALEN, NoLock, ObjectIdGetDatum, OidIsValid, PERFORM_DELETION_INTERNAL, performDeletion(), pgstat_progress_update_param(), PROGRESS_CLUSTER_PHASE, PROGRESS_CLUSTER_PHASE_FINAL_CLEANUP, PROGRESS_CLUSTER_PHASE_REBUILD_INDEX, PROGRESS_CLUSTER_PHASE_SWAP_REL_FILES, RelationData::rd_rel, REINDEX_REL_CHECK_CONSTRAINTS, REINDEX_REL_FORCE_INDEXES_PERMANENT, REINDEX_REL_FORCE_INDEXES_UNLOGGED, REINDEX_REL_SUPPRESS_INDEX_USE, reindex_relation(), relation_close(), RelationClearMissing(), RelationMapRemoveMapping(), RELOID, RenameRelationInternal(), ResetRelRewrite(), RowExclusiveLock, SearchSysCacheCopy1, snprintf, swap_relation_files(), HeapTupleData::t_self, table_close(), table_open(), and toast_get_valid_index().

Referenced by ATRewriteTables(), rebuild_relation(), and refresh_by_heap_swap().

◆ make_new_heap()

Oid make_new_heap ( Oid  OIDOldHeap,
Oid  NewTableSpace,
Oid  NewAccessMethod,
char  relpersistence,
LOCKMODE  lockmode 
)

Definition at line 686 of file cluster.c.

688 {
689  TupleDesc OldHeapDesc;
690  char NewHeapName[NAMEDATALEN];
691  Oid OIDNewHeap;
692  Oid toastid;
693  Relation OldHeap;
694  HeapTuple tuple;
695  Datum reloptions;
696  bool isNull;
697  Oid namespaceid;
698 
699  OldHeap = table_open(OIDOldHeap, lockmode);
700  OldHeapDesc = RelationGetDescr(OldHeap);
701 
702  /*
703  * Note that the NewHeap will not receive any of the defaults or
704  * constraints associated with the OldHeap; we don't need 'em, and there's
705  * no reason to spend cycles inserting them into the catalogs only to
706  * delete them.
707  */
708 
709  /*
710  * But we do want to use reloptions of the old heap for new heap.
711  */
712  tuple = SearchSysCache1(RELOID, ObjectIdGetDatum(OIDOldHeap));
713  if (!HeapTupleIsValid(tuple))
714  elog(ERROR, "cache lookup failed for relation %u", OIDOldHeap);
715  reloptions = SysCacheGetAttr(RELOID, tuple, Anum_pg_class_reloptions,
716  &isNull);
717  if (isNull)
718  reloptions = (Datum) 0;
719 
720  if (relpersistence == RELPERSISTENCE_TEMP)
721  namespaceid = LookupCreationNamespace("pg_temp");
722  else
723  namespaceid = RelationGetNamespace(OldHeap);
724 
725  /*
726  * Create the new heap, using a temporary name in the same namespace as
727  * the existing table. NOTE: there is some risk of collision with user
728  * relnames. Working around this seems more trouble than it's worth; in
729  * particular, we can't create the new heap in a different namespace from
730  * the old, or we will have problems with the TEMP status of temp tables.
731  *
732  * Note: the new heap is not a shared relation, even if we are rebuilding
733  * a shared rel. However, we do make the new heap mapped if the source is
734  * mapped. This simplifies swap_relation_files, and is absolutely
735  * necessary for rebuilding pg_class, for reasons explained there.
736  */
737  snprintf(NewHeapName, sizeof(NewHeapName), "pg_temp_%u", OIDOldHeap);
738 
739  OIDNewHeap = heap_create_with_catalog(NewHeapName,
740  namespaceid,
741  NewTableSpace,
742  InvalidOid,
743  InvalidOid,
744  InvalidOid,
745  OldHeap->rd_rel->relowner,
746  NewAccessMethod,
747  OldHeapDesc,
748  NIL,
749  RELKIND_RELATION,
750  relpersistence,
751  false,
752  RelationIsMapped(OldHeap),
754  reloptions,
755  false,
756  true,
757  true,
758  OIDOldHeap,
759  NULL);
760  Assert(OIDNewHeap != InvalidOid);
761 
762  ReleaseSysCache(tuple);
763 
764  /*
765  * Advance command counter so that the newly-created relation's catalog
766  * tuples will be visible to table_open.
767  */
769 
770  /*
771  * If necessary, create a TOAST table for the new relation.
772  *
773  * If the relation doesn't have a TOAST table already, we can't need one
774  * for the new relation. The other way around is possible though: if some
775  * wide columns have been dropped, NewHeapCreateToastTable can decide that
776  * no TOAST table is needed for the new table.
777  *
778  * Note that NewHeapCreateToastTable ends with CommandCounterIncrement, so
779  * that the TOAST table will be visible for insertion.
780  */
781  toastid = OldHeap->rd_rel->reltoastrelid;
782  if (OidIsValid(toastid))
783  {
784  /* keep the existing toast table's reloptions, if any */
785  tuple = SearchSysCache1(RELOID, ObjectIdGetDatum(toastid));
786  if (!HeapTupleIsValid(tuple))
787  elog(ERROR, "cache lookup failed for relation %u", toastid);
788  reloptions = SysCacheGetAttr(RELOID, tuple, Anum_pg_class_reloptions,
789  &isNull);
790  if (isNull)
791  reloptions = (Datum) 0;
792 
793  NewHeapCreateToastTable(OIDNewHeap, reloptions, lockmode, toastid);
794 
795  ReleaseSysCache(tuple);
796  }
797 
798  table_close(OldHeap, NoLock);
799 
800  return OIDNewHeap;
801 }
Oid heap_create_with_catalog(const char *relname, Oid relnamespace, Oid reltablespace, Oid relid, Oid reltypeid, Oid reloftypeid, Oid ownerid, Oid accessmtd, TupleDesc tupdesc, List *cooked_constraints, char relkind, char relpersistence, bool shared_relation, bool mapped_relation, OnCommitAction oncommit, Datum reloptions, bool use_user_acl, bool allow_system_table_mods, bool is_internal, Oid relrewrite, ObjectAddress *typaddress)
Definition: heap.c:1088
Oid LookupCreationNamespace(const char *nspname)
Definition: namespace.c:2982
#define NIL
Definition: pg_list.h:65
uintptr_t Datum
Definition: postgres.h:411
@ ONCOMMIT_NOOP
Definition: primnodes.h:49
#define RelationGetDescr(relation)
Definition: rel.h:514
#define RelationIsMapped(relation)
Definition: rel.h:537
#define RelationGetNamespace(relation)
Definition: rel.h:529
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1221
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1173
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1434
void NewHeapCreateToastTable(Oid relOid, Datum reloptions, LOCKMODE lockmode, Oid OIDOldToast)
Definition: toasting.c:66

References Assert(), CommandCounterIncrement(), elog, ERROR, heap_create_with_catalog(), HeapTupleIsValid, InvalidOid, LookupCreationNamespace(), NAMEDATALEN, NewHeapCreateToastTable(), NIL, NoLock, ObjectIdGetDatum, OidIsValid, ONCOMMIT_NOOP, RelationData::rd_rel, RelationGetDescr, RelationGetNamespace, RelationIsMapped, ReleaseSysCache(), RELOID, SearchSysCache1(), snprintf, SysCacheGetAttr(), table_close(), and table_open().

Referenced by ATRewriteTables(), ExecRefreshMatView(), and rebuild_relation().

◆ mark_index_clustered()

void mark_index_clustered ( Relation  rel,
Oid  indexOid,
bool  is_internal 
)

Definition at line 558 of file cluster.c.

559 {
560  HeapTuple indexTuple;
561  Form_pg_index indexForm;
562  Relation pg_index;
563  ListCell *index;
564 
565  /* Disallow applying to a partitioned table */
566  if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
567  ereport(ERROR,
568  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
569  errmsg("cannot mark index clustered in partitioned table")));
570 
571  /*
572  * If the index is already marked clustered, no need to do anything.
573  */
574  if (OidIsValid(indexOid))
575  {
576  if (get_index_isclustered(indexOid))
577  return;
578  }
579 
580  /*
581  * Check each index of the relation and set/clear the bit as needed.
582  */
583  pg_index = table_open(IndexRelationId, RowExclusiveLock);
584 
585  foreach(index, RelationGetIndexList(rel))
586  {
587  Oid thisIndexOid = lfirst_oid(index);
588 
589  indexTuple = SearchSysCacheCopy1(INDEXRELID,
590  ObjectIdGetDatum(thisIndexOid));
591  if (!HeapTupleIsValid(indexTuple))
592  elog(ERROR, "cache lookup failed for index %u", thisIndexOid);
593  indexForm = (Form_pg_index) GETSTRUCT(indexTuple);
594 
595  /*
596  * Unset the bit if set. We know it's wrong because we checked this
597  * earlier.
598  */
599  if (indexForm->indisclustered)
600  {
601  indexForm->indisclustered = false;
602  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
603  }
604  else if (thisIndexOid == indexOid)
605  {
606  /* this was checked earlier, but let's be real sure */
607  if (!indexForm->indisvalid)
608  elog(ERROR, "cannot cluster on invalid index %u", indexOid);
609  indexForm->indisclustered = true;
610  CatalogTupleUpdate(pg_index, &indexTuple->t_self, indexTuple);
611  }
612 
613  InvokeObjectPostAlterHookArg(IndexRelationId, thisIndexOid, 0,
614  InvalidOid, is_internal);
615 
616  heap_freetuple(indexTuple);
617  }
618 
619  table_close(pg_index, RowExclusiveLock);
620 }
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
#define InvokeObjectPostAlterHookArg(classId, objectId, subId, auxiliaryId, is_internal)
Definition: objectaccess.h:198
FormData_pg_index * Form_pg_index
Definition: pg_index.h:70
@ INDEXRELID
Definition: syscache.h:66

References CatalogTupleUpdate(), elog, ereport, errcode(), errmsg(), ERROR, get_index_isclustered(), GETSTRUCT, heap_freetuple(), HeapTupleIsValid, INDEXRELID, InvalidOid, InvokeObjectPostAlterHookArg, lfirst_oid, ObjectIdGetDatum, OidIsValid, RelationData::rd_rel, RelationGetIndexList(), RowExclusiveLock, SearchSysCacheCopy1, HeapTupleData::t_self, table_close(), and table_open().

Referenced by ATExecClusterOn(), ATExecDropCluster(), and rebuild_relation().