knex
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

knex

A batteries-included SQL query & schema builder for Postgres, MySQL and SQLite3 and the Browser

0.19.4  •  Published 2 months ago  •  by knex  •  MIT License

knex.js

npm version npm downloads 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 8+ 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('users').insert({ user_name: 'Tim' });
  })

  // ...and using the insert id, insert into the other table.
  .then(function(rows) {
    return knex('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);
  });

Popularity

Weekly Downloads
324.9K
Stars
10.8K

Maintenance

Development

Last ver 2 months ago
Created 7 years ago
Last commit 3 days ago
1 day between commits

Technology

Node version: 12.9.1
555K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

230 contributors
Mikael Lepistö
Maintainer, 124 commits, 215 merges, 48 PRs
Works at Vincit
Igor Savin
Maintainer, 138 commits, 201 merges, 104 PRs
wubzz
Maintainer, 169 commits, 59 merges, 83 PRs
Tim Griesser
Maintainer, 82 commits, 114 merges, 26 PRs
Works at cypress-io
Rhys van der Waerden
Maintainer, 73 commits, 74 merges, 8 PRs
Works at usabilityhub
Lorefnon
Maintainer, 32 commits, 1 merges, 35 PRs

Tags

sql
query
postgresql
mysql
sqlite3
oracle
mssql
Ready for the next level?
Join Devstore's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things