Introducing SQLE: An Open‑Source SQL Quality Control Platform and Its CI/CD Integration

1. SQLE Overview

SQLE is an open‑source project initiated by the ActionTech community that provides a comprehensive solution for SQL development, testing, and deployment, offering fine‑grained resource and permission management, simplicity, efficiency, easy maintenance, and extensibility, aimed at delivering a secure and controllable SQL quality control scheme.

2. Feature Introduction

During the development phase, SQLE performs SQL review through audit tasks that cover the entire lifecycle—from development to production—supporting MyBatis scanning, slow‑log analysis, metadata extraction, TopSQL, and Java application SQL capture. The MyBatis scanning task uses the SQLE‑provided Scanner tool to collect SQL statements and push them to SQLE for review.

In the CI/CD stage, SQLE can be integrated into pipelines (e.g., Jenkins, GoCD) as a check module, providing immediate feedback on non‑compliant SQL, reducing later review pressure, and allowing developers to optimize SQL before the build succeeds.

Scanner mode can be integrated with almost any CI/CD platform with simple configuration.

Audit results are returned instantly, enabling developers to fix issues promptly.

SQL classification statistics and audit reports can also be viewed directly in the SQLE UI.

3. Demonstration

1) Create an audit task

(Illustrative screenshots omitted for brevity.)

2) Add a build step in Jenkins

The SQLE Scanner is a binary command‑line tool located in the bin directory of the SQLE installation; its usage and parameters are documented at the official SQLE documentation site.

3) Jenkins triggers SQL audit

When the Jenkins job runs, SQLE performs the audit and returns results; non‑compliant SQL causes the build to fail, prompting developers to correct the statements and re‑run the pipeline.

4) View results in SQLE UI

Project leaders can inspect audit outcomes and SQL statistics on the SQLE platform, gaining insight into overall SQL quality and common issues.

4. Conclusion

The article demonstrates a simple integration of SQL auditing into a CI/CD workflow using SQLE; readers are encouraged to download SQLE from its GitHub repository and try it with their own CI/CD pipelines. Additional usage scenarios are documented in the official SQLE documentation.