pg_publication.h File Reference

#include "catalog/genbki.h"
#include "catalog/objectaddress.h"

Include dependency graph for pg_publication.h:

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

Go to the source code of this file.

Data Structures
struct	PublicationActions
struct	Publication

Macros
#define	PublicationRelationId   6104
#define	Natts_pg_publication   6
#define	Anum_pg_publication_pubname   1
#define	Anum_pg_publication_pubowner   2
#define	Anum_pg_publication_puballtables   3
#define	Anum_pg_publication_pubinsert   4
#define	Anum_pg_publication_pubupdate   5
#define	Anum_pg_publication_pubdelete   6

Typedefs
typedef FormData_pg_publication *	Form_pg_publication
typedef struct PublicationActions	PublicationActions
typedef struct Publication	Publication

Functions
	CATALOG (pg_publication, 6104)
Publication *	GetPublication (Oid pubid)
Publication *	GetPublicationByName (const char *pubname, bool missing_ok)
List *	GetRelationPublications (Oid relid)
List *	GetPublicationRelations (Oid pubid)
List *	GetAllTablesPublications (void)
List *	GetAllTablesPublicationRelations (void)
ObjectAddress	publication_add_relation (Oid pubid, Relation targetrel, bool if_not_exists)
Oid	get_publication_oid (const char *pubname, bool missing_ok)
char *	get_publication_name (Oid pubid)
Datum	pg_get_publication_tables (PG_FUNCTION_ARGS)

Variables
	FormData_pg_publication

Macro Definition Documentation

#define Anum_pg_publication_puballtables   3

Definition at line 69 of file pg_publication.h.

Referenced by CreatePublication(), and GetAllTablesPublications().

#define Anum_pg_publication_pubdelete   6

Definition at line 72 of file pg_publication.h.

Referenced by AlterPublicationOptions(), and CreatePublication().

#define Anum_pg_publication_pubinsert   4

Definition at line 70 of file pg_publication.h.

Referenced by AlterPublicationOptions(), and CreatePublication().

#define Anum_pg_publication_pubname   1

Definition at line 67 of file pg_publication.h.

Referenced by CreatePublication().

#define Anum_pg_publication_pubowner   2

Definition at line 68 of file pg_publication.h.

Referenced by CreatePublication().

#define Anum_pg_publication_pubupdate   5

Definition at line 71 of file pg_publication.h.

Referenced by AlterPublicationOptions(), and CreatePublication().

#define Natts_pg_publication   6

Definition at line 66 of file pg_publication.h.

Referenced by AlterPublicationOptions(), and CreatePublication().

#define PublicationRelationId   6104

Definition at line 29 of file pg_publication.h.

Referenced by AlterPublication(), AlterPublicationOptions(), AlterPublicationOwner(), AlterPublicationOwner_internal(), AlterPublicationOwner_oid(), CreatePublication(), get_object_address_unqualified(), GetAllTablesPublications(), getObjectClass(), publication_add_relation(), RemovePublicationById(), report_name_conflict(), and shdepReassignOwned().

Typedef Documentation

typedef FormData_pg_publication* Form_pg_publication

Definition at line 59 of file pg_publication.h.

typedef struct Publication Publication

typedef struct PublicationActions PublicationActions

Function Documentation

CATALOG	(	pg_publication	,
		6104
	)

Definition at line 31 of file pg_publication.h.

{
    NameData    pubname;        /* name of the publication */

    Oid         pubowner;       /* publication owner */

    /*
     * indicates that this is special publication which should encompass all
     * tables in the database (except for the unlogged and temp ones)
     */
    bool        puballtables;

    /* true if inserts are published */
    bool        pubinsert;

    /* true if updates are published */
    bool        pubupdate;

    /* true if deletes are published */
    bool        pubdelete;

} FormData_pg_publication;

char* get_publication_name

(

Oid

pubid

)

Definition at line 422 of file pg_publication.c.

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

Referenced by getObjectDescription(), and getObjectIdentityParts().

{
    HeapTuple   tup;
    char       *pubname;
    Form_pg_publication pubform;

    tup = SearchSysCache1(PUBLICATIONOID, ObjectIdGetDatum(pubid));

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

    pubform = (Form_pg_publication) GETSTRUCT(tup);
    pubname = pstrdup(NameStr(pubform->pubname));

    ReleaseSysCache(tup);

    return pubname;
}

Oid get_publication_oid	(	const char *	pubname,
		bool	missing_ok
	)

