# PostgreSQL 资源

> 核验版本：1.1.0；通道：stable；文档 ID：resource.postgresql

连接项目自己的 PostgreSQL 数据库，执行 SQL、事务、数据库 GraphQL、CRUD，并可启用业务数据审计。这不是访问 Viat 平台数据库的入口。应使用最小权限的应用角色，而非超级用户。

本页核对 Viat 1.1.0 稳定版。示例使用合成值/服务桩，未执行、未连接真实服务、未发送消息。先读[资源总览](index.md)。

## 前置条件与权限

先准备数据库与角色，并允许所有 API 节点访问。授予 CONNECT、schema USAGE 以及操作所需的表和序列权限。安装审计还需创建审计表、函数和表触发器的权限；资源 Test 不负责安装审计。

## 完整配置字段

表中“必填”描述结构解析；提供方/后端的条件必填、运行时默认及限制在下节补充。`null` 仅在类型明确允许时可用，数字格式的存储上限不等于有意义的业务范围。不要依赖未知键被忽略来检测拼写。

### `plain`

| 字段 | 类型/允许值 | 必填 | 省略默认 | 约束 | 含义 |
| --- | --- | --- | --- | --- | --- |
| `plain.audit` | AuditConfig / null | 否；可能条件必填 | `null` | — | 仅 PostgreSQL 的业务审计声明，保存可安装 DDL。 |
| `plain.authz_tables` | map<string, AuthzTableBinding> | 否；可能条件必填 | `{}` | — | 暴露表 → 授权类型或 {type,actions}，有绑定的引擎拒绝未绑定表。 |
| `plain.database` | string | 是 | — | — | 目标业务数据库，不是平台数据库。 |
| `plain.graphql_overlay` | string / null | 否；可能条件必填 | `null` | — | 数据库 GraphQL 引擎的 TOML 覆盖层，不是 GraphQL 请求。 |
| `plain.graphql_schemas` | array&lt;string&gt; | 否；可能条件必填 | `[]` | — | 有序 PostgreSQL schema，空表示 public，后续 schema 加前缀。 |
| `plain.host` | string | 是 | — | — | 服务主机名/IP，不是 URL 或凭据。 |
| `plain.port` | integer | 是 | — | minimum: 0; format: "uint16"; 0–65535 | TCP 端口，必填时须显式提供，TLS 不会推导端口。 |
| `plain.ssl` | boolean | 否；可能条件必填 | `false` | — | 存储的 TLS 偏好，运行时版本限制见下文。 |

#### `AuditConfig`

未知键会被拒绝。

| 字段 | 类型/允许值 | 必填 | 省略默认 | 约束 | 含义 |
| --- | --- | --- | --- | --- | --- |
| `AuditConfig.lock_down` | boolean | 否；可能条件必填 | `true` | — | 尝试撤销资源角色对审计表 UPDATE/DELETE，默认 true。 |
| `AuditConfig.schema` | string / null | 否；可能条件必填 | `"public"` | — | 审计表/函数的 schema，默认 public。 |
| `AuditConfig.table` | string / null | 否；可能条件必填 | `"viat_audit"` | — | 审计/元数据表名，运行时默认见下文。 |
| `AuditConfig.tables` | array&lt;AuditTable&gt; | 否；可能条件必填 | `[]` | — | 被审计表名或逐表完整声明。 |
| `AuditConfig.unattributed` | AuditUnattributed / null | 否；可能条件必填 | `"deployment (reject by default)"` | — | 未归属写入策略 reject/record，省略用部署默认 reject。 |

#### `AuditTable`

实际输入是表名字符串，或以下对象；导出 schema 暴露规范化结构，不能将其三个 required 字段直接当作写入要求。

| 字段 | 类型/允许值 | 必填 | 省略默认 | 约束 | 含义 |
| --- | --- | --- | --- | --- | --- |
| `AuditTable.ignore_columns` | array&lt;string&gt; | 否；可能条件必填 | `[]` | — | 仅从更新字段行抑制这些列，默认 []。 |
| `AuditTable.name` | string | 是 | — | — | 被审计表名，可带 schema，裸名表示 public。 |
| `AuditTable.reason_required` | boolean | 否；可能条件必填 | `false` | — | 缺审计原因则拒绝写，默认 false。 |

#### `AuditUnattributed`

允许结构/值：`"reject" / "record"`。

#### `AuthzTableBinding`

允许结构/值：`string / AuthzTableMapping`。

