Update your models' definition

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Update your models' definition

Your database schema will evolve over time. Any changes can (and probably should) be applied to your admin backend's models.

To upgrade your models definition in your code you need to be at least in the V7 version of forest-express-sequelize or forest-express-mongoose package. If this is not the case please follow our migration note.

Now you can use the forest schema:update command to achieve your goal.

This command is able to create all the missing file for a newly added table in your database. However it will not automatically modify existing files. So if you just added a new field inside an existing table, please just remove the corresponding model file inside your models folder and run the command.

Examples

In the following example, we added a new table customers on an existing project. This is the output of the forest schema:update command.

$ forest schema:update
✓ Connecting to your database(s)
✓ Analyzing the database(s)
  create forest/customers.js
  skip forest/staffs.js - already exist.
  skip forest/stores.js - already exist.
  create models/customers.js
  skip models/staffs.js - already exist.
  skip models/stores.js - already exist.
  create routes/customers.js
  skip routes/staffs.js - already exist.
  skip routes/stores.js - already exist.
✓ Generating your files

In the next example we just removed a field from the previous added table. After removing the model file from the models folder. This is the output of the forest schema:update command.

$ forest schema:update
✓ Connecting to your database(s)
✓ Analyzing the database(s)
  skip forest/customers.js - already exist.
  skip forest/staffs.js - already exist.
  skip forest/stores.js - already exist.
  create models/customers.js
  skip models/staffs.js - already exist.
  skip models/stores.js - already exist.
  skip routes/customers.js - already exist.
  skip routes/staffs.js - already exist.
  skip routes/stores.js - already exist.
✓ Generating your files