Definir un esquema de objeto de reino - SDK de Flutter

Crear modelo

import 'package:realm/realm.dart';

import 'package:realm_dart/realm.dart';

part 'schemas.realm.dart';

@RealmModel()
class _Car {
  @PrimaryKey()
  late ObjectId id;
  late String make;
  late String? model;
  late int? miles;
}

dart run realm generate

dart run realm_dart generate

.
├── schemas.dart
├── schemas.realm.dart // newly generated file
├── myapp.dart
└── ...rest of application

import './schemas.dart';
final hondaCivic = Car(ObjectId(), 'Honda', model: 'Civic', miles: 99);

Uso de esquemas con sincronización de dispositivos

Un esquema de App Services es una lista de esquemas de objetos válidos, cada uno de los cuales define un tipo de objeto que una aplicación puede conservar. Todos los objetos sincronizados en un dominio deben cumplir con el esquema de App Services.

Las aplicaciones cliente proporcionan un esquema de objeto al abrir un dominio. Si un dominio ya contiene datos, ya tiene un esquema, y ​​al abrirlo, Realm valida el esquema en el cliente comparándolo con el esquema existente.

Puede definir esquemas de servicios de aplicaciones de las siguientes maneras:

• Automáticamente con el esquema de objeto si el modo de desarrollo está habilitado.

• Defina explícitamente el esquema de servicios de aplicaciones con Servicios de aplicaciones.

En su esquema, debe utilizar la anotación MapTo("_id") con su clave principal en RealmModel para sincronizar exitosamente su esquema de objeto con App Services.

@RealmModel()
class _SyncSchema {
  @PrimaryKey()
  @MapTo("_id")
  late ObjectId id;
  // ... other properties
}

Para obtener más información sobre cómo definir su esquema y cuál de estos enfoques debería considerar para su aplicación, consulte la documentación Crear un esquema de reino.

Tipos de datos admitidos

Los esquemas de dominio admiten muchos tipos de datos del lenguaje Dart, además de algunos tipos específicos de dominio. Para obtener una referencia completa de todos los tipos de datos compatibles, consulte Tipos de datos.

Anotaciones de propiedad

Utiliza anotaciones para añadir funcionalidades a las propiedades en tus modelos de objetos Realm. Puede usar anotaciones para cosas como marcar una propiedad como nullable, establecer una clave primaria, ignorar una propiedad y más. Para obtener más información sobre las anotaciones de propiedades disponibles, consulta Anotaciones de Propiedades.

Definir propiedades de relación

Puedes definir relaciones entre objetos de Realm en tu esquema. El SDK de Flutter para Realm admite relaciones a uno, a muchos, inversas e incrustación de objetos dentro de otros. Para obtener más información sobre cómo definir relaciones en el esquema de objetos de Realm, consulta Relaciones.

Asignar un modelo o clase a un nombre diferente

Puede usar la anotación MapTo para asignar un modelo de objeto o propiedad de Realm a un nombre almacenado diferente en Realm. Esto puede ser útil en los siguientes casos. Por ejemplo:

• Para facilitar el trabajo en plataformas donde las convenciones de nomenclatura difieren. Por ejemplo, si los nombres de las propiedades del esquema de sincronización de dispositivos usan mayúsculas y minúsculas, mientras que el proyecto usa mayúsculas y minúsculas.

• Para cambiar un nombre de clase o campo sin forzar una migración.

• Para admitir múltiples clases de modelos con el mismo nombre en diferentes paquetes.

• Para utilizar un nombre de clase que sea más largo que el límite de 57caracteres impuesto por Realm.

Si está utilizando Atlas Device Sync, el nombre que especifique en la MapTo anotación se utilizará como nombre de esquema de App Services persistente.

@RealmModel()
@MapTo('naval_ship')
class _Boat {
  @PrimaryKey()
  late ObjectId id;
  late String name;
  late int? maxKnots;
  late int? nauticalMiles;
}

class _Vehicle {
  @PrimaryKey()
  late ObjectId id;
  late String? maybeDescription; // optional value
  late double milesTravelled = 0; // 0 is default value
  @Ignored()
  late String notInRealmModel;
  @Indexed()
  late String make;
  @MapTo('wheels') // 'wheels' is property name in the RealmObject
  late int numberOfWheels;
}

Modelar datos no estructurados

A partir de la versión del SDK de Flutter,2.0.0 puedes almacenar colecciones de datos mixtos dentro de una RealmValue propiedad. Puedes usar esta función para modelar estructuras de datos complejas, como documentos JSON o MongoDB, sin tener que definir un modelo de datos estricto.

