Sequelize
@adminjs/sequelize
Before reading this article, make sure you have set up an AdminJS instance using one of the supported Plugins.
Additionally, you should have installed
@adminjs/sequelize
as described in Getting started section.There are small differences in how you connect Sequelize to Nest.js vs other plugins, so the guide will be split into two sections accordingly.
Example model:
category.entity.ts
import { DataTypes, Model, Optional } from 'sequelize'
import sequelize from './index.js'
interface ICategory {
id: number;
name: string;
createdAt: Date;
updatedAt: Date;
}
export type CategoryCreationAttributes = Optional<ICategory, 'id'>
export class Category extends Model<ICategory, CategoryCreationAttributes> {
declare id: number;
declare name: string;
declare createdAt: Date;
declare updatedAt: Date;
}
Category.init(
{
id: {
type: DataTypes.INTEGER,
autoIncrement: true,
primaryKey: true,
},
name: {
type: new DataTypes.STRING(128),
allowNull: false,
},
createdAt: {
type: DataTypes.DATE,
},
updatedAt: {
type: DataTypes.DATE,
},
},
{
sequelize,
tableName: 'categories',
modelName: 'category',
}
)
Sequelize connection:
import { Sequelize } from 'sequelize'
const sequelize = new Sequelize('postgres://adminjs:adminjs@localhost:5435/adminjs', {
dialect: 'postgres',
})
export default sequelize
The configuration for non-Nest.js plugins is basically the same for each one of them:
- You must import
AdminJSSequelize
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 * as AdminJSSequelize from '@adminjs/sequelize'
import { Category } from './category.entity.js'
AdminJS.registerAdapter({
Resource: AdminJSSequelize.Resource,
Database: AdminJSSequelize.Database,
})
// ... other code
const start = async () => {
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()
Make sure you have set up your
app.module.ts
according to Nest.js documentation and you have followed Nest.js plugin tutorial as well.Your
app.module.ts
should have imports
option which contains:SequelizeModule.forRoot({ uri: '...', dialect: '...' })
to set up SequelizeAdminModule.createAdminAsync({ ... }
You should also be able to get Sequelize to work if you set it up using a Nest.js database provider. The main point is to have a database connection established before AdminJS is initialized.
In your
app.module.ts
add these imports at the top of the file:app.module.ts
import * as AdminJSSequelize from '@adminjs/sequelize'
import AdminJS from 'adminjs'
Following this, register
AdminJSSequelize
adapter somewhere after your imports:app.module.ts
AdminJS.registerAdapter({
Resource: AdminJSSequelize.Resource,
Database: AdminJSSequelize.Database,
})
This will allow you to pass Sequelize 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
Last modified 5mo ago