diff options
| author | mike bayer <mike_mp@zzzcomputing.com> | 2013-07-14 09:58:43 -0700 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2013-07-14 13:00:05 -0400 |
| commit | bb290b46a65d51f1b435031b132f03ec810b44da (patch) | |
| tree | 0b93d66f81d45780ab2d5c9a571ce3c3e4734a79 | |
| parent | 900780bceaad1905f9ce626ce429c9eaf06106e4 (diff) | |
| download | sqlalchemy-bb290b46a65d51f1b435031b132f03ec810b44da.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.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index 286dbf6b3..2e849fba9 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -674,12 +674,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 |