Revisions and RevisionHistory tables are not created

[davidrac]

I'm trying to work with paper trail version 3.0.0-rc.8. I followed the example code, but Revisions and RevisionHistory tables are not created. I'm working with sequelize version 5.10.

[nielsgl]

Odd, it should work, can you have a look at the tests to see what's different there from your code?

[danieldilly]

I'm having the same issue. I'm using sequelize-paper-trail v3.0.1 and sequelize v5.21.3.

I have set enableMigrations to true and this works to add the "revision" column to my "Customers" table but it does not create the Revisions table. I receive the error "Table 'project.revisions' doesn't exist. I can verify that there is no 'revisions' or 'Revisions' table being created.

Is there a step I'm missing? Do I need to manually create these tables?
I'm using migrations by the way, not sync.

[danieldilly]

I manually created the revisions table and changed the type of document from JSONB to TEXT as I'm using MySQL. It appears to be working now. I think this should be handled automatically. I had to view the source code to get the structure of the table to manually create it. That surely isn't how this is supposed to work, is it?

[n8stowell82]

I ran into the exact same issue. from what I can tell the problem is that the models are created in code and if you don't do a sequelize.sync() then those tables will never be created. I think the author intends that sync is being run at some point. As a work around, I created a couple of migration scripts that will create the tables based on what would have been made if sync were run.

just use the native sequelize migration creator to make two migrations and copy the following in modifying them as needed

npx sequelize-cli migration:create --name add-revision-table

'use strict';

module.exports = {
  up: (queryInterface, Sequelize) => {
    return queryInterface.createTable('revisions', {
      id: {
        allowNull: false,
        autoIncrement: true,
        primaryKey: true,
        type: Sequelize.INTEGER,
      },
      model: {
        type: Sequelize.TEXT,
      },
      document: {
        type: Sequelize.JSONB,
      },
      operation: {
        type: Sequelize.TEXT,
      },
      document_id: {
        type: Sequelize.INTEGER,
      },
      revision: {
        type: Sequelize.INTEGER,
      },
      created_at: {
        allowNull: false,
        type: Sequelize.DATE,
      },
      updated_at: {
        allowNull: false,
        type: Sequelize.DATE,
      },
    });
  },
  down: (queryInterface, Sequelize) => {
    return queryInterface.dropTable('revisions');
  },
};

and here is for the history (or changes)

module.exports = {
  up: (queryInterface, Sequelize) => {
    return queryInterface.createTable('revisions_changes', {
      id: {
        allowNull: false,
        autoIncrement: true,
        primaryKey: true,
        type: Sequelize.INTEGER,
      },
      path: {
        type: Sequelize.TEXT,
      },
      document: {
        type: Sequelize.JSONB,
      },
      diff: {
        type: Sequelize.JSONB,
      },
      revision_id: {
        type: Sequelize.INTEGER,
      },
      created_at: {
        allowNull: false,
        type: Sequelize.DATE,
      },
      updated_at: {
        allowNull: false,
        type: Sequelize.DATE,
      },
    });
  },
  down: (queryInterface, Sequelize) => {
    return queryInterface.dropTable('revisions_changes');
  },
};

[danieldilly]

What I ended up doing was checking if the tables exist, and if they do not, then syncing only those 2 tables:

    try {
      const revisionsExists = await models.sequelize.query("SELECT 1 FROM dbName.revisions LIMIT 0;", { type: models.Sequelize.QueryTypes.SELECT });
    } catch(err) {
      await models.Revision.sync()
      consola.success('Revision Model synced')
    }

    try {
      const revisionsExists = await models.sequelize.query("SELECT 1 FROM dbName.revisions LIMIT 0;", { type: models.Sequelize.QueryTypes.SELECT });
    } catch(err) {
      await models.Revision.sync()
      consola.success('Revision Model synced')
    }

[gabriel-yuca]

Thank you so much @n8stowell82, I got stuck with same issue, also there is no instruction on docs. Can I put something like this in the doc or there is a better way I didn't spotted?

[pkkulhari]

Thanks @n8stowell82 , It created table Revisions when I invoked sequelize.sync()