index.js

//  ██╗    ██╗ █████╗ ████████╗███████╗██████╗ ██╗     ██╗███╗   ██╗███████╗
//  ██║    ██║██╔══██╗╚══██╔══╝██╔════╝██╔══██╗██║     ██║████╗  ██║██╔════╝
//  ██║ █╗ ██║███████║   ██║   █████╗  ██████╔╝██║     ██║██╔██╗ ██║█████╗
//  ██║███╗██║██╔══██║   ██║   ██╔══╝  ██╔══██╗██║     ██║██║╚██╗██║██╔══╝
//  ╚███╔███╔╝██║  ██║   ██║   ███████╗██║  ██║███████╗██║██║ ╚████║███████╗
//   ╚══╝╚══╝ ╚═╝  ╚═╝   ╚═╝   ╚══════╝╚═╝  ╚═╝╚══════╝╚═╝╚═╝  ╚═══╝╚══════╝
//
//  ███████╗ ██████╗ ██╗         ██████╗ ██╗   ██╗██╗██╗     ██████╗ ███████╗██████╗
//  ██╔════╝██╔═══██╗██║         ██╔══██╗██║   ██║██║██║     ██╔══██╗██╔════╝██╔══██╗
//  ███████╗██║   ██║██║         ██████╔╝██║   ██║██║██║     ██║  ██║█████╗  ██████╔╝
//  ╚════██║██║▄▄ ██║██║         ██╔══██╗██║   ██║██║██║     ██║  ██║██╔══╝  ██╔══██╗
//  ███████║╚██████╔╝███████╗    ██████╔╝╚██████╔╝██║███████╗██████╔╝███████╗██║  ██║
//  ╚══════╝ ╚══▀▀═╝ ╚══════╝    ╚═════╝  ╚═════╝ ╚═╝╚══════╝╚═════╝ ╚══════╝╚═╝  ╚═╝
//
// Use Waterline Statements to generate a SQL query that can be used in one of
// the many supported drivers or run independently.

var Knex = require('knex');
var Utils = require('waterline-utils');
var Sequelizer = require('./lib/sequelizer');

module.exports = function sqlBuilder(options) {
  if (!options.dialect) {
    throw new Error('Missing Dialect!');
  }

  // Modify deprecated dialect values
  if (options.dialect==='mariadb') {
    options.dialect='mysql';
  }
  if (options.dialect==='oracle') {
    options.dialect='oracledb';
  }

  // Build up a Knex instance to use in the query builder
  var knexInstance = Knex({
    client: options.dialect,
    useNullAsDefault: true
  });


  return {

    //  ╔═╗╔═╗╔╗╔╔═╗╦═╗╔═╗╔╦╗╔═╗╦═╗
    //  ║ ╦║╣ ║║║║╣ ╠╦╝╠═╣ ║ ║ ║╠╦╝
    //  ╚═╝╚═╝╝╚╝╚═╝╩╚═╩ ╩ ╩ ╚═╝╩╚═
    // This the main function used by the adapters. Given a Statement, use the
    // query parser to generate a token tree and then build up a SQL string.
    generate: function generate(query) {
      // Tokenize the values
      var tokens = Utils.query.tokenizer(query);

      // Analyze the tokens
      var tree = Utils.query.analyzer(tokens);

      // Generate the SQL
      var sql = Sequelizer({
        knex: knexInstance,
        tree: tree
      });

      return sql;
    },

    //  ╔═╗╔═╗╔═╗ ╦ ╦╔═╗╦  ╦╔═╗╔═╗╦═╗
    //  ╚═╗║╣ ║═╬╗║ ║║╣ ║  ║╔═╝║╣ ╠╦╝
    //  ╚═╝╚═╝╚═╝╚╚═╝╚═╝╩═╝╩╚═╝╚═╝╩╚═
    // Given a token tree from the query parser, build up a SQL string.
    sequelizer: function sequelizer(tree) {
      return Sequelizer({
        knex: knexInstance,
        tree: tree
      });
    }
  };
};