U d.P @sdZddlmZddlmZmZmZmZmZm Z m Z m Z m Z m Z ddlmZddlmZddlmZddlmZmZmZddlmZmZmZdd lmZmZmZerdd l m!Z!dd l"m#Z#e e e$e e$e e%e$e e$effffZ&e e$e&fZ'Gd d d eeZ(GdddZ)GdddZ*GdddeeZ+GdddZ,Gddde,Z-Gddde,Z.GdddZ/GdddZ0dS)zOperation class definitions.) annotations) TYPE_CHECKINGAnyDictGenericListMappingOptionalSequenceTupleUnion)RawBSONDocument)helpers)validate_collation_or_none)validate_booleanvalidate_is_mapping validate_list)_gen_index_name_index_document _index_list) _CollationIn _DocumentType _Pipeline)SON)_Bulkc@sbeZdZdZdZdddddZddd d d Zd d ddZdddddZdddddZ dS) InsertOnez#Represents an insert_one operation._docrNone)documentreturncCs ||_dS)zCreate an InsertOne instance. For use with :meth:`~pymongo.collection.Collection.bulk_write`. :Parameters: - `document`: The document to insert. If the document is missing an _id field one will be added. Nr)selfrr"6/tmp/pip-unpacked-wheel-oblwsawz/pymongo/operations.py__init__4s zInsertOne.__init__rbulkobjr cCs||jdS)3Add this operation to the _Bulk instance `bulkobj`.N)Z add_insertrr!r&r"r"r# _add_to_bulk?szInsertOne._add_to_bulkstrr cCsd|jdS)Nz InsertOne()rr!r"r"r#__repr__CszInsertOne.__repr__rboolotherr cCs t|t|kr|j|jkStSN)typerNotImplementedr!r1r"r"r#__eq__Fs zInsertOne.__eq__cCs ||k Sr2r"r5r"r"r#__ne__KszInsertOne.__ne__N __name__ __module__ __qualname____doc__ __slots__r$r)r.r6r7r"r"r"r#r/s rc@sheZdZdZdZddddddd d Zd dd d dZddddZdddddZdddddZ dS) DeleteOnez"Represents a delete_one operation._filter _collation_hintNMapping[str, Any]Optional[_CollationIn]Optional[_IndexKeyHint]rfilter collationhintr cCsH|dk rtd||dk r2t|ts2t||_n||_||_||_dS)aCreate a DeleteOne instance. For use with :meth:`~pymongo.collection.Collection.bulk_write`. :Parameters: - `filter`: A query that matches the document to delete. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.5 Added the `collation` option. NrGr isinstancer*rrrBr@rAr!rGrHrIr"r"r#r$Ts zDeleteOne.__init__rr%cCs |j|jdt|j|jddS)r'rHrINZ add_deleter@rrArBr(r"r"r#r)ws zDeleteOne._add_to_bulkr*r+cCsd|jd|jdS)Nz DeleteOne(, r,r@rAr-r"r"r#r.szDeleteOne.__repr__rr/r0cCs,t|t|kr(|j|jf|j|jfkStSr2r3r@rAr4r5r"r"r#r6szDeleteOne.__eq__cCs ||k Sr2r"r5r"r"r#r7szDeleteOne.__ne__)NNr8r"r"r"r#r>Os# r>c@sheZdZdZdZddddddd d Zd dd d dZddddZdddddZdddddZ dS) DeleteManyz#Represents a delete_many operation.r?NrCrDrErrFcCsH|dk rtd||dk r2t|ts2t||_n||_||_||_dS)a!Create a DeleteMany instance. For use with :meth:`~pymongo.collection.Collection.bulk_write`. :Parameters: - `filter`: A query that matches the documents to delete. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.4 and above. .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.5 Added the `collation` option. NrGrJrLr"r"r#r$s zDeleteMany.__init__rr%cCs |j|jdt|j|jddS)r'rrNNrOr(r"r"r#r)s zDeleteMany._add_to_bulkr*r+cCsd|jd|jdS)Nz DeleteMany(rPr,rQr-r"r"r#r.szDeleteMany.__repr__rr/r0cCs,t|t|kr(|j|jf|j|jfkStSr2rRr5r"r"r#r6szDeleteMany.__eq__cCs ||k Sr2r"r5r"r"r#r7szDeleteMany.__ne__)NNr8r"r"r"r#rSs# rSc@sleZdZdZdZdddddd d d d d Zdd dddZdddddZdddddZddddZ dS) ReplaceOnez#Represents a replace_one operation.)r@r_upsertrArBFNrCz%Union[_DocumentType, RawBSONDocument]r/rDrEr)rG replacementupsertrHrIr cCsf|dk rtd||dk r$td||dk rDt|tsDt||_n||_||_||_||_ ||_ dS)aCreate a ReplaceOne instance. For use with :meth:`~pymongo.collection.Collection.bulk_write`. :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. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. .. versionchanged:: 3.11 Added the ``hint`` option. .. versionchanged:: 3.5 Added the ``collation`` option. NrGrW) rrrKr*rrrBr@rrUrA)r!rGrVrWrHrIr"r"r#r$s  zReplaceOne.__init__rr%cCs&|j|j|j|jt|j|jddS)r'rNN)Z add_replacer@rrUrrArBr(r"r"r#r)szReplaceOne._add_to_bulkrr0cCsDt|t|kr@|j|j|j|j|jf|j|j|j|j|jfkStSr2)r3r@rrUrArBr4r5r"r"r#r6szReplaceOne.__eq__cCs ||k Sr2r"r5r"r"r#r7szReplaceOne.__ne__r*r+cCs"d|jj|j|j|j|j|jS)Nz {}({!r}, {!r}, {!r}, {!r}, {!r}))format __class__r9r@rrUrArBr-r"r"r#r.szReplaceOne.__repr__)FNN) r9r:r;r<r=r$r)r6r7r.r"r"r"r#rTs,  rTc@sJeZdZdZdZddddddd d d Zd dd ddZddddZdS) _UpdateOpz)Private base class for update operations.)r@rrUrA_array_filtersrBrC#Union[Mapping[str, Any], _Pipeline]r/rD!Optional[List[Mapping[str, Any]]]rE)rGdocrWrH array_filtersrIcCs~|dk rtd||dk r$td||dk r6td||dk rVt|tsVt||_n||_||_||_ ||_ ||_ ||_ dS)NrGrWr_) rrrrKr*rrrBr@rrUrAr[)r!rGr^rWrHr_rIr"r"r#r$"s    z_UpdateOp.__init__objectr0cCsJt|t|rF|j|j|j|j|j|jf|j|j|j|j|j|jfkStSr2) rKr3r@rrUrAr[rBr4r5r"r"r#r6<s"z_UpdateOp.__eq__r*r+c Cs&d|jj|j|j|j|j|j|jS)Nz&{}({!r}, {!r}, {!r}, {!r}, {!r}, {!r})) rXrYr9r@rrUrAr[rBr-r"r"r#r.Osz_UpdateOp.__repr__N)r9r:r;r<r=r$r6r.r"r"r"r#rZs rZc sHeZdZdZdZdddddd d d d fd d Zdd dddZZS) UpdateOnez#Represents an update_one operation.r"FNrCr\r/rDr]rErrGupdaterWrHr_rIr cst||||||dS)aRepresents an update_one operation. For use with :meth:`~pymongo.collection.Collection.bulk_write`. :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. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `array_filters` (optional): A list of filters specifying which array elements an update should apply. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. .. 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. Nsuperr$r!rGrcrWrHr_rIrYr"r#r$`s&zUpdateOne.__init__rr%c Cs,|j|j|jd|jt|j|j|jddS)r'FrHr_rINZ add_updater@rrUrrAr[rBr(r"r"r#r)szUpdateOne._add_to_bulk)FNNNr9r:r;r<r=r$r) __classcell__r"r"rgr#ra[s (rac sHeZdZdZdZdddddd d d d fd d Zdd dddZZS) UpdateManyz$Represents an update_many operation.r"FNrCr\r/rDr]rErrbcst||||||dS)aCreate an UpdateMany instance. For use with :meth:`~pymongo.collection.Collection.bulk_write`. :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. - `collation` (optional): An instance of :class:`~pymongo.collation.Collation`. - `array_filters` (optional): A list of filters specifying which array elements an update should apply. - `hint` (optional): An index to use to support the query predicate specified either by its string name, or in the same format as passed to :meth:`~pymongo.collection.Collection.create_index` (e.g. ``[('field', ASCENDING)]``). This option is only supported on MongoDB 4.2 and above. .. 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. Nrdrfrgr"r#r$s&zUpdateMany.__init__rr%c Cs,|j|j|jd|jt|j|j|jddS)r'TrhNrir(r"r"r#r)szUpdateMany._add_to_bulk)FNNNrjr"r"rgr#rls (rlc@s8eZdZdZdZddddddZed d d d Zd S) IndexModelzRepresents an index to create.) __document _IndexKeyHintrr)keyskwargsr cKsZt|}|ddkr"t||d<t||d<t|dd}||_|dk rV||jd<dS)a Create an Index instance. For use with :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. :Parameters: - `keys`: a single key or a list containing (key, direction) pairs or keys specifying the index to create. - `**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.2 Added the ``partialFilterExpression`` option to support partial indexes. .. _wildcard index: https://mongodb.com/docs/master/core/index-wildcard/ nameNkeyrH)rgetrrrpop_IndexModel__document)r!rprqrHr"r"r#r$s>  zIndexModel.__init__zDict[str, Any]r+cCs|jS)zUAn index document suitable for passing to the createIndexes command. )rvr-r"r"r#rszIndexModel.documentNr9r:r;r<r=r$propertyrr"r"r"r#rms Grmc@s:eZdZdZdZd dddddd Zedd d d ZdS)SearchIndexModelz$Represents a search index to create.rnNrCz Optional[str]r) definitionrrr cCs(|dk rt||d|_n t|d|_dS)aCreate a Search Index instance. For use with :meth:`~pymongo.collection.Collection.create_search_index` and :meth:`~pymongo.collection.Collection.create_search_indexes`. :Parameters: - `definition` - The definition for this index. - `name` (optional) - The name for this index, if present. .. versionadded:: 4.5 .. note:: Search indexes require a MongoDB server version 7.0+ Atlas cluster. N)rrrz)rz)dict_SearchIndexModel__document)r!rzrrr"r"r#r$(s zSearchIndexModel.__init__r+cCs|jS)zThe document for this index.)r|r-r"r"r#r:szSearchIndexModel.document)Nrwr"r"r"r#ry#s ryN)1r< __future__rtypingrrrrrrr r r r Z bson.raw_bsonr ZpymongorZpymongo.collationrZpymongo.commonrrrZpymongo.helpersrrrZpymongo.typingsrrrZbson.sonrZ pymongo.bulkrr*intZ _IndexListrorr>rSrTrZrarlrmryr"r"r"r#s, 0     *  ==T>::T