logicalrelation.h File Reference

#include "access/attmap.h"
#include "catalog/index.h"
#include "replication/logicalproto.h"

Include dependency graph for logicalrelation.h:

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

Go to the source code of this file.

Data Structures
struct	LogicalRepRelMapEntry

Typedefs
typedef struct LogicalRepRelMapEntry	LogicalRepRelMapEntry

Functions
void	logicalrep_relmap_update (LogicalRepRelation *remoterel)
void	logicalrep_partmap_reset_relmap (LogicalRepRelation *remoterel)
LogicalRepRelMapEntry *	logicalrep_rel_open (LogicalRepRelId remoteid, LOCKMODE lockmode)
LogicalRepRelMapEntry *	logicalrep_partition_open (LogicalRepRelMapEntry *root, Relation partrel, AttrMap *map)
void	logicalrep_rel_close (LogicalRepRelMapEntry *rel, LOCKMODE lockmode)
bool	IsIndexUsableForReplicaIdentityFull (Relation idxrel, AttrMap *attrmap)
Oid	GetRelationIdentityOrPK (Relation rel)

Typedef Documentation

LogicalRepRelMapEntry

typedef struct LogicalRepRelMapEntry LogicalRepRelMapEntry

Function Documentation

GetRelationIdentityOrPK()

Oid GetRelationIdentityOrPK ( Relation  rel )

extern

Definition at line 905 of file relation.c.

{
    Oid         idxoid;
 
    idxoid = RelationGetReplicaIndex(rel);
 
    if (!OidIsValid(idxoid))
        idxoid = RelationGetPrimaryKeyIndex(rel, false);
 
    return idxoid;
}

References fb(), OidIsValid, RelationGetPrimaryKeyIndex(), and RelationGetReplicaIndex().

Referenced by check_relation_updatable(), FindLogicalRepLocalIndex(), FindReplTupleInLocalRel(), get_tuple_desc(), RelationFindDeletedTupleInfoByIndex(), and RelationFindReplTupleByIndex().

IsIndexUsableForReplicaIdentityFull()

bool IsIndexUsableForReplicaIdentityFull ( Relation  idxrel, AttrMap *  attrmap  )

extern

Definition at line 835 of file relation.c.

{
    AttrNumber  keycol;
    oidvector  *indclass;
 
    /* The index must not be a partial index */
    if (!heap_attisnull(idxrel->rd_indextuple, Anum_pg_index_indpred, NULL))
        return false;
 
    Assert(idxrel->rd_index->indnatts >= 1);
 
    indclass = (oidvector *) DatumGetPointer(SysCacheGetAttrNotNull(INDEXRELID,
                                                                    idxrel->rd_indextuple,
                                                                    Anum_pg_index_indclass));
 
    /* Ensure that the index has a valid equal strategy for each key column */
    for (int i = 0; i < idxrel->rd_index->indnkeyatts; i++)
    {
        Oid         opfamily;
 
        opfamily = get_opclass_family(indclass->values[i]);
        if (IndexAmTranslateCompareType(COMPARE_EQ, idxrel->rd_rel->relam, opfamily, true) == InvalidStrategy)
            return false;
    }
 
    /*
     * For indexes other than PK and REPLICA IDENTITY, we need to match the
     * local and remote tuples.  The equality routine tuples_equal() cannot
     * accept a data type where the type cache cannot provide an equality
     * operator.
     */
    for (int i = 0; i < idxrel->rd_att->natts; i++)
    {
        TypeCacheEntry *typentry;
 
        typentry = lookup_type_cache(TupleDescAttr(idxrel->rd_att, i)->atttypid, TYPECACHE_EQ_OPR_FINFO);
        if (!OidIsValid(typentry->eq_opr_finfo.fn_oid))
            return false;
    }
 
    /* The leftmost index field must not be an expression */
    keycol = idxrel->rd_index->indkey.values[0];
    if (!AttributeNumberIsValid(keycol))
        return false;
 
    /*
     * And the leftmost index field must reference the remote relation column.
     * This is because if it doesn't, the sequential scan is favorable over
     * index scan in most cases.
     */
    if (attrmap->maplen <= AttrNumberGetAttrOffset(keycol) ||
        attrmap->attnums[AttrNumberGetAttrOffset(keycol)] < 0)
        return false;
 
    /*
     * The given index access method must implement "amgettuple", which will
     * be used later to fetch the tuples.  See RelationFindReplTupleByIndex().
     */
    if (GetIndexAmRoutineByAmId(idxrel->rd_rel->relam, false)->amgettuple == NULL)
        return false;
 
    return true;
}

