Realm Kotlin SDK/io.realm.kotlin.types.annotations

Package io.realm.kotlin.types.annotations

Types

FullText

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class FullText

Annotation marking a property as having a full-text index, which will enable full-text queries on it. Full-text searches are done using the TEXT predicate, e.g.:

Ignore

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class Ignore

Annotation marking a field as ignored inside Realm, meaning that it will not be part of the models' schema.

Index

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class Index

Annotation marking a field as indexed.

PersistedName

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class PersistedName(name: String)

Annotation mapping a Kotlin class or field name to the name persisted in the Realm.

PrimaryKey

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class PrimaryKey

Annotation marking a field as a primary key inside Realm.