RubyGems - rroonga - Versions diffs - 3.0.7-x86-mingw32 → 3.0.8-x86-mingw32 - Mend

rroonga 3.0.7-x86-mingw32 → 3.0.8-x86-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (481) hide show

data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_info.html ADDED Viewed

@@ -0,0 +1,238 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>8.14.12. grn_info &mdash; groonga v3.0.8ドキュメント</title>
+    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '3.0.8',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <script type="text/javascript" src="../../_static/translations.js"></script>
+    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+    <link rel="top" title="groonga v3.0.8ドキュメント" href="../../index.html" />
+    <link rel="up" title="8.14. API" href="../api.html" />
+    <link rel="next" title="8.14.13. grn_match_escalation" href="grn_match_escalation.html" />
+    <link rel="prev" title="8.14.11. grn_index_cursor" href="grn_index_cursor.html" />
+  </head>
+  <body>
+<div class="header">
+  <h1 class="title">
+    <a id="top-link" href="../../index.html">
+      <span class="project">groonga</span>
+      <span class="separator">-</span>
+      <span class="description">オープンソースのカラムストア機能付き全文検索エンジン</span>
+    </a>
+  </h1>
+  <div class="other-language-links">
+    <ul>
+      <li><a href="../../../../en/html/reference/api/grn_info.html"><img src="../../_static/us.png" alt="English">English page</a></li>
+    </ul>
+  </div>
+</div>
+    <div class="related">
+      <h3>ナビゲーション</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="総合索引"
+             accesskey="I">索引</a></li>
+        <li class="right" >
+          <a href="grn_match_escalation.html" title="8.14.13. grn_match_escalation"
+             accesskey="N">次へ</a> |</li>
+        <li class="right" >
+          <a href="grn_index_cursor.html" title="8.14.11. grn_index_cursor"
+             accesskey="P">前へ</a> |</li>
+        <li><a href="../../index.html">groonga v3.0.8ドキュメント</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../api.html" accesskey="U">8.14. API</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="grn-info">
+<h1>8.14.12. <tt class="docutils literal"><span class="pre">grn_info</span></tt><a class="headerlink" href="#grn-info" title="このヘッドラインへのパーマリンク">¶</a></h1>
+<div class="section" id="summary">
+<h2>8.14.12.1. 概要<a class="headerlink" href="#summary" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>TODO...</p>
+</div>
+<div class="section" id="example">
+<h2>8.14.12.2. 実行例:<a class="headerlink" href="#example" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>TODO...</p>
+</div>
+<div class="section" id="reference">
+<h2>8.14.12.3. リファレンス<a class="headerlink" href="#reference" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<dl class="type">
+<dt id="grn_info_type">
+<tt class="descname">grn_info_type</tt><a class="headerlink" href="#grn_info_type" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>TODO...</p>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_get_info">
+<a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a> *<tt class="descname">grn_obj_get_info</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, <a class="reference internal" href="#grn_info_type" title="grn_info_type">grn_info_type</a><em>&nbsp;type</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*valuebuf</em><big>)</big><a class="headerlink" href="#grn_obj_get_info" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objのtypeに対応する情報をvaluebufに格納します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objを指定します。</li>
+<li><strong>type</strong> -- 取得する情報の種類を指定します。</li>
+<li><strong>valuebuf</strong> -- 値を格納するバッファ（呼出側で準備）を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_set_info">
+grn_rc <tt class="descname">grn_obj_set_info</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, <a class="reference internal" href="#grn_info_type" title="grn_info_type">grn_info_type</a><em>&nbsp;type</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*value</em><big>)</big><a class="headerlink" href="#grn_obj_set_info" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objのtypeに対応する情報をvalueの内容に更新します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objを指定します。</li>
+<li><strong>type</strong> -- 設定する情報の種類を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_get_element_info">
+<a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a> *<tt class="descname">grn_obj_get_element_info</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;id</em>, <a class="reference internal" href="#grn_info_type" title="grn_info_type">grn_info_type</a><em>&nbsp;type</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*value</em><big>)</big><a class="headerlink" href="#grn_obj_get_element_info" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objのidに対応するレコードの、typeに対応する情報をvaluebufに格納します。呼出側ではtypeに応じて十分なサイズのバッファを確保しなければいけません。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objを指定します。</li>
+<li><strong>id</strong> -- 対象IDを指定します。</li>
+<li><strong>type</strong> -- 取得する情報の種類を指定します。</li>
+<li><strong>value</strong> -- 値を格納するバッファ（呼出側で準備）を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_set_element_info">
+grn_rc <tt class="descname">grn_obj_set_element_info</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;id</em>, <a class="reference internal" href="#grn_info_type" title="grn_info_type">grn_info_type</a><em>&nbsp;type</em>, <a class="reference internal" href="grn_obj.html#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*value</em><big>)</big><a class="headerlink" href="#grn_obj_set_element_info" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objのidに対応するレコードのtypeに対応する情報をvalueの内容に更新します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+<li><strong>id</strong> -- 対象IDを指定します。</li>
+<li><strong>type</strong> -- 設定する情報の種類を指定します。</li>
+<li><strong>value</strong> -- 設定しようとする値を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../../index.html">目次</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">8.14.12. <tt class="docutils literal"><span class="pre">grn_info</span></tt></a><ul>
+<li><a class="reference internal" href="#summary">8.14.12.1. 概要</a></li>
+<li><a class="reference internal" href="#example">8.14.12.2. 実行例:</a></li>
+<li><a class="reference internal" href="#reference">8.14.12.3. リファレンス</a></li>
+</ul>
+</li>
+</ul>
+  <h4>前のトピックへ</h4>
+  <p class="topless"><a href="grn_index_cursor.html"
+                        title="前の章へ">8.14.11. <tt class="docutils literal docutils literal docutils literal docutils literal"><span class="pre">grn_index_cursor</span></tt></a></p>
+  <h4>次のトピックへ</h4>
+  <p class="topless"><a href="grn_match_escalation.html"
+                        title="次の章へ">8.14.13. <tt class="docutils literal"><span class="pre">grn_match_escalation</span></tt></a></p>
+  <h3>このページ</h3>
+  <ul class="this-page-menu">
+    <li><a href="../../_sources/reference/api/grn_info.txt"
+           rel="nofollow">ソースコードを表示(英語)</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>クイック検索</h3>
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="検索" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    モジュール、クラス、または関数名を入力してください
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>ナビゲーション</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="総合索引"
+             >索引</a></li>
+        <li class="right" >
+          <a href="grn_match_escalation.html" title="8.14.13. grn_match_escalation"
+             >次へ</a> |</li>
+        <li class="right" >
+          <a href="grn_index_cursor.html" title="8.14.11. grn_index_cursor"
+             >前へ</a> |</li>
+        <li><a href="../../index.html">groonga v3.0.8ドキュメント</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../api.html" >8.14. API</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2013, Brazil, Inc.
+    </div>
+  </body>
+</html>

