PostgreSQL Source Code  git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 cutoffMulti, 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 499 of file cluster.c.

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

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 107 of file cluster.c.

108 {
109  ListCell *lc;
110  ClusterParams params = {0};
111  bool verbose = false;
112  Relation rel = NULL;
113  Oid indexOid = InvalidOid;
114  MemoryContext cluster_context;
115  List *rtcs;
116 
117  /* Parse option list */
118  foreach(lc, stmt->params)
119  {
120  DefElem *opt = (DefElem *) lfirst(lc);
121 
122  if (strcmp(opt->defname, "verbose") == 0)
123  verbose = defGetBoolean(opt);
124  else
125  ereport(ERROR,
126  (errcode(ERRCODE_SYNTAX_ERROR),
127  errmsg("unrecognized CLUSTER option \"%s\"",
128  opt->defname),
129  parser_errposition(pstate, opt->location)));
130  }
131 
132  params.options = (verbose ? CLUOPT_VERBOSE : 0);
133 
134  if (stmt->relation != NULL)
135  {
136  /* This is the single-relation case. */
137  Oid tableOid;
138 
139  /*
140  * Find, lock, and check permissions on the table. We obtain
141  * AccessExclusiveLock right away to avoid lock-upgrade hazard in the
142  * single-transaction case.
143  */
144  tableOid = RangeVarGetRelidExtended(stmt->relation,
146  0,
148  NULL);
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 Assert(condition)
Definition: c.h:837
#define OidIsValid(objectId)
Definition: c.h:754
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:499
static List * get_tables_to_cluster(MemoryContext cluster_context)
Definition: cluster.c:1635
static List * get_tables_to_cluster_partitioned(MemoryContext cluster_context, Oid indexOid)
Definition: cluster.c:1689
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:107
#define stmt
Definition: indent_codes.h:59
int verbose
#define AccessExclusiveLock
Definition: lockdefs.h:43
#define AccessShareLock
Definition: lockdefs.h:36
bool get_index_isclustered(Oid index_oid)
Definition: lsyscache.c:3601
Oid get_relname_relid(const char *relname, Oid relnamespace)
Definition: lsyscache.c:1885
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:454
MemoryContext PortalContext
Definition: mcxt.c:158
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, uint32 flags, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:441
int parser_errposition(ParseState *pstate, int location)
Definition: parse_node.c:106
#define lfirst(lc)
Definition: pg_list.h:172
#define lfirst_oid(lc)
Definition: pg_list.h:174
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:658
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4766
bits32 options
Definition: cluster.h:30
char * defname
Definition: parsenodes.h:817
ParseLoc location
Definition: parsenodes.h:821
Definition: pg_list.h:54
Form_pg_class rd_rel
Definition: rel.h:111
Definition: type.h:96
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:40
void RangeVarCallbackMaintainsTable(const RangeVar *relation, Oid relId, Oid oldRelId, void *arg)
Definition: tablecmds.c:18257
void PreventInTransactionBlock(bool isTopLevel, const char *stmtType)
Definition: xact.c:3640
void StartTransactionCommand(void)
Definition: xact.c:3051

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(), InvalidOid, lfirst, lfirst_oid, DefElem::location, MemoryContextDelete(), NoLock, OidIsValid, ClusterParams::options, parser_errposition(), PortalContext, PreventInTransactionBlock(), RangeVarCallbackMaintainsTable(), RangeVarGetRelidExtended(), RelationData::rd_rel, RELATION_IS_OTHER_TEMP, RelationGetIndexList(), StartTransactionCommand(), stmt, table_close(), table_open(), and verbose.

Referenced by adjust_data_dir(), check_bin_dir(), check_data_dir(), check_for_connection_status(), check_for_data_types_usage(), check_for_incompatible_polymorphics(), check_for_isn_and_int8_passing_mismatch(), check_for_pg_role_prefix(), check_for_prepared_transactions(), check_for_tables_with_oids(), check_for_user_defined_encoding_conversions(), check_for_user_defined_postfix_ops(), check_is_install_user(), cluster_conn_opts(), connectToServer(), get_bin_version(), get_control_data(), get_db_conn(), get_db_infos(), get_db_rel_and_slot_infos(), get_major_server_version(), get_sock_dir(), get_subscription_count(), get_template0_info(), jsonb_9_4_check_applicable(), old_9_6_invalidate_hash_indexes(), process_query_result(), process_slot(), report_extension_updates(), set_tablespace_directory_suffix(), standard_ProcessUtility(), start_conn(), start_postmaster(), stop_postmaster(), and upgrade_task_run().

◆ 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();
355 
356  /*
357  * Since we may open a new transaction for each relation, we have to check
358  * that the relation still is what we think it is.
359  *
360  * If this is a single-transaction CLUSTER, we can skip these tests. We
361  * *must* skip the one on indisclustered since it would reject an attempt
362  * to cluster a not-previously-clustered index.
363  */
364  if (recheck)
365  {
366  /* Check that the user still has privileges for the relation */
367  if (!cluster_is_permitted_for_relation(tableOid, save_userid))
368  {
370  goto out;
371  }
372 
373  /*
374  * Silently skip a temp table for a remote session. Only doing this
375  * check in the "recheck" case is appropriate (which currently means
376  * somebody is executing a database-wide CLUSTER or on a partitioned
377  * table), because there is another check in cluster() which will stop
378  * any attempt to cluster remote temp tables by name. There is
379  * another check in cluster_rel which is redundant, but we leave it
380  * for extra safety.
381  */
382  if (RELATION_IS_OTHER_TEMP(OldHeap))
383  {
385  goto out;
386  }
387 
388  if (OidIsValid(indexOid))
389  {
390  /*
391  * Check that the index still exists
392  */
393  if (!SearchSysCacheExists1(RELOID, ObjectIdGetDatum(indexOid)))
394  {
396  goto out;
397  }
398 
399  /*
400  * Check that the index is still the one with indisclustered set,
401  * if needed.
402  */
403  if ((params->options & CLUOPT_RECHECK_ISCLUSTERED) != 0 &&
404  !get_index_isclustered(indexOid))
405  {
407  goto out;
408  }
409  }
410  }
411 
412  /*
413  * We allow VACUUM FULL, but not CLUSTER, on shared catalogs. CLUSTER
414  * would work in most respects, but the index would only get marked as
415  * indisclustered in the current database, leading to unexpected behavior
416  * if CLUSTER were later invoked in another database.
417  */
418  if (OidIsValid(indexOid) && OldHeap->rd_rel->relisshared)
419  ereport(ERROR,
420  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
421  errmsg("cannot cluster a shared catalog")));
422 
423  /*
424  * Don't process temp tables of other backends ... their local buffer
425  * manager is not going to cope.
426  */
427  if (RELATION_IS_OTHER_TEMP(OldHeap))
428  {
429  if (OidIsValid(indexOid))
430  ereport(ERROR,
431  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
432  errmsg("cannot cluster temporary tables of other sessions")));
433  else
434  ereport(ERROR,
435  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
436  errmsg("cannot vacuum temporary tables of other sessions")));
437  }
438 
439  /*
440  * Also check for active uses of the relation in the current transaction,
441  * including open scans and pending AFTER trigger events.
442  */
443  CheckTableNotInUse(OldHeap, OidIsValid(indexOid) ? "CLUSTER" : "VACUUM");
444 
445  /* Check heap and index are valid to cluster on */
446  if (OidIsValid(indexOid))
448 
449  /*
450  * Quietly ignore the request if this is a materialized view which has not
451  * been populated from its query. No harm is done because there is no data
452  * to deal with, and we don't want to throw an error if this is part of a
453  * multi-relation request -- for example, CLUSTER was run on the entire
454  * database.
455  */
456  if (OldHeap->rd_rel->relkind == RELKIND_MATVIEW &&
457  !RelationIsPopulated(OldHeap))
458  {
460  goto out;
461  }
462 
463  Assert(OldHeap->rd_rel->relkind == RELKIND_RELATION ||
464  OldHeap->rd_rel->relkind == RELKIND_MATVIEW ||
465  OldHeap->rd_rel->relkind == RELKIND_TOASTVALUE);
466 
467  /*
468  * All predicate locks on the tuples or pages are about to be made
469  * invalid, because we move tuples around. Promote them to relation
470  * locks. Predicate locks on indexes will be promoted when they are
471  * reindexed.
472  */
474 
475  /* rebuild_relation does all the dirty work */
476  rebuild_relation(OldHeap, indexOid, verbose);
477 
478  /* NB: rebuild_relation does table_close() on OldHeap */
479 
480 out:
481  /* Roll back any GUC changes executed by index functions */
482  AtEOXact_GUC(false, save_nestlevel);
483 
484  /* Restore userid and security context */
485  SetUserIdAndSecContext(save_userid, save_sec_context);
486 
488 }
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:632
static bool cluster_is_permitted_for_relation(Oid relid, Oid userid)
Definition: cluster.c:1737
int NewGUCNestLevel(void)
Definition: guc.c:2235
void RestrictSearchPath(void)
Definition: guc.c:2246
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:2262
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:312
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:667
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:674
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
void TransferPredicateLocksToHeapRelation(Relation relation)
Definition: predicate.c:3113
#define PROGRESS_CLUSTER_COMMAND_VACUUM_FULL
Definition: progress.h:78
#define PROGRESS_CLUSTER_COMMAND_CLUSTER
Definition: progress.h:77
#define PROGRESS_CLUSTER_COMMAND
Definition: progress.h:58
#define RelationIsPopulated(relation)
Definition: rel.h:677
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:205
Relation try_relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:88
#define SearchSysCacheExists1(cacheId, key1)
Definition: syscache.h:100
void CheckTableNotInUse(Relation rel, const char *stmt)
Definition: tablecmds.c:4329

References AccessExclusiveLock, Assert, AtEOXact_GUC(), CHECK_FOR_INTERRUPTS, check_index_is_clusterable(), CheckTableNotInUse(), CLUOPT_RECHECK, CLUOPT_RECHECK_ISCLUSTERED, CLUOPT_VERBOSE, cluster_is_permitted_for_relation(), ereport, errcode(), errmsg(), ERROR, get_index_isclustered(), GetUserIdAndSecContext(), NewGUCNestLevel(), ObjectIdGetDatum(), OidIsValid, ClusterParams::options, 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, RestrictSearchPath(), 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  cutoffMulti,
char  newrelpersistence 
)

Definition at line 1437 of file cluster.c.

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

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(), 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 687 of file cluster.c.

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

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(), SearchSysCache1(), snprintf, SysCacheGetAttr(), table_close(), and table_open().

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

◆ mark_index_clustered()

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

Definition at line 559 of file cluster.c.

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

References CatalogTupleUpdate(), elog, ereport, errcode(), errmsg(), ERROR, get_index_isclustered(), GETSTRUCT, heap_freetuple(), HeapTupleIsValid, 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().