菜鸟科技网

MySQL doc命令如何快速查找与使用?

在标准的 MySQL 命令行客户端中,并没有一个叫做 doc 的内置命令。

MySQL doc命令如何快速查找与使用?-图1
(图片来源网络,侵删)

你提到的 doc 命令,很可能是指 HELP 命令,或者是指如何访问 MySQL 的官方文档,下面我将为你详细解释这两方面。


HELP 命令:MySQL 内置的“帮助”命令

HELP 命令是你在 MySQL 命令行客户端中获取帮助信息最直接的方式,它可以用来查看:

  • 内建命令的列表。
  • 特定 SQL 语句(如 SELECT, ALTER TABLE)的语法。
  • MySQL 函数(如 COUNT(), DATE())的用法。

HELP 命令的基本用法

查看所有可用的帮助主题

直接输入 HELP;\h,然后按回车。

MySQL doc命令如何快速查找与使用?-图2
(图片来源网络,侵删)
mysql> HELP;
For information about MySQL products and services, visit:
   http://www.mysql.com/
For developer information, including the MySQL Reference Manual, visit:
   http://dev.mysql.com/
To buy MySQL Enterprise support, consulting, or training, visit:
   https://www.mysql.com/company/
List of all MySQL commands:
Note All text commands must be first on line and end with ';'
?         (\?) Synonym for `help'.
clear     (\c) Clear the current input statement.
connect   (\r) Reconnect to the server. Optional arguments are db and host.
delimiter (\d) Set statement delimiter.
edit      (\e) Edit command with $EDITOR.
ego       (\G) Send command to mysql server, display result vertically.
exit      (\q) Exit mysql. Same as quit.
go        (\g) Send command to mysql server.
help      (\h) Display this help.
nopager   (\n) Disable pager, print to stdout.
notee     (\t) Don't write into outfile.
pager     (\P) Set PAGER [to_pager]. Print the query results via PAGER.
print     (\p) Print current command.
prompt    (\R) Change your mysql prompt.
quit      (\q) Quit mysql.
source    (\.) Execute an SQL script file. Takes a file name as an argument.
status    (\s) Get server status.
system    (\!) Execute a system shell command.
tee       (\T) Set outfile [to_outfile]. Append everything into given outfile.
use       (\u) Use another database. Takes database name as argument.
charset   (\C) Switch to another charset. Might be needed for processing binlog with mysqlbinlog.
warnings  (\W) Show warnings after every statement.
nowarning (\w) Don't show warnings after every statement.
resetconnection(\x) Clean session context.

查看特定 SQL 语句的帮助

使用 HELP 关键字; 的格式,MySQL 会匹配与关键字最相关的主题。

-- 查看 SELECT 语句的帮助
mysql> HELP SELECT;
Name: 'SELECT'
Description:
[WITH [RECURSIVE] with_query [, with_query] ...]
SELECT
    [ALL | DISTINCT | DISTINCTROW ]
      [HIGH_PRIORITY]
      [STRAIGHT_JOIN]
      [SQL_SMALL_RESULT] [SQL_BIG_RESULT] [SQL_BUFFER_RESULT]
      [SQL_CACHE | SQL_NO_CACHE] [SQL_CALC_FOUND_ROWS]
    select_expr [, select_expr ...]
    [FROM table_references
      [PARTITION partition_list]
    [WHERE where_condition]
    [GROUP BY {col_name | expr | with_time_function} [ASC | DESC], ... [WITH ROLLUP]]
    [HAVING where_condition]
    [ORDER BY {col_name | expr | position}
      [ASC | DESC], ...]
    [LIMIT {[offset,] row_count | row_count OFFSET offset}]
    [PROCEDURE procedure_name(argument_list)]
    [INTO {OUTFILE | DUMPFILE} 'file_name'
        [CHARACTER SET charset_name]
        [export_options]]
    [FOR UPDATE | LOCK IN SHARE MODE]]
URL: https://dev.mysql.com/doc/refman/8.0/en/select.html

查看函数的帮助

函数的帮助通常以 FUNCTION <function_name> 的形式存在。

MySQL doc命令如何快速查找与使用?-图3
(图片来源网络,侵删)
-- 查看 COUNT 函数的帮助
mysql> HELP FUNCTION COUNT;
Name: 'COUNT'
Description:
COUNT(expr) returns a count of the number of non-NULL values in the rows
retrieved by a SELECT statement.
...
URL: https://dev.mysql.com/doc/refman/8.0/en/group-by-functions.html#function_count

访问 MySQL 官方文档

HELP 命令提供的信息相对简略,最权威、最全面的文档始终是 MySQL 官方文档。HELP 命令的输出中通常也包含了对应内容的官方文档链接(URL)。

如何访问官方文档?

通过浏览器访问

直接在浏览器中打开以下链接,这是最推荐的方式,因为它包含了完整的格式、图表和可搜索功能。

使用 mysql 命令行客户端的 --help 选项

这个 --help 是查看 mysql 客户端本身命令行选项的帮助,而不是 SQL 语句的帮助。

# 在你的系统终端(不是 mysql 提示符下)运行
$ mysql --help
Usage: mysql [OPTIONS] [database]
  -?, --help          Display this help and exit.
  -I, --help          Synonym for -?
...

从命令行打开浏览器(如果环境支持)

在某些 Linux/macOS 环境下,你可以从终端直接打开浏览器到文档页面。

# 使用 xdg-open (Linux)
$ xdg-open https://dev.mysql.com/doc/refman/8.0/en/
# 使用 open (macOS)
$ open https://dev.mysql.com/doc/refman/8.0/en/

总结与建议

需求 推荐命令/方法 优点 缺点
快速回忆某个 SQL 语句的语法 HELP SELECT; 快捷,直接在客户端内完成 信息简略,格式化差
查找某个函数的用法 HELP FUNCTION COUNT; 快捷,直接在客户端内完成 信息简略,格式化差
深入理解某个特性的细节、示例 浏览器访问官方文档 信息最权威、全面,有示例和图表 需要切换到浏览器
查看 mysql 客户端的启动选项 mysql --help 快速,显示所有可用选项 仅限客户端本身

最佳实践:

  1. 在日常使用中,先用 HELP 命令快速回忆语法。
  2. HELP 的信息不足以解决问题,或者你需要学习一个新功能时,请务必养成查阅官方文档的习惯,这是成为 MySQL 高手的关键一步。
分享:
扫描分享到社交APP
上一篇
下一篇