MySQL :: MySQL 9.0 参考手册 :: 15.8.3 HELP 语句

版本 9.0

8.4 当前
8.0
5.7

8.0 日语

MySQL 9.0 参考手册 / ... / HELP 语句

15.8.3 HELP 语句

HELP 'search_string'

HELP 语句从 MySQL 参考手册中返回在线信息。其正常运行要求 mysql 数据库中的帮助表已初始化帮助主题信息（请参阅第 7.1.17 节“服务器端帮助支持”）。

HELP 语句在帮助表中搜索给定的搜索字符串并显示搜索结果。搜索字符串不区分大小写。

搜索字符串可以包含通配符 % 和 _。它们的含义与使用 LIKE 运算符执行的模式匹配操作相同。例如，HELP 'rep%' 返回以 rep 开头的主题列表。

HELP 语句不需要终止符，例如 ; 或 \G。

HELP 语句可以理解几种类型的搜索字符串

在最一般的级别上，使用 contents 检索顶级帮助类别列表
```
HELP 'contents'
```
要获取给定帮助类别（例如 数据类型）中的主题列表，请使用类别名称
```
HELP 'data types'
```
如需特定帮助主题的帮助，例如 ASCII() 函数或 CREATE TABLE 语句，请使用相关的关键字。
```
HELP 'ascii'
HELP 'create table'
```

换句话说，搜索字符串可以匹配一个类别、多个主题或单个主题。以下描述说明了结果集可以采用的形式。

空结果

找不到与搜索字符串匹配的内容。

示例：HELP 'fake'

结果

Nothing found
Please try to run 'help contents' for a list of all accessible topics

包含单行的结果集

这意味着搜索字符串匹配到了该帮助主题。结果包括以下项目：

name：主题名称。
description：主题的描述性帮助文本。
example：一个或多个使用示例。（可能为空。）

示例：HELP 'log'

结果

Name: 'LOG'
Description:
Syntax:
LOG(X), LOG(B,X)

If called with one parameter, this function returns the natural
logarithm of X. If X is less than or equal to 0.0E0, the function
returns NULL and a warning "Invalid argument for logarithm" is
reported. Returns NULL if X or B is NULL.

The inverse of this function (when called with a single argument) is
the EXP() function.

URL: https://dev.mysqlserver.cn/doc/refman/8.4/en/mathematical-functions.html

Examples:
mysql> SELECT LOG(2);
        -> 0.69314718055995
mysql> SELECT LOG(-2);
        -> NULL

主题列表。

这意味着搜索字符串匹配了多个帮助主题。

示例：HELP 'status'

结果

Many help items for your request exist.
To make a more specific request, please type 'help <item>',
where <item> is one of the following topics:
   FLUSH
   SHOW
   SHOW BINARY LOG STATUS
   SHOW ENGINE
   SHOW FUNCTION STATUS
   SHOW PROCEDURE STATUS
   SHOW REPLICA STATUS
   SHOW STATUS
   SHOW TABLE STATUS

主题列表。

如果搜索字符串匹配某个类别，也会显示列表。

示例：HELP 'functions'

结果

You asked for help about help category: "Functions"
For more information, type 'help <item>', where <item> is one of the following
categories:
   Aggregate Functions and Modifiers
   Bit Functions
   Cast Functions and Operators
   Comparison Operators
   Date and Time Functions
   Encryption Functions
   Enterprise Encryption Functions
   Flow Control Functions
   GROUP BY Functions and Modifiers
   GTID
   Information Functions
   Internal Functions
   Locking Functions
   Logical Operators
   Miscellaneous Functions
   Numeric Functions
   Performance Schema Functions
   Spatial Functions
   String Functions
   Window Functions
   XML