Hur man hanterar migrationer i Express med Sequelize

Introduktion Under utvecklingen av dina projekt kan du behöva göra ändringar i dina ursprungliga databasscheman. Databasscheman definierar strukturen för data som lagras i databasen. För att göra dessa ändringar på ett sätt som undviker att förlora befintliga data, måste du använda databasmigrering. Databasmigrering är helt enkelt processen att göra versionskontrollerade och reversibla ändringar i databasscheman. Databasmigrering låter dig säkert göra ändringar i dina scheman och vända dessa ändringar om behovet uppstår. I den här handledningen lär du dig hur du implementerar databasmigrering i din Express- och Postgres-applikation. Du lär dig hur du skapar migreringsfiler, gör ändringar från migreringsfilerna till databasen och återställer ändringar som gjorts i databasen. Du lär dig hur du gör allt detta med hjälp av Sequelize Command-Line Interface (CLI) och Umzug-biblioteket. Du lär dig också hur du fyller din databas med test- eller dummydata. Förutsättningar För att följa denna tutorial behöver du följande: 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) Projektet Setup För att hålla artikeln kortfattad bygger den här handledningen på API: n Task Manager som skapats i . Föregående Tutorial https://hackernoon.com/how-to-connect-an-express-application-to-postgres-using-sequelize?embedable=true Klona basprojektet: Det första steget är att klona Task Manager API-förvaringen och navigera in i projektmappen: git clone https://github.com/michaelikoko/tasks-manager-api.git cd tasks-manager-api Installera beroenden: Installera de nödvändiga projektberoenden som anges i package.json: npm install Kontrollera projektstruktur: Efter installationen bör du ha en projektstruktur som ser ut så här: Databasinställning: Som anges i förutsättningarna, se till att du har en Postgres-instans som körs lokalt eller fjärr. Skapa en ny databas och spara databasanslutningsträngen i en .env-fil i rotkatalogen: PORT=5000 DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase Migrerar med Sequelize CLI I det här avsnittet kommer du att lära dig hur du hanterar migreringar med hjälp av Sequelize Command-Line Interface ( ) Du kommer att lära dig hur man ställer in hur du gör och återställer ändringar i schemat med hjälp av en migreringsfil och vissa kommandon som används av för att hantera migration. sequelize-cli sequelize-cli sequelize-cli Ställ in Sequelize CLI Installera Sequelize CLI med hjälp av en pakethanterare: npm install --save-dev sequelize-cli Ställ in Sequelize CLI i projektet med kommandot init: npx sequelize-cli init Det här kommandot skapar de nödvändiga mapparna som krävs av Sequelize CLI: och och och Om någon av dessa mappar finns innan kommandot körs (som i vårt fall med Sequelize CLI skriver inte över dem, utan genererar istället de saknade. config models migrations seeders models Slutligen konfigurerar du hur Sequelize CLI ansluter till databasen. Som standard genererar Sequelize CLI en fil, som du kan använda om du vill ha hårdkodade databasuppgifter. Men i den här handledningen kommer du att använda dynamisk konfiguration för att komma åt databasens URL, som kommer att lagras som en miljövariabel från . config/config.json .env I config-mappen tar du bort config.json och skapar config.js med följande innehåll: require('dotenv').config(); const {DATABASE_URL} = require('../utils/config'); module.exports = { development: { url: DATABASE_URL, dialect: 'postgres', seederStorage: "sequelize", seederStorageTableName: "SequelizeData" } }; För enkelhet i den här handledningen fokuserar du bara på utvecklingsmiljön. Du måste ange vägen till config.js till Sequelize CLI. I projektets rotkatalog skapar du konfigurationsfilen .sequelizerc med följande innehåll: // .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'), }; Skapa migreringsfiler Nu när du har konfigurerat Sequelize CLI kan du fortsätta med att skapa den första migreringsfilen för En migreringsfil i Sequelize är en JavaScript-fil som styr hur du implementerar och reverserar migreringar. I en typisk migreringsfil exporterar du två funktioner: 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 Båda de och Funktionerna har två parametrar: up down QueryInterface: Frågeinterface-objektet är vanligtvis den första parametern. Objektet är en instans av klassen QueryInterface. QueryInterface innehåller metoder som Sequelize använder för att kommunicera med databaser. Objektet har följande metoder: : 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-objektet är vanligtvis den andra parametern och innehåller alla angivna datatyper, till exempel STRING, INTEGER, BOOLEAN och så vidare. Du kan använda kommandot migration:generera för att generera en migreringsfil, som sparas i migreringsmappen. Använd följande kommando i en terminal för att generera migreringsfilen create-task-table: npx sequelize-cli migration:generate --name create-task-table Ersätt innehållet i den nyligen skapade migreringsfilen: med följande: 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"); }, }; den Migrationsfilen är ansvarig för att skapa tabellen i databasen. i den funktion, du utnyttjar den för att skapa tabellen genom att skicka namnet på databasens tabell ( ), och ett objekt av tabellens egenskaper (liknar definitionen av en modell i Sequelize). Om du skulle vända de ändringar som gjorts av den här migrationsfilen, i funktion, du utnyttjar den Metod för att ta bort den Tabell från databasen. XXXXXXXXXXXXXX-create-task-table.js Task up queryInterface.createTable Task down queryInterface.dropTable Task Löpande migration Migrationsfilerna måste köras för att kunna utföra ändringarna i databasen. och kommando: db:migrate npx sequelize-cli db:migrate den Kommando gör följande: db:migrate För det första skapar den en tabell som heter SequelizeMeta i databasen om den inte finns. Sequelize CLI använder sig av SequelizeMeta-tabellen för att hålla en rekord över de migrationer som har körts på databasen. För det andra söker den efter alla migreringsfiler som inte har körts. Detta bestäms genom att kontrollera migreringsfilerna i migreringsmappen mot de filer som sparas i tabellen SequelizeMeta. Slutligen kör den innehållet i alla migreringsfiler som inte har körts. Kommandon i upp-funktionen för migreringsfilen körs. Du kan använda den flagga för att endast köra en enskild migreringsfil. Till exempel, för att bara köra Migrationsfilen är: --name XXXXXXXXXXXXXX-create-task-table.js npx sequelize-cli db:migrate --name XXXXXXXXXXXXXX-create-task-table.js Ändra en befintlig modell Där vikten av att använda migreringar verkligen lyser är när du behöver göra ändringar i schemat för en befintlig databasmodell. Migreringar kan du säkert göra ändringar i databasschemat samtidigt som du säkerställer dataintegritet. Till exempel kommer du att göra en förändring till den modellschema i API:n Task Manager. Du kommer att lägga till en kolumnen till schemat. Detta kan göras i följande steg: Task dueDate Skapa migreringsfilen med kommandot migration:generera: npx sequelize-cli migration:generate --name add-dueDate-column Ersätt innehållet i den genererade migrationsfilen XXXXXXXXXXXX-add-dueDate-column.js med följande: '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") } }; Lägg till kolumnen dueDate i schemat för uppgiftsmodellen i 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 Du vill se till att förfallodagen kan läggas till när du skapar nya uppgifter via API-ändpunkten. Gör följande ändringar i kontrollerlogiken i 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, }); }); //... Slutligen kör migreringsfilen med kommandot db:migrate: npx sequelize-cli db:migrate Migrationen återvänder Databasmigrering ger dig möjlighet att säkert återställa ändringar som gjorts i databasen. Sequelize CLI ger olika kommandon som kan användas för att återställa migrering ändringar: Du kan avbryta den senaste migrationen med kommandot db:migrate:undo: npx sequelize-cli db:migrate:undo Du kan avbryta alla migreringar som gjorts och återgå till det ursprungliga tillståndet med kommandot db:migrate:undo:all: npx sequelize-cli db:migrate:undo:all Du kan också använda kommandot db:migrate:undo:all för att återgå till en viss migration genom att passera migrationsfilnamnet med --to flag. Till exempel för att återgå till migrationen XXXXXXXXXXXX-create-task-table.js: npx sequelize-cli db:migrate:undo:all --to XXXXXXXXXXXXXX-create-task-table.js Seeding Data med Sequelize CLI Databas sådd är tekniken för att fylla din databas med befintliga, ofta dumma data, för testning eller utvecklingsändamål. Sequelize ger ett sätt att sådda din databas i din Express-applikation med hjälp av såddar. Seeders är skript som låter dig fylla din databas med provdata. I det här avsnittet lär du dig hur du genererar fröfiler, kör frön och avbryter frön med Sequelize CLI. Skapa en Seeder För att skapa en fröfil kan du använda kommandot, överföra namnet på fröfilen till flagg. Kommandot sparar den genererade fröfilen i Fröfilen har strukturen med migreringsfiler, med samma och och funktioner. seed:generate --name seeders up down Du kan fortsätta att skapa en fröfil för Task Manager API som kommer att fylla i tabell med provuppgiftsdata. För att skapa filen använder du följande kommando: Tasks npx sequelize-cli seed:generate --name sample-tasks Detta kommando skapar följande fil i Föregående Folder: och den Filen ska ha följande innehåll: 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, {}); }, }; Löpning Seeders För att göra ändringarna i databasen måste du köra fröfilen. Sequelize CLI ger Kommandot att köra fröfiler. db:seed För att köra alla fröfiler i Folders, du använder följande kommando: seeders npx sequelize-cli db:seed:all Du kan också köra en viss fröfil genom att använda flagga och ange namnet på filen. Till exempel, för att bara köra fröfilen : --seed XXXXXXXXXXXXXX-sample-tasks.js npx sequelize-cli db:seed --seed XXXXXXXXXXXXXX-sample-tasks.js Tillbaka till Seeds Sequelize CLI ger också olika kommandon som återvänder eventuella ändringar som gjorts av fröfiler: Du kan använda följande kommando för att ta bort alla frön: npx sequelize-cli db:seed:undo:all Du kan använda följande kommando för att avbryta en viss fröfil, till exempel 20250913081512-sample-tasks.js: npx sequelize-cli db:seed:undo --seed 20250913081512-sample-tasks.js Du kan använda följande kommando för att avbryta det senaste fröet: npx sequelize-cli db:seed:undo Migration med umzug Hittills i handledningen har du använt Sequelize CLI-verktyget för att köra migrationer.Om du behöver mer kontroll över hur migrationer utförs och vill köra dem manuellt kan du använda och bibliotek. Mörkret Umzug beskrivs som: Framework agnostisk migrering verktyg för Node.js Framework agnostisk migrering verktyg för Node.js Ställ upp umzug Börja med att installera umzug biblioteket: npm install umzug Skapa migratorConfig-konfigurationsobjektet. Du använder det här objektet för att konfigurera en Umzug-instans genom att skicka den till konstruktorn. Redigera utils/db.js-filen enligt följande: //... 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, }; // ... Skapa funktionen runMigrations. Den utför migreringar på migreringsfiler som finns i migreringsmappen. I migratorConfig-objektet ber du Sequelize att spåra migreringar som har utförts, så runMigrations-funktionen gör ingenting om det inte finns några nya migreringsfiler. Lägg till följande kod till 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), }); }; Skapa funktionen undoMigrations som vänder den föregående migrationen. Lägg till följande kod till 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), }); }; // ... Slutligen, den Filen ska se ut så här: 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(); den Funktionen ska ha följande innehåll: util/undoMigrations.js const { undoMigrations } = require("./db"); undoMigrations(); Slutligen skapar du npm-skript i package.json: { //... "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" } //... } Migrera med Umzug När du använder Umzug-biblioteket för att köra migreringar skapar du manuellt migreringsfilerna, som de som skapats med kommandot Sequelize CLI. kommer inte att fungera. migration:generate Till exempel, den migreringsfilen, som lägger till kolumn till den tabell, bör se ut så här när utförs med hjälp av 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"); }, }; För att köra migreringsfilen använder du NPM-skript som du ställer in i som kallar den Funktioner : migration:up package.json runMigrations npm run migration:up Återställa migration med Umzug För att avbryta den sista migrationen använder du npm skript som kallar den Funktioner : migration:down undoMigration npm run migration:down Slutsats I slutet av den här handledningen lärde du dig vikten av att använda databasmigrationer när du utvecklar dina program. Du lärde dig hur du använder Sequelize CLI för att generera migreringsfiler, utföra migrationer och återställa ändringar som gjorts i databasen. Du lärde dig också hur du använder Sequelize CLI för att skapa fröfiler för att fylla din databas med provdata. Slutligen lärde du dig hur du kör migreringar manuellt med hjälp av Umzug-biblioteket. Koden för denna tutorial kan hittas på . GitHub Om du vill veta mer om databasmigreringar kan du besöka följande resurser: Sequel för dokumentation Hämta CLI Github Öppna GitHub

Hur man hanterar migrationer i Express med Sequelize

About Author

KOMMENTARER

HÄNG TAGGAR

DENNA ARTIKEL PRESENTERAS I

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps