5.5.3. mroonga_highlight_html()

バージョン 7.05 で追加.

5.5.3.1. 概要

mroonga_highlight_html() UDFは対象となるカラムや文字列をハイライトする機能を提供します。

5.5.3.2. 構文

mroonga_highlight_html() には必須引数と省略可能引数とがあります。:

mroonga_highlight_html(document, word1, ..., wordN)

mroonga_highlight_html(document, query)

5.5.3.3. 使いかた

'mroonga'というキーワードで対象となるテキストのハイライトをするクエリーです。

SELECT mroonga_highlight_html('Mroonga is the Groonga based storage engine.',
                              'mroonga') AS highlighted;

実行結果がこちらです。

+---------------------------------------------------------------------------+
| highlighted                                                               |
+---------------------------------------------------------------------------+
| <span class="keyword">Mroonga</span> is the Groonga based storage engine. |
+---------------------------------------------------------------------------+
1 row in set (0.00 sec)

5.5.3.4. 引数

5.5.3.4.1. 必須引数

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

5.5.3.4.1.1. document

カラム名もしくは文字列が必要です。

5.5.3.4.2. 省略可能引数

いくつか省略可能な引数があります。

5.5.3.4.2.1. wordN

任意の単語指定します。

5.5.3.4.2.2. query

任意のキーワードやプラグマを指定します。

5.5.3.5. 返り値

ハイライトされたHTMLを返します。省略可能な引数が指定されない場合、単に document をそのまま返します。