MySQL-python: Commands out of sync

在给 MySQL 数据库访问层增加新功能时遇到了这样的错误：

ProgrammingError: (2014, "Commands out of sync; you can't run this command now")

之前零星地见到过几次，因为发生频度很低，就没有太在意，这次找了一下原因，MySQL 文档对 Commands out of sync 错误的描述是这样的：

If you get Commands out of sync; you can’t run this command now in your client code, you are calling client functions in the wrong order.

This can happen, for example, if you are using mysql_use_result() and try to execute a new query before you have called mysql_free_result(). It can also happen if you try to execute two queries that return data without calling mysql_use_result() or mysql_store_result() in between.

Commands out of sync http://dev.mysql.com/doc/refman/5.1/en/commands-out-of-sync.html

MySQL 和客户端通信使用的是“半双工”的应答协议，客户端每发送一个查询，服务器“强行推送”结果给客户端，客户端需要执行 mysql_use_result() 或 mysql_store_result() 从服务器端取回结果，这是一次完整的查询交互，只提交查询而不取回结果就会导致 Commands out of sync。

由于使用的是 MySQL-python，所以第一种情况所说的没有调用 mysql_free_result() 的问题不大可能存在，并且 MySQLdb 的默认 cursor 使用的是 mysql_store_result() 而不是 mysql_use_result()，所以应该是第二种情况。

抓取了一些有可能会导致这个问题的查询，发现了类似这样的语句：

SELECT a, b FROM t LIMIT 1; -- some comments

执行了这样的查询之后，再执行任何查询都会遇到 Commands out of sync 问题。

因为这其实是由分号隔开的两个独立的查询语句，使用 MySQLdb 执行时，作为一个语句发送给 MySQL server，之后 MySQLdb 执行了一次 mysql_store_result()。

之前需要自动地给每一个查询增加注释，而个别的查询在末尾写了分号，追加注释之后就触发了这个问题，那么只需要在加注释前 strip 掉分号就好了。

MySQLdb 有四种 cursor：

class Cursor(CursorStoreResultMixIn, CursorTupleRowsMixIn,                      
             BaseCursor):                                                       
                                                                                
    """This is the standard Cursor class that returns rows as tuples            
    and stores the result set in the client."""                                 
                                                                                
                                                                                
class DictCursor(CursorStoreResultMixIn, CursorDictRowsMixIn,                   
                 BaseCursor):                                                   
                                                                                
     """This is a Cursor class that returns rows as dictionaries and            
    stores the result set in the client."""                                     
                                                                                
                                                                                
class SSCursor(CursorUseResultMixIn, CursorTupleRowsMixIn,                      
               BaseCursor):                                                     
                                                                                
    """This is a Cursor class that returns rows as tuples and stores            
    the result set in the server."""                                            
                                                                                
                                                                                
class SSDictCursor(CursorUseResultMixIn, CursorDictRowsMixIn,                   
                   BaseCursor):                                                 
                                                                                
    """This is a Cursor class that returns rows as dictionaries and             
    stores the result set in the server."""

默认使用的是 Cursor，在提交查询之后执行 mysql_store_result()，将 MySQL Server 返回的所有数据都取回并缓存在本地，SSCursor 则是使用 mysql_use_result()，将结果“缓存”在服务器端，客户端逐行取回结果，好处是速度会比 mysql_store_result() 快，并且客户端可以节省内存，但在高并发环境下，还是使用默认的 Cursor 比较好，因为 MySQL server 只有在客户端取回所有的结果之后才会释放相关的锁（如果有的话），而逐行取回并分别对每行做处理大多会需要更长的时间。

Reference: