mongodb-data-service

mongodb-data-service

MongoDB Data Service

The data service provides an API on top of [currently] the MongoDB Node Driver and [in the future] mongodb-scout-client.

Installation

npm install --save mongodb-data-service

Usage

Instantiating the service.

  const Connection = require('mongodb-connection-model');
  const DataService = require('mongodb-data-service');

  var model = new Connection({ hostname: '127.0.0.1', port: 27018, ns: 'data-service' });
  var service = new DataService(model);

Connecting to the server.

Once the service is ready, it will also emit a DataService.Events.Readble event.

  service.connect((error) => {
    assert.equal(null, error);
  });

  function handleReadable() {
    console.log('Connected!');
  }

  service.on(DataService.Events.Readable, handleReadable);

API

  // Get information for a collection.
  service.collection('database.collection', {}, (error, result) => {
    assert.equal(null, error);
  });

  // Get a document count.
  service.count('database.collection', { a: 1 }, {}, (error, count) => {
    assert.equal(null, error);
  });

  // Get information for a database.
  service.database('database', {}, (error, result) => {
    assert.equal(null, error);
  });

  // Find documents in a collection.
  service.find('database.collection', { a: 1 }, {}, (error, documents) => {
    assert.equal(null, error);
  });

  // Get a result for a RESTful endpoint.
  service.get('/collection/database.test', {}, (error, result) => {
    assert.equal(null, error);
  });

  // Get instance details.
  service.instance({}, (error, result) => {
    assert.equal(null, error);
  });

  // Get a sample stream of documents from a collection.
  service.sample('database.collection', {});

License

Apache 2.0