JavaScripting

The definitive source of the best
JavaScript libraries, frameworks, and plugins.


  • ×

    A query builder for PostgreSQL, MySQL and SQLite3, designed to be flexible, portable, and fun to use.
    Filed under 

    • 🔾88%Overall
    • 9,152
    • 1.7 days
    • 🕩1140
    • 👥37

    knex.js

    npm version Build Status Coverage Status Dependencies Status Gitter chat Language Grade: JavaScript

    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:

    Node.js versions 6+ 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:

    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')({
      dialect: 'sqlite3',
      connection: {
        filename: './data.db'
      }
    });
    
    // Create a table
    knex.schema.createTable('users', function(table) {
      table.increments('id');
      table.string('user_name');
    })
    
    // ...and another
    .createTable('accounts', function(table) {
      table.increments('id');
      table.string('account_name');
      table.integer('user_id').unsigned().references('users.id');
    })
    
    // 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) {
      console.log(row);
    })
    
    // Finally, add a .catch handler for the promise chain
    .catch(function(e) {
      console.error(e);
    });
    
    Show All