Cambiar un modelo de objeto - SDK de Node.js

Versión del esquema

Una versión de esquema identifica el estado de un esquema de dominio en un momento dado. Realm rastrea la versión de esquema de cada dominio y la utiliza para asignar los objetos de cada dominio al esquema correcto.

Las versiones del esquema son números enteros ascendentes que se pueden incluir opcionalmente en la configuración del dominio al abrirlo. Si una aplicación cliente no especifica un número de versión al abrir un dominio, este se configura de forma predeterminada como la versión. 0.

Migraciones

Una migración es una función que actualiza un dominio y los objetos que contiene de una versión de esquema a una versión más reciente. Las migraciones ofrecen la flexibilidad de cambiar los esquemas de objetos con el tiempo para incorporar nuevas funciones y refactorizaciones.

Al abrir un dominio existente con una versión de esquema posterior a la actual, Realm ejecuta una función de migración definida por usted. Esta función tiene acceso al número de versión del dominio y actualiza incrementalmente los objetos para que se ajusten al nuevo esquema.

Realm migra automáticamente ciertos cambios, como propiedades nuevas y eliminadas, pero no establece automáticamente valores para las nuevas propiedades a menos que el esquema de objeto actualizado especifique un valor predeterminado. Puede definir lógica adicional en la función de migración para personalizar aún más los valores de las propiedades.

Agregar una propiedad

Para agregar una propiedad a un esquema, agregue la nueva propiedad a la clase del objeto y establezca un schemaVersion del objeto de configuración del reino.

const Person = {
  name: 'Person',
  properties: {
    firstName: 'string',
    lastName: 'string',
    age: 'int'
  }
}

const realm = await Realm.open({
    schema: [Person],
    schemaVersion: 2
  });

Eliminar una propiedad

Para eliminar una propiedad de un esquema, elimínela de la clase del objeto y establezca un valor en el objeto schemaVersion de configuración del dominio. Eliminar una propiedad no afecta a los objetos existentes.

const realm = await Realm.open({
    schema: [Dog],
    schemaVersion: 2
  });

Cambiar el nombre de una propiedad

Para cambiar el nombre de una propiedad de objeto, cambie el nombre de la propiedad en el esquema del objeto y luego abra el ámbito con una versión de esquema incrementada y una función de migración que actualice los objetos existentes para usar el nuevo nombre de propiedad.

Las migraciones no permiten cambiar el nombre de una propiedad directamente. En su lugar, se puede crear una nueva propiedad con el nombre actualizado, copiar el valor de la propiedad anterior y, a continuación, eliminarla.

Realm.open({
  schema: [Person],
  schemaVersion: 2,
  onMigration: (oldRealm, newRealm) => {
    // only apply this change if upgrading to schemaVersion 2
    if (oldRealm.schemaVersion < 2) {
      const oldObjects = oldRealm.objects('Person');
      const newObjects = newRealm.objects('Person');
      // loop through all objects and set the fullName property in the new schema
      for (const objectIndex in oldObjects) {
        const oldObject = oldObjects[objectIndex];
        const newObject = newObjects[objectIndex];
        newObject.fullName = `${oldObject.firstName} ${oldObject.lastName}`;
      }
    }
  }
});

Modificar un tipo de propiedad

Para modificar el tipo de una propiedad, configure el tipo de propiedad del campo que desea modificar con el nuevo tipo de dato. A continuación, configure schemaVersion una migration función de devolución de llamada y una del objeto de configuración del dominio.

const realm = await Realm.open({
    schema: [Dog],
    schemaVersion: 2,
    onMigration: (oldRealm, newRealm) => {
        if(oldRealm.schemaVersion < 2){
            const oldObjects = oldRealm.objects('Dog');
            const newObjects = newRealm.objects('Dog');
            // loop through all objects and set the _id property in the new schema
            for (const objectIndex in oldObjects) {
              const oldObject = oldObjects[objectIndex];
              const newObject = newObjects[objectIndex];
              newObject._id = oldObject._id.toHexString();
            }
        }
    },
  });