Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastify/fastify-mongodb
Fastify MongoDB connection plugin
https://github.com/fastify/fastify-mongodb
database fastify fastify-plugin mongodb
Last synced: about 1 month ago
JSON representation
Fastify MongoDB connection plugin
- Host: GitHub
- URL: https://github.com/fastify/fastify-mongodb
- Owner: fastify
- License: mit
- Created: 2017-04-04T09:12:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T09:14:10.000Z (about 2 months ago)
- Last Synced: 2024-10-06T15:36:29.380Z (about 1 month ago)
- Topics: database, fastify, fastify-plugin, mongodb
- Language: JavaScript
- Homepage:
- Size: 149 KB
- Stars: 246
- Watchers: 20
- Forks: 51
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fastify - `fastify-mongodb`
README
# @fastify/mongodb
[](https://www.npmjs.com/package/@fastify/mongodb)
[](https://standardjs.com/)
Fastify MongoDB connection plugin; with this you can share the same MongoDB connection pool in every part of your server.
Under the hood the official [MongoDB](https://github.com/mongodb/node-mongodb-native) driver is used,
the options that you pass to `register` will be passed to the Mongo client.
The `mongodb` driver is v6.x.x.
If you do not provide the client by yourself (see below), the URL option is *required*.
## Install
```
npm i @fastify/mongodb
```
## Usage
Add it to your project with `register` and you are done!
```js
const fastify = require('fastify')()
fastify.register(require('@fastify/mongodb'), {
// force to close the mongodb connection when app stopped
// the default value is false
forceClose: true,
url: 'mongodb://mongo/mydb'
})
fastify.get('/user/:id', async function (req, reply) {
// Or this.mongo.client.db('mydb').collection('users')
const users = this.mongo.db.collection('users')
// if the id is an ObjectId format, you need to create a new ObjectId
const id = new this.mongo.ObjectId(req.params.id)
try {
const user = await users.findOne({ id })
return user
} catch (err) {
return err
}
})
fastify.listen({ port: 3000 }, err => {
if (err) throw err
})
```
You may also supply a pre-configured instance of `mongodb.MongoClient`:
```js
const mongodb = require('mongodb')
mongodb.MongoClient.connect('mongodb://mongo/db')
.then((client) => {
const fastify = require('fastify')()
fastify.register(require('@fastify/mongodb'), { client: client })
.register(function (fastify, opts, next) {
const db = fastify.mongo.client.db('mydb')
// ...
// ...
// ...
next()
})
})
.catch((err) => {
throw err
})
```
Notes:
* the passed `client` connection will **not** be closed when the Fastify server
shuts down.
* in order to terminate the MongoDB connection you have to manually call the [fastify.close](https://fastify.dev/docs/latest/Reference/Server/#close) method (for example for testing purposes, otherwise the test will hang).
* `mongodb` connection timeout is reduce from 30s (default) to 7.5s in order throw error before `fastify` plugin timeout.
## Reference
This plugin decorates the `fastify` instance with a `mongo` object. That object has the
following properties:
- `client` is the [`MongoClient` instance](http://mongodb.github.io/node-mongodb-native/3.3/api/MongoClient.html)
- `ObjectId` is the [`ObjectId` class](http://mongodb.github.io/node-mongodb-native/3.3/api/ObjectID.html)
- `db` is the [`DB` instance](http://mongodb.github.io/node-mongodb-native/3.3/api/Db.html)
The `ObjectId` class can also be directly imported from the plugin as it gets re-exported from `mongodb`:
```js
const { ObjectId } = require('@fastify/mongodb')
const id = new ObjectId('some-id-here')
```
The `db` property is added **only if**:
- a `database` string option is given during the plugin registration.
- the connection string contains the database name. See the [Connection String URI Format](https://docs.mongodb.com/manual/reference/connection-string/#connection-string-uri-format)
A `name` option can be used in order to connect to multiple MongoDB clusters.
```js
const fastify = require('fastify')()
fastify
.register(require('@fastify/mongodb'), { url: 'mongodb://mongo1/mydb', name: 'MONGO1' })
.register(require('@fastify/mongodb'), { url: 'mongodb://mongo2/otherdb', name: 'MONGO2' })
fastify.get('/', function (req, res) {
// This collection comes from "mongodb://mongo1/mydb"
const coll1 = this.mongo.MONGO1.db.collection('my_collection')
// This collection comes from "mongodb://mongo2/otherdb"
const coll2 = this.mongo.MONGO2.db.collection('my_collection')
// ...
// ...
// do your stuff here
// ...
// ...
res.send(yourResult)
})
```
## Acknowledgements
This project is kindly sponsored by:
- [nearForm](https://nearform.com)
- [LetzDoIt](https://www.letzdoitapp.com/)
## License
Licensed under [MIT](./LICENSE).