Modelos de Objetos - .NET SDK

Object Schema

An object schema is a configuration object that defines the properties and relationships of a Realm object. Realm client applications define object schemas with the native class implementation in their respective language using the Object Schema.

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

Cada aplicación tiene un Esquema de Servicios de Aplicaciones formado por una lista de esquemas de objetos para cada tipo de objeto que pueden contener los reinos en esa aplicación. Realm garantiza que todos los objetos en un realm cumplan con el esquema para su tipo de objeto Realm y valida los objetos cuando se crean, modifican o eliminan.

llave primaria

A primary key is a property that uniquely identifies an object. You can create a primary key with any of the following types (or their nullable counterparts):

• ObjectId

• UUID

• string

• char

• byte

• short

• int

• long

You may define a primary key on a single property for an object type as part of the object schema. Realm automatically indexes primary key properties, which allows you to efficiently read and modify objects based on their primary key.

If an object type has a primary key, then all objects of that type must include the primary key property with a value that is unique among objects of the same type in a realm.

The following example demonstrates how to designate a primary key in an object schema:

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 el tiempo de las queries en un Realm. Sin índices, Realm analiza cada documento en una colección para seleccionar los documentos que coinciden con la query dada. Sin embargo, si existe un índice aplicable para una query, Realm utiliza el índice para limitar la cantidad de documentos que debe inspeccionar.

You can index properties with the following types:

• 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; }
}

Full-Text Search Indexes

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, utiliza el atributo Indexed con la enumeración IndexType.FullText. En el siguiente ejemplo, tenemos un índice FullText en la propiedad Biography:

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

Default Field Values

You can use the built-in language features to assign a default value to a property. In C#, you can assign a default value on primitives in the property declaration. You cannot set a default value on a collection, except to set it to null!. Even if you set a collection to null!, collections are always initialized on first access, so will never be null.

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

Ignorar una propiedad

If you don't want to save a property in your model to a realm, you can ignore that property. A property is ignored by default if it is not autoimplemented or does not have a setter.

Ignore a property from a Realm object model with the Ignored attribute:

// 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; }

Rename a Property

Por defecto, Realm utiliza el nombre definido en la clase de modelo para representar internamente las propiedades. En algunos casos, es posible que desees cambiar este comportamiento:

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

• To change a property name in .NET without forcing a migration.

Choosing an internal name that differs from the name used in model classes has the following implications:

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

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

Use the [MapTo] attribute to rename a property:

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

Rename a Class

Por defecto, Realm utiliza el nombre definido en la clase del modelo para representar internamente las clases. En algunos casos, es posible que desees cambiar este comportamiento:

• To support multiple model classes with the same simple name in different namespaces.

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

• To use a class name that is longer than the 57 character limit enforced by Realm.

• Cambiar el nombre de una clase en .NET sin forzar una migración.

Use the [MapTo] attribute to rename a class:

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

Custom Setters

Realm will not store a property with a custom setter. To use a custom setter, store the property value in a private property and then map that value to a public property with the custom setter. Realm will store the private property, while you modify its value via the public property. In the following code, the private email property is stored in the realm, but the public Email property, which provides validation, is not persisted:

// 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;
    }
}

Ignoring Nullability

Puedes preferir tener mayor flexibilidad al definir la anulabilidad de las propiedades en los objetos de Realm. Puedes hacerlo configurando realm.ignore_objects_nullability = true en un archivo de configuración global.

If you enable realm.ignore_objects_nullability, nullability annotations will be ignored on Realm object properties, including collections of Realm objects.