13.8.3 HELP Statement — MySQL 5.7

13.8.3 Оператор HELP

HELP 'search_string'

Оператор HELP возвращает онлайн-информацию из Справочного руководства MySQL. Для его корректной работы необходимо, чтобы таблицы справки в базе данных mysql были инициализированы информацией о темах справки (см. Раздел 5.1.14, «Поддержка справки на стороне сервера»).

Оператор 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://docs.oracle.com/cd/E17952_01/mysql-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 ENGINE
   SHOW FUNCTION STATUS
   SHOW MASTER STATUS
   SHOW PROCEDURE 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
   Locking Functions
   Logical Operators
   Miscellaneous Functions
   Numeric Functions
   Spatial Functions
   String Functions
   XML