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

Typedef Documentation

LogicalDecodeBeginCB

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

Definition at line 53 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.

LogicalDecodeFilterByOriginCB

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

Definition at line 94 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.

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.

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.

{
    OUTPUT_PLUGIN_BINARY_OUTPUT,
    OUTPUT_PLUGIN_TEXTUAL_OUTPUT
} OutputPluginOutputType;

Function Documentation

OutputPluginPrepareWrite()

void OutputPluginPrepareWrite	(	struct LogicalDecodingContext *	ctx,
		bool	last_write
	)

Definition at line 527 of file logical.c.

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

Referenced by maybe_send_schema(), pg_decode_change(), pg_decode_commit_txn(), pg_decode_message(), pg_decode_truncate(), pg_output_begin(), pgoutput_begin_txn(), pgoutput_change(), pgoutput_commit_txn(), and pgoutput_truncate().

{
    if (!ctx->accept_writes)
        elog(ERROR, "writes are only accepted in commit, begin and change callbacks");

    ctx->prepare_write(ctx, ctx->write_location, ctx->write_xid, last_write);
    ctx->prepared_write = true;
}

OutputPluginUpdateProgress()

void OutputPluginUpdateProgress

(

struct LogicalDecodingContext *

ctx

)

Definition at line 553 of file logical.c.

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

Referenced by pgoutput_commit_txn().

{
    if (!ctx->update_progress)
        return;

    ctx->update_progress(ctx, ctx->write_location, ctx->write_xid);
}

OutputPluginWrite()

void OutputPluginWrite	(	struct LogicalDecodingContext *	ctx,
		bool	last_write
	)

Definition at line 540 of file logical.c.

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

Referenced by maybe_send_schema(), pg_decode_change(), pg_decode_commit_txn(), pg_decode_message(), pg_decode_truncate(), pg_output_begin(), pgoutput_begin_txn(), pgoutput_change(), pgoutput_commit_txn(), and pgoutput_truncate().

{
    if (!ctx->prepared_write)
        elog(ERROR, "OutputPluginPrepareWrite needs to be called before OutputPluginWrite");

    ctx->write(ctx, ctx->write_location, ctx->write_xid, last_write);
    ctx->prepared_write = false;
}