pg_publication.h File Reference

#include "catalog/genbki.h"
#include "catalog/objectaddress.h"
#include "catalog/pg_publication_d.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	PublicationDesc
struct	Publication
struct	PublicationRelInfo

Typedefs
typedef struct PublicationActions	PublicationActions
typedef struct PublicationDesc	PublicationDesc
typedef struct Publication	Publication
typedef struct PublicationRelInfo	PublicationRelInfo
typedef enum PublicationPartOpt	PublicationPartOpt

Enumerations
enum	PublicationPartOpt { PUBLICATION_PART_ROOT , PUBLICATION_PART_LEAF , PUBLICATION_PART_ALL }

Functions
BEGIN_CATALOG_STRUCT	CATALOG (pg_publication, 6104, PublicationRelationId)
	DECLARE_UNIQUE_INDEX_PKEY (pg_publication_oid_index, 6110, PublicationObjectIndexId, pg_publication, btree(oid oid_ops))
	DECLARE_UNIQUE_INDEX (pg_publication_pubname_index, 6111, PublicationNameIndexId, pg_publication, btree(pubname name_ops))
	MAKE_SYSCACHE (PUBLICATIONOID, pg_publication_oid_index, 8)
	MAKE_SYSCACHE (PUBLICATIONNAME, pg_publication_pubname_index, 8)
Publication *	GetPublication (Oid pubid)
Publication *	GetPublicationByName (const char *pubname, bool missing_ok)
List *	GetRelationIncludedPublications (Oid relid)
List *	GetRelationExcludedPublications (Oid relid)
List *	GetIncludedPublicationRelations (Oid pubid, PublicationPartOpt pub_partopt)
List *	GetExcludedPublicationTables (Oid pubid, PublicationPartOpt pub_partopt)
List *	GetAllTablesPublications (void)
List *	GetAllPublicationRelations (Oid pubid, char relkind, bool pubviaroot)
List *	GetPublicationSchemas (Oid pubid)
List *	GetSchemaPublications (Oid schemaid)
List *	GetSchemaPublicationRelations (Oid schemaid, PublicationPartOpt pub_partopt)
List *	GetAllSchemaPublicationRelations (Oid pubid, PublicationPartOpt pub_partopt)
List *	GetPubPartitionOptionRelations (List *result, PublicationPartOpt pub_partopt, Oid relid)
Oid	GetTopMostAncestorInPublication (Oid puboid, List *ancestors, int *ancestor_level)
bool	is_publishable_relation (Relation rel)
bool	is_schema_publication (Oid pubid)
bool	is_table_publication (Oid pubid)
bool	check_and_fetch_column_list (Publication *pub, Oid relid, MemoryContext mcxt, Bitmapset **cols)
ObjectAddress	publication_add_relation (Oid pubid, PublicationRelInfo *pri, bool if_not_exists, AlterPublicationStmt *alter_stmt)
Bitmapset *	pub_collist_validate (Relation targetrel, List *columns)
ObjectAddress	publication_add_schema (Oid pubid, Oid schemaid, bool if_not_exists)
Bitmapset *	pub_collist_to_bitmapset (Bitmapset *columns, Datum pubcols, MemoryContext mcxt)
Bitmapset *	pub_form_cols_map (Relation relation, PublishGencolsType include_gencols_type)

Variables
END_CATALOG_STRUCT typedef FormData_pg_publication *	Form_pg_publication
	FormData_pg_publication

Typedef Documentation

Publication

typedef struct Publication Publication

PublicationActions

typedef struct PublicationActions PublicationActions

PublicationDesc

typedef struct PublicationDesc PublicationDesc

PublicationPartOpt

typedef enum PublicationPartOpt PublicationPartOpt

PublicationRelInfo

typedef struct PublicationRelInfo PublicationRelInfo

Enumeration Type Documentation

PublicationPartOpt

enum PublicationPartOpt

Enumerator
PUBLICATION_PART_ROOT
PUBLICATION_PART_LEAF
PUBLICATION_PART_ALL

Definition at line 171 of file pg_publication.h.

{
    PUBLICATION_PART_ROOT,
    PUBLICATION_PART_LEAF,
    PUBLICATION_PART_ALL,
} PublicationPartOpt;

Function Documentation

CATALOG()

BEGIN_CATALOG_STRUCT CATALOG	(	pg_publication	,
		6104	,
		PublicationRelationId
	)

Definition at line 31 of file pg_publication.h.

{
    Oid         oid;            /* oid */
 
    NameData    pubname;        /* name of the publication */
 
    Oid         pubowner BKI_LOOKUP(pg_authid); /* 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;
 
    /*
     * indicates that this is special publication which should encompass all
     * sequences in the database (except for the unlogged and temp ones)
     */
    bool        puballsequences;
 
    /* true if inserts are published */
    bool        pubinsert;
 
    /* true if updates are published */
    bool        pubupdate;
 
    /* true if deletes are published */
    bool        pubdelete;
 
    /* true if truncates are published */
    bool        pubtruncate;
 
    /* true if partition changes are published using root schema */
    bool        pubviaroot;
 
    /*
     * 'n'(none) if generated column data should not be published. 's'(stored)
     * if stored generated column data should be published.
     */
    char        pubgencols;
} FormData_pg_publication;

References BKI_LOOKUP, and fb().

check_and_fetch_column_list()

bool check_and_fetch_column_list ( Publication *  pub, Oid  relid, MemoryContext  mcxt, Bitmapset **  cols  )

extern

Definition at line 363 of file pg_publication.c.

{
    HeapTuple   cftuple;
    bool        found = false;
 
    if (pub->alltables)
        return false;
 
    cftuple = SearchSysCache2(PUBLICATIONRELMAP,
                              ObjectIdGetDatum(relid),
                              ObjectIdGetDatum(pub->oid));
    if (HeapTupleIsValid(cftuple))
    {
        Datum       cfdatum;
        bool        isnull;
 
        /* Lookup the column list attribute. */
        cfdatum = SysCacheGetAttr(PUBLICATIONRELMAP, cftuple,
                                  Anum_pg_publication_rel_prattrs, &isnull);
 
        /* Was a column list found? */
        if (!isnull)
        {
            /* Build the column list bitmap in the given memory context. */
            if (cols)
                *cols = pub_collist_to_bitmapset(*cols, cfdatum, mcxt);
 
            found = true;
        }
 
        ReleaseSysCache(cftuple);
    }
 
    return found;
}

References Publication::alltables, fb(), HeapTupleIsValid, ObjectIdGetDatum(), Publication::oid, pub_collist_to_bitmapset(), ReleaseSysCache(), SearchSysCache2(), and SysCacheGetAttr().

Referenced by check_and_init_gencol(), pgoutput_column_list_init(), and pub_contains_invalid_column().

DECLARE_UNIQUE_INDEX()

DECLARE_UNIQUE_INDEX	(	pg_publication_pubname_index	,
		6111	,
		PublicationNameIndexId	,
		pg_publication	,
		btree(pubname name_ops)
	)

DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY	(	pg_publication_oid_index	,
		6110	,
		PublicationObjectIndexId	,
		pg_publication	,
		btree(oid oid_ops)
	)

GetAllPublicationRelations()

List * GetAllPublicationRelations ( Oid  pubid, char  relkind, bool  pubviaroot  )

extern

Definition at line 1045 of file pg_publication.c.

{
    Relation    classRel;
    ScanKeyData key[1];
    TableScanDesc scan;
    HeapTuple   tuple;
    List       *result = NIL;
    List       *exceptlist = NIL;
 
    Assert(!(relkind == RELKIND_SEQUENCE && pubviaroot));
 
    /* EXCEPT filtering applies only to relations, not sequences */
    if (relkind == RELKIND_RELATION)
        exceptlist = GetExcludedPublicationTables(pubid, pubviaroot ?
                                                  PUBLICATION_PART_ROOT :
                                                  PUBLICATION_PART_LEAF);
 
    classRel = table_open(RelationRelationId, AccessShareLock);
 
    ScanKeyInit(&key[0],
                Anum_pg_class_relkind,
                BTEqualStrategyNumber, F_CHAREQ,
                CharGetDatum(relkind));
 
    scan = table_beginscan_catalog(classRel, 1, key);
 
    while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
    {
        Form_pg_class relForm = (Form_pg_class) GETSTRUCT(tuple);
        Oid         relid = relForm->oid;
 
        if (is_publishable_class(relid, relForm) &&
            !(relForm->relispartition && pubviaroot) &&
            !list_member_oid(exceptlist, relid))
            result = lappend_oid(result, relid);
    }
 
    table_endscan(scan);
 
    if (pubviaroot)
    {
        ScanKeyInit(&key[0],
                    Anum_pg_class_relkind,
                    BTEqualStrategyNumber, F_CHAREQ,
                    CharGetDatum(RELKIND_PARTITIONED_TABLE));
 
        scan = table_beginscan_catalog(classRel, 1, key);
 
        while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
        {
            Form_pg_class relForm = (Form_pg_class) GETSTRUCT(tuple);
            Oid         relid = relForm->oid;
 
            if (is_publishable_class(relid, relForm) &&
                !relForm->relispartition &&
                !list_member_oid(exceptlist, relid))
                result = lappend_oid(result, relid);
        }
 
        table_endscan(scan);
    }
 
    table_close(classRel, AccessShareLock);
    return result;
}

References AccessShareLock, Assert, BTEqualStrategyNumber, CharGetDatum(), fb(), ForwardScanDirection, GetExcludedPublicationTables(), GETSTRUCT(), heap_getnext(), is_publishable_class(), lappend_oid(), list_member_oid(), NIL, PUBLICATION_PART_LEAF, PUBLICATION_PART_ROOT, result, ScanKeyInit(), table_beginscan_catalog(), table_close(), table_endscan(), and table_open().

