Kentaro Hayashi
null+****@clear*****
Tue Jun 27 12:08:23 JST 2017
Kentaro Hayashi 2017-06-27 12:08:23 +0900 (Tue, 27 Jun 2017) New Revision: e45c4411b38b6c45a999290ead2497b13e1e18e7 https://github.com/groonga/groonga.org/commit/e45c4411b38b6c45a999290ead2497b13e1e18e7 Message: Update grndb documents Modified files: docs/reference/executables/grndb.html docs/sources/reference/executables/grndb.txt ja/docs/reference/executables/grndb.html ja/docs/sources/reference/executables/grndb.txt Modified: docs/reference/executables/grndb.html (+29 -4) =================================================================== --- docs/reference/executables/grndb.html 2017-06-19 09:29:20 +0900 (71c0359) +++ docs/reference/executables/grndb.html 2017-06-27 12:08:23 +0900 (ec088f6) @@ -212,8 +212,32 @@ status. You can know whether the database is recoverable or not by is opened, this command may break the database.</p> </div> <p><code class="docutils literal"><span class="pre">recover</span></code> has some options.</p> +<div class="section" id="force-truncate"> +<h4>7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--force-truncate</span></code><a class="headerlink" href="#force-truncate" title="Permalink to this headline">¶</a></h4> +<div class="versionadded"> +<p><span class="versionmodified">New in version 7.0.4.</span></p> +</div> +<p>It forces to truncate a corrupted database object.</p> +<p>Here is an example that specifies <code class="docutils literal"><span class="pre">--force-truncate</span></code> option:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>% grndb recover --force-truncate --log-level info --log-path /var/log/groonga/grndb.log /var/lib/groonga/db/db +</pre></div> +</div> +<p>When this option is specified, <code class="docutils literal"><span class="pre">grndb</span></code> does the following:</p> +<ul class="simple"> +<li>check whether there is a corrupted database object (table, column, indexes)</li> +<li>truncate a corrupted database object (table, column, indexes)</li> +<li>remove incremental files with .00N suffix which is created when large amount of data is loaded</li> +</ul> +<p><code class="docutils literal"><span class="pre">--force-truncate</span></code> option is destructive one. Even though lock is still remained, <code class="docutils literal"><span class="pre">grndb</span></code> truncates a targeted corrupted database object.</p> +<p>After <code class="docutils literal"><span class="pre">grndb</span> <span class="pre">recover</span></code> command has finished, you need to load data +against truncated tables or columns to recreate database.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">You must use this option only when necessary. It means that you use it when there is a mismatch between database meta information and database object files which exists actually. This options should be used when there is no other way to recover database.</p> +</div> +</div> <div class="section" id="id1"> -<h4>7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--log-level</span></code><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4> +<h4>7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-level</span></code><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4> <div class="versionadded"> <p><span class="versionmodified">New in version 7.0.4.</span></p> </div> @@ -225,7 +249,7 @@ is opened, this command may break the database.</p> <p>See <a class="reference internal" href="../commands/log_level.html"><span class="doc">log_level</span></a> to know about supported log level.</p> </div> <div class="section" id="id2"> -<h4>7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-path</span></code><a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4> +<h4>7.1.1.4.2.3. <code class="docutils literal"><span class="pre">--log-path</span></code><a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4> <div class="versionadded"> <p><span class="versionmodified">New in version 7.0.4.</span></p> </div> @@ -259,8 +283,9 @@ is opened, this command may break the database.</p> </ul> </li> <li><a class="reference internal" href="#recover">7.1.1.4.2. <code class="docutils literal"><span class="pre">recover</span></code></a><ul> -<li><a class="reference internal" href="#id1">7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--log-level</span></code></a></li> -<li><a class="reference internal" href="#id2">7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-path</span></code></a></li> +<li><a class="reference internal" href="#force-truncate">7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--force-truncate</span></code></a></li> +<li><a class="reference internal" href="#id1">7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-level</span></code></a></li> +<li><a class="reference internal" href="#id2">7.1.1.4.2.3. <code class="docutils literal"><span class="pre">--log-path</span></code></a></li> </ul> </li> </ul> Modified: docs/sources/reference/executables/grndb.txt (+26 -0) =================================================================== --- docs/sources/reference/executables/grndb.txt 2017-06-19 09:29:20 +0900 (ac90cb0) +++ docs/sources/reference/executables/grndb.txt 2017-06-27 12:08:23 +0900 (48d856a) @@ -143,6 +143,32 @@ status. You can know whether the database is recoverable or not by ``recover`` has some options. +``--force-truncate`` +"""""""""""""""""""" + +.. versionadded:: 7.0.4 + +It forces to truncate a corrupted database object. + +Here is an example that specifies ``--force-truncate`` option:: + + % grndb recover --force-truncate --log-level info --log-path /var/log/groonga/grndb.log /var/lib/groonga/db/db + +When this option is specified, ``grndb`` does the following: + +* check whether there is a corrupted database object (table, column, indexes) +* truncate a corrupted database object (table, column, indexes) +* remove incremental files with .00N suffix which is created when large amount of data is loaded + +``--force-truncate`` option is destructive one. Even though lock is still remained, ``grndb`` truncates a targeted corrupted database object. + +After ``grndb recover`` command has finished, you need to load data +against truncated tables or columns to recreate database. + +.. note:: + + You must use this option only when necessary. It means that you use it when there is a mismatch between database meta information and database object files which exists actually. This options should be used when there is no other way to recover database. + ``--log-level`` """"""""""""""" Modified: ja/docs/reference/executables/grndb.html (+31 -4) =================================================================== --- ja/docs/reference/executables/grndb.html 2017-06-19 09:29:20 +0900 (873a968) +++ ja/docs/reference/executables/grndb.html 2017-06-27 12:08:23 +0900 (d2f8e22) @@ -199,8 +199,34 @@ <p class="last">このコマンドを他のプロセスが開いているデータベースに対しては使ってはいけません。もし、データベースが他のプロセスから開かれていると、このコマンドはデータベースを壊してしまう可能性があります。</p> </div> <p><code class="docutils literal"><span class="pre">recover</span></code> にはいくつかオプションがあります。</p> +<div class="section" id="force-truncate"> +<h4>7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--force-truncate</span></code><a class="headerlink" href="#force-truncate" title="このヘッドラインへのパーマリンク">¶</a></h4> +<div class="versionadded"> +<p><span class="versionmodified">バージョン 7.0.4 で追加.</span></p> +</div> +<p>壊れたデータベースオブジェクトを強制的に初期化します。</p> +<p>以下は <code class="docutils literal"><span class="pre">--force-truncate</span></code> オプションを指定する例です。</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>% grndb recover --force-truncate --log-level info --log-path /var/log/groonga/grndb.log /var/lib/groonga/db/db +</pre></div> +</div> +<p>このオプションが指定されたとき、 <code class="docutils literal"><span class="pre">grndb</span></code> は次のことを実行します。:</p> +<ul class="simple"> +<li><p class="first">壊れたデータベースオブジェクト(テーブル、カラム、インデックス)がないかチェックします</p> +</li> +<li><p class="first">壊れたデータベースオブジェクト(テーブル、カラム、インデックス)を初期化します</p> +</li> +<li><p class="first">大量のデータをロードしたときに作られる増分ファイル(末尾に.00Nがつきます)を削除します</p> +</li> +</ul> +<p><code class="docutils literal"><span class="pre">--force-truncate</span></code> は破壊的なオプションです。ロックが残留していても、 <code class="docutils literal"><span class="pre">grndb</span></code> は構わず対象となる壊れたデータベースオブジェクトを初期化します。</p> +<p><code class="docutils literal"><span class="pre">grndb</span> <span class="pre">recover</span></code> の処理が終わったら、データベースを再構築するために初期化されたテーブルやカラムに対して再びデータをロードする必要があります。</p> +<div class="admonition note"> +<p class="first admonition-title">注釈</p> +<p class="last">このオプションは必要なときのみ使用します。つまりデータベースのメタ情報と実際に存在するデータベースのオブジェクトファイルの情報が食い違っているときです。 他にデータベースを復旧する方法がないときのみ使うべきです。</p> +</div> +</div> <div class="section" id="id1"> -<h4>7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--log-level</span></code><a class="headerlink" href="#id1" title="このヘッドラインへのパーマリンク">¶</a></h4> +<h4>7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-level</span></code><a class="headerlink" href="#id1" title="このヘッドラインへのパーマリンク">¶</a></h4> <div class="versionadded"> <p><span class="versionmodified">バージョン 7.0.4 で追加.</span></p> </div> @@ -212,7 +238,7 @@ <p>サポートされているログレベルについては <a class="reference internal" href="../commands/log_level.html"><span class="doc">log_level</span></a> を参照してください。</p> </div> <div class="section" id="id2"> -<h4>7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-path</span></code><a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h4> +<h4>7.1.1.4.2.3. <code class="docutils literal"><span class="pre">--log-path</span></code><a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h4> <div class="versionadded"> <p><span class="versionmodified">バージョン 7.0.4 で追加.</span></p> </div> @@ -246,8 +272,9 @@ </ul> </li> <li><a class="reference internal" href="#recover">7.1.1.4.2. <code class="docutils literal"><span class="pre">recover</span></code></a><ul> -<li><a class="reference internal" href="#id1">7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--log-level</span></code></a></li> -<li><a class="reference internal" href="#id2">7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-path</span></code></a></li> +<li><a class="reference internal" href="#force-truncate">7.1.1.4.2.1. <code class="docutils literal"><span class="pre">--force-truncate</span></code></a></li> +<li><a class="reference internal" href="#id1">7.1.1.4.2.2. <code class="docutils literal"><span class="pre">--log-level</span></code></a></li> +<li><a class="reference internal" href="#id2">7.1.1.4.2.3. <code class="docutils literal"><span class="pre">--log-path</span></code></a></li> </ul> </li> </ul> Modified: ja/docs/sources/reference/executables/grndb.txt (+26 -0) =================================================================== --- ja/docs/sources/reference/executables/grndb.txt 2017-06-19 09:29:20 +0900 (ac90cb0) +++ ja/docs/sources/reference/executables/grndb.txt 2017-06-27 12:08:23 +0900 (48d856a) @@ -143,6 +143,32 @@ status. You can know whether the database is recoverable or not by ``recover`` has some options. +``--force-truncate`` +"""""""""""""""""""" + +.. versionadded:: 7.0.4 + +It forces to truncate a corrupted database object. + +Here is an example that specifies ``--force-truncate`` option:: + + % grndb recover --force-truncate --log-level info --log-path /var/log/groonga/grndb.log /var/lib/groonga/db/db + +When this option is specified, ``grndb`` does the following: + +* check whether there is a corrupted database object (table, column, indexes) +* truncate a corrupted database object (table, column, indexes) +* remove incremental files with .00N suffix which is created when large amount of data is loaded + +``--force-truncate`` option is destructive one. Even though lock is still remained, ``grndb`` truncates a targeted corrupted database object. + +After ``grndb recover`` command has finished, you need to load data +against truncated tables or columns to recreate database. + +.. note:: + + You must use this option only when necessary. It means that you use it when there is a mismatch between database meta information and database object files which exists actually. This options should be used when there is no other way to recover database. + ``--log-level`` """"""""""""""" -------------- next part -------------- HTML����������������������������...Download