openstack/oslo.db
Code Issues Proposed changes

Resolve SAWarning in Query.soft_delete()

Browse Source 
We currently see a lot of warnings like this from
the soft_delete() method:

  sqlalchemy.exc.SAWarning: Evaluating non-mapped column expression
  'updated_at' onto ORM instances; this is a deprecated use case.
  Please make use of the actual mapped columns in ORM-evaluated
  UPDATE / DELETE expressions.

This is because the "evaluate" synchronization strategy would like
to search for objects and update them based on the UPDATE criteria
passed, however the columns given, literal_column('id'),
literal_column('updated_at'), are not mapped to anything. The
evaluator has to make a guess that the string contained in these
expressions should be matched to a mapped attribute on the given
entity and this guess was first removed in [1], then added back in
[2] with a warning (likely since oslo.db is invoking it).

This uses the actual entity-mapped column for the query rather
than the literal string column.

[1] https://docs.sqlalchemy.org/en/latest/changelog/changelog_12.html#change-b1e620dece39006ab44c47044e9a6fee
[2] https://docs.sqlalchemy.org/en/latest/changelog/changelog_12.html#change-dff3a469788c81a46440584406cb22be

Change-Id: I192e84ce757d12d33085a209dd58d8ea46fb90fb
Closes-Bug: #1814199
This commit is contained in:
Mike Bayer 2019-02-01 11:53:26 -05:00 committed by Matt Riedemann
parent 8c60cc1135
commit af4b2263e4
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
oslo_db/sqlalchemy/orm.py
View File

@ -18,7 +18,6 @@
from oslo_utils import timeutils from oslo_utils import timeutils
import sqlalchemy.orm import sqlalchemy.orm
from sqlalchemy.sql.expression import literal_column
from oslo_db.sqlalchemy import update_match from oslo_db.sqlalchemy import update_match
@ -26,8 +25,9 @@ from oslo_db.sqlalchemy import update_match
class Query(sqlalchemy.orm.query.Query): class Query(sqlalchemy.orm.query.Query):
"""Subclass of sqlalchemy.query with soft_delete() method.""" """Subclass of sqlalchemy.query with soft_delete() method."""
def soft_delete(self, synchronize_session='evaluate'): def soft_delete(self, synchronize_session='evaluate'):
return self.update({'deleted': literal_column('id'), entity = self.column_descriptions[0]['entity']
'updated_at': literal_column('updated_at'), return self.update({'deleted': entity.id,
'updated_at': entity.updated_at,
'deleted_at': timeutils.utcnow()}, 'deleted_at': timeutils.utcnow()},
synchronize_session=synchronize_session) synchronize_session=synchronize_session)