aedes-persistence-cassandra - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "aedes-persistence-cassandra",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Cassandra persistence for Aedes",
@@ -5,0 +5,0 @@ "main": "persistence-cassandra.js",

persistence-cassandra.js

@@ -93,3 +93,3 @@ "use strict";
     const defaultOpts = { contactPoints: ["localhost:9042"], localDataCenter: "datacenter1", keyspace: "aedes" };
-    const cassandraOpts = that._opts.cassandra ? Object.assign(defaultOpts, that._opts.kafka) : defaultOpts;
+    const cassandraOpts = that._opts.cassandra ? Object.assign(defaultOpts, that._opts.cassandra) : defaultOpts;
 
@@ -96,0 +96,0 @@ that._shutdownClient = true;

README.md

@@ -7,4 +7,16 @@ # aedes-persistence-cassandra
 
-_**NOTE**: preliminary version, WIP._
+## Disclaimer
 
+Be sure to understand applicability and limitations before using this package in production.
+
+In most cases [aedes-persistence-mongodb](https://github.com/moscajs/aedes-persistence-mongodb) should be considered a better alternative to this.
+
+Please understand that Cassandra is not suited for implementing queues as in most cases this results in reading lots of tombstones ([cassandra-anti-patterns-queues-and-queue-datasets](https://www.datastax.com/blog/cassandra-anti-patterns-queues-and-queue-datasets)).
+
+This package is suitable when:
+
+* You have a small sets of subscriptions with low traffic
+* You already have a deployed Cassandra cluster and can't afford to deploy another persistence solution (e.g. MongoDB or Redis)
+* You are regularly performing compactions/repair on the used keyspace
+
 ## Install
@@ -11,0 +23,0 @@

No alert changes

Improved metrics

Total package byte prevSize

29735

increased by7.3%

Number of lines in readme file

99

increased by13.79%

No dependency changes