MySQL 官方手冊與客戶端內建 HELP 完全使用指南

MySQL 官方手冊與客戶端內建 HELP 完全使用指南

離線環境或生產故障時，無法上網查資料。掌握 MySQL 官方手冊下載與客戶端 HELP 系統，是 DBA 必備技能。

一、官方參考手冊

• 下載地址：https://dev.mysql.com/doc/
• 格式：PDF、HTML、EPUB
• 涵蓋：SQL 語法、安裝配置、系統/狀態變量、命令行工具、存儲引擎、複製、優化等全主題
• 建議：本地保留對應版本手冊，離線隨時查閱

二、客戶端內建 HELP 系統

1. 客戶端命令幫助

mysql> HELP;
-- 或 \h

列出所有客戶端命令：

2. 服務端 SQL 語法幫助

mysql> HELP CONTENTS;
-- 列出所有幫助類別：Account Management, Administration, Data Types, Functions, ...
mysql> HELP Administration;
-- 列出 Administration 下主題：BINLOG, CACHE INDEX, FLUSH, KILL ...
mysql> HELP FLUSH;
-- 顯示 FLUSH 語法、說明、權限要求
mysql> HELP CACHE INDEX;
-- 顯示 CACHE INDEX 語法

遞歸查詢：HELP 類別 → HELP 主題 → 獲得完整語法與說明。

3. 實用範例

• 分頁查看大結果集：PAGER less 或 PAGER more
• 記錄操作日誌：TEE /tmp/query.log → 操作 → NOTEE
• 垂直顯示寬表：SELECT * FROM t \G
• 修改提示符區分環境：PROMPT PROD>
• 切換字符集排查亂碼：CHARSET gbk → STATUS 確認
• 開啟警告即時顯示：WARNINGS → 錯誤 SQL → SHOW WARNINGS

三、常用 SHOW/SET 幫助

mysql> HELP SHOW;
-- 列出所有 SHOW 子命令：DATABASES, TABLES, VARIABLES, STATUS, ENGINES ...
mysql> HELP SET;
-- SET 語法、變量類型（GLOBAL/SESSION）、廢棄的 SET OPTION

善用內建 HELP，離線也能高效解決語法、權限、配置等問題。