# @alchemy\.run/sql 中文文档

规范地址：https://npmcn.com/package/%40alchemy.run/sql/

版本：2\.0\.0-beta\.85
npm 元数据更新时间：2026-11-02T21:08:03.726Z
中文译文更新时间：2026-11-05T17:27:19.976Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40alchemy.run/sql
原文对照：https://npmcn.com/package/%40alchemy.run/sql/?lang=original
项目主页：https://alchemy.run/
源码仓库：https://github.com/alchemy-run/alchemy

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：408 kB，113 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：pg ^8\.22\.0，effect ^4\.1\.0，mysql2 ^3\.24\.2，alchemy 2\.0\.0-beta\.85，@effect/sql-pg ^4\.1\.0，@effect/sql-libsql ^4\.1\.0，@effect/sql-mysql2 ^4\.1\.0
- 首次发布：2026-10-21T16:58:34.718Z
- 最新版本发布：2026-11-02T21:08:03.400Z
- 近 30 天下载量：374243（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

Postgres和MySQL客户端,SQL迁移,以及用于Alchemy的Postgres州立商店.

## 安装

```sh
npm install @alchemy.run/sql
```

也可以使用：`pnpm add @alchemy.run/sql`、`yarn add @alchemy.run/sql`、`bun add @alchemy.run/sql`

## README

# @alchemy.run/sql (中文(简体) )

SQL 为 [炼金术](https://alchemy.run/). 为 Postgres, MySQL 和 SQLite (libSQL) 键入效果 SQL 客户端,为每个数据库资源部署时间迁移,以及一个 Postgres 状态商店.

```sh
npm install alchemy @alchemy.run/sql @effect/sql-pg pg effect
```

从任何运行时间查询 Postgres 。 连接在请求的第一个查询中打开, 当请求结束时关闭, 所以在部署时没有连接 :

```typescript
// src/worker.ts
import * as Cloudflare from "@alchemy.run/cloudflare";
import * as SQL from "@alchemy.run/sql/Postgres";
import * as Config from "effect/Config";
import * as Effect from "effect/Effect";
import * as HttpServerResponse from "effect/http/HttpServerResponse";

export default Cloudflare.Worker(
  "Worker",
  { main: import.meta.url },
  Effect.gen(function* () {
    const sql = yield* SQL.Postgres({ url: Config.Redacted("DATABASE_URL") });

    return {
      fetch: Effect.gen(function* () {
        const users = yield* sql`SELECT * FROM users`;
        return yield* HttpServerResponse.json(users);
      }).pipe(Effect.orDie),
    };
  }),
);
```

同样的形状对 MySQL 和 SQLite 有效 :

| 数据库 | 导入 | 驱动程序 |
| --- | --- | --- |
| 邮资 | `@alchemy.run/sql/Postgres` | `@effect/sql-pg`, (中文(简体) ), `pg` |
| MySQL 数据 | `@alchemy.run/sql/MySQL` | `@effect/sql-mysql2`, (中文(简体) ), `mysql2` |
| SQLite( libSQL, Turso, 本地文件) | `@alchemy.run/sql/SQLite` | `@effect/sql-libsql` |

保留 Alchemy在您已经运行的 Postgres 数据库中的状态 :

```typescript
// alchemy.run.ts
import * as Alchemy from "alchemy";
import { postgresState } from "@alchemy.run/sql/PostgresState";
import * as Config from "effect/Config";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";

export default Alchemy.Stack(
  "MyApp",
  {
    providers: Layer.empty,
    state: postgresState({ url: Config.Redacted("STATE_DATABASE_URL") }),
  },
  Effect.gen(function* () {
    return {};
  }),
);
```

## 学多点

-   [SQL 在炼金术上运行](https://alchemy.run/sql)
-   [带有 Postgres 效果 SQL](https://alchemy.run/sql/effect-sql/postgres)
-   [移徙](https://alchemy.run/sql/effect-sql/migrations)
-   [国库](https://alchemy.run/state-store)

## 常见问题

### @alchemy\.run/sql 是什么？

Postgres和MySQL客户端,SQL迁移,以及用于Alchemy的Postgres州立商店\.

### 如何安装 @alchemy\.run/sql？

在项目目录运行 npm install @alchemy\.run/sql，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（^4\.1\.0）、alchemy（2\.0\.0-beta\.85）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @alchemy\.run/sql 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alchemy\.run/sql 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @alchemy\.run/sql 可以商用吗？

@alchemy\.run/sql 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @alchemy\.run/sql 的下载量有多少？

根据 npm 官方下载统计，@alchemy\.run/sql 在 2026/10/06 – 2026/11/04 这 30 天内被下载 374,243 次，日均约 12,475 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alchemy\.run/sql 还在维护吗？

最新版本 2\.0\.0-beta\.85 发布于 2026/11/03（3 天前）；至今共发布 4 个版本，其中过去 12 个月发布了 4 个；首次发布于 2026/10/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。