SurrealDB Docs Logo

Enter a search query

->health()

This method checks wether the database is running and the storage engine is running.

Note

This method is only available on a remote database targeted with the http protocol.

Method Syntax
$db->health();

Example usage

$health = $db->health();
echo "The health status is: $health."; // 200 or 500

The health function returns 200 if the database is running and is in good shape. 500 if a failure occurred.