@atscript/db

中文文档
0.1.174发布于 2026/11/07MITTypeScriptESM + CJS零依赖近 30 天下载 4917

用于标记的数据库适配器工具.

中文使用文档
文档目录6 节
  1. 安装
  2. 快速启动
  3. 子公司
  4. 特征
  5. 文档
  6. 许可证

Atscript

@ atscript/ db (帮助)

一次定义模型 ——从单个获取 TypeScript 类型、运行时间验证和 DB 元数据 .as 型号.

文档 • 妇女 数据库指南


Ascript 的通用数据库抽象层 。 提供统一的 CRUD, 关系, 视图, 聚合, 和计划同步 —— 均由 @db.* 注释 .as 模特们 可插件适配器连接任意数据库引擎(SQLite,PostgreSQL,MongoDB,MySQL).

安装

pnpm add @atscript/db

快速启动

@db.table "users"
interface User {
  @meta.id
  @db.default.increment
  id: number

  @db.index.unique "email_idx"
  email: string

  name: string
}
import { DbSpace } from "@atscript/db";
import { createAdapter } from "@atscript/db-sqlite";

const db = createAdapter("./myapp.db");
const users = db.getTable(User);

await users.insertOne({ name: "John", email: "[email protected]" });
const all = await users.findMany({ filter: { name: { $eq: "John" } } });

子公司

条目目的
@atscript/db/plugindbPlugin() 登记所有 @db.* 说明
@atscript/db/rel关系加载和嵌入
@atscript/db/agg聚合查询验证
@atscript/db/sync与漂移探测和分布式锁定同步
@atscript/db/shared适配器插件的注释助手

特征

  • 注释驱动方案:表格名称、索引、列映射、默认、主密钥
  • 可插接适配器通过 BaseDbAdapter – 任何数据库的代码相同
  • 自动写入管道:默认,验证,ID准备,列映射
  • 嵌入式物体平整( Q)__- 分开的列)和 @db.json 存储
  • 关系: @db.rel.to, (中文(简体) ), @db.rel.from, (中文(简体) ), @db.rel.via 以嵌入式写作
  • 视图 : @db.view 包含连接、过滤、已实现视图、汇总
  • Schema同步: FNV-1a 散列漂移探测,分布式锁定,列/表重命名
  • 串行补丁操作 : $insert, (中文(简体) ), $upsert, (中文(简体) ), $update, (中文(简体) ), $remove, (中文(简体) ), $replace
  • 类型安全查询 FlatOf<T> 用于自动完成过滤和预测

文档

许可证

麻省理工学院

版本与发布记录

@atscript/db 共发布 137 个版本,首次发布于 2026/03/16;过去 12 个月发布了 137 个版本。

版本发布日期距今
0.1.174latest2026/11/07今天
0.1.1732026/11/071 天前
0.1.1722026/11/061 天前
0.1.1712026/11/061 天前
0.1.1702026/11/061 天前
0.1.1692026/11/043 天前

关于 @atscript/db 的常见问题

@atscript/db 是什么?

用于标记的数据库适配器工具.

如何安装 @atscript/db?

在项目目录运行 npm install @atscript/db,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@uniqu/core(^0.2.1)、@atscript/core(^0.2.9)、@atscript/typescript(^0.2.9)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@atscript/db 支持 TypeScript 吗?

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

@atscript/db 支持 ESM 还是 CommonJS?

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

@atscript/db 可以商用吗?

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

@atscript/db 的下载量有多少?

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

@atscript/db 还在维护吗?

最新版本 0.1.174 发布于 2026/11/07(今天);至今共发布 137 个版本,其中过去 12 个月发布了 137 个;首次发布于 2026/03/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。