indexXInfo

fun indexXInfo(indexName: String): KQLiteCursor

Retrieves extended information about the columns of a specific index.

This pragma is an enhanced version of indexInfo. It provides additional details about each indexed column, which is especially useful for understanding complex indices.

The returned cursor contains the following columns for each column in the index:

  • seqno: The sequence number of the column within the index (0-based).

  • cid: The column ID in the underlying table, or -1 for an expression.

  • name: The name of the column or the expression text.

  • desc: A boolean flag that is 1 if the column is sorted in descending order (DESC) and 0 otherwise.

  • coll: The name of the collating sequence used for the column.

  • key: A boolean flag that is 1 if the column is part of the key and 0 if it is an included column in a covering index.

Return

A KQLiteCursor containing detailed information about the index columns.

Author

MOHAMMAD AZIM ANSARI

Parameters

indexName

The name of the index to query.

See also