indexInfo

fun indexInfo(indexName: String): KQLiteCursor

Retrieves information about the columns of a specific index.

This pragma returns a cursor where each row corresponds to a single column in the specified index. The columns in the cursor are:

  • seqno: The sequence number of the column within the index (0 for the first column, 1 for the second, etc.).

  • cid: The column ID in the underlying table. This is the index of the column in the table's CREATE TABLE statement.

  • name: The name of the column.

This is useful for introspecting the structure of an index. For more detailed information, including collation sequence and whether a column is descending, see indexXInfo.

Return

A KQLiteCursor containing information about the index columns.

Author

MOHAMMAD AZIM ANSARI

Parameters

indexName

The name of the index to query.

See also