svn: /phpdoc/en/trunk/reference/mysqlnd/ stats.xml

abedford Wed, 17 Nov 2010 12:13:06 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=305454 Log: Added two new stats. Changed paths: U phpdoc/en/trunk/reference/mysqlnd/stats.xml Modified: phpdoc/en/trunk/reference/mysqlnd/stats.xml =================================================================== --- phpdoc/en/trunk/reference/mysqlnd/stats.xml 2010-11-17 11:56:48 UTC (rev 305453) +++ phpdoc/en/trunk/reference/mysqlnd/stats.xml 2010-11-17 12:13:06 UTC (rev 305454) @@ -359,6 +359,55 @@ command_buffer_too_small (see below).</entry> <entry>Only useful for debugging CS protocol implementation.</entry> </row> + <row> + <entry><literal>bytes_received_real_data_normal</literal></entry> + <entry>Connection</entry> + <entry>Number of bytes of payload fetched by the PHP client from + <literal>mysqlnd</literal> using the text protocol.</entry> + <entry>This is the size of the actual data contained in result sets that do not + originate from prepared statements and which have been fetched by + the PHP client. Note that although a full result set may have been + pulled from MySQL by <literal>mysqlnd</literal>, this statistic + only counts actual data pulled from <literal>mysqlnd</literal> by + the PHP client. An example of a code sequence that will increase + the value is as follows: +<programlisting> +$mysqli = new mysqli(); +$res = $mysqli->query("SELECT 'abc'"); +$res->fetch_assoc(); +$res->close();</programlisting> + <para> + Every fetch operation will increase the value. + </para> + + <para> + The statistic will not be increased if the result set is only + buffered on the client, but not fetched, such as in the following + example: + </para> +<programlisting> +$mysqli = new mysqli(); +$res = $mysqli->query("SELECT 'abc'"); +$res->close();</programlisting> + <para> + This statistic is available as of PHP version 5.3.4. + </para></entry> + </row> + <row> + <entry><literal>bytes_received_real_data_ps</literal></entry> + <entry>Connection</entry> + <entry>Number of bytes of the payload fetched by the PHP client from + <literal>mysqlnd</literal> using the prepared statement protocol.</entry> + <entry>This is the size of the actual data contained in result sets that + originate from prepared statements and which has been fetched by + the PHP client. The value will not be increased if the result set + is not subsequently read by the PHP client. Note that although a + full result set may have been pulled from MySQL by + <literal>mysqlnd</literal>, this statistic only counts actual data + pulled from <literal>mysqlnd</literal> by the PHP client. See also + <literal>bytes_received_real_data_normal</literal>. This statistic + is available as of PHP version 5.3.4.</entry> + </row> </tbody> </tgroup> </informaltable> @@ -516,9 +565,9 @@ <row> <entry><literal>flushed_ps_sets</literal></entry> <entry>Connection</entry> - <entry>Number of result sets from prepared statements with - unread data which have been flushed silently for you. Flushing - happens only with unbuffered result sets.</entry> + <entry>Number of result sets from prepared statements with unread data which + have been flushed silently for you. Flushing happens only with + unbuffered result sets.</entry> <entry>Unbuffered result sets must be fetched completely before a new query can be run on the connection otherwise MySQL will throw an error. If the application does not fetch all rows from an unbuffered result @@ -831,8 +880,8 @@ <entry>Connection</entry> <entry>Total number of columns of a certain type fetched from a prepared statement (MySQL binary protocol).</entry> - <entry>For type mapping see <literal>proto_text_*</literal> described - in the preceding text.</entry> + <entry>For type mapping see <literal>proto_text_*</literal> described in the + preceding text.</entry> </row> </tbody> </tgroup>