13.8.3 HELP 構文

HELP 'search_string'

HELP は、MySQL リファレンスマニュアルのオンライン情報を返します。これが正しく動作するには、mysql データベース内のヘルプテーブルがヘルプトピック情報で初期化されている必要があります (セクション5.1.10「サーバー側のヘルプ」を参照してください)。

HELP ステートメントは、ヘルプテーブル内の指定された検索文字列を検索し、その検索の結果を表示します。検索文字列は大文字と小文字が区別されません。

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

HELP ステートメントは、次のいくつかの種類の検索文字列を理解します。

• もっとも一般的なレベルでは、トップレベルのヘルプカテゴリのリストを取得するには contents を使用します。

  HELP 'contents'

• Data Types などの、特定のヘルプカテゴリ内のトピックのリストを取得するには、そのカテゴリ名を使用します。

  HELP 'data types'

• ASCII() 関数や CREATE TABLE ステートメントなどの、特定のヘルプトピックに関するヘルプを表示するには、関連する 1 つまたは複数のキーワードを使用します。

  HELP 'ascii'
  HELP 'create table'

つまり、検索文字列はカテゴリ、多数のトピック、または 1 つのトピックに一致します。特定の検索文字列が項目のリストか、または 1 つのヘルプトピックのヘルプ情報のどちらを返すかが前もってわかるとはかぎりません。ただし、結果セット内の行数やカラム数を検査することによって、HELP がどのような種類の応答を返したかがわかります。

次の説明は、結果セットの可能性のある形式を示しています。ステートメントの例の出力は、mysql クライアントの使用時に表示されるなじみのある「表」または「垂直」形式を使用して示されています。

注記

mysql 自体は、HELP の結果セットを別の方法で再フォーマットします。

• 空の結果セット

  検索文字列に一致するものが見つかりませんでした。

• 3 つのカラムを含む単一行が含まれた結果セット

  これは、検索文字列が 1 つのヘルプトピックに一致したことを示します。この結果には 3 つのカラムが含まれています。

  • name: トピック名。

  • description: トピックの説明的なヘルプテキスト。

  • example: 使用例または例。このカラムはブランクである可能性があります。

  例: HELP 'replace'

  生成される結果:

  name: REPLACE
  description: Syntax:
  REPLACE(str,from_str,to_str)
  
  Returns the string str with all occurrences of the string from_str
  replaced by the string to_str. REPLACE() performs a case-sensitive
  match when searching for from_str.
  example: mysql> SELECT REPLACE('www.mysql.com', 'w', 'Ww');
          -> 'WwWwWw.mysql.com'

• 2 つのカラムを含む複数の行が含まれた結果セット

  これは、検索文字列が多数のヘルプトピックに一致したことを示します。この結果セットは、ヘルプトピック名を示します。

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

• 3 つのカラムを含む複数の行が含まれた結果セット

  これは、検索文字列がカテゴリに一致したことを示します。この結果セットには、カテゴリエントリが含まれています。

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