Add pgroonga_check document

pgroonga · Apr 26, 2017 · ee110d8 · ee110d8
1 parent d377ecc
commit ee110d8
Show file tree

Hide file tree

Showing 6 changed files with 144 additions and 1 deletion.
diff --git a/_po/ja/reference/index.po b/_po/ja/reference/index.po
@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"PO-Revision-Date: 2016-11-30 17:20+0900\n"
+"PO-Revision-Date: 2017-04-26 16:18+0900\n"
 "Language: ja\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -236,6 +236,13 @@ msgstr "  * [`pgroonga.log_type`パラメーター](parameters/log-type.html)"
 msgid "  * [`pgroonga.query_log_path` parameter](parameters/query-log-path.html)"
 msgstr "  * [`pgroonga.query_log_path`パラメーター](parameters/query-log-path.html)"
 
+msgid "## Modules"
+msgstr ""
+"## モジュール\n"
+
+msgid "  * [`pgroonga_check` module](modules/pgroonga-check.html)"
+msgstr "  * [`pgroonga_check`モジュール](modules/pgroonga-check.html)"
+
 msgid "## Groonga functions"
 msgstr "## Groongaの関数"
 

diff --git a/_po/ja/reference/modules/pgroonga-check.po b/_po/ja/reference/modules/pgroonga-check.po
@@ -0,0 +1,75 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"PO-Revision-Date: 2017-04-26 16:26+0900\n"
+"Language: ja\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+
+msgid ""
+"---\n"
+"title: pgroonga_check module\n"
+"upper_level: ../\n"
+"---"
+msgstr ""
+"---\n"
+"title: pgroonga_checkモジュール\n"
+"upper_level: ../\n"
+"---"
+
+msgid "# `pgroonga_check` module"
+msgstr "# `pgroonga_check`モジュール"
+
+msgid "## Summary"
+msgstr "## 概要"
+
+msgid ""
+"`pgroonga_check` module checkes PGroonga database consistency on startup. If P"
+"Groonga database is broken, it tries to recover the database."
+msgstr ""
+"`pgroonga_check`モジュールは起動時にPGroongaのデータベースの一貫性をチェックします。PGroongaのデータベースが壊れている場合は"
+"自動でそのデータベースを復旧します。"
+
+msgid "## Configuration"
+msgstr "## 設定"
+
+msgid ""
+"You need to add `pgroonga_check` to [`shared_preload_libraries`]({{ site.postg"
+"resql_doc_base_url.en }}/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARI"
+"ES) in `postgresql.conf`:"
+msgstr ""
+"`postgresql.conf`の[`shared_preload_libraries`]({{ site.postgresql_doc_base_url"
+".ja }}/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES)に`pgroonga_chec"
+"k`を追加します。"
+
+msgid ""
+"```text\n"
+"shared_preload_libraries = 'pgroonga_check'\n"
+"```"
+msgstr ""
+
+msgid "You need to restart your PostgreSQL to apply the change."
+msgstr "この変更を反映するためにPostgreSQLを再起動する必要があります。"
+
+msgid "## Usage"
+msgstr "## 使い方"
+
+msgid ""
+"You don't do anything. `pgroonga_check` module checks all PGroonga databases o"
+"n PostgreSQL startup. If `pgroonga_check` module finds any broken PGroonga dat"
+"abases, it tries to recover them automatically."
+msgstr ""
+"何もする必要はありません。`pgroonga_check`モジュールはPostgreSQL起動時にすべてのPGroongaのデータベースをチェックします。も"
+"し、`pgroonga_check`モジュールが壊れているPGroongaのデータベースを見つけたら、自動で復旧します。"
+
+msgid ""
+"If it can't recover, it removes all unrecoverable PGroonga databases automatic"
+"ally. There are no unrecoverable data in PGroonga databases. You can recover P"
+"Groonga databases by running [`REINDEX`]({{ site.postgresql_doc_base_url.en }}"
+"/sql-reindex.html) manually."
+msgstr ""
+"復旧に失敗した場合は該当PGroongaデータベースを自動で削除します。PGroongaのデータベース内には復旧不可能なデータはありません。手動で[`REI"
+"NDEX`]({{ site.postgresql_doc_base_url.ja }}/sql-reindex.html)を実行することでPGroonga"
+"のデータベースを復旧できます。"
diff --git a/ja/reference/index.md b/ja/reference/index.md
@@ -118,6 +118,11 @@ PGroonga 1.Y.Zは`pgroonga.XXX_v2`という演算子クラスを提供します
 
   * [`pgroonga.query_log_path`パラメーター](parameters/query-log-path.html)
 
