Database Manual / Reference / mongosh Methods / Connections

connect() (mongosh method)

Description

connect(url, user, password)

Creates a connection to a MongoDB instance and returns the reference to the database. However, in most cases, use the Mongo() object and its getDB() method instead.

ParameterTypeDescription

url

string

Specifies the connection string. You can specify either:

  • <hostname>:<port>/<database>
  • <hostname>/<database>
  • <database>

user

string

Optional. Specifies an existing username with access privileges for this database. If user is specified, you must include the password parameter as well.

password

string

Optional unless the user parameter is specified. Specifies the password for the user.

Compatibility

This method is available in deployments hosted in the following environments:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Example

The following example instantiates a new connection to the MongoDB instance running on the localhost interface and returns a reference to myDatabase:

db = connect("localhost:27017/myDatabase")