PostgreSQL Source Code  git master
Data Structures | Typedefs | Enumerations | Functions
output_plugin.h File Reference
#include "replication/reorderbuffer.h"
Include dependency graph for output_plugin.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  OutputPluginOptions
 
struct  OutputPluginCallbacks
 

Typedefs

typedef enum OutputPluginOutputType OutputPluginOutputType
 
typedef struct OutputPluginOptions OutputPluginOptions
 
typedef void(* LogicalOutputPluginInit) (struct OutputPluginCallbacks *cb)
 
typedef void(* LogicalDecodeStartupCB) (struct LogicalDecodingContext *ctx, OutputPluginOptions *options, bool is_init)
 
typedef void(* LogicalDecodeBeginCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)
 
typedef void(* LogicalDecodeChangeCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, Relation relation, ReorderBufferChange *change)
 
typedef void(* LogicalDecodeTruncateCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, int nrelations, Relation relations[], ReorderBufferChange *change)
 
typedef void(* LogicalDecodeCommitCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr commit_lsn)
 
typedef void(* LogicalDecodeMessageCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr message_lsn, bool transactional, const char *prefix, Size message_size, const char *message)
 
typedef bool(* LogicalDecodeFilterByOriginCB) (struct LogicalDecodingContext *ctx, RepOriginId origin_id)
 
typedef void(* LogicalDecodeShutdownCB) (struct LogicalDecodingContext *ctx)
 
typedef bool(* LogicalDecodeFilterPrepareCB) (struct LogicalDecodingContext *ctx, TransactionId xid, const char *gid)
 
typedef void(* LogicalDecodeBeginPrepareCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)
 
typedef void(* LogicalDecodePrepareCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr prepare_lsn)
 
typedef void(* LogicalDecodeCommitPreparedCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr commit_lsn)
 
typedef void(* LogicalDecodeRollbackPreparedCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr prepare_end_lsn, TimestampTz prepare_time)
 
typedef void(* LogicalDecodeStreamStartCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)
 
typedef void(* LogicalDecodeStreamStopCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)
 
typedef void(* LogicalDecodeStreamAbortCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr abort_lsn)
 
typedef void(* LogicalDecodeStreamPrepareCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr prepare_lsn)
 
typedef void(* LogicalDecodeStreamCommitCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr commit_lsn)
 
typedef void(* LogicalDecodeStreamChangeCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, Relation relation, ReorderBufferChange *change)
 
typedef void(* LogicalDecodeStreamMessageCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr message_lsn, bool transactional, const char *prefix, Size message_size, const char *message)
 
typedef void(* LogicalDecodeStreamTruncateCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, int nrelations, Relation relations[], ReorderBufferChange *change)
 
typedef struct OutputPluginCallbacks OutputPluginCallbacks
 

Enumerations

enum  OutputPluginOutputType { OUTPUT_PLUGIN_BINARY_OUTPUT , OUTPUT_PLUGIN_TEXTUAL_OUTPUT }
 

Functions

void OutputPluginPrepareWrite (struct LogicalDecodingContext *ctx, bool last_write)
 
void OutputPluginWrite (struct LogicalDecodingContext *ctx, bool last_write)
 
void OutputPluginUpdateProgress (struct LogicalDecodingContext *ctx, bool skipped_xact)
 

Typedef Documentation

◆ LogicalDecodeBeginCB

typedef void(* LogicalDecodeBeginCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)

Definition at line 53 of file output_plugin.h.

◆ LogicalDecodeBeginPrepareCB

typedef void(* LogicalDecodeBeginPrepareCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)

Definition at line 115 of file output_plugin.h.

◆ LogicalDecodeChangeCB

typedef void(* LogicalDecodeChangeCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, Relation relation, ReorderBufferChange *change)

Definition at line 59 of file output_plugin.h.

◆ LogicalDecodeCommitCB

typedef void(* LogicalDecodeCommitCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr commit_lsn)

Definition at line 76 of file output_plugin.h.

◆ LogicalDecodeCommitPreparedCB

typedef void(* LogicalDecodeCommitPreparedCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr commit_lsn)

Definition at line 129 of file output_plugin.h.

◆ LogicalDecodeFilterByOriginCB

typedef bool(* LogicalDecodeFilterByOriginCB) (struct LogicalDecodingContext *ctx, RepOriginId origin_id)

Definition at line 94 of file output_plugin.h.

◆ LogicalDecodeFilterPrepareCB

typedef bool(* LogicalDecodeFilterPrepareCB) (struct LogicalDecodingContext *ctx, TransactionId xid, const char *gid)

