CREATE SUBSCRIPTION

CREATE SUBSCRIPTION — создать подписку

Синтаксис

CREATE SUBSCRIPTION имя_подписки
    CONNECTION 'строка_подключения'
    PUBLICATION имя_публикации [, ...]
    [ WITH ( параметр_подписки [= значение] [, ... ] ) ]

Описание

CREATE SUBSCRIPTION создаёт подписку логической репликации. Имя подписки должно отличаться от имён других существующих подписок в текущей базе.

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

В момент фиксации транзакции, в рамках которой выполняется эта команда, будет запущен рабочий процесс логической репликации, если подписка создаётся не в отключённом состоянии.

Дополнительные сведения о подписках и логической репликации в целом можно найти в Разделе 29.2 и Главе 29.

Параметры

имя_подписки

Имя новой подписки.

CONNECTION 'строка_подключения'

Строка подключения libpq, определяющая, как подключаться к базе данных публикации. За подробностями обратитесь к Подразделу 32.1.1.

PUBLICATION имя_публикации [, ...]

Имена публикаций на публикующем сервере, на которые оформляется подписка.

WITH ( параметр_подписки [= значение] [, ... ] )

В этом предложении задаются необязательные параметры подписки.

Следующие параметры определяют, как будет создаваться подписка:

connect (boolean)

Определяет, нужно ли при выполнении CREATE SUBSCRIPTION подключаться к публикующему серверу. Значение по умолчанию — true. Если равняется false, параметры create_slot, enabled и copy_data тоже принимают значение false. (Значение false параметра connect несовместимо со значением true параметров create_slot, enabled и copy_data.)

Так как со значением false соединение не устанавливается, подписка на таблицы не оформляется, так что после включения подписки ничего не будет реплицироваться. Чтобы таблицы вошли в подписку, позже вам потребуется выполнить ALTER SUBSCRIPTION ... REFRESH PUBLICATION.

create_slot (boolean)

Определяет, должна ли команда создавать слот репликации на публикующем сервере. Значение по умолчанию — true. Устанавливая значение false, вы должны будете сами создать слот на публикующем сервере другим способом.

enabled (boolean)

Определяет, активировать ли репликацию в подписке, или её нужно только настроить, но не запускать сразу. Значение по умолчанию — true.

slot_name (string)

Имя слота репликации на публикующем сервере, которое должно использоваться. По умолчанию в качестве имени слота используется имя подписки.

Когда в качестве slot_name задаётся NONE, с подпиской не будет связан слот репликации. Используйте это значение, если будете создавать слот репликации позднее вручную. У таких подписок также должны быть равны false свойства enabled и create_slot.

Следующие параметры управляют поведением репликации подписки после её создания:

binary (boolean)

Определяет, будет ли для данной подписки запрашиваться передача данных в двоичном (а не в текстовом) виде. Значение по умолчанию — false. Даже если этот параметр включён, в двоичном виде будут передаваться только те типы данных, для которых определены функции двоичного получения/отправки.

При репликации между серверами разных версий возможна ситуация, когда для некоторого типа на стороне публикации будет определена функция двоичной отправки, а на стороне подписки не будет соответствующей функции двоичного получения. В такой ситуации передача данных будет невозможна, и параметр binary использовать нельзя.

copy_data (boolean)

Определяет, должны ли копироваться уже существующие данные в публикациях, на которые оформляется подписка, сразу после начала репликации. Значение по умолчанию — true.

Предложения WHERE, содержащиеся в публикациях, влияют на то, какие данные будут скопированы. За подробностями обратитесь к Замечания.

streaming (boolean)

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

synchronous_commit (enum)

Значение этого параметра переопределяет свойство synchronous_commit для рабочих процессов, применяющих изменения данной подписки. По умолчанию — off.

Значение off безопасно для логической репликации: если подписчик потеряет транзакции из-за нарушения синхронизации, данные будут повторно переданы с публикующего сервера.

