README

GridFS"> nodestream-gridfs

MongoDB GridFS adapter for Nodestream

Identity: gridfs

API docs

Description

This adapter provides interface for Nodestream to transfer bytes between your app and GridFS buckets.

Usage

Installation

npm install --save nodestream-gridfs

Configuration

The following configuration options are required by the adapter:

db: A connected MongoClient instance, or
uri: A MongoDB URI to connect to (db instance will take precedence if provided)
connectOpts: Connection options to be used when connecting. Passed directly to MongoClient.connect()
bucket: The bucket name this adapter will operate on (defaults to fs)
chunkSize: The default chunk size (defaults to 255kB)

Using the 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 db instance 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 db instance for the whole app.
You have special requirements on how the connection is created

// With `db` instance
// WARNING - Not production-ready code
const mongodb = require('mongodb')

mongodb.MongoClient().connect((err, db) => {
  // db is what this adapter needs!
  const Nodestream = require('nodestream')
  const nodestream = new Nodestream({
    adapter: 'gridfs',
    config: {
      db: db,
      bucket: 'avatars'
    }
  })
})

// With `uri`
const Bluebird = require('bluebird')
const Nodestream = require('nodestream')
const nodestream = new Nodestream({
  adapter: 'gridfs',
  config: {
    uri: 'mongodb://user:pass@localhost:27017/my-db',
    connectOpts: {
      promiseLibrary: Bluebird
    }
    bucket: 'avatars'
  }
})

License

This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.

Usage no npm install needed!