Miten käsitellä siirtymiä Expressin avulla Sequelize

Johdatus Projektien kehittämisen aikana on ehkä tehtävä muutoksia alkuperäisiin tietokantajärjestelmiin. Tietokantajärjestelmät määrittelevät tietokannassa tallennettujen tietojen rakenteen. Jos haluat tehdä nämä muutokset tavalla, joka välttää olemassa olevien tietojen menettämisen, sinun on käytettävä tietokannan siirtämistä. Tietokannan siirtäminen on yksinkertaisesti prosessi, jossa versio-ohjatut ja palautettavat muutokset tehdään tietokantajärjestelmiin. Tietokannan siirtäminen mahdollistaa järjestelmien turvallisten muutosten tekemisen ja näiden muutosten palauttamisen tarvittaessa. Tässä opetusohjelmassa opit toteuttamaan tietokantojen siirtämisen Express- ja Postgres-sovelluksessasi. Opit luomaan siirtomatiedostoja, tekemään muutoksia siirtomatiedostoista tietokantaan ja palauttamaan tietokantaan tehdyt muutokset. Opit tekemään kaiken tämän käyttämällä Sequelize Command-Line Interface (CLI) ja Umzug-kirjastoa. Opit myös, miten voit täyttää tietokannasi testeillä tai tyhmillä tiedoilla. Edellytykset Jotta voit seurata tätä opetusohjelmaa, tarvitset seuraavat: 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) Hankkeen asettaminen Jotta artikkeli pysyisi lyhyenä, tämä opetusohjelma perustuu Task Manager API: hen, joka on luotu . Edellinen Tutorial https://hackernoon.com/how-to-connect-an-express-application-to-postgres-using-sequelize?embedable=true Clone the Base Project: Ensimmäinen askel on kloonata Task Manager API -tallennus ja navigoida projektin kansioon: git clone https://github.com/michaelikoko/tasks-manager-api.git cd tasks-manager-api Asenna riippuvuudet: Asenna pakkauksessa package.json luetellut tarvittavat projektiriippuvuudet: npm install Tarkista projektin rakenne: Asennuksen jälkeen projektin rakenteen pitäisi näyttää tältä: Tietokannan asennus: Kuten edellytyksissä on mainittu, varmista, että sinulla on paikallisesti tai etänä käynnissä oleva Postgres-käyttäjä. Luo uusi tietokanta ja tallenna tietokannan yhteyssarja .env-tiedostoon root-kansiossa: PORT=5000 DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase Siirtyminen Sequelize CLI Tässä osiossa opit käsittelemään siirtymiä käyttäen Sequelize Command-Line Interface ( ) Opit, miten voit perustaa , miten voit tehdä ja palauttaa muutoksia kaavioon käyttämällä siirtotiedostoa ja joitakin komentoja, joita käytetään Maahanmuuton käsittelyä varten. sequelize-cli sequelize-cli sequelize-cli Aseta Sequelize CLI Asenna Sequelize CLI pakettien hallinnan avulla: npm install --save-dev sequelize-cli Aseta Sequelize CLI projektissa init-komennolla: npx sequelize-cli init Tämä komento luo tarvittavat kansiot, joita Sequelize CLI vaatii: ja ja ja Jos jokin näistä kansioista on olemassa ennen komennon suorittamista (kuten ), Sequelize CLI ei ylitä niitä, vaan luo puuttuvat. config models migrations seeders models 3. Lopuksi määrität, miten Sequelize CLI muodostaa yhteyden tietokantaan. Oletusarvoisesti Sequelize CLI luo tiedosto, jota voit käyttää, jos haluat koodata tietokannan luottamus. Kuitenkin tässä opetusohjelmassa käytät dynaamista konfigurointia tietokannan URL-osoitteen käyttämiseen, joka tallennetaan ympäristön muuttujana . config/config.json .env Konfig-kansiossa poista config.json ja luo config.js seuraavalla sisällöllä: require('dotenv').config(); const {DATABASE_URL} = require('../utils/config'); module.exports = { development: { url: DATABASE_URL, dialect: 'postgres', seederStorage: "sequelize", seederStorageTableName: "SequelizeData" } }; Yksinkertaisuuden vuoksi tässä opetusohjelmassa keskityt vain kehitysympäristöön. Sinun on annettava polku config.js:ään Sequelize CLI:hen. Luo projektin juurisovelluksessa .sequelizerc-konfiguratiedosto seuraavalla sisällö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'), }; Maahanmuuttotiedostojen luominen Nyt kun olet määrittänyt Sequelize CLI:n, voit luoda ensimmäisen siirtotiedoston Sequelize on JavaScript-tiedosto, joka ohjaa siirtymien toteuttamista ja palauttamista. Tyypillisessä siirtymätiedostossa voit viedä kaksi toimintoa: 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 Molemmat ovat ja Funktioilla on kaksi parametriä: up down QueryInterface: QueryInterface-objekti on yleensä ensimmäinen parametri. Objektti on QueryInterface-luokan instanssi. QueryInterface sisältää menetelmiä, joita Sequelize käyttää kommunikoimaan tietokantojen kanssa. : 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-objekti on yleensä toinen parametri, ja se sisältää kaikki annetut tietotyypit, kuten STRING, INTEGER, BOOLEAN ja niin edelleen. Voit käyttää siirtäminen:generoi -komentoa siirtodateen luomiseen, joka tallennetaan siirtokorttiin. npx sequelize-cli migration:generate --name create-task-table Vaihda äskettäin luodun siirtotiedoston sisältö: ja seuraavan kanssa: 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"); }, }; Sillä Maahanmuuttoviraston tehtävänä on luoda tietokannassa olevassa tietokannassa, jossa Toiminto, jonka avulla voit käyttää Tietokannan luomiseen käytetään tietokannan nimeä ( ), ja taulukon ominaisuuksien objekti (samanlainen kuin mallin määritteleminen Sequelize). Jos haluat kääntää muutokset, jotka tämä siirtotiedosto on tehnyt, Toiminto, jonka avulla voit käyttää Menetelmä poistaa Taulukko tietokannasta. XXXXXXXXXXXXXX-create-task-table.js Task up queryInterface.createTable Task down queryInterface.dropTable Task Juokseva maahanmuutto Siirtotiedostot on suoritettava tietokannan muutosten suorittamiseksi. Voit tehdä sen käyttämällä Käskyjä : db:migrate npx sequelize-cli db:migrate Sillä Komento tekee seuraavaa: db:migrate Ensinnäkin se luo taulukon nimeltä SequelizeMeta tietokannassa, jos sitä ei ole. Sequelize CLI käyttää SequelizeMeta-taulukkoa pitämään kirjaa tietokannassa suoritetuista siirtymistä. Toiseksi se etsii minkä tahansa muuttoliikennetiedoston, jota ei ole suoritettu.Tämä määritetään tarkistamalla muuttoliikennetiedostot muuttoliikennetiedostossa SequelizeMeta-taulukossa tallennettuja tiedostoja vastaan. Lopuksi se suorittaa sisällön kaikkiin muuttoliikennetiedostoihin, joita ei ole suoritettu. Voit käyttää sitä käytettäväksi ainoastaan yksittäisen siirtotiedoston avulla. Esimerkiksi vain Maahanmuuttoviraston tiedosto: --name XXXXXXXXXXXXXX-create-task-table.js npx sequelize-cli db:migrate --name XXXXXXXXXXXXXX-create-task-table.js Olemassa olevan mallin muuttaminen Siirtymien käytön merkitys loistaa silloin, kun joudut tekemään muutoksia olemassa olevan tietokantamallin kaavioon. Siirtymät mahdollistavat tietokantamallin turvallisten muutosten tekemisen samalla kun varmistetaan tietojen eheys. Esimerkiksi sinä aiot tehdä muutoksen Task Manager API -sovelluksen avulla voit lisätä Valitse ohjelma.Tämä voidaan tehdä seuraavissa vaiheissa: Task dueDate Siirtotiedoston luominen käyttäen migration:generate -komentoa: npx sequelize-cli migration:generate --name add-dueDate-column Vaihda luodun siirtymätiedoston XXXXXXXXXXXX-add-dueDate-column.js sisältö seuraavasti: '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") } }; Lisää dueDate-sarakkeen Task-mallin kaavioon mallit/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 Haluat varmistaa, että vanhentumispäivämäärä voidaan lisätä, kun luot uusia tehtäviä API:n päätepisteen kautta. Tee seuraavat muutokset index.js:n ohjaimen logiikkaan: //... 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, }); }); //... Lopuksi suorita siirtotiedosto käyttämällä db:migrate -komentoa: npx sequelize-cli db:migrate Maahanmuutto palautetaan Tietokannan siirtäminen antaa sinulle mahdollisuuden palauttaa tietokantaan tehdyt muutokset turvallisesti. Sequelize CLI tarjoaa useita komentoja, joita voidaan käyttää siirtymän muutosten palauttamiseen: Voit peruuttaa viimeisimmän siirtymän db:migrate:undo-komennolla: npx sequelize-cli db:migrate:undo Voit peruuttaa kaikki siirtymät ja palata alkuperäiseen tilaan db:migrate:undo:all-komennolla: npx sequelize-cli db:migrate:undo:all Voit myös käyttää db:migrate:undo:all -komentoa palauttamaan tietyn siirtymän siirtämällä siirtymätiedoston nimen merkinnällä --to flag. Esimerkiksi palataksesi XXXXXXXXXXXX-create-task-table.js -siirtymään: npx sequelize-cli db:migrate:undo:all --to XXXXXXXXXXXXXX-create-task-table.js Siementiedot Sequelize CLI:llä Tietokannan kylvö on tekniikka, jolla tietokanta täyttyy olemassa olevilla, usein tyhjillä tiedoilla testausta tai kehittämistä varten. Sequelize tarjoaa tavan kylvää tietokantaasi Express-sovelluksessasi kylvölaitteiden avulla. Tässä osiossa opit, miten voit luoda siementiedostoja, ajaa siemeniä ja poistaa siemeniä Sequelize CLI: n avulla. Luo siemenet Jos haluat luoda siementiedoston, voit käyttää komento, siirtämällä siementiedoston nimi Käsky tallentaa luodun siementiedoston Siementiedostolla on rakenne, jossa on siirtotiedostot, käyttämällä samaa ja ja funktioita. seed:generate --name seeders up down Voit luoda Task Manager API:lle siementiedoston, joka täyttää Taulukko, jossa on näytteitä tehtävätiedoista. Voit luoda tiedoston käyttämällä seuraavaa komentoa: Tasks npx sequelize-cli seed:generate --name sample-tasks Tämä komento luo seuraavan tiedoston Käsikirjoitukset : • The Tiedostolla tulee olla seuraava sisältö: 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, {}); }, }; Juoksevat siemenet Jotta voit tehdä muutoksia tietokantaan, sinun on suoritettava siementiedosto. Sequelize CLI tarjoaa Käynnistä seed files. db:seed Jos haluat ajaa kaikki siementiedostot Tällöin käytät seuraavaa komentoa: seeders npx sequelize-cli db:seed:all Voit myös ajaa tietyn siementiedoston käyttämällä lippu ja määrittää tiedoston nimen. Esimerkiksi vain siementiedoston suorittamiseksi : --seed XXXXXXXXXXXXXX-sample-tasks.js npx sequelize-cli db:seed --seed XXXXXXXXXXXXXX-sample-tasks.js Takaisin siemenet Sequelize CLI tarjoaa myös erilaisia komentoja, jotka palauttavat siementiedostojen tekemät muutokset: Voit käyttää seuraavaa komentoa poistamaan kaikki siemenet: npx sequelize-cli db:seed:undo:all Voit poistaa tietyn siementiedoston seuraavalla komennolla, esimerkiksi 20250913081512-sample-tasks.js: npx sequelize-cli db:seed:undo --seed 20250913081512-sample-tasks.js Voit käyttää seuraavaa komentoa viimeisimmän siementen poistamiseen: npx sequelize-cli db:seed:undo Maahanmuutto umzugin avulla Tähän mennessä opetusohjelmassa olet käyttänyt Sequelize CLI -työkalua siirtymien suorittamiseen.Jos tarvitset enemmän valvontaa siitä, miten siirtymät suoritetaan ja haluat suorittaa ne manuaalisesti, voit käyttää Kirjastossa on Hemmottelu Umzug on kuvattu seuraavasti: Framework agnostinen siirtotyökalu Node.js Framework agnostinen siirtotyökalu Node.js Aseta umzug Aloita asentamalla umzug-kirjasto: npm install umzug Luo migratorConfig-konfiguration-objekti. Voit käyttää tätä objektia määrittelemällä Umzug-istunnon siirtämällä sen rakentajalle. Muokkaa utils/db.js-tiedostoa seuraavasti: //... 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, }; // ... Luo runMigrations-toiminto. Se suorittaa siirtymät siirtymatiedostoihin, jotka löytyvät siirtymät-kansiosta. MigratorConfig-objektissa pyydät Sequelize-ohjelmaa seuraamaan suoritettuja siirtymiä, joten runMigrations-toiminto ei tee mitään, jos uusia siirtymatiedostoja ei ole. Lisää seuraava koodi 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), }); }; Luo funktio undoMigrations, joka kääntää edellisen siirtymän. Lisää seuraava koodi 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), }); }; // ... Lopuksi, The Tiedoston pitäisi näyttää tältä: 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(); Sillä Toiminnolla tulee olla seuraava sisältö: util/undoMigrations.js const { undoMigrations } = require("./db"); undoMigrations(); Lopuksi luo npm-skriptejä package.jsonissa: { //... "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" } //... } Suorita muuttoliikkeitä Umzugilla Kun käytät Umzug-kirjastoa siirtymien suorittamiseen, luot siirtymätiedostot manuaalisesti, kuten ne, jotka on luotu käyttäen Sequelize CLI -komentoa. Ei tule toimimaan. migration:generate Esimerkiksi The Maahanmuuttoviraston tiedosto, joka sisältää Kolumni on taulukko, pitäisi näyttää tältä, kun se suoritetaan käyttämällä 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"); }, }; Jos haluat siirtää tiedoston, käytä NPM-skripti, jonka olet asentanut joka kutsuu sitä Toiminnot : migration:up package.json runMigrations npm run migration:up Muuttoliikkeen palauttaminen Umzugin avulla Jos haluat poistaa viimeisen siirtymän, käytät NPM-skripti, joka kutsuu Toiminnot : migration:down undoMigration npm run migration:down Johtopäätös Tämän opetusohjelman lopussa opit tietokantojen siirtämisen käytön tärkeyden sovellusten kehittämisessä. Opit käyttämään Sequelize CLI: tä siirtorekisteritiedostojen luomiseen, siirtymien suorittamiseen ja tietokantaan tehtyjen muutosten palauttamiseen. Opit myös käyttämään Sequelize CLI: tä siementiedostojen luomiseen, jotta tietokanta täyttyy näytteillä olevilla tiedoilla. Tämän tutorialin koodi löytyy . Githubissa Jos haluat lisätietoja tietokannan siirtämisestä, käy seuraavissa resursseissa: Sequelize dokumentaatio Käytä GitHubia Lähde GitHub