概要
Sync Gatewayを使用すると、データベースをオフラインにしてオンラインに戻すことができます。これは、Sync Gatewayインスタンスを停止することなく実行されます。
データベースのステータス(オンラインまたはオフライン)の変更は、アドレス指定された特定のSync Gatewayインスタンスでのみ発生します。同じデータベースを使用する(Sync Gatewayクラスターの)他のSync Gatewayインスタンスには反映されません。
ユースケース
データベースのオフライン/オンライン機能の具体的な用途は次のとおりです。
- 他のデータベースに影響を与えることなく、データベースをオフラインにします。
- Sync Gatewayを再起動せずに、データベースの構成プロパティを(オフライン中に)変更します。
- オフライン中にデータベースを再同期します。
- 失われたDCPまたはTAPフィードを検出し、データベースを自動的にオフラインにします。
- オフライン状態でデータベースを作成し、データベースのサービス提供の開始を延期したり、Sync Gatewayインスタンス間で調整したりできるようにします。
- Couchbase Serverのアップグレードを実行します。
アクション
- データベースをオフラインにする:POST
/{db}/_offset
- データベースをオンラインにする:POST
/{db}/_online
デフォルトでは、Sync Gatewayが起動すると、構成ファイルで定義されているすべてのデータベースがオンラインになります。Sync Gatewayの起動時にデータベースをオフラインに保つには、offline
構成プロパティをデータベース構成プロパティに追加します。
後で、データベースをオンラインにするために、POST /{tkn-db}/_online
Admin RESTAPIリクエストを使用できます。
自動オフライン
Sync Gatewayは、データベースのDCPまたはTAPフィードを失うと、データベースを自動的にオフラインにします。これにより、原因を調査して修正することができます。
原因が解決され、フィードが復元されたら、Admin REST APIリクエストを使用してデータベースをオンラインに戻します。
状態図
以下の状態図は、Sync Gatewayの状態と、Sync GatewayとCouchbase Serverデータベース間の接続を表しています。
- Sync Gatewayインスタンスを開始または停止すると、そのインスタンスがサービスを提供するすべてのデータベースへの接続に影響します。
- 特定のデータベースに対して操作を実行します。たとえば、2つのデータベースをオンラインにし、3つ目のデータベースをオフラインにして再同期し、オンラインに戻すことができます。
関連情報