MySQLのサーバーサイドヘルプ機能の使い方を徹底解説

MySQLには、mysqlモニタ（クライアント）から離れることなくリファレンスマニュアルの内容を直接参照できる「サーバーサイドヘルプ」機能が用意されています。本記事では、helpコマンドの基本的な使い方と、よくある活用シーンを具体例とともに解説します。

helpコマンドの基本構文

mysql> help 検索文字列

helpコマンドに引数（検索文字列）を渡すと、mysqlはその文字列をキーとして、MySQLリファレンスマニュアルの内容から該当するヘルプ情報を検索して表示します。なお、このコマンドが正しく動作するためには、mysqlデータベース内のヘルプテーブルにヘルプトピックの情報があらかじめ初期化・登録されている必要があります。

検索結果が見つからない場合

検索文字列に一致する項目が存在しない場合、検索は失敗します。次の例で確認してみましょう。

mysql> help me

出力例

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

このように何も見つからない場合は、「help contents」を実行すれば、アクセス可能なすべてのトピック一覧を確認できると案内されます。

ヘルプカテゴリの一覧を表示する

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

出力には、アカウント管理（Account Management）、管理操作（Administration）、データ定義（Data Definition）、データ操作（Data Manipulation）、データ型（Data Types）、関数（Functions）、ストレージエンジン（Storage Engines）、トランザクション（Transactions）、トリガー（Triggers）など、15のカテゴリが表示されます。さらに詳しい情報が必要な場合は、「help 項目名」の形式で入力することで、個別のカテゴリやトピックに絞り込んで参照できます。

複数の項目に一致した場合

検索文字列が複数の項目にヒットした場合、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

このケースでは、表示された候補の中から目的のトピックを選び、「help SHOW BINARY LOGS」のように具体的なキーワードを指定して再検索すると、求めている情報にたどり着けます。

まとめ

サーバーサイドヘルプ機能を活用すれば、ブラウザやドキュメントサイトを開かずとも、SQL構文やステートメントの使い方をmysqlクライアント上で素早く調べられます。キーワードが曖昧なときは、まず「help contents」で全体像を把握し、カテゴリ→トピックの順に段階的に絞り込むのが効率的な調査のコツです。