results
– Result class definitions¶
Result class definitions.
- class pymongo.results.BulkWriteResult(bulk_api_result, acknowledged)¶
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 raiseInvalidOperation
.
- property acknowledged¶
Is this the result of an acknowledged write operation?
The
acknowledged
attribute will beFalse
when usingWriteConcern(w=0)
, otherwiseTrue
.Note
If the
acknowledged
attribute isFalse
all other attibutes of this class will raiseInvalidOperation
when accessed. Values for other attributes cannot be determined if the write operation was unacknowledged.See also
- property bulk_api_result¶
The raw bulk API result.
- property deleted_count¶
The number of documents deleted.
- property inserted_count¶
The number of documents inserted.
- property matched_count¶
The number of documents matched for an update.
- property modified_count¶
The number of documents modified.
Note
modified_count is only reported by MongoDB 2.6 and later. When connected to an earlier server version, or in certain mixed version sharding configurations, this attribute will be set to
None
.
- property upserted_count¶
The number of documents upserted.
- property upserted_ids¶
A map of operation index to the _id of the upserted document.
- class pymongo.results.DeleteResult(raw_result, acknowledged)¶
The return type for
delete_one()
anddelete_many()
- property acknowledged¶
Is this the result of an acknowledged write operation?
The
acknowledged
attribute will beFalse
when usingWriteConcern(w=0)
, otherwiseTrue
.Note
If the
acknowledged
attribute isFalse
all other attibutes of this class will raiseInvalidOperation
when accessed. Values for other attributes cannot be determined if the write operation was unacknowledged.See also
- property deleted_count¶
The number of documents deleted.
- property raw_result¶
The raw result document returned by the server.
- class pymongo.results.InsertManyResult(inserted_ids, acknowledged)¶
The return type for
insert_many()
.- property acknowledged¶
Is this the result of an acknowledged write operation?
The
acknowledged
attribute will beFalse
when usingWriteConcern(w=0)
, otherwiseTrue
.Note
If the
acknowledged
attribute isFalse
all other attibutes of this class will raiseInvalidOperation
when accessed. Values for other attributes cannot be determined if the write operation was unacknowledged.See also
- property inserted_ids¶
A list of _ids of the inserted documents, in the order provided.
Note
If
False
is passed for the ordered parameter toinsert_many()
the server may have inserted the documents in a different order than what is presented here.
- class pymongo.results.InsertOneResult(inserted_id, acknowledged)¶
The return type for
insert_one()
.- property acknowledged¶
Is this the result of an acknowledged write operation?
The
acknowledged
attribute will beFalse
when usingWriteConcern(w=0)
, otherwiseTrue
.Note
If the
acknowledged
attribute isFalse
all other attibutes of this class will raiseInvalidOperation
when accessed. Values for other attributes cannot be determined if the write operation was unacknowledged.See also
- property inserted_id¶
The inserted document’s _id.
- class pymongo.results.UpdateResult(raw_result, acknowledged)¶
The return type for
update_one()
,update_many()
, andreplace_one()
.- property acknowledged¶
Is this the result of an acknowledged write operation?
The
acknowledged
attribute will beFalse
when usingWriteConcern(w=0)
, otherwiseTrue
.Note
If the
acknowledged
attribute isFalse
all other attibutes of this class will raiseInvalidOperation
when accessed. Values for other attributes cannot be determined if the write operation was unacknowledged.See also
- property matched_count¶
The number of documents matched for this update.
- property modified_count¶
The number of documents modified.
Note
modified_count is only reported by MongoDB 2.6 and later. When connected to an earlier server version, or in certain mixed version sharding configurations, this attribute will be set to
None
.
- property raw_result¶
The raw result document returned by the server.
- property upserted_id¶
The _id of the inserted document if an upsert took place. Otherwise
None
.