Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qard/corm

document modeller for mongodb built on async/await
https://github.com/qard/corm

Last synced: 23 days ago
JSON representation

document modeller for mongodb built on async/await

Awesome Lists containing this project

README 

        
# CORM



![i like corm](http://kimaguresan.files.wordpress.com/2014/02/f3b0e52f0cb3ecbf0ee58978238b6563_h.jpg)



[![build status](https://secure.travis-ci.org/Qard/corm.png)](http://travis-ci.org/Qard/corm) [![Coverage Status](https://coveralls.io/repos/Qard/corm/badge.png)](https://coveralls.io/r/Qard/corm)



This is the beginnings of a project to make a full-featured ORM that takes advantage of generators, which should make the codebase and usage of the library vastly simpler. I spent weeks digging through existing node ORM implementations, only to find myself dissatisfied with how convoluted they all seemed to be.



## Installation



```sh

npm install corm

```



## Usage



```js

const model = corm('localhost/test')

const User = model('users')



const user = User.build({

  email: '[email protected]'

})

yield user.save()



yield user.update({

  name: 'me'

})



yield user.remove()

```



## Notes



In typical node fashion, this module is meant to be simple. This means it lacks many features you may expect of an ORM which are intended to be implemented externally. Here are a few to be aware of:



- No schema validation, but you can do that yourself by overriding model.validate().

- No multi-error support from model.validate(). It expects a single throw, but you can populate a model.errors array yourself.

- There is not yet any relational components, that will likely be an external module.

- Presently, it is completely tied to mongodb + monk. This will change later when I figure out a good plugin interface.



## Model API



### Statics



#### Model.build(data)

Build a model instance.



#### yield Model.create(data)

Build and save a model instance.



#### yield Model.find(query)

Find an array of model instances using a query object.



#### yield Model.findOne(query)

Find one model instance using a query object.



#### yield Model.findById(id)

Find one model instance by id.



#### yield Model.findOrCreate(data)

Find or create a model instance given a set of data



#### yield Model.createOrUpdate(query, changes)

Create or update a model instance given a query and change set



#### yield Model.update(query, data)

Update any records that match the query.



#### yield Model.updateById(id, data)

Update the record that matches the query.



#### yield Model.remove(query)

Remove any records that match the query.



#### yield Model.removeById(id)

Remove the record that matches the query.



#### yield Model.count(query)

Count number of records matching the query.



#### Model.index(...)

Currently, this is passed through directly to monk.



### Base methods



#### model.isNew()

This method is mostly used internally to detect if a model exists in the database already. Currently, it simply checks for existence of a `_id` property.



#### yield model.save()

Insert new models or update already persisted models.



#### yield model.update(data)

Apply the input data to the model and save it.



#### yield model.remove()

Remove the model from the database.



#### yield model.fetch()

Fetch the latest model state from the database.



### Hook methods



There are several hook methods that can be overridden to trigger things before or after various interactions. Each must be a generator function. These methods include:



- `beforeSave`

- `beforeCreate`

- `beforeUpdate`

- `beforeRemove`

- `beforeValidate`

- `afterSave`

- `afterCreate`

- `afterUpdate`

- `afterRemove`

- `afterValidate`



---



### Copyright (c) 2013 Stephen Belanger

#### Licensed under MIT License



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.