generated-columns.md

title	summary	category
Generated Column	本文档介绍如何使用 generated column	user guide

Generated Column

为了在功能上兼容 MySQL 5.7，TiDB 支持 generated column。Generated column 的主要的作用之一：从 JSON 数据类型中解出数据，并为该数据建立索引。

使用 generated column 对 JSON 建索引

MySQL 5.7 及 TiDB 都不能直接为 JSON 类型的列添加索引，即不支持如下表结构：

CREATE TABLE person (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    address_info JSON,
    KEY (address_info)
);

为 JSON 列添加索引之前，首先必须抽取该列为 generated column。以 city generated column 为例，你可以添加索引：

CREATE TABLE person (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    address_info JSON,
    city VARCHAR(64) AS (JSON_UNQUOTE(JSON_EXTRACT(address_info, '$.city'))) VIRTUAL,
    KEY (city)
);

该表中，city 列是一个 generated column。顾名思义，此列由该表的其他列生成，对此列进行插入或更新操作时，并不能对之赋值。此列按需生成，并不存储在数据库中，也不占用内存空间，因而是虚拟的。city 列的索引存储在数据库中，并使用和 varchar(64) 类的其他索引相同的结构。

可使用 generated column 的索引，以提高如下语句的执行速度：

SELECT name, id FROM person WHERE city = 'Beijing';

如果 $.city 路径中无数据，则 JSON_EXTRACT 返回 NULL。如果你想增加约束：city 列必须是NOT NULL，则可按照以下方式定义 virtual column：

CREATE TABLE person (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    address_info JSON,
    city VARCHAR(64) AS (JSON_UNQUOTE(JSON_EXTRACT(address_info, '$.city'))) VIRTUAL NOT NULL,
    KEY (city)
);

INSERT 和 UPDATE 语句都会检查 virtual column 的定义。未通过有效性检测的行会返回错误：

mysql> INSERT INTO person (name, address_info) VALUES ('Morgan', JSON_OBJECT('Country', 'Canada'));
ERROR 1048 (23000): Column 'city' cannot be null

局限性

目前 JSON and generated column 有以下局限性：

• 不能通过 ALTER TABLE 增加 STORED 存储方式的 generated column；
• 不能通过 ALTER TABLE 在 generated column 上增加索引；
• 并未支持所有的 JSON 函数。