Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharvit/mongoose-data-seed
Seed mongodb with data using mongoose models
https://github.com/sharvit/mongoose-data-seed
mongoose-data-seed mongoose-seed seed-mongodb
Last synced: about 1 month ago
JSON representation
Seed mongodb with data using mongoose models
- Host: GitHub
- URL: https://github.com/sharvit/mongoose-data-seed
- Owner: sharvit
- License: mit
- Created: 2017-04-08T09:14:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:39:36.000Z (almost 2 years ago)
- Last Synced: 2024-10-05T09:35:52.162Z (about 1 month ago)
- Topics: mongoose-data-seed, mongoose-seed, seed-mongodb
- Language: JavaScript
- Homepage: https://sharvit.github.io/mongoose-data-seed/
- Size: 4.68 MB
- Stars: 110
- Watchers: 4
- Forks: 21
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/mongoose-data-seed)
[](https://github.com/semantic-release/semantic-release)
[](https://npm-stat.com/charts.html?package=mongoose-data-seed&from=2016-04-01)
[](https://travis-ci.org/sharvit/mongoose-data-seed)
[](https://coveralls.io/github/sharvit/mongoose-data-seed?branch=master)
[](http://makeapullrequest.com)
[](https://david-dm.org/sharvit/mongoose-data-seed)
[](https://david-dm.org/sharvit/mongoose-data-seed?type=dev)
[](https://greenkeeper.io/)
[](https://github.com/prettier/prettier)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fsharvit%2Fmongoose-data-seed?ref=badge_shield)
[](http://opensource.org/licenses/MIT)
# mongoose-data-seed
Seed mongodb with data using mongoose models
## Install
```shell
npm install --save mongoose-data-seed
md-seed init
```
`md-seed init` will ask you to choose a folder for your seeders.
`md-seed init` will create the `seeders` folder, generate `md-seed-config.js` and update your `package.json`.
## Use
Generate seeder file
```shell
md-seed g users
```
Run all seeders
```shell
md-seed run
```
Or run specific seeders
```shell
md-seed run users posts comments
```
## Options
Drop the database before seeding
```shell
md-seed run --dropdb
```
## Seeder Example
```javascript
import { Seeder } from 'mongoose-data-seed';
import { User } from '../server/models';
const data = [
{
email: '[email protected]',
password: '123123',
passwordConfirmation: '123123',
isAdmin: true
},
{
email: '[email protected]',
password: '123123',
passwordConfirmation: '123123',
isAdmin: false
}
];
class UsersSeeder extends Seeder {
async shouldRun() {
return User.countDocuments()
.exec()
.then(count => count === 0);
}
async run() {
return User.create(data);
}
}
export default UsersSeeder;
```
### md-seed-config.js
`md-seed` expecting to get 3 values from `md-seed-config.js`
1. `seedersList` - A key/value list of all your seeders,
`md-seed` will run your seeders as they ordered in the list.
1. `connect` - Connect to mongodb implementation (should return promise).
2. `dropdb` - Drop/Clear the database implementation (should return promise).
#### Example
```javascript
import mongoose from 'mongoose';
import Users from './seeders/users.seeder';
import Posts from './seeders/posts.seeder';
import Comments from './seeders/comments.seeder';
const mongoURL = process.env.MONGO_URL || 'mongodb://localhost:27017/dbname';
/**
* Seeders List
* order is important
* @type {Object}
*/
export const seedersList = {
Users,
Posts,
Comments,
};
/**
* Connect to mongodb implementation
* @return {Promise}
*/
export const connect = async () => await mongoose.connect(mongoURL, { useNewUrlParser: true });
/**
* Drop/Clear the database implementation
* @return {Promise}
*/
export const dropdb = async () => mongoose.connection.db.dropDatabase();
```
### Configurations
`mongoose-data-seed` configurations will get loaded from the `mdSeed` field in your `package.json` file.
Field | Default Value | Description
-----------------------|---------------|--------------------------------------------------------------------------
`seedersFolder` | `'./seeders'` | Path for your seeders-folder, seeders will be generated into this folder.
`customSeederTemplate` | `undefined` | Path to a custom template file to generate your seeders from.
## Examples
1. [md-seed-example](https://github.com/sharvit/mongoose-data-seed/tree/master/examples/md-seed-example)
## License
MIT
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fsharvit%2Fmongoose-data-seed?ref=badge_shield)
[](http://opensource.org/licenses/MIT)