RENAME INDEX

The statement ALTER TABLE .. RENAME INDEX renames an existing index to a new name. This operation is instant in TiDB, and requires only a meta data change.

Synopsis

AlterTableStmt

RENAME INDEX - 图1

RenameIndexSpec

RENAME INDEX - 图2

  1. AlterTableStmt
  2.          ::= 'ALTER' 'IGNORE'? 'TABLE' TableName RenameIndexSpec ( ',' RenameIndexSpec )*
  4. RenameIndexSpec
  5.          ::= 'RENAME' ( 'KEY' | 'INDEX' ) Identifier 'TO' Identifier

Examples

  1. mysql> CREATE TABLE t1 (id INT NOT NULL PRIMARY KEY AUTO_INCREMENT, c1 INT NOT NULL, INDEX col1 (c1));
  2. Query OK, 0 rows affected (0.11 sec)
  4. mysql> SHOW CREATE TABLE t1\G
  5. *************************** 1. row ***************************
  6.        Table: t1
  7. Create Table: CREATE TABLE `t1` (
  8.   `id` int(11) NOT NULL AUTO_INCREMENT,
  9.   `c1` int(11) NOT NULL,
  10.   PRIMARY KEY (`id`),
  11.   KEY `col1` (`c1`)
  12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin
  13. 1 row in set (0.00 sec)
  15. mysql> ALTER TABLE t1 RENAME INDEX col1 TO c1;
  16. Query OK, 0 rows affected (0.09 sec)
  18. mysql> SHOW CREATE TABLE t1\G
  19. *************************** 1. row ***************************
  20.        Table: t1
  21. Create Table: CREATE TABLE `t1` (
  22.   `id` int(11) NOT NULL AUTO_INCREMENT,
  23.   `c1` int(11) NOT NULL,
  24.   PRIMARY KEY (`id`),
  25.   KEY `c1` (`c1`)
  26. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin
  27. 1 row in set (0.00 sec)

MySQL compatibility

The RENAME INDEX statement in TiDB is fully compatible with MySQL. If you find any compatibility differences, report a bug.

See also