PostgreSQL Source Code  git master
pg_subscription_rel.h File Reference
#include "access/xlogdefs.h"
#include "catalog/genbki.h"
#include "catalog/pg_subscription_rel_d.h"
#include "nodes/pg_list.h"
Include dependency graph for pg_subscription_rel.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SubscriptionRelState
 

Typedefs

typedef FormData_pg_subscription_relForm_pg_subscription_rel
 
typedef struct SubscriptionRelState SubscriptionRelState
 

Functions

 CATALOG (pg_subscription_rel, 6102, SubscriptionRelRelationId)
 
 DECLARE_UNIQUE_INDEX_PKEY (pg_subscription_rel_srrelid_srsubid_index, 6117, SubscriptionRelSrrelidSrsubidIndexId, on pg_subscription_rel using btree(srrelid oid_ops, srsubid oid_ops))
 
void AddSubscriptionRelState (Oid subid, Oid relid, char state, XLogRecPtr sublsn)
 
void UpdateSubscriptionRelState (Oid subid, Oid relid, char state, XLogRecPtr sublsn)
 
char GetSubscriptionRelState (Oid subid, Oid relid, XLogRecPtr *sublsn)
 
void RemoveSubscriptionRel (Oid subid, Oid relid)
 
bool HasSubscriptionRelations (Oid subid)
 
ListGetSubscriptionRelations (Oid subid)
 
ListGetSubscriptionNotReadyRelations (Oid subid)
 

Variables

 FormData_pg_subscription_rel
 

Typedef Documentation

◆ Form_pg_subscription_rel

◆ SubscriptionRelState

Function Documentation

◆ AddSubscriptionRelState()

void AddSubscriptionRelState ( Oid  subid,
Oid  relid,
char  state,
XLogRecPtr  sublsn 
)

Definition at line 280 of file pg_subscription.c.

282 {
283  Relation rel;
284  HeapTuple tup;
285  bool nulls[Natts_pg_subscription_rel];
286  Datum values[Natts_pg_subscription_rel];
287 
288  LockSharedObject(SubscriptionRelationId, subid, 0, AccessShareLock);
289 
290  rel = table_open(SubscriptionRelRelationId, RowExclusiveLock);
291 
292  /* Try finding existing mapping. */
294  ObjectIdGetDatum(relid),
295  ObjectIdGetDatum(subid));
296  if (HeapTupleIsValid(tup))
297  elog(ERROR, "subscription table %u in subscription %u already exists",
298  relid, subid);
299 
300  /* Form the tuple. */
301  memset(values, 0, sizeof(values));
302  memset(nulls, false, sizeof(nulls));
303  values[Anum_pg_subscription_rel_srsubid - 1] = ObjectIdGetDatum(subid);
304  values[Anum_pg_subscription_rel_srrelid - 1] = ObjectIdGetDatum(relid);
305  values[Anum_pg_subscription_rel_srsubstate - 1] = CharGetDatum(state);
306  if (sublsn != InvalidXLogRecPtr)
307  values[Anum_pg_subscription_rel_srsublsn - 1] = LSNGetDatum(sublsn);
308  else
309  nulls[Anum_pg_subscription_rel_srsublsn - 1] = true;
310 
311  tup = heap_form_tuple(RelationGetDescr(rel), values, nulls);
312 
313  /* Insert tuple into catalog. */
314  CatalogTupleInsert(rel, tup);
315 
316  heap_freetuple(tup);
317 
318  /* Cleanup. */
319  table_close(rel, NoLock);
320 }
static Datum values[MAXATTR]
Definition: bootstrap.c:156
#define ERROR
Definition: elog.h:33
#define elog(elevel,...)
Definition: elog.h:218
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:1020
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
void CatalogTupleInsert(Relation heapRel, HeapTuple tup)
Definition: indexing.c:221
void LockSharedObject(Oid classid, Oid objid, uint16 objsubid, LOCKMODE lockmode)
Definition: lmgr.c:1046
#define NoLock
Definition: lockdefs.h:34
#define AccessShareLock
Definition: lockdefs.h:36
#define RowExclusiveLock
Definition: lockdefs.h:38
#define LSNGetDatum(X)
Definition: pg_lsn.h:22
uintptr_t Datum
Definition: postgres.h:411
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
#define CharGetDatum(X)
Definition: postgres.h:460
#define RelationGetDescr(relation)
Definition: rel.h:515
Definition: regguts.h:318
#define SearchSysCacheCopy2(cacheId, key1, key2)
Definition: syscache.h:181
@ SUBSCRIPTIONRELMAP
Definition: syscache.h:100
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28

