h>dZddlZddlmZddlmZddlmZddlm Z m Z m Z ddl m Z ddlmZmZdd lmZdd lmZdd lmZdd lmZdd lmZmZmZmZddlmZddl m!Z!ddl"m#Z#ddl$m%Z%dddiiZ&ddddiiiZ'dZ(GddejRZ*Gdde+Z,y)zDatabase level operations.N)Code)DEFAULT_CODEC_OPTIONS)DBRef) iteritems string_type_unicode)SON)authcommon)_DatabaseAggregationCommandDatabaseChangeStream Collection) CommandCursor)CollectionInvalidConfigurationError InvalidNameOperationFailure) _first_batch)ReadPreference)SONManipulator)DEFAULT_WRITE_CONCERNnamez$regexz ^(?!.*\$)filterz ^(?!system\.)cP|s tddD]}||vstd|zy)z'Check if a database name is valid. z(database name cannot be the empty string) .$/\"z.database names cannot contain the character %rN)r)r invalid_chars S/var/www/html/ranktracker/api/venv/lib/python3.12/site-packages/pymongo/database.py _check_namer&+sD DEE?= 4 -/;<= ==c 2eZdZdZ d:fd ZdZedZedZedZ edZ ed Z ed Z ed Z d:d Zd ZdZdZdZdZ d:dZ d;dZdZdZdZdZdd!Z#d>d"Z$ d?d#Z%dd)Z+d? ? ;   tn  ')$/1,')$/1,r'ctjdtdtfd}|j rL||dr|j j d|||dr|jj d|yy||dr|jj d|||dr|jj d|yy) zAdd a new son manipulator to this database. **DEPRECATED** - `add_son_manipulator` is deprecated. .. versionchanged:: 3.0 Deprecated add_son_manipulator. z!add_son_manipulator is deprecated stacklevelc^t||jt|jk7S)z(Test if this method has been overridden.)getattr__func__)instancemethodbases r%method_overwrittenz8Database.add_son_manipulator..method_overwrittens0&""*(gdF.C.L.LM Nr'transform_incomingrtransform_outgoingN) warningswarnDeprecationWarningr will_copyr8insertr:r7r9)r; manipulatorrHrGs @r%add_son_manipulatorzDatabase.add_son_manipulatorys  9(Q 8 N  "!+/CD44;;A{K!+/CD44;;A{KE"+/CD,,33A{C!+/CD,,33A{CEr'ct|S)z**DEPRECATED**: :class:`SystemJS` helper for this :class:`Database`. See the documentation for :class:`SystemJS` for more details. )SystemJSr;s r% system_jszDatabase.system_jss ~r'c|jS)z/The client instance for this :class:`Database`.)r6rTs r%r<zDatabase.clients}}r'c|jS)z#The name of this :class:`Database`.)r5rTs r%rz Database.names{{r'ctjdtd|jDcgc]}|jj c}Scc}w)z**DEPRECATED**: All incoming SON manipulators. .. versionchanged:: 3.5 Deprecated. .. versionadded:: 2.0 z.Database.incoming_manipulators() is deprecatedr?r@)rKrLrMr7r=r4r;rPs r%incoming_manipulatorszDatabase.incoming_manipulatorsP  F(Q 8$(#?#?A%%..A AAA ctjdtd|jDcgc]}|jj c}Scc}w)z**DEPRECATED**: All incoming SON copying manipulators. .. versionchanged:: 3.5 Deprecated. .. versionadded:: 2.0 z6Database.incoming_copying_manipulators() is deprecatedr?r@)rKrLrMr8r=r4rYs r%incoming_copying_manipulatorsz&Database.incoming_copying_manipulatorsP  N(Q 8$(#G#GI%%..I IIr\ctjdtd|jDcgc]}|jj c}Scc}w)z**DEPRECATED**: All outgoing SON manipulators. .. versionchanged:: 3.5 Deprecated. .. versionadded:: 2.0 z.Database.outgoing_manipulators() is deprecatedr?r@)rKrLrMr9r=r4rYs r%outgoing_manipulatorszDatabase.outgoing_manipulatorsr[r\ctjdtd|jDcgc]}|jj c}Scc}w)z**DEPRECATED**: All outgoing SON copying manipulators. .. versionchanged:: 3.5 Deprecated. .. versionadded:: 2.0 z6Database.outgoing_copying_manipulators() is deprecatedr?r@)rKrLrMr:r=r4rYs r%outgoing_copying_manipulatorsz&Database.outgoing_copying_manipulatorsr_r\c t|j|j|xs |j|xs |j|xs |j |xs |j S)aCGet a clone of this database changing the specified settings. >>> db1.read_preference Primary() >>> from pymongo import ReadPreference >>> db2 = db1.with_options(read_preference=ReadPreference.SECONDARY) >>> db1.read_preference Primary() >>> db2.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. .. versionadded:: 3.8 )r)r<r5r.r/r0r1)r;r.r/r0r1s r% with_optionszDatabase.with_optionssWB  %;););'?4+?+?%;););$9(9(9 ; ;r'ct|tr4|j|jk(xr|j|j k(St SN)r2r)r6r<r5rNotImplementedr;others r%__eq__zDatabase.__eq__ s< eX &MMU\\1.KK5::- /r'c||k( Srgris r%__ne__zDatabase.__ne__s5=  r'c<d|jd|jdS)Nz Database(z, ))r6r5rTs r%__repr__zDatabase.__repr__s%)]]DKK@@r'c p|jdrtd|d|d|d|j|S)Get a collection of this database by name. Raises InvalidName if an invalid collection name is used. :Parameters: - `name`: the name of the collection to get _zDatabase has no attribute z. To access the z collection, use database[z].) startswithAttributeError __getitem__r;rs r% __getattr__zDatabase.__getattr__s? ??3  48$FG G%%r'ct||S)rsrrxs r%rwzDatabase.__getitem__$s$%%r'c $t||d||||S)agGet a :class:`~pymongo.collection.Collection` with the given name and options. Useful for creating a :class:`~pymongo.collection.Collection` with different codec options, read preference, and/or write concern from this :class:`Database`. >>> db.read_preference Primary() >>> coll1 = db.test >>> coll1.read_preference Primary() >>> from pymongo import ReadPreference >>> coll2 = db.get_collection( ... 'test', read_preference=ReadPreference.SECONDARY) >>> coll2.read_preference Secondary(tag_sets=None) :Parameters: - `name`: The name of the collection - a string. - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. If ``None`` (the default) the :attr:`codec_options` of this :class:`Database` is used. - `read_preference` (optional): The read preference to use. If ``None`` (the default) the :attr:`read_preference` of this :class:`Database` 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:`Database` is used. - `read_concern` (optional): An instance of :class:`~pymongo.read_concern.ReadConcern`. If ``None`` (the default) the :attr:`read_concern` of this :class:`Database` is used. Fr)r;rr.r/r0r1s r%get_collectionzDatabase.get_collection.s"N $}o <) )r'c |jj|5}|r |js%||jd|i|vrt d|zt ||d||||fd|i|cdddS#1swYyxYw)a& Create a new :class:`~pymongo.collection.Collection` in this database. Normally collection creation is automatic. This method should only be used to specify options on creation. :class:`~pymongo.errors.CollectionInvalid` will be raised if the collection already exists. Options should be passed as keyword arguments to this method. Supported options vary with MongoDB release. Some examples include: - "size": desired initial size for the collection (in bytes). For capped collections this size is the max size of the collection. - "capped": if True, this is a capped collection - "max": maximum number of objects if capped (optional) See the MongoDB documentation for a full list of supported options by server version. :Parameters: - `name`: the name of the collection to create - `codec_options` (optional): An instance of :class:`~bson.codec_options.CodecOptions`. If ``None`` (the default) the :attr:`codec_options` of this :class:`Database` is used. - `read_preference` (optional): The read preference to use. If ``None`` (the default) the :attr:`read_preference` of this :class:`Database` is used. - `write_concern` (optional): An instance of :class:`~pymongo.write_concern.WriteConcern`. If ``None`` (the default) the :attr:`write_concern` of this :class:`Database` is used. - `read_concern` (optional): An instance of :class:`~pymongo.read_concern.ReadConcern`. If ``None`` (the default) the :attr:`read_concern` of this :class:`Database` is used. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): additional keyword arguments will be passed as options for the create collection command .. versionchanged:: 3.11 This method is now supported inside multi-document transactions with MongoDB 4.4+. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Added the collation option. .. versionchanged:: 3.0 Added the codec_options, read_preference, and write_concern options. .. versionchanged:: 2.2 Removed deprecated argument: options r)rsessionzcollection %s already existsTr~N)r6 _tmp_sessionin_transactionlist_collection_namesrr) r;rr.r/r0r1r~kwargsss r%create_collectionzDatabase.create_collectionYs~]] ' ' 0 AAa..D66 &~q7::'(F(MNNdD$ -}*A45A9?A A A As AA--A6cL|jD]}|j||}|S)z%Apply incoming manipulators to `son`.)r7rIr;son collectionrPs r%_apply_incoming_manipulatorsz%Database._apply_incoming_manipulatorss077 BK00jAC B r'cL|jD]}|j||}|S)z-Apply incoming copying manipulators to `son`.)r8rIrs r%$_apply_incoming_copying_manipulatorsz-Database._apply_incoming_copying_manipulatorss0?? BK00jAC B r'cN|j||}|j||}|S)zApply manipulators to an incoming SON object before it gets stored. :Parameters: - `son`: the son object going into the database - `collection`: the collection the son object is being saved in )rr)r;rrs r% _fix_incomingzDatabase._fix_incomings-//Z@77ZH r'ct|jD]}|j||}t|jD]}|j||}|S)zApply manipulators to a SON object as it comes out of the database. :Parameters: - `son`: the son object coming out of the database - `collection`: the collection the son object was saved in )reversedr9rJr:rs r% _fix_outgoingzDatabase._fix_outgoingse$D$@$@A BK00jAC B#D$H$HI BK00jAC B r'c $|jj|d5}t|t|||dudddii}|jj |j |j |||j cdddS#1swYyxYw) aa Perform a database-level aggregation. See the `aggregation pipeline`_ documentation for a list of stages that are supported. Introduced in MongoDB 3.6. .. code-block:: python # Lists all operations currently running on the server. with client.admin.aggregate([{"$currentOp": {}}]) as cursor: for operation in cursor: print(operation) 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`. The :meth:`aggregate` method obeys the :attr:`read_preference` of this :class:`Database`, except when ``$out`` or ``$merge`` are used, in which case :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY` is used. .. note:: This method does not support the 'explain' option. Please use :meth:`~pymongo.database.Database.command` instead. .. note:: The :attr:`~pymongo.database.Database.write_concern` of this collection is automatically applied to this operation. :Parameters: - `pipeline`: a list of aggregation pipeline stages - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): See list of options above. :Returns: A :class:`~pymongo.command_cursor.CommandCursor` over the result set. .. versionadded:: 3.9 .. _aggregation pipeline: https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline .. _aggregate command: https://docs.mongodb.com/manual/reference/command/aggregate FcloseNcursor firstBatch) user_fields) retryable)r<rr r_retryable_read get_cursorget_read_preference_performs_write)r;pipeliner~rrcmds r% aggregatezDatabase.aggregatesv[[ % %gU % ; 3q-mXvwd7J% a'89;C;;.. 7 7 :A!111/3  3 3 3s ABBc *t|||||||||| S)aWatch changes on this database. Performs an aggregation with an implicit initial ``$changeStream`` stage and returns a :class:`~pymongo.change_stream.DatabaseChangeStream` cursor which iterates over changes on all collections in this database. Introduced in MongoDB 4.0. .. code-block:: python with db.watch() as stream: for change in stream: print(change) The :class:`~pymongo.change_stream.DatabaseChangeStream` iterable blocks until the next change document is returned or an error is raised. If the :meth:`~pymongo.change_stream.DatabaseChangeStream.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.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`_. :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.DatabaseChangeStream` cursor. .. versionchanged:: 3.9 Added the ``start_after`` parameter. .. versionadded:: 3.7 .. mongodoc:: changeStreams .. _change streams specification: https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst r ) r;r full_document resume_aftermax_await_time_ms batch_size collationstart_at_operation_timer~ start_afters r%watchzDatabase.watch s+n$ (M<9J  #:G  r'FrTc  "t|trt||fg}|j| |jj | 5} |j |j||||||| | | |j cdddS#1swYyxYw)zInternal command helper.)r0parse_write_concern_errorr~r<N)r2rr updater6rcommandr5)r; sock_inforslave_okvaluecheckallowable_errorsr/r.r0rr~rrs r%_commandzDatabase._commandgs g{ +GU+,-Gv ]] ' ' 0 &A$$  +*C}}% & & & &s 0BBc |&|xr|jxstj}|jj ||5\} } |j | || |||||fd|i|cdddS#1swYyxYw)aZIssue a MongoDB command. Send command `command` to the database and return the response. If `command` is an instance of :class:`basestring` (:class:`str` in python 3) then the command {`command`: `value`} will be sent. Otherwise, `command` must be an instance of :class:`dict` and will be sent as is. Any additional keyword arguments will be added to the final command document before it is sent. For example, a command like ``{buildinfo: 1}`` can be sent using: >>> db.command("buildinfo") For a command where the value matters, like ``{collstats: collection_name}`` we can do: >>> db.command("collstats", collection_name) For commands that take additional arguments we can use kwargs. So ``{filemd5: object_id, root: file_root}`` becomes: >>> db.command("filemd5", object_id, root=file_root) :Parameters: - `command`: document representing the command to be issued, or the name of the command (for simple commands only). .. note:: the order of keys in the `command` document is significant (the "verb" must come first), so commands which require multiple keys (e.g. `findandmodify`) should use an instance of :class:`~bson.son.SON` or a string and kwargs instead of a Python `dict`. - `value` (optional): value to use for the command verb when `command` is passed as a string - `check` (optional): check the response for errors, raising :class:`~pymongo.errors.OperationFailure` if there are any - `allowable_errors`: if `check` is ``True``, error messages in this list will be ignored by error-checking - `read_preference` (optional): The read preference for this operation. See :mod:`~pymongo.read_preferences` for options. If the provided `session` is in a transaction, defaults to the read preference configured for the transaction. Otherwise, defaults to :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY`. - `codec_options`: A :class:`~bson.codec_options.CodecOptions` instance. - `session` (optional): A :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): additional keyword arguments will be added to the command document before it is sent .. note:: :meth:`command` does **not** obey this Database's :attr:`read_preference` or :attr:`codec_options`. You must use the `read_preference` and `codec_options` parameters instead. .. note:: :meth:`command` does **not** apply any custom TypeDecoders when decoding the command response. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.0 Removed the `as_class`, `fields`, `uuid_subtype`, `tag_sets`, and `secondary_acceptable_latency_ms` option. 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. Added the `codec_options` parameter. .. 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 `tag_sets` and `secondary_acceptable_latency_ms` options. .. versionchanged:: 2.2 Added support for `as_class` - the class you want to use for the resulting documents .. _PYTHON-500: https://jira.mongodb.org/browse/PYTHON-500 .. mongodoc:: commands Nr~)_txn_read_preferencerPRIMARYr6_socket_for_readsr) r;rrrrr/r.r~rrrs r%rzDatabase.commands|  " ' JG,H,H,J 9"0"8"8  ]] , ,* K-Bi 4==GXu!&(8/!.K8?KCIK K K Ks A..A7c &|xr|jxstjfd} jj | |S)z5Same as command but used for retryable read commands.c < j||  fd|iS)Nr~)r) r~serverrrrrr.rrr/r;rs r%_cmdz.Database._retryable_read_command.._cmds= 4==GXu!&(8/!.K8?KCIK Kr'rrrr6r) r;rrrrr/r.r~rrs ``````` ` r%_retryable_read_commandz Database._retryable_read_commands[  " ' JG,H,H,J 9"0"8"8  K K }},, /7, ,r'c |jd|}|jdkDr|tddifg}|j||jj |d5}|j |||||d} t|| |j||d u cd d d St} d |vr d t|d gi} t|jjd dz} ddd| dgiddid| ig} tdd| fd|jdifg}|j |||d} t|| |jS#1swYy xYw)z Internal listCollections helper.z$cmd)r/r?)listCollectionsrrFr)r/r~N)r~explicit_sessionrz$andutf8.z$projectz$substrz$namer)roptionsz$match)rzsystem.namespacesr)r|max_wire_versionr rr6rrraddress _INDEX_REGEXlenrencodeget) r;r slave_okayr~r/rcollr tmp_sessionrmatchdblenrs r%_list_collectionszDatabase._list_collectionss"" O#5  % % )- "~'(C JJv ++5,* :-8sJ$3'')*23%%%'%,D%8 : : :!E6!,x0@!AB ((0478Ey7E22F&G)*,-5!H 9"H- &**Xr":;=>C]]9c:>xHF vy/@/@A A5 : :s 5D<<Ec ||d<|xr|jxstjfd}jj ||S)aGet a cursor over the collectons of this database. :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `filter` (optional): A query document to filter the list of collections returned from the listCollections command. - `**kwargs` (optional): Optional parameters of the `listCollections command `_ can be passed as keyword arguments to this method. The supported options differ by server version. :Returns: An instance of :class:`~pymongo.command_cursor.CommandCursor`. .. versionadded:: 3.6 rc2j|||fdiS)Nr/)r)r~rrrr read_prefr;s r%rz'Database.list_collections.._cmd4s/)4)):w@I r'r)r;r~rrrrs` ` @r%list_collectionszDatabase.list_collectionss^&  %F8 @'">">"@/&..   }},, )W& &r'c |d|d<n4tjd|||d<|rt|dk(r d|vrd|d<|jdd|i|Dcgc]}|d c}Scc}w)aGet a list of all the collection names in this database. For example, to list all non-system collections:: filter = {"name": {"$regex": r"^(?!system\.)"}} db.list_collection_names(filter=filter) :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `filter` (optional): A query document to filter the list of collections returned from the listCollections command. - `**kwargs` (optional): Optional parameters of the `listCollections command `_ can be passed as keyword arguments to this method. The supported options differ by server version. .. versionchanged:: 3.8 Added the ``filter`` and ``**kwargs`` parameters. .. versionadded:: 3.6 TnameOnlyrrrr~rm)r validate_is_mappingrr)r;r~rrresults r%rzDatabase.list_collection_names<s0 >!%F:   & &x 8%F8 c&kQ.6V3C%)z"4d33NGNvNPvP PPs A"ctjdtd|rint}|jd|dd|Dcgc]}|d c}Scc}w)a **DEPRECATED**: Get a list of all the collection names in this database. :Parameters: - `include_system_collections` (optional): if ``False`` list will not include system collections (e.g ``system.indexes``) - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. .. versionchanged:: 3.7 Deprecated. Use :meth:`list_collection_names` instead. .. versionchanged:: 3.6 Added ``session`` parameter. zBcollection_names is deprecated. Use list_collection_names instead.r?r@T)r~rrrm)rKrLrM_SYSTEM_FILTERr)r;include_system_collectionsr~kwsrs r%collection_nameszDatabase.collection_namesaso"  7(Q 8/bN3d33JG=AJEHJKvK KKs A c |}t|tr |j}t|tst dtj |j j|j||j j|5}|j|dt|ddg|j|d|cdddS#1swYyxYw)aDrop a collection. :Parameters: - `name_or_collection`: the name of a collection to drop or the collection object itself - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. .. note:: The :attr:`~pymongo.database.Database.write_concern` of this database is automatically applied to this operation when using MongoDB >= 3.4. .. versionchanged:: 3.6 Added ``session`` parameter. .. versionchanged:: 3.4 Apply this database's write concern automatically to this operation when connected to MongoDB >= 3.4. *name_or_collection must be an instance of dropz ns not foundT)rrr0rr~N) r2rrrr3r4r6 _purge_indexr5_socket_for_writesrr_write_concern_for)r;name_or_collectionr~rrs r%drop_collectionzDatabase.drop_collectionzs*" dJ '99D$ ,0;0D0DGH H ""4;;5 ]] - -g 6 !)==6$"0"!5"55g>*. !! ! ! !s 2CCc|}t|tr |j}t|tst dtj dt dt|fd|fd|fg}|||d<|j||}d} d |vr=|d } | jd d k7s| jd d k7rt|d | d|vrot|dD]]\} } d | vr>| d } | jd d k7s| jd d k7s8t|d | | jddr[d} nn|jddsd} | st|d ||S)awValidate a collection. Returns a dict of validation info. Raises CollectionInvalid if validation fails. See also the MongoDB documentation on the `validate command`_. :Parameters: - `name_or_collection`: A Collection object or the name of a collection to validate. - `scandata`: Do extra checks beyond checking the overall structure of the collection. - `full`: Have the server do a more thorough scan of the collection. Use with `scandata` for a thorough scan of the structure of the collection and the individual documents. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `background` (optional): A boolean flag that determines whether the command runs in the background. Requires MongoDB 4.4+. .. versionchanged:: 3.11 Added ``background`` parameter. .. versionchanged:: 3.6 Added ``session`` parameter. .. _validate command: https://docs.mongodb.com/manual/reference/command/validate/ rz or Collectionvalidatescandatafull backgroundr~Tr exceptionrcorruptz invalid: rawvalidF) r2rrrr3r4r rrfindrrr) r;rrrr~rrrrrinfortress r%validate_collectionzDatabase.validate_collections@" dJ '99D$ ,2=2F2FIJ JJ/)D>#$  ! *C c73 v (#Dyy%+tyy/Cr/I'D$(GHH f_#F5M2 3s?x=D +."4 IIi0B6/8t|dj|S)a!Returns a list containing current profiling information. :Parameters: - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. .. versionchanged:: 3.6 Added ``session`` parameter. .. mongodoc:: profiling zsystem.profiler)listr)r;r~s r%profiling_infozDatabase.profiling_infods#D)*///@AAr'ctjdtd|jd}|j dd}|y|j dr4|j j}|r|j j|||S) a:**DEPRECATED**: Get the error if one occurred on the last operation. This method is obsolete: all MongoDB write operations (insert, update, remove, and so on) use the write concern ``w=1`` and report their errors by default. .. versionchanged:: 2.8 Deprecated. zDatabase.error() is deprecatedr?r@ getlasterrorerrNz not master) rKrLrMrrrur6primary_handle_getlasterror)r;error error_msgrs r%rzDatabase.errorrs|  6(Q 8 ^,IIeR(      -mm++G 227IF r'c\tjdtd|jdS)al**DEPRECATED**: Get status information from the last operation. This method is obsolete: all MongoDB write operations (insert, update, remove, and so on) use the write concern ``w=1`` and report their errors by default. Returns a SON object with status information. .. versionchanged:: 2.8 Deprecated. zlast_status() is deprecatedr?r@r rKrLrMrrTs r% last_statuszDatabase.last_statuss)  3(Q 8||N++r'ctjdtd|jd}|j ddy|S)a**DEPRECATED**: Get the most recent error on this database. This method is obsolete: all MongoDB write operations (insert, update, remove, and so on) use the write concern ``w=1`` and report their errors by default. Only returns errors that have occurred since the last call to :meth:`reset_error_history`. Returns None if no such errors have occurred. .. versionchanged:: 2.8 Deprecated. zprevious_error() is deprecatedr?r@ getpreverrorrrN)rKrLrMrr)r;rs r%previous_errorzDatabase.previous_errorsA  6(Q 8 ^, 99UA  & r'c^tjdtd|jdy)a**DEPRECATED**: Reset the error history of this database. This method is obsolete: all MongoDB write operations (insert, update, remove, and so on) use the write concern ``w=1`` and report their errors by default. Calls to :meth:`previous_error` will only return errors that have occurred since the most recent call to this method. .. versionchanged:: 2.8 Deprecated. z#reset_error_history() is deprecatedr?r@ reseterrorNrrTs r%reset_error_historyzDatabase.reset_error_historys&  ;(Q 8 \"r'c|SrgrmrTs r%__iter__zDatabase.__iter__s r'ctd)Nz!'Database' object is not iterable)r3rTs r%__next__zDatabase.__next__s;<= 2.6zIThe read_only option is deprecated in MongoDB >= 2.6, use 'roles' insteadNdigestPasswordzzThe digestPassword option is not supported via add_user. Please use db.command('createUser', ...) instead for this option.pwd writeConcern createUser updateUserr~) rKrLrMr'rr0 acknowledgeddocumentrr) r;createrpasswordr&r~ropts command_names r%_create_or_update_userzDatabase._create_or_update_users G6$9 MM#$6 8"// :;DM  MM89K M  6)(*DEE#DK    * *t/A/A/J/J#'#5#5#>#>D  F 'L'L \4AADAr'c Ptjdtdt|tst dtj |Et|tst dtj t|dk(r td|%tjd |}d |vr td  |jd || }|j|d |||fd|i|y#t$r3}|jdk(r|jd|||fd|i|nYd}~yd}~wwxYw)ab **DEPRECATED**: Create user `name` with password `password`. Add a new user with permissions for this :class:`Database`. .. note:: Will change the password if user `name` already exists. .. note:: add_user is deprecated and will be removed in PyMongo 4.0. Starting with MongoDB 2.6 user management is handled with four database commands, createUser_, usersInfo_, updateUser_, and dropUser_. To create a user:: db.command("createUser", "admin", pwd="password", roles=["root"]) To create a read-only user:: db.command("createUser", "user", pwd="password", roles=["read"]) To change a password:: db.command("updateUser", "user", pwd="newpassword") Or change roles:: db.command("updateUser", "user", roles=["readWrite"]) .. _createUser: https://docs.mongodb.com/manual/reference/command/createUser/ .. _usersInfo: https://docs.mongodb.com/manual/reference/command/usersInfo/ .. _updateUser: https://docs.mongodb.com/manual/reference/command/updateUser/ .. _dropUser: https://docs.mongodb.com/manual/reference/command/createUser/ .. warning:: Never create or modify users over an insecure network without the use of TLS. See :doc:`/examples/tls` for more information. :Parameters: - `name`: the name of the user to create - `password` (optional): the password of the user to create. Can not be used with the ``userSource`` argument. - `read_only` (optional): if ``True`` the user will be read only - `**kwargs` (optional): optional fields for the user document (e.g. ``userSource``, ``otherDBRoles``, or ``roles``). See ``_ for more information. - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. .. versionchanged:: 3.7 Added support for SCRAM-SHA-256 users with MongoDB 4.0 and later. .. versionchanged:: 3.6 Added ``session`` parameter. Deprecated add_user. .. versionchanged:: 2.5 Added kwargs support for optional fields introduced in MongoDB 2.4 .. versionchanged:: 2.2 Added support for read only users zoadd_user is deprecated and will be removed in PyMongo 4.0. Use db.command with createUser or updateUser insteadr?r@r+N password must be an instance of rzpassword can't be emptyr&r)z(Can not use read_only and roles together usersInforusersr~ T)rKrLrMr2rr3r4rrr validate_booleanrrr5rcode)r;rr2r&r~ruinfoexcs r%add_userzDatabase.add_users`z   !3 C$ ,0;0D0DGH H  h 44?4H4H!KLL8}! !:;;  // YGI& (*HII LLdGLDE 'D ' '7^#dHi + +#) +  xx2~+++$)P=DPHNPP  s80C)) D%2)D  D%ctjdtdtd|fg}|jj r/|jj r|jj |d<|j||y)a[**DEPRECATED**: Remove user `name` from this :class:`Database`. User `name` will no longer have permissions to access this :class:`Database`. .. note:: remove_user is deprecated and will be removed in PyMongo 4.0. Use the dropUser command instead:: db.command("dropUser", "user") :Parameters: - `name`: the name of the user to remove - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. .. versionchanged:: 3.6 Added ``session`` parameter. Deprecated remove_user. zbremove_user is deprecated and will be removed in PyMongo 4.0. Use db.command with dropUser insteadr?r@dropUserr,rN)rKrLrMr r0r/r0r)r;rr~rs r% remove_userzDatabase.remove_user[sr&   !3 CJ%&'    * *t/A/A/J/J"&"4"4"="=C  S' *r'c f|,t|tstdtj|,t|tstdtj|,t|tstdtjt j d|t j }t|D]#\}}t j||\} } | || <%tj||||||j} |jj|j| dy)a **DEPRECATED**: Authenticate to use this database. .. warning:: Starting in MongoDB 3.6, calling :meth:`authenticate` invalidates all existing cursors. It may also leave logical sessions open on the server for up to 30 minutes until they time out. Authentication lasts for the life of the underlying client instance, or until :meth:`logout` is called. Raises :class:`TypeError` if (required) `name`, (optional) `password`, or (optional) `source` is not an instance of :class:`basestring` (:class:`str` in python 3). .. note:: - This method authenticates the current connection, and will also cause all new :class:`~socket.socket` connections in the underlying client instance to be authenticated automatically. - Authenticating more than once on the same database with different credentials is not supported. You must call :meth:`logout` before authenticating with new credentials. - When sharing a client instance between multiple threads, all threads will share the authentication. If you need different authentication profiles for different purposes you must use distinct client instances. :Parameters: - `name`: the name of the user to authenticate. Optional when `mechanism` is MONGODB-X509 and the MongoDB server version is >= 3.4. - `password` (optional): the password of the user to authenticate. Not used with GSSAPI or MONGODB-X509 authentication. - `source` (optional): the database to authenticate on. If not specified the current database is used. - `mechanism` (optional): See :data:`~pymongo.auth.MECHANISMS` for options. If no mechanism is specified, PyMongo automatically uses MONGODB-CR when connected to a pre-3.0 version of MongoDB, SCRAM-SHA-1 when connected to MongoDB 3.0 through 3.6, and negotiates the mechanism to use (SCRAM-SHA-1 or SCRAM-SHA-256) when connected to MongoDB 4.0+. - `authMechanismProperties` (optional): Used to specify authentication mechanism specific options. To specify the service name for GSSAPI authentication pass ``authMechanismProperties='SERVICE_NAME:'``. To specify the session token for MONGODB-AWS authentication pass ``authMechanismProperties='AWS_SESSION_TOKEN:'``. .. versionchanged:: 3.7 Added support for SCRAM-SHA-256 with MongoDB 4.0 and later. .. versionchanged:: 3.5 Deprecated. Authenticating multiple users conflicts with support for logical sessions in MongoDB 3.6. To authenticate as multiple users, create multiple instances of MongoClient. .. versionadded:: 2.8 Use SCRAM-SHA-1 with MongoDB 3.0 and later. .. versionchanged:: 2.5 Added the `source` and `mechanism` parameters. :meth:`authenticate` now raises a subclass of :class:`~pymongo.errors.PyMongoError` if authentication fails due to invalid credentials or configuration issues. .. mongodoc:: authenticate r+r7zsource must be an instance of mechanismT)connect)r2rr3r4r validate_auth_mechanism_CaseInsensitiveDictionaryrvalidate_auth_optionr _build_credentials_tuplerr<_cache_credentials) r;rr2sourcerDrvalidated_optionsoptionr normalizedval credentialss r% authenticatezDatabase.authenticatews7J  Jt[$A0;0D0DGH H   8[(I0;0D0DGH H  j&E0;0D0DGH H&&{I>"==?&v. 0MFE$99&%HOJ,/ j ) 033      II   && II  '  r'ctjdtd|jj |j y)a**DEPRECATED**: Deauthorize use of this database. .. warning:: Starting in MongoDB 3.6, calling :meth:`logout` invalidates all existing cursors. It may also leave logical sessions open on the server for up to 30 minutes until they time out. zDatabase.logout() is deprecatedr?r@N)rKrLrMr<_purge_credentialsrrTs r%logoutzDatabase.logouts0  7(Q 8 &&tyy1r'c Bt|tstdt|z|j?|j|j k7r&t d|jd|j d||jjd|jifd|i|S)a+Dereference a :class:`~bson.dbref.DBRef`, getting the document it points to. Raises :class:`TypeError` if `dbref` is not an instance of :class:`~bson.dbref.DBRef`. Returns a document, or ``None`` if the reference does not point to a valid document. Raises :class:`ValueError` if `dbref` has a database specified that is different from the current database. :Parameters: - `dbref`: the reference - `session` (optional): a :class:`~pymongo.client_session.ClientSession`. - `**kwargs` (optional): any additional keyword arguments are the same as the arguments to :meth:`~pymongo.collection.Collection.find`. .. versionchanged:: 3.6 Added ``session`` parameter. zcannot dereference a %sz?trying to dereference a DBRef that points to another database (z not rp_idr~) r2rr3typedatabaser5rrfind_oneid)r;dbrefr~rs r% dereferencezDatabase.dereferences*%'5U CD D >> %%..DKK*G?D~~?C{{LM M/tE$$%.. EHH :'.:28: :r'ctjdtdt|ts t |}|j d||}|j ddS)a**DEPRECATED**: Evaluate a JavaScript expression in MongoDB. :Parameters: - `code`: string representation of JavaScript code to be evaluated - `args` (optional): additional positional arguments are passed to the `code` being evaluated .. warning:: the eval command is deprecated in MongoDB 3.0 and will be removed in a future server version. zDatabase.eval() is deprecatedr?r@z$eval)argsretvalN)rKrLrMr2rrr)r;r<r^rs r%evalz Database.evalsR  5(Q 8$%:Dgt$7zz(D))r'cvtd|jd|jjjd)zJThis is only here so that some API misusages are easier to debug. z='Database' object is not callable. If you meant to call the 'z' method on a 'z5' object it is failing because no such method exists.)r3r5r6r=r4)r;r^rs r%__call__zDatabase.__call__s4!KK)@)@)I)IKL Lr')NNNN)NNNNNrg) NNNNNNNNN)NN)TN)FFNN)FN)NNN)NNNDEFAULT)>r4 __module__ __qualname____doc__r-rQpropertyrUr<rrZr^rarcrerkrnrqryrwr|rrrrrrrrrrrrrrrrrrrrrrrr rrrrrr nextr'r5r?rBrQrTr\r`rb __classcell__)r=s@r%r)r)7s>JN26<2|D6 A A I I A A I I@D6:&;P !A &&HL8<))V59>B59IAV   A3FEIAEFJZx5:$"&8N8N4#+0$ &0&'d!%t3TeKN67d!%t3T, $BL&@#PJ;?!%K2%!PAE'+IV B'6R(*B"BH\|+804,5bH 2:<**Lr'r)c@eZdZdZdZdZdZdZdZdZ dZ d Z y ) rSzE**DEPRECATED**: Helper class for dealing with stored JavaScript. ctjdtd|jjs+|j j |jt}tj|d|y)z~**DEPRECATED**: Get a system js helper for the database `database`. SystemJS will be removed in PyMongo 4.0. zSystemJS is deprecatedr?r@)r0_dbN) rKrLrMr0r/r< get_databaserrobject __setattr__)r;rXs r%r-zSystemJS.__init__(sa  .(Q 8%%2233 -B4DH 41r'c|jjjjd|i|t |ddy)NrV)rVrT)rlsystemjs replace_onerr;rr<s r%rozSystemJS.__setattr__6s3 && DM4$t*=t Er'c(|j||yrg)rorts r% __setitem__zSystemJS.__setitem__:s t$r'cf|jjjjd|iy)NrV)rlrqrr delete_onerxs r% __delattr__zSystemJS.__delattr__=s" %%udm4r'c&|j|yrg)ryrxs r% __delitem__zSystemJS.__delitem__@s r'cfdS)NcXjjtddig|S)Nz8function() { return this[name].apply(this, arguments); }r)scope)rlr`r)r^rr;s r%z&SystemJS.__getattr__..Ds;]TXX]]41F8>tn,FNIMNr'rmrxs``r%ryzSystemJS.__getattr__CsN Nr'c$|j|Srg)ryrxs r%rwzSystemJS.__getitem__Is%%r'c|jjjjdgDcgc]}|d c}Scc}w)zAGet a list of the names of the functions stored in this database.rV) projection)rlrqrrr)r;xs r%r z SystemJS.listLs8"&((//"4"4"9"9eW"9"MNQ%NNNs AN) r4rdrerfr-rorvryr{ryrwr rmr'r%rSrS$s2 2E%5N &Or'rS)-rfrK bson.coderbson.codec_optionsr bson.dbrefrbson.py3compatrrrbson.sonr pymongor r pymongo.aggregationr pymongo.change_streamrpymongo.collectionrpymongo.command_cursorrpymongo.errorsrrrrpymongo.messagerpymongo.read_preferencesrpymongo.son_manipulatorrpymongo.write_concernrrrr& BaseObjectr)rnrSrmr'r%rs!4;; ;6)0..)327<01 Vh0@%ABC =jLv  jLZ/*Ov*Or'