Bookshelfjs ORM How to get or see SQL statement its building

When building ORM query, I want to see what the actual (raw) query is that is executed.

For example in Rails we can do like this:

User.where(name: 'Oscar').to_sql
# => SELECT "users".* FROM "users"  WHERE "users"."name" = 'Oscar'

This feature present in Bookshelfjs? or any other way to get this?

[vellotis]

Hi @raj-optisol

You can use .query().toSQL() or .query().toString(). But achieving exact result as in Rails is a bit more complicated as queries may be not complete. The cause is that many statements get applied just before performing the query in Bookshelf. For example Bookshelf relations behave so. Also many plugins use events to apply query statements. If you want to debug the queries then I would suggest you to use Knex#debug instead. For example

model.query(function(qb) {
  qb.debug(true);
}).fetch()

It prints the debug info in the console.

[Paxa]

If you run with DEBUG=knex:query it will print queries but it will be something like:

  knex:query select "users".* from "users" where "company_id" = ? limit ? +3ms

If you need to see more - you can patch current code and add custom logging:

var util = require('util');
var knexClient = require('knex/lib/client');
var origQuery = knexClient.prototype.query;
knexClient.prototype.query = function (connection, obj) {
  console.log(`SQL: ${obj.sql}  --  ${util.inspect(this.prepBindings(obj.bindings))}`);
  return origQuery.apply(this, arguments);
};

Output will be:

SQL: select "users".* from "users" where "company_id" = ? limit ?  --  [45, 1]