Redis feature set table #1008
Redis feature set table #1008
Conversation
…added embed to a additional pages
rrelledge
requested review from
dwdougherty,
K-Jo,
ViktarStarastsenka,
mich-elle-luna and
a team
content/embeds/redis-feature-sets.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
@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."
There was a problem hiding this comment.
Agreed, specific configuration sounds like something different than version.
content/embeds/redis-feature-sets.md
Outdated
|
|
||
| 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 | Distributed in | What's new | |
There was a problem hiding this comment.
maybe we do not actually need the "Distributed in" column at all - we can reference the feature set version from everywhere (e.g. release notes in RS, Redis Cloud, etc.)
and it will make the table smaller
though I'd suggest creating a separate "Compatible versions" column, where we describe the Redis server version and modules (and just the Redis version with CE8)
There was a problem hiding this comment.
@ViktarStarastsenka I updated the staged previews of the table with your suggested changes.
I also added the table to the Cloud changelog: https://redis.io/docs/staging/DOC-4673/operate/rc/changelog/
cc @cmilesb , are you okay with this addition?
content/embeds/redis-feature-sets.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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.
content/embeds/redis-feature-sets.md
Outdated
|
|
||
| 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 | |
There was a problem hiding this comment.
can we please move "Compatible versions" after "What's new"?
since with Redis 8, this column would be less relevant
There was a problem hiding this comment.
I suggest combining the "Redis feature set version" and "Compatible versions" into one column to optimize space, especially when Redis 8 is out.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I think adding a line break is a good idea.
content/embeds/redis-feature-sets.md
Outdated
|
|
||
| | Redis feature set version | Compatible versions | What's new | | ||
| |-------------------|----------------|------------| | ||
| | 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 | |
There was a problem hiding this comment.
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
content/embeds/redis-feature-sets.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
…to the feature set descriptions
content/embeds/redis-feature-sets.md
Outdated
| | Redis feature set | What's new | | ||
| |-------------------|------------| | ||
| | **Feature set version:** 7.4<br /><br />**Component versions:**<br />[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**: <br>- [Expiration of individual hash fields]({{<relref "/develop/data-types/hashes#field-expiration">}}). <br> **Streams**: <br>- To start reading from the last stream message, use [`XREAD`]({{<relref "/commands/xread">}}) with the new ID value `+`.<br> **Time series**: <br>Insertion-filter for close samples. <br> **JSON**: <br>- A fix to not duplicate `AOF` commands multiple times in [`JSON.MSET`]({{< baseurl >}}/commands/json.mset/). <br> **Probabilistic**: <br>- Returns an error if [`CMS.MERGE`]({{< baseurl >}}/commands/cms.merge/) results in an overflow or underflow. <br> **Redis Query Engine**: <br>- New `BFLOAT16` and `FLOAT16` vector data types, reducing memory consumed by vectors while preserving accuracy. <br>- Support for indexing empty and missing values and enhanced developer experience for queries with exact matching capabilities. <br>- You can match `TAG` fields without needing to escape special characters. <br>- Expanded geospatial search with new `INTERSECT` and `DISJOINT` operators, improved reporting of the memory consumed by the index, and exposed full-text scoring in aggregation pipelines. <br> **Compatibility changes**: <br>- Redis feature set 7.4 does not include [triggers and functions]({{<relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions">}}). To ensure a seamless upgrade, remove any T&F functions created before loading an RDB file into the new Redis Stack. | | ||
| | **Feature set version:** 7.2<br /><br />**Component versions:**<br />[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) | - New [`WAITAOF`]({{<relref "/commands/waitaof">}}) command.<br />- Memory and speed optimizations for lists, sets, and sorted sets.<br />- RESP3 support.<br />- New RDB file format.<br />**JSON**:<br />- New JSON commands.<br />**Redis Query Engine:**<br />- Geo polygon search.<br />- Performance improvements for sorted search and queries. | |
There was a problem hiding this comment.
7.2:
Performance and resource utilization improvements, including significant memory and speed optimizations for lists, sets, and sorted sets.
JSON introduces two new commands:
Redis Query Engine:
Introducing the frequently asked Geo Polygon Search.
Compatibility changes:
- Redis 7.2 uses a new format (version 11) for RDB files, which is incompatible
with older versions. See release notes for additional breaking changes. - Redis feature set 7.2 does not include Graph capabilities.
There was a problem hiding this comment.
Thanks! I updated the 7.2 description in the table.
@mich-elle-luna originally told me not to include breaking changes in this table, so I omitted that part for now.
content/embeds/redis-feature-sets.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
just one comment - we can remove this
Compatibility changes:
- Redis feature set 7.4 does not include [triggers and functions]({{<relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions">}}). To ensure a seamless upgrade, remove any T&F functions created before loading an RDB file into the new Redis Stack.
DOC-4673