Native Methods in the Legacy Shell

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB server.

The methods listed in this section are for the legacy mongo shell. To use native methods in mongosh, see Native Methods in mongosh.

The mongocompat snippet also provides access to legacy mongo shell APIs.

Note

For details on specific methods, including syntax and examples, click on the specific method to go to its reference page.

Name	Description
cat()	Returns the contents of the specified file.
cd()	Changes the current working directory to the specified path.
`copyDbpath()`	Copies a local `dbPath`. For internal use.
`getHostName()`	Returns the hostname of the computer running the shell.
`getMemInfo()`	Returns a document that reports the amount of memory used by the shell.
hostname()	Returns the hostname of the system running the shell.
isInteractive()	Returns a boolean indicating whether the shell is running in interactive or script mode.
`listFiles()`	Returns an array of documents that show the name and size of each object in the directory.
load()	Loads and runs a JavaScript file in the shell.
ls()	Returns a list of the files in the current directory.
`md5sumFile()`	The md5 hash of the specified file.
mkdir()	Creates a directory in the specified path.
pwd()	Returns the current directory.
quit()	Exits the current shell session.
`removeFile()`	Removes the specified file from the local file system.
`resetDbpath()`	Removes a local `dbPath`. For internal use.
sleep()	Suspends `mongosh` for a period of time.
`setVerboseShell()`	Configures `mongosh` to report operation timing.
version()	Returns the current version of `mongosh` instance.
`_isWindows()`	Returns: `true` if the shell runs on Windows. `false` if the shell runs on Unix or Linux.
`_rand()`	Returns a random number between `0` and `1`.