Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
mongoose-multitenant
Advanced tools
Wrapper for Mongoose that allows for easy horizontal multitenancy (collection prefix per tenant)
This package facilitates horizontal multitenancy in one MongoDB database, obviously using Mongoose as the interaction layer.
With this package, you can use one schema per model, as you would normally with Mongoose, and then use special methods and syntax apply that schema to different tenant collections.
Instead of using mongoose.model(name, schema)
to compile your model, you would now use mongoose.mtModel(name, schema)
. This still creates the Mongoose model as normal, but adds some additional functionality. Specifically, you can retrieve a model for a specific tenant using this syntax:
mongoose.mtModel('tenantId.modelName')
When that happens, the package will check if that model for that tenant has already been compiled. If not, it creates a copy of the base model's schema, updates any refs
to other collections, and then compiles a new model with the new schema, with a collection name of tenantId__originalCollectionName
. All per-tenant models are lazy-loaded, meaning that they won't take up memory until they are needed.
var mongoose = require('mongoose');
require('mongoose-multitenant');
mongoose.connect('mongodb://localhost/multitenant');
With mongoose-multitenant you use all the same syntax for schema creation as you normally do with Mongoose, with the addition of the $tenant
property on document references. This tells the system whether it is a reference to a document for the same tenant (true
) or a root-level document without a tenant (false
)
var barSchema = new mongoose.Schema({
title:String,
_foos:[{
type:mongoose.Schema.Types.ObjectId,
ref:'Foo',
$tenant:true
}]
});
var fooSchema = new mongoose.Schema({
title:String,
date:Date
});
Instead of using mongoose.model
to compile, you use mongoose.mtModel
.
mongoose.mtModel('Bar', barSchema);
mongoose.mtModel('Foo', fooSchema);
Basic usage:
// This returns a new Foo model for tenant "tenant1"
var fooConstructor = mongoose.mtModel('tenant1.Foo');
var myFoo = new fooConstructor({
title:'My Foo',
date:new Date()
});
myFoo.save(function(err, result) {
// This saved it to the collection named "tenant1__foos"
});
And make use of refs/populate:
var barConstructor = mongoose.mtModel('tenant1.Bar');
var myBar = new barConstructor({
title:'My Bar'
_foos:[myFoo._id]
});
myBar.save(function(err, result) {
// Saved to the collection named "tenant1__bars"
barConstructor.find().populate('foos').exec(function(err, results) {
console.log(results[0]._foos[0].title); // "My Foo"
});
});
But you can't populate across tenancies:
var tenant2Bar = mongoose.mtModel('tenant2.Bar');
var newBar = new tenant2Bar({
title:'New Bar',
_foos:[myFoo._id]
});
newBar.save(function(err, result) {
tenant2Bar.find().populate('foos').exec(function(err, results) {
console.log(results[0]._foos[0]); // "undefined"
});
});
In addition to this base functionality, each per-tenant model gets two new schema methods: getTenantId()
and getModel()
.
This does what you think it does - returns the tenant ID for the model.
This can be used in your mongoose middleware methods to get the related model class. E.g.
barSchema.pre('save', function(next) {
// This gets Foos in the same tenancy as this Bar
this.getModel('Foo').find({_id:{$in:this._foos}}, function(err, foos) {
// Do something to the related Foos.
next()
});
});
FAQs
Wrapper for Mongoose that allows for easy horizontal multitenancy (collection prefix per tenant)
The npm package mongoose-multitenant receives a total of 2 weekly downloads. As such, mongoose-multitenant popularity was classified as not popular.
We found that mongoose-multitenant demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.