crudibility v0.0.2

CRUDibility

Explain, please.

Crudibility is a plugin for Mongoose models that allows for various CRUD (Create, Read, Update, Delete) features in a conveniently configurable way.

Table of Contents

• Installation
• Methods
  • add
  • edit
  • view
  • list
  • delete
• Options
  • Setting Defaults
  • fields
  • populate
  • paginate

Installation

var mySchema = new mongoose.Schema({...});
var crudibility = require('crudibility');
mySchema.plugin(crudibility);

Methods

add

Signature

add(attributes, [options], callback)

• attributes - hash of attributes to put in the document
• options (optional)
  • fields - see defaultFields section for details
  • populate - see crudiblePopulate section for details
• callback - called with (err, document)

Example

mongoose.models.Foo.add(
  {
    foo: 'bar'
  },
  {
    fields: 'foo',
    populate: [{
      path: 'baz'
    }]
  }, function (err, doc) {
    // a new document { foo: 'bar' } should now be in the database
  }
);

edit

Signature

edit(attributes, [options], callback)

• attributes - hash of attributes to set on the document, will only change attributes explicitly mentioned and leave old ones
  • must include an _id of the document to edit
• options (optional)
  • fields - see fields section for details
  • populate - see populate section for details
• callback - called with (err, document)

Example

mongoose.models.Foo.edit(
  {
    _id: '000000000000000000000001',
    foo: 'bar'
  },
  {
    fields: 'foo',
    populate: [{
      path: 'baz'
    }]
  }, function (err, doc) {
    // ...
  }
);

view

Signature

view(params, callback)

• params
  • _id - can use _id to retrieve a specific document
  • match - alternative to _id, can enter matching parameters (e.g. {foo: 'bar'} to retrieve the first document with field foo matching 'bar')
  • fields - see fields section for details
  • populate - see populate section for details
• callback - called with (err, document)

Example

mongoose.models.Foo.view(
  {
    _id: '000000000000000000000001',
    fields: 'foo',
    populate: [{
      path: 'baz'
    }]
  }, function (err, doc) {
    // ...
  }
);

list

Signature

list(params, callback)

• params
  • match - can enter matching parameters (e.g. {foo: 'bar'} to retrieve documents with field foo matching 'bar')
  • fields - see fields section for details
  • sort - takes the same options as Mongoose's sort option
  • populate - see populate section for details
  • paginate - see paginate section for details
• callback - called with (err, documents, meta)
  • meta - returns metadata for use with the Backbone Paginator plugin - currentPage, totalPages, pageSize, and totalResults

Example

mongoose.models.Foo.list(
  {
    match:
      foo: 'bar'
    fields: 'foo',
    populate: [{
      path: 'baz'
    }]
  }, function (err, docs, meta) {
    // ...
  }
);

delete

Signature

delete(params, callback)

• params
  • _id - use _id to delete a specific document
• callback - calls back with (err, document). The document will not be populated as with other methods.

Example

mongoose.models.Foo.delete(
  {
    _id: '000000000000000000000001'
  }, function (err, doc) {
    // doc's all gone from the database now!
  }
);

Options

Setting Defaults

When installing the plugin, you can define default options for the model as follows:

var crudibility = require('crudibility');
mySchema.plugin(crudibility, {
  defaultFields: 'foo', // see fields section below for details
  defaultPopulate: [],  // see populate below for details
  defaultPaginate: {}   // see paginate below for details
});

fields

fields options follow the same convention as Mongoose's select.

populate

Crudibility allows for nested populates. Nested populates should be nested within their parent populate. For example:

{
  populate: [
    path: 'baz',    // will populate the document at path 'baz'
    model: 'Baz',   // will populate from the Baz model (this is required!)
    select: 'qux',  // will populate from the Baz model with field 'qux'
    populate: [
      path: 'baz.qux',  // second-level populate, since it depends on 'baz' being populated first
      model: 'Qux',
      select: 'foo'
    ]
  ]
}

paginate

Paginate options determine which page and how many documents per page will be returned for a list function.

There are aliases for the same functionality - two examples representing the same options are shown below:

{
  paginate: {
    limit: 2,    // 2 documents per page
    page: 2      // return the third page (pages are zero-indexed)
  }
}

{
  paginate: {
    pageSize: 2,
    currentPage: 2
  }
}

License

Copyright (c) 2014 Chris Baik

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.