Skip to content

Commit 2378309

Browse files
committed
Merge branch 'main' into release-rs-fuya-fuya-minor
2 parents 6176293 + 97bb16a commit 2378309

File tree

10 files changed

+286
-177
lines changed

10 files changed

+286
-177
lines changed
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/operate/rc/api/_index.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,9 @@ You can use the API to:
3333

3434
1. [Manage subscriptions]({{< relref "/operate/rc/api/examples/manage-subscriptions.md" >}})
3535
1. Database examples
36-
- [Create database]({{< relref "/operate/rc/api/examples/create-database" >}})
37-
- [Update database]({{< relref "/operate/rc/api/examples/update-database.md" >}})
36+
- [Create and manage databases]({{< relref "/operate/rc/api/examples/create-database" >}})
3837
- [Back up and import data]({{< relref "/operate/rc/api/examples/back-up-and-import-data.md" >}})
39-
1. [Manage cloud accounts]({{< relref "/operate/rc/api/examples/manage-cloud-accounts.md" >}})
4038
1. [Estimate costs]({{< relref "/operate/rc/api/examples/dryrun-cost-estimates.md" >}})
41-
1. [View account info]({{< relref "/operate/rc/api/examples/view-account-information.md" >}})
4239

4340
## More info
4441

content/operate/rc/api/examples/create-database.md

Lines changed: 56 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,79 @@ categories:
55
- docs
66
- operate
77
- rc
8-
description: This article describes how to create and manage a database using `cURL`
9-
commands.
10-
linkTitle: Create databases
8+
description: This article describes how to create and manage a database using the Redis Cloud API.
9+
linkTitle: Create and manage databases
1110
weight: 20
1211
---
1312

14-
You can use the Redis Cloud REST API to create databases.
13+
You can use the Redis Cloud REST API to create and manage databases.
1514

16-
These examples use the [`cURL` utility]({{< relref "/operate/rc/api/get-started/use-rest-api#use-the-curl-http-client" >}}). You can use any REST client to work with the Redis Cloud REST API. The examples in this article refer to Redis Cloud Pro databases.
15+
## Redis Cloud Essentials
1716

18-
## Create a database
17+
### Create an Essentials database
1918

20-
To create a database, use `POST /subscriptions/{subscription-id}/databases`
19+
To create a Redis Cloud Essentials database, use [`POST /fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}).
2120

22-
The database is created in an existing or a newly created subscription.
21+
This call creates a database in the specified subscription. Use [`GET /fixed/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllSubscriptions_1" >}}) to get a list of Essentials subscriptions and their IDs.
2322

24-
When a subscription is created, it is created with at least one database.
23+
```shell
24+
POST "https://[host]/v1/fixed/subscriptions/{subscriptionId}/databases"
25+
{
26+
"name": "Basic-essentials-database-example"
27+
}
28+
```
29+
30+
This example JSON body contains only the most basic, required parameters to create a database:
31+
32+
- `name`: The database name. A unique name per subscription that can contain only alphanumeric characters and hyphens
33+
34+
There are other additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}).
35+
36+
Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports.
37+
38+
The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
39+
40+
### Update an Essentials database
2541

26-
You can add databases to the subscription; you can also update or delete existing databases.
42+
To update a Redis Cloud Essentials database, use [`PUT /fixed/subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/deleteFixedDatabaseByID" >}}).
2743

28-
Creating a database is an [asynchronous operation]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}).
44+
The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/deleteFixedDatabaseByID" >}}).
2945

30-
The following API call creates a database.
46+
Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports.
47+
48+
The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
49+
50+
## Redis Cloud Pro
51+
52+
### Create a Pro database
53+
54+
If you want to create a Pro database in a new subscription, see [Create a Pro subscription]({{< relref "/operate/rc/api/examples/manage-subscriptions#create-a-pro-subscription" >}}).
55+
56+
To create a Redis Cloud Pro database in an existing subscription, use [`POST /subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}).
57+
58+
This call creates a database in the specified subscription. Use [`GET /subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/getAllSubscriptions" >}}) to get a list of subscriptions and their IDs.
3159

3260
```shell
33-
POST "https://[host]/v1/subscriptions/$SUBSCRIPTION_ID/databases"
61+
POST "https://[host]/v1/subscriptions/{subscriptionId}/databases"
3462
{
35-
"name": "Database-example-basic",
36-
"memoryLimitInGb": 10,
37-
"password": "P@ssw0rd"
63+
"name": "Basic-database-example",
64+
"datasetSizeInGb": 1
3865
}
3966
```
4067

41-
The JSON body contains only the most basic, required parameters in order to create a database:
68+
This example JSON body contains only the most basic, required parameters to create a database:
69+
70+
- `name`: The database name. A unique name per subscription that can contain only alphanumeric characters and hyphens
71+
- `datasetSizeInGb`: Maximum dataset size in GB
72+
73+
There are many additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}).
74+
75+
The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
76+
77+
### Update a Redis Cloud Pro database
4278

43-
- Database name - A unique name per subscription that can contain only alphanumeric characters and hyphens
44-
- Maximum database size in GB
45-
- Database password
79+
To update a Redis Cloud Pro database, use [`PUT /subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/updateDatabase" >}}).
4680

47-
### Additional database parameters
81+
The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/updateDatabase" >}}).
4882

49-
There are many additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [Full API documentation]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}).
83+
The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.

content/operate/rc/api/examples/manage-cloud-accounts.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ description: Cloud accounts specify which account to use when creating and modif
99
infrastructure resources.
1010
linkTitle: Manage cloud accounts
1111
weight: 80
12+
draft: true
1213
---
14+
<!-- This article is removed since it was duplicated with the REST API reference. I decided to keep it as a draft just in case. -->
15+
1316
You can use the Redis Cloud REST API to create and manage cloud accounts.
1417

1518
These examples use the [`cURL` utility]({{< relref "/operate/rc/api/get-started/use-rest-api#use-the-curl-http-client" >}}); you can use any REST client to work with the Redis Cloud REST API.

0 commit comments

Comments
 (0)