diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2010-03-09 18:45:30 -0500 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2010-03-09 18:45:30 -0500 |
commit | 53832b9fb25afa89f36234d86a09b4414feada3a (patch) | |
tree | e22a3adbf03174569c06cb21a963ebda3d6e9891 /lib/sqlalchemy/orm/query.py | |
parent | dcd65902523f08dc1027d4d5a013b2c1f95bc230 (diff) | |
download | sqlalchemy-53832b9fb25afa89f36234d86a09b4414feada3a.tar.gz |
fixed up docs for execution_options() across all three locations.
Diffstat (limited to 'lib/sqlalchemy/orm/query.py')
-rw-r--r-- | lib/sqlalchemy/orm/query.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index a477ea544..0f68e0a41 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -691,14 +691,14 @@ class Query(object): @_generative() def execution_options(self, **kwargs): - """ Set non-SQL options for the resulting statement, - such as dialect-specific options. + """ Set non-SQL options which take effect during execution. - The only option currently understood is ``stream_results=True``, - only used by Psycopg2 to enable "server side cursors". This option - only has a useful effect if used in conjunction with - :meth:`~sqlalchemy.orm.query.Query.yield_per()`, - which currently sets ``stream_results`` to ``True`` automatically. + The options are the same as those accepted by + :meth:`sqlalchemy.sql.expression.Executable.execution_options`. + + Note that the ``stream_results`` execution option is enabled + automatically if the :meth:`~sqlalchemy.orm.query.Query.yield_per()` + method is used. """ _execution_options = self._execution_options.copy() |