References AccessShareLock, CatalogTupleInsert(), CharGetDatum, elog, ERROR, heap_form_tuple(), heap_freetuple(), HeapTupleIsValid, InvalidXLogRecPtr, LockSharedObject(), LSNGetDatum, NoLock, ObjectIdGetDatum, RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy2, SUBSCRIPTIONRELMAP, table_close(), table_open(), and values.

Referenced by AlterSubscription_refresh(), and CreateSubscription().

◆ CATALOG()

CATALOG ( pg_subscription_rel  ,
6102  ,
SubscriptionRelRelationId   
)

Definition at line 31 of file pg_subscription_rel.h.

32 {
33  Oid srsubid BKI_LOOKUP(pg_subscription); /* Oid of subscription */
34  Oid srrelid BKI_LOOKUP(pg_class); /* Oid of relation */
35  char srsubstate; /* state of the relation in subscription */
36 
37  /*
38  * Although srsublsn is a fixed-width type, it is allowed to be NULL, so
39  * we prevent direct C code access to it just as for a varlena field.
40  */
41 #ifdef CATALOG_VARLEN /* variable-length fields start here */
42 
43  XLogRecPtr srsublsn BKI_FORCE_NULL; /* remote LSN of the state change
44  * used for synchronization
45  * coordination, or NULL if not
46  * valid */
47 #endif
#define BKI_LOOKUP(catalog)
Definition: genbki.h:46
#define BKI_FORCE_NULL
Definition: genbki.h:32
FormData_pg_subscription_rel
unsigned int Oid
Definition: postgres_ext.h:31
uint64 XLogRecPtr
Definition: xlogdefs.h:21

References BKI_FORCE_NULL, and BKI_LOOKUP.

◆ DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY ( pg_subscription_rel_srrelid_srsubid_index  ,
6117  ,
SubscriptionRelSrrelidSrsubidIndexId  ,
on pg_subscription_rel using   btreesrrelid oid_ops, srsubid oid_ops 
)

◆ GetSubscriptionNotReadyRelations()

List* GetSubscriptionNotReadyRelations ( Oid  subid)

Definition at line 588 of file pg_subscription.c.

589 {
590  List *res = NIL;
591  Relation rel;
592  HeapTuple tup;
593  int nkeys = 0;
594  ScanKeyData skey[2];
595  SysScanDesc scan;
596 
597  rel = table_open(SubscriptionRelRelationId, AccessShareLock);
598 
599  ScanKeyInit(&skey[nkeys++],
600  Anum_pg_subscription_rel_srsubid,
601  BTEqualStrategyNumber, F_OIDEQ,
602  ObjectIdGetDatum(subid));
603 
604  ScanKeyInit(&skey[nkeys++],
605  Anum_pg_subscription_rel_srsubstate,
606  BTEqualStrategyNumber, F_CHARNE,
607  CharGetDatum(SUBREL_STATE_READY));
608 
609  scan = systable_beginscan(rel, InvalidOid, false,
610  NULL, nkeys, skey);
611 
612  while (HeapTupleIsValid(tup = systable_getnext(scan)))
613  {
615  SubscriptionRelState *relstate;
616  Datum d;
617  bool isnull;
618 
619  subrel = (Form_pg_subscription_rel) GETSTRUCT(tup);
620 
621  relstate = (SubscriptionRelState *) palloc(sizeof(SubscriptionRelState));
622  relstate->relid = subrel->srrelid;
623  relstate->state = subrel->srsubstate;
625  Anum_pg_subscription_rel_srsublsn, &isnull);
626  if (isnull)
627  relstate->lsn = InvalidXLogRecPtr;
628  else
629  relstate->lsn = DatumGetLSN(d);
630 
631  res = lappend(res, relstate);
632  }
633 
634  /* Cleanup */
635  systable_endscan(scan);
637 
638  return res;
639 }
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:598
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:505
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:386
#define GETSTRUCT(TUP)
Definition: htup_details.h:649
List * lappend(List *list, void *datum)
Definition: list.c:336
void * palloc(Size size)
Definition: mcxt.c:1068
#define NIL
Definition: pg_list.h:65
#define DatumGetLSN(X)
Definition: pg_lsn.h:21
FormData_pg_subscription_rel * Form_pg_subscription_rel
#define InvalidOid
Definition: postgres_ext.h:36
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
#define BTEqualStrategyNumber
Definition: stratnum.h:31
Definition: pg_list.h:51
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1434

