]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
wording about supported dialects for Query.yield_per
authorDomen Kožar <domen@dev.si>
Sun, 14 Jul 2013 16:18:16 +0000 (18:18 +0200)
committerDomen Kožar <domen@dev.si>
Sun, 14 Jul 2013 16:18:16 +0000 (18:18 +0200)
lib/sqlalchemy/orm/query.py

index 999e97394f4ce804cdd1837dbb99188b67e0e35d..f6fd07e61cdbfdebe279ff6093938b9d922f561f 100644 (file)
@@ -723,12 +723,12 @@ class Query(object):
         loading, the full result for all rows is fetched which generally
         defeats the purpose of :meth:`~sqlalchemy.orm.query.Query.yield_per`.
 
-        Also note that many DBAPIs do not "stream" results, pre-buffering
-        all rows before making them available, including mysql-python and
-        psycopg2.  :meth:`~sqlalchemy.orm.query.Query.yield_per` will also
-        set the ``stream_results`` execution
-        option to ``True``, which currently is only understood by psycopg2
-        and causes server side cursors to be used.
+        Also note that while :meth:`~sqlalchemy.orm.query.Query.yield_per`
+        will set the ``stream_results`` execution option to True, currently
+        this is only understood by :mod:`~sqlalchemy.dialects.postgresql.psycopg2` dialect
+        which will stream results using server side cursors instead of pre-buffer
+        all rows for this query. Other DBAPIs pre-buffer all rows before
+        making them available.
 
         """
         self._yield_per = count