[vector sets] VRANGE implementation by antirez · Pull Request #14235 · redis/redis

antirez · 2025-07-30T13:40:22Z

This is basically the Vector Set iteration primitive.
It exploits the underlying radix tree implementation.
The usage pattern is strongly reminiscent of other Redis commands doing similar things.

The command usage is straightforward:

> VRANGE word_embeddings_int8 [Redis + 10
 1) "Redis"
 2) "Rediscover"
 3) "Rediscover_Ashland"
 4) "Rediscover_Northern_Ireland"
 5) "Rediscovered"
 6) "Rediscovered_Bookshop"
 7) "Rediscovering"
 8) "Rediscovering_God"
 9) "Rediscovering_Lost"
10) "Rediscovers"

The above command returns 10 (or less, if less are available in the specified range) elements from "Redis" (inclusive) to the maximum possible element. The comparison is performed byte by byte, as memcmp() would do, in this way the elements have a total order. The start and end range can be either a string, prefixed
by [ or ( (the prefix is mandatory) to tell the command if the range is inclusive or exclusive, or can be the special symbols - and + that means the maximum and minimum element.

More info can be found in the implementation itself and in the README file change.

snyk-io · 2025-07-30T13:40:35Z

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

kaplanben · 2025-07-30T14:19:15Z

Checkmarx One – Scan Summary & Details – 5b97af55-1d4d-430e-998b-28633b25d8a5

New Issues (7)

Checkmarx found the following issues in this Pull Request

Issue	Source File / Package	Checkmarx Insight
Buffer_Overflow_Wrong_Buffer_Size	/src/redis-cli.c: 3676	details The buffer buf created in /src/redis-cli.c at line 3676 is written to a buffer in /deps/hiredis/sds.c at line 234 by newsh, but an error in calc... `ID: MB1M%2FHPv8FdnbXxmZA9TAV1%2BzTs%3D` Attack Vector
Buffer_Overflow_Wrong_Buffer_Size	/src/redis-cli.c: 3676	details The buffer buf created in /src/redis-cli.c at line 3676 is written to a buffer in /deps/hiredis/sds.c at line 234 by hdrlen, but an error in cal... `ID: MqnP7QsVuVyOykiPzdkQCxsw7H4%3D` Attack Vector
Buffer_Overflow_Wrong_Buffer_Size	/deps/linenoise/linenoise.c: 1200	details The buffer buf created in /deps/linenoise/linenoise.c at line 1200 is written to a buffer in /deps/hiredis/sds.c at line 97 by sh, but an error i... `ID: L1dS1AWIau3DXfxVZMTussbT9bE%3D` Attack Vector
Buffer_Overflow_Wrong_Buffer_Size	/src/redis-cli.c: 10588	details The buffer argv created in /src/redis-cli.c at line 10588 is written to a buffer in /deps/hiredis/sds.c at line 97 by sh, but an error in calcul... `ID: vC%2FFYG%2FXR4U4ciJLaAPiJS9TD80%3D` Attack Vector
Buffer_Overflow_Wrong_Buffer_Size	/deps/linenoise/linenoise.c: 1166	details The buffer fgetc created in /deps/linenoise/linenoise.c at line 1166 is written to a buffer in /deps/hiredis/sds.c at line 97 by sh, but an error... `ID: GntXTIkoxcin9A6wr5%2FfrOjRD7o%3D` Attack Vector
Divide_By_Zero	/deps/fpconv/fpconv_dtoa.c: 183	details The application performs an illegal operation in generate_digits, in /deps/fpconv/fpconv_dtoa.c. In line 183, the program attempts to divide by... `ID: f6%2Fo%2FUFMnQCQOzVpdP%2Bi6jAlAds%3D` Attack Vector
Divide_By_Zero	/src/redis-cli.c: 6037	details The application performs an illegal operation in clusterManagerNodeMasterRandom, in /src/redis-cli.c. In line 6050, the program attempts to divi... `ID: Ez8UONVHfwHV2ShayzJB8j%2B6jPI%3D` Attack Vector

Fixed Issues (4)

Great job! The following issues were fixed in this Pull Request

Severity	Issue	Source File / Package
	~~Buffer_Overflow_Wrong_Buffer_Size~~	/src/redis-cli.c: 3677
	~~Buffer_Overflow_Wrong_Buffer_Size~~	/src/redis-cli.c: 3677
	~~Buffer_Overflow_Wrong_Buffer_Size~~	/src/redis-cli.c: 3677
	~~Buffer_Overflow_Wrong_Buffer_Size~~	/src/redis-cli.c: 3677

GuyAv46

Are tests not running on CI? Coverage is 0
Are we set on VRANGE as the command name? IMO it's confusing with vector range queries. Maybe VLEXRANGE?

GuyAv46 · 2025-08-05T08:42:42Z

+    void *data;
+    while ((key_data = RedisModule_DictNextC(iter, &key_len, &data)) != NULL) {


Not using data, and it's an optional parameter of the API. Consider removing

Suggested change

void *data;

while ((key_data = RedisModule_DictNextC(iter, &key_len, &data)) != NULL) {

while ((key_data = RedisModule_DictNextC(iter, &key_len, NULL)) != NULL) {

GuyAv46 · 2025-08-05T08:45:40Z

+        result = self.redis.execute_command('VRANGE', self.test_key, '(apple', '[cherry', '10')
+        result = [r.decode() for r in result]
+        assert 'apple' not in result, "Exclusive boundary should not include 'apple'"
+        assert 'apricot' in result and 'banana' in result and 'cherry' in result, "Should include elements after apple up to cherry"


Consider asserting the full reply

GuyAv46 · 2025-08-05T08:46:13Z

+        result = self.redis.execute_command('VRANGE', self.test_key, '[banana', '(cherry', '10')
+        result = [r.decode() for r in result]
+        assert 'banana' in result, "Should include banana"
+        assert 'cherry' not in result, "Exclusive end should not include cherry"


Consider asserting the full reply.
The same comment applies to the cases listed below.

GuyAv46 · 2025-08-05T08:50:11Z

+
+        # Test 8: Count of 0 returns empty array
+        result = self.redis.execute_command('VRANGE', self.test_key, '-', '+', '0')
+        assert len(result) == 0, "Count of 0 should return empty array"


Consider asserting the returned value, and not its size. If something breaks, we won't know what we have got.

Suggested change

assert len(result) == 0, "Count of 0 should return empty array"

assert result == [], "Count of 0 should return empty array"

Same comment for the other cases below

antirez · 2025-09-09T18:03:44Z

Thank you @GuyAv46 I improved the PR with your suggestions.

GuyAv46

What's the plan for vector range queries? My only question is whether VRANGE should be kept for that command, and we should call this new command VLEXRANGE or another name indicating lexicographic ranges and not of embedding distances

antirez · 2025-09-18T05:51:10Z

@GuyAv46 thank you for the question. No problem for range queries: there is no plan for fetching ranges from vectors, as any total order of vectors in a high dimensional space is basically meaningless, more or less, and the "range" that is useful is basically VSIM: the subset of vectors near something. So it is worth to simplify naming for the range of vector sets. In the past, the names of certain Redis commands were probably a bit too fancy, but at least for a good reason. Here there are no such concerns.

antirez · 2025-09-18T07:04:44Z

I'm rebasing the changes so that the PR applies again cleanly.

antirez · 2025-09-18T07:42:59Z

Rebased and force-pushed.

sundb · 2025-09-18T13:57:08Z

+    "summary": "Return elements in a lexicographical range",
+    "complexity": "O(log(K)+M) where K is the number of elements in the start prefix, and M is the number of elements returned. In practical terms, the command is just O(M)",
+    "group": "vector_set",
+    "since": "8.3.0",


Should the next version be 8.4?

Hi, fixing, thanks.

In #14235 we forgot to skip vset module command `VRANGE` for schema validator.

sundb added this to Redis 8.2 Jul 30, 2025

github-project-automation Bot moved this to Todo in Redis 8.2 Jul 30, 2025

GuyAv46 reviewed Aug 5, 2025

View reviewed changes

sundb removed this from Redis 8.2 Aug 19, 2025

sundb added this to Redis 8.4 Aug 19, 2025

github-project-automation Bot moved this to Todo in Redis 8.4 Aug 19, 2025

GuyAv46 reviewed Sep 14, 2025

View reviewed changes

GuyAv46 approved these changes Sep 18, 2025

View reviewed changes

antirez added 5 commits September 18, 2025 09:07

VRANGE command implementation.

5202045

VRANGE documentation added.

5265f38

VRANGE test.

9413565

VRANGE added in commands.json.

b58a6bb

VRANGE: fixes after PR review.

739b84f

antirez force-pushed the vrange branch from 59e7542 to 739b84f Compare September 18, 2025 07:42

Fix RedisModuleCommandArg null term initialization to avoid warnings.

69d0b3d

GuyAv46 approved these changes Sep 18, 2025

View reviewed changes

sundb reviewed Sep 18, 2025

View reviewed changes

VRANGE: fix command first Redis version in json.

b76c741

sundb approved these changes Oct 9, 2025

View reviewed changes

sundb reviewed Oct 9, 2025

View reviewed changes

Comment thread modules/vector-sets/vset.c Outdated

Update modules/vector-sets/vset.c

91fb9c8

sundb merged commit 3de2fda into redis:unstable Oct 9, 2025
22 checks passed

github-project-automation Bot moved this from Todo to Done in Redis 8.4 Oct 9, 2025

sundb added the release-notes indication that this issue needs to be mentioned in the release notes label Oct 9, 2025

cxljs mentioned this pull request Oct 10, 2025

feat(vectorset): add vrange command redis/go-redis#3543

Merged

sundb mentioned this pull request Oct 10, 2025

Add VRANGE to ignored commands for schemas validator #14426

Merged

sundb added a commit that referenced this pull request Oct 10, 2025

Add VRANGE to ignored commands for schemas validator (#14426)

df28ad3

In #14235 we forgot to skip vset module command `VRANGE` for schema validator.

		void *data;
		while ((key_data = RedisModule_DictNextC(iter, &key_len, &data)) != NULL) {

	assert len(result) == 0, "Count of 0 should return empty array"
	assert result == [], "Count of 0 should return empty array"

Conversation

antirez commented Jul 30, 2025

Uh oh!

snyk-io Bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎉 Snyk checks have passed. No issues have been found so far.

Uh oh!

kaplanben commented Jul 30, 2025

Uh oh!

GuyAv46 left a comment

Choose a reason for hiding this comment

Uh oh!

GuyAv46 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

antirez Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

GuyAv46 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

GuyAv46 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

GuyAv46 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

antirez commented Sep 9, 2025

Uh oh!

GuyAv46 left a comment

Choose a reason for hiding this comment

Uh oh!

antirez commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

antirez commented Sep 18, 2025

Uh oh!

antirez commented Sep 18, 2025

Uh oh!

sundb Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

antirez Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

snyk-io Bot commented Jul 30, 2025 •

edited

Loading

antirez commented Sep 18, 2025 •

edited

Loading