Knex.js 开源项目教程
knex项目地址:https://gitcode.com/gh_mirrors/kne/knex
项目介绍
Knex.js 是一个用于 PostgreSQL、MySQL、MariaDB、SQLite3、Oracle 和 Amazon Redshift 的 SQL 查询构建器,旨在灵活、可移植和易于使用。它支持事务处理、连接池、流式查询、批处理查询等功能,并且可以与多种 Node.js 框架集成。
项目快速启动
安装 Knex.js
首先,你需要在你的项目中安装 Knex.js 和对应的数据库驱动。例如,如果你使用的是 PostgreSQL,你可以这样安装:
npm install knex --save
npm install pg --save
初始化 Knex 配置
创建一个 knexfile.js
文件来配置你的数据库连接:
module.exports = {
development: {
client: 'pg',
connection: {
host: '127.0.0.1',
user: 'your_database_user',
password: 'your_database_password',
database: 'myapp_test'
}
}
};
创建迁移文件
使用 Knex 命令行工具创建迁移文件:
npx knex migrate:make initial
在生成的迁移文件中定义你的表结构:
exports.up = function(knex) {
return knex.schema.createTable('users', function(table) {
table.increments('id');
table.string('user_name');
});
};
exports.down = function(knex) {
return knex.schema.dropTable('users');
};
运行迁移
运行迁移文件来创建数据库表:
npx knex migrate:latest
编写查询
在你的应用代码中使用 Knex 进行数据库查询:
const knex = require('knex')({
client: 'pg',
connection: {
host: '127.0.0.1',
user: 'your_database_user',
password: 'your_database_password',
database: 'myapp_test'
}
});
knex('users').select('*').then(rows => {
console.log(rows);
});
应用案例和最佳实践
事务处理
Knex 支持事务处理,确保数据库操作的原子性:
knex.transaction(trx => {
return trx('books').insert({name: 'New Book'}).then(() => {
return trx('logs').insert({event: 'Book was added'});
});
}).then(result => {
console.log('Transaction complete.');
}).catch(error => {
console.error('Error:', error);
});
连接池
Knex 内置连接池管理,可以有效管理数据库连接:
const knex = require('knex')({
client: 'pg',
connection: {
host: '127.0.0.1',
user: 'your_database_user',
password: 'your_database_password',
database: 'myapp_test'
},
pool: { min: 2, max: 10 }
});
典型生态项目
Bookshelf.js
Bookshelf.js 是一个基于 Knex.js 的 ORM,提供了模型和集合的概念,使得数据库操作更加直观和方便。
Objection.js
Objection.js 是另一个基于 Knex.js 的 ORM,它提供了更高级的查询功能和更好的性能。
通过这些生态项目,你可以进一步扩展 Knex.js 的功能,使其更符合你的应用需求。