Skip to content

Commit c7d0c1a

Browse files
authored
Merge pull request #22 from RedisInsight/feature/RI-4580
#RI-4580 - add info about bulk upload
2 parents 3b0e077 + 70a9aff commit c7d0c1a

File tree

1 file changed

+57
-1
lines changed

1 file changed

+57
-1
lines changed

README.md

+57-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
1313
3. [Markdown](#Markdown)
1414
4. [Images](#Images)
1515
5. [Manifest](#Manifest)
16-
6. [Advanced button parameters](#Advanced)
16+
6. [Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
17+
7. [Advanced button parameters](#Advanced)
1718

1819
## Structure
1920

@@ -105,6 +106,61 @@ A Node can be represented by various UI components and is specified by `type` pr
105106
> _**!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._
106107
107108

109+
## Bulk Upload From Tutorials
110+
111+
You can upload sample data sets in bulk from your custom RedisInsight tutorials.
112+
To do so, you will need to:
113+
- create a text file with the list of Redis commands
114+
- add this file to the archive with your custom tutorials
115+
- create a special `redis-upload` button described in this section to execute all the Redis commands from custom tutorials
116+
117+
This button works similarly to the Bulk Upload in Browser, so all the Redis commands specified in the file will be executed.
118+
119+
The following syntax describes the `redis-upload` button:
120+
121+
````
122+
123+
```redis-upload:[{relative_path_to_the_text_file}] Upload data
124+
```
125+
126+
````
127+
**Notes:**
128+
129+
* use only a relative path to the text file inside the tutorial folder
130+
* 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
131+
* 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
132+
133+
**Example:**
134+
135+
For example, with the following structure of a custom tutorial:
136+
137+
```
138+
_data // a folder with the file to upload in bulk
139+
upload.txt
140+
folder_1 // a folder with custom tutorials
141+
my-tutorial.md
142+
manifest.json
143+
```
144+
145+
Use one of the following examples to specify the `redis-upload` button in `my-tutorial.md`:
146+
147+
````
148+
```redis-upload:[../_data/upload.txt] Upload data
149+
```
150+
````
151+
152+
as a relative path from `folder_1`
153+
154+
or
155+
156+
````
157+
```redis-upload:[./_data/upload.txt] Upload data
158+
```
159+
````
160+
161+
as an absolute path from the tutorial folder.
162+
163+
108164
## Advanced
109165

110166
You can customize the run parameters to configure the raw mode, pipeline parameter and group mode. If specified, they will override

0 commit comments

Comments
 (0)