同期された Realm を設定して開く - Node.js SDK

同期された Realm

Realm を構成して、それぞれがデータのローカル コピーを持つ多数のデバイス間でデータを自動的に同期できます。 同期された Realm はローカル専用の Realm とは異なる構成を使用するため、同期プロセスを処理するには Atlas App Services バックエンド が必要です。

アプリケーションは、オフラインでも、ローカルで同期された Realm オブジェクトをいつでも作成、変更、削除できます。 ネットワーク接続が利用可能になるたびに、Realm SDK はアプリケーション サーバーへの接続を開き、他のクライアントとの間での変更を同期します。 Atlas Device Sync プロトコルとサーバー側の運用変換では、特定の変更がオフラインで発生したり、正しい順序で受信されなかった場合でも、Realm の完全に同期されたすべてのインスタンスが完全に同じデータを参照することが保証されます。

前提条件

Node.js アプリケーションで Flexible Sync を使用して Realm を構成する前に、

1. バックエンド で Flexible Sync を有効にします。 Flexible Sync は、クライアント アプリケーションで使用する前に、バックエンドで構成する必要があります。

2. アプリ クライアントを初期化します。

3. クライアント プロジェクトでユーザーを認証します。

同期された Realm を開く

Device Sync を実装する最初のステップは、同期された Realm を開くことです。 以下の情報は、Flexible Sync を使用するアプリに関連します。 既存のアプリが古いパーティションベースの同期を使用している場合は、「パーティションベースの同期 Realm を開く」を参照してください。 どれを使用するかをまだ決定していない、または不明な場合は、[同期モードの選択 ] ページをお読みください。

Flexible Sync を使用して Realm を開くには、 Realm.open()を呼び出します。 ConfigurationWithSyncオブジェクトを渡します。このオブジェクトには、 SyncConfigurationオブジェクトを定義する syncプロパティが含まれている必要があります。 同期構成では、 userとflexible:trueを含める必要があります。

const realm = await Realm.open({
  schema: [TaskSchema, TeamSchema],
  sync: {
    user: app.currentUser,
    flexible: true,
  },
});

デフォルトでは、Realm は返す前にサーバーからのすべてのデータを同期します。 バックグラウンドでデータを同期する場合は、 「 オフライン時に同期された Realm を開く」セクションをお読みください。

const app = new Realm.App({ id: APP_ID, baseFilePath: customPath });
const user = await app.logIn(Realm.Credentials.anonymous());
const realm = await Realm.open({
  schema: [Car],
  sync: {
    flexible: true,
    user,
  },
});

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

Realm アプリケーションはユーザーを認証する際、ユーザーの認証情報をキャッシュします。 既存のユーザー認証情報を確認して、ログイン フローをバイパスし、キャッシュされたユーザーにアクセスできます。 これを使用して、Realm をオフラインで開きます。

// Log user into your App Services App.
// On first login, the user must have a network connection.
const getUser = async () => {
  // If the device has no cached user credentials, log in.
  if (!app.currentUser) {
    const credentials = Realm.Credentials.anonymous();
    await app.logIn(credentials);
  }
  // If the app is offline, but credentials are
  // cached, return existing user.
  return app.currentUser!;
};

次のサブセクションでは、バックグラウンド同期を使用してオフラインのときに Realm にアクセスする方法を示します。 これを行うには、キャッシュされたユーザーとOpenRealmBehaviorConfigurationオブジェクトを使用します。

同期構成内で、オプションのnewRealmFileBehavior existingRealmFileBehaviorフィールドと フィールドをOpenRealmBehaviorConfiguration オブジェクトに設定して、バックグラウンド同期を有効にします。

const behaviorConfiguration = {
  type: "openImmediately",
};
const config = {
  schema: [Car],
  sync: {
    user: await getUser(),
    flexible: true,
    newRealmFileBehavior: behaviorConfiguration,
    existingRealmFileBehavior: behaviorConfiguration,
  },
};
const realm = await Realm.open(config);

const behaviorConfiguration: Realm.OpenRealmBehaviorConfiguration = {
  type: "openImmediately",
};
const config: Realm.Configuration = {
  schema: [Car],
  sync: {
    user: await getUser(),
    flexible: true,
    newRealmFileBehavior: behaviorConfiguration,
    existingRealmFileBehavior: behaviorConfiguration,
  },
};
const realm = await Realm.open(config);

