Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trailsjs/trailpack-mongoose
:package: Mongoose.js Trailpack http://mongoosejs.com
https://github.com/trailsjs/trailpack-mongoose
mongodb mongoose trailpack trails
Last synced: 6 days ago
JSON representation
:package: Mongoose.js Trailpack http://mongoosejs.com
- Host: GitHub
- URL: https://github.com/trailsjs/trailpack-mongoose
- Owner: trailsjs
- License: mit
- Created: 2016-04-02T01:45:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-17T13:23:56.000Z (over 6 years ago)
- Last Synced: 2024-04-24T20:42:07.255Z (7 months ago)
- Topics: mongodb, mongoose, trailpack, trails
- Language: JavaScript
- Size: 86.9 KB
- Stars: 8
- Watchers: 7
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# trailpack-mongoose
:package: Mongoose.js Trailpack [http://mongoosejs.com](http://mongoosejs.com)
[npm-image]: https://img.shields.io/npm/v/trailpack-mongoose.svg?style=flat-square
[npm-url]: https://npmjs.org/package/trailpack-mongoose
[ci-image]: https://img.shields.io/travis/trailsjs/trailpack-mongoose/master.svg?style=flat-square
[ci-url]: https://travis-ci.org/trailsjs/trailpack-mongoose
[daviddm-image]: http://img.shields.io/david/trailsjs/trailpack-mongoose.svg?style=flat-square
[daviddm-url]: https://david-dm.org/trailsjs/trailpack-mongoose
[codeclimate-image]: https://img.shields.io/codeclimate/github/trailsjs/trailpack-mongoose.svg?style=flat-square
[codeclimate-url]: https://codeclimate.com/github/trailsjs/trailpack-mongoose
[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square
[gitter-url]: https://gitter.im/trailsjs/trails
[![Gitter][gitter-image]][gitter-url]
[![NPM version][npm-image]][npm-url]
[![Build status][ci-image]][ci-url]
[![Dependency Status][daviddm-image]][daviddm-url]
[![Code Climate][codeclimate-image]][codeclimate-url]
Loads Application Models (in `api/models`) into the Mongoose ORM; Integrates with [trailpack-router](https://github.com/trailsjs/trailpack-router) to
generate Footprints for routes.
## Usage
### Include trailpack in app.
```js
// config/main.js
module.exports = {
// ...
packs: [
require('trailpack-mongoose')
]
}
```
### Configure stores.
```js
// config/database.js
module.exports = {
/**
* Define the database stores. A store is typically a single database.
*
* Use the SQLite3 by default for development purposes.
*
* Set production connection info in config/env/production.js
*/
stores: {
/**
* Define a store called "local" which uses SQLite3 to persist data.
*/
someteststore: {
//migration
migrate: 'create',
// Mongodb URI
uri: 'mongodb://localhost:27017/test',
// Mongoose connection options
options: {
}
}
},
models: {
defaultStore: 'someteststore',
migrate: 'drop'
}
}
```
### Models
#### Options
##### Model::Schema
See [Mongoose Documentation for Schemas](http://mongoosejs.com/docs/guide.html).
##### Model::Config
| Option | Type | Default | Description |
| --- | --- | --- | --- |
| tableName | String | `modelName.toLowerCase()` | Name of collection to use with this model. For example: MyModel.js defaults to collection named `mymodel`
| store | String | `app.config.database.models.defaultStore` | Datastore to use for this model; specify the name of one of the stores in `app.config.database.stores`.
| migrate | String | | Migrate *must* be set to one of `[ 'none', 'drop', 'create' ]`
| schema | Object | `{}` | [Schema Options](http://mongoosejs.com/docs/guide.html#options) to pass into Mongoose's Schema constructor.
| statics | Object | `{}` | [Static methods](http://mongoosejs.com/docs/guide.html#statics) to add to the Model.
| methods | Object | `{}` | [Instance methods](http://mongoosejs.com/docs/guide.html#methods) to add to this model's documents.
| onSchema | Function | undefined | Funcion which is useful to for adding schema middleware, virtuals, or indexes.
#### Example
```js
// Use default Schema from Mongoose. See http://mongoosejs.com/docs/schematypes.html
module.exports = class User extends Model {
static schema (app, Mongoose) {
return {
username: String,
childs: [{
type: Mongoose.Schema.ObjectId,
ref: 'UserSchema'
}],
email: {
type: String,
required: true,
unique: true,
lowercase: true,
trim: true,
validate: {
validator: function (val) {
return isEmail(val)
},
message: '{VALUE} is not a valid email'
}
}
}
}
static config (app, Mongoose) {
return {
// Collection name
tableName: 'users',
// Schema options
schema: {
timestamps: true,
versionKey: false,
toObject: {
virtuals: true
},
toJSON: {
virtuals: true
}
},
// Schema statics
statics: {
getByEmail: function (email) {
return this
.findOne({
email: _.trim(email)
})
.exec()
},
},
// Schema methods
methods: {
toJSON: function () {
const user = this.toObject()
delete user.password
return user
}
},
/**
* After Trails.js will create model Schema you could add anything you want here
* @param {TrailsApp} app TrailsJs app object
* @param {mongoose.Schema} schema mongoose new Schema object
*/
onSchema (app, schema) {
// virtuals
schema.virtual('name.full').get(function () {
return this.name.first + ' ' + this.name.last
})
// lifecircle events
schema.pre('save', function (next) {
// performing actions
next()
})
// text indexes
schema.index(
{
username: 'text',
email: 'text'
},
{
weights : {
username : 10,
email: 5
},
name: "usersIndex"
}
)
}
}
}
}
```
### Query
```js
// api/services/UserService.js
module.exports = class UserService extends Service {
/**
* Finds people with the given email.
* @return Promise
* @example {
* name: 'Ludwig Beethoven',
* email: '[email protected]',
* favoriteColors: [
* { name: 'yellow', hex: 'ffff00' },
* { name: 'black', hex: '000000' }
* ]
* }
*/
findUser (email) {
return this.orm.User.find({ email: email })
.exec()
}
}
```
## Contributing
We love contributions! Please check out our [Contributor's Guide](https://github.com/trailsjs/trails/blob/master/CONTRIBUTING.md) for more
information on how our projects are organized and how to get started.
## License
[MIT](https://github.com/trailsjs/trailpack-mongoose/blob/master/LICENSE)