conflict.h File Reference

#include "access/xlogdefs.h"
#include "datatype/timestamp.h"
#include "nodes/pg_list.h"

Include dependency graph for conflict.h:

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

Go to the source code of this file.

Data Structures
struct	ConflictTupleInfo

Macros
#define	CONFLICT_NUM_TYPES   (CT_MULTIPLE_UNIQUE_CONFLICTS + 1)
#define	CONFLICTS_LOGGED_TO_TABLE(dest)    ((dest == CONFLICT_LOG_DEST_TABLE) || (dest == CONFLICT_LOG_DEST_ALL))
#define	CONFLICTS_LOGGED_TO_LOG(dest)    ((dest == CONFLICT_LOG_DEST_LOG) || (dest == CONFLICT_LOG_DEST_ALL))

Typedefs
typedef struct EState	EState
typedef struct ResultRelInfo	ResultRelInfo
typedef struct TupleTableSlot	TupleTableSlot
typedef struct ConflictTupleInfo	ConflictTupleInfo
typedef enum ConflictLogDest	ConflictLogDest

Enumerations
enum	ConflictType {   CT_INSERT_EXISTS , CT_UPDATE_ORIGIN_DIFFERS , CT_UPDATE_EXISTS , CT_UPDATE_DELETED ,   CT_UPDATE_MISSING , CT_DELETE_ORIGIN_DIFFERS , CT_DELETE_MISSING , CT_MULTIPLE_UNIQUE_CONFLICTS }
enum	ConflictLogDest { CONFLICT_LOG_DEST_LOG = 0 , CONFLICT_LOG_DEST_TABLE , CONFLICT_LOG_DEST_ALL }

Functions
Oid	create_conflict_log_table (Oid subid, char *subname, Oid subowner)
ConflictLogDest	GetConflictLogDest (const char *dest)
bool	GetTupleTransactionInfo (TupleTableSlot *localslot, TransactionId *xmin, ReplOriginId *localorigin, TimestampTz *localts)
void	ReportApplyConflict (EState *estate, ResultRelInfo *relinfo, int elevel, ConflictType type, TupleTableSlot *searchslot, TupleTableSlot *remoteslot, List *conflicttuples)
void	InitConflictIndexes (ResultRelInfo *relInfo)

Variables
PGDLLIMPORT const char *const	ConflictLogDestNames []

Macro Definition Documentation

CONFLICT_NUM_TYPES

#define CONFLICT_NUM_TYPES   (CT_MULTIPLE_UNIQUE_CONFLICTS + 1)

Definition at line 64 of file conflict.h.

CONFLICTS_LOGGED_TO_LOG

#define CONFLICTS_LOGGED_TO_LOG

(

dest

)

((dest == CONFLICT_LOG_DEST_LOG) || (dest == CONFLICT_LOG_DEST_ALL))

Definition at line 98 of file conflict.h.

CONFLICTS_LOGGED_TO_TABLE

#define CONFLICTS_LOGGED_TO_TABLE

(

dest

)

((dest == CONFLICT_LOG_DEST_TABLE) || (dest == CONFLICT_LOG_DEST_ALL))

Definition at line 96 of file conflict.h.

Typedef Documentation

ConflictLogDest

typedef enum ConflictLogDest ConflictLogDest

ConflictTupleInfo

typedef struct ConflictTupleInfo ConflictTupleInfo

EState

typedef struct EState EState

Definition at line 17 of file conflict.h.

ResultRelInfo

typedef struct ResultRelInfo ResultRelInfo

Definition at line 18 of file conflict.h.

TupleTableSlot

typedef struct TupleTableSlot TupleTableSlot

Definition at line 19 of file conflict.h.

Enumeration Type Documentation

ConflictLogDest

enum ConflictLogDest

Enumerator
CONFLICT_LOG_DEST_LOG
CONFLICT_LOG_DEST_TABLE
CONFLICT_LOG_DEST_ALL

Definition at line 89 of file conflict.h.

{
    CONFLICT_LOG_DEST_LOG = 0,  /* Emit to server logs */
    CONFLICT_LOG_DEST_TABLE,    /* Insert into the conflict log table */
    CONFLICT_LOG_DEST_ALL       /* Both log and table */
} ConflictLogDest;

ConflictType

enum ConflictType

Enumerator
CT_INSERT_EXISTS
CT_UPDATE_ORIGIN_DIFFERS
CT_UPDATE_EXISTS
CT_UPDATE_DELETED
CT_UPDATE_MISSING
CT_DELETE_ORIGIN_DIFFERS
CT_DELETE_MISSING
CT_MULTIPLE_UNIQUE_CONFLICTS

