#include "access/xlogdefs.h"
#include "catalog/genbki.h"
#include "catalog/pg_subscription_d.h"
#include "nodes/pg_list.h"

Include dependency graph for pg_subscription.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Subscription

Macros
#define	LOGICALREP_TWOPHASE_STATE_DISABLED 'd'

#define	LOGICALREP_TWOPHASE_STATE_PENDING 'p'

#define	LOGICALREP_TWOPHASE_STATE_ENABLED 'e'

#define	LOGICALREP_ORIGIN_NONE "none"

#define	LOGICALREP_ORIGIN_ANY "any"

#define	LOGICALREP_STREAM_OFF 'f'

#define	LOGICALREP_STREAM_ON 't'

#define	LOGICALREP_STREAM_PARALLEL 'p'

Typedefs
typedef FormData_pg_subscription *	Form_pg_subscription

typedef struct Subscription	Subscription

Functions
	CATALOG (pg_subscription, 6100, SubscriptionRelationId) BKI_SHARED_RELATION BKI_ROWTYPE_OID(6101

Oid subdbid	BKI_LOOKUP (pg_database)

Oid subowner	BKI_LOOKUP (pg_authid)

	DECLARE_TOAST_WITH_MACRO (pg_subscription, 4183, 4184, PgSubscriptionToastTable, PgSubscriptionToastIndex)

	DECLARE_UNIQUE_INDEX_PKEY (pg_subscription_oid_index, 6114, SubscriptionObjectIndexId, pg_subscription, btree(oid oid_ops))

	DECLARE_UNIQUE_INDEX (pg_subscription_subname_index, 6115, SubscriptionNameIndexId, pg_subscription, btree(subdbid oid_ops, subname name_ops))

Subscription *	GetSubscription (Oid subid, bool missing_ok)

void	FreeSubscription (Subscription *sub)

void	DisableSubscription (Oid subid)

int	CountDBSubscriptions (Oid dbid)

Variables
SubscriptionRelation_Rowtype_Id	BKI_SCHEMA_MACRO

XLogRecPtr	subskiplsn

NameData	subname

bool	subenabled

bool	subbinary

char	substream

char	subtwophasestate

bool	subdisableonerr

bool	subpasswordrequired

bool	subrunasowner

	FormData_pg_subscription

Macro Definition Documentation

◆ LOGICALREP_ORIGIN_ANY

#define LOGICALREP_ORIGIN_ANY "any"

Definition at line 44 of file pg_subscription.h.

◆ LOGICALREP_ORIGIN_NONE

#define LOGICALREP_ORIGIN_NONE "none"

Definition at line 38 of file pg_subscription.h.

◆ LOGICALREP_STREAM_OFF

#define LOGICALREP_STREAM_OFF 'f'

Definition at line 151 of file pg_subscription.h.

◆ LOGICALREP_STREAM_ON

#define LOGICALREP_STREAM_ON 't'

Definition at line 157 of file pg_subscription.h.

◆ LOGICALREP_STREAM_PARALLEL

#define LOGICALREP_STREAM_PARALLEL 'p'

Definition at line 163 of file pg_subscription.h.

◆ LOGICALREP_TWOPHASE_STATE_DISABLED

#define LOGICALREP_TWOPHASE_STATE_DISABLED 'd'

Definition at line 30 of file pg_subscription.h.

◆ LOGICALREP_TWOPHASE_STATE_ENABLED

#define LOGICALREP_TWOPHASE_STATE_ENABLED 'e'

Definition at line 32 of file pg_subscription.h.

◆ LOGICALREP_TWOPHASE_STATE_PENDING

#define LOGICALREP_TWOPHASE_STATE_PENDING 'p'

Definition at line 31 of file pg_subscription.h.

Typedef Documentation

◆ Form_pg_subscription

typedef FormData_pg_subscription* Form_pg_subscription

Definition at line 114 of file pg_subscription.h.

◆ Subscription

typedef struct Subscription Subscription

Function Documentation

◆ BKI_LOOKUP() [1/2]

Oid subowner BKI_LOOKUP ( pg_authid )

◆ BKI_LOOKUP() [2/2]

Oid subdbid BKI_LOOKUP ( pg_database )

◆ CATALOG()

CATALOG	(	pg_subscription	,
		6100	,
		SubscriptionRelationId
	)

◆ CountDBSubscriptions()

int CountDBSubscriptions ( Oid dbid )

Definition at line 124 of file pg_subscription.c.

 {
     int         nsubs = 0;
     Relation    rel;
     ScanKeyData scankey;
     SysScanDesc scan;
     HeapTuple   tup;
  
     rel = table_open(SubscriptionRelationId, RowExclusiveLock);
  
     ScanKeyInit(&scankey,
                 Anum_pg_subscription_subdbid,
                 BTEqualStrategyNumber, F_OIDEQ,
                 ObjectIdGetDatum(dbid));
  
     scan = systable_beginscan(rel, InvalidOid, false,
                               NULL, 1, &scankey);
  
     while (HeapTupleIsValid(tup = systable_getnext(scan)))
         nsubs++;
  
     systable_endscan(scan);
  
     table_close(rel, NoLock);
  
     return nsubs;
 }

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

Referenced by dropdb().

◆ DECLARE_TOAST_WITH_MACRO()

DECLARE_TOAST_WITH_MACRO	(	pg_subscription	,
		4183	,
		4184	,
		PgSubscriptionToastTable	,
		PgSubscriptionToastIndex
	)

◆ DECLARE_UNIQUE_INDEX()

DECLARE_UNIQUE_INDEX	(	pg_subscription_subname_index	,
		6115	,
		SubscriptionNameIndexId	,
		pg_subscription	,
		btree(subdbid oid_ops, subname name_ops)
	)

◆ DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY	(	pg_subscription_oid_index	,
		6114	,
		SubscriptionObjectIndexId	,
		pg_subscription	,
		btree(oid oid_ops)
	)

◆ DisableSubscription()

void DisableSubscription ( Oid subid )

Definition at line 170 of file pg_subscription.c.

 {
     Relation    rel;
     bool        nulls[Natts_pg_subscription];
     bool        replaces[Natts_pg_subscription];
     Datum       values[Natts_pg_subscription];
     HeapTuple   tup;
  
     /* Look up the subscription in the catalog */
     rel = table_open(SubscriptionRelationId, RowExclusiveLock);
     tup = SearchSysCacheCopy1(SUBSCRIPTIONOID, ObjectIdGetDatum(subid));
  
     if (!HeapTupleIsValid(tup))
         elog(ERROR, "cache lookup failed for subscription %u", subid);
  
     LockSharedObject(SubscriptionRelationId, subid, 0, AccessShareLock);
  
     /* Form a new tuple. */
     memset(values, 0, sizeof(values));
     memset(nulls, false, sizeof(nulls));
     memset(replaces, false, sizeof(replaces));
  
     /* Set the subscription to disabled. */
     values[Anum_pg_subscription_subenabled - 1] = BoolGetDatum(false);
     replaces[Anum_pg_subscription_subenabled - 1] = true;
  
     /* Update the catalog */
     tup = heap_modify_tuple(tup, RelationGetDescr(rel), values, nulls,
                             replaces);
     CatalogTupleUpdate(rel, &tup->t_self, tup);
     heap_freetuple(tup);
  
     table_close(rel, NoLock);
 }

References AccessShareLock, BoolGetDatum(), CatalogTupleUpdate(), elog(), ERROR, heap_freetuple(), heap_modify_tuple(), HeapTupleIsValid, LockSharedObject(), NoLock, ObjectIdGetDatum(), RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy1, SUBSCRIPTIONOID, HeapTupleData::t_self, table_close(), table_open(), and values.

Referenced by DisableSubscriptionAndExit().

◆ FreeSubscription()

void FreeSubscription ( Subscription * sub )

Definition at line 156 of file pg_subscription.c.

 {
     pfree(sub->name);
     pfree(sub->conninfo);
     if (sub->slotname)
         pfree(sub->slotname);
     list_free_deep(sub->publications);
     pfree(sub);
 }

References Subscription::conninfo, list_free_deep(), Subscription::name, pfree(), Subscription::publications, and Subscription::slotname.

Referenced by maybe_reread_subscription().

◆ GetSubscription()

Subscription* GetSubscription	(	Oid	subid,
		bool	missing_ok
	)

Definition at line 43 of file pg_subscription.c.

 {
     HeapTuple   tup;
     Subscription *sub;
     Form_pg_subscription subform;
     Datum       datum;
     bool        isnull;
  
     tup = SearchSysCache1(SUBSCRIPTIONOID, ObjectIdGetDatum(subid));
  
     if (!HeapTupleIsValid(tup))
     {
         if (missing_ok)
             return NULL;
  
         elog(ERROR, "cache lookup failed for subscription %u", subid);
     }
  
     subform = (Form_pg_subscription) GETSTRUCT(tup);
  
     sub = (Subscription *) palloc(sizeof(Subscription));
     sub->oid = subid;
     sub->dbid = subform->subdbid;
     sub->skiplsn = subform->subskiplsn;
     sub->name = pstrdup(NameStr(subform->subname));
     sub->owner = subform->subowner;
     sub->enabled = subform->subenabled;
     sub->binary = subform->subbinary;
     sub->stream = subform->substream;
     sub->twophasestate = subform->subtwophasestate;
     sub->disableonerr = subform->subdisableonerr;
     sub->passwordrequired = subform->subpasswordrequired;
     sub->runasowner = subform->subrunasowner;
  
     /* Get conninfo */
     datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID,
                                    tup,
                                    Anum_pg_subscription_subconninfo);
     sub->conninfo = TextDatumGetCString(datum);
  
     /* Get slotname */
     datum = SysCacheGetAttr(SUBSCRIPTIONOID,
                             tup,
                             Anum_pg_subscription_subslotname,
                             &isnull);
     if (!isnull)
         sub->slotname = pstrdup(NameStr(*DatumGetName(datum)));
     else
         sub->slotname = NULL;
  
     /* Get synccommit */
     datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID,
                                    tup,
                                    Anum_pg_subscription_subsynccommit);
     sub->synccommit = TextDatumGetCString(datum);
  
     /* Get publications */
     datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID,
                                    tup,
                                    Anum_pg_subscription_subpublications);
     sub->publications = textarray_to_stringlist(DatumGetArrayTypeP(datum));
  
     /* Get origin */
     datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID,
                                    tup,
                                    Anum_pg_subscription_suborigin);
     sub->origin = TextDatumGetCString(datum);
  
     /* Is the subscription owner a superuser? */
     sub->ownersuperuser = superuser_arg(sub->owner);
  
     ReleaseSysCache(tup);
  
     return sub;
 }

