Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > e450e7f3d6075c4a54de19e68d38177f > files > 655

groonga-doc-3.0.5-1.fc18.x86_64.rpm


<!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.8.1. QueryExpanderTSV &mdash; groonga v3.0.5ドキュメント</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.5',
        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.5ドキュメント" href="../../index.html" />
    <link rel="up" title="8.8. クエリー展開オブジェクト一覧" href="../query_expanders.html" />
    <link rel="next" title="8.9. 疑似カラム (pseudo_column)" href="../pseudo_column.html" />
    <link rel="prev" title="8.8. クエリー展開オブジェクト一覧" href="../query_expanders.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/query_expanders/tsv.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="../pseudo_column.html" title="8.9. 疑似カラム (pseudo_column)"
             accesskey="N">次へ</a> |</li>
        <li class="right" >
          <a href="../query_expanders.html" title="8.8. クエリー展開オブジェクト一覧"
             accesskey="P">前へ</a> |</li>
        <li><a href="../../index.html">groonga v3.0.5ドキュメント</a> &raquo;</li>
          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
          <li><a href="../query_expanders.html" accesskey="U">8.8. クエリー展開オブジェクト一覧</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="queryexpandertsv">
<h1>8.8.1. QueryExpanderTSV<a class="headerlink" href="#queryexpandertsv" title="このヘッドラインへのパーマリンク">¶</a></h1>
<div class="section" id="summary">
<h2>8.8.1.1. 概要<a class="headerlink" href="#summary" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">QueryExpanderTSV</span></tt> はクエリー展開プラグインです。同義語はTSV(データをタブで区切るファイルフォーマット)ファイルから読み込みます。このプラグインは組み込みのクエリー展開機能よりも機能が少ないです。例えば、単語の正規化をサポートしていません。しかし、TSVファイルで同義語を管理できるためこちらの方が使いやすいかもしれません。TSVファイルなのでExcelなどの表計算ソフトで同義語を編集できます。組み込みのクエリー展開機能では、groongaのテーブルとして同義語を管理します。</p>
</div>
<div class="section" id="install">
<h2>8.8.1.2. インストール<a class="headerlink" href="#install" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">QueryExpanderTSV</span></tt> を使う前に <tt class="docutils literal"><span class="pre">query_expanders/tsv</span></tt> をプラグインとして登録します:</p>
<div class="highlight-none"><div class="highlight"><pre>register query_expanders/tsv
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>8.8.1.3. 使い方<a class="headerlink" href="#usage" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">select</span></tt> コマンドに <tt class="docutils literal"><span class="pre">--query_expansion</span> <span class="pre">QueryExpanderTSV</span></tt> パラメーターを追加します:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;QUERY&quot; --query_expansion QueryExpanderTSV
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">QUERY</span></tt> 内に登録済みの同義語がある場合はそれらが展開されます。例えば、以下の同義語があるとします。</p>
<table border="1" class="docutils">
<colgroup>
<col width="38%" />
<col width="32%" />
<col width="30%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head"><p class="first last">単語</p>
</th>
<th class="head"><p class="first last">同義語1</p>
</th>
<th class="head"><p class="first last">同義語2</p>
</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>groonga</td>
<td>groonga</td>
<td>Senna</td>
</tr>
<tr class="row-odd"><td>mroonga</td>
<td>mroonga</td>
<td>groonga MySQL</td>
</tr>
</tbody>
</table>
<p>この表は、 <tt class="docutils literal"><span class="pre">単語</span></tt> の同義語は <tt class="docutils literal"><span class="pre">同義語1</span></tt> と <tt class="docutils literal"><span class="pre">同義語2</span></tt> という意味です。例えば、 <tt class="docutils literal"><span class="pre">groonga</span></tt> の同義語は <tt class="docutils literal"><span class="pre">groonga</span></tt> と <tt class="docutils literal"><span class="pre">Senna</span></tt> です。また、 <tt class="docutils literal"><span class="pre">mroonga</span></tt> の同義語は <tt class="docutils literal"><span class="pre">mroonga</span></tt> と <tt class="docutils literal"><span class="pre">groonga</span> <span class="pre">MySQL</span></tt> です。</p>
<p>クエリーが <tt class="docutils literal"><span class="pre">groonga</span></tt> のときのクエリー展開の例です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expansion QueryExpanderTSV
</pre></div>
</div>
<p>上記のコマンドは以下のコマンドと同じ意味です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga OR Senna&quot; --query_expansion QueryExpanderTSV
</pre></div>
</div>
<p>クエリーが <tt class="docutils literal"><span class="pre">mroonga</span> <span class="pre">search</span></tt> のときのクエリー展開の例です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;mroonga search&quot; --query_expansion QueryExpanderTSV
</pre></div>
</div>
<p>上記のコマンドは以下のコマンドと同じ意味です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;(mroonga OR (groonga MySQL)) search&quot; --query_expansion QueryExpanderTSV
</pre></div>
</div>
<p>登録されている単語だけ(ここでは <tt class="docutils literal"><span class="pre">groonga</span></tt> と <tt class="docutils literal"><span class="pre">mroonga</span></tt> )クエリー展開されて、登録されていない単語(ここでは <tt class="docutils literal"><span class="pre">search</span></tt> )はクエリー展開されていないことが大事なポイントです。また、再帰的にクエリー展開しません。クエリー展開した結果の <tt class="docutils literal"><span class="pre">(mroonga</span> <span class="pre">OR</span> <span class="pre">(groonga</span> <span class="pre">MySQL))</span></tt> の中に <tt class="docutils literal"><span class="pre">groonga</span></tt> がありますが、これは展開されません。</p>
<p>通常、同義語の中に <tt class="docutils literal"><span class="pre">単語</span></tt> 自身も含める必要があります。例えば、 <tt class="docutils literal"><span class="pre">groonga</span></tt> と <tt class="docutils literal"><span class="pre">mroonga</span></tt> が同義語の中に含まれています。もし、 <tt class="docutils literal"><span class="pre">単語</span></tt> 自身を無視したい場合は同義語の中に <tt class="docutils literal"><span class="pre">単語</span></tt> を含めないでください。例えば、クエリー展開機能をスペル訂正機能として使う場合は、以下のような同義語を使ってください。</p>
<table border="1" class="docutils">
<colgroup>
<col width="54%" />
<col width="46%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head"><p class="first last">単語</p>
</th>
<th class="head"><p class="first last">同義語</p>
</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>gronga</td>
<td>groonga</td>
</tr>
</tbody>
</table>
<p><tt class="docutils literal"><span class="pre">単語</span></tt> の <tt class="docutils literal"><span class="pre">gronga</span></tt> には誤字があります。 <tt class="docutils literal"><span class="pre">o</span></tt> がひとつ足りません。 <tt class="docutils literal"><span class="pre">同義語</span></tt> の <tt class="docutils literal"><span class="pre">groonga</span></tt> が正しい単語です。</p>
<p>スペル訂正機能としてクエリー展開機能を使う例です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;gronga&quot; --query_expansion QueryExpanderTSV
</pre></div>
</div>
<p>上記のコマンドは以下のコマンドと同じ意味です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expansion QueryExpanderTSV
</pre></div>
</div>
<p>前者のコマンドは <tt class="docutils literal"><span class="pre">--query</span></tt> の値に誤字がありますが、後者のコマンドは誤字がありません。</p>
</div>
<div class="section" id="tsv-file">
<h2>8.8.1.4. TSVファイル<a class="headerlink" href="#tsv-file" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>同義語はTSVフォーマットのファイルで定義します。このセクションでは定義方法について説明します。</p>
<div class="section" id="location">
<h3>8.8.1.4.1. 場所<a class="headerlink" href="#location" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>TSVファイルのファイル名は <tt class="docutils literal"><span class="pre">synonyms.tsv</span></tt> で、設定ディレクトリに置かなければいけません。例えば、 <tt class="docutils literal"><span class="pre">/etc/groonga/synonyms.tsv</span></tt> がTSVファイルの場所になります。場所はビルド時に決まります。</p>
<p>環境変数 <tt class="docutils literal"><span class="pre">GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE</span></tt> を指定することで実行時に場所を変更することもできます:</p>
<div class="highlight-none"><div class="highlight"><pre>% env GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE=/tmp/synonyms.tsv groonga
</pre></div>
</div>
<p>上述のコマンドでは <tt class="docutils literal"><span class="pre">/tmp/synonyms.tsv</span></tt> ファイルが使われます。</p>
</div>
<div class="section" id="format">
<h3>8.8.1.4.2. フォーマット<a class="headerlink" href="#format" title="このヘッドラインへのパーマリンク">¶</a></h3>
<p>TSVファイル内に0個以上の同義語を定義することができます。1行につき <tt class="docutils literal"><span class="pre">単語</span></tt> と <tt class="docutils literal"><span class="pre">同義語リスト</span></tt> のペアを定義します。 <tt class="docutils literal"><span class="pre">--query</span></tt> の値の中にでてきた <tt class="docutils literal"><span class="pre">単語</span></tt> は <tt class="docutils literal"><span class="pre">同義語リスト</span></tt> に展開されます。 <tt class="docutils literal"><span class="pre">同義語リスト</span></tt> は <tt class="docutils literal"><span class="pre">OR</span></tt> でまとめます。例えば、同義語リスト <tt class="docutils literal"><span class="pre">groonga</span></tt> と <tt class="docutils literal"><span class="pre">Senna</span></tt> は <tt class="docutils literal"><span class="pre">groonga</span> <span class="pre">OR</span> <span class="pre">Senna</span></tt> と展開されます。</p>
<p>最初のカラムが <tt class="docutils literal"><span class="pre">単語</span></tt> で、残りのカラムが <tt class="docutils literal"><span class="pre">単語</span></tt> の <tt class="docutils literal"><span class="pre">同義語リスト</span></tt> になります。以下は、 <tt class="docutils literal"><span class="pre">単語</span></tt> が <tt class="docutils literal"><span class="pre">groonga</span></tt> で、 <tt class="docutils literal"><span class="pre">同義語リスト</span></tt> が <tt class="docutils literal"><span class="pre">groonga</span></tt> と <tt class="docutils literal"><span class="pre">synonyms</span></tt> の例です。 <tt class="docutils literal"><span class="pre">(TAB)</span></tt> はタブ文字( <tt class="docutils literal"><span class="pre">U+0009</span></tt> )という意味です:</p>
<div class="highlight-none"><div class="highlight"><pre>groonga(TAB)groonga(TAB)Senna
</pre></div>
</div>
<p>コメント行をサポートしています。 <tt class="docutils literal"><span class="pre">#</span></tt> から始まる行は無視します。以下はコメント行の例です。 <tt class="docutils literal"><span class="pre">groonga</span></tt> とある行はコメント行として無視されます:</p>
<div class="highlight-none"><div class="highlight"><pre>#groonga(TAB)groonga(TAB)Senna
mroonga(TAB)mroonga(TAB)groonga MySQL
</pre></div>
</div>
</div>
</div>
<div class="section" id="limitation">
<h2>8.8.1.5. 制限<a class="headerlink" href="#limitation" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>同義語を再読み込みするにはgroongaを再起動する必要があります。TSVファイルはプラグイン読み込み時に一度だけ読み込みます。</p>
</div>
<div class="section" id="see-also">
<h2>8.8.1.6. 参考<a class="headerlink" href="#see-also" title="このヘッドラインへのパーマリンク">¶</a></h2>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="../commands/select.html#query-expansion"><em>query_expansion</em></a></li>
</ul>
</div></blockquote>
</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.8.1. QueryExpanderTSV</a><ul>
<li><a class="reference internal" href="#summary">8.8.1.1. 概要</a></li>
<li><a class="reference internal" href="#install">8.8.1.2. インストール</a></li>
<li><a class="reference internal" href="#usage">8.8.1.3. 使い方</a></li>
<li><a class="reference internal" href="#tsv-file">8.8.1.4. TSVファイル</a><ul>
<li><a class="reference internal" href="#location">8.8.1.4.1. 場所</a></li>
<li><a class="reference internal" href="#format">8.8.1.4.2. フォーマット</a></li>
</ul>
</li>
<li><a class="reference internal" href="#limitation">8.8.1.5. 制限</a></li>
<li><a class="reference internal" href="#see-also">8.8.1.6. 参考</a></li>
</ul>
</li>
</ul>

  <h4>前のトピックへ</h4>
  <p class="topless"><a href="../query_expanders.html"
                        title="前の章へ">8.8. クエリー展開オブジェクト一覧</a></p>
  <h4>次のトピックへ</h4>
  <p class="topless"><a href="../pseudo_column.html"
                        title="次の章へ">8.9. 疑似カラム (pseudo_column)</a></p>
  <h3>このページ</h3>
  <ul class="this-page-menu">
    <li><a href="../../_sources/reference/query_expanders/tsv.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="../pseudo_column.html" title="8.9. 疑似カラム (pseudo_column)"
             >次へ</a> |</li>
        <li class="right" >
          <a href="../query_expanders.html" title="8.8. クエリー展開オブジェクト一覧"
             >前へ</a> |</li>
        <li><a href="../../index.html">groonga v3.0.5ドキュメント</a> &raquo;</li>
          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
          <li><a href="../query_expanders.html" >8.8. クエリー展開オブジェクト一覧</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2009-2013, Brazil, Inc.
    </div>
  </body>
</html>