Modelos de Objetos - .NET SDK

Esquema de objeto

Un esquema de objeto es un objeto de configuración que define las propiedades y relaciones de un objeto de Realm. Las aplicaciones cliente de Realm definen esquemas de objeto con la implementación de la clase nativa en su lenguaje correspondiente mediante el esquema de objeto.

Los esquemas de objeto especifican restricciones sobre las propiedades de los objetos, como el tipo de dato de cada propiedad y si una propiedad es obligatoria o no. Los esquemas también pueden definir relaciones entre los tipos de objetos de un dominio.

Cada aplicación tiene un esquema de App Services, compuesto por una lista de esquemas de objetos para cada tipo de objeto que los dominios de esa aplicación pueden contener. Realm garantiza que todos los objetos de un dominio se ajusten al esquema para su tipo de objeto y valida los objetos cada vez que se crean, modifican o eliminan.

Clave principal

Una clave principal es una propiedad que identifica de forma única a un objeto. Puede crear una clave principal con cualquiera de los siguientes tipos (o sus equivalentes que aceptan valores NULL):

• ObjectId

• UUID

• string

• char

• byte

• short

• int

• long

Puede definir una clave principal en una sola propiedad para un tipo de objeto como parte del esquema del objeto. Realm indexa automáticamente las propiedades de clave principal, lo que permite leer y modificar objetos eficientemente según su clave principal.

Si un tipo de objeto tiene una clave principal, entonces todos los objetos de ese tipo deben incluir la propiedad de clave principal con un valor que sea único entre los objetos del mismo tipo en un ámbito.

El siguiente ejemplo demuestra cómo designar una clave principal en un esquema de objeto:

public partial class Dog : IRealmObject
{
    [PrimaryKey]
    public string Name { get; set; }
    public int Age { get; set; }
    public Person? Owner { get; set; }
}

Indexes

Los índices mejoran significativamente los tiempos de consulta en un dominio. Sin índices, Realm escanea todos los documentos de una colección para seleccionar los que coinciden con la consulta. Sin embargo, si existe un índice aplicable para una consulta, Realm lo utiliza para limitar el número de documentos que debe inspeccionar.

Puede indexar propiedades con los siguientes tipos:

• bool

• byte

• short

• int

• long

• DateTimeOffset

• char

• string

• ObjectId

• UUID

Para indexar una propiedad, utilice el atributo Indexed. Con el Indexed atributo, puede especificar el tipo de índice de la propiedad mediante la enumeración IndexType. En el siguiente ejemplo, tenemos un índice predeterminado ("General") en la Name propiedad:

public partial class Person : IRealmObject
{
    [Indexed(IndexType.General)]
    public string Name { get; set; }
    [Indexed(IndexType.FullText)]
    public string Biography { get; set; }
}

Índices de búsqueda de texto completo

Además de los índices estándar, Realm también admite índices de texto completo (FTS) en string propiedades. Aunque es posible query un campo de string con o sin un índice estándar, un índice FTS permite buscar varias palabras y frases y excluir otras.

Para obtener más información sobre cómo consultar índices de texto completo, consulta Búsqueda de texto completo (LINQ) y Búsqueda de texto completo (RQL).

Para indexar una propiedad FTS, utilice el atributo Indexed con la enumeración IndexType.FullText. En el siguiente ejemplo, tenemos un FullText índice en la Biography propiedad:

public partial class Person : IRealmObject
{
    [Indexed(IndexType.General)]
    public string Name { get; set; }
    [Indexed(IndexType.FullText)]
    public string Biography { get; set; }
}

Valores de campo predeterminados

Puede usar las funciones integradas del lenguaje para asignar un valor predeterminado a una propiedad. En C#, puede asignar un valor predeterminado a las primitivas en la declaración de la propiedad. No puede establecer un valor predeterminado en una colección, excepto para establecerlo en null!. Incluso si establece una colección en null!, las colecciones siempre se inicializan en el primer acceso, por lo que nunca serán nulas.

public partial class Person : IRealmObject
{
    public string Name { get; set; } = "foo";
    public IList<PhoneNumber> PhoneNumbers { get; } = null!;
}

Ignorar una propiedad

Si no desea guardar una propiedad de su modelo en un dominio, puede ignorarla. Una propiedad se ignora por defecto si no se implementa automáticamente o no tiene un definidor.

Ignorar una propiedad de un modelo de objeto Realm con el atributo Ignorado:

// Rather than store an Image in Realm,
// store the path to the Image...
public string ThumbnailPath { get; set; }
// ...and the Image itself can be
// in-memory when the app is running:
[Ignored]
public Image? Thumbnail { get; set; }

Cambiar el nombre de una propiedad

De forma predeterminada, Realm usa el nombre definido en la clase del modelo para representar las propiedades internamente. En algunos casos, podría ser conveniente cambiar este comportamiento:

• Para facilitar el trabajo en diferentes plataformas, ya que las convenciones de nomenclatura difieren.

• Para cambiar un nombre de propiedad en .NET sin forzar una migración.

Elegir un nombre interno diferente del nombre utilizado en las clases del modelo tiene las siguientes implicaciones:

• Las migraciones deben utilizar el nombre interno al crear clases y propiedades.

• Los errores de esquema informados utilizarán el nombre interno.

Utilice el atributo [MapTo] para cambiar el nombre de una propiedad:

public partial class Person : IRealmObject
{
    [MapTo("moniker")]
    public string Name { get; set; }
}

Cambiar el nombre de una clase

De forma predeterminada, Realm usa el nombre definido en la clase del modelo para representar las clases internamente. En algunos casos, podría ser conveniente cambiar este comportamiento:

• Para admitir múltiples clases de modelo con el mismo nombre simple en diferentes espacios de nombres.

• Para facilitar el trabajo en diferentes plataformas, ya que las convenciones de nomenclatura difieren.

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

• Para cambiar un nombre de clase en .NET sin forzar una migración.

Utilice el atributo [MapTo] para cambiar el nombre de una clase:

[MapTo("Human")]
public partial class Person : IRealmObject
{
    public string Name { get; set; }
}

Configuradores personalizados

Realm no almacenará una propiedad con un establecedor personalizado. Para usar un establecedor personalizado, almacene el valor de la propiedad en una propiedad privada y luego asigne ese valor a una propiedad pública con el establecedor personalizado. Realm almacenará la propiedad privada, mientras que usted modificará su valor mediante la propiedad pública. En el siguiente código, la propiedad privada email se almacena en el dominio, pero la propiedad pública Email, que proporciona validación, no se conserva:

// This property will be stored in the Realm
private string email { get; set; }
// Custom validation of the email property.
// This property is *not* stored in Realm.
public string Email
{
    get { return email; }
    set
    {
        if (!value.Contains("@")) throw new Exception("Invalid email address");
        email = value;
    }
}

Ignorar la nulabilidad

Quizás prefiera tener más flexibilidad al definir la nulidad de las propiedades en sus objetos Realm. Puede hacerlo configurando realm.ignore_objects_nullability = true en un archivo de configuración global.

Si habilita realm.ignore_objects_nullability, las anotaciones de nulidad se ignorarán en las propiedades de objetos Realm, incluidas las colecciones de objetos Realm.