Как добавить, удалить новые столбцы в Sequelize CLI

Если вы используете sequelize-cli, вам необходимо сначала создать миграцию. Это просто файл, который сообщает движку, как обновить базу данных и как откатить изменения в случае, если что-то пойдет не так. Вы всегда должны фиксировать этот файл в своем репозитории.

$ sequelize migration:create --name name_of_your_migration

Файл миграции будет выглядеть так:

module.exports = {
  up: function(queryInterface, Sequelize) {
    // logic for transforming into the new state
    return queryInterface.addColumn(
      'Todo',
      'completed',
     Sequelize.BOOLEAN
    );

  },

  down: function(queryInterface, Sequelize) {
    // logic for reverting the changes
    return queryInterface.removeColumn(
      'Todo',
      'completed'
    );
  }
}

А затем запустите его:

$ sequelize db:migrate

Если вы хотите добавить несколько столбцов в одну и ту же таблицу, оберните все в Promise.all() и поместите столбцы, которые вы хотите добавить, в массив:

module.exports = {
  up: (queryInterface, Sequelize) => {
    return Promise.all([
      queryInterface.addColumn(
        'tableName',
        'columnName1',
        {
          type: Sequelize.STRING
        }
      ),
      queryInterface.addColumn(
        'tableName',
        'columnName2',
        {
          type: Sequelize.STRING
        }
      ),
    ]);
  },

  down: (queryInterface, Sequelize) => {
    return Promise.all([
      queryInterface.removeColumn('tableName', 'columnName1'),
      queryInterface.removeColumn('tableName', 'columnName2')
    ]);
  }
};

У вас может быть любой тип столбца, поддерживаемый sequelize https://sequelize.readthedocs.io/en/2.0/api/datatypes/

Чтобы добавить несколько столбцов в продолжение

Шаг 1: создайте пустой перенос

sequelize migration:generate --name custom_name_describing_your_migration

Шаг 2: добавьте столбцы в пустой перенос.

Используйте транзакцию в соответствии с документами https://sequelize.org/master/manual/migrations.html#migration-skeleton:

module.exports = {
    up: (queryInterface, Sequelize) => {
        return queryInterface.sequelize.transaction((t) => {
            return Promise.all([
                queryInterface.addColumn('table_name', 'field_one_name', {
                    type: Sequelize.STRING
                }, { transaction: t }),
                queryInterface.addColumn('table_name', 'field_two_name', {
                    type: Sequelize.STRING,
                }, { transaction: t })
            ])
        })
    },

    down: (queryInterface, Sequelize) => {
        return queryInterface.sequelize.transaction((t) => {
            return Promise.all([
                queryInterface.removeColumn('table_name', 'field_one_name', { transaction: t }),
                queryInterface.removeColumn('table_name', 'field_two_name', { transaction: t })
            ])
        })
    }
};

Шаг 3. запустите перенос

sequelize db:migrate

Если вы работаете в vscode, вы можете добавить определение типа в файл миграции. который помогает идентифицировать все методы, которые предоставляют QueryInterface и sequelize.

 module.exports = {
/**
   * @typedef {import('sequelize').Sequelize} Sequelize
   * @typedef {import('sequelize').QueryInterface} QueryInterface
   */

  /**
   * @param {QueryInterface} queryInterface
   * @param {Sequelize} Sequelize
   * @returns
   */
  up: function(queryInterface, Sequelize) {
    // logic for transforming into the new state
    return queryInterface.addColumn(
      'Todo',
      'completed',
     Sequelize.BOOLEAN
    );

  },

  down: function(queryInterface, Sequelize) {
    // logic for reverting the changes
    return queryInterface.removeColumn(
      'Todo',
      'completed'
    );
  }
}

Что обеспечит intellisense, как показано ниже

Вы по-прежнему можете использовать функцию синхронизации, которая принимает параметр объекта с двумя вариантами, конечно, вариант по умолчанию, где вы не добавляете значение, и экземпляр, где вы добавляете атрибут force или alter. Итак, в этом случае вы хотите использовать UserModel.sync({ force: true }): это создает таблицу, сначала удаляя ее, если она уже существует.

UserModel.sync({ alter: true })

Это проверяет текущее состояние таблицы в базе данных (какие столбцы у нее есть, каковы их типы данных и т. Д.), А затем выполняет необходимые изменения в таблице, чтобы она соответствовала режиму ... Вы можете использовать это при использовании экземпляров модели Для получения дополнительной информации об обновлении, а также таблиц и моделей ознакомьтесь с документацией по дополнительным функциям здесь

Предложение Per Pter обернуть Promise в транзакцию, вот пример с использованием async / await и транзакции (из документов с исправлением ошибки при создании индекса):

'use strict';

module.exports = {
    async up(queryInterface, Sequelize) {
        const transaction = await queryInterface.sequelize.transaction();
        try {
            await queryInterface.addColumn(
                'Todo',
                'completed',
                {
                    type: Sequelize.STRING,
                },
                { transaction }
            );

            await queryInterface.addIndex(
                'Todo',
                {
                    fields: ['completed'],
                    unique: true,
                },
                { transaction }
            );

            await transaction.commit();
        } catch (err) {
            await transaction.rollback();
            throw err;
        }
    },

    async down(queryInterface, Sequelize) {
        const transaction = await queryInterface.sequelize.transaction();
        try {
            await queryInterface.removeColumn(
                'Todo',
                'completed',
                { transaction }
            );

            await transaction.commit();
        } catch (err) {
            await transaction.rollback();
            throw err;
        }
    }
};

Я думаю, если бы вы проверили свой столбец внутри конкретной таблицы перед добавлением или удалением, это было бы здорово. Это устранит ошибку, если столбец уже существует.

'use strict';

module.exports = {
  // result_description
  up: async (queryInterface, Sequelize) => {
    let tableName = 'yourTableName';
    let columnName1 = 'columnName1';
    let columnName2 = 'columnName1';
    return Promise.all([
      queryInterface.describeTable(tableName)
        .then(tableDefinition => {
          if (tableDefinition.columnName1) return Promise.resolve();

          return queryInterface.addColumn(
            tableName,
            columnName1,
            {
              type: Sequelize.INTEGER,
              allowNull: false
            }
          );
        }),
      queryInterface.describeTable(tableName)
        .then(tableDefinition => {
          if (tableDefinition.columnName2) return Promise.resolve();

          return queryInterface.addColumn(
            tableName,
            columnName2,
            {
              type: Sequelize.STRING,
              allowNull: false
            }
          );
        })
    ]);
  },

  down: (queryInterface, Sequelize) => {

    let tableName = 'TestList';
    let columnName1 = 'totalScore';
    let columnName2 = 'resultDescription';
    return Promise.all([
      queryInterface.describeTable(tableName)
        .then(tableDefinition => {
          if (tableDefinition.columnName1) return Promise.resolve();
          return queryInterface.removeColumn(tableName, columnName1)
        }),
      queryInterface.describeTable(tableName)
        .then(tableDefinition => {
          if (tableDefinition.columnName1) return Promise.resolve();
          return queryInterface.removeColumn(tableName, columnName2)
        }),
    ]);
  }
};