Protocol 01

Introduction

ConsoleClvr.io is a specialized control plane designed for high-scale Laravel multi-tenant applications. It provides a unified graphical interface to manage infrastructure orchestration and database engineering without the overhead of manual CLI intervention.

Pro Tip

ConsoleClvr is built to handle thousands of isolated database nodes using the Laravel multi-tenancy paradigm.

Protocol 02

Installation

This repository already contains the full application. Start from Laravel defaults, then configure DB connection from the UI.

composer install
php artisan key:generate
php artisan migrate --force

Then open the app and set connection values from /schema/connection.

Protocol 03

System Requirements

  • PHP 8.2+
  • Laravel 12
  • MySQL access with privileges for schema operations
  • Mailgun credentials (only if using tenant welcome email flow)
Module A

Tenant Provisioning

Tenant operations currently available in the app:

01

Create & Manage Tenants

Create, list, update, and manage tenants from tenant dashboard and manage views.

02

Provision Tenant Database

Run tenant provisioning flow and create tenant-specific schema setup.

03

Email + Delete

Compose/send welcome email and delete tenant with DB drop after confirmation.

Module A2

Database Isolation

  • Tenant DB name is stored per tenant record.
  • Schema editor works against selected DB/table and uses qualified SQL.
  • Tenant delete flow removes tenant row and runs DROP DATABASE IF EXISTS for mapped database.
Module B

Schema Architect

The Schema Architect allows visual table edits with migration-backed execution.

  • Single DB update: generate and run alter migration for selected table.
  • Create mode: create new table via generated migration (single DB).
  • Multi-DB update: apply same alter plan across selected databases.
  • Multi-DB create: generate and run one create migration across selected databases.
Warning: Destructive Operations

Altering columns on tables with millions of rows can cause table locks. It is highly recommended to run heavy schema changes during low-traffic maintenance windows.

Module B2

Global Migrations

Current migration-related actions from UI:

  • Generate Migration (file only)
  • Generate + Run Migration (create mode)
  • Apply Changes (ALTER TABLE) (edit mode)
  • Apply To Multiple Databases (edit mode)
  • Generate + Run (Multi Database) (create mode)
Module C

Foreign Constraints

Foreign keys are part of schema payload. During apply flow, foreign key drops/adds are sequenced with column changes to avoid invalid states where possible.

UI Flow:
Columns JSON + Foreign Keys JSON
-> diff existing vs desired
-> drop impacted constraints
-> apply column alterations
-> re-add translated constraints