Node的关系型数据库ORM库:bookshelf

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云原生数据库 PolarDB MySQL 版,通用型 2核4GB 50GB
简介:

NodeJs 关系数据库ORM库:Bookshelf.js

bookshelf.js是基于knex的一个关系型数据库的ORM库。简单易用,内置了Promise的支持。这里主要罗列一些使用的例子,例子就是最好的教程。下面就是用mysql作为实例数据库表明bookshelf如何使用。其他的几个关系型数据库使用上基本一致,只是配置等地方需要使用的名称各自不同。为了更加贴近实际全部的例子都会放在Express打造的RESTful服务里。

安装bookshelf和knex

首先需要安装库knex和bookshelf,其次还需要安装你的数据库对应的包:

npm install knex --save
npm install bookshelf --save

接下来,安装对应于你要使用的数据库的driver包。下面列出了三个比较典型的,只需要选择一个安装就可以。

npm install pg --save       // PostgreSQL
npm install mysql --save    // MySQL
npm install sqlite3 --save  // SQLite

连接数据库

连接数据库就是非常的简单的,只需要传入一个JSON格式的配置:

var knex        = require('knex'),
    db;    // 数据库连接

// 数据库连接配置
var config = {
    client: 'mysql',        // 其他可以是pg、sqlite3
    connection: {
        host: 'localhost',
        user: 'root',
        password: '123456',
        database: 'petshop', // 数据库名称
        charset: 'utf8'
    }
};

// 保证数据库连接只初始化一次。
if (!db) {
    db = knex(config);
}

接下来就该让bookshelf出马了:

var bookshelf = require('bookshelf')(db);

正式开始前,假设你现在有这么两个表Pet和User,分别存储宠物和宠物店的用户数据:

