Agrupar un archivo de reino - Node SDK

Overview

Para crear y agrupar un archivo de reino con su aplicación:

1. Crea un archivo de reino que contenga los datos que deseas agrupar.

2. Añade el archivo realm empaquetado a tu aplicación de producción.

3. En su aplicación de producción, abra el dominio desde el archivo de recursos incluido. Para dominios sincronizados, debe incluir la clave de partición.

Crear un archivo de reino para agrupar

1. Build a temporary realm app that shares the data model of your application.

2. Open a realm and add the data you wish to bundle. If using a synchronized realm, allow time for the realm to fully sync.

3. Utiliza el método writeCopyTo() para copiar el realm a un nuevo archivo:

   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() automatically compacts your realm to the smallest possible size before copying.

   Nota

   Diferencias entre reinos sincronizados y reinos solo locales

   El ejemplo anterior utiliza una SyncConfiguration para configurar un realm sincronizado para el campo sync de la Configuration. Para crear una copia de un realm local, no incluyas el campo sync en tu objeto Configuration.

4. Tome nota de la ruta del archivo realm incluido, que puede encontrarse en la ubicación especificada en el argumento pasado a writeCopyTo() en el paso anterior. Necesitarás este archivo para usar el realm incluido en tu aplicación de producción, como se describe en la siguiente sección.

   temp_realm_app

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

Incluya un archivo Realm en su aplicación de producción

Ahora que tiene una copia del reino que contiene los datos iniciales, inclúyalo en su aplicación de producción.

Añade el archivo Realm empaquetado creado en la sección anterior a tu aplicación de producción.

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

Open a Realm from a Bundled Realm File

Ahora que tienes una copia del realm incluida con tu aplicación de producción, debes agregar código para usarla.

Cree una configuración con la ruta al dominio incluido como valor para el path campo. Pase esa configuración al método Realm.open(). Ahora puede trabajar con los datos de su dominio incluido en el dominio que acaba de abrir.

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

Agrupa un reino sincronizado

Generally, bundling a synchronized realm works the same as bundling a local-only realm. However, you can only bundle fully synchronized realms. Make sure that the realm has fully synchronized with the server before bundling:

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");

Further limitations exist when opening a bundled synchronized realm that uses the older Partition-Based Sync. For more information on using realms configured with Partition-Based Sync, refer to Partition-Based Sync - Node.js SDK.