aerospike/hll

const Aerospike = require('aerospike')
const hll = Aerospike.hll
const key = new Aerospike.Key('test', 'demo', 'hllDemo')

// INSERT HOSTNAME AND PORT NUMBER OF AEROSPIKE SERVER NODE HERE!
var config = {
  hosts: '192.168.33.10:3000',
  // Timeouts disabled, latency dependent on server location. Configure as needed.
  policies: {
    operate : new Aerospike.OperatePolicy({socketTimeout : 0, totalTimeout : 0})
  }
}
Aerospike.connect(config).then(async client => {
  const result = await client.operate(key, [
    hll.init('demo', 10),
    hll.add('demo', ['blue', 'green', 'red']),
    hll.add('demo', ['green', 'orange', 'yellow']),
    hll.add('demo', ['red', 'blue']),
    hll.getCount('demo')
  ])
  console.log('Count:', result.bins.demo) // => Count: 5
  client.close()
})

const Aerospike = require('aerospike')
const hll = Aerospike.hll
const ops = Aerospike.operations
// INSERT HOSTNAME AND PORT NUMBER OF AEROSPIKE SERVER NODE HERE!
var config = {
  hosts: '192.168.33.10:3000',
  // Timeouts disabled, latency dependent on server location. Configure as needed.
  policies: {
    operate : new Aerospike.OperatePolicy({socketTimeout : 0, totalTimeout : 0})
  }
}
const key1 = new Aerospike.Key('test', 'demo', 'hllDemo1')
const key2 = new Aerospike.Key('test', 'demo', 'hllDemo2')
const key3 = new Aerospike.Key('test', 'demo', 'hllDemo3')

Aerospike.connect(config).then(async client => {
  const { bins: { colors: colors1 } } = await client.operate(key1, [
    hll.add('colors', ['blue', 'green', 'orange', 'yellow'], 12),
    ops.read('colors')
  ])

  const { bins: { colors: colors2 } } = await client.operate(key2, [
    hll.add('colors', ['violet', 'purple', 'pink', 'orange'], 8),
    ops.read('colors')
  ])

  const { bins: { colors: count } } = await client.operate(key3, [
    hll.add('colors', ['red', 'yellow', 'brown', 'green'], 10),
    hll.setUnion('colors', [colors1, colors2])
         .withPolicy({ writeFlags: hll.writeFlags.ALLOW_FOLD }),
    hll.getCount('colors')
  ])

  console.log('Count:', count) // => Count: 9
  client.close()
})

Classes

HLLOperation

Members

(static) writeFlags :Object

HLL write flags.

Source:

• hll.js, line 150

See:

• HLLPolicy

Properties:

Type:

• Object

Methods

(static) add(bin, list, indexBitsopt, minhashBitsopt) → {Object}

Description:

• Adds elements to the HLL set. If the bin does not exist, create the HLL with the indexBits and minhashBits parameters.

  Returns an integer indicating number of entries that caused HLL to update a register.

  The add operation supports the following HLL Policy write flags:

  • CREATE_ONLY
  • NO_FAIL

  Not specifying the bit count, implies UPDATE_ONLY.

Source:

• hll.js, line 194

Parameters:

Returns:

Type

Object

(static) describe(bin) → {Object}

Description:

• Returns the index and min hash bit counts used to create the HLL bin as a list of integers.

Source:

• hll.js, line 325

Parameters:

Returns:

Type

Object

(static) fold(bin, indexBits) → {Object}

Description:

• Folds the index bit count to the specified value. This can only be applied when the min hash count on the HLL bin is 0.

Source:

• hll.js, line 243

Parameters:

Returns:

Type

Object

(static) getCount(bin) → {Object}

Description:

• Returns the estimated number of elements in the HLL bin.

Source:

• hll.js, line 253

Parameters:

Returns:

Type

Object

(static) getIntersectCount(bin, list) → {Object}

Description:

• Returns the estimated number of elements that would be contained by the intersection of these HLL objects.

Source:

• hll.js, line 297

Parameters:

Returns:

Type

Object

(static) getSimilarity(bin, list) → {Object}

Description:

• Returns the estimated similarity of these HLL objects. Return type is double.

Source:

• hll.js, line 311

Parameters:

Returns:

Type

Object

(static) getUnion(bin, list) → {Object}

Description:

• Returns an HLL object, which is the union of all specified HLL objects in the list with the HLL bin.

Source:

• hll.js, line 267

Parameters:

Returns:

Type

Object

(static) getUnionCount(bin, list) → {Object}

Description:

• Returns the estimated number of elements that would be contained by the union of these HLL objects.

Source:

• hll.js, line 282

Parameters:

Returns:

Type

Object

(static) init(bin, indexBits, minhashBitsopt) → {Object}

Description:

• Creates a new HLL or re-initializes an existing HLL. Re-initialization clears existing contents.

  The init operation supports the following HLL Policy write flags:

  • CREATE_ONLY
  • UPDATE_ONLY
  • NO_FAIL

Source:

• hll.js, line 168

Parameters:

Returns:

Type

Object

(static) refreshCount(bin) → {Object}

Description:

• Updates the cached count (if stale), and returns the estimated number of elements in the HLL bin.

Source:

• hll.js, line 231

Parameters:

Returns:

Type

Object

(static) setUnion(bin, list) → {Object}

Description:

• Sets a union of the specified HLLs with the HLL bin value (if it exists) back into the HLL bin.

  The setUnion operation supports the following HLL Policy write flags:

  • CREATE_ONLY
  • UPDATE_ONLY
  • ALLOW_FOLD
  • NO_FAIL

  If ALLOW_FOLD is not set, all provided HLLs and the target bin (if it exists) must have matching index bits and minhash bits. If ALLOW_FOLD is set, server will union down to the minimum index bits of all provided HLLs and the target bin (if it exists). Additionally, if minhash bits differs on any HLL, the resulting union will have 0 minhash bits.

Source:

• hll.js, line 220

Parameters:

Returns:

Type

Object