knex-redshift

knex.js

Gitter chat

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

A batteries-included, multi-dialect (MySQL, PostgreSQL, SQLite3, WebSQL, Oracle) query builder for Node.js and the Browser, featuring:

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

Read the full documentation to get started!

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

For an Object Relational Mapper, see: http://bookshelfjs.org

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:

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

Changelog

0.10.0 - 15 Feb, 2016

Breaking Changes:

• insert and update now ignore undefined values. Back compatibility is provided through the option useNullAsDefault. #1174, #1043

Other Changes:

• Add countDistinct, avgDistinct and sumDistinct. #1046
• Add schema.jsonb. Deprecated schema.json(column, true). #991
• Support binding identifiers with ??. #1103
• Restore query event when triggered by transactions. #855
• Correct question mark escaping in rendered queries. #519, #1058
• Add per-dialect escaping, allowing quotes to be escaped correctly. #886, #1095
• Add MSSQL support. #1090
• Add migration locking. #1094
• Allow column aliases to contain .. #1181
• Add batchInsert. #1182
• Support non-array arguments to knex.raw.
• Global query-error event. #1163
• Add batchInsert. #1182
• Better support for Mysql2 dialect options. #980
• Support for acquireConnectionTimeout default 60 seconds preventing #1040 from happening. #1177
• Fixed constraint name escaping when dropping a constraint. #1177
• Show also .raw queries in debug output. #1169
• Support for cli to use basic configuration without specific environment set. #1101