Definition at line 406 of file pg_publication.c.

References CStringGetDatum, ereport, errcode(), errmsg(), ERROR, GetSysCacheOid1, OidIsValid, and PUBLICATIONNAME.

Referenced by get_object_address_unqualified().

{
    Oid         oid;

    oid = GetSysCacheOid1(PUBLICATIONNAME, CStringGetDatum(pubname));
    if (!OidIsValid(oid) && !missing_ok)
        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("publication \"%s\" does not exist", pubname)));
    return oid;
}

List* GetAllTablesPublicationRelations

(

void

)

Definition at line 312 of file pg_publication.c.

References AccessShareLock, Anum_pg_class_relkind, BTEqualStrategyNumber, CharGetDatum, ForwardScanDirection, GETSTRUCT, heap_beginscan_catalog(), heap_close, heap_endscan(), heap_getnext(), heap_open(), HeapTupleGetOid, is_publishable_class(), lappend_oid(), NIL, RelationRelationId, RELKIND_RELATION, and ScanKeyInit().

Referenced by pg_get_publication_tables().

{
    Relation    classRel;
    ScanKeyData key[1];
    HeapScanDesc scan;
    HeapTuple   tuple;
    List       *result = NIL;

    classRel = heap_open(RelationRelationId, AccessShareLock);

    ScanKeyInit(&key[0],
                Anum_pg_class_relkind,
                BTEqualStrategyNumber, F_CHAREQ,
                CharGetDatum(RELKIND_RELATION));

    scan = heap_beginscan_catalog(classRel, 1, key);

    while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
    {
        Oid         relid = HeapTupleGetOid(tuple);
        Form_pg_class relForm = (Form_pg_class) GETSTRUCT(tuple);

        if (is_publishable_class(relid, relForm))
            result = lappend_oid(result, relid);
    }

    heap_endscan(scan);
    heap_close(classRel, AccessShareLock);

    return result;
}

List* GetAllTablesPublications

(

void

)

Definition at line 279 of file pg_publication.c.

References AccessShareLock, Anum_pg_publication_puballtables, BoolGetDatum, BTEqualStrategyNumber, heap_close, heap_open(), HeapTupleGetOid, HeapTupleIsValid, InvalidOid, lappend_oid(), NIL, PublicationRelationId, ScanKeyInit(), systable_beginscan(), systable_endscan(), and systable_getnext().

Referenced by GetRelationPublicationActions().

{
    List       *result;
    Relation    rel;
    ScanKeyData scankey;
    SysScanDesc scan;
    HeapTuple   tup;

    /* Find all publications that are marked as for all tables. */
    rel = heap_open(PublicationRelationId, AccessShareLock);

    ScanKeyInit(&scankey,
                Anum_pg_publication_puballtables,
                BTEqualStrategyNumber, F_BOOLEQ,
                BoolGetDatum(true));

    scan = systable_beginscan(rel, InvalidOid, false,
                              NULL, 1, &scankey);

    result = NIL;
    while (HeapTupleIsValid(tup = systable_getnext(scan)))
        result = lappend_oid(result, HeapTupleGetOid(tup));

    systable_endscan(scan);
    heap_close(rel, AccessShareLock);

    return result;
}

Publication* GetPublication

(

Oid

pubid

)

Definition at line 350 of file pg_publication.c.

References Publication::alltables, elog, ERROR, GETSTRUCT, HeapTupleIsValid, Publication::name, NameStr, ObjectIdGetDatum, Publication::oid, palloc(), pstrdup(), Publication::pubactions, PublicationActions::pubdelete, PublicationActions::pubinsert, PUBLICATIONOID, PublicationActions::pubupdate, ReleaseSysCache(), and SearchSysCache1.

Referenced by GetPublicationByName(), and publication_add_relation().

{
    HeapTuple   tup;
    Publication *pub;
    Form_pg_publication pubform;

    tup = SearchSysCache1(PUBLICATIONOID, ObjectIdGetDatum(pubid));

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

    pubform = (Form_pg_publication) GETSTRUCT(tup);

    pub = (Publication *) palloc(sizeof(Publication));
    pub->oid = pubid;
    pub->name = pstrdup(NameStr(pubform->pubname));
    pub->alltables = pubform->puballtables;
    pub->pubactions.pubinsert = pubform->pubinsert;
    pub->pubactions.pubupdate = pubform->pubupdate;
    pub->pubactions.pubdelete = pubform->pubdelete;

    ReleaseSysCache(tup);

    return pub;
}

