README

This package is an extension to laravel migrations to add some more optimized virtual/storedAs fields based on common use cases (at least my own);

Support us

Installation

You can install the package via composer:

composer require patrickcurl/laravel-computed-columns

You can publish and run the migrations with:

Usage

I'm planning on better documentation but the simplest way to jump in is look at some code.

<?php

declare(strict_types=1);

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Migrations\Migration;

return new class() extends Migration {
    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('locations');
        Schema::dropIfExists('locateables');
    }

    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('locations', function (Blueprint $table) {
            $table->id();
            $table->json('data')->nullable();

            $table->computedJsonColumns( // notice the plurality of columns.
                'stored' // the type, accepts: 'stored' and 'virtual'
                'data', // the json column to extract data from.
                [ // The fields in the data json object to convert to computed fields.
                    'type',
                    'country',
                    'country_code',
                    'state',
                    'postcode',
                    'city',
                    'lat',
                    'lng',
                ], // loop over these fields and run the storedAs method see example below.
                true // should each field be nullable?
            );

            // This is the equivalent of running:
            // $field = 'data->';
            // $path = 'country';
            // $this->string('type')->storedAs('json_unquote(json_extract('.$field.$path.'))');


            // concatWsStoredAs($column, $default, $separator, ...$fields)
            $table->computedConcatWsColumn(
                'stored' // type
                'label', // computed column name
                'data->label', // json path default value if other sources come up null.
                ', ', // separator
                'city', // ...$fields|$fields[] which fields on data to convert from:
                'state', // e.g. state will give you $model->state === $model->data->state;
                'country',
                'postcode'
            ); // This will use the default if it exists, otherwise it'll create a default either from json nested keys where fields are ['data->city', 'data->state', etc....];

            // This one simply creates an id, my location example basically does a lookup of data via openstreetmaps, and caches the label, and then if someone adds that to their profile as their location it'll pull it all in at that point either from the api, or the cache, or an existing location as we're only dealing with city/state not actual full addresses.

            // This isn't the most secure thing, for an id that's not critical that it's secret this is fine, but I wouldn't use it to hash passwords!
            $table->computedMd5Column(
                'stored', // type
                'uid', // column
                'label' // label column will be used, could also use data->label to use the original json to map from.
            );

            // alternately I could've used :
            $table->computedWrappedColumn(
                'stored',
                'MD5',
                'uid',
                'label'
            ) ;

            $table->timestamps();
        });

        Schema::create('locateables', function (Blueprint $table) {
            $table->id();
            $table->foreignId('location_id')->constrained();
            $table->morphs('locateable');
            $table->unique(['location_id', 'locateable_id', 'locateable_type']);
        });
    }
};

## Testing

```bash
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

License

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

patrickcurl / laravel-computed-columns

Maintainers

Details