Anotaciones de la propiedad - Kotlin SDK

Specify a Primary Key

A primary key is a unique identifier for an object in a realm. No other object of the same type can share an object's primary key.

To specify a property as the object type's primary key, use the @PrimaryKey annotation:

@PrimaryKey
var _id: ObjectId = ObjectId() // Primary key property

Aspectos importantes de las claves primarias:

• Puede definir solo una clave principal por esquema de objeto.

• No puedes cambiar el campo llave primaria para un tipo de objeto Realm después de agregar cualquier objeto de ese tipo a un realm.

• Los valores de clave primaria deben ser únicos en todas las instancias de un objeto en un realm. Intentar insertar un valor duplicado de llave primaria produce un error.

• 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.

• Primary keys are nullable. Because primary key values must be unique, null can only be the primary key of one object in a collection.

• Realm automatically indexes primary keys, so you can efficiently read and modify objects based on their primary key.

You can create a primary key with any of the following types:

• String

• Byte

• Char

• Short

• Int

• Long

• ObjectId

• RealmUUID

Asignar una propiedad o clase a un nombre diferente

By default, Realm uses the name defined in the model class to represent classes and fields internally. The Kotlin SDK lets you map a property or class name to a different persisted name than the name used in your code. Persisting a different name to the realm is useful in some cases, including:

• Para facilitar el trabajo entre plataformas donde las convenciones de nomenclatura difieren. Por ejemplo, si los nombres de las propiedades del esquema de Device Sync usan snake case, mientras que tu proyecto usa camel case.

• To change a class or field name in Kotlin without forcing a migration.

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

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

To map a Kotlin class or property name in your code to a different name to persist in a realm:

1. Utiliza la anotación @PersistedName en la clase o propiedad de Kotlin.

2. Specify a class or property name that you want persisted to the realm.

@PersistedName(name = "Frog_Entity") // Remapped class name
class Frog : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    var age: Int = 0
    var species: String? = null
    var owner: String? = null
}

@PersistedName("latin_name")
var species: String? = null // Remapped property

Si escribes en un realm sincronizado, el esquema sincronizar ve los valores almacenados utilizando el nombre persistente de clase o propiedad. Tenga en cuenta lo siguiente:

• Migrations must use the persisted class or property name.

• Cualquier error de esquema reportado utiliza el nombre almacenado.

Ignore Properties from Realm Schema

By default, Realm manages properties defined in your Realm object model. However, you can choose to ignore properties that you don't want to persist in a realm.

To ignore a property and prevent it from persisting in a realm, use the @Ignore annotation:

@Ignore
var age: Int = 0 // Ignored property

An ignored property behaves exactly like a managed property, except they aren't stored to the database, can't be used in queries, and don't trigger Realm notifications. You can mix managed and ignored properties within a class.

Propiedades del índice

Indexes are special data structures that store a small portion of a realm's data in an easy-to-traverse form. Indexes support more efficient query execution in a realm. When an appropriate index exists for a query, Realm uses the index to limit the number of documents that it must inspect. Otherwise, Realm must scan every document in a collection and select those documents that match a query.

The index stores the value of a specific field ordered by the value of the field. The ordering of the index entries supports efficient equality matches and range-based query operations. While indexes speed up some queries, they also cause slightly slower writes. They come with additional storage and memory overhead. Realm stores indexes on disk, which makes your realm files larger. Each index entry is a minimum of 12 bytes.

Para crear un índice en una propiedad, utilice la anotación @Index en la propiedad:

@Index
var name: String = "" // Indexed property

You can index fields with the following types:

• String

• Byte

• Short

• Int

• Long

• Boolean

• RealmInstant

• ObjectId

• RealmUUID

You cannot combine standard indexes with full-text search (FTS) indexes on the same property. To create an FTS index on a property, refer to the Full-Text Search Indexes section.

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 crear un índice FTS en una propiedad, utilice la anotación @FullText:

@FullText
var physicalDescription: String? = null // Full-text search indexed property

Toma en cuenta las siguientes restricciones sobre los índices de texto completo:

• You can only create an FTS index on properties of String type.

• No puede combinar índices de texto completo y índices estándar en la misma propiedad. Para crear un índice estándar en una propiedad, consultar la sección Propiedades del Índice.

For more information on querying full-text indexes, refer to Filter By Full-Text Search (FTS) Property.