MongoDB Shell Methods¶
Beta
The MongoDB Shell (mongosh) is currently available as a Beta
release. The product, its features, and the corresponding
documentation may change during the Beta stage.
The following document lists the available methods in the MongoDB Shell. Click a method to see its documentation in the MongoDB Manual, including syntax and examples.
Collection Methods¶
| Name | Description |
|---|---|
db.collection.aggregate | Provides access to the aggregation pipeline. |
db.collection.bulkWrite | Provides bulk write operation functionality. |
db.collection.count | Returns a count of the number of documents in a collection or a view. |
db.collection.countDocuments | Returns a count of the number of documents in a collection or a
view. Wraps the $group aggregation stage with a
$sum expression. |
db.collection.estimatedDocumentCount | Returns an approximate count of the documents in a collection or a view. |
db.collection.createIndex | Builds an index on a collection. |
db.collection.createIndexes | Builds one or more indexes on a collection. |
db.collection.dataSize | Returns the size of the collection. Wraps the
collStats.size field in the output of the
collStats. |
db.collection.deleteOne | Deletes a single document in a collection. |
db.collection.deleteMany | Deletes multiple documents in a collection. |
db.collection.distinct | Returns an array of documents that have distinct values for the specified field. |
db.collection.drop | Removes the specified collection from the database. |
db.collection.dropIndex | Removes a specified index on a collection. |
db.collection.dropIndexes | Removes all indexes on a collection. |
db.collection.ensureIndex | Deprecated. Use db.collection.createIndex. |
db.collection.explain | Returns information on the query execution of various methods. |
db.collection.find | Performs a query on a collection or a view and returns a cursor object. |
db.collection.findAndModify | Atomically modifies and returns a single document. |
db.collection.findOne | Performs a query and returns a single document. |
db.collection.findOneAndDelete | Finds a single document and deletes it. |
db.collection.findOneAndReplace | Finds a single document and replaces it. |
db.collection.findOneAndUpdate | Finds a single document and updates it. |
db.collection.getIndexes | Returns an array of documents that describe the existing indexes on a collection. |
db.collection.insert | Creates a new document in a collection. |
db.collection.insertOne | Inserts a new document in a collection. |
db.collection.insertMany | Inserts several new document in a collection. |
db.collection.isCapped | Reports if a collection is a capped collection. |
db.collection.reIndex | Rebuilds all existing indexes on a collection. |
db.collection.remove | Deletes documents from a collection. |
db.collection.renameCollection | Changes the name of a collection. |
db.collection.replaceOne | Replaces a single document in a collection. |
db.collection.save | Provides a wrapper around an db.collection.insert
and db.collection.update to insert new documents. |
db.collection.stats | Reports on the state of a collection. Provides a wrapper around
the collStats. |
db.collection.storageSize | Reports the total size used by the collection in bytes. Provides
a wrapper around the collStats.storageSize field of the
collStats output. |
db.collection.totalIndexSize | Reports the total size used by the indexes on a collection.
Provides a wrapper around the collStats.totalIndexSize
field of the collStats output. |
db.collection.totalSize | Reports the total size of a collection, including the size of all documents and all indexes on a collection. |
db.collection.update | Modifies a document in a collection. |
db.collection.updateOne | Modifies a single document in a collection. |
db.collection.updateMany | Modifies multiple documents in a collection. |
Cursor Methods¶
| Name | Description |
|---|---|
cursor.addOption | Adds special wire protocol flags that modify the behavior of the query. |
cursor.allowPartialResults | Allows db.collection.find operations against a
sharded collection to return partial results, rather than an
error, if one or more queried shards are unavailable. |
cursor.batchSize | Controls the number of documents MongoDB will return to the client in a single network message. |
cursor.close | Close a cursor and free associated server resources. |
cursor.collation | Specifies the collation for the cursor returned by the
db.collection.find. |
cursor.comment | Attaches a comment to the query to allow for traceability in the logs and the system.profile collection. |
cursor.count | Modifies the cursor to return the number of documents in the result set rather than the documents themselves. |
cursor.explain | Reports on the query execution plan for a cursor. |
cursor.forEach | Applies a JavaScript function for every document in a cursor. |
cursor.hasNext | Returns true if the cursor has documents and can be iterated. |
cursor.hint | Forces MongoDB to use a specific index for a query. |
cursor.isClosed | Returns true if the cursor is closed. |
cursor.isExhausted | Returns true if the cursor is closed and there are no
objects remaining in the batch. |
cursor.itcount | Computes the total number of documents in the cursor client-side by fetching and iterating the result set. |
cursor.limit | Constrains the size of a cursor's result set. |
cursor.map | Applies a function to each document in a cursor and collects the return values in an array. |
cursor.max | Specifies an exclusive upper index bound for a cursor. For use
with cursor.hint |
cursor.maxTimeMS | Specifies a cumulative time limit in milliseconds for processing operations on a cursor. |
cursor.min | Specifies an inclusive lower index bound for a cursor. For use
with cursor.hint |
cursor.next | Returns the next document in a cursor. |
cursor.noCursorTimeout | Instructs the server to avoid closing a cursor automatically after a period of inactivity. |
cursor.readPref | Specifies a read preference to a cursor to control how
the client directs queries to a replica set. |
cursor.returnKey | Modifies the cursor to return index keys rather than the documents. |
cursor.size | Returns a count of the documents in the cursor after applying
cursor.skip and cursor.limit methods. |
cursor.skip | Returns a cursor that begins returning results only after passing or skipping a number of documents. |
cursor.sort | Returns results ordered according to a sort specification. |
cursor.tailable | Marks the cursor as tailable. Only valid for cursors over capped collections. |
cursor.toArray | Returns an array that contains all documents returned by the cursor. |
Database Methods¶
| Name | Description |
|---|---|
db.adminCommand | Runs a command against the admin database. |
db.aggregate | Runs admin/diagnostic pipeline which does not require an underlying collection. |
db.dropDatabase | Removes the current database. |
db.getCollection | Returns a collection or view object. Used to access collections
with names that are not valid in the mongo shell. |
db.getCollectionInfos | Returns collection information for all collections and views in the current database. |
db.getCollectionNames | Lists all collections and views in the current database. |
db.getName | Returns the name of the current database. |
db.getSiblingDB | Provides access to the specified database. |
db.logout | Ends an authenticated session. |
db.runCommand | Runs a database command. |
User Management Methods¶
important
The passwordPrompt method is currently not
supported in mongosh. As a result, when using the following
methods you must specify the password as a parameter:
| Method | Description |
|---|---|
db.auth | Authenticates a user to a database. |
db.changeUserPassword | Changes an existing user’s password. |
db.createUser | Creates a new user. |
db.dropAllUsers | Deletes all users associated with a database. |
db.dropUser | Deletes a single user. |
db.getUser | Returns information about the specified user. |
db.getUsers | Returns information about all users associated with a database. |
db.updateUser | Updates a specified user's data. |
db.grantRolesToUser | Grants a role and its privileges to a user. |
db.revokeRolesFromUser | Removes a role from a user. |