Submit a Pull Request Report a Bug

    mysqli::options

    mysqli_options

    (PHP 5)

    mysqli::options -- mysqli_options — Set options

    Опис

    Об'єктно-орієнтований стиль

    bool mysqli::options ( int $option , mixed $value )

    Процедурний стиль

    bool mysqli_options ( mysqli $link , int $option , mixed $value )

    Used to set extra connect options and affect behavior for a connection.

    This function may be called multiple times to set several options.

    mysqli_options() should be called after mysqli_init() and before mysqli_real_connect().

    Параметри

    link

    Procedural style only: A link identifier returned by mysqli_connect() or mysqli_init()

    option

    The option that you want to set. It can be one of the following values:

    Valid options
    Name Description
    MYSQLI_OPT_CONNECT_TIMEOUT connection timeout in seconds (supported on Windows with TCP/IP since PHP 5.3.1)
    MYSQLI_OPT_LOCAL_INFILE enable/disable use of LOAD LOCAL INFILE
    MYSQLI_INIT_COMMAND command to execute after when connecting to MySQL server
    MYSQLI_READ_DEFAULT_FILE Read options from named option file instead of my.cnf
    MYSQLI_READ_DEFAULT_GROUP Read options from the named group from my.cnf or the file specified with MYSQL_READ_DEFAULT_FILE.
    MYSQLI_SERVER_PUBLIC_KEY RSA public key file used with the SHA-256 based authentication.
    MYSQLI_OPT_NET_CMD_BUFFER_SIZE The size of the internal command/network buffer. Only valid for mysqlnd.
    MYSQLI_OPT_NET_READ_BUFFER_SIZE Maximum read chunk size in bytes when reading the body of a MySQL command packet. Only valid for mysqlnd.

    value

    The value for the option.

    Значення, що повертаються

    Повертає TRUE в успішному випадку або FALSE в разі помилки.

    Журнал Змін

    Версія Опис
    5.5.0 The MYSQLI_SERVER_PUBLIC_KEY option was added.

    Приклади

    See mysqli_real_connect().

    Примітки

    Зауваження:

    MySQLnd always assumes the server default charset. This charset is sent during connection hand-shake/authentication, which mysqlnd will use.

    Libmysqlclient uses the default charset set in the my.cnf or by an explicit call to mysqli_options() prior to calling mysqli_real_connect(), but after mysqli_init().

    Прогляньте Також

    add a note add a note

    User Contributed Notes 3 notes

    up
    8
    php at darkain dot com
    5 years ago
    There is an undocumented option: MYSQLI_OPT_READ_TIMEOUT. This is similar to MYSQLI_OPT_CONNECT_TIMEOUT in theory, but has a slightly different application. Connection timeout only specifies the wait time for the initial TCP connection. Once that is created, the timeout no longer applies. Read timeout, however, is from the time the TCP connection is created until the first packet of actual data is received. There are instances where a TCP connection can be established, but the MySQL server stalls indefinitely, preventing execution from ever returning to PHP. Specifying a read timeout alleviates this condition, whereas connect timeout wouldn't.

    If the MYSQLI_OPT_READ_TIMEOUT constant isn't defined, it is still supported on versions where that isn't the case. You can define it yourself in older PHP versions with the following code.

    <?php
    if (!defined('MYSQLI_OPT_READ_TIMEOUT')) {
            define ('MYSQLI_OPT_READ_TIMEOUT', 11);
    }
    ?>

    You can then use read timeout the same way you could a connect timeout as follows. Please note that since these are two different timeout values for two different parts of the entire connection process, the timeouts do stack (eg: 10 seconds connect timeout + 10 seconds read timeout = maximum possible timeout of 20 seconds)

    <?php
    //create the object
    $connection = mysqli_init();

    //specify the connection timeout
    $connection->options(MYSQLI_OPT_CONNECT_TIMEOUT, 10);

    //specify the read timeout
    $connection->options(MYSQLI_OPT_READ_TIMEOUT, 10);

    //initiate the connection to the server, using both previously specified timeouts
    $connection->real_connect('server', 'user', 'pass', 'database');
    ?>
    up
    8
    fluppy
    17 years ago
    Here es little example to create a SSL Connection

    <?php

    $db     = mysqli_init();

    /*
    When you want so use a separate cnf
    $test = $db->options(MYSQLI_EAD_DEFAULT_FILE,'myother.cnf');
    */

    $db->ssl_set('server-key.pem','server-cert.pem',
    'cacert.pem',NULL,NULL);

    $db->real_connect('localhost','root','','mydb');

    //Here some query

    $db->close();

    ?>
    up
    -1
    king at bobfish dot org
    16 years ago
    Example on using mysqli_options to increase size of max_allowed_packet for working with big blobs.

    function dbConnect()
    {
       $user = 'jomama';
       $pass = 'cartoon';
       $dbName = 'LifeCycle';
       $host = 'localhost';

       $mysqli = mysqli_init();
       mysqli_options($mysqli,MYSQLI_READ_DEFAULT_GROUP,
                                        "max_allowed_packet=50M");
       mysqli_real_connect($mysqli,$host, $user, $pass,$dbName)
                      or die ('<P>Unable to connect</P>');

       return $mysqli;
    }
    add a note add a note
    To Top