Class yii\debug\panels\DbPanel

Inheritanceyii\debug\panels\DbPanel » yii\debug\Panel » yii\base\Component
Available since version2.0

Debugger panel that collects and displays database queries performed.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$actions array Array of actions to add to the debug modules default controller. yii\debug\Panel
$criticalQueryThreshold integer The threshold for determining whether the request has involved critical number of DB queries. yii\debug\panels\DbPanel
$data mixed Data associated with panel yii\debug\Panel
$db string The name of the database component to use for executing (explain) queries yii\debug\panels\DbPanel
$defaultFilter array The default filter to apply to the database queries. yii\debug\panels\DbPanel
$defaultOrder array The default ordering of the database queries. yii\debug\panels\DbPanel
$id string Panel unique identifier. yii\debug\Panel
$module yii\debug\Module yii\debug\Panel
$tag string Request data set identifier. yii\debug\Panel

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$error yii\debug\FlattenException|null Error while saving the panel yii\debug\Panel

Public Methods

Hide inherited methods

MethodDescriptionDefined By
calculateTimings() Calculates given request profile timings. yii\debug\panels\DbPanel
canBeExplained() Check if given query type can be explained. yii\debug\panels\DbPanel
countDuplicateQuery() Return associative array, where key is query string and value is number of occurrences the same query in array. yii\debug\panels\DbPanel
getDb() Returns a reference to the DB component associated with the panel yii\debug\panels\DbPanel
getDetail() yii\debug\panels\DbPanel
getError() yii\debug\Panel
getName() yii\debug\panels\DbPanel
getProfileLogs() Returns all profile logs of the current request for this panel. It includes categories such as: 'yii\db\Command::query', 'yii\db\Command::execute'. yii\debug\panels\DbPanel
getSummary() yii\debug\panels\DbPanel
getSummaryName() yii\debug\panels\DbPanel
getTraceLine() Returns a trace line yii\debug\Panel
getTypes() Returns array query types yii\debug\panels\DbPanel
getUrl() yii\debug\Panel
hasError() yii\debug\Panel
init() yii\debug\panels\DbPanel
isEnabled() Checks whether this panel is enabled. yii\debug\panels\DbPanel
isQueryCountCritical() Check if given queries count is critical according settings. yii\debug\panels\DbPanel
load() Loads data into the panel yii\debug\Panel
save() Saves data to be later used in debugger detail view. yii\debug\panels\DbPanel
setError() yii\debug\Panel
sumDuplicateQueries() Returns sum of all duplicated queries yii\debug\panels\DbPanel

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getLogMessages() Gets messages from log target and filters according to their categories and levels. yii\debug\Panel
getModels() Returns an array of models that represents logs of the current request. yii\debug\panels\DbPanel
getQueryType() Returns database query type. yii\debug\panels\DbPanel
getTotalQueryTime() Returns total query time. yii\debug\panels\DbPanel
hasExplain() yii\debug\panels\DbPanel

Property Details

$criticalQueryThreshold public property

The threshold for determining whether the request has involved critical number of DB queries. If the number of queries exceeds this number, the execution is considered taking critical number of DB queries.

$db public property

The name of the database component to use for executing (explain) queries

public string $db 'db'
$defaultFilter public property (available since version 2.0.7)

The default filter to apply to the database queries. In the format of [ property => value ], for example: [ 'type' => 'SELECT' ]

public array $defaultFilter = []
$defaultOrder public property (available since version 2.0.7)

The default ordering of the database queries. In the format of [ property => sort direction ], for example: [ 'duration' => SORT_DESC ]

public array $defaultOrder = ['seq' => SORT_ASC]

Method Details

calculateTimings() public method

Calculates given request profile timings.

public array calculateTimings ( )
return array

Timings [token, category, timestamp, traces, nesting level, elapsed time]

canBeExplained() public static method (available since version 2.0.5)

Check if given query type can be explained.

public static boolean canBeExplained ( $type )
$type string

Query type

countDuplicateQuery() public method (available since version 2.0.13)

Return associative array, where key is query string and value is number of occurrences the same query in array.

public array countDuplicateQuery ( $timings )
$timings
getDb() public method (available since version 2.0.5)

Returns a reference to the DB component associated with the panel

public \yii\db\Connection getDb ( )
throws \yii\base\InvalidConfigException
getDetail() public method

public string getDetail ( )
return string

Content that is displayed in debugger detail view

throws \yii\base\InvalidConfigException
getModels() protected method

Returns an array of models that represents logs of the current request.

Can be used with data providers such as \yii\data\ArrayDataProvider.

protected array getModels ( )
return array

Models

getName() public method

public string getName ( )
return string

Name of the panel

getProfileLogs() public method

Returns all profile logs of the current request for this panel. It includes categories such as: 'yii\db\Command::query', 'yii\db\Command::execute'.

public array getProfileLogs ( )
getQueryType() protected method

Returns database query type.

protected string getQueryType ( $timing )
$timing string

Timing procedure string

return string

Query type such as select, insert, delete, etc.

getSummary() public method

public string getSummary ( )
return string

Content that is displayed at debug toolbar

getSummaryName() public method

public string getSummaryName ( )
return string

Short name of the panel, which will be use in summary.

getTotalQueryTime() protected method

Returns total query time.

protected integer getTotalQueryTime ( $timings )
$timings array
return integer

Total time

getTypes() public method (available since version 2.0.3)

Returns array query types

public array getTypes ( )
hasExplain() protected method (available since version 2.0.5)

protected boolean hasExplain ( )
return boolean

Whether the DB component has support for EXPLAIN queries

throws \yii\base\InvalidConfigException
init() public method

public void init ( )
isEnabled() public method (available since version 2.0.10)

Checks whether this panel is enabled.

public boolean isEnabled ( )
return boolean

Whether this panel is enabled.

isQueryCountCritical() public method

Check if given queries count is critical according settings.

public boolean isQueryCountCritical ( $count )
$count integer

Queries count

save() public method

Saves data to be later used in debugger detail view.

This method is called on every page where debugger is enabled.

public mixed save ( )
return mixed

Data to be saved

sumDuplicateQueries() public method (available since version 2.0.13)

Returns sum of all duplicated queries

public integer sumDuplicateQueries ( $modelData )
$modelData