MySQL :: MySQL 8.3 Reference Manual :: 15.8.3 HELP Statement

version 8.3

8.0 current
5.7

8.0 Japanese

MySQL 8.3 Reference Manual / ... / HELP Statement

15.8.3 帮助语句

HELP 'search_string'

该 HELP 语句从 MySQL 参考手册中返回在线信息。其正确操作需要在 mysql 数据库中初始化帮助表格，以包含帮助主题信息（见第 7.1.17 节，“服务器端帮助支持”）。

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

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

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

该 HELP 语句理解多种类型的搜索字符串：

在最高级别上，使用 contents 来检索顶级帮助类别列表：
```
HELP 'contents'
```
要获取给定帮助类别中的主题列表，例如 Data Types，请使用类别名称：
```
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.mysql.com/doc/refman/8.0/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 MASTER STATUS
   SHOW PROCEDURE STATUS
   SHOW REPLICA STATUS
   SHOW SLAVE 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

PREV HOME UP NEXT