Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jarulraj/sqlcheck
Automatically identify anti-patterns in SQL queries
https://github.com/jarulraj/sqlcheck
command-line database microsoft-sql-server mysql oracle postgresql sql sqlite3
Last synced: 25 days ago
JSON representation
Automatically identify anti-patterns in SQL queries
- Host: GitHub
- URL: https://github.com/jarulraj/sqlcheck
- Owner: jarulraj
- License: apache-2.0
- Created: 2017-04-02T18:29:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T13:30:05.000Z (9 months ago)
- Last Synced: 2024-09-26T22:23:12.789Z (about 1 month ago)
- Topics: command-line, database, microsoft-sql-server, mysql, oracle, postgresql, sql, sqlite3
- Language: C++
- Homepage:
- Size: 961 KB
- Stars: 2,429
- Watchers: 63
- Forks: 121
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - jarulraj/sqlcheck - Automatically identify anti-patterns in SQL queries (C++)
- awesome-list - sqlcheck - patterns in SQL queries | jarulraj | 2016 | (C++)
- jimsghstars - jarulraj/sqlcheck - Automatically identify anti-patterns in SQL queries (C++)
- starred-awesome - sqlcheck - Automatically identify anti-patterns in SQL queries (C++)
README
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://github.com/jarulraj/sqlcheck/)
[](https://github.com/jarulraj/sqlcheck/actions/workflows/main.yml)
[](https://coveralls.io/github/jarulraj/sqlcheck?branch=master)
## What Is SQLCheck?
`sqlcheck` automatically detects common SQL anti-patterns. Such anti-patterns often slow down queries. Addressing them will, therefore, help accelerate queries.
`sqlcheck` targets **all major SQL dialects**.
For development updates on `sqlcheck` and general news on next generation database systems, follow me at @joy_arulraj.
## What it can do
Right now SQLCheck can detect the following anti-patterns:
### Logical Database Design Anti-Patterns
* [Multi-Valued Attribute](https://github.com/jarulraj/sqlcheck/blob/master/docs/logical/1001.md)
* [Recursive Dependency](https://github.com/jarulraj/sqlcheck/blob/master/docs/logical/1002.md)
* [Primary Key Does Not Exist](https://github.com/jarulraj/sqlcheck/blob/master/docs/logical/1003.md)
* [Generic Primary Key](https://github.com/jarulraj/sqlcheck/blob/master/docs/logical/1004.md)
* [Foreign Key Does Not Exist](https://github.com/jarulraj/sqlcheck/blob/master/docs/logical/1005.md)
* [Entity-Attribute-Value Pattern](https://github.com/jarulraj/sqlcheck/blob/master/docs/logical/1006.md)
* [Metadata Tribbles](https://github.com/jarulraj/sqlcheck/blob/master/docs/logical/1007.md)
### Physical Database Design Anti-Patterns
* [Imprecise Data Type](https://github.com/jarulraj/sqlcheck/blob/master/docs/physical/2001.md)
* [Values In Definition](https://github.com/jarulraj/sqlcheck/blob/master/docs/physical/2002.md)
* [Files Are Not SQL Data Types](https://github.com/jarulraj/sqlcheck/blob/master/docs/physical/2003.md)
* [Too Many Indexes](https://github.com/jarulraj/sqlcheck/blob/master/docs/physical/2004.md)
* [Index Attribute Order](https://github.com/jarulraj/sqlcheck/blob/master/docs/physical/2005.md)
### Query Anti-Patterns
* [SELECT *](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3001.md)
* [NULL Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3002.md)
* [NOT NULL Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3003.md)
* [String Concatenation](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3004.md)
* [GROUP BY Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3005.md)
* [ORDER BY RAND Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3006.md)
* [Pattern Matching Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3007.md)
* [Spaghetti Query Alert](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3008.md)
* [Reduce Number of JOINs](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3009.md)
* [Eliminate Unnecessary DISTINCT Conditions](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3010.md)
* [Implicit Column Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3011.md)
* [HAVING Clause Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3012.md)
* [Nested sub queries](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3013.md)
* [OR Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3014.md)
* [UNION Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3015.md)
* [DISTINCT & JOIN Usage](https://github.com/jarulraj/sqlcheck/blob/master/docs/query/3016.md)
### Application Development Anti-Patterns
* [Readable Passwords](https://github.com/jarulraj/sqlcheck/blob/master/docs/application/4001.md)
## Installation
###UBUNTU/MINT (DEBIAN)
1. Download the **debian package** from the latest release.
```shell
wget https://github.com/jarulraj/sqlcheck/releases/download/v1.3/sqlcheck-x86_64.deb
```
2. Install it by running the following command.
```shell
dpkg -i sqlcheck-x86_64.deb
```
### FEDORA/CENTOS (RPM)
1. Download the **rpm package** from the latest release.
```shell
wget https://github.com/jarulraj/sqlcheck/releases/download/v1.3/sqlcheck-x86_64.rpm
```
2. Install it by running the following command.
```shell
yum --nogpgcheck localinstall sqlcheck-x86_64.rpm
```
### MAC (DMG)
1. Download the **dmg package** from the latest release.
```shell
wget https://github.com/jarulraj/sqlcheck/releases/download/v1.3/sqlcheck-x86_64.dmg
```
2. Click the dmg to mount the package. This will mount it in the `Volumes` directory.
3. Open the `Terminal` app. [This page](http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line) contains more details on finding the app.
4. Copy over the SQLCheck binary file to desired local directory.
```shell
cp /Volumes/sqlcheck-x86_64/bin/sqlcheck /usr/local/bin/
```
### WINDOWS (EXE)
1. Download the **exe file** from the latest release.
```shell
wget https://github.com/jarulraj/sqlcheck/releases/download/v1.3/sqlcheck.exe
```
2. Open a terminal (like `cmd.exe`) and run the executable.
### ZIP
1. Download the **zip package** from the latest release.
```shell
wget https://github.com/jarulraj/sqlcheck/releases/download/v1.3/sqlcheck-x86_64.zip
```
2. Unzip it and find the SQLCheck binary (`bin/sqlcheck`).
```shell
unzip sqlcheck-x86_64.zip
```
## SOURCE CODE
SQLCheck has the following software dependencies:
- **g++ 4.9+**
- **cmake** ([Cmake installation guide](https://cmake.org/install/))
First, clone the repository (with **--recursive** option).
```shell
git clone --recursive https://github.com/jarulraj/sqlcheck.git
```
Next, run the following commands to build and install SQLCheck:
```shell
./bootstrap
cd build
cmake -DCMAKE_BUILD_TYPE=RELEASE ..
make
make install
```
### TESTS
To run SQLCheck unit tests during development, run:
```shell
./build/test/test_suite
```
## Usage
```
$ sqlcheck -h
Command line options : sqlcheck
-f --file_name : file name
-r --risk_level : set of anti-patterns to check
: 1 (all anti-patterns, default)
: 2 (only medium and high risk anti-patterns)
: 3 (only high risk anti-patterns)
-c --color_mode : color mode
-v --verbose_mode : verbose mode
```
```sql
$ sqlcheck -f examples/top_mutexes.sql -v
-------------------------------------------------
> RISK LEVEL :: ALL ANTI-PATTERNS
> SQL FILE NAME :: examples/top_mutexes.sql
-------------------------------------------------
==================== Results ===================
-------------------------------------------------
SQL Statement: with top_mutexes as ( select--+ leading(t1 s1 v1 v2 t2 s2) use_hash(s1)
use_nl(v1) use_hash(s2) materialize t1.hsecs ,s1.* ,s2.sleeps as end_sleeps
,s2.wait_time as end_wait_time ,s2.sleeps-s1.sleeps as delta_sleeps ,t2.hsecs -
t1.hsecs as delta_hsecs --,s2.* from v$timer t1 ,v$mutex_sleep s1 ,(select/*+
no_merge */ sum(level) a from dual connect by level<=1e6) v1 ,v$timer t2
,v$mutex_sleep s2 where s1.mutex_type=s2.mutex_type and s1.location=s2.location
) select * from top_mutexes order by delta_sleeps desc;
```
```
[examples/top_mutexes.sql]: (HIGH RISK) (QUERY ANTI-PATTERN) SELECT *
● Inefficiency in moving data to the consumer:
When you SELECT *, you're often retrieving more columns from the database than
your application really needs to function. This causes more data to move from
the database server to the client, slowing access and increasing load on your
machines, as well as taking more time to travel across the network. This is
especially true when someone adds new columns to underlying tables that didn't
exist and weren't needed when the original consumers coded their data access.
● Indexing issues:
Consider a scenario where you want to tune a query to a high level of
performance. If you were to use *, and it returned more columns than you
actually needed, the server would often have to perform more expensive methods
to retrieve your data than it otherwise might. For example, you wouldn't be able
to create an index which simply covered the columns in your SELECT list, and
even if you did (including all columns [shudder]), the next developer who came around
and added a column to the underlying table would cause the optimizer to ignore
your optimized covering index, and you'd likely find that the performance of
your query would drop substantially for no readily apparent reason.
[Matching Expression: select *]
[examples/top_mutexes.sql]: (LOW RISK) (QUERY ANTI-PATTERN) Spaghetti Query Alert
● Split up a complex spaghetti query into several simpler queries:
SQL is a very expressive language—you can accomplish a lot in a single query
or statement. But that doesn't mean it's mandatory or even a good idea to
approach every task with the assumption it has to be done in one line of code.
One common unintended consequence of producing all your results in one query is
a Cartesian product. This happens when two of the tables in the query have no
condition restricting their relationship. Without such a restriction, the join
of two tables pairs each row in the first table to every row in the other table.
Each such pairing becomes a row of the result set, and you end up with many more
rows than you expect.
It's important to consider that these queries are simply
hard to write, hard to modify, and hard to debug. You should expect to get
regular requests for incremental enhancements to your database applications.
Managers want more complex reports and more fields in a user interface. If you
design intricate, monolithic SQL queries, it's more costly and time-consuming to
make enhancements to them. Your time is worth something, both to you and to your
project. Split up a complex spaghetti query into several simpler queries. When
you split up a complex SQL query, the result may be many similar queries,
perhaps varying slightly depending on data values. Writing these queries is a
chore, so it's a good application of SQL code generation. Although SQL makes it
seem possible to solve a complex problem in a single line of code, don't be
tempted to build a house of cards.
==================== Summary ===================
All Anti-Patterns :: 2
> High Risk :: 1
> Medium Risk :: 0
> Low Risk :: 1
```
## References
(1) SQL Anti-patterns: Avoiding the Pitfalls of Database Programming, Bill Karwin
(2) [Common SQL Anti-patterns](https://stackoverflow.com/questions/346659/what-are-the-most-common-sql-anti-patterns), StackOverflow
## Contributions
Contributions to SQLCheck are always welcome. You can contribute in different ways:
* Open an issue with suggestions for improvements and errors you're facing;
* Fork this repository and submit a pull request;
* Improve the documentation.
## License
Licensed under the [Apache License](LICENSE).