Los datos no estructurados son aquellos que no se ajustan fácilmente a un esquema esperado, lo que dificulta o hace poco práctico modelarlos para clases de datos individuales. Por ejemplo, su aplicación podría tener datos muy variables o dinámicos cuya estructura se desconoce en tiempo de ejecución.

Almacenar colecciones en una propiedad mixta ofrece flexibilidad sin sacrificar la funcionalidad, incluyendo una sincronización eficiente al usar Device Sync. Además, puede trabajar con ellas de la misma manera que con una colección no mixta:

• Puedes anidar colecciones mixtas hasta 100 niveles.

• Puede consultar y reaccionar ante los cambios en colecciones mixtas.

• Puede buscar y actualizar elementos de colección mixtos individuales.

Sin embargo, almacenar datos en colecciones mixtas tiene menos rendimiento que usar un esquema estructurado o serializar blobs JSON en una única propiedad de cadena.

Para modelar datos no estructurados en su aplicación, defina las propiedades adecuadas en su esquema como tipos RealmValue. A continuación, puede configurar estas RealmValue propiedades como una colección RealmList o RealmMap de RealmValue elementos. Tenga en cuenta que RealmValue no puede representar un RealmSet ni un objeto incrustado.

Por ejemplo, puede utilizar un RealmValue que contenga un mapa de datos mixtos al modelar un objeto de registro de eventos variable:

// Define class with a `RealmValue` property
@RealmModel()
class _EventLog {
  @PrimaryKey()
  late ObjectId id;
  late String eventType;
  late DateTime timestamp;
  late String userId;
  late RealmValue details;
}

realm.write(() {
  // Add `eventLog` property data as a map of mixed data, which 
  // also includes nested lists of mixed data 
  realm.add(EventLog(ObjectId(), 'purchase', DateTime.now(), 'user123',
      details: RealmValue.from({
        'ipAddress': '192.168.1.1',
        'items': [
          {'id': 1, 'name': 'Laptop', 'price': 1200.00},
          {'id': 2, 'name': 'Mouse', 'price': 49.99}
        ],
        'total': 1249.99
      })));
  final eventLog = realm.all<EventLog>().first;
  final items = eventLog.details.asMap();
  print('''
      Event Type: ${eventLog.eventType}
      Timestamp: ${eventLog.timestamp}
      User ID: ${eventLog.userId}
      Details:
        Item: 
  ''');
  for (var item in items.entries) {
    print('${item.key}: ${item.value}');
  }

Event Type: purchase
Timestamp: 2024-03-18 13:50:58.402979Z
User ID: user123
Details:
Item:
   ipAddress: RealmValue(192.168.1.1)
   items: RealmValue([RealmValue({id: RealmValue(1), name: RealmValue(Laptop), price: RealmValue(1200.0)}), RealmValue({id: RealmValue(2), name: RealmValue(Mouse), price: RealmValue(49.99)})])
   total: RealmValue(1249.99)

Generar el RealmObject

Una vez que haya completado su modelo Realm, debe generar la clase RealmObject para usarlo en su aplicación.

Ejecute el siguiente comando para generar RealmObjects:

dart run realm generate

dart run realm_dart generate

Ejecutar esto crea una clase pública en un nuevo archivo en el directorio donde definiste la clase RealmModel según la sección Crear modelo.

El archivo generado tiene el mismo nombre base que el archivo con su RealmModel, terminando en .realm.dart. Por ejemplo, si el archivo con su RealmModel se llama schemas.dart, el archivo generado será schemas.realm.dart.

// ...import packages
part 'schemas.realm.dart';
@RealmModel()
// ...model definition

Si desea ver sus modelos de datos para generar RealmObjects cada vez que haya un cambio, incluya el indicador --watch en su comando.

dart run realm generate --watch

dart run realm_dart generate --watch

Para limpiar las cachés del generador, incluya el indicador --clean en su comando. Limpiar la caché del generador puede ser útil durante la depuración.

dart run realm generate --clean

dart run realm_dart generate --clean

Definir un objeto asimétrico

Los objetos asimétricos requieren sincronización flexible. Para definir un objeto asimétrico, pase ObjectType.asymmetricObject a @RealmModel().

@RealmModel(ObjectType.asymmetricObject)
class _WeatherSensor {
  @PrimaryKey()
  @MapTo("_id")
  late ObjectId id;
  late String deviceId;
  late double modtemperatureInFahrenheitel;
  late double barometricPressureInHg;
  late double windSpeedInMph;
}

En las versiones y anteriores del SDK de Flutter,1.5.0 no se pueden vincular los asymmetricObject tipos RealmObjects a. En las versiones 1.6.0 y posteriores del SDK, losasymmetricObject tipos pueden vincularse a,RealmObjects además de los tipos de objetos incrustados.

Para obtener más información sobre la ingesta de datos, consulte Transmitir datos a Atlas.