字符串是授权类型简写；对象使用下方 AuthzTableMapping。映射键为暴露表名，不是任意数据库限定名。

#### `AuthzTableMapping`

未知键会被拒绝。

| 字段 | 类型/允许值 | 必填 | 省略默认 | 约束 | 含义 |
| --- | --- | --- | --- | --- | --- |
| `AuthzTableMapping.actions` | map<string, string> | 否；可能条件必填 | `{}` | — | 隐含 read/create/update/delete → 模型操作名，未列项保留同名。 |
| `AuthzTableMapping.type` | string | 是 | — | — | 长形式表绑定中的授权模型类型名。 |

### `secret`

| 字段 | 类型/允许值 | 必填 | 省略默认 | 约束 | 含义 |
| --- | --- | --- | --- | --- | --- |
| `secret.password` | string | 是 | — | — | 账号密码/应用密码，不应作为明文配置。 |
| `secret.user` | string | 是 | — | — | 数据库登录用户，与 secret 一起加密。 |

## 运行规则、默认值与限制

`port` 必填，不会自动取 5432。`ssl` 在存储契约中默认 false，但 1.1.0 PostgreSQL 运行时 SQL/GraphQL 池和 Test 均未将其应用到 PgConnectOptions，实际使用驱动默认 TLS 协商。不能靠这个开关强制 TLS 或验证对端，应在部署/数据库侧强制传输要求并独立验证实际连接。`graphql_schemas: []` 表示 `["public"]`，保存拒绝空名、首尾空白和重复名，schema 存在性/引擎兼容性在内省时检查；第一项占用无前缀表名，后续 schema 使用前缀（audit.orders → audit_orders）。该设置不改变原生 SQL 的 search_path。`graphql_overlay` 为 TOML，保存检查语法，构建引擎时检查表和关系语义。已移除的非空 `graphql_scope` 会被拒绝，应改用 `authz_tables`。

`authz_tables` 将暴露的表名映射到授权类型字符串，或 `{ "type": "record", "actions": {"read":"list"} }`。隐含操作为 read/create/update/delete，未映射项保留同名操作。类型和显式重映射的目标操作必须存在；省略的同名操作保存时不检查，可以不存在（例如类型有意不声明 delete）。只要绑定了一张表，GraphQL/CRUD 策略面上的未绑定表就会拒绝访问。原生 `.query`/`.execute` 故意不执行这种行级过滤，须自行检查租户边界。Test 会对照实际 schema 检查绑定，且可能返回 `schema_warnings`。

`audit` 仅支持 PostgreSQL。`audit.tables` 每项为 `"public.orders"`（裸名 `orders` 指 public），或 `{name, reason_required:false, ignore_columns:[]}`。忽略列只抑制更新的字段记录，不会从插入/删除快照中删除。`unattributed` 可为 reject/record，省略则使用部署设置（默认 reject）。审计表和 schema 默认 viat_audit/public，`lock_down` 默认 true。保存会用资源凭据真正协调 DDL：被审计表须已存在并有可用主键。写 reason_required 表时必须提供原因；失败会拒绝业务写入，而不仅是跳过日志。

## 权限、身份与保存语义

管理 API 需要平台登录及项目成员身份。列举/查看需要成员身份；创建、PUT、PATCH、Test、refresh、copy、delete 需要有效项目角色 Owner/Admin/Developer；较低权限的 operator 角色不可写。管理权限不自动赋予上游账号权限，也不替代运行时的 s3/file/行级授权。MCP 只开放其工具清单实际声明的能力，不能把资源 schema 当作完整 MCP CRUD。

