Merge pull request #21 from dengliming/f_bf_insert

Add Support for BF.INSERT

Author: filipecosta90

Gopkg.lock

@@ -64,7 +64,7 @@ func main() {
 | [BF.RESERVE](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfreserve) | [Reserve](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.Reserve) |
 | [BF.ADD](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfadd) | [Add](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.Add) |
 | [BF.MADD](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfmadd) | [BfAddMulti](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.BfAddMulti)  |
-| [BF.INSERT](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfinsert) | N/A |
+| [BF.INSERT](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfinsert) | [BfInsert](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.BfInsert) |
 | [BF.EXISTS](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfexists) | [Exists](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.Exists) |
 | [BF.MEXISTS](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfmexists) | [BfExistsMulti](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.BfExistsMulti) |
 | [BF.SCANDUMP](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfscandump) | [BfScanDump](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.BfScanDump) |

Gopkg.toml

@@ -155,6 +155,44 @@ func (client *Client) BfLoadChunk(key string, iter int64, data []byte) (string,
 	return redis.String(conn.Do("BF.LOADCHUNK", key, iter, data))
 }
 
+// This command will add one or more items to the bloom filter, by default creating it if it does not yet exist.
+func (client *Client) BfInsert(key string, cap int64, errorRatio float64, expansion int64, noCreate bool, nonScaling bool, items []string) (res []int64, err error) {
+	conn := client.Pool.Get()
+	defer conn.Close()
+	args := redis.Args{key}
+	if cap > 0 {
+		args = args.Add("CAPACITY", cap)
+	}
+	if errorRatio > 0 {
+		args = args.Add("ERROR", errorRatio)
+	}
+	if expansion > 0 {
+		args = args.Add("EXPANSION", expansion)
+	}
+	if noCreate {
+		args = args.Add("NOCREATE")
+	}
+	if nonScaling {
+		args = args.Add("NONSCALING")
+	}
+	args = args.Add("ITEMS").AddFlat(items)
+	var resp []interface{}
+	var innerRes int64
+	resp, err = redis.Values(conn.Do("BF.INSERT", args...))
+	if err != nil {
+		return
+	}
+	for _, arrayPos := range resp {
+		innerRes, err = redis.Int64(arrayPos, err)
+		if err == nil {
+			res = append(res, innerRes)
+		} else {
+			break
+		}
+	}
+	return
+}
+
 // Initializes a TopK with specified parameters.
 func (client *Client) TopkReserve(key string, topk int64, width int64, depth int64, decay float64) (string, error) {
 	conn := client.Pool.Get()

README.md

@@ -130,6 +130,39 @@ func TestClient_BfExistsMulti(t *testing.T) {
 	assert.Equal(t, int64(0), existsResult[2])
 }
 
+func TestClient_BfInsert(t *testing.T) {
+	client.FlushAll()
+	key := "test_bf_insert"
+	key_nocreate := "test_bf_insert_nocreate"
+	key_noscaling := "test_bf_insert_noscaling"
+
+	ret, err := client.BfInsert(key, 1000, 0.1, -1, false, false, []string{"a"})
+	assert.Nil(t, err)
+	assert.Equal(t, 1, len(ret))
+	assert.True(t, ret[0] > 0)
+	existsResult, err := client.BfExistsMulti(key, []string{"a"})
+	assert.Nil(t, err)
+	assert.Equal(t, 1, len(existsResult))
+	assert.Equal(t, int64(1), existsResult[0])
+
+	ret, err = client.BfInsert(key, 1000, 0.1, -1, false, false, []string{"a", "b"})
+	assert.Nil(t, err)
+	assert.Equal(t, 2, len(ret))
+
+	// Test for NOCREATE : If specified, indicates that the filter should not be created if it does not already exist
+	_, err = client.BfInsert(key_nocreate, 1000, 0.1, -1, true, false, []string{"a"})
+	assert.NotNil(t, err)
+
+	// Test NONSCALING : Prevents the filter from creating additional sub-filters if initial capacity is reached.
+	ret, err = client.BfInsert(key_noscaling, 2, 0.1, -1, false, true, []string{"a", "b"})
+	assert.Nil(t, err)
+	assert.Equal(t, 2, len(ret))
+	ret, err = client.BfInsert(key_noscaling, 2, 0.1, -1, false, true, []string{"c"})
+	assert.NotNil(t, err)
+	assert.Equal(t, 0, len(ret))
+	assert.Equal(t, err.Error(), "ERR non scaling filter is full")
+}
+
 func TestClient_TopkReserve(t *testing.T) {
 	client.FlushAll()
 	ret, err := client.TopkReserve("test_topk_reserve", 10, 2000, 7, 0.925)