aerospike 4.0.1 → 4.0.2

package/CHANGELOG.md

@@ -11,7 +11,7 @@ All notable changes to this project will be documented in this file.
 ## [4.0.0]
 
 * **New Features**
-  * [CLIENT-1678] - Support boolean particle type. This feature requires Aerospike server version 5.6+. [#428](https://github.com/aerospike/aerospike-client-nodejs/pull/428)
+  * [CLIENT-1678] - Support boolean particle type. This feature requires server 5.6+. [#428](https://github.com/aerospike/aerospike-client-nodejs/pull/428)
   * [CLIENT-1679] - Add support for Aerospike Expressions.
   * [CLIENT-1680] - Added TypeScript typings. [#446](https://github.com/aerospike/aerospike-client-nodejs/pull/446) Thanks to [@bit0r1n](https://github.com/bit0r1n)!
 
@@ -82,7 +82,7 @@ All notable changes to this project will be documented in this file.
 ## [3.16.1] - 2020-06-30
 
 * **Bug Fixes**
-  * Fix memory leaks when running secondary index queries with string filter predicates. [#370](https://github.com/aerospike/aerospike-client-nodejs/issues/370)
+  * Fix memory leaks when running secondary index (SI) queries with string filter predicates. [#370](https://github.com/aerospike/aerospike-client-nodejs/issues/370)
 
 ## [3.16.0] - 2020-05-18
 
@@ -337,7 +337,7 @@ All notable changes to this project will be documented in this file.
 * **New Features**
   * Support for Promises in addition to Callback functions [PR #210](https://github.com/aerospike/aerospike-client-nodejs/pull/210)
   * Support nobins flag on query operations
-  * Support CDT List Increment operation. Requires Aerospike server version 3.15 or later.
+  * Support CDT List Increment operation. Requires server 3.15 or later.
   * Improved timeout handling and automatic transaction retries - see [detailed API changes](https://www.aerospike.com/docs/client/nodejs/usage/incompatible.html#version-3-0-0) for more info.
   * Support gen policy for apply UDF operation.
 
@@ -519,7 +519,7 @@ v2.5.x is the last release to support Node.js v0.12 and io.js. The next major cl
 ## [2.1.0] - 2016-06-03
 
 * **New Features**
-  * Support for operations on Sorted Maps. Requires Aerospike server version 3.8.4 or later.
+  * Support for operations on Sorted Maps. Requires server 3.8.4 or later.
 
 * **Improvements**
   * Key objects returned in callbacks now include the digest
@@ -614,7 +614,7 @@ v2.5.x is the last release to support Node.js v0.12 and io.js. The next major cl
 
 * **Improvements**
   * Added support for creating secondary indexes on list and map values;
-    requires Aerospike server version >= 3.8. [CLIENT-684]
+    requires server >= 3.8. [CLIENT-684]
   * Added `Aerospike.info` module with `parseInfo` utility method to parse info
     string returned by Aerospike cluster nodes using `Client#info` method.
   * Added IndexTask class returned by `Client#createIndex` to replace

package/examples/sindex.js

@@ -55,12 +55,12 @@ async function sindexRemove (client, argv) {
 }
 
 exports.command = 'sindex <command>'
-exports.describe = 'Manage secondary indexes'
+exports.describe = 'Manage secondary indexes (SI)'
 exports.builder = yargs => {
   return yargs
     .command({
       command: 'create <bin> <index> <type>',
-      desc: 'Create a secondary index',
+      desc: 'Create a SI',
       handler: shared.run(sindexCreate),
       builder: {
         type: {
@@ -71,7 +71,7 @@ exports.builder = yargs => {
     })
     .command({
       command: 'remove <index>',
-      desc: 'Remove a secondary index',
+      desc: 'Remove a SI',
       handler: shared.run(sindexRemove)
     })
 }

package/lib/aerospike.js

@@ -35,7 +35,7 @@ const utils = require('./utils')
 
 /**
  * The {@link module:aerospike/filter|filter} module provides functions to
- * create secondary index filter predicates for use in query operations via the
+ * create secondary index (SI) filter predicates for use in query operations via the
  * {@link Client#query} command.
  *
  * @summary {@link module:aerospike/filter|aerospike/filter} module
@@ -371,7 +371,7 @@ exports.log = as.log
  * namespace of the record.
  * @property {number} NEVER_EXIRE - Never expire the record.
  * @property {number} DONT_UPDATE - Update the record without changing the
- * record's TTL value. Requires Aerospike Server version 3.10.1 or later.
+ * record's TTL value. Requires server 3.10.1 or later.
  *
  * @example <caption>Use ttl.DONT_UPDATE to change the value of a record
  * bin without changing the records expiry time</caption>
@@ -422,34 +422,34 @@ exports.ttl = as.ttl
 exports.jobStatus = as.jobStatus
 
 /**
- * @summary Enumeration of secondary index data types.
+ * @summary Enumeration of SI data types.
  *
  * @readonly
  * @enum {number}
  *
- * @property {number} STRING - Values contained in the secondary index are strings.
- * @property {number} NUMERIC - Values contained in the secondary index are integers.
- * @property {number} GEO2DSPHERE - Values contained in the secondary index are GeoJSON values (points or polygons).
+ * @property {number} STRING - Values contained in the SI are strings.
+ * @property {number} NUMERIC - Values contained in the SI are integers.
+ * @property {number} GEO2DSPHERE - Values contained in the SI are GeoJSON values (points or polygons).
  *
  * @see {@link Client#createIndex}
  */
 exports.indexDataType = as.indexDataType
 
 /**
- * @summary Enumeration of secondary index types.
+ * @summary Enumeration of SI types.
  *
  * @readonly
  * @enum {number}
  *
- * @property {number} DEFAULT - Default secondary index type for bins
+ * @property {number} DEFAULT - Default SI type for bins
  * containing scalar values (i.e. integer, string).
- * @property {number} LIST - Secondary index for bins containing
+ * @property {number} LIST - SI for bins containing
  * <a href="http://www.aerospike.com/docs/guide/cdt-list.html" title="Aerospike List Data Type">&uArr;Lists</a>;
  * the index will be build over the individual entries of the list.
- * @property {number} MAPKEYS - Secondary index for bins containing
+ * @property {number} MAPKEYS - SI for bins containing
  * <a href="http://www.aerospike.com/docs/guide/cdt-map.html" title="Aerospike Maps Data Type">&uArr;Maps</a>;
  * the index will be build over the individual keys of the map entries.
- * @property {number} MAPVALUES - Secondary index for bins containing
+ * @property {number} MAPVALUES - SI for bins containing
  * <a href="http://www.aerospike.com/docs/guide/cdt-map.html" title="Aerospike Maps Data Type">&uArr;Maps</a>;
  * the index will be build over the individual values of the map entries.
  *

package/lib/client.js

@@ -344,7 +344,7 @@ Client.prototype.batchGet = function (keys, policy, callback) {
  * @description
  *
  * This method allows different namespaces/bins to be requested for each key in
- * the batch. This method requires Aerospike Server version >= 3.6.0.
+ * the batch. This method requires server >= 3.6.0.
  *
  * @param {object[]} records - List of keys and bins to retrieve.
  * @param {Key} records[].key - Key to retrieve.
@@ -546,7 +546,7 @@ Client.prototype.connect = function (callback) {
 /**
  * @function Client#createIndex
  *
- * @summary Creates a secondary index.
+ * @summary Creates a secondary index (SI).
  *
  * @description
  *
@@ -634,7 +634,7 @@ Client.prototype.connect = function (callback) {
  *     var pollInterval = 100
  *     job.waitUntilDone(pollInterval, (error) => {
  *       if (error) throw error
- *       console.info('secondary index %s on %s was created successfully', indexName, binName)
+ *       console.info('SI %s on %s was created successfully', indexName, binName)
  *       client.close()
  *     })
  *   })
@@ -664,7 +664,7 @@ Client.prototype.createIndex = function (options, policy, callback) {
 /**
  * @function Client#createIntegerIndex
  *
- * @summary Creates a secondary index of type Integer.
+ * @summary Creates a SI of type Integer.
  *
  * @description This is a short-hand for calling {@link Client#createIndex}
  * with the <code>datatype</code> option set to <code>Aerospike.indexDataType.NUMERIC</code>.
@@ -701,7 +701,7 @@ Client.prototype.createIndex = function (options, policy, callback) {
  *
  *   client.createIntegerIndex(options, function (error) {
  *     if (error) throw error
- *     console.info('secondary index %s on %s was created successfully', indexName, binName)
+ *     console.info('SI %s on %s was created successfully', indexName, binName)
  *     client.close()
  *   })
  * })
@@ -714,7 +714,7 @@ Client.prototype.createIntegerIndex = function (options, policy, callback) {
 /**
  * @function Client#createStringIndex
  *
- * @summary Creates a secondary index of type String.
+ * @summary Creates a SI of type String.
  *
  * @description This is a short-hand for calling {@link Client#createIndex}
  * with the <code>datatype</code> option set to <code>Aerospike.indexDataType.STRING</code>.
@@ -751,7 +751,7 @@ Client.prototype.createIntegerIndex = function (options, policy, callback) {
  *
  *   client.createStringIndex(options, function (error) {
  *     if (error) throw error
- *     console.info('secondary index %s on %s was created successfully', indexName, binName)
+ *     console.info('SI %s on %s was created successfully', indexName, binName)
  *     client.close()
  *   })
  * })
@@ -801,7 +801,7 @@ Client.prototype.createStringIndex = function (options, policy, callback) {
  *
  *   client.createGeo2DSphereIndex(options, function (error) {
  *     if (error) throw error
- *     console.info('secondary index %s on %s was created successfully', indexName, binName)
+ *     console.info('SI %s on %s was created successfully', indexName, binName)
  *     client.close()
  *   })
  * })
@@ -1503,7 +1503,7 @@ Client.prototype.select = function (key, bins, policy, callback) {
  * @summary Removes records in specified namespace/set efficiently.
  *
  * @description This method is many orders of magnitude faster than deleting
- * records one at a time. It requires Aerospike Server version 3.12 or later.
+ * records one at a time. It requires server 3.12 or later.
  *
  * @param {string} ns - Required namespace.
  * @param {string} set - Optional set name. Set to <code>null</code> to delete

package/lib/exp.js

@@ -30,17 +30,17 @@ const BIN_TYPE_UNDEF = 0
  * @module aerospike/exp
  * @summary {@link module:aerospike/exp|aerospike/exp} module
  *
- * @description This module defines a filter expression that provide
+ * @description This module defines a filter expression that is
  * a mechanism for additional filtering.
- * The resultset of a secondary index query or primary index
+ * The resultset of a secondary index (SI) query or primary index (PI)
  * query (scan) operation can be filtered through the QueryPolicy
  * and ScanPolicy classes.
- * It can also be used to filter single key operations and
+ * It can also filter single key operations and
  * batch operations through the filterExpression field of their policy class.
  *
  * Filter Expressions replace PredicateExpression filtering,
- * which was deprecated in Aerospike Server version 5.2 and
- * removed in Aerospike Server version 6.0.
+ * which was deprecated in server 5.2 and
+ * removed in server 6.0.
  *
  * @see {@link ReadPolicy#filterExpression}
  * @see {@link OperatePolicy#filterExpression}

package/lib/filter.js

@@ -22,7 +22,7 @@ const GeoJSON = require('./geojson')
 /**
  * @module aerospike/filter
  *
- * @description This module provides functions to create secondary index filter
+ * @description This module provides functions to create secondary index (SI) filter
  * predicates for use in query operations via the {@link Client#query} command.
  *
  * @see {@link Query}
@@ -47,7 +47,7 @@ const GeoJSON = require('./geojson')
 
 /**
  * @class module:aerospike/filter~SindexFilterPredicate
- * @classdesc Secondary index filter predicate to limit the scope of a {@link Query}.
+ * @classdesc SI filter predicate to limit the scope of a {@link Query}.
  *
  * Filter predicates must be instantiated using the methods in the {@link
  * module:aerospike/filter} module.
@@ -124,7 +124,7 @@ function dataTypeOf (value) {
  * @param {number} max - Upper end of the range (inclusive).
  * @param {number} [indexType=Aerospike.indexType.DEFAULT] - One of {@link
  * module:aerospike.indexType}, i.e. LIST or MAPVALUES.
- * @returns {module:aerospike/filter~SindexFilterPredicate} Secondary index
+ * @returns {module:aerospike/filter~SindexFilterPredicate} SI
  * filter predicate, that can be applied to queries using {@link Query#where}.
  */
 exports.range = function (bin, min, max, indexType) {
@@ -139,7 +139,7 @@ exports.range = function (bin, min, max, indexType) {
  *
  * @param {string} bin - The name of the bin.
  * @param {string} value - The filter value.
- * @returns {module:aerospike/filter~SindexFilterPredicate} Secondary index
+ * @returns {module:aerospike/filter~SindexFilterPredicate} SI
  * filter predicate, that can be applied to queries using {@link Query#where}.
  */
 exports.equal = function (bin, value) {
@@ -157,7 +157,7 @@ exports.equal = function (bin, value) {
  * list or map in the bin.
  * @param {number} indexType - One of {@link module:aerospike.indexType},
  * i.e. LIST, MAPVALUES or MAPKEYS.
- * @returns {module:aerospike/filter~SindexFilterPredicate} Secondary index
+ * @returns {module:aerospike/filter~SindexFilterPredicate} SI
  * filter predicate, that can be applied to queries using {@link Query#where}.
  *
  * @since v2.0
@@ -178,7 +178,7 @@ exports.contains = function (bin, value, indexType) {
  * @param {GeoJSON} value - GeoJSON region value.
  * @param {number} [indexType=Aerospike.indexType.DEFAULT] - One of {@link
  * module:aerospike.indexType}, i.e. LIST or MAPVALUES.
- * @returns {module:aerospike/filter~SindexFilterPredicate} Secondary index
+ * @returns {module:aerospike/filter~SindexFilterPredicate} SI
  * filter predicate, that can be applied to queries using {@link Query#where}.
  *
  * @since v2.0
@@ -196,14 +196,14 @@ exports.geoWithinGeoJSONRegion = function (bin, value, indexType) {
  * @summary Geospatial filter that matches regions that contain a given GeoJSON
  * point.
  * @description Depending on the index type, the filter will match GeoJSON
- * regions within list or map values as well (requires Aerospike server version
+ * regions within list or map values as well (requires server
  * >= 3.8).
  *
  * @param {string} bin - The name of the bin.
  * @param {GeoJSON} value - GeoJSON point value.
  * @param {number} [indexType=Aerospike.indexType.DEFAULT] - One of {@link
  * module:aerospike.indexType}, i.e. LIST or MAPVALUES.
- * @returns {module:aerospike/filter~SindexFilterPredicate} Secondary index
+ * @returns {module:aerospike/filter~SindexFilterPredicate} SI
  * filter predicate, that can be applied to queries using {@link Query#where}.
  *
  * @since v2.0
@@ -230,7 +230,7 @@ exports.geoContainsGeoJSONPoint = function (bin, value, indexType) {
  * @param {number} radius - Radius in meters.
  * @param {number} [indexType=Aerospike.indexType.DEFAULT] - One of {@link
  * module:aerospike.indexType}, i.e. LIST or MAPVALUES.
- * @returns {module:aerospike/filter~SindexFilterPredicate} Secondary index
+ * @returns {module:aerospike/filter~SindexFilterPredicate} SI
  * filter predicate, that can be applied to queries using {@link Query#where}.
  *
  * @since v2.0
@@ -244,7 +244,7 @@ exports.geoWithinRadius = function (bin, lon, lat, radius, indexType) {
  * @summary Geospatial filter that matches regions that contain a given lng/lat
  * coordinate.
  * @description Depending on the index type, the filter will match GeoJSON
- * regions within list or map values as well (requires Aerospike server version
+ * regions within list or map values as well (requires server
  * >= 3.8).
  *
  * @param {string} bin - The name of the bin.
@@ -252,7 +252,7 @@ exports.geoWithinRadius = function (bin, lon, lat, radius, indexType) {
  * @param {number} lat - Latitude of the point.
  * @param {number} [indexType=Aerospike.indexType.DEFAULT] - One of {@link
  * module:aerospike.indexType}, i.e. LIST or MAPVALUES.
- * @returns {module:aerospike/filter~SindexFilterPredicate} Secondary index
+ * @returns {module:aerospike/filter~SindexFilterPredicate} SI
  * filter predicate, that can be applied to queries using {@link Query#where}.
  *
  * @since v2.0

package/lib/index_job.js

@@ -48,7 +48,7 @@ const util = require('util')
  *     client.createIndex(options)
  *     .then(job => job.wait())
  *     .then(() => {
- *       console.info('Secondary index %s on %s was created successfully', indexName, binName)
+ *       console.info('secondary index (SI) %s on %s was created successfully', indexName, binName)
  *       client.close()
  *     })
  *     .catch(error => {
@@ -77,7 +77,7 @@ IndexJob.prototype.hasCompleted = function (sindexInfo) {
 }
 
 /**
- * Fetches info for the secondary index from each cluster node.
+ * Fetches info for the SI from each cluster node.
  *
  * @private
  */
@@ -99,7 +99,7 @@ IndexJob.prototype.info = function () {
 /**
  * @function IndexJob#wait
  *
- * @summary Wait until the job of creating a secondary index has completed.
+ * @summary Wait until the job of creating a SI has completed.
  *
  * @param {number} [pollInterval=1000] - Interval in milliseconds to use when polling the cluster nodes.
  * @param {doneCallback} [callback] - The function to call when the operation completes.

package/lib/policies/query_policy.js

@@ -51,6 +51,31 @@ class QueryPolicy extends BasePolicy {
      * @since v3.7.0
      */
     this.deserialize = props.deserialize
+
+    /**
+     * Terminate the query if the cluster is in migration state. If the query's
+     * "where" clause is not defined (scan), this field is ignored.
+     *
+     * Requires Aerospike Server version 4.2.0.2 or later.
+     *
+     * @type boolean
+     * @default <code>false</code>
+     * @since v3.4.0
+     */
+    this.failOnClusterChange = props.failOnClusterChange
+
+    /**
+     * Timeout in milliseconds used when the client sends info commands to
+     * check for cluster changes before and after the query. This timeout is
+     * only used when {@link
+     * QueryPolicy#failOnClusterChange|failOnClusterChange} is true and the
+     * query's "where" clause is defined.
+     *
+     * @type number
+     * @default 10000 ms
+     * @since v3.16.5
+     */
+    this.infoTimeout = props.infoTimeout
   }
 }
 

package/lib/policies/scan_policy.js

@@ -57,7 +57,7 @@ class ScanPolicy extends BasePolicy {
      * Limit returned records per second (RPS) rate for each server. Do not
      * apply RPS limit if <code>recordsPerSecond</code> is zero.
      *
-     * Requires Aerospike Server version >= 4.7.
+     * Requires server >= 4.7.
      *
      * @type number
      * @default 0
@@ -72,7 +72,7 @@ class ScanPolicy extends BasePolicy {
      * of records returned may be less than maxRecords if node record counts
      * are small and unbalanced across nodes.
      *
-     * Requires Aerospike Server version >= 4.9.
+     * Requires server >= 4.9.
      *
      * @type number
      * @default 0 (do not limit record count)