IndexDefinition class abstract
The definition of a (desired) index in the database.
- Implemented types
Constructors
-
IndexDefinition({required String indexName, String? tableSpace, required List<
IndexElementDefinition> elements, required String type, required bool isUnique, required bool isPrimary, String? predicate, VectorDistanceFunction? vectorDistanceFunction, ColumnType? vectorColumnType, Map<String, String> ? parameters}) -
factory
-
IndexDefinition.fromJson(Map<
String, dynamic> jsonSerialization) -
factory
Properties
-
elements
↔ List<
IndexElementDefinition> -
The elements, that are a part of this index.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- indexName ↔ String
-
The user defined name of the index
getter/setter pair
- isPrimary ↔ bool
-
Whether this index is the one for the primary key.
getter/setter pair
- isUnique ↔ bool
-
Whether the index is unique.
getter/setter pair
-
parameters
↔ Map<
String, String> ? -
Parameters for the index, if needed.
getter/setter pair
- predicate ↔ String?
-
The predicate of this partial index, if it is one.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- tableSpace ↔ String?
-
The tablespace this index is stored in.
If null, the index is in the databases default tablespace.
getter/setter pair
- type ↔ String
-
The type of the index
getter/setter pair
- vectorColumnType ↔ ColumnType?
-
The vector column type, if it is a vector index.
getter/setter pair
- vectorDistanceFunction ↔ VectorDistanceFunction?
-
The vector index distance function, if it is a vector index.
getter/setter pair
Methods
-
copyWith(
{String? indexName, String? tableSpace, List< IndexElementDefinition> ? elements, String? type, bool? isUnique, bool? isPrimary, String? predicate, VectorDistanceFunction? vectorDistanceFunction, ColumnType? vectorColumnType, Map<String, String> ? parameters}) → IndexDefinition - Returns a shallow copy of this IndexDefinition with some or all fields replaced by the given arguments.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a serialized JSON structure of the model which also includes
fields used by the database.
override
-
toJsonForProtocol(
) → Map< String, dynamic> -
Returns a JSON structure of the model, optimized for Protocol communication.
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited