Documentation Home
MySQL 9.0 C API Developer Guide
Download this Manual
PDF (US Ltr) - 1.4Mb
PDF (A4) - 1.4Mb


5.4.63 mysql_refresh()

int
mysql_refresh(MYSQL *mysql,
              unsigned int options)

Description

Note

mysql_refresh() is deprecated and is subject to removal in a future version of MySQL. Instead, use mysql_real_query() or mysql_query() to execute a FLUSH statement.

This function flushes tables or caches, or resets replication server information. The connected user must have the RELOAD privilege.

The options argument is a bitmask composed from any combination of the following values. Multiple values can be OR'ed together to perform multiple operations with a single call.

  • REFRESH_GRANT

    Refresh the grant tables, like FLUSH PRIVILEGES.

  • REFRESH_LOG

    Flush the logs, like FLUSH LOGS.

  • REFRESH_TABLES

    Flush the table cache, like FLUSH TABLES.

  • REFRESH_STATUS

    Reset status variables, like FLUSH STATUS.

  • REFRESH_SLAVE

    On a replica server, reset the source server information and restart the replica, like RESET REPLICA.

  • REFRESH_MASTER

    On a source server, remove the binary log files listed in the binary log index and truncate the index file, like RESET BINARY LOGS AND GTIDS.

Return Values

Zero for success. Nonzero if an error occurred.

Errors