ts-migrate-mongoose

import mongoose from 'mongoose'; import { Migrate, IMigration } from 'ts-migrate-mongoose'; // 1. Define your migration class implementing IMigration class AddTimestampToUsers implements IMigration { async up(): Promise<void> { console.log('Running up migration: AddTimestampToUsers'); // Example: Add a 'createdAt' and 'updatedAt' field to existing user documents await mongoose.connection.db.collection('users').updateMany( {}, // Filter for all documents { $set: { createdAt: new Date(), updatedAt: new Date() } }, // Add new fields { upsert: false } // Do not create new documents if no match ); console.log('Migration AddTimestampToUsers (up) completed.'); } async down(): Promise<void> { console.log('Running down migration: AddTimestampToUsers'); // Example: Remove the 'createdAt' and 'updatedAt' fields from user documents await mongoose.connection.db.collection('users').updateMany( {}, // Filter for all documents { $unset: { createdAt: '', updatedAt: '' } } // Remove fields ); console.log('Migration AddTimestampToUsers (down) completed.'); } } async function main() { // 2. Connect to MongoDB using Mongoose const mongoUri = process.env.MONGO_URI ?? 'mongodb://localhost:27017/my_ts_migrate_db'; await mongoose.connect(mongoUri); console.log('Connected to MongoDB.'); // 3. Initialize the Migrate runner with configuration const migrator = new Migrate({ migrationsPath: './migrations', // Directory where migration files are located (e.g., compiled JS files) uri: mongoUri, collectionName: 'migrations_log', // Collection to track applied migrations // Other options like `templatePath`, `compilerOptions`, etc. }); // In a real application, you would create a migration file (e.g., `migrations/20231027120000-add-timestamp-to-users.ts`) // and `migrator.up()` or `migrator.down()` would discover and run it. // For this quickstart, we'll demonstrate the core logic by manually running the `up` method. console.log('\n--- Simulating a migration UP run ---'); const tempMigrationInstance = new AddTimestampToUsers(); await tempMigrationInstance.up(); console.log('Simulated UP migration complete. (In a real scenario, this would be tracked by the migrator.)\n'); // To run all pending migrations (requires migration files in `migrationsPath`) // await migrator.up(); // console.log('All pending migrations (up) completed.'); // To run all migrations down // await migrator.down(); // console.log('All migrations (down) completed.'); // 4. Disconnect from MongoDB await mongoose.disconnect(); console.log('Disconnected from MongoDB.'); } main().catch(console.error);