PHP mysqli: real_connect() function

Last update on August 19 2022 21:51:16 (UTC/GMT +8 hours)

mysqli_real_connect() function / mysqli::real_connect

The mysqli_real_connect() function / mysqli::real_connect opens a new connection to the MySQL server.

The mysqli_real_connect() function differs from mysqli_connect() in the following ways:

mysqli_real_connect() requires a valid object which has to be created by mysqli_init().
It can be used with mysqli_options() to set different options for the connection.
It has a flag parameter.

Syntax:

Object oriented style

bool mysqli::real_connect ([ string $host [, string $username [, string $passwd [, string $dbname [, int $port [, string $socket [, int $flags ]]]]]]] )

Procedural style

bool mysqli_real_connect ( mysqli $link [, string $host [, string $username [, string $passwd [, string $dbname [, int $port [, string $socket [, int $flags ]]]]]]] )

Parameter:

Supported flags

Name	Description		Required/Optional
link	A link identifier returned by mysqli_connect() or mysqli_init()		Required for procedural style only and Optional for Object oriented style
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.		Required
username	The MySQL user name.		Required
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).		Required
dbname	If provided will specify the default database to be used when performing queries.		Required
port	Specifies the port number to attempt to connect to the MySQL server.		Optional
socket	Specifies the socket or named pipe that should be used.		Optional
flags	With the parameter flags you can set different connection options:		Optional
		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 closing the connection
		MYSQLI_CLIENT_SSL	Use SSL (encryption)
		MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT	Like MYSQLI_CLIENT_SSL, but disables validation of the provided SSL certificate. This is only for installations using MySQL Native Driver and MySQL 5.6 or later.

Usage: Procedural style

mysqli_real_connect(connection,host,username,password,dbname,port,socket,flag);

Parameter:

Name	Description	Required / Optional
connection	Specifies the MySQL connection to use	Required
host	Specifies a host name or an IP address	Required
username	Specifies the MySQL username	Required
password	Specifies the MySQL password	Required
dbname	Specifies the default database to be used	Required
port	Specifies the port number to attempt to connect to the MySQL server	Optional
socket	Specifies the socket or named pipe to be used	Optional
flag	Specifies different connection options. Possible values: MYSQLI_CLIENT_COMPRESS - Use compression protocol MYSQLI_CLIENT_FOUND_ROWS - Return number of matched rows (not affected rows) MYSQLI_CLIENT_IGNORE_SPACE - Allow spaces after function names. Make function names reserved words MYSQLI_CLIENT_INTERACTIVE - Allow interactive_timeout seconds of inactivity before closing connection MYSQLI_CLIENT_SSL - Use SSL encryption	Optional

Return value:

Returns TRUE on success or FALSE on failure.

Version: PHP 5, PHP 7

Example of 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', 'user1', 'datasoft123', 'hr')) {
    die('Connect Error (' . mysqli_connect_errno() . ') '
            . mysqli_connect_error());
}

echo 'Success... ' . $mysqli->host_info . "\n";

$mysqli->close();
?>

Output:

Success... MySQL host info: localhost via TCP/IP

Example of 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', 'user1', 'datasoft123', 'hr')) {
    die('Connect Error (' . mysqli_connect_errno() . ') '
            . mysqli_connect_error());
}

echo 'Success... ' . mysqli_get_host_info($link) . "\n";

mysqli_close($link);
?>

Output:

Success... MySQL host info: localhost via TCP/IP

See also

PHP Function Reference

Previous: query
Next: real_escape_string

Weekly Trends and Language Statistics
Weekly Trends and Language Statistics