pg_subscription_rel.h File Reference

#include "access/xlogdefs.h"
#include "catalog/genbki.h"
#include "catalog/pg_subscription_rel_d.h"
#include "nodes/pg_list.h"

Include dependency graph for pg_subscription_rel.h:

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

Go to the source code of this file.

Data Structures
struct	SubscriptionRelState
struct	LogicalRepSequenceInfo

Typedefs
typedef struct SubscriptionRelState	SubscriptionRelState
typedef struct LogicalRepSequenceInfo	LogicalRepSequenceInfo

Functions
BEGIN_CATALOG_STRUCT	CATALOG (pg_subscription_rel, 6102, SubscriptionRelRelationId)
	DECLARE_UNIQUE_INDEX_PKEY (pg_subscription_rel_srrelid_srsubid_index, 6117, SubscriptionRelSrrelidSrsubidIndexId, pg_subscription_rel, btree(srrelid oid_ops, srsubid oid_ops))
	MAKE_SYSCACHE (SUBSCRIPTIONRELMAP, pg_subscription_rel_srrelid_srsubid_index, 64)
void	AddSubscriptionRelState (Oid subid, Oid relid, char state, XLogRecPtr sublsn, bool retain_lock)
void	UpdateSubscriptionRelState (Oid subid, Oid relid, char state, XLogRecPtr sublsn, bool already_locked)
char	GetSubscriptionRelState (Oid subid, Oid relid, XLogRecPtr *sublsn)
void	RemoveSubscriptionRel (Oid subid, Oid relid)
bool	HasSubscriptionTables (Oid subid)
List *	GetSubscriptionRelations (Oid subid, bool tables, bool sequences, bool not_ready)
void	UpdateDeadTupleRetentionStatus (Oid subid, bool active)

Variables
END_CATALOG_STRUCT typedef FormData_pg_subscription_rel *	Form_pg_subscription_rel
	FormData_pg_subscription_rel

Typedef Documentation

LogicalRepSequenceInfo

typedef struct LogicalRepSequenceInfo LogicalRepSequenceInfo

SubscriptionRelState

typedef struct SubscriptionRelState SubscriptionRelState

Function Documentation

AddSubscriptionRelState()

void AddSubscriptionRelState ( Oid  subid, Oid  relid, char  state, XLogRecPtr  sublsn, bool  retain_lock  )

extern

Definition at line 304 of file pg_subscription.c.

{
    Relation    rel;
    HeapTuple   tup;
    bool        nulls[Natts_pg_subscription_rel];
    Datum       values[Natts_pg_subscription_rel];
 
    LockSharedObject(SubscriptionRelationId, subid, 0, AccessShareLock);
 
    rel = table_open(SubscriptionRelRelationId, RowExclusiveLock);
 
    /* Try finding existing mapping. */
    tup = SearchSysCacheCopy2(SUBSCRIPTIONRELMAP,
                              ObjectIdGetDatum(relid),
                              ObjectIdGetDatum(subid));
    if (HeapTupleIsValid(tup))
        elog(ERROR, "subscription relation %u in subscription %u already exists",
             relid, subid);
 
    /* Form the tuple. */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));
    values[Anum_pg_subscription_rel_srsubid - 1] = ObjectIdGetDatum(subid);
    values[Anum_pg_subscription_rel_srrelid - 1] = ObjectIdGetDatum(relid);
    values[Anum_pg_subscription_rel_srsubstate - 1] = CharGetDatum(state);
    if (XLogRecPtrIsValid(sublsn))
        values[Anum_pg_subscription_rel_srsublsn - 1] = LSNGetDatum(sublsn);
    else
        nulls[Anum_pg_subscription_rel_srsublsn - 1] = true;
 
    tup = heap_form_tuple(RelationGetDescr(rel), values, nulls);
 
    /* Insert tuple into catalog. */
    CatalogTupleInsert(rel, tup);
 
    heap_freetuple(tup);
 
    /* Cleanup. */
    if (retain_lock)
    {
        table_close(rel, NoLock);
    }
    else
    {
        table_close(rel, RowExclusiveLock);
        UnlockSharedObject(SubscriptionRelationId, subid, 0, AccessShareLock);
    }
}

