Skip to content

#4 Add database selection documentation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

#4 Add database selection documentation #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,24 @@ To get started, find your mongodb connection url and add this configuration to y
}
```

### Database Selection

The database name can be specified in the MongoDB connection URL path:

```
# Format
mongodb://username:password@host:port/database_name?authSource=admin

# Examples
mongodb://root:example@localhost:27017/myapp?authSource=admin # Uses "myapp" database
mongodb://root:example@localhost:27017 # Uses default "test" database
```

Note:

- If no database name is provided in the URL path, the "test" database will be used by default.
- MongoDB will automatically create the database if it doesn't exist.

### Prerequisites

- Node.js 18+
Expand Down