o Sb @sLdZddlmZddlmZmZmZmZmZm Z m Z m Z m Z m Z mZmZddlmZddlmZddlmZddlmZddlmZdd lmZmZmZmZmZdd l m!Z!m"Z"dd l#m$Z$dd l%m&Z&dd l'm(Z(ddl)m*Z*m+Z+ddl,m-Z-m.Z.m/Z/ddl0m1Z1m2Z2ddl3m4Z4m5Z5m6Z6m7Z7ddl8m9Z9ddl:m;Z;ddlZ>m?Z?m@Z@mAZAmBZBmCZCddlDmEZEmFZFddlGmHZHmIZImJZJmKZKmLZLddlMmNZNmOZOmPZPmQZQddlRmSZSddiZTee@e>e=eAeCeBfZUe eeVeeWeVe eVefffZXeeVeXfZYGdddeZZ[erddl\m]Z]ddl^m_Z_ddl`maZaGd d!d!ejbeePZcd"S)#z%Collection level utilities for Mongo.)abc) TYPE_CHECKINGAnyGenericIterableListMappingMutableMappingNoReturnOptionalSequenceTupleUnion) CodecOptions)ObjectId)RawBSONDocument)SON) Timestamp) ASCENDING_csotcommonhelpersmessage)_CollectionAggregationCommand _CollectionRawAggregationCommand)_BulkCollectionChangeStream)validate_collation_or_none) CommandCursorRawBatchCommandCursor)_ecc_coll_name_ecoc_coll_name_esc_coll_name)CursorRawBatchCursor)ConfigurationError InvalidNameInvalidOperationOperationFailure)_check_write_command_response)_UNICODE_REPLACE_CODEC_OPTIONS) DeleteMany DeleteOne IndexModel InsertOne ReplaceOne UpdateMany UpdateOne)ReadPreference _ServerMode)BulkWriteResult DeleteResultInsertManyResultInsertOneResult UpdateResult) _CollationIn _DocumentIn _DocumentType _Pipeline) WriteConcernvaluec@seZdZdZdZ dZdS)ReturnDocumentzAn enum used with :meth:`~pymongo.collection.Collection.find_one_and_replace` and :meth:`~pymongo.collection.Collection.find_one_and_update`. FTN)__name__ __module__ __qualname____doc__BEFOREZAFTERrGrG9/tmp/pip-target-onvjaxws/lib/python/pymongo/collection.pyrAVs rA) ClientSession)Database) ReadConcerncs eZdZdZ      ddddedeedeed eed ee d ed d edde ddffdd Z ddZ ddZ          dddZdddZdeddfddZdeddfdd Zd!d"Zd#e defd$d%Zd#e defd&d'Zdefd(d)Zdefd*d+Zedefd,d-Zedefd.d/Zedd0d1Z    ddeed eed ee d ed ddf d2d3Zej     dd4e e!d5ed6ed edd7ee d8ee"de#fd9d:Z$ dd;d<Z%   dd=e&d6ed edd7ee de'f d>d?Z(ej    dd@e)e&d5ed6ed edd7ee de*f dAdBZ+             ddCdDZ,            ddEdFZ-       ddGe"ee fdHe"ee fdIed6edJee.dKee/d edd8ee"ee fd7ee de0fdLdMZ1        ddGe"ee fdNe2e"ee fe3fdIed6edJee.dOee e"ee fdKee/d edd8ee"ee fd7ee de0fdPdQZ4        ddGe"ee fdNe2e"ee fe3fdIedOee e"ee fd6eedJee.dKee/d edd8ee"ee fd7ee de0fdRdSZ5   dd edd7ee dTee"ee fddfdUdVZ6         ddWdXZ7        ddYdZZ8     ddGe"ee fdJee.dKee/d edd8ee"ee fd7ee de9fd[d\Z:     ddGe"ee fdJee.dKee/d edd8ee"ee fd7ee de9fd]d^Z; ddGee d_e de dee<fd`daZ=d_e de de>e<fdbdcZ?d_e de de@e<fdddeZAdfdgZBdhdiZCdd7ee de defdjdkZD  ddGe"ee fd edd7ee de def dldmZEdndoZF  ddpe eGd edd7ee de deHef dqdrZIejdsdtZJ  ddue/d edd7ee de def dvdwZK  dd edd7ee de ddfdxdyZLej  ddze/d edd7ee de ddf d{d|ZM  dd edd7ee deNeOee ffd}d~ZP  dd edd7ee deOee ffddZQ  dd edd7ee deOee ffddZRej  dddZS   dde3d edd8ee"ee fd7ee de deNe<f ddZT  dde3d edd7ee de de@e<f ddZU           ddee3deedee"ee fdeedeedJee.deeVd eddee"ee fd7ee deedeWe<fddZXej  dded edd7ee de deOee ff ddZY   ddedGee"ee fd edd7ee de deHf ddZZddZ[de\j]ddddfddZ^      ddGe"ee fdee2e"ee fe)efdee_dKee/d edd8ee"ee fd7ee de de| ds>| ds>t d||dd ksJ|d d krPt d |d |vrXt d t | dd} ||_||_d|jj|jf|_|jjdtd|_|jjj|_| dd} |s| s| r| rtd| dddiddi} |t| || d||t| || d||t| || d||j|| | || d|dt fg|dS||| | |dSdS)a/Get / create a Mongo collection. Raises :class:`TypeError` if `name` is not an instance of :class:`basestring` (:class:`str` in python 3). Raises :class:`~pymongo.errors.InvalidName` if `name` is not a valid collection name. Any additional keyword arguments will be used as options passed to the create command. See :meth:`~pymongo.database.Database.create_collection` for valid options. If `create` is ``True``, `collation` is specified, or any additional keyword arguments are present, a ``create`` command will be sent, using ``session`` if specified. Otherwise, a ``create`` command will not be sent and the collection will be created implicitly on first use. The optional ``session`` argument is *only* used for the ``create`` command, it is not associated with the collection afterward. :Parameters: - `database`: the database to get a collection from - `name`: the name of the collection to get - `create` (optional): if ``True``, force collection creation even without options being set - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. If ``None`` (the default) database.codec_options is used. - `read_preference` (optional): The read preference to use. If ``None`` (the default) database.read_preference is used. - `write_concern` (optional): An instance of :class:`~pymongo.write_concern.WriteConcern`. If ``None`` (the default) database.write_concern is used. - `read_concern` (optional): An instance of :class:`~pymongo.read_concern.ReadConcern`. If ``None`` (the default) database.read_concern is used. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. If a collation is provided, it will be passed to the create collection command. - `session` (optional): a :class:`~pymongo.client_session.ClientSession` that is used with the create collection command - `**kwargs` (optional): additional keyword arguments will be passed as options for the create collection command .. versionchanged:: 4.2 Added the ``clusteredIndex`` and ``encryptedFields`` parameters. .. versionchanged:: 4.0 Removed the reindex, map_reduce, inline_map_reduce, parallel_scan, initialize_unordered_bulk_op, initialize_ordered_bulk_op, group, count, insert, save, update, remove, find_and_modify, and ensure_index methods. See the :ref:`pymongo4-migration-guide`. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Support the `collation` option. .. versionchanged:: 3.2 Added the read_concern option. .. versionchanged:: 3.0 Added the codec_options, read_preference, and write_concern options. Removed the uuid_subtype attribute. :class:`~pymongo.collection.Collection` no longer returns an instance of :class:`~pymongo.collection.Collection` for attribute names with leading underscores. You must use dict-style lookups instead:: collection['__my_collection__'] Not: collection.__my_collection__ .. seealso:: The MongoDB documentation on `collections `_. zname must be an instance of str.. collection names cannot be empty$ oplog.$mainz$cmdz)collection names must not contain '$': %rr.z3collection names must not start or end with '.': %rz4collection names must not contain the null character collationN%s.%sreplace)Zunicode_decode_error_handlerZdocument_classencryptedFieldsencrypted_fieldsZclusteredIndex_idr@T)keyunique)rcZ__safeContent__)!superrL__init__rQrRrSrT isinstancestr TypeErrorr' startswithrpop_Collection__database_Collection__namerO_Collection__full_name_replacedict)_Collection__write_response_codec_optionsclientoptionstimeout_timeoutrvalidate_is_mapping_Collection__creater#r!r" create_indexr) selfrMrOrPrQrRrSrTrUrVr_rcopts __class__rGrHrhmsH Y        zCollection.__init__cCs|jj|||SN)rnrt_socket_for_reads_read_preference_forr{rUrGrGrHrszCollection._socket_for_readscCs|jj|Sr)rnrt_socket_for_writesrrGrGrHrszCollection._socket_for_writesTc Csp|jj| '} |j|jj||p|| |p|j||||d| | |jj| | dWdS1s1wYdS)aInternal command helper. :Parameters: - `sock_info` - A SocketInfo instance. - `command` - The command itself, as a :class:`~bson.son.SON` instance. - `codec_options` (optional) - An instance of :class:`~bson.codec_options.CodecOptions`. - `check`: raise OperationFailure if there are errors - `allowable_errors`: errors to ignore if `check` is True - `read_concern` (optional) - An instance of :class:`~pymongo.read_concern.ReadConcern`. - `write_concern`: An instance of :class:`~pymongo.write_concern.WriteConcern`. - `collation` (optional) - An instance of :class:`~pymongo.collation.Collation`. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `retryable_write` (optional): True if this command is a retryable write. - `user_fields` (optional): Response fields that should be decoded using the TypeDecoders from codec_options, passed to bson._decode_all_selective. :Returns: The result document. T)rTrSparse_write_concern_errorr_rUrtretryable_write user_fieldsN)rnrt _tmp_sessioncommandrOrrQ)r{ sock_inforrRrQcheckallowable_errorsrTrSr_rUrrsrGrGrH_commands$) $zCollection._commandc Cstd|fg}|r ||d<|r d|vrt|d|d<||||}|j||tj||||dWddS1s@wYdS)z.Sends a create command with the given options.rPrbsize)rRrSr_rUN)rfloatupdaterrr3PRIMARY_write_concern_for)r{rOrur_rUrccmdrrGrGrHZ__create.s"  "zCollection.__createzCollection[_DocumentType]cCs4|drd|j|f}td|||f||S)zGet a sub-collection of this collection by name. Raises InvalidName if an invalid collection name is used. :Parameters: - `name`: the name of the collection to get _r`zPCollection has no attribute %r. To access the %s collection, use database['%s'].)rlroAttributeError __getitem__)r{rO full_namerGrGrH __getattr__Bs  zCollection.__getattr__cCs(t|jd|j|fd|j|j|j|jS)Nr`FrLrnrorQrRrSrT)r{rOrGrGrHrRs zCollection.__getitem__cCsd|j|jfS)NzCollection(%r, %r))rnror{rGrGrH__repr__]zCollection.__repr__othercCs&t|tr|j|jko|j|jkStSr)rirLrnrMrorONotImplementedr{rrGrGrH__eq__`s zCollection.__eq__cCs ||k SrrGrrGrGrH__ne__es zCollection.__ne__cCst|j|jfSr)hashrnrorrGrGrH__hash__hrzCollection.__hash__cCtd)Nz{Collection objects do not implement truth value testing or bool(). Please compare with None instead: collection is not None)NotImplementedErrorrrGrGrH__bool__kszCollection.__bool__cC|jS)zzThe full name of this :class:`Collection`. The full name is of the form `database_name.collection_name`. )rprrGrGrHrrszCollection.full_namecCr)z%The name of this :class:`Collection`.)rorrGrGrHrOzszCollection.namecCr)zdThe :class:`~pymongo.database.Database` that this :class:`Collection` is a part of. )rnrrGrGrHrMszCollection.databasecCs0t|j|jd|p |j|p|j|p|j|p|jS)a0Get a clone of this collection changing the specified settings. >>> coll1.read_preference Primary() >>> from pymongo import ReadPreference >>> coll2 = coll1.with_options(read_preference=ReadPreference.SECONDARY) >>> coll1.read_preference Primary() >>> coll2.read_preference Secondary(tag_sets=None) :Parameters: - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. If ``None`` (the default) the :attr:`codec_options` of this :class:`Collection` is used. - `read_preference` (optional): The read preference to use. If ``None`` (the default) the :attr:`read_preference` of this :class:`Collection` is used. See :mod:`~pymongo.read_preferences` for options. - `write_concern` (optional): An instance of :class:`~pymongo.write_concern.WriteConcern`. If ``None`` (the default) the :attr:`write_concern` of this :class:`Collection` is used. - `read_concern` (optional): An instance of :class:`~pymongo.read_concern.ReadConcern`. If ``None`` (the default) the :attr:`read_concern` of this :class:`Collection` is used. Fr)r{rQrRrSrTrGrGrH with_optionss$zCollection.with_optionsrequestsorderedbypass_document_validationcommentletc Cstd|t|||||d}|D]}z||Wqty(td|fw||} || |} | dur=t| dStidS)a3 Send a batch of write operations to the server. Requests are passed as a list of write operation instances ( :class:`~pymongo.operations.InsertOne`, :class:`~pymongo.operations.UpdateOne`, :class:`~pymongo.operations.UpdateMany`, :class:`~pymongo.operations.ReplaceOne`, :class:`~pymongo.operations.DeleteOne`, or :class:`~pymongo.operations.DeleteMany`). >>> for doc in db.test.find({}): ... print(doc) ... {'x': 1, '_id': ObjectId('54f62e60fba5226811f634ef')} {'x': 1, '_id': ObjectId('54f62e60fba5226811f634f0')} >>> # DeleteMany, UpdateOne, and UpdateMany are also available. ... >>> from pymongo import InsertOne, DeleteOne, ReplaceOne >>> requests = [InsertOne({'y': 1}), DeleteOne({'x': 1}), ... ReplaceOne({'w': 1}, {'z': 1}, upsert=True)] >>> result = db.test.bulk_write(requests) >>> result.inserted_count 1 >>> result.deleted_count 1 >>> result.modified_count 0 >>> result.upserted_ids {2: ObjectId('54f62ee28891e756a6e1abd5')} >>> for doc in db.test.find({}): ... print(doc) ... {'x': 1, '_id': ObjectId('54f62e60fba5226811f634f0')} {'y': 1, '_id': ObjectId('54f62ee2fba5226811f634f1')} {'z': 1, '_id': ObjectId('54f62ee28891e756a6e1abd5')} :Parameters: - `requests`: A list of write operations (see examples above). - `ordered` (optional): If ``True`` (the default) requests will be performed on the server serially, in the order provided. If an error occurs all remaining operations are aborted. If ``False`` requests will be performed on the server in arbitrary order, possibly in parallel, and all operations will be attempted. - `bypass_document_validation`: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. - `let` (optional): Map of parameter names and values. Values must be 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"). :Returns: An instance of :class:`~pymongo.results.BulkWriteResult`. .. seealso:: :ref:`writes-and-ids` .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 4.1 Added ``comment`` parameter. Added ``let`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 3.0 r)rrz%r is not a valid requestNTF) r validate_listrZ _add_to_bulkrrkrexecuter5) r{rrrrUrrblkrequestrSZbulk_api_resultrGrGrH bulk_writes U     zCollection.bulk_writec szpjj}tdjfd|fd|gfg|dur|d<fdd} jj|| |t|ts;| dSdS) z0Internal helper for inserting a single document.insertr documentsNrc s:rdd<|jjjj|jj|d}t|dS)NTbypassDocumentValidationrSrQrUrtr)rrnrOrsrtr*)rUrrresultbypass_doc_valrr{rSrGrH_insert_command"s z/Collection._insert_one.._insert_commandrd) rS acknowledgedrrOrnrt_retryable_writerirget) r{docrrSop_idrrUrrrrGrrH _insert_ones   zCollection._insert_onedocumentc CsRtd|t|tsd|vst|d<||}t|j|d|d|||d|jS)ahInsert a single document. >>> db.test.count_documents({'x': 1}) 0 >>> result = db.test.insert_one({'x': 1}) >>> result.inserted_id ObjectId('54f112defba522406c9cc208') >>> db.test.find_one({'x': 1}) {'x': 1, '_id': ObjectId('54f112defba522406c9cc208')} :Parameters: - `document`: The document to insert. Must be a mutable mapping type. If the document does not have an _id field one will be added automatically. - `bypass_document_validation`: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. :Returns: - An instance of :class:`~pymongo.results.InsertOneResult`. .. seealso:: :ref:`writes-and-ids` .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 3.0 rrdTN)rrSrrrUr) rvalidate_is_document_typerirrrr8rr)r{rrrUrrSrGrGrH insert_one7s 0   zCollection.insert_onerc s|ttjrttjsstdgfdd}||}t||||d}dd|D|_|j||dt |j S)atInsert an iterable of documents. >>> db.test.count_documents({}) 0 >>> result = db.test.insert_many([{'x': i} for i in range(2)]) >>> result.inserted_ids [ObjectId('54f113fffba522406c9cc20e'), ObjectId('54f113fffba522406c9cc20f')] >>> db.test.count_documents({}) 2 :Parameters: - `documents`: A iterable of documents to insert. - `ordered` (optional): If ``True`` (the default) documents will be inserted on the server serially, in the order provided. If an error occurs all remaining inserts are aborted. If ``False``, documents will be inserted on the server in arbitrary order, possibly in parallel, and all document inserts will be attempted. - `bypass_document_validation`: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. :Returns: An instance of :class:`~pymongo.results.InsertManyResult`. .. seealso:: :ref:`writes-and-ids` .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 3.0 z"documents must be a non-empty listc3sRD]#}td|t|ts d|vrt|d<|dtj|fVqdS)z6A generator that validates documents and handles _ids.rrdN)rrrirrappendrZ_INSERT)rrZ inserted_idsrGrHgens   z#Collection.insert_many..gen)rcSsg|]}|qSrGrG).0rrGrGrH sz*Collection.insert_many..rU) rirrrrkrropsrr7r) r{rrrrUrrrSrrGrrH insert_manyys 6   zCollection.insert_manyc Cstd|t| } |p|j}|j}td|fd|fd|fd|fg}| dur0|s,td| |d<| dur>|s:td| |d <| dur[|sM|jd krMtd t| t sWt | } | |d <td |j fd|fd|gfg}|durxt d|||d<|dur||d<| rd|d<|j|jj |||j| |jj|d}t||drd|vrd|d<nd|d<d|vr|ddd|d<|sdS|S)!Internal update / replace helper.upsertqumultiN3Collation is unsupported for unacknowledged writes.r_6arrayFilters is unsupported for unacknowledged writes. arrayFilterszPMust be connected to MongoDB 4.2+ to use hint on unacknowledged update commands.hintrrZupdatesrrTrrnZupsertedZupdatedExistingFrrd)rvalidate_booleanrrSrrr&max_wire_versionrirjr_index_documentrOrxrrnrsrtcopyr*r)r{rcriteriarrrrSrrrr_ array_filtersrrUrrrrZ update_docrrrGrGrH_updatesb        zCollection._updatecsF fdd} jj p jjo || S)rcs* j|  ||dS)N) rrrSrrrr_rrrUrrr)rrUrrrrr_rrrrrrrrr{rrSrGrHr)s$z-Collection._update_retryable.._updaternrtrrSr)r{rrrrrSrrrr_rrrUrrrrGrrH_update_retryables&zCollection._update_retryablefilter replacementrr_rc CsZtd|t||durtd|||} t|j|||| |||||| d | jS)a Replace a single document matching the filter. >>> for doc in db.test.find({}): ... print(doc) ... {'x': 1, '_id': ObjectId('54f4c5befba5220aa4d6dee7')} >>> result = db.test.replace_one({'x': 1}, {'y': 1}) >>> result.matched_count 1 >>> result.modified_count 1 >>> for doc in db.test.find({}): ... print(doc) ... {'y': 1, '_id': ObjectId('54f4c5befba5220aa4d6dee7')} The *upsert* option can be used to insert a new document if a matching document does not exist. >>> result = db.test.replace_one({'x': 1}, {'x': 1}, True) >>> result.matched_count 0 >>> result.modified_count 0 >>> result.upserted_id ObjectId('54f11e5c8891e756a6e1abd4') >>> db.test.find_one({'x': 1}) {'x': 1, '_id': ObjectId('54f11e5c8891e756a6e1abd4')} :Parameters: - `filter`: A query that matches the document to replace. - `replacement`: The new document. - `upsert` (optional): If ``True``, perform an insert if no documents match the filter. - `bypass_document_validation`: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. :Returns: - An instance of :class:`~pymongo.results.UpdateResult`. .. versionchanged:: 4.1 Added ``let`` parameter. Added ``comment`` parameter. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the `collation` option. .. versionchanged:: 3.2 Added bypass_document_validation support. .. versionadded:: 3.0 rNr)rSrr_rrUrr)rrxvalidate_ok_for_replacerr9rr) r{rrrrr_rrUrrrSrGrGrH replace_oneAs( R    zCollection.replace_onerrc CsTtd|t|td|||} t|j|||| |||||| | d | jS)a Update a single document matching the filter. >>> for doc in db.test.find(): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> result = db.test.update_one({'x': 1}, {'$inc': {'x': 3}}) >>> result.matched_count 1 >>> result.modified_count 1 >>> for doc in db.test.find(): ... print(doc) ... {'x': 4, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} If ``upsert=True`` and no documents match the filter, create a new document based on the filter criteria and update modifications. >>> result = db.test.update_one({'x': -10}, {'$inc': {'x': 3}}, upsert=True) >>> result.matched_count 0 >>> result.modified_count 0 >>> result.upserted_id ObjectId('626a678eeaa80587d4bb3fb7') >>> db.test.find_one(result.upserted_id) {'_id': ObjectId('626a678eeaa80587d4bb3fb7'), 'x': -7} :Parameters: - `filter`: A query that matches the document to update. - `update`: The modifications to apply. - `upsert` (optional): If ``True``, perform an insert if no documents match the filter. - `bypass_document_validation`: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `array_filters` (optional): A list of filters specifying which array elements an update should apply. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. :Returns: - An instance of :class:`~pymongo.results.UpdateResult`. .. versionchanged:: 4.1 Added ``let`` parameter. Added ``comment`` parameter. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.9 Added the ability to accept a pipeline as the ``update``. .. versionchanged:: 3.6 Added the ``array_filters`` and ``session`` parameters. .. versionchanged:: 3.4 Added the ``collation`` option. .. versionchanged:: 3.2 Added ``bypass_document_validation`` support. .. versionadded:: 3.0 rr)rSrr_rrrUrrrrxvalidate_ok_for_updatevalidate_list_or_nonerr9rr) r{rrrrr_rrrUrrrSrGrGrH update_ones( \    zCollection.update_onec CsVtd|t|td|||} t|j|||d| |||||| | d | jS)a Update one or more documents that match the filter. >>> for doc in db.test.find(): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> result = db.test.update_many({'x': 1}, {'$inc': {'x': 3}}) >>> result.matched_count 3 >>> result.modified_count 3 >>> for doc in db.test.find(): ... print(doc) ... {'x': 4, '_id': 0} {'x': 4, '_id': 1} {'x': 4, '_id': 2} :Parameters: - `filter`: A query that matches the documents to update. - `update`: The modifications to apply. - `upsert` (optional): If ``True``, perform an insert if no documents match the filter. - `bypass_document_validation` (optional): If ``True``, allows the write to opt-out of document level validation. Default is ``False``. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `array_filters` (optional): A list of filters specifying which array elements an update should apply. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. :Returns: - An instance of :class:`~pymongo.results.UpdateResult`. .. versionchanged:: 4.1 Added ``let`` parameter. Added ``comment`` parameter. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.9 Added the ability to accept a pipeline as the `update`. .. versionchanged:: 3.6 Added ``array_filters`` and ``session`` parameters. .. versionchanged:: 3.4 Added the `collation` option. .. versionchanged:: 3.2 Added bypass_document_validation support. .. versionadded:: 3.0 rrT) rrSrr_rrrUrrr) r{rrrrrr_rrUrrrSrGrGrH update_manys* O   zCollection.update_manyrccCs:|jj|jj|j|j|j|j}|j|j |||ddS)amAlias for :meth:`~pymongo.database.Database.drop_collection`. :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. - `encrypted_fields`: **(BETA)** Document that describes the encrypted fields for Queryable Encryption. The following two calls are equivalent: >>> db.foo.drop() >>> db.drop_collection("foo") .. versionchanged:: 4.2 Added ``encrypted_fields`` parameter. .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.7 :meth:`drop` now respects this :class:`Collection`'s :attr:`write_concern`. .. versionchanged:: 3.6 Added ``session`` parameter. )rUrrcN) rnrt get_databaserOrQrRrSrTZdrop_collectionro)r{rUrrcdborGrGrHdrops!  zCollection.dropc  Cs td||p |j}|j} td|fdt| fg}t|}|dur-| s)td||d<|durJ| s<|jdkr f dd} jj pjjo | |S)rcs"j| ||d S)N) rSrrr_rrUrrr)rr r_rrrrrrrr{rSrGrHrsz-Collection._delete_retryable.._deleter) r{rrrSrrr_rrUrrrrGrrH_delete_retryableszCollection._delete_retryablec C,||}t|j|d||||||d|jS)aDelete a single document matching the filter. >>> db.test.count_documents({'x': 1}) 3 >>> result = db.test.delete_one({'x': 1}) >>> result.deleted_count 1 >>> db.test.count_documents({'x': 1}) 2 :Parameters: - `filter`: A query that matches the document to delete. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. :Returns: - An instance of :class:`~pymongo.results.DeleteResult`. .. versionchanged:: 4.1 Added ``let`` parameter. Added ``comment`` parameter. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the `collation` option. .. versionadded:: 3.0 FrSr_rrUrrrr6rrr{rr_rrUrrrSrGrGrH delete_one 4 zCollection.delete_onec Cr)aDelete one or more documents matching the filter. >>> db.test.count_documents({'x': 1}) 3 >>> result = db.test.delete_many({'x': 1}) >>> result.deleted_count 3 >>> db.test.count_documents({'x': 1}) 0 :Parameters: - `filter`: A query that matches the documents to delete. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. :Returns: - An instance of :class:`~pymongo.results.DeleteResult`. .. versionchanged:: 4.1 Added ``let`` parameter. Added ``comment`` parameter. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the `collation` option. .. versionadded:: 3.0 TrrrrGrGrH delete_manyJrzCollection.delete_manyargscOsN|durt|tjsd|i}|j|g|Ri|}|dD]}|SdS)aGet a single document from the database. All arguments to :meth:`find` are also valid arguments for :meth:`find_one`, although any `limit` argument will be ignored. Returns a single document, or ``None`` if no matching document is found. The :meth:`find_one` method obeys the :attr:`read_preference` of this :class:`Collection`. :Parameters: - `filter` (optional): a dictionary specifying the query to be performed OR any other type to be used as the value for a query for ``"_id"``. - `*args` (optional): any additional positional arguments are the same as the arguments to :meth:`find`. - `**kwargs` (optional): any additional keyword arguments are the same as the arguments to :meth:`find`. >>> collection.find_one(max_time_ms=100) Nrdr])rirrfindr)r{rrrVcursorrrGrGrHfind_ones zCollection.find_onecOst|g|Ri|S)a1)Query the database. The `filter` argument is a query document that all results must match. For example: >>> db.test.find({"hello": "world"}) only matches documents that have a key "hello" with value "world". Matches can have other keys *in addition* to "hello". The `projection` argument is used to specify a subset of fields that should be included in the result documents. By limiting results to a certain subset of fields you can cut down on network traffic and decoding time. Raises :class:`TypeError` if any of the arguments are of improper type. Returns an instance of :class:`~pymongo.cursor.Cursor` corresponding to this query. The :meth:`find` method obeys the :attr:`read_preference` of this :class:`Collection`. :Parameters: - `filter` (optional): A query document that selects which documents to include in the result set. Can be an empty document to include all documents. - `projection` (optional): a list of field names that should be returned in the result set or a dict specifying the fields to include or exclude. If `projection` is a list "_id" will always be returned. Use a dict to exclude fields from the result (e.g. projection={'_id': False}). - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `skip` (optional): the number of documents to omit (from the start of the result set) when returning the results - `limit` (optional): the maximum number of results to return. A limit of 0 (the default) is equivalent to setting no limit. - `no_cursor_timeout` (optional): if False (the default), any returned cursor is closed by the server after 10 minutes of inactivity. If set to True, the returned cursor will never time out on the server. Care should be taken to ensure that cursors with no_cursor_timeout turned on are properly closed. - `cursor_type` (optional): the type of cursor to return. The valid options are defined by :class:`~pymongo.cursor.CursorType`: - :attr:`~pymongo.cursor.CursorType.NON_TAILABLE` - the result of this find call will return a standard cursor over the result set. - :attr:`~pymongo.cursor.CursorType.TAILABLE` - the result of this find call will be a tailable cursor - tailable cursors are only for use with capped collections. They are not closed when the last data is retrieved but are kept open and the cursor location marks the final document position. If more data is received iteration of the cursor will continue from the last document received. For details, see the `tailable cursor documentation `_. - :attr:`~pymongo.cursor.CursorType.TAILABLE_AWAIT` - the result of this find call will be a tailable cursor with the await flag set. The server will wait for a few seconds after returning the full result set so that it can capture and return additional data added during the query. - :attr:`~pymongo.cursor.CursorType.EXHAUST` - the result of this find call will be an exhaust cursor. MongoDB will stream batched results to the client without waiting for the client to request each batch, reducing latency. See notes on compatibility below. - `sort` (optional): a list of (key, direction) pairs specifying the sort order for this query. See :meth:`~pymongo.cursor.Cursor.sort` for details. - `allow_partial_results` (optional): if True, mongos will return partial results if some shards are down instead of returning an error. - `oplog_replay` (optional): **DEPRECATED** - if True, set the oplogReplay query flag. Default: False. - `batch_size` (optional): Limits the number of documents returned in a single batch. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `return_key` (optional): If True, return only the index keys in each document. - `show_record_id` (optional): If True, adds a field ``$recordId`` in each document with the storage engine's internal record identifier. - `snapshot` (optional): **DEPRECATED** - If True, prevents the cursor from returning a document more than once because of an intervening write operation. - `hint` (optional): An index, in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). Pass this as an alternative to calling :meth:`~pymongo.cursor.Cursor.hint` on the cursor to tell Mongo the proper index to use for the query. - `max_time_ms` (optional): Specifies a time limit for a query operation. If the specified time is exceeded, the operation will be aborted and :exc:`~pymongo.errors.ExecutionTimeout` is raised. Pass this as an alternative to calling :meth:`~pymongo.cursor.Cursor.max_time_ms` on the cursor. - `max_scan` (optional): **DEPRECATED** - The maximum number of documents to scan. Pass this as an alternative to calling :meth:`~pymongo.cursor.Cursor.max_scan` on the cursor. - `min` (optional): A list of field, limit pairs specifying the inclusive lower bound for all keys of a specific index in order. Pass this as an alternative to calling :meth:`~pymongo.cursor.Cursor.min` on the cursor. ``hint`` must also be passed to ensure the query utilizes the correct index. - `max` (optional): A list of field, limit pairs specifying the exclusive upper bound for all keys of a specific index in order. Pass this as an alternative to calling :meth:`~pymongo.cursor.Cursor.max` on the cursor. ``hint`` must also be passed to ensure the query utilizes the correct index. - `comment` (optional): A string to attach to the query to help interpret and trace the operation in the server logs and in profile data. Pass this as an alternative to calling :meth:`~pymongo.cursor.Cursor.comment` on the cursor. - `allow_disk_use` (optional): if True, MongoDB may use temporary disk files to store data exceeding the system memory limit while processing a blocking sort operation. The option has no effect if MongoDB can satisfy the specified sort using an index, or if the blocking sort requires less memory than the 100 MiB limit. This option is only supported on MongoDB 4.4 and above. .. note:: There are a number of caveats to using :attr:`~pymongo.cursor.CursorType.EXHAUST` as cursor_type: - The `limit` option can not be used with an exhaust cursor. - Exhaust cursors are not supported by mongos and can not be used with a sharded cluster. - A :class:`~pymongo.cursor.Cursor` instance created with the :attr:`~pymongo.cursor.CursorType.EXHAUST` cursor_type requires an exclusive :class:`~socket.socket` connection to MongoDB. If the :class:`~pymongo.cursor.Cursor` is discarded without being completely iterated the underlying :class:`~socket.socket` connection will be closed and discarded without being returned to the connection pool. .. versionchanged:: 4.0 Removed the ``modifiers`` option. Empty projections (eg {} or []) are passed to the server as-is, rather than the previous behavior which substituted in a projection of ``{"_id": 1}``. This means that an empty projection will now return the entire document, not just the ``"_id"`` field. .. versionchanged:: 3.11 Added the ``allow_disk_use`` option. Deprecated the ``oplog_replay`` option. Support for this option is deprecated in MongoDB 4.4. The query engine now automatically optimizes queries against the oplog without requiring this option to be set. .. versionchanged:: 3.7 Deprecated the ``snapshot`` option, which is deprecated in MongoDB 3.6 and removed in MongoDB 4.0. Deprecated the ``max_scan`` option. Support for this option is deprecated in MongoDB 4.0. Use ``max_time_ms`` instead to limit server-side execution time. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.5 Added the options ``return_key``, ``show_record_id``, ``snapshot``, ``hint``, ``max_time_ms``, ``max_scan``, ``min``, ``max``, and ``comment``. Deprecated the ``modifiers`` option. .. versionchanged:: 3.4 Added support for the ``collation`` option. .. versionchanged:: 3.0 Changed the parameter names ``spec``, ``fields``, ``timeout``, and ``partial`` to ``filter``, ``projection``, ``no_cursor_timeout``, and ``allow_partial_results`` respectively. Added the ``cursor_type``, ``oplog_replay``, and ``modifiers`` options. Removed the ``network_timeout``, ``read_preference``, ``tag_sets``, ``secondary_acceptable_latency_ms``, ``max_scan``, ``snapshot``, ``tailable``, ``await_data``, ``exhaust``, ``as_class``, and slave_okay parameters. Removed ``compile_re`` option: PyMongo now always represents BSON regular expressions as :class:`~bson.regex.Regex` objects. Use :meth:`~bson.regex.Regex.try_compile` to attempt to convert from a BSON regular expression to a Python regular expression object. Soft deprecated the ``manipulate`` option. .. seealso:: The MongoDB documentation on `find `_. )r$r{rrVrGrGrHrs>> import bson >>> cursor = db.test.find_raw_batches() >>> for batch in cursor: ... print(bson.decode_all(batch)) .. note:: find_raw_batches does not support auto encryption. .. versionchanged:: 3.12 Instead of ignoring the user-specified read concern, this method now sends it to the server when connected to MongoDB 3.6+. Added session support. .. versionadded:: 3.6 z1find_raw_batches does not support auto encryption)rnrt _encrypterr(r%rrGrGrHfind_raw_batchesms zCollection.find_raw_batchesc Cs@|j|||dg|j|j||d}|dddkrdSt|dS)zInternal count command helper.z ns missing)rRrrQrTr_rUerrmsgrr)rrsrTrr)r{rUrrRrr_resrGrGrH _count_cmds  zCollection._count_cmdc CsH|j|||dg|j|j||d}d|vrdS|dd}|r"|dSdS)zAInternal helper to run an aggregate that returns a single result.)rrQrTr_rUrN firstBatchr)rrsrT)r{rrRrr_rUrbatchrGrGrH_aggregate_one_results  z Collection._aggregate_one_resultc s:dvrtd|dur|d<fdd}|dS)aGet an estimate of the number of documents in this collection using collection metadata. The :meth:`estimated_document_count` method is **not** supported in a transaction. All optional parameters should be passed as keyword arguments to this method. Valid options include: - `maxTimeMS` (int): The maximum amount of time to allow this operation to run, in milliseconds. :Parameters: - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): See list of options above. .. versionchanged:: 4.2 This method now always uses the `count`_ command. Due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command was not included in V1 of the :ref:`versioned-api-ref`. Users of the Stable API with estimated_document_count are recommended to upgrade their server version to 5.0.9+ or set :attr:`pymongo.server_api.ServerApi.strict` to ``False`` to avoid encountering errors. .. versionadded:: 3.7 .. _count: https://mongodb.com/docs/manual/reference/command/count/ rUz2estimated_document_count does not support sessionsNrcs.tdjfg}|j||||ddS)Ncount)r_)rrorr)rUserverrrRrrVr{rGrH_cmds z1Collection.estimated_document_count.._cmd)r&_retryable_non_cursor_read)r{rrVrrGrrHestimated_document_counts  z#Collection.estimated_document_countc sd|ig}d|vr|d|did|vr!|d|di|dur)||d<|dd d d id itd jfd |fdifgd|vrWt|dtsWt|d|d<t|dd |fdd} ||S)a Count the number of documents in this collection. .. note:: For a fast count of the total documents in a collection see :meth:`estimated_document_count`. The :meth:`count_documents` method is supported in a transaction. All optional parameters should be passed as keyword arguments to this method. Valid options include: - `skip` (int): The number of matching documents to skip before returning results. - `limit` (int): The maximum number of documents to count. Must be a positive integer. If not provided, no limit is imposed. - `maxTimeMS` (int): The maximum amount of time to allow this operation to run, in milliseconds. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `hint` (string or list of tuples): The index to use. Specify either the index name as a string or the index specification as a list of tuples (e.g. [('a', pymongo.ASCENDING), ('b', pymongo.ASCENDING)]). The :meth:`count_documents` method obeys the :attr:`read_preference` of this :class:`Collection`. .. note:: When migrating from :meth:`count` to :meth:`count_documents` the following query operators must be replaced: +-------------+-------------------------------------+ | Operator | Replacement | +=============+=====================================+ | $where | `$expr`_ | +-------------+-------------------------------------+ | $near | `$geoWithin`_ with `$center`_ | +-------------+-------------------------------------+ | $nearSphere | `$geoWithin`_ with `$centerSphere`_ | +-------------+-------------------------------------+ :Parameters: - `filter` (required): A query document that selects which documents to count in the collection. Can be an empty document to count all documents. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): See list of options above. .. versionadded:: 3.7 .. _$expr: https://mongodb.com/docs/manual/reference/operator/query/expr/ .. _$geoWithin: https://mongodb.com/docs/manual/reference/operator/query/geoWithin/ .. _$center: https://mongodb.com/docs/manual/reference/operator/query/center/ .. _$centerSphere: https://mongodb.com/docs/manual/reference/operator/query/centerSphere/ z$matchskipz$skiprz$limitNrz$groupr@z$sum)rdr aggregatepipelinerrr_cs"|||}|s dS|dS)Nrr)r )rUr rrRrrr_r{rGrHr%sz(Collection.count_documents.._cmd) rrmrrorirjrrrrr)r{rrUrrVrrrGrrHcount_documentss ?  zCollection.count_documentscCsJ|jj}||}|||||WdS1swYdS)z;Non-cursor read helper to handle implicit session creation.N)rnrtr_retryable_readr)r{funcrUrtrrGrGrHr-s $z%Collection._retryable_non_cursor_readindexescKs0td||dur||d<|j||fi|S)aCreate one or more indexes on this collection. >>> from pymongo import IndexModel, ASCENDING, DESCENDING >>> index1 = IndexModel([("hello", DESCENDING), ... ("world", ASCENDING)], name="hello_world") >>> index2 = IndexModel([("goodbye", DESCENDING)]) >>> db.test.create_indexes([index1, index2]) ["hello_world", "goodbye_-1"] :Parameters: - `indexes`: A list of :class:`~pymongo.operations.IndexModel` instances. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation. .. versionchanged:: 3.6 Added ``session`` parameter. Added support for arbitrary keyword arguments. .. versionchanged:: 3.4 Apply this collection's write concern automatically to this operation when connected to MongoDB >= 3.4. .. versionadded:: 3.0 .. _createIndexes: https://mongodb.com/docs/manual/reference/command/createIndexes/ rNr)rr_Collection__create_indexes)r{rrUrrVrGrGrHcreate_indexes3s +zCollection.create_indexesc sg||A}|jdk}fdd}td|jfdt|fg}||d|vr1|s1td|j||tj t | ||dWd S1sKwYS) aInternal createIndexes helper. :Parameters: - `indexes`: A list of :class:`~pymongo.operations.IndexModel` instances. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. rc3sBD]}t|tstd|f|j}|d|VqdS)Nz6%r is not an instance of pymongo.operations.IndexModelrO)rir.rkrr)indexrrnamesrGrH gen_indexesss z0Collection.__create_indexes..gen_indexesZ createIndexesrZ commitQuorumzRMust be connected to MongoDB 4.4+ to use the commitQuorum option for createIndexes)rRrQrSrUN) rrrrOlistrr&rr3rr+r)r{rrUrVrZsupports_quorumrrrGrrHZ__create_indexescs,     zCollection.__create_indexeskeyscKsTi}d|vr |d|d<|dur||d<t|fi|}|j|g|fi|dS)aCreates an index on this collection. Takes either a single key or a list of (key, direction) pairs. The key(s) must be an instance of :class:`basestring` (:class:`str` in python 3), and the direction(s) must be one of (:data:`~pymongo.ASCENDING`, :data:`~pymongo.DESCENDING`, :data:`~pymongo.GEO2D`, :data:`~pymongo.GEOSPHERE`, :data:`~pymongo.HASHED`, :data:`~pymongo.TEXT`). To create a single key ascending index on the key ``'mike'`` we just use a string argument:: >>> my_collection.create_index("mike") For a compound index on ``'mike'`` descending and ``'eliot'`` ascending we need to use a list of tuples:: >>> my_collection.create_index([("mike", pymongo.DESCENDING), ... ("eliot", pymongo.ASCENDING)]) All optional index creation parameters should be passed as keyword arguments to this method. For example:: >>> my_collection.create_index([("mike", pymongo.DESCENDING)], ... background=True) Valid options include, but are not limited to: - `name`: custom name to use for this index - if none is given, a name will be generated. - `unique`: if ``True``, creates a uniqueness constraint on the index. - `background`: if ``True``, this index should be created in the background. - `sparse`: if ``True``, omit from the index any documents that lack the indexed field. - `bucketSize`: for use with geoHaystack indexes. Number of documents to group together within a certain proximity to a given longitude and latitude. - `min`: minimum value for keys in a :data:`~pymongo.GEO2D` index. - `max`: maximum value for keys in a :data:`~pymongo.GEO2D` index. - `expireAfterSeconds`: Used to create an expiring (TTL) collection. MongoDB will automatically delete documents from this collection after seconds. The indexed field must be a UTC datetime or the data will not expire. - `partialFilterExpression`: A document that specifies a filter for a partial index. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `wildcardProjection`: Allows users to include or exclude specific field paths from a `wildcard index`_ using the {"$**" : 1} key pattern. Requires MongoDB >= 4.2. - `hidden`: if ``True``, this index will be hidden from the query planner and will not be evaluated as part of query plan selection. Requires MongoDB >= 4.4. See the MongoDB documentation for a full list of supported options by server version. .. warning:: `dropDups` is not supported by MongoDB 3.0 or newer. The option is silently ignored by the server and unique index builds using the option will fail if a duplicate value is detected. .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation. :Parameters: - `keys`: a single key or a list of (key, direction) pairs specifying the index to create - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. arguments - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): any additional index creation options (see the above list) should be passed as keyword .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.11 Added the ``hidden`` option. .. versionchanged:: 3.6 Added ``session`` parameter. Added support for passing maxTimeMS in kwargs. .. versionchanged:: 3.4 Apply this collection's write concern automatically to this operation when connected to MongoDB >= 3.4. Support the `collation` option. .. versionchanged:: 3.2 Added partialFilterExpression to support partial indexes. .. versionchanged:: 3.0 Renamed `key_or_list` to `keys`. Removed the `cache_for` option. :meth:`create_index` no longer caches index names. Removed support for the drop_dups and bucket_size aliases. .. seealso:: The MongoDB documentation on `indexes `_. .. _wildcard index: https://dochub.mongodb.org/core/index-wildcard/ Z maxTimeMSNrr)rmr.r)r{r!rUrrVZ cmd_optionsrrGrGrHrzskzCollection.create_indexcKs(|dur||d<|jdd|i|dS)aDrops all indexes on this collection. Can be used on non-existant collections or collections with no indexes. Raises OperationFailure on an error. :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. arguments - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation. .. versionchanged:: 3.6 Added ``session`` parameter. Added support for arbitrary keyword arguments. .. versionchanged:: 3.4 Apply this collection's write concern automatically to this operation when connected to MongoDB >= 3.4. Nr*rU)r") drop_index)r{rUrrVrGrGrH drop_indexess"zCollection.drop_indexes index_or_namec Ks|}t|tr t|}t|tstdtd|jfd|fg}|||dur-||d<| |}|j ||t j ddg| ||dWddS1sOwYdS) a>Drops the specified index on this collection. Can be used on non-existant collections or collections with no indexes. Raises OperationFailure on an error (e.g. trying to drop an index that does not exist). `index_or_name` can be either an index name (as returned by `create_index`), or an index specifier (as passed to `create_index`). An index specifier should be a list of (key, direction) pairs. Raises TypeError if index is not an instance of (str, unicode, list). .. warning:: if a custom name was used on index creation (by passing the `name` parameter to :meth:`create_index`) the index **must** be dropped by name. :Parameters: - `index_or_name`: index (or name of index) to drop - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation. .. versionchanged:: 3.6 Added ``session`` parameter. Added support for arbitrary keyword arguments. .. versionchanged:: 3.4 Apply this collection's write concern automatically to this operation when connected to MongoDB >= 3.4. z0index_or_name must be an instance of str or listZ dropIndexesrNrz ns not foundr)rRrrSrU)rir rZ_gen_index_namerjrkrrorrrr3rr)r{r%rUrrVrOrrrGrGrHr#(s&0     "zCollection.drop_indexcsttjtjd|r|ptj}|dufdd}jj|d}jj |||WdS1s?wYdS)aGet a cursor over the index documents for this collection. >>> for index in db.test.list_indexes(): ... print(index) ... SON([('v', 2), ('key', SON([('_id', 1)])), ('name', '_id_')]) :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. :Returns: An instance of :class:`~pymongo.command_cursor.CommandCursor`. .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionadded:: 3.0 )rQrRNc stdjfdifg}dur|d<zj||||dd}Wnty>}z|jdkr/dgd}WYd}~nd}~wwt||j||dd}|||S) NZ listIndexesrrrrr)idr )rUexplicit_sessionr) rrorr)coderaddressrZ_maybe_pin_connection)rUr rrRrrexcZ cmd_cursorrQZcollrr'r{rGrHrs2   z%Collection.list_indexes.._cmdF) rrrr3rZ_txn_read_preferencernrtrr)r{rUrZ read_prefrrrGr+rH list_indexesms$zCollection.list_indexescCsJ|j||d}i}|D]}t|d|d<t|}|||d<q |S)aGet information on this collection's indexes. Returns a dictionary where the keys are index names (as returned by create_index()) and the values are dictionaries containing information about each index. The dictionary is guaranteed to contain at least a single key, ``"key"`` which is a list of (key, direction) pairs specifying the index (as passed to create_index()). It will also contain any other metadata about the indexes, except for the ``"ns"`` and ``"name"`` keys, which are cleaned. Example output might look like this: >>> db.test.create_index("x", unique=True) 'x_1' >>> db.test.index_information() {'_id_': {'key': [('_id', 1)]}, 'x_1': {'unique': True, 'key': [('x', 1)]}} :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. )rUrrerO)r,r itemsrrrm)r{rUrrinforrGrGrHindex_informations#zCollection.index_informationcCs||jj|jj|j|j|j|j}|j|d|j i|d}d}|D]}|}|s)iS| di}|dus5Jd|vr<|d=|S)aSGet the options set on this collection. Returns a dictionary of options and their values - see :meth:`~pymongo.database.Database.create_collection` for more information on the possible options. Returns an empty dictionary if the collection has not been created yet. :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. .. versionchanged:: 3.6 Added ``session`` parameter. rO)rUrrNrurP) rnrtrrOrQrRrSrTZlist_collectionsror)r{rUrrrrrrurGrGrHrus*   zCollection.optionsc KsP|dur||d<|||||||dddiid} |jjj| j| ||| j dS)Nrrr r@)r)Z retryable)rnrtrZ get_cursorZget_read_preferenceZ_performs_write) r{Zaggregation_commandrZ cursor_classrUr'rrrVrrGrGrH _aggregate s"   zCollection._aggregatercKsZ|jjj|dd}|jt|tf||du||d|WdS1s&wYdS)aePerform an aggregation using the aggregation framework on this collection. The :meth:`aggregate` method obeys the :attr:`read_preference` of this :class:`Collection`, except when ``$out`` or ``$merge`` are used on MongoDB <5.0, in which case :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY` is used. .. note:: This method does not support the 'explain' option. Please use :meth:`~pymongo.database.Database.command` instead. An example is included in the :ref:`aggregate-examples` documentation. .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation. :Parameters: - `pipeline`: a list of aggregation pipeline stages - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): extra `aggregate command`_ parameters. All optional `aggregate command`_ parameters should be passed as keyword arguments to this method. Valid options include, but are not limited to: - `allowDiskUse` (bool): Enables writing to temporary files. When set to True, aggregation stages can write data to the _tmp subdirectory of the --dbpath directory. The default is False. - `maxTimeMS` (int): The maximum amount of time to allow the operation to run in milliseconds. - `batchSize` (int): The maximum number of documents to return per batch. Ignored if the connected mongod or mongos does not support returning aggregate results using a cursor. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `let` (dict): A dict of parameter names and values. Values must be 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"``). This option is only supported on MongoDB >= 5.0. - `comment` (optional): A user-provided comment to attach to this command. :Returns: A :class:`~pymongo.command_cursor.CommandCursor` over the result set. .. versionchanged:: 4.1 Added ``comment`` parameter. Added ``let`` parameter. Support $merge and $out executing on secondaries according to the collection's :attr:`read_preference`. .. versionchanged:: 4.0 Removed the ``useCursor`` option. .. versionchanged:: 3.9 Apply this collection's read concern to pipelines containing the `$out` stage when connected to MongoDB >= 4.2. Added support for the ``$merge`` pipeline stage. Aggregations that write always use read preference :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY`. .. versionchanged:: 3.6 Added the `session` parameter. Added the `maxAwaitTimeMS` option. Deprecated the `useCursor` option. .. versionchanged:: 3.4 Apply this collection's write concern automatically to this operation when connected to MongoDB >= 3.4. Support the `collation` option. .. versionchanged:: 3.0 The :meth:`aggregate` method always returns a CommandCursor. The pipeline argument must be a list. .. seealso:: :doc:`/examples/aggregation` .. _aggregate command: https://mongodb.com/docs/manual/reference/command/aggregate FcloseN)rUr'rr)rnrtrr0rr)r{rrUrrrVrrGrGrHr' sU$zCollection.aggregatecKsx|jjjr td|dur||d<|jjj|dd}|jt|tf||dud|WdS1s5wYdS)aDPerform an aggregation and retrieve batches of raw BSON. Similar to the :meth:`aggregate` method but returns a :class:`~pymongo.cursor.RawBatchCursor`. This example demonstrates how to work with raw batches, but in practice raw batches should be passed to an external library that can decode BSON into another data type, rather than used with PyMongo's :mod:`bson` module. >>> import bson >>> cursor = db.test.aggregate_raw_batches([ ... {'$project': {'x': {'$multiply': [2, '$x']}}}]) >>> for batch in cursor: ... print(bson.decode_all(batch)) .. note:: aggregate_raw_batches does not support auto encryption. .. versionchanged:: 3.12 Added session support. .. versionadded:: 3.6 z6aggregate_raw_batches does not support auto encryptionNrFr1)rUr')rnrtrr(rr0rr )r{rrUrrVrrGrGrHaggregate_raw_batches s $z Collection.aggregate_raw_batches full_document resume_aftermax_await_time_ms batch_sizestart_at_operation_time start_afterfull_document_before_changec Cst|||||||||| | | S)aWatch changes on this collection. Performs an aggregation with an implicit initial ``$changeStream`` stage and returns a :class:`~pymongo.change_stream.CollectionChangeStream` cursor which iterates over changes on this collection. .. code-block:: python with db.collection.watch() as stream: for change in stream: print(change) The :class:`~pymongo.change_stream.CollectionChangeStream` iterable blocks until the next change document is returned or an error is raised. If the :meth:`~pymongo.change_stream.CollectionChangeStream.next` method encounters a network error when retrieving a batch from the server, it will automatically attempt to recreate the cursor such that no change events are missed. Any error encountered during the resume attempt indicates there may be an outage and will be raised. .. code-block:: python try: with db.collection.watch( [{'$match': {'operationType': 'insert'}}]) as stream: for insert_change in stream: print(insert_change) except pymongo.errors.PyMongoError: # The ChangeStream encountered an unrecoverable error or the # resume attempt failed to recreate the cursor. logging.error('...') For a precise description of the resume process see the `change streams specification`_. .. note:: Using this helper method is preferred to directly calling :meth:`~pymongo.collection.Collection.aggregate` with a ``$changeStream`` stage, for the purpose of supporting resumability. .. warning:: This Collection's :attr:`read_concern` must be ``ReadConcern("majority")`` in order to use the ``$changeStream`` stage. :Parameters: - `pipeline` (optional): A list of aggregation pipeline stages to append to an initial ``$changeStream`` stage. Not all pipeline stages are valid after a ``$changeStream`` stage, see the MongoDB documentation on change streams for the supported stages. - `full_document` (optional): The fullDocument to pass as an option to the ``$changeStream`` stage. Allowed values: 'updateLookup', 'whenAvailable', 'required'. When set to 'updateLookup', the change notification for partial updates will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred. - `full_document_before_change`: Allowed values: 'whenAvailable' and 'required'. Change events may now result in a 'fullDocumentBeforeChange' response field. - `resume_after` (optional): A resume token. If provided, the change stream will start returning changes that occur directly after the operation specified in the resume token. A resume token is the _id value of a change document. - `max_await_time_ms` (optional): The maximum time in milliseconds for the server to wait for changes before responding to a getMore operation. - `batch_size` (optional): The maximum number of documents to return per batch. - `collation` (optional): The :class:`~pymongo.collation.Collation` to use for the aggregation. - `start_at_operation_time` (optional): If provided, the resulting change stream will only return changes that occurred at or after the specified :class:`~bson.timestamp.Timestamp`. Requires MongoDB >= 4.0. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `start_after` (optional): The same as `resume_after` except that `start_after` can resume notifications after an invalidate event. This option and `resume_after` are mutually exclusive. - `comment` (optional): A user-provided comment to attach to this command. :Returns: A :class:`~pymongo.change_stream.CollectionChangeStream` cursor. .. versionchanged:: 4.2 Added ``full_document_before_change`` parameter. .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.9 Added the ``start_after`` parameter. .. versionchanged:: 3.7 Added the ``start_at_operation_time`` parameter. .. versionadded:: 3.6 .. seealso:: The MongoDB documentation on `changeStreams `_. .. _change streams specification: https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst r) r{rr4r5r6r7r_r8rUr9rr:rGrGrHwatch sxzCollection.watchnew_namec Ks2t|ts td|rd|vrtd|ddks|ddkr#tdd|vr0|d s0td d |jj|f}td |jfd |fg}| ||durP||d<| ||}| |4}|jj |}|jd||d||jj dWdWdS1swYWddS1swYdS)aRename this collection. If operating in auth mode, client must be authorized as an admin to perform this operation. Raises :class:`TypeError` if `new_name` is not an instance of :class:`basestring` (:class:`str` in python 3). Raises :class:`~pymongo.errors.InvalidName` if `new_name` is not a valid collection name. :Parameters: - `new_name`: new name for this collection - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): additional arguments to the rename command may be passed as keyword arguments to this helper method (i.e. ``dropTarget=True``) .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Apply this collection's write concern automatically to this operation when connected to MongoDB >= 3.4. z#new_name must be an instance of strrXrYrr\r]z.collecion names must not start or end with '.'rZr[z%collection names must not contain '$'r`ZrenameCollectiontoNrZadminT)rSrrUrt)rirjrkr'rlrnrOrrpr_write_concern_for_cmdrrtrr) r{r<rUrrVrrSrrrGrGrHrename< s8 %    "zCollection.renamerec st|ts tdtdjfd|fg|dur$d|vr td||d<t|dd||dur9|d<fd d } ||S) a6Get a list of distinct values for `key` among all documents in this collection. Raises :class:`TypeError` if `key` is not an instance of :class:`basestring` (:class:`str` in python 3). All optional distinct parameters should be passed as keyword arguments to this method. Valid options include: - `maxTimeMS` (int): The maximum amount of time to allow the count command to run, in milliseconds. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. The :meth:`distinct` method obeys the :attr:`read_preference` of this :class:`Collection`. :Parameters: - `key`: name of the field for which we want to get the distinct values - `filter` (optional): A query document that specifies the documents from which to retrieve the distinct values. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): See list of options above. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Support the `collation` option. zkey must be an instance of strdistinctreNqueryz can't pass both filter and queryr_rc s"j||j|ddiddS)Nvaluesr@)rRrTr_rUr)rrT)rUr rrRrrGrHr sz!Collection.distinct.._cmd) rirjrkrror&rrmrr)r{rerrUrrVrrGrrHr@} s +  zCollection.distinctcCs*|d}|durtdi|S||S)NZ writeConcernrG)rr>r)r{rrUZraw_wcrGrGrHr> s  z!Collection._write_concern_for_cmdc  s td|t|tstdt| ddtdjfd|fd|fg| dur3td| | d< | |durDt |d d <|durOt |d <|dur]t d ||d <durkttskt |fd d} jjj| |S)zInternal findAndModify helper.rzEreturn_document must be ReturnDocument.BEFORE or ReturnDocument.AFTERr_NZ findAndModifyrAnewr projectionfieldssortrc sj}dur|s tdtd<dur/|jdkr td|s+|jdkr+tdd<j|tj||td}t|| d S) NrrrzJMust be connected to MongoDB 4.2+ to use hint on find and modify commands.rzYMust be connected to MongoDB 4.4+ to use hint on unacknowledged find and modify commands.r)rRrSr_rUrrr?) rr&r rrr3r_FIND_AND_MODIFY_DOC_FIELDSr*r)rUrrroutrrr_rr{rSrGrH_find_and_modify s:   z6Collection.__find_and_modify.._find_and_modify)rrxribool ValueErrorrrmrrorrZ_fields_list_to_dictrrrjr>rnrtrr) r{rrDrFrreturn_documentrrrUrrVrJrGrIrHZ__find_and_modify s4         zCollection.__find_and_modifyrDrFc Ks6d|d<|dur ||d<|j|||f|||d|S)a Finds a single document and deletes it, returning the document. >>> db.test.count_documents({'x': 1}) 2 >>> db.test.find_one_and_delete({'x': 1}) {'x': 1, '_id': ObjectId('54f4e12bfba5220aa4d6dee8')} >>> db.test.count_documents({'x': 1}) 1 If multiple documents match *filter*, a *sort* can be applied. >>> for doc in db.test.find({'x': 1}): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> db.test.find_one_and_delete( ... {'x': 1}, sort=[('_id', pymongo.DESCENDING)]) {'x': 1, '_id': 2} The *projection* option can be used to limit the fields returned. >>> db.test.find_one_and_delete({'x': 1}, projection={'_id': False}) {'x': 1} :Parameters: - `filter`: A query that matches the document to delete. - `projection` (optional): a list of field names that should be returned in the result document or a mapping specifying the fields to include or exclude. If `projection` is a list "_id" will always be returned. Use a mapping to exclude fields from the result (e.g. projection={'_id': False}). - `sort` (optional): a list of (key, direction) pairs specifying the sort order for the query. If multiple documents match the query, they are sorted and the first is deleted. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): additional command arguments can be passed as keyword arguments (for example maxTimeMS can be used with recent server versions). .. versionchanged:: 4.1 Added ``let`` parameter. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.2 Respects write concern. .. warning:: Starting in PyMongo 3.2, this command uses the :class:`~pymongo.write_concern.WriteConcern` of this :class:`~pymongo.collection.Collection` when connected to MongoDB >= 3.2. Note that using an elevated write concern with this command may be slower compared to using the default write concern. .. versionchanged:: 3.4 Added the `collation` option. .. versionadded:: 3.0 TremoveNrrrrU)_Collection__find_and_modify) r{rrDrFrrUrrrVrGrGrHfind_one_and_delete sSzCollection.find_one_and_deleterMc KsDt||| d<| dur| | d<|j|||||f| ||d| S)aLFinds a single document and replaces it, returning either the original or the replaced document. The :meth:`find_one_and_replace` method differs from :meth:`find_one_and_update` by replacing the document matched by *filter*, rather than modifying the existing document. >>> for doc in db.test.find({}): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> db.test.find_one_and_replace({'x': 1}, {'y': 1}) {'x': 1, '_id': 0} >>> for doc in db.test.find({}): ... print(doc) ... {'y': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} :Parameters: - `filter`: A query that matches the document to replace. - `replacement`: The replacement document. - `projection` (optional): A list of field names that should be returned in the result document or a mapping specifying the fields to include or exclude. If `projection` is a list "_id" will always be returned. Use a mapping to exclude fields from the result (e.g. projection={'_id': False}). - `sort` (optional): a list of (key, direction) pairs specifying the sort order for the query. If multiple documents match the query, they are sorted and the first is replaced. - `upsert` (optional): When ``True``, inserts a new document if no document matches the query. Defaults to ``False``. - `return_document`: If :attr:`ReturnDocument.BEFORE` (the default), returns the original document before it was replaced, or ``None`` if no document matches. If :attr:`ReturnDocument.AFTER`, returns the replaced or inserted document. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): additional command arguments can be passed as keyword arguments (for example maxTimeMS can be used with recent server versions). .. versionchanged:: 4.1 Added ``let`` parameter. .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the ``collation`` option. .. versionchanged:: 3.2 Respects write concern. .. warning:: Starting in PyMongo 3.2, this command uses the :class:`~pymongo.write_concern.WriteConcern` of this :class:`~pymongo.collection.Collection` when connected to MongoDB >= 3.2. Note that using an elevated write concern with this command may be slower compared to using the default write concern. .. versionadded:: 3.0 rNrrO)rrrP) r{rrrDrFrrMrrUrrrVrGrGrHfind_one_and_replacem s" \ zCollection.find_one_and_replacec KsRt|td||| d<| dur| | d<|j||||||f|| | d| S)a Finds a single document and updates it, returning either the original or the updated document. >>> db.test.find_one_and_update( ... {'_id': 665}, {'$inc': {'count': 1}, '$set': {'done': True}}) {'_id': 665, 'done': False, 'count': 25}} Returns ``None`` if no document matches the filter. >>> db.test.find_one_and_update( ... {'_exists': False}, {'$inc': {'count': 1}}) When the filter matches, by default :meth:`find_one_and_update` returns the original version of the document before the update was applied. To return the updated (or inserted in the case of *upsert*) version of the document instead, use the *return_document* option. >>> from pymongo import ReturnDocument >>> db.example.find_one_and_update( ... {'_id': 'userid'}, ... {'$inc': {'seq': 1}}, ... return_document=ReturnDocument.AFTER) {'_id': 'userid', 'seq': 1} You can limit the fields returned with the *projection* option. >>> db.example.find_one_and_update( ... {'_id': 'userid'}, ... {'$inc': {'seq': 1}}, ... projection={'seq': True, '_id': False}, ... return_document=ReturnDocument.AFTER) {'seq': 2} The *upsert* option can be used to create the document if it doesn't already exist. >>> db.example.delete_many({}).deleted_count 1 >>> db.example.find_one_and_update( ... {'_id': 'userid'}, ... {'$inc': {'seq': 1}}, ... projection={'seq': True, '_id': False}, ... upsert=True, ... return_document=ReturnDocument.AFTER) {'seq': 1} If multiple documents match *filter*, a *sort* can be applied. >>> for doc in db.test.find({'done': True}): ... print(doc) ... {'_id': 665, 'done': True, 'result': {'count': 26}} {'_id': 701, 'done': True, 'result': {'count': 17}} >>> db.test.find_one_and_update( ... {'done': True}, ... {'$set': {'final': True}}, ... sort=[('_id', pymongo.DESCENDING)]) {'_id': 701, 'done': True, 'result': {'count': 17}} :Parameters: - `filter`: A query that matches the document to update. - `update`: The update operations to apply. - `projection` (optional): A list of field names that should be returned in the result document or a mapping specifying the fields to include or exclude. If `projection` is a list "_id" will always be returned. Use a dict to exclude fields from the result (e.g. projection={'_id': False}). - `sort` (optional): a list of (key, direction) pairs specifying the sort order for the query. If multiple documents match the query, they are sorted and the first is updated. - `upsert` (optional): When ``True``, inserts a new document if no document matches the query. Defaults to ``False``. - `return_document`: If :attr:`ReturnDocument.BEFORE` (the default), returns the original document before it was updated. If :attr:`ReturnDocument.AFTER`, returns the updated or inserted document. - `array_filters` (optional): A list of filters specifying which array elements an update should apply. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `let` (optional): Map of parameter names and values. Values must be 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"). - `comment` (optional): A user-provided comment to attach to this command. - `**kwargs` (optional): additional command arguments can be passed as keyword arguments (for example maxTimeMS can be used with recent server versions). .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.9 Added the ability to accept a pipeline as the ``update``. .. versionchanged:: 3.6 Added the ``array_filters`` and ``session`` options. .. versionchanged:: 3.4 Added the ``collation`` option. .. versionchanged:: 3.2 Respects write concern. .. warning:: Starting in PyMongo 3.2, this command uses the :class:`~pymongo.write_concern.WriteConcern` of this :class:`~pymongo.collection.Collection` when connected to MongoDB >= 3.2. Note that using an elevated write concern with this command may be slower compared to using the default write concern. .. versionadded:: 3.0 rrNr)rrrU)rrrrP) r{rrrDrFrrMrrrUrrrVrGrGrHfind_one_and_update s(   zCollection.find_one_and_updatecCr)Nz#'Collection' object is not iterable)rkrrGrGrH__next__r szCollection.__next__cOs0d|jvr td|jtd|jdd)zAThis is only here so that some API misusages are easier to debug.r\z'Collection' object is not callable. If you meant to call the '%s' method on a 'Database' object it is failing because no such method exists.z'Collection' object is not callable. If you meant to call the '%s' method on a 'Collection' object it is failing because no such method exists.r])rorksplitrrGrGrH__call__w s zCollection.__call__)FNNNNN) NNTNNNNNFNr)rWrN)NNNN)TFNNN)FNN)TFNN) FFNNTFNNNNFNN) FFNNTFNNNNNN)FFNNNNN)FFNNNNNN)FNNNNNNN)NNN) NNTNNNFNN)NNTNNNNN)NNNNN)NN) NNNNNNNNNNN)NNNNNN)hrBrCrDrErjr rKrr4r>rrhrrrryrrrrrrrr rpropertyrrOrMrrapplyr _WriteOprr5rrr;r8rrr7rrrr: _IndexKeyHintr9rrr=rrrrrr6rrr<rr$rr%rrr rrrr.rrrrzr$r#rr r,r/rur0rr3rrr;r?r@r>rArFrP _IndexListrQrRrS__iter__rTnextrV __classcell__rGrGr}rHrLjs    ;   . d " B Q T /     k     v     h 1 < &  F  D #>+  U  0 . u & F C  -  / ! d /       C D  N   ^       p       rLN)drE collectionsrtypingrrrrrrr r r r r rZbson.codec_optionsrZ bson.objectidrZ bson.raw_bsonrZbson.sonrZbson.timestamprZpymongorrrrrZpymongo.aggregationrrZ pymongo.bulkrZpymongo.change_streamrZpymongo.collationrZpymongo.command_cursorrr Zpymongo.commonr!r"r#Zpymongo.cursorr$r%Zpymongo.errorsr&r'r(r)Zpymongo.helpersr*Zpymongo.messager+Zpymongo.operationsr,r-r.r/r0r1r2Zpymongo.read_preferencesr3r4Zpymongo.resultsr5r6r7r8r9Zpymongo.typingsr:r;r<r=Zpymongo.write_concernr>rGrYrjrr[rZobjectrAZpymongo.client_sessionrIZpymongo.databaserJZpymongo.read_concernrKZ BaseObjectrLrGrGrGrHsD 8          $  "