diff options
Diffstat (limited to 'lib/sqlalchemy/orm/events.py')
| -rw-r--r-- | lib/sqlalchemy/orm/events.py | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/lib/sqlalchemy/orm/events.py b/lib/sqlalchemy/orm/events.py index 88d312237..9eb321b6b 100644 --- a/lib/sqlalchemy/orm/events.py +++ b/lib/sqlalchemy/orm/events.py @@ -1592,11 +1592,18 @@ class SessionEvents(event.Events): * ``session`` - the :class:`.Session` involved * ``query`` -the :class:`.Query` object that this update operation was called upon. + * ``values`` The "values" dictionary that was passed to + :meth:`.Query.update`. * ``context`` The :class:`.QueryContext` object, corresponding to the invocation of an ORM query. * ``result`` the :class:`.ResultProxy` returned as a result of the bulk UPDATE operation. + .. seealso:: + + :meth:`.QueryEvents.before_compile_update` + + :meth:`.SessionEvents.after_bulk_delete` """ @@ -1626,6 +1633,11 @@ class SessionEvents(event.Events): * ``result`` the :class:`.ResultProxy` returned as a result of the bulk DELETE operation. + .. seealso:: + + :meth:`.QueryEvents.before_compile_delete` + + :meth:`.SessionEvents.after_bulk_update` """ @@ -2348,8 +2360,9 @@ class QueryEvents(event.Events): """Allow modifications to the :class:`.Query` object within :meth:`.Query.update`. - Like the :meth:`.QueryEvents.before_compile` event, this event - should be configured with ``retval=True``, and the modified + Like the :meth:`.QueryEvents.before_compile` event, if the event + is to be used to alter the :class:`.Query` object, it should + be configured with ``retval=True``, and the modified :class:`.Query` object returned, as in :: @event.listens_for(Query, "before_compile_update", retval=True) @@ -2358,8 +2371,13 @@ class QueryEvents(event.Events): if desc['type'] is User: entity = desc['entity'] query = query.filter(entity.deleted == False) + + update_context.values['timestamp'] = datetime.utcnow() return query + The ``.values`` dictionary of the "update context" object can also + be modified in place as illustrated above. + :param query: a :class:`.Query` instance; this is also the ``.query`` attribute of the given "update context" object. @@ -2367,6 +2385,10 @@ class QueryEvents(event.Events): :param update_context: an "update context" object which is the same kind of object as described in :paramref:`.QueryEvents.after_bulk_update.update_context`. + The object has a ``.values`` attribute in an UPDATE context which is + the dictionary of parameters passed to :meth:`.Query.update`. This + dictionary can be modified to alter the VALUES clause of the + resulting UPDATE statement. .. versionadded:: 1.2.17 |