pg_subscription.h File Reference

#include "catalog/genbki.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	SubscriptionRelationId   6100
#define	SubscriptionRelation_Rowtype_Id   6101
#define	Natts_pg_subscription   8
#define	Anum_pg_subscription_subdbid   1
#define	Anum_pg_subscription_subname   2
#define	Anum_pg_subscription_subowner   3
#define	Anum_pg_subscription_subenabled   4
#define	Anum_pg_subscription_subconninfo   5
#define	Anum_pg_subscription_subslotname   6
#define	Anum_pg_subscription_subsynccommit   7
#define	Anum_pg_subscription_subpublications   8

Typedefs
typedef FormData_pg_subscription *	Form_pg_subscription
typedef struct Subscription	Subscription

Functions
	CATALOG (pg_subscription, 6100) BKI_SHARED_RELATION BKI_ROWTYPE_OID(6101) BKI_SCHEMA_MACRO
Subscription *	GetSubscription (Oid subid, bool missing_ok)
void	FreeSubscription (Subscription *sub)
Oid	get_subscription_oid (const char *subname, bool missing_ok)
char *	get_subscription_name (Oid subid)
int	CountDBSubscriptions (Oid dbid)

Variables
	FormData_pg_subscription

Macro Definition Documentation

#define Anum_pg_subscription_subconninfo   5

Definition at line 69 of file pg_subscription.h.

Referenced by AlterSubscription(), CreateSubscription(), DropSubscription(), and GetSubscription().

#define Anum_pg_subscription_subdbid   1

Definition at line 65 of file pg_subscription.h.

Referenced by CountDBSubscriptions(), and CreateSubscription().

#define Anum_pg_subscription_subenabled   4

Definition at line 68 of file pg_subscription.h.

Referenced by AlterSubscription(), and CreateSubscription().

#define Anum_pg_subscription_subname   2

Definition at line 66 of file pg_subscription.h.

Referenced by CreateSubscription(), and DropSubscription().

#define Anum_pg_subscription_subowner   3

Definition at line 67 of file pg_subscription.h.

Referenced by CreateSubscription().

#define Anum_pg_subscription_subpublications   8

Definition at line 72 of file pg_subscription.h.

Referenced by AlterSubscription(), CreateSubscription(), and GetSubscription().

#define Anum_pg_subscription_subslotname   6

Definition at line 70 of file pg_subscription.h.

Referenced by AlterSubscription(), CreateSubscription(), DropSubscription(), and GetSubscription().

#define Anum_pg_subscription_subsynccommit   7

Definition at line 71 of file pg_subscription.h.

Referenced by AlterSubscription(), CreateSubscription(), and GetSubscription().

#define Natts_pg_subscription   8

Definition at line 64 of file pg_subscription.h.

Referenced by AlterSubscription(), CreateSubscription(), and RelationCacheInitializePhase2().

#define SubscriptionRelation_Rowtype_Id   6101

Definition at line 23 of file pg_subscription.h.

Referenced by RelationCacheInitializePhase2().

#define SubscriptionRelationId   6100

Definition at line 22 of file pg_subscription.h.

Referenced by AlterObjectRename_internal(), AlterSubscription(), AlterSubscriptionOwner(), AlterSubscriptionOwner_internal(), AlterSubscriptionOwner_oid(), CountDBSubscriptions(), CreateSubscription(), DropSubscription(), get_object_address_unqualified(), get_subscription_list(), getObjectClass(), IsSharedRelation(), report_name_conflict(), SetSubscriptionRelState(), and shdepReassignOwned().

Typedef Documentation

typedef FormData_pg_subscription* Form_pg_subscription

Definition at line 58 of file pg_subscription.h.

typedef struct Subscription Subscription

Function Documentation

CATALOG	(	pg_subscription	,
		6100
	)

Definition at line 33 of file pg_subscription.h.

References BKI_FORCE_NOT_NULL.

{
    Oid         subdbid;        /* Database the subscription is in. */
    NameData    subname;        /* Name of the subscription */

    Oid         subowner;       /* Owner of the subscription */

    bool        subenabled;     /* True if the subscription is enabled (the
                                 * worker should be running) */

#ifdef CATALOG_VARLEN           /* variable-length fields start here */
    /* Connection string to the publisher */
    text        subconninfo BKI_FORCE_NOT_NULL;

    /* Slot name on publisher */
    NameData    subslotname;

    /* Synchronous commit setting for worker */
    text        subsynccommit BKI_FORCE_NOT_NULL;

    /* List of publications subscribed to */
    text        subpublications[1] BKI_FORCE_NOT_NULL;
#endif
} FormData_pg_subscription;

