Documentation Home
MySQL 8.3 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.8Mb
PDF (A4) - 40.9Mb
Man Pages (TGZ) - 294.0Kb
Man Pages (Zip) - 409.0Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb
Excerpts from this Manual

MySQL 8.3 Reference Manual  /  ...  /  Generated Invisible Primary Keys

15.1.20.11 生成的不可见主键

MySQL 8.3 支持在任何没有明确主键的 InnoDB 表中生成不可见主键。当 sql_generate_invisible_primary_key 服务器系统变量设置为 ON 时,MySQL 服务器将自动添加生成的不可见主键(GIPK)到该表中。

默认情况下,sql_generate_invisible_primary_key 的值为 OFF,这意味着自动添加 GIPKs 是禁用的。为了说明这如何影响表创建,我们首先创建两个相同的表,两者都没有主键,唯一的区别是第一个(表 auto_0)是在 sql_generate_invisible_primary_key 设置为 OFF 时创建的,而第二个(auto_1)是在设置为 ON 后创建的,如下所示:

mysql> SELECT @@sql_generate_invisible_primary_key;
+--------------------------------------+
| @@sql_generate_invisible_primary_key |
+--------------------------------------+
|                                    0 |
+--------------------------------------+
1 row in set (0.00 sec)

mysql> CREATE TABLE auto_0 (c1 VARCHAR(50), c2 INT);
Query OK, 0 rows affected (0.02 sec)

mysql> SET sql_generate_invisible_primary_key=ON;
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @@sql_generate_invisible_primary_key;
+--------------------------------------+
| @@sql_generate_invisible_primary_key |
+--------------------------------------+
|                                    1 |
+--------------------------------------+
1 row in set (0.00 sec)

mysql> CREATE TABLE auto_1 (c1 VARCHAR(50), c2 INT);
Query OK, 0 rows affected (0.04 sec)

比较这两个 SHOW CREATE TABLE 语句的输出,以查看表创建的差异:

mysql> SHOW CREATE TABLE auto_0\G
*************************** 1. row ***************************
       Table: auto_0