const behaviorConfiguration = {
  type: "openImmediately",
  timeOut: 1000,
  timeOutBehavior: "openLocalRealm",
};
const config = {
  schema: [Car],
  sync: {
    flexible: true,
    user: await getUser(),
    existingRealmFileBehavior: behaviorConfiguration,
    newRealmFileBehavior: behaviorConfiguration,
  },
};
const realm = await Realm.open(config);

const behaviorConfiguration: Realm.OpenRealmBehaviorConfiguration = {
  type: "openImmediately",
  timeOut: 1000,
  timeOutBehavior: "openLocalRealm",
};
const config: Realm.Configuration = {
  schema: [Car],
  sync: {
    flexible: true,
    user: await getUser(),
    existingRealmFileBehavior: behaviorConfiguration,
    newRealmFileBehavior: behaviorConfiguration,
  },
};
const realm = await Realm.open(config);

バックグラウンドでの変更の同期

同期された Realm がサーバーからデータをダウンロードする間にユーザーに部分的なデータを表示するために、バックグラウンドで変更を同期してユーザー エクスペリエンスがブロックされるのを防ぐ場合があります。 ユーザーのデバイスがオフラインになる可能性があるアプリケーションでは、バックグラウンドで変更を同期することをお勧めしGo 。 バックグラウンドで変更を同期するには、同期された Realm を同期的に開きます。

OpenRealmBehaviorConfigurationオブジェクトを作成し、そのtypeを"openImmediately"に設定します。

const behaviorConfiguration = {
  type: "openImmediately",
};

const behaviorConfiguration: Realm.OpenRealmBehaviorConfiguration = {
  type: Realm.OpenRealmBehaviorType.OpenImmediately,
};

構成オブジェクトを作成します。このオブジェクトには、 SyncConfigurationオブジェクトを定義するsyncプロパティが含まれている必要があります。 このOpenRealmBehaviorConfiguration オブジェクトをnewRealmFileBehavior existingRealmFileBehaviorの フィールドとSyncConfiguration フィールドの値として設定します。

const config = {
  schema: [DogSchema],
  sync: {
    user: app.currentUser,
    partitionValue: "MyPartitionValue",
    // The behavior to use when this is the first time opening a realm.
    newRealmFileBehavior: behaviorConfiguration,
    // The behavior to use when a realm file already exists locally,
    // i.e. you have previously opened the realm.
    existingRealmFileBehavior: behaviorConfiguration,
  },
};

const config: Realm.Configuration = {
  schema: [DogSchema],
  sync: {
    user: app.currentUser!,
    partitionValue: "MyPartitionValue",
    // The behavior to use when this is the first time opening a realm.
    newRealmFileBehavior: behaviorConfiguration,
    // The behavior to use when a realm file already exists locally,
    // i.e. you have previously opened the realm.
    existingRealmFileBehavior: behaviorConfiguration,
  },
};

最後に、 Realm.open()を呼び出して、同期された Realm を開きます。 これにより、同期セッションが作成され、バックグラウンドでサーバーから既存のデータのダウンロードが開始されます。

const realm = await Realm.open(config);

タイムアウト後に非同期操作をキャンセルする

baseSyncConfigurationオブジェクトでcancelWaitsOnNonFatalErrorsプロパティを指定できます。

trueの場合、Node.js SDK は、タイムアウト期間が経過すると、アップロードやダウンロードの待機などの非同期操作をキャンセルします。 AppConfigurationでこのオプションのタイムアウトを定義できます。 例については、「 アプリ クライアントのタイムアウトの構成 」を参照してください。

このプロパティは、値を指定しない場合、デフォルトでfalseになります。

const config = {
  schema: [Doggie],
  sync: {
    flexible: true,
    user: app.currentUser,
    // When `true`, upload and download waits are canceled on any
    // error, such as a timeout, instead of just a fatal error.
    // You can provide an optional timeouts property in milliseconds.
    cancelWaitsOnNonFatalError: true,
  },
};

const config: Realm.Configuration = {
  schema: [Doggie],
  sync: {
    flexible: true,
    user: app.currentUser!,
    // When `true`, upload and download waits are canceled on any
    // error, such as a timeout, instead of just a fatal error.
    // You can provide an optional timeouts property in milliseconds.
    cancelWaitsOnNonFatalError: true,
  },
};