Definition at line 31 of file conflict.h.

{
    /* The row to be inserted violates unique constraint */
    CT_INSERT_EXISTS,
 
    /* The row to be updated was modified by a different origin */
    CT_UPDATE_ORIGIN_DIFFERS,
 
    /* The updated row value violates unique constraint */
    CT_UPDATE_EXISTS,
 
    /* The row to be updated was concurrently deleted by a different origin */
    CT_UPDATE_DELETED,
 
    /* The row to be updated is missing */
    CT_UPDATE_MISSING,
 
    /* The row to be deleted was modified by a different origin */
    CT_DELETE_ORIGIN_DIFFERS,
 
    /* The row to be deleted is missing */
    CT_DELETE_MISSING,
 
    /* The row to be inserted/updated violates multiple unique constraint */
    CT_MULTIPLE_UNIQUE_CONFLICTS,
 
    /*
     * Other conflicts, such as exclusion constraint violations, involve more
     * complex rules than simple equality checks. These conflicts are left for
     * future improvements.
     */
} ConflictType;

Function Documentation

create_conflict_log_table()

Oid create_conflict_log_table ( Oid  subid, char *  subname, Oid  subowner  )

extern

Definition at line 147 of file conflict.c.

{
    TupleDesc   tupdesc;
    Oid         relid;
    char        relname[NAMEDATALEN];
 
    snprintf(relname, NAMEDATALEN, "pg_conflict_log_%u", subid);
 
    /* Build the tuple descriptor for the new table. */
    tupdesc = create_conflict_log_table_tupdesc();
 
    /* Create conflict log table. */
    relid = heap_create_with_catalog(relname,
                                     PG_CONFLICT_NAMESPACE,
                                     0, /* tablespace */
                                     InvalidOid,    /* relid */
                                     InvalidOid,    /* reltypeid */
                                     InvalidOid,    /* reloftypeid */
                                     subowner,
                                     HEAP_TABLE_AM_OID,
                                     tupdesc,
                                     NIL,
                                     RELKIND_RELATION,
                                     RELPERSISTENCE_PERMANENT,
                                     false, /* shared_relation */
                                     false, /* mapped_relation */
                                     ONCOMMIT_NOOP,
                                     (Datum) 0, /* reloptions */
                                     false, /* use_user_acl */
                                     false, /* allow_system_table_mods */
                                     true,  /* is_internal */
                                     InvalidOid,    /* relrewrite */
                                     NULL); /* typaddress */
    Assert(OidIsValid(relid));
 
    /* Release tuple descriptor memory. */
    FreeTupleDesc(tupdesc);
 
    /*
     * We must bump the command counter to make the newly-created relation
     * tuple visible for opening.
     */
    CommandCounterIncrement();
 
    /*
     * Create a TOAST table for the conflict log to support out-of-line
     * storage of large json data.
     */
    NewRelationCreateToastTable(relid, (Datum) 0);
 
    ereport(NOTICE,
            (errmsg("created conflict log table \"%s\" for subscription \"%s\"",
                    get_qualified_objname(PG_CONFLICT_NAMESPACE, relname),
                    subname)));
 
    return relid;
}

References Assert, CommandCounterIncrement(), create_conflict_log_table_tupdesc(), ereport, errmsg, fb(), FreeTupleDesc(), get_qualified_objname(), heap_create_with_catalog(), InvalidOid, NAMEDATALEN, NewRelationCreateToastTable(), NIL, NOTICE, OidIsValid, ONCOMMIT_NOOP, relname, snprintf, and subname.

Referenced by alter_sub_conflict_log_dest().

GetConflictLogDest()

ConflictLogDest GetConflictLogDest ( const char *  dest )

extern

Definition at line 210 of file conflict.c.

{
    /* NULL defaults to LOG. */
    if (dest == NULL || pg_strcasecmp(dest, "log") == 0)
        return CONFLICT_LOG_DEST_LOG;
 
    if (pg_strcasecmp(dest, "table") == 0)
        return CONFLICT_LOG_DEST_TABLE;
 
    if (pg_strcasecmp(dest, "all") == 0)
        return CONFLICT_LOG_DEST_ALL;
 
    /* Unrecognized string. */
    ereport(ERROR,
            (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
             errmsg("unrecognized conflict_log_destination value: \"%s\"", dest),
             errhint("Valid values are \"log\", \"table\", and \"all\".")));
}

References CONFLICT_LOG_DEST_ALL, CONFLICT_LOG_DEST_LOG, CONFLICT_LOG_DEST_TABLE, ereport, errcode(), errhint(), errmsg, ERROR, fb(), and pg_strcasecmp().

