[Groonga-commit] groonga/groonga at 2a883c5 [master] doc: document grn_db_recover()

Back to archive index

Kouhei Sutou null+****@clear*****
Mon Dec 29 16:11:06 JST 2014


Kouhei Sutou	2014-12-29 16:11:06 +0900 (Mon, 29 Dec 2014)

  New Revision: 2a883c527b1c205459037a0387905c01c367c467
  https://github.com/groonga/groonga/commit/2a883c527b1c205459037a0387905c01c367c467

  Message:
    doc: document grn_db_recover()

  Modified files:
    doc/source/reference/api/grn_db.rst

  Modified: doc/source/reference/api/grn_db.rst (+40 -0)
===================================================================
--- doc/source/reference/api/grn_db.rst    2014-12-29 15:40:44 +0900 (6af17d5)
+++ doc/source/reference/api/grn_db.rst    2014-12-29 16:11:06 +0900 (a178698)
@@ -69,3 +69,43 @@ TODO...
    objの属するdbを返します。
 
    :param obj: 対象objectを指定します。
+
+.. c:function:: grn_rc grn_db_recover(grn_ctx *ctx, grn_obj *db)
+
+   .. note::
+
+      This is an experimental API.
+
+   .. note::
+
+      This is a dangerous API. You must not use this API when other
+      thread or process opens the target database. If you use this API
+      against shared database, the database may be broken.
+
+   .. versionadded:: 4.0.9
+
+   Checks the passed database and recovers it if it is broken and it
+   can be recovered.
+
+   This API uses lock existence for checking whether the database is
+   broken or not.
+
+   Here are recoverable cases:
+
+     * Index column is broken. The index column must have source column.
+
+   Here are unrecoverable cases:
+
+     * Object name management feature is broken.
+     * Table is broken.
+     * Data column is broken.
+
+   Object name management feature is used for managing table name,
+   column name and so on. If the feature is broken, the database can't
+   be recovered. Please re-create the database from backup.
+
+   Table and data column can be recovered by removing an existence
+   lock and re-add data.
+
+   :param db: The database to be recovered.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
-------------- next part --------------
HTML����������������������������...
下载 



More information about the Groonga-commit mailing list
Back to archive index