References AccessShareLock, BTEqualStrategyNumber, CharGetDatum, DatumGetLSN, GETSTRUCT, HeapTupleIsValid, InvalidOid, InvalidXLogRecPtr, lappend(), SubscriptionRelState::lsn, NIL, ObjectIdGetDatum, palloc(), SubscriptionRelState::relid, res, ScanKeyInit(), SubscriptionRelState::state, SUBSCRIPTIONRELMAP, SysCacheGetAttr(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by DropSubscription(), and FetchTableStates().

◆ GetSubscriptionRelations()

List* GetSubscriptionRelations ( Oid  subid)

Definition at line 535 of file pg_subscription.c.

536 {
537  List *res = NIL;
538  Relation rel;
539  HeapTuple tup;
540  ScanKeyData skey[1];
541  SysScanDesc scan;
542 
543  rel = table_open(SubscriptionRelRelationId, AccessShareLock);
544 
545  ScanKeyInit(&skey[0],
546  Anum_pg_subscription_rel_srsubid,
547  BTEqualStrategyNumber, F_OIDEQ,
548  ObjectIdGetDatum(subid));
549 
550  scan = systable_beginscan(rel, InvalidOid, false,
551  NULL, 1, skey);
552 
553  while (HeapTupleIsValid(tup = systable_getnext(scan)))
554  {
556  SubscriptionRelState *relstate;
557  Datum d;
558  bool isnull;
559 
560  subrel = (Form_pg_subscription_rel) GETSTRUCT(tup);
561 
562  relstate = (SubscriptionRelState *) palloc(sizeof(SubscriptionRelState));
563  relstate->relid = subrel->srrelid;
564  relstate->state = subrel->srsubstate;
566  Anum_pg_subscription_rel_srsublsn, &isnull);
567  if (isnull)
568  relstate->lsn = InvalidXLogRecPtr;
569  else
570  relstate->lsn = DatumGetLSN(d);
571 
572  res = lappend(res, relstate);
573  }
574 
575  /* Cleanup */
576  systable_endscan(scan);
578 
579  return res;
580 }

References AccessShareLock, BTEqualStrategyNumber, DatumGetLSN, GETSTRUCT, HeapTupleIsValid, InvalidOid, InvalidXLogRecPtr, lappend(), SubscriptionRelState::lsn, NIL, ObjectIdGetDatum, palloc(), SubscriptionRelState::relid, res, ScanKeyInit(), SubscriptionRelState::state, SUBSCRIPTIONRELMAP, SysCacheGetAttr(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by AlterSubscription_refresh().

◆ GetSubscriptionRelState()

char GetSubscriptionRelState ( Oid  subid,
Oid  relid,
XLogRecPtr sublsn 
)

Definition at line 377 of file pg_subscription.c.

378 {
379  HeapTuple tup;
380  char substate;
381  bool isnull;
382  Datum d;
383  Relation rel;
384 
385  /*
386  * This is to avoid the race condition with AlterSubscription which tries
387  * to remove this relstate.
388  */
389  rel = table_open(SubscriptionRelRelationId, AccessShareLock);
390 
391  /* Try finding the mapping. */
393  ObjectIdGetDatum(relid),
394  ObjectIdGetDatum(subid));
395 
396  if (!HeapTupleIsValid(tup))
397  {
399  *sublsn = InvalidXLogRecPtr;
400  return SUBREL_STATE_UNKNOWN;
401  }
402 
403  /* Get the state. */
404  substate = ((Form_pg_subscription_rel) GETSTRUCT(tup))->srsubstate;
405 
406  /* Get the LSN */
408  Anum_pg_subscription_rel_srsublsn, &isnull);
409  if (isnull)
410  *sublsn = InvalidXLogRecPtr;
411  else
412  *sublsn = DatumGetLSN(d);
413 
414  /* Cleanup */
415  ReleaseSysCache(tup);
416 
418 
419  return substate;
420 }
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1221
HeapTuple SearchSysCache2(int cacheId, Datum key1, Datum key2)
Definition: syscache.c:1184