При выполнении синхронной логической репликации может быть уместно другое значение. Рабочие процессы логической репликации передают позиции записанных и сохранённых на диске данных публикующему серверу, так что при синхронной репликации он будет ждать завершения сохранения. Это значит, что значение off параметра synchronous_commit на подписчике может увеличить задержку при выполнении COMMIT на сервере публикации. При таком сценарии может быть выгоднее задать для synchronous_commit значение local или выше.

two_phase (boolean)

Определяет, включается ли двухфазная фиксация для этой подписки. Значение по умолчанию — false.

Когда двухфазная фиксация включена, подготовленные транзакции отправляются подписчику во время PREPARE TRANSACTION и также обрабатываются подписчиком как двухфазные транзакции. В противном случае подготовленные транзакции отправляются подписчику только после фиксации, а затем немедленно обрабатываются подписчиком.

Реализация двухфазной фиксации требует, чтобы процедура репликации успешно завершила начальную фазу синхронизации таблиц. Таким образом, даже если для подписки включён параметр two_phase, внутренним состоянием двухфазной фиксации временно остаётся «в ожидании», пока не завершится фаза инициализации. Фактическое состояние двухфазной фиксации можно увидеть в столбце subtwophasestate в pg_subscription.

disable_on_error (boolean)

Определяет, следует ли автоматически отключать подписку, если рабочие процессы подписчика обнаружат какие-либо ошибки при репликации данных публикации. Значение по умолчанию — false.

Замечания

Подробнее о том, как организовать управление доступом подписчиков к публикующему серверу, рассказывается в Разделе 29.9.

При создании слота репликации (поведение по умолчанию) CREATE SUBSCRIPTION нельзя выполнять внутри блока транзакции.

Создание подписки с подключением к тому же кластеру баз данных (например, для организации репликации между базами данных в одном кластере или в одной базе данных) будет успешным, только если слот репликации не создаётся той же командой. В противном случае команда CREATE SUBSCRIPTION зависнет. Чтобы оформить такую подписку, слот репликации нужно создать отдельно (воспользовавшись функцией pg_create_logical_replication_slot и передав ей имя модуля pgoutput) и создать подписку с параметром create_slot = false. Это ограничение реализации, которое может быть устранено в будущем выпуске.

Если для какой-либо таблицы в публикации указано предложение WHERE, строки, для которых выражение выдаёт значение false или null, не будут публиковаться. Когда в подписке есть несколько публикаций, в которых одна и та же таблица опубликована с разными предложениями WHERE, строка будет опубликована, если выполняется любое из выражений (относящееся к этой операции публикации). В случае неодинаковых предложений WHERE, если в одной из публикаций нет предложения WHERE (относящегося к этой операции публикации) или публикация объявлена ​​как FOR ALL TABLES или FOR TABLES IN SCHEMA, строки всегда публикуются независимо от определения других выражений. Если на стороне подписчика используется версия Postgres Pro ниже 15, на этапе начальной синхронизации данных все фильтры строк игнорируются. В этом случае следует рассмотреть возможность удалить все изначально скопированные данные, которые будут несовместимы с фильтрами впоследствии. Так как при первоначальной синхронизации данных параметр публикации publish не учитывается, при копировании существующих данных могут быть скопированы строки, которые не были бы реплицированы при выполнении операций DML. Примеры приведены в Подразделе 29.2.2.

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

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

Примеры

Создание подписки на репликации mypublication и insert_only на удалённом сервере с немедленным запуском репликации при фиксировании транзакции:

CREATE SUBSCRIPTION mysub
         CONNECTION 'host=192.168.1.50 port=5432 user=foo dbname=foodb'
        PUBLICATION mypublication, insert_only;

Создание подписки на публикацию insert_only на удалённом сервере с отключением репликации для запуска в будущем.

CREATE SUBSCRIPTION mysub
         CONNECTION 'host=192.168.1.50 port=5432 user=foo dbname=foodb'
        PUBLICATION insert_only
               WITH (enabled = false);

Совместимость

CREATE SUBSCRIPTION является расширением Postgres Pro.