Skip to content

Commit 5006b5d

Browse files
committed
Merge branch 'main' into DOC-4639
2 parents 3861233 + 74c6e9b commit 5006b5d

File tree

64 files changed

+14578
-307
lines changed

Some content is hidden

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

64 files changed

+14578
-307
lines changed

.github/workflows/rc_api_sync.yaml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: rc_api_sync
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 * * *' # run every day at midnight UTC time
6+
workflow_dispatch: # or run on manual trigger
7+
8+
jobs:
9+
rc_api_sync:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write
13+
pull-requests: write
14+
actions: write
15+
steps:
16+
- name: 'Checkout'
17+
uses: 'actions/checkout@v3'
18+
19+
- name: 'Fetch openapi json file'
20+
env:
21+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22+
run: |
23+
branch="rc_api_sync"
24+
spec_change=false
25+
26+
# check if remote branch already exists
27+
git fetch --all
28+
set +e
29+
git ls-remote --exit-code --heads origin "refs/heads/${branch}"
30+
if [ "$?" -eq 0 ]; then
31+
set -e
32+
# if it does, create local branch off existing remote branch
33+
git checkout -b "${branch}" "origin/${branch}"
34+
git branch --set-upstream-to="origin/${branch}" "${branch}"
35+
git pull
36+
else
37+
set -e
38+
# otherwise, create local branch from main
39+
git checkout -b "${branch}"
40+
fi
41+
42+
curl -Ls https://api.redislabs.com/v1/cloud-api-docs \
43+
| jq '(.. | .example? | try select(test("^{"))) |= fromjson' > content/operate/rc/api/api-reference/openapi.json
44+
45+
spec_is_different=$(git diff content/operate/rc/api/api-reference/openapi.json)
46+
47+
if [[ ! -z $spec_is_different ]]; then
48+
spec_change=true
49+
50+
git add "content/operate/rc/api/api-reference/openapi.json"
51+
git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
52+
git config user.name "redisdocsapp[bot]"
53+
git commit -m "Update content/operate/rc/api/api-reference/openapi.json"
54+
fi
55+
56+
if [ "$spec_change" = true ] ; then
57+
git push origin "${branch}"
58+
59+
# If a pr is not already open, create one
60+
set +e
61+
gh search prs -R redis/docs --state open --match title "update rc openapi spec" | grep -q "update rc openapi spec"
62+
if [ "$?" -eq 1 ]; then
63+
set -e
64+
gh pr create \
65+
--body "update rc openapi spec" \
66+
--title "update rc openapi spec" \
67+
--head "$branch" \
68+
--base "main"
69+
fi
70+
fi

content/apis/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Redis Cloud is a fully managed Database as a Service offering and the fastest wa
4545

