Skip to content

Commit d625457

Browse files
cmilesbcmilesb
committed
Merge branch 'main' into preview-rc-rdi
2 parents 319344e + d07e999 commit d625457

File tree

190 files changed

+564
-566
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

190 files changed

+564
-566
lines changed

‎README.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Redis Docs
22

3-
OPEN SOURCE LICENSE VS. TRADEMARKS. The three-clause BSD license gives you the right to redistribute and use the software in source and binary forms, with or without modification, under certain conditions. However, open source licenses like the three-clause BSD license do not address trademarks. For further details please read the [Redis Trademark Policy](https://redis.io/legal/trademark-policy/)."
4-
5-
## A note for Issue and PR submitters
6-
73
PRs are merged first to the `main` branch of this repo.
84
Periodically, the docs team will merge `main` into `latest`, which will make the changes visible on the docs site.
95
Please be patient, as there may be a lag of several days before `main` is merged into `latest`. If you want to see your changes before they're merged to `latest`, you can see them on https://redis.io/docs/staging/dev/.

‎content/commands/info/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ It won't be included when `INFO` or `INFO ALL` are called, and it is returned on
602602

603603
| Redis<br />Enterprise | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
604604
|:----------------------|:-----------------|:------|
605-
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | In Redis Enterprise, `INFO` returns a different set of fields than Redis Community Edition.<br />Not supported for [scripts]({{<relref "/develop/interact/programmability">}}). |
605+
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | In Redis Enterprise, `INFO` returns a different set of fields than Redis Open Source.<br />Not supported for [scripts]({{<relref "/develop/interact/programmability">}}). |
606606

607607
Note: key memory usage is different on Redis Software or Redis Cloud active-active databases than on non-active-active databases. This is because memory usage includes some amount of CRDB overhead.
608608

‎content/commands/module-load/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@ unmodified to the module.
4949
configuration directive in `redis.conf`.
5050

5151
{{< note >}}
52-
As of Redis CE v8.0.0, loading a module using the Redis CLI with configuration parameters is deprecated.
52+
As of Redis 8 in Redis Open Source, loading a module using the Redis CLI with configuration parameters is deprecated.
5353
{{< /note >}}

‎content/develop/clients/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ Redis does not document directly:
5757
## Requirements
5858

5959
You will need access to a Redis server to use these libraries.
60-
You can experiment with a local installation of Redis Community Edition
61-
(see [Install Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}})) or with a free trial of [Redis Cloud]({{< relref "/operate/rc" >}}).
60+
You can experiment with a local installation of Redis Open Source
61+
(see [Install Redis Open Source]({{< relref "/operate/oss_and_stack/install/install-stack/" >}})) or with a free trial of [Redis Cloud]({{< relref "/operate/rc" >}}).
6262
To interact with a Redis server without writing code, use the
6363
[Redis CLI]({{< relref "/develop/tools/cli" >}}) and
6464
[Redis Insight]({{< relref "/develop/tools/insight" >}}) tools.

‎content/develop/clients/dotnet/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ weight: 3
2020
The sections below explain how to install `NRedisStack` and connect your application
2121
to a Redis database.
2222

23-
`NRedisStack` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
23+
`NRedisStack` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
2424

2525
You can also access Redis with an object-mapping client interface. See
2626
[Redis OM for .NET]({{< relref "/integrate/redisom-for-net" >}})
@@ -70,9 +70,9 @@ Console.WriteLine(String.Join("; ", hashFields));
7070
// Prints:
7171
// name: John; surname: Smith; company: Redis; age: 29
7272
```
73-
## Redis Community Edition modules
73+
## Redis Open Source modules
7474

75-
To access Redis Community Edition capabilities, use the appropriate interface like this:
75+
To access Redis Open Source capabilities, use the appropriate interface like this:
7676

7777
```
7878
IBloomCommands bf = db.BF();

‎content/develop/clients/dotnet/queryjson.md

+63-11
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,55 @@ categories:
99
- oss
1010
- kubernetes
1111
- clients
12-
description: Learn how to use the Redis query engine with JSON
13-
linkTitle: Index and query JSON
14-
title: Example - Index and query JSON documents
12+
description: Learn how to use the Redis query engine with JSON and hash documents.
13+
linkTitle: Index and query documents
14+
title: Index and query documents
1515
weight: 2
1616
---
1717

