Skip to main content

Module list_indexes_tool

Module list_indexes_tool 

Source
Expand description

The list_indexes tool: returns index metadata for the database. When given a table name, only indexes on that table are returned; otherwise all indexes are listed. Each entry includes the index name, owning table, uniqueness flag, column list, and partial-index predicate (if any).

Structs§

IndexInfo
Metadata for a single index in the database.
ListIndexesInput
The input parameters for the list_indexes tool.
ListIndexesOutput
The result of listing indexes in the database.
ListIndexesTool
List indexes in the database. When a table name is provided, only indexes belonging to that table are returned. Otherwise all indexes across every table are listed. Each index entry includes its name, the table it belongs to, whether it enforces uniqueness, the ordered list of indexed columns, and the WHERE predicate for partial indexes.

Enums§

ListIndexesError
Errors specific to the list_indexes tool.