Un-deprecate commands by stockholmux · Pull Request #2546 · valkey-io/valkey

stockholmux · 2025-08-26T11:43:58Z

As per #2459, this PR removes deprecation and deprecated_since
element and DEPRECATED doc flag from commands. Closes #2459.

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

codecov · 2025-08-26T12:03:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.22%. Comparing base (9d682ba) to head (ae19ac6).
⚠️ Report is 19 commits behind head on unstable.

Additional details and impacted files

@@             Coverage Diff              @@
##           unstable    #2546      +/-   ##
============================================
+ Coverage     72.20%   72.22%   +0.02%     
============================================
  Files           126      126              
  Lines         70615    70662      +47     
============================================
+ Hits          50985    51036      +51     
+ Misses        19630    19626       -4

Files with missing lines	Coverage Δ
src/commands.def	`100.00% <ø> (ø)`

... and 26 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

enjoy-binbin

so we are removing the DEPRECATED flag but will keep the replaced_by? So how do we render (describe) them in our doc now?

zuiderkwast · 2025-08-26T18:44:27Z

so we are removing the DEPRECATED flag but will keep the replaced_by?

I agree replaced_by is strange without deprecated. I think it's better to change it to something more descriptive. Ideas: equivalent_to, similar_to. Do you have any other ideas?

So how do we render (describe) them in our doc now?

In the website repo, it seems that we don't use this replaced_by field at all. I don't find anything when I do git grep replaced_by in the valkey-io.github.io repo.

In the doc repo we have scripts to build man pages. Here, we show replaced_by only if deprecated_since is present. Here's the Python code that generates this markdown text:

utils/preprocess-markdown.py-
utils/preprocess-markdown.py-        if self.deprecated_since:
utils/preprocess-markdown.py-            print("# NOTES", end="\n\n")
utils/preprocess-markdown.py:            if self.replaced_by:
utils/preprocess-markdown.py-                print("This command is deprecated (since %s) and replaced by %s." %
utils/preprocess-markdown.py:                      (self.deprecated_since, self.replaced_by), end="\n\n")
utils/preprocess-markdown.py-            else:
utils/preprocess-markdown.py-                print("This command is deprecated since %s." % self.deprecated_since, end="\n\n")
utils/preprocess-markdown.py-

We can easily change this later to match whatever we decide in this PR.

stockholmux · 2025-08-27T07:36:43Z

@zuiderkwast / @enjoy-binbin

So how do we render (describe) them in our doc now?

In the website repo, it seems that we don't use this replaced_by field at all. I don't find anything when I do git grep replaced_by in the valkey-io.github.io repo.

Yeah, so we do use replaced_by
https://github.com/valkey-io/valkey-io.github.io/blob/main/templates/command-page.html#L175

It is rendered on the docs like this:

That said, it's trivial to sub replaced_by to alternative in the JSON the heading to something like "Alternative"

ranshid · 2025-08-27T09:21:41Z

@zuiderkwast / @enjoy-binbin

So how do we render (describe) them in our doc now?

In the website repo, it seems that we don't use this replaced_by field at all. I don't find anything when I do git grep replaced_by in the valkey-io.github.io repo.

Yeah, so we do use replaced_by https://github.com/valkey-io/valkey-io.github.io/blob/main/templates/command-page.html#L175

It is rendered on the docs like this:
That said, it's trivial to sub `replaced_by` to `alternative` in the JSON the heading to something like "Alternative"

I think we should do this. Having a deprecation advise seems weird.

stockholmux · 2025-09-02T19:23:33Z

The plot thickens. alternative might not be so trivial.

replaced_by is used in server.c for the COMMAND DOCS command:

127.0.0.1:6379> COMMAND DOCS BRPOPLPUSH
1) "brpoplpush"
...
    9) "replaced_by"
   10) "`BLMOVE` with the `RIGHT` and `LEFT` arguments"

It's also used in a couple python scripts: generate-command-code.py and generate-commands-json.py

So would wholesale substituting replaced_by with alternative would constitute a breaking change since the response now is different?

I see three options:

Leave the replaced_by alone: odd wording when the commands are not deprecated, but no real code changes
Have replaced_by for the remaining deprecated commands and alternative for un-deprecated commands - COMMAND DOCS returns either
Get rid of replaced_by entirely in lieu of alternative code changes are search/replace but anyone relying on COMMANDS DOCS to have replaced_by might be in trouble.

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

src/commands/slowlog.json

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

See valkey-io/valkey#2546. This moves the `replaced_by` information from the command json files in valkey-io/valkey into the docs for non-deprecated commands. Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

As per valkey-io#2459, this PR removes deprecation and `deprecated_since` element and `DEPRECATED` doc flag from commands. Closes valkey-io#2459. --------- Signed-off-by: Kyle J. Davis <kyledvs@amazon.com> Co-authored-by: Madelyn Olson <madelyneolson@gmail.com>

