Awesome

node-skizze

node-skizze are Node.js bindings for the Skizze database.

NOTE node-skizze is alpha software and still in heavy development.

Installation

$ npm install --save skizze

Example

var skizze = require('skizze');

var client = skizze.createClient("127.0.0.1:3596", { insecure: true });

client.createDomain("mydomain", function(err) {

	client.addToDomain("mydomain", ['alvin', 'simon', 'theodore'], function(err) {
		client.getCardinality("mydomain", function(err, card) {
			console.log(err, card);
		});
	});
});

Documentation

Classes

Members

Functions

<a name="SkizzeClient"></a>

SkizzeClient

Kind: global class

• SkizzeClient
  • new SkizzeClient()
  • .createSnapshot(callback)
  • .getSnapshot(callback)
  • .listSketches(type, callback)
  • .listDomains(callback)
  • .listAll(callback)
  • .createDomain(name, callback)
  • .createDomainWithProperties(name, sketches, callback)
  • .deleteDomain(name, callback)
  • .getDomain(name, callback)
  • .createSketch(name, callback)
  • .deleteSketch(name, callback)
  • .getSketch(name, callback)
  • .addToDomain(name, values, callback)
  • .addToSketch(name, values, callback)
  • .getMembership(name, values, callback)
  • .getMultiMembership(names, values, callback)
  • .getFrequency(name, values, callback)
  • .getMultiFrequency(names, values, callback)
  • .getRankings(name, callback)
  • .getMultiRankings(names, callback)
  • .getCardinality(name, callback)
  • .getMultiCardinality(names, callback)

<a name="new_SkizzeClient_new"></a>

new SkizzeClient()

Represents a connection to the Skizze database.

<a name="SkizzeClient+createSnapshot"></a>

skizzeClient.createSnapshot(callback)

Request a snapshot to be taken.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getSnapshot"></a>

skizzeClient.getSnapshot(callback)

Get details of the current or last snapshot.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+listSketches"></a>

skizzeClient.listSketches(type, callback)

List Sketches of a specific type.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+listDomains"></a>

skizzeClient.listDomains(callback)

List all domains.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+listAll"></a>

skizzeClient.listAll(callback)

List all Sketches.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+createDomain"></a>

skizzeClient.createDomain(name, callback)

Create a new domain with default settings for it's Sketches.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+createDomainWithProperties"></a>

skizzeClient.createDomainWithProperties(name, sketches, callback)

Create a new domain with customized settings.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+deleteDomain"></a>

skizzeClient.deleteDomain(name, callback)

Delete a domain.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getDomain"></a>

skizzeClient.getDomain(name, callback)

Get details of an existing domain.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+createSketch"></a>

skizzeClient.createSketch(name, callback)

Create a new Sketch.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+deleteSketch"></a>

skizzeClient.deleteSketch(name, callback)

Delete a Sketch.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getSketch"></a>

skizzeClient.getSketch(name, callback)

Get details of an existing sketch.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+addToDomain"></a>

skizzeClient.addToDomain(name, values, callback)

Add values to a domain.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+addToSketch"></a>

skizzeClient.addToSketch(name, values, callback)

Add values to a sketch.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getMembership"></a>

skizzeClient.getMembership(name, values, callback)

Query the sketch for membership (true/false) for the provided values.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getMultiMembership"></a>

skizzeClient.getMultiMembership(names, values, callback)

Query the sketches for membership (true/false) for the provided values.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getFrequency"></a>

skizzeClient.getFrequency(name, values, callback)

Query the sketch for frequency of the provided values.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getMultiFrequency"></a>

skizzeClient.getMultiFrequency(names, values, callback)

Query the sketches for frequency of the provided values.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getRankings"></a>

skizzeClient.getRankings(name, callback)

Query the sketch for top rankings.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getMultiRankings"></a>

skizzeClient.getMultiRankings(names, callback)

Query the sketches top rankings.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getCardinality"></a>

skizzeClient.getCardinality(name, callback)

Query the sketch for cardinality.

Kind: instance method of <code>SkizzeClient</code>

<a name="SkizzeClient+getMultiCardinality"></a>

skizzeClient.getMultiCardinality(names, callback)

Query the sketches for cardinality.

Kind: instance method of <code>SkizzeClient</code>

<a name="sketchType"></a>

sketchType : <code>enum</code>

Enum for Sketch type values.

Kind: global enum
Read only: true
Properties

<a name="snapshotState"></a>

snapshotState : <code>enum</code>

Enum for Snapshot state values.

Kind: global enum
Read only: true
Properties

<a name="createClient"></a>

createClient(address, options) ⇒ <code>SkizzeClient</code>

Creates and returns a new client connection to Skizze

Kind: global function
Returns: <code>SkizzeClient</code> - - A SkizzeClient.

TODO

• Merge in testing
• Hook up to Travis
• Example
• Versioning
• npm

License

node-skizze is available under the Apache License, Version 2.0.

Authors

• Neil Jagdish Patel