Referenced by pg_get_publication_sequences(), and pg_get_publication_tables().

GetAllSchemaPublicationRelations()

List * GetAllSchemaPublicationRelations ( Oid  pubid, PublicationPartOpt  pub_partopt  )

extern

Definition at line 1238 of file pg_publication.c.

{
    List       *result = NIL;
    List       *pubschemalist = GetPublicationSchemas(pubid);
    ListCell   *cell;
 
    foreach(cell, pubschemalist)
    {
        Oid         schemaid = lfirst_oid(cell);
        List       *schemaRels = NIL;
 
        schemaRels = GetSchemaPublicationRelations(schemaid, pub_partopt);
        result = list_concat(result, schemaRels);
    }
 
    return result;
}

References fb(), GetPublicationSchemas(), GetSchemaPublicationRelations(), lfirst_oid, list_concat(), NIL, and result.

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

GetAllTablesPublications()

List * GetAllTablesPublications ( void  )

extern

Definition at line 999 of file pg_publication.c.

{
    List       *result;
    Relation    rel;
    ScanKeyData scankey;
    SysScanDesc scan;
    HeapTuple   tup;
 
    /* Find all publications that are marked as for all tables. */
    rel = table_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)))
    {
        Oid         oid = ((Form_pg_publication) GETSTRUCT(tup))->oid;
 
        result = lappend_oid(result, oid);
    }
 
    systable_endscan(scan);
    table_close(rel, AccessShareLock);
 
    return result;
}

References AccessShareLock, BoolGetDatum(), BTEqualStrategyNumber, fb(), Form_pg_publication, GETSTRUCT(), HeapTupleIsValid, InvalidOid, lappend_oid(), NIL, result, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by RelationBuildPublicationDesc().

GetExcludedPublicationTables()

List * GetExcludedPublicationTables ( Oid  pubid, PublicationPartOpt  pub_partopt  )

extern

Definition at line 988 of file pg_publication.c.

{
    Assert(GetPublication(pubid)->alltables);
 
    return get_publication_relations(pubid, pub_partopt, true);
}

References Assert, fb(), get_publication_relations(), and GetPublication().

Referenced by AlterPublicationTables(), and GetAllPublicationRelations().

GetIncludedPublicationRelations()

List * GetIncludedPublicationRelations ( Oid  pubid, PublicationPartOpt  pub_partopt  )

extern

Definition at line 974 of file pg_publication.c.

{
    Assert(!GetPublication(pubid)->alltables);
 
    return get_publication_relations(pubid, pub_partopt, false);
}

References Assert, fb(), get_publication_relations(), and GetPublication().

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

GetPublication()

Publication * GetPublication ( Oid  pubid )

extern

Definition at line 1262 of file pg_publication.c.

{
    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 = palloc_object(Publication);
    pub->oid = pubid;
    pub->name = pstrdup(NameStr(pubform->pubname));
    pub->alltables = pubform->puballtables;
    pub->allsequences = pubform->puballsequences;
    pub->pubactions.pubinsert = pubform->pubinsert;
    pub->pubactions.pubupdate = pubform->pubupdate;
    pub->pubactions.pubdelete = pubform->pubdelete;
    pub->pubactions.pubtruncate = pubform->pubtruncate;
    pub->pubviaroot = pubform->pubviaroot;
    pub->pubgencols_type = pubform->pubgencols;
 
    ReleaseSysCache(tup);
 
    return pub;
}

References Publication::allsequences, Publication::alltables, elog, ERROR, fb(), Form_pg_publication, GETSTRUCT(), HeapTupleIsValid, Publication::name, NameStr, ObjectIdGetDatum(), Publication::oid, palloc_object, pstrdup(), Publication::pubactions, PublicationActions::pubdelete, Publication::pubgencols_type, PublicationActions::pubinsert, PublicationActions::pubtruncate, PublicationActions::pubupdate, Publication::pubviaroot, ReleaseSysCache(), and SearchSysCache1().

Referenced by GetExcludedPublicationTables(), GetIncludedPublicationRelations(), GetPublicationByName(), pg_get_publication_tables(), pub_contains_invalid_column(), publication_add_relation(), and publication_add_schema().

GetPublicationByName()

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

extern

Definition at line 1295 of file pg_publication.c.

{
    Oid         oid;
 
    oid = get_publication_oid(pubname, missing_ok);
 
    return OidIsValid(oid) ? GetPublication(oid) : NULL;
}

References fb(), get_publication_oid(), GetPublication(), and OidIsValid.

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

GetPublicationSchemas()

List * GetPublicationSchemas ( Oid  pubid )

extern

Definition at line 1117 of file pg_publication.c.

