mdocument.client.MDocumentAsyncIOMotorDatabase¶

class mdocument.client.MDocumentAsyncIOMotorDatabase(client, name, **kwargs)¶

Bases: motor.motor_asyncio.AsyncIOMotorDatabase

__init__(client, name, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`(client, name, **kwargs)	Initialize self.
`aggregate`(pipeline, **kwargs)	Execute an aggregation pipeline on this database.
`command`(command[, value, check, …])	Issue a MongoDB command.
`create_collection`(name[, codec_options, …])	Create a new `Collection` in this database.
`current_op`([include_all, session])	DEPRECATED: Get information on operations currently running.
`dereference`(dbref[, session])	Dereference a `DBRef`, getting the document it points to.
`drop_collection`(name_or_collection[, session])	Drop a collection.
`get_collection`(name[, codec_options, …])	Get a `Collection` with the given name and options.
`get_io_loop`()
`list_collection_names`([session, filter])	Get a list of all the collection names in this database.
`list_collections`([session, filter])	Get a cursor over the collectons of this database.
`profiling_info`([session])	Returns a list containing current profiling information.
`profiling_level`([session])	Get the database’s current profiling level.
`set_profiling_level`(level[, slow_ms, session])	Set the database’s profiling level.
`validate_collection`(name_or_collection[, …])	Validate a collection.
`watch`([pipeline, full_document, …])	Watch changes on this database.
`with_options`([codec_options, …])	Get a clone of this database changing the specified settings.
`wrap`(obj)

Attributes

`client`	This MotorDatabase’s `MotorClient`.
`codec_options`	Read only access to the `CodecOptions` of this instance.
`incoming_copying_manipulators`	All incoming SON copying manipulators.
`incoming_manipulators`	All incoming SON manipulators.
`name`	The name of this `Database`.
`outgoing_copying_manipulators`	All outgoing SON copying manipulators.
`outgoing_manipulators`	All outgoing SON manipulators.
`read_concern`	Read only access to the `ReadConcern` of this instance.
`read_preference`	Read only access to the read preference of this instance.
`write_concern`	Read only access to the `WriteConcern` of this instance.

aggregate(pipeline, **kwargs)¶

Execute an aggregation pipeline on this database.

Introduced in MongoDB 3.6.

The aggregation can be run on a secondary if the client is connected to a replica set and its read_preference is not PRIMARY. The aggregate() method obeys the read_preference of this MotorDatabase, except when $out or $merge are used, in which case PRIMARY is used.

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

allowDiskUse (bool): Enables writing to temporary files. When set to True, aggregation stages can write data to the _tmp subdirectory of the –dbpath directory. The default is False.

maxTimeMS (int): The maximum amount of time to allow the operation to run in milliseconds.

batchSize (int): The maximum number of documents to return per batch. Ignored if the connected mongod or mongos does not support returning aggregate results using a cursor.

collation (optional): An instance of Collation.

Returns a MotorCommandCursor that can be iterated like a cursor from find():

async def f():
    # Lists all operations currently running on the server.
    pipeline = [{"$currentOp": {}}]
    async for operation in client.admin.aggregate(pipeline):
        print(operation)

Note

This method does not support the ‘explain’ option. Please use MotorDatabase.command() instead.

Note

The MotorDatabase.write_concern of this database is automatically applied to this operation.

New in version 2.1.

property client¶: This MotorDatabase’s MotorClient.

property codec_options¶: Read only access to the CodecOptions of this instance.

command(command, value=1, check=True, allowable_errors=None, read_preference=None, codec_options=CodecOptions(document_class=dict, tz_aware=False, uuid_representation=UuidRepresentation.PYTHON_LEGACY, unicode_decode_error_handler='strict', tzinfo=None, type_registry=TypeRegistry(type_codecs=[], fallback_encoder=None)), session=None, **kwargs)¶

Issue a MongoDB command.

Send command command to the database and return the response. If command is a string then the command {command: value} will be sent. Otherwise, command must be a dict and will be sent as-is.

Additional keyword arguments are added to the final command document before it is sent.

For example, a command like {buildinfo: 1} can be sent using:

result = await db.command("buildinfo")

For a command where the value matters, like {collstats: collection_name} we can do:

result = await db.command("collstats", collection_name)

For commands that take additional arguments we can use kwargs. So {filemd5: object_id, root: file_root} becomes:

result = await db.command("filemd5", object_id, root=file_root)

Parameters

command: document representing the command to be issued, or the name of the command (for simple commands only).

Note

the order of keys in the command document is significant (the “verb” must come first), so commands which require multiple keys (e.g. findandmodify) should use an instance of SON or a string and kwargs instead of a Python dict.
value (optional): value to use for the command verb when command is passed as a string
check (optional): check the response for errors, raising OperationFailure if there are any
allowable_errors: if check is True, error messages in this list will be ignored by error-checking
read_preference: The read preference for this operation. See read_preferences for options.
session (optional): a ClientSession, created with start_session().
**kwargs (optional): additional keyword arguments will be added to the command document before it is sent

Changed in version 1.2: Added session parameter.

async create_collection(name, codec_options=None, read_preference=None, write_concern=None, read_concern=None, session=None, **kwargs)¶

Create a new Collection in this database.

Normally collection creation is automatic. This method should only be used to specify options on creation. CollectionInvalid will be raised if the collection already exists.

Options should be passed as keyword arguments to this method. Supported options vary with MongoDB release. Some examples include:

“size”: desired initial size for the collection (in bytes). For capped collections this size is the max size of the collection.

“capped”: if True, this is a capped collection

“max”: maximum number of objects if capped (optional)

See the MongoDB documentation for a full list of supported options by server version.

Parameters

name: the name of the collection to create
codec_options (optional): An instance of CodecOptions. If None (the default) the codec_options of this Database is used.
read_preference (optional): The read preference to use. If None (the default) the read_preference of this Database is used.
write_concern (optional): An instance of WriteConcern. If None (the default) the write_concern of this Database is used.
read_concern (optional): An instance of ReadConcern. If None (the default) the read_concern of this Database is used.
collation (optional): An instance of Collation.
session (optional): a ClientSession.
**kwargs (optional): additional keyword arguments will be passed as options for the create collection command

Changed in version 3.11: This method is now supported inside multi-document transactions with MongoDB 4.4+.

Changed in version 3.6: Added session parameter.

Changed in version 3.4: Added the collation option.

Changed in version 3.0: Added the codec_options, read_preference, and write_concern options.

Changed in version 2.2: Removed deprecated argument: options

current_op(include_all=False, session=None)¶

DEPRECATED: Get information on operations currently running.

Starting with MongoDB 3.6 this helper is obsolete. The functionality provided by this helper is available in MongoDB 3.6+ using the $currentOp aggregation pipeline stage, which can be used with aggregate(). Note that, while this helper can only return a single document limited to a 16MB result, aggregate() returns a cursor avoiding that limitation.

Users of MongoDB versions older than 3.6 can use the currentOp command directly:

# MongoDB 3.2 and 3.4
await client.admin.command("currentOp")

Or query the “inprog” virtual collection:

# MongoDB 2.6 and 3.0
await client.admin["$cmd.sys.inprog"].find_one()

Parameters

include_all (optional): if True also list currently idle operations in the result
session (optional): a ClientSession, created with start_session().

Changed in version 2.1: Deprecated, use aggregate() instead.

Changed in version 1.2: Added session parameter.

dereference(dbref, session=None, **kwargs)¶

Dereference a DBRef, getting the document it points to.

Raises TypeError if dbref is not an instance of DBRef. Returns a document, or None if the reference does not point to a valid document. Raises ValueError if dbref has a database specified that is different from the current database.

Parameters

dbref: the reference
session (optional): a ClientSession.
**kwargs (optional): any additional keyword arguments are the same as the arguments to find().

Changed in version 3.6: Added session parameter.

drop_collection(name_or_collection, session=None)¶

Drop a collection.

Parameters

name_or_collection: the name of a collection to drop or the collection object itself
session (optional): a ClientSession.

Note

The write_concern of this database 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 database’s write concern automatically to this operation when connected to MongoDB >= 3.4.

get_collection(name, codec_options=None, read_preference=None, write_concern=None, read_concern=None)¶

Get a Collection with the given name and options.

Useful for creating a Collection with different codec options, read preference, and/or write concern from this Database.

>>> db.read_preference
Primary()
>>> coll1 = db.test
>>> coll1.read_preference
Primary()
>>> from pymongo import ReadPreference
>>> coll2 = db.get_collection(
...     'test', read_preference=ReadPreference.SECONDARY)
>>> coll2.read_preference
Secondary(tag_sets=None)

Parameters

name: The name of the collection - a string.
codec_options (optional): An instance of CodecOptions. If None (the default) the codec_options of this Database is used.
read_preference (optional): The read preference to use. If None (the default) the read_preference of this Database is used. See read_preferences for options.
write_concern (optional): An instance of WriteConcern. If None (the default) the write_concern of this Database is used.
read_concern (optional): An instance of ReadConcern. If None (the default) the read_concern of this Database is used.

property incoming_copying_manipulators¶

All incoming SON copying manipulators.

Changed in version 3.5: Deprecated.

New in version 2.0.

Type: DEPRECATED

property incoming_manipulators¶

All incoming SON manipulators.

Changed in version 3.5: Deprecated.

New in version 2.0.

Type: DEPRECATED

list_collection_names(session=None, filter=None, **kwargs)¶

Get a list of all the collection names in this database.

For example, to list all non-system collections:

filter = {"name": {"$regex": r"^(?!system\.)"}}
names = await db.list_collection_names(filter=filter)

Parameters

session (optional): a ClientSession, created with start_session().
filter (optional): A query document to filter the list of collections returned from the listCollections command.
**kwargs (optional): Optional parameters of the listCollections command can be passed as keyword arguments to this method. The supported options differ by server version.

Changed in version 2.1: Added the filter and **kwargs parameters.

New in version 1.2.

list_collections(session=None, filter=None, **kwargs)¶

Get a cursor over the collectons of this database.

Parameters

session (optional): a ClientSession.
filter (optional): A query document to filter the list of collections returned from the listCollections command.
**kwargs (optional): Optional parameters of the listCollections command can be passed as keyword arguments to this method. The supported options differ by server version.

Returns

An instance of CommandCursor.

New in version 3.6.

property name¶: The name of this Database.

property outgoing_copying_manipulators¶

All outgoing SON copying manipulators.

Changed in version 3.5: Deprecated.

New in version 2.0.

Type: DEPRECATED

property outgoing_manipulators¶

All outgoing SON manipulators.

Changed in version 3.5: Deprecated.

New in version 2.0.

Type: DEPRECATED

profiling_info(session=None)¶

Returns a list containing current profiling information.

Parameters

session (optional): a ClientSession.

Changed in version 3.6: Added session parameter.

profiling_level(session=None)¶

Get the database’s current profiling level.

Returns one of (OFF, SLOW_ONLY, ALL).

Parameters

session (optional): a ClientSession.

Changed in version 3.6: Added session parameter.

property read_concern¶: Read only access to the ReadConcern of this instance.

New in version 3.2.

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

set_profiling_level(level, slow_ms=None, session=None)¶

Set the database’s profiling level.

Parameters

level: Specifies a profiling level, see list of possible values below.
slow_ms: Optionally modify the threshold for the profile to consider a query or operation. Even if the profiler is off queries slower than the slow_ms level will get written to the logs.
session (optional): a ClientSession.

Possible level values:

Level	Setting
`OFF`	Off. No profiling.
`SLOW_ONLY`	On. Only includes slow operations.
`ALL`	On. Includes all operations.

Raises ValueError if level is not one of (OFF, SLOW_ONLY, ALL).

Changed in version 3.6: Added session parameter.

validate_collection(name_or_collection, scandata=False, full=False, session=None, background=None)¶

Validate a collection.

Returns a dict of validation info. Raises CollectionInvalid if validation fails.

See also the MongoDB documentation on the validate command.

Parameters

name_or_collection: A Collection object or the name of a collection to validate.
scandata: Do extra checks beyond checking the overall structure of the collection.
full: Have the server do a more thorough scan of the collection. Use with scandata for a thorough scan of the structure of the collection and the individual documents.
session (optional): a ClientSession.
background (optional): A boolean flag that determines whether the command runs in the background. Requires MongoDB 4.4+.

Changed in version 3.11: Added background parameter.

Changed in version 3.6: Added session parameter.

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

Returns a MotorChangeStream cursor which iterates over changes on this database. Introduced in MongoDB 4.0.

See the documentation for MotorCollection.watch() for more details and examples.

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 option to pass 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 Collation to use for the aggregation.
start_at_operation_time (optional): If provided, the resulting change stream will only return changes that occurred at or after the specified Timestamp. Requires MongoDB >= 4.0.
session (optional): a ClientSession.
start_after (optional): The same as resume_after except that start_after can resume notifications after an invalidate event. This option and resume_after are mutually exclusive.

Returns

A MotorChangeStream.

Changed in version 2.1: Added the start_after parameter.

New in version 2.0.

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

Get a clone of this database changing the specified settings.

>>> db1.read_preference
Primary()
>>> from pymongo import ReadPreference
>>> db2 = db1.with_options(read_preference=ReadPreference.SECONDARY)
>>> db1.read_preference
Primary()
>>> db2.read_preference
Secondary(tag_sets=None)

Parameters

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

New in version 3.8.

property write_concern¶: Read only access to the WriteConcern of this instance.

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

mdocument.client.MDocumentAsyncIOMotorDatabase¶

MDocument

Navigation

Related Topics