References IndexAmRoutine::amgettuple, Assert, AttrMap::attnums, AttributeNumberIsValid, AttrNumberGetAttrOffset, COMPARE_EQ, DatumGetPointer(), TypeCacheEntry::eq_opr_finfo, fb(), FmgrInfo::fn_oid, get_opclass_family(), GetIndexAmRoutineByAmId(), heap_attisnull(), i, IndexAmTranslateCompareType(), InvalidStrategy, lookup_type_cache(), AttrMap::maplen, OidIsValid, SysCacheGetAttrNotNull(), TupleDescAttr(), and TYPECACHE_EQ_OPR_FINFO.

Referenced by FindReplTupleInLocalRel(), and FindUsableIndexForReplicaIdentityFull().

logicalrep_partition_open()

LogicalRepRelMapEntry * logicalrep_partition_open ( LogicalRepRelMapEntry *  root, Relation  partrel, AttrMap *  map  )

extern

Definition at line 647 of file relation.c.

{
    LogicalRepRelMapEntry *entry;
    LogicalRepPartMapEntry *part_entry;
    LogicalRepRelation *remoterel = &root->remoterel;
    Oid         partOid = RelationGetRelid(partrel);
    AttrMap    *attrmap = root->attrmap;
    bool        found;
    MemoryContext oldctx;
 
    if (LogicalRepPartMap == NULL)
        logicalrep_partmap_init();
 
    /* Search for existing entry. */
    part_entry = (LogicalRepPartMapEntry *) hash_search(LogicalRepPartMap,
                                                        &partOid,
                                                        HASH_ENTER, &found);
 
    entry = &part_entry->relmapentry;
 
    /*
     * We must always overwrite entry->localrel with the latest partition
     * Relation pointer, because the Relation pointed to by the old value may
     * have been cleared after the caller would have closed the partition
     * relation after the last use of this entry.  Note that localrelvalid is
     * only updated by the relcache invalidation callback, so it may still be
     * true irrespective of whether the Relation pointed to by localrel has
     * been cleared or not.
     */
    if (found && entry->localrelvalid)
    {
        entry->localrel = partrel;
        return entry;
    }
 
    /* Switch to longer-lived context. */
    oldctx = MemoryContextSwitchTo(LogicalRepPartMapContext);
 
    if (!found)
    {
        memset(part_entry, 0, sizeof(LogicalRepPartMapEntry));
        part_entry->partoid = partOid;
    }
 
    /* Release the no-longer-useful attrmap, if any. */
    if (entry->attrmap)
    {
        free_attrmap(entry->attrmap);
        entry->attrmap = NULL;
    }
 
    if (!entry->remoterel.remoteid)
    {
        int         i;
 
        /* Remote relation is copied as-is from the root entry. */
        entry->remoterel.remoteid = remoterel->remoteid;
        entry->remoterel.nspname = pstrdup(remoterel->nspname);
        entry->remoterel.relname = pstrdup(remoterel->relname);
        entry->remoterel.natts = remoterel->natts;
        entry->remoterel.attnames = palloc_array(char *, remoterel->natts);
        entry->remoterel.atttyps = palloc_array(Oid, remoterel->natts);
        for (i = 0; i < remoterel->natts; i++)
        {
            entry->remoterel.attnames[i] = pstrdup(remoterel->attnames[i]);
            entry->remoterel.atttyps[i] = remoterel->atttyps[i];
        }
        entry->remoterel.replident = remoterel->replident;
        entry->remoterel.attkeys = bms_copy(remoterel->attkeys);
    }
 
    entry->localrel = partrel;
    entry->localreloid = partOid;
 
    /*
     * If the partition's attributes don't match the root relation's, we'll
     * need to make a new attrmap which maps partition attribute numbers to
     * remoterel's, instead of the original which maps root relation's
     * attribute numbers to remoterel's.
     *
     * Note that 'map' which comes from the tuple routing data structure
     * contains 1-based attribute numbers (of the parent relation).  However,
     * the map in 'entry', a logical replication data structure, contains
     * 0-based attribute numbers (of the remote relation).
     */
    if (map)
    {
        AttrNumber  attno;
 
        entry->attrmap = make_attrmap(map->maplen);
        for (attno = 0; attno < entry->attrmap->maplen; attno++)
        {
            AttrNumber  root_attno = map->attnums[attno];
 
            /* 0 means it's a dropped attribute.  See comments atop AttrMap. */
            if (root_attno == 0)
                entry->attrmap->attnums[attno] = -1;
            else
                entry->attrmap->attnums[attno] = attrmap->attnums[root_attno - 1];
        }
    }
    else
    {
        /* Lacking copy_attmap, do this the hard way. */
        entry->attrmap = make_attrmap(attrmap->maplen);
        memcpy(entry->attrmap->attnums, attrmap->attnums,
               attrmap->maplen * sizeof(AttrNumber));
    }
 
    /* Set if the table's replica identity is enough to apply update/delete. */
    logicalrep_rel_mark_updatable(entry);
 
    /* state and statelsn are left set to 0. */
    MemoryContextSwitchTo(oldctx);
 
    /*
     * Finding a usable index is an infrequent task. It occurs when an
     * operation is first performed on the relation, or after invalidation of
     * the relation cache entry (such as ANALYZE or CREATE/DROP index on the
     * relation).
     *
     * We also prefer to run this code on the oldctx so that we do not leak
     * anything in the LogicalRepPartMapContext (hence CacheMemoryContext).
     */
    entry->localindexoid = FindLogicalRepLocalIndex(partrel, remoterel,
                                                    entry->attrmap);
 
    entry->localrelvalid = true;
 
    return entry;
}

