> ## 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 需要能访问目标数据库，才能采集慢查询并巡检数据库对象。接入在实例概览页的「+ 添加实例」入口启动，按向导分四步完成。

<Frame caption="实例概览页：查询实例与「+ 添加实例」入口">
  <img src="https://mintcdn.com/pawsql/cdtFYB4QMM1nGHhK/images/performance/patrol-instance-list.png?fit=max&auto=format&n=cdtFYB4QMM1nGHhK&q=85&s=c25451d9a52c6bbe8fdc04c5d1177dc7" alt="实例概览" width="1920" height="889" data-path="images/performance/patrol-instance-list.png" />
</Frame>

## 准备工作

目标数据库对 PawSQL 服务端网络可达，已开启慢查询日志，且连接账号具备所需权限。

## 操作步骤

按向导四步完成：选择实例类型、填写数据库连接、配置慢查询、配置库巡检。

## 第一步：选择实例类型

选择目标数据库的类型。类型决定连接协议、慢查询日志的采集方式，以及可用的巡检模板与审核规则。

<Frame caption="选择实例类型：共 19 种数据库，部分类型标注 beta">
  <img src="https://mintcdn.com/pawsql/cdtFYB4QMM1nGHhK/images/performance/patrol-select-instance-type.png?fit=max&auto=format&n=cdtFYB4QMM1nGHhK&q=85&s=be0b36a95f72859d813806807b128eb3" alt="选择实例类型" width="1920" height="889" data-path="images/performance/patrol-select-instance-type.png" />
</Frame>

支持 19 种数据库类型，其中 MySQL、PostgreSQL、OpenGauss、TDSQL PostgreSQL（分布式/集中式）为正式版本，其余标注 beta：

| 类型                    | 状态   |
| --------------------- | ---- |
| MySQL                 | 正式   |
| PostgreSQL            | 正式   |
| OpenGauss             | 正式   |
| TDSQL PostgreSQL（分布式） | 正式   |
| TDSQL PostgreSQL（集中式） | 正式   |
| Oracle                | beta |
| SQL Server            | beta |
| 达梦（Dameng）            | beta |
| GaussDB（分布式）          | beta |
| GaussDB for DWS       | beta |
| 电科金仓（Kingbase）        | beta |
| MogDB                 | beta |
| OceanBase（MySQL）      | beta |
| OceanBase（Oracle）     | beta |
| PolarDB-X 2.0         | beta |
| RDS MySQL             | beta |
| TDSQL MySQL 集中式（私有云）  | beta |
| TDSQL MySQL 分布式（公有云）  | beta |
| TDSQL MySQL 分布式（私有云）  | beta |

## 第二步：数据库连接

填写实例名称与连接信息：主机、端口、用户名、密码、目标数据库（或 Schema）。页面上方同时展示「实例设置指南」，按目标数据库类型给出开启慢查询日志、授权等前置要求。

<Frame caption="数据库连接步骤：连接信息表单与实例设置指南">
  <img src="https://mintcdn.com/pawsql/cdtFYB4QMM1nGHhK/images/performance/patrol-add-instance.png?fit=max&auto=format&n=cdtFYB4QMM1nGHhK&q=85&s=6176a31bb22392f80363cdf2bb30ad6a" alt="数据库连接" width="1920" height="889" data-path="images/performance/patrol-add-instance.png" />
</Frame>

<Steps>
  <Step title="实例名称">
    用于在实例清单中标识该实例，建议包含数据库类型与业务含义。
  </Step>

  <Step title="主机与端口">
    目标数据库的地址与端口。该地址由 PawSQL 服务端访问，而非浏览器。
  </Step>

  <Step title="用户名与密码">
    用于连接数据库的账号，需具备采集慢查询与读取元数据所需的权限。
  </Step>

  <Step title="数据库">
    目标库名（或 Schema），决定采集与巡检的范围。
  </Step>
</Steps>

### 连接校验在服务端执行

「检测」或「完成」触发的连接校验在 PawSQL 服务端执行，即 PawSQL 后端去连接目标数据库，而不是浏览器直接连接。因此：

* `127.0.0.1` 或 `localhost` 指 PawSQL 服务端自身的回环地址，通常无法访问到你的数据库；
* 目标数据库需对 PawSQL 服务端的网络出口开放（防火墙、安全组、白名单）；
* 校验失败时，优先检查网络连通性与账号权限，而不是浏览器所在机器。

## 第三步与第四步

数据库连接通过后，向导继续进入「慢查询配置」与「库巡检配置」，分别见[慢查询采集](/user-guide/performance/collect-slow-sql)与[对象巡检任务](/user-guide/performance/patrol-task)。

## 预期结果

完成四步向导后，实例出现在实例概览页，慢查询与库巡检配置均通过验证。

## 提交前检查

* [ ] 实例类型与目标数据库一致；
* [ ] 主机、端口、用户名、密码、数据库填写正确；
* [ ] 数据库已开启慢查询日志（MySQL 为 `slow_query_log`）；
* [ ] 账号具备读取慢查询与元数据的权限；
* [ ] 数据库对 PawSQL 服务端网络可达；
* [ ] 连接信息已脱敏，未在共享文档中暴露密码。

## 常见问题

| 现象        | 优先检查                                         |
| --------- | -------------------------------------------- |
| 数据库连接验证失败 | 服务端网络可达性、防火墙/安全组、账号权限、地址是否误填为回环地址            |
| 慢查询配置检测失败 | 慢查询日志是否开启、`log_output` 是否为 `TABLE`、账号是否有读取权限 |
| 实例列表无实例   | 是否提交完成、当前团队/账号的可见范围                          |
| 连接长时间等待   | 目标数据库响应、服务端任务队列状态                            |

## 延伸阅读

<CardGroup cols={2}>
  <Card title="慢查询采集" href="/user-guide/performance/collect-slow-sql" />

  <Card title="对象巡检任务" href="/user-guide/performance/patrol-task" />
</CardGroup>