PostgreSQL Source Code  git master
rel.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * rel.h
4  * POSTGRES relation descriptor (a/k/a relcache entry) definitions.
5  *
6  *
7  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/utils/rel.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef REL_H
15 #define REL_H
16 
17 #include "access/tupdesc.h"
18 #include "access/xlog.h"
19 #include "catalog/catalog.h"
20 #include "catalog/pg_class.h"
21 #include "catalog/pg_index.h"
22 #include "catalog/pg_publication.h"
23 #include "nodes/bitmapset.h"
24 #include "partitioning/partdefs.h"
25 #include "rewrite/prs2lock.h"
26 #include "storage/block.h"
27 #include "storage/relfilelocator.h"
28 #include "storage/smgr.h"
29 #include "utils/relcache.h"
30 #include "utils/reltrigger.h"
31 
32 
33 /*
34  * LockRelId and LockInfo really belong to lmgr.h, but it's more convenient
35  * to declare them here so we can have a LockInfoData field in a Relation.
36  */
37 
38 typedef struct LockRelId
39 {
40  Oid relId; /* a relation identifier */
41  Oid dbId; /* a database identifier */
43 
44 typedef struct LockInfoData
45 {
48 
50 
51 /*
52  * Here are the contents of a relation cache entry.
53  */
54 
55 typedef struct RelationData
56 {
57  RelFileLocator rd_locator; /* relation physical identifier */
58  SMgrRelation rd_smgr; /* cached file handle, or NULL */
59  int rd_refcnt; /* reference count */
60  BackendId rd_backend; /* owning backend id, if temporary relation */
61  bool rd_islocaltemp; /* rel is a temp rel of this session */
62  bool rd_isnailed; /* rel is nailed in cache */
63  bool rd_isvalid; /* relcache entry is valid */
64  bool rd_indexvalid; /* is rd_indexlist valid? (also rd_pkindex and
65  * rd_replidindex) */
66  bool rd_statvalid; /* is rd_statlist valid? */
67 
68  /*----------
69  * rd_createSubid is the ID of the highest subtransaction the rel has
70  * survived into or zero if the rel or its storage was created before the
71  * current top transaction. (IndexStmt.oldNumber leads to the case of a new
72  * rel with an old rd_locator.) rd_firstRelfilelocatorSubid is the ID of the
73  * highest subtransaction an rd_locator change has survived into or zero if
74  * rd_locator matches the value it had at the start of the current top
75  * transaction. (Rolling back the subtransaction that
76  * rd_firstRelfilelocatorSubid denotes would restore rd_locator to the value it
77  * had at the start of the current top transaction. Rolling back any
78  * lower subtransaction would not.) Their accuracy is critical to
79  * RelationNeedsWAL().
80  *
81  * rd_newRelfilelocatorSubid is the ID of the highest subtransaction the
82  * most-recent relfilenumber change has survived into or zero if not changed
83  * in the current transaction (or we have forgotten changing it). This
84  * field is accurate when non-zero, but it can be zero when a relation has
85  * multiple new relfilenumbers within a single transaction, with one of them
86  * occurring in a subsequently aborted subtransaction, e.g.
87  * BEGIN;
88  * TRUNCATE t;
89  * SAVEPOINT save;
90  * TRUNCATE t;
91  * ROLLBACK TO save;
92  * -- rd_newRelfilelocatorSubid is now forgotten
93  *
94  * If every rd_*Subid field is zero, they are read-only outside
95  * relcache.c. Files that trigger rd_locator changes by updating
96  * pg_class.reltablespace and/or pg_class.relfilenode call
97  * RelationAssumeNewRelfilelocator() to update rd_*Subid.
98  *
99  * rd_droppedSubid is the ID of the highest subtransaction that a drop of
100  * the rel has survived into. In entries visible outside relcache.c, this
101  * is always zero.
102  */
103  SubTransactionId rd_createSubid; /* rel was created in current xact */
104  SubTransactionId rd_newRelfilelocatorSubid; /* highest subxact changing
105  * rd_locator to current value */
107  * changing rd_locator to
108  * any value */
109  SubTransactionId rd_droppedSubid; /* dropped with another Subid set */
110 
111  Form_pg_class rd_rel; /* RELATION tuple */
112  TupleDesc rd_att; /* tuple descriptor */
113  Oid rd_id; /* relation's object id */
114  LockInfoData rd_lockInfo; /* lock mgr's info for locking relation */
115  RuleLock *rd_rules; /* rewrite rules */
116  MemoryContext rd_rulescxt; /* private memory cxt for rd_rules, if any */
117  TriggerDesc *trigdesc; /* Trigger info, or NULL if rel has none */
118  /* use "struct" here to avoid needing to include rowsecurity.h: */
119  struct RowSecurityDesc *rd_rsdesc; /* row security policies, or NULL */
120 
121  /* data managed by RelationGetFKeyList: */
122  List *rd_fkeylist; /* list of ForeignKeyCacheInfo (see below) */
123  bool rd_fkeyvalid; /* true if list has been computed */
124 
125  /* data managed by RelationGetPartitionKey: */
126  PartitionKey rd_partkey; /* partition key, or NULL */
127  MemoryContext rd_partkeycxt; /* private context for rd_partkey, if any */
128 
129  /* data managed by RelationGetPartitionDesc: */
130  PartitionDesc rd_partdesc; /* partition descriptor, or NULL */
131  MemoryContext rd_pdcxt; /* private context for rd_partdesc, if any */
132 
133  /* Same as above, for partdescs that omit detached partitions */
134  PartitionDesc rd_partdesc_nodetached; /* partdesc w/o detached parts */
135  MemoryContext rd_pddcxt; /* for rd_partdesc_nodetached, if any */
136 
137  /*
138  * pg_inherits.xmin of the partition that was excluded in
139  * rd_partdesc_nodetached. This informs a future user of that partdesc:
140  * if this value is not in progress for the active snapshot, then the
141  * partdesc can be used, otherwise they have to build a new one. (This
142  * matches what find_inheritance_children_extended would do).
143  */
145 
146  /* data managed by RelationGetPartitionQual: */
147  List *rd_partcheck; /* partition CHECK quals */
148  bool rd_partcheckvalid; /* true if list has been computed */
149  MemoryContext rd_partcheckcxt; /* private cxt for rd_partcheck, if any */
150 
151  /* data managed by RelationGetIndexList: */
152  List *rd_indexlist; /* list of OIDs of indexes on relation */
153  Oid rd_pkindex; /* OID of primary key, if any */
154  Oid rd_replidindex; /* OID of replica identity index, if any */
155 
156  /* data managed by RelationGetStatExtList: */
157  List *rd_statlist; /* list of OIDs of extended stats */
158 
159  /* data managed by RelationGetIndexAttrBitmap: */
160  bool rd_attrsvalid; /* are bitmaps of attrs valid? */
161  Bitmapset *rd_keyattr; /* cols that can be ref'd by foreign keys */
162  Bitmapset *rd_pkattr; /* cols included in primary key */
163  Bitmapset *rd_idattr; /* included in replica identity index */
164  Bitmapset *rd_hotblockingattr; /* cols blocking HOT update */
165  Bitmapset *rd_summarizedattr; /* cols indexed by summarizing indexes */
166 
167  PublicationDesc *rd_pubdesc; /* publication descriptor, or NULL */
168 
169  /*
170  * rd_options is set whenever rd_rel is loaded into the relcache entry.
171  * Note that you can NOT look into rd_rel for this data. NULL means "use
172  * defaults".
173  */
174  bytea *rd_options; /* parsed pg_class.reloptions */
175 
176  /*
177  * Oid of the handler for this relation. For an index this is a function
178  * returning IndexAmRoutine, for table like relations a function returning
179  * TableAmRoutine. This is stored separately from rd_indam, rd_tableam as
180  * its lookup requires syscache access, but during relcache bootstrap we
181  * need to be able to initialize rd_tableam without syscache lookups.
182  */
183  Oid rd_amhandler; /* OID of index AM's handler function */
184 
185  /*
186  * Table access method.
187  */
188  const struct TableAmRoutine *rd_tableam;
189 
190  /* These are non-NULL only for an index relation: */
191  Form_pg_index rd_index; /* pg_index tuple describing this index */
192  /* use "struct" here to avoid needing to include htup.h: */
193  struct HeapTupleData *rd_indextuple; /* all of pg_index tuple */
194 
195  /*
196  * index access support info (used only for an index relation)
197  *
198  * Note: only default support procs for each opclass are cached, namely
199  * those with lefttype and righttype equal to the opclass's opcintype. The
200  * arrays are indexed by support function number, which is a sufficient
201  * identifier given that restriction.
202  */
203  MemoryContext rd_indexcxt; /* private memory cxt for this stuff */
204  /* use "struct" here to avoid needing to include amapi.h: */
205  struct IndexAmRoutine *rd_indam; /* index AM's API struct */
206  Oid *rd_opfamily; /* OIDs of op families for each index col */
207  Oid *rd_opcintype; /* OIDs of opclass declared input data types */
208  RegProcedure *rd_support; /* OIDs of support procedures */
209  struct FmgrInfo *rd_supportinfo; /* lookup info for support procedures */
210  int16 *rd_indoption; /* per-column AM-specific flags */
211  List *rd_indexprs; /* index expression trees, if any */
212  List *rd_indpred; /* index predicate tree, if any */
213  Oid *rd_exclops; /* OIDs of exclusion operators, if any */
214  Oid *rd_exclprocs; /* OIDs of exclusion ops' procs, if any */
215  uint16 *rd_exclstrats; /* exclusion ops' strategy numbers, if any */
216  Oid *rd_indcollation; /* OIDs of index collations */
217  bytea **rd_opcoptions; /* parsed opclass-specific options */
218 
219  /*
220  * rd_amcache is available for index and table AMs to cache private data
221  * about the relation. This must be just a cache since it may get reset
222  * at any time (in particular, it will get reset by a relcache inval
223  * message for the relation). If used, it must point to a single memory
224  * chunk palloc'd in CacheMemoryContext, or in rd_indexcxt for an index
225  * relation. A relcache reset will include freeing that chunk and setting
226  * rd_amcache = NULL.
227  */
228  void *rd_amcache; /* available for use by index/table AM */
229 
230  /*
231  * foreign-table support
232  *
233  * rd_fdwroutine must point to a single memory chunk palloc'd in
234  * CacheMemoryContext. It will be freed and reset to NULL on a relcache
235  * reset.
236  */
237 
238  /* use "struct" here to avoid needing to include fdwapi.h: */
239  struct FdwRoutine *rd_fdwroutine; /* cached function pointers, or NULL */
240 
241  /*
242  * Hack for CLUSTER, rewriting ALTER TABLE, etc: when writing a new
243  * version of a table, we need to make any toast pointers inserted into it
244  * have the existing toast table's OID, not the OID of the transient toast
245  * table. If rd_toastoid isn't InvalidOid, it is the OID to place in
246  * toast pointers inserted into this rel. (Note it's set on the new
247  * version of the main heap, not the toast table itself.) This also
248  * causes toast_save_datum() to try to preserve toast value OIDs.
249  */
250  Oid rd_toastoid; /* Real TOAST table's OID, or InvalidOid */
251 
252  bool pgstat_enabled; /* should relation stats be counted */
253  /* use "struct" here to avoid needing to include pgstat.h: */
254  struct PgStat_TableStatus *pgstat_info; /* statistics collection area */
256 
257 
258 /*
259  * ForeignKeyCacheInfo
260  * Information the relcache can cache about foreign key constraints
261  *
262  * This is basically just an image of relevant columns from pg_constraint.
263  * We make it a subclass of Node so that copyObject() can be used on a list
264  * of these, but we also ensure it is a "flat" object without substructure,
265  * so that list_free_deep() is sufficient to free such a list.
266  * The per-FK-column arrays can be fixed-size because we allow at most
267  * INDEX_MAX_KEYS columns in a foreign key constraint.
268  *
269  * Currently, we mostly cache fields of interest to the planner, but the set
270  * of fields has already grown the constraint OID for other uses.
271  */
272 typedef struct ForeignKeyCacheInfo
273 {
274  pg_node_attr(no_equal, no_read, no_query_jumble)
275 
276  NodeTag type;
277  /* oid of the constraint itself */
279  /* relation constrained by the foreign key */
281  /* relation referenced by the foreign key */
283  /* number of columns in the foreign key */
284  int nkeys;
285 
286  /*
287  * these arrays each have nkeys valid entries:
288  */
289  /* cols in referencing table */
291  /* cols in referenced table */
293  /* PK = FK operator OIDs */
294  Oid conpfeqop[INDEX_MAX_KEYS] pg_node_attr(array_size(nkeys));
296 
297 
298 /*
299  * StdRdOptions
300  * Standard contents of rd_options for heaps.
301  *
302  * RelationGetFillFactor() and RelationGetTargetPageFreeSpace() can only
303  * be applied to relations that use this format or a superset for
304  * private options data.
305  */
306  /* autovacuum-related reloptions. */
307 typedef struct AutoVacOpts
308 {
309  bool enabled;
326 
327 /* StdRdOptions->vacuum_index_cleanup values */
329 {
334 
335 typedef struct StdRdOptions
336 {
337  int32 vl_len_; /* varlena header (do not touch directly!) */
338  int fillfactor; /* page fill factor in percent (0..100) */
339  int toast_tuple_target; /* target for tuple toasting */
340  AutoVacOpts autovacuum; /* autovacuum-related options */
341  bool user_catalog_table; /* use as an additional catalog relation */
342  int parallel_workers; /* max number of parallel workers */
343  StdRdOptIndexCleanup vacuum_index_cleanup; /* controls index vacuuming */
344  bool vacuum_truncate; /* enables vacuum to truncate a relation */
346 
347 #define HEAP_MIN_FILLFACTOR 10
348 #define HEAP_DEFAULT_FILLFACTOR 100
349 
350 /*
351  * RelationGetToastTupleTarget
352  * Returns the relation's toast_tuple_target. Note multiple eval of argument!
353  */
354 #define RelationGetToastTupleTarget(relation, defaulttarg) \
355  ((relation)->rd_options ? \
356  ((StdRdOptions *) (relation)->rd_options)->toast_tuple_target : (defaulttarg))
357 
358 /*
359  * RelationGetFillFactor
360  * Returns the relation's fillfactor. Note multiple eval of argument!
361  */
362 #define RelationGetFillFactor(relation, defaultff) \
363  ((relation)->rd_options ? \
364  ((StdRdOptions *) (relation)->rd_options)->fillfactor : (defaultff))
365 
366 /*
367  * RelationGetTargetPageUsage
368  * Returns the relation's desired space usage per page in bytes.
369  */
370 #define RelationGetTargetPageUsage(relation, defaultff) \
371  (BLCKSZ * RelationGetFillFactor(relation, defaultff) / 100)
372 
373 /*
374  * RelationGetTargetPageFreeSpace
375  * Returns the relation's desired freespace per page in bytes.
376  */
377 #define RelationGetTargetPageFreeSpace(relation, defaultff) \
378  (BLCKSZ * (100 - RelationGetFillFactor(relation, defaultff)) / 100)
379 
380 /*
381  * RelationIsUsedAsCatalogTable
382  * Returns whether the relation should be treated as a catalog table
383  * from the pov of logical decoding. Note multiple eval of argument!
384  */
385 #define RelationIsUsedAsCatalogTable(relation) \
386  ((relation)->rd_options && \
387  ((relation)->rd_rel->relkind == RELKIND_RELATION || \
388  (relation)->rd_rel->relkind == RELKIND_MATVIEW) ? \
389  ((StdRdOptions *) (relation)->rd_options)->user_catalog_table : false)
390 
391 /*
392  * RelationGetParallelWorkers
393  * Returns the relation's parallel_workers reloption setting.
394  * Note multiple eval of argument!
395  */
396 #define RelationGetParallelWorkers(relation, defaultpw) \
397  ((relation)->rd_options ? \
398  ((StdRdOptions *) (relation)->rd_options)->parallel_workers : (defaultpw))
399 
400 /* ViewOptions->check_option values */
401 typedef enum ViewOptCheckOption
402 {
407 
408 /*
409  * ViewOptions
410  * Contents of rd_options for views
411  */
412 typedef struct ViewOptions
413 {
414  int32 vl_len_; /* varlena header (do not touch directly!) */
419 
420 /*
421  * RelationIsSecurityView
422  * Returns whether the relation is security view, or not. Note multiple
423  * eval of argument!
424  */
425 #define RelationIsSecurityView(relation) \
426  (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW), \
427  (relation)->rd_options ? \
428  ((ViewOptions *) (relation)->rd_options)->security_barrier : false)
429 
430 /*
431  * RelationHasSecurityInvoker
432  * Returns true if the relation has the security_invoker property set.
433  * Note multiple eval of argument!
434  */
435 #define RelationHasSecurityInvoker(relation) \
436  (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW), \
437  (relation)->rd_options ? \
438  ((ViewOptions *) (relation)->rd_options)->security_invoker : false)
439 
440 /*
441  * RelationHasCheckOption
442  * Returns true if the relation is a view defined with either the local
443  * or the cascaded check option. Note multiple eval of argument!
444  */
445 #define RelationHasCheckOption(relation) \
446  (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW), \
447  (relation)->rd_options && \
448  ((ViewOptions *) (relation)->rd_options)->check_option != \
449  VIEW_OPTION_CHECK_OPTION_NOT_SET)
450 
451 /*
452  * RelationHasLocalCheckOption
453  * Returns true if the relation is a view defined with the local check
454  * option. Note multiple eval of argument!
455  */
456 #define RelationHasLocalCheckOption(relation) \
457  (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW), \
458  (relation)->rd_options && \
459  ((ViewOptions *) (relation)->rd_options)->check_option == \
460  VIEW_OPTION_CHECK_OPTION_LOCAL)
461 
462 /*
463  * RelationHasCascadedCheckOption
464  * Returns true if the relation is a view defined with the cascaded check
465  * option. Note multiple eval of argument!
466  */
467 #define RelationHasCascadedCheckOption(relation) \
468  (AssertMacro(relation->rd_rel->relkind == RELKIND_VIEW), \
469  (relation)->rd_options && \
470  ((ViewOptions *) (relation)->rd_options)->check_option == \
471  VIEW_OPTION_CHECK_OPTION_CASCADED)
472 
473 /*
474  * RelationIsValid
475  * True iff relation descriptor is valid.
476  */
477 #define RelationIsValid(relation) PointerIsValid(relation)
478 
479 #define InvalidRelation ((Relation) NULL)
480 
481 /*
482  * RelationHasReferenceCountZero
483  * True iff relation reference count is zero.
484  *
485  * Note:
486  * Assumes relation descriptor is valid.
487  */
488 #define RelationHasReferenceCountZero(relation) \
489  ((bool)((relation)->rd_refcnt == 0))
490 
491 /*
492  * RelationGetForm
493  * Returns pg_class tuple for a relation.
494  *
495  * Note:
496  * Assumes relation descriptor is valid.
497  */
498 #define RelationGetForm(relation) ((relation)->rd_rel)
499 
500 /*
501  * RelationGetRelid
502  * Returns the OID of the relation
503  */
504 #define RelationGetRelid(relation) ((relation)->rd_id)
505 
506 /*
507  * RelationGetNumberOfAttributes
508  * Returns the total number of attributes in a relation.
509  */
510 #define RelationGetNumberOfAttributes(relation) ((relation)->rd_rel->relnatts)
511 
512 /*
513  * IndexRelationGetNumberOfAttributes
514  * Returns the number of attributes in an index.
515  */
516 #define IndexRelationGetNumberOfAttributes(relation) \
517  ((relation)->rd_index->indnatts)
518 
519 /*
520  * IndexRelationGetNumberOfKeyAttributes
521  * Returns the number of key attributes in an index.
522  */
523 #define IndexRelationGetNumberOfKeyAttributes(relation) \
524  ((relation)->rd_index->indnkeyatts)
525 
526 /*
527  * RelationGetDescr
528  * Returns tuple descriptor for a relation.
529  */
530 #define RelationGetDescr(relation) ((relation)->rd_att)
531 
532 /*
533  * RelationGetRelationName
534  * Returns the rel's name.
535  *
536  * Note that the name is only unique within the containing namespace.
537  */
538 #define RelationGetRelationName(relation) \
539  (NameStr((relation)->rd_rel->relname))
540 
541 /*
542  * RelationGetNamespace
543  * Returns the rel's namespace OID.
544  */
545 #define RelationGetNamespace(relation) \
546  ((relation)->rd_rel->relnamespace)
547 
548 /*
549  * RelationIsMapped
550  * True if the relation uses the relfilenumber map. Note multiple eval
551  * of argument!
552  */
553 #define RelationIsMapped(relation) \
554  (RELKIND_HAS_STORAGE((relation)->rd_rel->relkind) && \
555  ((relation)->rd_rel->relfilenode == InvalidRelFileNumber))
556 
557 #ifndef FRONTEND
558 /*
559  * RelationGetSmgr
560  * Returns smgr file handle for a relation, opening it if needed.
561  *
562  * Very little code is authorized to touch rel->rd_smgr directly. Instead
563  * use this function to fetch its value.
564  */
565 static inline SMgrRelation
567 {
568  if (unlikely(rel->rd_smgr == NULL))
569  {
570  rel->rd_smgr = smgropen(rel->rd_locator, rel->rd_backend);
571  smgrpin(rel->rd_smgr);
572  }
573  return rel->rd_smgr;
574 }
575 
576 /*
577  * RelationCloseSmgr
578  * Close the relation at the smgr level, if not already done.
579  */
580 static inline void
582 {
583  if (relation->rd_smgr != NULL)
584  {
585  smgrunpin(relation->rd_smgr);
586  smgrclose(relation->rd_smgr);
587  relation->rd_smgr = NULL;
588  }
589 }
590 #endif /* !FRONTEND */
591 
592 /*
593  * RelationGetTargetBlock
594  * Fetch relation's current insertion target block.
595  *
596  * Returns InvalidBlockNumber if there is no current target block. Note
597  * that the target block status is discarded on any smgr-level invalidation,
598  * so there's no need to re-open the smgr handle if it's not currently open.
599  */
600 #define RelationGetTargetBlock(relation) \
601  ( (relation)->rd_smgr != NULL ? (relation)->rd_smgr->smgr_targblock : InvalidBlockNumber )
602 
603 /*
604  * RelationSetTargetBlock
605  * Set relation's current insertion target block.
606  */
607 #define RelationSetTargetBlock(relation, targblock) \
608  do { \
609  RelationGetSmgr(relation)->smgr_targblock = (targblock); \
610  } while (0)
611 
612 /*
613  * RelationIsPermanent
614  * True if relation is permanent.
615  */
616 #define RelationIsPermanent(relation) \
617  ((relation)->rd_rel->relpersistence == RELPERSISTENCE_PERMANENT)
618 
619 /*
620  * RelationNeedsWAL
621  * True if relation needs WAL.
622  *
623  * Returns false if wal_level = minimal and this relation is created or
624  * truncated in the current transaction. See "Skipping WAL for New
625  * RelFileLocator" in src/backend/access/transam/README.
626  */
627 #define RelationNeedsWAL(relation) \
628  (RelationIsPermanent(relation) && (XLogIsNeeded() || \
629  (relation->rd_createSubid == InvalidSubTransactionId && \
630  relation->rd_firstRelfilelocatorSubid == InvalidSubTransactionId)))
631 
632 /*
633  * RelationUsesLocalBuffers
634  * True if relation's pages are stored in local buffers.
635  */
636 #define RelationUsesLocalBuffers(relation) \
637  ((relation)->rd_rel->relpersistence == RELPERSISTENCE_TEMP)
638 
639 /*
640  * RELATION_IS_LOCAL
641  * If a rel is either temp or newly created in the current transaction,
642  * it can be assumed to be accessible only to the current backend.
643  * This is typically used to decide that we can skip acquiring locks.
644  *
645  * Beware of multiple eval of argument
646  */
647 #define RELATION_IS_LOCAL(relation) \
648  ((relation)->rd_islocaltemp || \
649  (relation)->rd_createSubid != InvalidSubTransactionId)
650 
651 /*
652  * RELATION_IS_OTHER_TEMP
653  * Test for a temporary relation that belongs to some other session.
654  *
655  * Beware of multiple eval of argument
656  */
657 #define RELATION_IS_OTHER_TEMP(relation) \
658  ((relation)->rd_rel->relpersistence == RELPERSISTENCE_TEMP && \
659  !(relation)->rd_islocaltemp)
660 
661 
662 /*
663  * RelationIsScannable
664  * Currently can only be false for a materialized view which has not been
665  * populated by its query. This is likely to get more complicated later,
666  * so use a macro which looks like a function.
667  */
668 #define RelationIsScannable(relation) ((relation)->rd_rel->relispopulated)
669 
670 /*
671  * RelationIsPopulated
672  * Currently, we don't physically distinguish the "populated" and
673  * "scannable" properties of matviews, but that may change later.
674  * Hence, use the appropriate one of these macros in code tests.
675  */
676 #define RelationIsPopulated(relation) ((relation)->rd_rel->relispopulated)
677 
678 /*
679  * RelationIsAccessibleInLogicalDecoding
680  * True if we need to log enough information to have access via
681  * decoding snapshot.
682  */
683 #define RelationIsAccessibleInLogicalDecoding(relation) \
684  (XLogLogicalInfoActive() && \
685  RelationNeedsWAL(relation) && \
686  (IsCatalogRelation(relation) || RelationIsUsedAsCatalogTable(relation)))
687 
688 /*
689  * RelationIsLogicallyLogged
690  * True if we need to log enough information to extract the data from the
691  * WAL stream.
692  *
693  * We don't log information for unlogged tables (since they don't WAL log
694  * anyway), for foreign tables (since they don't WAL log, either),
695  * and for system tables (their content is hard to make sense of, and
696  * it would complicate decoding slightly for little gain). Note that we *do*
697  * log information for user defined catalog tables since they presumably are
698  * interesting to the user...
699  */
700 #define RelationIsLogicallyLogged(relation) \
701  (XLogLogicalInfoActive() && \
702  RelationNeedsWAL(relation) && \
703  (relation)->rd_rel->relkind != RELKIND_FOREIGN_TABLE && \
704  !IsCatalogRelation(relation))
705 
706 /* routines in utils/cache/relcache.c */
709 
710 #endif /* REL_H */
int16 AttrNumber
Definition: attnum.h:21
int BackendId
Definition: backendid.h:21
unsigned short uint16
Definition: c.h:494
signed short int16
Definition: c.h:482
uint32 SubTransactionId
Definition: c.h:645
signed int int32
Definition: c.h:483
double float8
Definition: c.h:619
regproc RegProcedure
Definition: c.h:639
#define unlikely(x)
Definition: c.h:300
uint32 TransactionId
Definition: c.h:641
NodeTag
Definition: nodes.h:27
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
#define INDEX_MAX_KEYS
FormData_pg_index * Form_pg_index
Definition: pg_index.h:70
unsigned int Oid
Definition: postgres_ext.h:31
LockInfoData * LockInfo
Definition: rel.h:49
struct LockRelId LockRelId
void RelationDecrementReferenceCount(Relation rel)
Definition: relcache.c:2168
ViewOptCheckOption
Definition: rel.h:402
@ VIEW_OPTION_CHECK_OPTION_NOT_SET
Definition: rel.h:403
@ VIEW_OPTION_CHECK_OPTION_LOCAL
Definition: rel.h:404
@ VIEW_OPTION_CHECK_OPTION_CASCADED
Definition: rel.h:405
struct ForeignKeyCacheInfo ForeignKeyCacheInfo
static SMgrRelation RelationGetSmgr(Relation rel)
Definition: rel.h:566
void RelationIncrementReferenceCount(Relation rel)
Definition: relcache.c:2155
struct StdRdOptions StdRdOptions
struct ViewOptions ViewOptions
struct LockInfoData LockInfoData
struct AutoVacOpts AutoVacOpts
struct RelationData RelationData
static void RelationCloseSmgr(Relation relation)
Definition: rel.h:581
StdRdOptIndexCleanup
Definition: rel.h:329
@ STDRD_OPTION_VACUUM_INDEX_CLEANUP_AUTO
Definition: rel.h:330
@ STDRD_OPTION_VACUUM_INDEX_CLEANUP_OFF
Definition: rel.h:331
@ STDRD_OPTION_VACUUM_INDEX_CLEANUP_ON
Definition: rel.h:332
void smgrpin(SMgrRelation reln)
Definition: smgr.c:251
void smgrunpin(SMgrRelation reln)
Definition: smgr.c:266
void smgrclose(SMgrRelation reln)
Definition: smgr.c:321
SMgrRelation smgropen(RelFileLocator rlocator, BackendId backend)
Definition: smgr.c:199
int vacuum_ins_threshold
Definition: rel.h:311
int log_min_duration
Definition: rel.h:320
float8 vacuum_cost_delay
Definition: rel.h:321
int multixact_freeze_max_age
Definition: rel.h:318
int vacuum_cost_limit
Definition: rel.h:313
float8 vacuum_scale_factor
Definition: rel.h:322
int analyze_threshold
Definition: rel.h:312
float8 vacuum_ins_scale_factor
Definition: rel.h:323
bool enabled
Definition: rel.h:309
int multixact_freeze_table_age
Definition: rel.h:319
int freeze_min_age
Definition: rel.h:314
int freeze_table_age
Definition: rel.h:316
int freeze_max_age
Definition: rel.h:315
int vacuum_threshold
Definition: rel.h:310
int multixact_freeze_min_age
Definition: rel.h:317
float8 analyze_scale_factor
Definition: rel.h:324
Definition: fmgr.h:57
AttrNumber confkey[INDEX_MAX_KEYS] pg_node_attr(array_size(nkeys))
Oid conpfeqop[INDEX_MAX_KEYS] pg_node_attr(array_size(nkeys))
AttrNumber conkey[INDEX_MAX_KEYS] pg_node_attr(array_size(nkeys))
pg_node_attr(no_equal, no_read, no_query_jumble) NodeTag type
Definition: pg_list.h:54
LockRelId lockRelId
Definition: rel.h:46
Definition: rel.h:39
Oid relId
Definition: rel.h:40
Oid dbId
Definition: rel.h:41
List * rd_partcheck
Definition: rel.h:147
bool pgstat_enabled
Definition: rel.h:252
Bitmapset * rd_keyattr
Definition: rel.h:161
bool rd_partcheckvalid
Definition: rel.h:148
MemoryContext rd_pdcxt
Definition: rel.h:131
Oid rd_toastoid
Definition: rel.h:250
MemoryContext rd_partkeycxt
Definition: rel.h:127
const struct TableAmRoutine * rd_tableam
Definition: rel.h:188
TransactionId rd_partdesc_nodetached_xmin
Definition: rel.h:144
bool rd_indexvalid
Definition: rel.h:64
List * rd_indpred
Definition: rel.h:212
struct IndexAmRoutine * rd_indam
Definition: rel.h:205
List * rd_fkeylist
Definition: rel.h:122
Oid * rd_exclprocs
Definition: rel.h:214
SubTransactionId rd_firstRelfilelocatorSubid
Definition: rel.h:106
LockInfoData rd_lockInfo
Definition: rel.h:114
uint16 * rd_exclstrats
Definition: rel.h:215
List * rd_indexlist
Definition: rel.h:152
struct RowSecurityDesc * rd_rsdesc
Definition: rel.h:119
PartitionDesc rd_partdesc
Definition: rel.h:130
Oid rd_replidindex
Definition: rel.h:154
int rd_refcnt
Definition: rel.h:59
RegProcedure * rd_support
Definition: rel.h:208
PartitionDesc rd_partdesc_nodetached
Definition: rel.h:134
bytea ** rd_opcoptions
Definition: rel.h:217
PublicationDesc * rd_pubdesc
Definition: rel.h:167
struct FdwRoutine * rd_fdwroutine
Definition: rel.h:239
TriggerDesc * trigdesc
Definition: rel.h:117
Bitmapset * rd_idattr
Definition: rel.h:163
bool rd_isvalid
Definition: rel.h:63
bool rd_islocaltemp
Definition: rel.h:61
List * rd_indexprs
Definition: rel.h:211
bool rd_attrsvalid
Definition: rel.h:160
Oid * rd_exclops
Definition: rel.h:213
Oid * rd_opcintype
Definition: rel.h:207
struct HeapTupleData * rd_indextuple
Definition: rel.h:193
MemoryContext rd_partcheckcxt
Definition: rel.h:149
int16 * rd_indoption
Definition: rel.h:210
TupleDesc rd_att
Definition: rel.h:112
Form_pg_index rd_index
Definition: rel.h:191
Bitmapset * rd_hotblockingattr
Definition: rel.h:164
void * rd_amcache
Definition: rel.h:228
bool rd_isnailed
Definition: rel.h:62
Oid rd_id
Definition: rel.h:113
Oid rd_pkindex
Definition: rel.h:153
SubTransactionId rd_newRelfilelocatorSubid
Definition: rel.h:104
bool rd_fkeyvalid
Definition: rel.h:123
BackendId rd_backend
Definition: rel.h:60
Oid rd_amhandler
Definition: rel.h:183
SMgrRelation rd_smgr
Definition: rel.h:58
SubTransactionId rd_createSubid
Definition: rel.h:103
bool rd_statvalid
Definition: rel.h:66
MemoryContext rd_indexcxt
Definition: rel.h:203
List * rd_statlist
Definition: rel.h:157
MemoryContext rd_pddcxt
Definition: rel.h:135
RelFileLocator rd_locator
Definition: rel.h:57
RuleLock * rd_rules
Definition: rel.h:115
struct FmgrInfo * rd_supportinfo
Definition: rel.h:209
Oid * rd_opfamily
Definition: rel.h:206
SubTransactionId rd_droppedSubid
Definition: rel.h:109
MemoryContext rd_rulescxt
Definition: rel.h:116
Bitmapset * rd_summarizedattr
Definition: rel.h:165
Bitmapset * rd_pkattr
Definition: rel.h:162
PartitionKey rd_partkey
Definition: rel.h:126
bytea * rd_options
Definition: rel.h:174
Oid * rd_indcollation
Definition: rel.h:216
Form_pg_class rd_rel
Definition: rel.h:111
struct PgStat_TableStatus * pgstat_info
Definition: rel.h:254
int32 vl_len_
Definition: rel.h:337
bool user_catalog_table
Definition: rel.h:341
StdRdOptIndexCleanup vacuum_index_cleanup
Definition: rel.h:343
int fillfactor
Definition: rel.h:338
AutoVacOpts autovacuum
Definition: rel.h:340
int toast_tuple_target
Definition: rel.h:339
int parallel_workers
Definition: rel.h:342
bool vacuum_truncate
Definition: rel.h:344
bool security_invoker
Definition: rel.h:416
int32 vl_len_
Definition: rel.h:414
bool security_barrier
Definition: rel.h:415
ViewOptCheckOption check_option
Definition: rel.h:417
Definition: c.h:676
const char * type