MySQL 8.0 リファレンスマニュアル


4.5.1.4 mysql クライアントのサーバー側ヘルプ

mysql> help search_string

help コマンドに引数を指定した場合、mysql は、サーバー側のヘルプにアクセスして MySQL リファレンスマニュアルの内容から検索するための文字列として引数を使用します。 このコマンドを適切に操作するには、mysql データベース内のヘルプテーブルがヘルプトピック情報で初期化されていることが必要です (セクション5.1.17「サーバー側ヘルプのサポート」を参照してください)。

検索文字列に一致するものがない場合、検索は失敗に終わります。

mysql> help me

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

ヘルプカテゴリのリストを閲覧するには help contents を使用してください。

mysql> 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
   Data Definition
   Data Manipulation
   Data Types
   Functions
   Functions and Modifiers for Use with GROUP BY
   Geographic Features
   Language Structure
   Plugins
   Storage Engines
   Stored Routines
   Table Maintenance
   Transactions
   Triggers

検索文字列に一致するものが複数ある場合は、mysql は一致するトピックのリストを表示します。

mysql> help logs
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:
   SHOW
   SHOW BINARY LOGS
   SHOW ENGINE
   SHOW LOGS

トピックのヘルプエントリを閲覧するには、そのトピックを検索文字列として使用してください。

mysql> help show binary logs
Name: 'SHOW BINARY LOGS'
Description:
Syntax:
SHOW BINARY LOGS
SHOW MASTER LOGS

Lists the binary log files on the server. This statement is used as
part of the procedure described in [purge-binary-logs], that shows how
to determine which logs can be purged.

mysql> SHOW BINARY LOGS;
+---------------+-----------+-----------+
| Log_name      | File_size | Encrypted |
+---------------+-----------+-----------+
| binlog.000015 |    724935 | Yes       |
| binlog.000016 |    733481 | Yes       |
+---------------+-----------+-----------+

検索文字列には、ワイルドカード文字 % および_を含めることができます。 これらは LIKE 演算子で実行されるパターンマッチング演算と同じ意味を持ちます。 たとえば、HELP rep%rep で始まるトピックのリストを返します。

mysql> HELP rep%
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:
   REPAIR TABLE
   REPEAT FUNCTION
   REPEAT LOOP
   REPLACE
   REPLACE FUNCTION

関連キーワード:  プログラム, サーバー, テーブル, ヘルプ, 表示, コマンド, myisamchk, 情報, 接続, 検索