@alchemy.run/planetscale

中文文档
2.0.0-beta.85发布于 2026/11/03Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 11.5万

PlanetScale MySQL and Postgres databases for Alchemy.

原始使用文档

@alchemy.run/planetscale

PlanetScale for Alchemy. Declare serverless MySQL and Postgres databases, branches, and roles in the same TypeScript program as the code that uses them.

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

A Postgres database, a branch with migrations, and a role, reached from a Cloudflare Worker through Hyperdrive:

// 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,
  });
});
// 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)),
);
// 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 };
  }),
);

Learn more

版本与发布记录

@alchemy.run/planetscale 共发布 4 个版本,首次发布于 2026/10/22;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.0-beta.85latest2026/11/033 天前
2.0.0-beta.842026/10/2412 天前
0.0.02026/10/2215 天前
0.0.0-stage2026/10/2215 天前

关于 @alchemy.run/planetscale 的常见问题

@alchemy.run/planetscale 是什么?

PlanetScale MySQL and Postgres databases for Alchemy.

如何安装 @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 和提交记录判断。