1.1 A propos du manuel
1 Informations générales
Manuel de Référence MySQL 4.1 : Version Française
->Conventions utilisées dans ce manuel
|
1.1.1 Conventions utilisées dans ce manuel
Ce manuel utilise certaines conventions typographiques :
-
constant
-
La police à largeur fixe est utilisée pour les noms de commandes et les
options, les requêtes SQL, les noms de bases de données, de tables et de
colonnes, le code C et Perl, les variables d'environnement.
Par exemple, ``Pour voir comment
mysqladmin
fonctionne, exécutez-le
avec l'option
--help
.''
-
filename
-
La police à largeur fixe avec des guillemets d'encadrement indique
des noms de fichiers et de chemins de dossiers. Par exemple :
``La distribution est installée dans le dossier
/usr/local/
.''
-
'c'
-
La police à largeur fixe avec des guillemets d'encadrement est aussi
utilisée pour indiquer des séquences de caractères. Par exemple :
``Pour spécifier un caractère joker, utilisez le caractère
'%'
.''
-
italique
-
Les polices en italique sont utilisées pour attirer l'attention,
comme ceci
.
-
gras
-
Le gras est utilisé pour les entêtes de tables, et aussi pour
attirer fortement votre attention
.
Lorsque les commandes qui sont affichées sont destinées à
être exécutées par un programme particulier, le nom du
programme est indiqué dans l'invite de la commande. Par exemple,
shell>
indique une commande que vous exécutez
depuis votre console Shell, et
mysql>
indique une commande que vous exécutez
depuis le client
mysql
:
shell> tapez une commande shell ici
mysql> tapez une requête SQL ici
|
Le ``Shell'' est votre interpréteur de ligne de commande. Sous Unix, c'est
typiquement un programme comme
sh
ou
csh
. Sous Windows, le programme
équivalent est
command.com
ou
cmd.exe
, typiquement utilisée en console.
Lorsque vous saisissez une commande dans un exemple, omettez simplement
de saisir l'invite de commande affichée.
Souvent, les noms de bases de données, tables ou colonnes doivent être
remplacés dans les commandes. Pour indiquer qu'une telle substitution
est nécessaire, ce manuel utilise les noms de
nom_de_base
,
nom_de_table
et
nom_colonne
. Par exemple, vous pourriez avoir une
requête comme ceci :
mysql> SELECT nom_colonne FROM nom_de_base.nom_de_table;
|
Cela signifie que si vous devez saisir une requête semblable, vous devriez
utiliser votre propre nom de colonne, table et base de données, ce qui pourrait
se traduire par ceci :
mysql> SELECT author_name FROM biblio_db.author_list;
|
Les mot réservés SQL ne sont pas sensibles à la casse, et peuvent être écrits
en majuscules ou minuscules. Ce manuel utilise les majuscules.
Dans les illustrations de syntaxe, les crochets (
'['
et
']'
) sont
utilisés pour indiquer des clauses ou mots optionnels. Par exemple, dans la requête
suivante,
IF EXISTS
est optionnel :
DROP TABLE [IF EXISTS] nom_de_table
|
Lorsqu'un élément de syntaxe est constitué d'un certain nombre d'alternatives,
les alternatives sont séparées par des barres verticales (
'|'
). Lorsqu'un membre
d'un tel jeu de possibilités
peut
être choisi, les alternatives sont listées
entre crochets (
'['
et
']'
):
TRIM([[BOTH | LEADING | TRAILING] [remstr] FROM] str)
|
Lorsqu'un élément d'un jeu de possibilités
doit
être choisi, les
alternatives sont placées entre accolades (
'{'
et
''
}):
{DESCRIBE | DESC} nom_de_table {nom_colonne | wild}
|
Des crochets peuvent aussi indiquer que l'élément syntaxique précédent peut
être répété. Dans l'exemple suivant, plusieurs valeurs
reset_option
peuvent
être donnés, séparées par des virgules :
RESET reset_option [,reset_option] ...
|
Les commandes d'assignation des variables de Shell sont présentées avec la
syntaxe Bourne Shell. Par exemple, la syntaxe suivante modifie une variable
d'environnement :
shell> VARNAME=value some_command
|
Si vous utilisez
csh
ou
tcsh
, vous devez utiliser une syntaxe
légèrement différente. Il faut écrire :
shell> setenv VARNAME value
shell> some_command
|
|