knex.js

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

A batteries-included, multi-dialect (PostgreSQL, MySQL, CockroachDB, MSSQL, 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

Node.js versions 12+ are supported.

• Take a look at the full documentation to get started!
• Browse the list of plugins and tools built for knex
• Check out our recipes wiki to search for solutions to some specific problems
• In case of upgrading from an older version, see migration guide

You can report bugs and discuss features on the GitHub issues page or send tweets to @kibertoad.

For support and questions, join our Gitter channel.

For knex-based Object Relational Mapper, see:

• https://github.com/Vincit/objection.js
• https://github.com/mikro-orm/mikro-orm
• https://bookshelfjs.org

To see the SQL that Knex will generate for a given query, you can use Knex Query Lab

Examples

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

1const knex = require('knex')({
2  client: 'sqlite3',
3  connection: {
4    filename: './data.db',
5  },
6});
7
8try {
9  // Create a table
10  await knex.schema
11    .createTable('users', (table) => {
12      table.increments('id');
13      table.string('user_name');
14    })
15    // ...and another
16    .createTable('accounts', (table) => {
17      table.increments('id');
18      table.string('account_name');
19      table.integer('user_id').unsigned().references('users.id');
20    });
21
22  // Then query the table...
23  const insertedRows = await knex('users').insert({ user_name: 'Tim' });
24
25  // ...and using the insert id, insert into the other table.
26  await knex('accounts').insert({
27    account_name: 'knex',
28    user_id: insertedRows[0],
29  });
30
31  // Query both of the rows.
32  const selectedRows = await knex('users')
33    .join('accounts', 'users.id', 'accounts.user_id')
34    .select('users.user_name as user', 'accounts.account_name as account');
35
36  // map over the results
37  const enrichedRows = selectedRows.map((row) => ({ ...row, active: true }));
38
39  // Finally, add a catch statement
40} catch (e) {
41  console.error(e);
42}

TypeScript example

1import { Knex, knex } from 'knex';
2
3interface User {
4  id: number;
5  age: number;
6  name: string;
7  active: boolean;
8  departmentId: number;
9}
10
11const config: Knex.Config = {
12  client: 'sqlite3',
13  connection: {
14    filename: './data.db',
15  },
16};
17
18const knexInstance = knex(config);
19
20try {
21  const users = await knex<User>('users').select('id', 'age');
22} catch (err) {
23  // error handling
24}

Usage as ESM module

If you are launching your Node application with --experimental-modules, knex.mjs should be picked up automatically and named ESM import should work out-of-the-box. Otherwise, if you want to use named imports, you'll have to import knex like this:

1import { knex } from 'knex/knex.mjs';

You can also just do the default import:

1import knex from 'knex';

If you are not using TypeScript and would like the IntelliSense of your IDE to work correctly, it is recommended to set the type explicitly:

1/**
2 * @type {Knex}
3 */
4const database = knex({
5  client: 'mysql',
6  connection: {
7    host: '127.0.0.1',
8    user: 'your_database_user',
9    password: 'your_database_password',
10    database: 'myapp_test',
11  },
12});
13database.migrate.latest();