summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/orm/query.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2010-01-17 20:43:35 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2010-01-17 20:43:35 +0000
commit151fa4e75ce951e42068b3a5785e06a8ecf4dd44 (patch)
tree8b3958e357e37192fe4c233fa181e35ccc63096a /lib/sqlalchemy/orm/query.py
parent2b1937a31e5b5d8de56f266ec7692a3d0dd90976 (diff)
downloadsqlalchemy-151fa4e75ce951e42068b3a5785e06a8ecf4dd44.tar.gz
statement_options -> execution_options
Diffstat (limited to 'lib/sqlalchemy/orm/query.py')
-rw-r--r--lib/sqlalchemy/orm/query.py26
1 files changed, 14 insertions, 12 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index 444ad37bc..0a7a738c8 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -80,7 +80,7 @@ class Query(object):
_filter_aliases = None
_from_obj_alias = None
_joinpath = _joinpoint = util.frozendict()
- _statement_options = util.frozendict()
+ _execution_options = util.frozendict()
_params = util.frozendict()
_attributes = util.frozendict()
_with_options = ()
@@ -490,14 +490,14 @@ class Query(object):
Also note that many DBAPIs do not "stream" results, pre-buffering
all rows before making them available, including mysql-python and
- psycopg2. yield_per() will also set the ``stream_results`` statement
+ psycopg2. 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.
"""
self._yield_per = count
- self._statement_options = self._statement_options.copy()
- self._statement_options['stream_results'] = True
+ self._execution_options = self._execution_options.copy()
+ self._execution_options['stream_results'] = True
def get(self, ident):
"""Return an instance of the object based on the given identifier, or None if not found.
@@ -676,19 +676,21 @@ class Query(object):
opt.process_query(self)
@_generative()
- def statement_options(self, **kwargs):
- """ Set non-SQL options for the resulting statement, such as dialect-specific options.
+ def execution_options(self, **kwargs):
+ """ Set non-SQL options for the resulting statement,
+ such as dialect-specific options.
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()`,
+ 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.
"""
- _statement_options = self._statement_options.copy()
+ _execution_options = self._execution_options.copy()
for key, value in kwargs.items():
- _statement_options[key] = value
- self._statement_options = _statement_options
+ _execution_options[key] = value
+ self._execution_options = _execution_options
@_generative()
def with_lockmode(self, mode):
@@ -1938,7 +1940,7 @@ class Query(object):
context.adapter = sql_util.ColumnAdapter(inner, equivs)
- statement = sql.select([inner] + context.secondary_columns, for_update=for_update, use_labels=labels, statement_options=self._statement_options)
+ statement = sql.select([inner] + context.secondary_columns, for_update=for_update, use_labels=labels, execution_options=self._execution_options)
from_clause = inner
for eager_join in eager_joins:
@@ -1970,7 +1972,7 @@ class Query(object):
for_update=for_update,
correlate=False,
order_by=context.order_by,
- statement_options=self._statement_options,
+ execution_options=self._execution_options,
**self._select_args
)