On this page
Warning:
As of October 4, 2019, CockroachDB v2.0 is no longer supported. For more details, refer to the Release Support Policy.
The SHOW INDEX
statement returns index information for a table.
Required Privileges
The user must have any privilege on the target table.
Aliases
In CockroachDB, the following are aliases for SHOW INDEX
:
SHOW INDEXES
SHOW KEYS
Synopsis
Parameters
Parameter | Description |
---|---|
table_name |
The name of the table for which you want to show indexes. |
Response
The following fields are returned for each column in each index.
Field | Description |
---|---|
Table |
The name of the table. |
Name |
The name of the index. |
Unique |
Whether or not values in the indexed column are unique. Possible values: true or false . |
Seq |
The position of the column in the index, starting with 1. |
Column |
The indexed column. |
Direction |
How the column is sorted in the index. Possible values: ASC or DESC for indexed columns; N/A for stored columns. |
Storing |
Whether or not the STORING clause was used to index the column during index creation. Possible values: true or false . |
Implicit |
Whether or not the column is part of the index despite not being explicitly included during index creation. Possible values: true or false At this time, primary key columns are the only columns that get implicitly included in secondary indexes. The inclusion of primary key columns improves performance when retrieving columns not in the index. |
Examples
> CREATE TABLE t1 (
a INT PRIMARY KEY,
b DECIMAL,
c TIMESTAMP,
d STRING
);
> CREATE INDEX b_c_idx ON t1 (b, c) STORING (d);
> SHOW INDEX FROM t1;
+-------+---------+--------+-----+--------+-----------+---------+----------+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
+-------+---------+--------+-----+--------+-----------+---------+----------+
| t1 | primary | true | 1 | a | ASC | false | false |
| t1 | b_c_idx | false | 1 | b | ASC | false | false |
| t1 | b_c_idx | false | 2 | c | ASC | false | false |
| t1 | b_c_idx | false | 3 | d | N/A | true | false |
| t1 | b_c_idx | false | 4 | a | ASC | false | true |
+-------+---------+--------+-----+--------+-----------+---------+----------+
(5 rows)