Referenced by AlterSubscription(), and parse_subscription_options().

GetTupleTransactionInfo()

bool GetTupleTransactionInfo ( TupleTableSlot *  localslot, TransactionId *  xmin, ReplOriginId *  localorigin, TimestampTz *  localts  )

extern

Definition at line 236 of file conflict.c.

{
    Datum       xminDatum;
    bool        isnull;
 
    xminDatum = slot_getsysattr(localslot, MinTransactionIdAttributeNumber,
                                &isnull);
    *xmin = DatumGetTransactionId(xminDatum);
    Assert(!isnull);
 
    /*
     * The commit timestamp data is not available if track_commit_timestamp is
     * disabled.
     */
    if (!track_commit_timestamp)
    {
        *localorigin = InvalidReplOriginId;
        *localts = 0;
        return false;
    }
 
    return TransactionIdGetCommitTsData(*xmin, localts, localorigin);
}

References Assert, DatumGetTransactionId(), fb(), InvalidReplOriginId, MinTransactionIdAttributeNumber, slot_getsysattr(), track_commit_timestamp, and TransactionIdGetCommitTsData().

Referenced by apply_handle_delete_internal(), apply_handle_tuple_routing(), apply_handle_update_internal(), and CheckAndReportConflict().

InitConflictIndexes()

void InitConflictIndexes ( ResultRelInfo *  relInfo )

extern

Definition at line 312 of file conflict.c.

{
    List       *uniqueIndexes = NIL;
 
    for (int i = 0; i < relInfo->ri_NumIndices; i++)
    {
        Relation    indexRelation = relInfo->ri_IndexRelationDescs[i];
 
        if (indexRelation == NULL)
            continue;
 
        /* Detect conflict only for unique indexes */
        if (!relInfo->ri_IndexRelationInfo[i]->ii_Unique)
            continue;
 
        /* Don't support conflict detection for deferrable index */
        if (!indexRelation->rd_index->indimmediate)
            continue;
 
        uniqueIndexes = lappend_oid(uniqueIndexes,
                                    RelationGetRelid(indexRelation));
    }
 
    relInfo->ri_onConflictArbiterIndexes = uniqueIndexes;
}

References fb(), i, lappend_oid(), NIL, RelationData::rd_index, and RelationGetRelid.

Referenced by apply_handle_insert_internal(), apply_handle_tuple_routing(), and apply_handle_update_internal().

ReportApplyConflict()

void ReportApplyConflict ( EState *  estate, ResultRelInfo *  relinfo, int  elevel, ConflictType  type, TupleTableSlot *  searchslot, TupleTableSlot *  remoteslot, List *  conflicttuples  )

extern

Definition at line 277 of file conflict.c.

{
    Relation    localrel = relinfo->ri_RelationDesc;
    StringInfoData err_detail;
 
    initStringInfo(&err_detail);
 
    /* Form errdetail message by combining conflicting tuples information. */
    foreach_ptr(ConflictTupleInfo, conflicttuple, conflicttuples)
        errdetail_apply_conflict(estate, relinfo, type, searchslot,
                                 conflicttuple->slot, remoteslot,
                                 conflicttuple->indexoid,
                                 conflicttuple->xmin,
                                 conflicttuple->origin,
                                 conflicttuple->ts,
                                 &err_detail);
 
    pgstat_report_subscription_conflict(MySubscription->oid, type);
 
    ereport(elevel,
            errcode_apply_conflict(type),
            errmsg("conflict detected on relation \"%s.%s\": conflict=%s",
                   get_namespace_name(RelationGetNamespace(localrel)),
                   RelationGetRelationName(localrel),
                   ConflictTypeNames[type]),
            errdetail_internal("%s", err_detail.data));
}

References ConflictTypeNames, ereport, errcode_apply_conflict(), errdetail_apply_conflict(), errdetail_internal(), errmsg, fb(), foreach_ptr, get_namespace_name(), initStringInfo(), MySubscription, Subscription::oid, pgstat_report_subscription_conflict(), RelationGetNamespace, RelationGetRelationName, and type.

Referenced by apply_handle_delete_internal(), apply_handle_tuple_routing(), apply_handle_update_internal(), and CheckAndReportConflict().

Variable Documentation

ConflictLogDestNames

PGDLLIMPORT const char* const ConflictLogDestNames[]

extern

Definition at line 34 of file conflict.c.

                                           {
    [CONFLICT_LOG_DEST_LOG] = "log",
    [CONFLICT_LOG_DEST_TABLE] = "table",
    [CONFLICT_LOG_DEST_ALL] = "all"
};

Referenced by AlterSubscription().