专属node.js调用mysql数据库封装开发的mysqls库 链式调用、支持事务
2017年12月27日441 browse
在我自己的平常开发中很少有见到javascript对sql的封装比较好的库(找了一圈也没找到、应该是暂时我没发现),因此前期的项目中根据自己的项目情况实现了一套封装方法。
最近我准备写一个这样的库,基于前期自己对mysql的封装(ThinkPHP是我使用过的一个PHP框架,对它的模型模块调用sql的方式很喜欢) 因此决定参考其API,用javascript实现一次。
mysqls想表达什么
- node.js连接mysql的库有很多,因此觉得没必要自己再封装一个,为了达到库的广泛使用性,因此此库只做生成SQL语句的功能封装
- 整个api采用链式调用的方式,这样能最大化的减少开发代码和使用自由度
- 链式调用方法顺序内部已经做了排序,因此可以不按严格的sql语句顺序来使用方法
- sql调用方法直接参考ThinkPHP的api,因此不用自己再从新定义方法名称
- 自由、简洁、使用简单是它想表达出来的
- 完整的API说明文档,写文档比写代码更累,时间更久,可见开源框架文档的难能可贵,为它们致敬
进入正文:
简介:node-transform-mysql是在node.js场景中使用mysql,根据传入的参数生成相应的sql语句。它所做的事情很简单也很专一,只负责生成sql语句,不执行任何实际的增删改查。你也不用担心它的体量,整体代码300行左右,压缩之后代码不足8k。
github地址:https://github.com/wangweianger/mysqls
npm地址:https://www.npmjs.com/package/mysqls
API文档地址:https://wangweianger.gitbooks.io/node-transform-mysql/content/
安装:
npm install mysqls --save-dev
然后使用一个支持 CommonJS 或 ES2015 的模块管理器,例如 webpack:
//import方式
import { execute,sql,transaction } from 'mysqls'
//require方式
let { execute,sql,transaction } = require('mysqls')
参数说明
execute :执行单挑sql语句 参数:(config,sqlStr)
sql :链式调用生成sql语句 链式调用语法,参考后文
transaction :执行事务相关任务时使用 参数:(config,sqlArr)
定义一个公共的config配置
let config={
host:'localhost',
user:'root',
password:'123456',
database:'web-performance',
port:'3306',
}
使用Promise方式
//使用
let sqlstr = sql.table('web_pages').where({id:147}).select()
execute(config,sqlstr).then(res=>{
console.log(res)
}).catch(err=>{
console.log(err)
})
使用async/await
let sqlstr = sql.table('web_pages').where({id:147}).select()
let result = await execute(config,sqlstr)
console.log(result)
处理事务
let tranSqlArr = [
sql.table('table1').data({number:number-5}).update(),
sql.table('table2').data({number:number+5}).update()
]
let result = await transaction(config,tranSqlArr)
console.log(result)
生成sql语句简单用法
sql调用方法的顺序内部已经做了排序,因此可以不按严格的sql语句顺序来写
查询
sql
.table('node_table')
.where('id=1')
.select()
SELECT * FROM node_table WHERE id=1
sql
.table('node_table')
.field('id,name')
.where({id:1})
.select()
SELECT id,name FROM node_table WHERE id=1
插入
sql
.table('node_table')
.data({name:'zane',email:'752636052@qq.com'})
.insert()
INSERT INTO node_table (name,email) VALUES (`zane`,`752636052@qq.com`)
更新
sql
.table('node_table')
.data({name:'zane',email:'752636052@qq.com'})
.update()
UPDATE node_table SET name=`zane`,email=`752636052@qq.com`
删除
sql .table('node_table')
.where({name:'zane'})
.delet();
DELETE FROM node_table WHERE name=`zane`
生成sql语句高级用法
数据库的查询是最复杂的,因此高级用法主要针对于查询
//参数json多字段
sql
.table('node_table')
.where({id:1,name:'zane'})
.select()
SELECT * FROM node_table WHERE id=1 AND name=`zane`
//参数数组
let data=[
{id:1,name:'zhangsan',_type:'or'},
{sex:1,number:3}
]
sql.table('node_table').where(data).select()
SELECT * FROM node_table WHERE (id=1 OR name=`zhangsan` ) AND (sex=1 AND number=3 )
//多字段连接方式
let data=[
{id:1,name:'zhangsan',_type:'or',_nexttype:'or'},
{sex:1,number:3,_type:'and'}
]
sql.table('node_table').where(data).select()
SELECT * FROM node_table WHERE (id=1 OR name=`zhangsan`) OR (sex=1 AND number=3)
//表达式查询
let data={
id:{eq:100,egt:10,_type:'or'},
name:'zhangshan'
}
sql.table('node_table').where(data).select()
SELECT * FROM node_table WHERE ((id=100) OR (id>=10)) AND name=`zhangshan`
//混合查询
let data=[{
id:{eq:100,egt:10,_type:'or'},
name:'zhangshan',
_nexttype:'or'
},{
status:1,
name:{like:'%zane%'}
}]
sql.table('node_table').where(data).select()
SELECT * FROM node_table WHERE (((id=100) OR (id>=10)) AND name=`zhangshan`) OR (status=1 AND ((name LIKE `%zane%`)))
//UNION , UNION ALL 组合使用
sql
.union('SELECT * FROM think_user_1',true)
.union('SELECT * FROM think_user_2',true)
.union(['SELECT * FROM think_user_3','SELECT name FROM think_user_4'])
.union('SELECT * FROM think_user_5',true)
.select()
得到
(SELECT * FROM think_user_1) UNION ALL
(SELECT * FROM think_user_2) UNION ALL
(SELECT * FROM think_user_3) UNION
(SELECT name FROM think_user_4) UNION
(SELECT * FROM think_user_5)
//子查询
let sqlstring = sql.field('id,name').table('node_table').group('field')
sql.table(sqlstring).group('field').where('id=1').order('status').select()
得到
SELECT * FROM (SELECT id,name FROM node_table GROUP BY field ) WHERE id=1 GROUP BY field ORDER BY status
更多用法请查看详细文档
API文档地址:https://wangweianger.gitbooks.io/node-transform-mysql/content/
项目运行
git clone https://github.com/wangweianger/node-transform-mysql.git
npm install
//dve
npm run dve
//product
npm run build
此库后期也会根据自己的使用不断的完善,也欢迎您的建议
如果你绝对对你有帮助,欢迎给个star
博主
zane
发表于 2017-12-27 13:44:09,添加在了 javascript
标签下打赏
您的支持将鼓励我继续努力与分享。


评论
正在加载验证码......