# @drizzle-adapter/mysql2 中文文档 规范地址：https://npmcn.com/package/%40drizzle-adapter/mysql2/ 版本：1\.1\.4 npm 元数据更新时间：2026-10-03T06:19:31.824Z 中文译文更新时间：2026-11-12T20:16:27.325Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40drizzle-adapter/mysql2 原文对照：https://npmcn.com/package/%40drizzle-adapter/mysql2/?lang=original ## 关键信息（来自 npm 元数据） - 包体积（解压后）：73.5 kB，52 个文件 - 模块格式：ES Module - TypeScript 类型：包内自带 - 运行依赖：3 个 - peer 依赖：mysql2 ^3\.14\.0 - 首次发布：2024-12-03T05:41:49.870Z - 最新版本发布：2026-10-03T06:19:31.543Z - 近 30 天下载量：18210（2026-10-13 至 2026-11-11，npm 官方下载统计） - 已发布版本数：15（近 12 个月 4 个） ## 中文简介 MySQL 适配器用于 Drizzle适配器生态系统 使用 Mysql2 驱动程序. ## 安装 ```sh npm install @drizzle-adapter/mysql2 ``` 也可以使用：`pnpm add @drizzle-adapter/mysql2`、`yarn add @drizzle-adapter/mysql2`、`bun add @drizzle-adapter/mysql2` ## README # @ 细雨适应器/ mysql2 MySQL 适配器用于 Drizzle适配器生态系统 使用 Mysql2 驱动程序. ## 概览 这个 `@drizzle-adapter/mysql2` 软件包利用高性能为 Drizzle 适应器接口提供 MySQL 执行 `mysql2` 驾驶员。 虽然你不直接与此软件包互动( 您使用 `@drizzle-adapter/core` 相反,它使得MySQL能够在Drizzle适应器生态系统中提供支持. ## 为什么是Misql2? Mysql2驱动程序具有显著优势: - **高性能**:优化速度和效率 - **发言稿**: 编写说明的当地支持 - **连接集合**: 内置连接池管理 - **二进制协议**: 高效二进制协议支持 - **保证API**: 基于承诺的现代接口 - **压缩**: 网络压缩支持 - **SSL/TLS 系统**: 安全连接支持 - **字符集/组合**: 完整的字符集和整理支持 ## 安装 ```bash # Install both the core package and the MySQL adapter pnpm install @drizzle-adapter/core @drizzle-adapter/mysql2 ``` ## 重要:适配器注册 适配器要正确使用 DrizzleAdapterFactory 操作,必须导入它进行自我注册的副作用: ```typescript // Import for side effects - adapter will self-register import '@drizzle-adapter/mysql2'; // Now you can use the factory import { DrizzleAdapterFactory } from '@drizzle-adapter/core'; ``` ## 使用量 ### 配置 ```typescript import { DrizzleAdapterFactory, TypeDrizzleDatabaseConfig } from '@drizzle-adapter/core'; const config: TypeDrizzleDatabaseConfig = { DATABASE_DRIVER: 'mysql2', DATABASE_HOST: 'localhost', DATABASE_PORT: 3306, DATABASE_USER: 'user', DATABASE_PASSWORD: 'password', DATABASE_NAME: 'database' }; const factory = new DrizzleAdapterFactory(); const adapter = factory.create(config); ``` ### Schema 定义 ```typescript const dataTypes = adapter.getDataTypes(); const users = dataTypes.dbTable('users', { id: dataTypes.dbBigInt('id', { mode: 'number' }).primaryKey().autoincrement(), name: dataTypes.dbVarChar('name', { length: 255 }).notNull(), email: dataTypes.dbVarChar('email', { length: 255 }).notNull().unique(), status: dataTypes.dbEnum('status', ['active', 'inactive']).default('active'), metadata: dataTypes.dbJson('metadata'), createdAt: dataTypes.dbTimestamp('created_at').defaultNow() }); const posts = dataTypes.dbTable('posts', { id: dataTypes.dbBigInt('id', { mode: 'number' }).primaryKey().autoincrement(), userId: dataTypes.dbBigInt('user_id', { mode: 'number' }) .references(() => users.id), title: dataTypes.dbVarChar('title', { length: 255 }).notNull(), content: dataTypes.dbText('content').notNull(), published: dataTypes.dbBoolean('published').default(false), createdAt: dataTypes.dbTimestamp('created_at').defaultNow(), updatedAt: dataTypes.dbTimestamp('updated_at').onUpdateNow() }); ``` ### 基本 CRUD 操作 ```typescript import { eq, and, or, desc, sql } from 'drizzle-orm'; const connection = await adapter.getConnection(); const client = connection.getClient(); try { // INSERT // Single insert with returning const [newUser] = await client .insert(users) .values({ name: 'John Doe', email: 'john@example.com', metadata: { role: 'user' } }) .returning(); // Bulk insert await client .insert(posts) .values([ { userId: newUser.id, title: 'First Post', content: 'Hello, world!' }, { userId: newUser.id, title: 'Second Post', content: 'Another post' } ]); // SELECT // Select all const allUsers = await client .select() .from(users); // Select with conditions const user = await client .select() .from(users) .where(eq(users.email, 'john@example.com')); // Select with join const userPosts = await client .select({ userName: users.name, postTitle: posts.title, content: posts.content, metadata: users.metadata }) .from(posts) .leftJoin(users, eq(posts.userId, users.id)) .where(eq(posts.published, true)) .orderBy(desc(posts.createdAt)); // UPDATE // Update with JSON operations await client .update(users) .set({ name: 'John Smith', metadata: sql`JSON_SET(${users.metadata}, '$.role', 'admin')` }) .where(eq(users.id, newUser.id)); // DELETE await client .delete(posts) .where( and( eq(posts.userId, newUser.id), eq(posts.published, false) ) ); } finally { await connection.disconnect(); } ``` ### 高级特性 #### 交易支持 ```typescript const connection = await adapter.getConnection(); const client = connection.getClient(); try { await client.transaction(async (tx) => { const [user] = await tx .insert(users) .values({ name: 'John Doe', email: 'john@example.com' }) .returning(); await tx .insert(posts) .values({ userId: user.id, title: 'My First Post', content: 'Hello, world!' }); }); } finally { await connection.disconnect(); } ``` #### JSON业务 ```typescript // Query with JSON conditions const premiumUsers = await client .select() .from(users) .where(sql`JSON_EXTRACT(${users.metadata}, '$.subscription') = 'premium'`); // Update nested JSON await client .update(users) .set({ metadata: sql`JSON_SET( ${users.metadata}, '$.subscription', 'premium', '$.validUntil', CURRENT_TIMESTAMP )` }) .where(eq(users.id, userId)); ``` #### 全文搜索 ```typescript // Create FULLTEXT index await client.execute(sql` ALTER TABLE ${posts} ADD FULLTEXT INDEX posts_fulltext (title, content) `); // Search posts const searchResults = await client .select() .from(posts) .where(sql`MATCH(title, content) AGAINST(${searchTerm} IN BOOLEAN MODE)`) .orderBy(desc(posts.createdAt)); ``` ## 最佳做法 1. **连接管理**: 总是尝试/最后使用以确保连接被关闭 2. **交易**: 相关业务使用交易 3. **发言稿**: 自动准备发言 4. **处理错误**: 执行适当的错误处理和重试 5. **查询优化**: 使用适当的索引和查询规划 ## 捐款 我们欢迎捐款! 请随意提交拉力请求 对于重大变动,请先开出一个问题来讨论你想要改变什么. ## 相关软件包 - [@ 细雨适应器/ 核心](https://npmcn.com/package/%40drizzle-adapter/core) - 核心接口和类型 - [@ 细雨适应器/ mysql- core](https://npmcn.com/package/%40drizzle-adapter/mysql-core) - 共享 MySQL 功能 ## 常见问题 ### @drizzle-adapter/mysql2 是什么？ MySQL 适配器用于 Drizzle适配器生态系统 使用 Mysql2 驱动程序\. ### 如何安装 @drizzle-adapter/mysql2？ 在项目目录运行 npm install @drizzle-adapter/mysql2，或使用 pnpm add / yarn add / bun add。 ### @drizzle-adapter/mysql2 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @drizzle-adapter/mysql2 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @drizzle-adapter/mysql2 可以商用吗？ @drizzle-adapter/mysql2 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @drizzle-adapter/mysql2 的下载量有多少？ 根据 npm 官方下载统计，@drizzle-adapter/mysql2 在 2026/10/13 – 2026/11/11 这 30 天内被下载 18,210 次，日均约 607 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @drizzle-adapter/mysql2 还在维护吗？ 最新版本 1\.1\.4 发布于 2026/10/03（1 个月前）；至今共发布 15 个版本，其中过去 12 个月发布了 4 个；首次发布于 2024/12/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。