13.8.3. `HELP` Синтаксис

HELP 'search_string'

HELP оператор возвращает онлайновую информацию из MySQL Reference manual. Его правильное функционирование требует что таблицы справки в mysql база данных быть инициализированным с информацией о теме справки (см. Раздел 5.1.10, "Серверная Справка").

HELP оператор ищет таблицы справки данную строку поиска и выводит на экран результат поиска. Строка поиска не является чувствительной к регистру.

Строка поиска может содержать подстановочные символы"%"и"_". У них есть то же самое значение что касается операций сопоставления с образцом, выполняемых с LIKE оператор. Например, HELP 'rep%' возвращает список тем, которые начинаются rep.

Оператор HELP понимает несколько типов строк поиска:

На наиболее общем уровне использовать contents чтобы получить список верхнего уровня помогают категориям:
```
HELP 'contents'
```
Для списка тем в данной категории справки, такой как Data Types, используйте название категории:
```
HELP 'data types'
```
Для справки на определенной теме справки, такой как ASCII() функционируйте или CREATE TABLE оператор, используйте связанное ключевое слово или ключевые слова:
```
HELP 'ascii'HELP 'create table'
```

Другими словами строка поиска соответствует категорию, много тем, или единственную тему. Невозможно обязательно сказать заранее, возвратит ли данная строка поиска список элементов или справочной информации для единственной темы справки. Однако, можно сказать какой ответ HELP возвращенный, исследуя число строк и столбцов в наборе результатов.

Следующие описания указывают на формы, которые может принять набор результатов. Вывод для операторов в качестве примера показывают, используя знакомый "табличный" или "вертикальный" формат, который Вы видите при использовании mysql клиента, но отмечаете, что сам mysql переформатировал HELP наборы результатов по-другому.

Пустой набор результатов

Никакое соответствие не могло быть найдено для строки поиска.
Набор результатов, содержащий единственную строку с тремя столбцами

Это означает что строка поиска, к которой приводят хит для темы справки. У результата есть три столбца:
- name: Название темы.
- description: Дескриптивный текст справки для темы.
- example: Пример использования или примеры. Этот столбец мог бы быть пробелом.
Пример: HELP 'replace'

Урожаи:
```
name: REPLACEdescription: Syntax:REPLACE(str,from_str,to_str)Returns the string str with all occurrences of the string from_strreplaced by the string to_str. REPLACE() performs a case-sensitivematch when searching for from_str.example: mysql> SELECT REPLACE('www.mysql.com', 'w', 'Ww');        -> 'WwWwWw.mysql.com'
```
Набор результатов, содержащий многократные строки с двумя столбцами

Это означает что строка поиска, соответствующая много тем справки. Набор результатов указывает на названия темы справки:
- name: Название темы справки.
- is_it_category: Y если имя представляет категорию справки, N если это не делает. Если это не делает, name оцените когда определено как параметр HELP оператор должен привести к набору результатов единственной строки, содержащему описание для именованного элемента.
Пример: HELP 'status'

Урожаи:
```
+-----------------------+----------------+| 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: Название категории справки.
name: Название категории или название темы
is_it_category: Y если имя представляет категорию справки, N если это не делает. Если это не делает, name оцените когда определено как параметр HELP оператор должен привести к набору результатов единственной строки, содержащему описание для именованного элемента.

Пример: HELP 'functions'

Урожаи:

+----------------------+-------------------------+----------------+| 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              |+----------------------+-------------------------+----------------+

13.8.3. HELP Синтаксис

13.8.3. `HELP` Синтаксис