Опциональный обратный вызов startup_cb вызывается каждый раз, когда создается слот репликации или запрашивается поток изменений, независимо от количества готовых к отправке изменений.

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

Параметр is_init будет равен true, когда слот репликации создается, и false в противном случае. options указывает на структуру опций, которые могут быть установлены плагинами вывода:

typedef struct OutputPluginOptions
{
    OutputPluginOutputType output_type;
    bool        receive_rewrites;
} OutputPluginOptions;

output_type должен быть установлен либо в OUTPUT_PLUGIN_TEXTUAL_OUTPUT, либо в OUTPUT_PLUGIN_BINARY_OUTPUT. См. также Раздел 47.6.3. Если receive_rewrites установлено в true, плагин вывода также будет вызываться для изменений, внесенных перезаписью кучи во время некоторых операций DDL. Это интересно для плагинов, обрабатывающих репликацию DDL, но требуется особая обработка.

Коллбэк-функция запуска должна проверить наличие опций в ctx->output_plugin_options. Если выходной плагин требует наличия состояния, он может использовать ctx->output_plugin_private для его хранения.

Опциональный обратный вызов shutdown_cb вызывается, когда ранее активный слот репликации больше не используется и может использоваться для освобождения ресурсов, приватных для выходного плагина. Слот не обязательно удаляется, потоковая передача просто останавливается.

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

Требуемый обратный вызов begin_cb вызывается каждый раз, когда началась декодировка подтвержденной транзакции. Отмененные транзакции и их содержимое никогда не декодируются.

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

Параметр txn содержит метаинформацию о транзакции, такую как временная метка, когда она была подтверждена, и ее XID.

Требуемый обратный вызов commit_cb вызывается каждый раз, когда транзакция коммитится. Обратные вызовы change_cb для всех измененных строк будут вызваны до этого, если были измененные строки.

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

Требуется обратный вызов change_cb, который вызывается для каждой отдельной модификации строки внутри транзакции, будь то INSERT, UPDATE или DELETE. Даже если исходная команда модифицировала несколько строк одновременно, обратный вызов будет вызываться отдельно для каждой строки. Обратный вызов change_cb может получать доступ к системным или пользовательским каталогам для помощи в процессе вывода деталей модификации строки. В случае декодирования подготовленной (но еще не подтвержденной) транзакции или декодирования неподтвержденной транзакции, этот обратный вызов изменения также может завершиться с ошибкой из-за одновременного отката этой же самой транзакции. В этом случае логическое декодирование этой прерванной транзакции прекращается плавно.

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

Параметры ctx и txn имеют тот же содержимое, что и для обратных вызовов begin_cb и commit_cb, но дополнительно передаются дескриптор отношения relation, указывающий на отношение, к которому принадлежит строка, и структура change, описывающая модификацию строки.

Коллбэк truncate_cb вызывается для команды TRUNCATE.

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

Параметры аналогичны обратному вызову change_cb. Однако, поскольку действия TRUNCATE на таблицах, связанных внешними ключами, должны выполняться вместе, этот обратный вызов получает массив отношений вместо одного. См. описание оператора TRUNCATE для получения подробной информации.

Опциональный обратный вызов filter_by_origin_cb вызывается для определения, являются ли данные, воспроизведенные из origin_id, интересными для выходного плагина.

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

Параметр ctx имеет тот же контент, что и для других обратных вызовов. Нет доступной информации, кроме источника. Чтобы указать, что изменения, исходящие от переданного узла, не имеют значения, верните true, что приведет к их фильтрации; в противном случае - false. Для транзакций и изменений, которые были отфильтрованы, другие обратные вызовы не будут вызываться.

Это полезно при реализации каскадных или многонаправленных решений репликации. Фильтрация по источнику позволяет предотвратить повторная репликация одних и тех же изменений в таких настройках. Хотя транзакции и изменения также содержат информацию об источнике, фильтрация через этот обратный вызов заметно более эффективна.

Опциональный обратный вызов message_cb вызывается каждый раз, когда декодировано сообщение логического декодирования.

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

Параметр txn содержит метаинформацию о транзакции, такую как временная метка, когда она была подтверждена, и ее XID. Однако обратите внимание, что он может быть NULL, когда сообщение не является транзакционным и XID еще не был назначен в транзакции, которая записала сообщение. Параметр lsn содержит местоположение WAL сообщения. Параметр transactional указывает, было ли сообщение отправлено как транзакционное или нет. Аналогично обратному вызову изменений, в случае декодирования подготовленной (но еще не подтвержденной) транзакции или декодирования неподтвержденной транзакции, этот обратный вызов сообщений также может завершиться с ошибкой из-за одновременного отката этой же самой транзакции. В этом случае логическое декодирование этой прерванной транзакции прекращается плавно. Параметр prefix - это произвольный префикс с нулевым завершением, который может использоваться для идентификации интересующих сообщений для текущего плагина. И, наконец, параметр message содержит фактическое сообщение размером message_size.

