# @forinda/kickjs-db 中文文档

规范地址：https://npmcn.com/package/%40forinda/kickjs-db/

版本：8\.12\.4
npm 元数据更新时间：2026-10-30T11:07:40.762Z
中文译文更新时间：2026-11-15T07:53:59.181Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40forinda/kickjs-db
原文对照：https://npmcn.com/package/%40forinda/kickjs-db/?lang=original
项目主页：https://kickjs.app/
源码仓库：https://github.com/forinda/kick-js

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

- 包体积（解压后）：1.7 MB，60 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0
- 运行依赖：4 个
- peer 依赖：pg \>=8\.11\.0，mysql2 \>=3\.0\.0，better-sqlite3 \>=12\.0\.0，@forinda/kickjs \>=8\.8\.0，@electric-sql/pglite \>=0\.5\.5，@forinda/kickjs-devtools-kit \>=7\.0\.0
- 首次发布：2026-04-28T10:01:04.965Z
- 最新版本发布：2026-10-30T11:07:40.423Z
- 近 30 天下载量：3395（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：48（近 12 个月 48 个）

## 中文简介

KickJS- native ORM — 代码- 第1 schema, 可逆迁移, 多透析 SQL 构建器

## 安装

```sh
npm install @forinda/kickjs-db
```

也可以使用：`pnpm add @forinda/kickjs-db`、`yarn add @forinda/kickjs-db`、`bun add @forinda/kickjs-db`

## README

# @forinda/kickjs-db (英语)

kick/db,"KickJS"数据库层:一个代码-第一 schema,完全打入的查询,以及由 schema 变化产生的迁移. 与PostgreSQL,MySQL和SQLite合作.

## 安装

```bash
kick add db        # or: pnpm add @forinda/kickjs-db pg
```

作为子路径的Dialects飞船: `@forinda/kickjs-db/pg` (驾驶员) `pg`, (中文(简体) ), `/mysql` (单位:千美元)`mysql2`和 `/sqlite` (单位:千美元)`better-sqlite3`) (中文(简体) ).

## 快速实例

```ts
import { createDbClient, table, timestamp, uuid, varchar } from '@forinda/kickjs-db'
import { pgDialect } from '@forinda/kickjs-db/pg'
import { Pool } from 'pg'

const users = table('users', {
  id: uuid().primaryKey().defaultRandom(),
  email: varchar(255).notNull().unique(),
  createdAt: timestamp().notNull().defaultNow(),
})

const db = createDbClient({
  schema: { users },
  dialect: pgDialect({ pool: new Pool({ connectionString: process.env.DATABASE_URL }) }),
})

const user = await db.query.users.findFirst({
  where: (_u, eb) => eb('email', '=', 'a@b.com'),
})
//    ^ { id: string; email: string; createdAt: Date } | undefined
```

`kick db generate` 从您的计划变化中写入迁移,以及 `kick db migrate` 应用它.

## 文档

[kickjs.app/指针/数据库](https://kickjs.app/guide/database/): 开始, 计划, 查询, 关系, 迁移, 交易, 测试, 以及从 Prisma, Drizzle, TypeORM 或 Sequelize 移动 .

## 许可证

麻省理工学院

## 常见问题

### @forinda/kickjs-db 是什么？

KickJS- native ORM — 代码- 第1 schema, 可逆迁移, 多透析 SQL 构建器

### 如何安装 @forinda/kickjs-db？

在项目目录运行 npm install @forinda/kickjs-db，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@forinda/kickjs（\>=8\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 kickjs-db，可以用 npx kickjs-db 直接运行。

### @forinda/kickjs-db 支持 TypeScript 吗？

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

### @forinda/kickjs-db 支持 ESM 还是 CommonJS？

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

### @forinda/kickjs-db 需要什么版本的 Node\.js？

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

### @forinda/kickjs-db 可以商用吗？

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

### @forinda/kickjs-db 的下载量有多少？

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

### @forinda/kickjs-db 还在维护吗？

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