summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2011-02-11 14:41:29 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2011-02-11 14:41:29 -0500
commitd7fda4ae03f0e1c1ab73ced15e7b0472f36d1024 (patch)
tree280225601b0b1768423babdef6fb52766f4b21d2
parent33eae4a1405b1968ad486bfe3aefee7f7d631128 (diff)
downloadsqlalchemy-d7fda4ae03f0e1c1ab73ced15e7b0472f36d1024.tar.gz
- Additional tuning to "many-to-one" relationship
loads during a flush(). A change in version 0.6.6 ([ticket:2002]) required that more "unnecessary" m2o loads during a flush could occur. Extra loading modes have been added so that the SQL emitted in this specific use case is trimmed back, while still retrieving the information the flush needs in order to not miss anything. [ticket:2049]
-rw-r--r--CHANGES9
-rw-r--r--lib/sqlalchemy/orm/attributes.py12
-rw-r--r--lib/sqlalchemy/orm/dependency.py7
-rw-r--r--lib/sqlalchemy/orm/query.py4
-rw-r--r--lib/sqlalchemy/orm/strategies.py13
-rw-r--r--test/orm/test_unitofworkv2.py130
6 files changed, 159 insertions, 16 deletions
diff --git a/CHANGES b/CHANGES
index f1897c85c..8dfc8fd01 100644
--- a/CHANGES
+++ b/CHANGES
@@ -122,6 +122,15 @@ CHANGES
as *args, interpreted by the Postgresql dialect
as DISTINCT ON (<expr>). [ticket:1069]
+ - Additional tuning to "many-to-one" relationship
+ loads during a flush(). A change in version 0.6.6
+ ([ticket:2002]) required that more "unnecessary" m2o
+ loads during a flush could occur. Extra loading modes have
+ been added so that the SQL emitted in this
+ specific use case is trimmed back, while still
+ retrieving the information the flush needs in order
+ to not miss anything. [ticket:2049]
+
- sql
- Added over() function, method to FunctionElement
classes, produces the _Over() construct which
diff --git a/lib/sqlalchemy/orm/attributes.py b/lib/sqlalchemy/orm/attributes.py
index ca1137c3f..c0ec474cb 100644
--- a/lib/sqlalchemy/orm/attributes.py
+++ b/lib/sqlalchemy/orm/attributes.py
@@ -37,9 +37,19 @@ PASSIVE_NO_INITIALIZE = True #util.symbol('PASSIVE_NO_INITIALIZE')
# this is used by backrefs.
PASSIVE_NO_FETCH = util.symbol('PASSIVE_NO_FETCH')
-"""Symbol indicating that loader callables should not be fired off.
+"""Symbol indicating that loader callables should not emit SQL.
Non-initialized attributes should be initialized to an empty value."""
+PASSIVE_NO_FETCH_RELATED = util.symbol('PASSIVE_NO_FETCH_RELATED')
+"""Symbol indicating that loader callables should not emit SQL for
+ the related object, but can refresh the attributes of the local
+ instance.
+ Non-initialized attributes should be initialized to an empty value.
+
+ The unit of work uses this mode to check if history is present
+ with minimal SQL emitted.
+ """
+
PASSIVE_ONLY_PERSISTENT = util.symbol('PASSIVE_ONLY_PERSISTENT')
"""Symbol indicating that loader callables should only fire off for
persistent objects.
diff --git a/lib/sqlalchemy/orm/dependency.py b/lib/sqlalchemy/orm/dependency.py
index e3e2f5d56..dde0d94c8 100644
--- a/lib/sqlalchemy/orm/dependency.py
+++ b/lib/sqlalchemy/orm/dependency.py
@@ -219,7 +219,12 @@ class DependencyProcessor(object):
pass
def prop_has_changes(self, uowcommit, states, isdelete):
- passive = not isdelete or self.passive_deletes
+ if not isdelete or self.passive_deletes:
+ passive = attributes.PASSIVE_NO_INITIALIZE
+ elif self.direction is MANYTOONE:
+ passive = attributes.PASSIVE_NO_FETCH_RELATED
+ else:
+ passive = attributes.PASSIVE_OFF
for s in states:
# TODO: add a high speed method
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index 71a6edd31..43699b4d9 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -1947,6 +1947,10 @@ class Query(object):
if passive is attributes.PASSIVE_NO_FETCH:
# TODO: no coverage here
return attributes.PASSIVE_NO_RESULT
+ elif passive is attributes.PASSIVE_NO_FETCH_RELATED:
+ # this mode is used within a flush and the instance's
+ # expired state will be checked soon enough, if necessary
+ return instance
try:
state(passive)
except orm_exc.ObjectDeletedError:
diff --git a/lib/sqlalchemy/orm/strategies.py b/lib/sqlalchemy/orm/strategies.py
index bf7f04995..8d5649a39 100644
--- a/lib/sqlalchemy/orm/strategies.py
+++ b/lib/sqlalchemy/orm/strategies.py
@@ -451,7 +451,8 @@ class LazyLoader(AbstractRelationshipLoader):
pending = not state.key
if (
- passive is attributes.PASSIVE_NO_FETCH and
+ (passive is attributes.PASSIVE_NO_FETCH or \
+ passive is attributes.PASSIVE_NO_FETCH_RELATED) and
not self.use_get
) or (
passive is attributes.PASSIVE_ONLY_PERSISTENT and
@@ -476,12 +477,17 @@ class LazyLoader(AbstractRelationshipLoader):
get_attr = instance_mapper._get_state_attr_by_column
dict_ = state.dict
+ if passive is attributes.PASSIVE_NO_FETCH_RELATED:
+ attr_passive = attributes.PASSIVE_OFF
+ else:
+ attr_passive = passive
+
ident = [
get_attr(
state,
state.dict,
self._equated_columns[pk],
- passive=passive)
+ passive=attr_passive)
for pk in prop_mapper.primary_key
]
if attributes.PASSIVE_NO_RESULT in ident:
@@ -494,7 +500,8 @@ class LazyLoader(AbstractRelationshipLoader):
instance = Query._get_from_identity(session, ident_key, passive)
if instance is not None:
return instance
- elif passive is attributes.PASSIVE_NO_FETCH:
+ elif passive is attributes.PASSIVE_NO_FETCH or \
+ passive is attributes.PASSIVE_NO_FETCH_RELATED:
return attributes.PASSIVE_NO_RESULT
q = session.query(prop_mapper)._adapt_all_clauses()
diff --git a/test/orm/test_unitofworkv2.py b/test/orm/test_unitofworkv2.py
index 7018f2338..20b643b4d 100644
--- a/test/orm/test_unitofworkv2.py
+++ b/test/orm/test_unitofworkv2.py
@@ -259,9 +259,11 @@ class RudimentaryFlushTest(UOWTest):
testing.db,
session.flush,
AllOf(
- # ensure all three m2os are loaded.
+ # [ticket:2002] - ensure the m2os are loaded.
# the selects here are in fact unexpiring
# each row - the m2o comes from the identity map.
+ # the User row might be handled before or the addresses
+ # are loaded so need to use AllOf
CompiledSQL(
"SELECT addresses.id AS addresses_id, addresses.user_id AS "
"addresses_user_id, addresses.email_address AS "
@@ -281,14 +283,120 @@ class RudimentaryFlushTest(UOWTest):
"FROM users WHERE users.id = :param_1",
lambda ctx: {'param_1': pid}
),
+ CompiledSQL(
+ "DELETE FROM addresses WHERE addresses.id = :id",
+ lambda ctx: [{'id': c1id}, {'id': c2id}]
+ ),
+ CompiledSQL(
+ "DELETE FROM users WHERE users.id = :id",
+ lambda ctx: {'id': pid}
+ ),
+ ),
+ )
+
+ def test_many_to_one_delete_childonly_unloaded(self):
+ mapper(User, users)
+ mapper(Address, addresses, properties={
+ 'parent':relationship(User)
+ })
+
+ parent = User(name='p1')
+ c1, c2 = Address(email_address='c1', parent=parent), \
+ Address(email_address='c2', parent=parent)
+
+ session = Session()
+ session.add_all([c1, c2])
+ session.add(parent)
+
+ session.flush()
+
+ pid = parent.id
+ c1id = c1.id
+ c2id = c2.id
+
+ session.expire(c1)
+ session.expire(c2)
+
+ session.delete(c1)
+ session.delete(c2)
+
+ self.assert_sql_execution(
+ testing.db,
+ session.flush,
+ AllOf(
+ # [ticket:2049] - we aren't deleting User,
+ # relationship is simple m2o, no SELECT should be emitted for it.
+ CompiledSQL(
+ "SELECT addresses.id AS addresses_id, addresses.user_id AS "
+ "addresses_user_id, addresses.email_address AS "
+ "addresses_email_address FROM addresses WHERE addresses.id = "
+ ":param_1",
+ lambda ctx: {'param_1': c1id}
+ ),
+ CompiledSQL(
+ "SELECT addresses.id AS addresses_id, addresses.user_id AS "
+ "addresses_user_id, addresses.email_address AS "
+ "addresses_email_address FROM addresses WHERE addresses.id = "
+ ":param_1",
+ lambda ctx: {'param_1': c2id}
+ ),
),
CompiledSQL(
"DELETE FROM addresses WHERE addresses.id = :id",
lambda ctx: [{'id': c1id}, {'id': c2id}]
),
+ )
+
+ def test_many_to_one_delete_childonly_unloaded_expired(self):
+ mapper(User, users)
+ mapper(Address, addresses, properties={
+ 'parent':relationship(User)
+ })
+
+ parent = User(name='p1')
+ c1, c2 = Address(email_address='c1', parent=parent), \
+ Address(email_address='c2', parent=parent)
+
+ session = Session()
+ session.add_all([c1, c2])
+ session.add(parent)
+
+ session.flush()
+
+ pid = parent.id
+ c1id = c1.id
+ c2id = c2.id
+
+ session.expire(parent)
+ session.expire(c1)
+ session.expire(c2)
+
+ session.delete(c1)
+ session.delete(c2)
+
+ self.assert_sql_execution(
+ testing.db,
+ session.flush,
+ AllOf(
+ # the parent User is expired, so it gets loaded here.
+ CompiledSQL(
+ "SELECT addresses.id AS addresses_id, addresses.user_id AS "
+ "addresses_user_id, addresses.email_address AS "
+ "addresses_email_address FROM addresses WHERE addresses.id = "
+ ":param_1",
+ lambda ctx: {'param_1': c1id}
+ ),
+ CompiledSQL(
+ "SELECT addresses.id AS addresses_id, addresses.user_id AS "
+ "addresses_user_id, addresses.email_address AS "
+ "addresses_email_address FROM addresses WHERE addresses.id = "
+ ":param_1",
+ lambda ctx: {'param_1': c2id}
+ ),
+ ),
CompiledSQL(
- "DELETE FROM users WHERE users.id = :id",
- lambda ctx: {'id': pid}
+ "DELETE FROM addresses WHERE addresses.id = :id",
+ lambda ctx: [{'id': c1id}, {'id': c2id}]
),
)
@@ -708,14 +816,14 @@ class SingleCycleTest(UOWTest):
"WHERE nodes.id = :param_1",
lambda ctx: {'param_1': c2id}
),
- ),
- CompiledSQL(
- "DELETE FROM nodes WHERE nodes.id = :id",
- lambda ctx: [{'id': c1id}, {'id': c2id}]
- ),
- CompiledSQL(
- "DELETE FROM nodes WHERE nodes.id = :id",
- lambda ctx: {'id': pid}
+ CompiledSQL(
+ "DELETE FROM nodes WHERE nodes.id = :id",
+ lambda ctx: [{'id': c1id}, {'id': c2id}]
+ ),
+ CompiledSQL(
+ "DELETE FROM nodes WHERE nodes.id = :id",
+ lambda ctx: {'id': pid}
+ ),
),
)