3.6.6 Automatic Reconnection Control

The MySQL client library can perform an automatic reconnection to the server if it finds that the connection is down when you attempt to send a statement to the server to be executed. If auto-reconnect is enabled, the library tries once to reconnect to the server and send the statement again.

Auto-reconnect is disabled by default.

If it is important for your application to know that the connection has been dropped (so that it can exit or take action to adjust for the loss of state information), be sure that auto-reconnect is disabled. To ensure this, callmysql_options()with theMYSQL_OPT_RECONNECToption:

my_bool reconnect = 0; mysql_options(&mysql, MYSQL_OPT_RECONNECT, &reconnect);

If the connection has gone down, the effect ofmysql_ping()depends on the auto-reconnect state. If auto-reconnect is enabled,mysql_ping()performs a reconnect. Otherwise, it returns an error.

Some client programs might provide the capability of controlling automatic reconnection. For example,mysqlreconnects by default, but the--skip-reconnectoption can be used to suppress this behavior.

If an automatic reconnection does occur (for example, as a result of callingmysql_ping()), there is no explicit indication of it. To check for reconnection, callmysql_thread_id()to get the original connection identifier before callingmysql_ping(), then callmysql_thread_id()again to see whether the identifier changed.

Automatic reconnection can be convenient because you need not implement your own reconnect code, but if a reconnection does occur, several aspects of the connection state are reset on the server side and your application will not be notified.

Reconnection affects the connection-related state as follows:

  • Rolls back any active transactions and resets autocommit mode.

  • Releases all table locks.

  • Closes (and drops) allTEMPORARYtables.

  • Reinitializes session system variables to the values of the corresponding global system variables, including system variables that are set implicitly by statements such asSET NAMES.

  • Loses user-defined variable settings.

  • Releases prepared statements.

  • ClosesHANDLERvariables.

  • Resets the value ofLAST_INSERT_ID()to 0.

  • Releases locks acquired withGET_LOCK().

  • Loses the association of the client with the Performance Schemathreadstable row that determines connection thread instrumentation. If the client reconnects after a disconnect, the session is associated with a new row in thethreadstable and the thread monitoring state may be different. SeeThe threads Table.

If reconnection occurs, any SQL statement specified by callingmysql_options()with theMYSQL_INIT_COMMANDoption is re-executed.

If the connection drops, it is possible that the session associated with the connection on the server side will still be running if the server has not yet detected that the client is no longer connected. In this case, any locks held by the original connection still belong to that session, so you may want to kill it by callingmysql_kill().