mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Reworked docs using the new doc style. Added an alternate SHOW STATUS example,
returnvalues, used &example.outputs.similar;, and closed bug #22005. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@178317 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
parent
2cb3ea809a
commit
035fb21bde
1 changed files with 95 additions and 43 deletions
|
|
@ -1,44 +1,61 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<!-- $Revision: 1.9 $ -->
|
||||
<!-- splitted from ./en/functions/mysql.xml, last change in rev 1.62 -->
|
||||
<refentry id="function.mysql-stat">
|
||||
<refnamediv>
|
||||
<refname>mysql_stat</refname>
|
||||
<refpurpose>Get current system status</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>mysql_stat</methodname>
|
||||
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mysql_stat</function> returns the current server status.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
<function>mysql_stat</function> currently only returns 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 SHOW STATUS
|
||||
SQL command.
|
||||
</para>
|
||||
</note>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>mysql_stat</function> example</title>
|
||||
<programlisting role="php">
|
||||
<refentry id="function.mysql-stat">
|
||||
<refnamediv>
|
||||
<refname>mysql_stat</refname>
|
||||
<refpurpose>Get current system status</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>mysql_stat</methodname>
|
||||
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>mysql_stat</function> returns the current server status.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>link_identifier</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Link to the MySQL connection.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<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 <literal>SHOW STATUS</literal> SQL command.
|
||||
If <parameter>link_identifier</parameter> is invalid, &null; is returned.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>mysql_stat</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$link = mysql_connect('localhost', "mysql_user", "mysql_password");
|
||||
$link = mysql_connect('localhost', 'mysql_user', 'mysql_password');
|
||||
$status = explode(' ', mysql_stat($link));
|
||||
print_r($status);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
<para>
|
||||
The above example would produce the following output:
|
||||
</para>
|
||||
<screen>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Array
|
||||
(
|
||||
|
|
@ -52,16 +69,51 @@ Array
|
|||
[7] => Queries per second avg: 245.595
|
||||
)
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
See also
|
||||
<function>mysql_get_server_info</function> and
|
||||
<function>mysql_list_processes</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>Alternative <function>mysql_stat</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$link = mysql_connect('localhost', 'mysql_user', 'mysql_password');
|
||||
$result = mysql_query('SHOW VARIABLES', $link);
|
||||
while ($row = mysql_fetch_assoc($result)) {
|
||||
echo $row['Variable_name'] . ' = ' . $row['Value'] . "\n";
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
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/
|
||||
...
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>mysql_get_server_info</function></member>
|
||||
<member><function>mysql_list_processes</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
|
|||
Loading…
Reference in a new issue