CREATE SUBSCRIPTION
Пред. НаверхКоманды SQLНачало След.

CREATE SUBSCRIPTION

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

Синтаксис

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

Описание

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

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

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

Чтобы создать подписку, необходимо иметь права роли pg_create_subscription, а также право CREATE для текущей базы данных.

Дополнительные сведения о подписках и логической репликации в целом можно найти в Разделе 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 соединение не устанавливается, подписка на таблицы не оформляется. Чтобы начать репликацию, потребуется вручную создать слот репликации, при необходимости включить failover, включить подписку и обновить её. Примеры можно найти в Подразделе 29.2.3.

create_slot (boolean) #

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

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

enabled (boolean) #

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

slot_name (string) #

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

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

Если задать в качестве slot_name корректное имя, а для create_slot указать false, значение failover указанного слота может отличаться от значения failover в подписке. При создании слота убедитесь, что значение failover слота совпадает с указанным в подписке, иначе слот на публикующем сервере может вести себя неожиданно: например, слот на публикующем сервере может синхронизироваться с резервными серверами даже при выключенном в подписке параметре failover и не синхронизироваться даже при включённом в подписке параметре failover.

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

binary (boolean) #

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

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

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

copy_data (boolean) #

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

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

В Замечания описано поведение при копировании данных (copy_data = true) с параметром origin.

streaming (enum) #

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

Внимание

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

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

При значении off каждая транзакция сначала целиком декодируется на стороне публикации и только затем передаётся подписчику как единое целое.

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.

password_required (boolean) #

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

run_as_owner (boolean) #

Если true, все действия репликации выполняются от имени владельца подписки. Если false (по умолчанию), рабочие процессы репликации выполняют операции с таблицами от имени владельца таблицы, что в целом намного более безопасно (за подробностями обратитесь к Разделу 29.11).

origin (string) #

Определяет, будет ли для данной подписки запрашиваться передача изменений, не отмеченных источником репликации, или всех изменений независимо от источника. Если задать для origin значение none, для подписки будет запрашиваться передача изменений, не отмеченных источником репликации. Если задать для origin значение any, публикующий сервер отправляет все изменения независимо от их источника. По умолчанию — any.

В Замечания описано поведение при копировании данных (copy_data = true) с параметром origin.

failover (boolean) #

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

Если для параметра типа boolean опустить = значение, это равнозначно указанию значения TRUE.

Замечания

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

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

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

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

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

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

Когда для подписки заданы параметры copy_data = true и origin = NONE, данные для начальной синхронизации копируются напрямую с публикующего сервера, то есть исходный источник данных определить невозможно. Если публикующий сервер сам является подписчиком, копируемые данные могли быть получены из другого источника. При выявлении такой ситуации пользователю выдаётся предупреждение, которое только указывает на возможную проблему, — пользователю необходимо самостоятельно убедиться в необходимости копировать данные из третьего источника.

Чтобы найти таблицы, данные в которых могли быть получены из третьего источника (из-за подписок на публикующем сервере), воспользуйтесь таким SQL-запросом: 

# замените <pub-names> именами подписок для запроса
SELECT DISTINCT PT.schemaname, PT.tablename
FROM pg_publication_tables PT
     JOIN pg_class C ON (C.relname = PT.tablename)
     JOIN pg_namespace N ON (N.nspname = PT.schemaname),
     pg_subscription_rel PS
WHERE C.relnamespace = N.oid AND
      (PS.srrelid = C.oid OR
      C.oid IN (SELECT relid FROM pg_partition_ancestors(PS.srrelid) UNION
                SELECT relid FROM pg_partition_tree(PS.srrelid))) AND
      PT.pubname IN (<pub-names>);

Примеры

Создание подписки на репликации 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 STATISTICS Начало CREATE TABLE

Чтобы сделать работу с сайтом удобнее, мы используем cookie и аналитический сервис «Яндекс.Метрика». Продолжая пользоваться сайтом, вы соглашаетесь с их использованием.