micahdshackelford/rmap-laravel

External relationship mapping tool

v1.0.0 2023-05-25 03:51 UTC

Requires

• php: 8.0|^8.1
• illuminate/contracts: ^9.19|^10.12.0
• spatie/laravel-package-tools: ^1.14.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^7.9
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0

MIT

• Micah Shackelford

• laravel
• MicahDShackelford
• rmap-laravel

README

Adds the ability to specify external foreign keys in database migrations.

Installation

You can install the package via composer:

composer require micahdshackelford/rmap-laravel

Register the service provider:

in config/app.php

    'providers' => [
        ...
        /*
         * Package Service Providers...
         */
        MicahDShackelford\RmapLaravel\RmapLaravelServiceProvider::class,
        ...
    ]

Run the migration: 0000_00_00_000000_create_rmap_relationships_table.php

Usage

Creating a foreign relationship (from migration)

1. Create a new migration: php artisan make:migration [name] --create [table]
2. Define an column & external foreign key relationship

...
Schema::create('[table]', function (Blueprint $table) {
    ...
    $table->uuid('external_uuid');
    ...
    
    $table->externalForeign('test_uuid') // Name of the column on this table
        ->connection('external_connection') // External connection name
        ->on('tests') // External table
        ->references('uuid') // External column
        ->schema("default"); // (optional) Schema the external table.column lives on 
});
...

Creating a foreign relationship (from command)

Use php artisan rmap:create and follow the prompts.

Dropping a foreign relationship (from migration)

1. Create a roll migration: php artisan make:migration [name] --table [table]
2. Define an column & external foreign key relationship

...
Schema::table('[table]', function (Blueprint $table) {
    $table->dropExternalForeign('test_uuid'); // Name of the column on this table
        // ->connection('external_connection') // (optional) External connection name
        // ->on('tests') // (optional) External table
        // ->references('uuid') // (optional) External column
        // ->schema("default"); // (optional) Schema the external table.column lives on 
});
...

Clear all foreign relationships (from command)

Use php artisan rmap:clear and follow the prompts.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Micah Shackelford
• All Contributors

License

The MIT License (MIT). Please see License File for more information.