Need help with knex?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

knex
13.3K Stars 1.6K Forks MIT License 2.5K Commits 503 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

No Data

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 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); });

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.