Команда HELP

Синтаксис

HELP search_string

Описание

Команда HELP может использоваться в любом клиенте MariaDB, например, в командной строке mariadb, для получения базовой справки по синтаксису и краткого описания большинства команд и функций.

Если вы предоставите аргумент команде HELP, клиент mariadb использует его как строку поиска для доступа к справке на стороне сервера. Для корректной работы этой команды необходимо, чтобы таблицы справки в базе данных mysql были инициализированы информацией о темах справки.

Если совпадений со строкой поиска не найдено, поиск завершается неудачно. Используйте HELP contents для просмотра списка категорий справки:

HELP contents
You asked for help about help category: "Contents"
For more information, type 'help <item>', where <item> is one of the following
categories:
   Account Management
   Administration
   Compound Statements
   Data Definition
   Data Manipulation
   Data Types
   Functions
   Functions and Modifiers for Use with GROUP BY
   Geographic Features
   Help Metadata
   Language Structure
   Plugins
   Procedures
   Sequences
   Table Maintenance
   Transactions
   User-Defined Functions
   Utility

Если строка поиска соответствует нескольким элементам, MariaDB отображает список соответствующих тем:

HELP drop
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:
   ALTER TABLE
   DROP DATABASE
   DROP EVENT
   DROP FUNCTION
   DROP FUNCTION UDF
   DROP INDEX
   DROP PACKAGE
   DROP PACKAGE BODY
   DROP PROCEDURE
   DROP ROLE
   DROP SEQUENCE
   DROP SERVER
   DROP TABLE
   DROP TRIGGER
   DROP USER
   DROP VIEW

Затем вы можете ввести тему в качестве строки поиска, чтобы увидеть запись справки по этой теме.

Справка предоставляется сервером MariaDB и использует четыре таблицы справки, находящиеся в базе данных mysql: help_relation, help_topic, help_category и help_keyword. Эти таблицы заполняются скриптами mariadb-install-db или fill_help_table.sql.