Skip to content

Commit 0f01862

Browse files
rrelledgerrelledge
committed
Merge branch 'main' into DOC-4271 
2 parents 4435647 + 41a63d1 commit 0f01862

File tree

553 files changed

+9299
-2962
lines changed

Some content is hidden

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

553 files changed

+9299
-2962
lines changed

‎.github/workflows/redisvl_docs_sync.yaml‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ jobs:
6666
---
6767
linkTitle: ${linkTitle}
6868
title: ${title}
69-
type: integration
7069
EOL
7170
7271
# Inject weight property for index pages to preserve order
@@ -125,7 +124,7 @@ jobs:
125124
sed -E -i 's/^> *//g; s/\x1b\[[0-9;]*m//g' "${markdown_page}"
126125
127126
# Replace https://docs.redisvl.com links
128-
sed -E -i 's#https://docs.redisvl.com/en/latest/.+/([^_]+).+\.html(\#[^)]+)#{{< relref "\1\2" >}}#g; s#https://docs.redisvl.com/en/latest/(.+)\.html#https://redis.io/docs/latest/integrate/redisvl/\1#g' "${markdown_page}"
127+
sed -E -i 's#https://docs.redisvl.com/en/latest/.+/([^_]+).+\.html(\#[^)]+)#{{< relref "\1\2" >}}#g; s#https://docs.redisvl.com/en/latest/(.+)\.html#https://redis.io/docs/latest/develop/ai/redisvl/\1#g' "${markdown_page}"
129128
done
130129
131130
# Fix links in api pages
@@ -236,7 +235,7 @@ jobs:
236235
fi
237236
done
238237
239-
cp -r redis_vl_hugo/* content/integrate/redisvl/
238+
cp -r redis_vl_hugo/* content/develop/ai/redisvl/
240239
241240
- name: 'Create pull request if necessary'
242241
env:
@@ -262,12 +261,12 @@ jobs:
262261
git checkout -b "${branch}"
263262
fi
264263
265-
redisvl_is_different=$(git diff content/integrate/redisvl/)
264+
redisvl_is_different=$(git diff content/develop/ai/redisvl/)
266265
267266
if [[ ! -z $redisvl_is_different ]]; then
268267
redisvl_change=true
269268
270-
git add "content/integrate/redisvl/"
269+
git add "content/develop/ai/redisvl/"
271270
git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
272271
git config user.name "redisdocsapp[bot]"
273272
git commit -m "Update for redisvl ${release}"

‎assets/css/index.css‎

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,61 @@ section.prose {
2323
@apply font-geist
2424
}
2525

26-
.prose h1,
27-
.prose h3,
28-
.prose h4,
29-
.prose h5,
30-
.prose h6 {
31-
@apply font-normal;
26+
.prose h1 {
27+
@apply text-4xl font-normal break-words;
3228
}
3329

3430
.prose h2 {
35-
@apply text-lg font-medium pb-3 border-b border-b-redis-pen-700 border-opacity-50;
31+
@apply text-2xl font-medium pb-3 border-b border-b-redis-pen-700 border-opacity-50;
32+
}
33+
34+
.prose h3 {
35+
@apply text-xl font-semibold;
36+
}
37+
38+
.prose h4 {
39+
@apply text-lg font-medium;
40+
}
41+
42+
.prose h5 {
43+
@apply text-base font-medium;
44+
}
45+
46+
.prose h6 {
47+
@apply text-sm font-medium;
48+
}
49+
50+
/* Header link styles */
51+
.header-link {
52+
@apply text-slate-400 hover:text-slate-600 transition-all duration-200 no-underline cursor-pointer;
53+
text-decoration: none !important;
54+
vertical-align: baseline;
55+
}
56+
57+
.header-link:hover {
58+
@apply text-slate-600;
59+
text-decoration: none !important;
60+
}
61+
62+
.header-link svg {
63+
@apply w-4 h-4 inline-block;
64+
vertical-align: baseline;
65+
}
66+
67+
/* Ensure header links don't interfere with prose styling */
68+
.prose h1 .header-link,
69+
.prose h2 .header-link,
70+
.prose h3 .header-link,
71+
.prose h4 .header-link,
72+
.prose h5 .header-link,
73+
.prose h6 .header-link {
74+
@apply text-slate-400 hover:text-slate-600;
75+
text-decoration: none !important;
76+
}
77+
78+
/* Feedback state for copied links */
79+
.header-link.copied {
80+
@apply text-green-500;
3681
}
3782

