mongoose-auto-increment5.0.1 • Public • Published
Mongoose plugin that auto-increments any ID field on your schema every time a document is saved.
This is the module used by mongoose-simpledb to increment Number IDs. You are perfectly able to use this module by itself if you would like. However, if you're looking to make your life easier when using mongoose then I highly recommend you check out simpledb. It's a small wrapper around mongoose but it makes it extremely easy to deal with your models and draws a clear path for how to use mongoose in your application.
npm install mongoose-auto-increment
Once you have the plugin installed it is very simple to use. Just get reference to it, initialize it by passing in your
mongoose connection and pass
autoIncrement.plugin to the
plugin() function on your schema.
Note: You only need to initialize MAI once.
var mongoose =Schema = mongooseSchemaautoIncrement = ;var connection = mongoose;autoIncrement;var bookSchema =author: type: SchemaTypesObjectId ref: 'Author'title: Stringgenre: StringpublishDate: Date;bookSchema;var Book = connection;
That's it. Now you can create book entities at will and they will have an
_id field added of type
Number and will automatically increment with each new document. Even declaring references is easy, just remember to change the reference property's type to
Number instead of
ObjectId if the referenced model is also using the plugin.
var authorSchema =name: String;var bookSchema =author: type: Number ref: 'Author'title: Stringgenre: StringpublishDate: Date;bookSchema;authorSchema;
Want a field other than
Want that field to start at a different number than zero or increment by more than one?
Your first book document would have a
bookId equal to
100. Your second book document would have a
bookId equal to
200, and so on.
Want to know the next number coming up?
var Book = connection;Book;
nextCount is both a static method on the model (
Book.nextCount(...)) and an instance method on the document (
Want to reset counter back to the start value?
bookSchema;var Book = connectionbook = ;book;