Documentation Home
Connectors and APIs Manual
Download this Manual

7.9.2.27 MySQLConnection.ping() Method

Syntax:

cnx.ping(reconnect=False, attempts=1, delay=0)

Check whether the connection to the MySQL server is still available.

When reconnect is set to True, one or more attempts are made to try to reconnect to the MySQL server, and these options are forwarded to the reconnect()>method. Use the delay argument (seconds) if you want to wait between each retry.

When the connection is not available, an InterfaceError is raised. Use the is_connected() method to check the connection without raising an error.

Raises InterfaceError on errors.