Skip to content

Commit 6107cfa

Browse files
Merge pull request #9 from RedisInsight/feature/RI-3700_RI-3702_Added_silent_mode_and_changed_auto_parameter
#RI-3700, #RI-3702
2 parents 47af57e + e55ce75 commit 6107cfa

File tree

1 file changed

+27
-30
lines changed

1 file changed

+27
-30
lines changed

README.md

+27-30
Original file line numberDiff line numberDiff line change
@@ -127,35 +127,15 @@ the only difference is that you must specify `redis` as language and the label n
127127
```
128128
````
129129

130-
###### Auto-execute button
131-
![img.png](docs/tutorials-redis-auto-code-block.png)
132-
133-
A button that automatically executes the Redis commands (without inserting it into the Editor). Such buttons will be displayed with the "Play" icon inside.
134-
The code syntax is the same as for the manually executed buttons, just indicate the `redis-auto` (instead of `redis`) before the button.
135-
136-
````
137-
```redis-auto Create
138-
// Let's add three documents as Hashes.
139-
// Each document represents a building permit.
140-
141-
HSET permit:1 "description" "To reconstruct a single detached house with a front covered veranda." "construction_value" 42000 "building_type" "single detached house" "address_city" "Lisbon" "work_type" "demolition,reconstruction" "permit_timestamp" "1602156878" "address_street" "R. Da Palma" "location" "38.717746, -9.135839"
142-
143-
HSET permit:2 "description" "To construct a loft" "construction_value" 53000 "building_type" "apartment" "address_city" "Porto" "work_type" "construction" "permit_timestamp" "1556546400" "address_street" "Rua da Boavista" "location" "41.155854, -8.616721"
144-
145-
HSET permit:3 "description" "New house build" "construction_value" 260000 "building_type" "house" "address_city" "Lagos" "work_type" "construction;design" "permit_timestamp" "1612947600" "address_street" "R. Antonio Gedeao" "location" "37.114864, -8.668521"
146-
147-
```
148-
````
149-
150-
###### Auto-execute button parameters
130+
###### Button parameters
151131

152132
You can customize the run parameters to configure the raw mode, pipeline parameter and group mode. If specified, they will override
153133
the configuration set in RedisInsight. If not specified - the behaviour will be defined by parameters set in RedisInsight.
154134
To specify the parameters, insert them after the `redis-auto:` and add the parameters in square brackets separated with a semicolon (`;`) in
155135
the following way:
156136

157137
```
158-
redis-auto:[<parameter1>;<parameter2>;<...>;<parameterN>]
138+
redis:[<parameter1>;<parameter2>;<...>;<parameterN>]
159139
```
160140

161141
Ensure that all the parameters are listed **without spaces**, ordering does not matter.
@@ -164,9 +144,10 @@ _Supported parameters:_
164144

165145
| Name | Values | Notes | Description |
166146
|----------|--------------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
167-
| results | * _single_<br/>* _group_ | If enabled, then pipeline mode is ignored | Enable/disable the group mode to display the command results in a batch or as separate ones. |
147+
| results | * _single_<br/>* _group_<br/>* _silent_ | If enabled, then pipeline mode is ignored | * _single_ - Disable the group mode to display the command results in a batch or as separate ones.<br/>* _group_ - Enable the group mode <br/>* _silent_: <br/>&emsp; 1. Enable the group mode <br/>&emsp; 2. Auto collapse the result <br/>&emsp; 3. Show only error commands in the results|
168148
| mode | * _ascii_<br/>* _raw_ | | Enable/disable the raw mode to display command results. |
169149
| pipeline | any integer number | | Configure the number of commands in the pipeline. 0 or 1 pipelines every command. |
150+
| auto | * _true_<br/>* _false_ | | Configure the auto execute commands after click on the button |
170151

171152

172153
_Notes:_
@@ -177,15 +158,31 @@ _Notes:_
177158
_Examples:_
178159

179160
```
180-
redis-auto:[results=single]
181-
redis-auto:[mode=raw]
182-
redis-auto:[pipeline=1]
183-
redis-auto:[results=single;mode=raw]
184-
redis-auto:[results=single;pipeline=4]
185-
redis-auto:[results=group;mode=ascii]
186-
redis-auto:[pipeline=8;mode=raw;results=single;]
161+
redis:[results=single]
162+
redis:[auto=true;mode=raw]
163+
redis:[pipeline=1]
164+
redis:[results=silent;mode=raw]
165+
redis:[results=single;pipeline=4]
166+
redis:[results=group;mode=ascii]
167+
redis:[auto=true;pipeline=8;mode=raw;results=single;]
187168
```
188169

170+
###### Auto-execute button
171+
![img.png](docs/tutorials-redis-auto-code-block.png)
172+
173+
A button that automatically executes the Redis commands (without inserting it into the Editor). Such buttons will be displayed with the "Play" icon inside.
174+
The code syntax is the same as for the manually executed buttons, just insert parameter `[auto=true]` with any other parameters before the button.
175+
176+
````
177+
```redis:[auto=true;mode=raw] Create
178+
// Let's add three documents as Hashes.
179+
// Each document represents a building permit.
180+
HSET permit:1 "description" "To reconstruct a single detached house with a front covered veranda." "construction_value" 42000 "building_type" "single detached house" "address_city" "Lisbon" "work_type" "demolition,reconstruction" "permit_timestamp" "1602156878" "address_street" "R. Da Palma" "location" "38.717746, -9.135839"
181+
HSET permit:2 "description" "To construct a loft" "construction_value" 53000 "building_type" "apartment" "address_city" "Porto" "work_type" "construction" "permit_timestamp" "1556546400" "address_street" "Rua da Boavista" "location" "41.155854, -8.616721"
182+
HSET permit:3 "description" "New house build" "construction_value" 260000 "building_type" "house" "address_city" "Lagos" "work_type" "construction;design" "permit_timestamp" "1612947600" "address_street" "R. Antonio Gedeao" "location" "37.114864, -8.668521"
183+
```
184+
````
185+
189186
## Autoupdate
190187
Our application supports the ability to quickly update the static files of the Enablement area so that we can provide users with up-to-date information.
191188

0 commit comments

Comments
 (0)