SchemaIndex class

Metadata describing an index.

Returned by SchemaDriver.listIndexes.

Constructors

SchemaIndex({required String name, required List<String> columns, String? schema, String? tableName, bool unique = false, bool primary = false, String? method, String? whereClause, String? type, bool sparse = false})

const

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

factory

Properties

columns → List<String>

Columns covered by the index.

final

hashCode → int

The hash code for this object.

no setter, inherited

method → String?

Index method used (such as BTREE). Index method used (such as BTREE).

final

name → String

Index name.

final

primary → bool

Whether the index is the primary key.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schema → String?

Schema that contains the indexed table.

final

sparse → bool

Whether the index is sparse.

final

tableName → String?

Table that owns the index.

final

type → String?

Index type (e.g. text, geospatial).

final

unique → bool

Whether the index enforces uniqueness.

final

whereClause → String?

WHERE clause limiting the index when it is partial.

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited