Merge pull request #1159 from nats-io/bolt_config

[ADDED] Configuration parameters for RAFT's BoltDB store

server/clustering.go

@@ -111,14 +111,13 @@ type ClusteringOptions struct {
 	// speed up recovery since there is no need for a full database re-sync.
 	BoltFreeListSync bool
 
-	// BoltFreeListArray sets the backend freelist type to "array".
-	// There are two options:
-	// - "array" which is simple but suffers dramatic performance degradation if database is
-	//   large and framentation in freelist is common.
-	// - "hashmap" which is faster in almost all circumstances but doesn't guarantee
-	//   that it offers the smallest page id available. In normal case it is safe.
-	// Since v0.21.0, the default is "hashmap". Set this option to "true" to use "array" instead.
-	BoltFreeListArray bool
+	// BoltFreeListMap sets the backend freelist type to use a map instead of
+	// the default array type.
+	// The "array" type (the default) is simple but suffers dramatic performance
+	// degradation if database is large and framentation in freelist is common.
+	// The "hashmap which is faster in almost all circumstances but doesn't guarantee
+	// that it offers the smallest page id available. In normal case it is safe.
+	BoltFreeListMap bool
 }
 
 // raftNode is a handle to a member in a Raft consensus group.

server/conf.go

@@ -356,11 +356,11 @@ func parseCluster(itf interface{}, opts *Options) error {
 				return err
 			}
 			opts.Clustering.BoltFreeListSync = v.(bool)
-		case "bolt_free_list_array":
+		case "bolt_free_list_map":
 			if err := checkType(k, reflect.Bool, v); err != nil {
 				return err
 			}
-			opts.Clustering.BoltFreeListArray = v.(bool)
+			opts.Clustering.BoltFreeListMap = v.(bool)
 		case "nodes_connections":
 			if err := checkType(k, reflect.Bool, v); err != nil {
 				return err

server/conf_test.go

@@ -278,8 +278,8 @@ func TestParseConfig(t *testing.T) {
 	if !opts.Clustering.BoltFreeListSync {
 		t.Fatal("Expected BoltFreeListSync to be true")
 	}
-	if !opts.Clustering.BoltFreeListArray {
-		t.Fatal("Expected BoltFreeListArray to be true")
+	if !opts.Clustering.BoltFreeListMap {
+		t.Fatal("Expected BoltFreeListMap to be true")
 	}
 	if !opts.Clustering.NodesConnections {
 		t.Fatal("Expected NodesConnections to be true")
@@ -515,7 +515,7 @@ func TestParseWrongTypes(t *testing.T) {
 	expectFailureFor(t, "cluster:{raft_commit_timeout:\"not_a_time\"}", wrongTimeErr)
 	expectFailureFor(t, "cluster:{allow_add_remove_node:1}", wrongTypeErr)
 	expectFailureFor(t, "cluster:{bolt_free_list_sync:123}", wrongTypeErr)
-	expectFailureFor(t, "cluster:{bolt_free_list_array:123}", wrongTypeErr)
+	expectFailureFor(t, "cluster:{bolt_free_list_map:123}", wrongTypeErr)
 	expectFailureFor(t, "sql:{driver:false}", wrongTypeErr)
 	expectFailureFor(t, "sql:{source:false}", wrongTypeErr)
 	expectFailureFor(t, "sql:{no_caching:123}", wrongTypeErr)

server/raft_log.go

@@ -68,9 +68,9 @@ func newRaftLog(log logger.Logger, fileName string, opts *Options) (*raftLog, er
 		fileName: fileName,
 		codec:    &codec.MsgpackHandle{},
 	}
-	freeListType := bolt.FreelistMapType
-	if opts.Clustering.BoltFreeListArray {
-		freeListType = bolt.FreelistArrayType
+	freeListType := bolt.FreelistArrayType
+	if opts.Clustering.BoltFreeListMap {
+		freeListType = bolt.FreelistMapType
 	}
 	dbOpts := &bolt.Options{
 		NoSync:         !opts.Clustering.Sync,

test/configs/test_parse.conf

@@ -93,7 +93,7 @@ streaming: {
       raft_commit_timeout: "50ms"
       allow_add_remove_node: true
       bolt_free_list_sync: true
-      bolt_free_list_array: true
+      bolt_free_list_map: true
       nodes_connections: true
   }