pyarango-migrations

Python migration utilities for ArangoDB

CLI Migration Tool

The CLI migration tool is designed to manage and run migration scripts for an Arango database.

Running Migrations for a Single Tenant Database

To run migrations, you can use the run command via poetry or the bin/cli.py script. For example:

poetry run avocado run \
    --host http://localhost:8529 \
    --username root \
    --password password \
    --dbname test_db
# or alternatively
bin/cli.py migration run --password password --dbname test_db

Credentials can also be read from a file using the --credentials-file option. For example:

poetry run avocado run \
    --credentials-file /path/to/creds.json \
    --dbname test_db

The credentials should be a JSON file in the following format:

{
  "username": "root",
  "password": "password"
}

When running the command without specifying a target, it will use the latest record found in the database as the starting point and execute the upgrade method for each migration located in the migrations' directory. For instance, if the latest migration is labeled as "0005", and the migration directory contains "0006," "0007," and "0008," the tool will execute the upgrade method for each migration in sequential order, including "0008."

Specifying a Target Migration

If you want to specify a target version just pass a 4-digit number as an argument. For example:

poetry run avocado run --target 0005

In this case, if the migration was prior to the latest migration, the downgrade method will be invoked for each migration from the latest down to the target.

If the target migration is after the latest migration, the upgrade method will be invoked for each migration from the latest up to and including the target.

It is important to note that the downgrade process is non-inclusive. If the latest migration is "0005", and you specify a target migration of "0001", the tool will stop at "0002". The migration script for "0001" will not be executed. To remove a migration script "0001", you would need to specify a target version of "0000".

Running Migrations for Multiple Tenant Databases

To run migrations for multiple tenant databases, you can use the run-multi command. For example:

bin/cli.py migrate run-multi-tenant --credentials-file ./creds.json --tenants-file ./tenants.json --target 0003

As you can see, the command is an extension of the run with the only requirements being a path to a file containing the database names and another to the credentials.

The tenant file should be a JSON file with the following format:

[
  {
    "databaseName": "dev_db"
  },
  {
    "databaseName": "test_db"
  },
  {
    "databaseName": "prod_db"
  }
]

Creating Migration Scripts

To create a new migration script, you can use the create command followed by a brief description. The tool will automatically generate a migration script filename for you. Here's how to create a migration script: