collection – Collection level operations

    pymongo.ASCENDING = 1

    Ascending sort order.

    pymongo.DESCENDING = -1

    Descending sort order.

    pymongo.GEO2D = ‘2d’

    Index specifier for a 2-dimensional geospatial index.

    pymongo.GEOHAYSTACK = ‘geoHaystack’

    DEPRECATED - Index specifier for a 2-dimensional .

    DEPRECATED - GEOHAYSTACK is deprecated and will be removed in PyMongo 4.0. geoHaystack indexes (and the geoSearch command) were deprecated in MongoDB 4.4. Instead, create a 2d index and use $geoNear or $geoWithin. See .

    Changed in version 3.11: Deprecated.

    pymongo.GEOSPHERE = ‘2dsphere’

    Index specifier for a spherical geospatial index.

    New in version 2.5.

    pymongo.HASHED = ‘hashed’

    Index specifier for a .

    New in version 2.5.

    pymongo.TEXT = ‘text’

    Index specifier for a text index.

    See also

    MongoDB’s which offers more advanced text search functionality.

    New in version 2.7.1.

    class pymongo.collection.ReturnDocument

    An enum used with find_one_and_replace() and .

    • BEFORE

      Return the original document before it was updated/replaced, or None if no document matches the query.

    • AFTER

      Return the updated/replaced or inserted document.

    class pymongo.collection.Collection(database, name, create=False, \*kwargs*)

    Get / create a Mongo collection.

    Raises TypeError if name is not an instance of basestring ( in python 3). Raises InvalidName if name is not a valid collection name. Any additional keyword arguments will be used as options passed to the create command. See 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.

    Changed in version 3.6: Added session parameter.

    Changed in version 3.4: Support the collation option.

    Changed in version 3.2: Added the read_concern option.

    Changed in version 3.0: Added the codec_options, read_preference, and write_concern options. Removed the uuid_subtype attribute. Collection no longer returns an instance of for attribute names with leading underscores. You must use dict-style lookups instead::

    Not:

    collection.__my_collection__

    Changed in version 2.2: Removed deprecated argument: options

    New in version 2.1: uuid_subtype attribute

    See also

    The MongoDB documentation on

    collections

    • c[name] || c.name

      Get the name sub-collection of c.

      Raises InvalidName if an invalid collection name is used.

    • full_name

      The full name of this .

      The full name is of the form database_name.collection_name.

    • name

      The name of this Collection.

    • database

      The that this Collection is a part of.

    • codec_options

      Read only access to the of this instance.

    • read_preference

      Read only access to the read preference of this instance.

      Changed in version 3.0: The read_preference attribute is now read only.

    • write_concern

      Read only access to the of this instance.

      Changed in version 3.0: The write_concern attribute is now read only.

    • read_concern

      Read only access to the of this instance.

      New in version 3.2.

    • with_options(codec_options=None, read_preference=None, write_concern=None, read_concern=None)

      Get a clone of this collection changing the specified settings.

      Parameters:
      • codec_options (optional): An instance of CodecOptions. If None (the default) the of this Collection is used.
      • read_preference (optional): The read preference to use. If None (the default) the of this Collection is used. See for options.
      • write_concern (optional): An instance of WriteConcern. If None (the default) the of this Collection is used.
      • read_concern (optional): An instance of . If None (the default) the read_concern of this is used.

    • bulk_write(requests, ordered=True, bypass_document_validation=False, session=None)

      Send a batch of write operations to the server.

      Requests are passed as a list of write operation instances ( InsertOne, , UpdateMany, , DeleteOne, or ).

      1. >>> for doc in db.test.find({}):
      2. ...     print(doc)
      3. ...
      4. {u'x': 1, u'_id': ObjectId('54f62e60fba5226811f634ef')}
      5. {u'x': 1, u'_id': ObjectId('54f62e60fba5226811f634f0')}
      6. >>> # DeleteMany, UpdateOne, and UpdateMany are also available.
      7. ...
      8. >>> from pymongo import InsertOne, DeleteOne, ReplaceOne
      9. >>> requests = [InsertOne({'y': 1}), DeleteOne({'x': 1}),
      10. ...             ReplaceOne({'w': 1}, {'z': 1}, upsert=True)]
      11. >>> result = db.test.bulk_write(requests)
      12. >>> result.inserted_count
      13. 1
      14. >>> result.deleted_count
      15. 1
      16. >>> result.modified_count
      17. 0
      18. >>> result.upserted_ids
      19. {2: ObjectId('54f62ee28891e756a6e1abd5')}
      20. >>> for doc in db.test.find({}):
      21. ...     print(doc)
      22. ...
      23. {u'x': 1, u'_id': ObjectId('54f62e60fba5226811f634f0')}
      24. {u'y': 1, u'_id': ObjectId('54f62ee2fba5226811f634f1')}
      25. {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 ClientSession.
      Returns:

      An instance of .

      See also

      Why does PyMongo add an _id field to all of my documents?

      Note

      bypass_document_validation requires server version >= 3.2

      Changed in version 3.6: Added session parameter.

      Changed in version 3.2: Added bypass_document_validation support

      New in version 3.0.

    • insert_one(document, bypass_document_validation=False, session=None)

      Insert a single document.

      1. >>> db.test.count_documents({'x': 1})
      2. 0
      3. >>> result = db.test.insert_one({'x': 1})
      4. >>> result.inserted_id
      5. ObjectId('54f112defba522406c9cc208')
      6. >>> db.test.find_one({'x': 1})
      7. {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 .
      Returns:

      See also

      Note

      bypass_document_validation requires server version >= 3.2

      Changed in version 3.6: Added session parameter.

      Changed in version 3.2: Added bypass_document_validation support

      New in version 3.0.

    • insert_many(documents, ordered=True, bypass_document_validation=False, session=None)

      Insert an iterable of documents.

      1. >>> db.test.count_documents({})
      2. 0
      3. >>> result = db.test.insert_many([{'x': i} for i in range(2)])
      4. >>> result.inserted_ids
      5. [ObjectId('54f113fffba522406c9cc20e'), ObjectId('54f113fffba522406c9cc20f')]
      6. >>> db.test.count_documents({})
      7. 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 ClientSession.
      Returns:

      An instance of .

      See also

      Why does PyMongo add an _id field to all of my documents?

      Note

      bypass_document_validation requires server version >= 3.2

      Changed in version 3.6: Added session parameter.

      Changed in version 3.2: Added bypass_document_validation support

      New in version 3.0.

    • replace_one(filter, replacement, upsert=False, bypass_document_validation=False, collation=None, hint=None, session=None)

      Replace a single document matching the filter.

      1. >>> for doc in db.test.find({}):
      2. ...     print(doc)
      3. ...
      4. {u'x': 1, u'_id': ObjectId('54f4c5befba5220aa4d6dee7')}
      5. >>> result = db.test.replace_one({'x': 1}, {'y': 1})
      6. >>> result.matched_count
      7. 1
      8. >>> result.modified_count
      9. 1
      10. >>> for doc in db.test.find({}):
      11. ...     print(doc)
      12. ...
      13. {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.

      1. >>> result = db.test.replace_one({'x': 1}, {'x': 1}, True)
      2. >>> result.matched_count
      3. 0
      4. >>> result.modified_count
      5. 0
      6. >>> result.upserted_id
      7. ObjectId('54f11e5c8891e756a6e1abd4')
      8. >>> db.test.find_one({'x': 1})
      9. {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 . 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 create_index() (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.2 and above.
      • session (optional): a .
      Returns:

      Changed in version 3.11: Added hint parameter.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Added the collation option.

      Changed in version 3.2: Added bypass_document_validation support.

      New in version 3.0.

    • update_one(filter, update, upsert=False, bypass_document_validation=False, collation=None, array_filters=None, hint=None, session=None)

      Update a single document matching the filter.

      1. >>> for doc in db.test.find():
      2. ...     print(doc)
      3. ...
      4. {u'x': 1, u'_id': 0}
      5. {u'x': 1, u'_id': 1}
      6. {u'x': 1, u'_id': 2}
      7. >>> result = db.test.update_one({'x': 1}, {'$inc': {'x': 3}})
      8. >>> result.matched_count
      9. 1
      10. >>> result.modified_count
      11. 1
      12. >>> for doc in db.test.find():
      13. ...     print(doc)
      14. ...
      15. {u'x': 4, u'_id': 0}
      16. {u'x': 1, u'_id': 1}
      17. {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 . 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 create_index() (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.2 and above.
      • session (optional): a .
      Returns:

      Changed in version 3.11: Added hint parameter.

      Changed in version 3.9: Added the ability to accept a pipeline as the update.

      Changed in version 3.6: Added the array_filters and session parameters.

      Changed in version 3.4: Added the collation option.

      Changed in version 3.2: Added bypass_document_validation support.

      New in version 3.0.

    • update_many(filter, update, upsert=False, array_filters=None, bypass_document_validation=False, collation=None, hint=None, session=None)

      Update one or more documents that match the filter.

      2. ...     print(doc)
      3. ...
      4. {u'x': 1, u'_id': 0}
      5. {u'x': 1, u'_id': 1}
      6. {u'x': 1, u'_id': 2}
      7. >>> result = db.test.update_many({'x': 1}, {'$inc': {'x': 3}})
      8. >>> result.matched_count
      9. 3
      10. >>> result.modified_count
      11. 3
      12. >>> for doc in db.test.find():
      13. ...     print(doc)
      14. ...
      15. {u'x': 4, u'_id': 0}
      16. {u'x': 4, u'_id': 1}
      17. {u'x': 4, u'_id': 2}
      Parameters:
      • filter: A query that matches the documents to update.
      • 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 . 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 create_index() (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.2 and above.
      • session (optional): a .
      Returns:

      Changed in version 3.11: Added hint parameter.

      Changed in version 3.9: Added the ability to accept a pipeline as the update.

      Changed in version 3.6: Added array_filters and session parameters.

      Changed in version 3.4: Added the collation option.

      Changed in version 3.2: Added bypass_document_validation support.

      New in version 3.0.

    • delete_one(filter, collation=None, hint=None, session=None)

      Delete a single document matching the filter.

      1. >>> db.test.count_documents({'x': 1})
      2. 3
      3. >>> result = db.test.delete_one({'x': 1})
      4. >>> result.deleted_count
      5. 1
      6. >>> db.test.count_documents({'x': 1})
      7. 2
      Parameters:
      • filter: A query that matches the document to delete.
      • collation (optional): An instance of . 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 create_index() (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.4 and above.
      • session (optional): a .
      Returns:

      Changed in version 3.11: Added hint parameter.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Added the collation option.

      New in version 3.0.

    • delete_many(filter, collation=None, hint=None, session=None)

      Delete one or more documents matching the filter.

      1. >>> db.test.count_documents({'x': 1})
      2. 3
      3. >>> result = db.test.delete_many({'x': 1})
      4. >>> result.deleted_count
      5. 3
      6. >>> db.test.count_documents({'x': 1})
      7. 0
      Parameters:
      • filter: A query that matches the documents to delete.
      • collation (optional): An instance of . 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 create_index() (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.4 and above.
      • session (optional): a .
      Returns:

      Changed in version 3.11: Added hint parameter.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Added the collation option.

      New in version 3.0.

    • aggregate(pipeline, session=None, \*kwargs*)

      Perform an aggregation using the aggregation framework on this collection.

      All optional parameters should be passed as keyword arguments to this method. Valid options include, but are not limited to:

      The aggregate() method obeys the of this Collection, except when $out or $merge are used, in which case is used.

      Note

      This method does not support the ‘explain’ option. Please use command() instead. An example is included in the documentation.

      Note

      The write_concern of this collection is automatically applied to this operation when using MongoDB >= 3.4.

      Parameters:
      • pipeline: a list of aggregation pipeline stages
      • session (optional): a .
      • **kwargs (optional): See list of options above.
      Returns:

      A CommandCursor over the result set.

      Changed in version 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 .

      Changed in version 3.6: Added the session parameter. Added the maxAwaitTimeMS option. Deprecated the useCursor option.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4. Support the collation option.

      Changed in version 3.0: The aggregate() method always returns a CommandCursor. The pipeline argument must be a list.

      Changed in version 2.7: When the cursor option is used, return instead of Cursor.

      Changed in version 2.6: Added cursor support.

      New in version 2.3.

      See also

    • aggregate_raw_batches(pipeline, \*kwargs*)

      Perform an aggregation and retrieve batches of raw BSON.

      Similar to the method but returns a 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 module.

      1. >>> import bson
      2. >>> cursor = db.test.aggregate_raw_batches([
      3. ...     {'$project': {'x': {'$multiply': [2, '$x']}}}])
      4. >>> for batch in cursor:
      5. ...     print(bson.decode_all(batch))

      Note

      aggregate_raw_batches does not support sessions or auto encryption.

      New in version 3.6.

    • watch(pipeline=None, full_document=None, resume_after=None, max_await_time_ms=None, batch_size=None, collation=None, start_at_operation_time=None, session=None, start_after=None)

      Watch changes on this collection.

      Performs an aggregation with an implicit initial $changeStream stage and returns a CollectionChangeStream cursor which iterates over changes on this collection.

      Introduced in MongoDB 3.6.

      1. with db.collection.watch() as stream:
      2.     for change in stream:
      3.         print(change)

      The iterable blocks until the next change document is returned or an error is raised. If the 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.

      For a precise description of the resume process see the change streams specification.

      Note

      Using this helper method is preferred to directly calling with a $changeStream stage, for the purpose of supporting resumability.

      Warning

      This Collection’s 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 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 Timestamp. Requires MongoDB >= 4.0.
      • session (optional): a .
      • 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 CollectionChangeStream cursor.

      Changed in version 3.9: Added the start_after parameter.

      Changed in version 3.7: Added the start_at_operation_time parameter.

      New in version 3.6.

      See also

      The MongoDB documentation on

    • find(filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=CursorType.NON_TAILABLE, sort=None, allow_partial_results=False, oplog_replay=False, modifiers=None, batch_size=0, manipulate=True, collation=None, hint=None, max_scan=None, max_time_ms=None, max=None, min=None, return_key=False, show_record_id=False, snapshot=False, comment=None, session=None, allow_disk_use=None)

      Query the database.

      The filter argument is a prototype document that all results must match. For example:

      1. >>> 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 TypeError if any of the arguments are of improper type. Returns an instance of corresponding to this query.

      The find() method obeys the of this Collection.

      Note

      There are a number of caveats to using 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 Cursor instance created with the cursor_type requires an exclusive socket connection to MongoDB. If the Cursor is discarded without being completely iterated the underlying socket connection will be closed and discarded without being returned to the connection pool.

      Changed in version 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.

      Changed in version 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.

      Changed in version 3.6: Added session parameter.

      Changed in version 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.

      Changed in version 3.4: Added support for the collation option.

      Changed in version 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 objects. Use try_compile() to attempt to convert from a BSON regular expression to a Python regular expression object. Soft deprecated the manipulate option.

      Changed in version 2.7: Added compile_re option. If set to False, PyMongo represented BSON regular expressions as objects instead of attempting to compile BSON regular expressions as Python native regular expressions, thus preventing errors for some incompatible patterns, see PYTHON-500.

      Changed in version 2.3: Added the tag_sets and secondary_acceptable_latency_ms parameters.

      See also

      The MongoDB documentation on

    • find_raw_batches(filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=CursorType.NON_TAILABLE, sort=None, allow_partial_results=False, oplog_replay=False, modifiers=None, batch_size=0, manipulate=True, collation=None, hint=None, max_scan=None, max_time_ms=None, max=None, min=None, return_key=False, show_record_id=False, snapshot=False, comment=None, allow_disk_use=None)

      Query the database and retrieve batches of raw BSON.

      Similar to the find() method but returns a .

      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 bson module.

      1. >>> import bson
      2. >>> cursor = db.test.find_raw_batches()
      3. >>> for batch in cursor:
      4. ...     print(bson.decode_all(batch))

      Note

      find_raw_batches does not support sessions or auto encryption.

      New in version 3.6.

    • find_one(filter=None, \args, **kwargs*)

      Get a single document from the database.

      All arguments to are also valid arguments for find_one(), although any limit argument will be ignored. Returns a single document, or None if no matching document is found.

      The method obeys the read_preference of this .

      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 find().

      • *kwargs (optional): any additional keyword arguments are the same as the arguments to .

        1. >>> collection.find_one(max_time_ms=100)

    • find_one_and_delete(filter, projection=None, sort=None, hint=None, session=None, \*kwargs*)

      Finds a single document and deletes it, returning the document.

      1. >>> db.test.count_documents({'x': 1})
      2. 2
      3. >>> db.test.find_one_and_delete({'x': 1})
      4. {u'x': 1, u'_id': ObjectId('54f4e12bfba5220aa4d6dee8')}
      5. >>> db.test.count_documents({'x': 1})
      6. 1

      If multiple documents match filter, a sort can be applied.

      1. >>> for doc in db.test.find({'x': 1}):
      2. ...     print(doc)
      3. ...
      4. {u'x': 1, u'_id': 0}
      5. {u'x': 1, u'_id': 1}
      6. {u'x': 1, u'_id': 2}
      7. >>> db.test.find_one_and_delete(
      8. ...     {'x': 1}, sort=[('_id', pymongo.DESCENDING)])
      9. {u'x': 1, u'_id': 2}

      The projection option can be used to limit the fields returned.

      1. >>> db.test.find_one_and_delete({'x': 1}, projection={'_id': False})
      2. {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 create_index() (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.4 and above.
      • session (optional): a .
      • **kwargs (optional): additional command arguments can be passed as keyword arguments (for example maxTimeMS can be used with recent server versions).

      Changed in version 3.11: Added hint parameter.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.2: Respects write concern.

      Warning

      Starting in PyMongo 3.2, this command uses the WriteConcern of this 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.

      Changed in version 3.4: Added the collation option.

      New in version 3.0.

    • find_one_and_replace(filter, replacement, projection=None, sort=None, return_document=ReturnDocument.BEFORE, hint=None, session=None, \*kwargs*)

      Finds a single document and replaces it, returning either the original or the replaced document.

      The find_one_and_replace() method differs from by replacing the document matched by filter, rather than modifying the existing document.

      2. ...     print(doc)
      3. ...
      4. {u'x': 1, u'_id': 0}
      5. {u'x': 1, u'_id': 1}
      6. {u'x': 1, u'_id': 2}
      7. >>> db.test.find_one_and_replace({'x': 1}, {'y': 1})
      8. {u'x': 1, u'_id': 0}
      9. >>> for doc in db.test.find({}):
      10. ...     print(doc)
      11. ...
      12. {u'y': 1, u'_id': 0}
      13. {u'x': 1, u'_id': 1}
      14. {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 ReturnDocument.BEFORE (the default), returns the original document before it was replaced, or None if no document matches. If , 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 create_index() (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.4 and above.
      • session (optional): a .
      • **kwargs (optional): additional command arguments can be passed as keyword arguments (for example maxTimeMS can be used with recent server versions).

      Changed in version 3.11: Added the hint option.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Added the collation option.

      Changed in version 3.2: Respects write concern.

      Warning

      Starting in PyMongo 3.2, this command uses the WriteConcern of this 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.

      New in version 3.0.

    • find_one_and_update(filter, update, projection=None, sort=None, return_document=ReturnDocument.BEFORE, array_filters=None, hint=None, session=None, \*kwargs*)

      Finds a single document and updates it, returning either the original or the updated document.

      1. >>> db.test.find_one_and_update(
      2. ...    {'_id': 665}, {'$inc': {'count': 1}, '$set': {'done': True}})
      3. {u'_id': 665, u'done': False, u'count': 25}}

      Returns None if no document matches the filter.

      1. ...    {'_exists': False}, {'$inc': {'count': 1}})

      When the filter matches, by default 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.

      1. >>> from pymongo import ReturnDocument
      2. >>> db.example.find_one_and_update(
      3. ...     {'_id': 'userid'},
      4. ...     {'$inc': {'seq': 1}},
      5. ...     return_document=ReturnDocument.AFTER)
      6. {u'_id': u'userid', u'seq': 1}

      You can limit the fields returned with the projection option.

      1. >>> db.example.find_one_and_update(
      2. ...     {'_id': 'userid'},
      3. ...     {'$inc': {'seq': 1}},
      4. ...     projection={'seq': True, '_id': False},
      5. ...     return_document=ReturnDocument.AFTER)
      6. {u'seq': 2}

      The upsert option can be used to create the document if it doesn’t already exist.

      If multiple documents match filter, a sort can be applied.

      1. >>> for doc in db.test.find({'done': True}):
      2. ...     print(doc)
      3. ...
      4. {u'_id': 665, u'done': True, u'result': {u'count': 26}}
      5. {u'_id': 701, u'done': True, u'result': {u'count': 17}}
      6. >>> db.test.find_one_and_update(
      7. ...     {'done': True},
      8. ...     {'$set': {'final': True}},
      9. ...     sort=[('_id', pymongo.DESCENDING)])
      10. {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 (the default), returns the original document before it was updated. If 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 (e.g. [(‘field’, ASCENDING)]). This option is only supported on MongoDB 4.4 and above.
      • session (optional): a ClientSession.
      • **kwargs (optional): additional command arguments can be passed as keyword arguments (for example maxTimeMS can be used with recent server versions).

      Changed in version 3.11: Added the hint option.

      Changed in version 3.9: Added the ability to accept a pipeline as the update.

      Changed in version 3.6: Added the array_filters and session options.

      Changed in version 3.4: Added the collation option.

      Changed in version 3.2: Respects write concern.

      Warning

      Starting in PyMongo 3.2, this command uses the of this 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.

      New in version 3.0.

    • count_documents(filter, session=None, \*kwargs*)

      Count the number of documents in this collection.

      Note

      For a fast count of the total documents in a collection see .

      The 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 . 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 count_documents() method obeys the of this Collection.

      Note

      When migrating from to count_documents() the following query operators must be replaced:

      OperatorReplacement
      $where
      $near$geoWithin with
      $nearSphere$geoWithin with

      $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 ClientSession.
      • **kwargs (optional): See list of options above.

      New in version 3.7.

    • estimated_document_count(\*kwargs*)

      Get an estimate of the number of documents in this collection using collection metadata.

      The method is not supported in a transaction.

      All optional parameters should be passed as keyword arguments to this method. Valid options include:

      Parameters:
      • **kwargs (optional): See list of options above.

      New in version 3.7.

    • distinct(key, filter=None, session=None, \*kwargs*)

      Get a list of distinct values for key among all documents in this collection.

      Raises TypeError if key is not an instance of basestring ( 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 Collation. This option is only supported on MongoDB 3.4 and above.

      The method obeys the read_preference of this .

      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 ClientSession.
      • **kwargs (optional): See list of options above.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Support the collation option.

    • create_index(keys, session=None, \*kwargs*)

      Creates 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 basestring ( in python 3), and the direction(s) must be one of (ASCENDING, , GEO2D, , GEOSPHERE, , TEXT).

      To create a single key ascending index on the key 'mike' we just use a string argument:

      1. >>> my_collection.create_index("mike")

      For a compound index on 'mike' descending and 'eliot' ascending we need to use a list of tuples:

      1. >>> my_collection.create_index([("mike", pymongo.DESCENDING),
      2. ...                             ("eliot", pymongo.ASCENDING)])

      All optional index creation parameters should be passed as keyword arguments to this method. For example:

      1. >>> my_collection.create_index([("mike", pymongo.DESCENDING)],
      2. ...                            background=True)

      Valid options include, but are not limited to:

      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 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 ClientSession.
      • **kwargs (optional): any additional index creation options (see the above list) should be passed as keyword arguments

      Changed in version 3.11: Added the hidden option.

      Changed in version 3.6: Added session parameter. Added support for passing maxTimeMS in kwargs.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4. Support the collation option.

      Changed in version 3.2: Added partialFilterExpression to support partial indexes.

      Changed in version 3.0: Renamed key_or_list to keys. Removed the cache_for option. no longer caches index names. Removed support for the drop_dups and bucket_size aliases.

      See also

      The MongoDB documentation on

      indexes

    • create_indexes(indexes, session=None, \*kwargs*)

      Create one or more indexes on this collection.

      1. >>> from pymongo import IndexModel, ASCENDING, DESCENDING
      2. >>> index1 = IndexModel([("hello", DESCENDING),
      3. ...                      ("world", ASCENDING)], name="hello_world")
      4. >>> index2 = IndexModel([("goodbye", DESCENDING)])
      5. >>> db.test.create_indexes([index1, index2])
      6. ["hello_world", "goodbye_-1"]
      Parameters:
      • indexes: A list of instances.
      • session (optional): a ClientSession.
      • **kwargs (optional): optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments.

      Note

      create_indexes uses the command introduced in MongoDB 2.6 and cannot be used with earlier versions.

      Note

      The write_concern of this collection is automatically applied to this operation when using MongoDB >= 3.4.

      Changed in version 3.6: Added session parameter. Added support for arbitrary keyword arguments.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4.

      New in version 3.0.

    • drop_index(index_or_name, session=None, \*kwargs*)

      Drops 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

      Parameters:
      • index_or_name: index (or name of index) to drop
      • session (optional): a .
      • **kwargs (optional): optional arguments to the createIndexes command (like maxTimeMS) can be passed as keyword arguments.

      Note

      The write_concern of this collection is automatically applied to this operation when using MongoDB >= 3.4.

      Changed in version 3.6: Added session parameter. Added support for arbitrary keyword arguments.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4.

    • drop_indexes(session=None, \*kwargs*)

      Drops all indexes on this collection.

      Can be used on non-existant collections or collections with no indexes. Raises OperationFailure on an error.

      Note

      The of this collection is automatically applied to this operation when using MongoDB >= 3.4.

      Changed in version 3.6: Added session parameter. Added support for arbitrary keyword arguments.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4.

    • reindex(session=None, \*kwargs*)

      Rebuilds all indexes on this collection.

      DEPRECATED - The reindex() method is deprecated and will be removed in PyMongo 4.0. Use to run the reIndex command directly instead:

      1. db.command({"reIndex": "<collection_name>"})

      Note

      Starting in MongoDB 4.6, the reIndex command can only be run when connected to a standalone mongod.

      Parameters:
      • session (optional): a 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.

      Changed in version 3.11: Deprecated.

      Changed in version 3.6: Added session parameter. Added support for arbitrary keyword arguments.

      Changed in version 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.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4.

    • list_indexes(session=None)

      Get a cursor over the index documents for this collection.

      1. >>> for index in db.test.list_indexes():
      2. ...     print(index)
      3. ...
      4. SON([('v', 2), ('key', SON([('_id', 1)])), ('name', '_id_')])
      Parameters:
      • session (optional): a .
      Returns:

      An instance of CommandCursor.

      Changed in version 3.6: Added session parameter.

      New in version 3.0.

    • index_information(session=None)

      Get 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:

      1. >>> db.test.create_index("x", unique=True)
      2. u'x_1'
      3. >>> db.test.index_information()
      4. {u'_id_': {u'key': [(u'_id', 1)]},
      5.  u'x_1': {u'unique': True, u'key': [(u'x', 1)]}}
      Parameters:
      • session (optional): a .

      Changed in version 3.6: Added session parameter.

    • drop(session=None)

      Alias for drop_collection().

      Parameters:
      • session (optional): a .

      The following two calls are equivalent:

      1. >>> db.foo.drop()
      2. >>> db.drop_collection("foo")

      Changed in version 3.7: drop() now respects this ’s write_concern.

      Changed in version 3.6: Added session parameter.

    • rename(new_name, session=None, \*kwargs*)

      Rename this collection.

      If operating in auth mode, client must be authorized as an admin to perform this operation. Raises if new_name is not an instance of basestring (str in python 3). Raises if new_name is not a valid collection name.

      Parameters:
      • new_name: new name for this collection
      • session (optional): a ClientSession.
      • **kwargs (optional): additional arguments to the rename command may be passed as keyword arguments to this helper method (i.e. dropTarget=True)

      Note

      The of this collection is automatically applied to this operation when using MongoDB >= 3.4.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4.

    • options(session=None)

      Get the options set on this collection.

      Returns a dictionary of options and their values - see 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 .

      Changed in version 3.6: Added session parameter.

    • map_reduce(map, reduce, out, full_response=False, session=None, \*kwargs*)

      Perform a map/reduce operation on this collection.

      If full_response is False (default) returns a Collection instance containing the results of the operation. Otherwise, returns the full response from the server to the .

      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. can be used to specify multiple options. e.g. SON([(‘replace’, <collection name>), (‘db’, <database name>)])

      • full_response (optional): if True, return full response to this command - otherwise just return the result collection

      • session (optional): a ClientSession.

      • **kwargs (optional): additional arguments to the may be passed as keyword arguments to this helper method, e.g.:

        1. >>> db.test.map_reduce(map, reduce, “myresults”, limit=2)

      Note

      The map_reduce() method does not obey the of this Collection. To run mapReduce on a secondary use the method instead.

      Note

      The write_concern of this collection is automatically applied to this operation (if the output is not inline) when using MongoDB >= 3.4.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Apply this collection’s write concern automatically to this operation when connected to MongoDB >= 3.4.

      See also

      Changed in version 3.4: Added the collation option.

      Changed in version 2.2: Removed deprecated arguments: merge_output and reduce_output

      See also

      The MongoDB documentation on

      mapreduce

    • inline_map_reduce(map, reduce, full_response=False, session=None, \*kwargs*)

      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 .

      The inline_map_reduce() method obeys the of this 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 .

      • **kwargs (optional): additional arguments to the map reduce command may be passed as keyword arguments to this helper method, e.g.:

        1. >>> db.test.inline_map_reduce(map, reduce, limit=2)

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Added the collation option.

    • parallel_scan(num_cursors, session=None, \*kwargs*)

      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:

      The method obeys the read_preference of this .

      Parameters:
      • num_cursors: the number of cursors to return
      • session (optional): a ClientSession.
      • **kwargs: additional options for the parallelCollectionScan command can be passed as keyword arguments.

      Note

      Requires server version >= 2.5.5.

      Changed in version 3.7: Deprecated.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Added back support for arbitrary keyword arguments. MongoDB 3.4 adds support for maxTimeMS as an option to the parallelCollectionScan command.

      Changed in version 3.0: Removed support for arbitrary keyword arguments, since the parallelCollectionScan command has no optional arguments.

    • initialize_unordered_bulk_op(bypass_document_validation=False)

      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 instance.

      See Unordered Bulk Write Operations for examples.

      Note

      bypass_document_validation requires server version >= 3.2

      Changed in version 3.5: Deprecated. Use instead.

      Changed in version 3.2: Added bypass_document_validation support

      New in version 2.7.

    • initialize_ordered_bulk_op(bypass_document_validation=False)

      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 BulkOperationBuilder instance.

      See for examples.

      Note

      bypass_document_validation requires server version >= 3.2

      Changed in version 3.5: Deprecated. Use bulk_write() instead.

      Changed in version 3.2: Added bypass_document_validation support

      New in version 2.7.

    • group(key, condition, initial, reduce, finalize=None, \*kwargs*)

      Perform a query similar to an SQL group by operation.

      DEPRECATED - The group command was deprecated in MongoDB 3.4. The method is deprecated and will be removed in PyMongo 4.0. Use aggregate() with the $group stage or instead.

      Changed in version 3.5: Deprecated the group method.

      Changed in version 3.4: Added the collation option.

      Changed in version 2.2: Removed deprecated argument: command

    • count(filter=None, session=None, \*kwargs*)

      DEPRECATED - Get the number of documents in this collection.

      The count() method is deprecated and not supported in a transaction. Please use or 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 . 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 count() method obeys the of this Collection.

      Note

      When migrating from to count_documents() the following query operators must be replaced:

      $expr requires MongoDB 3.6+

      Parameters:
      • filter (optional): A query document that selects which documents to count in the collection.
      • session (optional): a .
      • **kwargs (optional): See list of options above.

      Changed in version 3.7: Deprecated.

      Changed in version 3.6: Added session parameter.

      Changed in version 3.4: Support the collation option.

    • insert(doc_or_docs, manipulate=True, check_keys=True, continue_on_error=False, \*kwargs*)

      Insert a document(s) into this collection.

      DEPRECATED - Use insert_one() or instead.

      Changed in version 3.0: Removed the safe parameter. Pass w=0 for unacknowledged write operations.

    • save(to_save, manipulate=True, check_keys=True, \*kwargs*)

      Save a document in this collection.

      DEPRECATED - Use insert_one() or instead.

      Changed in version 3.0: Removed the safe parameter. Pass w=0 for unacknowledged write operations.

    • update(spec, document, upsert=False, manipulate=False, multi=False, check_keys=True, \*kwargs*)

      Update a document(s) in this collection.

      DEPRECATED - Use replace_one(), , or update_many() instead.

      Changed in version 3.0: Removed the safe parameter. Pass w=0 for unacknowledged write operations.

    • remove(spec_or_id=None, multi=True, \*kwargs*)

      Remove a document(s) from this collection.

      DEPRECATED - Use or delete_many() instead.

      Changed in version 3.0: Removed the safe parameter. Pass w=0 for unacknowledged write operations.

    • find_and_modify(query={}, update=None, upsert=False, sort=None, full_response=False, manipulate=False, \*kwargs*)

      Update and return an object.

      DEPRECATED - Use , find_one_and_replace(), or instead.

    • (key_or_list, cache_for=300, \*kwargs*)

      Changed in version 3.0: DEPRECATED