aerospike 5.10.0 → 5.12.0

package/README.md

@@ -78,8 +78,11 @@ const config = {
 
 const key = new Aerospike.Key('test', 'demo', 'demo')
 
-Aerospike.connect(config)
-  .then(client => {
+;(async function () {
+  let client
+  try {
+    client = await Aerospike.connect(config)
+
     const bins = {
       i: 123,
       s: 'hello',
@@ -97,39 +100,32 @@ Aerospike.connect(config)
       totalTimeout : 0
     })
 
-    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()
-    }
-  })
+
+    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()
+  }
+})()
 ```
 ## Prerequisites
 
@@ -188,6 +184,10 @@ To install library prerequisites using `apt`:
 sudo apt install g++ libssl libssl-dev zlib1g-dev
 ```
 
+### Windows
+
+See our [Windows README.md](https://github.com/aerospike/aerospike-client-nodejs/blob/master/README_WINDOWS.md) for details on how to build and install on windows.
+
 ### macOS
 
 Before starting with the Aerospike Nodejs Client, verify that you have the following prerequisites:

package/binding.gyp

@@ -144,13 +144,14 @@
         'src/main/enums/config_enum.cc',
         'src/main/enums/exp_enum.cc',
         'src/main/enums/batch_type.cc',
+        'src/main/enums/query_duration.cc',
         'src/main/enums/privilege_code.cc',
         'src/main/enums/exp_read_flags.cc',
         'src/main/enums/exp_write_flags.cc',
         'src/main/stats.cc',
         'src/main/util/conversions.cc',
         'src/main/util/conversions_batch.cc',
-        'src/main/util/log.cc'
+        'src/main/util/log.cc',
       ],
       'configurations': {
         'Release': {

package/examples/typescript.ts

@@ -0,0 +1,23 @@
+import * as Aerospike from 'aerospike';
+
+(async function () {
+  let client = null;
+  try {
+    client = await Aerospike.connect();
+    const key = new Aerospike.Key('test', 'test', 'abcd');
+    const bins = {
+      name: 'Norma',
+      age: 31
+    };
+
+    await client.put(key, bins);
+    const record = await client.get(key);
+    console.info('Record:', record);
+    await client.remove(key);
+  } catch (error) {
+    console.error('Error:', error);
+    process.exit(1);
+  } finally {
+    if (client) client.close();
+  }
+})();

package/lib/binding/node-v108-win32-x64/aerospike-core-client/aerospik.95E228AA.tlog/CustomBuild.command.1.tlog

@@ -1,3 +1,3 @@
 ^C:\USERS\ADMINISTRATOR\DOCUMENTS\AEROSPIKE-CLIENT-NODEJS\BINDING.GYP
-call call "pwsh" "../scripts/build-c-client.ps1" "-Configuration" "Release" "-NodeLibFile" "C:/Users/Administrator/AppData/Local/node-gyp/Cache/18.19.0/x64/node.lib"
+call call "pwsh" "../scripts/build-c-client.ps1" "-Configuration" "Release" "-NodeLibFile" "C:/Users/Administrator/AppData/Local/node-gyp/Cache/18.20.2/x64/node.lib"
 if %errorlevel% neq 0 exit /b %errorlevel%

package/lib/binding/node-v108-win32-x64/aerospike-core-client/aerospik.95E228AA.tlog/aerospike-core-client.lastbuildstate

@@ -1,2 +1,2 @@
-PlatformToolSet=v143:VCToolArchitecture=Native64Bit:VCToolsVersion=14.38.33130:TargetPlatformVersion=10.0.22621.0:
+PlatformToolSet=v143:VCToolArchitecture=Native64Bit:VCToolsVersion=14.39.33519:TargetPlatformVersion=10.0.22621.0:
 Release|x64|C:\Users\Administrator\Documents\aerospike-client-nodejs\build\|

package/lib/lists.js

@@ -1079,6 +1079,61 @@ exports.clear = function (bin) {
   return new ListOperation(opcodes.LIST_CLEAR, bin)
 }
 
+/**
+ * @summary Creates list create operation.
+ *
+ *
+ * @param {string} bin - bin name.
+ * @param {number} order - list order.
+ * @parm {boolean} pad - If true, the context is allowed to be beyond list boundaries. In that case, nil
+ * list entries will be inserted to satisfy the context position.
+ * @param {boolean} persistIndex - If true, persist list index. A list index improves lookup performance,
+ * but requires more storage. A list index can be created for a top-level ordered list only. Nested and
+ * unordered list indexes are not supported.
+ * @param {number} ctx - optional path to nested list. If not defined, the top-level list is used.
+ *
+ * @returns {Object} Operation that can be passed to the {@link Client#operate} command.
+ *
+ * @example
+ *
+ * const Aerospike = require('aerospike')
+ * const lists = Aerospike.lists
+ * const key = new Aerospike.Key('test', 'demo', 'listKey')
+ *
+ * // 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 => {
+ *   let ops = [
+ *     lists.create('list', lists.order.ORDERED, false, true)
+ *   ]
+ *   let result = await client.operate(key, ops)
+ *   console.log(result.bins)                    // => { list: null }
+ *   let record = await client.get(key)
+ *   console.log(record.bins)                    // => { list: [] }
+ *
+ *   await client.remove(key)
+ *   client.close()
+ * })
+ */
+exports.create = function (bin, order, pad = false, persistIndex = false, ctx) {
+  const op = new ListOperation(opcodes.LIST_CREATE, bin)
+  op.order = order
+  op.pad = pad
+  op.persistIndex = persistIndex
+  if (ctx === undefined) {
+    return op
+  }
+
+  return op.withContext(ctx)
+}
+
 /**
  * @summary Sets the list element at the specified index to a new value.
  * @description This operation returns no result.

package/lib/policies/batch_policy.js

@@ -58,6 +58,22 @@ class BatchPolicy extends BasePolicy {
      * @see {@link module:aerospike/policy.readModeSC} for supported policy values.
      */
     this.readModeSC = props.readModeSC
+
+    /**
+     * Determine how record TTL (time to live) is affected on reads. When enabled, the server can
+     * efficiently operate as a read-based LRU cache where the least recently used records are expired.
+     * The value is expressed as a percentage of the TTL sent on the most recent write such that a read
+     * within this interval of the record’s end of life will generate a touch.
+     *
+     * For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to
+     * 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most
+     * recent write) will result in a touch, resetting the TTL to another 10 hours.
+     *      *
+     * @type number
+     * @default 0
+     */
+    this.readTouchTtlPercent = props.readTouchTtlPercent
+
     /**
      * Determine if batch commands to each server are run in parallel threads.
      *

package/lib/policies/batch_read_policy.js

@@ -52,6 +52,21 @@ class BatchReadPolicy {
       * @see {@link module:aerospike/policy.readModeSC} for supported policy values.
       */
     this.readModeSC = props.readModeSC
+
+    /**
+     * Determine how record TTL (time to live) is affected on reads. When enabled, the server can
+     * efficiently operate as a read-based LRU cache where the least recently used records are expired.
+     * The value is expressed as a percentage of the TTL sent on the most recent write such that a read
+     * within this interval of the record’s end of life will generate a touch.
+     *
+     * For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to
+     * 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most
+     * recent write) will result in a touch, resetting the TTL to another 10 hours.
+     *      *
+     * @type number
+     * @default 0
+     */
+    this.readTouchTtlPercent = props.readTouchTtlPercent
   }
 }
 

package/lib/policies/batch_write_policy.js

@@ -36,6 +36,14 @@ class BatchWritePolicy {
      *
      */
     this.filterExpression = props.filterExpression
+
+    /**
+     * The time-to-live (expiration) of the record in seconds.
+     *
+     * @type number
+     */
+    this.ttl = props.ttl
+
     /**
      * Specifies the behavior for the key.
      *

package/lib/policies/operate_policy.js

@@ -113,6 +113,21 @@ class OperatePolicy extends BasePolicy {
      * @see {@link module:aerospike/policy.readModeSC} for supported policy values.
      */
     this.readModeSC = props.readModeSC
+
+    /**
+     * Determine how record TTL (time to live) is affected on reads. When enabled, the server can
+     * efficiently operate as a read-based LRU cache where the least recently used records are expired.
+     * The value is expressed as a percentage of the TTL sent on the most recent write such that a read
+     * within this interval of the record’s end of life will generate a touch.
+     *
+     * For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to
+     * 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most
+     * recent write) will result in a touch, resetting the TTL to another 10 hours.
+     *      *
+     * @type number
+     * @default 0
+     */
+    this.readTouchTtlPercent = props.readTouchTtlPercent
   }
 }
 

package/lib/policies/query_policy.js

@@ -95,6 +95,16 @@ class QueryPolicy extends BasePolicy {
      * @override
      */
     this.totalTimeout = props.totalTimeout
+
+    /**
+     * Expected query duration. The server treats the query in different ways depending on the expected duration.
+     * This field is ignored for aggregation queries, background queries and server versions < 6.0.
+     *
+     * @see {@link module:aerospike/policy.queryDuration} for supported policy values.
+     * @type {@link module:aerospike/policy.queryDuration}
+     * @default {@link module:aerospike/policy.queryDuration.LONG}
+     */
+    this.expectedDuration = props.expectedDuration
   }
 }
 

package/lib/policies/read_policy.js

@@ -68,6 +68,21 @@ class ReadPolicy extends BasePolicy {
      */
     this.readModeSC = props.readModeSC
 
+    /**
+     * Determine how record TTL (time to live) is affected on reads. When enabled, the server can
+     * efficiently operate as a read-based LRU cache where the least recently used records are expired.
+     * The value is expressed as a percentage of the TTL sent on the most recent write such that a read
+     * within this interval of the record’s end of life will generate a touch.
+     *
+     * For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to
+     * 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most
+     * recent write) will result in a touch, resetting the TTL to another 10 hours.
+     *      *
+     * @type number
+     * @default 0
+     */
+    this.readTouchTtlPercent = props.readTouchTtlPercent
+
     /**
      * Should CDT data types (Lists / Maps) be deserialized to JS data types
      * (Arrays / Objects) or returned as raw bytes (Buffer).

package/lib/policy.js

@@ -60,7 +60,7 @@ const AdminPolicy = require('./policies/admin_policy')
  * * {@link WritePolicy} - Applies to {@link Client#put}.
  * * {@link BatchPolicy} - Applies to {@link Client#batchRead} as well as the
  *   deprecated {@link Client#batchExists}, {@link Client#batchGet}, and {@link
- *   Client#batchSelect} operations.
+ *   Client#batchSelect} operations. Also used when providing batchParentWrite policy to a client configuration.
  * * {@link BatchApplyPolicy} - Applies to {@link Client#batchApply}.
  * * {@link BatchReadPolicy} - Applies to {@link Client#batchRead}.
  * * {@link BatchRemovePolicy} - Applies to {@link Client#batchRemove}.
@@ -296,6 +296,36 @@ exports.readModeSC = as.policy.readModeSC
  */
 exports.commitLevel = as.policy.commitLevel
 
+/**
+ * @summary Expected query duration. The server treats the query in different ways depending on the expected duration.
+ * This enum is ignored for aggregation (UDF) queries, background queries and server versions < 6.0.
+ *
+ * @enum {number}
+ *
+ * @property {number} LONG - The query is expected to return more than 100 records per node. The server optimizes for a
+ * large record set in the following ways:
+ * <ul>
+ * <li>Allow query to be run in multiple threads using the server's query threading configuration.</li>
+ * <li>Do not relax read consistency for AP namespaces.</li>
+ * <li>Add the query to the server's query monitor.</li>
+ * <li>Do not add the overall latency to the server's latency histogram.</li>
+ * <li>Do not allow server timeouts.</li>
+ * </ul>
+ * @property {number} SHORT - The query is expected to return less than 100 records per node. The server optimizes for a
+ * small record set in the following ways:
+ * <ul>
+ * <li>Always run the query in one thread and ignore the server's query threading configuration.</li>
+ * <li>Allow query to be inlined directly on the server's service thread.</li>
+ * <li>Relax read consistency for AP namespaces.</li>
+ * <li>Do not add the query to the server's query monitor.</li>
+ * <li>Add the overall latency to the server's latency histogram.</li>
+ * <li>Allow server timeouts. The default server timeout for a short query is 1 second.</li>
+ * </ul>
+ * @property {number} LONG_RELAX_AP - Treat query as a LONG query, but relax read consistency for AP namespaces.
+ * This value is treated exactly like LONG for server versions &lt; 7.1.
+ */
+exports.queryDuration = as.queryDuration
+
 /**
  * A base class extended to client policies.
  *
@@ -443,6 +473,7 @@ function policyClass (type) {
     case 'batchRead': return BatchReadPolicy
     case 'batchRemove': return BatchRemovePolicy
     case 'batchWrite': return BatchWritePolicy
+    case 'batchParentWrite': return BatchPolicy
     case 'batchApply': return BatchApplyPolicy
     case 'commandQueue': return CommandQueuePolicy
     case 'hll': return HLLPolicy

package/lib/status.js

@@ -24,6 +24,37 @@ const as = require('bindings')('aerospike.node')
  * @description Database operation error codes.
  */
 
+/**
+ * One or more keys failed in a batch.
+ * @const {number}
+ */
+exports.BATCH_FAILED = exports.AEROSPIKE_BATCH_FAILED = as.status.AEROSPIKE_BATCH_FAILED
+
+/**
+ * No response received from server.
+ * @const {number}
+ */
+exports.NO_RESPONSE = exports.AEROSPIKE_NO_RESPONSE = as.status.AEROSPIKE_NO_RESPONSE
+
+/**
+ * Max errors limit reached.
+ * @const {number}
+ */
+exports.MAX_ERROR_RATE = exports.AEROSPIKE_MAX_ERROR_RATE = as.status.AEROSPIKE_MAX_ERROR_RATE
+
+/**
+ * Abort split batch retry and use normal node retry instead.
+ * Used internally and should not be returned to user.
+ * @const {number}
+ */
+exports.USE_NORMAL_RETRY = exports.AEROSPIKE_USE_NORMAL_RETRY = as.status.AEROSPIKE_USE_NORMAL_RETRY
+
+/**
+ * Max retries limit reached.
+ * @const {number}
+ */
+exports.ERR_MAX_RETRIES_EXCEEDED = exports.AEROSPIKE_ERR_MAX_RETRIES_EXCEEDED = as.status.AEROSPIKE_ERR_MAX_RETRIES_EXCEEDED
+
 /**
  * Async command delay queue is full.
  * @const {number}

package/lib/typedefs.js

@@ -229,6 +229,8 @@
  *
  * @property {ApplyPolicy} apply - Default apply policy
  * @property {BatchPolicy} batch - Default batch policy
+ * @property {BatchPolicy} batchWrite - Default write policy used in batch operate commands. Contains a {@link BatchWritePolicy}.
+ * @property {BatchPolicy} batchParentWrite - Default parent policy used in batch write commands. Contains a {@link BatchPolicy}.
  * @property {InfoPolicy} info - Default info policy
  * @property {OperatePolicy} operate - Default operate policy
  * @property {ReadPolicy} read - Default read policy

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aerospike",
-  "version": "5.10.0",
+  "version": "5.12.0",
   "description": "Aerospike Client Library",
   "keywords": [
     "aerospike",
@@ -42,6 +42,7 @@
     "install": "npm-run-all removeExtraBinaries build",
     "build": "node-pre-gyp install --fallback-to-build",
     "test": "mocha",
+    "test-dry-run": "mocha --dry-run",
     "test-noserver": "GLOBAL_CLIENT=false mocha -g '#noserver'",
     "lint": "standard",
     "posttest": "npm run lint",
@@ -58,26 +59,25 @@
     "@mapbox/node-pre-gyp": "^1.0.11",
     "bindings": "^1.5.0",
     "minimatch": "^3.1.2",
-    "nan": "^2.17.0",
-    "node-gyp": "^8.4.1",
+    "nan": "^2.19.0",
+    "node-gyp": "^10.1.0",
     "npm-run-all": "^4.1.5"
   },
   "devDependencies": {
-    "@types/node": "^17.0.45",
-    "chai": "^4.3.7",
+    "@types/node": "^20.12.7",
+    "chai": "^4.4.1",
     "choma": "^1.2.1",
     "codecov": "^3.8.3",
     "deep-eql": "^4.1.3",
-    "dirty-chai": "^2.0.1",
-    "husky": "^7.0.4",
-    "mocha": "^9.2.2",
+    "husky": "^9.0.11",
+    "mocha": "^10.4.0",
     "mocha-clean": "^1.0.0",
     "nyc": "^15.1.0",
     "p-throttle": "^3.1.0",
-    "semver": "^7.5.4",
-    "standard": "^16.0.4",
-    "tmp": "^0.1.0",
-    "yargs": "^15.4.1"
+    "semver": "^7.6.0",
+    "standard": "^17.1.0",
+    "tmp": "^0.2.3",
+    "yargs": "^17.7.2"
   },
   "standard": {
     "ignore": [

package/src/include/enums.h

@@ -21,6 +21,7 @@
 #define TTL_NAMESPACE_DEFAULT 0
 #define TTL_NEVER_EXPIRE -1
 #define TTL_DONT_UPDATE -2
+#define TTL_CLIENT_DEFAULT -3
 
 v8::Local<v8::Object> auth_mode_enum_values();
 v8::Local<v8::Object> bitwise_enum_values();
@@ -40,6 +41,7 @@ v8::Local<v8::Object> retry_policy_values();
 v8::Local<v8::Object> status();
 v8::Local<v8::Object> ttl_enum_values();
 v8::Local<v8::Object> batchTypes();
+v8::Local<v8::Object> queryDuration();
 v8::Local<v8::Object> privilegeCode();
 v8::Local<v8::Object> expReadFlags();
 v8::Local<v8::Object> expWriteFlags();

package/src/main/aerospike.cc

@@ -156,6 +156,7 @@ NAN_MODULE_INIT(Aerospike)
 	export("ttl", ttl_enum_values());
 	export("auth", auth_mode_enum_values());
 	export("batchTypes", batchTypes());
+	export("queryDuration", queryDuration());
 	export("privilegeCode", privilegeCode());
 	export("expReadFlags", expReadFlags());
 	export("expWriteFlags", expWriteFlags());

package/src/main/bit_operations.cc

@@ -254,7 +254,7 @@ bool add_bit_rshift_op(as_operations *ops, char *bin, as_bit_policy *policy,
 
 typedef bool (*AsBitMath)(as_operations *ops, const char *bin, as_cdt_ctx *ctx,
 						  as_bit_policy *policy, int bit_offset,
-						  uint32_t bit_size, int64_t value, bool sign,
+						  uint32_t bit_size, uint64_t value, bool sign,
 						  as_bit_overflow_action action);
 
 bool add_bit_math_op(as_operations *ops, AsBitMath math_op, char *bin,