# groonga - An open-source fulltext search engine and column store.

- 日本語版はこちら

### Navigation

- index
- next |
- previous |
- Groonga v4.0.2-145-gc632eed documentation »
- 8. Reference manual »
- 8.3. Command »

# 8.3.24. `ruby_load`

## 8.3.24.1. Summary

`ruby_load` command loads specified Ruby script.

## 8.3.24.2. Syntax

`ruby_load` has one required parameter:

    ruby_load path

## 8.3.24.3. Usage

You can load any script file which mruby supports by calling `ruby_load`.

Here is an example that just load `expression.rb` as Ruby script.

Execution example:

    register ruby/load
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    ruby_load "expression.rb"
    # [[0, 1337566253.89858, 0.000355720520019531], {"value": null}]

Register `ruby/load` plugin to use `ruby_load` command in advance.

Note that `ruby_load` is implemented as an experimental plugin, and the specification may be changed in the future.

## 8.3.24.4. Parameters

This section describes all parameters.

### 8.3.24.4.1. `path`

It specifies the Ruby script path which you want to load.

## 8.3.24.5. Return value

`ruby_load` returns the loaded result with metadata such as exception information (Including metadata isn't implemented yet):

    [HEADER, {"value": LOADED_VALUE}]

`HEADER`

> See Output format about `HEADER`.

`LOADED_VALUE`

> `LOADED_VALUE` is the loaded value of ruby script.

> `ruby_load` just return `null` as `LOADED_VALUE` for now, it will be supported in the future.

## 8.3.24.6. See also

ruby_eval

### Navigation

- index
- next |
- previous |
- Groonga v4.0.2-145-gc632eed documentation »
- 8. Reference manual »
- 8.3. Command »