Hash Field Expiration - Draft

src/Makefile

@@ -354,7 +354,7 @@ endif
 
 REDIS_SERVER_NAME=redis-server$(PROG_SUFFIX)
 REDIS_SENTINEL_NAME=redis-sentinel$(PROG_SUFFIX)
-REDIS_SERVER_OBJ=threads_mngr.o adlist.o quicklist.o ae.o anet.o dict.o kvstore.o server.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking.o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o pubsub.o multi.o debug.o sort.o intset.o syncio.o cluster.o cluster_legacy.o crc16.o endianconv.o slowlog.o eval.o bio.o rio.o rand.o memtest.o syscheck.o crcspeed.o crc64.o bitops.o sentinel.o notify.o setproctitle.o blocked.o hyperloglog.o latency.o sparkline.o redis-check-rdb.o redis-check-aof.o geo.o lazyfree.o module.o evict.o expire.o geohash.o geohash_helper.o childinfo.o defrag.o siphash.o rax.o t_stream.o listpack.o localtime.o lolwut.o lolwut5.o lolwut6.o acl.o tracking.o socket.o tls.o sha256.o timeout.o setcpuaffinity.o monotonic.o mt19937-64.o resp_parser.o call_reply.o script_lua.o script.o functions.o function_lua.o commands.o strl.o connection.o unix.o logreqres.o
+REDIS_SERVER_OBJ=threads_mngr.o adlist.o quicklist.o ae.o anet.o dict.o ebuckets.o mstr.o kvstore.o server.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking.o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o pubsub.o multi.o debug.o sort.o intset.o syncio.o cluster.o cluster_legacy.o crc16.o endianconv.o slowlog.o eval.o bio.o rio.o rand.o memtest.o syscheck.o crcspeed.o crc64.o bitops.o sentinel.o notify.o setproctitle.o blocked.o hyperloglog.o latency.o sparkline.o redis-check-rdb.o redis-check-aof.o geo.o lazyfree.o module.o evict.o expire.o geohash.o geohash_helper.o childinfo.o defrag.o siphash.o rax.o t_stream.o listpack.o localtime.o lolwut.o lolwut5.o lolwut6.o acl.o tracking.o socket.o tls.o sha256.o timeout.o setcpuaffinity.o monotonic.o mt19937-64.o resp_parser.o call_reply.o script_lua.o script.o functions.o function_lua.o commands.o strl.o connection.o unix.o logreqres.o
 REDIS_CLI_NAME=redis-cli$(PROG_SUFFIX)
 REDIS_CLI_OBJ=anet.o adlist.o dict.o redis-cli.o zmalloc.o release.o ae.o redisassert.o crcspeed.o crc64.o siphash.o crc16.o monotonic.o cli_common.o mt19937-64.o strl.o cli_commands.o
 REDIS_BENCHMARK_NAME=redis-benchmark$(PROG_SUFFIX)

src/aof.c

@@ -1950,8 +1950,10 @@ static int rioWriteHashIteratorCursor(rio *r, hashTypeIterator *hi, int what) {
         else
             return rioWriteBulkLongLong(r, vll);
     } else if (hi->encoding == OBJ_ENCODING_HT) {
-        sds value = hashTypeCurrentFromHashTable(hi, what);
-        return rioWriteBulkString(r, value, sdslen(value));
+        char *str;
+        size_t len;
+        hashTypeCurrentFromHashTable(hi, what, &str, &len, NULL);
+        return rioWriteBulkString(r, str, len);
     }
 
     serverPanic("Unknown hash encoding");
