IndexDefinition class

Declarative index metadata.

Annotations

• @immutable

Constructors

IndexDefinition({required String name, required IndexType type, required List<String> columns, bool raw = false, Map<String, Map<String, Object?>> driverOptions = const {}})

const

IndexDefinition.fromJson(Map<String, Object?> json)

factory

Properties

columns → List<String>

Columns captured by the index.

final

driverOptions → Map<String, Map<String, Object?>>

Driver-specific options applied when creating the index.

final

hashCode → int

The hash code for this object.

no setter, inherited

name → String

Index name used for creation/dropping.

final

raw → bool

Whether the index is defined using raw SQL.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → IndexType

Logical index type guiding SQL generation.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

toString() → String

A string representation of this object.

inherited

withDriverOptions(String driverName, Map<String, Object?> options) → IndexDefinition

Creates a copy with additional driver-specific options.

Operators

operator ==(Object other) → bool

The equality operator.

inherited