pg_subscription.h File Reference

#include "access/xlogdefs.h"
#include "catalog/genbki.h"
#include "catalog/pg_subscription_d.h"
#include "lib/stringinfo.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

Typedefs
typedef struct Subscription	Subscription

Functions
BEGIN_CATALOG_STRUCT	CATALOG (pg_subscription, 6100, SubscriptionRelationId) BKI_SHARED_RELATION BKI_ROWTYPE_OID(6101
Oid subdbid	BKI_LOOKUP (pg_database)
Oid subowner	BKI_LOOKUP (pg_authid)
Oid subserver	BKI_LOOKUP_OPT (pg_foreign_server)
	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))
	MAKE_SYSCACHE (SUBSCRIPTIONOID, pg_subscription_oid_index, 4)
	MAKE_SYSCACHE (SUBSCRIPTIONNAME, pg_subscription_subname_index, 4)
Subscription *	GetSubscription (Oid subid, bool missing_ok, bool conninfo_needed, bool conninfo_aclcheck)
void	DisableSubscription (Oid subid)
int	CountDBSubscriptions (Oid dbid)
void	GetPublicationsStr (List *publications, StringInfo dest, bool quote_literal)

Variables
END_CATALOG_STRUCT typedef FormData_pg_subscription *	Form_pg_subscription
BEGIN_CATALOG_STRUCT SubscriptionRelation_Rowtype_Id	BKI_SCHEMA_MACRO
XLogRecPtr	subskiplsn
NameData	subname
bool	subenabled
bool	subbinary
char	substream
char	subtwophasestate
bool	subdisableonerr
bool	subpasswordrequired
bool	subrunasowner
bool	subfailover
bool	subretaindeadtuples
int32	submaxretention
bool	subretentionactive
Oid	subconflictlogrelid
	FormData_pg_subscription

Typedef Documentation

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

)

BKI_LOOKUP_OPT()

Oid subserver BKI_LOOKUP_OPT

(

pg_foreign_server

)

CATALOG()

BEGIN_CATALOG_STRUCT CATALOG	(	pg_subscription	,
		6100	,
		SubscriptionRelationId
	)

CountDBSubscriptions()

int CountDBSubscriptions ( Oid  dbid )

extern

Definition at line 234 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, fb(), 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 )

extern

Definition at line 266 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);
 
    /* Must only modify subscriptions belonging to the current database. */
    Assert(((Form_pg_subscription) GETSTRUCT(tup))->subdbid == MyDatabaseId);
 
    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, Assert, BoolGetDatum(), CatalogTupleUpdate(), elog, ERROR, fb(), Form_pg_subscription, GETSTRUCT(), heap_freetuple(), heap_modify_tuple(), HeapTupleIsValid, LockSharedObject(), MyDatabaseId, NoLock, ObjectIdGetDatum(), RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy1, table_close(), table_open(), and values.

Referenced by DisableSubscriptionAndExit().

GetPublicationsStr()

void GetPublicationsStr ( List *  publications, StringInfo  dest, bool  quote_literal  )

extern

Definition at line 50 of file pg_subscription.c.

{
    ListCell   *lc;
    bool        first = true;
 
    Assert(publications != NIL);
 
    foreach(lc, publications)
    {
        char       *pubname = strVal(lfirst(lc));
 
        if (quote_literal)
        {
            if (!first)
                appendStringInfoString(dest, ", ");
            appendStringInfoString(dest, quote_literal_cstr(pubname));
        }
        else
        {
            if (first)
                appendStringInfo(dest, _("\"%s\""), pubname);
            else
                appendStringInfo(dest, _(", \"%s\""), pubname);
        }
 
        first = false;
    }
}

References _, appendStringInfo(), appendStringInfoString(), Assert, fb(), lfirst, NIL, quote_literal(), quote_literal_cstr(), and strVal.

Referenced by check_publications_origin_sequences(), check_publications_origin_tables(), fetch_relation_list(), and fetch_remote_table_info().

