docker

How to use Docker with a database migration tool?

Dylan

Dylan

— 3 min read
How to use Docker with a database migration tool?

Hey there, tech wizards and code enthusiasts! 🧙‍♂️ Today, we're diving into the exciting world of Docker and database migrations. If you've ever wondered how to make your database migrations as smooth as butter, then you've come to the right place. Let's get our hands dirty and make some magic happen! 🌟

What is Docker? 🐳

Before we dive into the nitty-gritty, let's quickly recap what Docker is. Docker is a platform that allows you to develop, ship, and run applications in containers. Containers are lightweight, portable, and self-sufficient, making them perfect for deploying applications consistently across different environments.

Why Use Docker with Database Migrations? 🤔

Database migrations can be a tricky business. They involve updating your database schema, which can lead to downtime, errors, and sometimes, even data loss. But fear not! Docker can help you manage these migrations more efficiently by providing a consistent environment for your application and its dependencies, including your database.

Setting Up Docker 🛠️

First things first, you need to have Docker installed on your machine. You can download it from the official Docker website. Once you've got Docker up and running, let's create a simple Dockerfile for our application.

# Dockerfile
FROM node:14

# Create and set work directory
WORKDIR /usr/src/app

# Copy package.json and install dependencies
COPY package.json ./
RUN npm install

# Copy the rest of the app
COPY . .

# Expose the port the app runs on
EXPOSE 3000

# Command to run the app
CMD ["node", "app.js"]

This Dockerfile sets up a Node.js application, but you can modify it to suit your specific needs.

Integrating a Database Migration Tool 🔄

Now, let's integrate a database migration tool. For this example, we'll use Sequelize, a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite, and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication, and more.

First, install Sequelize and a CLI for migrations:

npm install sequelize sequelize-cli --save-dev

Next, initialize Sequelize CLI:

npx sequelize-cli init

This command will create a migrations folder where you'll store your migration scripts.

Creating a Migration 📝

Let's create a simple migration to add a new table to our database. Run the following command:

npx sequelize-cli migration:generate --name create-user

This will create a new migration file in the migrations folder. Open the file and define your table schema:

'use strict';

module.exports = {
  async up (queryInterface, Sequelize) {
    await queryInterface.createTable('Users', {
      id: {
        allowNull: false,
        autoIncrement: true,
        primaryKey: true,
        type: Sequelize.INTEGER
      },
      username: {
        type: Sequelize.STRING
      },
      createdAt: {
        allowNull: false,
        type: Sequelize.DATE
      },
      updatedAt: {
        allowNull: false,
        type: Sequelize.DATE
      }
    });
  },

  async down (queryInterface, Sequelize) {
    await queryInterface.dropTable('Users');
  }
};

Running Migrations in Docker 🏃‍♂️

Now that we have our migration script ready, let's run it inside a Docker container. First, make sure your package.json has a script to run migrations:

"scripts": {
  "migrate": "sequelize db:migrate"
}

Now, run your migration using Docker:

docker build -t my-app .
docker run --rm my-app npm run migrate

This will build your Docker image and run the migration script inside a container, ensuring that your database schema is updated consistently across different environments.

Handling Database Connections in Docker 🔌

To connect to your database, you'll need to pass the database credentials to your application running inside the Docker container. You can use environment variables for this purpose. Update your docker-compose.yml to include the database credentials:

version: '3'
services:
  app:
    build: .
    environment:
      - DATABASE_HOST=db
      - DATABASE_USER=user
      - DATABASE_PASSWORD=password
    depends_on:
      - db
  db:
    image: postgres:latest
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
    ports:
      - "5432:5432"

This docker-compose.yml file defines two services: app and db. The app service depends on the db service, ensuring that the database is up and running before the application starts.

Conclusion 🎉

And there you have it! You now know how to use Docker with a database migration tool to make your database migrations smooth and consistent. By containerizing your application and its dependencies, you can ensure that your migrations run the same way in development, staging, and production environments. Happy coding, and may your migrations always be successful! 🌈

Remember, if you have any questions or need further assistance, the Docker and Sequelize communities are always ready to help. Keep calm and code on! 💻👨‍💻👩‍💻

Read more