aerospike on npm

3.9.0 (20 Feb 2019 14:02)

Aerospike Client Library


CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

[Unreleased]

[3.9.0] - 2019-02-20

  • Updates
    • Update C client library to v4.5.0.
    • Update nan to v2.12.1.
    • Update nyc to v13.3 to address multiple potential vulnerabilities in nyc dependencies.
    • Update docs for udfRemove function to document changes in server behavior when trying to delete a UDF module that does not exist.
    • Drop Node.js v4 from the test matrix. The client still runs on Node.js v4 for now, but not all of its dev dependencies do.

[3.8.0] - 2018-12-14

  • New Features

    • Add support for rack-aware clients.
    • Add client run-time stats.
  • Updates

    • Update C client library to v4.4.0.
    • Remove unused error codes.
    • Improve global command queue docs.
    • Shared memory layout has changed. The default Config#sharedMemory.key has changed to 0xA8000000 so old client applications do not mix shared memory with new client applications. If you are using shared memory clients with a custom shared memory key, it's critical that you change the key when upgrading to this version.

[3.7.2] - 2018-11-09

  • Bug Fixes

    • Fix Alpine Linux builds #286
    • Fix policies constructor to support setting totalTimeout to zero #289
    • Fix segfault in predexp unit tests on Node.js 11
  • Updates

    • Update C client library to v4.3.20.
    • Replace V8 conversion functions deprecated in Node.js 10.12/11
    • Suppress compiler deprecation warnings for Release builds
    • Add Node.js 10 back to Travis CI test matrix

[3.7.1] - 2018-10-03

  • Bug Fixes

    • Support using alternate-access-address. #267 #283
  • Updates

    • Fix some tests breaking when auth enabled. #284

[3.7.0] - 2018-10-02

  • New Features

    • Support "deserialize" policy setting. #278
    • Add getter for client instance to AerospikeError.
  • Bug Fixes

    • Fix memory leaks detected by Valgrind. #279
    • Increase max. info request length from 50 to 256. #280
    • Fix parsing of sets/ns/set info response. #282
  • Updates

    • Update C client library to v4.3.18.
    • Update nan and chai to latest versions.

[3.6.1] - 2018-09-04

  • Updates
    • Change max. bin name length to 15 (was 14). Requires server version 4.2 or later.
    • Update C client library to v4.3.17. #273

[3.6.0] - 2018-08-28

  • New Features

    • Support query filtering with predicate expressions. Requires server version v3.12 or later. #269
    • Add missing replica.sequence policy value #270
  • Updates

    • Update C client library to v4.3.16 #271
    • Remove modlua.systemPath config entry
    • Remove lua-core submodule; system lua code is now loaded directly from C strings instead of files

[3.5.0] - 2018-07-19

  • New Features

    • Support list/map nearest key/value get/remove operations (relative rank range). Requires server version v4.3.0 or later. #264
    • Support list write flags NO_FAIL and PARTIAL. Add new map write flags, including NO_FAIL and PARTIAL. Requires server version v4.3.0 or later. #265
    • Rewrote examples to use latest client APIs, ES2017 async functions, and reduce yargs boilerplate code #266
  • Updates

[3.4.1] - 2018-06-25

  • Bug Fixes
    • Fix Set Order/Sort List operations broken on some platforms #261

[3.4.0] - 2018-06-20

  • New Features

    • Add CDT List operations for Ordered Lists #250
    • Support scan/query consistency validation using cluster key. Set failOnClusterChange to true in ScanPolicy/QueryPolicy to enable this validation. (Requires Aerospike Server v4.2 or later.) #260
  • Updates

    • Update C client library to v4.3.13 #260
    • Change default log level from INFO to WARN; rename log level DETAIL to TRACE
    • Add support for Ubuntu 18.04
    • Remove support for Ubuntu 12.04

