kvs-abstract

KVS - Abstract

KVS or Key Value Store is an abstract KeyValueStore system. The kvs-* group of node modules, are intended to present a unified interface to key value stores of every persuasion. This allows for substituting them without changing anything but the initializing parameters.

KVS-Abstract itself is the abstract base class for any of the modules in the group. Unless you intend to implement a KVS compliant module, you will have no use for this module.

Use of KVS

var KVS=require('kvs-<coose-a-module>');
var store = new KVS({ <options> });
store.set('name', new Buffer('value is a buffer'), function(err) {…});
store.get('name', function(err, value) { … });
store.remove('name', function(err) { … });
store.list('name', function(err, value) { … });

User of KVS-Abstract

var Abstract = require('kvs-abstract');

Abstract.bequeath(MyBackend);
function MyBackend() {
	Abstract.instantiate(this);
	// Custom Initialization Here
}
Abstract.prototype._get = function(name, callback) { … }
Abstract.prototype._set = function(name, value, callback) { … }
Abstract.prototype._remove = function(name, callback) { … }
Abstract.prototype._list = function(name, callback) {
	// This is the format of the expected response
	callback(null, {
		count:1,
		values:[ 'name' ]
	});
}

License (MIT)

Copyright (c) 2013 Philipp Dunkel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.