Highlight keywords within a text string using HTML tags, making it easy to display search results with matched terms emphasized.
mroonga_highlight_html(text[[, query AS query]])
mroonga_highlight_html(text[[, keyword1, ..., keywordN]])mroonga_highlight_html is a (UDF) included with the . It highlights the specified keywords in the target text. See for details on creating this UDF if required.
The optional parameter can either be one or more keywords, or a Groonga query.
The function highlights the specified keywords in the target text by surrounding each keyword with <span class="keyword">...</span>, and escaping special HTML characters such as < and >.
Returns highlighted HTML.
Highlighting the words MariaDB and Mroonga in a given text:
The same outcome, formulated as a Groonga query:
This page is licensed: CC BY-SA / Gnu FDL
SELECT mroonga_highlight_html('<p>MariaDB includes the Mroonga storage engine</p>.')
AS highlighted_html;
+-----------------------------------------------------------------+
| highlighted_html |
+-----------------------------------------------------------------+
| <p>MariaDB includes the Mroonga storage engine</p>. |
+-----------------------------------------------------------------+SELECT mroonga_highlight_html('MariaDB includes the Mroonga storage engine.', 'MariaDB', 'Mroonga')
AS highlighted_html;
+--------------------------------------------------------------------------------------------------------+
| highlighted_html |
+--------------------------------------------------------------------------------------------------------+
| <span class="keyword">MariaDB</span> includes the <span class="keyword">Mroonga</span> storage engine. |
+--------------------------------------------------------------------------------------------------------+SELECT mroonga_highlight_html('MariaDB includes the Mroonga storage engine.', 'MariaDB OR Mroonga'
AS query) AS highlighted_text;
+--------------------------------------------------------------------------------------------------------+
| highlighted_text |
+--------------------------------------------------------------------------------------------------------+
| <span class="keyword">MariaDB</span> includes the <span class="keyword">Mroonga</span> storage engine. |
+--------------------------------------------------------------------------------------------------------+