Mongo Migrate

https://pypi.org/project/mongo-migrate/
Admin
A Python package for seamless MongoDB schema migrations with support for migration creation,...
Tokens:2,464
Snippets:36
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install mongo-migrate

Source: https://pypi.org/project/mongo-migrate

Install the mongo-migrate package using pip. This is the first step to using the library.

```bash
pip install mongo-migrate
```

--------------------------------

### Example: Upgrade Database

Source: https://pypi.org/project/mongo-migrate

An example command to upgrade the database to a specific migration timestamp, including host, port, and database name.

```bash
mongo-migrate upgrade --host 127.0.0.1 --port 27017 --database test --upto 20230815092813
```

--------------------------------

### Example: Create Migration

Source: https://pypi.org/project/mongo-migrate

An example command to create a new migration, specifying host, port, database, and a descriptive message.

```bash
mongo-migrate create --host 127.0.0.1 --port 27017 --database test --message 'first migration'
```

--------------------------------

### Install mongo-migrate

Source: https://pypi.org/project/mongo-migrate/0.1.2

Install the mongo-migrate library using pip. It is recommended to specify the version for consistent environments.

```bash
pip install mongo-migrate==0.1.2
```

--------------------------------

### Create New Migration

Source: https://pypi.org/project/mongo-migrate/0.1.2

Command to create a new migration file. Requires database connection details and a message describing the migration.

```bash
usage: mongo-migrate create [-h] [--host HOST] [--port PORT] [--database DATABASE] [--migrations MIGRATIONS] [--title TITLE] --message MESSAGE

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           the database host
  --port PORT           the database port
  --database DATABASE   provide the database name
  --migrations MIGRATIONS
                        provide the folder to store migrations
  --title TITLE         title will be used in the file name
  --message MESSAGE     message will be recorded as a comment inside the migration file
```

```bash
mongo-migrate create --host 127.0.0.1 --port 27017 --database test --message 'first migration'
```

--------------------------------

### Create New Migration Command

Source: https://pypi.org/project/mongo-migrate

Command to create a new migration file. Requires database connection details and a message for the migration.

```bash
usage: mongo-migrate create [-h] [--host HOST] [--port PORT] [--database DATABASE] [--migrations MIGRATIONS] [--title TITLE] --message MESSAGE

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           the database host
  --port PORT           the database port
  --database DATABASE   provide the database name
  --migrations MIGRATIONS
                        provide the folder to store migrations
  --title TITLE         title will be used in the file name
  --message MESSAGE     message will be recorded as a comment inside the migration file
```

--------------------------------

### mongo-migrate CLI Usage

Source: https://pypi.org/project/mongo-migrate

The main command-line interface for mongo-migrate, offering subcommands for migration management.

```bash
usage: mongo-migrate [-h] {create,upgrade,downgrade} ...

positional arguments:
  {create, upgrade, downgrade}
    create              create a new migration
    upgrade             upgrade the database to the specific migration
    downgrade           downgrade the database to the specific migration

optional arguments:
  -h, --help            show this help message and exit
```

--------------------------------

### Upgrade Database Command

Source: https://pypi.org/project/mongo-migrate

Command to upgrade the database to a specific migration version. Requires connection details and optionally a target migration timestamp.

```bash
usage: mongo-migrate upgrade [-h] [--host HOST] [--port PORT] [--database DATABASE] [--migrations MIGRATIONS] [--upto UPTO]

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           the database host
  --port PORT           the database port
  --database DATABASE   provide the database name
  --migrations MIGRATIONS
                        provide the folder to store migrations
  --upto UPTO           target migration timestamp
```

--------------------------------

### Upgrade Database Migration

Source: https://pypi.org/project/mongo-migrate/0.1.2

Command to upgrade the database to a specific migration version. Requires database connection details and the target migration timestamp.

```bash
usage: mongo-migrate upgrade [-h] [--host HOST] [--port PORT] [--database DATABASE] [--migrations MIGRATIONS] [--upto UPTO]

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           the database host
  --port PORT           the database port
  --database DATABASE   provide the database name
  --migrations MIGRATIONS
                        provide the folder to store migrations
  --upto UPTO           target migration timestamp
```

```bash
mongo-migrate upgrade --host 127.0.0.1 --port 27017 --database test --upto 20230815092813
```

--------------------------------

### Downgrade Database Command

Source: https://pypi.org/project/mongo-migrate

Use this command to downgrade your database to a specific migration timestamp. Ensure you provide the correct host, port, database name, and migration folder.

```bash
usage: mongo-migrate downgrade [-h] [--host HOST] [--port PORT] [--database DATABASE] [--migrations MIGRATIONS] [--upto UPTO]

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           the database host
  --port PORT           the database port
  --database DATABASE   provide the database name
  --migrations MIGRATIONS
                        provide the folder to store migrations
  --upto UPTO           target migration timestamp

```

```bash
mongo-migrate downgrade --host 127.0.0.1 --port 27017 --database test --upto 20230815092813

```

--------------------------------

### Downgrade Database Command

Source: https://pypi.org/project/mongo-migrate/0.1.2

Use this command to downgrade your database to a specific migration timestamp. Ensure the database host, port, and name are correctly specified.

```bash
usage: mongo-migrate downgrade [-h] [--host HOST] [--port PORT] [--database DATABASE] [--migrations MIGRATIONS] [--upto UPTO]

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           the database host
  --port PORT           the database port
  --database DATABASE   provide the database name
  --migrations MIGRATIONS
                        provide the folder to store migrations
  --upto UPTO           target migration timestamp
```

```bash
mongo-migrate downgrade --host 127.0.0.1 --port 27017 --database test --upto 20230815092813
```
Tokens:
Raw