@atscript/db-mysql

中文文档
0.1.174发布于 2026/11/07MITTypeScriptESM + CJS近 30 天下载 3061

MySQL adapter for @atscript/db with mysql2 driver support.

原始使用文档
文档目录5 节
  1. Installation
  2. Quick Start
  3. Features
  4. Documentation
  5. License

Atscript

@atscript/db-mysql

Define your models once — get TypeScript types, runtime validation, and DB metadata from a single .as model.

Documentation · MySQL Adapter


MySQL adapter for @atscript/db using the mysql2 driver. Supports native FULLTEXT search, VECTOR columns (MySQL 9.0+), AUTO_INCREMENT, batched multi-row inserts, and full schema sync.

Includes MysqlPlugin for @db.mysql.* annotations (engine, charset, collation, unsigned, type overrides, ON UPDATE).

Installation

pnpm add @atscript/db-mysql mysql2

Quick Start

import { DbSpace } from "@atscript/db";
import { createAdapter } from "@atscript/db-mysql";

const db = createAdapter("mysql://root@localhost:3306/mydb");
const users = db.getTable(UsersType);

await users.insertOne({ name: "Alice", email: "[email protected]" });

Features

  • Full CRUD with batched multi-row INSERT (auto-chunking)
  • Native FULLTEXT search via MATCH ... AGAINST
  • VECTOR(N) column type on MySQL 9.0+ with distance functions
  • AUTO_INCREMENT with configurable start value
  • Storage engine selection (InnoDB, MyISAM, etc.)
  • Character set and collation control
  • UNSIGNED integer columns, native type overrides, ON UPDATE expressions
  • Foreign key constraints with referential actions
  • Full schema sync: CREATE, ALTER, DROP, indexes, views

Documentation

License

MIT

版本与发布记录

@atscript/db-mysql 共发布 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-mysql 的常见问题

@atscript/db-mysql 是什么?

MySQL adapter for @atscript/db with mysql2 driver support.

如何安装 @atscript/db-mysql?

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

@atscript/db-mysql 支持 TypeScript 吗?

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

@atscript/db-mysql 支持 ESM 还是 CommonJS?

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

@atscript/db-mysql 可以商用吗?

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

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

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

@atscript/db-mysql 还在维护吗?

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