HELP command

Sintaxe

MariaDB [(none)]> HELP search_string

Descrição

O comando HELP pode ser usado em qualquer cliente MariaDB / MySQL, assim como o cliente de linha de comando mysql, para obter uma ajuda básica respeito a sintaxe do MySQL e uma breve descrição da maioria dos comandos e funções.

Se você fornecer um argumento ao comando help, o cliente mysql, usa ele como uma cadeia de busca para acessar a ajuda do lado do servidor. O funcionamiento adequado deste comando requer com que as tabelas de ajuda no banco de dados sejam inicializadas com informação do tópico ajuda.

Se não houver correspondência com a cadeia de busca, a busca falha:

MariaDB [(none)]> HELP something

Nothing found
Please try to run 'help contents' for a list of all accessible topics

Use help contents para ver uma lista das categorias de ajuda:

MariaDB [(none)]> 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
   Language Structure
   Plugins
   Table Maintenance
   Transactions
   User-Defined Functions
   Utility

Se a cadeia de busca corresponde com varios items, mysql mostra uma lista dos tópicos correspondidos:

MariaDB [(none)]> help create
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:
   CREATE DATABASE
   CREATE EVENT
   CREATE FUNCTION
   CREATE FUNCTION UDF
   CREATE INDEX
   CREATE PROCEDURE
   CREATE SERVER
   CREATE TABLE
   CREATE TABLESPACE
   CREATE TRIGGER
   CREATE USER
   CREATE VIEW
   SHOW
   SHOW CREATE DATABASE
   SHOW CREATE EVENT
   SHOW CREATE FUNCTION
   SHOW CREATE PROCEDURE
   SHOW CREATE TABLE
   SPATIAL

Use um tópico como a cadeia de busca para ver a entrada na ajuda para esse tópico.

A ajuda é fornecida pelo servidor MariaDB e as tabelas de ajuda são preenchidas com o script mysql_install_db ou com o script fill_help_table.sql.