GetSubscription()

Subscription * GetSubscription ( Oid  subid, bool  missing_ok, bool  conninfo_needed, bool  conninfo_aclcheck  )

extern

Definition at line 88 of file pg_subscription.c.

{
    HeapTuple   tup;
    Subscription *sub;
    Form_pg_subscription subform;
    Datum       datum;
    bool        isnull;
    MemoryContext cxt;
    MemoryContext oldcxt;
 
    Assert(conninfo_needed || !conninfo_aclcheck);
 
    tup = SearchSysCache1(SUBSCRIPTIONOID, ObjectIdGetDatum(subid));
 
    if (!HeapTupleIsValid(tup))
    {
        if (missing_ok)
            return NULL;
 
        elog(ERROR, "cache lookup failed for subscription %u", subid);
    }
 
    cxt = AllocSetContextCreate(CurrentMemoryContext, "subscription",
                                ALLOCSET_SMALL_SIZES);
    oldcxt = MemoryContextSwitchTo(cxt);
 
    subform = (Form_pg_subscription) GETSTRUCT(tup);
 
    /*
     * It's only safe to access subscriptions from another database from the
     * launcher process, which does not call GetSubscription().
     */
    Assert(subform->subdbid == MyDatabaseId);
 
    sub = palloc0_object(Subscription);
    sub->cxt = cxt;
    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;
    sub->failover = subform->subfailover;
    sub->retaindeadtuples = subform->subretaindeadtuples;
    sub->maxretention = subform->submaxretention;
    sub->retentionactive = subform->subretentionactive;
    sub->conflictlogrelid = subform->subconflictlogrelid;
 
    if (conninfo_needed)
    {
        if (OidIsValid(subform->subserver))
        {
            AclResult   aclresult;
            ForeignServer *server;
 
            server = GetForeignServer(subform->subserver);
 
            if (conninfo_aclcheck)
            {
                /* recheck ACL if requested */
                aclresult = object_aclcheck(ForeignServerRelationId,
                                            subform->subserver,
                                            subform->subowner, ACL_USAGE);
 
                if (aclresult != ACLCHECK_OK)
                    ereport(ERROR,
                            (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                             errmsg("subscription owner \"%s\" does not have permission on foreign server \"%s\"",
                                    GetUserNameFromId(subform->subowner, false),
                                    server->servername)));
            }
 
            sub->conninfo = ForeignServerConnectionString(subform->subowner,
                                                          server);
        }
        else
        {
            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 walrcvtimeout */
    datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID,
                                   tup,
                                   Anum_pg_subscription_subwalrcvtimeout);
    sub->walrcvtimeout = 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);
 
    /* Get conflict log destination */
    datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID,
                                   tup,
                                   Anum_pg_subscription_subconflictlogdest);
    sub->conflictlogdest = TextDatumGetCString(datum);
 
    /* Is the subscription owner a superuser? */
    sub->ownersuperuser = superuser_arg(sub->owner);
 
    ReleaseSysCache(tup);
 
    MemoryContextSwitchTo(oldcxt);
 
    return sub;
}

References ACL_USAGE, ACLCHECK_OK, ALLOCSET_SMALL_SIZES, AllocSetContextCreate, Assert, Subscription::binary, Subscription::conflictlogdest, Subscription::conflictlogrelid, Subscription::conninfo, CurrentMemoryContext, Subscription::cxt, DatumGetArrayTypeP, DatumGetName(), Subscription::dbid, Subscription::disableonerr, elog, Subscription::enabled, ereport, errcode(), errmsg, ERROR, Subscription::failover, fb(), ForeignServerConnectionString(), Form_pg_subscription, GetForeignServer(), GETSTRUCT(), GetUserNameFromId(), HeapTupleIsValid, Subscription::maxretention, MemoryContextSwitchTo(), MyDatabaseId, Subscription::name, NameStr, object_aclcheck(), ObjectIdGetDatum(), Subscription::oid, OidIsValid, Subscription::origin, Subscription::owner, Subscription::ownersuperuser, palloc0_object, Subscription::passwordrequired, pstrdup(), Subscription::publications, ReleaseSysCache(), Subscription::retaindeadtuples, Subscription::retentionactive, Subscription::runasowner, SearchSysCache1(), ForeignServer::servername, Subscription::skiplsn, Subscription::slotname, Subscription::stream, superuser_arg(), Subscription::synccommit, SysCacheGetAttr(), SysCacheGetAttrNotNull(), textarray_to_stringlist(), TextDatumGetCString, Subscription::twophasestate, and Subscription::walrcvtimeout.

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