Definition at line 108 of file output_plugin.h.

◆ LogicalDecodeMessageCB

typedef void(* LogicalDecodeMessageCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr message_lsn, bool transactional, const char *prefix, Size message_size, const char *message)

Definition at line 83 of file output_plugin.h.

◆ LogicalDecodePrepareCB

typedef void(* LogicalDecodePrepareCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr prepare_lsn)

Definition at line 122 of file output_plugin.h.

◆ LogicalDecodeRollbackPreparedCB

typedef void(* LogicalDecodeRollbackPreparedCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr prepare_end_lsn, TimestampTz prepare_time)

Definition at line 136 of file output_plugin.h.

◆ LogicalDecodeShutdownCB

typedef void(* LogicalDecodeShutdownCB) (struct LogicalDecodingContext *ctx)

Definition at line 100 of file output_plugin.h.

◆ LogicalDecodeStartupCB

typedef void(* LogicalDecodeStartupCB) (struct LogicalDecodingContext *ctx, OutputPluginOptions *options, bool is_init)

Definition at line 45 of file output_plugin.h.

◆ LogicalDecodeStreamAbortCB

typedef void(* LogicalDecodeStreamAbortCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr abort_lsn)

Definition at line 162 of file output_plugin.h.

◆ LogicalDecodeStreamChangeCB

typedef void(* LogicalDecodeStreamChangeCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, Relation relation, ReorderBufferChange *change)

Definition at line 185 of file output_plugin.h.

◆ LogicalDecodeStreamCommitCB

typedef void(* LogicalDecodeStreamCommitCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr commit_lsn)

Definition at line 178 of file output_plugin.h.

◆ LogicalDecodeStreamMessageCB

typedef void(* LogicalDecodeStreamMessageCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr message_lsn, bool transactional, const char *prefix, Size message_size, const char *message)

Definition at line 194 of file output_plugin.h.

◆ LogicalDecodeStreamPrepareCB

typedef void(* LogicalDecodeStreamPrepareCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, XLogRecPtr prepare_lsn)

Definition at line 170 of file output_plugin.h.

◆ LogicalDecodeStreamStartCB

typedef void(* LogicalDecodeStreamStartCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)

Definition at line 147 of file output_plugin.h.

◆ LogicalDecodeStreamStopCB

typedef void(* LogicalDecodeStreamStopCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn)

Definition at line 155 of file output_plugin.h.

◆ LogicalDecodeStreamTruncateCB

typedef void(* LogicalDecodeStreamTruncateCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, int nrelations, Relation relations[], ReorderBufferChange *change)

Definition at line 205 of file output_plugin.h.

◆ LogicalDecodeTruncateCB

typedef void(* LogicalDecodeTruncateCB) (struct LogicalDecodingContext *ctx, ReorderBufferTXN *txn, int nrelations, Relation relations[], ReorderBufferChange *change)

Definition at line 67 of file output_plugin.h.

◆ LogicalOutputPluginInit

typedef void(* LogicalOutputPluginInit) (struct OutputPluginCallbacks *cb)

Definition at line 36 of file output_plugin.h.

◆ OutputPluginCallbacks

typedef struct OutputPluginCallbacks OutputPluginCallbacks

◆ OutputPluginOptions

typedef struct OutputPluginOptions OutputPluginOptions

◆ OutputPluginOutputType

typedef enum OutputPluginOutputType OutputPluginOutputType

Enumeration Type Documentation

◆ OutputPluginOutputType

enum OutputPluginOutputType
Enumerator
OUTPUT_PLUGIN_BINARY_OUTPUT 
OUTPUT_PLUGIN_TEXTUAL_OUTPUT 

Definition at line 17 of file output_plugin.h.

18 {
19  OUTPUT_PLUGIN_BINARY_OUTPUT,
20  OUTPUT_PLUGIN_TEXTUAL_OUTPUT
21 } OutputPluginOutputType;
OutputPluginOutputType
OutputPluginOutputType
Definition: output_plugin.h:18
OUTPUT_PLUGIN_BINARY_OUTPUT
@ OUTPUT_PLUGIN_BINARY_OUTPUT
Definition: output_plugin.h:19
OUTPUT_PLUGIN_TEXTUAL_OUTPUT
@ OUTPUT_PLUGIN_TEXTUAL_OUTPUT
Definition: output_plugin.h:20

Function Documentation

◆ OutputPluginPrepareWrite()

void OutputPluginPrepareWrite ( struct LogicalDecodingContext *  ctx,
bool  last_write 
)

