7.14.8. highlight_html

バージョン 4.0.5 で追加.

7.14.8.1. 概要

highlight_html は対象テキストをタグ付けします。検索文字列をハイライトさせるために利用することができます。タグ付けされたテキストはHTML中に埋め込みやすいように処理されています。<> などの特殊文字は &lt; や &gt; にエスケープされています。キーワードは <span class="keyword"></span> で囲まれています。たとえば、 I am a groonga user. <3 という対象テキストのキーワード groonga でタグ付けされたテキストは I am a <span class="keyword">groonga</span> user. &lt;3 となります。

7.14.8.2. 構文

この関数の引数は1つです。:

highlight_html(text)

7.14.8.3. 使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries body COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms document_index COLUMN_INDEX|WITH_POSITION Entries body
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{"body": "Mroonga is a MySQL storage engine based on Groonga. <b>Rroonga</b> is a Ruby binding of Groonga."}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

highlight_htmlselect コマンドの --output_columns 内でのみ指定できます。

highlight_html を使うには コマンドバージョン 2以降を使う必要があります。

また、 --query--filter オプションも指定する必要があります。(どちらか一方でも構いません。)これは、 --query--filter オプションからキーワードを抽出しているためです。

以下の例は --query "groonga mysql" を使っています。この場合は、キーワードとして groongamysql を使います。

実行例:

select Entries --output_columns --match_columns body --query 'groonga mysql' --output_columns 'highlight_html(body)' --command_version 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "highlight_html",
#           null
#         ]
#       ],
#       [
#         "Mroonga is a <span class=\"keyword\">MySQL</span> storage engine based on <span class=\"keyword\">Groonga</span>. &lt;b&gt;Rroonga&lt;/b&gt; is a Ruby binding of <span class=\"keyword\">Groonga</span>."
#       ]
#     ]
#   ]
# ]

キーワードとテキストは NormalizerAuto ノーマライザーで正規化されてタグ付けのためにスキャンされます。

--query "groonga mysql" は最初のレコードにマッチします。highlight_html(body) は、テキスト中に含まれるキーワード groongamysql<span class="keyword"></span> で囲みます。

カラムの代わりに文字列リテラルを指定することもできます。

実行例:

select Entries --output_columns 'highlight_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns body --query "groonga"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "highlight_html",
#           null
#         ]
#       ],
#       [
#         "<span class=\"keyword\">Groonga</span> is very fast fulltext search engine."
#       ]
#     ]
#   ]
# ]

7.14.8.4. 引数

このセクションではすべての引数について説明します。

7.14.8.4.1. 必須引数

1つだけ必須の引数があります。

7.14.8.4.1.1. text

HTMLでハイライトする対象のテキストです。

7.14.8.4.2. 省略可能引数

省略可能な引数はありません。

7.14.8.5. 戻り値

highlight_html はタグ付の文字列もしくは null を返します。highlight_html は該当するキーワードがない場合に null を返します。

7.14.8.6. 参考