summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy
diff options
context:
space:
mode:
authormike bayer <mike_mp@zzzcomputing.com>2013-07-14 09:58:43 -0700
committerMike Bayer <mike_mp@zzzcomputing.com>2013-07-14 12:59:58 -0400
commit7da90f41b269f7b40090627b93d1d48781ce9b6a (patch)
treeb821e49657f8142057c8801df4c4684ba629fa2b /lib/sqlalchemy
parenta5d9e1367599fd7b453981134f4352dbfb29914a (diff)
downloadsqlalchemy-7da90f41b269f7b40090627b93d1d48781ce9b6a.tar.gz
Merge pull request #17 from iElectric/docs/wording_yield_per
wording about supported dialects for Query.yield_per
Diffstat (limited to 'lib/sqlalchemy')
-rw-r--r--lib/sqlalchemy/orm/query.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index 9a85374b4..1743aa599 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -721,12 +721,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