logicalproto.h File Reference

#include "replication/reorderbuffer.h"
#include "utils/rel.h"

Include dependency graph for logicalproto.h:

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

Go to the source code of this file.

Data Structures
struct	LogicalRepTupleData
struct	LogicalRepRelation
struct	LogicalRepTyp
struct	LogicalRepBeginData
struct	LogicalRepCommitData

Macros
#define	LOGICALREP_PROTO_MIN_VERSION_NUM   1
#define	LOGICALREP_PROTO_VERSION_NUM   1
#define	LOGICALREP_COLUMN_NULL   'n'
#define	LOGICALREP_COLUMN_UNCHANGED   'u'
#define	LOGICALREP_COLUMN_TEXT   't'
#define	LOGICALREP_COLUMN_BINARY   'b' /* added in PG14 */

Typedefs
typedef struct LogicalRepTupleData	LogicalRepTupleData
typedef uint32	LogicalRepRelId
typedef struct LogicalRepRelation	LogicalRepRelation
typedef struct LogicalRepTyp	LogicalRepTyp
typedef struct LogicalRepBeginData	LogicalRepBeginData
typedef struct LogicalRepCommitData	LogicalRepCommitData

Functions
void	logicalrep_write_begin (StringInfo out, ReorderBufferTXN *txn)
void	logicalrep_read_begin (StringInfo in, LogicalRepBeginData *begin_data)
void	logicalrep_write_commit (StringInfo out, ReorderBufferTXN *txn, XLogRecPtr commit_lsn)
void	logicalrep_read_commit (StringInfo in, LogicalRepCommitData *commit_data)
void	logicalrep_write_origin (StringInfo out, const char *origin, XLogRecPtr origin_lsn)
char *	logicalrep_read_origin (StringInfo in, XLogRecPtr *origin_lsn)
void	logicalrep_write_insert (StringInfo out, Relation rel, HeapTuple newtuple, bool binary)
LogicalRepRelId	logicalrep_read_insert (StringInfo in, LogicalRepTupleData *newtup)
void	logicalrep_write_update (StringInfo out, Relation rel, HeapTuple oldtuple, HeapTuple newtuple, bool binary)
LogicalRepRelId	logicalrep_read_update (StringInfo in, bool *has_oldtuple, LogicalRepTupleData *oldtup, LogicalRepTupleData *newtup)
void	logicalrep_write_delete (StringInfo out, Relation rel, HeapTuple oldtuple, bool binary)
LogicalRepRelId	logicalrep_read_delete (StringInfo in, LogicalRepTupleData *oldtup)
void	logicalrep_write_truncate (StringInfo out, int nrelids, Oid relids[], bool cascade, bool restart_seqs)
List *	logicalrep_read_truncate (StringInfo in, bool *cascade, bool *restart_seqs)
void	logicalrep_write_rel (StringInfo out, Relation rel)
LogicalRepRelation *	logicalrep_read_rel (StringInfo in)
void	logicalrep_write_typ (StringInfo out, Oid typoid)
void	logicalrep_read_typ (StringInfo out, LogicalRepTyp *ltyp)

Macro Definition Documentation

LOGICALREP_COLUMN_BINARY

#define LOGICALREP_COLUMN_BINARY   'b' /* added in PG14 */

Definition at line 49 of file logicalproto.h.

Referenced by logicalrep_read_tuple(), logicalrep_write_tuple(), slot_modify_data(), and slot_store_data().

LOGICALREP_COLUMN_NULL

#define LOGICALREP_COLUMN_NULL   'n'

Definition at line 46 of file logicalproto.h.

Referenced by logicalrep_read_tuple(), and logicalrep_write_tuple().

LOGICALREP_COLUMN_TEXT

#define LOGICALREP_COLUMN_TEXT   't'

Definition at line 48 of file logicalproto.h.

Referenced by logicalrep_read_tuple(), logicalrep_write_tuple(), slot_modify_data(), and slot_store_data().

LOGICALREP_COLUMN_UNCHANGED

#define LOGICALREP_COLUMN_UNCHANGED   'u'

Definition at line 47 of file logicalproto.h.

Referenced by apply_handle_update(), logicalrep_read_tuple(), logicalrep_write_tuple(), and slot_modify_data().

LOGICALREP_PROTO_MIN_VERSION_NUM

#define LOGICALREP_PROTO_MIN_VERSION_NUM   1

Definition at line 27 of file logicalproto.h.

Referenced by pgoutput_startup().

LOGICALREP_PROTO_VERSION_NUM

#define LOGICALREP_PROTO_VERSION_NUM   1

Definition at line 28 of file logicalproto.h.

Referenced by ApplyWorkerMain(), and pgoutput_startup().

Typedef Documentation

LogicalRepBeginData

typedef struct LogicalRepBeginData LogicalRepBeginData

LogicalRepCommitData

typedef struct LogicalRepCommitData LogicalRepCommitData

LogicalRepRelation

typedef struct LogicalRepRelation LogicalRepRelation

LogicalRepRelId

typedef uint32 LogicalRepRelId

Definition at line 51 of file logicalproto.h.

LogicalRepTupleData

typedef struct LogicalRepTupleData LogicalRepTupleData

LogicalRepTyp

typedef struct LogicalRepTyp LogicalRepTyp

Function Documentation

logicalrep_read_begin()

void logicalrep_read_begin	(	StringInfo	in,
		LogicalRepBeginData *	begin_data
	)

Definition at line 59 of file proto.c.

References LogicalRepBeginData::committime, elog, ERROR, LogicalRepBeginData::final_lsn, InvalidXLogRecPtr, pq_getmsgint(), pq_getmsgint64(), and LogicalRepBeginData::xid.

Referenced by apply_handle_begin().

{
    /* read fields */
    begin_data->final_lsn = pq_getmsgint64(in);
    if (begin_data->final_lsn == InvalidXLogRecPtr)
        elog(ERROR, "final_lsn not set in begin message");
    begin_data->committime = pq_getmsgint64(in);
    begin_data->xid = pq_getmsgint(in, 4);
}

logicalrep_read_commit()

void logicalrep_read_commit	(	StringInfo	in,
		LogicalRepCommitData *	commit_data
	)

Definition at line 94 of file proto.c.

References LogicalRepCommitData::commit_lsn, LogicalRepCommitData::committime, elog, LogicalRepCommitData::end_lsn, ERROR, pq_getmsgbyte(), and pq_getmsgint64().

Referenced by apply_handle_commit().

{
    /* read flags (unused for now) */
    uint8       flags = pq_getmsgbyte(in);

    if (flags != 0)
        elog(ERROR, "unrecognized flags %u in commit message", flags);

    /* read fields */
    commit_data->commit_lsn = pq_getmsgint64(in);
    commit_data->end_lsn = pq_getmsgint64(in);
    commit_data->committime = pq_getmsgint64(in);
}

logicalrep_read_delete()

LogicalRepRelId logicalrep_read_delete	(	StringInfo	in,
		LogicalRepTupleData *	oldtup
	)

Definition at line 275 of file proto.c.

References generate_unaccent_rules::action, elog, ERROR, logicalrep_read_tuple(), pq_getmsgbyte(), and pq_getmsgint().

Referenced by apply_handle_delete().

{
    char        action;
    LogicalRepRelId relid;

    /* read the relation id */
    relid = pq_getmsgint(in, 4);

    /* read and verify action */
    action = pq_getmsgbyte(in);
    if (action != 'K' && action != 'O')
        elog(ERROR, "expected action 'O' or 'K', got %c", action);

    logicalrep_read_tuple(in, oldtup);

    return relid;
}

logicalrep_read_insert()

LogicalRepRelId logicalrep_read_insert	(	StringInfo	in,
		LogicalRepTupleData *	newtup
	)

Definition at line 158 of file proto.c.

References generate_unaccent_rules::action, elog, ERROR, logicalrep_read_tuple(), pq_getmsgbyte(), and pq_getmsgint().

Referenced by apply_handle_insert().

{
    char        action;
    LogicalRepRelId relid;

    /* read the relation id */
    relid = pq_getmsgint(in, 4);

    action = pq_getmsgbyte(in);
    if (action != 'N')
        elog(ERROR, "expected new tuple but got %d",
             action);

    logicalrep_read_tuple(in, newtup);

    return relid;
}

