knex

What is knex?

Knex.js is a SQL query builder for JavaScript, which works with multiple database systems like PostgreSQL, MySQL, SQLite3, and Oracle. It allows for building and executing SQL queries in a readable and programmatic way, handling connections and transactions, and seeding and migrating databases for development purposes.

What are knex's main functionalities?

Query Building

Builds a SQL query to select all columns from the 'users' table where the 'id' is 1.

knex.select('*').from('users').where('id', 1)

Schema Building

Creates a new table called 'users' with an auto-incrementing 'id' column, a 'name' column of string type, and timestamp columns for 'created_at' and 'updated_at'.

knex.schema.createTable('users', function(table) { table.increments('id'); table.string('name'); table.timestamps(); })

Transaction Support

Performs a transaction to insert multiple records into the 'books' table. If any part of the transaction fails, all changes are rolled back.

knex.transaction(function(trx) { const books = [{title: 'Canterbury Tales'}, {title: 'Macbeth'}]; return trx.insert(books).into('books'); })

Raw Queries

Executes a raw SQL query, selecting all columns from the 'users' table where the 'id' is 1, with parameter binding.

knex.raw('SELECT * FROM users WHERE id = ?', [1])

Seeding

Defines a seed file that first clears the 'users' table and then inserts new records into it.

exports.seed = function(knex) { return knex('users').del().then(function() { return knex('users').insert([{name: 'Alice'}, {name: 'Bob'}]); }); }

Migrations

Defines a migration file with an 'up' method to create a new 'users' table and a 'down' method to drop the 'users' table.

exports.up = function(knex) { return knex.schema.createTable('users', function(table) { table.increments(); table.string('name'); table.timestamps(); }); }; exports.down = function(knex) { return knex.schema.dropTable('users'); };

Other packages similar to knex

sequelize

Sequelize is an ORM (Object-Relational Mapping) library for Node.js. It provides a higher-level abstraction for database interactions and supports multiple dialects. Unlike Knex, which is primarily a query builder, Sequelize allows for defining models and relationships directly in JavaScript.

typeorm

TypeORM is an ORM for TypeScript and JavaScript (ES7, ES6, ES5). It supports the Data Mapper and Active Record patterns and works with SQL databases. It provides more advanced ORM features compared to Knex, such as automatic migration generation and support for decorators.

bookshelf

Bookshelf.js is a JavaScript ORM for Node.js, built on the Knex SQL query builder. It features a simple and intuitive API and supports relations, eager and lazy loading, model events, and plugins. It's more ORM-focused than Knex but uses Knex under the hood for query building.

README

knex.js

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, featuring:

• transactions
• connection pooling
• streaming queries
• both a promise and callback API
• a thorough test suite
• the ability to run in the Browser

Node.js versions 10+ are supported.

Read the full documentation to get started!
Or check out our Recipes wiki to search for solutions to some specific problems
If upgrading from older version, see Upgrading instructions

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

For an Object Relational Mapper, see:

• http://bookshelfjs.org
• https://github.com/Vincit/objection.js

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

Examples

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

const knex = require('knex')({
  client: 'sqlite3',
  connection: {
    filename: './data.db',
  },
});

// Create a table
knex.schema
  .createTable('users', table => {
    table.increments('id');
    table.string('user_name');
  })

  // ...and another
  .createTable('accounts', table => {
    table.increments('id');
    table.string('account_name');
    table
      .integer('user_id')
      .unsigned()
      .references('users.id');
  })

  // Then query the table...
  .then(() =>
    knex('users').insert({ user_name: 'Tim' })
  )

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

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

  // map over the results
  .then(rows =>
    rows.map(row => {
      console.log(row)
    })
  )

  // Finally, add a .catch handler for the promise chain
  .catch(e => {
    console.error(e);
  });

Changelog

0.21.11 - 01 November, 2020

Typings:

• Revert support for globally defining table/record mapping #4099