As per #2459, this PR removes deprecation and `deprecated_since` element and `DEPRECATED` doc flag from commands. Closes #2459. --------- Signed-off-by: Kyle J. Davis <kyledvs@amazon.com> Co-authored-by: Madelyn Olson <madelyneolson@gmail.com>

As per valkey-io#2459, this PR removes deprecation and `deprecated_since` element and `DEPRECATED` doc flag from commands. Closes valkey-io#2459. --------- Signed-off-by: Kyle J. Davis <kyledvs@amazon.com> Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Harkrishn Patro <harkrisp@amazon.com>

stockholmux added 17 commits August 25, 2025 16:57

undeprecated quit

8a3be11

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated georadius

d0c6ef6

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated georadiusbymember

f9d8df6

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated georadiusbymember_ro

438f816

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated georadius_ro

94f6b7c

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated hmset

f0b17ec

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated brpoplpush

f362dde

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated rpoplpush

23c3732

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated slowlog

dddea55

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated zrangebylex

74a43de

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated zrangebyscore

543d466

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated zrevrangebylex

93f733c

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated getset

80d1ff7

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated psetex

45621e7

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated setex

e3666f9

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated setnx

9af6395

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

undeprecated substr

e8f4079

Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

github-actions bot assigned stockholmux Aug 26, 2025

stockholmux requested review from madolson and zuiderkwast August 26, 2025 11:44

enjoy-binbin added this to Valkey 9.0 Aug 26, 2025

enjoy-binbin added release-notes This issue should get a line item in the release notes major-decision-approved Major decision approved by TSC team labels Aug 26, 2025

enjoy-binbin moved this to In Progress in Valkey 9.0 Aug 26, 2025

enjoy-binbin approved these changes Aug 26, 2025

View reviewed changes

stockholmux and others added 19 commits September 3, 2025 11:14

Update src/commands/georadius_ro.json

edc5c4d

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/georadiusbymember_ro.json

5e1fcd1

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/zrevrange.json

29b7b6e

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/zrangebyscore.json

32c274b

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/zrangebylex.json

46327e1

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/georadiusbymember.json

336ceae

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/getset.json

366c629

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/substr.json

fa916bf

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/hmset.json

fb8676a

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/psetex.json

4016eaa

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/quit.json

aa14b79

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/slowlog.json

a78d71d

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/rpoplpush.json

c1ccbcd

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/setex.json

2676c36

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/setnx.json

ab96e21

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/slowlog-get.json

f217218

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/slowlog-help.json

064c0ed

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/slowlog-len.json

90121c4

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

Update src/commands/slowlog-reset.json

1f25dd3

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

madolson reviewed Sep 3, 2025

View reviewed changes

src/commands/slowlog.json Outdated Show resolved Hide resolved

Update src/commands/slowlog.json

ae19ac6

Co-authored-by: Madelyn Olson <madelyneolson@gmail.com> Signed-off-by: Kyle J. Davis <kyledvs@amazon.com>

madolson merged commit 811a644 into valkey-io:unstable Sep 3, 2025
53 checks passed

github-project-automation bot moved this from In Progress to Done in Valkey 9.0 Sep 3, 2025

zuiderkwast mentioned this pull request Sep 4, 2025

moves replaced_by from command json to markdown valkey-io/valkey-doc#354

Merged

adam-fowler mentioned this pull request Feb 20, 2026

Update commands for v9.0.2 valkey-io/valkey-swift#345

Merged

mkmkme mentioned this pull request Mar 18, 2026

Add deprecation warning to GEORADIUS and GEORADIUSBYMEMBER valkey-io/valkey-py#58

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Un-deprecate commands#2546

Un-deprecate commands#2546
madolson merged 41 commits intovalkey-io:unstablefrom
stockholmux:undeprecation

stockholmux commented Aug 26, 2025 •

edited by enjoy-binbin

Loading

Uh oh!

codecov bot commented Aug 26, 2025 •

edited

Loading

Uh oh!

enjoy-binbin left a comment

Uh oh!

zuiderkwast commented Aug 26, 2025

Uh oh!

stockholmux commented Aug 27, 2025

Uh oh!

ranshid commented Aug 27, 2025

Uh oh!

stockholmux commented Sep 2, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

stockholmux commented Aug 26, 2025 • edited by enjoy-binbin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

enjoy-binbin left a comment

Choose a reason for hiding this comment

Uh oh!

zuiderkwast commented Aug 26, 2025

Uh oh!

stockholmux commented Aug 27, 2025

Uh oh!

ranshid commented Aug 27, 2025

Uh oh!

stockholmux commented Sep 2, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

stockholmux commented Aug 26, 2025 •

edited by enjoy-binbin

Loading

codecov bot commented Aug 26, 2025 •

edited

Loading