Migrations for schema changes in Express - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a migration in the context of database schema changes?

A migration is a set of instructions that change the database structure, like adding or removing tables or columns, to keep the database in sync with the application code.

beginner

Why are migrations important in Express applications?

Migrations help manage database changes safely and consistently, allowing developers to update the schema without losing data or causing errors.

intermediate

Name a popular tool used with Express for managing migrations.

Sequelize CLI is a popular tool that helps create, run, and undo migrations in Express apps using Sequelize ORM.

intermediate

What does the 'up' function do in a migration file?

The 'up' function defines the changes to apply to the database schema, like creating tables or adding columns.

intermediate

How does the 'down' function in a migration file help during development?

The 'down' function reverses the changes made by the 'up' function, allowing you to undo migrations if needed.

What is the main purpose of a migration in Express apps?

A To style the application

B To write frontend code

C To update the database schema safely

D To handle user authentication

Migrations are used to update the database schema safely and consistently.

Which tool is commonly used with Express for migrations?

A Sequelize CLI

B React Router

C Webpack

D Express Generator

Sequelize CLI is a popular tool for managing migrations in Express apps using Sequelize.

What does the 'up' function in a migration file do?

A Handles user input

B Reverts schema changes

C Runs server code

D Applies schema changes

The 'up' function applies schema changes like creating or modifying tables.

What is the role of the 'down' function in migrations?

A To apply new schema changes

B To undo schema changes

C To start the Express server

D To connect to the database

The 'down' function undoes the changes made by the 'up' function.

Why should migrations be used instead of manual database changes?

A They keep schema changes consistent and reversible

B They are faster to write

C They improve frontend performance

D They replace the need for a database

Migrations keep schema changes consistent, trackable, and reversible, avoiding errors.

Explain what a migration is and why it is useful in Express applications.

Think about how you change your database structure without breaking your app.

Describe the roles of the 'up' and 'down' functions in a migration file.

One function moves forward, the other moves backward.

Practice

1. What is the main purpose of migrations in an Express app using a database?

easy

A. To create API routes for the app

B. To handle user authentication automatically

C. To manage and apply database schema changes step-by-step

D. To serve static files like images and CSS

Solution

1. Step 1: Understand migrations role

   Migrations help track and apply changes to the database schema in a controlled way.

2. Step 2: Compare other options

   Options A, B, and C relate to other app features, not schema changes.

3. Final Answer:

   To manage and apply database schema changes step-by-step -> Option C

4. Quick Check:

   Migrations = Manage schema changes [OK]

Hint: Migrations = step-by-step database structure updates [OK]

Common Mistakes:

• Confusing migrations with routing or middleware
• Thinking migrations handle user login
• Assuming migrations serve static files

2. Which of the following is the correct command to create a new migration file using a common migration tool like Sequelize CLI?

easy

A. sequelize new migration add-users-table

B. sequelize migrate new add-users-table

C. sequelize create migration add-users-table

D. sequelize migration:create --name add-users-table

Solution

1. Step 1: Recall Sequelize CLI syntax

   The correct command to create a migration is sequelize migration:create --name <name>.

2. Step 2: Check other options

   Options B, C, and D use incorrect command structures not recognized by Sequelize CLI.

3. Final Answer:

   sequelize migration:create --name add-users-table -> Option D

4. Quick Check:

   Correct CLI command = sequelize migration:create --name add-users-table [OK]

Hint: Use 'migration:create --name' to create migration files [OK]

Common Mistakes:

• Mixing up command order or keywords
• Omitting '--name' flag
• Using 'new' instead of 'create'

3. Given this migration snippet using Sequelize:

module.exports = {
  up: async (queryInterface, Sequelize) => {
    await queryInterface.addColumn('Users', 'age', { type: Sequelize.INTEGER });
  },
  down: async (queryInterface) => {
    await queryInterface.removeColumn('Users', 'age');
  }
};

What will happen when this migration is run?

medium

A. Creates a new 'Users' table with an 'age' column

B. Adds an 'age' column of type INTEGER to the 'Users' table

C. Removes the 'age' column from the 'Users' table

D. Throws an error because 'down' is missing Sequelize parameter

Solution

1. Step 1: Analyze the 'up' function

   The 'up' function adds a new column 'age' of type INTEGER to the 'Users' table.

2. Step 2: Understand the 'down' function

   The 'down' function reverses this by removing the 'age' column, but this runs only on rollback.

3. Final Answer:

   Adds an 'age' column of type INTEGER to the 'Users' table -> Option B

4. Quick Check:

   'up' adds column, 'down' removes column [OK]

Hint: 'up' applies changes, 'down' reverts them [OK]

Common Mistakes:

• Confusing 'up' and 'down' functions
• Assuming 'down' runs on migration
• Thinking it creates a new table

4. You wrote this migration to rename a column but it throws an error:

module.exports = {
  up: async (queryInterface) => {
    await queryInterface.renameColumn('Users', 'username', 'user_name');
  },
  down: async (queryInterface) => {
    await queryInterface.renameColumn('Users', 'user_name', 'username');
  }
};

What is the most likely cause of the error?

medium

A. The table name 'Users' is incorrect or does not exist

B. Missing Sequelize parameter in the functions

C. renameColumn requires the column type as a third argument

D. The migration file name is invalid

Solution

1. Step 1: Check renameColumn usage

   renameColumn needs correct table and column names; no type argument is needed.

2. Step 2: Consider error causes

   If the table 'Users' does not exist or is misnamed, renameColumn will fail.

3. Final Answer:

   The table name 'Users' is incorrect or does not exist -> Option A

4. Quick Check:

   Table name must exist for renameColumn [OK]

Hint: Check table and column names exist before renaming [OK]

Common Mistakes:

• Assuming renameColumn needs column type
• Ignoring table name case sensitivity
• Forgetting to verify table existence

5. You want to add a new column 'email' to the 'Users' table but only if it doesn't already exist, to avoid errors during migration. Which approach best handles this in an Express app migration?

hard

A. Use a raw SQL query inside the migration to check column existence before adding

B. Directly add the column without checks; rely on migration rollback if error occurs

C. Modify the model only and skip migration since model syncs automatically

D. Delete the 'Users' table first, then add the column

Solution

1. Step 1: Understand migration safety

   Adding a column without checking can cause errors if it exists already.

2. Step 2: Use raw SQL for conditional check

   Running a raw SQL query to check if the column exists before adding prevents errors.

3. Step 3: Evaluate other options

   Directly add the column without checks; rely on migration rollback if error occurs risks errors, C ignores migration purpose, D is destructive and unsafe.

4. Final Answer:

   Use a raw SQL query inside the migration to check column existence before adding -> Option A

5. Quick Check:

   Check column first with SQL to avoid errors [OK]

Hint: Check column existence with SQL before adding [OK]

Common Mistakes:

• Skipping existence check causing migration failure
• Relying only on model sync without migration
• Dropping tables unnecessarily