logicalrep_read_origin()

char* logicalrep_read_origin	(	StringInfo	in,
		XLogRecPtr *	origin_lsn
	)

Definition at line 128 of file proto.c.

References pq_getmsgint64(), pq_getmsgstring(), and pstrdup().

{
    /* fixed fields */
    *origin_lsn = pq_getmsgint64(in);

    /* return origin */
    return pstrdup(pq_getmsgstring(in));
}

logicalrep_read_rel()

LogicalRepRelation* logicalrep_read_rel

(

StringInfo

in

)

Definition at line 374 of file proto.c.

References logicalrep_read_attrs(), logicalrep_read_namespace(), LogicalRepRelation::nspname, palloc(), pq_getmsgbyte(), pq_getmsgint(), pq_getmsgstring(), pstrdup(), LogicalRepRelation::relname, LogicalRepRelation::remoteid, and LogicalRepRelation::replident.

Referenced by apply_handle_relation().

{
    LogicalRepRelation *rel = palloc(sizeof(LogicalRepRelation));

    rel->remoteid = pq_getmsgint(in, 4);

    /* Read relation name from stream */
    rel->nspname = pstrdup(logicalrep_read_namespace(in));
    rel->relname = pstrdup(pq_getmsgstring(in));

    /* Read the replica identity. */
    rel->replident = pq_getmsgbyte(in);

    /* Get attribute description */
    logicalrep_read_attrs(in, rel);

    return rel;
}

logicalrep_read_truncate()

List* logicalrep_read_truncate	(	StringInfo	in,
		bool *	cascade,
		bool *	restart_seqs
	)

Definition at line 324 of file proto.c.

References i, lappend_oid(), NIL, pq_getmsgint(), TRUNCATE_CASCADE, and TRUNCATE_RESTART_SEQS.

Referenced by apply_handle_truncate().

{
    int         i;
    int         nrelids;
    List       *relids = NIL;
    uint8       flags;

    nrelids = pq_getmsgint(in, 4);

    /* read and decode truncate flags */
    flags = pq_getmsgint(in, 1);
    *cascade = (flags & TRUNCATE_CASCADE) > 0;
    *restart_seqs = (flags & TRUNCATE_RESTART_SEQS) > 0;

    for (i = 0; i < nrelids; i++)
        relids = lappend_oid(relids, pq_getmsgint(in, 4));

    return relids;
}

logicalrep_read_typ()

void logicalrep_read_typ	(	StringInfo	out,
		LogicalRepTyp *	ltyp
	)

Definition at line 426 of file proto.c.

References logicalrep_read_namespace(), LogicalRepTyp::nspname, pq_getmsgint(), pq_getmsgstring(), pstrdup(), LogicalRepTyp::remoteid, and LogicalRepTyp::typname.

Referenced by apply_handle_type().

{
    ltyp->remoteid = pq_getmsgint(in, 4);

    /* Read type name from stream */
    ltyp->nspname = pstrdup(logicalrep_read_namespace(in));
    ltyp->typname = pstrdup(pq_getmsgstring(in));
}

logicalrep_read_update()

LogicalRepRelId logicalrep_read_update	(	StringInfo	in,
		bool *	has_oldtuple,
		LogicalRepTupleData *	oldtup,
		LogicalRepTupleData *	newtup
	)

Definition at line 209 of file proto.c.

References generate_unaccent_rules::action, elog, ERROR, logicalrep_read_tuple(), pq_getmsgbyte(), and pq_getmsgint().

Referenced by apply_handle_update().

{
    char        action;
    LogicalRepRelId relid;

    /* read the relation id */
    relid = pq_getmsgint(in, 4);

    /* read and verify action */
    action = pq_getmsgbyte(in);
    if (action != 'K' && action != 'O' && action != 'N')
        elog(ERROR, "expected action 'N', 'O' or 'K', got %c",
             action);

    /* check for old tuple */
    if (action == 'K' || action == 'O')
    {
        logicalrep_read_tuple(in, oldtup);
        *has_oldtuple = true;

        action = pq_getmsgbyte(in);
    }
    else
        *has_oldtuple = false;

    /* check for new  tuple */
    if (action != 'N')
        elog(ERROR, "expected action 'N', got %c",
             action);

    logicalrep_read_tuple(in, newtup);

    return relid;
}

