my.cnf 增加一个配置项，MySQL 不能启动了

有一天，同事问了我一个来自客户的问题：
在 my.cnf 中增加系统变量 foreign_key_checks 之后，MySQL 就启动不了了。

我们尝试通过 SET 命令修改 foreign_key_checks，成功了。查看官方文档，明明也是有这个系统变量的：

为什么把 foreign_key_checks 加到配置文件里就不行了呢？

这就触及到我的盲区了，同时也勾起了我的好奇心，搞清楚这个问题势在必行。

研究一番之后，发现并不是只有 foreign_key_checks 存在这种情况，还有一些系统变量也是这样的，不能加到配置文件里，只能通过 SET 命令修改。

如果你也对这个问题感到好奇，我们就一起来探个究竟吧。

本文基于 MySQL 8.0.32 源码。

目录

[TOC]

正文

1. 问题复现

在 my.cnf 中增加系统变量：

1foreign_key_checks = 0

然后，启动 MySQL，结果：启动失败。查看 error.log，能看到如下错误信息：

1unknown variable 'foreign_key_checks = 0'

官方文档里说 MySQL 支持这个系统变量，MySQL 说我不认识它，是不是有点奇怪？

不过，不管怎样，我们已经复现了这个问题，接下来，继续追根溯源。

2. 原理介绍

MySQL 中，每个系统变量都会在代码里定义，foreign_key_checks 定义如下：

我最开始怀疑是 SESSION_VAR 的问题，调试了一遍，发现 SESSION_VAR 是无辜的，它并不是导致 MySQL 无法识别配置文件中 foreign_key_checks 的元凶。

调试过程中，发现了另一个疑似凶手，就是红框里的 NO_CMD_LINE。

为了验证我的推测，又在代码中搜索了其它带有 NO_CMD_LINE 标志的系统变量，在其中发现了一个比较眼熟的家伙（autocommit）：

为了确认 autocommit 是否也会导致 MySQL 启动失败，修改了配置文件：

1# foreign_key_checks = 0
2autocommit = 0

注释掉配置文件中的 foreign_key_checks，加上了 autocommit，结果 MySQL 启动成功了。

完了，NO_CMD_LINE 看起来也不像凶手，探索之路就此进入了尴尬的局面。

又经过一番漫长的东调西试，发现了 autocommit 的秘密：autocommit 有两处定义，上面截图是 sql/sys_vars.cc 里的定义，还有一处位于 sql/mysqld.cc 文件。

为了验证 MySQL 能识别配置文件中的 autocommit，是因为 my_long_options 中增加了 autocommit 的定义，我把 my_long_options 中的 autocommit 删掉了，然后启动 MySQL，结果失败。

不过，遗憾的是，并没有报 unknown variable 错误，而是触发了一个断言错误，和配置文件无关，这条路径验证失败。

为了继续验证我的推测，在 sql/sys_vars.cc 中增加了一个带有 NO_CMD_LINE 标志的自定义系统变量，并加到配置文件中，然后，启动 MySQL，结果：启动失败，报错：unknown variable xxx。

接着，我又在 sql/mysqld.cc 的 my_long_options 中增加了这个自定义的系统变量，然后，启动 MySQL，结果：启动成功。

这就证明了我的推测：
sql/sys_vars.cc 中定义的系统变量，如果包含了 NO_CMD_LINE，MySQL 启动过程中不能识别。

这种系统变量加入 sql/mysqld.cc 的 my_long_options 数组之后，MySQL 启动过程中就能识别了，autocommit 就是这么干的。

另外，调试过程中还有另一个发现：sql/mysqld.cc 的 my_long_early_options 数组，也具有和 my_long_options 一样的功能。

概括来说，NO_CMD_LINE 是一扇门，my_long_options、my_long_early_options 是两扇窗，某个系统变量被 NO_CMD_LINE 关起来闭门思过之后，如果开了其中一扇窗，这个系统变量就可以从窗户上逃出来了。

3. 简单的分辨方法

有些系统变量能在配置文件中配置，有些变量又不能，我们想知道哪些变量能，哪些变量不能，除了撸代码还有别的方法吗？

当然是有的，用这个命令就可以：

1/path/mysqld --verbose --help | grep "xxx"

例如，查看 foreign_key_checks 是否能通过配置文件配置：

1./mysqld --verbose --help | grep "foreign-key-checks"

执行命令没有任何输出，说明 foreign_key_checks 不能通过配置文件配置。

查看 autocommit 是否能通过配置文件配置：

1./mysqld --verbose --help | grep "autocommit"
2
3# 输出如下
4--autocommit Set default value for autocommit (0 or 1)
5            (Defaults to on; use --skip-autocommit to disable.)

输出结果中有 --autocommit balabala，说明 autocommit 能通过配置文件配置。

注意：grep 后面系统变量名中的下划线需要替换为中划线，例如 foreign-key-checks。

4. 总结

对于官方文档里说明 MySQL 支持的系统变量，如果我们在配置文件（my.cnf）中增加了一个系统变量，MySQL 启动时报 unknown variable xxx 错误，说明这个系统变量不支持通过配置文件配置。

另一种分辨方法是执行 /path/mysqld --verbose --help | grep "xxx" 命令，如果输出结果中没有 --xxx balabala 这样的信息，也可以说明这个系统变量不支持通过配置文件配置。