★PostgreSQLカンファレンス2024 12月6日開催/チケット販売中★
他のバージョンの文書 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

CREATE SUBSCRIPTION

CREATE SUBSCRIPTION — 新しいサブスクリプションを定義する

概要

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

説明

CREATE SUBSCRIPTIONは現在のデータベースに新しいサブスクリプションを追加します。 サブスクリプションの名前は現在のデータベースに存在するどのサブスクリプションの名前とも異なるものでなければなりません。

サブスクリプションはパブリッシャーへのレプリケーション接続を表します。 そのためこのコマンドはローカルのカタログに定義を追加するだけでなく、パブリッシャーのレプリケーションスロットも作成します。

このコマンドが実行されるトランザクションがコミットされた時点で、新しいサブスクリプションに対してデータを複製する論理レプリケーションワーカが開始されます。

サブスクリプションおよび論理レプリケーションの全体像についての追加情報は31.2および第31章に記述されています。

パラメータ

subscription_name

新しいサブスクリプションの名前です。

CONNECTION 'conninfo'

パブリッシャーへの接続文字列です。 詳細は34.1.1を参照してください。

PUBLICATION publication_name

パブリッシャー上のパブリケーションで、サブスクリプションの対象となるものの名前です。

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

この句ではサブスクリプションのオプションパラメータを指定します。 以下のパラメータがサポートされています。

copy_data (boolean)

サブスクリプションの対象となるパブリケーションの既存データが、レプリケーションの開始時にコピーされるかどうかを指定します。 デフォルトはtrueです。

create_slot (boolean)

このコマンドがパブリッシャー上にレプリケーションスロットを作るかどうかを指定します。 デフォルトはtrueです。

enabled (boolean)

サブスクリプションが複製の動作をすぐに行うか、あるいは単に設定をするだけでまだ開始しないかを指定します。 デフォルトはtrueです。

slot_name (string)

使用するレプリケーションスロットの名前です。 デフォルトの挙動では、サブスクリプションの名前をスロット名として使用します。

slot_nameNONEに設定すると、サブスクリプションに紐付けられたレプリケーションスロットがなくなります。 これはレプリケーションスロットを後で手作業で作成する場合に使用できます。 そのようなサブスクリプションは、enabledcreate_slotの両方をfalseに設定しなければなりません。

synchronous_commit (enum)

このパラメータの値は、このサブスクリプションの適用されるワーカプロセスのsynchronous_commitの設定をオーバーライドします。 デフォルト値はoffです。

論理レプリケーションではoffを使用するのが安全です。 そうすることで、同期の失敗によりサブスクライバーがトランザクションを失った場合でも、パブリッシャーからデータが再送されます。

同期論理レプリケーションを行う場合は別の設定が適切かもしれません。 論理レプリケーションのワーカは書き込みおよび吐き出しの位置をパブリッシャーに報告しますが、同期レプリケーションを行っているときは、パブリッシャーは実際に吐き出しがされるのを待ちます。 これはつまり、サブスクリプションが同期レプリケーションで使われている時に、サブスクライバーのsynchronous_commitoffに設定すると、パブリッシャーでのCOMMITの遅延が増大するかもしれない、ということを意味します。 この場合、synchronous_commitlocalまたはそれ以上に設定することが有利になりえます。

binary (boolean)

サブスクリプションがパブリッシャーにデータを(テキストではなく)バイナリ形式で送るよう要求するかどうかを指定します。 デフォルトはfalseです。 このオプションが有効な場合でも、バイナリ送受信関数のあるデータ型だけがバイナリで転送されます。

バージョンをまたいでレプリケーションをしている場合は、パブリッシャーはあるデータ型に対してバイナリ送信関数を持っているものの、サブスクライバーはその型に対してバイナリ受信関数を持っていないという場合があり得ます。 その場合、データ転送は失敗し、binaryオプションは使えません。

connect (boolean)

CREATE SUBSCRIPTIONがパブリッシャーに接続するかどうかを指定します。 これをfalseに設定すると、enabledcreate_slotcopy_dataのデフォルト値をfalseに変更します。

connectfalseに設定し、enabledcreate_slotまたはcopy_datatrueに設定することは許されません。

このオプションがfalseに設定されると接続が行われないため、テーブルはサブスクライブされません。 そのため、サブスクリプションを有効にしても、何も複製されません。 テーブルをサブスクライブするには、ALTER SUBSCRIPTION ... REFRESH PUBLICATIONを実行する必要があります。

streaming (boolean)

進行中のトランザクションのストリーミングをこのサブスクリプションで有効にするかどうかを指定します。 デフォルトでは、すべてのトランザクションはパブリッシャーで完全にデコードされ、その後でのみ全体としてサブスクライバーに送られます。

注釈

サブスクリプションとパブリケーションのインスタンスの間のアクセス制御をどのように設定するかの詳細については、31.7を参照してください。

レプリケーションスロットを作成する(デフォルトの動作です)場合、CREATE SUBSCRIPTIONをトランザクションブロックの内側で実行することはできません。

同じデータベースクラスタに接続するサブスクリプション(例えば、同一のクラスタ内のデータベース間で複製を行う、あるいは同一のデータベース内で複製を行う)の作成は、同じコマンド内でレプリケーションスロットが作成されない場合にのみ成功します。 そうでない場合、CREATE SUBSCRIPTIONの呼び出しはハングアップします。 これを動作させるには、(関数pg_create_logical_replication_slotをプラグイン名pgoutputで使って)レプリケーションスロットを別に作り、パラメータcreate_slot = falseを使ってサブスクリプションを作成してください。 これは実装上の制限で、将来のリリースでは解決されるかもしれません。

パブリケーションmypublicationおよびinsert_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 SUBSCRIPTIONPostgreSQLの拡張です。

関連項目

ALTER SUBSCRIPTION, DROP SUBSCRIPTION, CREATE PUBLICATION, ALTER PUBLICATION