Publication* GetPublicationByName	(	const char *	pubname,
		bool	missing_ok
	)

Definition at line 381 of file pg_publication.c.

References CStringGetDatum, ereport, errcode(), errmsg(), ERROR, GetPublication(), GetSysCacheOid1, OidIsValid, and PUBLICATIONNAME.

Referenced by get_object_address_publication_rel(), LoadPublications(), and pg_get_publication_tables().

{
    Oid         oid;

    oid = GetSysCacheOid1(PUBLICATIONNAME, CStringGetDatum(pubname));
    if (!OidIsValid(oid))
    {
        if (missing_ok)
            return NULL;

        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("publication \"%s\" does not exist", pubname)));
    }

    return GetPublication(oid);
}

List* GetPublicationRelations

(

Oid

pubid

)

Definition at line 240 of file pg_publication.c.

References AccessShareLock, Anum_pg_publication_rel_prpubid, BTEqualStrategyNumber, GETSTRUCT, heap_close, heap_open(), HeapTupleIsValid, lappend_oid(), NIL, ObjectIdGetDatum, PublicationRelPrrelidPrpubidIndexId, PublicationRelRelationId, ScanKeyInit(), systable_beginscan(), systable_endscan(), and systable_getnext().

Referenced by AlterPublicationOptions(), AlterPublicationTables(), and pg_get_publication_tables().

{
    List       *result;
    Relation    pubrelsrel;
    ScanKeyData scankey;
    SysScanDesc scan;
    HeapTuple   tup;

    /* Find all publications associated with the relation. */
    pubrelsrel = heap_open(PublicationRelRelationId, AccessShareLock);

    ScanKeyInit(&scankey,
                Anum_pg_publication_rel_prpubid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(pubid));

    scan = systable_beginscan(pubrelsrel, PublicationRelPrrelidPrpubidIndexId,
                              true, NULL, 1, &scankey);

    result = NIL;
    while (HeapTupleIsValid(tup = systable_getnext(scan)))
    {
        Form_pg_publication_rel pubrel;

        pubrel = (Form_pg_publication_rel) GETSTRUCT(tup);

        result = lappend_oid(result, pubrel->prrelid);
    }

    systable_endscan(scan);
    heap_close(pubrelsrel, AccessShareLock);

    return result;
}

List* GetRelationPublications

(

Oid

relid

)

Definition at line 211 of file pg_publication.c.

References GETSTRUCT, i, lappend_oid(), catclist::members, catclist::n_members, NIL, ObjectIdGetDatum, PUBLICATIONRELMAP, ReleaseSysCacheList, SearchSysCacheList1, and catctup::tuple.

Referenced by ATPrepChangePersistence(), get_rel_sync_entry(), and GetRelationPublicationActions().

{
    List       *result = NIL;
    CatCList   *pubrellist;
    int         i;

    /* Find all publications associated with the relation. */
    pubrellist = SearchSysCacheList1(PUBLICATIONRELMAP,
                                     ObjectIdGetDatum(relid));
    for (i = 0; i < pubrellist->n_members; i++)
    {
        HeapTuple   tup = &pubrellist->members[i]->tuple;
        Oid         pubid = ((Form_pg_publication_rel) GETSTRUCT(tup))->prpubid;

        result = lappend_oid(result, pubid);
    }

    ReleaseSysCacheList(pubrellist);

    return result;
}

Datum pg_get_publication_tables

(

PG_FUNCTION_ARGS

)

Definition at line 445 of file pg_publication.c.

References Publication::alltables, GetAllTablesPublicationRelations(), GetPublicationByName(), GetPublicationRelations(), lfirst_oid, list_head(), lnext, MemoryContextSwitchTo(), FuncCallContext::multi_call_memory_ctx, ObjectIdGetDatum, Publication::oid, palloc(), PG_GETARG_TEXT_PP, SRF_FIRSTCALL_INIT, SRF_IS_FIRSTCALL, SRF_PERCALL_SETUP, SRF_RETURN_DONE, SRF_RETURN_NEXT, text_to_cstring(), and FuncCallContext::user_fctx.

