Realm ファイルのバンドル - Node SDK

Overview

Realm ファイルを作成してアプリケーションにバンドルするには、次の手順に従います。

1. バンドルするデータを含むRealm ファイルを作成します。

2. バンドルされている Realm ファイルを本番アプリケーションに追加します。

3. 本番アプリケーションで、バンドルされた アセット ファイル から Realm を開きます。 同期された Realm の場合は、パーティション キーを含める必要があります。

バンドル用の Realm ファイルの作成

1. アプリケーションのデータモデルを共有する一時的な Realm アプリを構築します。

2. Realm を開き、バンドルするデータを追加します。 同期された Realm を使用する場合は、Realm が完全に同期するまで時間を待ちます。

3. writeCopyTo()メソッドを使用して、Realm を新しいファイルにコピーします。

   const originalPath = path.join(__dirname, "original.realm");
   const originalConfig = {
     schema: [Car],
     path: originalPath,
   };
   const originalRealm = await Realm.open(originalConfig);
   const copyPath = path.join(__dirname, "copy.realm");
   originalRealm.writeCopyTo(copyPath);

   writeCopyTo() は、コピーする前に Realm を可能な限り最小のサイズに自動的に圧縮します。

   注意

   同期された Realm とローカル専用 Realm の違い

   上記の例では、 SyncConfigurationを使用して、 構成 のsyncフィールドに同期された Realm を構成します。 ローカル Realm のコピーを作成するには、構成オブジェクトにsyncフィールドを含めないでください。

4. バンドルされた Realm ファイルのファイルパスに注目してください。このファイルは、前のステップでwriteCopyTo()に渡された 引数で指定された場所にあります。 次のセクションで説明されているように、本番アプリケーションでバンドルされた Realm を使用するにはこのファイルが必要になります。

   temp_realm_app

   .
   ├── copyOfDefault.realm
   ... rest of files in _temp_ application

本番アプリケーションでの Realm ファイルのバンドル

初期データを含む Realm のコピーが用意できたら、それを本番アプリケーションにバンドルします。

前のセクションで作成されたバンドルされた Realm ファイルを本番アプリケーションに追加します。

.
├── copyOfDefault.realm
... rest of files in _prod_ application

バンドルされた Realm ファイルから Realm を開く

本番アプリケーションに含まれる Realm のコピーが作成できたら、それを使用するためのコードを追加する必要があります。

バンドルされた Realm へのパスをpathフィールドの値として持つ構成を作成します。 その構成をRealm.open() 使用して複数のドキュメントを挿入できます。 これで、作成したRealmでバンドルされたRealmのデータを操作できるようになります。

const copyConfig = {
  schema: [Car],
  path: "path/to/bundled/file.realm"
};
const copyRealm = await Realm.open(copyConfig);

同期された Realm のバンドル

一般的に、同期された Realm のバンドルは、ローカル専用 Realm のバンドルと同じように機能します。 ただし、バンドルできる Realm は完全に同期されたもののみです。 バンドルする前に、Realm がサーバーと完全に同期していることを確認してください。

const config = {
  sync: {
    user: app.currentUser,
    partitionValue: app.currentUser.id,
  },
  schema: [Car],
};
const realm = await Realm.open(config);
// create many changes
realm.write(() => {
  for (let i = 0; i < 25; i++) {
    realm.create("Car", {
      make: "Toyota",
      model: "Prius",
      miles: i,
      owner: app.currentUser.id,
    });
  }
});
// ensure synchronize all changes before copy
await realm.syncSession.uploadAllLocalChanges();
await realm.syncSession.downloadAllServerChanges();
// changes are synchronized -- we can copy the realm
realm.writeCopyTo(__dirname + "syncedCopy.realm");

古いパーティションベースの同期を使用するバンドルされた同期 Realm を開くには、さらに制限があります。 パーティションベースの同期 で構成された Realm の使用の詳細については、「パーティションベースの同期 - Node.js SDK 」を参照してください。