# kasumi-plugin-sql 中文文档

规范地址：https://npmcn.com/package/kasumi-plugin-sql/

版本：26\.11\.4
npm 元数据更新时间：2026-11-03T23:49:33.245Z
中文译文更新时间：2026-11-04T00:06:02.232Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/kasumi-plugin-sql
原文对照：https://npmcn.com/package/kasumi-plugin-sql/?lang=original
项目主页：https://blog.miomoe.cn/docs/kasumi/plugins/sql
源码仓库：https://github.com/YuiNijika/Kasumi

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

- 包体积（解压后）：3.2 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-11-02T22:35:06.754Z
- 最新版本发布：2026-11-03T23:49:33.124Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

用于Kasumi应用程序的SQL数据库插件API

## 安装

```sh
npm install kasumi-plugin-sql
```

也可以使用：`pnpm add kasumi-plugin-sql`、`yarn add kasumi-plugin-sql`、`bun add kasumi-plugin-sql`

## README

# kasumi-plugin-sql

> 使用 Kasumi SQL 插件连接数据库并执行参数化语句。

## 安装

```bash
pnpm add kasumi-bridge kasumi-plugin-sql
```

## 用法

```ts
import { KSM } from "kasumi-bridge";
import { close, drivers, execute, open, query } from "kasumi-plugin-sql";

KSM.init();

const available = await drivers();
if (!available.drivers.includes("sqlite")) {
  throw new Error("当前宿主没有 SQLite 驱动");
}

const database = await open({
  driver: "sqlite",
  url: "app://data/example.db"
});

await execute({
  connectionId: database.connectionId,
  statement: "CREATE TABLE IF NOT EXISTS notes (id INTEGER PRIMARY KEY, body TEXT)"
});

const rows = await query({
  connectionId: database.connectionId,
  statement: "SELECT id, body FROM notes"
});

await close({ connectionId: database.connectionId });
console.log(rows.rows);
```

驱动是否可用以 `drivers()` 为准。SQLite 内置；MySQL、PostgreSQL 和 MongoDB 取决于宿主注册的驱动，详细边界见线上 SQL 插件文档。

## 常见问题

### kasumi-plugin-sql 是什么？

用于Kasumi应用程序的SQL数据库插件API

### 如何安装 kasumi-plugin-sql？

在项目目录运行 npm install kasumi-plugin-sql，或使用 pnpm add / yarn add / bun add。

### kasumi-plugin-sql 支持 TypeScript 吗？

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

### kasumi-plugin-sql 支持 ESM 还是 CommonJS？

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

### kasumi-plugin-sql 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### kasumi-plugin-sql 可以商用吗？

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

### kasumi-plugin-sql 还在维护吗？

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