3 ]]6@sdZddlmZmZmZddlmZddlmZm Z m Z Gddde Z Gddde Z Gd d d e ZGd d d e ZGd dde ZGdddeZGdddeZGddde ZdS)zOperation class definitions.)validate_booleanvalidate_is_mapping validate_list)validate_collation_or_none)_gen_index_name_index_document _index_listc@s<eZdZdZdZddZddZddZd d Zd d Z d S) InsertOnez#Represents an insert_one operation._doccCs ||_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. N)r )selfdocumentr 5/tmp/pip-build-20mum3z4/pymongo/pymongo/operations.py__init__s zInsertOne.__init__cCs|j|jdS)z3Add this operation to the _Bulk instance `bulkobj`.N)Z add_insertr )r bulkobjr r r _add_to_bulk&szInsertOne._add_to_bulkcCs d|jfS)Nz InsertOne(%r))r )r r r r__repr__*szInsertOne.__repr__cCs t|t|kr|j|jkStS)N)typer NotImplemented)r otherr r r__eq__-s zInsertOne.__eq__cCs ||k S)Nr )r rr r r__ne__2szInsertOne.__ne__N)r ) __name__ __module__ __qualname____doc__ __slots__rrrrrr r r rr s r c@s>eZdZdZdZdddZddZd d Zd d Zd dZ dS) DeleteOnez"Represents a delete_one operation._filter _collationNcCs"|dk rtd|||_||_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`. This option is only supported on MongoDB 3.4 and above. .. versionchanged:: 3.5 Added the `collation` option. Nfilter)rrr)r r collationr r rr;s zDeleteOne.__init__cCs|j|jd|jddS)z3Add this operation to the _Bulk instance `bulkobj`.)r!N) add_deleterr)r rr r rrNszDeleteOne._add_to_bulkcCsd|j|jfS)NzDeleteOne(%r, %r))rr)r r r rrRszDeleteOne.__repr__cCs,t|t|kr(|j|jf|j|jfkStS)N)rrrr)r rr r rrUs zDeleteOne.__eq__cCs ||k S)Nr )r rr r rr[szDeleteOne.__ne__)rr)N) rrrrrrrrrrr r r rr6s rc@s>eZdZdZdZdddZddZd d Zd d Zd dZ dS) DeleteManyz#Represents a delete_many operation.rrNcCs"|dk rtd|||_||_dS)aCreate 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`. This option is only supported on MongoDB 3.4 and above. .. versionchanged:: 3.5 Added the `collation` option. Nr )rrr)r r r!r r rrds zDeleteMany.__init__cCs|j|jd|jddS)z3Add this operation to the _Bulk instance `bulkobj`.r)r!N)r#rr)r rr r rrwszDeleteMany._add_to_bulkcCsd|j|jfS)NzDeleteMany(%r, %r))rr)r r r rr{szDeleteMany.__repr__cCs,t|t|kr(|j|jf|j|jfkStS)N)rrrr)r rr r rr~s zDeleteMany.__eq__cCs ||k S)Nr )r rr r rrszDeleteMany.__ne__)rr)N) rrrrrrrrrrr r r rr$_s r$c@s>eZdZdZdZddd Zd d Zd d ZddZddZ dS) ReplaceOnez#Represents a replace_one operation.rr _upsertrFNcCs@|dk rtd||dk r$td|||_||_||_||_dS)aXCreate 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`. This option is only supported on MongoDB 3.4 and above. .. versionchanged:: 3.5 Added the `collation` option. Nr upsert)rrrr r&r)r r replacementr'r!r r rrs  zReplaceOne.__init__cCs|j|j|j|j|jddS)z3Add this operation to the _Bulk instance `bulkobj`.)r!N)Z add_replacerr r&r)r rr r rrszReplaceOne._add_to_bulkcCs<t|t|kr8|j|j|j|jf|j|j|j|jfkStS)N)rrr r&rr)r rr r rrszReplaceOne.__eq__cCs ||k S)Nr )r rr r rrszReplaceOne.__ne__cCsd|jj|j|j|j|jfS)Nz%s(%r, %r, %r, %r)) __class__rrr r&r)r r r rrszReplaceOne.__repr__)rr r&r)FN) rrrrrrrrrrr r r rr%s r%c@s4eZdZdZdZddZd d Zd d Zd dZdS) _UpdateOpz)Private base class for update operations.rr r&r_array_filterscCsX|dk rtd||dk r$td||dk r6td|||_||_||_||_||_dS)Nr r' array_filters)rrrrr r&rr+)r r docr'r!r,r r rrs   z_UpdateOp.__init__cCsDt|t|kr@|j|j|j|j|jf|j|j|j|j|jfkStS)N)rrr r&rr+r)r rr r rrs  z_UpdateOp.__eq__cCs ||k S)Nr )r rr r rrsz_UpdateOp.__ne__cCs"d|jj|j|j|j|j|jfS)Nz%s(%r, %r, %r, %r, %r))r)rrr r&rr+)r r r rrsz_UpdateOp.__repr__N)rr r&rr+) rrrrrrrrrr r r rr*s   r*cs.eZdZdZfZdfdd ZddZZS) UpdateOnez#Represents an update_one operation.FNcstt|j|||||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`. 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. Requires MongoDB 3.6+. .. 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. N)superr.r)r r updater'r!r,)r)r rrszUpdateOne.__init__cCs$|j|j|jd|j|j|jddS)z3Add this operation to the _Bulk instance `bulkobj`.F)r!r,N) add_updaterr r&rr+)r rr r rrszUpdateOne._add_to_bulk)FNN)rrrrrrr __classcell__r r )r)rr.s r.cs.eZdZdZfZdfdd ZddZZS) UpdateManyz$Represents an update_many operation.FNcstt|j|||||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`. 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. Requires MongoDB 3.6+. .. 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. N)r/r3r)r r r0r'r!r,)r)r rr szUpdateMany.__init__cCs$|j|j|jd|j|j|jddS)z3Add this operation to the _Bulk instance `bulkobj`.T)r!r,N)r1rr r&rr+)r rr r rr'szUpdateMany._add_to_bulk)FNN)rrrrrrrr2r r )r)rr3s r3c@s(eZdZdZdZddZeddZdS) IndexModelzRepresents an index to create. __documentcKsTt|}d|krt||d<t||d<t|jdd}||_|dk rP||jd<dS)a Create an Index instance. For use with :meth:`~pymongo.collection.Collection.create_indexes`. 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`). 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 server version >= 3.2. - `collation`: An instance of :class:`~pymongo.collation.Collation` that specifies the collation to use in MongoDB >= 3.4. - `wildcardProjection`: Allows users to include or exclude specific field paths from a `wildcard index`_ using the { "$**" : 1} key pattern. Requires server version >= 4.2. See the MongoDB documentation for a full list of supported options by server version. :Parameters: - `keys`: a single key or a list of (key, direction) pairs specifying the index to create - `**kwargs` (optional): any additional index creation options (see the above list) should be passed as keyword arguments .. versionchanged:: 3.2 Added partialFilterExpression to support partial indexes. .. _wildcard index: https://docs.mongodb.com/master/core/index-wildcard/#wildcard-index-core namekeyr!N)rrrrpop_IndexModel__document)r keyskwargsr!r r rr3s8  zIndexModel.__init__cCs|jS)zUAn index document suitable for passing to the createIndexes command. )r9)r r r rr tszIndexModel.documentN)r5)rrrrrrpropertyr r r r rr4.sAr4N)rZpymongo.commonrrrZpymongo.collationrZpymongo.helpersrrrobjectr rr$r%r*r.r3r4r r r rs  ))4$''