pg_subscription.h File Reference

#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	PgSubscriptionToastTable   4183
#define	PgSubscriptionToastIndex   4184
#define	SubscriptionObjectIndexId   6114
#define	SubscriptionNameIndexId   6115

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 (pg_subscription, 4183, 4184)
	DECLARE_UNIQUE_INDEX_PKEY (pg_subscription_oid_index, 6114, on pg_subscription using btree(oid oid_ops))
	DECLARE_UNIQUE_INDEX (pg_subscription_subname_index, 6115, on pg_subscription using btree(subdbid oid_ops, subname name_ops))
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, bool missing_ok)
int	CountDBSubscriptions (Oid dbid)

Variables
SubscriptionRelation_Rowtype_Id	BKI_SCHEMA_MACRO
NameData	subname
bool	subenabled
bool	subbinary
bool	substream
	FormData_pg_subscription

Macro Definition Documentation

PgSubscriptionToastIndex

#define PgSubscriptionToastIndex   4184

Definition at line 76 of file pg_subscription.h.

Referenced by IsSharedRelation().

PgSubscriptionToastTable

#define PgSubscriptionToastTable   4183

Definition at line 75 of file pg_subscription.h.

Referenced by IsSharedRelation().

SubscriptionNameIndexId

#define SubscriptionNameIndexId   6115

Definition at line 81 of file pg_subscription.h.

Referenced by IsSharedRelation().

SubscriptionObjectIndexId

#define SubscriptionObjectIndexId   6114

Definition at line 79 of file pg_subscription.h.

Referenced by CreateSubscription(), and IsSharedRelation().

Typedef Documentation

Form_pg_subscription

typedef FormData_pg_subscription* Form_pg_subscription

Definition at line 72 of file pg_subscription.h.

Subscription

typedef struct Subscription Subscription

Function Documentation

BKI_LOOKUP() [1/2]

Oid subdbid BKI_LOOKUP

(

pg_database

)

BKI_LOOKUP() [2/2]

Oid subowner BKI_LOOKUP

(

pg_authid

)

CATALOG()

CATALOG	(	pg_subscription	,
		6100	,
		SubscriptionRelationId
	)

CountDBSubscriptions()

int CountDBSubscriptions

(

Oid

dbid

)

Definition at line 116 of file pg_subscription.c.

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

Referenced by dropdb().

{
    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;
}

DECLARE_TOAST()

DECLARE_TOAST	(	pg_subscription	,
		4183	,
		4184
	)

DECLARE_UNIQUE_INDEX()

DECLARE_UNIQUE_INDEX	(	pg_subscription_subname_index	,
		6115	,
		on pg_subscription using	btreesubdbid oid_ops, subname name_ops
	)

DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY	(	pg_subscription_oid_index	,
		6114	,
		on pg_subscription using	btreeoid oid_ops
	)

FreeSubscription()

void FreeSubscription

(

Subscription *

sub

)

Definition at line 148 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);
}

get_subscription_name()

char* get_subscription_name	(	Oid	subid,
		bool	missing_ok
	)

Definition at line 185 of file pg_subscription.c.

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

Referenced by getObjectDescription(), getObjectIdentityParts(), and RemoveSubscriptionRel().

{
    HeapTuple   tup;
    char       *subname;
    Form_pg_subscription subform;

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

    if (!HeapTupleIsValid(tup))
    {
        if (!missing_ok)
            elog(ERROR, "cache lookup failed for subscription %u", subid);
        return NULL;
    }

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

    ReleaseSysCache(tup);

    return subname;
}

get_subscription_oid()

Oid get_subscription_oid	(	const char *	subname,
		bool	missing_ok
	)

Definition at line 165 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, Anum_pg_subscription_oid,
                          MyDatabaseId, CStringGetDatum(subname));
    if (!OidIsValid(oid) && !missing_ok)
        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("subscription \"%s\" does not exist", subname)));
    return oid;
}

GetSubscription()

Subscription* GetSubscription	(	Oid	subid,
		bool	missing_ok
	)

Definition at line 43 of file pg_subscription.c.

References Assert, Subscription::binary, 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, Subscription::stream, 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;
    sub->binary = subform->subbinary;
    sub->stream = subform->substream;

    /* 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

BKI_SCHEMA_MACRO

SubscriptionRelation_Rowtype_Id BKI_SCHEMA_MACRO

Initial value:

{
    Oid         oid

Definition at line 40 of file pg_subscription.h.

FormData_pg_subscription

FormData_pg_subscription

Definition at line 70 of file pg_subscription.h.

subbinary

bool subbinary

Definition at line 52 of file pg_subscription.h.

subenabled

bool subenabled

Definition at line 49 of file pg_subscription.h.

subname

NameData subname

Definition at line 45 of file pg_subscription.h.

Referenced by _copyAlterSubscriptionStmt(), _copyCreateSubscriptionStmt(), _copyDropSubscriptionStmt(), _copyRenameStmt(), _equalAlterSubscriptionStmt(), _equalCreateSubscriptionStmt(), _equalDropSubscriptionStmt(), _equalRenameStmt(), DropSubscription(), get_subscription_name(), getObjectDescription(), getObjectIdentityParts(), and plperl_create_sub().

substream

bool substream

Definition at line 55 of file pg_subscription.h.