- 创建：`POST /projects/{slug}/resources`，请求为 `{name,folder?,kind,plain,secret}`。name 长度 1–64 字节且不可含 /；system 为保留名。folder 省略/空字符串表示根，非空为 [A-Za-z0-9_-]+ 段，最多 8 层/255 字节，无首尾或连续 /。
- 资源身份为同项目 `(folder,name)`，不是全项目裸名。同名可以位于不同文件夹。详情路由用 `/resources/{name}?folder=team` 显式定位；CLI 用 `team/name`。脚本裸引用按自身文件夹、根、全项目唯一名顺序解析，建议跨文件夹显式限定，Python 用 `getattr(ctx.resources, "team/name")`，TypeScript 用 `ctx.resources["team/name"]`，而非属性链。
- PUT 是完整替换：须重发正确 kind、完整 plain 与全部要保留的秘密值，不能从 show 的掩码恢复秘密。PATCH 的 kind 固定；省略 plain 保留，提供 plain 则整体替换（不是深合并）；secret 仅逐字段覆盖，省略字段保留。移动 folder 时引用在新位置重检。
- 清除可选秘密用 PATCH 显式 null（仅允许 null 的字段）或空字符串（仅允许空值的字段）；必需/条件必需字段不能清空。清除可选 plain 字段需发送去掉该字段的完整 plain，让类型默认/缺省生效。不要用 null 代替所有类型，也不要把 *** 当作旧值。
- `$keep` 是仅 PATCH/仓库同步使用的**顶层 plain 字段**占位符，保留服务端已有同名字段，连数字/布尔也可保留；新资源/不存在字段不能使用。嵌套 `$keep` 不是深合并指令。
- 仓库文件 `resources/<folder>/<name>.yaml` 由路径承载 folder，name 仍是裸名。`viat pull` 将 secret 字段写为字符串 `$secret`；`viat push` 去掉这些占位（也接受旧 !secret 标签），对已有资源 PATCH，绝不把占位当凭据。新资源必须先安全提供实际必需秘密；占位不能创建凭据。顶层 allowed_authorizers 是仓库访问同步元数据，不要擅自塞进 plain。

`$secret` 占位与凭据引用不同：`{"$secret":"name"}` 在 config/cloud 支持位置命名另一个 secret 资源；HTTP/GraphQL 字符串头用整个 `"$secret:name"`。它们不等于秘密明文，保存/读取/导出保留引用，使用时解析。目标按消费资源文件夹锚定并须已存在且为 secret 类型，不能用字符串拼接插值。

公开响应含资源标识、kind、folder、plain 及秘密摘要，不返回秘密值；摘要 *** 表示该种类声明的字段，不证明每个可选凭据实际已填。plain 会原样可读/导出；secret 通过部署秘密后端加密。脚本/依赖的发布版本按快照规则冻结，uses 无 (live) 时亦冻结，不可把所有依赖描述为每次读 live；资源读取/代理操作和显式实时 secret IO 是不同边界。

## 脚本秘密边界

**1.1.0 兼容/安全限制：** 本类型实际运行投影仍向 worker 注入含凭据连接 URL，虽然下列推荐操作由平台代理且不需要它。脚本及其依赖树应视为能接触该凭据。不要记录/返回整个资源，不要提取 URL 到应用代码；优先代理助手与最小上游权限。静态加密和 CRUD 掩码不能消除此 worker 暴露。

## 最小配置：管理 API / CLI 文件

下面是创建请求 JSON，同时也是合法 YAML，可作为 `resource.yaml` 交给真实 CLI 命令。域名/凭据均为测试值，生产使用前须替换并完成前置条件；不要把真实 secret 文件提交仓库。

```json
{
  "name": "demo",
  "folder": "",
  "kind": "postgresql",
  "plain": {
    "host": "postgres.example.test",
    "port": 5432,
    "database": "demo",
    "ssl": true
  },
  "secret": {
    "user": "demo_reader",
    "password": "fixture-password-not-a-credential"
  }
}
```

```sh
viat project select <slug>
viat resource create --file resource.yaml
viat resource show demo --json
```

等价 API 为 `POST /projects/{slug}/resources`（相对实例管理 API 根），请求体如上。预期得到已保存资源的公开表示和掩码摘要，不是秘密回显；示例名已存在则 409。仓库同步时去掉 folder，把配置放 `resources/demo.yaml`；`viat push` 可同步完整 plain 及未被占位过滤的 secret。创建成功不保证每个远程动作成功。

## SDK 操作与示例

Python/TypeScript：`query(sql, params={})` 返回 `{rows, affected}`；`execute` 返回影响行数（丢弃 RETURNING 行）；`graphql(document, variables={})` 返回 data 对象；事务使用 Python 的 `transaction()` 上下文管理器或 TypeScript 的 `transaction(async tx => …)` 回调。tx 提供 query/execute/graphql 和 `set_reason`，reason 仅适用于 PostgreSQL。参数写作 `:name`，缺失值绑定 NULL，对象和数组绑定为 JSON 文本而非 PostgreSQL 原生数组。需要 RETURNING 时用 query。事务中任何语句失败都会使整个代理事务失效并回滚，即使脚本捕获该错误也不例外。

这两个完整脚本均声明同一个根资源 demo；在获批准的测试运行中使用。写入、发送、构建和数据删除不是 dry-run。

### Python

```python
# @resource demo
from viat import ctx

def main():
    return ctx.resources.demo.query("SELECT :n AS answer", {"n": 42})
```