{
    FuncCallContext *funcctx;
    char       *pubname = text_to_cstring(PG_GETARG_TEXT_PP(0));
    Publication *publication;
    List       *tables;
    ListCell  **lcp;

    /* stuff done only on the first call of the function */
    if (SRF_IS_FIRSTCALL())
    {
        MemoryContext oldcontext;

        /* create a function context for cross-call persistence */
        funcctx = SRF_FIRSTCALL_INIT();

        /* switch to memory context appropriate for multiple function calls */
        oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);

        publication = GetPublicationByName(pubname, false);
        if (publication->alltables)
            tables = GetAllTablesPublicationRelations();
        else
            tables = GetPublicationRelations(publication->oid);
        lcp = (ListCell **) palloc(sizeof(ListCell *));
        *lcp = list_head(tables);
        funcctx->user_fctx = (void *) lcp;

        MemoryContextSwitchTo(oldcontext);
    }

    /* stuff done on every call of the function */
    funcctx = SRF_PERCALL_SETUP();
    lcp = (ListCell **) funcctx->user_fctx;

    while (*lcp != NULL)
    {
        Oid         relid = lfirst_oid(*lcp);

        *lcp = lnext(*lcp);
        SRF_RETURN_NEXT(funcctx, ObjectIdGetDatum(relid));
    }

    SRF_RETURN_DONE(funcctx);
}

ObjectAddress publication_add_relation	(	Oid	pubid,
		Relation	targetrel,
		bool	if_not_exists
	)

Definition at line 136 of file pg_publication.c.

References Anum_pg_publication_rel_prpubid, Anum_pg_publication_rel_prrelid, CacheInvalidateRelcache(), CatalogTupleInsert(), check_publication_add_relation(), DEPENDENCY_AUTO, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, GetPublication(), heap_close, heap_form_tuple(), heap_freetuple(), heap_open(), InvalidObjectAddress, Publication::name, Natts_pg_publication_rel, ObjectAddressSet, ObjectIdGetDatum, PublicationRelationId, PUBLICATIONRELMAP, PublicationRelRelationId, recordDependencyOn(), RelationGetDescr, RelationGetRelationName, RelationGetRelid, RelationRelationId, RowExclusiveLock, SearchSysCacheExists2, and values.

Referenced by PublicationAddTables().

{
    Relation    rel;
    HeapTuple   tup;
    Datum       values[Natts_pg_publication_rel];
    bool        nulls[Natts_pg_publication_rel];
    Oid         relid = RelationGetRelid(targetrel);
    Oid         prrelid;
    Publication *pub = GetPublication(pubid);
    ObjectAddress myself,
                referenced;

    rel = heap_open(PublicationRelRelationId, RowExclusiveLock);

    /*
     * Check for duplicates. Note that this does not really prevent
     * duplicates, it's here just to provide nicer error message in common
     * case. The real protection is the unique key on the catalog.
     */
    if (SearchSysCacheExists2(PUBLICATIONRELMAP, ObjectIdGetDatum(relid),
                              ObjectIdGetDatum(pubid)))
    {
        heap_close(rel, RowExclusiveLock);

        if (if_not_exists)
            return InvalidObjectAddress;

        ereport(ERROR,
                (errcode(ERRCODE_DUPLICATE_OBJECT),
                 errmsg("relation \"%s\" is already member of publication \"%s\"",
                        RelationGetRelationName(targetrel), pub->name)));
    }

    check_publication_add_relation(targetrel);

    /* Form a tuple. */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));

    values[Anum_pg_publication_rel_prpubid - 1] =
        ObjectIdGetDatum(pubid);
    values[Anum_pg_publication_rel_prrelid - 1] =
        ObjectIdGetDatum(relid);

    tup = heap_form_tuple(RelationGetDescr(rel), values, nulls);

    /* Insert tuple into catalog. */
    prrelid = CatalogTupleInsert(rel, tup);
    heap_freetuple(tup);

    ObjectAddressSet(myself, PublicationRelRelationId, prrelid);

    /* Add dependency on the publication */
    ObjectAddressSet(referenced, PublicationRelationId, pubid);
    recordDependencyOn(&myself, &referenced, DEPENDENCY_AUTO);

    /* Add dependency on the relation */
    ObjectAddressSet(referenced, RelationRelationId, relid);
    recordDependencyOn(&myself, &referenced, DEPENDENCY_AUTO);

    /* Close the table. */
    heap_close(rel, RowExclusiveLock);

    /* Invalidate relcache so that publication info is rebuilt. */
    CacheInvalidateRelcache(targetrel);

    return myself;
}

Variable Documentation

FormData_pg_publication

Definition at line 52 of file pg_publication.h.