Create Table: CREATE TABLE `auto_0` (
  `c1` varchar(50) DEFAULT NULL,
  `c2` int DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

mysql> SHOW CREATE TABLE auto_1\G
*************************** 1. row ***************************
       Table: auto_1
Create Table: CREATE TABLE `auto_1` (
  `my_row_id` bigint unsigned NOT NULL AUTO_INCREMENT /*!80023 INVISIBLE */,
  `c1` varchar(50) DEFAULT NULL,
  `c2` int DEFAULT NULL,
  PRIMARY KEY (`my_row_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

由于 auto_1 没有在创建表时指定主键,因此设置 sql_generate_invisible_primary_key = ON 导致 MySQL 添加了不可见列 my_row_id 到该表中,并在该列上添加了主键。由于 sql_generate_invisible_primary_key 在创建 auto_0 时为 OFF,因此没有对该表进行这样的添加。

当服务器添加主键到表时,列和键名总是 my_row_id。因此,在启用生成的不可见主键时,您不能创建一个名为 my_row_id 的列,除非表创建语句也指定了明确的主键。(您不需要在这种情况下将列或键命名为 my_row_id。)

my_row_id 是一个不可见列,这意味着它不会出现在 SELECT *TABLE 的输出中;该列必须通过名称明确选择。请参阅 第 15.1.20.10 节,“不可见列”

当 GIPKs 启用时,生成的主键不能被修改,除非将其切换为 VISIBLEINVISIBLE 之间。要使生成的不可见主键在 auto_1 上可见,请执行以下 ALTER TABLE 语句:

mysql> ALTER TABLE auto_1 ALTER COLUMN my_row_id SET VISIBLE;
Query OK, 0 rows affected (0.02 sec)
Records: 0  Duplicates: 0  Warnings: 0

mysql> SHOW CREATE TABLE auto_1\G
*************************** 1. row ***************************
       Table: auto_1
Create Table: CREATE TABLE `auto_1` (
  `my_row_id` bigint unsigned NOT NULL AUTO_INCREMENT,
  `c1` varchar(50) DEFAULT NULL,
  `c2` int DEFAULT NULL,
  PRIMARY KEY (`my_row_id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.01 sec)

要使生成的主键再次不可见,请发出 ALTER TABLE auto_1 ALTER COLUMN my_row_id SET INVISIBLE

生成的不可见主键默认总是不可见的。

每当 GIPKs 启用时,您不能删除生成的主键,如果以下 2 个条件中的任何一个结果是:

  • 表格将没有主键。

  • 主键被删除,但不是主键列。

sql_generate_invisible_primary_key 的效果仅适用于使用 InnoDB 存储引擎的表格。您可以使用 ALTER TABLE 语句更改使用生成的不可见主键的表格的存储引擎;在这种情况下,主键和列将保留在原处,但表格和键将不再受到任何特殊处理。

默认情况下,GIPKs 将显示在 SHOW CREATE TABLESHOW COLUMNSSHOW INDEX 的输出中,并在信息模式 COLUMNSSTATISTICS 表中可见。您可以通过将 show_gipk_in_create_table_and_information_schema 系统变量设置为 OFF 来隐藏生成的不可见主键在这些情况下。默认情况下,该变量为 ON,如下所示:

mysql> SELECT @@show_gipk_in_create_table_and_information_schema;
+----------------------------------------------------+
| @@show_gipk_in_create_table_and_information_schema |
+----------------------------------------------------+
|                                                  1 |
+----------------------------------------------------+
1 row in set (0.00 sec)

从以下对 COLUMNS 表的查询中可以看到,my_row_idauto_1 的列之一:

mysql> SELECT COLUMN_NAME, ORDINAL_POSITION, DATA_TYPE, COLUMN_KEY
    -> FROM INFORMATION_SCHEMA.COLUMNS
    -> WHERE TABLE_NAME = "auto_1";
+-------------+------------------+-----------+------------+
| COLUMN_NAME | ORDINAL_POSITION | DATA_TYPE | COLUMN_KEY |
+-------------+------------------+-----------+------------+
| my_row_id   |                1 | bigint    | PRI        |
| c1          |                2 | varchar   |            |
| c2          |                3 | int       |            |
+-------------+------------------+-----------+------------+
3 rows in set (0.01 sec)

show_gipk_in_create_table_and_information_schema 设置为 OFF 后,my_row_id 将不再出现在 COLUMNS 表中,如下所示:

mysql> SET show_gipk_in_create_table_and_information_schema = OFF;
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @@show_gipk_in_create_table_and_information_schema;
+----------------------------------------------------+
| @@show_gipk_in_create_table_and_information_schema |
+----------------------------------------------------+
|                                                  0 |
+----------------------------------------------------+
1 row in set (0.00 sec)

mysql> SELECT COLUMN_NAME, ORDINAL_POSITION, DATA_TYPE, COLUMN_KEY
    -> FROM INFORMATION_SCHEMA.COLUMNS
    -> WHERE TABLE_NAME = "auto_1";
+-------------+------------------+-----------+------------+
| COLUMN_NAME | ORDINAL_POSITION | DATA_TYPE | COLUMN_KEY |
+-------------+------------------+-----------+------------+
| c1          |                2 | varchar   |            |
| c2          |                3 | int       |            |
+-------------+------------------+-----------+------------+
2 rows in set (0.00 sec)

设置 sql_generate_invisible_primary_key 不会被复制,并且会被复制应用程序线程忽略。这意味着源上的这个变量设置对副本没有影响。你可以使用 REQUIRE_TABLE_PRIMARY_KEY_CHECK = GENERATE 作为 CHANGE REPLICATION SOURCE TO 语句的一部分,在给定的复制通道上强制副本添加 GIPK 对于没有主键的表。

GIPK 与基于行的复制 CREATE TABLE ... SELECT 配合工作;在这种情况下,二进制日志中写入的信息包括 GIPK 定义,因此可以正确地复制。基于语句的复制 CREATE TABLE ... SELECT 不支持 sql_generate_invisible_primary_key = ON

在创建或导入使用 GIPK 的安装备份时,可以排除生成的不可见主键列和值。--skip-generated-invisible-primary-key 选项用于 mysqldump,导致 GIPK 信息在程序的输出中被排除。如果您要导入包含生成的不可见主键和值的转储文件,也可以使用 --skip-generated-invisible-primary-keymysqlpump,以便这些被抑制(因此不被导入)。