PhpDev.App
tpetry/laravel-mysql-explain

tpetry/laravel-mysql-explain

Stars: 110

Forks: 4

Pull Requests: 4

Issues: 1

Watchers: 1

Last Updated: 2023-07-07 09:15:24

#explain #laravel #mysql #query-optimization

Get MySQL EXPLAIN plans that are understandable for humans

License: MIT License

Languages: PHP

https://explainmysql.com

Laravel MySQL Explains For Humans

License PHP Laravel Latest Version on Packagist GitHub Unit Tests Action Status GitHub Static Analysis Action Status GitHub Code Style Action Status

MySQL Query optimization with the EXPLAIN command is unnecessarily complicated: The output contains a lot of cryptic information that is incomprehensible or entirely misleading.

This Larvel package collects many query metrics that will be sent to explainmysql.com and transformed to be much easier to understand.

Installation

You can install the package via composer:

composer require tpetry/laravel-mysql-explain

Usage

Query Builder

Three new methods have been added to the query builder for very easy submission of query plans:

Type Action
explainForHumans returns URL to processed EXPLAIN output
dumpExplainForHumans dumps URL to processed EXPLAIN output and continue normal execution
ddExplainForHumans dumps URL to processed EXPLAIN output and stops execution 
// $url will be e.g. https://explainmysql.com/e/C0Omak70mLEXfok1a7Oo1n
$url = Film::where('description', 'like', '%astronaut%')
    ->explainForHumans();

// URL to EXPLAIN will be printed to screen
$users = Film::where('description', 'like', '%astronaut%')
    ->dumpExplainForHumans()
    ->get();

// URL to EXPLAIN will be printed to screen & execution is stopped
$users = Film::where('description', 'like', '%astronaut%')
    ->ddExplainForHumans()
    ->get();

Raw Queries

In some cases you are executing raw SQL queries and don't use the query builder. You can use the MysqlExplain facade to get the EXPLAIN url for them:

use Tpetry\MysqlExplain\Facades\MysqlExplain;

// $url will be e.g. https://explainmysql.com/e/H1pfKQ7FH3HnH87dS64Wk1
$url = MysqlExplain::submitQuery(
    DB::connection('mysql'),
    'SELECT * FROM actor WHERE first_name = ?',
    ['PENEL\'OPE'],
);

Testing

composer test

Changelog

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

Credits

License

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

OPEN ISSUES

See all

RELEASES

See all