PolarDB-X 1.0-SQL 手册-DDL-CREATE INDEX

PolarDB-X支持创建局部索引和全局二级索引 (Global Secondary Index, GSI) ，同时支持删除这两种索引。

PolarDB-X全局二级索引要求MySQL版本需为5.7或以上，且内核小版本需为5.4.1或以上。关于全局二级索引基本原理，请参见全局二级索引.

局部索引

关于局部索引，详情请参见CREATE INDEX。

全局二级索引

语法：

1. CREATE [UNIQUE]
2.    GLOBAL INDEX index_name [index_type]
3.    ON tbl_name (index_sharding_col_name,...)
4.    global_secondary_index_option
5.    [index_option]
6.    [algorithm_option | lock_option]...
7. 
   
8. # 全局二级索引特有语法，具体说明请参见CREATE TABLE文档
9. global_secondary_index_option:
10.    [COVERING (col_name,...)]
11.    drds_partition_options
12. 
    
13. # 分库分表子句，具体说明请参见CREATE TABLE文档
14. drds_partition_options:
15.    DBPARTITION BY db_sharding_algorithm
16.    [TBPARTITION BY {table_sharding_algorithm}[TBPARTITIONS num]]
17. 
    
18. db_sharding_algorithm:
19.    HASH([col_name])
20.  |{YYYYMM|YYYYWEEK|YYYYDD|YYYYMM_OPT|YYYYWEEK_OPT|YYYYDD_OPT}(col_name)
21.  | UNI_HASH(col_name)
22.  | RIGHT_SHIFT(col_name, n)
23.  | RANGE_HASH(col_name, col_name, n)
24. 
    
25. table_sharding_algorithm:
26.    HASH(col_name)
27.  |{MM|DD|WEEK|MMDD|YYYYMM|YYYYWEEK|YYYYDD|YYYYMM_OPT|YYYYWEEK_OPT|YYYYDD_OPT}(col_name)
28.  | UNI_HASH(col_name)
29.  | RIGHT_SHIFT(col_name, n)
30.  | RANGE_HASH(col_name, col_name, n)
31. 
    
32. # 以下为 MySQL DDL 语法
33. index_sharding_col_name:
34.    col_name [(length)][ASC | DESC]# length 参数仅用于在索引表拆分键上创建局部索引
35. 
    
36. index_option:
37.    KEY_BLOCK_SIZE [=] value
38.  | index_type
39.  | WITH PARSER parser_name
40.  | COMMENT 'string'
41. 
    
42. index_type:
43.    USING {BTREE | HASH}
44. 
    
45. algorithm_option:
46.    ALGORITHM [=]{DEFAULT|INPLACE|COPY}
47. 
    
48. lock_option:
49.    LOCK [=]{DEFAULT|NONE|SHARED|EXCLUSIVE}

CREATE GLOBAL INDEX系列语法用于在建表后添加GSI，该系列语法在MySQL语法上新引入了GLOBAL关键字，用于指定添加的索引类型为GSI。目前建表后创建GSI存在一定限制，关于GSI的限制与约定，详情请参见使用全局二级索引。

关于全局二级索引定义子句详细说明，请参见CREATE TABLE。

示例

下面以建立普通全局二级索引为例，介绍在建表后创建GSI。

