o 'hmE@sdZddlmZddlZddlmZddlmZmZm Z m Z m Z m Z m Z mZmZmZmZmZmZmZmZmZmZmZddlmZmZddlmZddlmZdd l m!Z!dd l"m#Z#dd l$m%Z%m&Z&m'Z'm(Z(m)Z)dd l*m+Z+m,Z,dd l-m.Z.ddl/m0Z0ddl1m2Z2m3Z3ddl4m5Z5m6Z6ddl7m8Z8ddl9m:Z:m;Z;ddlZ>m?Z?m@Z@ddlAmBZBddlCmDZDddlEmFZFmGZGmHZHmIZImJZJmKZKmLZLmMZMmNZNmOZOmPZPddlQmRZRddlSmTZTmUZUddlVmWZWmXZXmYZYmZZZm[Z[ddl\m]Z]m^Z^m_Z_m`Z`ddlambZbmcZcmdZddZeedZfddiZgeeIe^eGeFeJe^eMeLfZhGd d!d!ZierNddljZjdd"l*mkZkdd#llmmZmdd$lnmoZodd%lpmqZqdd&lrmsZsdd'l7mtZtdd(lQmuZuGd)d*d*e'jve e^ZwdS)+z%Collection level utilities for Mongo.) annotationsN)abc) TYPE_CHECKINGAnyAsyncContextManagerCallable CoroutineGenericIterableIteratorMappingMutableMappingNoReturnOptionalSequenceTypeTypeVarUnioncastoverload)DEFAULT_CODEC_OPTIONS CodecOptions)ObjectId)RawBSONDocument)SON) Timestamp) ASCENDING_csotcommonhelpers_sharedmessage)_CollectionAggregationCommand _CollectionRawAggregationCommand) _AsyncBulk)AsyncCollectionChangeStream)AsyncCommandCursorAsyncRawBatchCommandCursor) AsyncCursorAsyncRawBatchCursor)validate_collation_or_none)_ecoc_coll_name_esc_coll_name)ConfigurationError InvalidNameInvalidOperationOperationFailure)_check_write_command_response)_UNICODE_REPLACE_CODEC_OPTIONS) DeleteMany DeleteOne IndexModel InsertOne ReplaceOneSearchIndexModel UpdateMany UpdateOne _IndexKeyHint _IndexList_Op)DEFAULT_READ_CONCERN)ReadPreference _ServerMode)BulkWriteResult DeleteResultInsertManyResultInsertOneResult UpdateResult) _CollationIn _DocumentType_DocumentTypeArg _Pipeline)DEFAULT_WRITE_CONCERN WriteConcernvalidate_booleanFTvaluec@seZdZdZdZ dZdS)ReturnDocumentzAn enum used with :meth:`~pymongo.asynchronous.collection.AsyncCollection.find_one_and_replace` and :meth:`~pymongo.asynchronous.collection.AsyncCollection.find_one_and_update`. FTN)__name__ __module__ __qualname____doc__BEFOREAFTERrVrV[/var/www/html/olx_land/venv/lib/python3.10/site-packages/pymongo/asynchronous/collection.pyrOqs rO)_AggregationCommand)AsyncClientSession AsyncDatabase)AsyncConnection)Server) Collation) ReadConcernc seZdZdZ      ddfdd ZdddZdddZddd Zdd#d$Zdd%d&Z dd(d)Z dd+d,Z e dd-d.Z e dd/d0Ze dd1d2Ze  3 3 3ddd4d5Ze 3 3 3ddd8d5Z    dd d;d5Zd!d?d@ZdZddAdBZeZd"dDdEZ            d#d$dYdZZd%d]d^Z   _       d&d'djdkZ  d(d)dodpZd*dqdrZej _    d+d,dzd{Z d-d.ddZ   d/d0ddZ ej _   d1d2ddZ!     _         d3d4ddZ"     _        d5d6ddZ#        d7d8ddZ$         d9d:ddZ%        d7d;ddZ&   d/dddZ(   _     d?d@ddZ)     dAdBddZ*     dAdBddZ+ d-dCddZ,dDddZ-dEddZ.dFddZ/dGddZ0d-dHddZ1  dIdJddZ2dKddĄZ3  dIdLddɄZ4ejdMdd˄Z5  dIdNddτZ6  dIdOddфZ7ej  dIdPddԄZ8ej  dIdPddքZ9  dIdQddلZ:  dIdQddۄZ;  dIdRdd݄Z<   d/dSddZ=  dIdTddZ>  dIdUddZ?  dIdUddZ@  dIdVddZA  dIdWddZB  dIdRddZCej  dIdXddZD   d/dYddZE  dIdZddZFej  dId[ddZG    dd\ddZHdeIjJddddfd]d d ZK      d^d_d dZLdddeIjJddddfd`ddZMdddeIjJdddddf daddZNZOS(bAsyncCollectionz!An asynchronous Mongo collection.FNdatabaseAsyncDatabase[_DocumentType]namestrcreateOptional[bool] codec_options(Optional[CodecOptions[_DocumentTypeArg]]read_preferenceOptional[_ServerMode] write_concernOptional[WriteConcern] read_concernOptional[ReadConcern]sessionOptional[AsyncClientSession]kwargsrreturnNonec  sft|p|j|p |j|p|j|p|jt|ts#tdt |ddl m } t|| sDt ddt |j DsDtdt |j|rJd|vrNtdd |vr]|d s]td ||dd ksi|d d krotd|d|vrwtd||_||_|jjd |j|_|jjdtd|_|jjj|_|s| rtrtjdtdd| | |dSt!ddS)a& Get / create an asynchronous Mongo collection. Raises :class:`TypeError` if `name` is not an instance of :class:`str`. 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.asynchronous.database.AsyncDatabase.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. :param database: the database to get a collection from :param name: the name of the collection to get :param create: **Not supported by AsyncCollection**. :param codec_options: An instance of :class:`~bson.codec_options.CodecOptions`. If ``None`` (the default) database.codec_options is used. :param read_preference: The read preference to use. If ``None`` (the default) database.read_preference is used. :param write_concern: An instance of :class:`~pymongo.write_concern.WriteConcern`. If ``None`` (the default) database.write_concern is used. :param read_concern: An instance of :class:`~pymongo.read_concern.ReadConcern`. If ``None`` (the default) database.read_concern is used. :param collation: An instance of :class:`~pymongo.collation.Collation`. If a collation is provided, it will be passed to the create collection command. :param session: **Not supported by AsyncCollection**. :param kwargs: **Not supported by AsyncCollection**. .. 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.asynchronous.collection.AsyncCollection` no longer returns an instance of :class:`~pymongo.asynchronous.collection.AsyncCollection` 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 `_. z%name must be an instance of str, not rrZcss|]}|jdkVqdS)r[N)rP).0clsrVrVrW sz+AsyncCollection.__init__..z!AsyncDatabase required but given .. collection names cannot be empty$) oplog.$mainz$cmdz)collection names must not contain '$': %r.z3collection names must not start or end with '.': %rz4collection names must not contain the null characterreplace)unicode_decode_error_handlerdocument_classzhThe `create` and `kwargs` arguments to AsyncCollection are deprecated and will be removed in PyMongo 5.0) stacklevelzDAsyncCollection does not support the `create` or `kwargs` arguments.N)"super__init__rgrirkrm isinstancerd TypeErrortypepymongo.asynchronous.databaser[any__mro__rPr- startswith _database_namerc _full_name_replacedict_write_response_codec_optionsclientoptionstimeout_timeout_IS_SYNCwarningswarnDeprecationWarning_create ValueError) selfrarcrergrirkrmrorqr[ __class__rVrWrsNS       zAsyncCollection.__init__AsyncCollection[_DocumentType]c CsJ|dr |jd|}tt|jd|d|d|d||S)zGet a sub-collection of this collection by name. Raises InvalidName if an invalid collection name is used. :param name: the name of the collection to get _r{z has no attribute z. To access the z collection, use database['z'].)rrAttributeErrorrrP __getitem__)rrc full_namerVrVrW __getattr__ s  zAsyncCollection.__getattr__cCs*t|j|jd|d|j|j|j|jS)Nr{Fr`rrrgrirkrm)rrcrVrVrWrszAsyncCollection.__getitem__cCs t|jd|jd|jdS)N(z, ))rrPrrrrVrVrW__repr__'s zAsyncCollection.__repr__otherboolcCs&t|tr|j|jko|j|jkStSN)rr`rrarrcNotImplementedrrrVrVrW__eq__*s zAsyncCollection.__eq__cCs ||k SrrVrrVrVrW__ne__/s zAsyncCollection.__ne__intcCst|j|jfSr)hashrrrrVrVrW__hash__2szAsyncCollection.__hash__rcCstt|jd)Nzq objects do not implement truth value testing or bool(). Please compare with None instead: collection is not None)NotImplementedErrorrrPrrVrVrW__bool__5szAsyncCollection.__bool__cC|jS)zThe full name of this :class:`AsyncCollection`. The full name is of the form `database_name.collection_name`. )rrrVrVrWr<szAsyncCollection.full_namecCr)z*The name of this :class:`AsyncCollection`.)rrrVrVrWrcDszAsyncCollection.namecCr)z{The :class:`~pymongo.asynchronous.database.AsyncDatabase` that this :class:`AsyncCollection` is a part of. )rrrVrVrWraIszAsyncCollection.database.cCdSrrVrrgrirkrmrVrVrW with_optionsPzAsyncCollection.with_options#bson.CodecOptions[_DocumentTypeArg]!AsyncCollection[_DocumentTypeArg]cCrrrVrrVrVrWrZr-Optional[bson.CodecOptions[_DocumentTypeArg]]BAsyncCollection[_DocumentType] | AsyncCollection[_DocumentTypeArg]cCs0t|j|jd|p |j|p|j|p|j|p|jS)aGet 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) :param codec_options: An instance of :class:`~bson.codec_options.CodecOptions`. If ``None`` (the default) the :attr:`codec_options` of this :class:`AsyncCollection` is used. :param read_preference: The read preference to use. If ``None`` (the default) the :attr:`read_preference` of this :class:`AsyncCollection` is used. See :mod:`~pymongo.read_preferences` for options. :param write_concern: An instance of :class:`~pymongo.write_concern.WriteConcern`. If ``None`` (the default) the :attr:`write_concern` of this :class:`AsyncCollection` is used. :param read_concern: An instance of :class:`~pymongo.read_concern.ReadConcern`. If ``None`` (the default) the :attr:`read_concern` of this :class:`AsyncCollection` is used. FrrrVrVrWrds#cmdMapping[str, Any]rJcCs*|d}|durtdi|S||S)N writeConcernrV)getrJ_write_concern_for)rrroraw_wcrVrVrW_write_concern_for_cmds  z&AsyncCollection._write_concern_for_cmdcCstd)Nz('AsyncCollection' object is not iterable)rrrVrVrW__next__szAsyncCollection.__next__argscOsXd|jvrtdt|jd|jtdt|jdt|jd|jdd)zAThis is only here so that some API misusages are easier to debug.r{'z' object is not callable. If you meant to call the '%s' method on an 'AsyncDatabase' object it is failing because no such method exists.zE' object is not callable. If you meant to call the '%s' method on a 'z5' object it is failing because no such method exists.r|)rrrrPsplitrrrqrVrVrW__call__s zAsyncCollection.__call__pipelineOptional[_Pipeline] full_document Optional[str] resume_afterOptional[Mapping[str, Any]]max_await_time_ms Optional[int] batch_size collationOptional[_CollationIn]start_at_operation_timeOptional[Timestamp] start_aftercomment Optional[Any]full_document_before_changeshow_expanded_events*AsyncCollectionChangeStream[_DocumentType]c s4t|||||||||| | | | } | IdH| S)aXWatch changes on this collection. Performs an aggregation with an implicit initial ``$changeStream`` stage and returns a :class:`~pymongo.asynchronous.change_stream.AsyncCollectionChangeStream` cursor which iterates over changes on this collection. .. code-block:: python async with await db.collection.watch() as stream: async for change in stream: print(change) The :class:`~pymongo.asynchronous.change_stream.AsyncCollectionChangeStream` iterable blocks until the next change document is returned or an error is raised. If the :meth:`~pymongo.asynchronous.change_stream.AsyncCollectionChangeStream.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: async with await db.coll.watch([{"$match": {"operationType": "insert"}}]) as stream: async for insert_change in stream: print(insert_change) except pymongo.errors.PyMongoError: # The AsyncChangeStream 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.asynchronous.collection.AsyncCollection.aggregate` with a ``$changeStream`` stage, for the purpose of supporting resumability. .. warning:: This AsyncCollection's :attr:`read_concern` must be ``ReadConcern("majority")`` in order to use the ``$changeStream`` stage. :param pipeline: 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. :param full_document: 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. :param full_document_before_change: Allowed values: 'whenAvailable' and 'required'. Change events may now result in a 'fullDocumentBeforeChange' response field. :param resume_after: 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. :param max_await_time_ms: The maximum time in milliseconds for the server to wait for changes before responding to a getMore operation. :param batch_size: The maximum number of documents to return per batch. :param collation: The :class:`~pymongo.collation.Collation` to use for the aggregation. :param start_at_operation_time: 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. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param start_after: The same as `resume_after` except that `start_after` can resume notifications after an invalidate event. This option and `resume_after` are mutually exclusive. :param comment: A user-provided comment to attach to this command. :param show_expanded_events: Include expanded events such as DDL events like `dropIndexes`. :return: A :class:`~pymongo.asynchronous.change_stream.AsyncCollectionChangeStream` cursor. .. versionchanged:: 4.3 Added `show_expanded_events` parameter. .. 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.md N)r$_initialize_cursor)rrrrrrrrrorrrr change_streamrVrVrWwatchs$zzAsyncCollection.watch operation$AsyncContextManager[AsyncConnection]cs|jj||IdHSr)rr_conn_for_writes)rrorrVrVrWr>sz AsyncCollection._conn_for_writesTconnr\commandMutableMapping[str, Any]Optional[CodecOptions]checkallowable_errors#Optional[Sequence[Union[str, int]]]retryable_write user_fieldsc s|jj| 4IdH-} |j|jj||p|| |p|j||||d| | |jj| | dIdHWdIdHS1IdHs?wYdS)aInternal command helper. :param conn` - A AsyncConnection instance. :param command` - The command itself, as a :class:`~bson.son.SON` instance. :param read_preference` (optional) - The read preference to use. :param codec_options` (optional) - An instance of :class:`~bson.codec_options.CodecOptions`. :param check: raise OperationFailure if there are errors :param allowable_errors: errors to ignore if `check` is True :param read_concern` (optional) - An instance of :class:`~pymongo.read_concern.ReadConcern`. :param write_concern: An instance of :class:`~pymongo.write_concern.WriteConcern`. :param collation` (optional) - An instance of :class:`~pymongo.collation.Collation`. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param retryable_write: True if this command is a retryable write. :param user_fields: Response fields that should be decoded using the TypeDecoders from codec_options, passed to bson._decode_all_selective. :return: The result document. NT)rmrkparse_write_concern_errorrrorrr)rr _tmp_sessionrrc_read_preference_forrg)rrrrirgrrrmrkrrorrsrVrVrW_commandCs&(  0zAsyncCollection._commandrencrypted_fields qev2_requiredc sd|i}|r ||d<|rd|vrt|d|d<|||j|tjdIdH4IdH.}|r>|jdkr>td|jd|j||tj | |||d IdHWdIdHdS1IdHsawYdS) z.Sends a create command with the given options.reencryptedFieldssizerNzDriver support of Queryable Encryption is incompatible with server. Upgrade server to use Queryable Encryption. Got maxWireVersion z. but need maxWireVersion >= 21 (MongoDB >=7.0))rirkrro) floatupdaterr<CREATEmax_wire_versionr,rr>PRIMARYr) rrcrrrorrrrrVrVrW_create_helper}s0   .zAsyncCollection._create_helpercst|dd}|dd}|r\td|dddiddi}|jt||j|d|dd IdH|t||j|d|IdH|j|j||||d IdH|d t fg|IdHdS||j|||IdHdS) NrrrclusteredIndex_idrNT)keyunique)r)r__safeContent__) r)poprvalidate_is_mappingrr+rr* create_indexr)rrrorroptsrVrVrWrs*       zAsyncCollection._createrequests!Sequence[_WriteOp[_DocumentType]]orderedbypass_document_validationletOptional[Mapping]r@c std|t|||||d}|D]}z||Wqty*t|ddw||} || |tj IdH} | durDt | dSt idS)a 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`). >>> async 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 = await db.test.bulk_write(requests) >>> result.inserted_count 1 >>> result.deleted_count 1 >>> result.modified_count 0 >>> result.upserted_ids {2: ObjectId('54f62ee28891e756a6e1abd5')} >>> async for doc in db.test.find({}): ... print(doc) ... {'x': 1, '_id': ObjectId('54f62e60fba5226811f634f0')} {'y': 1, '_id': ObjectId('54f62ee2fba5226811f634f1')} {'z': 1, '_id': ObjectId('54f62ee28891e756a6e1abd5')} :param requests: A list of write operations (see examples above). :param ordered: 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. :param bypass_document_validation: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param let: 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"). :return: 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)rr z is not a valid requestNTF) r validate_listr# _add_to_bulkrrrexecuter<INSERTr@) rrr r rorr blkrequestrkbulk_api_resultrVrVrW bulk_writes S    zAsyncCollection.bulk_writedocop_idbypass_doc_valc s|pjj}j||gd|dur|d<dfd d } jjj|| |tjdIdHt|t s<| dSdS)z0Internal helper for inserting a single document.)insertr  documentsNrrorprr\rrrrrsc sFdur d<|jjjj|jj|dIdH}t|dS)NbypassDocumentValidationrkrgrorr)rrrcrrr0)rorrresultrrrrkrVrW_insert_command.s z4AsyncCollection._insert_one.._insert_commandrr)rorprr\rrrrrs) rk acknowledgedrcrr_retryable_writer<rrrr) rrr rkrrrorr rrVrrW _insert_ones    zAsyncCollection._insert_onedocument%Union[_DocumentType, RawBSONDocument]rCc sZtd|t|tsd|vst|d<||}t|j|d|d|||dIdH|jS)aZInsert a single document. >>> await db.test.count_documents({'x': 1}) 0 >>> result = await db.test.insert_one({'x': 1}) >>> result.inserted_id ObjectId('54f112defba522406c9cc208') >>> await db.test.find_one({'x': 1}) {'x': 1, '_id': ObjectId('54f112defba522406c9cc208')} :param 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. :param bypass_document_validation: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :return: - 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 r#rTN)r rkrrror) rvalidate_is_document_typerrrrrCr"r )rr#r rorrkrVrVrW insert_oneHs" .    zAsyncCollection.insert_oner/Iterable[Union[_DocumentType, RawBSONDocument]]rBc sttjrttjsstdgdfdd }||}t||||d}t||_| ||t j IdHt |j S) abInsert an iterable of documents. >>> await db.test.count_documents({}) 0 >>> result = await db.test.insert_many([{'x': i} for i in range(2)]) >>> await result.inserted_ids [ObjectId('54f113fffba522406c9cc20e'), ObjectId('54f113fffba522406c9cc20f')] >>> await db.test.count_documents({}) 2 :param documents: A iterable of documents to insert. :param ordered: 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. :param bypass_document_validation: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :return: 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 listrr'Iterator[tuple[int, Mapping[str, Any]]]c3sRD]#}td|t|ts d|vrt|d<|dtj|fVqdS)z6A generator that validates documents and handles _ids.r#rN)rr%rrrappendr _INSERT)r#r inserted_idsrVrWgens   z(AsyncCollection.insert_many..gen)rN)rrr()rrr r rrr#listopsrr<rrBr ) rrr r rorr-rkrrVr+rW insert_manys 4    zAsyncCollection.insert_manycriteria#Union[Mapping[str, Any], _Pipeline]upsertmulti array_filters%Optional[Sequence[Mapping[str, Any]]]hintOptional[_IndexKeyHint]sortc std|t| } |p|j}|j}||||d}| dur'|s#td| |d<| dur5|s1td| |d<| durR|sD|jdkrDtd t| tsNt | } | |d <|durk|sa|jd kratd t d |||d <|j ||gd}|durt d|||d<|dur||d<| dur| |d<|j |jj |||j| |jj|dIdH}t||drd|vrd|d<nd|d<d|vr|ddd|d<|sdS|S)!Internal update / replace helper.r3)qur4r3N3Collation is unsupported for unacknowledged writes.r6arrayFilters is unsupported for unacknowledged writes. arrayFilterszPMust be connected to MongoDB 4.2+ to use hint on unacknowledged update commands.r7zPMust be connected to MongoDB 8.0+ to use sort on unacknowledged update commands.r9)rr updatesr rrrnupsertedTupdatedExistingFrr)rKr)rkr r,rrrdr_index_documentrrrcrrrrcopyr0r)rrr1r#r3r4rkrr rrr5r7rorr r9rr  update_docrrrVrVrW_updatesz          zAsyncCollection._updatecsTd  fd d } jjp jjo" || |Id HS) r:rorprr\rrrrrcs8 j|f  || dIdHS)N)r3r4rkrr rrr5r7rorr r9r)rIrorrr5rrrr1r#r7r r4rr rr9r3rkrVrWrIHs*z2AsyncCollection._update_retryable.._updateN)rorprr\rrrrr)rrr!rkr )rr1r#rr3r4rkrr rrr5r7ror r9rrIrVrKrW_update_retryable3s* z!AsyncCollection._update_retryablefilter replacementrDc shtd|t||durtd|||} t|j||tj|| |||||| | d IdH| jS)aE Replace a single document matching the filter. >>> async for doc in db.test.find({}): ... print(doc) ... {'x': 1, '_id': ObjectId('54f4c5befba5220aa4d6dee7')} >>> result = await db.test.replace_one({'x': 1}, {'y': 1}) >>> result.matched_count 1 >>> result.modified_count 1 >>> async 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 = await db.test.replace_one({'x': 1}, {'x': 1}, True) >>> result.matched_count 0 >>> result.modified_count 0 >>> result.upserted_id ObjectId('54f11e5c8891e756a6e1abd4') >>> await db.test.find_one({'x': 1}) {'x': 1, '_id': ObjectId('54f11e5c8891e756a6e1abd4')} :param filter: A query that matches the document to replace. :param replacement: The new document. :param upsert: If ``True``, perform an insert if no documents match the filter. :param bypass_document_validation: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :param comment: A user-provided comment to attach to this command. :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. This option is only supported on MongoDB 8.0 and above. :return: - An instance of :class:`~pymongo.results.UpdateResult`. .. versionchanged:: 4.11 Added ``sort`` parameter. .. 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 rMNr )rkrrr7ror r9r) rrvalidate_ok_for_replacerrDrLr<UPDATEr ) rrMrNr3r rr7ror r9rrkrVrVrW replace_onefs. V    zAsyncCollection.replace_onerc sbtd|t|td|||} t|j||tj|| |||||| | | d IdH| j S)a Update a single document matching the filter. >>> async for doc in db.test.find(): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> result = await db.test.update_one({'x': 1}, {'$inc': {'x': 3}}) >>> result.matched_count 1 >>> result.modified_count 1 >>> async 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 = await db.test.update_one({'x': -10}, {'$inc': {'x': 3}}, upsert=True) >>> result.matched_count 0 >>> result.modified_count 0 >>> result.upserted_id ObjectId('626a678eeaa80587d4bb3fb7') >>> await db.test.find_one(result.upserted_id) {'_id': ObjectId('626a678eeaa80587d4bb3fb7'), 'x': -7} :param filter: A query that matches the document to update. :param update: The modifications to apply. :param upsert: If ``True``, perform an insert if no documents match the filter. :param bypass_document_validation: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param array_filters: A list of filters specifying which array elements an update should apply. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :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. This option is only supported on MongoDB 8.0 and above. :param comment: A user-provided comment to attach to this command. :return: - An instance of :class:`~pymongo.results.UpdateResult`. .. versionchanged:: 4.11 Added ``sort`` parameter. .. 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 rMr5) rkrrr5r7ror r9rN rrvalidate_ok_for_updatevalidate_list_or_nonerrDrLr<rPr ) rrMrr3r rr5r7ror r9rrkrVrVrW update_ones. `    zAsyncCollection.update_onec sbtd|t|td|||} t|j||tj|d| |||||| | d IdH| j S)aM Update one or more documents that match the filter. >>> async for doc in db.test.find(): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> result = await db.test.update_many({'x': 1}, {'$inc': {'x': 3}}) >>> result.matched_count 3 >>> result.modified_count 3 >>> async for doc in db.test.find(): ... print(doc) ... {'x': 4, '_id': 0} {'x': 4, '_id': 1} {'x': 4, '_id': 2} :param filter: A query that matches the documents to update. :param update: The modifications to apply. :param upsert: If ``True``, perform an insert if no documents match the filter. :param bypass_document_validation: If ``True``, allows the write to opt-out of document level validation. Default is ``False``. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param array_filters: A list of filters specifying which array elements an update should apply. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :param comment: A user-provided comment to attach to this command. :return: - 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 rMr5T) r4rkrrr5r7ror rNrR) rrMrr3r5r rr7ror rrkrVrVrW update_manyKs. M    zAsyncCollection.update_manycsB|jj|jj|j|j|j|j}|j|j |||dIdHdS)azAlias for :meth:`~pymongo.asynchronous.database.AsyncDatabase.drop_collection`. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param encrypted_fields: **(BETA)** Document that describes the encrypted fields for Queryable Encryption. The following two calls are equivalent: >>> await db.foo.drop() >>> await 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:`AsyncCollection`'s :attr:`write_concern`. .. versionchanged:: 3.6 Added ``session`` parameter. )rorrN) rr get_databasercrgrirkrmdrop_collectionr)rrorrdborVrVrWdrops  zAsyncCollection.dropc  std||p |j}|j} |t| d}t|}|dur)| s%td||d<|durF| s8|jdkr8tdt|t sBt |}||d<|j ||gd }| dur\t d | | |d <| durd| |d <|j|jj |||j| |jj| d IdH}t||S) Internal delete helper.rM)r;limitNr=r zPMust be connected to MongoDB 4.4+ to use hint on unacknowledged delete commands.r7)deleter deletesr rr)rrrkr rr)r,rrrdrrFrcr%rrrrr0)rrr1r4rkrr rr7rorr rr  delete_docrrrVrVrW_deletesF       zAsyncCollection._deletec sNd  f d d } jjj pjjo | |tjd Id HS)r[rorprr\rrrrrcs*j| ||d IdHS)N) rkrr rr7rorr r)rarJ rrr1r7r r4rr rrkrVrWra"s z2AsyncCollection._delete_retryable.._deleterN)rorprr\rrrrr)rrr!rkr r<DELETE) rr1r4rkrr rr7ror rrarVrbrW_delete_retryables  z!AsyncCollection._delete_retryablerAc 4||}t|j|d||||||dIdH|jS)aDelete a single document matching the filter. >>> await db.test.count_documents({'x': 1}) 3 >>> result = await db.test.delete_one({'x': 1}) >>> result.deleted_count 1 >>> await db.test.count_documents({'x': 1}) 2 :param filter: A query that matches the document to delete. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :param comment: A user-provided comment to attach to this command. :return: - 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 Frkrr7ror rNrrArdr rrMrr7ror rrkrVrVrW delete_one; 2  zAsyncCollection.delete_onec re)aDelete one or more documents matching the filter. >>> await db.test.count_documents({'x': 1}) 3 >>> result = await db.test.delete_many({'x': 1}) >>> result.deleted_count 3 >>> await db.test.count_documents({'x': 1}) 0 :param filter: A query that matches the documents to delete. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :param comment: A user-provided comment to attach to this command. :return: - 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 TrfNrgrhrVrVrW delete_many|rjzAsyncCollection.delete_manyOptional[_DocumentType]csZ|durt|tjsd|i}|j|g|Ri|}|d2z 3dHW}|S6dS)azGet 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:`AsyncCollection`. :param filter: a dictionary specifying the query to be performed OR any other type to be used as the value for a query for ``"_id"``. :param args: any additional positional arguments are the same as the arguments to :meth:`find`. :param kwargs: any additional keyword arguments are the same as the arguments to :meth:`find`. :: code-block: python >>> await collection.find_one(max_time_ms=100) Nrr|)rrr findr\)rrMrrqcursorrrVrVrWfind_oneszAsyncCollection.find_oneAsyncCursor[_DocumentType]cOst|g|Ri|S)a)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.asynchronous.cursor.AsyncCursor` corresponding to this query. The :meth:`find` method obeys the :attr:`read_preference` of this :class:`AsyncCollection`. :param filter: A query document that selects which documents to include in the result set. Can be an empty document to include all documents. :param projection: 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}). :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param skip: the number of documents to omit (from the start of the result set) when returning the results :param limit: the maximum number of results to return. A limit of 0 (the default) is equivalent to setting no limit. :param no_cursor_timeout: 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. :param cursor_type: 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. :param sort: a list of (key, direction) pairs specifying the sort order for this query. See :meth:`~pymongo.asynchronous.cursor.AsyncCursor.sort` for details. :param allow_partial_results: if True, mongos will return partial results if some shards are down instead of returning an error. :param oplog_replay: **DEPRECATED** - if True, set the oplogReplay query flag. Default: False. :param batch_size: Limits the number of documents returned in a single batch. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param return_key: If True, return only the index keys in each document. :param show_record_id: If True, adds a field ``$recordId`` in each document with the storage engine's internal record identifier. :param snapshot: **DEPRECATED** - If True, prevents the cursor from returning a document more than once because of an intervening write operation. :param hint: An index, in the same format as passed to :meth:`~pymongo.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). Pass this as an alternative to calling :meth:`~pymongo.asynchronous.cursor.AsyncCursor.hint` on the cursor to tell Mongo the proper index to use for the query. :param max_time_ms: 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.asynchronous.cursor.AsyncCursor.max_time_ms` on the cursor. :param max_scan: **DEPRECATED** - The maximum number of documents to scan. Pass this as an alternative to calling :meth:`~pymongo.asynchronous.cursor.AsyncCursor.max_scan` on the cursor. :param min: 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.asynchronous.cursor.AsyncCursor.min` on the cursor. ``hint`` must also be passed to ensure the query utilizes the correct index. :param max: 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.asynchronous.cursor.AsyncCursor.max` on the cursor. ``hint`` must also be passed to ensure the query utilizes the correct index. :param comment: 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.asynchronous.cursor.AsyncCursor.comment` on the cursor. :param allow_disk_use: 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.AsyncCursor` instance created with the :attr:`~pymongo.cursor.CursorType.EXHAUST` cursor_type requires an exclusive :class:`~socket.socket` connection to MongoDB. If the :class:`~pymongo.asynchronous.cursor.AsyncCursor` 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'rrVrVrWrms;zAsyncCollection.find"AsyncRawBatchCursor[_DocumentType]cOs(|jjjr tdt|g|Ri|S)aQuery the database and retrieve batches of raw BSON. Similar to the :meth:`find` method but returns a :class:`~pymongo.asynchronous.cursor.AsyncRawBatchCursor`. 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.find_raw_batches() >>> async 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)rr _encrypterr.r(rrVrVrWfind_raw_batchess z AsyncCollection.find_raw_batchesdict[str, Any]Optional[Collation]c s0|j||||j|j||dIdH}t|dS)zInternal count command helper.)rirgrmrroNrC)rrrmr)rrorrirrresrVrVrW _count_cmds  zAsyncCollection._count_cmdc sP|j|||dg|j|j||dIdH}d|vrdS|dd}|r&|dSdS)zAInternal helper to run an aggregate that returns a single result.)rrgrmrroNrn firstBatchr)rrrm)rrrirrrorbatchrVrVrW_aggregate_one_results    z%AsyncCollection._aggregate_one_resultcsJdvr td|dur|d<dfdd }j|dtjdIdHS)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. :param comment: A user-provided comment to attach to this command. :param kwargs: 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/ roz2estimated_document_count does not support sessionsNrrp_serverr]rr\rirjrrrcs0dji}|j||||ddIdHS)Ncount)r)rrrw)ror|rrirrqrrVrW_cmds  z6AsyncCollection.estimated_document_count.._cmdr rorpr|r]rr\rirjrrr)r,_retryable_non_cursor_readr<COUNT)rrrqrrVr~rWestimated_document_counts z(AsyncCollection.estimated_document_countcsd|ig}d|vr|d|did|vr"|d|di|dur*||d<|dd d d id ij|id d |vrQt|d tsQt|d |d <t|dd|dfdd } ||t j IdHS)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:`AsyncCollection`. .. 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`_ | +-------------+-------------------------------------+ :param filter: A query document that selects which documents to count in the collection. Can be an empty document to count all documents. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: 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$skipr\z$limitNrz$grouprNz$sum)rrC) aggregaterrnr7rrorpr|r]rr\rirjrrrcs*|||IdH}|sdS|dS)NrrC)r{)ror|rrirrrrrVrWr`s  z-AsyncCollection.count_documents.._cmdr) r)rrrrdrrFr)rrr<r)rrMrorrqrrrVrrWcount_documentss  >  zAsyncCollection.count_documentsfuncpCallable[[Optional[AsyncClientSession], Server, AsyncConnection, Optional[_ServerMode]], Coroutine[Any, Any, T]]rLc sh|jj}||4IdH}||||||IdHWdIdHS1IdHs-wYdS)z;Non-cursor read helper to handle implicit session creation.N)rrr_retryable_readr)rrrorrrrVrVrWros  0z*AsyncCollection._retryable_non_cursor_readindexesSequence[IndexModel] list[str]cs8td||dur||d<|j||fi|IdHS)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)]) >>> await db.test.create_indexes([index1, index2]) ["hello_world", "goodbye_-1"] :param indexes: A list of :class:`~pymongo.operations.IndexModel` instances. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: The :attr:`~pymongo.asynchronous.collection.AsyncCollection.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_create_indexes)rrrorrqrVrVrWcreate_indexes}s  *zAsyncCollection.create_indexesc sg|j|tjdIdH4IdHC}|jdk}d fdd }|jt|d}||d |vr8|s8td |j||t j t | ||d IdHWdIdHS1IdHs[wYS) ayInternal createIndexes helper. :param indexes: A list of :class:`~pymongo.operations.IndexModel` instances. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param kwargs: optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. rNr]rrIterator[Mapping[str, Any]]c3sBD]}t|tst|d|j}|d|VqdS)Nz4 is not an instance of pymongo.operations.IndexModelrc)rr4rr#r))indexr#rnamesrVrW gen_indexess z4AsyncCollection._create_indexes..gen_indexes) createIndexesr commitQuorumzRMust be connected to MongoDB 4.4+ to use the commitQuorum option for createIndexes)rirgrkrorrr) rr<CREATE_INDEXESrrcr.rr,rr>rr1r)rrrorqrsupports_quorumrrrVrrWrs.    zAsyncCollection._create_indexeskeysr:cs\i}d|vr|d|d<|dur||d<t|fi|}|j|g|fi|IdHdS)afCreates an index on this collection. Takes either a single key or a list containing (key, direction) pairs or keys. If no direction is given, :data:`~pymongo.ASCENDING` will be assumed. The key(s) must be an instance of :class:`str` 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:: >>> await my_collection.create_index("mike") For a compound index on ``'mike'`` descending and ``'eliot'`` ascending we need to use a list of tuples:: >>> await my_collection.create_index([("mike", pymongo.DESCENDING), ... "eliot"]) All optional index creation parameters should be passed as keyword arguments to this method. For example:: >>> await 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.asynchronous.collection.AsyncCollection.write_concern` of this collection is automatically applied to this operation. :param keys: a single key or a list of (key, direction) pairs specifying the index to create :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: any additional index creation options (see the above list) should be passed as keyword arguments. .. versionchanged:: 4.4 Allow passing a list containing (key, direction) pairs or keys for the ``keys`` parameter. .. 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/ maxTimeMSNrr)rr4r)rrrorrq cmd_optionsrrVrVrWrsn zAsyncCollection.create_indexcs0|dur ||d<|jdd|i|IdHdS)aDrops all indexes on this collection. Can be used on non-existent collections or collections with no indexes. Raises OperationFailure on an error. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: The :attr:`~pymongo.asynchronous.collection.AsyncCollection.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*ro)r _drop_index)rrorrqrVrVrW drop_indexesO szAsyncCollection.drop_indexes index_or_namecs"|j|||fi|IdHdS)a.Drops the specified index on this collection. Can be used on non-existent 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. :param index_or_name: index (or name of index) to drop :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: The :attr:`~pymongo.asynchronous.collection.AsyncCollection.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)rrrorrqrVrVrW drop_indexp s /zAsyncCollection.drop_indexc s|}t|tr t|}t|tstdt||j|d}|||dur.||d<|j |t j dIdH4IdH }|j ||t jddg|||dIdHWdIdHdS1IdHscwYdS)Nz6index_or_name must be an instance of str or list, not ) dropIndexesrrr ns not foundrx)rirrkro)rr.r_gen_index_namerdrrrrrr< DROP_INDEXESrr>rr)rrrorrqrcrrrVrVrWr s(      .zAsyncCollection._drop_index,AsyncCommandCursor[MutableMapping[str, Any]]cs|||IdHS)aGet a cursor over the index documents for this collection. >>> async for index in await db.test.list_indexes(): ... print(index) ... SON([('v', 2), ('key', SON([('_id', 1)])), ('name', '_id_')]) :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :return: An instance of :class:`~pymongo.asynchronous.command_cursor.AsyncCommandCursor`. .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionadded:: 3.0 N) _list_indexes)rrorrVrVrW list_indexes szAsyncCollection.list_indexesc stttttttfjtj d|r| ptj }|dudfd d }j j |d4IdH}j j j|||tjdIdHWdIdHS1IdHsZwYdS)N)rgrirorpr|r]rr\rir?rrrc sjid}dur|d<zj||||dIdHd}Wnty=}z|jdkr.dgd}WYd}~nd}~wwt||j||dd}||IdH|S) N) listIndexesrnr)rornrxr)idry)roexplicit_sessionr)rrr/coder%addressr_maybe_pin_connection)ror|rrirrnexc cmd_cursorrgcollrrrrVrWr s0  z+AsyncCollection._list_indexes.._cmdFr) rorpr|r]rr\rir?rrr)rrrr`r rdrrr>r_txn_read_preferencerrrrr< LIST_INDEXES)rror read_prefrrrVrrWr s  0zAsyncCollection._list_indexescs\|j||dIdH}i}|2z3dHW}t|d|d<t|}|||d<q6|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: >>> await db.test.create_index("x", unique=True) 'x_1' >>> await db.test.index_information() {'_id_': {'key': [('_id', 1)]}, 'x_1': {'unique': True, 'key': [('x', 1)]}} :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. .. versionchanged:: 4.1 Added ``comment`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. )rorNrrc)rr.itemsrr)rrorrninforrVrVrWindex_information s"z!AsyncCollection.index_information%AsyncCommandCursor[Mapping[str, Any]]c s|dur diig}ndd|iig}|jttjttd}t|t|||du|dddiid}|jj j |j | |||j tjd IdHS) aReturn a cursor over search indexes for the current collection. :param name: If given, the name of the index to search for. Only indexes with matching index names will be returned. If not given, all search indexes for the current collection will be returned. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :return: A :class:`~pymongo.asynchronous.command_cursor.AsyncCommandCursor` over the result set. .. note:: requires a MongoDB server version 7.0+ Atlas cluster. .. versionadded:: 4.5 Nz$listSearchIndexesrc)rgrirkrmrnryrN)rrr retryabler)rrr>rrIr=r!r%rrr get_cursorget_read_preference_performs_writer<LIST_SEARCH_INDEX)rrcrorrqrrrrVrVrWlist_search_indexes6 s4    z#AsyncCollection.list_search_indexesmodel*Union[Mapping[str, Any], SearchIndexModel]cs<t|ts tdi|}|j|g||fi|IdHdS)aCreate a single search index for the current collection. :param model: The model for the new search index. It can be given as a :class:`~pymongo.operations.SearchIndexModel` instance or a dictionary with a model "definition" and optional "name". :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: optional arguments to the createSearchIndexes command (like maxTimeMS) can be passed as keyword arguments. :return: The name of the new search index. .. note:: requires a MongoDB server version 7.0+ Atlas cluster. .. versionadded:: 4.5 NrrV)rr7_create_search_indexes)rrrorrqrVrVrWcreate_search_indexk s "z#AsyncCollection.create_search_indexmodelslist[SearchIndexModel]cs|j|||fi|IdHS)aCreate multiple search indexes for the current collection. :param models: A list of :class:`~pymongo.operations.SearchIndexModel` instances. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: optional arguments to the createSearchIndexes command (like maxTimeMS) can be passed as keyword arguments. :return: A list of the newly created search index names. .. note:: requires a MongoDB server version 7.0+ Atlas cluster. .. versionadded:: 4.5 N)r)rrrorrqrVrVrWcreate_search_indexes sz%AsyncCollection.create_search_indexesc s|dur ||d<d fdd }|jt|d}|||j|tjdIdH4IdH!}|j||tjt dIdH}d d |d DWdIdHS1IdHsTwYdS) Nrrrrc3s0D]}t|tst|d|jVqdS)Nz: is not an instance of pymongo.operations.SearchIndexModel)rr7rr#)rrrVrWr s  z;AsyncCollection._create_search_indexes..gen_indexes)createSearchIndexesrr)rirgcSsg|]}|dqS)rcrV)rtrrVrVrW sz:AsyncCollection._create_search_indexes..indexesCreatedr) rcr.rrr<CREATE_SEARCH_INDEXESrr>rr1) rrrorrqrrrresprVrrWr s$  0z&AsyncCollection._create_search_indexesc s|j|d}|||dur||d<|j|tjdIdH4IdH}|j||tjddgtdIdHWdIdHdS1IdHsEwYdS)a"Delete a search index by index name. :param name: The name of the search index to be deleted. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: optional arguments to the dropSearchIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: requires a MongoDB server version 7.0+ Atlas cluster. .. versionadded:: 4.5 )dropSearchIndexrcNrrrrxrirrg) rrrr<DROP_SEARCH_INDEXESrr>rr1)rrcrorrqrrrVrVrWdrop_search_index s   .z!AsyncCollection.drop_search_index definitionc s|j||d}|||dur||d<|j|tjdIdH4IdH}|j||tjddgtdIdHWdIdHdS1IdHsFwYdS)aUpdate a search index by replacing the existing index definition with the provided definition. :param name: The name of the search index to be updated. :param definition: The new search index definition. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: optional arguments to the updateSearchIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: requires a MongoDB server version 7.0+ Atlas cluster. .. versionadded:: 4.5 )updateSearchIndexrcrNrrrrxr) rrrr<UPDATE_SEARCH_INDEXrr>rr1)rrcrrorrqrrrVrVrWupdate_search_index s  .z#AsyncCollection.update_search_indexcs|jj|jj|j|j|j|j}|j|d|j i|dIdH}d}|2z 3dHW}|}n6|s3iS| di}|dus?Jd|vrF|d=|S)aNGet the options set on this collection. Returns a dictionary of options and their values - see :meth:`~pymongo.asynchronous.database.AsyncDatabase.create_collection` for more information on the possible options. Returns an empty dictionary if the collection has not been created yet. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. .. versionchanged:: 3.6 Added ``session`` parameter. rc)rorMrNrre) rrrWrcrgrirkrmlist_collectionsrr)rrorrYrnrrrrVrVrWr s.    zAsyncCollection.optionsaggregation_commandType[_AggregationCommand]rH cursor_classType[AsyncCommandCursor]r!AsyncCommandCursor[_DocumentType]c s\|dur ||d<|||||||dddiid} |jjj| j| ||| j tjdIdHS)NrrnryrN)rr)rrrrrrr< AGGREGATE) rrrrrorr rrqrrVrVrW _aggregate5 s&    zAsyncCollection._aggregatec sv|jjj|dd4IdH }|jt|tf||du||d|IdHWdIdHS1IdHs4wYdS)aPerform an aggregation using the aggregation framework on this collection. The :meth:`aggregate` method obeys the :attr:`read_preference` of this :class:`AsyncCollection`, 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 `PyMongoExplain `_ instead. An example is included in the :ref:`aggregate-examples` documentation. .. note:: The :attr:`~pymongo.asynchronous.collection.AsyncCollection.write_concern` of this collection is automatically applied to this operation. :param pipeline: a list of aggregation pipeline stages :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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. :param comment: A user-provided comment to attach to this command. :param kwargs: 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`. - `bypassDocumentValidation` (bool): If ``True``, allows the write to opt-out of document level validation. :return: A :class:`~pymongo.asynchronous.command_cursor.AsyncCommandCursor` 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 an AsyncCommandCursor. The pipeline argument must be a list. .. seealso:: :doc:`/examples/aggregation` .. _aggregate command: https://mongodb.com/docs/manual/reference/command/aggregate FcloseN)rorr r)rrrrr!r%)rrror rrqrrVrVrWrU sT 0zAsyncCollection.aggregatec s|jjjr td|dur||d<|jjj|dd4IdH#}ttt|jt |t f||dud|IdHWdIdHS1IdHsHwYdS)abPerform an aggregation and retrieve batches of raw BSON. Similar to the :meth:`aggregate` method but returns a :class:`~pymongo.asynchronous.cursor.AsyncRawBatchCursor`. 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 = await db.test.aggregate_raw_batches([ ... {'$project': {'x': {'$multiply': [2, '$x']}}}]) >>> async 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 encryptionNrFr)ror) rrrrr.rrr(rFrr"r&)rrrorrqrrVrVrWaggregate_raw_batches s(  0z%AsyncCollection.aggregate_raw_batchesnew_namec svt|tstdt||rd|vrtd|ddks%|ddkr)tdd|vr6|d s6td |jjd|}|j|d }| ||d urR||d <| ||}|j |t j dId H4Id HG}|jj|4Id H%}|jd||d||jjdId HWd Id HWd Id HS1Id HswYWd Id Hd S1Id HswYd S)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:`str`. Raises :class:`~pymongo.errors.InvalidName` if `new_name` is not a valid collection name. :param new_name: new name for this collection :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param kwargs: additional arguments to the rename command may be passed as keyword arguments to this helper method (i.e. ``dropTarget=True``) .. note:: The :attr:`~pymongo.asynchronous.collection.AsyncCollection.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 str, not rwrxrr{r|z/collection names must not start or end with '.'ryrzz%collection names must not contain '$')renameCollectiontoNrradminT)rkrror)rrdrrr-rrrcrrrrr<RENAMErrr) rrrorrqrrkrrrVrVrWrename s: $      .zAsyncCollection.renamerr.cst|tstdt|j|d|dur%d|vr!td||d<t|dd||dur:|d<|durLt|tsHt |}|d<dfdd }j ||t j dIdHS)aMGet a list of distinct values for `key` among all documents in this collection. Raises :class:`TypeError` if `key` is not an instance of :class:`str`. 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:`AsyncCollection`. :param key: name of the field for which we want to get the distinct values :param filter: A query document that specifies the documents from which to retrieve the distinct values. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param comment: A user-provided comment to attach to this command. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). :param kwargs: See list of options above. .. versionchanged:: 4.12 Added ``hint`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Support the `collation` option. z$key must be an instance of str, not )distinctrNqueryz can't pass both filter and queryrrr7rorpr|r]rr\rirjrrr.c s*j||j|ddidIdHdS)NvaluesrN)rirmrror)rrm)ror|rrirrVrWrg s  z&AsyncCollection.distinct.._cmdr) rorpr|r]rr\rirjrrr.)rrdrrrr,r)rrrrFrr<DISTINCT)rrrMrorr7rqrrVrrWr% s$ 2    zAsyncCollection.distinct projection1Optional[Union[Mapping[str, Any], Iterable[str]]]Optional[_IndexList]return_documentc std|t|tstdt|t| ddj||d| dur2td| | d< | |durCt |dd<|durNt |d <|dur[t d ||d <durittsit |dfdd } jjjj| |tjdIdHS)zInternal findAndModify helper.rMzKreturn_document must be ReturnDocument.BEFORE or ReturnDocument.AFTER, not rN) findAndModifyrnewr rfieldsr9r3rorprr\rrrrrc sj}dur|stdtd<dur0|jdkr!td|s,|jdkr,tdd<j|tj||tdIdH}t|| d S) Nr>r?r@zJMust be connected to MongoDB 4.2+ to use hint on find and modify commands.r]zYMust be connected to MongoDB 4.4+ to use hint on unacknowledged find and modify commands.r7)rirkrrorrrM) r r,r.rrr>r_FIND_AND_MODIFY_DOC_FIELDSr0r)rorrr outr5rrr7rrkrVrW_find_and_modify_helper s<    zAAsyncCollection._find_and_modify.._find_and_modify_helperr)rorprr\rrrrr)rrrrrrr)rrrr_fields_list_to_dictrFrKrdrrrr!r r<FIND_AND_MODIFY) rrMrr9r3rr5r7ror rqrrVrrW_find_and_modify{ s<         " z AsyncCollection._find_and_modifyrFc s>d|d<|dur ||d<|j|||f|||d|IdHS)a Finds a single document and deletes it, returning the document. >>> await db.test.count_documents({'x': 1}) 2 >>> await db.test.find_one_and_delete({'x': 1}) {'x': 1, '_id': ObjectId('54f4e12bfba5220aa4d6dee8')} >>> await db.test.count_documents({'x': 1}) 1 If multiple documents match *filter*, a *sort* can be applied. >>> async for doc in db.test.find({'x': 1}): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> await 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. >>> await db.test.find_one_and_delete({'x': 1}, projection={'_id': False}) {'x': 1} :param filter: A query that matches the document to delete. :param projection: 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}). :param sort: 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. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :param comment: A user-provided comment to attach to this command. :param kwargs: 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.asynchronous.collection.AsyncCollection` 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 TremoveNrr r7ro)r) rrMrr9r7ror rrqrVrVrWfind_one_and_delete sR z#AsyncCollection.find_one_and_deletec sLt||| d<| dur| | d<|j|||||f| ||d| IdHS)a0Finds 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. >>> async for doc in db.test.find({}): ... print(doc) ... {'x': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} >>> await db.test.find_one_and_replace({'x': 1}, {'y': 1}) {'x': 1, '_id': 0} >>> async for doc in db.test.find({}): ... print(doc) ... {'y': 1, '_id': 0} {'x': 1, '_id': 1} {'x': 1, '_id': 2} :param filter: A query that matches the document to replace. :param replacement: The replacement document. :param projection: 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}). :param sort: 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. :param upsert: When ``True``, inserts a new document if no document matches the query. Defaults to ``False``. :param 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. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :param comment: A user-provided comment to attach to this command. :param kwargs: 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.asynchronous.collection.AsyncCollection` 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 rNrr)rrOr) rrMrNrr9r3rr7ror rrqrVrVrWfind_one_and_replace# s$ [ z$AsyncCollection.find_one_and_replacec sZt|td||| d<| dur| | d<|j||||||f|| | d| IdHS)aFinds a single document and updates it, returning either the original or the updated document. >>> await 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. >>> await 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 >>> await 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. >>> await 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. >>> (await db.example.delete_many({})).deleted_count 1 >>> await 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. >>> async for doc in db.test.find({'done': True}): ... print(doc) ... {'_id': 665, 'done': True, 'result': {'count': 26}} {'_id': 701, 'done': True, 'result': {'count': 17}} >>> await db.test.find_one_and_update( ... {'done': True}, ... {'$set': {'final': True}}, ... sort=[('_id', pymongo.DESCENDING)]) {'_id': 701, 'done': True, 'result': {'count': 17}} :param filter: A query that matches the document to update. :param update: The update operations to apply. :param projection: 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}). :param sort: 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. :param upsert: When ``True``, inserts a new document if no document matches the query. Defaults to ``False``. :param 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. :param array_filters: A list of filters specifying which array elements an update should apply. :param hint: 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.asynchronous.collection.AsyncCollection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. :param session: a :class:`~pymongo.asynchronous.client_session.AsyncClientSession`. :param let: 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"). :param comment: A user-provided comment to attach to this command. :param kwargs: 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.asynchronous.collection.AsyncCollection` 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 r5rNr)r7r ro)rrSrTr) rrMrrr9r3rr5r7ror rrqrVrVrWfind_one_and_update s*   z#AsyncCollection.find_one_and_update)FNNNNN)rarbrcrdrerfrgrhrirjrkrlrmrnrorprqrrrrs)rcrdrrr)rrrd)rrrrr)rrr)rrr)rrrb)N...) rgrsrirjrkrlrmrnrrr)...) rgrrirjrkrlrmrnrrr)NNNN) rgrrirjrkrlrmrnrrr)rrrorprrrJ)rrrqrrrr) NNNNNNNNNNNN)rrrrrrrrrrrrrrrorprrrrrrrrfrrr)rorprrdrrr) NNTNNNNNFN)rr\rrrirjrgrrrrrrmrnrkrlrrrorprrrrrrr)NF)rcrdrrrrrorprrrrrrrs)rrrorprrrs)TNNNN)rr r rr rfrorprrr r rrr@r)rrr rrkrJrrrrfrorprrrrr)NNN) r#r$r rfrorprrrrrC)TNNN) rr'r rr rfrorprrrrrB)FFNNTNNNNNFNNN)$rr\r1rr#r2r3rr4rrkrlrrr rrrfrrr5r6r7r8rorprrr rr9rrrrrr) FFNNTNNNNNNNN)"r1rr#r2rrdr3rr4rrkrlrrr rrrfrrr5r6r7r8rorpr rr9rrrrrr)FNNNNNNN)rMrrNrr3rr rfrrr7r8rorpr rr9rrrrrrD) FNNNNNNNN)rMrrr2r3rr rfrrr5r6r7r8rorpr rr9rrrrrrD)rMrrr2r3rr5r6r rfrrr7r8rorpr rrrrrrD)rorprrrrrrrs) NNTNNNFNN)rr\r1rr4rrkrlrrr rrrr7r8rorprrr rrrrrr)NNTNNNNN)r1rr4rrkrlrrr rrrr7r8rorpr rrrrrr)NNNNN)rMrrrr7r8rorpr rrrrrrA)rMrrrrqrrrrl)rrrqrrrrp)rrrqrrrrq) rorprr\rirjrrtrrurrr) rr\rirjrrtrrrorprrr)rrrqrrrr)NN) rMrrorprrrqrrrr)rrrorprrdrrrL) rrrorprrrqrrrr)rrrorprqrrrr) rr:rorprrrqrrrrd)rorprrrqrrrrs) rr:rorprrrqrrrrs)rorprrrrr)rorprrrrr) rcrrorprrrqrrrr) rrrorprrrqrrrrd) rrrorprrrqrrrr) rcrdrorprrrqrrrrs) rcrdrrrorprrrqrrrrs)rrrrHrrrorprrr rrrrqrrrr) rrHrorpr rrrrqrrrr) rrHrorprrrqrrrrq) rrdrorprrrqrrrr)rrdrMrrorprrr7r8rqrrrr.)rMrrrr9rr3rfrrr5r6r7r8rorpr r rqrrrr)NNNNNN)rMrrrr9rr7r8rorpr rrrrqrrrrF)rMrrNrrrr9rr3rrrr7r8rorpr rrrrqrrrrF)rMrrr2rrr9rr3rrrr5r6r7r8rorpr rrrrqrrrrF)PrPrQrRrSrrrrrrrrpropertyrrcrarrr__iter__rnextrrrrrrrapplyrr"r&r0rIrLrQrUrVrZrardrirkrormrsrwr{rrrrrrrrrrrrrrrrrrrrrrrrrOrTrrrr __classcell__rVrVrrWr`sX         -    @ #i.@Oe7q|g0<+DB # =  / [//x!03,8!#&&."c0B[R]or`)xrS __future__rr collectionsrtypingrrrrrr r r r r rrrrrrrrbson.codec_optionsrr bson.objectidr bson.raw_bsonrbson.sonrbson.timestamprpymongorrrrr pymongo.asynchronous.aggregationr!r"pymongo.asynchronous.bulkr#"pymongo.asynchronous.change_streamr$#pymongo.asynchronous.command_cursorr%r&pymongo.asynchronous.cursorr'r(pymongo.collationr)pymongo.commonr*r+pymongo.errorsr,r-r.r/pymongo.helpers_sharedr0pymongo.messager1pymongo.operationsr2r3r4r5r6r7r8r9r:r;r<pymongo.read_concernr=pymongo.read_preferencesr>r?pymongo.resultsr@rArBrCrDpymongo.typingsrErFrGrHpymongo.write_concernrIrJrKrrLr_WriteOprObsonrX#pymongo.asynchronous.client_sessionrYrr[pymongo.asynchronous.poolr\pymongo.asynchronous.serverr]r^r_ BaseObjectr`rVrVrVrWsd  P         4