12.3.2 HELP 構文

12.3.2. `HELP` 構文

HELP 'search_string'

HELP ステートメントは MySQL リファレンスマニュアルからオンライン情報を返します。その正しい操作の為には mysql データベース内のヘルプテーブルが、ヘルプトピック情報で初期化さる必要があります。(項4.2.8. 「サーバサイドヘルプ」を参照してください。)

HELP ステートメントは、ヘルプテーブルの中で与えられた検索文字列を検索し、その結果を表示します。検索文字列は、大文字と小文字を区別しません。

HELP ステートメントはいくつかの検索文字列タイプを理解します。

一般的なレベルでは、最高レベルのヘルプカテゴリのリストを検索する為に contents を利用してください。
```
HELP 'contents'
```
Data Types のような与えられたヘルプカテゴリ内のトピックリストには、カテゴリ名を利用してください。
```
HELP 'data types'
```
ASCII() 関数や CREATE TABLE ステートメントのような特定のヘルプトピックには、関連キーワードを利用してください。
```
HELP 'ascii'
HELP 'create table'
```

言い換えると、検索文字列はカテゴリ、多くのトピック、または単一トピックに一致するという事です。あらかじめ、与えられた検索文字列が、項目リストや単一ヘルプトピックのヘルプ情報を返すかどうかを知る事はできません。しかし、結果セットの中のカラムと行数を調べる事で、HELP がどのような答えを返したのかを知る事ができます。

次の説明は結果セットが取る事ができる形を指示します。ステートメント例のアウトプットは、mysql クライアントを利用する時に見る事ができる為になじみのある「tabular」や「vertical」フォーマットを利用して表示されますが、mysql 自体は HELP 結果セットを違う方法で再フォーマットする事に注意してください。

空の結果セット

検索文字列に一致する物が見つかりませんでした。
3つのカラムを持つ単列を含む結果セット

これは、検索文字列がヘルプトピックにヒットをもたらしたという意味です。結果は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。もしそうでなければ、HELP ステートメントへの引数として指定された時の name 値は、名づけられた項目に対する説明を含む単列結果セットをもたらす必要があります。
例:HELP 'status'

下記をもたらします。
```
+-----------------------+----------------+
| name                  | is_it_category |
+-----------------------+----------------+
| SHOW                  | N              |
| SHOW ENGINE           | N              |
| SHOW INNODB STATUS    | 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。もしそうでなければ、HELP ステートメントへの引数として指定された時の name 値は、名づけられた項目に対する説明を含む単列結果セットをもたらす必要があります。

例: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              |
+----------------------+-------------------------+----------------+

12.3.2. HELP 構文

12.3.2. `HELP` 構文