Mongoose -- Force collection name

Question

I am trying to use mongoose to create a database and a collection in it. My code is:

var mongoose = require('mongoose');
    var db = mongoose.connect('mongodb://localhost/testdb');
    var Schema = mongoose.Schema;

    var UserInfo = new Schema({
    username : String,
    password : String 
    });

    mongoose.model('UserInfo', UserInfo);

    var user = db.model('UserInfo');


    var admin = new user();
    admin.username = "sss";
    admin.password = "ee";
    admin.save();

When I run this code, mongoose created collection named UserInfo instead of userinfo. How to force collection name in mongoose?

Fun fact: mongoose knows that the plural of ox is oxen, but not that the plural of goose is geese. — Sean Letendre, Aug 15 '18 at 05:09

score 255 · Answer 1 · edited Jan 05 '19 at 17:57

255

This should do it

var UserInfo = new Schema({
  username : String,
  password : String 
}, { collection: 'userinfo' });

See this link from the Mongoose documentation for more information.

edited Jan 05 '19 at 17:57

gandreadis

3,004
2
26
38

answered Sep 23 '11 at 10:19

Thomas Blobaum

3,680
1
17
16

7

Thanks for this. Here's the relevant link: http://mongoosejs.com/docs/guide.html#collection – Jon Page Dec 07 '14 at 20:23
2

Thanks @JonPage, I was wondering why my collection of Person objects was named as people. The link you provided is a good reference. I think this method of setting a custom collection name when creating a schema is better than the other method of defining a collection name when creating the model. – Bharat Mar 10 '15 at 04:22
This was super helpful. I spent two days trying to query something now. – Holt Mansfield Sep 26 '18 at 15:23

score 105 · Answer 2 · answered Oct 11 '11 at 07:08

105

If you are using mongoose 2.0.0, pass the collectionName as the third argument

mongoose.model('UserInfo', UserInfo, 'UserInfo');

answered Oct 11 '11 at 07:08

Bilal Husain

1,730
1
12
11

1

Perfect way to declare a custom collection name at the model's level. – tezqa Jan 28 '19 at 09:32
1

This answer doesn't say if this is still working until 2.0.0 or if it has been implemented since 2.0.0. – snoob dogg Dec 23 '20 at 16:53

score 36 · Answer 3 · edited Feb 04 '19 at 03:21

36

Mongoose will add 's' to collection name by default. If you want to avoid that, just pass as third argument the name of the collection:

var mongoose = require('mongoose');
var db = mongoose.connect('mongodb://localhost/testdb');
var Schema = mongoose.Schema;

var UserInfo = new Schema({
    username: String,
    password: String 
});

mongoose.model('UserInfo', UserInfo, 'UserInfo')

tan = new user();
admin.username = 'sss';
admin.password = 'ee';
admin.save();

edited Feb 04 '19 at 03:21

gandreadis

3,004
2
26
38

answered Feb 25 '17 at 13:49

vijay kumar

1,025
13
11

1

This is the best suggestion. I have always found it the easiest to just pass the collection name in mongoose.model(). Also good for pointing out how mongoose pluralizes the collection name, that was confusing when I first started. – John Morrison Mar 24 '17 at 17:10

score 17 · Answer 4 · answered Nov 04 '16 at 07:04

API structure of mongoose.model is this:

Mongoose#model(name, [schema], [collection], [skipInit])

What mongoose do is that, When no collection argument is passed, Mongoose produces a collection name by pluralizing the model name. If you don't like this behavior, either pass a collection name or set your schemas collection name option.

Example:

var schema = new Schema({ name: String }, { collection: 'actor' });

or

schema.set('collection', 'actor');

or

var collectionName = 'actor'
var M = mongoose.model('Actor', schema, collectionName);

score 11 · Answer 5 · answered Feb 05 '16 at 02:39

11

You need to set the collection name in your schema.

new Schema({...},{collection: 'userInfo'});

answered Feb 05 '16 at 02:39

James Freund

473
4
13

score 9 · Answer 6 · answered Jul 03 '18 at 17:17

9

Mongoose maintainer here. We recommend doing mongoose.model('UserInfo', UserInfo, 'UserInfo');, third arg to mongoose.model() is the collection name. Here's the relevant docs.

answered Jul 03 '18 at 17:17

vkarpov15

3,614
24
21

score 8 · Answer 7 · answered Aug 13 '20 at 13:34

Passing a third argument on module.exports = mongoose.model('name', schema, 'collection') overrides the automatic collection name based on model name, which has already been answered.. but there are 2 other ways,

per mongoose.model doco link: https://mongoosejs.com/docs/api.html#mongoose_Mongoose-model

there are 3 methods to manually enter a collection name:

var schema = new Schema({ name: String }, { collection: 'actor' });

// or

schema.set('collection', 'actor');

// or

var collectionName = 'actor'
var M = mongoose.model('Actor', schema, collectionName)

score 5 · Answer 8 · answered Nov 19 '18 at 14:58

Answer:

mongoose.model('UserInfo', UserInfo, 'userinfo'); //3rd parameter 'userinfo': as collection name

Better explanation with syntax:

Mongoose.model(name, [schema], [collection], [skipInit])

Parameters Explanation:

1st parameter - name model name
2nd parameter [schema] schema name
3rd parameter [collection] collection name (optional, induced from model name)
4th parameter [skipInit] whether to skip initialization (defaults to false)

score 0 · Answer 9 · answered Aug 06 '18 at 08:58

your model name : userInfo.js

in express route file or app.js

var mongoose = require('mongoose');
mongoose.connect('mongodb://localhost/testdb');

then in your userInfo.js

var mongoose = require('mongoose');
var Schema = mongoose.Schema;
var UserInfo = new Schema({
 username : String,
 password : String 
});
module.exports = mongoose.model('UserInfo', UserInfo);

Mongoose -- Force collection name

9 Answers9

Linked