Kouhei Sutou
null+****@clear*****
Tue Jan 26 15:42:49 JST 2016
Kouhei Sutou 2016-01-26 15:42:49 +0900 (Tue, 26 Jan 2016) New Revision: 8c689e2391c7eddecda6a26be1ee075029dee239 https://github.com/groonga/groonga/commit/8c689e2391c7eddecda6a26be1ee075029dee239 Message: doc: document config_delete Added files: doc/source/example/reference/commands/config_delete/existent.log doc/source/example/reference/commands/config_delete/nonexistent.log doc/source/reference/commands/config_delete.rst Modified files: doc/files.am Modified: doc/files.am (+14 -0) =================================================================== --- doc/files.am 2016-01-26 15:38:27 +0900 (410055a) +++ doc/files.am 2016-01-26 15:42:49 +0900 (d5d9d33) @@ -56,8 +56,11 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/reference/commands/column_copy/to_table_setup.log \ $(top_srcdir)/doc/source/example/reference/commands/column_list/column_list.log \ $(top_srcdir)/doc/source/example/reference/commands/column_rename/column_rename.log \ + $(top_srcdir)/doc/source/example/reference/commands/config_delete/existent.log \ + $(top_srcdir)/doc/source/example/reference/commands/config_delete/nonexistent.log \ $(top_srcdir)/doc/source/example/reference/commands/config_get/existent.log \ $(top_srcdir)/doc/source/example/reference/commands/config_get/nonexistent.log \ + $(top_srcdir)/doc/source/example/reference/commands/config_set/set_and_get.log \ $(top_srcdir)/doc/source/example/reference/commands/database_unmap/usage_failure.log \ $(top_srcdir)/doc/source/example/reference/commands/database_unmap/usage_success.log \ $(top_srcdir)/doc/source/example/reference/commands/delete/cascade.log \ @@ -629,7 +632,9 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/commands/column_list.rst \ $(top_srcdir)/doc/source/reference/commands/column_remove.rst \ $(top_srcdir)/doc/source/reference/commands/column_rename.rst \ + $(top_srcdir)/doc/source/reference/commands/config_delete.rst \ $(top_srcdir)/doc/source/reference/commands/config_get.rst \ + $(top_srcdir)/doc/source/reference/commands/config_set.rst \ $(top_srcdir)/doc/source/reference/commands/database_unmap.rst \ $(top_srcdir)/doc/source/reference/commands/define_selector.rst \ $(top_srcdir)/doc/source/reference/commands/defrag.rst \ @@ -834,8 +839,11 @@ source_files_relative_from_doc_dir = \ source/example/reference/commands/column_copy/to_table_setup.log \ source/example/reference/commands/column_list/column_list.log \ source/example/reference/commands/column_rename/column_rename.log \ + source/example/reference/commands/config_delete/existent.log \ + source/example/reference/commands/config_delete/nonexistent.log \ source/example/reference/commands/config_get/existent.log \ source/example/reference/commands/config_get/nonexistent.log \ + source/example/reference/commands/config_set/set_and_get.log \ source/example/reference/commands/database_unmap/usage_failure.log \ source/example/reference/commands/database_unmap/usage_success.log \ source/example/reference/commands/delete/cascade.log \ @@ -1407,7 +1415,9 @@ source_files_relative_from_doc_dir = \ source/reference/commands/column_list.rst \ source/reference/commands/column_remove.rst \ source/reference/commands/column_rename.rst \ + source/reference/commands/config_delete.rst \ source/reference/commands/config_get.rst \ + source/reference/commands/config_set.rst \ source/reference/commands/database_unmap.rst \ source/reference/commands/define_selector.rst \ source/reference/commands/defrag.rst \ @@ -1757,7 +1767,9 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/commands/column_list.txt \ html/_sources/reference/commands/column_remove.txt \ html/_sources/reference/commands/column_rename.txt \ + html/_sources/reference/commands/config_delete.txt \ html/_sources/reference/commands/config_get.txt \ + html/_sources/reference/commands/config_set.txt \ html/_sources/reference/commands/database_unmap.txt \ html/_sources/reference/commands/define_selector.txt \ html/_sources/reference/commands/defrag.txt \ @@ -1999,7 +2011,9 @@ html_files_relative_from_locale_dir = \ html/reference/commands/column_list.html \ html/reference/commands/column_remove.html \ html/reference/commands/column_rename.html \ + html/reference/commands/config_delete.html \ html/reference/commands/config_get.html \ + html/reference/commands/config_set.html \ html/reference/commands/database_unmap.html \ html/reference/commands/define_selector.html \ html/reference/commands/defrag.html \ Added: doc/source/example/reference/commands/config_delete/existent.log (+10 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/config_delete/existent.log 2016-01-26 15:42:49 +0900 (ff93215) @@ -0,0 +1,10 @@ +Execution example:: + + config_set alias.column_name Aliases.real_name + # [[0, 1337566253.89858, 0.000355720520019531], true] + config_get alias.column_name + # [[0, 1337566253.89858, 0.000355720520019531], "Aliases.real_name"] + config_delete alias.column_name + # [[0, 1337566253.89858, 0.000355720520019531], true] + config_get alias.column_name + # [[0, 1337566253.89858, 0.000355720520019531], ""] Added: doc/source/example/reference/commands/config_delete/nonexistent.log (+19 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/config_delete/nonexistent.log 2016-01-26 15:42:49 +0900 (06c2988) @@ -0,0 +1,19 @@ +Execution example:: + + config_delete nonexistent + # [ + # [ + # -22, + # 1337566253.89858, + # 0.000355720520019531, + # "[config][delete] failed to delete", + # [ + # [ + # "grn_config_delete", + # "config.c", + # 166 + # ] + # ] + # ], + # false + # ] Added: doc/source/reference/commands/config_delete.rst (+95 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/config_delete.rst 2016-01-26 15:42:49 +0900 (34d4db6) @@ -0,0 +1,95 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: config_delete + +``config_delete`` +================= + +Summary +------- + +.. versionadded:: 5.1.2 + +``config_delete`` command deletes the specified configuration item. + +Syntax +------ + +This command takes one parameter:: + + config_delete key + +Usage +----- + +Here is an example to delete ``alias.column_name`` configuration item: + +.. groonga-command +.. include:: ../../example/reference/commands/config_delete/existent.log +.. config_set alias.column_name Aliases.real_name +.. config_get alias.column_name +.. config_delete alias.column_name +.. config_get alias.column_name + +Here is an example to delete nonexistent configuration item: + +.. groonga-command +.. include:: ../../example/reference/commands/config_delete/nonexistent.log +.. config_delete nonexistent + +``config_delete`` returns an error when you try to delete nonexistent +configuration item. + +Parameters +---------- + +This section describes all parameters. + +Required parameters +^^^^^^^^^^^^^^^^^^^ + +There is one required parameter. + +.. _config-delete-key: + +``key`` +""""""" + +Specifies the key of target configuration item. + +The max key size is 4KiB. + +You can't use an empty string as key. + +Optional parameters +^^^^^^^^^^^^^^^^^^^ + +There is no optional parameters. + +Return value +------------ + +``config_delete`` command returns whether deleting a configuration +item 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_set` -------------- next part -------------- HTML����������������������������...Télécharger
