Index class

Annotate properties to build an index.

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

Constructors

Index({String? name, List<String> composite = const [], bool unique = false, bool hash = false})
Annotate properties to build an index.
const

Properties

composite List<String>
Specify up to two other properties to build a composite index.
final
hash bool
Stores the hash of the value(s) in the index. This saves space and increases performance, but only equality queries are supported. You should always use this if you only want to guarantee uniqueness.
final
hashCode int
The hash code for this object.
no setterinherited
name String?
Name of the index. By default, the names of the properties are concatenated using "_"
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
unique bool
A unique index ensures the index does not contain any duplicate values. If you attempt to insert an object that conflicts with an existing object that has the same value for the indexed property, the existing object will be overwritten.
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