mysqli::ping

mysqli_ping

(PHP 5, PHP 7, PHP 8)

mysqli::ping -- mysqli_pingPings a server connection, or tries to reconnect if the connection has gone down

Description

Object-oriented style

public mysqli::ping(): bool

Procedural style

mysqli_ping(mysqli $mysql): bool

Checks whether the connection to the server is working. If it has gone down and global option mysqli.reconnect is enabled, an automatic reconnection is attempted.

Note: The php.ini setting mysqli.reconnect is ignored by the mysqlnd driver, so automatic reconnection is never attempted.

This function can be used by clients that remain idle for a long while, to check whether the server has closed the connection and reconnect if necessary.

Parameters

mysql

Procedural style only: A mysqli object returned by mysqli_connect() or mysqli_init()

Return Values

Returns true on success or false on failure.

Examples

Example #1 mysqli::ping() example

Object-oriented style

<?php
$mysqli 
= new mysqli("localhost""my_user""my_password""world");

/* check connection */
if ($mysqli->connect_errno) {
    
printf("Connect failed: %s\n"$mysqli->connect_error);
    exit();
}

/* check if server is alive */
if ($mysqli->ping()) {
    
printf ("Our connection is ok!\n");
} else {
    
printf ("Error: %s\n"$mysqli->error);
}

/* close connection */
$mysqli->close();
?>

Procedural style

<?php
$link 
mysqli_connect("localhost""my_user""my_password""world");

/* check connection */
if (mysqli_connect_errno()) {
    
printf("Connect failed: %s\n"mysqli_connect_error());
    exit();
}

/* check if server is alive */
if (mysqli_ping($link)) {
    
printf ("Our connection is ok!\n");
} else {
    
printf ("Error: %s\n"mysqli_error($link));
}

/* close connection */
mysqli_close($link);
?>

The above examples will output:

Our connection is ok!