1818
This example shows how to create a
1919
[search index]({{< relref "/develop/interact/search-and-query/indexing" >}})
20-
for [JSON]({{< relref "/develop/data-types/json" >}}) data and
21-
run queries against the index.
20+
for [JSON]({{< relref "/develop/data-types/json" >}}) documents and
21+
run queries against the index. It then goes on to show the slight differences
22+
in the equivalent code for [hash]({{< relref "/develop/data-types/hashes" >}})
23+
documents.
2224

23-
Make sure that you have Redis Community Edition and `NRedisStack` installed.
25+
## Initialize
2426

25-
Start by importing dependencies:
27+
Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack" >}})
28+
or another Redis server available. Also install the
29+
[`NRedisStack`]({{< relref "/develop/clients/dotnet" >}}) client library if you
30+
haven't already done so.
31+
32+
Add the following dependencies:
2633

2734
{{< clients-example cs_home_json import >}}
2835
{{< /clients-example >}}
2936

30-
Connect to the database:
31-
32-
{{< clients-example cs_home_json connect >}}
33-
{{< /clients-example >}}
37+
## Create data
3438

3539
Create some test data to add to the database:
3640

3741
{{< clients-example cs_home_json create_data >}}
3842
{{< /clients-example >}}
3943

44+
## Add the index
45+
46+
Connect to your Redis database. The code below shows the most
47+
basic connection but see
48+
[Connect to the server]({{< relref "/develop/clients/dotnet/connect" >}})
49+
to learn more about the available connection options.
50+
51+
{{< clients-example cs_home_json connect >}}
52+
{{< /clients-example >}}
53+
4054
Create an index. In this example, only JSON documents with the key prefix `user:` are indexed. For more information, see [Query syntax]({{< relref "/develop/interact/search-and-query/query/" >}}).
4155

4256
{{< clients-example cs_home_json make_index >}}
4357
{{< /clients-example >}}
4458

59+
## Add the data
60+
4561
Add the three sets of user data to the database as
4662
[JSON]({{< relref "/develop/data-types/json" >}}) objects.
4763
If you use keys with the `user:` prefix then Redis will index the
@@ -50,6 +66,8 @@ objects automatically as you add them:
5066
{{< clients-example cs_home_json add_data >}}
5167
{{< /clients-example >}}
5268

69+
## Query the data
70+
5371
You can now use the index to search the JSON objects. The
5472
[query]({{< relref "/develop/interact/search-and-query/query" >}})
5573
below searches for objects that have the text "Paul" in any field
@@ -70,5 +88,39 @@ to count all users in each city.
7088
{{< clients-example cs_home_json query3 >}}
7189
{{< /clients-example >}}
7290

91+
## Differences with hash documents
92+
93+
Indexing for hash documents is very similar to JSON indexing but you
94+
need to specify some slightly different options.
95+
96+
When you create the schema for a hash index, you don't need to
97+
add aliases for the fields, since you use the basic names to access
98+
the fields anyway. Also, you must set the `On` option to `IndexDataType.HASH`
99+
in the `FTCreateParams` object when you create the index. The code below shows
100+
these changes with a new index called `hash-idx:users`, which is otherwise the
101+
same as the `idx:users` index used for JSON documents in the previous examples.
102+
103+
{{< clients-example cs_home_json make_hash_index >}}
104+
{{< /clients-example >}}
105+
106+
You use [`HashSet()`]({{< relref "/commands/hset" >}}) to add the hash
107+
documents instead of [`JSON.Set()`]({{< relref "/commands/json.set" >}}).
108+
Also, you must add the fields as key-value pairs instead of combining them
109+
into a single object.
110+
111+
{{< clients-example cs_home_json add_hash_data >}}
112+
{{< /clients-example >}}
113+
114+
The query commands work the same here for hash as they do for JSON (but
115+
the name of the hash index is different). The format of the result is
116+
almost the same except that the fields are returned directly in the
117+
`Document` object of the result (for JSON, the fields are all enclosed
118+
in a string under the key `json`):
119+
120+
{{< clients-example cs_home_json query1_hash >}}
121+
{{< /clients-example >}}
122+
123+
## More information
124+
73125
See the [Redis query engine]({{< relref "/develop/interact/search-and-query" >}}) docs
74126
for a full description of all query features with examples.

