Skip to content

Redis feature set table #1008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jan 24, 2025
Merged

Redis feature set table #1008

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3a52ed5
DOC-4673 Initial Redis version matrix
rrelledge Dec 18, 2024
6583053
DOC-4673 Added highlights to what's new in Redis feature set embed & …
rrelledge Dec 20, 2024
fc2f364
DOC-4673 Feedback updates to change table columns & add table to Clou…
rrelledge Dec 23, 2024
124fc14
Merge branch 'main' into DOC-4673
rrelledge Dec 23, 2024
c0c5837
Merge branch 'main' into DOC-4673
rrelledge Jan 15, 2025
bf02b8b
DOC-4673 Feedback updates to rearrange table & add some more details …
rrelledge Jan 15, 2025
dcff44b
DOC-4673 Feedback updates for 7.2 feature set description
rrelledge Jan 16, 2025
3c2677b
DOC-4673 Remove feature set table embed from various release notes an…
rrelledge Jan 17, 2025
c2a10c3
DOC-4673 Moved Redis feature set table to develop > what's new
rrelledge Jan 17, 2025
f2d675e
Merge branch 'main' into DOC-4673
rrelledge Jan 24, 2025
002c69a
DOC-4673 Feedback update to remove T&F compatibility change from what…
rrelledge Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions content/embeds/redis-feature-sets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
A Redis feature set includes a specific Redis database version along with the advanced capabilities and data structures provided by compatible module versions.
Copy link
Collaborator

@dwdougherty dwdougherty Dec 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a caveat here: Redis CE doesn't include the advanced capabilities by default. Customers will either have to download and install them separately, or use Redis Stack. This, of course, will go away when CE8 ships, essentially replacing both standalone Redis CE and Redis Stack.

So, really, this just applies to RS, RC, and Redis Stack.

Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Dec 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest using something like this to not mention advanced capabilities and data structures to be ready for CE8.

A Redis feature set represents the complete set of features available in a specific configuration, and its version number increments whenever a new feature is introduced.

To use a new feature introduced in a later feature set, you must upgrade to the corresponding feature set version, as outlined in the table below.

Copy link
Contributor

@K-Jo K-Jo Dec 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct. We can add that in if you like. I don't think users are consuming modules separately often. We see in the field customers running redis-stack in production

Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rrelledge , what do you think about this wording?

A Redis feature set represents the complete set of features available in a specific configuration, and its version number increments whenever a new feature is introduced.

To use a new feature introduced in a later feature set, you must upgrade to the corresponding feature set version, as outlined in the table below.

Copy link
Collaborator Author

@rrelledge rrelledge Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ViktarStarastsenka
I'm fine with changing the feature set description, but I'm not sure about the phrase "specific configuration".

What do you think of something like:
"A Redis feature set represents the complete set of features available for a specific Redis version."

I don't think it's necessary to explain "its version number increments whenever a new feature is introduced".

I changed the last sentence to: "To use a new feature introduced in a later feature set, you must upgrade the corresponding components according to the following table."

Copy link
Collaborator

@mich-elle-luna mich-elle-luna Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, specific configuration sounds like something different than version.

Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The suggestion is to locate the feature sets under the “Commands” section since basically commands are introduced or their behavior is changed with the feature sets

Copy link
Collaborator Author

@rrelledge rrelledge Jan 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we can easily include a separate, non-command page under the commands section at this time. The commands section uses layouts that work differently from the rest of the site. It did not work at all when I made a cursory attempt in my local env. I don't think it's a simple change, and we definitely want to be careful with the commands section.

cc @dwdougherty since you are more familiar with the commands section than me.


A database is not compatible with module versions from different feature set versions. If you want to use advanced capability features or data structures introduced by a later feature set version, you must upgrade your database to the compatible Redis version and module versions according to the following table.

| Redis feature set version | Compatible versions | What's new |
Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we please move "Compatible versions" after "What's new"?
since with Redis 8, this column would be less relevant

Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest combining the "Redis feature set version" and "Compatible versions" into one column to optimize space, especially when Redis 8 is out.

Copy link
Collaborator Author

@rrelledge rrelledge Jan 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's going to potentially look crowded with either solution. If we list all the module versions in the first column, then it might make the feature set version more difficult to see. I guess adding a line break between the feature set version and component versions might help though.

For the change with Redis 8, we might need to add a footnote to the table or something that explains the sudden absence of component versions and their release notes links.

Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Jan 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think adding a line break is a good idea.

