捆绑Realm文件 - Node SDK

Overview

要创建 Realm 文件并将其与应用程序捆绑在一起，请执行以下操作：

1. 创建一个 Realm 文件，其中包含要捆绑的数据。

2. 将捆绑的域文件添加到生产应用程序中。

3. 在生产应用程序中，从捆绑的资产文件中打开域 。 对于同步 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为 Configuration 的sync字段配置同步 Realm。 要创建本地 Realm 的副本，请不要在配置对象中包含sync字段。

4. 请注意捆绑域文件的文件路径，该文件可以在上一步中传递给writeCopyTo()的参数指定的位置找到。 您需要此文件才能在生产应用程序中使用捆绑域 ，如下一节所述。

   temp_realm_app

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

在生产应用程序中捆绑 Realm 文件

现在您已拥有包含初始数据的 Realm 副本，请将其与生产应用程序捆绑在一起。

将上一节中创建的捆绑域文件添加到生产应用程序中。

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

从捆绑的 Realm 文件中打开 Realm

现在您已经拥有生产应用程序中包含的 Realm 副本，您需要添加代码来使用它。

创建一个配置，将捆绑域的路径作为path字段的值。 将该配置传递给Realm.open() 方法。 现在，您可以在刚刚打开的域中使用来自捆绑域的数据。

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

捆绑同步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 的更多信息，请参阅基于分区的同步- Node.js SDK。