expiration filter

Author: HDT3213

README.md

@@ -59,6 +59,12 @@ Options:
   -sep separator for flamegraph, rdb will separate key by it, default value is ":". 
                 supporting multi separators: -sep sep1 -sep sep2 
   -regex using regex expression filter keys
+  -expire filter keys by its expiration time
+		1. '>1751731200' '>now' get keys with expiration time greater than given time
+		2. '<1751731200' '<now' get keys with expiration time less than given time
+		3. '1751731200~1751817600' '1751731200~now' get keys with expiration time in range
+		4. 'noexpire' get keys without expiration time
+		5. 'anyexpire' get all keys with expiration time
   -no-expired reserve expired keys
   -concurrent The number of concurrent json converters. (CpuNum -1 by default, reserve a core for decoder)
 
@@ -411,6 +417,49 @@ Example:
 rdb -c json -o regex.json -regex '^l.*' cases/memory.rdb
 ```
 
+# Expiration Filter
+
+The `-expire` parameter can be configured to filter based on the expiration time.
+
+Keys with expiration times between 2025-07-06 00:00:00 and 2025-07-07 00:00:00:
+```bash
+# toTimestamp(2025-07-06 00:00:00) == 1751731200
+# toTimestamp(2025-07-07 00:00:00) == 1751817600
+rdb -c json -o dump.json -expire 1751731200~1751817600 cases/expiration.rdb
+```
+
+```bash
+# Keys with expiration times earlier than 2025-07-07 00:00:00
+rdb -c json -o dump.json -expire 0~1751817600 cases/expiration.rdb
+```
+
+The magic variable `inf` represents infinity:
+```bash
+rdb -c json -o dump.json -expire 1751731200~inf cases/expiration.rdb
+```
+
+The magic variable `now` represents the current time:
+
+```bash
+# Keys with expiration times earlier than now
+rdb -c json -o dump.json -expire 0~now cases/expiration.rdb
+```
+
+```bash
+# Keys with expiration times later than now
+rdb -c json -o dump.json -expire now~inf cases/expiration.rdb
+```
+
+All keys with expiration times set:
+```bash
+rdb -c json -o dump.json -expire anyexpire cases/expiration.rdb
+```
+
+All keys without expiration times set:
+```bash
+rdb -c json -o dump.json -expire noexpire cases/expiration.rdb
+```
+
 # Customize data usage
 
 ```go

README_CN.md

@@ -46,6 +46,12 @@ Options:
   -sep separator for flamegraph, rdb will separate key by it, default value is ":". 
                 supporting multi separators: -sep sep1 -sep sep2 
   -regex using regex expression filter keys
+  -expire filter keys by its expiration time
+		1. '>1751731200' '>now' get keys with expiration time greater than given time
+		2. '<1751731200' '<now' get keys with expiration time less than given time
+		3. '1751731200~1751817600' '1751731200~now' get keys with expiration time in range
+		4. 'noexpire' get keys without expiration time
+		5. 'anyexpire' get all keys with expiration time
   -no-expired filter expired keys
   -concurrent The number of concurrent json converters. (Cpu number by default)
 
@@ -390,14 +396,57 @@ aaaaaaa
 
 # 正则过滤器
 
-本工具支持使用正则表达式过滤自己关心的键值对：
+支持使用正则表达式过滤自己关心的键值对：
 
 示例:
 
 ```bash
 rdb -c json -o regex.json -regex '^l.*' cases/memory.rdb
 ```
 
+# Expiration 过滤器
+
+`-expire` 参数可以配置根据过期时间过滤.
+
+过期时间在 2025-07-06 00:00:00 与 2025-07-07 00:00:00之间的 key:
+```bash
+# toTimestamp(2025-07-06 00:00:00) == 1751731200
+# toTimestamp(2025-07-07 00:00:00) == 1751817600
+rdb -c json -o dump.json -expire 1751731200~1751817600 cases/expiration.rdb
+```
+
+```bash
+# 过期时间早于 2025-07-07 00:00:00 的 key
+rdb -c json -o dump.json -expire 0~1751817600 cases/expiration.rdb
+```
+
+魔法变量 `inf` 表示无穷大：
+```bash
+rdb -c json -o dump.json -expire 1751731200~inf cases/expiration.rdb
+```
+
+魔法变量 `now` 表示当前时间：
+
+```bash
+# 过期时间早于现在的 key
+rdb -c json -o dump.json -expire 0~now cases/expiration.rdb
+```
+
+```bash
+# 过期时间晚于现在的 key
+rdb -c json -o dump.json -expire now~inf cases/expiration.rdb
+```
+
+所有设置了过期时间的key:
+```bash
+rdb -c json -o dump.json -expire anyexpire cases/expiration.rdb
+```
+
+所有未设置过期时间的key:
+```bash
+rdb -c json -o dump.json -expire noexpire cases/expiration.rdb
+```
+
 # 自定义用途
 
 除了命令行工具之外，您可以在自己的项目中引入 hdt3213/rdb/parser 包，自行决定如何处理 RDB 中的数据。

