Mongoose plugin to create a document or return the existing one based on the unique index
npm install --save mongoose-create-uniqueIt works with MongoDB 3.0 or higher.
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.
It was designed to work the same way Model.create and 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.
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
})MIT ยฉ Diego Haz
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent