Database Makefile Usage Guide

This Makefile provides essential Liquibase database migration management for the Composio Hermes project using TypeScript-based migrations with Bun.

Prerequisites

• Bun: Required for running TypeScript migrations
• Environment Variables: DATABASE_URL and THERMOS_DATABASE_URL must be set

Quick Start

1. Install Liquibase:

   make install

2. Set environment variables:

   export DATABASE_URL="postgresql://postgres:postgres@localhost:5432/pocdb"
   export THERMOS_DATABASE_URL="postgresql://postgres:postgres@localhost:5432/pocdb"

3. Run migrations:

   make migrate

4. Check status:

   make status

Available Commands

Installation

• make install - Install Liquibase (via Homebrew on macOS)

Migration Management

• make migrate - Run all pending migrations (append-only — always applies every pending changeset)
• make rollback - Rollback last migration
• make rollback COUNT=3 - Rollback 3 migrations
• make rollback-to-tag TAG=tagname - Rollback to specific tag (for incident recovery)

Note: There is no migrate-to-tag command. Forward migration is always append-only to ensure all environments converge to the same schema state.

Design Context & Resources

Slack Discussions

• Soft-delete middleware removal discussion - PR review on removing Prisma soft-delete middleware
• Migration troubleshooting - Discussion on Prisma migration errors and foreign key constraints

Notion Documentation

• Database Schema - Main schema documentation
• Evaluating database migration tools - RFC comparing migration approaches

Related Documentation

• See CLAUDE.md in this directory for AI assistant context
• See /packages/lib/README.md for encryption utilities used with credentials