Kouhei Sutou
null+****@clear*****
Tue Jan 26 14:56:16 JST 2016
Kouhei Sutou 2016-01-26 14:56:16 +0900 (Tue, 26 Jan 2016) New Revision: 68157711655c030bb3284ab7c33e44e2be74093f https://github.com/groonga/groonga/commit/68157711655c030bb3284ab7c33e44e2be74093f Message: doc: add configuration document Added files: doc/source/reference/configuration.rst Added: doc/source/reference/configuration.rst (+50 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/configuration.rst 2016-01-26 14:56:16 +0900 (de47ec8) @@ -0,0 +1,50 @@ +.. -*- rst -*- + +.. highlightlang:: none + +Configuration +============= + +.. versionadded:: 5.1.2 + +Groonga can manage configuration items in each database. These +configuration items are persistent. It means that these configuration +items are usable after a Groonga process exits. + +Summary +------- + +You can change some Groonga behaviors such as :doc:`/spec/search` by +some ways such as request parameter +(:ref:`select-match-escalation-threshold`) and build parameter +(:ref:`install-configure-with-match-escalation-threshold`). + +Configuration is one of these ways. You can change some Groonga +behaviors per database by configuration. + +A configuration item consists of key and value. Both of key and value +are string. The max key size is 4KiB. The max value size is 4091B (= +4KiB - 5B). + +You can set a configuration item by +:doc:`/reference/commands/config_set`. + +You can get a configuration item by +:doc:`/reference/commands/config_get`. + +You can delete a configuration item by +:doc:`/reference/commands/config_delete`. + +You can confirm all configuration items by +:doc:`/reference/commands/dump`. + +.. _configuration-commands: + +Commands +-------- + +.. toctree:: + :maxdepth: 1 + :glob: + + commands/config_* -------------- next part -------------- HTML����������������������������...Download