В этом руководстве используются определенные типографические соглашения:

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

$> type a command here
#> type a command as root here
C:\> type a command here (Windows only)
mysql> type a mysql statement here

Команды выполняются в вашем интерпретаторе команд. В Unix это обычно программы, такие как sh, csh или bash. В Windows эквивалентной программой является command.com или cmd.exe, обычно запускаемые в окне консоли. Операторы, предваряемые mysql, выполняются в клиенте командной строки mysql.

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

source> type a mysql statement on the replication source here
replica> type a mysql statement on the replica here

Имена баз данных, таблиц и столбцов часто должны быть подставлены в операторы. Чтобы указать необходимость такой подстановки, в этом руководстве используются 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

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

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 и выполнения команды configure выглядит следующим образом в синтаксисе оболочки Bourne:

$> CC=gcc ./configure

Если вы используете csh или tcsh, вы должны выполнять команды немного иначе:

$> setenv CC gcc
$> ./configure

Исходные файлы Справочного руководства написаны в формате DocBook XML. Версия HTML и другие форматы создаются автоматически, в основном с использованием стилей DocBook XSL. Информацию о DocBook см. на http://docbook.org/

Первоначально это руководство было написано Дэвидом Акмарком и Майклом “Монти” Видениусом. Оно поддерживается командой документации MySQL, состоящей из Эдварда Гилмора, Стефана Хинца, Дэвида Холлиса, Филиппа Олсона, Дэниела Со и Джона Стивенса.