{
    List       *result = NIL;
    Relation    pubschsrel;
    ScanKeyData scankey;
    SysScanDesc scan;
    HeapTuple   tup;
 
    /* Find all schemas associated with the publication */
    pubschsrel = table_open(PublicationNamespaceRelationId, AccessShareLock);
 
    ScanKeyInit(&scankey,
                Anum_pg_publication_namespace_pnpubid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(pubid));
 
    scan = systable_beginscan(pubschsrel,
                              PublicationNamespacePnnspidPnpubidIndexId,
                              true, NULL, 1, &scankey);
    while (HeapTupleIsValid(tup = systable_getnext(scan)))
    {
        Form_pg_publication_namespace pubsch;
 
        pubsch = (Form_pg_publication_namespace) GETSTRUCT(tup);
 
        result = lappend_oid(result, pubsch->pnnspid);
    }
 
    systable_endscan(scan);
    table_close(pubschsrel, AccessShareLock);
 
    return result;
}

References AccessShareLock, BTEqualStrategyNumber, fb(), Form_pg_publication_namespace, GETSTRUCT(), HeapTupleIsValid, lappend_oid(), NIL, ObjectIdGetDatum(), result, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by AlterPublicationSchemas(), and GetAllSchemaPublicationRelations().

GetPubPartitionOptionRelations()

List * GetPubPartitionOptionRelations ( List *  result, PublicationPartOpt  pub_partopt, Oid  relid  )

extern

Definition at line 405 of file pg_publication.c.

{
    if (get_rel_relkind(relid) == RELKIND_PARTITIONED_TABLE &&
        pub_partopt != PUBLICATION_PART_ROOT)
    {
        List       *all_parts = find_all_inheritors(relid, NoLock,
                                                    NULL);
 
        if (pub_partopt == PUBLICATION_PART_ALL)
            result = list_concat(result, all_parts);
        else if (pub_partopt == PUBLICATION_PART_LEAF)
        {
            ListCell   *lc;
 
            foreach(lc, all_parts)
            {
                Oid         partOid = lfirst_oid(lc);
 
                if (get_rel_relkind(partOid) != RELKIND_PARTITIONED_TABLE)
                    result = lappend_oid(result, partOid);
            }
        }
        else
            Assert(false);
    }
    else
        result = lappend_oid(result, relid);
 
    return result;
}

References Assert, fb(), find_all_inheritors(), get_rel_relkind(), lappend_oid(), lfirst_oid, list_concat(), NoLock, PUBLICATION_PART_ALL, PUBLICATION_PART_LEAF, PUBLICATION_PART_ROOT, and result.

Referenced by AlterPublicationOptions(), get_publication_relations(), GetSchemaPublicationRelations(), publication_add_relation(), and RemovePublicationRelById().

GetRelationExcludedPublications()

List * GetRelationExcludedPublications ( Oid  relid )

extern

Definition at line 912 of file pg_publication.c.

{
    return get_relation_publications(relid, true);
}

References get_relation_publications().

Referenced by ATExecAttachPartition(), get_rel_sync_entry(), and RelationBuildPublicationDesc().

GetRelationIncludedPublications()

List * GetRelationIncludedPublications ( Oid  relid )

extern

Definition at line 903 of file pg_publication.c.

{
    return get_relation_publications(relid, false);
}

References get_relation_publications().

Referenced by ATExecSetExpression(), ATPrepChangePersistence(), get_rel_sync_entry(), GetTopMostAncestorInPublication(), and RelationBuildPublicationDesc().

GetSchemaPublicationRelations()

List * GetSchemaPublicationRelations ( Oid  schemaid, PublicationPartOpt  pub_partopt  )

extern

Definition at line 1181 of file pg_publication.c.

{
    Relation    classRel;
    ScanKeyData key[1];
    TableScanDesc scan;
    HeapTuple   tuple;
    List       *result = NIL;
 
    Assert(OidIsValid(schemaid));
 
    classRel = table_open(RelationRelationId, AccessShareLock);
 
    ScanKeyInit(&key[0],
                Anum_pg_class_relnamespace,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(schemaid));
 
    /* get all the relations present in the specified schema */
    scan = table_beginscan_catalog(classRel, 1, key);
    while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
    {
        Form_pg_class relForm = (Form_pg_class) GETSTRUCT(tuple);
        Oid         relid = relForm->oid;
        char        relkind;
 
        if (!is_publishable_class(relid, relForm))
            continue;
 
        relkind = get_rel_relkind(relid);
        if (relkind == RELKIND_RELATION)
            result = lappend_oid(result, relid);
        else if (relkind == RELKIND_PARTITIONED_TABLE)
        {
            List       *partitionrels = NIL;
 
            /*
             * It is quite possible that some of the partitions are in a
             * different schema than the parent table, so we need to get such
             * partitions separately.
             */
            partitionrels = GetPubPartitionOptionRelations(partitionrels,
                                                           pub_partopt,
                                                           relForm->oid);
            result = list_concat_unique_oid(result, partitionrels);
        }
    }
 
    table_endscan(scan);
    table_close(classRel, AccessShareLock);
    return result;
}