[3.3.0] - 2018-04-30

  • Bug Fixes

    • Command queue tests fail if cluster address is specified using host/port cli options #247
    • Query fails if one or more cluster nodes do not have records in the set #253
    • TypeError: domain.enter is not a function using Node.js 9.6 or later in interactive mode #254
  • New Features

    • Support authentication mode (Config#authMode). When user authentication is enabled, the mode specifies internal server authentication or external (e.g. LDAP) authentication.
    • Support separate login timeout (Config#loginTimeoutMs) when authentication is enabled.
    • Support for Async Hooks in Node.js 9/10 #255
  • Updates

    • Tests: Upgrade to Mocha v5, Choma v1.2 & replace expect.js with Chai
    • Update C client library to v4.3.11.

[3.2.0] - 2018-02-08

  • Bug Fixes

    • Avoid buffer overflows when copying bin/set/ns names. #241
    • Fix possible race condition in indexRemove test cases. #240
  • New Features

    • Support building package on Windows (64bit, Windows 7 or later) #239
    • Add new, optional command queue. If configurable limit of in-process commands is exceeded, additional commands are queued for later execution. #245
    • Added new inDoubt flag to AerospikeError. The inDoubt flag indicates if a write command may have completed even though an error was returned. This scenario can occur on a client timeout for a command that has been sent to the server. #242
    • Added a command reference to AerospikeError for the database command, during which the error occurred. The Command object may contain additional information such as the record key for single-record-key read/write commands. #242
  • Updates

    • Update C client library to v4.3.5.

[3.1.1] - 2018-01-09

  • Bug Fixes

    • Support all data types for write operation in Client#operate #235
    • Only setup cluster events callback on Client#connect #237
  • Updates

    • Update C client library to v4.3.2.

[3.1.0] - 2017-12-18

  • New Features

    • Logging improvements: C client logs enabled by default; log level can be controlled through new, global log settings. PR #231
    • Support "exists" policy for operate command. PR #233
    • Support "linearize read" policy for Strong Consistency mode. (Requires Aerospike server v4.0.)
  • Updates

    • Add support for Node.js v9.x
    • Update C client library to v4.3.1. PR #232
    • Update to C client's new package format.
    • Add support for Debian 9 ("Stretch")

[3.0.2] - 2017-10-09

  • Bug Fixes
    • Release event loop on #close even if client not connected #225

[3.0.1] - 2017-10-06

  • Bug Fixes
    • Fixed typo: Aerospike.ttl.DONT_UPDDATE #222
    • Return parameter error if ttl or gen meta-data values are invalid #223
    • Call Client#connect callback asynchronously #224

[3.0.0] - 2017-10-03

  • New Features

    • Support for Promises in addition to Callback functions PR #210
    • Support nobins flag on query operations
    • Support CDT List Increment operation. Requires Aerospike server version 3.15 or later.
    • Improved timeout handling and automatic transaction retries - see detailed API changes for more info.
    • Support gen policy for apply UDF operation.
  • Bug Fixes

    • Fix memory leak in batchRead #213
  • Updates

    • Requires Node.js v4.x (LTS) or later; Node.js v0.12.x and io.js are no longer supported PR #179
    • Update C client library to v4.2.0.
    • Changes to callback function signatures for several client operations. PR #210
    • Removal of several client functions, that were marked as deprecated under v2.x. PR #214
    • Policy rewrite and changes to how default client policies are configured. PR #221
    • Changes to shared memory layout and default shared memory key.

Please refer to the full list of backward incompatible API changes for further details.

[2.7.2] - 2017-08-03

  • Bug Fixes
    • Close cluster event callback handle when client is closed #211

[2.7.1] - 2017-07-24

  • New Features
    • Add socket timeout setting to query policy #207

[2.7.0] - 2017-07-17

  • New Features

    • Client emits cluster state changed events #206
  • Updates

    • Update C client library to v4.1.8.
    • Update packaging to include system Lua scripts in npm package #202

[2.6.0] - 2017-05-25

  • New Features

    • Expose new consistency level in batch policy [#197](https://github.com/aerospike/aerospike-client-nodejs/pull/197
    • Add interface to dynamically add/remove seed hosts #194
    • New UDF register/unregister job to async wait for job completion #198
    • Improved Info.parse() function, replacing Info.parseInfo()
  • Updates

    • Update C client library to v4.1.6.
    • The Client#udfRegisterWait and Info#parseInfo functions have been marked deprecated. See API Changes for details.

[2.5.2] - 2017-04-20

v2.5.x is the last release to support Node.js v0.12 and io.js. The next major client release will require Node.js v4 or later.

  • New Features

    • Capture more useful stacktraces for debugging #189
  • Bug Fixes

    • Synchronous error callback in query command causes "unspecified" error in record stream #146
    • Query/scan record stream should emit AerospikeError instances #187

[2.5.1] - 2017-04-11

  • Bug Fixes
    • Support queries with keys with just namespace + digest #184

[2.5.0] - 2017-04-05

  • New Features

    • Support ns/set truncate command #712
    • Support configurable scan socket write timeout #174
  • Bug Fixes

    • Possible memory leak during batchRead - fix included in Aerospike C client v4.1.5 #167
    • Query/scan policy not getting applied on some operations #175
  • Updates

    • Update C client library to v4.1.5.
    • Update npm install script to support additional Linux distros #166, #170
    • Update to JavaScript Standard Style v9 #178
    • Add WebWorker based test case to scan stress test #180

[2.4.4] - 2016-12-19

  • Bug Fixes

    • Fix TTL value returned from server for records that never expire. #156
    • Add type checks for record keys and raise error when float keys are used. #158
  • Updates

    • Remove non-functional TLS support for now. #160
  • Documentation

    • Mark LargeList functionality as deprectated. #159

[2.4.3] - 2016-11-11

  • Bug Fixes
    • Fix installation on macOS. #155 Thanks to @arch1t3ct!
    • Fix installation on platforms without which command.
    • Explicity link zlib to fix usage on Alpine Linux. #117 Thanks to @rma4ok!

[2.4.2] - 2016-11-10

  • New Features

    • Added constant enums Aerospike.ttl for "special" TTL values, incl. DONT_UPDATE value supported by Aerospike Server v3.10.1 and later.
  • Bug Fixes

    • Security Fix: Download C client using HTTPS and verify package checksum. #153 Thanks to Adam Baldwin of @liftsecurity for the report!
    • Support for Ubuntu 16.10/17.04 in the C client download script. #154 Thanks to @kitex!

[2.4.1] - 2016-10-10

  • Bug Fixes

  • Changes

    • Renamed Cluster ID to Cluster Name; Cluster Name verification requires Aerospike Server v3.10 or later.
  • Updates

    • Update C client library to v4.1.1.

[2.4.0] - 2016-09-09

  • New Features

    • Support for durable delete write policy [CLIENT-769]; requires Aerospike Server Enterprise Edition v3.10 or later.
    • Support IPv6 socket protocol; requires Aerospike Server v3.10 or later.
    • Support Cluster ID verification; requires Aerospike Server v3.10 or later.
    • Support new peers info protocol; requires Aerospike Server v3.10 or later.
    • ~~Support TLS 1.2 secure socket protocol; requires future Aerospike Server release.~~
    • New Client#infoAny command to send info request to single cluster node.
  • Improvements

    • Add support for two new server error codes (23 & 24) introduced in Aerospike Server v3.9.1.
    • Regression: Skip LDT and CDT Map tests if server does not support the feature [CLIENT-753]
  • Updates

    • Update C client library to v4.1.0.
    • Shared memory layout has changed in v4.1.0 of the C client library. See backward incompatible API changes for more details.
    • The retry policy value for read, write, remove and operate policies has been deprecated as it does not actually affect single key read/write commands, the batch read command or query/scan commands in client versions v2.x.

[2.3.1] - 2016-08-11

  • Bug Fixes
    • Fix installation on Amazon Linux. #143

[2.3.0] - 2016-08-11

  • New Features

    • Add Client#infoAll method to simplify processing info responses from multiple hosts. #43
  • Bug Fixes

    • Add work-around for issues running client with Node's interactive debugger. #140
    • Support writing null values to delete bin using Client#operate. #142
  • Improvements

    • Improved C-client resolution to avoid issues fetching C client artifact during npm package installation
  • Changes

    • Update C client library to v4.0.7.
    • Drop support for Debian 6

[2.2.0] - 2016-07-13

  • New Features
    • Added back support for applying stream UDF to query results w/o aggregation.
    • Added maxConnsPerNode config setting to address #130.

[2.1.1] - 2016-06-29

  • Bug Fixes
    • Prevent segfault processing query/scan record stream if client object goes out of scope. [CLIENT-735]
    • Update C client to v4.0.6 with fix to complete scan on empty sets. #132

[2.1.0] - 2016-06-03

  • New Features

    • Support for operations on Sorted Maps. Requires Aerospike server version 3.8.4 or later.
  • Improvements

    • Key objects returned in callbacks now include the digest
    • Code cleanup to support standard@7.0.0 which adds several new rules
  • Fixes

    • Fix compile time error with Node 0.12 using gcc 4.4. #131
  • Changes

    • The aerospike.operator module has been split up into two seperate modules aerospike.operations and aerospike.lists for operations on scalar and list data types respectively. See detailed list of API changes for further details.
  • Documentation

    • Pulled client configuration out into a separate class and expanded the documentation.
    • Documented sharedMemory configuration.
    • Added tutorial for using Aerospike client in Node.js cluster setup.

[2.0.4] - 2016-05-09

[2.0.3] - 2016-05-03

  • Fixes
    • Event loop does not get released if module gets required but never used to open & close client connection. #124

[2.0.2] - 2016-04-29

[2.0.1] - 2016-04-27

  • Improvements

    • Optimize callback handler performance. #119
    • Removed some unused async C++ helper functions; minor code cleanup
  • Fixes

    • Ensure callbacks are always called asynchronously, even for param errors raised by the client itself. #120
  • Tests

    • Complete tests for writing bins with specific data types
    • Extend query/scan performance tests
  • Documentation

    • Minor JSDoc documentation fixes

[2.0.0] - 2016-04-19

  • Documentation
    • Added overview page for API docs
    • Added "Getting Started" tutorial to API docs
    • Updated documentation for aerospike module

[2.0.0-alpha.3] - 2016-04-18

  • Improvements

    • Added new filter predicates in the Aerospike.filter module:
      • contains() to match on list/map membership for integer & string values
      • geoWithinRadius() to match on geospatial locations within a given radius from another point (incl. geospatial locations in lists and maps)
      • geoContainsPoint() to match on geospatial regions that include given lng/lat coordinates (incl. geospatial regions in lists and maps)
      • geoContains() is deprecated and has been replaced by geoContainsGeoJSONPoint()
      • geoWithin() is deprecated and has been replaced by geoWithinGeoJSONRegion()
    • New async. implementation for Query#foreach (renamed from Query#execute).
    • Added support for background queries with Record UDF via Query#background.
    • Support aborting background queries via RecordStream#abort.
    • Consolidated ScanTask, IndexTask into new Job class with support for querying background queries as well.
    • Combined Scan#applyEach and Scan#background to reduce chance of mis-use. (Record UDF can only be applied on background scan.)
  • Fixes

    • Fix possible memory corruption parsing UDF module or function names.

[2.0.0-alpha.2] - 2016-04-12

  • Improvements
    • Added support for creating secondary indexes on list and map values; requires Aerospike server version >= 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 Client#createIndexWait; IndexTask#waitUntilDone polls for task completion asynchronously.
    • Added new Scan API implementation via Client#scan.

[2.0.0-alpha.1] - 2016-03-30

  • Improvements

    • Use asynchronous client commands of the new Aerospike C/C++ client library version 4.0.
    • Follow Node.js error-first callback conventions: The client now returns null as the first parameter (error) in most callbacks when the command was executed successfully. See backward incompatible API changes for more details. #105, PR #106. Thanks to @eljefedelrodeodeljefe!
    • Add support for pluggable callback handler logic for backwards compatibility with legacy error callback semantics.
    • The Key, Double and GeoJSON functions can be used as Constructors now to create instances of the respective data types, e.g. var key = new Key(ns, set, 'mykey1'). Use of the Double and GeoJSON functions as well as the key function as regular functions without the new keyword is deprecated but still supported for backwards compatibility.
    • The new batchRead command was added to support reading different namespaces/bins for each key in a batch. This method requires Aerospike server version >= 3.6.0. The batchGet/batchExists/batchSelect client commands deprecated but still supported for backwards compatibility.
    • Added isConnected client method to check cluster connection status.
    • Improvements to the client's mocha test suite, incl. performance improvements by re-using a single client connection for all tests.
    • Add missing status codes to Aerospike.status.
    • Added support for set compression threshold policy for write operations, retry policy for read operations, and ttl policy for apply operations.
  • Fixes

    • Node segfault when trying to query the aerospike client after closing the connection. #88
  • Changes

    • Drop support for Node.js v0.10. The Aerospike Node.js client now requires Node.js v0.12 or later.
    • The add client command was renamed to incr; the add function is maintained as an alias for the new incr function for backwards compatibility but is deprecated.
    • The execute client command was renamed to apply; the execute function is maintained as an alias for the new apply function for backwards compatibility but is deprecated.
  • Documentation

    • JSDoc-style annotations have been added throughout the library code and new API documentation is generated from the source code using JSDoc v3. This is work-in-progress and will be completed before v2.0.0-final is released.

[1.0.57] - 2016-03-18

  • Improvements

    • Update build script to support Fedora 23 as well as Korora 22/23. #113, #115
    • Update Aerospike C client library to v4.0.3.
    • Optionally read hosts config from AEROSPIKE_HOSTS environment variable. Thanks to @mrbar42!
    • Collect TPS stats in benchmarks.
    • Update Travis CI config to test latest Node.js release & add badge. Thanks to @revington!
  • Fixes

    • Fix replica policy value overwriting gen policy [CLIENT-699]
    • Fix lists being returned as bytes in listGetRange/listPopRange operations (via C client library v4.0.3).

[1.0.56] - 2016-02-11

  • Improvements

    • Support operator.incr() operation on double values.
    • Refactor test suite to improve performance and maintainability.
  • Fixes

    • Fix segfault when client.connect() is called without callback function.
  • Documentation

    • Fix wrong method name in llist documentation. Thanks to @srinivasiyer!
    • Update build dependencies for CentOS/RHEL 6.
    • Clarify supported data types and (lack of) automatic data type conversions.
    • Update supported Node.js versions.

[1.0.55] - 2016-01-15

  • Improvements

    • Update to C Client v4.0.0.
    • Documentation updates. Thanks to @mrbar42!
    • Avoid polluting global namespace. Thanks to @mrbar42!
    • Use standard module to enforce coding style.
    • Add connTimeoutMs and tenderInterval client configs.
  • Fixes

    • Fix connection issues when using V8 profiler (node --prof)

Version History

Version Date
3.9.0 20 Feb 2019 14:02
3.8.0 14 Dec 2018 19:12
3.7.2 09 Nov 2018 04:11
3.7.1 03 Oct 2018 10:10
3.7.0 02 Oct 2018 04:10
3.6.1 04 Sep 2018 07:09
3.6.0 28 Aug 2018 07:08
3.5.0 19 Jul 2018 08:07
3.4.0 20 Jun 2018 10:06
3.3.0 30 Apr 2018 07:04
3.2.0 08 Feb 2018 10:02
3.1.1 09 Jan 2018 03:01
3.1.0 18 Dec 2017 10:12
3.0.2 09 Oct 2017 08:10
3.0.1 06 Oct 2017 11:10
3.0.0 03 Oct 2017 03:10
2.7.2 03 Aug 2017 09:08
2.7.1 24 Jul 2017 02:07
2.7.0 17 Jul 2017 06:07
2.6.0 25 May 2017 02:05
2.5.2 20 Apr 2017 10:04
2.5.1 10 Apr 2017 23:04
2.5.0 05 Apr 2017 10:04
2.4.4 19 Dec 2016 09:12
2.4.3 11 Nov 2016 04:11
2.4.2 10 Nov 2016 09:11
1.0.58 17 Oct 2016 06:10
2.4.1 10 Oct 2016 09:10
2.4.0 13 Sep 2016 01:09
2.3.1 11 Aug 2016 09:08
2.3.0 11 Aug 2016 04:08
2.2.0 13 Jul 2016 10:07
2.1.1 29 Jun 2016 03:06
2.1.0 03 Jun 2016 16:06
2.0.4 09 May 2016 09:05
2.0.3 03 May 2016 02:05
2.0.2 29 Apr 2016 04:04
2.0.1 27 Apr 2016 17:04
2.0.0 19 Apr 2016 11:04
2.0.0-alpha.3 18 Apr 2016 07:04
2.0.0-alpha.2 12 Apr 2016 04:04
2.0.0-alpha.1 30 Mar 2016 10:03
1.0.57 18 Mar 2016 08:03
1.0.56 11 Feb 2016 08:02
1.0.55 15 Jan 2016 10:01
1.0.54 04 Jan 2016 06:01
1.0.53 03 Nov 2015 08:11
1.0.52 07 Oct 2015 06:10
1.0.51 30 Sep 2015 11:09
1.0.50 21 Aug 2015 16:08
1.0.49 14 Aug 2015 06:08
1.0.48 31 Jul 2015 09:07
1.0.47 15 Jul 2015 06:07
1.0.45 06 Jul 2015 18:07
1.0.44 30 Jun 2015 13:06
1.0.43 26 Jun 2015 13:06
1.0.42 23 Jun 2015 14:06
1.0.41 16 Jun 2015 17:06
1.0.40 27 May 2015 10:05
1.0.39 11 May 2015 06:05
1.0.38 30 Apr 2015 18:04
1.0.37 23 Apr 2015 11:04
1.0.36 09 Apr 2015 10:04
1.0.35 18 Mar 2015 14:03
1.0.34 10 Mar 2015 06:03
1.0.31 24 Feb 2015 17:02
1.0.30 19 Feb 2015 11:02
1.0.29 16 Feb 2015 09:02
1.0.28 09 Feb 2015 12:02
1.0.27 30 Jan 2015 05:01
1.0.26 06 Jan 2015 09:01
1.0.25 01 Jan 2015 12:01
1.0.24 03 Dec 2014 08:12
1.0.23 19 Nov 2014 12:11
1.0.22 12 Nov 2014 07:11
1.0.21 28 Oct 2014 05:10
1.0.19 17 Oct 2014 20:10
1.0.18 25 Sep 2014 12:09
1.0.16 16 Sep 2014 01:09
1.0.15 15 Aug 2014 00:08
1.0.14 13 Aug 2014 20:08
1.0.12 13 Jul 2014 05:07
1.0.11 04 Jul 2014 19:07
1.0.10 24 Jun 2014 19:06
1.0.9 24 Jun 2014 18:06
1.0.8 24 Jun 2014 18:06
1.0.7 18 Jun 2014 16:06
1.0.6 12 Jun 2014 17:06
1.0.5 11 Jun 2014 01:06
1.0.4 13 May 2014 18:05
1.0.3 28 Mar 2014 15:03
1.0.2 28 Mar 2014 01:03
1.0.1 24 Mar 2014 22:03
1.0.0 11 Feb 2014 23:02