パーティションベースの同期 - Java SDK

オンライン中に同期された Realm を開く

同期された Realm を開くには、 SyncConfiguration オブジェクトを渡して getInstanceAsync() を呼び出します。次のコードは、 SyncConfigurationオブジェクトを使用して作成された特定の同期設定で Realm を作成する方法を示しています。

SyncConfiguration config = new SyncConfiguration.Builder(app.currentUser(), PARTITION)
        .allowQueriesOnUiThread(true)
        .allowWritesOnUiThread(true)
        .build();
Realm.getInstanceAsync(config, new Realm.Callback() {
    @Override
    public void onSuccess(Realm realm) {
        Log.v(
                "EXAMPLE",
                "Successfully opened a realm with reads and writes allowed on the UI thread."
        );
    }
});

val config = SyncConfiguration.Builder(app.currentUser(), PARTITION)
    .allowQueriesOnUiThread(true)
    .allowWritesOnUiThread(true)
    .build()
Realm.getInstanceAsync(config, object : Realm.Callback() {
    override fun onSuccess(realm: Realm) {
        Log.v("EXAMPLE", "Successfully opened a realm with reads and writes allowed on the UI thread.")
    }
})

上記のコードは、 getInstanceAsync() を使用して、Realm を 非同期 に開く方法を示しています。また、 getInstance()を使用して、Realm を同期的に開くこともできます。これは、バックエンドからのすべてのデータを同期する前に開いている Realm を返します。 ただし、リモート データがダウンロードされている中に一時的なデータの不整合が発生する可能性があるため、通常は推奨されません。 waitForInitialMongoDB()構成オプションを使用すると、Realm を開く前に SDK にリモート データを取得させるよう強制して、こうした不整合を回避できます。

パーティション値は、同期するデータのどのサブセットを指定します。 これは通常、ユーザー ID、プロジェクト ID、ストア ID、または現在のユーザーに特定の関連性を持つアプリ内のその他のカテゴリ識別子です。

オフライン時に同期された Realm を開く

オンライン 中に同期された Realm を開くのに使用するのとまったく同じ構文で、オフラインのときに同期された Realm を開くことができます。 すべての SDK がこのパターンに従うわけではないため、クロスプラットフォーム開発者は各 SDK のドキュメントを参照して詳細を確認する必要があります。

移行後のクライアント コードの更新

パーティションベースの同期から Flexible Sync への自動移行には、クライアント コードを変更する必要はありません。 ただし、この機能をサポートするために、Realm は 2 つの同期モード間の違いを次の方法で自動的に処理します。

• partitionKey == partitionValueの各オブジェクトタイプの Flexible Sync サブスクリプションを自動的に作成します。

• すべてのオブジェクトにpartitionKeyフィールドを挿入します（フィールドがまだ存在しない場合）。 これは自動 Flexible Sync サブスクライブに必要です。

If you need to make updates to your client code after migration, consider updating your client codebase to remove hidden migration functionality. 次の場合には、クライアント コードベースを更新する必要がある場合があります。

• クライアント コードベースで新しいモデルを追加または変更する

• Realm オブジェクトの読み取りまたは書き込みを含む機能を追加または変更する場合

• 同期するデータの内容をより詳細に制御する機能を実装したい

Flexible Sync を使用するようにパーティションベースの同期クライアント コードを変換するには、次の変更を行います。

• を使用するように SyncConfiguration.Builder Flexible Syncを更新します。これには、必要に応じて、 partitionValueを削除し、一連の初期サブスクリプションを追加することが含まれます。

• Flexible Sync サブスクライブで使用する関連プロパティをオブジェクトモデルに追加します。 たとえば、ユーザーが自分のデータのみを同期できるようにするには、 ownerIdプロパティを追加します。

• 自動 Flexible Sync サブスクライブを削除します。 SyncConfiguration.Builderで初期サブスクリプションを追加しなかった場合は、関連するサブスクライブを手動で作成します。

これらの戦略にデータをモデル化する方法の例を含む、Flexible Sync 権限戦略の例については、 Device Sync 権限ガイド を参照してください。