References AccessShareLock, Assert, BTEqualStrategyNumber, fb(), ForwardScanDirection, get_rel_relkind(), GetPubPartitionOptionRelations(), GETSTRUCT(), heap_getnext(), is_publishable_class(), lappend_oid(), list_concat_unique_oid(), NIL, ObjectIdGetDatum(), OidIsValid, result, ScanKeyInit(), table_beginscan_catalog(), table_close(), table_endscan(), and table_open().

Referenced by GetAllSchemaPublicationRelations(), publication_add_schema(), and RemovePublicationSchemaById().

GetSchemaPublications()

List * GetSchemaPublications ( Oid  schemaid )

extern

Definition at line 1155 of file pg_publication.c.

{
    List       *result = NIL;
    CatCList   *pubschlist;
    int         i;
 
    /* Find all publications associated with the schema */
    pubschlist = SearchSysCacheList1(PUBLICATIONNAMESPACEMAP,
                                     ObjectIdGetDatum(schemaid));
    for (i = 0; i < pubschlist->n_members; i++)
    {
        HeapTuple   tup = &pubschlist->members[i]->tuple;
        Oid         pubid = ((Form_pg_publication_namespace) GETSTRUCT(tup))->pnpubid;
 
        result = lappend_oid(result, pubid);
    }
 
    ReleaseSysCacheList(pubschlist);
 
    return result;
}

References fb(), Form_pg_publication_namespace, GETSTRUCT(), i, lappend_oid(), NIL, ObjectIdGetDatum(), ReleaseSysCacheList, result, and SearchSysCacheList1.

Referenced by get_rel_sync_entry(), GetTopMostAncestorInPublication(), and RelationBuildPublicationDesc().

GetTopMostAncestorInPublication()

Oid GetTopMostAncestorInPublication ( Oid  puboid, List *  ancestors, int *  ancestor_level  )

extern

Definition at line 449 of file pg_publication.c.

{
    ListCell   *lc;
    Oid         topmost_relid = InvalidOid;
    int         level = 0;
 
    /*
     * Find the "topmost" ancestor that is in this publication.
     */
    foreach(lc, ancestors)
    {
        Oid         ancestor = lfirst_oid(lc);
        List       *apubids = GetRelationIncludedPublications(ancestor);
        List       *aschemaPubids = NIL;
 
        level++;
 
        if (list_member_oid(apubids, puboid))
        {
            topmost_relid = ancestor;
 
            if (ancestor_level)
                *ancestor_level = level;
        }
        else
        {
            aschemaPubids = GetSchemaPublications(get_rel_namespace(ancestor));
            if (list_member_oid(aschemaPubids, puboid))
            {
                topmost_relid = ancestor;
 
                if (ancestor_level)
                    *ancestor_level = level;
            }
        }
 
        list_free(apubids);
        list_free(aschemaPubids);
    }
 
    return topmost_relid;
}

References fb(), get_rel_namespace(), GetRelationIncludedPublications(), GetSchemaPublications(), InvalidOid, lfirst_oid, list_free(), list_member_oid(), and NIL.

Referenced by get_rel_sync_entry(), is_table_publishable_in_publication(), pub_contains_invalid_column(), and pub_rf_contains_invalid_column().

is_publishable_relation()

bool is_publishable_relation ( Relation  rel )

extern

Definition at line 168 of file pg_publication.c.

{
    return is_publishable_class(RelationGetRelid(rel), rel->rd_rel);
}

References is_publishable_class(), RelationData::rd_rel, and RelationGetRelid.

Referenced by pgoutput_change(), pgoutput_truncate(), and RelationBuildPublicationDesc().

is_schema_publication()

bool is_schema_publication ( Oid  pubid )

extern

Definition at line 285 of file pg_publication.c.

{
    Relation    pubschsrel;
    ScanKeyData scankey;
    SysScanDesc scan;
    HeapTuple   tup;
    bool        result = false;
 
    pubschsrel = table_open(PublicationNamespaceRelationId, AccessShareLock);
    ScanKeyInit(&scankey,
                Anum_pg_publication_namespace_pnpubid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(pubid));
 
    scan = systable_beginscan(pubschsrel,
                              PublicationNamespacePnnspidPnpubidIndexId,
                              true, NULL, 1, &scankey);
    tup = systable_getnext(scan);
    result = HeapTupleIsValid(tup);
 
    systable_endscan(scan);
    table_close(pubschsrel, AccessShareLock);
 
    return result;
}

References AccessShareLock, BTEqualStrategyNumber, fb(), HeapTupleIsValid, ObjectIdGetDatum(), result, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by AlterPublicationOwner_internal(), AlterPublicationTables(), and CheckAlterPublication().

is_table_publication()

bool is_table_publication ( Oid  pubid )

extern

Definition at line 316 of file pg_publication.c.

