1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="mysql_refresh" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:db="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysql_refresh</refname>
<refpurpose>This function flushes tables or caches, or resets replication server information.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>result = mysql_refresh(mysql, option)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>This function flushes tables or caches, or resets
replication server information. The connected user
must have the RELOAD privilege.</para>
<para>The options argument is a bit mask composed from
any combination of the following values. Multiple values
can be OR'ed together to perform multiple operations with
a single call.</para>
<itemizedlist>
<listitem><para>REFRESH_GRANT Refresh the grant tables, like FLUSH PRIVILEGES.</para></listitem>
<listitem><para>REFRESH_LOG Flush the logs, like FLUSH LOGS.</para></listitem>
<listitem><para>REFRESH_TABLES Flush the table cache, like FLUSH TABLES.</para></listitem>
<listitem><para>REFRESH_HOSTS Flush the host cache, like FLUSH HOSTS.</para></listitem>
<listitem><para>REFRESH_STATUS Reset status variables, like FLUSH STATUS.</para></listitem>
<listitem><para>REFRESH_THREADS Flush the thread cache.</para></listitem>
<listitem><para>REFRESH_SLAVE On a slave replication server,
reset the master server information and restart the slave, like RESET SLAVE.</para></listitem>
<listitem><para>REFRESH_MASTER On a master replication server,
remove the binary log files listed in the binary log index
and truncate the index file, like RESET MASTER.</para></listitem>
</itemizedlist>
</refsection>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>mysql</term>
<listitem>
<para>a MySQL pointer</para>
</listitem>
</varlistentry>
<varlistentry>
<term>option</term>
<listitem>
<para>the refresh option (see above).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>result</term>
<listitem>
<para>Zero for success. Nonzero if an error occurred.</para>
<para>Error list:</para>
<itemizedlist>
<listitem><para>CR_COMMANDS_OUT_OF_SYNC Commands were executed in an improper order.</para></listitem>
<listitem><para>CR_SERVER_GONE_ERROR The MySQL server has gone away.</para></listitem>
<listitem><para>CR_SERVER_LOST The connection to the server was lost during the query.</para></listitem>
<listitem><para>CR_UNKNOWN_ERROR An unknown error occurred.</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
username = 'glpk'; // Put your username
password = 'gnu'; // Put your password
database = 'glpk';
port = 3306; // use netstat -a | grep mysql to locate the mysql port
// or ps -elf | grep mysql and locate --port
myhost = 'localhost'; // localhost most of the time
sql_ptr = mysql_init();
status = mysql_real_connect(sql_ptr, myhost, username, password, database, port);
result = mysql_refresh(sql_ptr, 1); // REFRESH_GRANT = 1
mysql_close(sql_ptr);
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member><link linkend="mysql_real_connect">mysql_real_connect</link></member>
<member><link linkend="mysql_close">mysql_close</link></member>
<member><link linkend="mysql_fetch_row">mysql_fetch_row</link></member>
<member><link linkend="mysql_store_result">mysql_store_result</link></member>
<member><link linkend="mysql_real_query">mysql_real_query</link></member>
</simplelist>
</refsection>
<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Yann COLLETTE</member>
</simplelist>
</refsection>
</refentry>
|