data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_match_escalation.html ADDED Viewed

@@ -0,0 +1,201 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>8.14.13. grn_match_escalation &mdash; groonga v3.0.8ドキュメント</title>
+    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '3.0.8',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <script type="text/javascript" src="../../_static/translations.js"></script>
+    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+    <link rel="top" title="groonga v3.0.8ドキュメント" href="../../index.html" />
+    <link rel="up" title="8.14. API" href="../api.html" />
+    <link rel="next" title="8.14.14. grn_obj" href="grn_obj.html" />
+    <link rel="prev" title="8.14.12. grn_info" href="grn_info.html" />
+  </head>
+  <body>
+<div class="header">
+  <h1 class="title">
+    <a id="top-link" href="../../index.html">
+      <span class="project">groonga</span>
+      <span class="separator">-</span>
+      <span class="description">オープンソースのカラムストア機能付き全文検索エンジン</span>
+    </a>
+  </h1>
+  <div class="other-language-links">
+    <ul>
+      <li><a href="../../../../en/html/reference/api/grn_match_escalation.html"><img src="../../_static/us.png" alt="English">English page</a></li>
+    </ul>
+  </div>
+</div>
+    <div class="related">
+      <h3>ナビゲーション</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="総合索引"
+             accesskey="I">索引</a></li>
+        <li class="right" >
+          <a href="grn_obj.html" title="8.14.14. grn_obj"
+             accesskey="N">次へ</a> |</li>
+        <li class="right" >
+          <a href="grn_info.html" title="8.14.12. grn_info"
+             accesskey="P">前へ</a> |</li>
+        <li><a href="../../index.html">groonga v3.0.8ドキュメント</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../api.html" accesskey="U">8.14. API</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="grn-match-escalation">
+<h1>8.14.13. <tt class="docutils literal"><span class="pre">grn_match_escalation</span></tt><a class="headerlink" href="#grn-match-escalation" title="このヘッドラインへのパーマリンク">¶</a></h1>
+<div class="section" id="summary">
+<h2>8.14.13.1. 概要<a class="headerlink" href="#summary" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>TODO...</p>
+</div>
+<div class="section" id="example">
+<h2>8.14.13.2. 実行例:<a class="headerlink" href="#example" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>TODO...</p>
+</div>
+<div class="section" id="reference">
+<h2>8.14.13.3. リファレンス<a class="headerlink" href="#reference" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<dl class="function">
+<dt id="grn_ctx_get_match_escalation_threshold">
+long long int <tt class="descname">grn_ctx_get_match_escalation_threshold</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em><big>)</big><a class="headerlink" href="#grn_ctx_get_match_escalation_threshold" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>検索の挙動をエスカレーションする閾値を返します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。</p>
+</dd></dl>
+<dl class="function">
+<dt id="grn_ctx_set_match_escalation_threshold">
+grn_rc <tt class="descname">grn_ctx_set_match_escalation_threshold</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, long long int<em>&nbsp;threshold</em><big>)</big><a class="headerlink" href="#grn_ctx_set_match_escalation_threshold" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>検索の挙動をエスカレーションする閾値を変更します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>threshold</strong> -- 変更後の検索の挙動をエスカレーションする閾値を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_get_default_match_escalation_threshold">
+long long int <tt class="descname">grn_get_default_match_escalation_threshold</tt><big>(</big>void<big>)</big><a class="headerlink" href="#grn_get_default_match_escalation_threshold" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>デフォルトの検索の挙動をエスカレーションする閾値を返します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。</p>
+</dd></dl>
+<dl class="function">
+<dt id="grn_set_default_match_escalation_threshold">
+grn_rc <tt class="descname">grn_set_default_match_escalation_threshold</tt><big>(</big>long long int<em>&nbsp;threshold</em><big>)</big><a class="headerlink" href="#grn_set_default_match_escalation_threshold" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>デフォルトの検索の挙動をエスカレーションする閾値を変更します。エスカレーションの詳細は詳細は検索の仕様に関するドキュメントを参照してください。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>threshold</strong> -- 変更後のデフォルトの検索の挙動をエスカレーションする閾値を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../../index.html">目次</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">8.14.13. <tt class="docutils literal"><span class="pre">grn_match_escalation</span></tt></a><ul>
+<li><a class="reference internal" href="#summary">8.14.13.1. 概要</a></li>
+<li><a class="reference internal" href="#example">8.14.13.2. 実行例:</a></li>
+<li><a class="reference internal" href="#reference">8.14.13.3. リファレンス</a></li>
+</ul>
+</li>
+</ul>
+  <h4>前のトピックへ</h4>
+  <p class="topless"><a href="grn_info.html"
+                        title="前の章へ">8.14.12. <tt class="docutils literal docutils literal docutils literal docutils literal"><span class="pre">grn_info</span></tt></a></p>
+  <h4>次のトピックへ</h4>
+  <p class="topless"><a href="grn_obj.html"
+                        title="次の章へ">8.14.14. <tt class="docutils literal"><span class="pre">grn_obj</span></tt></a></p>
+  <h3>このページ</h3>
+  <ul class="this-page-menu">
+    <li><a href="../../_sources/reference/api/grn_match_escalation.txt"
+           rel="nofollow">ソースコードを表示(英語)</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>クイック検索</h3>
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="検索" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    モジュール、クラス、または関数名を入力してください
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>ナビゲーション</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="総合索引"
+             >索引</a></li>
+        <li class="right" >
+          <a href="grn_obj.html" title="8.14.14. grn_obj"
+             >次へ</a> |</li>
+        <li class="right" >
+          <a href="grn_info.html" title="8.14.12. grn_info"
+             >前へ</a> |</li>
+        <li><a href="../../index.html">groonga v3.0.8ドキュメント</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../api.html" >8.14. API</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2013, Brazil, Inc.
+    </div>
+  </body>
+</html>

