Bug #37122 documentation for internal structure "resultset"
Submitted: 31 May 2008 20:56 Modified: 30 Jul 2008 10:02
Reporter: Roland Bouman Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Proxy: Documentation Severity:S3 (Non-critical)
Version: OS:Any
Assigned to: MC Brown CPU Architecture:Any
Triage: D4 (Minor)

[31 May 2008 20:56] Roland Bouman
Description:
The documentation at 

http://dev.mysql.com/doc/refman/5.1/en/mysql-proxy-scripting-read-query-result.html
and
http://dev.mysql.com/doc/refman/5.1/en/mysql-proxy-scripting-structures.html

does not seem to contain the documentation for the resultset object. The existence of the resultset is documented in http://dev.mysql.com/doc/refman/5.1/en/mysql-proxy-scripting-read-query-result.html but the object itself is not.

The tutorial-packets.lua script indicates that we have:

fields        - the columns ("fields") in the resultset
rows          - the rows in the resultset
raw           - all bits and bytes that make up the result (?)
flags         - 
warning_count - number of warnings
affected_rows - number of rows updated and/or inserted (?)
insert_id     - last insert id  for auto_increment column (?)
query_status  - (if it's < 0, and error occurred, that's all I know...)

(by the looks of tutorial-packets.lua, you need to extract quite some stuff from raw....) 

How to repeat:
http://dev.mysql.com/doc/refman/5.1/en/mysql-proxy-scripting-read-query-result.html
and
http://dev.mysql.com/doc/refman/5.1/en/mysql-proxy-scripting-structures.html
and 
the tutorial-packets.lua script in the proxy/share dir.

Suggested fix:
please document resultsets
[1 Jun 2008 5:53] Sveta Smirnova
Thank you for the report.

Verified as described.
[30 Jul 2008 10:02] MC Brown
Resultsets (and responses) have now been added to the manual.