これはPGroonga 2.X用のドキュメントです。古いPGroongaを使っているならPGroonga 1.xのドキュメントを見てください。
pgroonga_highlight_html
関数1.0.7で追加。
pgroonga_highlight_html
関数は指定したテキスト中にある指定したキーワードを<span class="keyword">
と</span>
で囲みます。指定したテキスト中にある&
などのHTMLの特別な文字はエスケープされます。
使い方は2つあります。
text pgroonga_highlight_html(target, ARRAY[keyword1, keyword2, ...])
text pgroonga_highlight_html(target, ARRAY[keyword1, keyword2, ...], index_name)
1つ目の使い方は他の使い方よりもシンプルです。多くの場合は1つ目の使い方で十分です。
2つ目の使い方はノーマライザーを変更しているときに便利です。
2つ目の使い方は2.0.7から使えます。
以下は1つ目の使い方の説明です。
text pgroonga_highlight_html(target, ARRAY[keyword1, keyword2, ...])
target
はハイライト対象のテキストです。型はtext
です。
キーワードは<span class="keyword">
と</span>
で囲まれています。target
中の<
、>
、&
、"
はHTMLエスケープされます。
pgroonga_highlight_html
はtarget
中のキーワードをマークアップします。型はtext
です。
キーワードは<span class="keyword">
と</span>
で囲まれます。target
中の<
、>
、&
、"
はHTMLエスケープされます。
以下は2つ目の使い方の説明です。
text pgroonga_highlight_html(target, ARRAY[keyword1, keyword2, ...], index_name)
target
はハイライト対象のテキストです。型はtext
です。
キーワードは<span class="keyword">
と</span>
で囲まれています。target
中の<
、>
、&
、"
はHTMLエスケープされます。
index_name
は対応するPGroongaのインデックス名です。text
型です。
index_name
にはNULL
を指定できます。
NormalizerNFKC100
のようにNormalizerAuto
以外のノーマライザーを使っている場合は、index_name
を使うとよいです。この関数はデフォルトでNormalizerAuto
ノーマライザーを使います。これにより意図しない結果になることがあります。
index_name
を指定した場合は、指定したPGroongaのインデックスには"report_source_location"
オプションを指定したTokenNgram
トークナイザーを指定しないといけません。
例です。
CREATE TABLE memos (
content text
);
CREATE INDEX pgroonga_content_index
ON memos
USING pgroonga (content)
WITH (tokenizer='TokenNgram("report_source_location", true)',
normalizer='NormalizerNFKC100');
これでindex_name
にpgroonga_content_index
を指定できます。
SELECT pgroonga_highlight_html('one two three four five',
ARRAY['two three', 'five'],
'pgroonga_content_index');
-- pgroonga_highlight_html
-- -----------------------------------------------------------------------------------
-- one<span class="keyword"> two three</span> four<span class="keyword"> five</span>
-- (1 row)
pgroonga_highlight_html
はtarget
中のキーワードをマークアップします。型はtext
です。
キーワードは<span class="keyword">
と</span>
で囲まれます。target
中の<
、>
、&
、"
はHTMLエスケープされます。
2.0.7から使えます。
少なくとも1つキーワードを指定しなければいけません。
SELECT pgroonga_highlight_html('PGroonga is a PostgreSQL extension.',
ARRAY['PostgreSQL']) AS highlight_html;
-- highlight_html
-- ------------------------------------------------------------------
-- PGroonga is a <span class="keyword">PostgreSQL</span> extension.
-- (1 row)
複数のキーワードを指定できます。
SELECT pgroonga_highlight_html('PGroonga is a PostgreSQL extension.',
ARRAY['Groonga', 'PostgreSQL']) AS highlight_html;
-- highlight_html
-- -----------------------------------------------------------------------------------------------
-- P<span class="keyword">Groonga</span> is a <span class="keyword">PostgreSQL</span> extension.
-- (1 row)
pgroonga_query_extract_keywords
関数を使うとクエリーからキーワードを抽出できます。
SELECT pgroonga_highlight_html('PGroonga is a PostgreSQL extension.',
pgroonga_query_extract_keywords('Groonga PostgreSQL -extension')) AS highlight_html;
-- highlight_html
-- -----------------------------------------------------------------------------------------------
-- P<span class="keyword">Groonga</span> is a <span class="keyword">PostgreSQL</span> extension.
-- (1 row)
HTMLの特別な文字は自動でエスケープされます。
SELECT pgroonga_highlight_html('<p>PGroonga is Groonga & PostgreSQL.</p>',
ARRAY['PostgreSQL']) AS highlight_html;
-- highlight_html
-- ---------------------------------------------------------------------------------------
-- <p>PGroonga is Groonga & <span class="keyword">PostgreSQL</span>.</p>
-- (1 row)
文字は正規化されます。
SELECT pgroonga_highlight_html('PGroonga + pglogical = replicatable!',
ARRAY['Pg']) AS highlight_html;
-- highlight_html
-- ------------------------------------------------------------------------------------------------
-- <span class="keyword">PG</span>roonga + <span class="keyword">pg</span>logical = replicatable!
-- (1 row)
マルチバイト文字にも対応しています。
SELECT pgroonga_highlight_html('10㌖先にある100キログラムの米',
ARRAY['キロ']) AS highlight_html;
-- highlight_html
-- ---------------------------------------------------------------------------------------
-- 10<span class="keyword">㌖</span>先にある100<span class="keyword">キロ</span>グラムの米
-- (1 row)
PGroongaのインデックス名を指定するとトークナイザーとノーマライザーをカスタマイズできます。
CREATE TABLE memos (
content text
);
CREATE INDEX pgroonga_content_index
ON memos
USING pgroonga (content)
WITH (tokenizer='TokenNgram("report_source_location", true)',
normalizer='NormalizerNFKC100');
SELECT pgroonga_highlight_html('one two three four five',
ARRAY['two three', 'five'],
'pgroonga_content_index');
-- pgroonga_highlight_html
-- -----------------------------------------------------------------------------------
-- one<span class="keyword"> two three</span> four<span class="keyword"> five</span>
-- (1 row)