Die in der Dokumentation verwendete Syntaxnotation ist von der Backus Naur Form (BNF) abgeleitet. Es gelten unter anderem folgende Konventionen:
Syntaxelement |
Beschreibung |
SCHLÜSSELWORT |
Schlüsselwort
Schlüsselwörter werden zur Hervorhebung in Großbuchstaben geschrieben. Wenn in der Dokumentation kein besonderer Hinweis zur Groß- und Kleinschreibung steht, dann können Sie Schlüsselwörter in Groß- oder in Kleinbuchstaben eingeben. |
<variable> |
Platzhalter für Syntaxelement, wie z. B. eine Variable.
Wenn Sie die Variable eingeben, dann geben Sie die spitzen Klammern nicht mit ein. |
[syntax_element] |
optionales Syntaxelement |
syntax_element1 | syntax_element1 |
alternative Syntaxelemente (oder) |
syntax_element, ... |
Syntaxelement kann beliebig oft wiederholt werden. |
Um die Dokumentation übersichtlicher zu gestalten, ist die Syntax folgendermaßen formatiert:
Beispiel |
Beschreibung |
>dbmcli db_enum |
Kommandos und SQL-Anweisungen, die Benutzer eingeben sollen |
OK DEMODB |
Ausgaben des Datenbanksystem, der Datenbankwerkzeuge oder anderer Programme |
Das Kommando db_enum listet alle Datenbankinstanzen auf. Die Dokumentation verwendet die Demo-Datenbankinstanz DEMODB. |
Syntaxelemente und Beispiele im Fließtext |
>sqlcli –d <database_name> –u <database_user>,<database_user_password> <sql_statement>
Um Befehle und Aktionen zu illustrieren, verwendet die Dokumentation die Demo-Datenbankinstanz DEMODB und die darin enthaltenen Beispieldaten des Schemas 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 |
Siehe auch:
SQL-Referenzhandbuch, Syntaxnotation
Loader, Syntaxregeln:
Übersicht