My.cnf 增加一個配置項,MySQL 不能啟動了
有一天,同事問了我一個來自客戶的問題:在 my.cnf 中增加系統變量 foreign_key_checks 之后,MySQL 就啟動不了了。
我們嘗試通過 SET 命令修改 foreign_key_checks,成功了。查看官方文檔,明明也是有這個系統變量的:
圖片
為什么把 foreign_key_checks 加到配置文件里就不行了呢?
這就觸及到我的盲區了,同時也勾起了我的好奇心,搞清楚這個問題勢在必行。
研究一番之后,發現并不是只有 foreign_key_checks 存在這種情況,還有一些系統變量也是這樣的,不能加到配置文件里,只能通過 SET 命令修改。
如果你也對這個問題感到好奇,我們就一起來探個究竟吧。
本文基于 MySQL 8.0.32 源碼。
1、問題復現
在 my.cnf 中增加系統變量:
foreign_key_checks = 0
然后,啟動 MySQL,結果:啟動失敗。查看 error.log,能看到如下錯誤信息:
unknown 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 啟動失敗,修改了配置文件:
# foreign_key_checks = 0
autocommit = 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、簡單的分辨方法
有些系統變量能在配置文件中配置,有些變量又不能,我們想知道哪些變量能,哪些變量不能,除了擼代碼還有別的方法嗎?
當然是有的,用這個命令就可以:
/path/mysqld --verbose --help | grep "xxx"
例如,查看 foreign_key_checks 是否能通過配置文件配置:
./mysqld --verbose --help | grep "foreign-key-checks"
執行命令沒有任何輸出,說明 foreign_key_checks 不能通過配置文件配置。
查看 autocommit 是否能通過配置文件配置:
./mysqld --verbose --help | grep "autocommit"
# 輸出如下
--autocommit Set default value for autocommit (0 or 1)
(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 這樣的信息,也可以說明這個系統變量不支持通過配置文件配置。
本文轉載自微信公眾號「一樹一溪」,可以通過以下二維碼關注。轉載本文請聯系一樹一溪公眾號。