‎content/develop/clients/go/_index.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ weight: 7
1919
[`go-redis`](https://github.com/redis/go-redis) is the [Go](https://go.dev/) client for Redis.
2020
The sections below explain how to install `go-redis` and connect your application to a Redis database.
2121

22-
`go-redis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server.
23-
See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation
24-
instructions.
22+
`go-redis` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
2523

2624
## Install
2725

‎content/develop/clients/go/queryjson.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ documents.
2424

2525
## Initialize
2626

27-
Make sure that you have [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}})
27+
Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack/" >}})
2828
or another Redis server available. Also install the
2929
[`go-redis`]({{< relref "/develop/clients/go" >}}) client library if you
3030
haven't already done so.

‎content/develop/clients/jedis/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ a more advanced Java client that also supports asynchronous and reactive connect
2222
The sections below explain how to install `Jedis` and connect your application
2323
to a Redis database.
2424

25-
`Jedis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
25+
`Jedis` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
2626

2727
## Install
2828

‎content/develop/clients/jedis/queryjson.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ documents.
2424

2525
## Initialize
2626

27-
Make sure that you have [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}})
27+
Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack/" >}})
2828
or another Redis server available. Also install the
2929
[Jedis]({{< relref "/develop/clients/jedis" >}}) client library if you
3030
haven't already done so.

‎content/develop/clients/lettuce/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you only need synchronous connections then you may find the other Java client
2424
The sections below explain how to install `Lettuce` and connect your application
2525
to a Redis database.
2626

27-
`Lettuce` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
27+
`Lettuce` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
2828

2929
## Install
3030

‎content/develop/clients/nodejs/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ weight: 4
2020
The sections below explain how to install `node-redis` and connect your application
2121
to a Redis database.
2222

23-
`node-redis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
23+
`node-redis` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
2424

2525
You can also access Redis with an object-mapping client interface. See
2626
[RedisOM for Node.js]({{< relref "/integrate/redisom-for-node-js" >}})

‎content/develop/clients/nodejs/queryjson.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ documents.
2424

2525
## Initialize
2626

27-
Make sure that you have [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}})
27+
Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack/" >}})
2828
or another Redis server available. Also install the
2929
[`node-redis`]({{< relref "/develop/clients/nodejs" >}}) client library if you
3030
haven't already done so.

‎content/develop/clients/om-clients/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ categories:
1010
- oss
1111
- kubernetes
1212
- clients
13-
description: Object-Mapper libraries for Redis Community Edition
13+
description: Object-Mapper libraries for Redis Open Source
1414
linkTitle: Object mapping
1515
stack: true
1616
title: Object-Mapper libraries
1717
weight: 20
1818
---
1919

20-
Redis OM (pronounced *REDiss OHM*) is a library that provides object mapping for Redis. With the help of Redis OM, you can map Redis data types, specifically Hashes and JSON documents, to objects of your preferred programming language or framework. Redis OM relies on the JSON and Redis Query Engine features of Redis Community Edition, allowing you to search and/or query for objects.
20+
Redis OM (pronounced *REDiss OHM*) is a library that provides object mapping for Redis. With the help of Redis OM, you can map Redis data types, specifically Hashes and JSON documents, to objects of your preferred programming language or framework. Redis OM relies on the JSON and Redis Query Engine features of Redis Open Source, allowing you to search and/or query for objects.
2121

2222
You can use Redis OM with the following four programming languages:
2323

‎content/develop/clients/php/_index.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ The sections below explain how to install `Predis` and connect your application
2424
client library and is not developed or supported directly by Redis.
2525
{{< /note >}}
2626

27-
`Predis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server.
28-
See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation
29-
instructions.
27+
`Predis` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
3028

3129
## Install
3230

‎content/develop/clients/php/queryjson.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ documents.
2424

2525
## Initialize
2626

27-
Make sure that you have [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}})
27+
Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack/" >}})
2828
or another Redis server available. Also install the
2929
[`Predis`]({{< relref "/develop/clients/php" >}}) client library if you
3030
haven't already done so.

