15.8.3 HELP Statement — MySQL 8.4

15.8.3 Заявление HELP

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://docs.oracle.com/cd/E17952_01/mysql-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