Skip to content

PYTHON-4576 Allow update to supply sort option #1881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 16, 2024
Merged

PYTHON-4576 Allow update to supply sort option #1881

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f7de5cd
PYTHON-4576 Allow update to supply sort option
blink1073 Sep 30, 2024
523875b
clean up bulk support
blink1073 Sep 30, 2024
2402cdf
clean up operations
blink1073 Sep 30, 2024
b63db31
fix replaceone
blink1073 Sep 30, 2024
ac2264f
try with updated specs
blink1073 Sep 30, 2024
7e46c4a
update tests
blink1073 Oct 1, 2024
6caba66
Merge branch 'master' into PYTHON-4576
blink1073 Oct 14, 2024
aa636d4
Merge branch 'master' of github.com:mongodb/mongo-python-driver into …
blink1073 Oct 16, 2024
14c2d80
address review
blink1073 Oct 16, 2024
978fa10
Merge branch 'PYTHON-4576' of github.com:blink1073/mongo-python-drive…
blink1073 Oct 16, 2024
ac64d2c
address review
blink1073 Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pymongo/asynchronous/bulk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ def __init__(
self.uses_array_filters = False
self.uses_hint_update = False
self.uses_hint_delete = False
self.uses_sort = False
self.is_retryable = True
self.retrying = False
self.started_retryable_write = False
Expand Down Expand Up @@ -144,6 +145,7 @@ def add_update(
collation: Optional[Mapping[str, Any]] = None,
array_filters: Optional[list[Mapping[str, Any]]] = None,
hint: Union[str, dict[str, Any], None] = None,
sort: Optional[Mapping[str, Any]] = None,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is slightly inconsistent with pymongo's other sort APIs which use _Sort type and allow a list of key pairs as well as a mapping. I think that's okay because mapping should be the preferred approach now (after PYTHON-2878).

I say we keep it like this and only add support for a list of pairs if a user requests it. It will save us the work of adding tests for the (list or pairs) behavior.

) -> None:
"""Create an update document and add it to the list of ops."""
validate_ok_for_update(update)
Expand All @@ -159,6 +161,9 @@ def add_update(
if hint is not None:
self.uses_hint_update = True
cmd["hint"] = hint
if sort is not None:
self.uses_sort = True
cmd["sort"] = sort
if multi:
# A bulk_write containing an update_many is not retryable.
self.is_retryable = False
Expand All @@ -171,6 +176,7 @@ def add_replace(
upsert: bool = False,
collation: Optional[Mapping[str, Any]] = None,
hint: Union[str, dict[str, Any], None] = None,
sort: Optional[Mapping[str, Any]] = None,
) -> None:
"""Create a replace document and add it to the list of ops."""
validate_ok_for_replace(replacement)
Expand All @@ -181,6 +187,9 @@ def add_replace(
if hint is not None:
self.uses_hint_update = True
cmd["hint"] = hint
if sort is not None:
self.uses_sort = True
cmd["sort"] = sort
self.ops.append((_UPDATE, cmd))

def add_delete(
Expand Down Expand Up @@ -699,6 +708,10 @@ async def execute_no_results(
raise ConfigurationError(
"Must be connected to MongoDB 4.2+ to use hint on unacknowledged update commands."
)
if unack and self.uses_sort and conn.max_wire_version < 25:
raise ConfigurationError(
"Must be connected to MongoDB 8.0+ to use sort on unacknowledged update commands."
)
# Cannot have both unacknowledged writes and bypass document validation.
if self.bypass_doc_val:
raise OperationFailure(
Expand Down
9 changes: 9 additions & 0 deletions pymongo/asynchronous/client_bulk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ def __init__(
self.uses_array_filters = False
self.uses_hint_update = False
self.uses_hint_delete = False
self.uses_sort = False

self.is_retryable = self.client.options.retry_writes
self.retrying = False
Expand Down Expand Up @@ -148,6 +149,7 @@ def add_update(
collation: Optional[Mapping[str, Any]] = None,
array_filters: Optional[list[Mapping[str, Any]]] = None,
hint: Union[str, dict[str, Any], None] = None,
sort: Optional[Mapping[str, Any]] = None,
) -> None:
"""Create an update document and add it to the list of ops."""
validate_ok_for_update(update)
Expand All @@ -169,6 +171,9 @@ def add_update(
if collation is not None:
self.uses_collation = True
cmd["collation"] = collation
if sort is not None:
self.uses_sort = True
cmd["sort"] = sort
if multi:
# A bulk_write containing an update_many is not retryable.
self.is_retryable = False
Expand All @@ -184,6 +189,7 @@ def add_replace(
upsert: Optional[bool] = None,
collation: Optional[Mapping[str, Any]] = None,
hint: Union[str, dict[str, Any], None] = None,
sort: Optional[Mapping[str, Any]] = None,
) -> None:
"""Create a replace document and add it to the list of ops."""
validate_ok_for_replace(replacement)
Expand All @@ -202,6 +208,9 @@ def add_replace(
if collation is not None:
self.uses_collation = True
cmd["collation"] = collation
if sort is not None:
self.uses_sort = True
cmd["sort"] = sort
self.ops.append(("replace", cmd))
self.namespaces.append(namespace)
self.total_ops += 1
Expand Down
23 changes: 23 additions & 0 deletions pymongo/asynchronous/collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -993,6 +993,7 @@ async def _update(
session: Optional[AsyncClientSession] = None,
retryable_write: bool = False,
let: Optional[Mapping[str, Any]] = None,
sort: Optional[Mapping[str, Any]] = None,
comment: Optional[Any] = None,
) -> Optional[Mapping[str, Any]]:
"""Internal update / replace helper."""
Expand Down Expand Up @@ -1024,6 +1025,14 @@ async def _update(
if not isinstance(hint, str):
hint = helpers_shared._index_document(hint)
update_doc["hint"] = hint
if sort is not None:
if not acknowledged and conn.max_wire_version < 25:
raise ConfigurationError(
"Must be connected to MongoDB 8.0+ to use sort on unacknowledged update commands."
)
common.validate_is_mapping("sort", sort)
update_doc["sort"] = sort

command = {"update": self.name, "ordered": ordered, "updates": [update_doc]}
if let is not None:
common.validate_is_mapping("let", let)
Expand Down Expand Up @@ -1079,6 +1088,7 @@ async def _update_retryable(
hint: Optional[_IndexKeyHint] = None,
session: Optional[AsyncClientSession] = None,
let: Optional[Mapping[str, Any]] = None,
sort: Optional[Mapping[str, Any]] = None,
comment: Optional[Any] = None,
) -> Optional[Mapping[str, Any]]:
"""Internal update / replace helper."""
Expand All @@ -1102,6 +1112,7 @@ async def _update(
session=session,
retryable_write=retryable_write,
let=let,
sort=sort,
comment=comment,
)

Expand All @@ -1122,6 +1133,7 @@ async def replace_one(
hint: Optional[_IndexKeyHint] = None,
session: Optional[AsyncClientSession] = None,
let: Optional[Mapping[str, Any]] = None,
sort: Optional[Mapping[str, Any]] = None,
comment: Optional[Any] = None,
) -> UpdateResult:
"""Replace a single document matching the filter.
Expand Down Expand Up @@ -1176,8 +1188,12 @@ async def replace_one(
aggregate expression context (e.g. "$$var").
:param comment: A user-provided comment to attach to this
command.
:param sort: Specify which document the operation updates if the query matches
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a mention for these new apis in the changelog?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

multiple documents. The first document matched by the sort order will be updated.
:return: - An instance of :class:`~pymongo.results.UpdateResult`.

.. versionchanged:: 4.10
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4.10 -> 4.11 here and elsewhere.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Added ``sort`` parameter.
.. versionchanged:: 4.1
Added ``let`` parameter.
Added ``comment`` parameter.
Expand Down Expand Up @@ -1209,6 +1225,7 @@ async def replace_one(
hint=hint,
session=session,
let=let,
sort=sort,
comment=comment,
),
write_concern.acknowledged,
Expand All @@ -1225,6 +1242,7 @@ async def update_one(
hint: Optional[_IndexKeyHint] = None,
session: Optional[AsyncClientSession] = None,
let: Optional[Mapping[str, Any]] = None,
sort: Optional[Mapping[str, Any]] = None,
comment: Optional[Any] = None,
) -> UpdateResult:
"""Update a single document matching the filter.
Expand Down Expand Up @@ -1283,11 +1301,15 @@ async def update_one(
constant or closed expressions that do not reference document
fields. Parameters can then be accessed as variables in an
aggregate expression context (e.g. "$$var").
:param sort: Specify which document the operation updates if the query matches
multiple documents. The first document matched by the sort order will be updated.
:param comment: A user-provided comment to attach to this
command.

:return: - An instance of :class:`~pymongo.results.UpdateResult`.

.. versionchanged:: 4.10
Added ``sort`` parameter.
.. versionchanged:: 4.1
Added ``let`` parameter.
Added ``comment`` parameter.
Expand Down Expand Up @@ -1322,6 +1344,7 @@ async def update_one(
hint=hint,
session=session,
let=let,
sort=sort,
comment=comment,
),
write_concern.acknowledged,
Expand Down
Loading
Loading