oxid-sql-logger/README.md

60 lines
1.6 KiB
Markdown
Raw Normal View History

2019-08-21 00:36:20 +02:00
Oxid eShop SQL Logger
---------------------
2019-08-20 23:34:33 +02:00
2019-10-01 12:21:04 +02:00
[![Build Status](https://travis-ci.org/TumTum/oxid-sql-logger.svg?branch=master)](https://travis-ci.org/TumTum/oxid-sql-logger)
2019-08-21 00:43:33 +02:00
Returns all SQL queries into console of a Browser.
2019-08-20 23:34:33 +02:00
## Install
2019-09-20 16:05:36 +02:00
`composer require --dev d3/oxid-sql-logger`
2019-08-20 23:34:33 +02:00
## Usage
2019-09-20 16:05:36 +02:00
Just set the function `D3StartSQLLog()` somewhere and from that point on all SQLs will be logged.
2019-08-21 00:36:20 +02:00
2019-08-20 23:34:33 +02:00
```php
2019-09-20 16:05:36 +02:00
\D3StartSQLLog('specific log message');
2019-08-20 23:34:33 +02:00
$db = \OxidEsales\Eshop\Core\DatabaseProvider::getDb(\OxidEsales\Eshop\Core\DatabaseProvider::FETCH_MODE_ASSOC);
2019-08-21 00:36:20 +02:00
$list = $db->getAll('SELECT * FROM oxarticles WHERE oxprice < ? LIMIT 100', [49.99]);
2019-08-20 23:34:33 +02:00
2019-09-20 16:05:36 +02:00
\D3StopSQLLog();
2019-08-20 23:34:33 +02:00
```
2019-08-21 00:36:20 +02:00
## Screenshots
2019-08-21 08:15:58 +02:00
Browser:
2019-09-23 08:38:19 +02:00
![Example all sqls](https://raw.githubusercontent.com/d3datadevelopment/oxid-sql-logger/master/img/screenshot-a.jpg)
2019-08-21 00:36:20 +02:00
2019-08-21 08:15:58 +02:00
CLI:
2019-09-23 08:38:19 +02:00
![Example CLI](https://raw.githubusercontent.com/d3datadevelopment/oxid-sql-logger/master/img/screenshot-cli.jpg)
2019-08-21 08:15:58 +02:00
## SQL Query Status Monitor
![Example CLI](https://raw.githubusercontent.com/TumTum/oxid-sql-logger/master/img/sql-query-status-monitor.jpg)
See how many queries and which types of queries have been added to the database.
To determine the amount.
#### Switch on
For this purpose, the parameter `$this->blSQLStatusBox = true;` must be stored in the file `config.inc.php`.
So you can turn it on and off temporarily.
Unique: Insert, at the end, the Smarty tag: `[{tm_sql_status}]` in the `base.tpl` file.
####### source/Application/views/flow/tpl/layout/base.tpl
```html
[{tm_sql_status}]
</body>
</html>
```
2019-09-23 08:45:00 +02:00
## Credits
Many thanks to [Tobias Matthaiou](https://github.com/TumTum/oxid-sql-logger) for his inspiration.