SerializableModelIndexDefinition class

The definition of an index for a file, that is also stored in the database.

Constructors

SerializableModelIndexDefinition({required String name, required String type, required bool unique, required List<String> fields, bool? nullsDistinct, GinOperatorClass? ginOperatorClass, VectorDistanceFunction? vectorDistanceFunction, Map<String, String>? parameters})
Create a new SerializableModelIndexDefinition.

Properties

fields → List<String>
The fields this index includes. The order of the fields matters.
final
ginOperatorClass → GinOperatorClass?
The gin index operator class, if it is a gin index.
final
hashCode → int
The hash code for this object.
no setterinherited
isGinIndex → bool
Whether the index is of GIN type.
no setter
isVectorIndex → bool
Whether the index is of vector type.
no setter
name → String
The name of the index.
final
nullsDistinct → bool?
Whether null values should be considered distinct in this unique index.
final
parameters → Map<String, String>?
The parameters of the index, if any. Used for Vector indexes.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → String
The type of this index. Usually this is btree.
final
unique → bool
Whether the fields of this index should be unique.
final
vectorDistanceFunction → VectorDistanceFunction?
The vector index distance function, if it is a vector index.
final

Methods

copyWithPrefix(String prefix) → SerializableModelIndexDefinition
Copy the index with a new name that is prefixed with prefix.
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