data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_obj.html ADDED Viewed

@@ -0,0 +1,649 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>8.14.14. grn_obj &mdash; groonga v3.0.8ドキュメント</title>
+    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '3.0.8',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <script type="text/javascript" src="../../_static/translations.js"></script>
+    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+    <link rel="top" title="groonga v3.0.8ドキュメント" href="../../index.html" />
+    <link rel="up" title="8.14. API" href="../api.html" />
+    <link rel="next" title="8.14.15. grn_proc" href="grn_proc.html" />
+    <link rel="prev" title="8.14.13. grn_match_escalation" href="grn_match_escalation.html" />
+  </head>
+  <body>
+<div class="header">
+  <h1 class="title">
+    <a id="top-link" href="../../index.html">
+      <span class="project">groonga</span>
+      <span class="separator">-</span>
+      <span class="description">オープンソースのカラムストア機能付き全文検索エンジン</span>
+    </a>
+  </h1>
+  <div class="other-language-links">
+    <ul>
+      <li><a href="../../../../en/html/reference/api/grn_obj.html"><img src="../../_static/us.png" alt="English">English page</a></li>
+    </ul>
+  </div>
+</div>
+    <div class="related">
+      <h3>ナビゲーション</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="総合索引"
+             accesskey="I">索引</a></li>
+        <li class="right" >
+          <a href="grn_proc.html" title="8.14.15. grn_proc"
+             accesskey="N">次へ</a> |</li>
+        <li class="right" >
+          <a href="grn_match_escalation.html" title="8.14.13. grn_match_escalation"
+             accesskey="P">前へ</a> |</li>
+        <li><a href="../../index.html">groonga v3.0.8ドキュメント</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../api.html" accesskey="U">8.14. API</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="grn-obj">
+<h1>8.14.14. <tt class="docutils literal"><span class="pre">grn_obj</span></tt><a class="headerlink" href="#grn-obj" title="このヘッドラインへのパーマリンク">¶</a></h1>
+<div class="section" id="summary">
+<h2>8.14.14.1. 概要<a class="headerlink" href="#summary" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>TODO...</p>
+</div>
+<div class="section" id="example">
+<h2>8.14.14.2. 実行例:<a class="headerlink" href="#example" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>TODO...</p>
+</div>
+<div class="section" id="reference">
+<h2>8.14.14.3. リファレンス<a class="headerlink" href="#reference" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<dl class="type">
+<dt id="grn_obj">
+<tt class="descname">grn_obj</tt><a class="headerlink" href="#grn_obj" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>TODO...</p>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_column">
+<a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a> *<tt class="descname">grn_obj_column</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*table</em>, const char<em>&nbsp;*name</em>, unsigned int<em>&nbsp;name_size</em><big>)</big><a class="headerlink" href="#grn_obj_column" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>nameがカラム名の場合、それに対応するtableのカラムを返します。対応するカラムが存在しなければNULLを返します。</p>
+<p>nameはアクセサ文字列の場合、それに対応するaccessorを返します。アクセサ文字列とは、カラム名等を'.'で連結した文字列です。'_id', '_key'は特殊なアクセサで、それぞれレコードID/keyを返します。例) 'col1' / 'col2.col3' / 'col2._id'</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>table</strong> -- 対象tableを指定します。</li>
+<li><strong>name</strong> -- カラム名を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_is_builtin">
+grn_bool <tt class="descname">grn_obj_is_builtin</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_is_builtin" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>Check whether groonga built-in object.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first simple">
+<li><strong>ctx</strong> -- context</li>
+<li><strong>obj</strong> -- target object</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">戻り値:</th><td class="field-body"><p class="first last"><tt class="docutils literal"><span class="pre">GRN_TRUE</span></tt> for built-in groonga object, <tt class="docutils literal"><span class="pre">GRN_FALSE</span></tt> otherwise.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_get_value">
+<a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a> *<tt class="descname">grn_obj_get_value</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;id</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*value</em><big>)</big><a class="headerlink" href="#grn_obj_get_value" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+<li><strong>id</strong> -- 対象レコードのIDを指定します。</li>
+<li><strong>value</strong> -- 値を格納するバッファ（呼出側で準備する）を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_get_values">
+int <tt class="descname">grn_obj_get_values</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;offset</em>, void<em>&nbsp;**values</em><big>)</big><a class="headerlink" href="#grn_obj_get_values" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objに指定されたカラムについて、offsetに指定されたレコードIDを開始位置として、IDが連続するレコードに対応するカラム値が昇順に格納された配列へのポインタをvaluesにセットします。</p>
+<p>取得できた件数が戻り値として返されます。エラーが発生した場合は -1 が返されます。</p>
+<div class="admonition note">
+<p class="first admonition-title">ノート</p>
+<p class="last">値が固定長であるカラムのみがobjに指定できます。範囲内のIDに対応するレコードが有効であるとは限りません。delete操作を実行したことのあるテーブルに対しては、<a class="reference internal" href="grn_table.html#grn_table_at" title="grn_table_at"><tt class="xref c c-func docutils literal"><span class="pre">grn_table_at()</span></tt></a> などによって各レコードの存否を別途確認しなければなりません。</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+<li><strong>offset</strong> -- 値を取得する範囲の開始位置となるレコードIDを指定します。</li>
+<li><strong>values</strong> -- 値の配列がセットされます。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_set_value">
+grn_rc <tt class="descname">grn_obj_set_value</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;id</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*value</em>, int<em>&nbsp;flags</em><big>)</big><a class="headerlink" href="#grn_obj_set_value" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objのIDに対応するレコードの値を更新します。対応するレコードが存在しない場合は <tt class="docutils literal"><span class="pre">GRN_INVALID_ARGUMENT</span></tt> を返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+<li><strong>id</strong> -- 対象レコードのIDを指定します。</li>
+<li><strong>value</strong> -- 格納する値を指定します。</li>
+<li><strong>flags</strong> -- <p>以下の値を指定できます。</p>
+<table class="hlist"><tr><td><ul>
+<li><a class="reference internal" href="#GRN_OBJ_SET" title="GRN_OBJ_SET"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_SET</span></tt></a></li>
+<li><a class="reference internal" href="#GRN_OBJ_INCR" title="GRN_OBJ_INCR"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_INCR</span></tt></a></li>
+<li><a class="reference internal" href="#GRN_OBJ_DECR" title="GRN_OBJ_DECR"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_DECR</span></tt></a></li>
+</ul>
+</td><td><ul>
+<li><a class="reference internal" href="#GRN_OBJ_APPEND" title="GRN_OBJ_APPEND"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_APPEND</span></tt></a></li>
+<li><a class="reference internal" href="#GRN_OBJ_PREPEND" title="GRN_OBJ_PREPEND"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_PREPEND</span></tt></a></li>
+<li><a class="reference internal" href="#GRN_OBJ_GET" title="GRN_OBJ_GET"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_GET</span></tt></a></li>
+</ul>
+</td><td><ul>
+<li><a class="reference internal" href="#GRN_OBJ_COMPARE" title="GRN_OBJ_COMPARE"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_COMPARE</span></tt></a></li>
+<li><a class="reference internal" href="#GRN_OBJ_LOCK" title="GRN_OBJ_LOCK"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_LOCK</span></tt></a></li>
+<li><a class="reference internal" href="#GRN_OBJ_UNLOCK" title="GRN_OBJ_UNLOCK"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_UNLOCK</span></tt></a></li>
+</ul>
+</td></tr></table>
+</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_SET_MASK">
+<tt class="descname">GRN_OBJ_SET_MASK</tt><a class="headerlink" href="#GRN_OBJ_SET_MASK" title="この定義へのパーマリンク">¶</a></dt>
+<dd></dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_SET">
+<tt class="descname">GRN_OBJ_SET</tt><a class="headerlink" href="#GRN_OBJ_SET" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>レコードの値をvalueと置き換えます。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_INCR">
+<tt class="descname">GRN_OBJ_INCR</tt><a class="headerlink" href="#GRN_OBJ_INCR" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>レコードの値にvalueを加算します。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_DECR">
+<tt class="descname">GRN_OBJ_DECR</tt><a class="headerlink" href="#GRN_OBJ_DECR" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>レコードの値にvalueを減算します。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_APPEND">
+<tt class="descname">GRN_OBJ_APPEND</tt><a class="headerlink" href="#GRN_OBJ_APPEND" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>レコードの値の末尾にvalueを追加します。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_PREPEND">
+<tt class="descname">GRN_OBJ_PREPEND</tt><a class="headerlink" href="#GRN_OBJ_PREPEND" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>レコードの値の先頭にvalueを追加します。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_GET">
+<tt class="descname">GRN_OBJ_GET</tt><a class="headerlink" href="#GRN_OBJ_GET" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>新しいレコードの値をvalueにセットします。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_COMPARE">
+<tt class="descname">GRN_OBJ_COMPARE</tt><a class="headerlink" href="#GRN_OBJ_COMPARE" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>レコードの値とvalueが等しいか調べます。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_LOCK">
+<tt class="descname">GRN_OBJ_LOCK</tt><a class="headerlink" href="#GRN_OBJ_LOCK" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>当該レコードをロックします。<a class="reference internal" href="#GRN_OBJ_COMPARE" title="GRN_OBJ_COMPARE"><tt class="xref c c-macro docutils literal"><span class="pre">GRN_OBJ_COMPARE</span></tt></a> と共に指定された場合は、レコードの値とvalueが等しい場合に限ってロックします。</p>
+</dd></dl>
+<dl class="macro">
+<dt id="GRN_OBJ_UNLOCK">
+<tt class="descname">GRN_OBJ_UNLOCK</tt><a class="headerlink" href="#GRN_OBJ_UNLOCK" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>当該レコードのロックを解除します。</p>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_remove">
+grn_rc <tt class="descname">grn_obj_remove</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_remove" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objをメモリから解放し、それが永続オブジェクトであった場合は、該当するファイル一式を削除します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_rename">
+grn_rc <tt class="descname">grn_obj_rename</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, const char<em>&nbsp;*name</em>, unsigned int<em>&nbsp;name_size</em><big>)</big><a class="headerlink" href="#grn_obj_rename" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>ctxが使用するdbにおいてobjに対応する名前をnameに更新します。objは永続オブジェクトでなければいけません。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+<li><strong>name</strong> -- 新しい名前を指定します。</li>
+<li><strong>name_size</strong> -- nameパラメータのsize（byte）を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_close">
+grn_rc <tt class="descname">grn_obj_close</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_close" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>一時的なobjectであるobjをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。</p>
+<p>永続的な、table, column, exprなどは解放してはいけません。一般的には、一時的か永続的かを気にしなくてよい <a class="reference internal" href="#grn_obj_unlink" title="grn_obj_unlink"><tt class="xref c c-func docutils literal"><span class="pre">grn_obj_unlink()</span></tt></a> を用いるべきです。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_reinit">
+grn_rc <tt class="descname">grn_obj_reinit</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;domain</em>, unsigned char<em>&nbsp;flags</em><big>)</big><a class="headerlink" href="#grn_obj_reinit" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objの型を変更します。</p>
+<p>objは <tt class="xref c c-func docutils literal"><span class="pre">GRN_OBJ_INIT()</span></tt> マクロなどで初期化済みでなければいけません。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+<li><strong>domain</strong> -- 変更後のobjの型を指定します。</li>
+<li><strong>flags</strong> -- <tt class="docutils literal"><span class="pre">GRN_OBJ_VECTOR</span></tt> を指定するとdomain型の値のベクタを格納するオブジェクトになります。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_unlink">
+void <tt class="descname">grn_obj_unlink</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_unlink" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。</p>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_path">
+const char *<tt class="descname">grn_obj_path</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_path" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objに対応するファイルパスを返します。一時objectならNULLを返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_name">
+int <tt class="descname">grn_obj_name</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, char<em>&nbsp;*namebuf</em>, int<em>&nbsp;buf_size</em><big>)</big><a class="headerlink" href="#grn_obj_name" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objの名前の長さを返します。無名objectなら0を返します。</p>
+<p>名前付きのobjectであり、buf_sizeの長さが名前の長以上であった場合は、namebufに該当する名前をコピーします。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+<li><strong>namebuf</strong> -- 名前を格納するバッファ（呼出側で準備する）を指定します。</li>
+<li><strong>buf_size</strong> -- namebufのサイズ（byte長）を指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_get_range">
+grn_id <tt class="descname">grn_obj_get_range</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_get_range" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objパラメータのとる値の範囲を表わしているオブジェクトのIDを返します。例えば、<a class="reference internal" href="grn_type.html#grn_builtin_type" title="grn_builtin_type"><tt class="xref c c-type docutils literal"><span class="pre">grn_builtin_type</span></tt></a> にある <tt class="docutils literal"><span class="pre">GRN_DB_INT</span></tt> などを返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_expire">
+int <tt class="descname">grn_obj_expire</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, int<em>&nbsp;threshold</em><big>)</big><a class="headerlink" href="#grn_obj_expire" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objの占有するメモリのうち、可能な領域をthresholdを指標として解放します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_check">
+int <tt class="descname">grn_obj_check</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_check" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objに対応するファイルの整合性を検査します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_lock">
+grn_rc <tt class="descname">grn_obj_lock</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;id</em>, int<em>&nbsp;timeout</em><big>)</big><a class="headerlink" href="#grn_obj_lock" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objをlockします。timeout（秒）経過してもlockを取得できない場合は <tt class="docutils literal"><span class="pre">GRN_RESOURCE_DEADLOCK_AVOIDED</span></tt> を返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_unlock">
+grn_rc <tt class="descname">grn_obj_unlock</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, grn_id<em>&nbsp;id</em><big>)</big><a class="headerlink" href="#grn_obj_unlock" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objをunlockします。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_clear_lock">
+grn_rc <tt class="descname">grn_obj_clear_lock</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_clear_lock" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>強制的にロックをクリアします。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_is_locked">
+unsigned int <tt class="descname">grn_obj_is_locked</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_is_locked" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objが現在lockされていれば0以外の値を返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_defrag">
+int <tt class="descname">grn_obj_defrag</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em>, int<em>&nbsp;threshold</em><big>)</big><a class="headerlink" href="#grn_obj_defrag" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objの占有するDBファイル領域のうち、可能な領域をthresholdを指標としてフラグメントの解消を行います。</p>
+<p>フラグメント解消が実行されたセグメントの数を返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_id">
+grn_id <tt class="descname">grn_obj_id</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*obj</em><big>)</big><a class="headerlink" href="#grn_obj_id" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>objのidを返します。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>obj</strong> -- 対象objectを指定します。</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_delete_by_id">
+grn_rc <tt class="descname">grn_obj_delete_by_id</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*db</em>, grn_id<em>&nbsp;id</em>, grn_bool<em>&nbsp;removep</em><big>)</big><a class="headerlink" href="#grn_obj_delete_by_id" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>dbからidに対応するテーブルやカラムなどを削除します。mroonga向けに用意した内部APIです。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>db</strong> -- The target database.</li>
+<li><strong>id</strong> -- The object (table, column and so on) ID to be deleted.</li>
+<li><strong>removep</strong> -- If <tt class="docutils literal"><span class="pre">GRN_TRUE</span></tt>, clear object cache and remove relation between ID and key in database. Otherwise, just clear object cache.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="function">
+<dt id="grn_obj_path_by_id">
+grn_rc <tt class="descname">grn_obj_path_by_id</tt><big>(</big><a class="reference internal" href="grn_ctx.html#grn_ctx" title="grn_ctx">grn_ctx</a><em>&nbsp;*ctx</em>, <a class="reference internal" href="#grn_obj" title="grn_obj">grn_obj</a><em>&nbsp;*db</em>, grn_id<em>&nbsp;id</em>, char<em>&nbsp;*buffer</em><big>)</big><a class="headerlink" href="#grn_obj_path_by_id" title="この定義へのパーマリンク">¶</a></dt>
+<dd><p>dbのidに対応するpathを返します。mroonga向けに用意した内部APIです。</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">パラメタ:</th><td class="field-body"><ul class="first last simple">
+<li><strong>db</strong> -- The target database.</li>
+<li><strong>id</strong> -- The object (table, column and so on) ID to be deleted.</li>
+<li><strong>buffer</strong> -- path string corresponding to the id will be set in this buffer.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../../index.html">目次</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">8.14.14. <tt class="docutils literal"><span class="pre">grn_obj</span></tt></a><ul>
+<li><a class="reference internal" href="#summary">8.14.14.1. 概要</a></li>
+<li><a class="reference internal" href="#example">8.14.14.2. 実行例:</a></li>
+<li><a class="reference internal" href="#reference">8.14.14.3. リファレンス</a></li>
+</ul>
+</li>
+</ul>
+  <h4>前のトピックへ</h4>
+  <p class="topless"><a href="grn_match_escalation.html"
+                        title="前の章へ">8.14.13. <tt class="docutils literal docutils literal docutils literal docutils literal"><span class="pre">grn_match_escalation</span></tt></a></p>
+  <h4>次のトピックへ</h4>
+  <p class="topless"><a href="grn_proc.html"
+                        title="次の章へ">8.14.15. <tt class="docutils literal"><span class="pre">grn_proc</span></tt></a></p>
+  <h3>このページ</h3>
+  <ul class="this-page-menu">
+    <li><a href="../../_sources/reference/api/grn_obj.txt"
+           rel="nofollow">ソースコードを表示(英語)</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>クイック検索</h3>
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="検索" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    モジュール、クラス、または関数名を入力してください
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>ナビゲーション</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="総合索引"
+             >索引</a></li>
+        <li class="right" >
+          <a href="grn_proc.html" title="8.14.15. grn_proc"
+             >次へ</a> |</li>
+        <li class="right" >
+          <a href="grn_match_escalation.html" title="8.14.13. grn_match_escalation"
+             >前へ</a> |</li>
+        <li><a href="../../index.html">groonga v3.0.8ドキュメント</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../api.html" >8.14. API</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2013, Brazil, Inc.
+    </div>
+  </body>
+</html>