logicalrep_write_begin()

void logicalrep_write_begin	(	StringInfo	out,
		ReorderBufferTXN *	txn
	)

Definition at line 45 of file proto.c.

References ReorderBufferTXN::commit_time, ReorderBufferTXN::final_lsn, pq_sendbyte(), pq_sendint32(), pq_sendint64(), and ReorderBufferTXN::xid.

Referenced by pgoutput_begin_txn().

{
    pq_sendbyte(out, 'B');      /* BEGIN */

    /* fixed fields */
    pq_sendint64(out, txn->final_lsn);
    pq_sendint64(out, txn->commit_time);
    pq_sendint32(out, txn->xid);
}

logicalrep_write_commit()

void logicalrep_write_commit	(	StringInfo	out,
		ReorderBufferTXN *	txn,
		XLogRecPtr	commit_lsn
	)

Definition at line 74 of file proto.c.

References ReorderBufferTXN::commit_time, ReorderBufferTXN::end_lsn, pq_sendbyte(), and pq_sendint64().

Referenced by pgoutput_commit_txn().

{
    uint8       flags = 0;

    pq_sendbyte(out, 'C');      /* sending COMMIT */

    /* send the flags field (unused for now) */
    pq_sendbyte(out, flags);

    /* send fields */
    pq_sendint64(out, commit_lsn);
    pq_sendint64(out, txn->end_lsn);
    pq_sendint64(out, txn->commit_time);
}

logicalrep_write_delete()

void logicalrep_write_delete	(	StringInfo	out,
		Relation	rel,
		HeapTuple	oldtuple,
		bool	binary
	)

Definition at line 250 of file proto.c.

References Assert, logicalrep_write_tuple(), pq_sendbyte(), pq_sendint32(), RelationData::rd_rel, and RelationGetRelid.

Referenced by pgoutput_change().

{
    Assert(rel->rd_rel->relreplident == REPLICA_IDENTITY_DEFAULT ||
           rel->rd_rel->relreplident == REPLICA_IDENTITY_FULL ||
           rel->rd_rel->relreplident == REPLICA_IDENTITY_INDEX);

    pq_sendbyte(out, 'D');      /* action DELETE */

    /* use Oid as relation identifier */
    pq_sendint32(out, RelationGetRelid(rel));

    if (rel->rd_rel->relreplident == REPLICA_IDENTITY_FULL)
        pq_sendbyte(out, 'O');  /* old tuple follows */
    else
        pq_sendbyte(out, 'K');  /* old key follows */

    logicalrep_write_tuple(out, rel, oldtuple, binary);
}

logicalrep_write_insert()

void logicalrep_write_insert	(	StringInfo	out,
		Relation	rel,
		HeapTuple	newtuple,
		bool	binary
	)

Definition at line 141 of file proto.c.

References logicalrep_write_tuple(), pq_sendbyte(), pq_sendint32(), and RelationGetRelid.

Referenced by pgoutput_change().

{
    pq_sendbyte(out, 'I');      /* action INSERT */

    /* use Oid as relation identifier */
    pq_sendint32(out, RelationGetRelid(rel));

    pq_sendbyte(out, 'N');      /* new tuple follows */
    logicalrep_write_tuple(out, rel, newtuple, binary);
}

logicalrep_write_origin()

void logicalrep_write_origin	(	StringInfo	out,
		const char *	origin,
		XLogRecPtr	origin_lsn
	)

Definition at line 112 of file proto.c.

References pq_sendbyte(), pq_sendint64(), and pq_sendstring().

Referenced by pgoutput_begin_txn().

{
    pq_sendbyte(out, 'O');      /* ORIGIN */

    /* fixed fields */
    pq_sendint64(out, origin_lsn);

    /* origin string */
    pq_sendstring(out, origin);
}

logicalrep_write_rel()

void logicalrep_write_rel	(	StringInfo	out,
		Relation	rel
	)

Definition at line 349 of file proto.c.

References logicalrep_write_attrs(), logicalrep_write_namespace(), pq_sendbyte(), pq_sendint32(), pq_sendstring(), RelationData::rd_rel, RelationGetNamespace, RelationGetRelationName, RelationGetRelid, and relname.

