217 lines
7.3 KiB
Python
217 lines
7.3 KiB
Python
# Copyright 2015-present MongoDB, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""Result class definitions."""
|
|
from typing import Any, Dict, List, Optional, cast
|
|
|
|
from pymongo.errors import InvalidOperation
|
|
|
|
|
|
class _WriteResult:
|
|
"""Base class for write result classes."""
|
|
|
|
__slots__ = ("__acknowledged",)
|
|
|
|
def __init__(self, acknowledged: bool) -> None:
|
|
self.__acknowledged = acknowledged
|
|
|
|
def _raise_if_unacknowledged(self, property_name):
|
|
"""Raise an exception on property access if unacknowledged."""
|
|
if not self.__acknowledged:
|
|
raise InvalidOperation(
|
|
"A value for {} is not available when "
|
|
"the write is unacknowledged. Check the "
|
|
"acknowledged attribute to avoid this "
|
|
"error.".format(property_name)
|
|
)
|
|
|
|
@property
|
|
def acknowledged(self) -> bool:
|
|
"""Is this the result of an acknowledged write operation?
|
|
|
|
The :attr:`acknowledged` attribute will be ``False`` when using
|
|
``WriteConcern(w=0)``, otherwise ``True``.
|
|
|
|
.. note::
|
|
If the :attr:`acknowledged` attribute is ``False`` all other
|
|
attributes of this class will raise
|
|
:class:`~pymongo.errors.InvalidOperation` when accessed. Values for
|
|
other attributes cannot be determined if the write operation was
|
|
unacknowledged.
|
|
|
|
.. seealso::
|
|
:class:`~pymongo.write_concern.WriteConcern`
|
|
"""
|
|
return self.__acknowledged
|
|
|
|
|
|
class InsertOneResult(_WriteResult):
|
|
"""The return type for :meth:`~pymongo.collection.Collection.insert_one`."""
|
|
|
|
__slots__ = ("__inserted_id",)
|
|
|
|
def __init__(self, inserted_id: Any, acknowledged: bool) -> None:
|
|
self.__inserted_id = inserted_id
|
|
super().__init__(acknowledged)
|
|
|
|
@property
|
|
def inserted_id(self) -> Any:
|
|
"""The inserted document's _id."""
|
|
return self.__inserted_id
|
|
|
|
|
|
class InsertManyResult(_WriteResult):
|
|
"""The return type for :meth:`~pymongo.collection.Collection.insert_many`."""
|
|
|
|
__slots__ = ("__inserted_ids",)
|
|
|
|
def __init__(self, inserted_ids: List[Any], acknowledged: bool) -> None:
|
|
self.__inserted_ids = inserted_ids
|
|
super().__init__(acknowledged)
|
|
|
|
@property
|
|
def inserted_ids(self) -> List:
|
|
"""A list of _ids of the inserted documents, in the order provided.
|
|
|
|
.. note:: If ``False`` is passed for the `ordered` parameter to
|
|
:meth:`~pymongo.collection.Collection.insert_many` the server
|
|
may have inserted the documents in a different order than what
|
|
is presented here.
|
|
"""
|
|
return self.__inserted_ids
|
|
|
|
|
|
class UpdateResult(_WriteResult):
|
|
"""The return type for :meth:`~pymongo.collection.Collection.update_one`,
|
|
:meth:`~pymongo.collection.Collection.update_many`, and
|
|
:meth:`~pymongo.collection.Collection.replace_one`.
|
|
"""
|
|
|
|
__slots__ = ("__raw_result",)
|
|
|
|
def __init__(self, raw_result: Dict[str, Any], acknowledged: bool) -> None:
|
|
self.__raw_result = raw_result
|
|
super().__init__(acknowledged)
|
|
|
|
@property
|
|
def raw_result(self) -> Dict[str, Any]:
|
|
"""The raw result document returned by the server."""
|
|
return self.__raw_result
|
|
|
|
@property
|
|
def matched_count(self) -> int:
|
|
"""The number of documents matched for this update."""
|
|
self._raise_if_unacknowledged("matched_count")
|
|
if self.upserted_id is not None:
|
|
return 0
|
|
return self.__raw_result.get("n", 0)
|
|
|
|
@property
|
|
def modified_count(self) -> int:
|
|
"""The number of documents modified."""
|
|
self._raise_if_unacknowledged("modified_count")
|
|
return cast(int, self.__raw_result.get("nModified"))
|
|
|
|
@property
|
|
def upserted_id(self) -> Any:
|
|
"""The _id of the inserted document if an upsert took place. Otherwise
|
|
``None``.
|
|
"""
|
|
self._raise_if_unacknowledged("upserted_id")
|
|
return self.__raw_result.get("upserted")
|
|
|
|
|
|
class DeleteResult(_WriteResult):
|
|
"""The return type for :meth:`~pymongo.collection.Collection.delete_one`
|
|
and :meth:`~pymongo.collection.Collection.delete_many`
|
|
"""
|
|
|
|
__slots__ = ("__raw_result",)
|
|
|
|
def __init__(self, raw_result: Dict[str, Any], acknowledged: bool) -> None:
|
|
self.__raw_result = raw_result
|
|
super().__init__(acknowledged)
|
|
|
|
@property
|
|
def raw_result(self) -> Dict[str, Any]:
|
|
"""The raw result document returned by the server."""
|
|
return self.__raw_result
|
|
|
|
@property
|
|
def deleted_count(self) -> int:
|
|
"""The number of documents deleted."""
|
|
self._raise_if_unacknowledged("deleted_count")
|
|
return self.__raw_result.get("n", 0)
|
|
|
|
|
|
class BulkWriteResult(_WriteResult):
|
|
"""An object wrapper for bulk API write results."""
|
|
|
|
__slots__ = ("__bulk_api_result",)
|
|
|
|
def __init__(self, bulk_api_result: Dict[str, Any], acknowledged: bool) -> None:
|
|
"""Create a BulkWriteResult instance.
|
|
|
|
:Parameters:
|
|
- `bulk_api_result`: A result dict from the bulk API
|
|
- `acknowledged`: Was this write result acknowledged? If ``False``
|
|
then all properties of this object will raise
|
|
:exc:`~pymongo.errors.InvalidOperation`.
|
|
"""
|
|
self.__bulk_api_result = bulk_api_result
|
|
super().__init__(acknowledged)
|
|
|
|
@property
|
|
def bulk_api_result(self) -> Dict[str, Any]:
|
|
"""The raw bulk API result."""
|
|
return self.__bulk_api_result
|
|
|
|
@property
|
|
def inserted_count(self) -> int:
|
|
"""The number of documents inserted."""
|
|
self._raise_if_unacknowledged("inserted_count")
|
|
return cast(int, self.__bulk_api_result.get("nInserted"))
|
|
|
|
@property
|
|
def matched_count(self) -> int:
|
|
"""The number of documents matched for an update."""
|
|
self._raise_if_unacknowledged("matched_count")
|
|
return cast(int, self.__bulk_api_result.get("nMatched"))
|
|
|
|
@property
|
|
def modified_count(self) -> int:
|
|
"""The number of documents modified."""
|
|
self._raise_if_unacknowledged("modified_count")
|
|
return cast(int, self.__bulk_api_result.get("nModified"))
|
|
|
|
@property
|
|
def deleted_count(self) -> int:
|
|
"""The number of documents deleted."""
|
|
self._raise_if_unacknowledged("deleted_count")
|
|
return cast(int, self.__bulk_api_result.get("nRemoved"))
|
|
|
|
@property
|
|
def upserted_count(self) -> int:
|
|
"""The number of documents upserted."""
|
|
self._raise_if_unacknowledged("upserted_count")
|
|
return cast(int, self.__bulk_api_result.get("nUpserted"))
|
|
|
|
@property
|
|
def upserted_ids(self) -> Optional[Dict[int, Any]]:
|
|
"""A map of operation index to the _id of the upserted document."""
|
|
self._raise_if_unacknowledged("upserted_ids")
|
|
if self.__bulk_api_result:
|
|
return {upsert["index"]: upsert["_id"] for upsert in self.bulk_api_result["upserted"]}
|
|
return None
|