asaihost-nodejs-dbmysql
v0.0.1
Published
AsaiWeb CMS MySQL database driver plugin for asaihost-nodejs sysserver
Maintainers
Readme
asaihost-nodejs-dbmysql
asaihost-nodejs 的 MySQL 数据库驱动插件:连接池、Promise 封装、缺表时自动建库建表。
| 项 | 值 |
|----|-----|
| npm 包名 | asaihost-nodejs-dbmysql |
| 插件入口 | index.ts(monorepo 源码)/ dist/asaihost-nodejs-dbmysql.es.js(发布后) |
| 运行时依赖 | mysql ^2.18 |
| Node 版本 | >= 20 |
安装
npm install asaihost-nodejs asaihost-nodejs-dbmysql用法
驱动以 factory 函数 导出,由 asaihost-nodejs 的 sysserver 注入:
import AsaiHostNodejs from 'asaihost-nodejs';
import AsaiHostNodejsDbmysql from 'asaihost-nodejs-dbmysql';
AsaiHostNodejs.sysserver($asai, {
db: { mysql: AsaiHostNodejsDbmysql },
});在 asaihost.json 或业务配置中指定 type: "mysql" 即可使用该驱动。
配置示例
{
"type": "mysql",
"opt": {
"host": "127.0.0.1",
"user": "root",
"password": "secret",
"database": "asaicms",
"create": true
}
}| 字段 | 说明 |
|------|------|
| host / user / password / database | 标准 MySQL 连接参数 |
| create | 为 true 时,表不存在则自动创建数据库与表 |
在 AsaiCMS monorepo 内使用
开发时直接引用源码,无需先 npm pack:
import AsaiHostNodejsDbmysql from './src/plugs/asaihost-nodejs-dbmysql/index';开发与发布 npm 包
cd webserver/src/plugs/asaihost-nodejs-dbmysql
npm install
npm run typecheck
npm run build
npm pack # 本地验证 .tgz 内容
npm publish --access publicpackage.json exports 约定
| 条件 | 解析到 |
|------|--------|
| development | ./index.ts(monorepo + tsx 开发) |
| import | ./dist/asaihost-nodejs-dbmysql.es.js |
| require | ./dist/asaihost-nodejs-dbmysql.cjs |
| types | ./dist/asaihost-nodejs-dbmysql.d.ts |
MySQL 环境
本地 MySQL 8 安装与配置说明见 MYSQL.md。
与 asaihost-nodejs 配对使用;禁止跨插件 deep import。
