Spec-Zone .ru
спецификации, руководства, описания, API

1.2. Соглашения о правилах печати и Соглашения о синтаксисе

Это руководство использует определенные соглашения о правилах печати:

Когда команды показывают, которые предназначаются, чтобы быть выполненными изнутри определенной программы, подсказка, показанная, предшествуя команде, указывает который команда использовать. Например, shell> указывает на команду, которую Вы выполняете от своей оболочки входа в систему, root-shell> подобно, но должен быть выполнен как root, и mysql> указывает на оператор, который Вы выполняете из mysql клиентской программы:

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

В некоторых областях различные системы можно отличить друг от друга, чтобы показать, что команды должны быть выполнены в двух различных средах. Например, работая с репликацией команды могли бы быть снабжены префиксом master и slave:

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

"Оболочка" является Вашим интерпретатором команд. На Unix это обычно - программа, такая как sh, csh, или удар. На 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 не являются чувствительными к регистру и могут быть записаны в любом lettercase. Это руководство использует верхний регистр.

В описаниях синтаксиса, квадратные скобки ("["и"]"), указывают на дополнительные слова или пункты. Например, в следующем операторе, IF EXISTS является дополнительным:

DROP TABLE [IF EXISTS] tbl_name

Когда элемент синтаксиса состоит из многих альтернатив, альтернативы разделяются вертикальными панелями ("|"). Когда один элемент от ряда вариантов может быть выбран, альтернативы перечисляются в пределах квадратных скобок ("["и"]"):

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

Когда один элемент от ряда вариантов должен быть выбран, альтернативы перечисляются в пределах фигурных скобок ("{"и"}"):

{DESCRIBE | DESC} tbl_name [col_name | wild]

Замещающий знак (...) указывает на пропуск раздела оператора, обычно чтобы обеспечить более короткую версию более сложного синтаксиса. Например, SELECT ... INTO OUTFILE сокращение для формы SELECT оператор, который имеет INTO OUTFILE пункт после других частей оператора.

Замещающий знак может также указать, что предыдущий элемент синтаксиса оператора может быть повторен. В следующем примере, многократном reset_option значения могут быть даны с каждым из тех после первого, которому предшествуют запятые:

RESET reset_option [,reset_option] ...

Команды для того, чтобы установить переменные оболочки показывают, используя синтаксис Оболочки Bourne. Например, последовательность, чтобы установить CC переменная окружения и выполненный сконфигурировать команда похожа на это в синтаксисе Оболочки Bourne:

shell> CC=gcc ./configure

Если Вы используете csh или tcsh, следует дать команды несколько по-другому:

shell> setenv CC gccshell> ./configure