References AccessShareLock, CatalogTupleInsert(), CharGetDatum(), elog, ERROR, fb(), heap_form_tuple(), heap_freetuple(), HeapTupleIsValid, LockSharedObject(), LSNGetDatum(), NoLock, ObjectIdGetDatum(), RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy2, table_close(), table_open(), UnlockSharedObject(), values, and XLogRecPtrIsValid.

Referenced by AlterSubscription_refresh(), binary_upgrade_add_sub_rel_state(), and CreateSubscription().

CATALOG()

BEGIN_CATALOG_STRUCT CATALOG	(	pg_subscription_rel	,
		6102	,
		SubscriptionRelRelationId
	)

Definition at line 33 of file pg_subscription_rel.h.

{
    Oid         srsubid BKI_LOOKUP(pg_subscription);    /* Oid of subscription */
    Oid         srrelid BKI_LOOKUP(pg_class);   /* Oid of relation */
    char        srsubstate;     /* state of the relation in subscription */
 
    /*
     * Although srsublsn is a fixed-width type, it is allowed to be NULL, so
     * we prevent direct C code access to it just as for a varlena field.
     */
#ifdef CATALOG_VARLEN           /* variable-length fields start here */
 
    XLogRecPtr  srsublsn BKI_FORCE_NULL;    /* remote LSN of the state change
                                             * used for synchronization
                                             * coordination, or NULL if not
                                             * valid */
#endif
} FormData_pg_subscription_rel;

References BKI_FORCE_NULL, BKI_LOOKUP, and fb().

DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY	(	pg_subscription_rel_srrelid_srsubid_index	,
		6117	,
		SubscriptionRelSrrelidSrsubidIndexId	,
		pg_subscription_rel	,
		btree(srrelid oid_ops, srsubid oid_ops)
	)

GetSubscriptionRelations()

List * GetSubscriptionRelations ( Oid  subid, bool  tables, bool  sequences, bool  not_ready  )

extern

Definition at line 602 of file pg_subscription.c.

{
    List       *res = NIL;
    Relation    rel;
    HeapTuple   tup;
    int         nkeys = 0;
    ScanKeyData skey[2];
    SysScanDesc scan;
 
    /* One or both of 'tables' and 'sequences' must be true. */
    Assert(tables || sequences);
 
    rel = table_open(SubscriptionRelRelationId, AccessShareLock);
 
    ScanKeyInit(&skey[nkeys++],
                Anum_pg_subscription_rel_srsubid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(subid));
 
    if (not_ready)
        ScanKeyInit(&skey[nkeys++],
                    Anum_pg_subscription_rel_srsubstate,
                    BTEqualStrategyNumber, F_CHARNE,
                    CharGetDatum(SUBREL_STATE_READY));
 
    scan = systable_beginscan(rel, InvalidOid, false,
                              NULL, nkeys, skey);
 
    while (HeapTupleIsValid(tup = systable_getnext(scan)))
    {
        Form_pg_subscription_rel subrel;
        SubscriptionRelState *relstate;
        Datum       d;
        bool        isnull;
        char        relkind;
 
        subrel = (Form_pg_subscription_rel) GETSTRUCT(tup);
 
        /* Relation is either a sequence or a table */
        relkind = get_rel_relkind(subrel->srrelid);
        Assert(relkind == RELKIND_SEQUENCE || relkind == RELKIND_RELATION ||
               relkind == RELKIND_PARTITIONED_TABLE);
 
        /* Skip sequences if they were not requested */
        if ((relkind == RELKIND_SEQUENCE) && !sequences)
            continue;
 
        /* Skip tables if they were not requested */
        if ((relkind == RELKIND_RELATION ||
             relkind == RELKIND_PARTITIONED_TABLE) && !tables)
            continue;
 
        relstate = palloc_object(SubscriptionRelState);
        relstate->relid = subrel->srrelid;
        relstate->state = subrel->srsubstate;
        d = SysCacheGetAttr(SUBSCRIPTIONRELMAP, tup,
                            Anum_pg_subscription_rel_srsublsn, &isnull);
        if (isnull)
            relstate->lsn = InvalidXLogRecPtr;
        else
            relstate->lsn = DatumGetLSN(d);
 
        res = lappend(res, relstate);
    }
 
    /* Cleanup */
    systable_endscan(scan);
    table_close(rel, AccessShareLock);
 
    return res;
}