3883
.prose p, .prose ol, .prose ul {
@@ -47,10 +92,6 @@ section.prose {
4792
@apply bg-none font-monogeist;
4893
}
4994

50-
.prose h1 {
51-
@apply text-4xl break-words;
52-
}
53-
5495
.prose h1[id],
5596
.prose h2[id],
5697
.prose h3[id],
@@ -382,7 +423,7 @@ select {
382423

383424
.codetabs.cli > .panel .highlight > .chroma {
384425
margin: 1rem 1rem 0.1rem 0.1rem;
385-
overflow-x: hidden;
426+
overflow-x: auto;
386427
padding-bottom: 0;
387428
}
388429

‎config.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ rdi_redis_gears_version = "1.2.6"
5555
rdi_debezium_server_version = "2.3.0.Final"
5656
rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
5757
rdi_cli_latest = "latest"
58-
rdi_current_version = "1.10.0"
58+
rdi_current_version = "1.12.2"
5959

6060
[params.clientsConfig]
6161
"Python"={quickstartSlug="redis-py"}

‎content/apis/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ The existing Redis commands cover most use cases, but if low latency is a critic
2626

2727
Lua scripts have been available since early versions of Redis. With Lua, the script is provided by the client and cached on the server side, which implies the risk that different clients might use a different script version.
2828

29-
- [Redis Lua API reference]({{< relref "/develop/interact/programmability/lua-api" >}})
30-
- [Scripting with Lua introduction]({{< relref "/develop/interact/programmability/eval-intro" >}})
29+
- [Redis Lua API reference]({{< relref "/develop/programmability/lua-api" >}})
30+
- [Scripting with Lua introduction]({{< relref "/develop/programmability/eval-intro" >}})
3131

3232
The Redis functions feature, which became available in Redis 7, supersedes the use of Lua in prior versions of Redis. The client is still responsible for invoking the execution, but unlike the previous Lua scripts, functions can now be replicated and persisted.
3333

34-
- [Functions and scripting in Redis 7 and beyond]({{< relref "/develop/interact/programmability/functions-intro" >}})
34+
- [Functions and scripting in Redis 7 and beyond]({{< relref "/develop/programmability/functions-intro" >}})
3535

3636
If none of the previous methods fulfills your needs, then you can extend the functionality of Redis with new commands using the Redis Modules API.
3737

‎content/commands/bf.add.md‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,6 @@ If `key` does not exist - a new Bloom filter is created with default error rate,
4949
is an item to add.
5050
</details>
5151

52-
## Return value
53-
54-
Returns one of these replies:
55-
56-
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) - where "1" means that the item has been added successfully, and "0" means that such item was already added to the filter (which could be wrong)
57-
- [] on error (invalid arguments, wrong key type, etc.) and also when the filter is full
58-
5952
## Examples
6053

6154
{{< highlight bash >}}
@@ -64,3 +57,21 @@ redis> BF.ADD bf item1
6457
redis> BF.ADD bf item1
6558
(integer) 0
6659
{{< / highlight >}}
60+
61+
## Return information
62+
63+
{{< multitabs id="bf-add-return-info"
64+
tab1="RESP2"
65+
tab2="RESP3" >}}
66+
67+
One of the following:
68+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): `1` for successfully adding an item, or `0` if there's a probability that the item was already added to the filter.
69+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the filter is full.
70+
71+
-tab-sep-
72+
73+
One of the following:
74+
* [Boolean reply]({{< relref "/develop/reference/protocol-spec#booleans" >}}): `true` for successfully adding an item, or `false` if there's a probability that the item was already added to the filter.
75+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the filter is full.
76+
77+
{{< /multitabs >}}