References LogicalRepRelation::attkeys, LogicalRepRelation::attnames, AttrMap::attnums, LogicalRepRelMapEntry::attrmap, LogicalRepRelation::atttyps, bms_copy(), fb(), FindLogicalRepLocalIndex(), free_attrmap(), HASH_ENTER, hash_search(), i, LogicalRepRelMapEntry::localindexoid, LogicalRepRelMapEntry::localrel, LogicalRepRelMapEntry::localreloid, LogicalRepRelMapEntry::localrelvalid, logicalrep_partmap_init(), logicalrep_rel_mark_updatable(), LogicalRepPartMap, LogicalRepPartMapContext, make_attrmap(), AttrMap::maplen, MemoryContextSwitchTo(), LogicalRepRelation::natts, LogicalRepRelation::nspname, palloc_array, pstrdup(), RelationGetRelid, LogicalRepRelation::relname, LogicalRepRelation::remoteid, LogicalRepRelMapEntry::remoterel, LogicalRepRelation::replident, and root.

Referenced by apply_handle_tuple_routing().

logicalrep_partmap_reset_relmap()

void logicalrep_partmap_reset_relmap ( LogicalRepRelation *  remoterel )

extern

Definition at line 585 of file relation.c.

{
    HASH_SEQ_STATUS status;
    LogicalRepPartMapEntry *part_entry;
    LogicalRepRelMapEntry *entry;
 
    if (LogicalRepPartMap == NULL)
        return;
 
    hash_seq_init(&status, LogicalRepPartMap);
    while ((part_entry = (LogicalRepPartMapEntry *) hash_seq_search(&status)) != NULL)
    {
        entry = &part_entry->relmapentry;
 
        if (entry->remoterel.remoteid != remoterel->remoteid)
            continue;
 
        logicalrep_relmap_free_entry(entry);
 
        memset(entry, 0, sizeof(LogicalRepRelMapEntry));
    }
}

References fb(), hash_seq_init(), hash_seq_search(), logicalrep_relmap_free_entry(), LogicalRepPartMap, LogicalRepRelation::remoteid, and LogicalRepRelMapEntry::remoterel.

Referenced by apply_handle_relation().

logicalrep_rel_close()

void logicalrep_rel_close ( LogicalRepRelMapEntry *  rel, LOCKMODE  lockmode  )

extern

Definition at line 518 of file relation.c.

{
    table_close(rel->localrel, lockmode);
    rel->localrel = NULL;
}

References fb(), LogicalRepRelMapEntry::localrel, and table_close().

Referenced by apply_handle_delete(), apply_handle_insert(), apply_handle_truncate(), apply_handle_update(), and copy_table().

logicalrep_rel_open()

LogicalRepRelMapEntry * logicalrep_rel_open ( LogicalRepRelId  remoteid, LOCKMODE  lockmode  )

extern

Definition at line 362 of file relation.c.