References Subscription::binary, Subscription::conninfo, DatumGetArrayTypeP, DatumGetName(), Subscription::dbid, Subscription::disableonerr, elog(), Subscription::enabled, ERROR, GETSTRUCT, HeapTupleIsValid, Subscription::name, NameStr, ObjectIdGetDatum(), Subscription::oid, Subscription::origin, Subscription::owner, Subscription::ownersuperuser, palloc(), Subscription::passwordrequired, pstrdup(), Subscription::publications, ReleaseSysCache(), Subscription::runasowner, SearchSysCache1(), Subscription::skiplsn, Subscription::slotname, Subscription::stream, SUBSCRIPTIONOID, superuser_arg(), Subscription::synccommit, SysCacheGetAttr(), SysCacheGetAttrNotNull(), textarray_to_stringlist(), TextDatumGetCString, and Subscription::twophasestate.

Referenced by AlterSubscription(), InitializeLogRepWorker(), and maybe_reread_subscription().

Variable Documentation

◆ BKI_SCHEMA_MACRO

SubscriptionRelation_Rowtype_Id BKI_SCHEMA_MACRO

Initial value:

{

Oid oid

Oid

unsigned int Oid

Definition: postgres_ext.h:31

Definition at line 63 of file pg_subscription.h.

◆ FormData_pg_subscription

FormData_pg_subscription

Definition at line 112 of file pg_subscription.h.

◆ subbinary

bool subbinary

Definition at line 80 of file pg_subscription.h.

◆ subdisableonerr

bool subdisableonerr

Definition at line 88 of file pg_subscription.h.

◆ subenabled

bool subenabled

Definition at line 77 of file pg_subscription.h.

◆ subname

NameData subname

Definition at line 73 of file pg_subscription.h.

Referenced by AddAcl(), buildACLCommands(), check_publications_origin(), DropSubscription(), dumpACL(), get_subscription_name(), get_subscription_oid(), getObjectDescription(), getObjectIdentityParts(), logicalrep_worker_launch(), merge_publications(), parseAclItem(), and plperl_create_sub().

◆ subpasswordrequired

bool subpasswordrequired

Definition at line 91 of file pg_subscription.h.

◆ subrunasowner

bool subrunasowner

Definition at line 93 of file pg_subscription.h.

◆ subskiplsn

XLogRecPtr subskiplsn

Definition at line 70 of file pg_subscription.h.

◆ substream

char substream

Definition at line 83 of file pg_subscription.h.

◆ subtwophasestate

char subtwophasestate

Definition at line 86 of file pg_subscription.h.

Data Structures

Macros

Typedefs

Functions

Variables