skills.rest
koriym
koriymCOMMUNITY
Explore all skills by this author →
Website𝕏@koriymGitHub

sql-quality-check

Analyze SQL files for performance issues and output JSON or Markdown reports.

3|2|Updated Dec 19, 2024
Search Tags:#performance#database#analysis#sql#code-quality#query-optimization#ci
One-click install
npx skills add https://github.com/koriym/Koriym.SqlQuality --skill sql-quality-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sql-quality-check
Source: https://github.com/koriym/Koriym.SqlQuality/tree/main/skills/sql-quality-check
Command: npx skills add https://github.com/koriym/Koriym.SqlQuality --skill sql-quality-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyze SQL files in CI pipelines to detect performance issues without modifying source files, focusing on critical problems and actionable warnings.

Core Features & Use Cases

  • Detects common performance issues in SQL files (e.g., full table scans, inefficient joins, and slow sorts) and reports them in a CI-friendly format.
  • Supports JSON and Markdown outputs for easy integration with dashboards and pull request checks.
  • Provides clear exit codes to indicate presence of critical issues for automated CI gating and reviewer notifications.
  • Use Case: integrate the analyzer into CI to automatically report issues in pull requests without altering production queries.

Quick Start

Run the analyzer on your SQL directory with your parameters to generate a CI-friendly report.

Frequently Asked Questions about sql-quality-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect SQL performance issues in a CI pipeline?▼

Detect SQL performance issues in a CI pipeline by analyzing SQL files for full table scans, inefficient joins, and slow sorts, outputting structured JSON or Markdown reports with exit codes to gate builds.

What are common SQL query performance issues to check for?▼

Common SQL query performance issues include FullTableScan, IneffectiveJoin, IneffectiveSort, and TemporaryTableGrouping scenarios, which can be automatically identified in SQL files without altering source code.

Can I run SQL query analysis without modifying my source code?▼

Yes, you can run SQL query analysis without modifying source code by reading SQL files directly from the repository to assess performance issues and generate CI-friendly reports.

How do I output SQL analysis results for pull request checks?▼

Output SQL analysis results for pull request checks by generating structured reports in JSON or Markdown formats, which integrate easily into dashboards and automated reviewer notifications.

How do I use exit codes to gate CI builds based on SQL query quality?▼

Gate CI builds based on SQL query quality by utilizing clear exit codes that signal the presence of critical or warning-level performance issues, enabling automated build prevention and reviewer alerts.

Related Skills

Explore More Software Engineering Skills→
sjunglingsjungling
13

structured-logging

Parse large multi-source outputs into a local SQL-queryable store.

Community
Advanced
softmgsoftmg

Verification & Quality Assurance

Run verification checks and produce CI-friendly JSON reports with exit codes.

Official
Advanced
giosuetedeschi-specgiosuetedeschi-spec

github-workflow-automation

Automate GitHub repository management tasks including pull request reviews, issue triage, and CI/CD pipeline orchestration.

Community
Advanced
GDSDNGDSDN
3

db-explain

Analyze PostgreSQL query plans with EXPLAIN ANALYZE to identify bottlenecks.

Community
Advanced