Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.igboapi.com/llms.txt

Use this file to discover all available pages before exploring further.

We use migrate-mongo to handle our MongoDB database migrations.
The database has gone through a number of migrations since the beginning of this project. To ensure that local testing data is the same shape as the data in the production MongoDB database, run all MongoDB migration scripts with the following command: 
npm run migrate-up

​
Generate a New Migration script

Globally install migrate-mongo to be able to generate migration scripts. 
npm i -g migrate-mongo

migrate-mongo create <name_of_migration>
Replace <name_of_migration> with the name of your own migration. Remember to use snake case.

​
Structure of MongoDB Migration

Each migration script must include an up and down function that are included in the default exports.
migrations/20201106045436-name-of-migration.js
module.exports = {
  async up(db) {
    // logic to update all relevant collections
  },

  async down(db) {
    // logic to revert updates for all relevant collections
  },
};
Here are all the examples of database migrations for the Igbo API.