LogoLogo
Join our community
  • AdminJS
  • Contribute
  • Demo
  • Addons Marketplace
  • Installation
    • Getting started
    • Plugins
      • Adonis
      • Express
      • Nest
      • Fastify
      • Hapi
      • Koa
      • Community Plugins
        • FeathersJS
        • AdonisJS
      • Matrix
    • Adapters
      • TypeORM
      • Sequelize
      • Prisma
      • MikroORM
      • Objection
      • SQL
      • Mongoose
      • Community Adapters
        • AdonisJS
    • What's new in v7?
    • Migration Guide v7
  • Basics
    • Resource
    • Action
    • Property
    • Features
      • Relations
      • Upload
      • Logger
      • Import & Export
      • Password
      • Leaflet Maps
      • Writing your own features
    • API
      • List
      • New
      • Search
      • Show
      • Edit
      • Delete
      • Bulk Delete
    • Themes
    • Authentication
      • FirebaseAuthProvider
      • MatrixAuthProvider
  • How to write an addon?
  • UI Customization
    • Writing your own Components
    • Overwriting CSS styles
    • Dashboard customization
    • Changing the form view
    • Storybook
  • Tutorials
    • Role-Based Access Control
    • Internationalization (i18n)
    • Content Management System
    • Custom components library
    • Custom component internationalization
  • FAQ
    • PDF Generator
    • Charts
    • Forgot Password
  • ⚠️Legacy documentation
Powered by GitBook
On this page
  • Standard
  • Nest.js
  1. Installation
  2. Adapters

Mongoose

@adminjs/mongoose

PreviousSQLNextCommunity Adapters

Last updated 2 years ago

Before reading this article, make sure you have set up an AdminJS instance using one of the supported . Additionally, you should have installed @adminjs/mongoose as described in section.

This guide will assume you have set up Mongoose using it's or .

There are small differences in how you connect Mongoose to Nest.js vs other plugins, so the guide will be split into two sections accordingly.

Example model:

category.entity.ts
import { model, Schema, Types } from 'mongoose'

export interface ICategory {
  title: string;
}

export const CategorySchema = new Schema<ICategory>(
  {
    title: { type: 'String', required: true },
  },
  { timestamps: true },
)

export const Category = model<ICategory>('Category', CategorySchema);

Standard

The configuration for non-Nest.js plugins is basically the same for each one of them:

  • You must connect to Mongo before creating AdminJS instance

  • You must import AdminJSMongoose adapter and register it

  • You must import the entities you want to use and pass them to AdminJS resources options

app.ts
// ... other imports
import mongoose from 'mongoose'
import * as AdminJSMongoose from '@adminjs/mongoose'

import { Category } from './category.entity.js'

AdminJS.registerAdapter({
  Resource: AdminJSMongoose.Resource,
  Database: AdminJSMongoose.Database,
})

// ... other code
const start = async () => {
  await mongoose.connect('<mongo db url>')
  const adminOptions = {
    // We pass Category to `resources`
    resources: [Category],
  }
  // Please note that some plugins don't need you to create AdminJS instance manually,
  // instead you would just pass `adminOptions` into the plugin directly,
  // an example would be "@adminjs/hapi"
  const admin = new AdminJS(adminOptions)
  // ... other code
}

start()

Nest.js

Your app.module.ts should have imports option which contains:

  • MongooseModule.forRoot('<mongo db url>') to set up Mongoose

  • AdminModule.createAdminAsync({ ... }

In your app.module.ts add these imports at the top of the file:

app.module.ts
import * as AdminJSMongoose from '@adminjs/mongoose'
import AdminJS from 'adminjs'

Following this, register AdminJSMongoose adapter somewhere after your imports:

app.module.ts
AdminJS.registerAdapter({
  Resource: AdminJSMongoose.Resource,
  Database: AdminJSMongoose.Database,
})

This will allow you to pass Mongoose models for AdminJS to load. If we use the Category entity that we used as en example earlier, you should import it into app.module.ts and pass it into resources in your adminJsOptions:

app.module.ts
// ... other imports
import { Category } from './category.entity.js'
// ... other code
AdminModule.createAdminAsync({
  useFactory: () => ({
    adminJsOptions: {
      rootPath: '/admin',
      resources: [Category],
    },
  }),
}),
// ... other code

Make sure you have followed the tutorial for the framework you are using in the section.

Make sure you have set up your app.module.ts according to and you have followed as well.

Plugins
Getting started
documentation
Nest.js documentation
Plugins
Nest.js documentation
Nest.js plugin tutorial
Page cover image