References AccessShareLock, DatumGetLSN, GETSTRUCT, HeapTupleIsValid, InvalidXLogRecPtr, ObjectIdGetDatum, ReleaseSysCache(), SearchSysCache2(), SUBSCRIPTIONRELMAP, SysCacheGetAttr(), table_close(), and table_open().

Referenced by AlterSubscription_refresh(), logicalrep_rel_open(), LogicalRepSyncTableStart(), and wait_for_relation_state_change().

◆ HasSubscriptionRelations()

bool HasSubscriptionRelations ( Oid  subid)

Definition at line 502 of file pg_subscription.c.

503 {
504  Relation rel;
505  ScanKeyData skey[1];
506  SysScanDesc scan;
507  bool has_subrels;
508 
509  rel = table_open(SubscriptionRelRelationId, AccessShareLock);
510 
511  ScanKeyInit(&skey[0],
512  Anum_pg_subscription_rel_srsubid,
513  BTEqualStrategyNumber, F_OIDEQ,
514  ObjectIdGetDatum(subid));
515 
516  scan = systable_beginscan(rel, InvalidOid, false,
517  NULL, 1, skey);
518 
519  /* If even a single tuple exists then the subscription has tables. */
520  has_subrels = HeapTupleIsValid(systable_getnext(scan));
521 
522  /* Cleanup */
523  systable_endscan(scan);
525 
526  return has_subrels;
527 }

References AccessShareLock, BTEqualStrategyNumber, HeapTupleIsValid, InvalidOid, ObjectIdGetDatum, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by FetchTableStates().

◆ RemoveSubscriptionRel()

void RemoveSubscriptionRel ( Oid  subid,
Oid  relid 
)

Definition at line 427 of file pg_subscription.c.

428 {
429  Relation rel;
430  TableScanDesc scan;
431  ScanKeyData skey[2];
432  HeapTuple tup;
433  int nkeys = 0;
434 
435  rel = table_open(SubscriptionRelRelationId, RowExclusiveLock);
436 
437  if (OidIsValid(subid))
438  {
439  ScanKeyInit(&skey[nkeys++],
440  Anum_pg_subscription_rel_srsubid,
442  F_OIDEQ,
443  ObjectIdGetDatum(subid));
444  }
445 
446  if (OidIsValid(relid))
447  {
448  ScanKeyInit(&skey[nkeys++],
449  Anum_pg_subscription_rel_srrelid,
451  F_OIDEQ,
452  ObjectIdGetDatum(relid));
453  }
454 
455  /* Do the search and delete what we found. */
456  scan = table_beginscan_catalog(rel, nkeys, skey);
458  {
460 
461  subrel = (Form_pg_subscription_rel) GETSTRUCT(tup);
462 
463  /*
464  * We don't allow to drop the relation mapping when the table
465  * synchronization is in progress unless the caller updates the
466  * corresponding subscription as well. This is to ensure that we don't
467  * leave tablesync slots or origins in the system when the
468  * corresponding table is dropped.
469  */
470  if (!OidIsValid(subid) && subrel->srsubstate != SUBREL_STATE_READY)
471  {
472  ereport(ERROR,
473  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
474  errmsg("could not drop relation mapping for subscription \"%s\"",
475  get_subscription_name(subrel->srsubid, false)),
476  errdetail("Table synchronization for relation \"%s\" is in progress and is in state \"%c\".",
477  get_rel_name(relid), subrel->srsubstate),
478 
479  /*
480  * translator: first %s is a SQL ALTER command and second %s is a
481  * SQL DROP command
482  */
483  errhint("Use %s to enable subscription if not already enabled or use %s to drop the subscription.",
484  "ALTER SUBSCRIPTION ... ENABLE",
485  "DROP SUBSCRIPTION ...")));
486  }
487 
488  CatalogTupleDelete(rel, &tup->t_self);
489  }
490  table_endscan(scan);
491 
493 }
#define OidIsValid(objectId)
Definition: c.h:710
int errdetail(const char *fmt,...)
Definition: elog.c:1037
int errhint(const char *fmt,...)
Definition: elog.c:1151
int errcode(int sqlerrcode)
Definition: elog.c:693
int errmsg(const char *fmt,...)
Definition: elog.c:904
#define ereport(elevel,...)
Definition: elog.h:143
HeapTuple heap_getnext(TableScanDesc sscan, ScanDirection direction)
Definition: heapam.c:1296
void CatalogTupleDelete(Relation heapRel, ItemPointer tid)
Definition: indexing.c:350
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1909
char * get_subscription_name(Oid subid, bool missing_ok)
@ ForwardScanDirection
Definition: sdir.h:26
ItemPointerData t_self
Definition: htup.h:65
TableScanDesc table_beginscan_catalog(Relation relation, int nkeys, struct ScanKeyData *key)
Definition: tableam.c:112
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:993