‎content/commands/bf.card.md‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,6 @@ is key name for a Bloom filter.
4141

4242
</details>
4343

44-
## Return value
45-
46-
Returns one of these replies:
47-
48-
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) - the number of items that were added to this Bloom filter and detected as unique (items that caused at least one bit to be set in at least one sub-filter), or 0 when `key` does not exist.
49-
- [] on error (invalid arguments, wrong key type, etc.)
50-
51-
Note: when `key` exists - return the same value as `BF.INFO key ITEMS`.
52-
5344
## Examples
5445

5546
{{< highlight bash >}}
@@ -60,3 +51,24 @@ redis> BF.CARD bf1
6051
redis> BF.CARD bf_new
6152
(integer) 0
6253
{{< / highlight >}}
54+
55+
## Return information
56+
57+
{{< multitabs id="bf-card-return-info"
58+
tab1="RESP2"
59+
tab2="RESP3" >}}
60+
61+
One of the following:
62+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the number of items detected as unique that were added to the Bloom filter (items that caused at least one bit to be set in at least one sub-filter), or `0` when the given `key` does not exist.
63+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the filter is full.
64+
65+
Note: when `key` exists, `BF.CARD` returns the same value as `BF.INFO key ITEMS`.
66+
67+
-tab-sep-
68+
69+
One of the following:
70+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the number of items detected as unique that were added to the Bloom filter (items that caused at least one bit to be set in at least one sub-filter), or `0` when the given `key` does not exist.
71+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the filter is full.
72+
73+
Note: when `key` exists, `BF.CARD` returns the same value as `BF.INFO key ITEMS`.
74+
{{< /multitabs >}}

‎content/commands/bf.exists.md‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,6 @@ is key name for a Bloom filter.
4848
is an item to check.
4949
</details>
5050

51-
## Return value
52-
53-
Returns one of these replies:
54-
55-
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}), where `1` means that, with high probability, `item` was already added to the filter, and `0` means that `key` does not exist or that `item` had not been added to the filter.
56-
- [] on error (invalid arguments, wrong key type, etc.)
57-
5851
## Examples
5952

6053
{{< highlight bash >}}
@@ -65,3 +58,21 @@ redis> BF.EXISTS bf item1
6558
redis> BF.EXISTS bf item2
6659
(integer) 0
6760
{{< / highlight >}}
61+
62+
## Return information
63+
64+
{{< multitabs id="bf-exists-return-info"
65+
tab1="RESP2"
66+
tab2="RESP3" >}}
67+
68+
One of the following:
69+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): `1` means that, with high probability, `item` was already added to the filter, and `0` means that either the `key` does not exist or that the `item` had not been added to the filter.
70+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if invalid arguments are passed.
71+
72+
-tab-sep-
73+
74+
One of the following:
75+
* [Boolean reply]({{< relref "/develop/reference/protocol-spec#booleans" >}}): `true` means that, with high probability, `item` was already added to the filter, and `false` means that either `key` does not exist or that `item` had not been added to the filter.
76+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) if invalid arguments are passed or `key` is not of the correct type.
77+
78+
{{< /multitabs >}}

‎content/commands/bf.info.md‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -84,20 +84,6 @@ Return the number of items that were added to this Bloom filter and detected as
8484
Return the expansion rate.
8585
</details>
8686

87-
When no optional argument is specified: return all information fields.
88-
89-
## Return value
90-
91-
When no optional argument is specified, returns one of these replies:
92-
93-
- [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with argument name ([Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}})) and value ([Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}})) pairs
94-
- [] on error (invalid arguments, key does not exist, wrong key type, and so on)
95-
96-
When an optional argument is specified, returns one of these replies:
97-
98-
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) - argument value
99-
- [] on error (invalid arguments, key does not exist, wrong key type, and so on)
100-
10187
## Examples
10288

