#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:

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 (IndexInfo indexInfo, AttrMap attrmap)

Oid	GetRelationIdentityOrPK (Relation rel)

Typedef Documentation

◆ LogicalRepRelMapEntry

typedef struct LogicalRepRelMapEntry LogicalRepRelMapEntry

Function Documentation

◆ GetRelationIdentityOrPK()

Oid GetRelationIdentityOrPK ( Relation rel )

Definition at line 851 of file relation.c.

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

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

Referenced by build_tuple_value_details(), check_relation_updatable(), FindLogicalRepLocalIndex(), FindReplTupleInLocalRel(), and RelationFindReplTupleByIndex().

◆ IsIndexUsableForReplicaIdentityFull()

bool IsIndexUsableForReplicaIdentityFull	(	IndexInfo *	indexInfo,
		AttrMap *	attrmap
	)

Definition at line 804 of file relation.c.

 {
     AttrNumber  keycol;
  
     /* Ensure that the index access method has a valid equal strategy */
     if (get_equal_strategy_number_for_am(indexInfo->ii_Am) == InvalidStrategy)
         return false;
  
     /* The index must not be a partial index */
     if (indexInfo->ii_Predicate != NIL)
         return false;
  
     Assert(indexInfo->ii_NumIndexAttrs >= 1);
  
     /* The leftmost index field must not be an expression */
     keycol = indexInfo->ii_IndexAttrNumbers[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;
  
 #ifdef USE_ASSERT_CHECKING
     {
         IndexAmRoutine *amroutine;
  
         /* The given index access method must implement amgettuple. */
         amroutine = GetIndexAmRoutineByAmId(indexInfo->ii_Am, false);
         Assert(amroutine->amgettuple != NULL);
     }
 #endif
  
     return true;
 }

References IndexAmRoutine::amgettuple, Assert, AttrMap::attnums, AttributeNumberIsValid, AttrNumberGetAttrOffset, get_equal_strategy_number_for_am(), GetIndexAmRoutineByAmId(), IndexInfo::ii_Am, IndexInfo::ii_IndexAttrNumbers, IndexInfo::ii_NumIndexAttrs, IndexInfo::ii_Predicate, InvalidStrategy, AttrMap::maplen, and NIL.

Referenced by FindReplTupleInLocalRel(), and FindUsableIndexForReplicaIdentityFull().

◆ logicalrep_partition_open()

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

Definition at line 602 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(remoterel->natts * sizeof(char *));
         entry->remoterel.atttyps = palloc(remoterel->natts * sizeof(Oid));
         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;
 }

Referenced by apply_handle_tuple_routing().

◆ logicalrep_partmap_reset_relmap()

void logicalrep_partmap_reset_relmap ( LogicalRepRelation * remoterel )

Definition at line 540 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 hash_seq_init(), hash_seq_search(), logicalrep_relmap_free_entry(), LogicalRepPartMap, LogicalRepPartMapEntry::relmapentry, LogicalRepRelation::remoteid, and LogicalRepRelMapEntry::remoterel.

Referenced by apply_handle_relation().

◆ logicalrep_rel_close()

void logicalrep_rel_close	(	LogicalRepRelMapEntry *	rel,
		LOCKMODE	lockmode
	)

Definition at line 473 of file relation.c.

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

References 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
	)

Definition at line 327 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;
  
         /* 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->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 || attr->attgenerated)
             {
                 entry->attrmap->attnums[i] = -1;
                 continue;
             }
  
             attnum = logicalrep_rel_att_by_name(remoterel,
                                                 NameStr(attr->attname));
  
             entry->attrmap->attnums[i] = attnum;
             if (attnum >= 0)
                 missingatts = bms_del_member(missingatts, attnum);
         }
  
         logicalrep_report_missing_attrs(remoterel, missingatts);
  
         /* be tidy */
         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;
 }

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 )

Definition at line 164 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(remoterel->natts * sizeof(char *));
     entry->remoterel.atttyps = palloc(remoterel->natts * sizeof(Oid));
     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);
     MemoryContextSwitchTo(oldctx);
 }

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

Referenced by apply_handle_relation(), and copy_table().

Data Structures

Typedefs

Functions