# @fedify/mysql 中文文档

规范地址：https://npmcn.com/package/%40fedify/mysql/

版本：2\.1\.32
npm 元数据更新时间：2026-11-17T06:44:47.553Z
中文译文更新时间：2026-11-17T06:45:21.606Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：63.4 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：mysql2 ^3\.18\.0，@fedify/fedify ^2\.1\.32
- 首次发布：2026-03-08T16:01:49.063Z
- 最新版本发布：2026-11-17T06:44:47.114Z
- 近 30 天下载量：6342（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：388（近 12 个月 388 个）

## 中文简介

MySQL/马里亚DB 联邦化驱动程序

## 安装

```sh
npm install @fedify/mysql
```

也可以使用：`pnpm add @fedify/mysql`、`yarn add @fedify/mysql`、`bun add @fedify/mysql`

## README

# @fedify/mysql: MySQL/马里亚DB 用于联邦化的驱动程序

[![JSR](https://jsr.io/badges/@fedify/mysql)](https://jsr.io/@fedify/mysql) [![npm](https://img.shields.io/npm/v/@fedify/mysql?logo=npm)](https://www.npmjs.com/package/@fedify/mysql)

此软件包提供 [联邦](https://fedify.dev/)是因为 [`KvStore`](https://jsr.io/@fedify/fedify/doc/federation/~/KvStore) 财务报告和审定财务报表 [`MessageQueue`](https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue) mySQL/MariaDB 的执行 :

-   [`MysqlKvStore`](https://jsr.io/@fedify/mysql/doc/~/MysqlKvStore)
-   [`MysqlMessageQueue`](https://jsr.io/@fedify/mysql/doc/mq/~/MysqlMessageQueue)

```typescript
import { createFederation } from "@fedify/fedify";
import { MysqlKvStore, MysqlMessageQueue } from "@fedify/mysql";
import mysql from "mysql2/promise";

const pool = mysql.createPool("mysql://user:password@localhost/dbname");

const federation = createFederation({
  kv: new MysqlKvStore(pool),
  queue: new MysqlMessageQueue(pool),
});
```

## 安装

```sh
deno add jsr:@fedify/mysql              # Deno
npm  add     @fedify/mysql mysql2       # npm
pnpm add     @fedify/mysql mysql2       # pnpm
yarn add     @fedify/mysql mysql2       # Yarn
bun  add     @fedify/mysql mysql2       # Bun
```

## 常见问题

### @fedify/mysql 是什么？

MySQL/马里亚DB 联邦化驱动程序

### 如何安装 @fedify/mysql？

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

### @fedify/mysql 支持 TypeScript 吗？

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

### @fedify/mysql 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @fedify/mysql 可以商用吗？

@fedify/mysql 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fedify/mysql 的下载量有多少？

根据 npm 官方下载统计，@fedify/mysql 在 2026/10/15 – 2026/11/13 这 30 天内被下载 6,342 次，日均约 211 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fedify/mysql 还在维护吗？

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

