summaryrefslogtreecommitdiff
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 09:58:43 -0700
commitc59199c9879c3535dc48647a3f61281f0ac631f4 (patch)
tree1e44a81bce73708e46a989fe9db1c649c0c46b9b
parent171f8d4265c1d5995d15f73f1bdbb873c5c21290 (diff)
parent0d4b769d6aed2979625443e20e626a43ae67c28d (diff)
downloadsqlalchemy-c59199c9879c3535dc48647a3f61281f0ac631f4.tar.gz
Merge pull request #17 from iElectric/docs/wording_yield_per
wording about supported dialects for Query.yield_per
-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 999e97394..f6fd07e61 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -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