You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+56-46
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,8 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
10
10
11
11
1.[Structure](#structure)
12
12
2.[Examples](#examples)
13
-
3.[Advanced button parameters](#advanced)
14
13
3.[Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
14
+
4.[Advanced button parameters](#advanced)
15
15
16
16
## Structure
17
17
@@ -85,6 +85,61 @@ A Node can be represented by various UI components and is specified by `type` pr
85
85
> _**!Note.** All **"internal-link"** nodes located in the same **"group"** will be connected to each other. And using pagination (created dynamically) you can go directly from one page to another. Therefore, it is better to combine elements into groups related to the same topic._
86
86
87
87
88
+
## Bulk Upload From Tutorials
89
+
90
+
You can upload sample data sets in bulk from your custom RedisInsight tutorials.
91
+
To do so, you will need to:
92
+
- create a text file with the list of Redis commands
93
+
- add this file to the archive with your custom tutorials
94
+
- create a special `redis-upload` button described in this section to execute all the Redis commands from custom tutorials
95
+
96
+
This button works similarly to the Bulk Upload in Browser, so all the Redis commands specified in the file will be executed.
97
+
98
+
The following syntax describes the `redis-upload` button:
99
+
100
+
````
101
+
102
+
```redis-upload:[{relative_path_to_the_text_file}] Upload data
103
+
```
104
+
105
+
````
106
+
**Notes:**
107
+
108
+
* use only a relative path to the text file inside the tutorial folder
109
+
* it is recommended to start the folder name with the text file from a dot (*.*) or underscore (*_*), so in the cases when the manifest file is automatically generated, RedisInsight will ignore this folder and not display it in your custom tutorial
110
+
* all the files included in your custom tutorials will be stored inside the RedisInsight folder as long as the tutorials exist in RedisInsight, so instead of including large text files in your custom tutorials, consider using Bulk Upload in Browser
111
+
112
+
**Example:**
113
+
114
+
For example, with the following structure of a custom tutorial:
115
+
116
+
```
117
+
_data // a folder with the file to upload in bulk
118
+
upload.txt
119
+
folder_1 // a folder with custom tutorials
120
+
my-tutorial.md
121
+
manifest.json
122
+
```
123
+
124
+
Use one of the following examples to specify the `redis-upload` button in `my-tutorial.md`:
125
+
126
+
````
127
+
```redis-upload:[../_data/upload.txt] Upload data
128
+
```
129
+
````
130
+
131
+
as a relative path from `folder_1`
132
+
133
+
or
134
+
135
+
````
136
+
```redis-upload:[./_data/upload.txt] Upload data
137
+
```
138
+
````
139
+
140
+
as an absolute path from the tutorial folder.
141
+
142
+
88
143
## Advanced
89
144
90
145
You can customize the run parameters to configure the raw mode, pipeline parameter and group mode. If specified, they will override
0 commit comments