Следует обратить особое внимание на то, чтобы префикс, который рассматривает выходной плагин, был уникальным. Часто хорошим выбором является использование имени расширения или самого выходного плагина.

Необязательный обратный вызов filter_prepare_cb вызывается для определения того, должны ли данные, являющиеся частью текущей двухфазной транзакции подготовки, рассматриваться для декодирования на этапе подготовки или позже, как обычная однофазная транзакция при выполнении команды COMMIT PREPARED. Чтобы указать, что декодирование должно быть прне указано, верните true; в противном случае верните false. Когда обратный вызов не определен, предполагается false (т.е. нет фильтрации, все транзакции, использующие двухфазный коммит, также декодируются в две фазы).

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

Параметр ctx содержит те же данные, что и для других обратных вызовов. Параметры xid и gid предоставляют два разных способа идентификации транзакции. Позднее выполнение команды COMMIT PREPARED или ROLLBACK PREPARED содержит оба идентификатора, что позволяет плагину вывода выбрать, что использовать.

Коллбэк может быть вызван несколько раз за транзакцию для декодирования и должен предоставлять одинаковый статический ответ для заданной пары xid и gid каждый раз, когда он вызывается.

Требуемый обратный вызов begin_prepare_cb вызывается, когда начало подготовленной транзакции было декодировано. Поле gid, которое является частью параметра txn, может быть использовано в этом обратном вызове для проверки, была ли уже получена этой плагином команда PREPARE, в таком случае он может либо вызвать ошибку, либо пропустить оставшиеся изменения транзакции.

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

Требуемый обратный вызов prepare_cb вызывается каждый раз, когда транзакция, подготовленная для двухфазного коммита, была декодирована. Обратный вызов change_cb для всех измененных строк будет вызван до этого, если были изменены какие-либо строки. Поле gid, которое является частью параметра txn, может быть использовано в этом обратном вызове.

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

Требуемый обратный вызов commit_prepared_cb вызывается каждый раз, когда транзакция COMMIT PREPARED была декодирована. Поле gid, которое является частью параметра txn, может быть использовано в этом обратном вызове.

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

Необходимый обратный вызов rollback_prepared_cb вызывается каждый раз, когда декодирована команда ROLLBACK PREPARED. Поле gid, которое является частью параметра txn, может использоваться в этом обратном вызове. Параметры prepare_end_lsn и prepare_time могут использоваться для проверки, была ли получена плагином команда PREPARE TRANSACTION, в таком случае можно выполнить откат, в противном случае можно пропустить операцию отката. Только поле gid недостаточно, потому что у удаленного узла может быть подготовленная транзакция с тем же идентификатором.

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

Колбэк stream_start_cb вызывается при открытии блока потоковых изменений из транзакции, находящейся в процессе выполнения.

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

Колбэк stream_stop_cb вызывается при закрытии блока потоковых изменений из транзакции, находящейся в процессе выполнения.

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

Колбэк stream_abort_cb вызывается для прерывания ранее переданной транзакции.

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

Коллбэк stream_prepare_cb вызывается для подготовки ранее переданной транзакции в рамках двухфазного коммита.

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

Коллбэк stream_commit_cb вызывается для коммита ранее переданной транзакции.

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

Коллбэк stream_change_cb вызывается при отправке изменения в блоке потоковых изменений (ограниченных вызовами stream_start_cb и stream_stop_cb). Фактические изменения не отображаются, так как транзакция может быть отменена позже, и мы не декодируем изменения для отмененных транзакций.

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

Коллбэк stream_message_cb вызывается при отправке общего сообщения в блоке потоковых изменений (ограниченного вызовами stream_start_cb и stream_stop_cb). Содержимое сообщений транзакций не отображается, так как транзакция может быть отменена впоследствии, и мы не декодируем изменения для отмененных транзакций.

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

Коллбэк stream_truncate_cb вызывается для команды TRUNCATE в блоке потоковых изменений (ограниченном вызовами stream_start_cb и stream_stop_cb).

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

Параметры аналогичны обратному вызову stream_change_cb. Однако, поскольку действия TRUNCATE на таблицах, связанных внешними ключами, должны выполняться вместе, этот обратный вызов получает массив отношений вместо одного. Подробности см. в описании оператора TRUNCATE.