Необязательная 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 . См. также Раздел 5.12.6.3 . Если параметр receive_rewrites имеет значение true, плагин вывода также будет вызываться для изменений, вызванных перезаписью кучи (heap rewrites) при выполнении определенных 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 callback. Однако, поскольку TRUNCATE действия над таблицами, связанными внешними ключами, должны выполняться совместно, данная функция обратного вызова получает массив отношений (relations) вместо одного объекта. Подробности приведены в описании оператора TRUNCATE оператор для получения подробных сведений.

Необязательная функция filter_by_origin_cb callback вызывается для определения того, должны ли данные, воспроизведенные из 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 callback вызывается для определения того, следует ли учитывать данные, относящиеся к текущей транзакции двухфазной фиксации, при декодировании на данном этапе подготовки или позже, как обычную однофазную транзакцию, во время выполнения 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 callback. Однако, поскольку TRUNCATE действия над таблицами, связанными внешними ключами, должны выполняться совместно, данная функция обратного вызова получает массив отношений (relations) вместо одного объекта. Подробности приведены в описании оператора TRUNCATE оператор для получения подробных сведений.