Anotaciones de la propiedad - Kotlin SDK

Especificar una clave principal

Una clave principal es un identificador único para un objeto en un dominio. Ningún otro objeto del mismo tipo puede compartir la clave principal de un objeto.

Para especificar una propiedad como clave principal del tipo de objeto, utilice la anotación @PrimaryKey:

@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 es posible cambiar el campo de clave principal de un tipo de objeto después de agregar cualquier objeto de ese tipo a un reino.

• Los valores de clave principal deben ser únicos en todas las instancias de un objeto en un dominio. Intentar insertar un valor de clave principal duplicado genera 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.

• Las claves primarias admiten valores nulos. Dado que los valores de clave primaria deben ser únicos, null solo puede ser la clave primaria de un objeto en una colección.

• Realm indexa automáticamente las claves principales, de modo que usted puede leer y modificar objetos de manera eficiente en función de su clave principal.

Puede crear una clave principal con cualquiera de los siguientes tipos:

• String

• Byte

• Char

• Short

• Int

• Long

• ObjectId

• RealmUUID

Asignar una propiedad o clase a un nombre diferente

De forma predeterminada, Realm usa el nombre definido en la clase del modelo para representar internamente las clases y los campos. El SDK de Kotlin permite asignar el nombre de una propiedad o clase a un nombre persistente distinto del usado en el código. Persistir un nombre diferente en el realm es útil en algunos casos, como:

• 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 en Kotlin sin forzar una migración.

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

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

Para asignar un nombre de propiedad o clase Kotlin en su código a un nombre diferente para que persista en un reino:

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

2. Especifique una clase o propiedad name que desea que persista en el reino.

@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 escribe en un dominio sincronizado, el esquema de sincronización ve los valores almacenados con el nombre de la clase o propiedad persistente. Tenga en cuenta lo siguiente:

• Las migraciones deben utilizar el nombre de la propiedad o clase persistente.

• Cualquier error de esquema reportado utiliza el nombre almacenado.

Ignorar propiedades del esquema de dominio

De forma predeterminada, Realm administra las propiedades definidas en su modelo de objetos. Sin embargo, puede ignorar las propiedades que no desee que persistan en un dominio.

Para ignorar una propiedad y evitar que persista en un reino, use la anotación @Ignore:

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

Una propiedad ignorada se comporta exactamente igual que una propiedad administrada, excepto que no se almacena en la base de datos, no se puede usar en consultas ni activa notificaciones de Realm. Se pueden combinar propiedades administradas e ignoradas dentro de una clase.

Propiedades del índice

Losíndices son estructuras de datos especiales que almacenan una pequeña porción de los datos de un dominio de forma fácil de navegar. Los índices facilitan la ejecución de consultas en un dominio. Cuando existe un índice adecuado para una consulta, Realm lo utiliza para limitar el número de documentos que debe inspeccionar. De lo contrario, Realm debe analizar todos los documentos de una colección y seleccionar los que coinciden con la consulta.

El índice almacena el valor de un campo específico, ordenado por su valor. El orden de las entradas del índice permite coincidencias de igualdad eficientes y operaciones de consulta basadas en rangos. Si bien los índices aceleran algunas consultas, también ralentizan ligeramente las escrituras. Implican una sobrecarga de almacenamiento y memoria adicional. Realm almacena los índices en disco, lo que aumenta el tamaño de los archivos de realm. Cada entrada de índice tiene un mínimo de 12 bytes.

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

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

Puede indexar campos con los siguientes tipos:

• String

• Byte

• Short

• Int

• Long

• Boolean

• RealmInstant

• ObjectId

• RealmUUID

No se pueden combinar índices estándar con índices de búsqueda de texto completo (FTS) en la misma propiedad. Para crear un índice FTS en una propiedad, consulte la sección Índices de búsqueda de texto completo.

Í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 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:

• Sólo se puede crear un índice FTS en propiedades de tipo String.

• No se pueden combinar índices FTS e índices estándar en la misma propiedad. Para crear un índice estándar en una propiedad, consulte la sección Propiedades del índice.

Para obtener más información sobre cómo consultar índices de texto completo, consulte la propiedad Filtrar por búsqueda de texto completo (FTS).