diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2021-03-26 10:37:21 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2021-03-26 13:01:05 -0400 |
| commit | 56f9c7743e9083add69a10501a503f4e25bb59d7 (patch) | |
| tree | 43debd5fd0b2d90df87975d7c85d36a5e20da328 /lib/sqlalchemy/orm/strategy_options.py | |
| parent | 784d32edff03cd960d0c47768f7ef0d0a438463e (diff) | |
| download | sqlalchemy-56f9c7743e9083add69a10501a503f4e25bb59d7.tar.gz | |
Adapt loader_criteria params for current query
Fixed critical issue in the new :meth:`_orm.PropComparator.and_` feature
where loader strategies that emit secondary SELECT statements such as
:func:`_orm.selectinload` and :func:`_orm.lazyload` would fail to
accommodate for bound parameters in the user-defined criteria in terms of
the current statement being executed, as opposed to the cached statement,
causing stale bound values to be used.
This also adds a warning for the case where an object that uses
:func:`_orm.lazyload` in conjunction with :meth:`_orm.PropComparator.and_`
is attempted to be serialized; the loader criteria cannot reliably
be serialized and deserialized and eager loading should be used for this
case.
Fixes: #6139
Change-Id: I5a638bbecb7b583db2d3c0b76469f5a25c13dd3b
Diffstat (limited to 'lib/sqlalchemy/orm/strategy_options.py')
| -rw-r--r-- | lib/sqlalchemy/orm/strategy_options.py | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/lib/sqlalchemy/orm/strategy_options.py b/lib/sqlalchemy/orm/strategy_options.py index ba4e5c466..8fa79bfdb 100644 --- a/lib/sqlalchemy/orm/strategy_options.py +++ b/lib/sqlalchemy/orm/strategy_options.py @@ -25,12 +25,18 @@ from .util import _orm_full_deannotate from .. import exc as sa_exc from .. import inspect from .. import util +from ..sql import and_ from ..sql import coercions from ..sql import roles from ..sql import visitors from ..sql.base import _generative from ..sql.base import Generative +if util.TYPE_CHECKING: + from .context import QueryContext + from typing import Sequence + from ..sql.elements import ColumnElement + class Load(Generative, LoaderOption): """Represents loader options which modify the state of a @@ -108,6 +114,31 @@ class Load(Generative, LoaderOption): load._extra_criteria = () return load + def _generate_extra_criteria(self, context): + # type: (QueryContext) -> Sequence[ColumnElement] + """Apply the current bound parameters in a QueryContext to the + "extra_criteria" stored with this Load object. + + Load objects are typically pulled from the cached version of + the statement from a QueryContext. The statement currently being + executed will have new values (and keys) for bound parameters in the + extra criteria which need to be applied by loader strategies when + they handle this criteria for a result set. + + """ + + assert ( + self._extra_criteria + ), "this should only be called if _extra_criteria is present" + + orig_query = context.compile_state.select_statement + current_query = context.query + + k1 = orig_query._generate_cache_key() + k2 = current_query._generate_cache_key() + + return k2._apply_params_to_element(k1, and_(*self._extra_criteria)) + @property def _context_cache_key(self): serialized = [] @@ -488,6 +519,10 @@ class Load(Generative, LoaderOption): def __getstate__(self): d = self.__dict__.copy() + + # can't pickle this right now; warning is raised by strategies + d["_extra_criteria"] = () + if d["context"] is not None: d["context"] = PathRegistry.serialize_context_dict( d["context"], ("loader",) @@ -623,6 +658,10 @@ class _UnboundLoad(Load): def __getstate__(self): d = self.__dict__.copy() + + # can't pickle this right now; warning is raised by strategies + d["_extra_criteria"] = () + d["path"] = self._serialize_path(self.path, filter_aliased_class=True) return d |
