# 語(yǔ)法

# capacity
#過(guò)濾器的預(yù)估容量。
#容量向上取整到下一個(gè) 2^n 數(shù)。
#過(guò)濾器很可能無(wú)法完全填充到其容量的 100%。如果您想避免擴(kuò)展，請(qǐng)確保預(yù)留額外的容量。

#BUCKETSIZE bucketsize
#每個(gè)桶中的項(xiàng)目數(shù)。
#較高的桶大小值可以提高填充率，但也會(huì)導(dǎo)致更高的錯(cuò)誤率和稍微慢的性能。
#bucketsize 是一個(gè)介于 1 到 255 之間的整數(shù)。默認(rèn)值為 2。

# MAXITERATIONS maxiterations
#在聲明過(guò)濾器已滿(mǎn)并創(chuàng)建附加過(guò)濾器之前，在桶之間交換項(xiàng)目的嘗試次數(shù)。
#較低的值有利于性能，較高的值有利于過(guò)濾器填充率。
#maxiterations 是一個(gè)介于 1 到 65535 之間的整數(shù)。默認(rèn)值為 20。

# EXPANSION expansion
#創(chuàng)建新過(guò)濾器時(shí)，其大小是當(dāng)前過(guò)濾器大小乘以 expansion。
#expansion 是一個(gè)介于 0 到 32768 之間的整數(shù)。默認(rèn)值為 1。
#擴(kuò)展值向上取整到下一個(gè) 2^n 數(shù)。

CF.RESERVE key capacity [BUCKETSIZE bucketsize]  [MAXITERATIONS maxiterations] [EXPANSION expansion]

redis> CF.RESERVE cf 1000
OK
# 不允許重復(fù)創(chuàng)建
redis> CF.RESERVE cf 1000
(error) ERR item exists

redis> CF.RESERVE cf_params 1000 BUCKETSIZE 8 MAXITERATIONS 20 EXPANSION 2
OK

# 語(yǔ)法
CF.ADD key item


# 示例 可以重復(fù)添加
redis> CF.ADD cf item1
(integer) 1
redis> CF.ADD cf item1
(integer) 1

# 語(yǔ)法 如果元素不存在，則將項(xiàng)目添加到 Cuckoo 過(guò)濾器中。
CF.ADDNX key item

redis> CF.ADDNX cf item
(integer) 1
# 不能重復(fù)添加
redis> CF.ADDNX cf item
(integer) 0

# 語(yǔ)法 返回給定項(xiàng)被添加到布谷鳥(niǎo)過(guò)濾器中的次數(shù)的估計(jì)值。
CF.COUNT key item

redis> CF.INSERT cf ITEMS item1 item2 item2
1) (integer) 1
2) (integer) 1
3) (integer) 1
redis> CF.COUNT cf item1
(integer) 1
redis> CF.COUNT cf item2
(integer) 2

# 語(yǔ)法
CF.DEL key item

redis> CF.INSERT cf ITEMS item1 item2 item2
1) (integer) 1
2) (integer) 1
3) (integer) 1
redis> CF.DEL cf item1
(integer) 1
redis> CF.DEL cf item1
(integer) 0
redis> CF.DEL cf item2
(integer) 1
redis> CF.DEL cf item2
(integer) 1
redis> CF.DEL cf item2
(integer) 0

# 語(yǔ)法，返回值為整數(shù)，其中 1 表示 item !很可能!已經(jīng)添加到過(guò)濾器中，而 0 表示 key 不存在或 item 未添加到過(guò)濾器中。
CF.EXISTS key item

# 示例
redis> CF.ADD cf item1
(integer) 1
redis> CF.EXISTS cf item1
(integer) 1
redis> CF.EXISTS cf item2
(integer) 0

# 語(yǔ)法
CF.MEXISTS key item [item ...]

# 示例
redis> CF.INSERT cf ITEMS item1 item2
1) (integer) 1
2) (integer) 1
redis> CF.MEXISTS cf item1 item2 item3
1) (integer) 1
2) (integer) 1
3) (integer) 0

# 語(yǔ)法
CF.INFO key

# 示例
redis> CF.INFO cf
 1) Size
 2) (integer) 1080
 3) Number of buckets
 4) (integer) 512
 5) Number of filter
 6) (integer) 1
 7) Number of items inserted
 8) (integer) 0
 9) Number of items deleted
