ALTER SUBSCRIPTION
ALTER SUBSCRIPTION — изменить определение подписки
Синтаксис
ALTER SUBSCRIPTIONимяCONNECTION 'строка_подключения' ALTER SUBSCRIPTIONимяSET PUBLICATIONимя_публикации[, ...] [ WITH (параметр_публикации[=значение] [, ... ] ) ] ALTER SUBSCRIPTIONимяADD PUBLICATIONимя_публикации[, ...] [ WITH (параметр_публикации[=значение] [, ... ] ) ] ALTER SUBSCRIPTIONимяDROP PUBLICATIONимя_публикации[, ...] [ WITH (параметр_публикации[=значение] [, ... ] ) ] ALTER SUBSCRIPTIONимяREFRESH PUBLICATION [ WITH (параметр_обновления[=значение] [, ... ] ) ] ALTER SUBSCRIPTIONимяENABLE ALTER SUBSCRIPTIONимяDISABLE ALTER SUBSCRIPTIONимяSET (параметр_подписки[=значение] [, ... ] ) ALTER SUBSCRIPTIONимяSKIP (параметр_пропуска=значение) ALTER SUBSCRIPTIONимяOWNER TO {новый_владелец| CURRENT_ROLE | CURRENT_USER | SESSION_USER } ALTER SUBSCRIPTIONимяRENAME TOновое_имя
Описание
ALTER SUBSCRIPTION может менять многие свойства подписки, которые могут задаваться в CREATE SUBSCRIPTION.
Чтобы выполнить ALTER SUBSCRIPTION для подписки, нужно быть её владельцем. Чтобы переименовать подписку или сменить владельца, необходимо иметь право CREATE в базе данных. Кроме того, чтобы сменить владельца, необходимо иметь право SET ROLE для новой роли-владельца. Если для подписки задано password_required=false, изменять её могут только суперпользователи.
При обновлении подписки производится удаление отношений, которые были из неё исключены, а также удаление слотов синхронизации этих таблиц, если таковые имеются. Эти слоты необходимо удалять, чтобы были освобождены ресурсы, выделенные для данной подписки на удалённом сервере. Если по причине сбоя в сети или какой-то другой ошибки Postgres Pro не сможет удалить эти слоты, выполнение команды будет прервано ошибкой. Для разрешения такой ситуации можно либо попробовать повторить эту операцию, либо разорвать связь слота с подпиской и удалить подписку, выполнив DROP SUBSCRIPTION.
Команды ALTER SUBSCRIPTION ... REFRESH PUBLICATION, ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ... с параметром refresh, равным true, ALTER SUBSCRIPTION ... SET (failover = true|false) и ALTER SUBSCRIPTION ... SET (two_phase = false) не могут выполняться в блоке транзакции.
Команды ALTER SUBSCRIPTION ... REFRESH PUBLICATION и ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ... с параметром refresh, равным true, также не могут выполняться, если для подписки включён режим two_phase, за исключением случая, когда copy_data равен false. Состояние режима двухфазной фиксации показывается в столбце subtwophasestate каталога pg_subscription.
Параметры
имя#Имя подписки, свойства которой изменяются.
CONNECTION '#строка_подключения'Это предложение заменяет строку соединения, изначально установленную командой CREATE SUBSCRIPTION. За дополнительными сведениями обратитесь к описанию этой команды.
SET PUBLICATIONимя_публикацииADD PUBLICATIONимя_публикацииDROP PUBLICATION#имя_публикацииИзменяет список публикаций, на которые оформлена подписка. Предложение
SETполностью заменяет один список публикаций другим,ADDдобавляет публикации к списку публикаций, аDROPудаляет публикации из этого списка. В формахADDиSETдопускается указание несуществующих публикаций в расчёте на то, что они будут добавлены позже. За подробностями обратитесь к описанию CREATE SUBSCRIPTION. По умолчанию эта команда также выполняет действиеREFRESH PUBLICATION.В указании
параметр_публикациизадаются дополнительные свойства операции. Поддерживаются следующие параметры:refresh(boolean)Со значением
falseданная команда не будет обновлять информацию о таблицах. В этом случае следует выполнитьREFRESH PUBLICATIONотдельно. Значение по умолчанию —true.
Кроме того, здесь могут задаваться параметры, относящиеся к
REFRESH PUBLICATIONи управляющие неявной операцией обновления.REFRESH PUBLICATION#Считывает недостающую информацию о таблицах с публикующего сервера. В результате производится репликация таблиц, добавленных в публикации, на которые оформлена подписка, после
CREATE SUBSCRIPTIONили последнего вызоваREFRESH PUBLICATION.В указании
параметр_обновлениязадаются дополнительные свойства операции обновления. Поддерживаются следующие параметры:copy_data(boolean)Определяет, должны ли копироваться уже существующие данные в публикациях, на которые оформляется подписка, когда начинается репликация. Значение по умолчанию —
true.Таблицы, входившие в подписку ранее, не копируются, даже если предложение
WHEREфильтра строк таблицы изменилось с момента подписки.Подробнее взаимодействие
copy_data = trueс параметромoriginописано в Замечания.Чтобы получить дополнительные сведения о копировании уже существующих данных в двоичном формате, обратитесь к описанию параметра
binaryкомандыCREATE SUBSCRIPTION.
ENABLE#Включает ранее отключённую подписку, запуская процесс логической репликации в конце транзакции.
DISABLE#Отключает активную подписку, останавливая процесс логической репликации в конце транзакции.
SET (#параметр_подписки[=значение] [, ... ] )Это предложение изменяет параметры, изначально установленные командой CREATE SUBSCRIPTION. За подробностями обратитесь к её описанию. Данное предложение позволяет изменить параметры
slot_name,synchronous_commit,binary,streaming,disable_on_error,password_required,run_as_owner,origin,failoverиtwo_phase. Указатьpassword_required = falseможет только суперпользователь.При изменении
slot_nameпараметрыfailoverиtwo_phaseуказанного слота могут отличаться от параметровfailoverиtwo_phase, указанных в подписке. При создании слота убедитесь, что значения слота в параметрахfailoverиtwo_phaseсовпадают с указанными в подписке, иначе слот на публикующем сервере может вести себя по-другому: например, слот на публикующем сервере может синхронизироваться с резервными серверами даже при выключенном в подписке параметреfailoverи не синхронизироваться даже при включённом в подписке параметреfailover.Параметры
failoverиtwo_phaseможно изменять только тогда, когда подписка отключена.При изменении значения параметра
two_phaseсtrueнаfalseобслуживающий процесс выдаёт ошибку, если обнаружены подготовленные транзакции, созданные рабочим процессом логической репликации (когда для параметраtwo_phaseещё было заданоtrue). В этом случае можно разрешить подготовленные транзакции на публикующем узле или вручную откатить их на подписчике, а затем повторить попытку. Транзакции, подготовленные рабочим процессом логической репликации для конкретной подписки, получают имена такого формата: «pg_gid_%u_%u» (параметры: идентификатор подпискиoid, идентификатор удалённой транзакцииxid). Чтобы завершить такие транзакции вручную, необходимо откатить все подготовленные транзакции с соответствующими идентификаторами подписок в именах. Чтобы найти нужные подготовленные транзакции, приложения могут проверить представлениеpg_prepared_xacts. После изменения значения параметраtwo_phaseсtrueнаfalseпубликующий узел будет повторно реплицировать транзакции при их фиксации.SKIP (#параметр_пропуска=значение)Пропускает применение всех изменений удалённой транзакции. Если входящие данные нарушают какие-либо ограничения, логическая репликация будет остановлена, пока конфликты не будут разрешены. Когда выполняется команда
ALTER SUBSCRIPTION ... SKIP, рабочий процесс логической репликации пропускает все изменения данных в транзакции. Этот параметр не влияет на транзакции, которые уже подготовлены на стороне подписчика (в результате действия режимаtwo_phase). После того, как рабочий процесс логической репликации успешно пропускает транзакцию или транзакция завершается, номер LSN (хранящийся вpg_subscription.subskiplsn) очищается. Подробнее конфликты логической репликации описаны в Разделе 30.7.Параметр_пропускаопределяет свойства данной операции. Поддерживается следующий параметр:lsn(pg_lsn)Указывает LSN завершения удалённой транзакции, изменения которой должны быть пропущены процессом логической репликации. LSN завершения — это LSN, с которым транзакция зафиксирована либо подготовлена. Пропуск отдельных подтранзакций не поддерживается. Значение
NONEсбрасывает ранее установленный LSN.
новый_владелец#Имя пользователя, назначаемого новым владельцем подписки.
новое_имя#Новое имя подписки.
Если для параметра типа boolean опустить = значение, это равнозначно указанию значения TRUE.
Примеры
Изменение подписки, заключающееся в подписывании на публикацию insert_only:
ALTER SUBSCRIPTION mysub SET PUBLICATION insert_only;
Отключение (остановка) подписки:
ALTER SUBSCRIPTION mysub DISABLE;
Совместимость
ALTER SUBSCRIPTION является расширением Postgres Pro.
ALTER SUBSCRIPTION
ALTER SUBSCRIPTION — change the definition of a subscription
Synopsis
ALTER SUBSCRIPTIONnameCONNECTION 'conninfo' ALTER SUBSCRIPTIONnameSET PUBLICATIONpublication_name[, ...] [ WITH (publication_option[=value] [, ... ] ) ] ALTER SUBSCRIPTIONnameADD PUBLICATIONpublication_name[, ...] [ WITH (publication_option[=value] [, ... ] ) ] ALTER SUBSCRIPTIONnameDROP PUBLICATIONpublication_name[, ...] [ WITH (publication_option[=value] [, ... ] ) ] ALTER SUBSCRIPTIONnameREFRESH PUBLICATION [ WITH (refresh_option[=value] [, ... ] ) ] ALTER SUBSCRIPTIONnameENABLE ALTER SUBSCRIPTIONnameDISABLE ALTER SUBSCRIPTIONnameSET (subscription_parameter[=value] [, ... ] ) ALTER SUBSCRIPTIONnameSKIP (skip_option=value) ALTER SUBSCRIPTIONnameOWNER TO {new_owner| CURRENT_ROLE | CURRENT_USER | SESSION_USER } ALTER SUBSCRIPTIONnameRENAME TOnew_name
Description
ALTER SUBSCRIPTION can change most of the subscription properties that can be specified in CREATE SUBSCRIPTION.
You must own the subscription to use ALTER SUBSCRIPTION. To rename a subscription or alter the owner, you must have CREATE permission on the database. In addition, to alter the owner, you must be able to SET ROLE to the new owning role. If the subscription has password_required=false, only superusers can modify it.
When refreshing a publication we remove the relations that are no longer part of the publication and we also remove the table synchronization slots if there are any. It is necessary to remove these slots so that the resources allocated for the subscription on the remote host are released. If due to network breakdown or some other error, Postgres Pro is unable to remove the slots, an error will be reported. To proceed in this situation, the user either needs to retry the operation or disassociate the slot from the subscription and drop the subscription as explained in DROP SUBSCRIPTION.
Commands ALTER SUBSCRIPTION ... REFRESH PUBLICATION, ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ... with refresh option as true, ALTER SUBSCRIPTION ... SET (failover = true|false) and ALTER SUBSCRIPTION ... SET (two_phase = false) cannot be executed inside a transaction block.
Commands ALTER SUBSCRIPTION ... REFRESH PUBLICATION and ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ... with refresh option as true also cannot be executed when the subscription has two_phase commit enabled, unless copy_data is false. See column subtwophasestate of pg_subscription to know the actual two-phase state.
Parameters
name#The name of a subscription whose properties are to be altered.
CONNECTION '#conninfo'This clause replaces the connection string originally set by CREATE SUBSCRIPTION. See there for more information.
SET PUBLICATIONpublication_nameADD PUBLICATIONpublication_nameDROP PUBLICATION#publication_nameThese forms change the list of subscribed publications.
SETreplaces the entire list of publications with a new list,ADDadds additional publications to the list of publications, andDROPremoves the publications from the list of publications. We allow non-existent publications to be specified inADDandSETvariants so that users can add those later. See CREATE SUBSCRIPTION for more information. By default, this command will also act likeREFRESH PUBLICATION.publication_optionspecifies additional options for this operation. The supported options are:refresh(boolean)When false, the command will not try to refresh table information.
REFRESH PUBLICATIONshould then be executed separately. The default istrue.
Additionally, the options described under
REFRESH PUBLICATIONmay be specified, to control the implicit refresh operation.REFRESH PUBLICATION#Fetch missing table information from publisher. This will start replication of tables that were added to the subscribed-to publications since
CREATE SUBSCRIPTIONor the last invocation ofREFRESH PUBLICATION.refresh_optionspecifies additional options for the refresh operation. The supported options are: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.Previously subscribed tables are not copied, even if a table's row filter
WHEREclause has since been modified.See Notes for details of how
copy_data = truecan interact with theoriginparameter.See the
binaryparameter ofCREATE SUBSCRIPTIONfor details about copying pre-existing data in binary format.
ENABLE#Enables a previously disabled subscription, starting the logical replication worker at the end of the transaction.
DISABLE#Disables a running subscription, stopping the logical replication worker at the end of the transaction.
SET (#subscription_parameter[=value] [, ... ] )This clause alters parameters originally set by CREATE SUBSCRIPTION. See there for more information. The parameters that can be altered are
slot_name,synchronous_commit,binary,streaming,disable_on_error,password_required,run_as_owner,origin,failover, andtwo_phase. Only a superuser can setpassword_required = false.When altering the
slot_name, thefailoverandtwo_phaseproperty values of the named slot may differ from the counterpartfailoverandtwo_phaseparameters specified in the subscription. When creating the slot, ensure the slot propertiesfailoverandtwo_phasematch their counterpart parameters of the subscription. Otherwise, the slot on the publisher may behave differently from what these subscription options say: for example, the slot on the publisher could either be synced to the standbys even when the subscription'sfailoveroption is disabled or could be disabled for sync even when the subscription'sfailoveroption is enabled.The
failoverandtwo_phaseparameters can only be altered when the subscription is disabled.When altering
two_phasefromtruetofalse, the backend process reports an error if any prepared transactions done by the logical replication worker (from whentwo_phaseparameter was stilltrue) are found. You can resolve prepared transactions on the publisher node, or manually roll them back on the subscriber, and then try again. The transactions prepared by logical replication worker corresponding to a particular subscription have the following pattern: “pg_gid_%u_%u” (parameters: subscriptionoid, remote transaction idxid). To resolve such transactions manually, you need to roll back all the prepared transactions with corresponding subscription IDs in their names. Applications can checkpg_prepared_xactsto find the required prepared transactions. After thetwo_phaseoption is changed fromtruetofalse, the publisher will replicate the transactions again when they are committed.SKIP (#skip_option=value)Skips applying all changes of the remote transaction. If incoming data violates any constraints, logical replication will stop until it is resolved. By using the
ALTER SUBSCRIPTION ... SKIPcommand, the logical replication worker skips all data modification changes within the transaction. This option has no effect on the transactions that are already prepared by enablingtwo_phaseon the subscriber. After the logical replication worker successfully skips the transaction or finishes a transaction, the LSN (stored inpg_subscription.subskiplsn) is cleared. See Section 30.7 for the details of logical replication conflicts.skip_optionspecifies options for this operation. The supported option is:lsn(pg_lsn)Specifies the finish LSN of the remote transaction whose changes are to be skipped by the logical replication worker. The finish LSN is the LSN at which the transaction is either committed or prepared. Skipping individual subtransactions is not supported. Setting
NONEresets the LSN.
new_owner#The user name of the new owner of the subscription.
new_name#The new name for the subscription.
When specifying a parameter of type boolean, the = value part can be omitted, which is equivalent to specifying TRUE.
Examples
Change the publication subscribed by a subscription to insert_only:
ALTER SUBSCRIPTION mysub SET PUBLICATION insert_only;
Disable (stop) the subscription:
ALTER SUBSCRIPTION mysub DISABLE;
Compatibility
ALTER SUBSCRIPTION is a Postgres Pro extension.