Index class

Annotate properties to build an index.

Annotations

• @Target({TargetKind.field, TargetKind.getter})

Constructors

Index({String? name, List<CompositeIndex> composite = const [], bool unique = false, bool replace = false, IndexType? type, bool? caseSensitive})

Annotate properties to build an index.

const

Properties

caseSensitive → bool?

String or List<String> indexes can be case sensitive (default) or case insensitive.

final

composite → List<CompositeIndex>

Specify up to two other properties to build a composite index.

final

hashCode → int

The hash code for this object.

no setter, inherited

name → String?

Name of the index. By default, the names of the properties are concatenated using "_"

final

replace → bool

If set to true, inserting a duplicate unique value will replace the existing object instead of throwing an error.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → IndexType?

Specifies how an index is stored in Isar.

final

unique → bool

A unique index ensures the index does not contain any duplicate values. Any attempt to insert or update data into the unique index that causes a duplicate will result in an error.

final

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