MongoDB GridFS adapter for Nodestream
This adapter provides interface for Nodestream to transfer bytes between your app and GridFS buckets.
npm install --save nodestream-gridfs
The following configuration options are required by the adapter:
db: A connected MongoClient instance, or
uri: A MongoDB URI to connect to (
dbinstance will take precedence if provided)
connectOpts: Connection options to be used when connecting. Passed directly to
bucket: The bucket name this adapter will operate on (defaults to
chunkSize: The default chunk size (defaults to 255kB)
db instance might seem a bit more complicated, but it has several advantages:
- You have full control over the state of the connection - you can close the session anytime you want. Currently this is not possible to achieve if Nodestream manages the
dbinstance itself and thus prevents you from making the Node.js process quit gracefully.
- Rather than creating new connection to Mongo, you can re-use the same connection your ORM uses. This can save some memory by only having one
dbinstance for the whole app.
- You have special requirements on how the connection is created
// With `db` instance// WARNING - Not production-ready codeconst mongodb =mongodb// With `uri`const Bluebird =const Nodestream =const nodestream =adapter: 'gridfs'config:uri: 'mongodb://user:pass@localhost:27017/my-db'connectOpts:promiseLibrary: Bluebirdbucket: 'avatars'
This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.