{
    Relation    pubrelsrel;
    ScanKeyData scankey;
    SysScanDesc scan;
    HeapTuple   tup;
    bool        result = false;
 
    pubrelsrel = table_open(PublicationRelRelationId, AccessShareLock);
    ScanKeyInit(&scankey,
                Anum_pg_publication_rel_prpubid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(pubid));
 
    scan = systable_beginscan(pubrelsrel,
                              PublicationRelPrpubidIndexId,
                              true, NULL, 1, &scankey);
    tup = systable_getnext(scan);
    if (HeapTupleIsValid(tup))
    {
        Form_pg_publication_rel pubrel;
 
        pubrel = (Form_pg_publication_rel) GETSTRUCT(tup);
 
        /*
         * For any publication, pg_publication_rel contains either only EXCEPT
         * entries or only explicitly included tables. Therefore, examining
         * the first tuple is sufficient to determine table inclusion.
         */
        result = !pubrel->prexcept;
    }
 
    systable_endscan(scan);
    table_close(pubrelsrel, AccessShareLock);
 
    return result;
}

References AccessShareLock, BTEqualStrategyNumber, fb(), Form_pg_publication_rel, GETSTRUCT(), HeapTupleIsValid, ObjectIdGetDatum(), result, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by CheckAlterPublication().

MAKE_SYSCACHE() [1/2]

MAKE_SYSCACHE	(	PUBLICATIONNAME	,
		pg_publication_pubname_index	,
		8
	)

MAKE_SYSCACHE() [2/2]

MAKE_SYSCACHE	(	PUBLICATIONOID	,
		pg_publication_oid_index	,
		8
	)

pub_collist_to_bitmapset()

Bitmapset * pub_collist_to_bitmapset ( Bitmapset *  columns, Datum  pubcols, MemoryContext  mcxt  )

extern

Definition at line 724 of file pg_publication.c.

{
    Bitmapset  *result = columns;
    ArrayType  *arr;
    int         nelems;
    int16      *elems;
    MemoryContext oldcxt = NULL;
 
    arr = DatumGetArrayTypeP(pubcols);
    nelems = ARR_DIMS(arr)[0];
    elems = (int16 *) ARR_DATA_PTR(arr);
 
    /* If a memory context was specified, switch to it. */
    if (mcxt)
        oldcxt = MemoryContextSwitchTo(mcxt);
 
    for (int i = 0; i < nelems; i++)
        result = bms_add_member(result, elems[i]);
 
    if (mcxt)
        MemoryContextSwitchTo(oldcxt);
 
    return result;
}

References ARR_DATA_PTR, ARR_DIMS, bms_add_member(), DatumGetArrayTypeP, fb(), i, MemoryContextSwitchTo(), and result.

Referenced by AlterPublicationTables(), and check_and_fetch_column_list().

pub_collist_validate()

Bitmapset * pub_collist_validate ( Relation  targetrel, List *  columns  )

extern

Definition at line 675 of file pg_publication.c.

{
    Bitmapset  *set = NULL;
    ListCell   *lc;
    TupleDesc   tupdesc = RelationGetDescr(targetrel);
 
    foreach(lc, columns)
    {
        char       *colname = strVal(lfirst(lc));
        AttrNumber  attnum = get_attnum(RelationGetRelid(targetrel), colname);
 
        if (attnum == InvalidAttrNumber)
            ereport(ERROR,
                    errcode(ERRCODE_UNDEFINED_COLUMN),
                    errmsg("column \"%s\" of relation \"%s\" does not exist",
                           colname, RelationGetRelationName(targetrel)));
 
        if (!AttrNumberIsForUserDefinedAttr(attnum))
            ereport(ERROR,
                    errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
                    errmsg("cannot use system column \"%s\" in publication column list",
                           colname));
 
        if (TupleDescAttr(tupdesc, attnum - 1)->attgenerated == ATTRIBUTE_GENERATED_VIRTUAL)
            ereport(ERROR,
                    errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
                    errmsg("cannot use virtual generated column \"%s\" in publication column list",
                           colname));
 
        if (bms_is_member(attnum, set))
            ereport(ERROR,
                    errcode(ERRCODE_DUPLICATE_OBJECT),
                    errmsg("duplicate column \"%s\" in publication column list",
                           colname));
 
        set = bms_add_member(set, attnum);
    }
 
    return set;
}

References attnum, AttrNumberIsForUserDefinedAttr, bms_add_member(), bms_is_member(), ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg, ERROR, fb(), get_attnum(), InvalidAttrNumber, lfirst, RelationGetDescr, RelationGetRelationName, RelationGetRelid, strVal, and TupleDescAttr().

Referenced by AlterPublicationTables(), and publication_add_relation().

pub_form_cols_map()

Bitmapset * pub_form_cols_map ( Relation  relation, PublishGencolsType  include_gencols_type  )

extern

Definition at line 756 of file pg_publication.c.

{
    Bitmapset  *result = NULL;
    TupleDesc   desc = RelationGetDescr(relation);
 
    for (int i = 0; i < desc->natts; i++)
    {
        Form_pg_attribute att = TupleDescAttr(desc, i);
 
        if (att->attisdropped)
            continue;
 
        if (att->attgenerated)
        {
            /* We only support replication of STORED generated cols. */
            if (att->attgenerated != ATTRIBUTE_GENERATED_STORED)
                continue;
 
            /* User hasn't requested to replicate STORED generated cols. */
            if (include_gencols_type != PUBLISH_GENCOLS_STORED)
                continue;
        }
 
        result = bms_add_member(result, att->attnum);
    }
 
    return result;
}