4646
- [Redis Cloud REST API introduction]({{< relref "/operate/rc/api/" >}})
4747
- [Redis Cloud REST API examples]({{< relref "/operate/rc/api/examples/" >}})
48-
- [Redis Cloud REST API reference](https://api.redislabs.com/v1/swagger-ui.html)
48+
- [Redis Cloud REST API reference]({{< relref "/operate/rc/api/api-reference" >}})
4949

5050

5151
### Redis Enterprise Software API

content/commands/bitpos/index.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -104,16 +104,25 @@ Non-existent keys are treated as empty strings.
104104

105105
## Examples
106106

107-
{{% redis-cli %}}
108-
SET mykey "\xff\xf0\x00"
109-
BITPOS mykey 0
110-
SET mykey "\x00\xff\xf0"
111-
BITPOS mykey 1 0
112-
BITPOS mykey 1 2
113-
BITPOS mykey 1 2 -1 BYTE
114-
BITPOS mykey 1 7 15 BIT
115-
set mykey "\x00\x00\x00"
116-
BITPOS mykey 1
117-
BITPOS mykey 1 7 -3 BIT
118-
{{% /redis-cli %}}
119-
107+
```redis
108+
redis> SET mykey "\xff\xf0\x00"
109+
OK
110+
redis> BITPOS mykey 0
111+
(integer) 12
112+
redis> SET mykey "\x00\xff\xf0"
113+
OK
114+
redis> BITPOS mykey 1 0
115+
(integer) 8
116+
redis> BITPOS mykey 1 2
117+
(integer) 16
118+
redis> BITPOS mykey 1 2 -1 BYTE
119+
(integer) 16
120+
redis> BITPOS mykey 1 7 15 BIT
121+
(integer) 8
122+
redis> set mykey "\x00\x00\x00"
123+
OK
124+
redis> BITPOS mykey 1
125+
(integer) -1
126+
redis> BITPOS mykey 1 7 -3 BIT
127+
(integer) -1
128+
```

content/commands/client-list/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ Here is the meaning of the fields:
114114
* `user`: the authenticated username of the client
115115
* `redir`: client id of current client tracking redirection
116116
* `resp`: client RESP protocol version. Added in Redis 7.0
117+
* `rbp`: peak size of the client's read buffer since the client connected. Added in Redis 7.0
118+
* `rbs`: current size of the client's read buffer in bytes. Added in Redis 7.0
117119

118120
The client flags can be a combination of:
119121

content/commands/latency-histogram/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ Each histogram consists of the following fields:
5454
* Each bucket represents a latency range
5555
* Each bucket covers twice the previous bucket's range
5656
* Empty buckets are excluded from the reply
57-
* The tracked latencies are between 1 microsecond and roughly 1 second
57+
* The tracked latencies are between 1 nanosecond and roughly 1 second
5858
* Everything above 1 second is considered +Inf
59-
* At max, there will be log2(1,000,000,000)=30 buckets
59+
* At max, there will be log2(1,000,000,000) = 30 buckets
6060

6161
This command requires the extended latency monitoring feature to be enabled, which is the default.
6262
If you need to enable it, call `CONFIG SET latency-tracking yes`.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
Title: Redis Insight v2.64.0, December 2024
3+
linkTitle: v2.64.0 (December 2024)
4+
date: 2024-12-19 00:00:00 +0000
5+
description: Redis Insight v2.64
6+
weight: 1
7+
8+
---
9+
## 2.64 (December 2024)
10+
This is the General Availability (GA) release of Redis Insight 2.64.
11+
12+
### Highlights
13+
- Improved the database connections list and simplified the connection form, delivering a cleaner, more intuitive UI for improved focus.
14+
- New in-app reminders to prevent your free Redis Cloud database from being deleted due to inactivity, ensuring you can make the most of it to test your ideas.
15+
16+
### Details
17+
18+
**Features and improvements**
19+
- [#4088](https://github.com/RedisInsight/RedisInsight/pull/4088), [#4078](https://github.com/RedisInsight/RedisInsight/pull/4078), [#4094](https://github.com/RedisInsight/RedisInsight/pull/4094) Improved the database connections list and simplified the connection form, delivering a cleaner, more intuitive UI for improved focus.
20+
- [#4189](https://github.com/RedisInsight/RedisInsight/pull/4189), [#4191](https://github.com/RedisInsight/RedisInsight/pull/4191) New in-app reminders notify you before your free Redis Cloud database is deleted due to inactivity, ensuring you can make the most of it to test your ideas.
21+
- [#4204](https://github.com/RedisInsight/RedisInsight/pull/4204), [#4196](https://github.com/RedisInsight/RedisInsight/pull/4196), [#4202](https://github.com/RedisInsight/RedisInsight/pull/4202) Various vulnerabilities have been fixed.
22+
23+
**Bugs**
24+
- [#4194](https://github.com/RedisInsight/RedisInsight/pull/4194) Resolved an [issue](https://github.com/RedisInsight/RedisInsight/issues/4186) where modifying a JSON value inadvertently converted strings into numbers.
25+
26+
**SHA-256 Checksums**
27+
| Package | SHA-256 |
28+
|--|--|
29+
| Windows | iYZbKsFtz/Ua4qeBdeHIRtZRiA1I50R3yY1t3VUD2cn94EpZLR5Xz3lK3yRxA85PxJaHjrWljyGliZv0OX0KBg== |
30+
| Linux AppImage | ToEFW8wVLI8oFoc/puzf2Cwoff8gBTsIxEsGjQRZq5D5BgrE3muxtuEQto3J2RiRbadGAZx6AZPh75WVJ0DKRw== |
31+
| Linux Debian| /k6jgfzDSRJ0yWmbtxpD5WG2i9wGUZ4r2AexDz6rUOLyZMqQPJUKEKuonprFvHZp+PUW/EtSWc436IFykBVmsQ== |
32+
| MacOS Intel | PrbRc+ju0UKxr4huP7Xl9Sq0fH0XaxUtydW86rAYepEAADUADsAYV2lB8gO7Ohs9ukJ7mXBEU7OJWRqJGLhxHg== |
33+
| MacOS Apple silicon | E6kTbnkoW3eji/v7WVrnwqlEKk444+hxiFqt56r8J+zAHhmX9dlNd7y37xdJlQ82FZ9QOIIMsN5Z0N+bgRisuw== |
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
Title: Redis for VS Code v1.2.0, December 2024
3+
linkTitle: v1.2.0 (December 2024)
4+
date: 2024-12-19 00:00:00 +0000
5+
description: Redis for VS Code v1.2
6+
weight: 99
7+
---
8+
9+
## 1.2.0 (December 2024)
10+
11+
This is the General Availability (GA) release of Redis for VS Code 1.2.
12+
13+
### Headlines
14+
* Work with keys across multiple database indexes, which are automatically discovered and displayed in the database list.
15+
* Support for adding multiple elements to the head or tail of Redis lists, for both new and existing keys.
16+
* Auto-refresh the list of keys and key values with a customizable timer.
17+
* Delete and update previously added CA and client certificates to keep them updated.
18+
19+
### Details
20+
21+
- [#223](https://github.com/RedisInsight/Redis-for-VS-Code/pull/223) Work with keys across multiple database indexes. Database indexes with keys are automatically discovered and displayed in the database list.
22+
- [#207](https://github.com/RedisInsight/Redis-for-VS-Code/pull/207) Support for adding multiple elements to the head or tail of Redis lists for new and existing key.
23+
- [#226](https://github.com/RedisInsight/Redis-for-VS-Code/pull/226) Auto-refresh the list of keys and key values with a customizable timer. To do so, enable the Auto-refresh mode by clicking the control next to the Refresh button and setting the refresh rate.
24+
- [#224](https://github.com/RedisInsight/Redis-for-VS-Code/pull/224) Ability to delete previously added CA and Client certificates to keep them up-to-date.
25+
- [#224](https://github.com/RedisInsight/Redis-for-VS-Code/pull/224) Enhanced both the Java and PHP serialized formatters: the Java formatter now supports date and time data, while the PHP formatter includes UTF-8 encoding for better handling of special characters and multi-language data.
26+
- [#224](https://github.com/RedisInsight/Redis-for-VS-Code/pull/224) Keep databases and the list of keys [expanded](https://github.com/RedisInsight/Redis-for-VS-Code/issues/217) after navigating away.
27+
- [#226](https://github.com/RedisInsight/Redis-for-VS-Code/pull/226) New users can optionally encrypt sensitive data, such as connection certificates and passwords. Existing users can enable encryption by deleting the ~/.redis-for-vscode/redisinsight.db file and re-adding their database connections.
28+
29+
**Bugs**
30+
- [#224](https://github.com/RedisInsight/Redis-for-VS-Code/pull/224) Resolved an issue where large integers in JSON keys were being rounded, ensuring data integrity.
31+
- [#224](https://github.com/RedisInsight/Redis-for-VS-Code/pull/224) Saved SNI and SSH connection information for newly added database connections.
32+
- [#224](https://github.com/RedisInsight/Redis-for-VS-Code/pull/224) Fixed an issue to display multiple hash fields when expanding a hash value.
33+
34+
### Get started with Redis for VS Code
35+
Install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=redis.redis-for-vscode) to use it.

content/develop/use/patterns/distributed-locks.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ already available that can be used for reference.
5656
* [ScarletLock](https://github.com/psibernetic/scarletlock) (C# .NET implementation with configurable datastore).
5757
* [Redlock4Net](https://github.com/LiZhenNet/Redlock4Net) (C# .NET implementation).
5858
* [node-redlock](https://github.com/mike-marcacci/node-redlock) (NodeJS implementation). Includes support for lock extension.
59-
* [simple-redis-mutex](https://github.com/AmrSaber/simple-redis-mutex) (Node.js implementation) Available as an [NPM package](https://www.npmjs.com/package/simple-redis-mutex).
6059
* [Deno DLM](https://github.com/oslabs-beta/Deno-Redlock) (Deno implementation)
6160
* [Rslock](https://github.com/hexcowboy/rslock) (Rust implementation). Includes async and lock extension support.
6261

content/embeds/rc-create-db-first-steps.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,4 @@ To create a database in your Redis Cloud account:
88

99
{{<image filename="images/rc/button-database-new.png" alt="The New Database button creates a new database." width="120px">}}
1010

11-
This displays the **Create database** screen.
12-
13-
3. Select your Redis use case. There are four pre-defined use cases:
14-
15-
{{<image filename="images/rc/create-database-redis-use-cases.png" alt="The Redis Use case panel">}}
16-
17-
- **Cache**: Stores short-term or volatile data. Can be used for session management, semantic cache, session store, and other uses where data is short-lived.
18-
- **Database**: Stores durable and consistent data. Can be used for document databases, feature storage, gaming leaderboards, durable caches, and other uses where your data needs to be highly available and persistent.
19-
- **Vector search**: Manages and manipulates vector data. Can be used for Generative AI, recommendation systems, visual search, and other uses where you can search and query your data.
20-
- **Custom**: If your Redis use case doesn't match any of the other use cases, you can choose this option to customize all of your settings.
21-
22-
Select the use case that best matches your Redis use case. You can always change the settings later.
11+
This displays the **Create database** screen.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
3. Select your Redis use case. There are four pre-defined use cases:
2+
3+
{{<image filename="images/rc/create-database-redis-use-cases.png" alt="The Redis Use case panel">}}
4+
5+
- **Cache**: Stores short-term or volatile data. Can be used for session management, semantic cache, session store, and other uses where data is short-lived.
6+
- **Database**: Stores durable and consistent data. Can be used for document databases, feature storage, gaming leaderboards, durable caches, and other uses where your data needs to be highly available and persistent.
7+
- **Vector search**: Manages and manipulates vector data. Can be used for Generative AI, recommendation systems, visual search, and other uses where you can search and query your data.
8+
- **Custom**: If your Redis use case doesn't match any of the other use cases, you can choose this option to customize all of your settings.
9+
10+
Select the use case that best matches your Redis use case. You can always change the settings later.

0 commit comments

Comments
 (0)