これはPGroonga 2.X用のドキュメントです。古いPGroongaを使っているならPGroonga 1.xのドキュメントを見てください。

pgroonga_snippet_html関数

概要

pgroonga_snippet_html関数は対象テキストの中からキーワード周辺のテキストを抽出して返します。これはKWIC(keyword in context)とも呼ばれています。Web検索エンジンの結果で使われていることが多いので見たことが多い人も多いでしょう。

構文

この関数の構文は次の通りです。

text[] pgroonga_snippet_html(target, ARRAY[keyword1, keyword2, ...])

targettext型の値です。pgroonga_snippet_htmltargetの中からキーワード周辺のテキストを抽出します。

keyword1, keyword2, ...text型の配列です。これらのキーワードをtargetから抽出します。1つ以上のキーワードを指定する必要があります。

pgroonga_snippet_htmltext型の配列を返します。

返ってくる配列の各要素はキーワード周辺のテキストです。

キーワードは<span class="keyword"></span>で囲まれます。target中の<>&"はHTMLエスケープされます。

各要素のtarget由来の部分の最大サイズは200バイトです。単位は文字数ではなくバイトです。各要素は200バイトより大きくなることがありまう。なぜなら、各要素には<span class="keyword"></span>が含まれますし、HTMLエスケープした値が含まれることもあるからです。もし、<がHTMLエスケープされると&lt;になり、バイトサイズは1から4に増えます。

使い方

チュートリアルの中の例も参考にしてください。

参考