ALTER SUBSCRIPTION
ALTER SUBSCRIPTION
7
SQL - Language Statements
ALTER SUBSCRIPTION
change the definition of a subscription
ALTER SUBSCRIPTION name CONNECTION 'conninfo'
ALTER SUBSCRIPTION name SET PUBLICATION publication_name [, ...] [ WITH ( publication_option [= value] [, ... ] ) ]
ALTER SUBSCRIPTION name ADD PUBLICATION publication_name [, ...] [ WITH ( publication_option [= value] [, ... ] ) ]
ALTER SUBSCRIPTION name DROP PUBLICATION publication_name [, ...] [ WITH ( publication_option [= value] [, ... ] ) ]
ALTER SUBSCRIPTION name REFRESH PUBLICATION [ WITH ( refresh_option [= value] [, ... ] ) ]
ALTER SUBSCRIPTION name ENABLE
ALTER SUBSCRIPTION name DISABLE
ALTER SUBSCRIPTION name SET ( subscription_parameter [= value] [, ... ] )
ALTER SUBSCRIPTION name OWNER TO { new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
ALTER SUBSCRIPTION name RENAME TO new_name
Description
ALTER SUBSCRIPTION can change most of the subscription
properties that can be specified
in .
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
.
Commands ALTER SUBSCRIPTION ... REFRESH PUBLICATION and
ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ...
with refresh option as true cannot be
executed inside a transaction block.
Parameters
name
The name of a subscription whose properties are to be altered.
CONNECTION 'conninfo'
This clause alters the connection property originally set by
. See there for more
information.
SET PUBLICATION publication_name
ADD PUBLICATION publication_name
DROP PUBLICATION publication_name
Changes 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. See
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 the last invocation of REFRESH PUBLICATION or
since CREATE SUBSCRIPTION.
refresh_option specifies additional options for the
refresh operation. The supported options are:
copy_data (boolean)
Specifies whether the existing data in the publications that are
being subscribed to should be copied once the replication starts.
The default is true. (Previously subscribed
tables are not copied.)
ENABLE
Enables the previously disabled subscription, starting the logical
replication worker at the end of transaction.
DISABLE
Disables the running subscription, stopping the logical replication
worker at the end of transaction.
SET ( subscription_parameter [= value] [, ... ] )
This clause alters parameters originally set by
. See there for more
information. The parameters that can be altered
are slot_name,
synchronous_commit,
binary, and
streaming.
new_owner
The user name of the new owner of the subscription.
new_name
The new name for the subscription.
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