1. # 先建表
2. CREATE TABLE t_order (
3.  `id` bigint(11) NOT NULL AUTO_INCREMENT,
4.  `order_id` varchar(20) DEFAULT NULL,
5.  `buyer_id` varchar(20) DEFAULT NULL,
6.  `seller_id` varchar(20) DEFAULT NULL,
7.  `order_snapshot` longtext DEFAULT NULL,
8.  `order_detail` longtext DEFAULT NULL,
9.  PRIMARY KEY (`id`),
10.  KEY `l_i_order`(`order_id`)
11. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 dbpartition by hash(`order_id`);
12. 
    
13. # 再建全局二级索引
14. CREATE GLOBAL INDEX `g_i_seller` ON t_order (`seller_id`) dbpartition by hash(`seller_id`);

其中：

• 主表：t_order 只分库不分表，分库的拆分方式为按照 order_id 列进行哈希。
• 索引表：g_i_seller 只分库不分表，分库的拆分方式为按照 seller_id 列进行哈希。
• 索引定义子句：GLOBAL INDEX `g_i_seller` ON t_order (`seller_id`) dbpartition by hash(`seller_id`)。

通过 SHOW INDEX 查看索引信息，包含拆分键order_id上的局部索引，和seller_id、id和order_id上的GSI，其中seller_id为索引表的拆分键，id和order_id为默认的覆盖列（主键和主表的拆分键）。

关于GSI的限制与约定，详情请参见使用全局二级索引，SHOW INDEX详细说明，请参见SHOW INDEX。

1. mysql> show index from t_order;
2. +---------+------------+------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+----------+---------------+
3. | TABLE   | NON_UNIQUE | KEY_NAME   | SEQ_IN_INDEX | COLUMN_NAME | COLLATION | CARDINALITY | SUB_PART | PACKED | NULL | INDEX_TYPE | COMMENT  | INDEX_COMMENT |
4. +---------+------------+------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+----------+---------------+
5. | t_order |          0| PRIMARY    |            1| id          | A         |           0|     NULL | NULL   |      | BTREE      |          |               |
6. | t_order |          1| l_i_order  |            1| order_id    | A         |           0|     NULL | NULL   | YES  | BTREE      |          |               |
7. | t_order |          1| g_i_seller |            1| seller_id   | NULL      |           0|     NULL | NULL   | YES  | GLOBAL     | INDEX    |               |
8. | t_order |          1| g_i_seller |            2| id          | NULL      |           0|     NULL | NULL   |      | GLOBAL     | COVERING |               |
9. | t_order |          1| g_i_seller |            3| order_id    | NULL      |           0|     NULL | NULL   | YES  | GLOBAL     | COVERING |               |
10. +---------+------------+------------+--------------+-------------+-----------+-------------+----------+--------+------+------------+----------+---------------+

您可以通过SHOW GLOBAL INDEX单独查看GSI信息，详细说明请参见SHOW GLOBAL INDEX。

1. mysql> show global index from t_order;
2. +---------------------+---------+------------+------------+-------------+----------------+------------+------------------+---------------------+--------------------+------------------+---------------------+--------------------+--------+
3. | SCHEMA              | TABLE   | NON_UNIQUE | KEY_NAME   | INDEX_NAMES | COVERING_NAMES | INDEX_TYPE | DB_PARTITION_KEY | DB_PARTITION_POLICY | DB_PARTITION_COUNT | TB_PARTITION_KEY | TB_PARTITION_POLICY | TB_PARTITION_COUNT | STATUS |
4. +---------------------+---------+------------+------------+-------------+----------------+------------+------------------+---------------------+--------------------+------------------+---------------------+--------------------+--------+
5. | ZZY3_DRDS_LOCAL_APP | t_order |1          | g_i_seller | seller_id   | id, order_id   | NULL       | seller_id        | HASH                |4                  |                  | NULL                | NULL               | PUBLIC |
6. +---------------------+---------+------------+------------+-------------+----------------+------------+------------------+---------------------+--------------------+------------------+---------------------+--------------------+--------+

查看索引表的结构，索引表包含主表的主键、分库分表键、默认的覆盖列和自定义覆盖列，主键列去除了AUTO_INCREMENT属性，并且去除了主表中的局部索引。

1. mysql> show create table g_i_seller;
2. +------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
3. |Table      |CreateTable                                                                                                                                                                                                                                                                                  |
4. +------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5. | g_i_seller | CREATE TABLE `g_i_seller`(
6.  `id` bigint(11) NOT NULL,
7.  `order_id` varchar(20) DEFAULT NULL,
8.  `seller_id` varchar(20) DEFAULT NULL,
9.  PRIMARY KEY (`id`),
10.  KEY `auto_shard_key_seller_id`(`seller_id`) USING BTREE
11. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 dbpartition by hash(`seller_id`)|