5.5.1. mroonga_command() — Mroonga vmrn_version documentation

Skip to main content
`Ctrl`+`K`

# 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.

## 5.5.1.2. 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.3. Usage

TODO

## 5.5.1.4. Parameters

### 5.5.1.4.1. Required parameters

There is one required parameter, `command`.

#### 5.5.1.4.1.1. `command`

It specifies a Groonga command to be executed.

## 5.5.1.5. Return value

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

## 5.5.1.6. See also

Command in Groonga document.