+## モジュール
+
+
+  * [`pgroonga_check`モジュール](modules/pgroonga-check.html)
+
 ## Groongaの関数
 
 [`pgroonga.command`関数](functions/pgroonga-command.html)内で以下のGroongaの関数を使えます。`WHERE`節では使えません。

diff --git a/ja/reference/modules/pgroonga-check.md b/ja/reference/modules/pgroonga-check.md
@@ -0,0 +1,26 @@
+---
+title: pgroonga_checkモジュール
+upper_level: ../
+---
+
+# `pgroonga_check`モジュール
+
+## 概要
+
+`pgroonga_check`モジュールは起動時にPGroongaのデータベースの一貫性をチェックします。PGroongaのデータベースが壊れている場合は自動でそのデータベースを復旧します。
+
+## 設定
+
+`postgresql.conf`の[`shared_preload_libraries`]({{ site.postgresql_doc_base_url.ja }}/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES)に`pgroonga_check`を追加します。
+
+```text
+shared_preload_libraries = 'pgroonga_check'
+```
+
+この変更を反映するためにPostgreSQLを再起動する必要があります。
+
+## 使い方
+
+何もする必要はありません。`pgroonga_check`モジュールはPostgreSQL起動時にすべてのPGroongaのデータベースをチェックします。もし、`pgroonga_check`モジュールが壊れているPGroongaのデータベースを見つけたら、自動で復旧します。
+
+復旧に失敗した場合は該当PGroongaデータベースを自動で削除します。PGroongaのデータベース内には復旧不可能なデータはありません。手動で[`REINDEX`]({{ site.postgresql_doc_base_url.ja }}/sql-reindex.html)を実行することでPGroongaのデータベースを復旧できます。
diff --git a/reference/index.md b/reference/index.md
@@ -118,6 +118,10 @@ If you use them, you need to use [incompatible case steps](../upgrade/#incompati
 
   * [`pgroonga.query_log_path` parameter](parameters/query-log-path.html)
 
+## Modules
+
+  * [`pgroonga_check` module](modules/pgroonga-check.html)
+
 ## Groonga functions
 
 You can use them with [`pgroonga.command` function](functions/pgroonga-command.html). You can't use them in `WHERE` clause.

diff --git a/reference/modules/pgroonga-check.md b/reference/modules/pgroonga-check.md
@@ -0,0 +1,26 @@
+---
+title: pgroonga_check module
+upper_level: ../
+---
+
+# `pgroonga_check` module
+
+## Summary
+
+`pgroonga_check` module checkes PGroonga database consistency on startup. If PGroonga database is broken, it tries to recover the database.
+
+## Configuration
+
+You need to add `pgroonga_check` to [`shared_preload_libraries`]({{ site.postgresql_doc_base_url.en }}/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES) in `postgresql.conf`:
+
+```text
+shared_preload_libraries = 'pgroonga_check'
+```
+
+You need to restart your PostgreSQL to apply the change.
+
+## Usage
+
+You don't do anything. `pgroonga_check` module checks all PGroonga databases on PostgreSQL startup. If `pgroonga_check` module finds any broken PGroonga databases, it tries to recover them automatically.
+
+If it can't recover, it removes all unrecoverable PGroonga databases automatically. There are no unrecoverable data in PGroonga databases. You can recover PGroonga databases by running [`REINDEX`]({{ site.postgresql_doc_base_url.en }}/sql-reindex.html) manually.