介绍
egg-toshihiko 是基于 Egg.js 框架的 MySQL ORM 插件,其优化了 Sequelize 的性能,特别适合在 Node.js 项目中调用 MySQL 数据库。
本文将为您介绍 egg-toshihiko 的使用方法以及一些注意事项,希望能为您在项目开发中提供帮助。
安装
使用 npm 进行安装:
npm install --save egg-toshihiko
配置
在 config/plugin.js 中进行配置:
exports.toshihiko = { enable: true, package: 'egg-toshihiko', };
在 config/config.default.js 中进行数据库连接配置:
-- -------------------- ---- ------- ----------------- - - ------- - ----- ------------ ----- ------- --------- --------- ----- ------- --- ------- -- --
使用
在控制器中进行调用:
-- -------------------- ---- ------- ---- -------- ----- ---------- - -------------------------- ----- -------------- ------- ---------- - ----- ------- - ----- - ---- --- - - ----- ----- - --------- - - ---- ----- ----- - ------------------------------- ----- ------ - ----- ---------------- -------- - ------- - ----- ------ - ----- - ---- --- - - ----- ----- - --------- - - ---- ----- ----- - ------------------------------- ----- ------ - ----- ------------ --- ------------- --- -------- - ------- - - -------------- - ---------------
示例代码
在使用 egg-toshihiko 前,需要确认安装好了 MySQL 数据库,以下示例将演示如何使用 egg-toshihiko 连接 MySQL 数据库,并进行增删改查操作。
- 示例代码:数据库连接配置
-- -------------------- ---- ------- -- ------------------------ ----------------- - - ------- - ----- ------------ ----- ------- --------- --- ----- ------- --- ------- -- --
- 示例代码:数据表定义
-- -------------------- ---- ------- -- ----------------- -------------- - --- -- ----------------------------- - --- - ----------- ----- ----- --------------------------- -- ----- - ----- -------------------------- -- ---- - ----- --------------------------- ------------- -- -- -- - ----------- ------ ---
- 示例代码:插入数据
-- -------------------- ---- ------- -- ---------------------- ----- -------- - ----- - ---- --- - - ----- ----- - --------- - - ---- ----- ----- - ------------------------------- ----- ------ - ----- -------------- ----- ---------------------- ---- --------------------- --- -------- - ------- -
- 示例代码:删除数据
// app/controller/user.js async destroy() { const { ctx, app } = this; const { Toshihiko } = app; const model = Toshihiko.adapter.models.users; const result = await model.deleteById(ctx.params.id); ctx.body = { success: result === 1 }; }
- 示例代码:更新数据
-- -------------------- ---- ------- -- ---------------------- ----- -------- - ----- - ---- --- - - ----- ----- - --------- - - ---- ----- ----- - ------------------------------- ----- - ------- - - ----- -------------- ----- --------------------- -- - ------ - --- ------------- - --- -------- - - -------- ------ --- - -- -
- 示例代码:查询数据
// app/controller/user.js async index() { const { ctx, app } = this; const { Toshihiko } = app; const model = Toshihiko.adapter.models.users; const result = await model.findAll(); ctx.body = result; }
注意事项
egg-toshihiko 依赖 egg-sequelize,需要先安装 egg-sequelize。
在 model 的定义中,primaryKey 必须指定。
在操作数据时,需要确认是否存在该数据表。
总结
本文为您介绍了 egg-toshihiko 的使用方法及注意事项,并提供了增删改查操作的示例代码。希望能对您在 Node.js 项目中调用 MySQL 数据库提供帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cb981e8991b448e6271