knex/clients/server/base.js

// ServerBase
// -------

var _          = require('lodash');

var Pool       = require('../pool').Pool;
var ClientBase = require('../base').ClientBase;
var Promise    = require('../../lib/promise').Promise;

var ServerBase = ClientBase.extend({

  // Pass a config object into the constructor,
  // which then initializes the pool and
  constructor: function(config) {
    if (config.debug) this.isDebugging = true;
    this.attachGrammars();
    this.connectionSettings = config.connection;
    this.initPool(config.pool);
    _.bindAll(this, 'getRawConnection');
  },

  // Initialize a pool with the apporpriate configuration and
  // bind the pool to the current client object.
  initPool: function(poolConfig) {
    this.pool = new Pool(_.extend({}, _.result(this, 'poolDefaults'), poolConfig), this);
  },

  // Execute a query on the specified Builder or QueryBuilder
  // interface. If a `connection` is specified, use it, otherwise
  // acquire a connection, and then dispose of it when we're done.
  query: Promise.method(function(builder) {
    var conn, client = this;
    var sql        = builder.toSql(builder);
    var bindings   = builder.getBindings();

    var chain = this.getConnection(builder).then(function(connection) {
      if (client.isDebugging || builder.flags.debug) {
        client.debug(sql, bindings, connection, builder);
      }
      conn = connection;
      if (_.isArray(sql)) {
        var current = Promise.fulfilled();
        return Promise.map(sql, function(query, i) {
          current = current.then(function () {
            builder.currentIndex = i;
            return client.runQuery(connection, query, bindings, builder);
          });
          return current;
        });
      }
      return client.runQuery(connection, sql, bindings, builder);
    });

    // If the builder came with a supplied connection, then we won't do
    // anything to it (most commonly in the case of transactions)... otherwise,
    // ensure the connection gets dumped back into the client pool.
    if (!builder.usingConnection) {
      chain = chain.ensure(function() {
        if (!conn) {
          // The connection must have failed to initialize. Avoid pushing undefined
          // into the connection pool.
          return;
        }
        client.pool.release(conn);
      });
    }

    // Since we usually only need the `sql` and `bindings` to help us debug the query, output them
    // into a new error... this way, it `console.log`'s nicely for debugging, but you can also
    // parse them out with a `JSON.parse(error.message)`. Also, use the original `clientError` from the
    // database client is retained as a property on the `newError`, for any additional info.
    return chain.then(builder.handleResponse).caught(function(error) {
      var newError = new Error(error.message + ', sql: ' + sql + ', bindings: ' + bindings);
          newError.sql = sql;
          newError.bindings = bindings;
          newError.clientError = error;
      throw newError;
    });
  }),

  // Debug a query.
  debug: function(sql, bindings, connection, builder) {
    console.log({sql: sql, bindings: bindings, __cid: connection.__cid});
  },

  // Retrieves a connection from the connection pool,
  // returning a promise.
  getConnection: function(builder) {
    if (builder && builder.usingConnection) return Promise.fulfilled(builder.usingConnection);
    return Promise.promisify(this.pool.acquire, this.pool)();
  },

  // Releases a connection from the connection pool,
  // returning a promise.
  releaseConnection: function(conn) {
    return Promise.promisify(this.pool.release)(conn);
  },

  // Begins a transaction statement on the instance,
  // resolving with the connection of the current transaction.
  startTransaction: function() {
    return this.getConnection()
      .tap(function(connection) {
        return Promise.promisify(connection.query, connection)('begin;', []);
      });
  },

  // Finishes the transaction statement on the instance.
  finishTransaction: function(type, transaction, msg) {
    var client = this;
    var dfd    = transaction.dfd;
    Promise.promisify(transaction.connection.query, transaction.connection)(type + ';', []).then(function(resp) {
      if (type === 'commit') dfd.fulfill(msg || resp);
      if (type === 'rollback') dfd.reject(msg || resp);
    }, function (err) {
      dfd.reject(err);
    }).ensure(function() {
      return client.releaseConnection(transaction.connection).tap(function() {
        transaction.connection = null;
      });
    });
  }

});

exports.ServerBase = ServerBase;