[8.x] Add explain() to Query\Builder and Eloquent\Builder

[hivokas]

explain() method allows you to receive the explanation from the builder (both Query and Eloquent).

Before you would typically call toSql(), copy the result, open TablePlus, prepend the query with EXPLAIN , replace all ?, and check the result.

Now you can just call explain() to return the explanation or explain()->dd() to die & dump the explanation.

>>> Webhook::where('event', 'users.registered')->explain()
=> Illuminate\Support\Collection {#15414
     all: [
       {#15407
         +"id": 1,
         +"select_type": "SIMPLE",
         +"table": "webhooks",
         +"partitions": null,
         +"type": "ref",
         +"possible_keys": "webhooks_event_index",
         +"key": "webhooks_event_index",
         +"key_len": "1022",
         +"ref": "const",
         +"rows": 1,
         +"filtered": 10.0,
         +"Extra": "Using where",
       },
     ],
   }
>>> DB::table('webhooks')->where('event', 'users.registered')->explain()
=> Illuminate\Support\Collection {#5350
     all: [
       {#5448
         +"id": 1,
         +"select_type": "SIMPLE",
         +"table": "webhooks",
         +"partitions": null,
         +"type": "ref",
         +"possible_keys": "webhooks_event_index",
         +"key": "webhooks_event_index",
         +"key_len": "1022",
         +"ref": "const",
         +"rows": 1,
         +"filtered": 100.0,
         +"Extra": null,
       },
     ],
   }
>>> User::where('name', 'Illia Sakovich')->explain()
=> Illuminate\Support\Collection {#5344
     all: [
       {#15407
         +"id": 1,
         +"select_type": "SIMPLE",
         +"table": "users",
         +"partitions": null,
         +"type": "ALL",
         +"possible_keys": null,
         +"key": null,
         +"key_len": null,
         +"ref": null,
         +"rows": 9,
         +"filtered": 11.11111164093,
         +"Extra": "Using where",
       },
     ],
   }
>>> DB::table('users')->where('name', 'Illia Sakovich')->explain()
=> Illuminate\Support\Collection {#5348
     all: [
       {#5342
         +"id": 1,
         +"select_type": "SIMPLE",
         +"table": "users",
         +"partitions": null,
         +"type": "ALL",
         +"possible_keys": null,
         +"key": null,
         +"key_len": null,
         +"ref": null,
         +"rows": 9,
         +"filtered": 11.11111164093,
         +"Extra": "Using where",
       },
     ],
   }

[deleugpn]

Woah, this is another level awesomeness. I hated replacing all those ? for large queries