Kako upravljati migracijama u Expressu koristeći Sequelize

Uvod Tijekom razvoja projekata, možda ćete morati da izvršite promene u početnim shemama baze podataka. Sheme baze podataka definiraju strukturu podataka pohranjenih u bazi podataka. Da biste izvršili ove promene na način koji sprečava gubitak postojećih podataka, potrebno je da koristite migraciju baze podataka. Migracija baze podataka je jednostavno proces izvršavanja modifikacija kontrolisanih verzijama i reverzibilnih u shemama baze podataka. Migracija baze podataka omogućava vam da bezbedno izvršite promene u svojim shemama i vratite te promene ako se pojavi potreba. U ovom vodiču, naučit ćete kako da implementirate migraciju baze podataka u vašoj aplikaciji Express i Postgres. Naučit ćete kako da kreirate migracijske datoteke, izvršite promene iz migracijskih datoteka u bazu podataka i vratite promene napravljene u bazu podataka. Naučit ćete kako da uradite sve to koristeći Sequelize Command-Line Interface (CLI) i Umzug biblioteku. Takođe ćete naučiti kako da popunite svoju bazu podataka sa test ili dummy podataka. Preduvjeti Da biste pratili zajedno sa ovim tutorialom, potrebno vam je sljedeće: 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) Projekat postavljanja Da bi članak bio kratak, ovaj tutorial se zasniva na API-ju Task Manager kreiranom u . Prethodni članakTutorial https://hackernoon.com/how-to-connect-an-express-application-to-postgres-using-sequelize?embedable=true Kloniranje baznog projekta: Prvi korak je kloniranje repozitorija API menadžera zadataka i navigacija kroz projektnu fasciklu: git clone https://github.com/michaelikoko/tasks-manager-api.git cd tasks-manager-api Instalirajte zavisnosti: Instalirajte potrebne zavisnosti projekta navedene u paketu package.json: npm install Provjerite strukturu projekta: Nakon instalacije, trebali biste imati strukturu projekta koja izgleda ovako: Postavljanje baze podataka: Kao što je navedeno u preduvjetima, pobrinite se da imate Postgres instanci koja se pokreće lokalno ili udaljeno. Kreirajte novu bazu podataka i pohranite niz veze baze podataka u .env datoteci u root direktoriju: PORT=5000 DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase Migracije pomoću Sequelize CLI U ovom odeljku ćete naučiti kako da rukujete migracijama koristeći Sequelize Command-Line Interface ( ) Naučit ćete kako da postavite , kako napraviti i vratiti promene u shemi pomoću datoteke za migraciju, i neke komande koje koriste Upravljanje migracijama. sequelize-cli sequelize-cli sequelize-cli Postavite Sequelize CLI Instalirajte Sequelize CLI pomoću menadžera paketa: npm install --save-dev sequelize-cli Postavite Sequelize CLI u projektu pomoću zapovesti init: npx sequelize-cli init Ova komanda stvara potrebne fascikle koje zahtijeva Sequelize CLI: U pitanju je U pitanju je i Ako bilo koja od ovih fascikli postoji prije pokretanja komande (kao u našem slučaju sa ), Sequelize CLI ih ne prepisuje, već umjesto toga generira one koje nedostaju. config models migrations seeders models Konačno, konfigurirate kako se Sequelize CLI poveže sa bazom podataka. Podrazumevano, Sequelize CLI generira datoteka, koju možete koristiti ako želite da hardcode povjerljivosti baze podataka. Međutim, u ovom vodiču, vi ćete koristiti dinamičku konfiguraciju za pristup URL baze podataka, koji će biti pohranjen kao varijable okruženja iz . config/config.json .env U konfig mapi, obrišite config.json i kreirajte config.js sa sledećim sadržajem: require('dotenv').config(); const {DATABASE_URL} = require('../utils/config'); module.exports = { development: { url: DATABASE_URL, dialect: 'postgres', seederStorage: "sequelize", seederStorageTableName: "SequelizeData" } }; Za jednostavnost u ovom vodiču, fokusirate se samo na razvojno okruženje. Potrebno je da navedete put do config.js do Sequelize CLI. U korenskom direktoriju projekta kreirajte konfiguracijsku datoteku .sequelizerc sa sledećim sadržajem: // .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'), }; Generiranje migracijskih datoteka Sada kada ste konfigurisali Sequelize CLI, možete nastaviti s kreiranjem prve migracijske datoteke za Model. Migracijska datoteka u programu Sequelize je JavaScript datoteka koja upravlja kako implementirati i preokrenuti migracije. U tipičnoj migracijskoj datoteci izvezete dvije funkcije: 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 Obe strane i Funkcije imaju dva parametra: up down queryInterface: Objekt queryInterface je obično prvi parametar. Objekt je instanca klase QueryInterface. QueryInterface sadrži metode koje Sequelize koristi za komunikaciju s bazama podataka. Objekt ima sledeće metode: : 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: Objekt Sequelize je obično drugi parametar i sadrži sve navedene tipove podataka, kao što su STRING, INTEGER, BOOLEAN i tako dalje. Možete koristiti komandu migration:generate da biste generisali datoteku migracije, koja je sačuvana u mapi migracije. Koristite sledeću komandu u terminalu da biste generisali datoteku migracije tabele create-task: npx sequelize-cli migration:generate --name create-task-table Zamijenite sadržaj upravo kreirane migracijske datoteke: uz sledeće: 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"); }, }; Naši migracijska datoteka je odgovorna za stvaranje Tablica u bazi podataka. u funkcije, vi koristite Prethodni članakKako izabrati bazu podataka ( ), i objekta svojstava tabele (sličan definiciji modela u Sequelize). Ako biste trebali vratiti promene napravljene ovom migracijskom datotekom, u funkcije, vi koristite Metode za uklanjanje Tablica iz baze podataka. XXXXXXXXXXXXXX-create-task-table.js Task up queryInterface.createTable Task down queryInterface.dropTable Task Uskoro migracije Migracijske datoteke moraju biti pokrenute kako bi se izvršile promjene u bazi podataka. To možete učiniti pomoću Zapovjedništvo : db:migrate npx sequelize-cli db:migrate Naši Zapovjedništvo čini sledeće: db:migrate Prvo, kreira tabelu pod nazivom SequelizeMeta u bazi podataka ako ne postoji. Sequelize CLI koristi tabelu SequelizeMeta da bi vodio evidenciju o migracijama koje su pokrenute u bazi podataka. Drugo, pretražuje bilo koju datoteku migracije koja nije pokrenuta.To se određuje provjeravanjem datoteka migracije u mapi migracije protiv datoteka zabilježenih u tabeli SequelizeMeta. Konačno, izvršava sadržaj svih migracijskih datoteka koje nisu pokrenute. Možete koristiti za pokretanje samo pojedinačne migracijske datoteke. Na primjer, za pokretanje samo Migracije datoteka: --name XXXXXXXXXXXXXX-create-task-table.js npx sequelize-cli db:migrate --name XXXXXXXXXXXXXX-create-task-table.js Promjena postojećeg modela Migracije vam omogućuju da bezbedno izvršite promene u shemi baze podataka dok osiguravate integritet podataka, a ako se pojavi potreba, možete bezbedno vratiti promene izvršene u shemi. Na primer, vi ćete napraviti promjenu na Model sheme u API-ju menadžera zadataka. Dodat ćete kolona na shemu. To se može učiniti u sledećim koracima: Task dueDate Kreirajte datoteku migracije pomoću komande migration:generate: npx sequelize-cli migration:generate --name add-dueDate-column Zamijenite sadržaj generirane migracijske datoteke XXXXXXXXXXXX-add-dueDate-column.js sa sljedećim: '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") } }; Dodajte kolonu dueDate u shemu modela zadatka u modelima/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 Želite da se pobrinete da datum dospijeća može da se doda prilikom kreiranja novih zadataka kroz API krajnju tačku. Napravite sledeće promene u logiku kontrolera u 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, }); }); //... Konačno, pokrenite datoteku migracije pomoću komande db:migrate: npx sequelize-cli db:migrate Povratak migracije Migracija baze podataka vam daje mogućnost da bezbedno preokrenete promene napravljene u bazi podataka. Sequelize CLI pruža različite komande koje se mogu koristiti za preokrenuti promene migracije: Možete poništiti najnoviju migraciju pomoću komande db:migrate:undo: npx sequelize-cli db:migrate:undo Možete poništiti sve migracije napravljene i vratiti se u početno stanje pomoću komande db:migrate:undo:all: npx sequelize-cli db:migrate:undo:all Takođe možete koristiti naredbu db:migrate:undo:all da biste se vratili na određenu migraciju tako što ćete prenijeti ime datoteke migracije sa znakom --to flag. Na primjer, da biste se vratili na XXXXXXXXXXXXXX-create-task-table.js migraciju: npx sequelize-cli db:migrate:undo:all --to XXXXXXXXXXXXXX-create-task-table.js Sijanje podataka pomoću Sequelize CLI Database seeding je tehnika popunjavanja vaše baze podataka sa postojećim, često neobičnim podacima, za testiranje ili razvojne svrhe. Sequelize pruža način za sjetvu vaše baze podataka u vašoj Express aplikaciji pomoću sjetva. Seeders su skripti koji vam omogućuju popunjavanje vaše baze podataka uzorkom podataka. U ovom odjeljku ćete naučiti kako generirati datoteke sjemena, pokrenuti sjemena i poništiti sjemena pomoću Sequelize CLI. Kreirajte seedera Da biste kreirali datoteku sjemena, možete koristiti zapovest, prenoseći ime datoteke sjemena na Zapovest čuva generisanu datoteku sjemena u datoteka sjemena ima strukturu sa migracionim datotekama, koristeći istu i U funkcijama. seed:generate --name seeders up down Možete nastaviti da kreirate datoteku sjemena za Task Manager API koji će popuniti tabela sa podacima o uzorku zadatka. Da biste kreirali datoteku, koristite sledeću komandu: Tasks npx sequelize-cli seed:generate --name sample-tasks Ova komanda će stvoriti sledeću datoteku u Poslovni listovi: • O Dosje treba da ima sledeći sadržaj: 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, {}); }, }; Trčanje seoske Da biste izvršili promene u bazi podataka, morate pokrenuti datoteku sjemena. Sequelize CLI pruža Komanda za pokretanje datoteka sjemena. db:seed Da biste pokrenuli sve datoteke sjemena u U nastavku, koristite sledeću komandu: seeders npx sequelize-cli db:seed:all Također možete pokrenuti određenu datoteku sjemena pomoću zastavu i navodeći ime datoteke. Na primjer, da biste pokrenuli samo datoteku sjemena : --seed XXXXXXXXXXXXXX-sample-tasks.js npx sequelize-cli db:seed --seed XXXXXXXXXXXXXX-sample-tasks.js Oporavak semenki Sequelize CLI takođe pruža različite komande koje vraćaju bilo kakve promene napravljene datotekama sjemena: Možete koristiti sledeću komandu da poništite sva sjemena: npx sequelize-cli db:seed:undo:all Možete koristiti sledeću naredbu da poništite određenu datoteku sjemena, na primjer 20250913081512-sample-tasks.js: npx sequelize-cli db:seed:undo --seed 20250913081512-sample-tasks.js Možete koristiti sledeću naredbu za poništavanje najnovijeg sjemena: npx sequelize-cli db:seed:undo Migracije uz Umzug Do sada ste u vodiču koristili alat Sequelize CLI za pokretanje migracija. Ako vam je potrebna veća kontrola nad načinom na koji se migracije izvode i želite ih ručno pokrenuti, možete iskoristiti u biblioteci. Umetnost Umzug je opisan kao: Framework agnostički alat za migraciju za Node.js Framework agnostički alat za migraciju za Node.js Postavite umzug Počnite instaliranjem umzug biblioteke: npm install umzug Kreirajte objekat konfiguracije migratorConfig. Koristite ovaj objekat za konfiguraciju Umzug instance tako što ćete ga proslijediti konstruktoru. Uredi fajl utils/db.js kako slijedi: //... 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, }; // ... U objektu migratorConfig, kažete Sequelize da prati migracije koje su izvršene, tako da funkcija runMigrations ne radi ništa ako nema novih migracijskih datoteka. Dodajte sledeći komad koda u 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), }); }; Kreirajte funkciju undoMigrations koja obnavlja prethodnu migraciju. Dodajte sledeći komad koda u 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), }); }; // ... Na kraju, The Dosje treba da izgleda ovako: 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(); Naši Funkcija mora imati sledeći sadržaj: util/undoMigrations.js const { undoMigrations } = require("./db"); undoMigrations(); Konačno, kreirajte npm skripte u paketu.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" } //... } Upravljanje migracijama uz Umzug Kada koristite Umzug biblioteku za pokretanje migracija, ručno ćete stvoriti migracijske datoteke, kao one stvorene pomoću komande Sequelize CLI Neće raditi migration:generate Na primer, na migracijska datoteka, koja dodaje Kolona za tabela, treba da izgleda ovako kada se izvodi pomoću 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"); }, }; Da biste pokrenuli datoteku migracije, koristite Npm scenarij koji ste postavili u koji se zove Funkcije : migration:up package.json runMigrations npm run migration:up Oporavak migracija uz Umzug Da biste otkazali posljednju migraciju, koristite npm scenarij koji zove Funkcije : migration:down undoMigration npm run migration:down Zaključak Na kraju ovog tutoriala, naučili ste važnost korištenja migracija baza podataka prilikom razvijanja vaših aplikacija. Naučili ste kako koristiti Sequelize CLI za generiranje migracijskih datoteka, izvršavanje migracija i vraćanje promjena napravljenih u bazu podataka. Također ste naučili kako koristiti Sequelize CLI za kreiranje datoteka sjemena kako biste popunili bazu podataka uzoraka. Koda za ovaj tutorial može se naći na . GitHub podrška Da biste saznali više o migracijama baza podataka, posetite sledeće resurse: Sequeliza dokumentacija Uslovi korišćenja GitHub Korišćenje GitHub

Kako upravljati migracijama u Expressu koristeći Sequelize

About Author

KOMENTARI

HANG TAGS

OVAJ ČLANAK JE PREDSTAVLJEN U

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps