aerospike 5.12.0 → 5.13.0

package/README.md

@@ -1,4 +1,4 @@
-# Aerospike Node.js Client [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url]
+# Aerospike Node.js Client [![codecov][codecov-image]][codecov-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url]
 
 [travis-image]: https://travis-ci.org/aerospike/aerospike-client-nodejs.svg?branch=master
 [travis-url]: https://travis-ci.org/aerospike/aerospike-client-nodejs
@@ -11,12 +11,12 @@
 
 The Aerospike Node.js client is a Node.js add-on module, written using V8.
 
-The client is compatible with Node.js 20 (Upcoming LTS) and 18 (LTS).
+The client is compatible with Node.js 23, Node.js 22, (LTS), Node.js 20 (LTS),and 18 (LTS).
 It supports the following operating systems:
 - RHEL 8/9
 - Debian 11
 - Amazon Linux 2023
-- Ubuntu 20.04/22.04 (Focal Fossa, Jammy Jellyfish)
+- Ubuntu 20.04/22.04/24.04 (Focal Fossa, Jammy Jellyfish, Noble Numbat)
 - Many Linux distributions compatible with one of the above OS releases.
 - macOS 12/13/14
 
@@ -78,11 +78,8 @@ const config = {
 
 const key = new Aerospike.Key('test', 'demo', 'demo')
 
-;(async function () {
-  let client
-  try {
-    client = await Aerospike.connect(config)
-
+Aerospike.connect(config)
+  .then(client => {
     const bins = {
       i: 123,
       s: 'hello',
@@ -100,32 +97,39 @@ const key = new Aerospike.Key('test', 'demo', 'demo')
       totalTimeout : 0
     })
 
-
-    await client.put(key, bins, meta, policy)
-    const ops = [
-      Aerospike.operations.incr('i', 1),
-      Aerospike.operations.read('i'),
-      Aerospike.lists.append('l', 'z'),
-      Aerospike.maps.removeByKey('m', 'bar')
-    ]
-
-    await client.operate(key, ops)
-    let record = await client.get(key) 
-
-    console.log(record.bins) // => { i: 124,
-                             //      s: 'hello',
-                             //      b: <Buffer 77 6f 72 6c 64>,
-                             //      d: 3.1415,
-                             //      g: '{"type":"Point","coordinates":[103.913,1.308]}',
-                             //      l: [ 1, 'a', { x: 'y' }, 'z' ],
-                             //      m: { foo: 4 } }
-  } catch (error) {
-    console.error('Error:', error)
-    process.exit(1)
-  } finally {
-    if (client) client.close()
-  }
-})()
+    return client.put(key, bins, meta, policy)
+      .then(() => {
+        const ops = [
+          Aerospike.operations.incr('i', 1),
+          Aerospike.operations.read('i'),
+          Aerospike.lists.append('l', 'z'),
+          Aerospike.maps.removeByKey('m', 'bar')
+        ]
+
+        return client.operate(key, ops)
+      })
+      .then(result => {
+        console.log(result.bins) // => { i: 124, l: 4, m: null }
+
+        return client.get(key)
+      })
+      .then(record => {
+        console.log(record.bins) // => { i: 124,
+                                 //      s: 'hello',
+                                 //      b: <Buffer 77 6f 72 6c 64>,
+                                 //      d: 3.1415,
+                                 //      g: '{"type":"Point","coordinates":[103.913,1.308]}',
+                                 //      l: [ 1, 'a', { x: 'y' }, 'z' ],
+                                 //      m: { foo: 4 } }
+      })
+      .then(() => client.close())
+  })
+  .catch(error => {
+    console.error('Error: %s [%i]', error.message, error.code)
+    if (error.client) {
+      error.client.close()
+    }
+  })
 ```
 ## Prerequisites
 
@@ -309,7 +313,7 @@ The API docs also contain a few basic tutorials:
 * [Handling asynchronous database operations using Callbacks, Promises or `async`/`await`](https://www.aerospike.com/apidocs/nodejs/tutorial-callbacks_promises_async_await.html)
 
 A variety of additional example applications are provided in the
-[`examples`](examples) directory of this repository.
+[`examples`](https://github.com/aerospike/aerospike-client-nodejs/tree/master/examples) directory of this repository.
 
 Access backward incompatible API changes by a release at:
 https://developer.aerospike.com/client/nodejs/usage/incompatible.

package/benchmarks/alerts.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/benchmarks/inspect.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/benchmarks/logging.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/benchmarks/main.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/benchmarks/memory.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/benchmarks/stats.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/benchmarks/worker.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/add.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/append.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/apply.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/batch.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/exists.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/geospatialMonteCarlo.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/get.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/info.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/operate.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/put.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/query.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/remove.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/run.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/scan.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/sindex.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/examples/udf.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/lib/aerospike.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.
@@ -272,6 +272,20 @@ exports.Record = require('./record')
  */
 exports.Bin = require('./bin')
 
+/**
+ * Scan class return by the {@link Client#scan} method.
+ *
+ * @summary {@link Scan} class
+ */
+exports.Scan = require('./scan')
+
+/**
+ * Query class returned by the {@link Client#query} method.
+ *
+ * @summary {@link Query} class
+ */
+exports.Query = require('./query')
+
 // ========================================================================
 // Enumerations
 // ========================================================================
@@ -402,7 +416,7 @@ exports.log = as.log
  *
  * @property {number} NAMESPACE_DEFAULT - Use the default TTL value for the
  * namespace of the record.
- * @property {number} NEVER_EXIRE - Never expire the record.
+ * @property {number} NEVER_EXPIRE - Never expire the record.
  * @property {number} DONT_UPDATE - Update the record without changing the
  * record's TTL value. Requires server 3.10.1 or later.
  *
@@ -461,6 +475,20 @@ exports.ttl = as.ttl
  */
 exports.jobStatus = as.jobStatus
 
+/**
+ * @summary IndexJob class
+ *
+ * @see {@link IndexJob} for more information.
+ */
+exports.IndexJob = require('./index_job')
+
+/**
+ * @summary Job class
+ *
+ * @see {@link Job} for more information.
+ */
+exports.Job = require('./job')
+
 /**
  * @summary Enumeration of SI data types.
  *

package/lib/batch_type.js

@@ -30,25 +30,25 @@ const batchType = as.batchTypes
 // ========================================================================
 module.exports = {
   /**
-     * An instance of class {@link Record} that is used in a batch for read operations.
+     * Indicates that a {@link Record} instance is used in a batch for read operations.
      * @const {number}
      */
   BATCH_READ: batchType.BATCH_READ,
 
   /**
-     * An instance of class {@link Record} that is used in a batch for write operations.
+     * Indicates that a {@link Record} instance is used in a batch for write operations.
      * @const {number}
      */
   BATCH_WRITE: batchType.BATCH_WRITE,
 
   /**
-     * An instance of class {@link Record} that is used in a batch for applying record.
+     * Indicates that a {@link Record} instance is used in a batch for applying record.
      * @const {number}
      */
   BATCH_APPLY: batchType.BATCH_APPLY,
 
   /**
-     * An instance of class {@link Record} that is used in a batch for removal operations.
+     * Indicates that a {@link Record} instance is used in a batch for removal operations.
      * @const {number}
      */
   BATCH_REMOVE: batchType.BATCH_REMOVE

package/lib/bigint.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.

package/lib/bitwise.js

@@ -157,7 +157,7 @@ exports.resize = function (bin, size, flags = 0) {
  * a value.
  *
  * @param {string} bin - The name of the bin. The bin must contain a byte value.
- * @param {number} offset - Offset in bytes.
+ * @param {number} byteOffset - Offset in bytes.
  * @param {Buffer} value - Bytes to insert.
  * @returns {BitwiseOperation} Operation that can be passed to the {@link Client#operate} command.
  */

package/lib/client.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.
@@ -2285,7 +2285,17 @@ Client.prototype.exists = function exists (key, policy, callback) {
     policy = null
   }
 
-  const cmd = new Commands.Exists(this, [key, policy], callback)
+  const cmd = new Commands.Exists(this, null, [key, policy], callback)
+  return cmd.execute()
+}
+
+Client.prototype.existsWithMetadata = function exists (key, policy, callback) {
+  if (typeof policy === 'function') {
+    callback = policy
+    policy = null
+  }
+
+  const cmd = new Commands.Exists(this, key, [policy], callback)
   return cmd.execute()
 }
 

package/lib/commands/batch_command.js

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright 2013-2023 Aerospike, Inc.
+// Copyright 2013-2024 Aerospike, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License")
 // you may not use this file except in compliance with the License.
@@ -20,9 +20,10 @@ const Command = require('./command')
 const Record = require('../record')
 
 class BatchResult {
-  constructor (status, record) {
+  constructor (status, record, inDoubt) {
     this.status = status
     this.record = record
+    this.inDoubt = inDoubt
   }
 }
 
@@ -32,7 +33,7 @@ module.exports = asCommand => class BatchCommand extends Command(asCommand) {
 
     return results.map(result => {
       const record = new Record(result.key, result.bins, result.meta)
-      return new BatchResult(result.status, record)
+      return new BatchResult(result.status, record, result.inDoubt)
     })
   }
 }