SQL COMMAND · 逻辑复制

ALTER SUBSCRIPTION

修改订阅的定义

ALTER逻辑复制引入 10（基线）现存至 20 devel2 次语法变更

动词: ALTER
对象: SUBSCRIPTION
分组: 逻辑复制
引入版本: 10（基线）
状态: 现存
语法变更次数: 2
手册小节数: 5

本站手册 · 18 官方文档 ↗

版本轨迹

相对 PostgreSQL 17 语法未变，正文有更新。

语法铁道图 PostgreSQL 18

沿轨道从左向右阅读，分岔表示选择，绕行表示可选，回环表示重复。方框为参数，点击带下划线的参数可展开子规则。

ALTER SUBSCRIPTION · 语法 2

ALTER SUBSCRIPTION · 语法 3

ALTER SUBSCRIPTION · 语法 4

ALTER SUBSCRIPTION · 语法 5

ALTER SUBSCRIPTION · 语法 6

ALTER SUBSCRIPTION · 语法 7

ALTER SUBSCRIPTION · 语法 8

ALTER SUBSCRIPTION · 语法 9

ALTER SUBSCRIPTION · 语法 10

ALTER SUBSCRIPTION · 语法 11

语法概要

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 SKIP ( skip_option = value )
ALTER SUBSCRIPTION name OWNER TO { new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
ALTER SUBSCRIPTION name RENAME TO new_name

PostgreSQL 18 手册 · 查看完整参考页

描述

ALTER SUBSCRIPTION可以更改大多数可在 CREATE SUBSCRIPTION中指定的订阅属性。

要使用ALTER SUBSCRIPTION，你必须拥有该订阅。要重命名订阅或更改其所有者，你必须在数据库上具有 CREATE权限。此外，要更改所有者，你必须能够对新的拥有角色执行 SET ROLE。如果该订阅具有 password_required=false，则只有超级用户可以修改它。

刷新发布时，会移除不再属于该发布的关系；如果存在表同步槽，也会一并删除。必须删除这些槽，才能释放远端主机上为该订阅分配的资源。如果由于网络故障或其他错误， PostgreSQL无法删除这些槽，则会报告错误。在这种情况下，如需继续，用户要么重试该操作，要么按DROP SUBSCRIPTION中的说明将该槽与订阅解除关联并删除该订阅。

命令ALTER SUBSCRIPTION ... REFRESH PUBLICATION、带有refresh = true选项的 ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ...、 ALTER SUBSCRIPTION ... SET (failover = true|false)以及 ALTER SUBSCRIPTION ... SET (two_phase = false) 不能在事务块内执行。

命令ALTER SUBSCRIPTION ... REFRESH PUBLICATION以及带有refresh = true选项的 ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ...，在订阅启用了 two_phase 参数时也不能执行，除非 copy_data 为false。要了解实际的两阶段状态，可参见 pg_subscription 的subtwophasestate列。

参数

name

要更改其属性的订阅名称。

CONNECTION 'conninfo'

该子句替换最初由CREATE SUBSCRIPTION设置的连接字符串。详情请参见该命令。

SET PUBLICATION publication_name ADD PUBLICATION publication_name DROP PUBLICATION publication_name

这些形式会更改已订阅发布的列表。SET用新列表替换整个发布列表， ADD向发布列表中添加额外的发布，而DROP 从发布列表中移除发布。在ADD和SET变体中，允许指定不存在的发布，以便用户稍后再创建这些发布。详情请参见 CREATE SUBSCRIPTION。默认情况下，此命令还会执行与 REFRESH PUBLICATION类似的操作。

publication_option指定此操作的附加选项。支持的选项有：

refresh (boolean): 为false时，该命令不会尝试刷新表信息。此时应单独执行 REFRESH PUBLICATION。默认值为true。

此外，还可以指定REFRESH PUBLICATION下描述的选项，以控制隐式执行的刷新操作。

REFRESH PUBLICATION

从发布者获取缺失的表信息。这将开始复制自 CREATE SUBSCRIPTION 或上次执行REFRESH PUBLICATION以来添加到已订阅发布中的表。

refresh_option指定刷新操作的附加选项。支持的选项有：

copy_data (boolean)

指定在复制开始时，是否复制所订阅发布中预先存在的数据。默认值为true。

以前已订阅的表不会再次复制，即使某个表的行过滤器 WHERE子句此后已被修改。

关于copy_data = true如何与 origin 参数相互作用的细节，请参见Notes。

关于以二进制格式复制预先存在的数据的细节，请参见 CREATE SUBSCRIPTION的 binary 参数。

ENABLE

启用先前已禁用的订阅，并在事务结束时启动逻辑复制工作进程。

DISABLE

禁用正在运行的订阅，并在事务结束时停止逻辑复制工作进程。

SET ( subscription_parameter [= value] [, ... ] )

该子句修改最初由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，远端事务 ID xid）。要手工处理这类事务，需要回滚名称中包含相应订阅 ID 的所有预备事务。应用可以检查 pg_prepared_xacts 来找出所需的预备事务。在two_phase选项从true 改为false之后，这些事务在提交时会由发布者再次复制。

SKIP ( skip_option = value )

跳过应用远端事务的所有更改。如果传入数据违反任何约束，逻辑复制会停止，直到问题解决。通过使用ALTER SUBSCRIPTION ... SKIP命令，逻辑复制工作进程会跳过该事务中的所有数据修改操作。若订阅者上启用了 two_phase，则此选项对因在订阅者上启用该参数而已经预备的事务没有作用。逻辑复制工作进程成功跳过该事务或完成一个事务后， LSN（存储在pg_subscription.subskiplsn中）会被清除。有关逻辑复制冲突的详细信息，请参见 Section 29.7。

skip_option指定此操作的选项。支持的选项有：

lsn (pg_lsn): 指定逻辑复制工作进程要跳过其更改的远端事务的完成 LSN。完成 LSN 是该事务提交或预备时所在的 LSN。不支持跳过单个子事务。设置 NONE会重置该 LSN。

new_owner

订阅新所有者的用户名。

new_name

订阅的新名称。

当指定boolean类型的参数时，可以省略 = value 部分，这等价于指定TRUE。

示例

将订阅所订阅的发布更改为insert_only：

ALTER SUBSCRIPTION mysub SET PUBLICATION insert_only;

禁用（停止）该订阅：

ALTER SUBSCRIPTION mysub DISABLE;

兼容性

ALTER SUBSCRIPTION是PostgreSQL 的一个扩展。

另见

CREATE SUBSCRIPTION, DROP SUBSCRIPTION, CREATE PUBLICATION, ALTER PUBLICATION

语法演化

相邻大版本之间的差异，新的在前。版本号链接到对应快照。

PostgreSQL 20← 19正文更新

正文更新
PostgreSQL 19← 18语法变化

+ ALTER SUBSCRIPTION name SERVER server_name+ ALTER SUBSCRIPTION name REFRESH SEQUENCES正文更新
PostgreSQL 18← 17正文更新

正文更新
PostgreSQL 17← 16正文更新

正文更新
PostgreSQL 16← 15正文更新

正文更新
PostgreSQL 15← 14正文更新

正文更新
PostgreSQL 14← 13语法变化

+ 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 SKIP ( skip_option = value )+ ALTER SUBSCRIPTION name OWNER TO { new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }− ALTER SUBSCRIPTION name SET PUBLICATION publication_name [, ...] [ WITH ( set_publication_option [= value] [, ... ] ) ]− ALTER SUBSCRIPTION name OWNER TO { new_owner | CURRENT_USER | SESSION_USER }正文更新

同组命令

命令	动词	对象	最近变更
LOGICAL REPLICATION逻辑复制6 条↑
`CREATE PUBLICATION`	CREATE	PUBLICATION	192 次
定义一个新的发布			现存
`ALTER PUBLICATION`	ALTER	PUBLICATION	192 次
修改发布的定义			现存
`DROP PUBLICATION`	DROP	PUBLICATION	—
移除一个发布			现存
`CREATE SUBSCRIPTION`	CREATE	SUBSCRIPTION	191 次
定义一个新的订阅			现存
`ALTER SUBSCRIPTION`	ALTER	SUBSCRIPTION	192 次
修改订阅的定义			现存
`DROP SUBSCRIPTION`	DROP	SUBSCRIPTION	—
移除一个订阅			现存

快速链接

版本轨迹

语法铁道图 PostgreSQL 18

语法概要

描述

参数

示例

兼容性

另见

语法演化

相关命令

同组命令