Skip to content

Commit 6b517f4

Browse files
committed
added
1 parent b942ff2 commit 6b517f4

File tree

4 files changed

+88
-30
lines changed

4 files changed

+88
-30
lines changed

docs/create/redis-stack/index-redis-stack.mdx

+86-27
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: index-redis-stack
3-
title: Create a database using Redis Stack
3+
title: Introduction to Redis Stack
44
sidebar_label: Redis Stack
55
slug: /create/redis-stack
66
authors: [ajeet]
@@ -14,10 +14,10 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1414

1515
![redis stack](images/redis-stack.png)
1616

17-
Redis Stack is an extension of Redis that adds modern data models and processing engines to provide a complete developer experience.Redis Stack provides a simple and seamless way to access different data models such as full-text search, document store, graph, time series, and probabilistic data structures enabling developers to build any real-time data application.
17+
Redis Stack is an extension of Redis that adds modern data models and processing engines to provide a complete developer experience. Redis Stack provides a simple and seamless way to access different data models such as full-text search, document store, graph, time series, and probabilistic data structures enabling developers to build any real-time data application.
1818

1919

20-
### Redis OSS vs Redis Stack
20+
### Redis OSS vs. Redis Stack
2121

2222
In addition to all of the features of OSS Redis, Redis stack supports:
2323

@@ -38,7 +38,7 @@ Redis Stack is made up of several components, licensed as follows:
3838

3939
### Which client libraries support Redis Stack?
4040

41-
Redis Stack supports various client libraries. The following core client libraries support Redis Stack:
41+
The following core client libraries support Redis Stack:
4242

