summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/build/changelog/changelog_12.rst14
-rw-r--r--doc/build/changelog/migration_12.rst24
2 files changed, 38 insertions, 0 deletions
diff --git a/doc/build/changelog/changelog_12.rst b/doc/build/changelog/changelog_12.rst
index 1797a14ad..c855c10e5 100644
--- a/doc/build/changelog/changelog_12.rst
+++ b/doc/build/changelog/changelog_12.rst
@@ -75,6 +75,20 @@
support that relationship. This applies to both a single and a
joined inheritance polymorphic load.
+ .. change:: 3991
+ :tags: bug, orm
+ :tickets: 3991
+
+ Added new argument :paramref:`.with_for_update` to the
+ :meth:`.Session.refresh` method. When the :meth:`.Query.with_lockmode`
+ method were deprecated in favor of :meth:`.Query.with_for_update`,
+ the :meth:`.Session.refresh` method was never updated to reflect
+ the new option.
+
+ .. seealso::
+
+ :ref:`change_3991`
+
.. change:: 3984
:tags: bug, orm
:tickets: 3984
diff --git a/doc/build/changelog/migration_12.rst b/doc/build/changelog/migration_12.rst
index bb863ccca..9371fe64c 100644
--- a/doc/build/changelog/migration_12.rst
+++ b/doc/build/changelog/migration_12.rst
@@ -335,6 +335,30 @@ Above, the event handler will be triggered when an in-place change to the
:ticket:`3303`
+.. _change_3991:
+
+Added "for update" arguments to Session.refresh
+------------------------------------------------
+
+Added new argument :paramref:`.with_for_update` to the
+:meth:`.Session.refresh` method. When the :meth:`.Query.with_lockmode`
+method were deprecated in favor of :meth:`.Query.with_for_update`,
+the :meth:`.Session.refresh` method was never updated to reflect
+the new option::
+
+ session.refresh(some_object, with_for_update=True)
+
+The :paramref:`.Session.refresh.with_for_update` argument accepts a dictionary
+of options that will be passed as the same arguments which are sent to
+:meth:`.Query.with_for_update`::
+
+ session.refresh(some_objects with_for_update={"read": True})
+
+The new parameter supersedes the :paramref:`.Session.refresh.lockmode`
+parameter.
+
+:ticket:`3991`
+
New Features and Improvements - Core
====================================