PolarDB-X 1.0-SQL 手册-DDL-ALTER TABLE

语法

1. ALTER [ONLINE|OFFLINE][IGNORE] TABLE tbl_name
2.    [alter_specification [, alter_specification]...]
3.    [partition_options]

ALTER TABLE用于改变表的结构，如增加列、增加索引和修改数据定义。详细语法请参见MySQL修改表语法。

不允许修改拆分字段。

• 增加列：

1. ALTER TABLE user_log
2.   ADD COLUMN idcard varchar(30);

• 增加索引：

1. ALTER TABLE user_log
2.   ADD INDEX idcard_idx (idcard);

• 删除索引：

1. ALTER TABLE user_log
2.   DROP INDEX idcard_idx;

• 重命名索引：

1. ALTER TABLE user_log
2.   RENAME INDEX `idcard_idx` TO `idcard_idx_new`;

• 修改字段：

1. ALTER TABLE user_log
2.   MODIFY COLUMN idcard varchar(40);

全局二级索引

版本限制：MySQL 版本 >= 5.7, 并且 DRDS 版本 >= 5.4.1

PolarDB-X支持全局二级索引 (Global Secondary Index, GSI) 基本原理请参见全局二级索引。

列变更

使用全局二级索引的表，对列的修改，语法和普通表的一致。

__注意：当修改的表包含全局二级索引时，对列的修改有额外的限制，关于GSI的限制与约定，详情请参见使用全局二级索引。

索引变更

语法：

1. ALTER TABLE tbl_name
2.    alter_specification # 全局二级索引相关变更仅支持一条 alter_specification
3. 
   
4. alter_specification:
5.  | ADD GLOBAL {INDEX|KEY} index_name # 全局二级索引必须显式指定索引名
6.      [index_type](index_sharding_col_name,...)
7.      global_secondary_index_option
8.      [index_option]...
9.  | ADD [CONSTRAINT [symbol]] UNIQUE GLOBAL
10.      [INDEX|KEY] index_name # 全局二级索引必须显式指定索引名
11.      [index_type](index_sharding_col_name,...)
12.      global_secondary_index_option
13.      [index_option]...
14.  | DROP {INDEX|KEY} index_name
15.  | RENAME {INDEX|KEY} old_index_name TO new_index_name
16. 
    
17. # 关于全局二级索引特有语法，详情请参见CREATE TABLE文档
18. global_secondary_index_option:
19.    [COVERING (col_name,...)]# Covering Index
20.    drds_partition_options # 包含且仅包含 index_sharding_col_name 中指定的列
21. 
    
22. # 指定索引表拆分方式
23. drds_partition_options:
24.    DBPARTITION BY db_sharding_algorithm
25.    [TBPARTITION BY {table_sharding_algorithm}[TBPARTITIONS num]]
26. 
    
27. db_sharding_algorithm:
28.    HASH([col_name])
29.  |{YYYYMM|YYYYWEEK|YYYYDD|YYYYMM_OPT|YYYYWEEK_OPT|YYYYDD_OPT}(col_name)
30.  | UNI_HASH(col_name)
31.  | RIGHT_SHIFT(col_name, n)
32.  | RANGE_HASH(col_name, col_name, n)
33. 
    
34. table_sharding_algorithm:
35.    HASH(col_name)
36.  |{MM|DD|WEEK|MMDD|YYYYMM|YYYYWEEK|YYYYDD|YYYYMM_OPT|YYYYWEEK_OPT|YYYYDD_OPT}(col_name)
37.  | UNI_HASH(col_name)
38.  | RIGHT_SHIFT(col_name, n)
39.  | RANGE_HASH(col_name, col_name, n)
40. 
    
41. # 以下为 MySQL DDL 语法
42. index_sharding_col_name:
43.    col_name [(length)][ASC | DESC]
44. 
    
45. index_option:
46.    KEY_BLOCK_SIZE [=] value
47.  | index_type
48.  | WITH PARSER parser_name
49.  | COMMENT 'string'
50. 
    
51. index_type:
52.    USING {BTREE | HASH}

ALTER TABLE ADD GLOBAL INDEX 系列语法用于在建表后添加GSI，该系列语法在 MySQL 语法上新引入了 GLOBAL 关键字，用于指定添加的索引类型为GSI。

ALTER TABLE { DROP | RENAME } INDEX 语法同样可以对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. ALTER TABLE t_order ADD UNIQUE GLOBAL INDEX `g_i_buyer`(`buyer_id`) COVERING (`order_snapshot`) dbpartition by hash(`buyer_id`);

其中：

• 主表：t_order 只分库不分表，分库的拆分方式为按照 order_id 列进行哈希。
• 索引表：g_i_buyer 只分库不分表，分库的拆分方式为按照 buyer_id 列进行哈希，指定覆盖列为 order_snapshot。
• 索引定义子句：UNIQUE GLOBAL INDEX `g_i_buyer`(`buyer_id`) COVERING (order_snapshot) dbpartition by hash(`buyer_id`)。

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

关于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 |          0| g_i_buyer |            1| buyer_id       | NULL      |           0|     NULL | NULL   | YES  | GLOBAL     | INDEX    |               |
8. | t_order |          1| g_i_buyer |            2| id             | NULL      |           0|     NULL | NULL   |      | GLOBAL     | COVERING |               |
9. | t_order |          1| g_i_buyer |            3| order_id       | NULL      |           0|     NULL | NULL   | YES  | GLOBAL     | COVERING |               |
10. | t_order |          1| g_i_buyer |            4| order_snapshot | NULL      |           0|     NULL | NULL   | YES  | GLOBAL     | COVERING |               |
11. +---------+------------+-----------+--------------+----------------+-----------+-------------+----------+--------+------+------------+----------+---------------+

通过 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 |0          | g_i_buyer | buyer_id    | id, order_id, order_snapshot | NULL       | buyer_id         | HASH                |4                  |                  | NULL                | NULL               | PUBLIC |
6. +---------------------+---------+------------+-----------+-------------+------------------------------+------------+------------------+---------------------+--------------------+------------------+---------------------+--------------------+--------+

查看索引表的结构，索引表包含主表的主键、分库分表键、默认的覆盖列和自定义覆盖列，主键列去除了AUTO_INCREMENT属性，并且去除了主表中的局部索引，全局唯一索引默认在索引表的所有分库分表键上创建一个唯一索引，以实现全局唯一约束。

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

删除全局二级索引

1. # 删除索引
2. ALTER TABLE `t_order` DROP INDEX `g_i_seller`;

删除名为 g_i_seller 的 GSI，相应的索引表也将被删除。

重命名索引

默认情况下限制对GSI的重命名，关于GSI的限制与约定，详情请参见全局二级索引使用。