DOCSEARCHbyAlgolia
Submit Docs

SQLE Documentation

website·Indexed 30 days ago

https://actiontech.github.io/sqle-docs/

SQLE is an open-source SQL audit and management platform designed to optimize database operations. It features SQL audit workflows, rule template management, Online DDL integration, index optimization, and a SQL workbench based on CloudBeaver. The platform supports various databases including MySQL, PostgreSQL, MariaDB, SQL Server, Oracle, and DB2, providing tools for DBA and developers to manage SQL reviews, scanners, and database audit plugins.

Tokens
114.4K
Snippets
242
Records
914
Agent score
73%

What's inside SQLE

  1. Overview of SQLE Message Push Notifications

    v3
    SQLE v3 supports synchronizing ticket status changes to external platforms to ensure operators are notified promptly without needing to be constantly logged into the platform. Supported notification channels include SMTP Email, Enterprise WeChat, Feishu, and Webhooks. To access these settings, an administrator must navigate to the 'System Settings' page and select the 'Message Push' (消息推送) tab.

  2. Overview of SQLE-customized CloudBeaver (v3)

    v3

    SQLE provides a customized version of CloudBeaver based on the release_22_2_0 branch. This version is optimized for integration with SQLE and includes the following changes:

    • Native support and default enablement of OceanBase and TiDB drivers.
    • Default access route changed to /sql_query for SQLE integration.
    • Default session timeout increased from 30 minutes to 12 hours.
    • Removal of default PG and SQLite demonstration instances.
    • Default theme set to dark mode.
    • Updated Docker image name: actiontech/sqle-cloudbeaver:22_2_0.

  3. Overview of SQLE SQL Workbench (CloudBeaver Integration)

    v2
    SQLE integrates CloudBeaver Community, an open-source web database visualization tool, to provide database operation capabilities for developers and DBAs. It supports multiple databases including PostgreSQL, MySQL, MariaDB, SQL Server, Oracle, DB2, Firebird, H2, and Trino. The integration ensures that user and instance information are synchronized from SQLE to prevent unauthorized access and allows for SQL restriction and auditing via parameter configuration and query reviews.

  4. Overview of SQLE SQL Audit Tool

    v2
    SQLE is an open-source SQL auditing tool developed by ActionTech (上海爱可生信息技术股份有限公司). It provides capabilities for SQL auditing, index optimization, pre-deployment auditing, and post-deployment auditing. It supports standardized deployment workflows, provides native support for MySQL auditing, and features an extensible architecture to support additional database types.

  5. Overview of SQLE Customized CloudBeaver (v2)

    v2

    SQLE provides a customized version of CloudBeaver based on the release_22_2_0 branch. This version is optimized for SQLE integration and includes the following changes:

    • Database Support: OceanBase and TiDB drivers are supported and enabled by default.
    • Routing: The default access route is changed to /sql_query for easier integration with SQLE.
    • Session Management: Default session timeout is increased from 30 minutes to 12 hours.
    • Cleanup: Default PG and SQLite demo instances are removed.
    • UI: The default theme is set to dark mode.
    • Docker Image: The image name is updated to actiontech/sqle-cloudbeaver:22_2_0.

  7. Overview of Role-Based Access Control in SQLE

    In SQLE (v4), roles are used to define the operational permissions a user has within a project. A role consists of a collection of operation permissions. By binding a role to a project member and associating it with specific data sources, administrators can control exactly what actions a member can perform on those data sources.

  8. Overview of SQLE SQL Workbench

    The SQLE SQL Workbench integrates CloudBeaver to provide a web-based database visualization and management tool. It synchronizes user and instance information automatically to reduce the risk of password leakage. It allows administrators to implement SQL auditing, reject non-compliant SQL queries, and enforce granular permission controls to prevent performance issues or unauthorized database operations.

  9. Overview of Data Masking in DMS

    Data Masking is a DMS-exclusive feature that automatically identifies sensitive fields within data sources and applies masking rules. This ensures that unauthorized users cannot access real sensitive data during SQL workbench queries or data exports. The feature is accessed via Data Security → Data Masking in the project navigation bar.

  10. Overview of SQLE SQL Optimization features

    SQLE v4 provides intelligent SQL rewriting and tuning suggestions to help developers and DBAs improve SQL execution efficiency. The optimization suite consists of two primary functions: SQL Rewriting (automated performance improvements) and SQL Tuning (tuning suggestions based on execution plans).

  12. Overview of SQLE Knowledge and Rules

    SQLE's auditing capabilities are built upon a foundation of knowledge and rules, which consist of a knowledge base containing accumulated operational experience and the ability for users to define custom auditing rules. For a complete list of auditing rules and supported data sources, refer to the Resource Overview (located in the Platform Management module).