# samjuk/m2-module-verbose-db-status

> Adds a verbose mode to the setup:db:status command, to assist with debugging DB schema differences

`composer require samjuk/m2-module-verbose-db-status`

Canonical URL: https://packagento.com/samjuk/m2-module-verbose-db-status

## At a glance

- **Vendor**: samjuk (https://packagento.com/samjuk.md)
- **Latest version**: v1.0.0 — released 2024-11-17
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/samjuk/m2-module-verbose-db-status and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require samjuk/m2-module-verbose-db-status:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Adds a verbose mode to the setup:db:status command, to assist with debugging DB schema differences

## README

[![CI Workflow Status](https://github.com/samjuk/m2-module-verbose-db-status/actions/workflows/ci.yml/badge.svg)](https://github.com/SamJUK/m2-module-verbose-db-status/actions/workflows/ci.yml) [![GitHub Release](https://img.shields.io/github/v/release/SamJUK/m2-module-verbose-db-status?label=Latest%20Release&logo=github)](https://github.com/SamJUK/m2-module-verbose-db-status/releases)

This is a simple module that adds a verbose and extra verbose mode to the `setup:db:status` command. 

Especially useful within a CI environment for identifying what schema changes are causing a database migration, which in turn prevents most typical zero downtime deployment strategies.

Example with the verbose flag set | Example with the extra verbose flag set
--- | ---
![Example of the DB Status command with the verbose flag set](./.github/db-status-verbose.png) | ![Example of the DB Status command with the extra verbose flag set](./.github/db-status-extra-verbose.png)

---

### Installation

```bash
composer config repositories.samjuk-m2-module-verbose-db-status vcs git@github.com:SamJUK/m2-module-verbose-db-status.git
composer require samjuk/m2-module-verbose-db-status:@dev
php bin/magento module:enable SamJUK_VerboseDBStatus && php bin/magento cache:flush
```

---

### Usage

Run the `setup:db:status` command, specifying the appropriate verbosity level
```bash
php bin/magento setup:db:status # Standard Magento Output
php bin/magento setup:db:status -v # Display before and after for modified values
php bin/magento setup:db:status -vv # Display before and after for modified values, and raw data diff
```

## Recent Versions

| Version | Released |
|---|---|
| v1.0.0 | 2024-11-17 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| php | >=7.3 |

## Quality

Latest release (v1.0.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 22 | 22 warnings (ruleset: Magento2) |
| PHPMD | Warning | 22 | 22 rule violations (UnusedPrivateField:22) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 4 | 4 | – | – |
| 2.4.8 | – | 4 | 4 | – |
| 2.4.9 | – | – | 4 | 4 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["samjuk/m2-module-verbose-db-status"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

samjuk is a Magento 2 vendor on Packagento. See https://packagento.com/samjuk.md for their full catalogue.