int CountDBSubscriptions

(

Oid

dbid

)

Definition at line 118 of file pg_subscription.c.

References Anum_pg_subscription_subdbid, BTEqualStrategyNumber, heap_close, heap_open(), HeapTupleIsValid, InvalidOid, NoLock, ObjectIdGetDatum, RowExclusiveLock, ScanKeyInit(), SubscriptionRelationId, systable_beginscan(), systable_endscan(), and systable_getnext().

Referenced by dropdb().

{
    int         nsubs = 0;
    Relation    rel;
    ScanKeyData scankey;
    SysScanDesc scan;
    HeapTuple   tup;

    rel = heap_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);

    heap_close(rel, NoLock);

    return nsubs;
}

void FreeSubscription

(

Subscription *

sub

)

Definition at line 150 of file pg_subscription.c.

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

Referenced by maybe_reread_subscription().

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

char* get_subscription_name

(

Oid

subid

)

Definition at line 184 of file pg_subscription.c.

References elog, ERROR, GETSTRUCT, HeapTupleIsValid, NameStr, ObjectIdGetDatum, pstrdup(), ReleaseSysCache(), SearchSysCache1(), and SUBSCRIPTIONOID.

Referenced by getObjectDescription(), and getObjectIdentityParts().

{
    HeapTuple   tup;
    char       *subname;
    Form_pg_subscription subform;

    tup = SearchSysCache1(SUBSCRIPTIONOID, ObjectIdGetDatum(subid));

    if (!HeapTupleIsValid(tup))
        elog(ERROR, "cache lookup failed for subscription %u", subid);

    subform = (Form_pg_subscription) GETSTRUCT(tup);
    subname = pstrdup(NameStr(subform->subname));

    ReleaseSysCache(tup);

    return subname;
}

Oid get_subscription_oid	(	const char *	subname,
		bool	missing_ok
	)

Definition at line 167 of file pg_subscription.c.

References CStringGetDatum, ereport, errcode(), errmsg(), ERROR, GetSysCacheOid2, MyDatabaseId, OidIsValid, and SUBSCRIPTIONNAME.

Referenced by get_object_address_unqualified().

{
    Oid         oid;

    oid = GetSysCacheOid2(SUBSCRIPTIONNAME, MyDatabaseId,
                          CStringGetDatum(subname));
    if (!OidIsValid(oid) && !missing_ok)
        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("subscription \"%s\" does not exist", subname)));
    return oid;
}

Subscription* GetSubscription	(	Oid	subid,
		bool	missing_ok
	)

Definition at line 47 of file pg_subscription.c.

References Anum_pg_subscription_subconninfo, Anum_pg_subscription_subpublications, Anum_pg_subscription_subslotname, Anum_pg_subscription_subsynccommit, Assert, Subscription::conninfo, DatumGetArrayTypeP, DatumGetName, Subscription::dbid, elog, Subscription::enabled, ERROR, GETSTRUCT, HeapTupleIsValid, Subscription::name, NameStr, ObjectIdGetDatum, Subscription::oid, Subscription::owner, palloc(), pstrdup(), Subscription::publications, ReleaseSysCache(), SearchSysCache1(), Subscription::slotname, SUBSCRIPTIONOID, Subscription::synccommit, SysCacheGetAttr(), textarray_to_stringlist(), and TextDatumGetCString.

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

{
    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->name = pstrdup(NameStr(subform->subname));
    sub->owner = subform->subowner;
    sub->enabled = subform->subenabled;

    /* Get conninfo */
    datum = SysCacheGetAttr(SUBSCRIPTIONOID,
                            tup,
                            Anum_pg_subscription_subconninfo,
                            &isnull);
    Assert(!isnull);
    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 = SysCacheGetAttr(SUBSCRIPTIONOID,
                            tup,
                            Anum_pg_subscription_subsynccommit,
                            &isnull);
    Assert(!isnull);
    sub->synccommit = TextDatumGetCString(datum);

    /* Get publications */
    datum = SysCacheGetAttr(SUBSCRIPTIONOID,
                            tup,
                            Anum_pg_subscription_subpublications,
                            &isnull);
    Assert(!isnull);
    sub->publications = textarray_to_stringlist(DatumGetArrayTypeP(datum));

    ReleaseSysCache(tup);

    return sub;
}

Variable Documentation

FormData_pg_subscription

Definition at line 56 of file pg_subscription.h.