CREATE SUBSCRIPTION
CREATE SUBSCRIPTION — создать подписку
Синтаксис
CREATE SUBSCRIPTIONимя_подпискиCONNECTION 'строка_подключения' PUBLICATIONимя_публикации[, ...] [ WITH (параметр_подписки[=значение] [, ... ] ) ]
Описание
CREATE SUBSCRIPTION создаёт подписку логической репликации. Имя подписки должно отличаться от имён других существующих подписок в текущей базе.
Подписка представляет собой реплицирующее подключение к публикующему серверу. Поэтому данная команда не только добавляет определения подписки в локальные каталоги, но также создаёт слот репликации на удалённом сервере.
В момент фиксации транзакции, в рамках которой выполняется эта команда, будет запущен рабочий процесс логической репликации, если подписка создаётся не в отключённом состоянии.
Дополнительные сведения о подписках и логической репликации в целом можно найти в Разделе 31.2 и Главе 31.
Параметры
имя_подпискиИмя новой подписки.
CONNECTION 'строка_подключения'Строка подключения libpq, определяющая, как подключаться к базе данных публикации. За подробностями обратитесь к Подразделу 34.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.
Замечания
Подробнее о том, как организовать управление доступом подписчиков к публикующему серверу, рассказывается в Разделе 31.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, строки всегда публикуются независимо от определения других выражений. Если на стороне подписчика используется версия PostgreSQL ниже 15, на этапе начальной синхронизации данных все фильтры строк игнорируются. В этом случае следует рассмотреть возможность удалить все изначально скопированные данные, которые будут несовместимы с фильтрами впоследствии. Так как при первоначальной синхронизации данных параметр публикации publish не учитывается, при копировании существующих данных могут быть скопированы строки, которые не были бы реплицированы при выполнении операций DML. Примеры приведены в Подразделе 31.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 является расширением PostgreSQL.
CREATE SUBSCRIPTION
CREATE SUBSCRIPTION — define a new subscription
Synopsis
CREATE SUBSCRIPTIONsubscription_nameCONNECTION 'conninfo' PUBLICATIONpublication_name[, ...] [ WITH (subscription_parameter[=value] [, ... ] ) ]
Description
CREATE SUBSCRIPTION adds a new logical-replication subscription. The subscription name must be distinct from the name of any existing subscription in the current database.
A subscription represents a replication connection to the publisher. Hence, in addition to adding definitions in the local catalogs, this command normally creates a replication slot on the publisher.
A logical replication worker will be started to replicate data for the new subscription at the commit of the transaction where this command is run, unless the subscription is initially disabled.
Additional information about subscriptions and logical replication as a whole is available at Section 31.2 and Chapter 31.
Parameters
subscription_nameThe name of the new subscription.
CONNECTION 'conninfo'The libpq connection string defining how to connect to the publisher database. For details see Section 34.1.1.
PUBLICATIONpublication_name[, ...]Names of the publications on the publisher to subscribe to.
WITH (subscription_parameter[=value] [, ... ] )This clause specifies optional parameters for a subscription.
The following parameters control what happens during subscription creation:
connect(boolean)Specifies whether the
CREATE SUBSCRIPTIONcommand should connect to the publisher at all. The default istrue. Setting this tofalsewill force the values ofcreate_slot,enabledandcopy_datatofalse. (You cannot combine settingconnecttofalsewith settingcreate_slot,enabled, orcopy_datatotrue.)Since no connection is made when this option is
false, no tables are subscribed, and so after you enable the subscription nothing will be replicated. You will need to then runALTER SUBSCRIPTION ... REFRESH PUBLICATIONfor tables to be subscribed.create_slot(boolean)Specifies whether the command should create the replication slot on the publisher. The default is
true. If set tofalse, you are responsible for creating the publisher's slot in some other way.enabled(boolean)Specifies whether the subscription should be actively replicating or whether it should just be set up but not started yet. The default is
true.slot_name(string)Name of the publisher's replication slot to use. The default is to use the name of the subscription for the slot name.
Setting
slot_nametoNONEmeans there will be no replication slot associated with the subscription. Use this when you will be creating the replication slot later manually. Such subscriptions must also have bothenabledandcreate_slotset tofalse.
The following parameters control the subscription's replication behavior after it has been created:
binary(boolean)Specifies whether the subscription will request the publisher to send the data in binary format (as opposed to text). The default is
false. Even when this option is enabled, only data types having binary send and receive functions will be transferred in binary.When doing cross-version replication, it could be that the publisher has a binary send function for some data type, but the subscriber lacks a binary receive function for that type. In such a case, data transfer will fail, and the
binaryoption cannot be used.copy_data(boolean)Specifies whether to copy pre-existing data in the publications that are being subscribed to when the replication starts. The default is
true.If the publications contain
WHEREclauses, it will affect what data is copied. Refer to the Notes for details.streaming(boolean)Specifies whether to enable streaming of in-progress transactions for this subscription. By default, all transactions are fully decoded on the publisher and only then sent to the subscriber as a whole.
synchronous_commit(enum)The value of this parameter overrides the synchronous_commit setting within this subscription's apply worker processes. The default value is
off.It is safe to use
offfor logical replication: If the subscriber loses transactions because of missing synchronization, the data will be sent again from the publisher.A different setting might be appropriate when doing synchronous logical replication. The logical replication workers report the positions of writes and flushes to the publisher, and when using synchronous replication, the publisher will wait for the actual flush. This means that setting
synchronous_commitfor the subscriber tooffwhen the subscription is used for synchronous replication might increase the latency forCOMMITon the publisher. In this scenario, it can be advantageous to setsynchronous_committolocalor higher.two_phase(boolean)Specifies whether two-phase commit is enabled for this subscription. The default is
false.When two-phase commit is enabled, prepared transactions are sent to the subscriber at the time of
PREPARE TRANSACTION, and are processed as two-phase transactions on the subscriber too. Otherwise, prepared transactions are sent to the subscriber only when committed, and are then processed immediately by the subscriber.The implementation of two-phase commit requires that replication has successfully finished the initial table synchronization phase. So even when
two_phaseis enabled for a subscription, the internal two-phase state remains temporarily “pending” until the initialization phase completes. See columnsubtwophasestateofpg_subscriptionto know the actual two-phase state.disable_on_error(boolean)Specifies whether the subscription should be automatically disabled if any errors are detected by subscription workers during data replication from the publisher. The default is
false.
Notes
See Section 31.9 for details on how to configure access control between the subscription and the publication instance.
When creating a replication slot (the default behavior), CREATE SUBSCRIPTION cannot be executed inside a transaction block.
Creating a subscription that connects to the same database cluster (for example, to replicate between databases in the same cluster or to replicate within the same database) will only succeed if the replication slot is not created as part of the same command. Otherwise, the CREATE SUBSCRIPTION call will hang. To make this work, create the replication slot separately (using the function pg_create_logical_replication_slot with the plugin name pgoutput) and create the subscription using the parameter create_slot = false. This is an implementation restriction that might be lifted in a future release.
If any table in the publication has a WHERE clause, rows for which the expression evaluates to false or null will not be published. If the subscription has several publications in which the same table has been published with different WHERE clauses, a row will be published if any of the expressions (referring to that publish operation) are satisfied. In the case of different WHERE clauses, if one of the publications has no WHERE clause (referring to that publish operation) or the publication is declared as FOR ALL TABLES or FOR TABLES IN SCHEMA, rows are always published regardless of the definition of the other expressions. If the subscriber is a PostgreSQL version before 15, then any row filtering is ignored during the initial data synchronization phase. For this case, the user might want to consider deleting any initially copied data that would be incompatible with subsequent filtering. Because initial data synchronization does not take into account the publication publish parameter when copying existing table data, some rows may be copied that would not be replicated using DML. See Section 31.2.2 for examples.
Subscriptions having several publications in which the same table has been published with different column lists are not supported.
We allow non-existent publications to be specified so that users can add those later. This means pg_subscription can have non-existent publications.
Examples
Create a subscription to a remote server that replicates tables in the publications mypublication and insert_only and starts replicating immediately on commit:
CREATE SUBSCRIPTION mysub
CONNECTION 'host=192.168.1.50 port=5432 user=foo dbname=foodb'
PUBLICATION mypublication, insert_only;
Create a subscription to a remote server that replicates tables in the insert_only publication and does not start replicating until enabled at a later time.
CREATE SUBSCRIPTION mysub
CONNECTION 'host=192.168.1.50 port=5432 user=foo dbname=foodb'
PUBLICATION insert_only
WITH (enabled = false);
Compatibility
CREATE SUBSCRIPTION is a PostgreSQL extension.