Class Key

Key

A key uniquely identifies a record in the Aerospike database within a given namespace.

Remarks

Key Digests

In your application, you must specify the namespace, set and the key itself to read and write records. When a key is sent to the database, the key value and its set are hashed into a 160-bit digest. When a database command returns a key (e.g. Query or Scan commands) it might contain either the set and key value, or just the digest.

Param: ns

The Namespace to which the key belongs.

Param: set

The Set to which the key belongs.

Param: key

The unique key value. Keys can be strings, integers or an instance of the Buffer class.

Param: digest

The digest value of the key.

Example: Creating a new {@link Key} instance

const Aerospike = require('aerospike')
const Key = Aerospike.Key

var key1 = new Key('test', 'demo', 12345)
var key2 = new Key('test', 'demo', 'abcde')
var key3 = new Key('test', 'demo', Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]))

Implements

Constructors

constructor

Properties

digest key ns set

Methods

equals

Constructors

constructor

  • new Key(ns?, set?, key?, digest?): Key

  • Constructs a new Key instance.

    Parameters

    • Optionalns: null | string

      The Namespace to which the key belongs.

    • Optionalset: null | string

      The Set to which the key belongs.

    • Optionalkey:
          | null
          | string
          | number
          | BigInt
          | Buffer

      The unique key value. Keys can be strings, integers or an instance of the Buffer class.

    • Optionaldigest: null | Buffer

      The digest value of the key.

    Returns Key

Properties

digest

digest: undefined | Buffer

The digest value of the key.

key

key: string | number | Buffer

The unique key value. Keys can be strings, integers or an instance of the Buffer class.

ns

ns: string

The Namespace to which the key belongs.

set

set: string

he Set to which the key belongs.

Methods

equals

Settings

Member Visibility

On This Page

Key Digests
Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR