1. module mariasql
   1. function mariasql (config)
   2. function mariasql.escape ()
   3. function mariasql.super_ ()
   4. function mariasql.version ()
   5. number mariasql.AUTO_INCREMENT_FLAG
   6. number mariasql.BINARY_FLAG
   7. number mariasql.BLOB_FLAG
   8. number mariasql.ENUM_FLAG
   9. number mariasql.MULTIPLE_KEY_FLAG
   10. number mariasql.NOT_NULL_FLAG
   11. number mariasql.NO_DEFAULT_VALUE_FLAG
   12. number mariasql.NUM_FLAG
   13. number mariasql.ON_UPDATE_NOW_FLAG
   14. number mariasql.PART_KEY_FLAG
   15. number mariasql.PRI_KEY_FLAG
   16. number mariasql.SET_FLAG
   17. number mariasql.TIMESTAMP_FLAG
   18. number mariasql.UNIQUE_KEY_FLAG
   19. number mariasql.UNSIGNED_FLAG
   20. number mariasql.ZEROFILL_FLAG

module mariasql

function mariasql (config)

• description and source-code

  function Client(config) {
    if (!(this instanceof Client))
      return new Client(config);
  
    EventEmitter.call(this);
  
    this._handle = null;
  
    if (typeof config === 'object' && config !== null)
      this._config = config;
    else
      this._config = {};
  
    var queryCache;
    var ncache = 30;
    if (typeof this._config.queryCache === 'number')
      ncache = this._config.queryCache;
    else if (typeof this._config.queryCache === 'object')
      queryCache = this._config.queryCache; // Assume lru-cache instance
    if (this._config.queryCache !== false && !queryCache)
      queryCache = new LRU({ max: ncache, dispose: EMPTY_LRU_FN });
  
    this._req = undefined;
    this._queue = [];
    this._queryCache = queryCache;
    this._handleClosing = false;
    this._tmrInactive = undefined;
    this._tmrPingWaitRes = undefined;
    this.connecting = false;
    this.connected = false;
    this.closing = false;
    this.threadId = undefined;
  
    if (this._config.threadId === false)
      return;
  
    // XXX: hack to get thread ID first before any other queries
    var self = this;
    this._firstQuery = {
      str: 'SELECT CONNECTION_ID()',
      cb: function(err, rows) {
        if (err) {
          self.emit('error', err);
          self.close(true);
          return;
        }
        self.threadId = rows[0][0];
        self.connecting = false;
        self.connected = true;
        self.emit('ready');
      },
      result: undefined,
      results: undefined,
      needMetadata: false,
      needColumns: false
    };
  }

• example usage

  n/a

function mariasql.escape ()

• description and source-code

  escape = function () { [native code] }

• example usage

  ...
  Client.prototype.lastInsertId = function() {
    this._initHandle();
    return this._handle.lastInsertId();
  };
  
  Client.prototype.escape = function(str) {
    this._initHandle();
    return this._handle.escape(str);
  };
  
  Client.prototype.serverVersion = function() {
    this._initHandle();
    return this._handle.serverVersion();
  };
  ...

function mariasql.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

function mariasql.version ()

• description and source-code

  version = function () { [native code] }

• example usage

  ...
  var DEFAULT_PASSWORD = process.env.DB_PASS || '';
  
  function NOOP(err) { assert.strictEqual(err, null); }
  
  var tests = [
  { what: 'Client::version()',
    run: function() {
      var version = Client.version();
      assert.strictEqual(typeof version, 'string');
      assert.notStrictEqual(version.length, 0);
      next();
    }
  },
  { what: 'Client::escape()',
    run: function() {
  ...