5.5.1. mroonga_command()

Added in version 3.02.

5.5.1.1. Summary

mroonga_command() UDF executes the given string as a Groonga command and returns result of the Groonga command. Groonga command will be faster than MySQL query.

mroonga_command() is an UDF for advanced users. Normally, you don’t need to use this UDF.

Warning

mroonga_command() sends the given command to Groonga directly. It bypasses the privilege control of MySQL/MariaDB. Don’t register this UDF on a multi-user system that relies on privilege separation of accounts.

5.5.1.2. Install

Changed in version 16.13: install.sql doesn’t register mroonga_command().

If you need mroonga_command(), use install_mroonga_command.sql in the same directory as install.sql:

$ mysql -u root < /usr/share/mroonga/install_mroonga_command.sql

5.5.1.3. Syntax

mroonga_command() has only one required parameter:

mroonga_command(command)

command is a string value. It’s a Groonga command to be executed.

5.5.1.4. Usage

TODO

5.5.1.5. Parameters

5.5.1.5.1. Required parameters

There is one required parameter, command.

5.5.1.5.1.1. command

It specifies a Groonga command to be executed.

5.5.1.6. Return value

It returns an evaluated result of the given Groonga command as a string.

5.5.1.7. See also

Command in Groonga document.