NAME
ALTER_SUBSCRIPTION - change the definition of a subscription
SYNOPSIS
ALTER SUBSCRIPTION \nname\n CONNECTION '\nconninfo\n'
ALTER SUBSCRIPTION \nname\n SET PUBLICATION \npublication_name\n [, ...] [ WITH ( \npublication_option\n [= \nvalue\n] [, ... ] ) ]
ALTER SUBSCRIPTION \nname\n ADD PUBLICATION \npublication_name\n [, ...] [ WITH ( \npublication_option\n [= \nvalue\n] [, ... ] ) ]
ALTER SUBSCRIPTION \nname\n DROP PUBLICATION \npublication_name\n [, ...] [ WITH ( \npublication_option\n [= \nvalue\n] [, ... ] ) ]
ALTER SUBSCRIPTION \nname\n REFRESH PUBLICATION [ WITH ( \nrefresh_option\n [= \nvalue\n] [, ... ] ) ]
ALTER SUBSCRIPTION \nname\n ENABLE
ALTER SUBSCRIPTION \nname\n DISABLE
ALTER SUBSCRIPTION \nname\n SET ( \nsubscription_parameter\n [= \nvalue\n] [, ... ] )
ALTER SUBSCRIPTION \nname\n SKIP ( \nskip_option\n = \nvalue\n )
ALTER SUBSCRIPTION \nname\n OWNER TO { \nnew_owner\n | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
ALTER SUBSCRIPTION \nname\n RENAME TO \nnew_nameDESCRIPTION
ALTER SUBSCRIPTION can change most of the subscription properties that can be specified in CREATE SUBSCRIPTION (CREATE_SUBSCRIPTION(7)).
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, 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 (DROP_SUBSCRIPTION(7)).
Commands ALTER SUBSCRIPTION ... REFRESH PUBLICATION, ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ... with refresh option as true and ALTER SUBSCRIPTION ... SET (failover = true|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
CONNECTION 'conninfo'
SET PUBLICATION publication_name ADD PUBLICATION publication_name DROP PUBLICATION publication_name
publication_option specifies additional options for this operation. The supported options are:
refresh (boolean)
Additionally, the options described under REFRESH PUBLICATION may be specified, to control the implicit refresh operation.
REFRESH PUBLICATION
refresh_option specifies additional options for the refresh operation. The supported options are:
copy_data (boolean)
Previously subscribed tables are not copied, even if a table's row filter WHERE clause has since been modified.
See Notes for details of how copy_data = true can interact with the origin parameter.
See the binary parameter of CREATE SUBSCRIPTION for details about copying pre-existing data in binary format.
ENABLE
DISABLE
SET ( subscription_parameter [= value] [, ... ] )
When altering the slot_name, the failover and two_phase property values of the named slot may differ from the counterpart failover and two_phase parameters specified in the subscription. When creating the slot, ensure the slot properties failover and two_phase match 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's failover option is disabled or could be disabled for sync even when the subscription's failover option is enabled.
SKIP ( skip_option = value )
skip_option specifies options for this operation. The supported option is:
lsn (pg_lsn)
new_owner
new_name
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 PostgreSQL extension.
SEE ALSO
CREATE SUBSCRIPTION (CREATE_SUBSCRIPTION(7)), DROP SUBSCRIPTION (DROP_SUBSCRIPTION(7)), CREATE PUBLICATION (CREATE_PUBLICATION(7)), ALTER PUBLICATION (ALTER_PUBLICATION(7))