Sequelize を使用して Express で移行を処理する方法

導入 プロジェクトの開発の過程で、初期のデータベース スケジュールに変更を行う必要がある場合があります. データベース スケジュールは、データベースに保存されているデータの構造を定義します. To make these changes in a way that avoids losing existing data, you will require the use of Database migration. Database migration is simply the process of making version-controlled and reversible modifications to database schemes. Database migration allows you to safely make changes to your schemes and revert these changes if the need arises. データベースの移行は単に、バージョン制御およびリバリエーション可能な変更を行うプロセスです。 このチュートリアルでは、ExpressおよびPostgresアプリケーションでデータベース移行を実装する方法を学びます。あなたは移行ファイルを作成し、移行ファイルからデータベースに変更を行い、データベースに変更を返します。あなたはCLI(Sequelize Command-Line Interface)とUmzugライブラリを使用してこれらのすべての方法を学びます。あなたはまた、テストまたはデュミーデータでデータベースを埋め込む方法を学びます。 前提条件 このチュートリアルに従うには、以下のことが必要になります。 A text editor (e.g., VS Code) NodeJS installed on your computer Basic knowledge of Express Basic knowledge of Git A Postgres instance running either locally or remotely An API client (e.g., Postman) プロジェクト設定 Let's begin by setting up the project you'll be working on. To keep the article concise, this tutorial builds on the Task Manager API created in the . 以前のTutorial https://hackernoon.com/how-to-connect-an-express-application-to-postgres-using-sequelize?embedable=true ベース プロジェクトをクローン化する: 最初のステップは、タスク マネージャー API リポジトリをクローン化し、プロジェクト フォルダに移動することです。 git clone https://github.com/michaelikoko/tasks-manager-api.git cd tasks-manager-api 依存をインストールする: package.json に記載されているプロジェクト依存をインストールします。 npm install プロジェクト構造をチェック: インストール後、このように見えるプロジェクト構造が必要です。 データベースのセットアップ:前提条件で述べたように、ローカルまたはリモートで実行されている Postgres インスタンスを持っていることを確認してください. Create a new database and store the database connection string in a .env file at the root directory: PORT=5000 DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase Sequelize CLI による移行 このセクションでは、Sequelize Command-Line Interface (Sequelize Command-Line Interface) を使用して移行を処理する方法を学びます。 )を設定する方法を学びます。 , how to make and revert changes to the schema using a migration file, and some commands used by 移住を扱うこと。 sequelize-cli sequelize-cli sequelize-cli Sequelize CLIの設定 パッケージマネージャーを使用して Sequelize CLI をインストールします: npm install --save-dev sequelize-cli init コマンドを使用して Project で Sequelize CLI を設定する: npx sequelize-cli init このコマンドは Sequelize CLI に必要なフォルダを作成します。 で、 , そして、 これらのフォルダのいずれかがコマンドを実行する前に存在する場合(当社の場合のように、 ), Sequelize CLI does not overwrite them, but instead generates the missing ones. config models migrations seeders models 最後に、Sequelize CLI がデータベースに接続する方法を設定します。 file, which you can make use of if you want to hardcode database credentials. However, in this tutorial, you'll make use of dynamic configuration to access the database URL, which will be stored as an environment variable from . config/config.json .env config フォルダで config.json を削除し、次のコンテンツで config.js を作成します。 require('dotenv').config(); const {DATABASE_URL} = require('../utils/config'); module.exports = { development: { url: DATABASE_URL, dialect: 'postgres', seederStorage: "sequelize", seederStorageTableName: "SequelizeData" } }; このチュートリアルのシンプルさのために、あなたは開発環境にのみ焦点を当てています。 プロジェクトのルートディレクトリで、次のコンテンツを持つ .sequelizerc 構成ファイルを作成します。 // .sequelizerc const path = require('path'); module.exports = { config: path.resolve('config', 'config.js'), 'models-path': path.resolve('models'), 'seeders-path': path.resolve('seeders'), 'migrations-path': path.resolve('migrations'), }; Generate Migration Files Sequelize CLI を設定した後、最初の移行ファイルを作成します。 モデル. Sequelize での移行ファイルは、移行の実装と逆転を制御する JavaScript ファイルです. In a typical migration file, you export two functions: task : The function contains logic for modifying the database to a new state. up up : The function contains logic for reverting the changes made in the function. down down up 両方 The そして 機能には2つのパラメーターがあります。 up down queryInterface: queryInterface オブジェクトは通常、最初のパラメータです。 オブジェクトは QueryInterface クラスのインスタンスです。 QueryInterface には、Sequelize がデータベースと通信するために使用するメソッドが含まれています。 : creates a new table queryInterface.createTable : adds a column to a table queryInterface.addColumn : changes the properties of a column queryInterface.changeColumn : removes a column queryInterface.removeColumn : inserts multiple data into a table queryInterface.bulkInsert : deletes multiple data from a table queryInterface.bulkDelete For a full list of available methods, visit the section of the Sequelize documentation. QueryInterface API Sequelize: Sequelize オブジェクトは通常、2 番目のパラメータであり、TRING、INTEGER、BOOLEAN などすべての提供されたデータタイプを含みます。Migration:generate コマンドを使用して、移行ファイルを生成し、移行フォルダに保存できます。 npx sequelize-cli migration:generate --name create-task-table 新しく作成された移行ファイルのコンテンツを置き換える: 以下を含む。 XXXXXXXXXXXXXX-create-task-table.js "use strict"; /** @type {import('sequelize-cli').Migration} */ module.exports = { async up(queryInterface, Sequelize) { await queryInterface.createTable("Tasks", { id: { type: Sequelize.DataTypes.INTEGER, autoIncrement: true, primaryKey: true, }, title: { type: Sequelize.DataTypes.STRING, allowNull: false, }, completed: { type: Sequelize.DataTypes.BOOLEAN, defaultValue: false, }, createdAt: { type: Sequelize.DataTypes.DATE, allowNull: false }, updatedAt: { type: Sequelize.DataTypes.DATE, allowNull: false } }); }, async down(queryInterface, Sequelize) { await queryInterface.dropTable("Tasks"); }, }; THE migration file is responsible for creating the table in the database. In the 機能を用いて、あなたは データベースのタブレット(データベースのタブレットの名前を渡す方法) )とテーブル属性のオブジェクト(Sequelize でモデルを定義するに似ています)。 機能を用いて、あなたは 削除する方法 The method to remove the データベースからのテーブル XXXXXXXXXXXXXX-create-task-table.js Task up queryInterface.createTable Task down queryInterface.dropTable Task 走る移民 移行ファイルは、データベースの変更を実行するために実行する必要があります。 command: db:migrate npx sequelize-cli db:migrate THE command does the following: db:migrate まず、データベースに SequelizeMeta というテーブルが存在しない場合は、SequelizeMeta というテーブルを作成します。 第二に、実行されていないすべての移行ファイルを検索します. This is determined by checking the migration files in the migration folder against the files recorded in the SequelizeMeta table. 移行フォルダの移行ファイルを SequelizeMeta テーブルに保存したファイルにチェックすることによって決定されます. 最後に、実行されていないすべての移行ファイルのコンテンツを実行します。 You can use the 単一の移行ファイルのみを実行するために、例えば、 移住ファイル: --name XXXXXXXXXXXXXX-create-task-table.js npx sequelize-cli db:migrate --name XXXXXXXXXXXXXX-create-task-table.js 既存のモデルを変更 移行の使用の重要性は、既存のデータベース モデルのスケジュールに変更を加える必要がある場合に明らかになります。 移行は、データベース スケジュールの変更を安全に実行し、データの完全性を確保することを可能にします。 For example, you're going to make a change to the タスクマネージャー API でモデル スケジュールを追加します。 スケジュールをクリックすると、以下の手順で行うことができます。 Task dueDate migration:generate コマンドを使用して移行ファイルを作成します。 npx sequelize-cli migration:generate --name add-dueDate-column 生成された移行ファイル XXXXXXXXXXXX-add-dueDate-column.js のコンテンツを次のとおりに置き換える: 'use strict'; /** @type {import('sequelize-cli').Migration} */ module.exports = { async up (queryInterface, Sequelize) { await queryInterface.addColumn("Tasks", "dueDate", { type: Sequelize.DataTypes.DATE, allowNull: true }) }, async down (queryInterface, Sequelize) { await queryInterface.removeColumn("Tasks", "dueDate") } }; Add the column to the model schema in : dueDate Task models/task.js const {Model, DataTypes} = require("sequelize") const {sequelize} = require("../utils/db") class Task extends Model {} Task.init({ id: { type: DataTypes.INTEGER, autoIncrement: true, primaryKey: true }, title: { type: DataTypes.STRING, allowNull: false }, completed: { type: DataTypes.BOOLEAN, defaultValue: false }, dueDate: { type: DataTypes.DATE, allowNull: true } }, { sequelize, modelName: "Task", timestamps: true, underscored: false, defaultScope: { attributes: { exclude: ["createdAt", "updatedAt"] } } }) module.exports = Task API エンドポイントを使用して新しいタスクを作成するときに、到着日が追加されることを確認する必要があります. Make the following changes to the controller logic in index.js: //... app.post("/api/tasks", async (req, res) => { const { title, dueDate } = req.body; if (!title) { return res.status(400).json({ message: "Title is required" }); } const dueDateObj = dueDate ? new Date(dueDate) : null; if (dueDateObj == "Invalid Date") { return res.status(400).json({ message: "Invalid due date format" }); } if (dueDateObj && dueDateObj < new Date()) { return res.status(400).json({ message: "Due date cannot be in the past" }); } const task = await Task.create({ title, dueDate: dueDateObj }); res.status(201).json({ message: "Task created successfully", task, }); }); //... 最後に、db:migrate コマンドを使用して移行ファイルを実行します。 npx sequelize-cli db:migrate Revert Migrations データベースの移行は、データベースに作成した変更を安全に逆転する機能を提供します。Sequelize CLI は、移行の変更を逆転するために使用できるさまざまなコマンドを提供します。 db:migrate:undo コマンドで最新の移行をキャンセルできます。 npx sequelize-cli db:migrate:undo すべての移行を無効にし、 db:migrate:undo:all コマンドで元の状態に戻すことができます。 npx sequelize-cli db:migrate:undo:all You can also use the command to return to a particular migration by passing the migration file name with the flag. For example, to revert back to the migration: db:migrate:undo:all --to XXXXXXXXXXXXXX-create-task-table.js npx sequelize-cli db:migrate:undo:all --to XXXXXXXXXXXXXX-create-task-table.js Sequelize CLI で Seeding Data Database seeding is the technique of populating your database with existing, often dummy data, for testing or development purposes. Sequelize provides a way to seed your database in your Express application using seeders. Seeders are scripts that allow you to populate your database with sample data. このセクションでは、Sequelize CLI を使用して種子ファイルを生成し、種子を実行し、種子を無効にする方法を学びます。 SEEDERを生成する 種子ファイルを作成するには、あなたは使用することができます。 名前の由来 名の由来 名の由来 名の由来 flag. The command saves the generated seed file in the folder. The seed file has the structure with migration files, using the same and 機能 seed:generate --name seeders up down タスクマネージャの API のために種子ファイルを作成し、そのファイルを埋め込むことができます。 サンプルタスクデータを含むテーブル. To create the file, use the following command: Tasks npx sequelize-cli seed:generate --name sample-tasks This command will create the following file in the folder: ♪ The file should have the following contents: seeders XXXXXXXXXXXXXX-sample-tasks.js XXXXXXXXXXXXXX-sample-tasks.js "use strict"; /** @type {import('sequelize-cli').Migration} */ module.exports = { async up(queryInterface, Sequelize) { await queryInterface.bulkDelete("Tasks", null, {}); // First, clear the Tasks table await queryInterface.bulkInsert( "Tasks", [ { title: "Finish project proposal", dueDate: new Date("2025-09-15"), createdAt: new Date(), updatedAt: new Date(), }, { title: "Team meeting", dueDate: new Date("2025-09-17"), createdAt: new Date(), updatedAt: new Date(), }, { title: "Code review", dueDate: null, createdAt: new Date(), updatedAt: new Date(), }, { title: "Update documentation", dueDate: new Date("2025-09-20"), createdAt: new Date(), updatedAt: new Date(), }, { title: "Refactor legacy code", dueDate: null, createdAt: new Date(), updatedAt: new Date(), }, ], {} ); }, async down(queryInterface, Sequelize) { await queryInterface.bulkDelete("Tasks", null, {}); }, }; RUN SEEDERS In order to effect the changes to the database, you need to run the seed file. Sequelize CLI provides the command to run seed files. db:seed すべての種子ファイルを実行するには、 Folders では、以下のコマンドを使用します。 seeders npx sequelize-cli db:seed:all また、特定の種子ファイルを実行することもできます。 flag and specifying the name of the file. For example, to only run the seed file : --seed XXXXXXXXXXXXXX-sample-tasks.js npx sequelize-cli db:seed --seed XXXXXXXXXXXXXX-sample-tasks.js 再生セーバー Sequelize CLI also provides various commands that revert any changes made by seed files: You can use the following command to undo all seeds: npx sequelize-cli db:seed:undo:all You can use the following command to undo a specific seed file, for example, : 20250913081512-sample-tasks.js npx sequelize-cli db:seed:undo --seed 20250913081512-sample-tasks.js 次のコマンドを使用して、最新の種子を無効にすることができます。 npx sequelize-cli db:seed:undo Umzugによる移住 So far in the tutorial, you have used the Sequelize CLI tool to run migrations. If you require more control on how migrations are performed and want to run them manually, you can make use of the library. Umzug Umzug is described as: Framework Agnostic Migration Tool for Node.js Framework agnostic migration tool for Node.js オムツを立てて Start by installing the library: umzug npm install umzug migratorConfig 構成オブジェクトを作成します. このオブジェクトを使用して、Constructor に転送して Umzug インスタンスを構成します. 次の方法で utils/db.js ファイルを編集します: //... const { Umzug, SequelizeStorage } = require("umzug"); const migratorConfig = { migrations: { glob: "migrations/*.js", }, storage: new SequelizeStorage({ sequelize, tableName: "SequelizeMeta" }), // Store performed migration files context: sequelize.getQueryInterface(), logger: console, }; // ... Create the function. The performs migrations on migration files found in the folder. In the object, you tell Sequelize to keep track of migrations that have been executed, so the function doesn't do anything if there are no new migration files. Add the following piece of code to : runMigrations migrations migratorConfig runMigrations utils/db.js // ... const runMigrations = async () => { await sequelize.authenticate(); const migrator = new Umzug(migratorConfig); const migrations = await migrator.up(); console.log("Migrations up to date", { files: migrations.map((mig) => mig.name), }); }; 前回の移行を逆転させる undoMigrations 関数を作成します. Add the following piece of code to utils/db.js: //... const undoMigrations = async () => { await sequelize.authenticate(); const migrator = new Umzug(migratorConfig); const migrations = await migrator.down(); console.log("Migrations reverted", { files: migrations.map((mig) => mig.name), }); }; // ... 最後に、The ファイルはこんな感じ: utils/db.js const Sequelize = require("sequelize"); const { DATABASE_URL } = require("./config"); const { Umzug, SequelizeStorage } = require("umzug"); const sequelize = new Sequelize(DATABASE_URL); const connectToDB = async () => { try { await sequelize.authenticate(); console.log("Database connection established successfully."); } catch (error) { console.log("Unable to connect to the database:", error); return process.exit(1); } return null; }; const migratorConfig = { migrations: { glob: "migrations/*.js", }, storage: new SequelizeStorage({ sequelize, tableName: "SequelizeMeta" }), // Store performed migration files context: sequelize.getQueryInterface(), logger: console, }; const runMigrations = async () => { await sequelize.authenticate(); const migrator = new Umzug(migratorConfig); const migrations = await migrator.up(); console.log("Migrations up to date", { files: migrations.map((mig) => mig.name), }); }; const undoMigrations = async () => { await sequelize.authenticate(); const migrator = new Umzug(migratorConfig); const migrations = await migrator.down(); console.log("Migrations reverted", { files: migrations.map((mig) => mig.name), }); }; module.exports = { connectToDB, sequelize, runMigrations, undoMigrations, }; Create two files in the directory: and . These files will allow you to set up npm scripts to execute the and functions created. util runMigrations.js undoMigrations.js runMigrations undoMigrations The function should have the following contents: util/runMigrations.js const { runMigrations } = require("./db"); runMigrations(); THE 機能には以下のコンテンツが含まれます。 util/undoMigrations.js const { undoMigrations } = require("./db"); undoMigrations(); 最後に package.json で npm スクリプトを作成します。 { //... "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "dev": "nodemon index.js", "start": "node index.js", "migration:up": "node utils/runMigrations.js", "migration:down": "node utils/undoMigrations.js" } //... } Umzug で Migration を実行 Umzug ライブラリを使用して移行を実行する場合は、Sequelize CLI コマンドを使用して作成された移行ファイルとして、移行ファイルを手動で作成します。 働かない。 migration:generate 例えば、The migration file, which adds the column to the table, should look like this when executed using Umzug: XXXXXXXXXXXXXX-add-dueDate-column.js dueDate Tasks const { DataTypes } = require("sequelize"); module.exports = { async up({ context: queryInterface }) { await queryInterface.addColumn("Tasks", "dueDate", { type: DataTypes.DATE, allowNull: true, }); }, async down({ context: queryInterface }) { await queryInterface.removeColumn("Tasks", "dueDate"); }, }; To run the migration file, you make use of the npm スクリプト you set up in , which calls the 機能: migration:up package.json runMigrations npm run migration:up Revert Migrations with Umzug 最後の移行をキャンセルするには、あなたは npm というスクリプトは、 function: migration:down undoMigration npm run migration:down Conclusion At the end of this tutorial, you learnt the importance of using database migrations when developing your applications. You learnt how to use the Sequelize CLI to generate migration files, execute migrations, and revert changes made to the database. You also learnt how to use the Sequelize CLI to create seed files in order to populate your database with sample data. Lastly, you learnt how to run migrations manually using the Umzug library. The code for this tutorial can be found on . GitHub データベース移行の詳細については、以下のリソースを参照してください。 Sequelize Documentation GitHub をクリックする トップ > GitHub