philip Wed Jan 26 14:14:34 2005 EDT
Modified files:
/phpdoc/en/reference/mysql/functions mysql-stat.xml
Log:
Reworked docs using the new doc style. Added an alternate SHOW STATUS
example,
returnvalues, used &example.outputs.similar;, and closed bug #22005.
http://cvs.php.net/diff.php/phpdoc/en/reference/mysql/functions/mysql-stat.xml?r1=1.8&r2=1.9&ty=u
Index: phpdoc/en/reference/mysql/functions/mysql-stat.xml
diff -u phpdoc/en/reference/mysql/functions/mysql-stat.xml:1.8
phpdoc/en/reference/mysql/functions/mysql-stat.xml:1.9
--- phpdoc/en/reference/mysql/functions/mysql-stat.xml:1.8 Wed Jul 21
00:27:29 2004
+++ phpdoc/en/reference/mysql/functions/mysql-stat.xml Wed Jan 26 14:14:34 2005
@@ -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 @@
[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:
