ADD INDEX

The ALTER TABLE.. ADD INDEX statement adds an index to an existing table. This operation is online in TiDB, which means that neither reads or writes to the table are blocked by adding an index.

ADD INDEX - 图1

Tip

The TiDB Distributed eXecution Framework (DXF) can be used to speed up the operation of this statement.

ADD INDEX - 图2

Warning

  • DO NOT upgrade a TiDB cluster when a DDL statement is being executed in the cluster (usually for the time-consuming DDL statements such as ADD INDEX and the column type changes).
  • Before the upgrade, it is recommended to use the ADMIN SHOW DDL command to check whether the TiDB cluster has an ongoing DDL job. If the cluster has a DDL job, to upgrade the cluster, wait until the DDL execution is finished or use the ADMIN CANCEL DDL command to cancel the DDL job before you upgrade the cluster.
  • In addition, during the cluster upgrade, DO NOT execute any DDL statement. Otherwise, the issue of undefined behavior might occur.

When you upgrade TiDB from v7.1.0 to a later version, you can ignore the preceding limitations. For details, see the limitations of TiDB smooth upgrade.

Synopsis

AlterTableStmt

ADD INDEX - 图3

AddIndexSpec

ADD INDEX - 图4

IndexPartSpecification

ADD INDEX - 图5

IndexOption

ADD INDEX - 图6

IndexType

ADD INDEX - 图7

  1. AlterTableStmt
  2.          ::= 'ALTER' 'IGNORE'? 'TABLE' TableName AddIndexSpec ( ',' AddIndexSpec )*
  4. AddIndexSpec
  5.          ::= 'ADD' ( ( 'PRIMARY' 'KEY' | ( 'KEY' | 'INDEX' ) 'IF NOT EXISTS'? | 'UNIQUE' ( 'KEY' | 'INDEX' )? ) ( ( Identifier? 'USING' | Identifier 'TYPE' ) IndexType )? | 'FULLTEXT' ( 'KEY' | 'INDEX' )? IndexName ) '(' IndexPartSpecification ( ',' IndexPartSpecification )* ')' IndexOption*
  7. IndexPartSpecification
  8.          ::= ( ColumnName ( '(' LengthNum ')' )? | '(' Expression ')' ) ( 'ASC' | 'DESC' )
  10. IndexOption
  11.          ::= 'KEY_BLOCK_SIZE' '='? LengthNum
  12.            | IndexType
  13.            | 'WITH' 'PARSER' Identifier
  14.            | 'COMMENT' stringLit
  15.            | 'VISIBLE'
  16.            | 'INVISIBLE'
  18. IndexType
  19.          ::= 'BTREE'
  20.            | 'HASH'
  21.            | 'RTREE'

Examples

  1. mysql> CREATE TABLE t1 (id INT NOT NULL PRIMARY KEY AUTO_INCREMENT, c1 INT NOT NULL);
  2. Query OK, 0 rows affected (0.11 sec)
  4. mysql> INSERT INTO t1 (c1) VALUES (1),(2),(3),(4),(5);
  5. Query OK, 5 rows affected (0.03 sec)
  6. Records: 5  Duplicates: 0  Warnings: 0
  8. mysql> EXPLAIN SELECT * FROM t1 WHERE c1 = 3;
  9. +-------------------------+----------+-----------+---------------+--------------------------------+
  10. | id                      | estRows  | task      | access object | operator info                  |
  11. +-------------------------+----------+-----------+---------------+--------------------------------+
  12. | TableReader_7           | 10.00    | root      |               | data:Selection_6               |
  13. | └─Selection_6           | 10.00    | cop[tikv] |               | eq(test.t1.c1, 3)              |
  14. |   └─TableFullScan_5     | 10000.00 | cop[tikv] | table:t1      | keep order:false, stats:pseudo |
  15. +-------------------------+----------+-----------+---------------+--------------------------------+
  16. 3 rows in set (0.00 sec)
  18. mysql> ALTER TABLE t1 ADD INDEX (c1);
  19. Query OK, 0 rows affected (0.30 sec)
  21. mysql> EXPLAIN SELECT * FROM t1 WHERE c1 = 3;
  22. +------------------------+---------+-----------+------------------------+---------------------------------------------+
  23. | id                     | estRows | task      | access object          | operator info                               |
  24. +------------------------+---------+-----------+------------------------+---------------------------------------------+
  25. | IndexReader_6          | 0.01    | root      |                        | index:IndexRangeScan_5                      |
  26. | └─IndexRangeScan_5     | 0.01    | cop[tikv] | table:t1, index:c1(c1) | range:[3,3], keep order:false, stats:pseudo |
  27. +------------------------+---------+-----------+------------------------+---------------------------------------------+
  28. 2 rows in set (0.00 sec)

MySQL compatibility

  • TiDB accepts index types such as HASH, BTREE and RTREE in syntax for compatibility with MySQL, but ignores them.
  • SPATIAL indexes are not supported.
  • TiDB supports parsing the FULLTEXT syntax but does not support using the FULLTEXT indexes.
  • Descending indexes are not supported (similar to MySQL 5.7).
  • Adding the primary key of the CLUSTERED type to a table is not supported. For more details about the primary key of the CLUSTERED type, refer to clustered index.

See also