10) (integer) 0
11) Bucket size
12) (integer) 2
13) Expansion rate
14) (integer) 1
15) Max iteration
16) (integer) 20

# 語(yǔ)法

# 如果 key 不存在，則會(huì)創(chuàng)建一個(gè)新的布谷鳥(niǎo)過(guò)濾器。

#CAPACITY capacity
#如果過(guò)濾器尚不存在，則指定新過(guò)濾器的期望容量。
#如果過(guò)濾器已存在，則忽略此參數(shù)。
#如果過(guò)濾器尚不存在且未指定此參數(shù)，則會(huì)以模塊級(jí)別的默認(rèn)容量（即 1024）創(chuàng)建過(guò)濾器。

# NOCREATE
#如果指定此選項(xiàng)，則在過(guò)濾器不存在時(shí)阻止自動(dòng)創(chuàng)建（將返回錯(cuò)誤）。
#此選項(xiàng)與 CAPACITY 互斥。

CF.INSERT key [CAPACITY capacity] [NOCREATE] ITEMS item [item ...]

# 創(chuàng)建并添加元素
redis> CF.INSERT cf CAPACITY 1000 ITEMS item1 item2 
1) (integer) 1
2) (integer) 1

# NOCREATE 不創(chuàng)建
redis> CF.INSERT cf1 CAPACITY 1000 NOCREATE ITEMS item1 item2 
(error) ERR not found

# 指定容量
redis> CF.RESERVE cf2 2 BUCKETSIZE 1 EXPANSION 0
OK
redis> CF.INSERT cf2 ITEMS 1 1 1 1
1) (integer) 1
2) (integer) 1
3) (integer) -1
4) (integer) -1

# 語(yǔ)法

#CAPACITY capacity
#指定新過(guò)濾器的期望容量，如果此過(guò)濾器尚不存在。
#如果過(guò)濾器已存在，則此參數(shù)將被忽略。
#如果過(guò)濾器尚不存在且未指定此參數(shù)，則使用模塊級(jí)別的默認(rèn)容量 1024 創(chuàng)建過(guò)濾器。

#NOCREATE
#如果指定此項(xiàng)，則在過(guò)濾器不存在時(shí)阻止自動(dòng)創(chuàng)建過(guò)濾器（此時(shí)會(huì)返回錯(cuò)誤）。
#此選項(xiàng)與 CAPACITY 互斥。

CF.INSERTNX key [CAPACITY capacity] [NOCREATE] ITEMS item [item ...]

# 創(chuàng)建過(guò)濾器并添加
redis> CF.INSERTNX cf CAPACITY 1000 ITEMS item1 item2 
1) (integer) 1
2) (integer) 1
# 不允許重復(fù)添加元素
redis> CF.INSERTNX cf CAPACITY 1000 ITEMS item1 item2 item3
1) (integer) 0
2) (integer) 0
3) (integer) 1
# NOCREATE 不會(huì)創(chuàng)建過(guò)濾器
redis> CF.INSERTNX cf_new CAPACITY 1000 NOCREATE ITEMS item1 item2 
(error) ERR not found

# 語(yǔ)法
CF.SCANDUMP key iterator

redis> CF.RESERVE cf 8
OK
redis> CF.ADD cf item1
(integer) 1
redis> CF.SCANDUMP cf 0
1) (integer) 1
2) "\x01\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x02\x00\x14\x00\x01\x008\x9a\xe0\xd8\xc3\x7f\x00\x00"
redis> CF.SCANDUMP cf 1
1) (integer) 9
2) "\x00\x00\x00\x00\a\x00\x00\x00"
redis> CF.SCANDUMP cf 9
1) (integer) 0
2) (nil)
redis> DEL bf
(integer) 1
redis> CF.LOADCHUNK cf 1 "\x01\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x02\x00\x14\x00\x01\x008\x9a\xe0\xd8\xc3\x7f\x00\x00"
OK
redis> CF.LOADCHUNK cf 9 "\x00\x00\x00\x00\a\x00\x00\x00"
OK
redis> CF.EXISTS cf item1
(integer) 1

# python代碼
chunks = []
iter = 0
while True:
    iter, data = CF.SCANDUMP(key, iter)
    if iter == 0:
        break
    else:
        chunks.append([iter, data])

# Load it back
for chunk in chunks:
    iter, data = chunk
    CF.LOADCHUNK(key, iter, data)

# 語(yǔ)法
CF.LOADCHUNK key iterator data