Skip to content

Commit d517b24

Browse files
author
Roman.Sergeenko
committed
#RI-2664 - add info about parameters for auto-execute button
1 parent 9838cb1 commit d517b24

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,45 @@ The code syntax is the same as for the manually executed buttons, just indicate
147147
```
148148
````
149149

150+
###### Auto-execute button parameters
151+
152+
You can customize the run parameters to configure the raw mode, pipeline parameter and group mode. If specified, they will override
153+
the configuration set in RedisInsight. If not specified - the behaviour will be defined by parameters set in RedisInsight.
154+
To specify the parameters, insert them after the `redis-auto:` and add the parameters in square brackets separated with a semicolon (`;`) in
155+
the following way:
156+
157+
```
158+
redis-auto:[<parameter1>;<parameter2>;<...>;<parameterN>]
159+
```
160+
161+
Ensure that all the parameters are listed **without spaces**, ordering does not matter.
162+
163+
_Supported parameters:_
164+
165+
| Name | Values | Notes | Description |
166+
|----------|--------------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
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. |
168+
| mode | * _ascii_<br/>* _raw_ | | Enable/disable the raw mode to display command results. |
169+
| pipeline | any integer number | | Configure the number of commands in the pipeline. 0 or 1 pipelines every command. |
170+
171+
172+
_Notes:_
173+
174+
* Ensure that there are no spaces
175+
* All the parameters with mistakes will be ignored
176+
177+
_Examples:_
178+
179+
```
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;]
187+
```
188+
150189
## Autoupdate
151190
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.
152191

0 commit comments

Comments
 (0)