PHP mysqli options() Function

PHP MySQLi Reference : Set extra connect options

Definition and Usage

The options() / mysqli_options() function is used to set extra connect options and affect behavior for a connection.

Note: This function should be called after init() and before real_connect().

Syntax

Object oriented style:

$mysqli -> options(option, value)

Procedural style:

mysqli_options(connection, option, value)

Parameter Values

Parameter Description
connection Required. Specifies the MySQL connection to use
option Required. Specifies the option to set. Can be one of the following values:
  • MYSQLI_OPT_CONNECT_TIMEOUT - Set connection timeout in seconds
  • MYSQLI_OPT_LOCAL_INFILE - Enable/Disable use of LOAD LOCAL INFILE
  • MYSQLI_INIT_COMMAND - Set a command to execute after connecting to MySQL server
  • MYSQLI_READ_DEFAULT_FILE - Set read options from named file instead of my.cnf
  • MYSQLI_READ_DEFAULT_GROUP - Set read options from named group from my.cnf or the file specified in MYSQLI_READ_DEFAULT_FILE
  • MYSQLI_SERVER_PUBLIC_KEY - Set RSA public key file used with SHA-256 based authentication
  • MYSQLI_OPT_NET_CMD_BUFFER_SIZE - only for mysqlnd
  • MYSQLI_OPT_NET_READ_BUFFER_SIZE - only for mysqlnd
  • MYSQLI_OPT_INT_AND_FLOAT_NATIVE - only for mysqlnd
  • MYSQLI_OPT_SSL_VERIFY_SERVER_CERT - only for mysqlnd
value Required. Specifies the value for the option

Technical Details

Return Value: TRUE on success. FALSE on failure
PHP Version: 5+
PHP Changelog: PHP 5.5: Added MYSQLI_SERVER_PUBLIC_KEY option
PHP 5.3: Added MYSQLI_OPT_INT_AND_FLOAT_NATIVE, MYSQLI_OPT_NET_CMD_BUFFER_SIZE, MYSQLI_OPT_NET_READ_BUFFER_SIZE, and MYSQLI_OPT_SSL_VERIFY_SERVER_CERT options

Example - Procedural style

Set extra connect options:

<?php
$con = mysqli_init();
if (!$con) {
  die("mysqli_init failed");
}

// Specify connection timeout
mysqli_options($con, MYSQLI_OPT_CONNECT_TIMEOUT, 10);

// Specify read options from named file instead of my.cnf
mysqli_options($con, MYSQLI_READ_DEFAULT_FILE, "myfile.cnf");

mysqli_real_connect($con,"localhost","my_user","my_password","my_db");
?> 

❮ PHP MySQLi Reference