Source of: /manual/en/function.mysql-stat.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mysql.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mysql-stat.php',
1 => 'mysql_stat',
),
'up' =>
array (
0 => 'ref.mysql.php',
1 => 'MySQL Functions',
),
'prev' =>
array (
0 => 'function.mysql-set-charset.php',
1 => 'mysql_set_charset',
),
'next' =>
array (
0 => 'function.mysql-tablename.php',
1 => 'mysql_tablename',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mysql-stat" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysql_stat</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">mysql_stat</span> — <span class="dc-title">Get current system status</span></p>
</div>
<a name="function.mysql-stat.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>mysql_stat</b></span>
([ <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$link_identifier</tt></span>
] )</div>
<p class="para rdfs-comment">
<b>mysql_stat()</b> returns the current server status.
</p>
</div>
<a name="function.mysql-stat.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">
link_identifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The MySQL connection. If the
link identifier is not specified, the last link opened by
<a href="function.mysql-connect.php" class="function">mysql_connect()</a> is assumed. If no such link is found, it
will try to create one as if <a href="function.mysql-connect.php" class="function">mysql_connect()</a> was called
with no arguments. If no connection is found or established, an
<b><tt class="constant">E_WARNING</tt></b> level error is generated.</p></dd>
</dl>
<p>
</p>
</div>
<a name="function.mysql-stat.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string with the status for uptime, threads, queries, open tables,
flush tables and queries per second. For a complete list of other status
variables, you have to use the <i>SHOW STATUS</i> SQL command.
If <i><tt class="parameter">link_identifier</tt></i>
is invalid, <b><tt class="constant">NULL</tt></b> is returned.
</p>
</div>
<a name="function.mysql-stat.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mysql_stat()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_user'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_password'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$status </span><span style="color: #007700">= </span><span style="color: #0000BB">explode</span><span style="color: #007700">(</span><span style="color: #DD0000">' '</span><span style="color: #007700">, </span><span style="color: #0000BB">mysql_stat</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$status</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[0] => Uptime: 5380
[1] => Threads: 2
[2] => Questions: 1321299
[3] => Slow queries: 0
[4] => Opens: 26
[5] => Flush tables: 1
[6] => Open tables: 17
[7] => Queries per second avg: 245.595
)
</pre></div>
</div>
</div><p>
</p>
<p class="para">
</p><div class="example">
<p><b>Example #2 Alternative <b>mysql_stat()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_user'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_password'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_query</span><span style="color: #007700">(</span><span style="color: #DD0000">'SHOW VARIABLES'</span><span style="color: #007700">, </span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_fetch_assoc</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'Variable_name'</span><span style="color: #007700">] . </span><span style="color: #DD0000">' = ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'Value'</span><span style="color: #007700">] . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
back_log = 50
basedir = /usr/local/
bdb_cache_size = 8388600
bdb_log_buffer_size = 32768
bdb_home = /var/db/mysql/
bdb_max_lock = 10000
bdb_logdir =
bdb_shared_data = OFF
bdb_tmpdir = /var/tmp/
...
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.mysql-stat.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mysql-get-server-info.php" class="function" rel="rdfs-seeAlso">mysql_get_server_info()</a> - Get MySQL server info</li>
<li class="member"><a href="function.mysql-list-processes.php" class="function" rel="rdfs-seeAlso">mysql_list_processes()</a> - List MySQL processes</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
