Download the PHP package tpetry/php-mysql-explain without Composer
On this page you can find all versions of the php package tpetry/php-mysql-explain. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tpetry/php-mysql-explain
More information about tpetry/php-mysql-explain
Files in tpetry/php-mysql-explain
Package php-mysql-explain
Short Description Visual MySQL EXPLAIN plans for PHP
License MIT
Homepage https://github.com/tpetry/php-mysql-explain
Informations about the package php-mysql-explain
MySQL Visual Explains with PHP
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 PHP package collects many query metrics that will be sent to mysqlexplain.com and transformed to be much easier to understand.
Installation
You can install the package via composer:
Usage
1. Query Definition
The query you want to analyze must first be defined with all the parameters used and its database connection.
Included are implementations for PHP's mysqli and PDO drivers.
However, you can also build framework-specific ones by implementing the QueryInterface
.
[!NOTE]
The minimum required PHP version is 7.4 but the examples use the named arguments syntax of PHP 8 for easier reading.
mysqli Driver
In its most simple form, you only provide the mysqli connection and the query to execute:
You can also provide variables that are bound to the prepared statement:
Please be aware that by default all passed variables are interpreted as strings.
However, you can pass a string as last parameter following the characteristics of the $types
parameter from mysqli's bind_param function:
PDO Driver
You can also provide variables that are bound to the prepared statement with positional or named parameters:
Please be aware that by default all passed variables are interpreted as strings. However, you can pass an array as last parameter with PDO::PARAM_* types:
2. Metric Collection
Now, the query profiling information must be collected for the previously configured query:
3. API Call
Finally, the $metrics
object containing all the information must be sent to the mysqlexplain.com API:
[!IMPORTANT] This package has no dependency on any specific HTTP client library to avoid conflicts with actively used versions within your project. Therefore, you must pass an object of any http library implementing
psr/http-client
. In this example, the popular Guzzle HTTP library (composer require guzzlehttp/guzzle
) was used - which you probably have already installed. But you can also choose from many other implementations.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
- tpetry
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of php-mysql-explain with dependencies
ext-json Version *
nyholm/psr7 Version ^1.6.0
psr/http-client Version ^1.0
symfony/polyfill-php81 Version ^1.22