MAKE_SYSCACHE() [1/2]

MAKE_SYSCACHE	(	SUBSCRIPTIONNAME	,
		pg_subscription_subname_index	,
		4
	)

MAKE_SYSCACHE() [2/2]

MAKE_SYSCACHE	(	SUBSCRIPTIONOID	,
		pg_subscription_oid_index	,
		4
	)

Variable Documentation

BKI_SCHEMA_MACRO

BEGIN_CATALOG_STRUCT SubscriptionRelation_Rowtype_Id BKI_SCHEMA_MACRO

Initial value:

{
    Oid         oid

Definition at line 45 of file pg_subscription.h.

Form_pg_subscription

END_CATALOG_STRUCT typedef FormData_pg_subscription* Form_pg_subscription

Definition at line 129 of file pg_subscription.h.

Referenced by AlterObjectRename_internal(), AlterSubscription(), AlterSubscriptionOwner(), AlterSubscriptionOwner_internal(), AlterSubscriptionOwner_oid(), clear_subscription_skip_lsn(), DisableSubscription(), DropSubscription(), get_subscription_list(), get_subscription_name(), GetSubscription(), and UpdateDeadTupleRetentionStatus().

FormData_pg_subscription

FormData_pg_subscription

Definition at line 125 of file pg_subscription.h.

subbinary

bool subbinary

Definition at line 62 of file pg_subscription.h.

subconflictlogrelid

Oid subconflictlogrelid

Definition at line 98 of file pg_subscription.h.

Referenced by drop_sub_conflict_log_table(), and DropSubscription().

subdisableonerr

bool subdisableonerr

Definition at line 70 of file pg_subscription.h.

subenabled

bool subenabled

Definition at line 59 of file pg_subscription.h.

subfailover

bool subfailover

Definition at line 78 of file pg_subscription.h.

submaxretention

int32 submaxretention

Definition at line 86 of file pg_subscription.h.

subname

NameData subname

Definition at line 55 of file pg_subscription.h.

Referenced by AddAcl(), binary_upgrade_add_sub_rel_state(), binary_upgrade_replorigin_advance(), buildACLCommands(), check_publications_origin_sequences(), check_publications_origin_tables(), create_conflict_log_table(), drop_existing_subscription(), drop_sub_conflict_log_table(), DropSubscription(), dumpACL(), enable_subscription(), get_subscription_name(), get_subscription_oid(), getObjectDescription(), getObjectIdentityParts(), logicalrep_worker_launch(), merge_publications(), parseAclItem(), plperl_create_sub(), report_result(), set_replication_progress(), setup_publisher(), and store_pub_sub_info().

subpasswordrequired

bool subpasswordrequired

Definition at line 73 of file pg_subscription.h.

subretaindeadtuples

bool subretaindeadtuples

Definition at line 83 of file pg_subscription.h.

subretentionactive

bool subretentionactive

Definition at line 90 of file pg_subscription.h.

subrunasowner

bool subrunasowner

Definition at line 75 of file pg_subscription.h.

subskiplsn

XLogRecPtr subskiplsn

Definition at line 52 of file pg_subscription.h.

substream

char substream

Definition at line 65 of file pg_subscription.h.

subtwophasestate

char subtwophasestate

Definition at line 68 of file pg_subscription.h.