Kouhei Sutou
null+****@clear*****
Mon Dec 29 17:38:06 JST 2014
Kouhei Sutou 2014-12-29 17:38:06 +0900 (Mon, 29 Dec 2014) New Revision: 543f01f4cd3039a513eb2848e4064b4a1cc56f81 https://github.com/groonga/groonga/commit/543f01f4cd3039a513eb2848e4064b4a1cc56f81 Message: doc grndb: add Added files: doc/source/reference/executables/grndb.rst Modified files: doc/files.am Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2014-12-29 17:28:24 +0900 (22b14aa) +++ doc/files.am 2014-12-29 17:38:06 +0900 (21785c6) @@ -471,6 +471,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/example/reference/executables/groonga-suggest-httpd-launch.log \ $(top_srcdir)/doc/source/reference/example/reference/executables/groonga-suggest-httpd-setup.log \ $(top_srcdir)/doc/source/reference/executables.rst \ + $(top_srcdir)/doc/source/reference/executables/grndb.rst \ $(top_srcdir)/doc/source/reference/executables/grnslap.rst \ $(top_srcdir)/doc/source/reference/executables/groonga-benchmark.rst \ $(top_srcdir)/doc/source/reference/executables/groonga-httpd.rst \ @@ -1028,6 +1029,7 @@ source_files_relative_from_doc_dir = \ source/reference/example/reference/executables/groonga-suggest-httpd-launch.log \ source/reference/example/reference/executables/groonga-suggest-httpd-setup.log \ source/reference/executables.rst \ + source/reference/executables/grndb.rst \ source/reference/executables/grnslap.rst \ source/reference/executables/groonga-benchmark.rst \ source/reference/executables/groonga-httpd.rst \ @@ -1331,6 +1333,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/commands/tokenizer_list.txt \ html/_sources/reference/commands/truncate.txt \ html/_sources/reference/executables.txt \ + html/_sources/reference/executables/grndb.txt \ html/_sources/reference/executables/grnslap.txt \ html/_sources/reference/executables/groonga-benchmark.txt \ html/_sources/reference/executables/groonga-httpd.txt \ @@ -1535,6 +1538,7 @@ html_files_relative_from_locale_dir = \ html/reference/commands/tokenizer_list.html \ html/reference/commands/truncate.html \ html/reference/executables.html \ + html/reference/executables/grndb.html \ html/reference/executables/grnslap.html \ html/reference/executables/groonga-benchmark.html \ html/reference/executables/groonga-httpd.html \ Added: doc/source/reference/executables/grndb.rst (+84 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/executables/grndb.rst 2014-12-29 17:38:06 +0900 (d9e914d) @@ -0,0 +1,84 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grndb`` +========= + +Summary +------- + +.. note:: + + This executable command is an experimental feature. + +.. vesionadded:: 4.0.9 + +``grndb`` manages a Groonga database. + +Here are features: + + * Checks whether database is broken or not. + * Recovers broken database automatically if the database is + recoverable. + +Syntax +------ + +``grndb`` requires command and database path:: + + grndb COMMAND [OPTIONS] DATABASE_PATH + +Here are available commands: + + * ``check`` - Checks whether database is broken or not. + * ``recover`` - Recovers database. + +Usage +----- + +Here is an example to check the database at ``/var/lib/groonga/db/db``:: + + $ grndb check /var/lib/groonga/db/db + +Here is an example to recover the database at ``/var/lib/groonga/db/db``:: + + $ grndb recover /var/lib/groonga/db/db + +Commands +-------- + +This section describes available commands. + +``check`` +""""""""" + +It checks an existing Groonga database. If the database is broken, +``grndb`` reports reasons and exits with non-``0`` exit status. + +.. note:: + + You must not use this command for opened database. If the database + is opened, this command may report wrong result. + +``recover`` +""""""""""" + +It recovers an existing broken Groonga database. + +If the database is not broken, ``grndb`` does nothing and exits with +``0`` exit status. + +If the database is broken and one or more index columns are only +broken, ``grndb`` recovers these index columns and exists with ``0`` +exit status. It may take a long time for large indexed data. + +If the database is broken and tables or data columns are broken, +``grndb`` reports broken reasons and exits with non-``0`` exit +status. You can know whether the database is recoverable or not by +``check`` command. + +.. note:: + + You must not use this command for opened database. If the database + is opened, this command may break the database. -------------- next part -------------- HTML����������������������������...Download