### 13.8.3 帮助声明

[](<>)

```
HELP 'search_string'
```

这[`帮助`](help.html)语句返回 MySQL 参考手册中的在线信息。它的正确操作需要在帮助表中`mysql`使用帮助主题信息初始化数据库（请参阅[第 5.1.17 节，“服务器端帮助支持”](server-side-help-support.html)）。

这[`帮助`](help.html)语句在帮助表中搜索给定的搜索字符串并显示搜索结果。搜索字符串不区分大小写。

搜索字符串可以包含通配符`%`和`_`.这些与使用[`喜欢`](string-comparison-functions.html#operator_like)操作员。例如，`帮助'rep%'`返回以开头的主题列表`代表`.

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

-   在最一般的层面上，使用`内容`检索顶级帮助类别的列表：

    ```
    HELP 'contents'
    ```

-   对于给定帮助类别中的主题列表，例如`数据类型`，使用类别名称：

    ```
    HELP 'data types'
    ```

-   有关特定帮助主题的帮助，例如[`ASCII()`](string-functions.html#function_ascii)函数或[`创建表`](create-table.html)语句，使用相关的关键字或关键字：

    ```
    HELP 'ascii'
    HELP 'create table'
    ```

    换句话说，搜索字符串匹配一个类别、许多主题或单个主题。您不一定要提前判断给定的搜索字符串是否返回项目列表或单个帮助主题的帮助信息。但是，你可以告诉什么样的反应[`帮助`](help.html)通过检查结果集中的行数和列数返回。

    以下描述指示结果集可以采用的形式。示例语句的输出使用熟悉的“表格”或“垂直”格式显示，您在使用[**mysql**](mysql.html)客户，但请注意[**mysql**](mysql.html)本身重新格式化[`帮助`](help.html)结果集以不同的方式。

-   空结果集

    找不到搜索字符串的匹配项。

-   结果集包含单行和三列

    这意味着搜索字符串对帮助主题产生了命中。结果包含三列：

    -   `姓名`：主题名称。

    -   `描述`：主题的描述性帮助文本。

    -   `例子`：使用示例或示例。此列可能为空白。

        例子：`帮助“替换”`

        产量：

    ```
    name: REPLACE
    description: Syntax:
    REPLACE(str,from_str,to_str)

    Returns the string str with all occurrences of the string from_str
    replaced by the string to_str. REPLACE() performs a case-sensitive
    match when searching for from_str.
    example: mysql> SELECT REPLACE('www.mysql.com', 'w', 'Ww');
            -> 'WwWwWw.mysql.com'
    ```

-   结果集包含多行和两列

    这意味着搜索字符串匹配了许多帮助主题。结果集指示帮助主题名称：

    -   `姓名`：帮助主题名称。

    -   `is_it_category`：`是`如果名称代表帮助类别，`ñ`如果没有。如果没有，则`姓名`指定为参数时的值[`帮助`](help.html)语句应该产生一个包含命名项描述的单行结果集。

        例子：`帮助“状态”`

        产量：

    ```
    +-----------------------+----------------+
    | name                  | is_it_category |
    +-----------------------+----------------+
    | SHOW                  | N              |
    | SHOW ENGINE           | N              |
    | SHOW MASTER STATUS    | N              |
    | SHOW PROCEDURE STATUS | N              |
    | SHOW SLAVE STATUS     | N              |
    | SHOW STATUS           | N              |
    | SHOW TABLE STATUS     | N              |
    +-----------------------+----------------+
    ```

-   结果集包含多行和三列

    这意味着搜索字符串匹配一个类别。结果集包含类别条目：

    -   `source_category_name`：帮助类别名称。

    -   `姓名`：类别或主题名称

    -   `is_it_category`：`是`如果名称代表帮助类别，`ñ`如果没有。如果没有，则`姓名`指定为参数时的值[`帮助`](help.html)语句应该产生一个包含命名项描述的单行结果集。

        例子：`帮助“功能”`

        产量：

    ```
    +----------------------+-------------------------+----------------+
    | source_category_name | name                    | is_it_category |
    +----------------------+-------------------------+----------------+
    | Functions            | CREATE FUNCTION         | N              |
    | Functions            | DROP FUNCTION           | N              |
    | Functions            | Bit Functions           | Y              |
    | Functions            | Comparison operators    | Y              |
    | Functions            | Control flow functions  | Y              |
    | Functions            | Date and Time Functions | Y              |
    | Functions            | Encryption Functions    | Y              |
    | Functions            | Information Functions   | Y              |
    | Functions            | Logical operators       | Y              |
    | Functions            | Miscellaneous Functions | Y              |
    | Functions            | Numeric Functions       | Y              |
    | Functions            | String Functions        | Y              |
    +----------------------+-------------------------+----------------+
    ```