References bms_add_member(), fb(), i, TupleDescData::natts, RelationGetDescr, result, and TupleDescAttr().

Referenced by pgoutput_column_list_init().

publication_add_relation()

ObjectAddress publication_add_relation ( Oid  pubid, PublicationRelInfo *  pri, bool  if_not_exists, AlterPublicationStmt *  alter_stmt  )

extern

Definition at line 523 of file pg_publication.c.

{
    Relation    rel;
    HeapTuple   tup;
    Datum       values[Natts_pg_publication_rel];
    bool        nulls[Natts_pg_publication_rel];
    Relation    targetrel = pri->relation;
    Oid         relid = RelationGetRelid(targetrel);
    Oid         pubreloid;
    Bitmapset  *attnums;
    Publication *pub = GetPublication(pubid);
    ObjectAddress myself,
                referenced;
    List       *relids = NIL;
    int         i;
    bool        inval_except_table;
 
    rel = table_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)))
    {
        table_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(pri);
 
    /* Validate and translate column names into a Bitmapset of attnums. */
    attnums = pub_collist_validate(pri->relation, pri->columns);
 
    /* Form a tuple. */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));
 
    pubreloid = GetNewOidWithIndex(rel, PublicationRelObjectIndexId,
                                   Anum_pg_publication_rel_oid);
    values[Anum_pg_publication_rel_oid - 1] = ObjectIdGetDatum(pubreloid);
    values[Anum_pg_publication_rel_prpubid - 1] =
        ObjectIdGetDatum(pubid);
    values[Anum_pg_publication_rel_prrelid - 1] =
        ObjectIdGetDatum(relid);
    values[Anum_pg_publication_rel_prexcept - 1] =
        BoolGetDatum(pri->except);
 
    /* Add qualifications, if available */
    if (pri->whereClause != NULL)
        values[Anum_pg_publication_rel_prqual - 1] = CStringGetTextDatum(nodeToString(pri->whereClause));
    else
        nulls[Anum_pg_publication_rel_prqual - 1] = true;
 
    /* Add column list, if available */
    if (pri->columns)
        values[Anum_pg_publication_rel_prattrs - 1] = PointerGetDatum(attnumstoint2vector(attnums));
    else
        nulls[Anum_pg_publication_rel_prattrs - 1] = true;
 
    tup = heap_form_tuple(RelationGetDescr(rel), values, nulls);
 
    /* Insert tuple into catalog. */
    CatalogTupleInsert(rel, tup);
    heap_freetuple(tup);
 
    /* Register dependencies as needed */
    ObjectAddressSet(myself, PublicationRelRelationId, pubreloid);
 
    /* 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);
 
    /* Add dependency on the objects mentioned in the qualifications */
    if (pri->whereClause)
        recordDependencyOnSingleRelExpr(&myself, pri->whereClause, relid,
                                        DEPENDENCY_NORMAL, DEPENDENCY_NORMAL,
                                        false);
 
    /* Add dependency on the columns, if any are listed */
    i = -1;
    while ((i = bms_next_member(attnums, i)) >= 0)
    {
        ObjectAddressSubSet(referenced, RelationRelationId, relid, i);
        recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
    }
 
    /* Close the table. */
    table_close(rel, RowExclusiveLock);
 
    /*
     * Determine whether EXCEPT tables require explicit relcache invalidation.
     *
     * For CREATE PUBLICATION with EXCEPT tables, invalidation is skipped
     * here, as CreatePublication() function invalidates all relations as part
     * of defining a FOR ALL TABLES publication.
     *
     * For ALTER PUBLICATION, invalidation is needed only when adding an
     * EXCEPT table to a publication already marked as ALL TABLES. For
     * publications that were originally empty or defined as ALL SEQUENCES and
     * are being converted to ALL TABLES, invalidation is skipped here, as
     * AlterPublicationAllFlags() function invalidates all relations while
     * marking the publication as ALL TABLES publication.
     */
    inval_except_table = (alter_stmt != NULL) && pub->alltables &&
        (alter_stmt->for_all_tables && pri->except);
 
    if (!pri->except || inval_except_table)
    {
        /*
         * Invalidate relcache so that publication info is rebuilt.
         *
         * For the partitioned tables, we must invalidate all partitions
         * contained in the respective partition hierarchies, not just the one
         * explicitly mentioned in the publication. This is required because
         * we implicitly publish the child tables when the parent table is
         * published.
         */
        relids = GetPubPartitionOptionRelations(relids, PUBLICATION_PART_ALL,
                                                relid);
 
        InvalidatePublicationRels(relids);
    }
 
    return myself;
}

