database – Database level operations (original) (raw)

Database level operations.

pymongo.auth.MECHANISMS = frozenset({'DEFAULT', 'GSSAPI', 'MONGODB-AWS', 'MONGODB-OIDC', 'MONGODB-X509', 'PLAIN', 'SCRAM-SHA-1', 'SCRAM-SHA-256'})¶

frozenset() -> empty frozenset object frozenset(iterable) -> frozenset object

Build an immutable unordered collection of unique elements.

class pymongo.database.Database(client, name, codec_options=None, read_preference=None, write_concern=None, read_concern=None)¶

Get a database by client and name.

Raises TypeError if name is not an instance ofstr. Raises InvalidName ifname is not a valid database name.

Parameters:

client (MongoClient[ _DocumentType ]) – A MongoClient instance.
name (str) – The database name.
codec_options (Optional _[_CodecOptions[ _DocumentTypeArg ] ]) – An instance ofCodecOptions. If None (the default) client.codec_options is used.
read_preference (Optional [ _ServerMode ]) – The read preference to use. IfNone (the default) client.read_preference is used.
write_concern (Optional _[_WriteConcern]) – An instance ofWriteConcern. If None (the default) client.write_concern is used.
read_concern (Optional _[_ReadConcern]) – An instance ofReadConcern. If None (the default) client.read_concern is used.

Lists all operations currently running on the server.

with client.admin.aggregate([{"$currentOp": {}}]) as cursor: for operation in cursor: print(operation)

The aggregate() method obeys the read_preference of thisDatabase, except when $out or $merge are used, in which case PRIMARYis used.

Note

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

Note

The write_concern of this collection is automatically applied to this operation.

Parameters:

pipeline (_Pipeline) – a list of aggregation pipeline stages
session (Optional _[_ClientSession]) – aClientSession.
kwargs (Any) – extra aggregate command parameters.

Return type:

CommandCursor[_DocumentType]

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

let (dict): A dict of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. "$$var"). This option is only supported on MongoDB >= 5.0.

Returns:

A CommandCursor over the result set.

Parameters:

pipeline (_Pipeline)
session (Optional _[_ClientSession])
kwargs (Any)

Return type:

CommandCursor[_DocumentType]

Added in version 3.9.

property client_: MongoClient[_DocumentType]_¶

The client instance for this Database.

command(command: str | MutableMapping[str, Any], value: Any = 1, check: bool = True, allowable_errors: Sequence[str | int] | None = None, read_preference: _ServerMode | None = None, codec_options: None = None, session: ClientSession | None = None, comment: Any | None = None, **kwargs: Any) → dict[str, Any]¶

command(command: str | MutableMapping[str, Any], value: Any = 1, check: bool = True, allowable_errors: Sequence[str | int] | None = None, read_preference: _ServerMode | None = None, codec_options: CodecOptions[_CodecDocumentType] = None, session: ClientSession | None = None, comment: Any | None = None, **kwargs: Any) → _CodecDocumentType

Issue a MongoDB command.

Send command command to the database and return the response. If command is an instance of strthen the command {command: value} will be sent. Otherwise, command must be an instance ofdict and will be sent as is.

Any additional keyword arguments will be added to the final command document before it is sent.

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

db.command("buildinfo") OR db.command({"buildinfo": 1})

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

db.command("count", collection_name) OR db.command({"count": collection_name})

For commands that take additional arguments we can use kwargs. So {count: collection_name, query: query} becomes:

db.command("count", collection_name, query=query) OR db.command({"count": collection_name, "query": query})

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 be done with this in mind.
value – value to use for the command verb whencommand is passed as a string
check – check the response for errors, raisingOperationFailure 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. If the provided session is in a transaction, defaults to the read preference configured for the transaction. Otherwise, defaults toPRIMARY.
codec_options – A CodecOptionsinstance.
session – AClientSession.
comment – A user-provided comment to attach to this command.
kwargs – additional keyword arguments will be added to the command document before it is sent

Note

command() does not obey this Database’sread_preference or codec_options. You must use theread_preference and codec_options parameters instead.

Note

command() does not apply any custom TypeDecoders when decoding the command response.

Note

If this client has been configured to use MongoDB Stable API (see MongoDB Stable API), then command() will automatically add API versioning options to the given command. Explicitly adding API versioning options in the command and declaring an API version on the client is not supported.

Changed in version 3.6: Added session parameter.