--pet
CREATE TABLE `pet` (
  `petId` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(45) DEFAULT NULL,
  `type` int(11) DEFAULT NULL,
  `quantity` int(11) DEFAULT NULL,
  `userId` int(11) NOT NULL,    -- 外键,和哪个用户关联
  PRIMARY KEY (`petId`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;


--user
CREATE TABLE `user` (
  `userId` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(45) DEFAULT NULL,
  `password` varchar(45) DEFAULT NULL,
  `email` varchar(105) DEFAULT NULL,
  PRIMARY KEY (`userId`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

Express打造的RESTful服务代码:

var Promise     = require('bluebird'),
    express     = require('express'),
    bodyParser  = require('body-parser'),
    session     = require('express-session');

var app = express();

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: true}));

app.use(session({
    secret: 'abcdefghijklmnopqrstuvwxyz1234567890',
    resave: false,
    saveUninitialized: true
    // cookie: {secure: true}
}));

var models = require('./bookshelf');
var router = express.Router();

router.get('/', function(req, res) {
    res.send('Hello bookshelf');
});

/**
 * 添加
 */
router.route('/add').post(function(req, res) {
    // ...
});

/** 
 * 更新
 */
router.route('/update').post(function(req, res) {
    // ...
});

app.use('/bookshelf', router);

app.listen(4000, function(){
    console.log('express is running on http://localhost:4000');
});

为了正常使用还需要安装某些包body-parser,这个包用来解析post发送上来的数据。bluebirdexpress-session什么的可以选择不装,不影响。

Model

ORM,这model是必须不可以少的。如何让model来对应于数据库的table呢:

var Pet = bookshelf.Model.extend({
    tableName: 'pet',
});

现在就可以使用Pet来处理pet表的数据了。

上面是理论上的。回到本例中。首先在根目录下创建一个文件夹bookshelf,然后添加文件model.js

添加数据

给表添加一条记录:

new Pet({
    name: 'King',
    type: 1, // 1: dog, 2: cat...
    quantity: 10,
    userId: 123456
}).save().then(function(model){
    console.log(model);
}).catch(function(err) {
    console.log(err);
});

放在RESTful API里:

router.route('/add').post(function(req, res) {
    var pet = new models.Pet({
        name: req.body.name,
        type: req.body.type,
        quantity: req.body.quantity,
        userId: req.body.userId
    });

    pet.save().then(function(model){
        res.json({message:'done', data: pet});
    }).catch(function(err){
        res.json({message: 'error', data: err});
    });
});

在处理数据的时候可以使用bookshelf提供的很多“静态方法”。上面的extend就是这些静态方法中的一个。创建新的model的时候就可以是用静态方法里的一个forge,这样就不用new的方式了。

    models.Pet.forge({
        name: req.body.name,
        type: req.body.type,
        quantity: req.body.quantity,
        userId: req.body.userId
    }).save().then(function(pet){
        res.json({message:'done', data: pet});
    }).catch(function(err){
        res.json({message: 'error', data: err});
    });

查找数据

添加了数据就可以查找出来了。

查找全部

查找全部的数据:

router.route('/findall').get(function(req, res) {
    models.Pet.forge().fetchAll().then(function(pets) {
        res.json({message: 'done', data: pets});
    }).catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

在浏览器里输入地址:http://localhost:4000/bookshelf/findall可以查找出全部的pet数据

查找某一个Pet

router.route('/find/:petId').get(function(req, res) {
    models.Pet.forge({
        petId: req.params.petId
    }).fetch().then(function(pet) {
        res.json({message: 'done', data: pet});
    }).catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

在浏览器里输入地址:http://localhost:4000/bookshelf/find/1可以查找出petId为1的数据

我们在上一个例子中已经创建了一条记录,所以现在可以搜出来一条记录。

更多的更复杂的查找可以使用方法query,查看这里了解更多。

更新数据

更新和创建一条新纪录,在写法上没什么太大的区别。只不过你需要在save方法里设置需要更新的数据。但是有一个限制条件,就是需要在forge方法里给出id,必须是这个词id。如果你的Primary key不是这个名称,那么就稍微复杂一点了。必须给出where条件,比如:

router.route('/update/:petId').post(function(req, res) {
    models.Pet.forge()
    .where('petId', '=', req.params.petId)
    .save({
        name: req.body.name,
        type: req.body.type,
        quantity: req.body.quantity,
        userId: req.body.userId
    }, {patch: true}).then(function(pet) {
        res.json({message: 'done', data: pet});
    }).catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

更多关于where内容可以查看这里

删除记录

最后可以删除记录。

router.route('/delete/:petId').get(function(req, res) {
    models.Pet.forge()
    .where('petId', '=', req.params.petId)
    .destroy()
    .then(function(pet) {
        res.json({message: 'done', data: pet});
    })
    .catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

最后

bookshelf这个库非常好用。不过这些还只是比较常用的一部分功能。还有很多的关系数据库的一对一、一对多以及多对多的关系的处理。
这些都可以在官方文档中查找到。














本文转自张昺华-sky博客园博客,原文链接:http://www.cnblogs.com/sunshine-anycall/p/5642901.html,如需转载请自行联系原作者


相关实践学习
使用PolarDB和ECS搭建门户网站
本场景主要介绍基于PolarDB和ECS实现搭建门户网站。
阿里云数据库产品家族及特性
阿里云智能数据库产品团队一直致力于不断健全产品体系,提升产品性能,打磨产品功能,从而帮助客户实现更加极致的弹性能力、具备更强的扩展能力、并利用云设施进一步降低企业成本。以云原生+分布式为核心技术抓手,打造以自研的在线事务型(OLTP)数据库Polar DB和在线分析型(OLAP)数据库Analytic DB为代表的新一代企业级云原生数据库产品体系, 结合NoSQL数据库、数据库生态工具、云原生智能化数据库管控平台,为阿里巴巴经济体以及各个行业的企业客户和开发者提供从公共云到混合云再到私有云的完整解决方案,提供基于云基础设施进行数据从处理、到存储、再到计算与分析的一体化解决方案。本节课带你了解阿里云数据库产品家族及特性。
相关文章
|
3月前
|
关系型数据库 MySQL 数据库
ORM对mysql数据库中数据进行操作报错解决
ORM对mysql数据库中数据进行操作报错解决
90 2
|
4月前
|
SQL 开发框架 数据库
".NET开发者的超能力:AgileEAS.NET ORM带你穿越数据库的迷宫,让数据操作变得轻松又神奇!"
【8月更文挑战第16天】AgileEAS.NET是面向.NET平台的企业应用开发框架,核心功能包括数据关系映射(ORM),允许以面向对象方式操作数据库,无需编写复杂SQL。通过继承`AgileEAS.Data.Entity`创建实体类对应数据库表,利用ORM简化数据访问层编码。支持基本的CRUD操作及复杂查询如条件筛选、排序和分页,并可通过导航属性实现多表关联。此外,提供了事务管理功能确保数据一致性。AgileEAS.NET的ORM简化了数据库操作,提升了开发效率和代码可维护性。
54 5
|
2月前
|
SQL JavaScript 关系型数据库
node博客小项目:接口开发、连接mysql数据库
【10月更文挑战第14天】node博客小项目:接口开发、连接mysql数据库
|
2月前
|
存储 关系型数据库 MySQL
PACS系统 中 dicom 文件在mysql 8.0 数据库中的 存储和读取(pydicom 库使用)
PACS系统 中 dicom 文件在mysql 8.0 数据库中的 存储和读取(pydicom 库使用)
40 2
|
3月前
|
存储 关系型数据库 MySQL
【阿里规约】阿里开发手册解读——数据库和ORM篇
从命名规范、建表规范、查询规范、索引规范、操作规范等角度出发,详细阐述MySQL数据库使用过程中所需要遵循的各种规范。
【阿里规约】阿里开发手册解读——数据库和ORM篇
|
2月前
|
SQL Go 数据库
【速存】深入理解Django ORM:编写高效的数据库查询
【速存】深入理解Django ORM:编写高效的数据库查询
70 0
|
3月前
|
SQL JavaScript 关系型数据库
Node服务连接Mysql数据库
本文介绍了如何在Node服务中连接MySQL数据库,并实现心跳包连接机制。
47 0
Node服务连接Mysql数据库
|
4月前
|
SQL Java 数据库连接
Hibernate 是一款开源 ORM(对象关系映射)框架,封装了 JDBC,允许以面向对象的方式操作数据库,简化了数据访问层的开发。
Hibernate 是一款开源 ORM(对象关系映射)框架,封装了 JDBC,允许以面向对象的方式操作数据库,简化了数据访问层的开发。通过映射机制,它可以自动处理对象与数据库表之间的转换,支持主流数据库,提高了代码的可移植性和可维护性。其核心接口包括 SessionFactory、Session 和 Transaction 等,通过它们可以执行数据库的 CRUD 操作。配置方面,需在项目中引入 Hibernate 及数据库驱动依赖,并创建 `hibernate.cfg.xml` 配置文件来设置数据库连接和 Hibernate 行为参数。
56 1
|
4月前
|
数据采集 DataWorks 安全
DataWorks产品使用合集之如何判断数据库类型是否支持整库
DataWorks作为一站式的数据开发与治理平台,提供了从数据采集、清洗、开发、调度、服务化、质量监控到安全管理的全套解决方案,帮助企业构建高效、规范、安全的大数据处理体系。以下是对DataWorks产品使用合集的概述,涵盖数据处理的各个环节。