2.2. ネットワークを通じた利用

groongaはネットワークを通じて利用することができます。groonga独自プロトコルもしくはHTTPのどちらかを選択してgroongaを起動することにより、groongaはネットワーク接続を待ち受けます。

2.2.1. groonga専用プロトコルによる通信

2.2.1.1. groongaデーモンの起動

書式

groonga [-p ポート番号] -d DBパス名

既存のデータベースのフルパス名をDBパス名に指定します。 groongaがデーモンモードで起動し、指定したポート番号でgroongaの専用プロトコルを用いた通信をすることができます。 (ポート番号を省略した場合は10041が使用されます)

実行例:

% groonga -d /var/tmp/hoge.db
12345
%

デーモンモードで起動後、プロセス番号が表示されます。

2.2.1.2. groongaサーバへの接続

書式

groonga [-p ポート番号] -c [対象ホスト名またはIPアドレス]

対象ホストで動作しているgroongaサーバに接続します。

対象ホスト名を省略した場合はlocalhostに対して接続し、対象ポート番号を省略した場合は10041ポートに対して接続します。

接続に成功すると対話モードに入り、標準入力からコマンドを読み込んで順次実行します。

実行例:

% groonga -c
> status
[[0,1269936150.9489,6.5e-05],{"alloc_count":125,"starttime":1269935680,"uptime":470,"version":"0.1.7-10-g6bf93ba"}]
> ctrl-d
%

2.2.1.3. groongaデーモンの終了

groongaデーモンにshutdownコマンドを発行することにより、終了させることができます。

実行例:

% groonga -c
> shutdown
[[0,1270188017.75553,0.000104]]
%

2.2.2. HTTPによる通信

groongaをHTTP経由で利用したい場合には、HTTPプロトコルモードで起動します。

書式

groonga [-p ポート番号] -d --protocol http DBパス名

protocolオプションで、groongaが受け付けるプロトコルを指定できます。httpを指定すると、groongaはHTTPプロトコルでの通信を受け付けます。

2.2.2.1. HTML管理ツール

コマンド実行後、http://[IPアドレスまたはホスト名]:[ポート番号]/ というURLにブラウザからアクセスすると、HTML管理ツールが表示されます。ブラウザは、JavaScriptの実行が有効になっている必要があります。

2.2.2.2. HTTPでのコマンド実行

groongaがHTTPプロトコルモードで起動されているとき、「/d/コマンド名」というURLにアクセスすると、コマンドを実行することが出来ます。

コマンドのオプションは、HTTPのGETパラメータで渡します。つまり、「?オプション=値&オプション=値 …」という書式になります。

実行例

http://[IPまたはホスト名]:[ポート番号]/d/status
 レスポンス:[[0,1270106793.0733,5.6e-05],{"alloc_count":171,"starttime":1270106348,"uptime":445,"version":"0.1.8-4-g4404d63"}]

http://[IPまたはホスト名]:[ポート番号]/d/select?table=Site&query=title:@this
 レスポンス:[[0,1270106743.60756,0.000903],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"]]]]

2.2.3. セキュリティ

groongaのネットワークサービスにはは認証機能がありません。誰でもデータベースの内容を閲覧・修正することができます。iptablesなどを用いて、アクセス元IPアドレスを制限することを薦めます。