References AccessShareLock, Assert, BTEqualStrategyNumber, CharGetDatum(), DatumGetLSN(), fb(), Form_pg_subscription_rel, get_rel_relkind(), GETSTRUCT(), HeapTupleIsValid, InvalidOid, InvalidXLogRecPtr, lappend(), SubscriptionRelState::lsn, NIL, ObjectIdGetDatum(), palloc_object, SubscriptionRelState::relid, ScanKeyInit(), sequences, SubscriptionRelState::state, SysCacheGetAttr(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by AlterSubscription_refresh(), AlterSubscription_refresh_seq(), DropSubscription(), and FetchRelationStates().

GetSubscriptionRelState()

char GetSubscriptionRelState ( Oid  subid, Oid  relid, XLogRecPtr *  sublsn  )

extern

Definition at line 424 of file pg_subscription.c.

{
    HeapTuple   tup;
    char        substate;
    bool        isnull;
    Datum       d;
    Relation    rel;
 
    /*
     * This is to avoid the race condition with AlterSubscription which tries
     * to remove this relstate.
     */
    rel = table_open(SubscriptionRelRelationId, AccessShareLock);
 
    /* Try finding the mapping. */
    tup = SearchSysCache2(SUBSCRIPTIONRELMAP,
                          ObjectIdGetDatum(relid),
                          ObjectIdGetDatum(subid));
 
    if (!HeapTupleIsValid(tup))
    {
        table_close(rel, AccessShareLock);
        *sublsn = InvalidXLogRecPtr;
        return SUBREL_STATE_UNKNOWN;
    }
 
    /* Get the state. */
    substate = ((Form_pg_subscription_rel) GETSTRUCT(tup))->srsubstate;
 
    /* Get the LSN */
    d = SysCacheGetAttr(SUBSCRIPTIONRELMAP, tup,
                        Anum_pg_subscription_rel_srsublsn, &isnull);
    if (isnull)
        *sublsn = InvalidXLogRecPtr;
    else
        *sublsn = DatumGetLSN(d);
 
    /* Cleanup */
    ReleaseSysCache(tup);
 
    table_close(rel, AccessShareLock);
 
    return substate;
}

References AccessShareLock, DatumGetLSN(), fb(), Form_pg_subscription_rel, GETSTRUCT(), HeapTupleIsValid, InvalidXLogRecPtr, ObjectIdGetDatum(), ReleaseSysCache(), SearchSysCache2(), SysCacheGetAttr(), table_close(), and table_open().

Referenced by AlterSubscription_refresh(), logicalrep_rel_open(), LogicalRepSyncTableStart(), and wait_for_table_state_change().

HasSubscriptionTables()

bool HasSubscriptionTables ( Oid  subid )

extern

Definition at line 553 of file pg_subscription.c.

{
    Relation    rel;
    ScanKeyData skey[1];
    SysScanDesc scan;
    HeapTuple   tup;
    bool        has_subtables = false;
 
    rel = table_open(SubscriptionRelRelationId, AccessShareLock);
 
    ScanKeyInit(&skey[0],
                Anum_pg_subscription_rel_srsubid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(subid));
 
    scan = systable_beginscan(rel, InvalidOid, false,
                              NULL, 1, skey);
 
    while (HeapTupleIsValid(tup = systable_getnext(scan)))
    {
        Form_pg_subscription_rel subrel;
        char        relkind;
 
        subrel = (Form_pg_subscription_rel) GETSTRUCT(tup);
        relkind = get_rel_relkind(subrel->srrelid);
 
        if (relkind == RELKIND_RELATION ||
            relkind == RELKIND_PARTITIONED_TABLE)
        {
            has_subtables = true;
            break;
        }
    }
 
    /* Cleanup */
    systable_endscan(scan);
    table_close(rel, AccessShareLock);
 
    return has_subtables;
}

References AccessShareLock, BTEqualStrategyNumber, fb(), Form_pg_subscription_rel, get_rel_relkind(), GETSTRUCT(), HeapTupleIsValid, InvalidOid, ObjectIdGetDatum(), ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by FetchRelationStates().

MAKE_SYSCACHE()

MAKE_SYSCACHE	(	SUBSCRIPTIONRELMAP	,
		pg_subscription_rel_srrelid_srsubid_index	,
		64
	)

RemoveSubscriptionRel()

void RemoveSubscriptionRel ( Oid  subid, Oid  relid  )

extern

Definition at line 474 of file pg_subscription.c.

{
    Relation    rel;
    TableScanDesc scan;
    ScanKeyData skey[2];
    HeapTuple   tup;
    int         nkeys = 0;
 
    rel = table_open(SubscriptionRelRelationId, RowExclusiveLock);
 
    if (OidIsValid(subid))
    {
        ScanKeyInit(&skey[nkeys++],
                    Anum_pg_subscription_rel_srsubid,
                    BTEqualStrategyNumber,
                    F_OIDEQ,
                    ObjectIdGetDatum(subid));
    }
 
    if (OidIsValid(relid))
    {
        ScanKeyInit(&skey[nkeys++],
                    Anum_pg_subscription_rel_srrelid,
                    BTEqualStrategyNumber,
                    F_OIDEQ,
                    ObjectIdGetDatum(relid));
    }
 
    /* Do the search and delete what we found. */
    scan = table_beginscan_catalog(rel, nkeys, skey);
    while (HeapTupleIsValid(tup = heap_getnext(scan, ForwardScanDirection)))
    {
        Form_pg_subscription_rel subrel;
 
        subrel = (Form_pg_subscription_rel) GETSTRUCT(tup);
 
        /*
         * We don't allow to drop the relation mapping when the table
         * synchronization is in progress unless the caller updates the
         * corresponding subscription as well. This is to ensure that we don't
         * leave tablesync slots or origins in the system when the
         * corresponding table is dropped. For sequences, however, it's ok to
         * drop them since no separate slots or origins are created during
         * synchronization.
         */
        if (!OidIsValid(subid) &&
            subrel->srsubstate != SUBREL_STATE_READY &&
            get_rel_relkind(subrel->srrelid) != RELKIND_SEQUENCE)
        {
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("could not drop relation mapping for subscription \"%s\"",
                            get_subscription_name(subrel->srsubid, false)),
                     errdetail("Table synchronization for relation \"%s\" is in progress and is in state \"%c\".",
                               get_rel_name(relid), subrel->srsubstate),
 
            /*
             * translator: first %s is a SQL ALTER command and second %s is a
             * SQL DROP command
             */
                     errhint("Use %s to enable subscription if not already enabled or use %s to drop the subscription.",
                             "ALTER SUBSCRIPTION ... ENABLE",
                             "DROP SUBSCRIPTION ...")));
        }
 
        CatalogTupleDelete(rel, &tup->t_self);
    }
    table_endscan(scan);
 
    table_close(rel, RowExclusiveLock);
}

