README

Asynchronous migrations, seeders, and programmatic schema definition for PHP 8.4+.

Note: This repository provides the CLI tooling and schema builder for the Hibla Database Ecosystem. For complete, comprehensive documentation covering all CLI commands, Blueprint definitions, and Query Builder features, please visit the main hiblaphp/database meta-package.

Overview

hiblaphp/schema-manager is a standalone database lifecycle management toolkit. It equips any PHP application or microframework with Laravel-style migrations, programmatic blueprints, asynchronous database seeders, and advanced production safeguards like "Safe Mode" and native Schema Dumping (Squashing).

It supports MySQL, PostgreSQL, and SQLite out of the box. Notably, it fully overcomes SQLite's infamous ALTER TABLE limitations by safely orchestrating atomic table-recreation and index-preservation within asynchronous transactions automatically.

Installation

This package is currently in beta. Before installing, ensure your composer.json allows beta releases:

Install the package via Composer. (This automatically installs the required hiblaphp/query-builder dependency).

composer require hiblaphp/schema-manager

Run the initialization command to auto-scaffold your configuration files:

# Places configs in a /config directory for instant auto-discovery
./vendor/bin/hibla-db init --dir=config

Quick Start

Zero-Config Default: By default, Hibla resolves to an in-memory SQLite database (:memory:), meaning you can start running migrations and seeders immediately without configuring a database server!

1. Create a Migration

Generate your first migration using the CLI. The command automatically detects table creation intents based on the name:

./vendor/bin/hibla-db make:migration create_users_table

This generates a safe, anonymous class in your database/migrations folder:

<?php

use Hibla\SchemaManager\Schema\Blueprint;
use Hibla\SchemaManager\Schema\Migration;
use function Hibla\await;

return new class extends Migration {
    public function up(): void {
        await($this->create('users', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('email')->unique();
            $table->timestamps();
        }));
    }

    public function down(): void {
        await($this->dropIfExists('users'));
    }
};

2. Run the Migrations

Apply your schema to the database safely:

./vendor/bin/hibla-db migrate

3. Create a Seeder

Generate a database seeder file:

./vendor/bin/hibla-db make:seeder UserSeeder

Seed your data using highly optimized, asynchronous queries:

<?php

use Hibla\SchemaManager\Schema\Seeder;
use function Hibla\await;

return new class extends Seeder {
    public function run(): void {
        await($this->db('users')->insertBatch([
            ['name' => 'Alice', 'email' => 'alice@test.com'],
            ['name' => 'Bob', 'email' => 'bob@test.com'],
        ]));
    }
};

Run your seeders:

./vendor/bin/hibla-db db:seed

Testing & Development

Because the Schema Manager tests native table alterations, foreign key bindings, and schema state dumping, the test suite requires real databases to run against. A docker-compose.yml file is provided to quickly spin up the necessary environments for MySQL and PostgreSQL.

1. SQLite Testing (Zero Setup)

To run the SQLite test suite, no external database engines or Docker setups are required. Simply execute:

composer test:sqlite

2. Start the External Database Containers

Start the MySQL 8 and PostgreSQL 15 containers:

docker compose up -d

3. Run the Suite

To run the tests against MySQL:

composer test:mysql

To run the tests against PostgreSQL:

composer test:pgsql

To run the tests against all three databases sequentially:

composer test:all

Documentation

For full documentation on available Blueprint column types, multi-connection migrations, production Safe Mode, and Schema Squashing (schema:dump), please read the Comprehensive Hibla Documentation.

License

This package is open-sourced software licensed under the MIT license.

hiblaphp / schema-manager

Maintainers

Package info

Fund package maintenance!

Statistics

Security