Referenced by send_relation_and_attrs().

{
    char       *relname;

    pq_sendbyte(out, 'R');      /* sending RELATION */

    /* use Oid as relation identifier */
    pq_sendint32(out, RelationGetRelid(rel));

    /* send qualified relation name */
    logicalrep_write_namespace(out, RelationGetNamespace(rel));
    relname = RelationGetRelationName(rel);
    pq_sendstring(out, relname);

    /* send replica identity */
    pq_sendbyte(out, rel->rd_rel->relreplident);

    /* send the attribute info */
    logicalrep_write_attrs(out, rel);
}

logicalrep_write_truncate()

void logicalrep_write_truncate	(	StringInfo	out,
		int	nrelids,
		Oid	relids[],
		bool	cascade,
		bool	restart_seqs
	)

Definition at line 297 of file proto.c.

References i, pq_sendbyte(), pq_sendint32(), pq_sendint8(), TRUNCATE_CASCADE, and TRUNCATE_RESTART_SEQS.

Referenced by pgoutput_truncate().

{
    int         i;
    uint8       flags = 0;

    pq_sendbyte(out, 'T');      /* action TRUNCATE */

    pq_sendint32(out, nrelids);

    /* encode and send truncate flags */
    if (cascade)
        flags |= TRUNCATE_CASCADE;
    if (restart_seqs)
        flags |= TRUNCATE_RESTART_SEQS;
    pq_sendint8(out, flags);

    for (i = 0; i < nrelids; i++)
        pq_sendint32(out, relids[i]);
}

logicalrep_write_typ()

void logicalrep_write_typ	(	StringInfo	out,
		Oid	typoid
	)

Definition at line 399 of file proto.c.

References elog, ERROR, getBaseType(), GETSTRUCT, HeapTupleIsValid, logicalrep_write_namespace(), NameStr, ObjectIdGetDatum, pq_sendbyte(), pq_sendint32(), pq_sendstring(), ReleaseSysCache(), SearchSysCache1(), and TYPEOID.

Referenced by send_relation_and_attrs().

{
    Oid         basetypoid = getBaseType(typoid);
    HeapTuple   tup;
    Form_pg_type typtup;

    pq_sendbyte(out, 'Y');      /* sending TYPE */

    tup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(basetypoid));
    if (!HeapTupleIsValid(tup))
        elog(ERROR, "cache lookup failed for type %u", basetypoid);
    typtup = (Form_pg_type) GETSTRUCT(tup);

    /* use Oid as relation identifier */
    pq_sendint32(out, typoid);

    /* send qualified type name */
    logicalrep_write_namespace(out, typtup->typnamespace);
    pq_sendstring(out, NameStr(typtup->typname));

    ReleaseSysCache(tup);
}

logicalrep_write_update()

void logicalrep_write_update	(	StringInfo	out,
		Relation	rel,
		HeapTuple	oldtuple,
		HeapTuple	newtuple,
		bool	binary
	)

Definition at line 180 of file proto.c.

References Assert, logicalrep_write_tuple(), pq_sendbyte(), pq_sendint32(), RelationData::rd_rel, and RelationGetRelid.

Referenced by pgoutput_change().

{
    pq_sendbyte(out, 'U');      /* action UPDATE */

    Assert(rel->rd_rel->relreplident == REPLICA_IDENTITY_DEFAULT ||
           rel->rd_rel->relreplident == REPLICA_IDENTITY_FULL ||
           rel->rd_rel->relreplident == REPLICA_IDENTITY_INDEX);

    /* use Oid as relation identifier */
    pq_sendint32(out, RelationGetRelid(rel));

    if (oldtuple != NULL)
    {
        if (rel->rd_rel->relreplident == REPLICA_IDENTITY_FULL)
            pq_sendbyte(out, 'O');  /* old tuple follows */
        else
            pq_sendbyte(out, 'K');  /* old key follows */
        logicalrep_write_tuple(out, rel, oldtuple, binary);
    }

    pq_sendbyte(out, 'N');      /* new tuple follows */
    logicalrep_write_tuple(out, rel, newtuple, binary);
}