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

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

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

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

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

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

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

## 中文简介

用于Alchemy的Planet Scale MySQL和Postgres数据库.

## 安装

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

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

## README

# @alchemy.run/平面标

行星规模 [炼金术](https://alchemy.run/)。宣布没有服务器的 MySQL 和 Postgres 数据库、分支和角色与使用它们的代码相同.

```sh
npm install alchemy @alchemy.run/planetscale @alchemy.run/cloudflare @alchemy.run/sql effect
```

一个Postgres数据库,一个有迁移的分支和一个角色,从Cloudflare工人通过Hyperdrive到达:

```typescript
// src/db.ts
import * as Cloudflare from "@alchemy.run/cloudflare";
import * as Planetscale from "@alchemy.run/planetscale";
import * as Effect from "effect/Effect";

export const Hyperdrive = Effect.gen(function* () {
  const database = yield* Planetscale.PostgresDatabase("Db", {
    region: { slug: "us-east" },
    clusterSize: "PS_10",
  });
  const branch = yield* Planetscale.PostgresBranch("Main", {
    database,
    migrations: "./migrations",
  });
  const role = yield* Planetscale.PostgresRole("App", {
    database,
    branch,
    inheritedRoles: ["postgres"],
  });
  return yield* Cloudflare.Hyperdrive.Connection("Hyperdrive", {
    origin: role.origin,
  });
});
```

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

export default Cloudflare.Worker(
  "Worker",
  { main: import.meta.url },
  Effect.gen(function* () {
    const hyperdrive = yield* Cloudflare.Hyperdrive.Connect(yield* Hyperdrive);
    const sql = yield* SQL.Postgres({ url: hyperdrive.connectionString });

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

```typescript
// alchemy.run.ts
import * as Alchemy from "alchemy";
import * as Cloudflare from "@alchemy.run/cloudflare";
import * as Planetscale from "@alchemy.run/planetscale";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";
import Worker from "./src/worker.ts";

export default Alchemy.Stack(
  "MyApp",
  {
    providers: Layer.mergeAll(Cloudflare.providers(), Planetscale.providers()),
    state: Cloudflare.state(),
  },
  Effect.gen(function* () {
    const worker = yield* Worker;
    return { url: worker.url };
  }),
);
```

## 学多点

-   [炼金术上的行星模型 运行](https://alchemy.run/planetscale)
-   [设置](https://alchemy.run/planetscale/setup)
-   [API 参考](https://alchemy.run/providers)

## 常见问题

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

用于Alchemy的Planet Scale MySQL和Postgres数据库\.

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

在项目目录运行 npm install @alchemy\.run/planetscale，或使用 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/planetscale 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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