RealmIndexType enum

Describes the indexing mode for properties annotated with the @Indexed annotation.

Inheritance
Available extensions

Values

regular → const RealmIndexType

Describes an index with no special capabilities. This type of index is suitable for equality searches as well as comparison operations for numeric values.

fullText → const RealmIndexType

Describes a Full-Text index on a string property.

The full-text index currently support this set of features:

  • Only token or word search, e.g. query("bio TEXT \$0", "computer dancing") will find all objects that contains the words computer and dancing in their bio property
  • Tokens are diacritics- and case-insensitive, e.g. query("bio TEXT \$0", "cafe dancing") and query("bio TEXT \$0", "café DANCING") will return the same set of matches.
  • Ignoring results with certain tokens is done using -, e.g. query("bio TEXT \$0", "computer -dancing") will find all objects that contain computer but not dancing.
  • Tokens only consist of alphanumerical characters from ASCII and the Latin-1 supplement. All other characters are considered whitespace. In particular words using - like full-text are split into two tokens.

Note the following constraints before using full-text search:

  • Token prefix or suffix search like query("bio TEXT \$0", "comp* *cing") is not supported.
  • Only ASCII and Latin-1 alphanumerical chars are included in the index (most western languages).
  • Only boolean match is supported, i.e. "found" or "not found". It is not possible to sort results by "relevance".

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<RealmIndexType>
A constant List of the values in this enum, in order of their declaration.