5.3. mroonga_highlight_html()

バージョン 7.05 で追加.

5.3.1. 概要

mroonga_highlight_html() highlights the specified keywords in target text. It surrounds each keyword with <span class="keyword">...</span> and special characters in HTML such as < and > are escaped. You can use the result as is safely in HTML.

5.3.2. 構文

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

mroonga_highlight_html(text, query AS query)

mroonga_highlight_html(text, keyword1, ..., keywordN)

AS query is very important. You must specify it to extract keywords from query.

5.3.3. 使いかた

Here is a sample to highlight keywords "mroonga" and "groonga" in target text by query "mroonga OR groonga". You must specify AS query:

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

実行結果はこちらです。:

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

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

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

実行結果はこちらです。:

+--------------------------------------------------------------------------------------------------------+
| highlighted                                                                                            |
+--------------------------------------------------------------------------------------------------------+
| <span class="keyword">Mroonga</span> is the <span class="keyword">Groonga</span> based storage engine. |
+--------------------------------------------------------------------------------------------------------+

5.3.4. 引数

5.3.4.1. 必須引数

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

5.3.4.1.1. text

ハイライトされるカラム名もしくは文字列が必要です。

5.3.4.2. 省略可能引数

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

5.3.4.2.1. query

詳細は Groongaのクエリー構文 を参照してください。

You must specify AS query to extract keywords from query like the following:

SELECT mroonga_highlight_html('...', 'mroonga OR groonga' AS query);

5.3.4.2.2. keyword

Specify 0 or more keywords to be highlighted.

5.3.5. 返り値

ハイライトされたHTMLを返します。省略可能な引数が指定されない場合、text に含まれるHTMLの特殊文字 <> をエスケープします。