IndexSnapshot class

Represents an index snapshot.

Annotations

• @immutable

Constructors

IndexSnapshot({required String name, required String tableName, required List<String> columns, bool isUnique = false, String? where})

Creates a snapshot of a single index.

const

IndexSnapshot.fromMap(String name, Map<String, dynamic> data)

Creates an index snapshot from a map.

factory

Properties

columns → List<String>

The column names that make up the index.

final

hashCode → int

The hash code for this object.

no setter, override

isUnique → bool

Whether this index enforces uniqueness.

final

name → String

The index name.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tableName → String

The table this index belongs to.

final

where → String?

Optional partial-index predicate (raw SQL).

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toIndexInfo() → IndexInfo

Converts the index snapshot to the IndexInfo the DDL generators consume.

toMap() → Map<String, dynamic>

Converts the index snapshot to a map.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

override