ALTER SUBSCRIPTION — change the definition of a subscription
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
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 alter the owner, you must also be a direct or indirect member of the
new owning role. The new owner has to be a superuser.
(Currently, all subscription owners must be superusers, so the owner checks
will be bypassed in practice. But this might change in the future.)
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, PostgreSQL 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 and
ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ...
with refresh option as true cannot be
executed inside a transaction block.
These commands 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.
nameThe 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 PUBLICATION publication_nameADD PUBLICATION publication_nameDROP PUBLICATION publication_name
These forms change the list of subscribed publications.
SET
replaces the entire list of publications with a new list,
ADD adds additional publications to the list of
publications, and DROP removes the publications from
the list of publications. We allow non-existent publications to be
specified in ADD and SET variants
so that users can add those later. See CREATE SUBSCRIPTION
for more information. By default, this command will also act like
REFRESH PUBLICATION.
publication_option specifies additional
options for this operation. The supported options are:
refresh (boolean)
When false, the command will not try to refresh table information.
REFRESH PUBLICATION should then be executed separately.
The default is true.
Additionally, the options described under
REFRESH PUBLICATION may 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 SUBSCRIPTION or
the last invocation of REFRESH PUBLICATION.
refresh_option specifies 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 WHERE clause has since been modified.
ENABLEEnables a previously disabled subscription, starting the logical replication worker at the end of the transaction.
DISABLEDisables 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, and
disable_on_error.
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 ... SKIP command,
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 enabling two_phase on
subscriber.
After the logical replication worker successfully skips the transaction or
finishes a transaction, the LSN (stored in
pg_subscription.subskiplsn)
is cleared. See Section 31.5 for
the details of logical replication conflicts. Using this command requires
superuser privilege.
skip_option specifies 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
NONE resets the LSN.
new_ownerThe user name of the new owner of the subscription.
new_nameThe new name for the subscription.
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;
ALTER SUBSCRIPTION is a PostgreSQL
extension.