7.1.6. Groonga HTTPサーバー — Groonga v7.0.6ドキュメント

# groonga - オープンソースのカラムストア機能付き全文検索エンジン

- English

# 7.1.6. Groonga HTTPサーバー

## 7.1.6.1. 名前

Groonga HTTPサーバー

## 7.1.6.2. 書式

    groonga -d --protocol http DB_PATH

## 7.1.6.3. 概要

Groongaサーバを起動する時に `--protocol` オプションに `http` を指定すると、HTTPで通信可能になります。また、 `--document-root` によって静的ページのパスを指定すると、HTTPリクエストに指定されたURIに対応する、パス配下に置かれたファイルを出力します。

GroongaにはHTML + JavaScriptで実装された管理ツールが標準で付属しています。 `--document-root` を指定しない場合は管理ツールがインストールされているパスが指定されたとみなされますので、ウェブブラウザで `http://HOSTNAME:PORT/` にアクセスすると、管理ツールを利用できます。

## 7.1.6.4. コマンド

`http` を指定して起動したGroongaサーバーに対しても、他のモードで起動したGroongaと同じコマンドが使用できます。

コマンドは、複数の引数をとります。引数にはそれぞれ名前があります。また、特殊な引数である `output_type` と `command_version` があります。

スタンドアロンやクライアントモードでは、コマンドは以下のような形式で指定します。

> 形式1: コマンド名 値1 値2,..

> 形式2: コマンド名 --引数名1 値1 --引数名2 値2,..

形式1と形式2は混在させることができます。これらの形式では、 `output_type` という引数名を用いて出力形式を指定します。

HTTPでGroongaサーバーと通信する際には、以下のような形式でコマンドを指定します。:

    Format: /d/COMMAND_NAME.OUTPUT_TYPE?ARGUMENT_NAME1=VALUE1&ARGUMENT_NAME2=VALUE2&...

ただし、コマンド名、引数名、値はURLエンコードが必要です。

GETメソッドのみが使用可能です。

出力形式にはJSON, TSV, XMLが指定可能です。

`command_version` はコマンドの仕様の互換性を指定します。詳細は コマンドバージョン を参照してください。

## 7.1.6.5. 戻り値

出力形式の指定に従って、コマンドの実行結果を出力します。