heroku-debug
Version:
debugging plugin for the CLI
55 lines (36 loc) • 1.27 kB
Markdown
# sql-summary
Summarize any SQL query.
This JavaScript module will analyse an SQL query and return a very brief
summary string containing:
- Main verb used (`SELECT`, `INSERT`, `UPDATE` etc.)
- Potentially the type operated on (`TABLE`, `DATABASE` etc.)
- The name of the primary table or database operated on
For example, if given the following SQL query:
```sql
SELECT col1, col2 FROM table_name WHERE id=1
```
The following summary string is produced:
```sql
SELECT FROM table_name
```
[](https://travis-ci.org/watson/sql-summary)
[](https://github.com/feross/standard)
## Installation
```
npm install sql-summary
```
## Usage
```js
var sqlSummary = require('sql-summary')
var query = 'UPDATE table_name SET col1=1, col2=2 WHERE id=1'
console.log('Running query:', sqlSummary(query)) // => 'Running query: UPDATE table_name'
db.query(query, function (err, result) {
// ...
})
```
## Use-cases
- In a web-server log output the type of queries used without going into
too much details about each query
- Group similar queries operating on the same tables
## License
MIT