Make sure you have @storehouse/core and mongoose installed.
npm install @storehouse/mongoose
movies.ts
import { Model, Require_id, Schema } from 'mongoose';
import { ModelSettings } from '@storehouse/mongoose';
export interface IMovie {
title: string;
rate?: number;
}
export type MovieWithId = Require_id<IMovie>
export interface MovieModel extends Model<IMovie> {
}
export const movieSettings: ModelSettings<IMovie, MovieModel> = {
name: 'movies',
schema: new Schema<IMovie, MovieModel>({
title: {
type: String,
trim: true,
required: [true, '\'title\' is required.'],
unique: true,
index: { unique: true },
},
rate: {
type: Number
},
}),
collection: 'movies'
};
index.ts
import { Storehouse } from '@storehouse/core';
import { MongooseManager, CustomModel } from '@storehouse/mongoose';
import { movieSettings } from './movies';
// register
Storehouse.add({
local: {
// type: '@storehouse/mongoose' if you called Storehouse.setManagerType(MongooseManager)
type: MongooseManager,
config: {
// string
database: 'mongodb://localhost:27017/database',
// ConnectOptions
options: {
keepAlive: true,
maxPoolSize: 24
},
// ModelSettings[]
models: [
movieSettings
]
}
}
});
Once the manager registered, you can access it or directly get the connection or models.
import { Storehouse } from '@storehouse/core';
import { MongooseManager } from '@storehouse/mongoose';
import { Connection } from 'mongoose';
import { IMovie, MovieModel } from './movies';
// connection
const conn = await Storehouse.getConnection<Connection>().asPromise();
if (conn) {
console.log('retrieved connection for database', conn.name);
}
// manager
const localManager = Storehouse.getManager<MongooseManager>('local');
if (localManager) {
// model
const moviesModel = localManager.getModel<IMovie, MovieModel>('movies');
if (moviesModel) {
console.log('nb movies', await moviesModel.countDocuments());
}
}
// model
const Movies = Storehouse.getModel<IMovie, MovieModel>('movies');
if(Movies) {
console.log('nb movies', await Movies.countDocuments());
}
There are methods to help you retrieve the connection, manager and models so you don't have to check if they are undefined. Those methods throw an error when they fail.
import { Storehouse } from '@storehouse/core';
import { getConnection, getManager, getModel } from '@storehouse/mongoose';
import { IMovie, MovieModel } from './movies';
// connection
const conn = await getConnection(Storehouse, 'local').asPromise();
console.log('retrieved connection for database', conn.name);
// manager
const manager = getManager(Storehouse, 'local');
manager.getModel<IMovie, MovieModel>('movies');
// model
const Movies = getModel<IMovie, MovieModel>(Storehouse, 'local', 'movies');
console.log('nb movies', await Movies.countDocuments());
A method from @storehouse/mongoose's model.
import { Storehouse } from '@storehouse/core';
import { getModel } from '@storehouse/mongoose';
import { IMovie, MovieModel, MovieWithId } from './movies';
const Movies = getModel<IMovie>(Storehouse, 'local', 'movies');
const movies = await Movies.aggregation<MovieWithId>().match({});
Check if a manager's connection is currently active:
const connected = await manager.isConnected();
if (connected) {
console.log('Connection is active');
}
Perform a comprehensive health check on a manager's connection:
const health = await manager.healthCheck();
if (health?.healthy) {
console.log(`✓ Healthy - ${health.message}`);
console.log(`Latency: ${health.latency}ms`);
console.log('Details:', health.details);
} else {
console.error(`✗ Unhealthy - ${health?.message}`);
}
The health check result extends Storehouse's HealthCheckResult interface:
export interface MongooseHealthCheckResult extends HealthCheckResult {
details: {
name: string;
databaseName?: string;
host?: string;
port?: number;
models?: string[];
modelCount?: number;
readyState?: string | number;
latency?: string;
[key: string]: unknown;
};
}