<!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.11.9. snippet_html — 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.11. 関数" href="../function.html" />
<link rel="next" title="8.11.10. sub_filter" href="sub_filter.html" />
<link rel="prev" title="8.11.8. rand" href="rand.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/functions/snippet_html.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="sub_filter.html" title="8.11.10. sub_filter"
accesskey="N">次へ</a> |</li>
<li class="right" >
<a href="rand.html" title="8.11.8. rand"
accesskey="P">前へ</a> |</li>
<li><a href="../../index.html">groonga v3.0.5ドキュメント</a> »</li>
<li><a href="../../reference.html" >8. リファレンスマニュアル</a> »</li>
<li><a href="../function.html" accesskey="U">8.11. 関数</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="snippet-html">
<h1>8.11.9. snippet_html<a class="headerlink" href="#snippet-html" title="このヘッドラインへのパーマリンク">¶</a></h1>
<div class="admonition caution">
<p class="first admonition-title">ご用心</p>
<p class="last">この機能は実験的です。APIが変わる可能性があります。</p>
</div>
<div class="section" id="summary">
<h2>8.11.9.1. 概要<a class="headerlink" href="#summary" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">snippet_html</span></tt> は対象テキスト中から検索キーワード周辺のテキスト（ <tt class="docutils literal"><span class="pre">KWIC</span></tt> 。 <tt class="docutils literal"><span class="pre">KeyWord</span> <span class="pre">In</span> <span class="pre">Context</span></tt> ）を抽出します。抽出されたテキストのことをスニペットと呼びます。スニペットはHTML中に埋め込みやすいように処理されています。 <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">&lt;</span></tt> や <tt class="docutils literal"><span class="pre">&gt;</span></tt> にエスケープされています。キーワードは <tt class="docutils literal"><span class="pre"><span</span> <span class="pre">class="keyword"></span></tt> と <tt class="docutils literal"><span class="pre"></span></span></tt> で囲まれています。たとえば、 <tt class="docutils literal"><span class="pre">I</span> <span class="pre">am</span> <span class="pre">a</span> <span class="pre">groonga</span> <span class="pre">user.</span> <span class="pre"><3</span></tt> という対象テキストのキーワード <tt class="docutils literal"><span class="pre">groonga</span></tt> でのスニペットは <tt class="docutils literal"><span class="pre">I</span> <span class="pre">am</span> <span class="pre">a</span> <span class="pre"><span</span> <span class="pre">class="keyword">groonga</span></span> <span class="pre">user.</span> <span class="pre">&lt;3</span></tt> となります。</p>
</div>
<div class="section" id="syntax">
<h2>8.11.9.2. 構文<a class="headerlink" href="#syntax" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">snippet_html</span></tt> の引数は1つだけです:</p>
<div class="highlight-none"><div class="highlight"><pre>snippet_html(column)
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">snippet_html</span></tt> は内部にはたくさんのオプションがありますが、今はまだ指定できません。じきに指定できるようになる予定です。</p>
</div>
<div class="section" id="usage">
<h2>8.11.9.3. 使い方<a class="headerlink" href="#usage" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。</p>
<p>実行例:</p>
<div class="highlight-none"><div class="highlight"><pre>table_create Documents TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Documents content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms documents_content_index COLUMN_INDEX|WITH_POSITION Documents content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Documents
[
["content"],
["Groonga is a fast and accurate full text search engine based on inverted index. One of the characteristics of groonga is that a newly registered document instantly appears in search results. Also, groonga allows updates without read locks. These characteristics result in superior performance on real-time applications."],
["Groonga is also a column-oriented database management system (DBMS). Compared with well-known row-oriented systems, such as MySQL and PostgreSQL, column-oriented systems are more suited for aggregate queries. Due to this advantage, groonga can cover weakness of row-oriented systems."]
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">snippet_html</span></tt> は <a class="reference internal" href="../commands/select.html"><em>select</em></a> コマンドの <tt class="docutils literal"><span class="pre">--output_columns</span></tt> 内でのみ指定できます。</p>
<p>groonga 2.0.9では <tt class="docutils literal"><span class="pre">output_columns</span></tt> 内での関数呼び出しはまだ実験的な機能なので、明示的に <tt class="docutils literal"><span class="pre">--command_version</span> <span class="pre">2</span></tt> オプションを指定する必要があります。この機能はじきに有効になる予定です。</p>
<p>また、 <tt class="docutils literal"><span class="pre">--query</span></tt> と <tt class="docutils literal"><span class="pre">--filter</span></tt> オプションも指定する必要があります。（どちらか一方でも構いません。）これは、 <tt class="docutils literal"><span class="pre">--query</span></tt> と <tt class="docutils literal"><span class="pre">--filter</span></tt> オプションからキーワードを抽出しているためです。</p>
<p>以下の例は <tt class="docutils literal"><span class="pre">--query</span> <span class="pre">"fast</span> <span class="pre">performance"</span></tt> を使っています。この場合は、キーワードとして <tt class="docutils literal"><span class="pre">fast</span></tt> と <tt class="docutils literal"><span class="pre">performance</span></tt> を使います。</p>
<p>実行例:</p>
<div class="highlight-none"><div class="highlight"><pre>select Documents --output_columns "snippet_html(content)" --command_version 2 --match_columns content --query "fast performance"
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "snippet_html",
# "null"
# ]
# ],
# [
# [
# "Groonga is a <span class=\"keyword\">fast</span> and accurate full text search engine based on inverted index. One of the characteristics of groonga is that a newly registered document instantly appears in search results. Also, gro",
# "onga allows updates without read locks. These characteristics result in superior <span class=\"keyword\">performance</span> on real-time applications."
# ]
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">--query</span> <span class="pre">"fast</span> <span class="pre">performance"</span></tt> は最初のレコードの内容にだけマッチします。 <tt class="docutils literal"><span class="pre">snippet_html(content)</span></tt> は、テキスト中からキーワード <tt class="docutils literal"><span class="pre">fast</span></tt> と <tt class="docutils literal"><span class="pre">performance</span></tt> の少なくともどちらか一方を含んでいるテキストの断片を抽出します。今回は2箇所抽出しています。そして、抽出したテキストの断片内にあるキーワードを <tt class="docutils literal"><span class="pre"><span</span> <span class="pre">class="keyword"></span></tt> と <tt class="docutils literal"><span class="pre"></span></span></tt> で囲みます。</p>
<p>テキストの断片数は多くても3です。4つ以上のテキストの断片が抽出できるときは、最初の3つだけを使います。</p>
<p>テキストの断片の最大サイズは200バイトです。単位は文字数ではなくバイトです。挿入される <tt class="docutils literal"><span class="pre"><span</span> <span class="pre">keyword="keyword"></span></tt> と <tt class="docutils literal"><span class="pre"></span></span></tt> のバイト数はこのサイズの中には含まれません。</p>
<p>テキストの断片の最大数とテキストの断片の最大サイズはカスタマイズできません。</p>
<p>カラムの代わりに文字列リテラルを指定することもできます。</p>
<p>実行例:</p>
<div class="highlight-none"><div class="highlight"><pre>select Documents --output_columns 'snippet_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns content --query "fast performance"
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "snippet_html",
# "null"
# ]
# ],
# [
# [
# "Groonga is very <span class=\"keyword\">fast</span> fulltext search engine."
# ]
# ]
# ]
# ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="return-value">
<h2>8.11.9.4. 戻り値<a class="headerlink" href="#return-value" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">snippet_html</span></tt> は文字列の配列を返します。それぞれの要素がスニペットになります:</p>
<div class="highlight-none"><div class="highlight"><pre>[SNIPPET1, SNIPPET2, SNIPPET3]
</pre></div>
</div>
<p>スニペットには1つ以上のキーワードが含まれています。 <tt class="docutils literal"><span class="pre"><span</span> <span class="pre">keyword="keyword"></span></tt> と <tt class="docutils literal"><span class="pre"></span></span></tt> を除いたスニペットの最大サイズは200byteです。単位は文字数ではなくてバイトです。</p>
<p>配列のサイズは0以上3以下です。最大サイズの3は、じきにカスタマイズできるようになる予定です。</p>
</div>
<div class="section" id="todo">
<h2>8.11.9.5. TODO<a class="headerlink" href="#todo" title="このヘッドラインへのパーマリンク">¶</a></h2>
<ul class="simple">
<li><p class="first">テキストの断片の最大数をカスタマイズできるようにする。</p>
</li>
<li><p class="first">テキストの断片最大サイズをカスタマイズできるようにする。</p>
</li>
<li><p class="first">キーワードをカスタマイズできるようにする。</p>
</li>
<li><p class="first">キーワードを囲むタグをカスタマイズできるようにする。</p>
</li>
<li><p class="first">正規化の方法をカスタマイズできるようにする。</p>
</li>
<li><p class="first">オブジェクトリテラル形式でのオプション指定をサポートする。</p>
</li>
</ul>
</div>
<div class="section" id="see-also">
<h2>8.11.9.6. 参考<a class="headerlink" href="#see-also" title="このヘッドラインへのパーマリンク">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="../commands/select.html"><em>select</em></a></li>
</ul>
</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.11.9. snippet_html</a><ul>
<li><a class="reference internal" href="#summary">8.11.9.1. 概要</a></li>
<li><a class="reference internal" href="#syntax">8.11.9.2. 構文</a></li>
<li><a class="reference internal" href="#usage">8.11.9.3. 使い方</a></li>
<li><a class="reference internal" href="#return-value">8.11.9.4. 戻り値</a></li>
<li><a class="reference internal" href="#todo">8.11.9.5. TODO</a></li>
<li><a class="reference internal" href="#see-also">8.11.9.6. 参考</a></li>
</ul>
</li>
</ul>
<h4>前のトピックへ</h4>
<p class="topless"><a href="rand.html"
title="前の章へ">8.11.8. rand</a></p>
<h4>次のトピックへ</h4>
<p class="topless"><a href="sub_filter.html"
title="次の章へ">8.11.10. sub_filter</a></p>
<h3>このページ</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/reference/functions/snippet_html.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="sub_filter.html" title="8.11.10. sub_filter"
>次へ</a> |</li>
<li class="right" >
<a href="rand.html" title="8.11.8. rand"
>前へ</a> |</li>
<li><a href="../../index.html">groonga v3.0.5ドキュメント</a> »</li>
<li><a href="../../reference.html" >8. リファレンスマニュアル</a> »</li>
<li><a href="../function.html" >8.11. 関数</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2013, Brazil, Inc.
</div>
</body>
</html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
e450e7f3d6075c4a54de19e68d38177f
>
files
>
642
