Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/diegohaz/mongoose-create-unique
Mongoose plugin to create a document or return the existing one based on the unique index
https://github.com/diegohaz/mongoose-create-unique
mongodb mongoose plugin
Last synced: 2 months ago
JSON representation
Mongoose plugin to create a document or return the existing one based on the unique index
- Host: GitHub
- URL: https://github.com/diegohaz/mongoose-create-unique
- Owner: diegohaz
- License: other
- Created: 2016-05-03T03:15:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-15T02:20:33.000Z (over 7 years ago)
- Last Synced: 2024-05-01T23:15:50.935Z (8 months ago)
- Topics: mongodb, mongoose, plugin
- Language: JavaScript
- Homepage:
- Size: 43.9 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# mongoose-create-unique
[![JS Standard Style][standard-image]][standard-url]
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coveralls Status][coveralls-image]][coveralls-url]
[![Dependency Status][depstat-image]][depstat-url]
[![Downloads][download-badge]][npm-url]
> Mongoose plugin to create a document or return the existing one based on the unique index
## Install
```sh
npm install --save mongoose-create-unique
```
It works with MongoDB 3.0 or higher.
## The problem
If you try to create a document with a duplicate key, MongoDB and Mongoose will throw the following error:
> E11000 duplicate key error collection: mydb.mycollection index: myfield_1 dup key: { : "my value" }'
We want to avoid this error when creating a new document with unique field by returning the existing one.
## How it works
It was designed to work the same way [`Model.create`](http://mongoosejs.com/docs/api.html#model_Model.create) and [`Model#save`](http://mongoosejs.com/docs/api.html#model_Model-save) do. Just use `Model.createUnique` and `Model#saveUnique` instead. The only difference is that it will return the existing document(s) if there is already one, not an error.
What `mongoose-create-unique` actually does is try to save the document(s). If Mongo throw the duplicate key error, it finds the existing document and returns it.
## Example
```js
var mongoose = require('mongoose');
mongoose.plugin(require('mongoose-create-unique'));
var ArtistSchema = new mongoose.Schema({
name: {
type: String,
unique: true
}
});
var Artist = mongoose.model('Artist', ArtistSchema);
Artist.createUnique({name: 'Shakira'}).then(function(artist) {
console.log(artist); // {_id: 1, name: 'Shakira'}
return Artist.createUnique({name: 'Rihanna'});
}).then(function(artist) {
console.log(artist); // {_id: 2, name: 'Rihanna'}
return Artist.createUnique({name: 'Shakira'});
}).then(function(artist) {
console.log(artist); // {_id: 1, name: 'Shakira'}
});
// or multiple
Artist.createUnique(
{name: 'Shakira'},
{name: 'Rihanna'},
{name: 'Shakira'}
).then(function(artists) {
// artists[0] and artists[2] are the same
})
```
## License
MIT © [Diego Haz](http://github.com/diegohaz)
[standard-url]: http://standardjs.com
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[npm-url]: https://npmjs.org/package/mongoose-create-unique
[npm-image]: https://img.shields.io/npm/v/mongoose-create-unique.svg?style=flat-square
[travis-url]: https://travis-ci.org/diegohaz/mongoose-create-unique
[travis-image]: https://img.shields.io/travis/diegohaz/mongoose-create-unique.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/diegohaz/mongoose-create-unique
[coveralls-image]: https://img.shields.io/coveralls/diegohaz/mongoose-create-unique.svg?style=flat-square
[depstat-url]: https://david-dm.org/diegohaz/mongoose-create-unique
[depstat-image]: https://david-dm.org/diegohaz/mongoose-create-unique.svg?style=flat-square
[download-badge]: http://img.shields.io/npm/dm/mongoose-create-unique.svg?style=flat-square