|-------------------|----------------|------------|
| 7.4 | [Redis 7.4]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisce/redisce-7.4-release-notes.md">}})<br />[Search 2.10]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.10-release-notes.md" >}})<br />[JSON 2.8]({{<relref "operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.8-release-notes.md">}})<br />[Time series 1.12]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.12-release-notes.md">}})<br />[Bloom 2.8]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.8-release-notes.md">}}) | Hash field expiration; new vector data types; time series insertion filters |
Copy link
Contributor

@ViktarStarastsenka ViktarStarastsenka Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's add more information about new features and changes for every release.
Also, we need to add a description for “Compatibility Changes”, describing any behavioral/incompatible changes since they affect the steps users need to upgrade

I added a possible example here - https://github.com/redis/docs/pull/1034/files

| 7.2 | [Redis 7.2](https://raw.githubusercontent.com/redis/redis/7.2/00-RELEASENOTES)<br />[Search 2.8]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.8-release-notes.md" >}})<br />[JSON 2.6]({{<relref "operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.6-release-notes.md">}})<br />[Time series 1.10]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.10-release-notes.md">}})<br />[Bloom 2.6]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.6-release-notes.md">}})<br />[Gears 2.0](https://github.com/RedisGears/RedisGears/releases) | `WAITAOF`; memory and speed optimizations for lists, sets, and sorted sets; RESP3 support; new RDB file format; geo polygon search; performance improvements for sorted search and queries; new JSON commands |
| 6.2 | [Redis 6.2](https://raw.githubusercontent.com/redis/redis/6.2/00-RELEASENOTES)<br />[Search 2.6]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.6-release-notes.md" >}})<br />[JSON 2.4]({{<relref "operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.4-release-notes.md">}})<br />[Time series 1.8]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.8-release-notes.md">}})<br />[Bloom 2.4]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.4-release-notes.md">}})<br />[Graph 2.10]({{<relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.10-release-notes.md">}}) | Wildcard queries for `TEXT` and `TAG`; suffix search; multi-value indexing and queries; improved JSON path parser; new probabilistic data structure t-digest; new pathfinding algorithms for graphs; time series gap filling |
6 changes: 5 additions & 1 deletion content/operate/oss_and_stack/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@
title: Redis Community Edition and Stack
description: Operate Redis Community Edition and Redis Stack. Redis OSS was renamed Redis Community Edition (CE) with the v7.4 release.
linkTitle: Redis Community Edition and Stack
---
---

## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}
4 changes: 4 additions & 0 deletions content/operate/oss_and_stack/stack-with-enterprise/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ aliases:
---

[Redis Enterprise Software]({{< relref "/operate/rs" >}}) and [Redis Cloud]({{< relref "/operate/rc" >}}) support all [Redis Stack]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities" >}}) features, which extend the core Redis feature set. Some of the capabilities Redis Stack provides include querying, indexing, and full-text search and support for JSON, time series, and probabilistic data structures.

## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}
8 changes: 7 additions & 1 deletion content/operate/oss_and_stack/stack-with-enterprise/release-notes/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ categories:
- docs
- operate
- stack
description: Redis Stack and modules release notes
description: Release notes for Redis Community Edition, Redis Stack, and modules
hideListLinks: true
linkTitle: Release notes
weight: 99
---

## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}

## Release notes

See the following release notes for new features, enhancements, and other changes to Redis Stack capabilities.

{{<table-children columnNames="Release notes,Description" columnSources="LinkTitle,Description" enableLinks="LinkTitle" limitTags="visible">}}
6 changes: 6 additions & 0 deletions content/operate/rc/changelog/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ linktitle: Changelog
weight: 95
---

## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}

## Changelogs

Changelogs list new features, enhancements, and other changes in Redis Cloud.

Select a month from the following table to see a more detailed changelog for that month:
Expand Down
11 changes: 9 additions & 2 deletions content/operate/rs/release-notes/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
Title: Release notes
Title: Redis Software release notes
linkTitle: Release notes
alwaysopen: false
categories:
- docs
Expand All @@ -10,6 +11,12 @@ hideListLinks: true
weight: 90
---

Here's what changed recently in Redis Enterprise Software:
## Redis feature sets

{{<embed-md "redis-feature-sets.md">}}

## Release notes

Here's what changed recently in Redis Software:

{{< table-children columnNames="Version&nbsp;(Release&nbsp;date)&nbsp;,Major changes,Redis CE compatibility" columnSources="LinkTitle,Description,compatibleOSSVersion" enableLinks="LinkTitle" >}}
Loading