|
| 1 | +# Getting Started with the Database Migration Assessment (DMA) Collector |
| 2 | + |
| 3 | +These instructions will guide you through setting up and running the DMA collector using the Python CLI. |
| 4 | + |
| 5 | +## Verify Python Version |
| 6 | + |
| 7 | +The DMA collector requires Python 3.9 or higher. Check your Python version by opening a terminal and running: |
| 8 | + |
| 9 | +```bash |
| 10 | +python3 --version |
| 11 | +``` |
| 12 | + |
| 13 | +If your Python version is lower than 3.9, you'll need to install a compatible version. |
| 14 | + |
| 15 | +## Create a Virtual Environment (Recommended) |
| 16 | + |
| 17 | +A virtual environment isolates the DMA collector's dependencies from other Python projects. This prevents conflicts and ensures a consistent environment. |
| 18 | + |
| 19 | +### Create the virtual environment |
| 20 | + |
| 21 | +To create the new virtual environment. |
| 22 | + |
| 23 | +```bash |
| 24 | +python3 -m venv .venv |
| 25 | +``` |
| 26 | + |
| 27 | +Activate the virtual environment by running: |
| 28 | + |
| 29 | +```bash |
| 30 | +source .venv/bin/activate |
| 31 | +``` |
| 32 | + |
| 33 | +(You'll typically see the virtual environment name in parentheses at the beginning of your terminal prompt: `(.venv) $`) |
| 34 | + |
| 35 | +## Install the DMA Readiness Check Utility |
| 36 | + |
| 37 | +Navigate to the directory containing the DMA collector wheel file (.whl file). This file is the packaged distribution of the collector. |
| 38 | + |
| 39 | +Install the wheel file using pip: |
| 40 | + |
| 41 | +```shell |
| 42 | +pip install dma-collector-<version>.whl |
| 43 | +``` |
| 44 | + |
| 45 | +**Note** Replace `<version>` with the actual version number of the wheel file (e.g., dma-collector-1.2.3.whl). |
| 46 | + |
| 47 | +## Executing the Postgres Readiness Check |
| 48 | + |
| 49 | +Now that the DMA collector is installed, you can run the readiness check for Postgres. |
| 50 | + |
| 51 | +```shell |
| 52 | +dma readiness-check --db-type postgres --hostname localhost --no-prompt --port 5432 --database postgres --username postgres --password password1 |
| 53 | +``` |
| 54 | + |
| 55 | +If you do not supply credentials at the CLI, the tool will prompt you for connection information. |
| 56 | + |
| 57 | + |
0 commit comments