How to integrate SQLCheck into a CI/CD pipeline like GitHub Actions?

You can run SQLCheck as a shell command in your pipeline script to scan SQL files; use the -f flag for file input and set risk levels with -r to fail builds on high-risk issues. However, it lacks native CI integrations, so manual scripting is required.

SQLCheck vs other SQL linters like SQLLint or SonarQube?

SQLCheck focuses specifically on performance anti-patterns across all SQL dialects with detailed explanations, while tools like SQLLint may emphasize syntax checking or SonarQube offers broader code quality metrics. SQLCheck is best for targeted performance tuning rather than general linting.

Does SQLCheck work with stored procedures or dynamic SQL?

SQLCheck primarily analyzes static SQL files and may not fully parse complex stored procedures or dynamically generated SQL, as it's designed for common anti-patterns in straightforward queries and schemas.

What are common false positives in SQLCheck?

False positives can occur with legitimate uses of patterns like SELECT * for quick prototyping or OR in optimized queries, as SQLCheck flags these based on general rules without context-aware analysis.

How to run SQLCheck on multiple SQL files in a folder?

Use a shell loop or script to iterate over files, such as 'for file in *.sql; do sqlcheck -f $file; done', since the tool processes one file at a time via the -f flag without built-in batch processing.

Can SQLCheck detect anti-patterns in NoSQL or graph databases?

No, SQLCheck is limited to SQL dialects and does not support NoSQL or graph database queries, as its rule set is tailored for relational SQL anti-patterns only.

Open-Awesome

SQLCheck

Apache-2.0C++v1.3

Automatically detects SQL anti-patterns across logical design, physical design, queries, and application development to improve query performance.

GitHub

2.5k stars122 forks0 contributors

What is SQLCheck?

SQLCheck is a command-line tool that automatically identifies common SQL anti-patterns across logical design, physical design, queries, and application development. It helps developers and database administrators detect issues that slow down queries, providing actionable feedback to improve database performance. The tool supports all major SQL dialects and categorizes anti-patterns by risk level.

Target Audience

Database administrators, backend developers, and data engineers who write and optimize SQL queries and need to ensure efficient database performance.

Value Proposition

Developers choose SQLCheck for its comprehensive, automated detection of SQL anti-patterns across multiple categories, its support for all major SQL dialects, and its ability to provide detailed explanations and risk-level filtering to prioritize fixes.

Overview

Automatically identify anti-patterns in SQL queries

Use Cases

Best For

Identifying performance bottlenecks in existing SQL queries
Learning SQL best practices by analyzing anti-pattern explanations
Code reviews to automatically flag inefficient SQL patterns
Optimizing database schemas for logical and physical design
Preventing common SQL mistakes in application development
Tuning queries across different SQL dialects consistently

Not Ideal For

Projects requiring real-time query performance monitoring and dynamic analysis
Teams needing integrated IDE plugins or graphical dashboards for SQL linting
Environments where SQL code uses niche or proprietary extensions beyond major dialects
Use cases demanding highly customizable or extensible rule sets for project-specific patterns

Pros & Cons

Pros

Cross-Dialect Support

Works with all major SQL dialects like MySQL and PostgreSQL, making it versatile for mixed database environments without needing separate tools.

Risk-Level Filtering

Allows filtering anti-patterns by high, medium, or all risks via the -r flag, helping users prioritize fixes based on severity from the CLI.

Detailed Explanations

Provides verbose output with clear explanations and actionable fixes for each anti-pattern, as shown in the example output with descriptions and recommendations.

Comprehensive Detection

Covers anti-patterns across logical design, physical design, queries, and application development, offering a broad scope for database optimization.

Cons

Static Analysis Only

SQLCheck analyzes SQL files statically and cannot detect runtime performance issues, dynamic query generation, or live database behavior, limiting its use for real-time tuning.

Fixed Rule Set

The tool relies on a pre-defined list of anti-patterns with no built-in mechanism for adding custom rules, reducing flexibility for project-specific needs or evolving best practices.

Complex Source Build

Building from source requires dependencies like g++ 4.9+ and cmake, which adds setup overhead compared to simpler package managers or plug-and-play tools.

Frequently Asked Questions

Related Projects

Hasura GraphQL Engine

Blazing fast, instant realtime GraphQL APIs on all your data with fine grained access control, also trigger webhooks on database events.

Stars31,953

Forks2,876

Last commit8 days ago

PostgREST

REST API for any Postgres database

🔮 Graphile's Crystal Monorepo; home to Grafast, PostGraphile, pg-introspection, pg-sql2 and much more!

Stars12,914

Forks618

Last commit2 days ago

SQLFluff

A modular SQL linter and auto-formatter with support for multiple dialects and templated code.

Stars9,662

Forks981