h`MdZddlZddlZddlmZddlmZddlmZm Z m Z m Z ddl m Z ddlmZddlmZdd lmZmZmZdd lmZmZdd lmZmZdd lmZmZdd lm Z ddl!m"Z"ddl#m$Z$ddl%m&Z&m'Z'ddl(m)Z)m*Z*m+Z+m,Z,m-Z-ddl.m/Z/m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8m9Z9m:Z:m;Z;mZ>dZ?ddiZ@dZAGddeBZCGddejZEy) z%Collection level utilities for Mongo.N)Code)ObjectId)_unicodeabc integer_types string_type)RawBSONDocument) CodecOptions)SON)commonhelpersmessage)_CollectionAggregationCommand _CollectionRawAggregationCommand)BulkOperationBuilder_Bulk) CommandCursorRawBatchCommandCursor) ORDERED_TYPES)validate_collation_or_noneCollectionChangeStream)CursorRawBatchCursor)BulkWriteErrorConfigurationError InvalidNameInvalidOperationOperationFailure)_check_write_command_response_raise_last_error)_UNICODE_REPLACE_CODEC_OPTIONS) IndexModel)ReadPreference)BulkWriteResult DeleteResultInsertOneResultInsertManyResult UpdateResult) WriteConcernz%s.%svaluezgeoHaystack indexes are deprecated as of MongoDB 4.4. Instead, create a 2d index and use $geoNear or $geoWithin. See https://dochub.mongodb.org/core/4.4-deprecate-geoHaystackceZdZdZdZ dZy)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__BEFOREAFTERU/var/www/html/ranktracker/api/venv/lib/python3.12/site-packages/pymongo/collection.pyr.r.AsF E;r6r.c<eZdZdZ dNfd ZdZdZ dOdZdZd Z d Z d Z d Z d Z edZedZedZ dPdZdQdZdQdZ dRdZdZdZ dSdZ dTdZ dRdZ dUdZ dVdZ dWdZ dXdZ dYdZdZdZ d[d Z! d\d!Z"d]d"Z#d]d#Z$dZd$Z%d%Z&d&Z'dZd'Z(d^d(Z) d^d)Z*d*Z+dZd+Z,d^d,Z-dZd-Z.d.Z/dZd/Z0d_d0Z1dZd1Z2dZd2Z3dZd3Z4dZd4Z5dZd5Z6dZd6Z7d7Z8dZd8Z9d9Z: d`d:Z;dZd;Zd>Z?dTd?Z@dTd@ZAdAZBdeCjdddfdBZE dPdCZFdddeCjddfdDZGdddeCjdddfdEZHdadFZI dbdGZJ dcdHZKdddIZLidddddfdJZMdKZNdLZOeOZPdMZQxZRS)e CollectionzA Mongo collection. FNc  tt| |xs |j|xs |j|xs |j |xs |j t|tstdtj|rd|vr tdd|vr0|jds|jdstd|z|dd k(s|d d k(rtd |zd |vr td t| jdd} ||_t!||_t$|jj&|j"fz|_|s| s| r|j+| | ||jj-dt.|_y)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. This option is only supported on MongoDB 3.4 and above. - `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:: 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__ .. versionchanged:: 2.2 Removed deprecated argument: options .. versionadded:: 2.1 uuid_subtype attribute .. mongodoc:: collections zname must be an instance of .. 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 collationNreplace)unicode_decode_error_handlerdocument_class)superr9__init__ codec_optionsread_preference write_concern read_concern isinstancer TypeErrorr/r startswithrpop_Collection__databaser_Collection__name_UJOINname_Collection__full_name_Collection__create_replacedict)_Collection__write_response_codec_options) selfdatabaserScreaterHrIrJrKsessionkwargsrB __class__s r7rGzCollection.__init__RsZ j$(  3X33  7x77  3X33  1H11  3 $ ,'2';';>? ?tt|@A A $; > $ 702678 8 7c>T"X_46:;< < T>/0 0.vzz+t/LM "tn !T__%9%94;;$GG Vy MM&)W 5.2.@.@.I.I)2/J/!+r6cl|jjj|j||SN)rPclient_socket_for_reads_read_preference_forrYr\s r7rbzCollection._socket_for_readss/%%77  % %g .9 9r6cL|jjj|Sr`)rPra_socket_for_writesrds r7rfzCollection._socket_for_writess%%88AAr6cJ|jjj| 5}|j|jj|||xs|j | |xs |j |||| d| ||jj| | cdddS#1swYyxYw)aInternal command helper. :Parameters: - `sock_info` - A SocketInfo instance. - `command` - The command itself, as a SON instance. - `slave_ok`: whether to set the SlaveOkay wire protocol bit. - `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`. This option is only valid for MongoDB 3.4 and above. - `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)rKrJparse_write_concern_errorrBr\raretryable_write user_fieldsN)rPra _tmp_sessioncommandrSrcrH)rY sock_inforlslave_okrIrHcheckallowable_errorsrKrJrBr\rirjss r7_commandzCollection._commandsJ__ # # 0 0 9 )Q$$$$E4#<##W  6 6 6 6s 5BBc |jdr*t|j|fz}td|d|d|d|j |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 _zCollection has no attribute z. To access the z collection, use database['z'].)rNrRrQAttributeError __getitem__)rYrS full_names r7 __getattr__zCollection.__getattr__ sQ ??3 $++t!44I )Y01 1%%r6c t|jt|j|fzd|j|j |j |jS)NF)r9rPrRrQrHrIrJrK)rYrSs r7rzCollection.__getitem__sM$// DKK#66,,..,,++ - -r6c<d|jd|jdS)Nz Collection(z, ))rPrQrYs r7__repr__zCollection.__repr__&s'+ DDr6ct|tr4|j|jk(xr|j|j k(St Sr`)rLr9rPrZrQrSNotImplementedrYothers r7__eq__zCollection.__eq__)s< eZ (OOu~~5.KK5::- /r6c||k( Sr`r5rs r7__ne__zCollection.__ne__/s5=  r6c|jS)zzThe full name of this :class:`Collection`. The full name is of the form `database_name.collection_name`. )rTrs r7rzCollection.full_name2s r6c|jS)z%The name of this :class:`Collection`.)rQrs r7rSzCollection.name:s{{r6c|jS)zdThe :class:`~pymongo.database.Database` that this :class:`Collection` is a part of. )rPrs r7rZzCollection.database?s r6c t|j|jd|xs |j|xs |j|xs |j |xs |j S)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. F)r9rPrQrHrIrJrK)rYrHrIrJrKs r7 with_optionszCollection.with_optionsFsY>$//++'=4+=+=)AT-A-A'=4+=+=&;$*;*; = =r6cTtjdtdt|d|S)aa**DEPRECATED** - Initialize an unordered batch of write operations. Operations will be performed on the server in arbitrary order, possibly in parallel. All operations will be attempted. :Parameters: - `bypass_document_validation`: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. Returns a :class:`~pymongo.bulk.BulkOperationBuilder` instance. See :ref:`unordered_bulk` for examples. .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 3.5 Deprecated. Use :meth:`~pymongo.collection.Collection.bulk_write` instead. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 2.7 z*initialize_unordered_bulk_op is deprecated stacklevelFwarningswarnDeprecationWarningrrYbypass_document_validations r7initialize_unordered_bulk_opz'Collection.initialize_unordered_bulk_opms(6  B(Q 8#D%1KLLr6cTtjdtdt|d|S)as**DEPRECATED** - Initialize an ordered batch of write operations. Operations will be performed on the server serially, in the order provided. If an error occurs all remaining operations are aborted. :Parameters: - `bypass_document_validation`: (optional) If ``True``, allows the write to opt-out of document level validation. Default is ``False``. Returns a :class:`~pymongo.bulk.BulkOperationBuilder` instance. See :ref:`ordered_bulk` for examples. .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 3.5 Deprecated. Use :meth:`~pymongo.collection.Collection.bulk_write` instead. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 2.7 z(initialize_ordered_bulk_op is deprecatedrrTrrs r7initialize_ordered_bulk_opz%Collection.initialize_ordered_bulk_ops(8  @(Q 8#D$0JKKr6c*tjd|t|||}|D]} |j||j |}|j||}| t|dStidS#t$rt |dwxYw)aU 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) ... {u'x': 1, u'_id': ObjectId('54f62e60fba5226811f634ef')} {u'x': 1, u'_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) ... {u'x': 1, u'_id': ObjectId('54f62e60fba5226811f634f0')} {u'y': 1, u'_id': ObjectId('54f62ee2fba5226811f634f1')} {u'z': 1, u'_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`. :Returns: An instance of :class:`~pymongo.results.BulkWriteResult`. .. seealso:: :ref:`writes-and-ids` .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 3.0 requestsz is not a valid requestTF) r validate_listr _add_to_bulkr~rMrxexecuter%) rYrorderedrr\blkrequestrJbulk_api_results r7 bulk_writezCollection.bulk_writesF Z2D'#=> JG J$$S) J //8 ++mW=  &"?D9 9r5))" Jw HII Js A::Bc |r|jdk\r td|jjj}|j } | rt j j} ||jfz}||\} } } | rrt j j z }|j||jj| |j|t j j} |j| | | d}| rb|t%j&|||}nddi}t j j z z}|j)|||| |j||S#t$r}| rt j j z z}t|trY|j }|j#drQd|vrMt%j&|||}|j)|||| |j|t%j*|}|j-|||| |j|d}~wwxYw)z,Internal legacy unacknowledged write helper.zGCannot set bypass_document_validation with unacknowledged write concernFoknNr,)max_wire_versionrrZra_event_listenersenabled_for_commandsdatetimenowcompression_contextpublish_command_startrPrSaddress legacy_write ExceptionrLdetailsgetr_convert_write_resultpublish_command_success_convert_exceptionpublish_command_failure)rYrmrSrzop_idbypass_doc_valfuncargs listenerspublishstartrqst_idmsgmax_sizedurationresultexcdurrreplys r7 _legacy_writezCollection._legacy_writes1 i88A="$CD DMM((99 00 %%))+Ey4466!%th ((,,.6H  + +T__))7I4E4Eu N%%))+E ++GS(EJF$ !55dCHq  ))--/%78CH  - -%w 0A0A5 J 5 ((,,.6(Bc#34!kkG{{4(SG^ ' = = #w!0!99gy7H7H%Q%88=G11$1B1BEK ! s7E11 I:CH??Ic  |rYjjttsdvr t d<jj xs j j tdjfd|fdgfg jsj d<  fd} jjj | |ttsjdSy)z0Internal helper for inserting a single document._idinsertr documents writeConcernc|jsLsJ j|d tj jgd j d j Sr|jdk\rdd<|j jj j | jj|}t|y)NrFrTbypassDocumentValidation)rJrH check_keysr\rari) op_msg_enabledrrrrTdocumentrXrrlrPrSrar ) r\rmrir acknowledgedrrrldocrrYrJs r7_insert_commandz/Collection._insert_one.._insert_commandBs++L))x%"GNND4D4DE:um.D.De77 99 )"<"<"A6:23&&$$+"AA%-- /'1F *& 1r6N)rP_apply_incoming_manipulatorsrLr r$_apply_incoming_copying_manipulatorsrJrr rSis_server_defaultrra_retryable_writer) rYrrr manipulaterJrrr\rrrls `` ` ``` @@r7 _insert_onezCollection._insert_one/s //>>sDICc?3S8H%ZE //FFsGKMC%;);); $11 $)),!7+#cU+-...&3&<& !0r6c  ttjrj|||||||Sg |r fd} n fd} |xsj |}t ||} | D cgc]} t j| fc} | _ | j|| Scc} w#t$r } t| jYd} ~ Sd} ~ wwxYw)zInternal insert helper.c3Kj}D]_}|j|}t|tsd|vs t |d<|j |}j |d|ayw)ztGenerator that applies SON manipulators to each document and adds _id if necessary. rN)rPrrLr rrappend)_dbrdocsidsrYs r7genzCollection._insert..genlswoo C::3EC&sO< %-ZE BB3MCJJs5z*I sA2A5c3KD]6}t|ts j|jd|8yw)z)Generator that only tracks existing _ids.rN)rLr rr)rrrs r7rzCollection._insert..gen}s9C%c?; 3775>2I s=Ar\N) rLrMappingrrxrr_INSERTopsrrr!r)rYrrrrrJrrr\rrrbwers`` @r7_insertzCollection._insert`s dCKK (##gz:}e) )  " &I)@)@)I D'>258U;cGOOS); + KK wK 7 < + ckk * *  +s3B*B// C8CCctjd|t|tsd|vs t |d<|j |}t |j|||||jS)aInsert 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}) {u'x': 1, u'_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`. :Returns: - An instance of :class:`~pymongo.results.InsertOneResult`. .. seealso:: :ref:`writes-and-ids` .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 3.0 rr)rJrr\) r validate_is_document_typerLr rrxr'rr)rYrrr\rJs r7 insert_onezCollection.insert_onesuL ((X>8_5(9J&jHUO//8  LL'4(B!(  *  & & ( (r6c0 ttjrs tdg  fd}|j |}t |||}|Dcgc]}|c}|_|j||t |jScc}w)aInsert 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`. :Returns: An instance of :class:`~pymongo.results.InsertManyResult`. .. seealso:: :ref:`writes-and-ids` .. note:: `bypass_document_validation` requires server version **>= 3.2** .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.2 Added bypass_document_validation support .. versionadded:: 3.0 z"documents must be a non-empty listc3KD]a}tjd|t|ts%d|vr t |d<j |dt j|fcyw)z6A generator that validates documents and handles _ids.rrN)r rrLr rrrr)rr inserted_idss r7rz#Collection.insert_many..gensd% 200XF!(O<H,*2* ''811  2sA(A+r) rLrIterablerMrxrrrr(r) rYrrrr\rrJrrrs ` @r7 insert_manyzCollection.insert_manysR)S\\2)@A A  2//8 D'#=>"%%(33( M7 3 m.H.HII)s Bctjd||r|jj||}t | } |xs |j }|j }td|fd|fd|fd|fg}| ,|jdkr td|s td| |d <| ,|jd kr td |s td | |d <|Q|jdkr td|s tdt|tstj|}||d<td|jfd| fd|gfg}|js|j |d<|j"sM|sK|j%|d|| | t&j(|j*||||d|j ||j,S| r|jdk\rd|d<|j/|jj|||j,||jj0|j3}t5||j7dr d|vrd|d<nd|d<d|vr|ddd|d<|sy|S)!Internal update / replace helper.upsertqumultiN4Must be connected to MongoDB 3.4+ to use collations.3Collation is unsupported for unacknowledged writes.rBz7Must be connected to MongoDB 3.6+ to use array_filters.6arrayFilters is unsupported for unacknowledged writes. arrayFilters.Must be connected to MongoDB 3.4+ to use hint..hint is unsupported for unacknowledged writes.hintrvrupdatesrFrTrrJrHr\rarirupsertedupdatedExistingrr)r validate_booleanrP _fix_incomingrrJrr rrrLrr _index_documentrSrrrrrrvrTrXrlracopyr r)rYrmcriteriarrrrrrJrrrrB array_filtersrr\rir update_docrlrs r7_updatezCollection._updates &1 44XtDH.y9 %;);); $11 3//"E*#V,./   ))A-(JLL!(IKK+4 ;'  $))A-(MOO!(LNN.; >*  ))A-(DFF!(DFFdK0..t4!%Jv $)),!7+!J<023..&3&<&._update[s?<<8Xf%Uz+5'-+$ /  1 1r6rPrarrJr)rYrrrrrrrJrrrrBrrr\rs`````````````` r7_update_retryablezCollection._update_retryableTsR 1 1 1%%66  0d00 > > Lu9 W r6c tjd|tj||j|}t |j |||||||||j S)a Replace a single document matching the filter. >>> for doc in db.test.find({}): ... print(doc) ... {u'x': 1, u'_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) ... {u'y': 1, u'_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}) {u'x': 1, u'_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``. This option is only supported on MongoDB 3.2 and above. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. This option is only supported on MongoDB 3.4 and above. - `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`. :Returns: - An instance of :class:`~pymongo.results.UpdateResult`. .. 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 filter)rJrrBrr\)r validate_is_mappingvalidate_ok_for_replacerxr)rr) rYr replacementrrrBrr\rJs r7 replace_onezCollection.replace_onehssD ""8V4&&{3//8   " " V+9#$ # A  & & ( (r6c tjd|tj|tjd||j |} t |j |||d| ||||| | jS)an Update a single document matching the filter. >>> for doc in db.test.find(): ... print(doc) ... {u'x': 1, u'_id': 0} {u'x': 1, u'_id': 1} {u'x': 1, u'_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) ... {u'x': 4, u'_id': 0} {u'x': 1, u'_id': 1} {u'x': 1, u'_id': 2} :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``. This option is only supported on MongoDB 3.2 and above. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. This option is only supported on MongoDB 3.4 and above. - `array_filters` (optional): A list of filters specifying which array elements an update should apply. This option is only supported on MongoDB 3.6 and above. - `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`. :Returns: - An instance of :class:`~pymongo.results.UpdateResult`. .. 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 rrF)rrJrrBrrr\r rvalidate_ok_for_updatevalidate_list_or_nonerxr)rr) rYrrvrrrBrrr\rJs r7 update_onezCollection.update_ones~ ""8V4%%f-$$_mD//8   " "5+9#=7 # ,  & &( (r6c tjd|tj|tjd||j |} t |j |||dd| ||||| | jS)aj Update one or more documents that match the filter. >>> for doc in db.test.find(): ... print(doc) ... {u'x': 1, u'_id': 0} {u'x': 1, u'_id': 1} {u'x': 1, u'_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) ... {u'x': 4, u'_id': 0} {u'x': 4, u'_id': 1} {u'x': 4, u'_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``. This option is only supported on MongoDB 3.2 and above. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. This option is only supported on MongoDB 3.4 and above. - `array_filters` (optional): A list of filters specifying which array elements an update should apply. This option is only supported on MongoDB 3.6 and above. - `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`. :Returns: - An instance of :class:`~pymongo.results.UpdateResult`. .. 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 rrFT)rrrJrrBrrr\r) rYrrvrrrrBrr\rJs r7 update_manyzCollection.update_manys| ""8V4%%f-$$_mD//8   " "5+9#=7 # ,  & &( (r6c|jjj|jj|j|j |j |j}|j|j|y)aAlias for :meth:`~pymongo.database.Database.drop_collection`. :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. The following two calls are equivalent: >>> db.foo.drop() >>> db.drop_collection("foo") .. versionchanged:: 3.7 :meth:`drop` now respects this :class:`Collection`'s :attr:`write_concern`. .. versionchanged:: 3.6 Added ``session`` parameter. rN) rPra get_databaserSrHrIrJrKdrop_collectionrQ)rYr\dbos r7dropzCollection.dropOsh$oo$$11 OO            DKK9r6c tjd||xs |j}|j} t d|fdt | fg} t |}|,|jdkr td| s td|| d<|Q|jdkr td| s td t|tstj|}|| d <t d |jfd |fd | gfg} |js|j| d<|j sT| sR|j#|d | |dt$j&|j(|d|j|j*t |  S|j-|j.j| ||j*| |j.j0| }t3||S)Internal delete helper.rrlimitrrrrBrrrdeleterdeletesrFr)r rrJrr intrrrrLrr r rSrrrrrr+rTrXrlrPrar )rYrmrrrJrrrBrr\rir delete_docrlrs r7_deletezCollection._deleteis ""8X6%;);); $11 3/"CE N356 .y9  ))A-(JLL!(IKK+4 ;'  ))A-(DFF!(DFFdK0..t4!%Jv $)),!7+!J<023..&3&<&._deletes1<<8U+5'#$ /  1 1r6r) rYrrrJrrrBrr\r/s ```````` r7_delete_retryablezCollection._delete_retryablesL  1 1%%66  0d00 > > Lu9 W r6c z|j|}t|j|d|||||jS)a!Delete 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`. This option is only supported on MongoDB 3.4 and above. - `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`. :Returns: - An instance of :class:`~pymongo.results.DeleteResult`. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the `collation` option. .. versionadded:: 3.0 FrJrBrr\rxr&r2rrYrrBrr\rJs r7 delete_onezCollection.delete_onesPH//8   " "+#$ # A  & & ( (r6c z|j|}t|j|d|||||jS)a'Delete 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`. This option is only supported on MongoDB 3.4 and above. - `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`. :Returns: - An instance of :class:`~pymongo.results.DeleteResult`. .. versionchanged:: 3.11 Added ``hint`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the `collation` option. .. versionadded:: 3.0 Tr4r5r6s r7 delete_manyzCollection.delete_manysPH//8   " "+#$ # A  & & ( (r6c|t|tjsd|i}|j|g|i|}|j dD]}|cSy)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) Nrr@)rLrrfindr*)rYrrr]cursorrs r7find_onezCollection.find_one s[2  63;;/V_F63D3F3ll2& FM r6c t|g|i|S)a)+Query the database. The `filter` argument is a prototype 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 SON object specifying elements which must be present for a document to be included in the result set - `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. - `manipulate` (optional): **DEPRECATED** - If True, apply any outgoing SON manipulators before returning. Default: True. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. This option is only supported on MongoDB 3.4 and above. - `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. - `modifiers` (optional): **DEPRECATED** - A dict specifying additional MongoDB query modifiers. Use the keyword arguments listed above instead. - `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:: 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. .. versionchanged:: 2.7 Added ``compile_re`` option. If set to False, PyMongo represented BSON regular expressions as :class:`~bson.regex.Regex` objects instead of attempting to compile BSON regular expressions as Python native regular expressions, thus preventing errors for some incompatible patterns, see `PYTHON-500`_. .. versionchanged:: 2.3 Added the ``tag_sets`` and ``secondary_acceptable_latency_ms`` parameters. .. _PYTHON-500: https://jira.mongodb.org/browse/PYTHON-500 .. mongodoc:: find )rrYrr]s r7r;zCollection.find+sPd,T,V,,r6cd|vr td|jjjr t dt |g|i|S)aQuery the database and retrieve batches of raw BSON. Similar to the :meth:`find` 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.find_raw_batches() >>> for batch in cursor: ... print(bson.decode_all(batch)) .. note:: find_raw_batches does not support sessions or auto encryption. .. versionadded:: 3.6 r\z*find_raw_batches does not support sessionsz1find_raw_batches does not support auto encryption)rrPra _encrypterrrr?s r7find_raw_batcheszCollection.find_raw_batchessZ.  $<> > ?? ! ! , ,"CE Ed4T4V44r6c &tjdtdtd|jfd|fg}|j ||j |5\}}|j|jj|||j||j|jd||jj }dddg}d D]0} |jt|| d j ||du 2|S#1swYExYw) a2**DEPRECATED**: Scan this entire collection in parallel. Returns a list of up to ``num_cursors`` cursors that can be iterated concurrently. As long as the collection is not modified during scanning, each document appears once in one of the cursors result sets. For example, to process each document in a collection using some thread-safe ``process_document()`` function: >>> def process_cursor(cursor): ... for document in cursor: ... # Some thread-safe processing function: ... process_document(document) >>> >>> # Get up to 4 cursors. ... >>> cursors = collection.parallel_scan(4) >>> threads = [ ... threading.Thread(target=process_cursor, args=(cursor,)) ... for cursor in cursors] >>> >>> for thread in threads: ... thread.start() >>> >>> for thread in threads: ... thread.join() >>> >>> # All documents have now been processed. The :meth:`parallel_scan` method obeys the :attr:`read_preference` of this :class:`Collection`. :Parameters: - `num_cursors`: the number of cursors to return - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs`: additional options for the parallelCollectionScan command can be passed as keyword arguments. .. note:: Requires server version **>= 2.5.5**. .. versionchanged:: 3.7 Deprecated. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added back support for arbitrary keyword arguments. MongoDB 3.4 adds support for maxTimeMS as an option to the parallelCollectionScan command. .. versionchanged:: 3.0 Removed support for arbitrary keyword arguments, since the parallelCollectionScan command has no optional arguments. zXparallel_scan is deprecated. MongoDB 4.2 will remove the parallelCollectionScan command.rrparallelCollectionScan numCursorsT)rKrhr\raNcursorsr<r\explicit_session)rrrr rQrvrbrlrPrSrcrHrKrarrr) rY num_cursorsr\r]rzrmrnrrFr<s r7 parallel_scanzCollection.parallel_scans(t  <(Q 8,dkk: +.01 6  # #G , /0EH&&$$))'2""!..*.--' /F /Y' HF NN=fX& (9(9'2EG H H ) / /s A)DDcfd}jjj|j||S)zInternal count helper.c j||dgjj|}|jdddk(ryt |dS)Nz ns missing)rprHrKrBr\errmsgrr)rrrXrKrr-)r\serverrmrnresrzrBrYs r7_cmdzCollection._count.._cmdrsb--"."AA!..# !Cwwx$ 4s3x= r6)rPra_retryable_readrc)rYrzrBr\rQs``` r7_countzCollection._countns9 !%%55 $++G4g? ?r6c ||j||||j|j||}|dd}|r|dSdS)zAInternal helper to run an aggregate that returns a single result.)rHrKrBr\r< firstBatchrN)rrrXrK)rYrmrnrzrBr\rbatchs r7_aggregate_one_resultz Collection._aggregate_one_resultsZ   ==**x . uQx*d*r6c d|vr tdtd|jfg}|j||j |S)a.Get 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: - `**kwargs` (optional): See list of options above. .. versionadded:: 3.7 r\z2estimated_document_count does not support sessionscount)rr rQrvrS)rYr]rzs r7estimated_document_countz#Collection.estimated_document_countsO$  $DF FGT[[)*+ 6{{3r6c Ld|ig}d|vr"|jd|jdid|vr"|jd|jdi|jddddid itd jfd |fd ifgd |vr.t |d t st j|d |d <t|jddj|fd}jjj|j||S)aF 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`. This option is only supported on MongoDB 3.4 and above. - `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)]). This option is only supported on MongoDB 3.6 and above. 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`_ | +-------------+-------------------------------------+ $expr requires MongoDB 3.6+ :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`. - `**kwargs` (optional): See list of options above. .. versionadded:: 3.7 .. _$expr: https://docs.mongodb.com/manual/reference/operator/query/expr/ .. _$geoWithin: https://docs.mongodb.com/manual/reference/operator/query/geoWithin/ .. _$center: https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center .. _$centerSphere: https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere z$matchskipz$skipr*z$limitz$groupr,z$sum)rr aggregatepipeliner<rrBNc>j|||}|sy|dS)Nrr)rW)r\rOrmrnrrzrBrYs r7rQz(Collection.count_documents.._cmds.//8S)W>F#; r6)rrOr rQrLrr r rrvrPrarRrc)rYrr\r]r^rQrzrBs` @@r7count_documentszCollection.count_documentss tv&' V  OOWfjj&89 : f  OOXvzz'':; <1FA;#?@AK-)b>#$ V Jvf~{$K$44VF^DF6N.vzz+t/LM  6 %%55 $++G4g? ?r6c xtjdtdtd|jfg}|d|vr t d||d<d|vr.t |dtstj|d|d<t|jd d}|j||j|||S) an **DEPRECATED** - Get the number of documents in this collection. The :meth:`count` method is deprecated and **not** supported in a transaction. Please use :meth:`count_documents` or :meth:`estimated_document_count` instead. All optional count 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. A limit of 0 (the default) is equivalent to setting no limit. - `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`. This option is only supported on MongoDB 3.4 and above. - `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` 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`_ | +-------------+-------------------------------------+ $expr requires MongoDB 3.6+ :Parameters: - `filter` (optional): A query document that selects which documents to count in the collection. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): See list of options above. .. versionchanged:: 3.7 Deprecated. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Support the `collation` option. .. _$expr: https://docs.mongodb.com/manual/reference/operator/query/expr/ .. _$geoWithin: https://docs.mongodb.com/manual/reference/operator/query/geoWithin/ .. _$center: https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center .. _$centerSphere: https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere zcount is deprecated. Use estimated_document_count or count_documents instead. Please note that $where must be replaced by $expr, $near must be replaced by $geoWithin with $center, and $nearSphere must be replaced by $geoWithin with $centerSphererrrYNquery can't pass both filter and queryrrB)rrrr rQrrLrr r rrOrvrS)rYrr\r]rzrBs r7rYzCollection.counts|  B )Q  8 GT[[)*+  & ()KLL$F7O V Jvf~{$K$44VF^DF6N.vzz+t/LM  6{{3 733r6c Vtjd||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`. - `**kwargs` (optional): optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments. .. note:: `create_indexes` uses the `createIndexes`_ command introduced in MongoDB **2.6** and cannot be used with earlier versions. .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation when using MongoDB >= 3.4. .. 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://docs.mongodb.com/manual/reference/command/createIndexes/ indexes)r r_Collection__create_indexes)rYrer\r]s r7create_indexeszCollection.create_indexesKs/J Y0$t$$Wg@@@r6c  g|j|5}|jdk\ |jdk\} fd}td|jfdt |fg}|j |d|vr |s t d|j||tjt|j||d d d S#1swYSxYw) 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. r c3 KD]y}t|tst|d|j}d|vr s t dd|vr t j ttdj|d|{yw)Nz4 is not an instance of pymongo.operations.IndexModelrBr bucketSizerrrS) rLr#rMrrrr _HAYSTACK_MSGrr)indexrrenamessupports_collationss r7 gen_indexesz0Collection.__create_indexes..gen_indexess$#E%eZ8'?DGHH %~~H"h.7J0677$x/ )+=!MLL&!12"N#sBB createIndexesre commitQuorumzRMust be connected to MongoDB 4.4+ to use the commitQuorum option for createIndexes)rIrHrJr\N) rfrr rSlistrvrrrr$rwr"rx) rYrer\r]rmsupports_quorumrprzrnros ` @@r7__create_indexeszCollection.__create_indexesss  $ $W -" !"+"<"<"A '88A=O #$3!4 #679:C JJv '(<== MM30F0F<"55g>  !=" !F G" !F s B)C  Cc ~i}d|vr|jd|d<t|fi|}|j|g|fi|dS)aMCreates 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.GEOHAYSTACK`, :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. Requires MongoDB >=3.2. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. Requires MongoDB >= 3.4. - `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 when using MongoDB >= 3.4. :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`. - `**kwargs` (optional): any additional index creation options (see the above list) should be passed as keyword arguments .. 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. .. mongodoc:: indexes .. _wildcard index: https://docs.mongodb.com/master/core/index-wildcard/#wildcard-index-core maxTimeMSr)rOr#rf)rYkeysr\r] cmd_optionsrms r7 create_indexzCollection.create_indexsUF & '-zz+'>K $4*6*$t$$eWgEEaHHr6c jtjdtdt|tst|t s t dd|vr|jd|d<d|vr|jd|d<t|fi|}|jd }|jjj|jj|j|s\|j|gd |jjj!|jj|j|||Sy ) z**DEPRECATED** - Ensures that an index exists on this collection. .. versionchanged:: 3.0 **DEPRECATED** z5ensure_index is deprecated. Use create_index instead.rrz&cache_for must be an integer or float. drop_dupsdropDups bucket_sizerkrSNr)rrrrLrrurMrOr#rrPra_cachedrSrQrf _cache_index)rY key_or_list cache_forr]rmrSs r7 ensure_indexzCollection.ensure_index s   M(Q 89m49e,DE E & !'K!8F:  F "#)::m#= 3.4. .. 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. r\N)*)rPra _purge_indexrSrQ drop_index)rYr\r]s r7 drop_indexeszCollection.drop_indexes1sB2 ++DOO,@,@$++N7W77r6c "|}t|trtj|}t|ts t d|j jj|j j|j|td|jfd|fg}|j||j|5}|j||tj ddg|j#||dddy#1swYyxYw)aDrops 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` or :meth:`ensure_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`. - `**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 when using MongoDB >= 3.4. .. 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. z+index_or_name must be an index name or list dropIndexesrmz ns not found)rIrprJr\N)rLrsr _gen_index_namerrMrPrarrSrQr rvrfrrr$rwrx)rY index_or_namer\r]rSrzrms r7rzCollection.drop_indexMsJ mT ***=9D$ ,IJ J ++ OO $++t 5M4;;/'4AB 6  $ $W - + MM)*8*@*@,:B+?(,(?(?(H")  + + + +s 7DDc tjdtdtd|jfg}|j ||j |5}|j||tj|cdddS#1swYyxYw)aRebuilds all indexes on this collection. **DEPRECATED** - The :meth:`~reindex` method is deprecated and will be removed in PyMongo 4.0. Use :meth:`~pymongo.database.Database.command` to run the ``reIndex`` command directly instead:: db.command({"reIndex": ""}) .. note:: Starting in MongoDB 4.6, the `reIndex` command can only be run when connected to a standalone mongod. :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): optional arguments to the reIndex command (like maxTimeMS) can be passed as keyword arguments. .. warning:: reindex blocks all other operations (indexes are built in the foreground) and will be slow for large collections. .. versionchanged:: 3.11 Deprecated. .. versionchanged:: 3.6 Added ``session`` parameter. Added support for arbitrary keyword arguments. .. versionchanged:: 3.5 We no longer apply this collection's write concern to this operation. MongoDB 3.4 silently ignored the write concern. MongoDB 3.6+ returns an error if we include the write concern. .. versionchanged:: 3.4 Apply this collection's write concern automatically to this operation when connected to MongoDB >= 3.4. zThe reindex method is deprecated and will be removed in PyMongo 4.0. Use the Database.command method to run the reIndex command instead.rrreIndex)rIr\N) rrrr rQrvrfrrr$rw)rYr\r]rzrms r7reindexzCollection.reindexsL  1)Q 8It{{+,- 6  $ $W - !==30F0F!! ! ! !s #BB cttjtj|xr|j xstjfd}j jj||S)a&Get 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`. :Returns: An instance of :class:`~pymongo.command_cursor.CommandCursor`. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionadded:: 3.0 )rHrIc td jfdifg}|jdkDrf jjj |d5} j ||| |d}dddt |j|du Stj| jjd d jid| | jjj }|d}t ||jS#t$r}|jdk7rdgd}Yd}~d}~wwxYw#1swYxYw) N listIndexesr<rFrrr)idrUrGzsystem.indexesns)r rQrrPrarkrrrcoderrr _first_batchrSrTrZr) r\rOrmrnrzrqr<rrPrHcoll read_prefrYs r7rQz%Collection.list_indexes.._cmdsW t{{3h^DEC))A-__++88%H =A =!%y#x/8/<78"/":;C"D =%T693D3D-.6=T6IKK**t335E4++,a=sMM((99 ; X%T693D3DEE%,=88r>!()!< = = =s0D5D  D2D-(D5-D22D55D>) r r rr$rw_txn_read_preferencerPrarR)rYr\rQrHrrs` @@@r7 list_indexeszCollection.list_indexess(%S)   }1?1G1G!I@'">">"@/&..  F:%%55 )W& &r6c|j|}i}|D]7}|dj|d<t|}|||jd<9|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) u'x_1' >>> db.test.index_information() {u'_id_': {u'key': [(u'_id', 1)]}, u'x_1': {u'unique': True, u'key': [(u'x', 1)]}} :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. .. versionchanged:: 3.6 Added ``session`` parameter. rkeyrS)ritemsrWrO)rYr\r<informs r7index_informationzCollection.index_informationsd4""7"3 ,E <--/E%LKE&+D6" # , r6c`|jjj|jj|j|j |j |j}|j|d|ji}d}|D]}|}n|siS|jdi}d|vr|d=|S)aGet 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`. .. versionchanged:: 3.6 Added ``session`` parameter. rS)r\rNryr[) rPrar$rSrHrIrJrKlist_collectionsrQr)rYr\r&r<rrrys r7ryzCollection.options soo$$11 OO            %%VT[[$9&; CF  I**Y+ w !r6c Rd}d|vrBtjdtdtjd|j dd}||||||dddii| }|j jj|j|j|||j S) NT useCursorzEThe useCursor option is deprecated and will be removed in PyMongo 4.0rrr<rUr,)rj use_cursor) retryable) rrrr r rOrPrarR get_cursorget_read_preference_performs_write) rYaggregation_commandr^ cursor_classr\rHr]rrzs r7 _aggregatezCollection._aggregate8 s & MM5"q 2 00VZZ T:= 3.4. :Parameters: - `pipeline`: a list of aggregation pipeline stages - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): See list of options above. :Returns: A :class:`~pymongo.command_cursor.CommandCursor` over the result set. .. 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. .. versionchanged:: 2.7 When the cursor option is used, return :class:`~pymongo.command_cursor.CommandCursor` instead of :class:`~pymongo.cursor.Cursor`. .. versionchanged:: 2.6 Added cursor support. .. versionadded:: 2.3 .. seealso:: :doc:`/examples/aggregation` .. _aggregate command: https://docs.mongodb.com/manual/reference/command/aggregate F)closeNrG)rPrarkrrr)rYr^r\r]rqs r7r]zCollection.aggregateK slR__ # # 0 0 0 F -!"4??#@#+#0-,-4;44G - &, - - - -s "AAc d|vr td|jjjr t d|j t |tfddd|S)aPerform 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 sessions or auto encryption. .. versionadded:: 3.6 r\z/aggregate_raw_batches does not support sessionsz6aggregate_raw_batches does not support auto encryptionNFrG)rrPrarArrrr)rYr^r]s r7aggregate_raw_batchesz Collection.aggregate_raw_batches sz0  $AC C ?? ! ! , ,"HJ Jt?'4)(,05 ) "( ) )r6c *t|||||||||| 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. Introduced in MongoDB 3.6. .. 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'. 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. - `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. :Returns: A :class:`~pymongo.change_stream.CollectionChangeStream` cursor. .. versionchanged:: 3.9 Added the ``start_after`` parameter. .. versionchanged:: 3.7 Added the ``start_at_operation_time`` parameter. .. versionadded:: 3.6 .. mongodoc:: changeStreams .. _change streams specification: https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst r) rYr^ full_document resume_aftermax_await_time_ms batch_sizerBstart_at_operation_timer\ start_afters r7watchzCollection.watch s+F& (M<9J  #:G  r6c tjdtdi}t|trt ||d<n|dt j|di}|j|d<t ||d<||d <||d <|t ||d <td |fg}t|jd d} |j||jd5\} } |j| || | ddidcdddS#1swYyxYw)a Perform a query similar to an SQL *group by* operation. **DEPRECATED** - The group command was deprecated in MongoDB 3.4. The :meth:`~group` method is deprecated and will be removed in PyMongo 4.0. Use :meth:`~aggregate` with the `$group` stage or :meth:`~map_reduce` instead. .. versionchanged:: 3.5 Deprecated the group method. .. versionchanged:: 3.4 Added the `collation` option. .. versionchanged:: 2.2 Removed deprecated argument: command zThe group method is deprecated and will be removed in PyMongo 4.0. Use the aggregate method with the $group stage or the map_reduce method instead.rrz$keyfNrrz$reducecondinitialfinalizegrouprBrretvalr,)rBrj)rrrrLrrr _fields_list_to_dictrQr rrOrvrbrr) rYr conditionrreducerr]rrzrBrmrns r7rzCollection.group, s'  @)Q 8 c; '!#YE'N _G88eDEEkkd <i!f "i   $XE* GU#$%.vzz+t/LM  6  # #D # 1 F5Ji==C+4.6]!<= 3.4. .. 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 r;r<rr?r@z.collecion names must not start or end with '.'r=r>z%collection names must not contain '$'renameCollectiontoadminT)rJrhr\raN)rLrrMr/rrNrPrSr rTrv_write_concern_for_cmdrfrarkrl)rYnew_namer\r]rzrJrmrqs r7renamezCollection.renameT sn:(K00;0D0DGH H48+@A A A;# "!4NO O (?8#6#6}#EEF F"oo22H=&(8(89D(;KLM 633CA  $ $W - >''44W= > ((S"/.2doo&<&< )> > > > > > > > > > >s$#&E +E4 EE EE&c t|tstdtjt dj fd|fg|d|vr t d||d<t|jddj|fd}jjj|j||S) aGet 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`. This option is only supported on MongoDB 3.4 and above. 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`. - `**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 distinctrNrbrcrBc Rj||j|ddidS)Nvaluesr,)rKrBr\rj)rrrK)r\rOrmrnrzrBrYs r7rQz!Collection.distinct.._cmd s>==3t7H7H#W%qM!+,45 5r6)rLrrMr/r rQrrrOrvrPrarRrc)rYrrr\r]rQrzrBs` @@r7rzCollection.distinct sF#{+0;0D0DGH HJ ,3<!"  & ()KLL$F7O.vzz+t/LM  6 5 %%55 $++G4g? ?r6c td|jfd|fd|fd|fg}t|jdd}|j |d|v} | rdd i} nd} |xr|j xs|}|j jj||5\} } | jd k\rd |vr| r |j} nd} d |vr| s|j|}nd}|j| || || |||| cdddS#1swYyxYw)zInternal mapReduce helper. mapReducemaproutrBNinlineresultsr,r readConcernr)rKrJrBr\rj) r rQrrOrvrrPrarbrrKrxrr)rYrrrr\rr]rzrBrrjrmrnrKrJs r7 _map_reducezCollection._map_reduce s9K-3<f%3<!"/vzz+t/LM  6S $a.KK@'">">"@"! __ # # 5 5i I )N%8**a/"#-#00 # S( $ 7 7 @ $ ==3))+#W' !) ) ) )s AC>>Dc t|ttjfst dtj d|j ||||tjfi|}|s|jds|St|dtr,|dd}|dd} |jj|| S|j|dS)a* Perform a map/reduce operation on this collection. If `full_response` is ``False`` (default) returns a :class:`~pymongo.collection.Collection` instance containing the results of the operation. Otherwise, returns the full response from the server to the `map reduce command`_. :Parameters: - `map`: map function (as a JavaScript string) - `reduce`: reduce function (as a JavaScript string) - `out`: output collection name or `out object` (dict). See the `map reduce command`_ documentation for available options. Note: `out` options are order sensitive. :class:`~bson.son.SON` can be used to specify multiple options. e.g. SON([('replace', ), ('db', )]) - `full_response` (optional): if ``True``, return full response to this command - otherwise just return the result collection - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): additional arguments to the `map reduce command`_ may be passed as keyword arguments to this helper method, e.g.:: >>> db.test.map_reduce(map, reduce, "myresults", limit=2) .. note:: The :meth:`map_reduce` method does **not** obey the :attr:`read_preference` of this :class:`Collection`. To run mapReduce on a secondary use the :meth:`inline_map_reduce` method instead. .. note:: The :attr:`~pymongo.collection.Collection.write_concern` of this collection is automatically applied to this operation (if the output is not inline) when using MongoDB >= 3.4. .. 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. .. seealso:: :doc:`/examples/aggregation` .. versionchanged:: 3.4 Added the `collation` option. .. versionchanged:: 2.2 Removed deprecated arguments: merge_output and reduce_output .. _map reduce command: http://docs.mongodb.org/manual/reference/command/mapReduce/ .. mongodoc:: mapreduce z'out' must be an instance of z or a mappingrdb collection) rLrrrrMr/rr$rwrrWrPra) rYrrr full_responser\r]responsedbasers r7 map_reducezCollection.map_reduce sn# S[[9:1<1E1EHI I$4##Cg$2$:$:F>DF  X 6O *D 1X&t,EH%l3D??))%06 6??8H#56 6r6c r|j||ddi||jfi|}|r|S|jdS)a Perform an inline map/reduce operation on this collection. Perform the map/reduce operation on the server in RAM. A result collection is not created. The result set is returned as a list of documents. If `full_response` is ``False`` (default) returns the result documents in a list. Otherwise, returns the full response from the server to the `map reduce command`_. The :meth:`inline_map_reduce` method obeys the :attr:`read_preference` of this :class:`Collection`. :Parameters: - `map`: map function (as a JavaScript string) - `reduce`: reduce function (as a JavaScript string) - `full_response` (optional): if ``True``, return full response to this command - otherwise just return the result collection - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): additional arguments to the `map reduce command`_ may be passed as keyword arguments to this helper method, e.g.:: >>> db.test.inline_map_reduce(map, reduce, limit=2) .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the `collation` option. rr,r)rrIr)rYrrrr\r]rPs r7inline_map_reducezCollection.inline_map_reduce. sMBdsFXqM7#33?7=? J779% %r6c`|jd}| tdi|S|j|S)Nrr5)rr*rx)rYrzr\raw_wcs r7rz!Collection._write_concern_for_cmdW s5(  )&) )**73 3r6c   tjd|t|ts t dt | j dd tdjfd|fd|fg j| |tj|d d <|tj| d <|tjd || d <%ttstjj |   fd } j j"j% j&| |S) zInternal findAndModify helper.rzEreturn_document must be ReturnDocument.BEFORE or ReturnDocument.AFTERrBN findAndModifyrbnew projectionfieldssortrc 6|jdkr td js tdd<6|jdkr td js tdd<|jd k\r js jd <j |t j ||t }t||jd S) Nrz6Must be connected to MongoDB 3.6+ to use arrayFilters.rrz.Must be connected to MongoDB 4.2+ to use hint.rrrr)rIrJrBr\rirjr+) rrrrrrrr$rw_FIND_AND_MODIFY_DOC_FIELDSr r) r\rmrirrrzrBrrYrJs r7_find_and_modifyz6Collection.__find_and_modify.._find_and_modify{ s (--1,())%11,"##'4N#--1,HJJ$11,HJJ"F **a/%77&3&<&<N#-- 30>0F0F.;*3W0?,G  IC *# .777# #r6)r rrLbool ValueErrorrrOr rQrvr rr r rrrPrarr)rYrrrrreturn_documentrrr\r]rrzrBrJs` `` @@@r7__find_and_modifyzCollection.__find_and_modify^ sF ""8V4/40MN N.vzz+t/LM OT[[1V$?+-. 6  !#889EGCM  !11$7CK    # #Hf 5"CM  dK0..t433CA  $ $@%%66  & &(8'C Cr6c <d|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}) {u'x': 1, u'_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) ... {u'x': 1, u'_id': 0} {u'x': 1, u'_id': 1} {u'x': 1, u'_id': 2} >>> db.test.find_one_and_delete( ... {'x': 1}, sort=[('_id', pymongo.DESCENDING)]) {u'x': 1, u'_id': 2} The *projection* option can be used to limit the fields returned. >>> db.test.find_one_and_delete({'x': 1}, projection={'_id': False}) {u'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`. - `**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 ``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 Tremoverr\)_Collection__find_and_modify)rYrrrrr\r]s r7find_one_and_deletezCollection.find_one_and_delete s@F x%t%%fj$L+/LDJL Lr6c  jtj||| d<|j|||||f||d| S)a Finds 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) ... {u'x': 1, u'_id': 0} {u'x': 1, u'_id': 1} {u'x': 1, u'_id': 2} >>> db.test.find_one_and_replace({'x': 1}, {'y': 1}) {u'x': 1, u'_id': 0} >>> for doc in db.test.find({}): ... print(doc) ... {u'y': 1, u'_id': 0} {u'x': 1, u'_id': 1} {u'x': 1, u'_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`. - `**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.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 rvr)r rr) rYrrrrrrrr\r]s r7find_one_and_replacezCollection.find_one_and_replace sST &&{3&x%t%%fj&*FOL+/LDJL Lr6c  tj|tjd||| d<|j||||||f|| d| S)aFinds 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}}) {u'_id': 665, u'done': False, u'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) {u'_id': u'userid', u'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) {u'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) {u'seq': 1} If multiple documents match *filter*, a *sort* can be applied. >>> for doc in db.test.find({'done': True}): ... print(doc) ... {u'_id': 665, u'done': True, u'result': {u'count': 26}} {u'_id': 701, u'done': True, u'result': {u'count': 17}} >>> db.test.find_one_and_update( ... {'done': True}, ... {'$set': {'final': True}}, ... sort=[('_id', pymongo.DESCENDING)]) {u'_id': 701, u'done': True, u'result': {u'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. This option is only supported on MongoDB 3.6 and above. - `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`. - `**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 rrvr)r rrr) rYrrvrrrrrrr\r]s r7find_one_and_updatezCollection.find_one_and_update5 sjj %%f-$$_mD!x%t%%fj&*FO&3A:>.5A:@A Ar6c jtjdtdtjd|d}t |j dd}|r td i|}t|tsd|vs|j|d|||S|jd|di|d|d ||| |jdS) aSave a document in this collection. **DEPRECATED** - Use :meth:`insert_one` or :meth:`replace_one` instead. .. versionchanged:: 3.0 Removed the `safe` parameter. Pass ``w=0`` for unacknowledged write operations. z9save is deprecated. Use insert_one or replace_one insteadrrto_saveNrBrTFrBr5) rrrr rrrOr*rLr rrr)rYrrrr]rJrBs r7savezCollection.save s   !3 C((G< .vzz+t/LM (262M7O48H<<z:}F F  " "'$E:}# # %;;u% %r6c tjdtdd}|r tdi|}|j || |||S)a Insert a document(s) into this collection. **DEPRECATED** - Use :meth:`insert_one` or :meth:`insert_many` instead. .. versionchanged:: 3.0 Removed the `safe` parameter. Pass ``w=0`` for unacknowledged write operations. z)>& MC Cr6c jtjdtdtjd|tjd||r't t |}|jdrd}d} t|jd d} |r td i|} |j||||||| | S) a'Update a document(s) in this collection. **DEPRECATED** - Use :meth:`replace_one`, :meth:`update_one`, or :meth:`update_many` instead. .. versionchanged:: 3.0 Removed the `safe` parameter. Pass ``w=0`` for unacknowledged write operations. zIupdate is deprecated. Use replace_one, update_one or update_many instead.rrspecrr=FNrBrr5) rrrr rnextiterrNrrOr*r) rYrrrrrrr]firstrJrBs r7rvzCollection.update s  -.@Q P""640"":x8  h(E$"  .vzz+t/LM (262M%% (FJz Y&0 0r6c tjdtd|i}t|tj sd|i}d}t |jdd}|r tdi|}|j||||S) a Remove a document(s) from this collection. **DEPRECATED** - Use :meth:`delete_one` or :meth:`delete_many` instead. .. versionchanged:: 3.0 Removed the `safe` parameter. Pass ``w=0`` for unacknowledged write operations. z._find_and_modifyL sd**a/%77&3&<&<N#]]30F0F#7 #9F *& 1Mr6r+)rrrrrrLrsr r rrWlenrMrOrrr rQrvrrPrarr _fix_outgoing)rYrbrvrrrrr]rrrrrzrBrJs` @@@r7find_and_modifyzCollection.find_and_modify s  O(Q 8fjj48;< < fjj40>? ? #F7O %F8  %F8  $%!(!8!8!>vT=1T4(SY!^ N0Q@"&v!566Hd+  &;;FHMF8 .vzz+t/LM OT[[123 633C>  oo$$55  & &(8$@ Jwww'H??884HOr6c|Sr`r5rs r7__iter__zCollection.__iter__d s r6ctd)Nz#'Collection' object is not iterable)rMrs r7__next__zCollection.__next__g s=>>r6cd|jvrtd|jztd|jjddz)zJThis 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@)rQrMsplitr?s r7__call__zCollection.__call__l sc dkk !&!KK () ) A ))#.r234 4r6)FNNNNN) FNNTNNNNNFN)NNNN)F)TFN)TTFNNFN)FN) FTFFNNTFNNNNF) FTFFNNTFNNNN)FFNNN)FFNNNN)FNFNNNr`)NNTNNNF)NNTNNN)NNN)NN)i,) NNNNNNNNN)TT)TTF)FFFT)NT)Sr/r0r1r2rGrbrfrrrUrrrrrpropertyrrSrZrrrrrrrrrrrrr r"r'r/r2r7r9r=r;rBrJrSrWrZr`rYrgrfrzrrrrrrryrr]rrrrrrrrrr.r3rrrrrrrvrr r r rr __classcell__)r^s@r7r9r9Ns4DHHLm!^9B5:!%BF"#!&!5)n 6& -E !   @D6:%=NM>L@,0=AP*d/b/"b6:<@.2,\?D0(d.2>B:Jx=B9>8 Vr.35:48@D# (7<@D'+L(\16.3<@K(ZGK@D'+J(X:859EJ6t59/3 *(X*(X DH-T 5DUn?,EI + 2P?dM4^&AP/bgIR"H886+p/!b8&t D$L/&O-b&)PEIAEFJfP&FP3>j5?n%)NE7N'&R4BF*8*?*?(,4>CB>B$(ELP)-4-;-B-B"&NLb(,$u,:,A,A*.T4{Az&8.227C$?D'+0BC,%'t$4u#(KZ? D 4r6r9)Fr2rr bson.coder bson.objectidrbson.py3compatrrrr bson.raw_bsonr bson.codec_optionsr bson.sonr pymongor r rpymongo.aggregationrr pymongo.bulkrrpymongo.command_cursorrrpymongo.commonrpymongo.collationrpymongo.change_streamrpymongo.cursorrrpymongo.errorsrrrrrpymongo.helpersr r!pymongo.messager"pymongo.operationsr#pymongo.read_preferencesr$pymongo.resultsr%r&r'r(r)pymongo.write_concernr*rRrrlobjectr. BaseObjectr9r5r6r7r*s,"))*+C4G(881.. 0:)3++ / &lE