References Publication::alltables, attnumstoint2vector(), bms_next_member(), BoolGetDatum(), CatalogTupleInsert(), check_publication_add_relation(), CStringGetTextDatum, DEPENDENCY_AUTO, DEPENDENCY_NORMAL, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg, ERROR, fb(), GetNewOidWithIndex(), GetPublication(), GetPubPartitionOptionRelations(), heap_form_tuple(), heap_freetuple(), i, InvalidatePublicationRels(), InvalidObjectAddress, Publication::name, NIL, nodeToString(), ObjectAddressSet, ObjectAddressSubSet, ObjectIdGetDatum(), PointerGetDatum, pub_collist_validate(), PUBLICATION_PART_ALL, recordDependencyOn(), recordDependencyOnSingleRelExpr(), RelationGetDescr, RelationGetRelationName, RelationGetRelid, RowExclusiveLock, SearchSysCacheExists2, table_close(), table_open(), and values.

Referenced by PublicationAddTables().

publication_add_schema()

ObjectAddress publication_add_schema ( Oid  pubid, Oid  schemaid, bool  if_not_exists  )

extern

Definition at line 789 of file pg_publication.c.

{
    Relation    rel;
    HeapTuple   tup;
    Datum       values[Natts_pg_publication_namespace];
    bool        nulls[Natts_pg_publication_namespace];
    Oid         psschid;
    Publication *pub = GetPublication(pubid);
    List       *schemaRels = NIL;
    ObjectAddress myself,
                referenced;
 
    rel = table_open(PublicationNamespaceRelationId, 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(PUBLICATIONNAMESPACEMAP,
                              ObjectIdGetDatum(schemaid),
                              ObjectIdGetDatum(pubid)))
    {
        table_close(rel, RowExclusiveLock);
 
        if (if_not_exists)
            return InvalidObjectAddress;
 
        ereport(ERROR,
                (errcode(ERRCODE_DUPLICATE_OBJECT),
                 errmsg("schema \"%s\" is already member of publication \"%s\"",
                        get_namespace_name(schemaid), pub->name)));
    }
 
    check_publication_add_schema(schemaid);
 
    /* Form a tuple */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));
 
    psschid = GetNewOidWithIndex(rel, PublicationNamespaceObjectIndexId,
                                 Anum_pg_publication_namespace_oid);
    values[Anum_pg_publication_namespace_oid - 1] = ObjectIdGetDatum(psschid);
    values[Anum_pg_publication_namespace_pnpubid - 1] =
        ObjectIdGetDatum(pubid);
    values[Anum_pg_publication_namespace_pnnspid - 1] =
        ObjectIdGetDatum(schemaid);
 
    tup = heap_form_tuple(RelationGetDescr(rel), values, nulls);
 
    /* Insert tuple into catalog */
    CatalogTupleInsert(rel, tup);
    heap_freetuple(tup);
 
    ObjectAddressSet(myself, PublicationNamespaceRelationId, psschid);
 
    /* Add dependency on the publication */
    ObjectAddressSet(referenced, PublicationRelationId, pubid);
    recordDependencyOn(&myself, &referenced, DEPENDENCY_AUTO);
 
    /* Add dependency on the schema */
    ObjectAddressSet(referenced, NamespaceRelationId, schemaid);
    recordDependencyOn(&myself, &referenced, DEPENDENCY_AUTO);
 
    /* Close the table */
    table_close(rel, RowExclusiveLock);
 
    /*
     * Invalidate relcache so that publication info is rebuilt. See
     * publication_add_relation for why we need to consider all the
     * partitions.
     */
    schemaRels = GetSchemaPublicationRelations(schemaid,
                                               PUBLICATION_PART_ALL);
    InvalidatePublicationRels(schemaRels);
 
    return myself;
}

References CatalogTupleInsert(), check_publication_add_schema(), DEPENDENCY_AUTO, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg, ERROR, fb(), get_namespace_name(), GetNewOidWithIndex(), GetPublication(), GetSchemaPublicationRelations(), heap_form_tuple(), heap_freetuple(), InvalidatePublicationRels(), InvalidObjectAddress, Publication::name, NIL, ObjectAddressSet, ObjectIdGetDatum(), PUBLICATION_PART_ALL, recordDependencyOn(), RelationGetDescr, RowExclusiveLock, SearchSysCacheExists2, table_close(), table_open(), and values.

Referenced by PublicationAddSchemas().

Variable Documentation

Form_pg_publication

END_CATALOG_STRUCT typedef FormData_pg_publication* Form_pg_publication

Definition at line 80 of file pg_publication.h.

Referenced by AlterObjectRename_internal(), AlterPublication(), AlterPublicationAllFlags(), AlterPublicationOptions(), AlterPublicationOwner(), AlterPublicationOwner_internal(), AlterPublicationSchemas(), AlterPublicationTables(), CheckAlterPublication(), get_publication_name(), GetAllTablesPublications(), GetPublication(), RelationBuildPublicationDesc(), and RemovePublicationById().

FormData_pg_publication

FormData_pg_publication

Definition at line 71 of file pg_publication.h.