{
    LogicalRepRelMapEntry *entry;
    bool        found;
    LogicalRepRelation *remoterel;
 
    if (LogicalRepRelMap == NULL)
        logicalrep_relmap_init();
 
    /* Search for existing entry. */
    entry = hash_search(LogicalRepRelMap, &remoteid,
                        HASH_FIND, &found);
 
    if (!found)
        elog(ERROR, "no relation map entry for remote relation ID %u",
             remoteid);
 
    remoterel = &entry->remoterel;
 
    /* Ensure we don't leak a relcache refcount. */
    if (entry->localrel)
        elog(ERROR, "remote relation ID %u is already open", remoteid);
 
    /*
     * When opening and locking a relation, pending invalidation messages are
     * processed which can invalidate the relation.  Hence, if the entry is
     * currently considered valid, try to open the local relation by OID and
     * see if invalidation ensues.
     */
    if (entry->localrelvalid)
    {
        entry->localrel = try_table_open(entry->localreloid, lockmode);
        if (!entry->localrel)
        {
            /* Table was renamed or dropped. */
            entry->localrelvalid = false;
        }
        else if (!entry->localrelvalid)
        {
            /* Note we release the no-longer-useful lock here. */
            table_close(entry->localrel, lockmode);
            entry->localrel = NULL;
        }
    }
 
    /*
     * If the entry has been marked invalid since we last had lock on it,
     * re-open the local relation by name and rebuild all derived data.
     */
    if (!entry->localrelvalid)
    {
        Oid         relid;
        TupleDesc   desc;
        MemoryContext oldctx;
        int         i;
        Bitmapset  *missingatts;
        Bitmapset  *generatedattrs = NULL;
 
        /* Release the no-longer-useful attrmap, if any. */
        if (entry->attrmap)
        {
            free_attrmap(entry->attrmap);
            entry->attrmap = NULL;
        }
 
        /* Try to find and lock the relation by name. */
        relid = RangeVarGetRelid(makeRangeVar(remoterel->nspname,
                                              remoterel->relname, -1),
                                 lockmode, true);
        if (!OidIsValid(relid))
            ereport(ERROR,
                    (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                     errmsg("logical replication target relation \"%s.%s\" does not exist",
                            remoterel->nspname, remoterel->relname)));
        entry->localrel = table_open(relid, NoLock);
        entry->localreloid = relid;
 
        /* Check for supported relkind. */
        CheckSubscriptionRelkind(entry->localrel->rd_rel->relkind,
                                 remoterel->relkind,
                                 remoterel->nspname, remoterel->relname);
 
        /*
         * Build the mapping of local attribute numbers to remote attribute
         * numbers and validate that we don't miss any replicated columns as
         * that would result in potentially unwanted data loss.
         */
        desc = RelationGetDescr(entry->localrel);
        oldctx = MemoryContextSwitchTo(LogicalRepRelMapContext);
        entry->attrmap = make_attrmap(desc->natts);
        MemoryContextSwitchTo(oldctx);
 
        /* check and report missing attrs, if any */
        missingatts = bms_add_range(NULL, 0, remoterel->natts - 1);
        for (i = 0; i < desc->natts; i++)
        {
            int         attnum;
            Form_pg_attribute attr = TupleDescAttr(desc, i);
 
            if (attr->attisdropped)
            {
                entry->attrmap->attnums[i] = -1;
                continue;
            }
 
            attnum = logicalrep_rel_att_by_name(remoterel,
                                                NameStr(attr->attname));
 
            entry->attrmap->attnums[i] = attnum;
            if (attnum >= 0)
            {
                /* Remember which subscriber columns are generated. */
                if (attr->attgenerated)
                    generatedattrs = bms_add_member(generatedattrs, attnum);
 
                missingatts = bms_del_member(missingatts, attnum);
            }
        }
 
        logicalrep_report_missing_or_gen_attrs(remoterel, missingatts,
                                               generatedattrs);
 
        /* be tidy */
        bms_free(generatedattrs);
        bms_free(missingatts);
 
        /*
         * Set if the table's replica identity is enough to apply
         * update/delete.
         */
        logicalrep_rel_mark_updatable(entry);
 
        /*
         * Finding a usable index is an infrequent task. It occurs when an
         * operation is first performed on the relation, or after invalidation
         * of the relation cache entry (such as ANALYZE or CREATE/DROP index
         * on the relation).
         */
        entry->localindexoid = FindLogicalRepLocalIndex(entry->localrel, remoterel,
                                                        entry->attrmap);
 
        entry->localrelvalid = true;
    }
 
    if (entry->state != SUBREL_STATE_READY)
        entry->state = GetSubscriptionRelState(MySubscription->oid,
                                               entry->localreloid,
                                               &entry->statelsn);
 
    return entry;
}

