Get the collection_name MotorCollection of MotorDatabase db.
Raises InvalidName if an invalid collection name is used.
Add a new son manipulator to this database.
Newly added manipulators will be applied before existing ones.
Parameters : |
|
---|
Create user name with password password.
Add a new user with permissions for this Database.
Note
Will change the password if user name already exists.
Parameters : |
|
---|
Note
The use of optional keyword arguments like userSource, otherDBRoles, or roles requires MongoDB >= 2.4.0
If a callback is passed, returns None, else returns a Future.
Authenticate to use this database.
Raises TypeError if either name or password is not an instance of basestring (str in python 3). Authentication lasts for the life of the underlying client instance, or until logout() is called.
The “admin” database is special. Authenticating on “admin” gives access to all databases. Effectively, “admin” access means root access to the database.
Note
This method authenticates the current connection, and will also cause all new socket connections in the underlying client instance to be authenticated automatically.
Parameters : |
|
---|
See general MongoDB documentation
If a callback is passed, returns None, else returns a Future.
Get a list of all the collection names in this database.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Issue a MongoDB command.
Send command command to the database and return the response. If command is an instance of basestring (str in python 3) then the command {command: value} will be sent. Otherwise, command must be an instance of dict 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")
For a command where the value matters, like {collstats: collection_name} we can do:
>>> db.command("collstats", collection_name)
For commands that take additional arguments we can use kwargs. So {filemd5: object_id, root: file_root} becomes:
>>> db.command("filemd5", object_id, root=file_root)
Parameters : |
|
---|
See general MongoDB documentation
If a callback is passed, returns None, else returns a Future.
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. Any of the following options are valid:
- “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)
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Get information on operations currently running.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
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 : |
|
---|
If a callback is passed, returns None, else returns a Future.
Drop a collection.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Get a database error if one occured on the last operation.
Return None if the last operation was error-free. Otherwise return the error that occurred.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Evaluate a JavaScript expression in MongoDB.
Useful if you need to touch a lot of data lightly; in such a scenario the network transfer of the data could be a bottleneck. The code argument must be a JavaScript function. Additional positional arguments will be passed to that function when it is run on the server.
Raises TypeError if code is not an instance of basestring (str in python 3) or Code. Raises OperationFailure if the eval fails. Returns the result of the evaluation.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Get status information from the last operation.
Returns a SON object with status information.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Deauthorize use of this database for this client instance.
Note
Other databases may still be authenticated, and other existing socket connections may remain authenticated for this database unless you reset all sockets with disconnect().
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Get the most recent error to have occurred on this database.
Only returns errors that have occurred since the last call to Database.reset_error_history. Returns None if no such errors have occurred.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Returns a list containing current profiling information.
See general MongoDB documentation
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Get the database’s current profiling level.
Returns one of (OFF, SLOW_ONLY, ALL).
See general MongoDB documentation
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Remove user name from this Database.
User name will no longer have permissions to access this Database.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Reset the error history of this database.
Calls to Database.previous_error will only return errors that have occurred since the most recent call to this method.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
Set the database’s profiling level.
Parameters : |
|
---|
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).
See general MongoDB documentation
If a callback is passed, returns None, else returns a Future.
Validate a collection.
Returns a dict of validation info. Raises CollectionInvalid if validation fails.
With MongoDB < 1.9 the result dict will include a result key with a string value that represents the validation results. With MongoDB >= 1.9 the result key no longer exists and the results are split into individual fields in the result dict.
Parameters : |
|
---|
If a callback is passed, returns None, else returns a Future.
List all incoming SON copying manipulators installed on this instance.
List all incoming SON manipulators installed on this instance.
The name of this Database.
List all outgoing SON copying manipulators installed on this instance.
List all outgoing SON manipulators installed on this instance.
The read preference mode for this instance.
See ReadPreference for available options.
Any replica-set member whose ping time is within secondary_acceptable_latency_ms of the nearest member may accept reads. Defaults to 15 milliseconds.
See ReadPreference.
Note
secondary_acceptable_latency_ms is ignored when talking to a replica set through a mongos. The equivalent is the localThreshold command line option.
Set tag_sets to a list of dictionaries like [{‘dc’: ‘ny’}] to read only from members whose dc tag has the value "ny". To specify a priority-order for tag sets, provide a list of tag sets: [{'dc': 'ny'}, {'dc': 'la'}, {}]. A final, empty tag set, {}, means “read from any member that matches the mode, ignoring tags.” ReplicaSetConnection tries each set of tags in turn until it finds a set of tags with at least one matching member.
See also
The default write concern for this instance.
Supports dict style access for getting/setting write concern options. Valid options include:
>>> m = pymongo.MongoClient()
>>> m.write_concern
{}
>>> m.write_concern = {'w': 2, 'wtimeout': 1000}
>>> m.write_concern
{'wtimeout': 1000, 'w': 2}
>>> m.write_concern['j'] = True
>>> m.write_concern
{'wtimeout': 1000, 'j': True, 'w': 2}
>>> m.write_concern = {'j': True}
>>> m.write_concern
{'j': True}
>>> # Disable write acknowledgement and write concern
...
>>> m.write_concern['w'] = 0
Note
Accessing write_concern returns its value (a subclass of dict), not a copy.