10389
{{< highlight bash >}}
@@ -117,3 +103,21 @@ redis> BF.INFO bf1
117103
redis> BF.INFO bf1 CAPACITY
118104
1) (integer) 100
119105
{{< / highlight >}}
106+
107+
## Return information
108+
109+
{{< multitabs id="bf-info-return-info"
110+
tab1="RESP2"
111+
tab2="RESP3" >}}
112+
113+
One of the following:
114+
* [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with argument name ([Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}})) and value ([Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}})) pairs.
115+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the key does not exist.
116+
117+
-tab-sep-
118+
119+
One of the following:
120+
* [Map reply]({{< relref "/develop/reference/protocol-spec#maps" >}}) with argument name ([Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}})) and value ([Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}})) pairs.
121+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when the key does not exist.
122+
123+
{{< /multitabs >}}

‎content/commands/bf.insert.md‎

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -118,15 +118,6 @@ If the number of elements to be stored in the filter is unknown, use an `expansi
118118
Otherwise, use an `expansion` of `1` to reduce memory consumption. The default value is `2`.
119119
</details>
120120

121-
## Return value
122-
123-
Returns one of these replies:
124-
125-
- [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) where each element is one of these options:
126-
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}), where `1` denotes that the item has been added successfully, and `0` means that such item had already added to the filter (which could be wrong)
127-
- [] when the item cannot be added because the filter is full
128-
- [], for example, when the number of arguments or key type is wrong, and also when `NOCREATE` is specified and `key` does not exist.
129-
130121
## Examples
131122

132123
Add three items to a filter, then create the filter with default parameters if it does not already exist.
@@ -146,3 +137,25 @@ Add two items to a filter, then return error if the filter does not already exis
146137
{{< highlight bash >}}
147138
BF.INSERT filter NOCREATE ITEMS foo bar
148139
{{< / highlight >}}
140+
141+
## Return information
142+
143+
{{< multitabs id="bf-insert-return-info"
144+
tab1="RESP2"
145+
tab2="RESP3" >}}
146+
147+
One of the following: where each element is one of these options:
148+
* [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}), where each element is one of the following options:
149+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) `1` for successfully adding an item, or `0` if there's a probability that the item was already added to the filter.
150+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings">}}) when the item cannot be added because the filter is full.
151+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors">}}) when the number of arguments or key type is wrong, and also when `NOCREATE` is specified and `key` does not exist.
152+
153+
-tab-sep-
154+
155+
One of the following: where each element is one of these options:
156+
* [Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}), where each element is one of the following options:
157+
* [Boolean reply]({{< relref "/develop/reference/protocol-spec#booleans" >}}) `true` for successfully adding an item, or `false` if there's a probability that the item was already added to the filter.
158+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings">}}) when the item cannot be added because the filter is full.
159+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors">}}) when the number of arguments or key type is wrong, and also when `NOCREATE` is specified and `key` does not exist.
160+
161+
{{< /multitabs >}}

‎content/commands/bf.loadchunk.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,24 @@ Iterator value associated with `data` (returned by [`BF.SCANDUMP`]({{< relref "c
6161
Current data chunk (returned by [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}))
6262
</details>
6363

64-
## Return value
64+
## Examples
6565

66-
Returns one of these replies:
66+
See [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}) for an example.
6767

68-
- [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly
69-
- [] on error (invalid arguments, wrong key type, wrong data, etc.)
68+
## Return information
7069

71-
## Examples
70+
{{< multitabs id="bf-loadchunk-return-info"
71+
tab1="RESP2"
72+
tab2="RESP3" >}}
7273

73-
See [`BF.SCANDUMP`]({{< relref "commands/bf.scandump/" >}}) for an example.
74+
One of the following:
75+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
76+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when invalid data was passed.
77+
78+
-tab-sep-
79+
80+
One of the following:
81+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if executed correctly.
82+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when invalid data was passed.
83+
84+
{{< /multitabs >}}

0 commit comments

Comments
 (0)