References BTEqualStrategyNumber, CatalogTupleDelete(), ereport, errcode(), errdetail(), errhint(), errmsg(), ERROR, ForwardScanDirection, get_rel_name(), get_subscription_name(), GETSTRUCT, heap_getnext(), HeapTupleIsValid, ObjectIdGetDatum, OidIsValid, RowExclusiveLock, ScanKeyInit(), HeapTupleData::t_self, table_beginscan_catalog(), table_close(), table_endscan(), and table_open().

Referenced by AlterSubscription_refresh(), DropSubscription(), and heap_drop_with_catalog().

◆ UpdateSubscriptionRelState()

void UpdateSubscriptionRelState ( Oid  subid,
Oid  relid,
char  state,
XLogRecPtr  sublsn 
)

Definition at line 326 of file pg_subscription.c.

328 {
329  Relation rel;
330  HeapTuple tup;
331  bool nulls[Natts_pg_subscription_rel];
332  Datum values[Natts_pg_subscription_rel];
333  bool replaces[Natts_pg_subscription_rel];
334 
335  LockSharedObject(SubscriptionRelationId, subid, 0, AccessShareLock);
336 
337  rel = table_open(SubscriptionRelRelationId, RowExclusiveLock);
338 
339  /* Try finding existing mapping. */
341  ObjectIdGetDatum(relid),
342  ObjectIdGetDatum(subid));
343  if (!HeapTupleIsValid(tup))
344  elog(ERROR, "subscription table %u in subscription %u does not exist",
345  relid, subid);
346 
347  /* Update the tuple. */
348  memset(values, 0, sizeof(values));
349  memset(nulls, false, sizeof(nulls));
350  memset(replaces, false, sizeof(replaces));
351 
352  replaces[Anum_pg_subscription_rel_srsubstate - 1] = true;
353  values[Anum_pg_subscription_rel_srsubstate - 1] = CharGetDatum(state);
354 
355  replaces[Anum_pg_subscription_rel_srsublsn - 1] = true;
356  if (sublsn != InvalidXLogRecPtr)
357  values[Anum_pg_subscription_rel_srsublsn - 1] = LSNGetDatum(sublsn);
358  else
359  nulls[Anum_pg_subscription_rel_srsublsn - 1] = true;
360 
361  tup = heap_modify_tuple(tup, RelationGetDescr(rel), values, nulls,
362  replaces);
363 
364  /* Update the catalog. */
365  CatalogTupleUpdate(rel, &tup->t_self, tup);
366 
367  /* Cleanup. */
368  table_close(rel, NoLock);
369 }
HeapTuple heap_modify_tuple(HeapTuple tuple, TupleDesc tupleDesc, Datum *replValues, bool *replIsnull, bool *doReplace)
Definition: heaptuple.c:1113
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:301

References AccessShareLock, CatalogTupleUpdate(), CharGetDatum, elog, ERROR, heap_modify_tuple(), HeapTupleIsValid, InvalidXLogRecPtr, LockSharedObject(), LSNGetDatum, NoLock, ObjectIdGetDatum, RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy2, SUBSCRIPTIONRELMAP, HeapTupleData::t_self, table_close(), table_open(), and values.

Referenced by LogicalRepSyncTableStart(), process_syncing_tables_for_apply(), and process_syncing_tables_for_sync().

Variable Documentation

◆ FormData_pg_subscription_rel

FormData_pg_subscription_rel

Definition at line 48 of file pg_subscription_rel.h.