> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pawsql.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## 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 服务、认证、权限、工作空间和 SQL 分析链路。

安装或配置完成后，应验证完整使用链路，而不只是确认页面能够打开。推荐按照“服务—认证—权限—上下文—任务”的顺序检查，这样更容易定位问题所在。

## 目标

使用分层检查方法验证 PawSQL 服务、认证、权限、工作空间和 SQL 分析链路。

## 准备工作

已部署 PawSQL 服务（Cloud 或 Server），并准备好非生产工作空间和脱敏只读测试 SQL。

## 操作步骤

按「服务—认证—权限—上下文—任务」的顺序逐项验证整条链路。

## 验证范围

```mermaid theme={null}
flowchart LR
    A["服务可访问"] --> B["身份认证成功"]
    B --> C["组织与权限正确"]
    C --> D["工作空间可用"]
    D --> E["SQL 任务成功"]
```

## 1. 验证服务访问

* [ ] 使用预期的域名或服务地址打开 PawSQL。
* [ ] HTTPS 证书可信，域名与证书匹配。
* [ ] 页面能够正常加载，没有代理、跨域或网关错误。
* [ ] IDE 或 MCP 所在设备能够访问同一服务地址。
* [ ] PawSQL Server 管理员确认核心服务运行正常。

如果 Web 可以访问而 IDE 或 MCP 无法访问，应重点检查客户端代理、证书信任和网络区域差异。

## 2. 验证身份认证

* [ ] Web 用户可以正常登录。
* [ ] 登录后显示的账号与预期一致。
* [ ] IDE、MCP 或 API 使用的访问凭据仍在有效期内。
* [ ] 认证失败时不会在日志中输出完整密码或令牌。

## 3. 验证权限

* [ ] 可以进入正确的组织或项目。
* [ ] 能够看到角色需要的菜单。
* [ ] 能够查看或创建测试工作空间。
* [ ] 能够创建 SQL 优化测试任务。
* [ ] 普通用户无法访问不属于其职责的管理功能。

<Tip>
  “登录成功但看不到资源”通常是权限或组织范围问题；“无法登录”才优先检查认证配置。
</Tip>

## 4. 验证工作空间

选择已有测试工作空间，或创建一个最小工作空间：

* [ ] 数据库类型和版本正确。
* [ ] DDL 导入成功，或数据库连接测试成功。
* [ ] 可以查看测试 SQL 涉及的表和列。
* [ ] 需要智能索引推荐时，工作空间包含必要的索引信息。
* [ ] 当前用户具有使用该工作空间的权限。

如果数据库连接失败，应从 PawSQL Server 所在网络检查数据库地址、端口、白名单、TLS 和账户权限。

## 5. 验证 SQL 分析

使用一条脱敏且只读的测试查询完成验证。

<Steps>
  <Step title="选择测试工作空间">
    核对数据库类型、版本和 Schema，避免选择生产工作空间。
  </Step>

  <Step title="提交测试 SQL">
    输入完整查询语句并启动 SQL 优化或审核。
  </Step>

  <Step title="等待任务完成">
    确认任务从等待或执行状态进入完成状态。
  </Step>

  <Step title="核对分析结果">
    确认 SQL 解析成功，并能看到原始 SQL、分析上下文和结果详情。
  </Step>

  <Step title="记录测试结果">
    保存 PawSQL 版本、工作空间、任务编号、测试时间和验证结论。
  </Step>
</Steps>

## 客户端专项验证

<Tabs>
  <Tab title="IDE 插件">
    * 插件已经启用且版本符合要求；
    * 连接测试成功；
    * 可以选择项目和工作空间；
    * 选中 SQL 后可以收到 PawSQL 返回的结果。
  </Tab>

  <Tab title="PawSQL MCP">
    * MCP 服务可以启动；
    * 客户端能够发现 PawSQL 工具；
    * 工具调用使用正确的服务和账号；
    * 脱敏测试 SQL 可以成功返回分析结果。
  </Tab>

  <Tab title="OpenAPI">
    * 认证请求成功；
    * 可以创建测试任务；
    * 可以查询任务状态和结果；
    * 错误响应不会泄露凭据。
  </Tab>
</Tabs>

## 问题定位表

| 现象       | 优先检查                   |
| -------- | ---------------------- |
| 页面无法打开   | 服务状态、地址、DNS、代理、防火墙、证书  |
| 无法登录     | 账号、密码、统一身份认证、系统时间、服务环境 |
| 登录后无菜单   | 角色、项目、License、功能开关     |
| 客户端连接失败  | 服务地址、令牌、代理、证书信任        |
| 没有工作空间   | 组织成员关系、工作空间权限、项目范围     |
| SQL 解析失败 | 数据库方言、版本、语句完整性、参数和分隔符  |
| 表或列无法识别  | Schema、DDL、元数据同步、对象大小写 |
| 任务长时间等待  | 分析服务、任务队列、并发与系统资源      |

## 验收记录建议

生产上线或团队推广前，建议保存以下信息：

* PawSQL 产品和版本；
* 部署环境与服务地址；
* 验证日期和负责人；
* 浏览器、IDE 或 MCP 客户端版本；
* 测试账号角色；
* 测试工作空间和数据库类型；
* 测试任务编号；
* 通过项、未通过项和后续负责人。

<Warning>
  验收记录中不要包含密码、完整访问令牌、数据库连接串或未脱敏的生产 SQL。
</Warning>

## 下一步

<CardGroup cols={2}>
  <Card title="创建工作空间" href="/user-guide/workspaces/index" />

  <Card title="一分钟完成 SQL 优化" href="/getting-started/quickstart" />
</CardGroup>