4343
- [Jedis](https://github.com/redis/jedis) >= 4.0
4444
- [node-redis](https://github.com/redis/node-redis) >= 4.0
@@ -58,8 +58,8 @@ The Redis OM client libraries let you use the document modeling, indexing, and q
5858
defaultValue="Redis Enterprise Cloud"
5959
values={[
6060
{label: 'Redis Enterprise Cloud', value: 'Redis Enterprise Cloud'},
61-
{label: 'Mac', value: 'Mac'},
6261
{label: 'Docker', value: 'Docker'},
62+
{label: 'Mac', value: 'Mac'},
6363
]}>
6464
<TabItem value="Redis Enterprise Cloud">
6565

@@ -79,27 +79,28 @@ For a limited time, use **TIGER200** to get **$200** credits on Redis Enterprise
7979

8080
### Step 2. Create Your database
8181

82-
Choose your preferred cloud vendor. Select the region and then click "Let's start free" to create your free database automatically.
82+
For the cloud provider, select your preferred cloud (for demo purpose).
83+
Select the region of your choice and then click "Let's start free".
8384

8485
:::info TIP
8586
If you want to create a custom database with your preferred name and type of redis,
86-
click "Create a custom database" option shown in the image.
87+
click "Create a custom database".
8788
:::
8889

8990
![create database ](images/select_cloud_vendor.png)
9091

9192

92-
### Step 3. Verify the database details
93+
### Step 3. Listing the database details
9394

94-
You will be provided with Public endpoint URL and "Redis Stack" as the type of database with the list of modules that comes by default.
95+
Once fully activated, you will see the database endpoints as shown below
9596

9697

9798

9899
![verify database](images/details_database.png)
99100

100101

101102

102-
### Step 4. Install RedisInsight
103+
### Step 4. Connecting to the database via RedisInsight
103104

104105
RedisInsight is a visual tool that lets you do both GUI- and CLI-based interactions with your Redis database, and so much more when developing your Redis based application. It is a fully-featured pure Desktop GUI client that provides capabilities to design, develop and optimize your Redis application. It works with any cloud provider as long as you run it on a host with network access to your cloud-based Redis server. It makes it easy to discover cloud databases and configure connection details with a single click. It allows you to automatically add Redis Enterprise Software and Redis Enterprise Cloud databases.
105106

@@ -119,7 +120,7 @@ You can install Redis Stack on your local system to get RedisInsight GUI tool up
119120
🍺 redis-stack was successfully installed!
120121
```
121122

122-
Go to Applications and click "RedisInsight Preview" to bring up the Redis Desktop GUI tool.
123+
You can easily find the Applications folder on your Mac with Finder. Search "RedisInsight Preview" and click the icon to bring up the Redis Desktop GUI tool.
123124

124125

125126

@@ -133,7 +134,7 @@ Go to Applications and click "RedisInsight Preview" to bring up the Redis Deskto
133134
Add the Redis Enterprise cloud database endpoint, port and password.
134135

135136

136-
![access redisinsight](images/database_creds.png)
137+
![access redisinsight](images/database_creDs.png)
137138

138139

139140
### Step 7. Verify the database under RedisInsight dashboard
@@ -146,7 +147,7 @@ Add the Redis Enterprise cloud database endpoint, port and password.
146147

147148
In this tutorial, we will go through an example of a bike shop. We will show the different capabilities of Redis Stack.
148149

149-
Choose "Redis Stack" in the left sidebar.
150+
Choose "Redis Stack" from the left sidebar menu.
150151

151152
![access json workbench](images/stack1.png)
152153

@@ -160,7 +161,7 @@ It will display JSON.SET command with model, brand, price, type, specs and descr
160161

161162
### Step 10. Accessing the part of stored JSON document
162163

163-
Click "Get specific fileds" to access a part of stored JSON document as shown in the following diagram:
164+
Click "Get specific fileds" to access a part of stored JSON document as shown in the following image:
164165

165166
![access json keys](images/stack3.png)
166167

@@ -170,13 +171,16 @@ Click "Get specific fileds" to access a part of stored JSON document as shown in
170171

171172
<TabItem value="Mac">
172173

173-
To install Redis Stack on macOS, use Homebrew. Make sure that you have Homebrew installed before starting on the installation instructions below.
174+
To install Redis Stack on macOS, use Homebrew. Follow the below set of instructions:
174175

175176

177+
### Step 1. Install Homebrew
176178

177-
Follow the quick step to setup Redis Stack on your Mac:
179+
```bash
180+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
181+
```
178182

179-
### Step 1. Install Redis Stack using Homebrew
183+
### Step 2. Install Redis Stack using Homebrew
180184

181185
First, tap the Redis Stack Homebrew tap and then run `brew install` as shown below:
182186

@@ -198,7 +202,7 @@ This will install all Redis and Redis Stack binaries. How you run these binaries
198202

199203
:::info TIP
200204

201-
If this is the first time you’ve installed Redis on your system, then all Redis Stack binaries be installed and accessible from the `$PATH`. On M1 Macs, this assumes that `/opt/homebrew/bin` is in your path. On Intel-based Macs, /usr/local/bin should be in the $PATH.
205+
If this is the first time you’ve installed Redis on your system, then all Redis Stack binaries will be installed and accessible from the `$PATH`. On M1 Macs, this assumes that `/opt/homebrew/bin` is in your path. On Intel-based Macs, /usr/local/bin should be in the $PATH.
202206

203207
To check this, run:
204208

@@ -236,19 +240,19 @@ Go to Applications and click "RedisInsight Preview" to bring up the Redis Deskto
236240

237241

238242

239-
### Step 2. Add Redis database
243+
### Step 3. Add Redis database
240244

241245
![access redisinsight](images/add_database.png)
242246

243-
### Step 3. Enter Redis database details
247+
### Step 4. Enter Redis database details
244248

245249
Add the local Redis database endpoint and port.
246250

247251

248252
![access redisinsight](images/testredis1.png)
249253

250254

251-
### Step 4. Redis for time series
255+
### Step 5. Redis for time series
252256

253257

254258
Redis Stack provides you with a native time series data structure. Let's see how a time series might be useful in our bike shop.
@@ -261,7 +265,7 @@ Click "Guides" icon(just below the key) in the left sidebar and choose "Redis fo
261265

262266
![redis for timeseries](images/testredis2.png)
263267

264-
### Step 5. Create time series per shop
268+
### Step 6. Create time series per shop
265269

266270

267271
```bash
@@ -277,11 +281,11 @@ Since the metrics are collected with a millisecond timestamp, we can compact our
277281

278282
![create time series per shop](images/testredis3.png)
279283

280-
### Step 6. Running the query
284+
### Step 7. Run the query
281285

282286
![execute the query](images/testredis4.png)
283287

284-
### Step 7. Time series compaction
288+
### Step 8. Time series Aggregations
285289

286290
RedisTimeSeries supports downsampling with the following aggregations: avg, sum, min, max, range, count, first and last. If you want to keep all of your raw data points indefinitely, your data set grows linearly over time. However, if your use case allows you to have less fine-grained data further back in time, downsampling can be applied. This allows you to keep fewer historical data points by aggregating raw data for a given time window using a given aggregation function.
287291

@@ -370,8 +374,63 @@ Here’s how to set a retention policy for RedisTimeSeries:
370374
371375
### Next Steps
372376
373-
- [Perform Database Search and Analytics using the RediSearch Plugin in RedisInsight v2.0](/explore/redisinsightv2/redisearch)
374-
- [Visualize Redis Database Keys using the RedisInsight Browser Tool](/explore/redisinsightv2/browser)
375-
- [RedisInsight Profiler Tool - Analyze Your Redis Commands Using Redis Monitor Command](/explore/redisinsightv2/profiler)
376377
377378
379+
<div class="row text--center">
380+
381+
<div class="col ">
382+
<div className="ri-container">
383+
384+
#### Storing and querying JSON documents
385+
386+
387+
[Follow this tutorial](/howtos/redisjson/getting-started) in order to store and query JSON documents using Redis Stack
388+
389+
390+
</div>
391+
</div>
392+
393+
<div class="col">
394+
<div className="ri-container">
395+
396+
#### Full-text search
397+
398+
399+
400+
401+
402+
Learn how to [perform full-text search](/howtos/redisearch/) using Redis Stack
403+
404+
</div>
405+
</div>
406+
</div>
407+
408+
409+
<div class="row text--center">
410+
411+
<div class="col ">
412+
<div className="ri-container">
413+
414+
#### Probabilistic data structure
415+
416+
417+
Follow this tutorial to learn [how to implement low latency and compact Probabilistic data structure](/howtos/redisbloom) using Redis Stack
418+
419+
420+
</div>
421+
</div>
422+
423+
<div class="col">
424+
<div className="ri-container">
425+
426+
#### Storing and querying time seris data
427+
428+
429+
430+
431+
432+
[Learn how to store and query time series data](/howtos/redistimeseries/getting-started) using Redis Stack
433+
434+
</div>
435+
</div>
436+
</div>

src/theme/Demos/index.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@ function Demos() {
2222
<h5 className="title">Getting started with Redis Stack</h5>
2323
<ul className="links">
2424
<li><a href="/create/redis-stack/">Introduction to Redis Stack</a></li>
25-
<li><a href="/create/rediscloud">Create Redis Stack database on Redis Enterprise Cloud</a></li>
2625
<li><a href="/howtos/redisjson/getting-started/">Storing and querying JSON documents</a></li>
27-
<li><a href="/howtos/redisearch/">Support for Full-text search</a></li>
26+
<li><a href="/howtos/redisearch/">Full-text search using Redis Stack</a></li>
2827
<li><a href="/howtos/redistimeseries/getting-started/">Storing and Querying Time Series data</a></li>
29-
<li><a href="/howtos/redisbloom/">Support for Probabilistic data structure</a></li>
28+
<li><a href="/howtos/redisbloom/">Probabilistic data structure using Redis Stack</a></li>
3029
</ul>
3130
</div>
3231
</div>

static/img/logos/redisearch.png

18 KB
Loading

static/img/logos/redisjson.png

3.82 KB
Loading

0 commit comments

Comments
 (0)