A query builder for PostgreSQL, MySQL and SQLite3, designed to be flexible, portable, and fun to use.
JavaScript Shell
Clone or download
kibertoad and elhigu Refactor migrator (#2695)
* Refactor migrator

* Fix exports

* Fix ESLint

* Fix migrator

* Fix reference to config

* Split some more

* Fix table builder

* Fix argument order

* Merge branch 'master' of https://github.com/tgriesser/knex into feature/2690-support-multiple-migration-dirs

# Conflicts:
#	src/migrate/index.js
#	test/index.js
#	test/unit/migrate/migrator.js
Latest commit a01c359 Jul 17, 2018



npm version Build Status Coverage Status Dependencies Status Gitter chat

A SQL query builder that is flexible, portable, and fun to use!

A batteries-included, multi-dialect (MSSQL, MySQL, PostgreSQL, SQLite3, Oracle(including Oracle Wallet Authentication)) query builder for Node.js and the Browser, featuring:

Node.js versions 6+ are supported.

Read the full documentation to get started!

For support and questions, join the #bookshelf channel on freenode IRC

For an Object Relational Mapper, see:

To see the SQL that Knex will generate for a given query, see: Knex Query Lab


We have several examples on the website. Here is the first one to get you started:

var knex = require('knex')({
  dialect: 'sqlite3',
  connection: {
    filename: './data.db'

// Create a table
knex.schema.createTable('users', function(table) {

// ...and another
.createTable('accounts', function(table) {

// Then query the table...
.then(function() {
  return knex.insert({user_name: 'Tim'}).into('users');

// ...and using the insert id, insert into the other table.
.then(function(rows) {
  return knex.table('accounts').insert({account_name: 'knex', user_id: rows[0]});

// Query both of the rows.
.then(function() {
  return knex('users')
    .join('accounts', 'users.id', 'accounts.user_id')
    .select('users.user_name as user', 'accounts.account_name as account');

// .map over the results
.map(function(row) {

// Finally, add a .catch handler for the promise chain
.catch(function(e) {