CREATE SUBSCRIPTION

CREATE SUBSCRIPTION — 定义一个新的订阅

Synopsis

CREATE SUBSCRIPTION subscription_name
    CONNECTION 'conninfo'
    PUBLICATION publication_name [, ...]
    [ WITH ( subscription_parameter [= value] [, ... ] ) ]

描述

CREATE SUBSCRIPTION为当前数据库添加一个新的订阅。 订阅名称必须与数据库中任何现有的订阅不同。

订阅表示到发布者的复制连接。因此,此命令不仅在本地目录中添加定义, 还会在发布者上创建复制插槽。

在运行此命令的事务提交时,将启动逻辑复制工作器以复制新订阅的数据。

关于订阅和逻辑复制的更多信息,请参见 Section 30.2Chapter 30

参数

subscription_name

新订阅的名称。

CONNECTION 'conninfo'

连接发布者的字符串。详细信息请见Section 32.1.1

PUBLICATION publication_name

要订阅的发布者上的发布名称。

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

该子句指定订阅的可选参数。支持的参数有:

copy_data (boolean)

指定在复制启动后是否应复制正在订阅的发布中的现有数据。 默认值是true

create_slot (boolean)

指定该命令是否要在发布者上创建复制槽。默认值是true

enabled (boolean)

指定订阅是否应该主动复制,或者是否应该只是设置,但尚未启动。 默认值是true

slot_name (string)

要使用的复制插槽的名称。默认行为是使用订阅名称作为插槽的名称。

slot_name设置为NONE时, 将不会有复制槽与订阅关联。这在需要稍后手动设置复制槽的情况下会使用。 这样的订阅必须同时enabled并且 create_slot设置为false

synchronous_commit (enum)

在这个订阅的应用worker进程时,该参数的值会覆盖synchronous_commit设置。 默认值是off

对于逻辑复制使用off是安全的: 如果订阅者由于缺少同步而丢失事务,数据将从发布者再次发送。

进行同步逻辑复制时,不同的设置可能是合适的。 逻辑复制工作者向发布者报告写入和刷新的位置,当使用同步复制时, 发布者将等待实际刷新。这意味着,当订阅用于同步复制时, 将订阅者的synchronous_commit设置为off 可能会增加发布服务器上COMMIT的延迟。 在这种情况下,将synchronous_commit设置为 local或更高是有利的。

binary (boolean)

指定订阅是否要求发布器以二进制格式(相对的是文本格式)发送数据。 默认值是false。 即使此选项被启用,也只有具备二进制发送和接收函数的数据类型将以二进制传输。

在进行跨版本复制时,可能会出现发布器具有某些数据类型的二进制发送函数,但订阅器缺乏针对此类型的二进制接收函数的情况。 在这种情况下,数据传输将失败,并且binary选项不能被使用。

connect (boolean)

指定CREATE SUBSCRIPTION是否应该连接到发布者。 将其设置为false将会改变默认值enabledcreate_slotcopy_datafalse

不允许将connect设置为false的同时将 enabledcreate_slotcopy_data 设置为true

因为该选项设置为false时不会建立连接, 因此表没有被订阅,所以当启用订阅后,不会复制任何内容。 需要运行ALTER SUBSCRIPTION ... REFRESH PUBLICATION才能订阅表。

streaming (boolean)

指定是否对此订阅启用进行中事务的流。 默认情况下,所有事务都在发布器上完全解码,直到那时才作为整体发送给订阅器。

注意

有关如何在订阅和发布实例之间配置访问控制的详细信息,请参见 Section 30.7

创建复制槽时(默认行为), CREATE SUBSCRIPTION不能在事务块内部执行。

如果复制插槽不是作为同一命令的一部分创建的,则创建连接到相同数据库集群的订阅 (例如,在同一集群中的数据库之间进行复制或在同一个数据库中进行复制)只能成功 否则,CREATE SUBSCRIPTION调用将挂起。要做到这一点, 单独创建复制插槽(使用函数pg_create_logical_replication_slot 和插件名称pgoutput),并使用参数create_slot = false 创建订阅。这是一个实施限制,可能会在未来的版本中解除。

示例

创建一个到远程服务器的订阅,复制发布mypublicationinsert_only中的表,并在提交时立即开始复制:

CREATE SUBSCRIPTION mysub
         CONNECTION 'host=192.168.1.50 port=5432 user=foo dbname=foodb'
        PUBLICATION mypublication, insert_only;

创建一个到远程服务器的订阅,复制insert_only发布中的表, 并且不开始复制直到稍后启用复制。

CREATE SUBSCRIPTION mysub
         CONNECTION 'host=192.168.1.50 port=5432 user=foo dbname=foodb'
        PUBLICATION insert_only
               WITH (enabled = false);

兼容性

CREATE SUBSCRIPTION是一个LightDB 扩展。

又见

ALTER SUBSCRIPTION, DROP SUBSCRIPTION, CREATE PUBLICATION, ALTER PUBLICATION