文書では、バッカスナウアー記法 (BNF) にもとづいた構文表記が使用されています。特に、以下の規則が適用されます。
構文要素 |
内容 |
KEYWORD |
キーワード
キーワードは、大文字で強調されています。文書で大文字と小文字が区別されると明記されていない場合は、キーワードは大文字または小文字のいずれでも記述することができます。 |
<variable> |
変数などの構文要素のプレースホルダ
変数に入力する場合は、山括弧は入力しません。 |
[syntax_element] |
オプションの構文要素 |
syntax_element1 | syntax_element1 |
選択的構文要素 (OR) |
syntax_element, ... |
この構文要素は必要に応じて、何度でも繰り返すことができます。 |
文書を参照しやすくするために、構文は以下のように書式設定されています。
例 |
内容 |
>dbmcli db_enum |
ユーザが入力する必要があるコマンドおよび SQL 文 |
OK DEMODB |
データベースシステム、データベースツール、またはその他のプログラムの出力 |
コマンド db_enum は、すべてのデータベースインスタンスを一覧表示します。 文書では、デモデータベースインスタンス DEMODB を使用しています。 |
継続テキスト内の構文要素および例 |
>sqlcli –d <database_name> –u <database_user>,<database_user_password> <sql_statement>
コマンドおよびアクションを説明するために、この文書では DEMODB デモデータベースインスタンスおよび HOTEL スキーマサンプルデータを使用しています。
>sqlcli –d demodb -u mona,red SELECT * FROM hotel.city
| ZIP | NAME | STATE |
| ----- | -------------------- | ----- |
| 10019 | New York | NY |
| 10580 | New York | NY |
| 11788 | Long Island | NY |
| 12203 | Albany | NY |
| 20005 | Washington | DC |
| 20019 | Washington | DC |
参照:
SQL 参照マニュアル、構文表記
ローダ、構文ルール: 概要