# PawSQL > PawSQL 让数据库性能优化自动化且可验证：SQL 审核、语义级查询重写、基于代价的索引推荐。文档内容面向工程师与 coding agents，检索友好。 > ## Agent Instructions > PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products. > 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit. > 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact. ## 开始使用 ### 快速开始 - [什么是 PawSQL?](https://docs.pawsql.com/getting-started/index.md): PawSQL 是一个面向开发人员、测试人员、数据库管理员与企业治理团队的 **SQL 工程与治理平台**，把 SQL质量检查、查询重写优化、智能索引推荐、自动化性能验证与执行计划分析整合到统一平台，覆盖 SQL 从开发到生产的全生命周期。 - [一分钟完成 SQL 优化](https://docs.pawsql.com/getting-started/quickstart.md): 从创建工作空间到获得 SQL 重写、索引推荐和性能验证结果，快速完成第一次 PawSQL 优化。 - [选择 PawSQL 使用方式](https://docs.pawsql.com/getting-started/choose-access.md): 根据数据边界、部署环境和工作流程，选择 PawSQL Cloud、私有部署及 Web、IDE 或自动化接入方式。 - [支持的数据库](https://docs.pawsql.com/getting-started/supported-databases.md): PawSQL 支持的数据库范围（关系型、国产、分布式与大数据），以及各数据库的能力支持矩阵。 ### 用户手册 - [用户手册概览](https://docs.pawsql.com/user-guide/index.md): PawSQL 用户手册提供面向实际任务的操作指南，帮助开发人员、DBA、审核人员、DevOps 工程师和平台管理员正确配置分析环境，并在研发、测试、发布和生产治理过程中使用 PawSQL。 #### 安装与接入 - [安装与接入概览](https://docs.pawsql.com/user-guide/installation/index.md): 根据使用方式完成 PawSQL Cloud、PawSQL Server、IDE 插件或 PawSQL MCP 的安装、登录与连接验证。 - [使用 PawSQL Cloud](https://docs.pawsql.com/user-guide/installation/pawsql-cloud.md): 通过浏览器访问 PawSQL Cloud，完成登录和首次SQL优化、审核或性能巡检功能。 - [部署 PawSQL Server](https://docs.pawsql.com/user-guide/installation/pawsql-server.md): 规划并完成 PawSQL Server 私有化部署、初始化和上线前验证。 - [安装 IDE 插件](https://docs.pawsql.com/user-guide/installation/ide-plugins.md): 在 DBeaver、JetBrains IDE 或 Visual Studio Code 中安装 PawSQL 插件并连接 PawSQL 服务。 - [登录与身份认证](https://docs.pawsql.com/user-guide/installation/authentication.md): 了解 PawSQL Web、IDE、MCP 和 API 的认证方式，安全管理账号、密码和访问令牌。 - [验证安装与连接](https://docs.pawsql.com/user-guide/installation/verify-installation.md): 使用分层检查方法验证 PawSQL 服务、认证、权限、工作空间和 SQL 分析链路。 #### 工作空间和上下文 - [工作空间概述](https://docs.pawsql.com/user-guide/workspaces/index.md): 了解 PawSQL 工作空间，并通过 DDL 或数据库连接为 SQL 审核和优化提供数据库上下文。 - [通过 DDL 创建工作空间](https://docs.pawsql.com/user-guide/workspaces/create-from-ddl.md): 使用表、视图和索引等 DDL 构建不依赖数据库连接的 PawSQL 工作空间。 - [通过数据库连接创建工作空间](https://docs.pawsql.com/user-guide/workspaces/create-from-database.md): 连接目标数据库并同步允许访问的 Schema、表、列、约束和索引，创建 PawSQL 工作空间。 #### SQL 优化 - [SQL 优化概览](https://docs.pawsql.com/user-guide/optimization/index.md): 使用 PawSQL 创建工作负载并提交 SQL，配置优化任务，查看摘要与详情结果，验证并落地重写与索引建议。 - [输入待优化 SQL](https://docs.pawsql.com/user-guide/optimization/create-workload.md): 从文本框、SQL 文件、数据库日志或 MyBatis Mapper 文件输入待优化的 SQL，构成优化任务的工作负载。 - [优化任务创建与配置](https://docs.pawsql.com/user-guide/optimization/setup-optimization.md): 配置优化任务的输入、验证、索引推荐和优化规则选项，控制重写与索引建议的产生方式。 - [查看优化结果](https://docs.pawsql.com/user-guide/optimization/explain-output.md): 从优化摘要进入每条 SQL 的详情，阅读重写、审查、索引推荐和性能验证结果，并对比优化前后的 SQL 与执行计划。 - [评估与落地建议](https://docs.pawsql.com/user-guide/optimization/apply-suggestions.md): 用统一的决策框架评估重写与索引建议的语义、兼容性、收益和成本，并在测试、审核后安全落地。 #### SQL 审核 - [SQL 审核概述](https://docs.pawsql.com/user-guide/sql-audit/index.md): 创建审核工单，识别质量、性能与安全风险，并推动修改、复核和放行。 - [创建审核工单](https://docs.pawsql.com/user-guide/sql-audit/create-review-task.md): 在创建审核工单页面填写标题、数据库、审核策略、优先级、工作空间与 SQL，提交并跟踪审核流程。 - [查看审核结果](https://docs.pawsql.com/user-guide/sql-audit/read-audit-results.md): 阅读 SQL 审核摘要和问题明细，定位触发规则、风险语句及处理建议。 - [处理审核问题](https://docs.pawsql.com/user-guide/sql-audit/resolve-findings.md): 对 SQL 审核问题进行确认、修改、复核和例外记录，形成可追踪的闭环。 - [人工复核与审批](https://docs.pawsql.com/user-guide/sql-audit/manual-review-and-approval.md): 在自动审核基础上完成人工复核、例外审批和放行记录。 - [审核历史、报告与导出](https://docs.pawsql.com/user-guide/sql-audit/history-reports-and-export.md): 查询 SQL 审核历史，复核工单配置，并导出和留存审核报告。 - [选择审核策略](https://docs.pawsql.com/user-guide/sql-audit/select-audit-policy.md): 在创建审核工单时选择匹配的审核策略：按数据库类型、环境与用途确定策略，核对规则、级别与阈值。 - [工作空间与审核上下文](https://docs.pawsql.com/user-guide/sql-audit/configure-review-context.md): 理解工作空间如何为 SQL 审核提供对象元数据，并在创建审核工单时选择匹配的工作空间。 - [高风险 SQL 管控](https://docs.pawsql.com/user-guide/sql-audit/high-risk-sql-control.md): 识别和处置高风险 SQL，并将审核结果接入发布门禁、例外审批和审计流程。 #### 巡检与慢查询治理 - [巡检与治理工作流](https://docs.pawsql.com/user-guide/performance/index.md): 性能巡检平台通过接入数据库实例、采集慢 SQL、巡检数据库对象，识别性能与结构风险，并支持批量优化和治理进度跟踪。 - [接入数据库实例](https://docs.pawsql.com/user-guide/performance/connect-instance.md): 在性能巡检平台添加实例，按选择实例类型、数据库连接、慢查询配置、库巡检配置四步完成接入，连接校验由服务端执行。 ##### 慢查询治理 - [慢查询采集](https://docs.pawsql.com/user-guide/performance/collect-slow-sql.md): 在慢查询配置步骤检测数据库慢查询日志并完成采集配置，通过手动采集或定时采集把慢 SQL 汇聚到巡检平台。 - [SQL 聚合与去重](https://docs.pawsql.com/user-guide/performance/aggregate-dedup.md): 慢查询采集后按 SQL 结构自动聚合去重，用「只展示业务SQL」过滤内部 SQL，从概要、SQL 类型、优化状态与平均耗时了解治理清单。 - [批量分析与优化](https://docs.pawsql.com/user-guide/performance/batch-optimize.md): 在慢查询页勾选慢 SQL 后通过批量操作发起优化、批量 AI 优化或忽略，并在创建优化任务页配置基础、验证、索引与规则参数。 - [创建优化任务工单](https://docs.pawsql.com/user-guide/performance/create-optimize-ticket.md): 在新建查询优化页把选中的慢 SQL 打包成优化任务工单，配置基础、验证、索引与规则参数并提交跟踪。 - [跟踪治理进度](https://docs.pawsql.com/user-guide/performance/track-progress.md): 通过慢查询页的优化状态、处置阶段与性能提升，以及实例概览的状态列，跟踪每条慢 SQL 和每个实例的治理进展。 ##### 数据库对象巡检 - [对象巡检任务](https://docs.pawsql.com/user-guide/performance/patrol-task.md): 在库巡检配置步骤选择巡检模板完成实例巡检配置，并通过手动巡检或定时巡检对数据库对象进行结构风险检查。 - [巡检任务报告](https://docs.pawsql.com/user-guide/performance/reports.md): 在数据库对象页查看巡检概要、风险级别分布、Top 审核规则与 Top 数据库对象，并下钻到每个表的巡查异常。 - [创建巡检问题工单](https://docs.pawsql.com/user-guide/performance/create-patrol-ticket.md): 把巡检报告中存在异常的对象打包成巡检问题工单，确认标题、优先级与关联对象后提交，进入整改跟踪。 #### 规则与审核策略 - [审核策略概述](https://docs.pawsql.com/user-guide/rules-policy/index.md): 审核策略定义需要检查的 SQL 规范、规则级别与参数阈值。本文概述全局与局部模板、规则分类与级别体系，并链接到具体配置操作。 - [审核策略管理](https://docs.pawsql.com/user-guide/rules-policy/rule-sets.md): 从内置全局模板创建审核策略：选择数据库类型与基础模板，三步完成规则配置，并在列表与详情页管理模板。 - [规则管理](https://docs.pawsql.com/user-guide/rules-policy/configure-rules.md): 在规则管理页按分类树、级别筛选与搜索浏览内置审核规则，查看每条规则的启用状态、类别、级别、阈值与父级节点。 - [配置 SQL 质量门禁](https://docs.pawsql.com/user-guide/rules-policy/quality-gate.md): 配置审批流与风险等级门槛（通知、警告、严重），决定允许创建工单的最高风险等级，建立 SQL 质量门禁。 #### 开发工具集成 - [开发工具集成概览](https://docs.pawsql.com/user-guide/dev-tools/index.md): 在 DBeaver、JetBrains IDE、Visual Studio Code 和支持 MCP 的 AI 编程工具中接入 PawSQL，把 SQL 审核与优化前移到开发工具。 - [在 DBeaver 中进行 SQL 执行前审核](https://docs.pawsql.com/user-guide/dev-tools/dbeaver.md): 安装和配置 PawSQL Client for DBeaver，在 SQL 执行前完成静态审核、高风险确认和结果查看。 - [在 JetBrains IDE 中优化 SQL](https://docs.pawsql.com/user-guide/dev-tools/jetbrains.md): 安装和配置 PawSQL Client for JetBrains，优化选中的 SQL、SQL 文件、目录或 MyBatis Mapper。 - [在 Visual Studio Code 中优化 SQL](https://docs.pawsql.com/user-guide/dev-tools/vscode.md): 安装和配置 PawSQL Client for VS Code，在代码或 SQL 文件中快速优化选中的 SQL。 - [使用 PawSQL MCP 优化 SQL](https://docs.pawsql.com/user-guide/dev-tools/mcp.md): 在支持 MCP 的 AI 编程工具中连接 PawSQL，选择合适的数据库上下文，并安全地获取 SQL 重写、索引推荐和性能验证结果。 #### CI/CD 与平台集成 - [CI/CD 与平台集成概览](https://docs.pawsql.com/user-guide/cicd/index.md): 使用预置连接器或 OpenAPI，将 PawSQL SQL 审核接入代码提交、合并请求和发布流水线。 - [集成流程与核心概念](https://docs.pawsql.com/user-guide/cicd/concepts.md): 了解 PawSQL CI/CD 集成中的事件、SQL 变更集、工作空间、审核策略和门禁结果。 - [接入前准备与安全要求](https://docs.pawsql.com/user-guide/cicd/prerequisites.md): 在连接代码仓库或流水线前，准备 PawSQL 服务、账号权限、工作空间、网络和安全控制。 - [SQL 质量门禁与结果回传](https://docs.pawsql.com/user-guide/cicd/pipeline-gate.md): 将 PawSQL 审核结果转换为通过、警告或阻断结论，并反馈到代码仓库和流水线。 - [代码仓库连接器](https://docs.pawsql.com/user-guide/cicd/repositories.md): 使用 PawSQL 预置连接器接入腾讯 CODING、GitHub 和 GitLab，在提交与合并请求阶段审核 SQL。 - [集成腾讯 CODING](https://docs.pawsql.com/user-guide/cicd/coding.md): 使用 PawSQL 预置代码仓库连接器，在腾讯 CODING 提交和合并请求阶段审核 SQL。 - [集成 GitHub](https://docs.pawsql.com/user-guide/cicd/github.md): 使用 PawSQL 预置代码仓库连接器，在 GitHub Push 和 Pull Request 阶段审核 SQL。 - [集成 GitLab](https://docs.pawsql.com/user-guide/cicd/gitlab.md): 使用 PawSQL 预置代码仓库连接器，在 GitLab Push 和 Merge Request 阶段审核 SQL。 - [集成蓝鲸流水线](https://docs.pawsql.com/user-guide/cicd/blueking.md): 使用 PawSQL 预置连接器在蓝鲸流水线中审核 SQL，并根据质量门禁控制后续步骤。 - [OpenAPI 流水线集成](https://docs.pawsql.com/user-guide/cicd/openapi-pipeline.md): 在任意 CI/CD 流水线中调用 PawSQL，提交变更 SQL、等待审核结果并设置构建状态。 - [接入未预置的平台](https://docs.pawsql.com/user-guide/cicd/unsupported-platforms.md): 评估未提供预置连接器的 CI/CD 与企业自研平台，选择 OpenAPI、Webhook 或企业集成服务完成 SQL 审核接入。 - [Webhook 集成机制](https://docs.pawsql.com/user-guide/cicd/webhook.md): 了解事件驱动集成中的签名、过滤、异步处理、重试和重复事件控制。 - [CI/CD 集成故障排查](https://docs.pawsql.com/user-guide/cicd/logs-troubleshooting.md): 根据现象排查 Webhook、SQL 提取、认证、工单处理、质量门禁和结果回传问题。 ## 使用场景与核心能力 ### 使用场景 - [使用场景概述](https://docs.pawsql.com/use-cases/index.md): 从开发阶段 SQL 优化、CI/CD SQL 质量门禁，到生产慢 SQL 治理、数据库迁移和企业级 SQL Governance，PawSQL 覆盖 SQL 从编写、审核、发布到生产优化的完整生命周期。 - [开发者 SQL 智能优化助手](https://docs.pawsql.com/use-cases/developer-sql-copilot.md): 在编码阶段分析、优化并验证 SQL，帮助开发人员在代码提交前发现并解决 SQL 性能风险。 - [CI/CD SQL 质量门禁](https://docs.pawsql.com/use-cases/sql-quality-gate-cicd.md): 将 SQL质量检查、风险检测和性能分析嵌入 CI/CD 流程，在 SQL 进入生产之前自动拦截高风险语句与不符合规范的数据库变更。 - [生产慢 SQL 批量治理](https://docs.pawsql.com/use-cases/slow-sql-optimization.md): 从慢查询采集、SQL 归一化到查询重写优化、智能索引推荐与执行计划验证，PawSQL 帮助 DBA 把生产慢 SQL 治理从人工逐条排查升级为自动化、规模化的性能工程流程。 - [信创 / 数据库迁移中的 SQL 治理](https://docs.pawsql.com/use-cases/database-migration-sql-governance.md): 在数据库迁移和信创改造过程中，PawSQL 帮助企业批量识别 SQL 兼容性与性能风险，分析目标数据库执行计划，提供 SQL 重写和索引优化建议，降低迁移后的性能回退风险。 - [企业统一 SQL 治理平台](https://docs.pawsql.com/use-cases/enterprise-sql-governance.md): 面向多团队、多数据库和复杂研发流程，PawSQL 帮助企业建立统一的 SQL 治理平台，覆盖开发、交付、生产和持续优化，形成端到端的 SQL 全生命周期治理体系。 ### 核心能力 - [核心能力概览](https://docs.pawsql.com/features/index.md): 探索 PawSQL 在 SQL 质量、SQL 优化、性能分析、SQL 治理与研发集成方面的核心能力。 - [SQL质量检查](https://docs.pawsql.com/features/sql-review.md): 使用 PawSQL 在 SQL 进入测试、发布或生产环境之前发现规范、风险、兼容性和潜在性能问题。 - [查询重写优化](https://docs.pawsql.com/features/automatic-sql-rewrite.md): 使用 PawSQL 自动识别低效 SQL 写法，并生成语义等价且更高效的查询重写优化方案。 - [智能索引推荐](https://docs.pawsql.com/features/index-recommendation.md): 基于 SQL 结构、谓词、Join、排序、聚合与现有索引，生成并验证更有效的索引方案。 - [自动化性能验证](https://docs.pawsql.com/features/performance-validation.md): 使用目标数据库优化器、执行计划与 Cost 对比验证查询重写优化和索引优化是否真正有效。 - [执行计划分析](https://docs.pawsql.com/features/execution-plan-visualization.md): 将复杂数据库执行计划转换为更易理解的图形结构，帮助快速定位高成本算子、扫描、Join、排序与数据流问题。 - [分布式 SQL 优化](https://docs.pawsql.com/features/distributed-sql-optimization.md): 针对分布式数据库中的分布键、跨分片 Join、数据移动、复制表和全局/局部索引等问题进行 SQL 优化。 - [大数据 SQL 优化](https://docs.pawsql.com/features/big-data-sql-optimization.md): 针对 Hive 等大数据 SQL 的分区裁剪、分桶 Join、数据倾斜、聚合、窗口函数和全局排序进行专项优化。 ## API ### CI/CD 集成接口 #### SQL审核任务 - [创建审核任务](https://docs.pawsql.com/api-reference/sql审核任务/创建审核任务.md): 外部集成平台调用此接口创建 SQL 审核任务。 支持幂等（通过 requestId），支持多种 SQL 来源（文本、部署包、提交、合并请求、目录）。 - [查询审核结果](https://docs.pawsql.com/api-reference/sql审核任务/查询审核结果.md): 通过任务ID查询SQL审核任务的状态和结果。 - [查询工作空间ID](https://docs.pawsql.com/api-reference/sql审核任务/查询工作空间id.md): 根据工作空间名称和环境查询工作空间ID及推荐规则模板。 无需登录认证，供集成平台查询配置使用。 #### GitLab Webhook - [GitLab Webhook回调](https://docs.pawsql.com/api-reference/gitlab-webhook/gitlab-webhook回调.md): 接收 GitLab Push/Merge Request 事件，自动提取变更 SQL 并触发审核。 #### Coding Webhook - [Coding Webhook回调](https://docs.pawsql.com/api-reference/coding-webhook/coding-webhook回调.md): 接收 Coding Push/Merge Request 事件，自动提取变更 SQL 并触发审核。 #### GitHub Webhook - [GitHub Webhook回调](https://docs.pawsql.com/api-reference/github-webhook/github-webhook回调.md): 接收 GitHub Push/Pull Request 事件，自动提取变更 SQL 并触发审核。 ### 优化服务接口 #### 身份认证 - [获取 UserKey](https://docs.pawsql.com/api-reference/身份认证/获取-userkey.md): 通过邮箱和密码登录，获取 userKey（激活码），用于后续 API 调用的身份认证。 - [校验 UserKey](https://docs.pawsql.com/api-reference/身份认证/校验-userkey.md): 校验 userKey 是否有效，可用于客户端启动时验证激活码可用性。 #### 工作空间 - [创建工作空间](https://docs.pawsql.com/api-reference/工作空间/创建工作空间.md): 创建工作空间并返回 workspaceId，支持离线模式（DDL 文本）和在线模式（数据库连接）。 - [查询工作空间列表](https://docs.pawsql.com/api-reference/工作空间/查询工作空间列表.md): 获取当前用户的所有工作空间列表（分页）。 #### 优化任务 - [创建优化任务（同步）](https://docs.pawsql.com/api-reference/优化任务/创建优化任务（同步）.md): 创建 SQL 优化任务，**同步等待优化完成后返回结果**。适用于短查询或客户端可以长时间等待的场景。 - [创建优化任务（异步）](https://docs.pawsql.com/api-reference/优化任务/创建优化任务（异步）.md): 创建 SQL 优化任务后立即返回，通过 `/getAnalysisSummary` 轮询优化结果。 适用于长查询或需要避免 HTTP 超时的场景。 - [查询优化汇总](https://docs.pawsql.com/api-reference/优化任务/查询优化汇总.md): 通过优化任务 ID 或名称查询优化汇总信息。 - [查询优化任务列表](https://docs.pawsql.com/api-reference/优化任务/查询优化任务列表.md): 获取当前用户（指定工作空间）的优化任务列表（分页）。 - [查询语句优化详情](https://docs.pawsql.com/api-reference/优化任务/查询语句优化详情.md): 通过语句 ID（`analysisStmtId`）查询单条 SQL 的优化详情， 包括重写建议、索引推荐、执行计划对比等。 ## OpenAPI Specs - [pawsql-integration](/openapi/pawsql-integration.yaml) - [pawsql-optimization](/openapi/pawsql-optimization.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [English (89 pages)](https://docs.pawsql.com/_llms/en.md): Documentation for English.