SupabaseIndexInfo class

Represents information about a database index.

An index improves the speed of data retrieval operations on a database table at the cost of additional writes and storage space to maintain the index structure.

Constructors

SupabaseIndexInfo.new({required String name, required String originalName, String? localName, required bool isUnique, required List<String> columns, required List<String> originalColumns})
Creates an instance of SupabaseIndexInfo.
SupabaseIndexInfo.fromJson(Map<String, dynamic> json)
Creates a SupabaseIndexInfo instance from a JSON map.
factory
SupabaseIndexInfo.fromRow(List row, String nameConverter(String))
Creates a SupabaseIndexInfo instance from a raw SQL query result row.
factory

Properties

columns → List<String>
List of column names covered by this index, converted to camelCase. Example: user_id becomes userId.
final
hashCode → int
The hash code for this object.
no setterinherited
isUnique → bool
Indicates whether the index enforces uniqueness on the indexed column(s). If true, duplicate values are not allowed in the combination of indexed columns.
final
localName → String
A Dart-safe name for the index, avoiding keyword conflicts. If name is a Dart keyword (e.g., default), localName might be defaultIndex.
final
name → String
The name of the index, converted to camelCase for Dart conventions. Example: user_email_idx becomes userEmailIdx.
final
originalColumns → List<String>
List of original database names of columns covered by this index. Example: user_id.
final
originalName → String
The original database name of the index as it exists in PostgreSQL. Example: user_email_idx.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts this SupabaseIndexInfo instance to a JSON map.
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited