MYSQLI.REAL_CONNECT(3) 1 MYSQLI.REAL_CONNECT(3)
mysqli::real_connect - Opens a connection to a mysql server
Object oriented style
SYNOPSIS
bool mysqli::real_connect ([string $host], [string $username], [string $passwd], [string $dbname], [int $port], [string $socket],
[int $flags])
DESCRIPTION
Procedural style
bool mysqli_real_connect (mysqli $link, [string $host], [string $username], [string $passwd], [string $dbname], [int $port], [string
$socket], [int $flags])
Establish a connection to a MySQL database engine.
This function differs from mysqli_connect(3):
omysqli_real_connect(3) needs a valid object which has to be created by function mysqli_init(3).
o With the mysqli_options(3) function you can set various options for connection.
o There is a $flags parameter.
PARAMETERS
o $
link -Procedural style only: A link identifier returned by mysqli_connect(3) or mysqli_init(3)
o $host
- Can be either a host name or an IP address. Passing the NULL value or the string "localhost" to this parameter, the local host
is assumed. When possible, pipes will be used instead of the TCP/IP protocol.
o $username
- The MySQL user name.
o $passwd
- If provided or NULL, the MySQL server will attempt to authenticate the user against those user records which have no password
only. This allows one username to be used with different permissions (depending on if a password as provided or not).
o $dbname
- If provided will specify the default database to be used when performing queries.
o $port
- Specifies the port number to attempt to connect to the MySQL server.
o $socket
- Specifies the socket or named pipe that should be used.
Note
Specifying the $socket parameter will not explicitly determine the type of connection to be used when connecting to the
MySQL server. How the connection is made to the MySQL database is determined by the $host parameter.
o $flags
- With the parameter $flags you can set different connection options:
Supported flags
+---------------------------+---------------------------------------------------+
| Name | |
| | |
| | Description |
| | |
+---------------------------+---------------------------------------------------+
| | |
| MYSQLI_CLIENT_COMPRESS | |
| | |
| | Use compression protocol |
| | |
| | |
| MYSQLI_CLIENT_FOUND_ROWS | |
| | |
| | return number of matched rows, not the number of |
| | affected rows |
| | |
| | |
|MYSQLI_CLIENT_IGNORE_SPACE | |
| | |
| | Allow spaces after function names. Makes all |
| | function names reserved words. |
| | |
| | |
|MYSQLI_CLIENT_INTERACTIVE | |
| | |
| | Allow interactive_timeout seconds (instead of |
| | wait_timeout seconds) of inactivity before clos- |
| | ing the connection |
| | |
| | |
| MYSQLI_CLIENT_SSL | |
| | |
| | Use SSL (encryption) |
| | |
+---------------------------+---------------------------------------------------+
Note
For security reasons the MULTI_STATEMENT flag is not supported in PHP. If you want to execute multiple queries use the
mysqli_multi_query(3) function.
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
mysqli::real_connect example
Object oriented style
<?php
$mysqli = mysqli_init();
if (!$mysqli) {
die('mysqli_init failed');
}
if (!$mysqli->options(MYSQLI_INIT_COMMAND, 'SET AUTOCOMMIT = 0')) {
die('Setting MYSQLI_INIT_COMMAND failed');
}
if (!$mysqli->options(MYSQLI_OPT_CONNECT_TIMEOUT, 5)) {
die('Setting MYSQLI_OPT_CONNECT_TIMEOUT failed');
}
if (!$mysqli->real_connect('localhost', 'my_user', 'my_password', 'my_db')) {
die('Connect Error (' . mysqli_connect_errno() . ') '
. mysqli_connect_error());
}
echo 'Success... ' . $mysqli->host_info . "
";
$mysqli->close();
?>
Object oriented style when extending mysqli class
<?php
class foo_mysqli extends mysqli {
public function __construct($host, $user, $pass, $db) {
parent::init();
if (!parent::options(MYSQLI_INIT_COMMAND, 'SET AUTOCOMMIT = 0')) {
die('Setting MYSQLI_INIT_COMMAND failed');
}
if (!parent::options(MYSQLI_OPT_CONNECT_TIMEOUT, 5)) {
die('Setting MYSQLI_OPT_CONNECT_TIMEOUT failed');
}
if (!parent::real_connect($host, $user, $pass, $db)) {
die('Connect Error (' . mysqli_connect_errno() . ') '
. mysqli_connect_error());
}
}
}
$db = new foo_mysqli('localhost', 'my_user', 'my_password', 'my_db');
echo 'Success... ' . $db->host_info . "
";
$db->close();
?>
Procedural style
<?php
$link = mysqli_init();
if (!$link) {
die('mysqli_init failed');
}
if (!mysqli_options($link, MYSQLI_INIT_COMMAND, 'SET AUTOCOMMIT = 0')) {
die('Setting MYSQLI_INIT_COMMAND failed');
}
if (!mysqli_options($link, MYSQLI_OPT_CONNECT_TIMEOUT, 5)) {
die('Setting MYSQLI_OPT_CONNECT_TIMEOUT failed');
}
if (!mysqli_real_connect($link, 'localhost', 'my_user', 'my_password', 'my_db')) {
die('Connect Error (' . mysqli_connect_errno() . ') '
. mysqli_connect_error());
}
echo 'Success... ' . mysqli_get_host_info($link) . "
";
mysqli_close($link);
?>
The above examples will output:
Success... MySQL host info: localhost via TCP/IP
NOTES
Note
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(3) prior to calling
mysqli_real_connect(3), but after mysqli_init(3).
SEE ALSO
mysqli_connect(3), mysqli_init(3), mysqli_options(3), mysqli_ssl_set(3), mysqli_close(3).
PHP Documentation Group MYSQLI.REAL_CONNECT(3)