[Groonga-commit] groonga/groonga at ab288c7 [master] doc: document grn_db_unmap()

Back to archive index

Kouhei Sutou null+****@clear*****
Sun Aug 30 13:45:01 JST 2015


Kouhei Sutou	2015-08-30 13:45:01 +0900 (Sun, 30 Aug 2015)

  New Revision: ab288c7749047157db9f9641e9712e2c631bd1e5
  https://github.com/groonga/groonga/commit/ab288c7749047157db9f9641e9712e2c631bd1e5

  Message:
    doc: document grn_db_unmap()

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

  Modified: doc/source/reference/api/grn_db.rst (+23 -0)
===================================================================
--- doc/source/reference/api/grn_db.rst    2015-08-30 13:44:53 +0900 (a178698)
+++ doc/source/reference/api/grn_db.rst    2015-08-30 13:45:01 +0900 (471015c)
@@ -109,3 +109,26 @@ TODO...
 
    :param db: The database to be recovered.
    :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_rc grn_db_unmap(grn_ctx *ctx, grn_obj *db)
+
+   .. note::
+
+      This is an experimental API.
+
+   .. note::
+
+      This is a thread unsafe API. You can't touch the database while
+      this API is running.
+
+   .. versionadded:: 5.0.7
+
+   Unmaps all opened tables and columns in the passed
+   database. Resources used by these opened tables and columns are
+   freed.
+
+   Normally, this API isn't useless. Because resources used by opened
+   tables and columns are managed by OS automatically.
+
+   :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