DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

(mysql.info.gz) mysql_options

Info Catalog (mysql.info.gz) mysql_num_rows (mysql.info.gz) C API functions (mysql.info.gz) mysql_ping
 
 22.2.3.43 `mysql_options()'
 ...........................
 
 `int mysql_options(MYSQL *mysql, enum mysql_option option, const char
 *arg)'
 
 Description
 ...........
 
 Can be used to set extra connect options and affect behavior for a
 connection.  This function may be called multiple times to set several
 options.
 
 `mysql_options()' should be called after `mysql_init()' and before
 `mysql_connect()' or `mysql_real_connect()'.
 
 The `option' argument is the option that you want to set; the `arg'
 argument is the value for the option. If the option is an integer, then
 `arg' should point to the value of the integer.
 
 Possible option values:
 
 *Option*                       *Argument      *Function*
                                Type*          
 `MYSQL_INIT_COMMAND'           `char *'       Command to execute when
                                               connecting to the MySQL
                                               server. Will automatically
                                               be re-executed when
                                               reconnecting.
 `MYSQL_OPT_COMPRESS'           Not used       Use the compressed
                                               client/server protocol.
 `MYSQL_OPT_CONNECT_TIMEOUT'    `unsigned int  Connect timeout in seconds.
                                *'             
 `MYSQL_OPT_LOCAL_INFILE'       optional       If no pointer is given or
                                pointer to     if pointer points to an
                                uint           `unsigned int != 0' the
                                               command `LOAD LOCAL
                                               INFILE' is enabled.
 `MYSQL_OPT_NAMED_PIPE'         Not used       Use named pipes to connect
                                               to a MySQL server on NT.
 `MYSQL_OPT_PROTOCOL'           `unsigned int  Type of protocol to use.
                                *'             Should be one of the enum
                                               values of
                                               `mysql_protocol_type'
                                               defined in `mysql.h'. New
                                               in 4.1.0.
 `MYSQL_OPT_READ_TIMEOUT'       `unsigned int  Timeout for reads from
                                *'             server (works currently
                                               only on Windows on TCP/IP
                                               connections). New in 4.1.1.
 `MYSQL_OPT_WRITE_TIMEOUT'      `unsigned int  Timeout for writes to
                                *'             server (works currently
                                               only on Windows on TCP/IP
                                               connections). New in 4.1.1.
 `MYSQL_READ_DEFAULT_FILE'      `char *'       Read options from the
                                               named option file instead
                                               of from `my.cnf'.
 `MYSQL_READ_DEFAULT_GROUP'     `char *'       Read options from the
                                               named group from `my.cnf'
                                               or the file specified with
                                               `MYSQL_READ_DEFAULT_FILE'.
 `MYSQL_REPORT_DATA_TRUNCATION' `my_bool *'    Enable or disable
                                               reporting of data
                                               truncation errors for
                                               prepared statements via
                                               `MYSQL_BIND.error'.
                                               (Default: disabled) New in
                                               5.0.3.
 `MYSQL_SECURE_AUTH'            `my_bool*'     Whether to connect to a
                                               server that does not
                                               support the new 4.1.1
                                               password hashing. New in
                                               4.1.1.
 `MYSQL_SET_CHARSET_DIR'        `char*'        The pathname to the
                                               directory that contains
                                               character set definition
                                               files.
 `MYSQL_SET_CHARSET_NAME'       `char*'        The name of the character
                                               set to use as the default
                                               character set.
 `MYSQL_SHARED_MEMORY_BASE_NAME'`char*'        Named of shared memory
                                               object for communication
                                               to server. Should be same
                                               as the option
                                               `-shared-memory-base-name'
                                               used for the mysqld server
                                               you want's to connect to.
                                               New in 4.1.0.
 
 Note that the `client' group is always read if you use
 `MYSQL_READ_DEFAULT_FILE' or `MYSQL_READ_DEFAULT_GROUP'.
 
 The specified group in the option file may contain the following
 options:
 
 *Option*           *Description*
 `connect-timeout'  Connect timeout in seconds. On Linux this
                    timeout is also used for waiting for the
                    first answer from the server.
 `compress'         Use the compressed client/server protocol.
 `database'         Connect to this database if no database
                    was specified in the connect command.
 `debug'            Debug options.
 `disable-local-infile'Disable use of `LOAD DATA LOCAL'.
 `host'             Default hostname.
 `init-command'     Command to execute when connecting to
                    MySQL server. Will automatically be
                    re-executed when reconnecting.
 `interactive-timeout'Same as specifying `CLIENT_INTERACTIVE' to
                    `mysql_real_connect()'. 
                    mysql_real_connect.
 `local-infile[=(0|1)]'If no argument or argument != 0 then
                    enable use of `LOAD DATA LOCAL'.
 `max_allowed_packet'Max size of packet client can read from
                    server.
 `multi-results'    Allow multiple result sets from
                    multiple-statement executions or stored
                    procedures.  New in 4.1.1.
 `multi-statements' Allow the client to send multiple
                    statements in a single string (separated
                    by `;'). New in 4.1.9.
 `password'         Default password.
 `pipe'             Use named pipes to connect to a MySQL
                    server on NT.
 `protocol={TCP |   The protocol to use when connecting to
 SOCKET | PIPE |    server (New in 4.1)
 MEMORY}'           
 `port'             Default port number.
 `return-found-rows'Tell `mysql_info()' to return found rows
                    instead of updated rows when using
                    `UPDATE'.
 `shared-memory-base-name=NAME'Shared memory name to use to connect to
                    server (default is "MYSQL"). New in MySQL
                    4.1.
 `socket'           Default socket file.
 `user'             Default user.
 
 Note that `timeout' has been replaced by `connect-timeout', but
 `timeout' will still work for a while.
 
 For more information about option files, see  Option files.
 
 Return Values
 .............
 
 Zero for success.  Non-zero if you used an unknown option.
 
 Example
 .......
 
      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, "Failed to connect to database: Error: %s\n",
                mysql_error(&mysql));
      }
 
 This code requests the client to use the compressed client/server
 protocol and read the additional options from the `odbc' section in the
 `my.cnf' file.
 
Info Catalog (mysql.info.gz) mysql_num_rows (mysql.info.gz) C API functions (mysql.info.gz) mysql_ping
automatically generated byinfo2html