This is the official documentation of the @forestadmin/agent Node.js agent.

The Sequelize data source allows importing collections from a Sequelize instance.

To make everything work as expected, you need to install the package @forestadmin/datasource-sequelize.

Note that:

  • Sequelize scopes will be mapped to Forest Admin segments

  • Sequelize hooks will run

  • Sequelize association, field aliasing, relationships, and validation will be respected

const { createAgent } = require('@forestadmin/agent');
const { createSequelizeDataSource } = require('@forestadmin/datasource-sequelize');
const { Sequelize, Model, DataTypes } = require('@sequelize/core');

// Create a Sequelize instance
const sequelize = new Sequelize('sqlite::memory:');

class User extends Model {}
    username: DataTypes.STRING,
    birthday: DataTypes.DATE,
  { sequelize, modelName: 'user' },

// Create agent and import collections from sequelize
const agent = createAgent(options).addDataSource(

Last updated