‎content/develop/clients/redis-py/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ weight: 1
2020
The sections below explain how to install `redis-py` and connect your application
2121
to a Redis database.
2222

23-
`redis-py` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
23+
`redis-py` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
2424

2525
You can also access Redis with an object-mapping client interface. See
2626
[RedisOM for Python]({{< relref "/integrate/redisom-for-python" >}})

‎content/develop/clients/redis-py/queryjson.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ documents.
2424

2525
## Initialize
2626

27-
Make sure that you have [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}})
27+
Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack/" >}})
2828
or another Redis server available. Also install the
2929
[`redis-py`]({{< relref "/develop/clients/redis-py" >}}) client library if you
3030
haven't already done so.

‎content/develop/data-types/_index.md

+5-25
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ At its core, Redis provides a collection of native data types that help you solv
2323
Below is a short description of each data type, with links to broader overviews and command references.
2424
Each overview includes a comprehensive tutorial with code samples.
2525

26-
## Core data types
26+
## Data types
2727

28-
[Redis Community Edition]({{< relref "/operate/oss_and_stack" >}})
28+
[Redis Open Source]({{< relref "/operate/oss_and_stack" >}})
2929
implements the following data types:
3030

3131
- [String](#strings)
@@ -38,12 +38,9 @@ implements the following data types:
3838
- [Bitmap](#bitmaps)
3939
- [Bitfield](#bitfields)
4040
- [Geospatial](#geospatial-indexes)
41-
42-
[Redis Community Edition]({{< relref "/operate/oss_and_stack" >}}) and
43-
[Redis Enterprise]({{< relref "/operate/rs" >}})
44-
also include some [extension modules](#adding-extensions) that implement other
45-
useful types, such as JSON. See [Extension data types](#extension-data-types)
46-
for the full list.
41+
- [JSON](#json)
42+
- [Probabilistic data types](#probabilistic-data-types)
43+
- [Time series](#time-series)
4744

4845
### Strings
4946

@@ -129,22 +126,6 @@ For more information, see:
129126
* [Overview of Redis bitfields]({{< relref "/develop/data-types/bitfields" >}})
130127
* The [`BITFIELD`]({{< relref "/commands/bitfield" >}}) command.
131128

132-
## Extension data types
133-
134-
[Redis Community Edition]({{< relref "/operate/oss_and_stack" >}}) and
135-
[Redis Enterprise]({{< relref "/operate/rs" >}})
136-
include some [extension modules](#adding-extensions) that implement
137-
the following data types:
138-
139-
- [JSON](#json)
140-
- [Probabilistic data types](#probabilistic-data-types)
141-
- [Time series](#time-series)
142-
143-
These are not included by default with
144-
[Redis Community Edition]({{< relref "/operate/oss_and_stack" >}}).
145-
See [Core data types](#core-data-types) for the list of types that
146-
Redis Community Edition supports natively.
147-
148129
### JSON
149130

150131
[Redis JSON]({{< relref "/develop/data-types/json" >}}) provides
@@ -238,4 +219,3 @@ To extend the features provided by the included data types, use one of these opt
238219

239220
1. Write your own custom [server-side functions in Lua]({{< relref "/develop/interact/programmability/" >}}).
240221
1. Write your own Redis module using the [modules API]({{< relref "/develop/reference/modules/" >}}) or check out the [community-supported modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/" >}}).
241-
1. Use [JSON]({{< relref "/develop/data-types/json/" >}}), [search]({{< relref "/develop/interact/search-and-query/" >}}), [time series]({{< relref "/develop/data-types/timeseries/" >}}), and other capabilities provided by [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}}).

‎content/develop/data-types/hashes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ See the [complete list of hash commands]({{< relref "/commands/" >}}?group=hash)
100100

101101
## Field expiration
102102

103-
New in Redis Community Edition 7.4 is the ability to specify an expiration time or a time-to-live (TTL) value for individual hash fields.
103+
New in Redis Open Source 7.4 is the ability to specify an expiration time or a time-to-live (TTL) value for individual hash fields.
104104
This capability is comparable to [key expiration]({{< relref "/develop/use/keyspace#key-expiration" >}}) and includes a number of similar commands.
105105

106106
Use the following commands to set either an exact expiration time or a TTL value for specific fields:

0 commit comments

Comments
 (0)