Modelos de objeto - C++ SDK

Database Schema

Un esquema de base de datos es una lista de posibles esquemas de objetos que la base de datos puede contener. Cada objeto de base de datos debe ajustarse a un tipo de objeto Realm que esté incluido en el esquema de su base de datos.

Al abrir una base de datos, debes especificar qué modelos están disponibles pasando los modelos a la plantilla que utilizas para abrir la base de datos. Esos modelos deben tener esquemas y esta lista de esquemas se convierte en el esquema de la base de datos.

If the database already contains data when you open it, the SDK validates each object to ensure that an object schema was provided for its type and that it meets all of the constraints specified in the schema.

For more information about how to open the database, refer to Configure & Open a Realm - C++ SDK

Object Model

El modelo de objetos es la estructura principal que proporciona a la base de datos información sobre cómo interpretar y almacenar los objetos en la aplicación. El modelo de objetos del SDK de C++ es una clase o estructura de C++ normal que contiene un conjunto de propiedades. Las propiedades que se desean conservar deben usar tipos de datos compatibles. Las propiedades también son el mecanismo para establecer relaciones entre los tipos de objetos.

When you define your C++ class or struct, you must also provide an object schema. The schema is a C++ macro that gives the SDK information about which properties to persist, and what type of database object it is.

Debe definir su modelo de objeto SDK dentro del realm namespace.

Object Schema

Un esquema de objeto de un SDK de C++ asigna propiedades para un tipo de objeto específico. Los esquemas del SDK son macros que proporcionan al SDK la información necesaria para almacenar y recuperar los objetos. Cada modelo de objeto que se desee conservar debe ir acompañado de un esquema, que puede ser uno de los siguientes:

• REALM_SCHEMA

• REALM_EMBEDDED_SCHEMA

• REALM_ASYMMETRIC_SCHEMA

You must define the schema and your object model within the realm namespace.

Specify a Primary Key

You can designate a property as the primary key of your object.

Primary keys allow you to efficiently find, update, and upsert objects.

Primary keys are subject to the following limitations:

• You can define only one primary key per object model.

• Primary key values must be unique across all instances of an object in the database. The C++ SDK throws an error if you try to insert a duplicate primary key value.

• Los valores de la llave primaria son inmutables. Para cambiar el valor de la clave primaria de un objeto, se debe borrar el objeto original e insertar uno nuevo con un valor de clave primaria diferente.

• Los objetos incrustados no pueden definir una clave principal.

If you are using Device Sync, your models must have a primary key named _id.

The C++ SDK supports primary keys of the following types, and their optional variants:

• int64_t

• realm::object_id

• realm::uuid

• std::string

Additionally, a required realm::enum property can be a primary key, but realm::enum cannot be optional if it is used as a primary key.

Set a property as a primary key with the primary_key template:

struct Person {
  realm::primary_key<int64_t> _id;
  std::string name;
  int64_t age;
  // Create relationships by pointing an Object field to another struct or class
  Dog *dog;
};
REALM_SCHEMA(Person, _id, name, age, dog)

Ignorar una propiedad

Tu modelo puede incluir propiedades que la base de datos no almacena.

La base de datos ignora cualquier propiedad que no esté incluida en el esquema del objeto.

namespace realm {
struct Employee {
  realm::primary_key<int64_t> _id;
  std::string firstName;
  std::string lastName;
  // You can use this property as you would any other member
  // Omitting it from the schema means the SDK ignores it
  std::string jobTitle_notPersisted;
};
// The REALM_SCHEMA omits the `jobTitle_notPersisted` property
// The SDK does not store and cannot retrieve a value for this property
REALM_SCHEMA(Employee, _id, firstName, lastName)
}  // namespace realm

Define an Embedded Object

Un objeto incrustado es un tipo especial de objeto que modela datos complejos sobre un objeto concreto. Los objetos incrustados son similares a las relaciones, pero ofrecen restricciones adicionales y reflejan de manera más natural el modelo de documento denormalizado de MongoDB.

The C++ SDK enforces unique ownership constraints that treat each embedded object as nested data inside of a single, specific parent object. An embedded object inherits the lifecycle of its parent object and cannot exist as an independent database object. The SDK automatically deletes embedded objects if their parent object is deleted or when overwritten by a new embedded object instance.

Puedes declarar un objeto como un objeto incrustado que no tenga un ciclo de vida independiente del objeto en el que está incrustado. Esto difiere de una relación de uno a uno o de uno a muchos, en la que los objetos relacionados tienen ciclos de vida independientes.

Provide a REALM_EMBEDDED_SCHEMA with the struct or class name and the names of any properties that you want the database to persist.

Define a property as an embedded object on the parent object by setting a pointer to the embedded object's type.

namespace realm {
struct ContactDetails {
  // Because ContactDetails is an embedded object, it cannot have its own _id
  // It does not have a lifecycle outside of the top-level object
  std::string emailAddress;
  std::string phoneNumber;
};
REALM_EMBEDDED_SCHEMA(ContactDetails, emailAddress, phoneNumber)
struct Business {
  realm::object_id _id;
  std::string name;
  ContactDetails *contactDetails;
};
REALM_SCHEMA(Business, _id, name, contactDetails)
}  // namespace realm

Definir un objeto asimétrico

Puede utilizar la ingesta de datos para sincronizar un objeto de forma unidireccional desde su dispositivo a la base de datos vinculada a su aplicación Atlas App Services.

An asymmetric_object broadly has the same supported types as realm::object, with a few exceptions:

• Asymmetric objects can link to the following types: - object - embedded_object - std::vector<embedded_object>

Los objetos asimétricos no funcionan igual que otros objetos de base de datos. No se puede:

• Remove an asymmetric object from the device database

• Consultar un objeto asimétrico de la base de datos del dispositivo

Solo puede crear un objeto asimétrico, que luego se sincroniza de forma unidireccional con la base de datos de Atlas vinculada a su aplicación con Device Sync.

For more information, see: Create an Asymmetric Object.

En el SDK de C++, defina un objeto asimétrico de la misma forma que definiría una estructura o clase de C++ normal. Indique un REALM_ASYMMETRIC_SCHEMA con el nombre de la estructura o clase y los nombres de las propiedades que desea que la base de datos conserve.

struct WeatherSensorReading {
  realm::primary_key<realm::object_id> _id{realm::object_id::generate()};
  std::string deviceId;
  double temperatureInFahrenheit;
  int64_t windSpeedInMph;
};
REALM_ASYMMETRIC_SCHEMA(WeatherSensorReading, _id, deviceId,
                        temperatureInFahrenheit, windSpeedInMph)