1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
.. -*- rst -*-
.. highlightlang:: none
.. groonga-command
.. database: config_set
``config_set``
==============
Summary
-------
.. versionadded:: 5.1.2
``config_set`` command sets a value to the specified
configuration item.
Syntax
------
This command takes two required parameters::
config_set key value
Usage
-----
Here is an example to set a value to ``alias.column``
configuration item and confirm the set value:
.. groonga-command
.. include:: ../../example/reference/commands/config_set/set_and_get.log
.. config_set alias.column Aliases.real_name
.. config_get alias.column
Parameters
----------
This section describes all parameters.
Required parameters
^^^^^^^^^^^^^^^^^^^
There are required parameters.
.. _config-set-key:
``key``
"""""""
Specifies the key of target configuration item.
The max key size is 4KiB.
You can't use an empty string as key.
.. _config-set-value:
``value``
"""""""""
Specifies the value of the target configuration item specified by
``key``.
The max value size is 4091B (= 4KiB - 5B).
Optional parameters
^^^^^^^^^^^^^^^^^^^
There is no optional parameter.
Return value
------------
``config_set`` command returns whether setting a configuration item
value is succeeded or not::
[HEADER, SUCCEEDED_OR_NOT]
``HEADER``
^^^^^^^^^^
See :doc:`/reference/command/output_format` about ``HEADER``.
``SUCCEEDED_OR_NOT``
^^^^^^^^^^^^^^^^^^^^
If command succeeded, it returns true, otherwise it returns false on error.
See also
--------
* :doc:`/reference/configuration`
* :doc:`config_get`
* :doc:`config_delete`
|