@@ -1962,10 +1964,10 @@ static int rioWriteHashIteratorCursor(rio *r, hashTypeIterator *hi, int what) {
  * The function returns 0 on error, 1 on success. */
 int rewriteHashObject(rio *r, robj *key, robj *o) {
     hashTypeIterator *hi;
-    long long count = 0, items = hashTypeLength(o);
+    long long count = 0, items = hashTypeLength(o, 0);
 
     hi = hashTypeInitIterator(o);
-    while (hashTypeNext(hi) != C_ERR) {
+    while (hashTypeNext(hi, 0) != C_ERR) {
         if (count == 0) {
             int cmd_items = (items > AOF_REWRITE_ITEMS_PER_CMD) ?
                 AOF_REWRITE_ITEMS_PER_CMD : items;

src/commands/hexpire.json

@@ -0,0 +1,118 @@
+{
+    "HEXPIRE": {
+        "summary": "Set expiry for hash field using relative time to expire (seconds)",
+        "complexity": "O(N) where N is the number of arguments to the command",
+        "group": "hash",
+        "since": "8.0.0",
+        "arity": -5,
+        "function": "hexpireCommand",
+        "history": [],
+        "command_flags": [
+            "WRITE",
+            "DENYOOM",
+            "FAST"
+        ],
+        "acl_categories": [
+            "HASH"
+        ],
+        "key_specs": [
+            {
+                "flags": [
+                    "RW",
+                    "UPDATE"
+                ],
+                "begin_search": {
+                    "index": {
+                        "pos": 1
+                    }
+                },
+                "find_keys": {
+                    "range": {
+                        "lastkey": 0,
+                        "step": 1,
+                        "limit": 0
+                    }
+                }
+            }
+        ],
+        "reply_schema": {
+            "oneOf": [
+                {
+                    "description": "Key does not exist.",
+                    "type": "null"
+                },
+                {
+                    "description": "Array of results",
+                    "type": "array",
+                    "minItems": 1,
+                    "maxItems": 4294967295,
+                    "items": [
+                        {
+                            "description": "The field does not exist.",
+                            "const": -2
+                        },
+                        {
+                            "description": "Specified NX | XX | GT | LT condition not met",
+                            "const": 0
+                        },
+                        {
+                            "description": "Expiration time was set or updated.",
+                            "const": 1
+                        },
+                        {
+                            "description": "Field deleted because the specified expiration time is in the past.",
+                            "const": 2
+                        }
+                    ]
+                }
+            ]
+        },
+        "arguments": [
+            {
+                "name": "key",
+                "type": "key",
+                "key_spec_index": 0
+            },
+            {
+                "name": "seconds",
+                "type": "integer"
+            },
+            {
+                "name": "condition",
+                "type": "oneof",
+                "optional": true,
+                "arguments": [
+                    {
+                        "name": "nx",
+                        "type": "pure-token",
+                        "token": "NX"
+                    },
+                    {
+                        "name": "xx",
+                        "type": "pure-token",
+                        "token": "XX"
+                    },
+                    {
+                        "name": "gt",
+                        "type": "pure-token",
+                        "token": "GT"
+                    },
+                    {
+                        "name": "lt",
+                        "type": "pure-token",
+                        "token": "LT"
+                    }
+                ]
+            },
+            {
+                "name": "numfields",
+                "type": "integer"
+            },
+            {
+                "name": "field",
+                "type": "string",
+                "multiple": true
+            }
+        ]
+    }
+}

src/commands/hexpireat.json

@@ -0,0 +1,118 @@
+{
+    "HEXPIREAT": {
+        "summary": "Set expiry for hash field using an absolute Unix timestamp (seconds)",
+        "complexity": "O(N) where N is the number of arguments to the command",
+        "group": "hash",
+        "since": "8.0.0",
+        "arity": -5,
+        "function": "hexpireatCommand",
+        "history": [],
+        "command_flags": [
+            "WRITE",
+            "DENYOOM",
+            "FAST"
+        ],
+        "acl_categories": [
+            "HASH"
+        ],
+        "key_specs": [
+            {
+                "flags": [
+                    "RW",
+                    "UPDATE"
+                ],
+                "begin_search": {
+                    "index": {
+                        "pos": 1
+                    }
+                },
+                "find_keys": {
+                    "range": {
+                        "lastkey": 0,
+                        "step": 1,
+                        "limit": 0
+                    }
+                }
+            }
+        ],
+        "reply_schema": {
+            "oneOf": [
+                {
+                    "description": "Key does not exist.",
+                    "type": "null"
+                },
+                {
+                    "description": "Array of results",
+                    "type": "array",
+                    "minItems": 1,
+                    "maxItems": 4294967295,
+                    "items": [
+                        {
+                            "description": "The field does not exist.",
+                            "const": -2
+                        },
+                        {
+                            "description": "Specified NX | XX | GT | LT condition not met",
+                            "const": 0
+                        },
+                        {
+                            "description": "Expiration time was set or updated.",
+                            "const": 1
+                        },
+                        {
+                            "description": "Field deleted because the specified expiration time is in the past.",
+                            "const": 2
+                        }
+                    ]
+                }
+            ]
+        },
+        "arguments": [
+            {
+                "name": "key",
+                "type": "key",
+                "key_spec_index": 0
+            },
+            {
+                "name": "unix-time-seconds",
+                "type": "unix-time"
+            },
+            {
+                "name": "condition",
+                "type": "oneof",
+                "optional": true,
+                "arguments": [
+                    {
+                        "name": "nx",
+                        "type": "pure-token",
+                        "token": "NX"
+                    },
+                    {
+                        "name": "xx",
+                        "type": "pure-token",
+                        "token": "XX"
+                    },
+                    {
+                        "name": "gt",
+                        "type": "pure-token",
+                        "token": "GT"
+                    },
+                    {
+                        "name": "lt",
+                        "type": "pure-token",
+                        "token": "LT"
+                    }
+                ]
+            },
+            {
+                "name": "numfields",
+                "type": "integer"
+            },
+            {
+                "name": "field",
+                "type": "string",
+                "multiple": true
+            }
+        ]
+    }
+}

src/commands/hexpiretime.json

@@ -0,0 +1,83 @@
+{
+    "HEXPIRETIME": {
+      "summary": "Returns the expiration time of a hash field as a Unix timestamp, in seconds.",
+      "complexity": "O(N) where N is the number of arguments to the command",
+      "group": "hash",
+      "since": "8.0.0",
+      "arity": -4,
+      "function": "hexpiretimeCommand",
+      "history": [],
+      "command_flags": [
+        "READONLY",
+        "FAST"
+      ],
+      "acl_categories": [
+        "HASH"
+      ],
+      "key_specs": [
+        {
+          "flags": [
+            "RO",
+            "ACCESS"
+          ],
+          "begin_search": {
+            "index": {
+              "pos": 1
+            }
+          },
+          "find_keys": {
+            "range": {
+              "lastkey": 0,
+              "step": 1,
+              "limit": 0
+            }
+          }
+        }
+      ],
+      "reply_schema": {
+        "oneOf": [
+          {
+            "description": "Key does not exist.",
+            "type": "null"
+          },
+          {
+            "description": "Array of results",
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 4294967295,
+            "items": [
+              {
+                "description": "The field does not exist.",
+                "const": -2
+              },
+              {
+                "description": "The field exists but has no associated expire.",
+                "const": -1
+              },
+              {
+                "description": "Expiration Unix timestamp in seconds.",
+                "type": "integer",
+                "minimum": 1
+              }
+            ]
+          }
+        ]
+      },
+      "arguments": [
+         {
+           "name": "key",
+           "type": "key",
+           "key_spec_index": 0
+         },
+         {
+           "name": "numfields",
+           "type": "integer"
+         },
+         {
+           "name": "field",
+           "type": "string",
+           "multiple": true
+         }
+      ]
+    }
+}