これはPGroonga 1.X用のドキュメントです。新しいPGroongaを使っているならPGroonga 2.xのドキュメントを見てください。
pgroonga.snippet_html
関数pgroonga.snippet_html
関数は対象テキストの中からキーワード周辺のテキストを抽出して返します。これはKWIC(keyword in context)とも呼ばれています。Web検索エンジンの結果で使われていることが多いので見たことが多い人も多いでしょう。
この関数の構文は次の通りです。
text[] pgroonga.snippet_html(target, ARRAY[keyword1, keyword2, ...])
target
はtext
型の値です。pgroonga.snippet_html
はtarget
の中からキーワード周辺のテキストを抽出します。
keyword1
, keyword2
, ...
はtext
型の配列です。これらのキーワードをtarget
から抽出します。1つ以上のキーワードを指定する必要があります。
pgroonga.snippet_html
はtext
型の配列を返します。
返ってくる配列の各要素はキーワード周辺のテキストです。
キーワードは<span class="keyword">
と</span>
で囲まれます。target
中の<
、>
、&
、"
はHTMLエスケープされます。
各要素のtarget
由来の部分の最大サイズは200バイトです。単位は文字数ではなくバイトです。各要素は200バイトより大きくなることがあります。なぜなら、各要素には<span class="keyword">
と</span>
が含まれますし、HTMLエスケープした値が含まれることもあるからです。もし、<
がHTMLエスケープされると<
になり、バイトサイズは1から4に増えます。
チュートリアルの中の例も参考にしてください。