cases/expiration.rdb

@@ -19,7 +19,13 @@ Options:
   -sep separator for flamegraph, rdb will separate key by it, default value is ":". 
 		supporting multi separators: -sep sep1 -sep sep2 
   -regex using regex expression filter keys
-  -no-expired filter expired keys
+  -expire filter keys by its expiration time
+		1. '1751731200~1751817600' get keys with expiration time in range [1751731200, 1751817600]
+		2. '1751731200~now' 'now~1751731200' magic variable 'now' represents the current timestamp
+		3. '1751731200~inf' 'now~inf' magic variable 'inf' represents the Infinity
+		4. 'noexpire' get keys without expiration time
+		5. 'anyexpire' get all keys with expiration time
+  -no-expired filter expired keys(deprecated, please use 'expire' option)
   -concurrent The number of concurrent json converters. 4 by default.
 
 Examples:
@@ -58,6 +64,7 @@ func main() {
 	var seps separators
 	var regexExpr string
 	var noExpired bool
+	var expirationExpr string
 	var maxDepth int
 	var concurrent int
 	var err error
@@ -69,7 +76,8 @@ func main() {
 	flagSet.IntVar(&concurrent, "concurrent", 0, "concurrent number for json converter")
 	flagSet.Var(&seps, "sep", "separator for flame graph")
 	flagSet.StringVar(&regexExpr, "regex", "", "regex expression")
-	flagSet.BoolVar(&noExpired, "no-expired", false, "filter expired keys")
+	flagSet.StringVar(&expirationExpr, "expire", "", "expiration filter expression")
+	flagSet.BoolVar(&noExpired, "no-expired", false, "filter expired keys(deprecated, please use expire)")
 	_ = flagSet.Parse(os.Args[1:]) // ExitOnError
 	src := flagSet.Arg(0)
 
@@ -92,6 +100,9 @@ func main() {
 	if concurrent != 0 {
 		options = append(options, helper.WithConcurrent(concurrent))
 	}
+	if expirationExpr != "" {
+		options = append(options, helper.WithExpirationOption(expirationExpr))
+	}
 
 	var outputFile *os.File
 	if output == "" {

cmd.go

@@ -2,11 +2,14 @@ package helper
 
 import (
 	"bufio"
-	"github.com/bytedance/sonic"
 	"os"
 	"path/filepath"
 	"testing"
 	"time"
+
+	"github.com/bytedance/sonic"
+	"github.com/hdt3213/rdb/model"
+	"github.com/hdt3213/rdb/parser"
 )
 
 func compareFileByLine(t *testing.T, fn1, fn2 string) (bool, error) {
@@ -237,3 +240,78 @@ func TestToAofWithRegex(t *testing.T) {
 		t.Error("expect error")
 	}
 }
+
+func TestExpiration(t *testing.T) {
+	newDecoder := func(expr string) decoder {
+		rdbFile, err := os.Open("../cases/expiration.rdb")
+		if err != nil {
+			panic(err)
+		}
+		var dec decoder = parser.NewDecoder(rdbFile)
+		dec, err = wrapDecoder(dec, WithExpirationOption(expr))
+		if err != nil {
+			panic(err)
+		}
+		return dec
+	}
+
+	dec := newDecoder("0~1751817600")
+	count := 0
+	dec.Parse(func(object model.RedisObject) bool {
+		count++
+		return true
+	})
+	if count != 1 {
+		t.Errorf("expect 1 got %d", count)
+	}
+
+	dec = newDecoder("1751817600~inf")
+	count = 0
+	dec.Parse(func(object model.RedisObject) bool {
+		count++
+		return true
+	})
+	if count != 0 {
+		t.Errorf("expect 0 got %d", count)
+	}
+
+	dec = newDecoder("1751731200~1751817600")
+	count = 0
+	dec.Parse(func(object model.RedisObject) bool {
+		count++
+		return true
+	})
+	if count != 1 {
+		t.Errorf("expect 1 got %d", count)
+	}
+
+	dec = newDecoder("1751817600~now")
+	count = 0
+	dec.Parse(func(object model.RedisObject) bool {
+		count++
+		return true
+	})
+	if count != 0 {
+		t.Errorf("expect 0 got %d", count)
+	}
+
+	dec = newDecoder("noexpire")
+	count = 0
+	dec.Parse(func(object model.RedisObject) bool {
+		count++
+		return true
+	})
+	if count != 1 {
+		t.Errorf("expect 1 got %d", count)
+	}
+
+	dec = newDecoder("anyexpire")
+	count = 0
+	dec.Parse(func(object model.RedisObject) bool {
+		count++
+		return true
+	})
+	if count != 1 {
+		t.Errorf("expect 1 got %d", count)
+	}
+}