Schritte zum Hinzufügen einer neuen Spalte mit Sequelize Migrations

In einem Update für meine Blogging-Plattform musste ich eine Spalte mit Miniaturbildern hinzufügen, um die Artikel optisch ansprechender zu gestalten. Dieses Update ging mit einem Wechsel von der Anzeige aller Artikel auf einer einzelnen Seite zur Anzeige jedes Artikels auf einer eigenen Seite einher und verbesserte die Navigation, wenn die Anzahl der Artikel zunahm.

In der Miniaturbildspalte wird eine Zeichenfolge gespeichert, die einen Link zu einem Bild darstellt. Dieser Ansatz hält die Datenbank kompakt und trennt Bedenken, indem die Bildspeicherung an anderer Stelle erfolgt.

Hinzufügen der neuen Spalte zum Modell

Zunächst habe ich das BlogPosts-Modell aktualisiert, um die Miniaturbildspalte einzuschließen. Durch die Einstellung „allowNull: true“ wurde sichergestellt, dass das Hinzufügen eines Miniaturbilds optional war, und es wurden Probleme mit älteren Beiträgen vermieden, die noch kein Miniaturbild hatten:

thumbnail: {
    type: DataTypes.STRING,
    allowNull: true, // Optional for older posts
    },

Diese Modelländerung allein reichte jedoch nicht aus. Die Postgres-Datenbank hat die neue Spalte nicht erkannt und es ist der Fehler aufgetreten:

Fehler: Die Spalte „Miniaturansicht“ existiert nicht

Dies geschieht, weil Sequelize-Modelle definieren, wie die Anwendung mit der Datenbank interagiert, das Datenbankschema jedoch nicht automatisch ändert. Um dieses Problem zu beheben, musste ich eine Sequelize-Migration verwenden.

Sequelize für Migrationen vorbereiten

Bevor ich die Migration erstellte, stellte ich sicher, dass die Sequelize-CLI im Projekt initialisiert wurde. Bevor Sie den folgenden Befehl ausführen, der einen config/-Ordner und das zugehörige Setup erstellt, müssen Sie ihn zuerst installieren, indem Sie npm install sequelize-cli

eingeben

npx sequelize-cli init

Im Ordner config/ habe ich mich für die Verwendung einer config.js-Datei anstelle von config.json entschieden. Dadurch konnte ich Umgebungsvariablen mit dotenv für die Konfiguration verwenden:

require('dotenv').config();

module.exports = {
   development: {
       username: process.env.DB_USER,
       password: process.env.DB_PASSWORD,
       database: process.env.DB_NAME,
       host: process.env.DB_HOST,
       dialect: "postgres",
   },
   production: {
       username: process.env.DB_USER,
       password: process.env.DB_PASSWORD,
       database: process.env.DB_NAME,
       host: process.env.DB_HOST,
       dialect: "postgres",
   },
};

Ich habe dann die Datei config.json entfernt, um Konflikte zu vermeiden.

Generieren der Migrationsdatei

Als nächstes habe ich die Migrationsdatei zum Hinzufügen der Miniaturbildspalte mit dem folgenden Befehl erstellt:

npx sequelize-cli migration:generate --name add-thumbnail-to-blogposts

Dadurch wurde eine neue Datei im Ordner migrations/ erstellt, die etwa einen Namen hat wie:

20241206232526-add-thumbnail-to-blogposts.js

Ich habe diese Datei geändert, um die neue Spalte hinzuzufügen:

module.exports = {
  up: async (queryInterface, Sequelize) => {
      await queryInterface.addColumn('blogposts', 'thumbnail', {
          type: Sequelize.STRING,
          allowNull: true,
      });
  },

  down: async (queryInterface) => {
      await queryInterface.removeColumn('blogposts', 'thumbnail');
  },
};

Anwenden der Migration

Um die Entwicklungsdatenbank zu aktualisieren, habe ich den folgenden Befehl ausgeführt:

npx sequelize-cli db:migrate

Dadurch wurde die Miniaturbildspalte erfolgreich zur Blogpost-Tabelle hinzugefügt, sodass ich Bildlinks für jeden Artikel speichern konnte.

Anwendung der Migration in der Produktion

Für die bereitgestellte Version der Datenbank habe ich die folgenden Schritte ausgeführt:

Backup the Production Database: Before making changes, I downloaded a backup to safeguard against misconfigurations.
Copy the Migration Files: I ensured the updated config.js file and add-thumbnail-to-blogposts.js migration file were present in the server repository.
Set Environment Variables: I verified that the production environment variables required by dotenv were configured correctly. These were set in the Setup Node.js App section of cPanel.
Run the Migration: I navigated to the backend app directory in the production terminal and ran:

npx sequelize-cli db:migrate --env Production

Dadurch wurde die Miniaturbildspalte erfolgreich zur Postgres-Produktionsdatenbank hinzugefügt.

Abschluss

Durch das Hinzufügen der Miniaturbildspalte konnten Bilder für jeden Blogartikel angezeigt werden, wodurch die visuelle Attraktivität und Benutzerfreundlichkeit der Plattform verbessert wurde. Diese Schritte bieten einen strukturierten und wiederholbaren Ansatz zum Hinzufügen neuer Spalten zur Datenbank mithilfe von Sequelize-Migrationen, was für die Aufrechterhaltung der Synchronisierung zwischen den Modellen und der Datenbank von entscheidender Bedeutung ist.

Das obige ist der detaillierte Inhalt vonSchritte zum Hinzufügen einer neuen Spalte mit Sequelize Migrations. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!