Improving documentation

.travis/wait-for-docker-up.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const basePromise = require("../lib/index");
+const basePromise = require("../promise");
 const Conf = require('../test/conf');
 
 let decrement = 30;

benchmarks/common_benchmarks.js

@@ -4,8 +4,8 @@ const Benchmark = require("benchmark");
 const conf = require("../test/conf");
 
 const colors = require("colors");
-const mariadb = require("../lib/index");
+const mariadb = require("../promise");
-const callbackMariadb = require("../lib/callback");
+const callbackMariadb = require("../callback");
 
 let promiseMariasql, mariasql, promiseMysql, mysql, promiseMysql2, mysql2;
 

callback.js

@@ -1,7 +1,7 @@
 "use strict";
 
-let ConnectionCallback = require("./connection-callback");
+let ConnectionCallback = require("./lib/connection-callback");
-let ConnOptions = require("./config/connection-options");
+let ConnOptions = require("./lib/config/connection-options");
 
 module.exports.createConnection = function createConnection(opts) {
   return new ConnectionCallback(new ConnOptions(opts));

documentation/callback-api.md

@@ -15,6 +15,24 @@ npm install mariadb
 import is not `require('mariadb')`, but `require('mariadb/callback')`
 Callback API is similar to the Promise one, with this difference : 
 
+
+# Quick Start
+
+    npm install mariadb
+
+```js
+  const mariadb = require('mariadb/callback');
+  const conn = mariadb.createConnection({host: 'mydb.com', user:'myUser'});
+  conn.query("SELECT 1 as val", (err, rows) => {
+      console.log(rows); //[ {val: 1}, meta: ... ]
+      conn.query("INSERT INTO myTable value (?, ?)", [1, "mariadb"], (err, res) => {
+        console.log(res); // { affectedRows: 1, insertId: 1, warningStatus: 0 }
+        conn.end();
+      });
+  });    
+```
+
+
 ## Callback API
 
 Create Connection

lib/connection.js

@@ -440,7 +440,11 @@ function Connection(options) {
 
     let cmd;
     if (_cb) {
-      const resolve = rows => _cb(null, rows, rows.meta);
+      const resolve = rows => {
+        const meta = rows.meta;
+        delete rows.meta;
+        _cb(null, rows, meta);
+      };
       cmd = new Query(resolve, _cb, _options, _sql, _values);
     } else {
       cmd = new Query(() => {}, () => {}, _options, _sql, _values);

package.json

@@ -2,7 +2,7 @@
   "name": "mariadb",
   "version": "0.6.0",
   "description": "fast mariadb/mysql connector.",
-  "main": "./lib",
+  "main": "promise.js",
   "directories": {
     "src": "src",
     "test": "test"

promise.js

@@ -1,7 +1,7 @@
 "use strict";
 
-let Connection = require("./connection.js");
+let Connection = require("./lib/connection.js");
-let ConnOptions = require("./config/connection-options.js");
+let ConnOptions = require("./lib/config/connection-options.js");
 
 module.exports.createConnection = function createConnection(opts) {
   try {

test/base.js

@@ -1,7 +1,7 @@
 "use strict";
 
-const basePromise = require("../lib/index");
+const basePromise = require("../promise");
-const baseCallback = require("../lib/callback");
+const baseCallback = require("../callback");
 const Conf = require("./conf");
 
 //*****************************************************************

test/integration/test-multi-results.js

@@ -142,6 +142,7 @@ describe("multi-results", () => {
           if (err) {
             done(err);
           } else {
+            console.log(rows);
             assert.deepEqual(rows, [{ "1": 1 }]);
             callbackConn.end();
             done();