[Groonga-commit] groonga/groonga at da5fd46 [master] doc grn_column_truncate(): add

Back to archive index

Kouhei Sutou null+****@clear*****
Mon Dec 29 17:52:27 JST 2014


Kouhei Sutou	2014-12-29 17:52:27 +0900 (Mon, 29 Dec 2014)

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

  Message:
    doc grn_column_truncate(): add

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

  Modified: doc/source/reference/api/grn_column.rst (+16 -0)
===================================================================
--- doc/source/reference/api/grn_column.rst    2014-12-29 17:38:56 +0900 (f438288)
+++ doc/source/reference/api/grn_column.rst    2014-12-29 17:52:27 +0900 (e8caab9)
@@ -180,3 +180,19 @@ Reference
    :param indexbuf: indexを格納するバッファ(呼出側で準備する)を指定します。
    :param buf_size: indexbufのサイズ(byte長)を指定します。
    :param section: section番号を格納するint長バッファ(呼出側で準備する)を指定します。
+
+.. c:function:: grn_rc grn_column_truncate(grn_ctx *ctx, grn_obj *column)
+
+   .. note::
+
+      This is a dangerous API. You must not use this API when other
+      thread or process accesses the target column. If you use this
+      API against shared column, the process that accesses the column
+      may be broken and the column may be broken.
+
+   .. versionadded:: 4.0.9
+
+   Clears all values in the column.
+
+   :param column: The column to be truncated.
+   :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