Skip to content

5.x: add docs for SqlTraceTrait #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LordSimal merged 2 commits into from
Sep 17, 2023
Merged

5.x: add docs for SqlTraceTrait #960

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83d0bdb
add docs for SqlTraceTrait
LordSimal Sep 17, 2023
a823997
adjust composer require docs
LordSimal Sep 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/en/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ you've removed it and want to re-install it, you can do so by running the
following from your application's ROOT directory (where composer.json file is
located)::

php composer.phar require --dev cakephp/debug_kit "~4.0"
php composer.phar require --dev cakephp/debug_kit "~5.0"

Then, you need to enable the plugin by executing the following line::

Expand Down Expand Up @@ -316,3 +316,20 @@ Helper Functions

* ``sql()`` Dumps out the SQL from an ORM query.
* ``sqld()`` Dumps out the SQL from an ORM query, and exits.

Tracing query execution
=======================

Sometimes you need to know where specific queries are being executed in your app.
To get this kind of information you can add the ``SqlTraceTrait`` to your Table class like so::

use DebugKit\Model\Table\SqlTraceTrait;

class CategoriesTable extends Table
{
use SqlTraceTrait;
}

This will add the following information to the SQL log::

/* APP/Controller/CategoriesController.php (line 20) *)