1.2 表記規則および構文規則

このマニュアルは、次の表記規則に従って記載されています。

• このスタイルのテキストは、SQL ステートメント、データベース、テーブル、カラム名、プログラムリスト、ソースコード、環境変数に使用されます。例: 「付与テーブルをリロードするには、FLUSH PRIVILEGES ステートメントを使用します。」

• このスタイルのテキストは、例の中で入力する文字の例を示します。

• このスタイルのテキストは、mysql (MySQL コマンド行のクライアントプログラム) および mysqld (MySQL Server 実行可能ファイル) である実行可能プログラムおよびスクリプトの名前を示します。

• このスタイルのテキストは、独自に選択する値に置き換える変数入力に使用されます。

• このスタイルのテキストは、強調に使用されます。

• このスタイルのテキストは、表の見出しや特に重要なことを示すときに使用されます。

• このスタイルのテキストは、プログラムの実行方法に影響を与えるか、またはプログラムが特定の方法で機能するために必要な情報を提供するプログラムオプションを示すために使用されます。例: 「--host オプション (短縮形 -h) は、mysql クライアントプログラムに対して接続すべき MySQL Server のホスト名または IP アドレスを指示します」。

• ファイル名とディレクトリ名は次のように表示されます。「グローバル my.cnf ファイルは、/etc ディレクトリにあります。」

• 文字シーケンスは次のように表示されます。「ワイルドカードを指定するには、『%』 文字を使用します。」

特定のプログラム内から実行されるコマンドが示される場合、そのコマンドの前に記されるプロンプトは、どのコマンドが使用されるかを示しています。たとえば、shell> はログインシェルから実行するコマンドを示し、root-shell> は同様ですが root として実行する必要があり、mysql> は mysql クライアントプログラムから実行するステートメントを示します。

shell> type a shell command here
root-shell> type a shell command as root here
mysql> type a mysql statement here

領域によっては、コマンドを 2 つの異なる環境で実行すべきであることを示すために、異なるシステムが区別される場合があります。たとえば、レプリケーションを操作する場合、コマンドの前に master および slave が記される場合があります。

master> type a mysql command on the replication master here
slave> type a mysql command on the replication slave here

「shell」 は、コマンドインタープリタです。UNIX の場合、これは通常、sh、csh、bash などのプログラムです。Windows の場合、同等のプログラムは command.com または cmd.exe で、通常コンソールウィンドウで実行します。

例に示されるコマンドまたはステートメントを入力する場合、その例に示されるプロンプトを入力する必要はありません。

データベース名、テーブル名、およびカラム名は多くの場合、ステートメントに代入する必要があります。このような代入が必要であることを示す場合、このマニュアルでは db_name、tbl_name、および col_name を使用します。たとえば、次のようなステートメントがあるとします。

mysql> SELECT col_name FROM db_name.tbl_name;

これは、同様のステートメントを入力する場合、データベース名、テーブル名、およびカラム名を自分で指定することを意味します。たとえば、次のようになります。

mysql> SELECT author_name FROM biblio_db.author_list;

SQL キーワードは大文字と小文字を区別しないので、大文字で記述されることも小文字で記述されることもあります。このマニュアルでは大文字を使用します。

構文の説明では、角かっこ (「[」 および 「]」) はオプションの語または句を示します。たとえば、次のステートメントでは、IF EXISTS はオプションです。

DROP TABLE [IF EXISTS] tbl_name

構文要素が複数の選択肢で構成される場合、選択肢は縦棒 (「|」) で区切られます。一連の選択肢から 1 つのメンバーを選択できる場合、選択肢は角かっこ (「[」 および 「]」) 内にリストされます。

TRIM([[BOTH | LEADING | TRAILING] [remstr] FROM] str)

一連の選択肢から 1 つのメンバーを選択しなければならない場合、選択肢は中かっこ (「{」 および 「}」) 内にリストされます。

{DESCRIBE | DESC} tbl_name [col_name | wild]

省略記号 (...) は、ステートメントの一部が省略されていることを示し、通常、複雑な構文を簡単に記しています。たとえば、SELECT ... INTO OUTFILE は、ステートメントのほかの部分に INTO OUTFILE 句が続く SELECT ステートメントを省略したものです。

省略記号は、ステートメントで前にある構文要素を繰り返すことができる場合にも使用されます。次の例では、reset_option 値を、最初のもの以外はそれぞれカンマを前に付けて、複数回繰り返すことができます。

RESET reset_option [,reset_option] ...

シェル変数を設定するコマンドは、Bourne シェル構文を使用して示されます。たとえば、CC 環境変数を設定し、configure コマンドを実行するシーケンスは、Bourne シェル構文では次のように示されます。

shell> CC=gcc ./configure

csh または tcsh を使用する場合、多少異なるコマンドを入力する必要があります。

shell> setenv CC gcc
shell> ./configure