Added stop and active methods to LiveMsqlSelect prototype

Author: numtel

README.md

@@ -111,6 +111,8 @@ Method Name | Arguments | Description
 ------------|-----------|-----------------------
 `on`, `addListener` | `event`, `handler` | Add an event handler to the result set. See the following section for a list of the available event names.
 `update`    | `callback` | Update the result set. Callback function accepts `error, rows` arguments. Events will be emitted.
+`stop`      | *None* | Stop receiving updates
+`active`    | *None* | Return `true` if ready to recieve updates, `false` if `stop()` method has been called.
 
 As well as all of the other methods available on [`EventEmitter`](http://nodejs.org/api/events.html)...
 

lib/LiveMysql.js

@@ -68,6 +68,7 @@ LiveMysql.prototype.select = function(query, triggers){
      triggers.length === 0)
     throw new Error('triggers array required');
 
+  // Update schema included in ZongJi events
   var includeSchema = self.zongjiSettings.includeSchema;
   for(var i = 0; i < triggers.length; i++){
     var triggerDatabase = triggers[i].database || self.settings.database;

lib/LiveMysqlSelect.js

@@ -134,4 +134,21 @@ LiveMysqlSelect.prototype.update = function(callback){
   }
 };
 
+LiveMysqlSelect.prototype.stop = function(){
+  var self = this;
+  
+  var index = self.base._select.indexOf(self);
+  if(index !== -1){
+    self.base._select.splice(index, 1);
+    return true;
+  }else{
+    return false;
+  }
+};
+
+LiveMysqlSelect.prototype.active = function(){
+  var self = this;
+  return self.base._select.indexOf(self) !== -1;
+};
+
 module.exports = LiveMysqlSelect;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql-live-select",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "Live updating MySQL SELECT statements",
   "main": "lib/LiveMysql.js",
   "repository": "https://github.com/numtel/mysql-live-select",

test/index.js

@@ -113,13 +113,15 @@ module.exports = {
           }else if(rows.length === 0){
             // Give time, just in case the `removed` event comes in
             setTimeout(function(){
+              conn.settings.skipDiff = false;
               test.done();
             }, 100);
           }
         })
         .on('added', error)
         .on('changed', error)
-        .on('removed', error);
+        .on('removed', error)
+        .on('diff', error);
 
         querySequence(conn.db, [
           'UPDATE ' + escId(table) +
@@ -130,6 +132,43 @@ module.exports = {
       });
     });
   },
+  stopAndActive: function(test){
+    var table = 'stop_active';
+    server.on('ready', function(conn, esc, escId, queries){
+      querySequence(conn.db, [
+        'DROP TABLE IF EXISTS ' + escId(table),
+        'CREATE TABLE ' + escId(table) + ' (col INT UNSIGNED)',
+        'INSERT INTO ' + escId(table) + ' (col) VALUES (10)',
+      ], function(results){
+        conn.select('SELECT * FROM ' + escId(table), [ {
+          table: table,
+          database: server.database
+        } ]).on('update', function(rows){
+          if(rows.length > 0 && rows[0].col === 10){
+            test.ok(true);
+          }else if(rows.length > 0 && rows[0].col === 15){
+            test.ok(this.active());
+            this.stop();
+            test.ok(!this.active());
+            conn.db.query('DELETE FROM ' + escId(table));
+            setTimeout(function(){
+              test.done();
+            }, 100);
+          }
+        }).on('removed', function(row, index){
+          throw new Error('should not be called');
+        });
+
+        querySequence(conn.db, [
+          'UPDATE ' + escId(table) +
+          ' SET `col` = 15'
+        ], function(results){
+          // ...
+        });
+      });
+    });
+  },
+
   error_no_db_selected: function(test){
     server.on('ready', function(conn, esc, escId, queries){