U ~fhv @sdZddlmZddlZddlmZmZmZmZm Z m Z m Z m Z ddl mZddlmZddlmZddlmZmZdd lmZdd lmZmZmZdd lmZmZmZdd l m!Z!erdd lm"Z"m#Z#e e e e$e e$e e%e$ee$effffee$effZ&e e$e&fZ'Gddde$ej(Z)GdddeeZ*GdddZ+Gddde+Z,Gddde+Z-GdddeeZ.GdddZ/Gddde/Z0Gddde/Z1Gd d!d!Z2Gd"d#d#Z3dS)$z~Operation class definitions. .. seealso:: This module is compatible with both the synchronous and asynchronous PyMongo APIs. ) annotationsN) TYPE_CHECKINGAnyGenericMappingOptionalSequenceTupleUnion)RawBSONDocument)helpers_shared)validate_collation_or_none)validate_is_mapping validate_list)InvalidOperation)_gen_index_name_index_document _index_list) _CollationIn _DocumentType _Pipeline)validate_boolean) _AgnosticBulk_AgnosticClientBulkc@seZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdS)_OpZabortTransactionZ aggregateZ bulkWriteZcommitTransactioncountcreateZ createIndexesZcreateSearchIndexesdeleteZdistinctZdropZ dropDatabaseZ dropIndexesZdropSearchIndexesZ endSessionsZ findAndModifyfindinsertZlistCollectionsZ listIndexesZlistSearchIndexesZ listDatabasesupdateZ updateIndexZupdateSearchIndexrenameZgetMoreZ killCursorsZ testOperationN) __name__ __module__ __qualname__ZABORTZ AGGREGATEZ BULK_WRITEZCOMMITZCOUNTZCREATEZCREATE_INDEXESZCREATE_SEARCH_INDEXESDELETEZDISTINCTZDROPZ DROP_DATABASEZ DROP_INDEXESZDROP_SEARCH_INDEXESZ END_SESSIONSZFIND_AND_MODIFYZFINDZINSERTZLIST_COLLECTIONSZ LIST_INDEXESZLIST_SEARCH_INDEXZLIST_DATABASESZUPDATEZ UPDATE_INDEXZUPDATE_SEARCH_INDEXZRENAMEZGETMOREZ KILL_CURSORSZTESTr&r&6/tmp/pip-unpacked-wheel-36gvocj8/pymongo/operations.pyr5s:rc@sveZdZdZdZddddddd Zd dd d d Zddd ddZddddZdddddZ dddddZ dS) InsertOnez#Represents an insert_one operation._doc _namespaceNr Optional[str]None)document namespacereturncCs||_||_dS)avCreate an InsertOne instance. For use with :meth:`~pymongo.asynchronous.collection.AsyncCollection.bulk_write`, :meth:`~pymongo.collection.Collection.bulk_write`, :meth:`~pymongo.asynchronous.mongo_client.AsyncMongoClient.bulk_write` and :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. :param document: The document to insert. If the document is missing an _id field one will be added. :param namespace: (optional) The namespace in which to insert a document. .. versionchanged:: 4.9 Added the `namespace` option to support `MongoClient.bulk_write`. Nr))selfr.r/r&r&r'__init__]s zInsertOne.__init__rbulkobjr0cCs||jdS)>Add this operation to the _AsyncBulk/_Bulk instance `bulkobj`.N) add_insertr*r1r4r&r&r' _add_to_bulkmszInsertOne._add_to_bulkrcCs"|jstd||j|jdS)JAdd this operation to the _AsyncClientBulk/_ClientBulk instance `bulkobj`.SMongoClient.bulk_write requires a namespace to be provided for each write operationN)r+rr6r*r7r&r&r'_add_to_client_bulkqszInsertOne._add_to_client_bulkstrr0cCs:|jr$|jjd|jd|jdS|jjd|jdS)N(, ))r+ __class__r"r*r1r&r&r'__repr__|szInsertOne.__repr__rboolotherr0cCs,t|t|kr(|j|jko&|j|jkStSN)typer*r+NotImplementedr1rFr&r&r'__eq__szInsertOne.__eq__cCs ||k SrGr&rJr&r&r'__ne__szInsertOne.__ne__)N) r"r#r$__doc__ __slots__r2r8r;rCrKrLr&r&r&r'r(Us r(c@sZeZdZdZdZddddddd d d Zd d dddZd d dddZddddZdS) _DeleteOpz)Private base class for delete operations.)_filter _collation_hintr+NMapping[str, Any]Optional[_CollationIn]Optional[_IndexKeyHint]r,r-filter collationhintr/r0cCsN|dk rtd||dk r2t|ts2t||_n||_||_||_||_dS)NrW) r isinstancer<r rrRrPrQr+r1rWrXrYr/r&r&r'r2s z_DeleteOp.__init__rrDrEcCs<t|t|kr8|j|j|j|jf|j|j|j|jfkStSrG)rHrPrQrRr+rIrJr&r&r'rKs z_DeleteOp.__eq__cCs ||k SrGr&rJr&r&r'rLsz_DeleteOp.__ne__r<r=cCsJ|jr$d|jj|j|j|j|jS|jjd|jd|jd|jdS)Nz{}({!r}, {!r}, {!r}, {!r})r>r?r@)r+formatrAr"rPrQrRrBr&r&r'rCsz_DeleteOp.__repr__)NNN r"r#r$rMrNr2rKrLrCr&r&r&r'rOs rOcsTeZdZdZdZddddddd fd d Zd dd ddZddd ddZZS) DeleteOnez"Represents a delete_one operation.r&NrSrTrUr,r-rVcst||||dS)aCreate a DeleteOne instance. For use with :meth:`~pymongo.asynchronous.collection.AsyncCollection.bulk_write`, :meth:`~pymongo.collection.Collection.bulk_write`, :meth:`~pymongo.asynchronous.mongo_client.AsyncMongoClient.bulk_write` and :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. :param filter: A query that matches the document to delete. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param hint: An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.asynchronous.collection.AsyncCollection.create_index` or :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. :param namespace: (optional) The namespace in which to delete a document. .. versionchanged:: 4.9 Added the `namespace` option to support `MongoClient.bulk_write`. .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.5 Added the `collation` option. Nsuperr2r[rAr&r'r2szDeleteOne.__init__rr3cCs |j|jdt|j|jddS)r5rXrYN add_deleterPr rQrRr7r&r&r'r8s zDeleteOne._add_to_bulkrcCs2|jstd|j|j|jdt|j|jddS)r9r:FZmultirXrYNr+rrerPr rQrRr7r&r&r'r;szDeleteOne._add_to_client_bulk)NNN r"r#r$rMrNr2r8r; __classcell__r&r&rar'r^s  r^csTeZdZdZdZddddddd fd d Zd dd ddZddd ddZZS) DeleteManyz#Represents a delete_many operation.r&NrSrTrUr,r-rVcst||||dS)aCreate a DeleteMany instance. For use with :meth:`~pymongo.asynchronous.collection.AsyncCollection.bulk_write`, :meth:`~pymongo.collection.Collection.bulk_write`, :meth:`~pymongo.asynchronous.mongo_client.AsyncMongoClient.bulk_write` and :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. :param filter: A query that matches the documents to delete. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param hint: An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.asynchronous.collection.AsyncCollection.create_index` or :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. :param namespace: (optional) The namespace in which to delete documents. .. versionchanged:: 4.9 Added the `namespace` option to support `MongoClient.bulk_write`. .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.5 Added the `collation` option. Nr_r[rar&r'r2szDeleteMany.__init__rr3cCs |j|jdt|j|jddS)r5rrcNrdr7r&r&r'r8&s zDeleteMany._add_to_bulkrcCs2|jstd|j|j|jdt|j|jddS)r9r:TrfNrgr7r&r&r'r;/szDeleteMany._add_to_client_bulk)NNNrhr&r&rar'rjs  rjc @s~eZdZdZdZd ddddd d d d d dZdd dddZdd dddZdddddZdddddZ ddddZ dS)! ReplaceOnez#Represents a replace_one operation.)rPr*_upsertrQrRr+FNrSz%Union[_DocumentType, RawBSONDocument]rDrTrUr,r-)rW replacementupsertrXrYr/r0cCsl|dk rtd||dk r$td||dk rDt|tsDt||_n||_||_||_||_ ||_ ||_ dS)adCreate a ReplaceOne instance. For use with :meth:`~pymongo.asynchronous.collection.AsyncCollection.bulk_write`, :meth:`~pymongo.collection.Collection.bulk_write`, :meth:`~pymongo.asynchronous.mongo_client.AsyncMongoClient.bulk_write` and :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. :param filter: A query that matches the document to replace. :param replacement: The new document. :param upsert: If ``True``, perform an insert if no documents match the filter. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param hint: An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.asynchronous.collection.AsyncCollection.create_index` or :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. :param namespace: (optional) The namespace in which to replace a document. .. versionchanged:: 4.9 Added the `namespace` option to support `MongoClient.bulk_write`. .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.5 Added the ``collation`` option. NrWrn) rrrZr<r rrRrPr*rlrQr+)r1rWrmrnrXrYr/r&r&r'r2Js#  zReplaceOne.__init__rr3cCs&|j|j|j|jt|j|jddS)r5rcN) add_replacerPr*rlr rQrRr7r&r&r'r8|szReplaceOne._add_to_bulkrcCs8|jstd|j|j|j|j|jt|j|jddS)r9r:rcN) r+rrorPr*rlr rQrRr7r&r&r'r;szReplaceOne._add_to_client_bulkrrEcCsLt|t|krH|j|j|j|j|j|jf|j|j|j|j|j|jfkStSrG)rHrPr*rlrQrRr+rIrJr&r&r'rKs"zReplaceOne.__eq__cCs ||k SrGr&rJr&r&r'rLszReplaceOne.__ne__r<r=c CsN|jr,d|jj|j|j|j|j|j|jSd|jj|j|j|j|j|jS)N&{}({!r}, {!r}, {!r}, {!r}, {!r}, {!r})z {}({!r}, {!r}, {!r}, {!r}, {!r})) r+r\rAr"rPr*rlrQrRrBr&r&r'rCs$ zReplaceOne.__repr__)FNNN) r"r#r$rMrNr2r8r;rKrLrCr&r&r&r'rk>s 2 rkc@s\eZdZdZdZddddddd d d d Zd ddddZdddddZddddZdS) _UpdateOpz)Private base class for update operations.)rPr*rlrQ_array_filtersrRr+rS#Union[Mapping[str, Any], _Pipeline]Optional[bool]rT!Optional[list[Mapping[str, Any]]]rUr,)rWdocrnrX array_filtersrYr/cCs|dk rtd||dk r$td||dk r6td||dk rVt|tsVt||_n||_||_||_ ||_ ||_ ||_ ||_ dS)NrWrnrw)rrrrZr<r rrRrPr*rlrQrrr+)r1rWrvrnrXrwrYr/r&r&r'r2s    z_UpdateOp.__init__objectrDrEcCsRt|t|rN|j|j|j|j|j|j|jf|j|j|j|j|j|j|jfkSt SrG) rZrHrPr*rlrQrrrRr+rIrJr&r&r'rKs& z_UpdateOp.__eq__rcCs ||k SrGr&rJr&r&r'rLsz_UpdateOp.__ne__r<r=c CsV|jr0d|jj|j|j|j|j|j|j |jSd|jj|j|j|j|j|j|j S)Nz,{}({!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r})rp) r+r\rAr"rPr*rlrQrrrRrBr&r&r'rCs( z_UpdateOp.__repr__Nr]r&r&r&r'rqs  rqc sZeZdZdZdZddddddd d d d fd d Zdd dddZdd dddZZS) UpdateOnez#Represents an update_one operation.r&NrSrsrtrTrurUr,r-rWr rnrXrwrYr/r0c st|||||||dS)aRepresents an update_one operation. For use with :meth:`~pymongo.asynchronous.collection.AsyncCollection.bulk_write`, :meth:`~pymongo.collection.Collection.bulk_write`, :meth:`~pymongo.asynchronous.mongo_client.AsyncMongoClient.bulk_write` and :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. :param filter: A query that matches the document to update. :param update: The modifications to apply. :param upsert: If ``True``, perform an insert if no documents match the filter. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param array_filters: A list of filters specifying which array elements an update should apply. :param hint: An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.asynchronous.collection.AsyncCollection.create_index` or :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. :param namespace: (optional) The namespace in which to update a document. .. versionchanged:: 4.9 Added the `namespace` option to support `MongoClient.bulk_write`. .. 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` option. .. versionchanged:: 3.5 Added the `collation` option. Nr_r1rWr rnrXrwrYr/rar&r'r2s*zUpdateOne.__init__rr3c Cs0|j|j|jdt|jt|j|j|jddS)r5FrXrwrYN add_updaterPr*rDrlr rQrrrRr7r&r&r'r8IszUpdateOne._add_to_bulkrc Cs>|jstd|j|j|j|jd|jt|j|j|j ddS)r9r:Fr|N r+rr~rPr*rlr rQrrrRr7r&r&r'r;UszUpdateOne._add_to_client_bulk)NNNNNrhr&r&rar'rys", ryc sZeZdZdZdZddddddd d d d fd d Zdd dddZdd dddZZS) UpdateManyz$Represents an update_many operation.r&NrSrsrtrTrurUr,r-rzc st|||||||dS)aCreate an UpdateMany instance. For use with :meth:`~pymongo.asynchronous.collection.AsyncCollection.bulk_write`, :meth:`~pymongo.collection.Collection.bulk_write`, :meth:`~pymongo.asynchronous.mongo_client.AsyncMongoClient.bulk_write` and :meth:`~pymongo.mongo_client.MongoClient.bulk_write`. :param filter: A query that matches the documents to update. :param update: The modifications to apply. :param upsert: If ``True``, perform an insert if no documents match the filter. :param collation: An instance of :class:`~pymongo.collation.Collation`. :param array_filters: A list of filters specifying which array elements an update should apply. :param hint: An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.asynchronous.collection.AsyncCollection.create_index` or :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. :param namespace: (optional) The namespace in which to update documents. .. versionchanged:: 4.9 Added the `namespace` option to support `MongoClient.bulk_write`. .. 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` option. .. versionchanged:: 3.5 Added the `collation` option. Nr_r{rar&r'r2ls*zUpdateMany.__init__rr3c Cs0|j|j|jdt|jt|j|j|jddS)r5Tr|Nr}r7r&r&r'r8szUpdateMany._add_to_bulkrc Cs>|jstd|j|j|j|jd|jt|j|j|j ddS)r9r:Tr|Nrr7r&r&r'r;szUpdateMany._add_to_client_bulk)NNNNNrhr&r&rar'rgs", rc@s8eZdZdZdZddddddZed d d d Zd S) IndexModelzRepresents an index to create.Z __document _IndexKeyHintrr-)keyskwargsr0cKsZt|}|ddkr"t||d<t||d<t|dd}||_|dk rV||jd<dS)a Create an Index instance. For use with :meth:`~pymongo.asynchronous.collection.AsyncCollection.create_indexes` and :meth:`~pymongo.collection.Collection.create_indexes`. Takes either a single key or a list containing (key, direction) pairs or keys. If no direction is given, :data:`~pymongo.ASCENDING` will be assumed. The key(s) must be an instance of :class:`str`, and the direction(s) must be one of (:data:`~pymongo.ASCENDING`, :data:`~pymongo.DESCENDING`, :data:`~pymongo.GEO2D`, :data:`~pymongo.GEOSPHERE`, :data:`~pymongo.HASHED`, :data:`~pymongo.TEXT`). Valid options include, but are not limited to: - `name`: custom name to use for this index - if none is given, a name will be generated. - `unique`: if ``True``, creates a uniqueness constraint on the index. - `background`: if ``True``, this index should be created in the background. - `sparse`: if ``True``, omit from the index any documents that lack the indexed field. - `bucketSize`: for use with geoHaystack indexes. Number of documents to group together within a certain proximity to a given longitude and latitude. - `min`: minimum value for keys in a :data:`~pymongo.GEO2D` index. - `max`: maximum value for keys in a :data:`~pymongo.GEO2D` index. - `expireAfterSeconds`: Used to create an expiring (TTL) collection. MongoDB will automatically delete documents from this collection after seconds. The indexed field must be a UTC datetime or the data will not expire. - `partialFilterExpression`: A document that specifies a filter for a partial index. - `collation`: An instance of :class:`~pymongo.collation.Collation` that specifies the collation to use. - `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. :param keys: a single key or a list containing (key, direction) pairs or keys specifying the index to create. :param kwargs: any additional index creation options (see the above list) should be passed as keyword arguments. .. versionchanged:: 3.11 Added the ``hidden`` option. .. versionchanged:: 3.2 Added the ``partialFilterExpression`` option to support partial indexes. .. _wildcard index: https://mongodb.com/docs/master/core/index-wildcard/ nameNkeyrX)rgetrrr pop_IndexModel__document)r1rrrXr&r&r'r2s=  zIndexModel.__init__zdict[str, Any]r=cCs|jS)zUAn index document suitable for passing to the createIndexes command. )rrBr&r&r'r.szIndexModel.documentNr"r#r$rMrNr2propertyr.r&r&r&r'rs Frc@s>eZdZdZdZdddddddd d Zedd d d ZdS)SearchIndexModelz$Represents a search index to create.rNrSr,rr-) definitionrrHrr0cKsDi|_|dk r||jd<||jd<|dk r4||jd<|j|dS)aCreate a Search Index instance. For use with :meth:`~pymongo.collection.AsyncCollection.create_search_index` and :meth:`~pymongo.collection.AsyncCollection.create_search_indexes`. :param definition: The definition for this index. :param name: The name for this index, if present. :param type: The type for this index which defaults to "search". Alternative values include "vectorSearch". :param kwargs: Keyword arguments supplying any additional options. .. note:: Search indexes require a MongoDB server version 7.0+ Atlas cluster. .. versionadded:: 4.5 .. versionchanged:: 4.7 Added the type and kwargs arguments. NrrrH)_SearchIndexModel__documentr )r1rrrHrr&r&r'r2s   zSearchIndexModel.__init__r=cCs|jS)zThe document for this index.)rrBr&r&r'r.+szSearchIndexModel.document)NNrr&r&r&r'r sr)4rM __future__renumtypingrrrrrrr r Z bson.raw_bsonr Zpymongor Zpymongo.collationr Zpymongo.commonrrZpymongo.errorsrZpymongo.helpers_sharedrrrZpymongo.typingsrrrZpymongo.write_concernrrrr<intZ _IndexListrEnumrr(rOr^rjrkrqryrrrr&r&r&r's: (     4  5:==XOOS