MySQL :: MySQL 8.4 Reference Manual :: 15.8.3 HELP Statement

version 8.4

8.0 current
5.7

8.0 Japanese

MySQL 8.4 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.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

PREV HOME UP NEXT