Setting up Migrations

Author: mohammadnazm

reminder.txt

@@ -23,3 +23,31 @@ nest g class coffees/dto/create-coffee.dto --no-spec
 
 /* Generate Entity Class */
 nest g class coffees/entities/flavor.entity --no-spec
+
+
+// Creating a TypeOrm Migration
+npx typeorm migration:create src/migrations/CoffeeRefactor
+// CoffeeRefactor being the NAME we are giving "this" migration
+
+
+/* RUNNING MIGRATIONS */
+
+/**
+ * 💡 Remember 💡
+ * You must BUILD your Nest project (so that everything is output to the `/dist/` folder,
+ * before a Migration can run, it needs compilated files.
+ */
+ 
+// Compile project first 
+npm run build
+
+// Run migration(s) 
+npx typeorm migration:run -d dist/typeorm-cli.config
+
+// REVERT migration(s)
+npx typeorm migration:revert -d dist/typeorm-cli.config
+
+// Let TypeOrm generate migrations (for you)
+npx typeorm migration:generate src/migrations/SchemaSync -d dist/typeorm-cli.config
+
+

src/coffees/entities/coffee.entity.ts

@@ -13,11 +13,14 @@ export class Coffee {
   id: number;
 
   @Column()
-  name: string;
+  title: string;
 
   @Column()
   brand: string;
 
+  @Column({ nullable: true })
+  description: string;
+
   @Column({ default: 0 })
   recommendations: number;
 

src/events/entities/event.entity.ts

@@ -1,16 +1,18 @@
-import { Column, Entity, PrimaryGeneratedColumn } from "typeorm";
+import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm';
 
+@Index(['name', 'type'])
 @Entity()
 export class Event {
-    @PrimaryGeneratedColumn()
-    id: number;
+  @PrimaryGeneratedColumn()
+  id: number;
 
-    @Column()
-    type: string;
+  @Column()
+  type: string;
 
-    @Column()
-    name: string;
+  @Index()
+  @Column()
+  name: string;
 
-    @Column('json')
-    payload: Record<string, any>;
+  @Column('json')
+  payload: Record<string, any>;
 }

src/migrations/1675676028883-CoffeeRefactor.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class CoffeeRefactor1675676028883 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<any> {
+    await queryRunner.query(
+      `ALTER TABLE "coffee" RENAME COLUMN "name" TO "title"`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<any> {
+    await queryRunner.query(
+      `ALTER TABLE "coffee" RENAME COLUMN "title" TO "name"`,
+    );
+  }
+}

src/migrations/1675678328747-SchemaSync.ts

@@ -0,0 +1,16 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class SchemaSync1675678328747 implements MigrationInterface {
+    name = 'SchemaSync1675678328747'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "coffee" ADD "description" character varying`);
+        await queryRunner.query(`ALTER TABLE "coffee" ADD "recommendations" integer NOT NULL DEFAULT '0'`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "coffee" DROP COLUMN "recommendations"`);
+        await queryRunner.query(`ALTER TABLE "coffee" DROP COLUMN "description"`);
+    }
+
+}

typeorm-cli.config.ts

@@ -0,0 +1,16 @@
+import { Coffee } from 'src/coffees/entities/coffee.entity';
+import { Flavor } from 'src/coffees/entities/flavor.entity';
+import { CoffeeRefactor1675676028883 } from 'src/migrations/1675676028883-CoffeeRefactor';
+import { SchemaSync1675678328747 } from 'src/migrations/1675678328747-SchemaSync';
+import { DataSource } from 'typeorm';
+
+export default new DataSource({
+  type: 'postgres',
+  host: 'localhost',
+  port: 5432,
+  username: 'postgres',
+  password: 'admin',
+  database: 'iluvcoffee',
+  entities: [Coffee, Flavor],
+  migrations: [CoffeeRefactor1675676028883, SchemaSync1675678328747],
+});