References attnum, AttrMap::attnums, LogicalRepRelMapEntry::attrmap, bms_add_member(), bms_add_range(), bms_del_member(), bms_free(), CheckSubscriptionRelkind(), elog, ereport, errcode(), errmsg(), ERROR, fb(), FindLogicalRepLocalIndex(), free_attrmap(), GetSubscriptionRelState(), HASH_FIND, hash_search(), i, LogicalRepRelMapEntry::localindexoid, LogicalRepRelMapEntry::localrel, LogicalRepRelMapEntry::localreloid, LogicalRepRelMapEntry::localrelvalid, logicalrep_rel_att_by_name(), logicalrep_rel_mark_updatable(), logicalrep_relmap_init(), logicalrep_report_missing_or_gen_attrs(), LogicalRepRelMap, LogicalRepRelMapContext, make_attrmap(), makeRangeVar(), MemoryContextSwitchTo(), MySubscription, NameStr, TupleDescData::natts, LogicalRepRelation::natts, NoLock, LogicalRepRelation::nspname, Subscription::oid, OidIsValid, RangeVarGetRelid, RelationData::rd_rel, RelationGetDescr, LogicalRepRelation::relkind, LogicalRepRelation::relname, LogicalRepRelMapEntry::remoterel, LogicalRepRelMapEntry::state, LogicalRepRelMapEntry::statelsn, table_close(), table_open(), try_table_open(), and TupleDescAttr().

Referenced by apply_handle_delete(), apply_handle_insert(), apply_handle_truncate(), apply_handle_update(), and copy_table().

logicalrep_relmap_update()

void logicalrep_relmap_update ( LogicalRepRelation *  remoterel )

extern

Definition at line 165 of file relation.c.

{
    MemoryContext oldctx;
    LogicalRepRelMapEntry *entry;
    bool        found;
    int         i;
 
    if (LogicalRepRelMap == NULL)
        logicalrep_relmap_init();
 
    /*
     * HASH_ENTER returns the existing entry if present or creates a new one.
     */
    entry = hash_search(LogicalRepRelMap, &remoterel->remoteid,
                        HASH_ENTER, &found);
 
    if (found)
        logicalrep_relmap_free_entry(entry);
 
    memset(entry, 0, sizeof(LogicalRepRelMapEntry));
 
    /* Make cached copy of the data */
    oldctx = MemoryContextSwitchTo(LogicalRepRelMapContext);
    entry->remoterel.remoteid = remoterel->remoteid;
    entry->remoterel.nspname = pstrdup(remoterel->nspname);
    entry->remoterel.relname = pstrdup(remoterel->relname);
    entry->remoterel.natts = remoterel->natts;
    entry->remoterel.attnames = palloc_array(char *, remoterel->natts);
    entry->remoterel.atttyps = palloc_array(Oid, remoterel->natts);
    for (i = 0; i < remoterel->natts; i++)
    {
        entry->remoterel.attnames[i] = pstrdup(remoterel->attnames[i]);
        entry->remoterel.atttyps[i] = remoterel->atttyps[i];
    }
    entry->remoterel.replident = remoterel->replident;
 
    /*
     * XXX The walsender currently does not transmit the relkind of the remote
     * relation when replicating changes. Since we support replicating only
     * table changes at present, we default to initializing relkind as
     * RELKIND_RELATION. This is needed in CheckSubscriptionRelkind() to check
     * if the publisher and subscriber relation kinds are compatible.
     */
    entry->remoterel.relkind =
        (remoterel->relkind == 0) ? RELKIND_RELATION : remoterel->relkind;
 
    entry->remoterel.attkeys = bms_copy(remoterel->attkeys);
    MemoryContextSwitchTo(oldctx);
}

References LogicalRepRelation::attkeys, LogicalRepRelation::attnames, LogicalRepRelation::atttyps, bms_copy(), fb(), HASH_ENTER, hash_search(), i, logicalrep_relmap_free_entry(), logicalrep_relmap_init(), LogicalRepRelMap, LogicalRepRelMapContext, MemoryContextSwitchTo(), LogicalRepRelation::natts, LogicalRepRelation::nspname, palloc_array, pstrdup(), LogicalRepRelation::relkind, LogicalRepRelation::relname, LogicalRepRelation::remoteid, LogicalRepRelMapEntry::remoterel, and LogicalRepRelation::replident.

Referenced by apply_handle_relation(), and copy_table().