Definition at line 649 of file logical.c.

650 {
651  if (!ctx->accept_writes)
652  elog(ERROR, "writes are only accepted in commit, begin and change callbacks");
653 
654  ctx->prepare_write(ctx, ctx->write_location, ctx->write_xid, last_write);
655  ctx->prepared_write = true;
656 }
ERROR
#define ERROR
Definition: elog.h:33
elog
#define elog(elevel,...)
Definition: elog.h:218
LogicalDecodingContext::write_location
XLogRecPtr write_location
Definition: logical.h:108
LogicalDecodingContext::prepare_write
LogicalOutputPluginWriterPrepareWrite prepare_write
Definition: logical.h:64
LogicalDecodingContext::write_xid
TransactionId write_xid
Definition: logical.h:109

References LogicalDecodingContext::accept_writes, elog, ERROR, LogicalDecodingContext::prepare_write, LogicalDecodingContext::prepared_write, LogicalDecodingContext::write_location, and LogicalDecodingContext::write_xid.

Referenced by pg_decode_change(), pg_decode_commit_prepared_txn(), pg_decode_commit_txn(), pg_decode_message(), pg_decode_prepare_txn(), pg_decode_rollback_prepared_txn(), pg_decode_stream_abort(), pg_decode_stream_change(), pg_decode_stream_commit(), pg_decode_stream_message(), pg_decode_stream_prepare(), pg_decode_stream_stop(), pg_decode_stream_truncate(), pg_decode_truncate(), pg_output_begin(), pg_output_stream_start(), pgoutput_begin_prepare_txn(), pgoutput_change(), pgoutput_commit_prepared_txn(), pgoutput_commit_txn(), pgoutput_message(), pgoutput_prepare_txn(), pgoutput_rollback_prepared_txn(), pgoutput_send_begin(), pgoutput_stream_abort(), pgoutput_stream_commit(), pgoutput_stream_prepare_txn(), pgoutput_stream_start(), pgoutput_stream_stop(), pgoutput_truncate(), send_relation_and_attrs(), and send_repl_origin().

◆ OutputPluginUpdateProgress()

void OutputPluginUpdateProgress ( struct LogicalDecodingContext *  ctx,
bool  skipped_xact 
)

Definition at line 675 of file logical.c.

677 {
678  if (!ctx->update_progress)
679  return;
680 
681  ctx->update_progress(ctx, ctx->write_location, ctx->write_xid,
682  skipped_xact);
683 }
LogicalDecodingContext::update_progress
LogicalOutputPluginWriterUpdateProgress update_progress
Definition: logical.h:66

References LogicalDecodingContext::update_progress, LogicalDecodingContext::write_location, and LogicalDecodingContext::write_xid.

Referenced by update_replication_progress().

◆ OutputPluginWrite()

void OutputPluginWrite ( struct LogicalDecodingContext *  ctx,
bool  last_write 
)

Definition at line 662 of file logical.c.

663 {
664  if (!ctx->prepared_write)
665  elog(ERROR, "OutputPluginPrepareWrite needs to be called before OutputPluginWrite");
666 
667  ctx->write(ctx, ctx->write_location, ctx->write_xid, last_write);
668  ctx->prepared_write = false;
669 }
LogicalDecodingContext::write
LogicalOutputPluginWriterWrite write
Definition: logical.h:65

References elog, ERROR, LogicalDecodingContext::prepared_write, LogicalDecodingContext::write, LogicalDecodingContext::write_location, and LogicalDecodingContext::write_xid.

Referenced by pg_decode_change(), pg_decode_commit_prepared_txn(), pg_decode_commit_txn(), pg_decode_message(), pg_decode_prepare_txn(), pg_decode_rollback_prepared_txn(), pg_decode_stream_abort(), pg_decode_stream_change(), pg_decode_stream_commit(), pg_decode_stream_message(), pg_decode_stream_prepare(), pg_decode_stream_stop(), pg_decode_stream_truncate(), pg_decode_truncate(), pg_output_begin(), pg_output_stream_start(), pgoutput_begin_prepare_txn(), pgoutput_change(), pgoutput_commit_prepared_txn(), pgoutput_commit_txn(), pgoutput_message(), pgoutput_prepare_txn(), pgoutput_rollback_prepared_txn(), pgoutput_send_begin(), pgoutput_stream_abort(), pgoutput_stream_commit(), pgoutput_stream_prepare_txn(), pgoutput_stream_start(), pgoutput_stream_stop(), pgoutput_truncate(), send_relation_and_attrs(), and send_repl_origin().