1.2 Соглашения, используемые в данном руководстве
В данном руководстве используются следующие обозначения:
Моноширинный
-
Для имен команд и опций; SQL-операторов; имен баз данных, таблиц,
столбцов; кода на C и Perl, переменных окружения применяется моноширинный
шрифт. Например: ''Чтобы увидеть, как работает
mysqladmin, запустите его с
опцией --help.''
- `filename'
-
Моноширинный шрифт и кавычки используются для имен файлов и путей. Например: "Дистрибутив устанавливается в каталог `/usr/local/'".
- `c'
-
Для представления последовательности символов используется моноширинный
шрифт, а сама последовательность символов заключается в кавычки. Например:
"Для задания шаблонного символа используется символ `%'".
- Курсив
-
Курсив используется для выделения текста, подобно данному.
- полужирный шрифт
-
Полужирный шрифт используется для заголовков таблиц и для того, чтобы
особо выделить фрагмент текста.
Если нужно показать, что приведенная команда должна выполняться
определенной программой, она предваряется подсказкой с именем этой
программы. Например, shell> указывает, что команда будет выполняться
вашей оболочкой, а mysql> означает, что команда будет выполняться
клиентской программой mysql:
shell> набирайте команды оболочки здесь
mysql> набирайте SQL-операторы здесь
Для представления команд оболочки в данном руководстве применяется
синтаксис оболочки Bourne. Если у вас используется csh-оболочка, синтаксис
для нее будет несколько отличаться. Например, последовательность команд
для установки переменной окружения и запуска команды в синтаксисе оболочки
Bourne выглядит следующим образом:
shell> ПЕРЕМЕННАЯ=значение некая_команда
В случае csh-оболочки для выполнения тех же действий вам потребуются
следующие команды:
shell> setenv ПЕРЕМЕННАЯ значение
shell> некая_команда
Часто в командах имена баз данных, таблиц, столбцов следует заменять
конкретными значениями. Чтобы показать необходимость такой замены, в
данном руководстве используются выражения типа db_name (имя базы данных),
table_name (имя таблицы) и col_name (имя столбца). Например, в тексте
руководства может встретиться оператор, подобный следующему:
mysql> SELECT col_name FROM db_name.table_name;
Это означает, что при вводе такого оператора вам необходимо будет указать
собственную базу данных, имя таблицы и имя столбца, например:
mysql> SELECT author_name FROM biblio_db.author_list;
Ключевые слова SQL являются нечувствительными к регистру, поэтому их можно
записывать, используя как прописные, так и строчные буквы. В данном
руководстве используется регистр прописных букв.
Для представления необязательных слов и выражений в синтаксических
описаниях используются квадратные скобки (`[' и `]'). Например, в
приведенном ниже операторе выражение IF EXISTS является необязательным:
DROP TABLE [IF EXISTS] имя_таблицы
Если элемент синтаксиса состоит из ряда альтернативных элементов,
последние отделяются друг от друга вертикальными чертами (`|' ). В случае,
когда может быть выбран один элемент из такого ряда, альтернативные
элементы заключаются в квадратные скобки (`[' и `]'):
TRIM([[BOTH | LEADING | TRAILING] [remstr] FROM] str)
В случае, когда должен быть выбран один элемент из такого ряда,
альтернативные элементы заключаются в фигурные скобки (`{' и `}'):
{DESCRIBE | DESC } имя_таблицы {имя_столбца | wild}
