Convenciones utilizadas en el manual de mysql 5

Este manual usa ciertas convenciones tipográficas:

• El texto de este estilo se usa para sentencias SQL; nombres de bases de datos, tablas y columnnas; código C y Perl; y variables de entorno. Ejemplo: "Para recargar las tablas de permisos use el comando FLUSH PRIVILEGES".
• El texto de este estilo se usa para entrada de variables las cuales debe substituir por un valor de su propia elección.
• Nombres de ficheros y directorios se escriben así: "El fichero global my.cnf se encuentra en el directorio /etc".
• Las secuencias de caracteres se escriben así: "Para especificar un comodín, use el carácter '%'."
• El texto de este estilo se usa para enfatizar.
• El texto de este estilo se usa en las cabeceras y para dar un enfásis especialmente fuerte.

Cuando se muestran comandos que deben ser ejecutados en un programa particular, el programa se indica con un prompt mostrado antes del comando. Por ejemplo, shell> indica un comando que se ejecuta desde el login shell, y mysql> indica un comando que se ejecuta desde el programa cliente mysql :

shell> escriba un comando de shell aquí
mysql> escriba un comando mysql aquí

El "shell" es su intérprete de comandos. En Unix, esto es normalmente un programa como sh csh. En Windows, el programa equivalente es command.com o cmd.exe, normalmente ejecutado en una ventana de consola.

Cuando introduzca un comando u órden no escriba el prompt mostrado en el ejemplo.

Nombres de bases de datos, tablas y columnas a menudo deben reemplazarse en los comandos. Para indicar que dicha substitución es necesaria, el manual usa db_name, tbl_name, y col_name. Por ejemplo, puede ver un comando como este:

mysql> SELECT col_name FROM db_name.tbl_name;

Significa que si quisiera introducir un comando similar, debería escribir su propio nombre de base de datos, tabla y columna, tal vez así:

mysql> SELECT author_name FROM biblio_db.author_list;

Las palabras clave SQL no son case sensitive y pueden escribirse en mayúsculas o minúsculas. Este manual usa mayúsculas.

En descripciones de sintaxis, corchetes ('[' y ']') se usan para indicar palabras o cláusulas opcionales. Por ejemplo, en el siguiente comando, IF EXISTS es opcional:

DROP TABLE [IF EXISTS] tbl_name

Cuando un elemento de sintaxis consiste en un número de alternativas, las alternativas se separan mediante barras verticales ('|'). Cuando un miembro de una serie de elecciones puede ser elegido, las alternativas se muestran entre corchetes ('[' y ']'):

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

Cuando un miembro de una serie de elecciones debe ser elegido, las alternativas se muestran entre llaves ('{' y '}'):

{DESCRIBE | DESC} tbl_name [col_name | wild]

Puntos suspensivos (...) indica la omisión de una parte del comando, típicamente para proporcionar una versión corta de una sintaxis más compleja. Por ejemplo, INSERT ... SELECT es la versión corta de un comando INSERT seguido de un comando SELECT.

Puntos suspensivos pueden tambier indicar que el elemento de sintaxis precedente de un comando puede repertirse. En el siguiente ejemplo, pueden darse varios valores reset_option cada uno de ellos tras el primero precedidos por comas:

RESET reset_option [,reset_option] ...

Los comandos para inicializar variables del shell se muestran usando la sintaxis del shell Bourne. Por ejemplo, la secuencia para incializar una variable de entorno y ejecutar un comando es la siguiente con la sintaxis del shell Bourne:

shell> VARNAME=value some_command

Si utiliza csh o tcsh, debe proporcionar comandos ligeramente distintos. Debería ejecutar la secuencia anterior así:

shell> setenv VARNAME value
shell> some_command