Skip to content

Commit 9a879cd

Browse files
author
Roman Sergeenko
committed
#RI-4580 - add info about bulk upload
1 parent 2b2697f commit 9a879cd

File tree

1 file changed

+50
-3
lines changed

1 file changed

+50
-3
lines changed

README.md

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
88

99
## Navigation
1010

11-
1. [Structure](#Structure)
12-
2. [Examples](#Examples)
13-
3. [Advanced button parameters](#Advanced)
11+
1. [Structure](#structure)
12+
2. [Examples](#examples)
13+
3. [Advanced button parameters](#advanced)
14+
3. [Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
1415

1516
## Structure
1617

@@ -123,3 +124,49 @@ redis:[results=single;pipeline=4]
123124
redis:[results=group;mode=ascii]
124125
redis:[auto=true;pipeline=8;mode=raw;results=single;]
125126
```
127+
128+
## Bulk Upload From Tutorials
129+
130+
You can specify a special button for the Bulk Upload, upon clicking which,
131+
a text file with redis commands will be loaded and executed. It works the same as Bulk Upload in Browser.
132+
133+
To specify bulk upload button, you have to use the following syntax:
134+
135+
````
136+
137+
```redis-upload:[{path_to_file}] Upload data
138+
```
139+
140+
````
141+
_Notes:_
142+
143+
* You can use a relative path to text file inside the tutorial folder
144+
* If manifest is not specified, folder with bulk upload text files should start with *.* or *_*
145+
* Text files included into tutorial will be stored as long as tutorial
146+
147+
_Example_:
148+
For example, we have the following structure of tutorial:
149+
```
150+
_data // folder with bulk upload text file
151+
upload.txt
152+
folder_1 // folder with tutorial
153+
my-tutorial.md
154+
manifest.json
155+
```
156+
157+
In *my-tutorial.md* `redis-upload` button can be specified as:
158+
159+
````
160+
```redis-upload:[../_data/upload.txt] Upload data
161+
```
162+
````
163+
as relative path from current folder_1
164+
165+
or
166+
````
167+
```redis-upload:[./_data/upload.txt] Upload data
168+
```
169+
````
170+
as absolute path from tutorial folder
171+
172+

0 commit comments

Comments
 (0)