References BTEqualStrategyNumber, CatalogTupleDelete(), ereport, errcode(), errdetail(), errhint(), errmsg, ERROR, fb(), Form_pg_subscription_rel, ForwardScanDirection, get_rel_name(), get_rel_relkind(), get_subscription_name(), GETSTRUCT(), heap_getnext(), HeapTupleIsValid, ObjectIdGetDatum(), OidIsValid, RowExclusiveLock, ScanKeyInit(), table_beginscan_catalog(), table_close(), table_endscan(), and table_open().

Referenced by AlterSubscription_refresh(), DropSubscription(), and heap_drop_with_catalog().

UpdateDeadTupleRetentionStatus()

void UpdateDeadTupleRetentionStatus ( Oid  subid, bool  active  )

extern

Definition at line 679 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);
 
    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_subretentionactive - 1] = active;
    replaces[Anum_pg_subscription_subretentionactive - 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, CatalogTupleUpdate(), elog, ERROR, fb(), heap_freetuple(), heap_modify_tuple(), HeapTupleIsValid, LockSharedObject(), NoLock, ObjectIdGetDatum(), RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy1, table_close(), table_open(), and values.

Referenced by update_retention_status().

UpdateSubscriptionRelState()

void UpdateSubscriptionRelState ( Oid  subid, Oid  relid, char  state, XLogRecPtr  sublsn, bool  already_locked  )

extern

Definition at line 358 of file pg_subscription.c.

{
    Relation    rel;
    HeapTuple   tup;
    bool        nulls[Natts_pg_subscription_rel];
    Datum       values[Natts_pg_subscription_rel];
    bool        replaces[Natts_pg_subscription_rel];
 
    if (already_locked)
    {
#ifdef USE_ASSERT_CHECKING
        LOCKTAG     tag;
 
        Assert(CheckRelationOidLockedByMe(SubscriptionRelRelationId,
                                          RowExclusiveLock, true));
        SET_LOCKTAG_OBJECT(tag, InvalidOid, SubscriptionRelationId, subid, 0);
        Assert(LockHeldByMe(&tag, AccessShareLock, true));
#endif
 
        rel = table_open(SubscriptionRelRelationId, NoLock);
    }
    else
    {
        LockSharedObject(SubscriptionRelationId, subid, 0, AccessShareLock);
        rel = table_open(SubscriptionRelRelationId, RowExclusiveLock);
    }
 
    /* Try finding existing mapping. */
    tup = SearchSysCacheCopy2(SUBSCRIPTIONRELMAP,
                              ObjectIdGetDatum(relid),
                              ObjectIdGetDatum(subid));
    if (!HeapTupleIsValid(tup))
        elog(ERROR, "subscription relation %u in subscription %u does not exist",
             relid, subid);
 
    /* Update the tuple. */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));
    memset(replaces, false, sizeof(replaces));
 
    replaces[Anum_pg_subscription_rel_srsubstate - 1] = true;
    values[Anum_pg_subscription_rel_srsubstate - 1] = CharGetDatum(state);
 
    replaces[Anum_pg_subscription_rel_srsublsn - 1] = true;
    if (XLogRecPtrIsValid(sublsn))
        values[Anum_pg_subscription_rel_srsublsn - 1] = LSNGetDatum(sublsn);
    else
        nulls[Anum_pg_subscription_rel_srsublsn - 1] = true;
 
    tup = heap_modify_tuple(tup, RelationGetDescr(rel), values, nulls,
                            replaces);
 
    /* Update the catalog. */
    CatalogTupleUpdate(rel, &tup->t_self, tup);
 
    /* Cleanup. */
    table_close(rel, NoLock);
}

References AccessShareLock, Assert, CatalogTupleUpdate(), CharGetDatum(), CheckRelationOidLockedByMe(), elog, ERROR, fb(), heap_modify_tuple(), HeapTupleIsValid, InvalidOid, LockHeldByMe(), LockSharedObject(), LSNGetDatum(), NoLock, ObjectIdGetDatum(), RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy2, SET_LOCKTAG_OBJECT, table_close(), table_open(), values, and XLogRecPtrIsValid.

Referenced by AlterSubscription_refresh_seq(), copy_sequence(), LogicalRepSyncTableStart(), ProcessSyncingTablesForApply(), and ProcessSyncingTablesForSync().

Variable Documentation

Form_pg_subscription_rel

END_CATALOG_STRUCT typedef FormData_pg_subscription_rel* Form_pg_subscription_rel

Definition at line 54 of file pg_subscription_rel.h.

Referenced by GetSubscriptionRelations(), GetSubscriptionRelState(), HasSubscriptionTables(), LogicalRepSyncSequences(), and RemoveSubscriptionRel().

FormData_pg_subscription_rel

FormData_pg_subscription_rel

Definition at line 50 of file pg_subscription_rel.h.