### TypeScript

```typescript
// @resource demo
import { ctx } from "viat";

export async function main() {
  return await ctx.resources.demo.query("SELECT :n AS answer", { n: 42 });
}
```

### Rust

Rust 的已验证表面是 `ctx.resource(name)` 的通用 `call(op,req)`（library 用 `ctx.library`）；不是照搬 Python 方法名。下面展示对应协议调用，返回原始操作结果，可能不同于上方复合示例。

```rust
// @resource demo
use serde_json::{json, Value};
use viat::{Ctx, Error};

fn main() {
    viat::serve(|ctx: &Ctx, _args: Value| -> Result<Value, Error> {
        ctx.resource("demo").call("sql_query", json!({"sql":"SELECT :n AS answer","params":{"n":42}}))
    });
}
```

Shell 没有方法装饰的 ctx.resources，仅有 JSON 环境投影；不能把上述方法名直接写成 shell 函数。binary 程序可按 worker 协议实现相应 RPC，并非自动拥有 Python/TypeScript 方法。sql 语言仅用于四种 SQL 数据源，viat_gql 仅用于 PostgreSQL/MySQL/SQLite，graphql 语言用于远程 graphql，llm 语言用于 llm；不支持的组合不会自动适配。

### 预期结果

连接可用的测试数据库后，示例返回含 answer = 42 的 rows 及 affected 计数。PostgreSQL 的精确数值/decimal 可能以字符串返回。无需预建业务表。

## Test 行为与副作用

建立一个连接，执行 SELECT 1 后关闭，再尽力执行 GraphQL 诊断。与 Test 不同，保存包含 audit 的资源可能安装或协调表、函数与触发器。

管理 API 使用 `POST /projects/{slug}/resources/{name}/test?folder=`；CLI 为 `viat resource test demo`。API 检查响应体 `ok`：连接失败通常仍为 HTTP 200 `{ok:false,error:"…"}`，可能附 `schema_warnings`，不能只检查状态码。CLI 失败会非零退出。仅在允许出站/文件动作后执行。

## 常见失败与恢复

`audit_reason_required`：补充请求或事务块的审计原因后重试。`audit_unsupported_kind` 针对其他 SQL 类型，不适用于本类型。以 graphql_overlay/graphql_schemas 开头的消息表示覆盖层语法或列表配置错误。授权类型或显式映射目标操作不存在会保存失败，隐含同名操作缺失不在保存时检查；表绑定错误会使 Test 失败。连接错误应分别检查 DNS、端口、权限与 TLS。

管理错误一般为 `{error,message}`。DTO 的 `resource.<kind>.*` 经常位于 400 `bad_request` 的 message，而非顶层 error；不要把它们当成所有运行时助手都会返回的统一枚举。401 先恢复平台登录，403 检查有效项目角色/运行时规则，404 检查 folder/name，409 先解决同名或 `resource_in_use` 引用。远程拒绝与平台拒绝分开诊断，重试前判断上一次动作是否可能已生效。

## 生产注意与清理

事务应短小，值必须绑定参数，表名等标识符不能靠值参数替代。DDL 后执行 `viat resource refresh demo`，让各节点下次使用时重建缓存 schema。业务数据和审计证据应独立于 Viat 备份。删除资源不会删除数据库或审计证据，但会删除指向该审计资源的授权规则。

通用删除步骤：先停用调用脚本、代理/CRUD 目标及相关触发器，迁移依赖并保留需要的证据，再用 `viat resource delete demo` 或 DELETE 详情路由。409 `resource_in_use` 时先重新绑定/删除消息指出的端点，不应强行绕过引用。删除配置资产不等于撤销第三方凭据、删除外部数据或回滚已发生副作用。

## 相关资源与维护依据

- [MySQL 资源](mysql.md)
- [SQLite 资源](sqlite.md)
- [SQL Server 资源](sqlserver.md)
- [受管 Storage 资源](storage.md)
- [资源总览](index.md)

固定契约：`contracts/1.1.0/resources.json` → `resource.postgresql`。

核对实现（产品仓库相对路径）：viat-core/src/types/resource.rs (KindSpec/Plain/Secret); viat-api/src/dto.rs (normalization/validation); viat-api/src/handlers/resources.rs (CRUD/Test); viat-runtime/src/resource_io.rs, resources_json.rs, python.rs, typescript.rs; viat-api/src/runner/broker.rs; viat-cli/src/main.rs and repo/resources.rs; viat-core/src/types/snapshot.rs.