Interface KeyOptions

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

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.

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]))
interface KeyOptions {
    digest?: Buffer;
    key?: string | number | Buffer;
    ns: string;
    set: string;
}

Implemented by

Properties

digest? key? ns set

Properties

Optionaldigest

digest?: Buffer

The digest value of the key.

Optionalkey

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

The Set to which the key belongs.

Settings

Member Visibility

On This Page

Key Digests
Properties
MMNEPVFCICPMFPCPTTAAATR