Skip navigation links
24.2.3.44 mysql_ping() »
Section Navigation      [Toggle]

24.2.3.43. mysql_options()

int mysql_options(MYSQL *mysql, enum mysql_option option, const char *arg)

Description

Cette fonction peut être utilisée pour spécifier des options de connexion et modifier le comportement de la session courante. Cette fonction peut être appelée plusieurs fois pour définir plusieurs options.

mysql_options() doit être appelée après mysql_init() et avant mysql_connect() ou mysql_real_connect().

L'argument option est l'option que vous voulez configurer; l'argument arg est la valeur pour cette option. Si l'option est un entier, arg doit pointer sur la valeur d'un entier.

Les valeurs possibles pour les options sont :

Option Type de l'argument Fonction
MYSQL_OPT_CONNECT_TIMEOUT unsigned int * Délai d'inactivité maximal permis.
MYSQL_OPT_READ_TIMEOUT unsigned int * Délai d'expiration pour les lectures depuis le serveur (fonctionne uniquement sur Windows sur les connexions TCP/IP)
MYSQL_OPT_WRITE_TIMEOUT unsigned int * Délai pour les écritures sur le serveur (fonctionne uniquement sur Windows sur les connexions TCP/IP)
MYSQL_OPT_COMPRESS Non utilisé Utiliser le protocole compressé client/serveur.
MYSQL_OPT_LOCAL_INFILE pointeur optionnel sur uint Si aucun pointeur n'est donné, ou que celui-ci pointe sur un unsigned int != 0 la commande LOAD LOCAL INFILE est activée.
MYSQL_OPT_NAMED_PIPE Non utilisé Utiliser les pipes nommés pour se connecter au serveur MySQL sur NT.
MYSQL_INIT_COMMAND char * Commande à exécuter lors de la connexion au serveur MySQL. Sera automatiquement re-exécutée lors des reconnexions.
MYSQL_READ_DEFAULT_FILE char * Lit les options à partir du fichier d'options nommé plutôt que de my.cnf.
MYSQL_READ_DEFAULT_GROUP char * Lit les options à partir du groupe spécifié dans le fichier d'options my.cnfou le fichier spécifié par MYSQL_READ_DEFAULT_FILE.
MYSQL_OPT_PROTOCOL unsigned int * Type de protocole à utiliser. Doit être une des valeurs de mysql_protocol_type définies dans mysql.h.
MYSQL_SHARED_MEMORY_BASE_NAME char* Nom d'un objet de mémoire partagée pour communiquer avec le serveur. Doit être le même que l'option -shared-memory-base-name utilisé pour le serveur mysqld auquel vous voulez vous connecter.

Notez que le groupe client est toujours lu si vous utilisez MYSQL_READ_DEFAULT_FILE ou MYSQL_READ_DEFAULT_GROUP.

Le groupe spécifié dans le fichier des options peut contenir les options suivantes :

Option Description
connect-timeout Délai d'inactivité maximal permis en secondes. Sous Linux, ce délai est aussi utilisé lors de l'attente de la première réponse du serveur.
compress Utiliser le protocole compressé client/serveur.
database Se connecter à cette base de données si aucune base n'a été sélectionnée à la connexion.
debug Options de débogage.
disable-local-infile Interdit l'utilisation de LOAD DATA LOCAL.
host Nom d'hôte par défaut.
init-command Commande lors de la connexion au serveur MySQL. Sera automatiquement re-exécutée lors des reconnexions.
interactive-timeout Revient à spécifier CLIENT_INTERACTIVE à mysql_real_connect(). See Section 24.2.3.46, « mysql_real_connect() ».
local-infile[=(0|1)] Si aucun argument, ou argument != 0, on permet alors l'utilisation de LOAD DATA LOCAL.
max_allowed_packet Taille maximale de paquet que le client peut lire du serveur.
password Mot de passe par défaut.
pipe Utiliser les tunnels nommés pour se connecter à MySQL sur NT.
protocol=(TCP | SOCKET | PIPE | MEMORY) Le protocole utilisé lors de la connexion au serveur (nouveau en version 4.1).
port Port par défaut.
return-found-rows Demande à mysql_info() de retourner les lignes trouvées au lieu des lignes mises à jour lors de l'utilisation de UPDATE.
shared-memory-base-name=name Nom de l'objet en mémoire partagée à utiliser pour se connecter au serveur (par défaut, c'est "MySQL"). Nouveau en MySQL 4.1.
socket Numéro de socket par défaut.
user Utilisateur par défaut.

Notez que timeout a été remplacé par connect-timeout, mais que timeout fonctionne encore pour le moment.

Pour plus d'informations sur les fichiers d'options, reportez vous à Section 4.3.2, « Fichier d'options my.cnf ».

Valeur de retour

Zéro si la commande a été effectuée avec succès. Différente de zéro si une erreur est survenue.

Exemple 

MYSQL mysql;

mysql_init(&mysql);
mysql_options(&mysql,MYSQL_OPT_COMPRESS,0);
mysql_options(&mysql,MYSQL_READ_DEFAULT_GROUP,"odbc");
if (!mysql_real_connect(&mysql,"host","user","passwd","database",0,NULL,0))
{
    fprintf(stderr, "Impossible de se connecter à la base de données. Erreur : %s\n",
          mysql_error(&mysql));
}

Ce qui précède demande au client d'utiliser le protocole compressé client/serveur et lit les options optionnelles de la section odbc dans le fichier my.cnf.

This is a translation of the MySQL Reference Manual that can be found at dev.mysql.com. The original Reference Manual is in English, and this translation is not necessarily as up to date as the English version.