Changed in version 3.0: Removed the as_class, fields, uuid_subtype, tag_sets, and secondary_acceptable_latency_ms option. Removed compile_re option: PyMongo now always represents BSON regular expressions as Regex objects. Usetry_compile() to attempt to convert from a BSON regular expression to a Python regular expression object. Added the codec_options parameter.

See also

The MongoDB documentation on commands.

create_collection(name, codec_options=None, read_preference=None, write_concern=None, read_concern=None, session=None, check_exists=True, **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.

Parameters:

name (str) – the name of the collection to create
codec_options (Optional _[_CodecOptions[ _DocumentTypeArg ] ]) – An instance ofCodecOptions. If None (the default) the codec_options of this Database is used.
read_preference (Optional [ _ServerMode ]) – The read preference to use. IfNone (the default) the read_preference of thisDatabase is used.
write_concern (Optional _[_WriteConcern]) – An instance ofWriteConcern. If None (the default) the write_concern of this Database is used.
read_concern (Optional _[_ReadConcern]) – An instance ofReadConcern. If None (the default) the read_concern of this Database is used.
collation – An instance ofCollation.
session (Optional _[_ClientSession]) – aClientSession.
check_exists (Optional _[_bool]) – if True (the default), send a listCollections command to check if the collection already exists before creation.
kwargs (Any) – additional keyword arguments will be passed as options for the create collection command

Return type:

Collection[_DocumentType]

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

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

capped (bool): if True, this is a capped collection

max (int): maximum number of objects if capped (optional)

timeseries (dict): a document specifying configuration options for timeseries collections

expireAfterSeconds (int): the number of seconds after which a document in a timeseries collection expires

validator (dict): a document specifying validation rules or expressions for the collection

validationLevel (str): how strictly to apply the validation rules to existing documents during an update. The default level is “strict”

validationAction (str): whether to “error” on invalid documents (the default) or just “warn” about the violations but allow invalid documents to be inserted

indexOptionDefaults (dict): a document specifying a default configuration for indexes when creating a collection

viewOn (str): the name of the source collection or view from which to create the view

pipeline (list): a list of aggregation pipeline stages

comment (str): a user-provided comment to attach to this command. This option is only supported on MongoDB >= 4.4.

encryptedFields (dict): (BETA) Document that describes the encrypted fields for Queryable Encryption. For example:
{
"escCollection": "enxcol_.encryptedCollection.esc",
"ecocCollection": "enxcol_.encryptedCollection.ecoc",
"fields": [
{
"path": "firstName",
"keyId": Binary.from_uuid(UUID('00000000-0000-0000-0000-000000000000')),
"bsonType": "string",
"queries": {"queryType": "equality"}
},
{
"path": "ssn",
"keyId": Binary.from_uuid(UUID('04104104-1041-0410-4104-104104104104')),
"bsonType": "string"
}
]
}

clusteredIndex (dict): Document that specifies the clustered index configuration. It must have the following form:
{
// key pattern must be {_id: 1}
key: , // required
unique: , // required, must be true
name: , // optional, otherwise automatically generated
v: , // optional, must be 2 if provided
}

changeStreamPreAndPostImages (dict): a document with a boolean field enabled for enabling pre- and post-images.

Changed in version 4.2: Added the check_exists, clusteredIndex, and encryptedFields parameters.

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.

cursor_command(command, value=1, read_preference=None, codec_options=None, session=None, comment=None, max_await_time_ms=None, **kwargs)¶

Issue a MongoDB command and parse the response as a cursor.

If the response from the server does not include a cursor field, an error will be thrown.

Otherwise, behaves identically to issuing a normal MongoDB command.

Parameters:

command (Union [_str,_ MutableMapping [_str,_ Any ] ]) –
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 (Any) – value to use for the command verb whencommand is passed as a string
read_preference (Optional [ _ServerMode ]) – The read preference for this operation. See read_preferences for options. If the provided session is in a transaction, defaults to the read preference configured for the transaction. Otherwise, defaults toPRIMARY.
codec_options (Optional _[_CodecOptions[ _CodecDocumentType ] ]) – A CodecOptionsinstance.
session (Optional _[_ClientSession]) – AClientSession.
comment (Optional [ Any ]) – A user-provided comment to attach to future getMores for this command.
max_await_time_ms (Optional _[_int]) – The number of ms to wait for more data on future getMores for this command.
kwargs (Any) – additional keyword arguments will be added to the command document before it is sent

Return type:

CommandCursor[_DocumentType]

Note

command() does not obey this Database’sread_preference or codec_options. You must use theread_preference and codec_options parameters instead.

Note

command() does not apply any custom TypeDecoders when decoding the command response.

Note