1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2024-11-08 08:47:17 +01:00
SqMod/vendor/MDBC/man/mysql_refresh.3

93 lines
1.5 KiB
Groff
Raw Normal View History

.\"t
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_refresh" "3" "" "Version 3.2.2" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_refresh \- flushes information on the server
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>
int mysql_refresh(MYSQL * mysql, unsigned int options);
\f[R]
.fi
.SS Description
.PP
Flushes different types of information stored on the server.
The bit\-masked parameter options specify which kind of information will
be flushed.
.SS Parameters
.IP \[bu] 2
\f[C]mysql\f[R] \- a mysql handle, which was previously allocated by
\f[B]mysql_init(3)\f[R] and connected by
\f[B]mysql_real_connect(3)\f[R].
.IP \[bu] 2
\f[C]options\f[R] \- a bit masked composed integer.
See below.
.PP
\f[C]options\f[R] can be any combinationation of the following flags:
.PP
.TS
tab(@);
l l.
T{
Option
T}@T{
Description
T}
_
T{
\f[C]REFRESH_GRANT\f[R]
T}@T{
Refresh grant tables.
T}
T{
\f[C]REFRESH_LOG\f[R]
T}@T{
Flush logs.
T}
T{
\f[C]REFRESH_TABLES\f[R]
T}@T{
Flush table cache.
T}
T{
\f[C]REFRESH_HOSTS\f[R]
T}@T{
Flush host cache.
T}
T{
\f[C]REFRESH_STATUS\f[R]
T}@T{
Reset status variables.
T}
T{
\f[C]REFRESH_THREADS\f[R]
T}@T{
Flush thread cache.
T}
T{
\f[C]REFRESH_SLAVE\f[R]
T}@T{
Reset master server information and restart slaves.
T}
T{
\f[C]REFRESH_MASTER\f[R]
T}@T{
Remove binary log files.
T}
.TE
.SS Notes
.IP \[bu] 2
To combine different values in the options parameter use the OR operator
`|'.
.IP \[bu] 2
\f[C]mysql_reload()\f[R] is an alias for mysql_refresh().
.SS Return value
.PP
Returns zero on success, otherwise non zero.