7.3.18. config_set
¶
7.3.18.1. Summary¶
New in version 5.1.2.
config_set
command sets a value to the specified
configuration item.
7.3.18.2. Syntax¶
This command takes two required parameters:
config_set key value
7.3.18.3. Usage¶
Here is an example to set a value to alias.column
configuration item and confirm the set value:
Execution example:
config_set alias.column Aliases.real_name
# [[0,1337566253.89858,0.000355720520019531],true]
config_get alias.column
# [[0,1337566253.89858,0.000355720520019531],"Aliases.real_name"]
7.3.18.4. Parameters¶
This section describes all parameters.
7.3.18.4.1. Required parameters¶
There are required parameters.
7.3.18.4.1.1. key
¶
Specifies the key of target configuration item.
The max key size is 4KiB.
You can’t use an empty string as key.
7.3.18.4.1.2. value
¶
Specifies the value of the target configuration item specified by
key
.
The max value size is 4091B (= 4KiB - 5B).
7.3.18.4.2. Optional parameters¶
There is no optional parameter.
7.3.18.5. Return value¶
config_set
command returns whether setting a configuration item
value is succeeded or not:
[HEADER, SUCCEEDED_OR_NOT]
7.3.18.5.1. HEADER
¶
See Output format about HEADER
.
7.3.18.5.2. SUCCEEDED_OR_NOT
¶
If command succeeded, it returns true, otherwise it returns false on error.