GROONGA(1)

NAME
groonga - groonga documentation

•   news

GROONGAの特徴

  全文検索ライブラリSennaの後継

groongaは、広く使われている全文検索ライブラリSennaの後継として開発されています。Sennaの特徴である、高速・高精度・高柔軟性という特徴を引き継ぎつつ、さらにそれらの特徴を追求するために開発が始められました。

  HTTPなどの複数プロトコルに対応したサーバ

Sennaは、全文検索を行うアプリケーションで用いるための部品でした。groongaでは、全文検索サービスを行うためのサーバが存在します。groongaサーバは、HTTPやmemcached binaryプロトコル、独自プロトコルであるgqtpを用いてクライアントとTCP/IP通信を行うことができます。よって、ライブラリをインストールできないレンタルサーバなどの環境でも利用しやすくなりました。

Sennaと同様に、groongaもC言語のライブラリとして利用できます。

  高速なデータ更新

groongaの前身であるSennaは、ストレージを持たない全文検索ライブラリでした。そのため、MySQLのMyISAMストレージエンジンと組み合わせて用いるTritonnや、PostgreSQLと組み合わせて用いるLudiaを通じて利用するのが一般的でした。しかし、これらの形態では、全文検索インデックス更新における参照lockが不要というSennaの性能特性を生かすことができませんでした。

たとえば、MyISAMではレコードが更新される際には、多くの場合テーブルロックが必要となります。このような場合には、いかに全文検索インデックスの更新が速くとも、MyISAMでのデータ更新がボトルネックとなってしまいます。

より即時性の高い検索サービスを実現するために、groongaでは参照lockが不要なストレージを実装しました。

  複数プロセス・複数スレッドで共有できるストレージ

groongaのストレージファイルは、複数プロセスや複数スレッドで共有することができます。明示的なロックなどは必要ありません。

Tritonnの次期バージョンは、MySQLのプラガブルストレージエンジンとして実装予定です。Tritonnで開いているgroongaストレージファイルも共有可能です。たとえば、MySQLプロトコルでデータの更新を行い、HTTPでデータの参照を行うことができます。

  ドリルダウンなどの集計系クエリを高速に実現

groongaのストレージは、カラムごとにデータを保存するカラム指向データベースを採用しています。カラム指向データベースはOLAPなどの集計クエリを高速に実現するのに向いています。

全文検索結果のうち、特定のカラム値ごとにグループ分けをし、それぞれのグループのレコード数を数えるような処理をドリルダウンといいます。groongaはカラム指向データベースを生かして、このような処理を高速に実行します。

  Sennaの転置インデックス実装をさらに改良

groongaの転置インデックスは、Sennaにおける転置インデックスの実装を改良し、より高速かつ汎用的なものとなりました。

転置インデックスを生かすことにより、SQLでも実現が難しい複雑なクエリを高速に実行することができます。いわゆるタグ検索やドリルダウンにおいて、転置インデックスを利用した高速な処理を行うことができます。

  位置情報（緯度・経度）検索

日本測地系のみならず、世界測地系にも対応した位置情報での絞込が可能です。位置情報の範囲は、円や矩形を指定することができます。また、任意の２点間の距離も計算可能です。

  自動クエリキャッシュ機構

参照系のクエリについて、自動的にクエリキャッシュを行います。

インストール

それぞれの環境毎にインストール方法を説明します。

  Debian GNU/Linux lenny

/etc/apt/sources.list.d/groonga.list:

deb http://packages.groonga.org/debian/ lenny main
deb-src http://packages.groonga.org/debian/ lenny main

インストール:

% sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 1C837F31
% sudo aptitude update
% sudo aptitude -V -D -y install groonga libgroonga-dev

  Debian GNU/Linux squeeze

/etc/apt/sources.list.d/groonga.list:

deb http://packages.groonga.org/debian/ squeeze main
deb-src http://packages.groonga.org/debian/ squeeze main

インストール:

% sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 1C837F31
% sudo aptitude update
% sudo aptitude -V -D -y install groonga libgroonga-dev

  Debian GNU/Linux sid

/etc/apt/sources.list.d/groonga.list:

deb http://packages.groonga.org/debian/ unstable main
deb-src http://packages.groonga.org/debian/ unstable main

インストール:

% sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 1C837F31
% sudo aptitude update
% sudo aptitude -V -D -y install groonga libgroonga-dev

  Ubuntu 10.04 LTS Lucid Lynx

注: Ubuntu本家のuniverseセクションもインストール対象としておくこと

/etc/apt/sources.list.d/groonga.list:

deb http://packages.groonga.org/ubuntu/ lucid universe
deb-src http://packages.groonga.org/ubuntu/ lucid universe

インストール:

% sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 1C837F31
% sudo aptitude update
% sudo aptitude -V -D -y install groonga libgroonga-dev

  Ubuntu 10.10 Maverick Meerkat

注: Ubuntu本家のuniverseセクションもインストール対象としておくこと

/etc/apt/sources.list.d/groonga.list:

deb http://packages.groonga.org/ubuntu/ maverick universe
deb-src http://packages.groonga.org/ubuntu/ maverick universe

インストール:

% sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 1C837F31
% sudo aptitude update
% sudo aptitude -V -D -y install groonga libgroonga-dev

  CentOS 5

インストール:

% sudo rpm -ivh http://packages.groonga.org/centos/groonga-repository-1.0.0-0.noarch.rpm
% sudo yum update
% sudo yum install -y groonga groonga-tokenizer-mecab groonga-devel

  Fedora 14

インストール:

% sudo rpm -ivh http://packages.groonga.org/fedora/groonga-repository-1.0.0-0.noarch.rpm
% sudo yum update
% sudo yum install -y groonga groonga-tokenizer-mecab groonga-devel

  その他

形態素単位でトークナイズした全文検索索引を使用したい場合は、 groongaのインストール前にMeCab (http://mecab.sourceforge.net/)をインストールしてください。

http://groonga.org/download/よりtar.gzファイルを取得し、 インストール先の環境にファイルを展開して、

./configure --prefix=/usr --localstatedir=/var && make && sudo make install

のように実行することでインストールできます。

prefixは、インストール先を指定するパラメータです。prefixを指定しない場合には、/usr/localが指定されたものとみなします。LD_LIBRARY_PATHなどに詳しくない人は、上記のように/usrを指定することをお勧めします。

チュートリアル

  基本的な操作

groongaは、Cのライブラリとして使用する方法と、groonga実行ファイルを通して使用する方法があります。

本チュートリアルでは、groonga実行ファイルを使用する方法について説明します。

groonga実行ファイルを使って、DBの作成・操作・サーバの起動・サーバへの接続などの操作が行えます。

  DBの作成

以下のようなコマンドを実行すると、データベースを新規に作成することができます。

書式

groonga -n データベースパス名

-nオプションは、データベースを作ることを示します。

データベースパス名には、新しく作成するデータベースのフルパス名を指定します。

上記コマンドでデータベースを作成すると、そのまま対話モードと呼ばれるコマンドを受け付けるモードになります。Ctrlキーを押しながらdキーを押すと、対話モードから抜けることができます。

実行例:

% groonga -n /tmp/tutorial.db
> ctrl-d
%

  DBの操作

書式

groonga DBパス名 [コマンド]

既存のデータベースのフルパス名をDBパス名に指定します。 コマンドを指定すると、実行結果を返します。

コマンドを指定しない場合には、対話モードに入ります。 対話モードでは、標準入力からコマンドを読み込み、順次実行します。 本チュートリアルでは、対話モードを主に使用します。

たとえば、statusというコマンドを実行してみましょう。statusコマンドは、groongaの実行状態を返すコマンドです。

実行例

% groonga /tmp/tutorial.db
> status
[[0,1294292494.18924,3.7116e-05],{"alloc_count":443,"starttime":1294292404,"uptime":90,"version":"1.0.6-10-gba9df76","n_queries":106,"cache_hit_rate":0.943396226415094,"command_version":1,"default_command_version":1,"max_command_version":2}]

以上のように、コマンドの実行結果は基本的にjson形式で返却されます。jsonの配列の0番目の要素に、エラーコードや実行時間などの情報が入ります。jsonの配列の1番目の様子に、コマンドの実行結果が入ります。

  コマンド

groonga実行ファイルやgroongaサーバを介して様々なコマンドを実行して、DBを操作することができます。 コマンドは以下の書式のうちいずれかで与えることができます。

書式1: コマンド名 引数1 引数2 ..
書式2: コマンド名 --引数名1 値1 --引数名2 値2 ..

書式1と2は混ぜて使うことができます。

書式2において、空白や、記号「"'()」のうちいずれかを含む値を指定したい場合は、シングルクォート(')かダブルクォート(")で値を囲みます。

詳しくは、 execfile のコマンドの項を参考にしてください。

  主なコマンド

status

    groongaプロセスの状態を表示します。

table_list

    DBに定義されているテーブルのリストを表示します。

column_list

    テーブルに定義されているカラムのリストを表示します。

table_create

    DBにテーブルを追加します。

column_create

    テーブルにカラムを追加します。

select

    テーブルに含まれるレコードを検索して表示します。

load

    テーブルにレコードを挿入します。

  テーブルの作成

table_create コマンドを使用してテーブルを作成します。

groongaでは、多くの場合テーブルを作成する際に主キーが必要となります。また、主キーには型と、その格納方法を指定する必要があります。

型については、のちのチュートリアルで触れます。データの種類をあらわしているもの、とイメージしてください。

主キーの格納方法によって、主キーでの検索速度や、前方一致検索の可否が決まります。これも、のちのチュートリアルで触れます。

ここでは、ShortText型の主キー値を持ち、主キーの格納方法はHASHである、'Site'という名前のテーブルを作成します。

実行例

> table_create --name Site --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292494.39228,0.080407899],true]

  検索

select コマンドを用いて、テーブルの中身を表示することができます。

実行例

> select --table Site
[[0,1294292494.67374,0.000159976],[[[0],[["_id","UInt32"],["_key","ShortText"]]]]]

selectにテーブル名を指定すると、指定したテーブルの中身を10件表示します。[0]は検索されたレコードの件数、["_id","Uint32"]は値がUInt32型である"_id'という名前のカラム、["_key","ShortText"]は値がShortText型である'_key'という名前のカラムを示しています。

table_createコマンドで作成したテーブルには、最初から'_id'/'_key'という２つのカラムがあります。'_id'はgroongaが自動的に付与するID番号が格納されるカラムです。'_key'は主キーが格納されるカラムです。これらのカラム名を変更することはできません。

  カラムの作成

column_create コマンドを用いて、カラムを作成することができます。

ShortText型の値を持つ、'comment'という名前のカラムを'Site'テーブルに追加しましょう。

実行例

> column_create --table Site --name title --flags COLUMN_SCALAR --type ShortText
[[0,1294292494.87523,0.073160479],true]
> select --table Site
[[0,1294292495.14923,0.000136609],[[[0],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]]]]]

COLUMN_SCALARについては、通常のカラムであることを示しています。

  全文検索用の語彙表の作成

このチュートリアルでは、groongaに登録したデータを用いた全文検索を行います。

全文検索を行う場合は、まず語彙表を作成する必要があります。 語彙表とは、文書の中にある単語が主キーとなるテーブルです。 ここでは、ShortText型の主キー値を持つ、'Terms'という名前のテーブルを作成しました。

実行例

> table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
[[0,1294292495.351,0.064287537],true]

この実行例には、多くのパラメータが指定されています。本チュートリアルでは、これらをすべて理解する必要はありません。以下に簡単な説明を記しますが、読み飛ばしてもらってかまいません。

実行例にある、TABLE_PAT_KEY|KEY_NORMALIZEという値は、主キー値をパトリシア木に格納し、各語彙を正規化して登録することを示しています。

実行例にある、TokenBigramという値は、 語彙表として使用するテーブルは、対象の文書をトークナイズする方式を、default_tokenizerパラメータで与えます。この例ではTokenBigramを指定しています。よって、一般的にN-gramと呼ばれるようなインデックス方式を選択しています。

  全文検索用のインデックスカラムの作成

Siteテーブルのtitleカラムを全文検索の対象としたいとしましょう。その場合には、語彙表にインデックス型のカラムを作成します。

実行例

> column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
[[0,1294292495.6163,0.118577336],true]

Siteテーブルのtitleカラムを検索対象とする、'blog_title'という名前のインデックス型カラムをTermsテーブルに作成しました。インデックス対象となるテーブルをtypeに、インデックス対象となるカラムをsourceに指定します。

実行例のflagsのCOLUMN_INDEX|WITH_POSITIONという値は、語彙の位置情報を格納するインデックス型のカラムであることを示しています。通常の全文検索インデックスでは、COLUMN_INDEX|WITH_POSITIONを指定してください。語彙の位置情報を格納する意味については、本チュートリアルでは触れません。

  データのロード

load コマンドを使用します。loadコマンドでは、jsonで受け取ったデータをテーブルに格納します。

実行例

> load --table Site
> [
> {"_key":"http://example.org/","title":"This is test record 1!"},
> {"_key":"http://example.net/","title":"test record 2."},
> {"_key":"http://example.com/","title":"test test record three."},
> {"_key":"http://example.net/afr","title":"test record four."},
> {"_key":"http://example.org/aba","title":"test test test record five."},
> {"_key":"http://example.com/rab","title":"test test test test record six."},
> {"_key":"http://example.net/atv","title":"test test test record seven."},
> {"_key":"http://example.org/gat","title":"test test record eight."},
> {"_key":"http://example.com/vdw","title":"test test record nine."},
> ]
[[0,1294292495.93593,2.202904311],9]

selectコマンドで、データが入っていることを確認しましょう。

実行例

> select --table Site
[[0,1294292498.33981,0.000163623],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"],[2,"http://example.net/","test record 2."],[3,"http://example.com/","test test record three."],[4,"http://example.net/afr","test record four."],[5,"http://example.org/aba","test test test record five."],[6,"http://example.com/rab","test test test test record six."],[7,"http://example.net/atv","test test test record seven."],[8,"http://example.org/gat","test test record eight."],[9,"http://example.com/vdw","test test record nine."]]]]

  データの検索

groongaでは、'_id'カラムと'_key'カラムの値はテーブル中で一意です。よって、それを用いて検索してみましょう。

selectコマンドにおいて、queryパラメータを用いるとデータの検索を行うことができます。

実行例

> select --table Site --query _id:1
[[0,1294292498.54636,0.000363938],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"]]]]

queryパラメータに与えた「_id:1」というのは、'_id'という名前のカラムに'1'という値が入っているレコードを検索する、という意味です。

_keyでも検索してみましょう。

実行例

> select --table Site --query "_key:\"http://example.org/\""
[[0,1294292498.74872,0.00031979],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"]]]]

queryパラメータに与えた「_key:"http://example.org/"」というのは、'_key'という名前のカラムに'"http://example.org/"'という値が入っているレコードを検索する、という意味です。

  全文検索

queryパラメータでは、インデックスを用いた全文検索を行うこともできます。

実行例

> select --table Site --query title:@this
[[0,1294292498.95104,0.00032904],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"]]]]

titleカラムに対して、'this'という文字列で全文検索を行った結果を返します。

queryパラメータに与えた「title:@this」というのが、'title'という名前のカラムに'this'という文字列が含まれているレコードを検索する、という意味です。

selectコマンドには、match_columnsというパラメータが存在します。これを指定すると、query内にカラム名を指定しない条件があった場合、match_columnsで指定されたカラムに対しての検索であることを示します。[1]_

match_columnsパラメータに'title'、queryパラメータに'this'という文字列を指定すると、上記のクエリと同じ結果を得ることができます。

実行例

> select --table Site --match_columns title --query this
[[0,1294292499.15359,0.000397943],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"]]]]

  出力カラムの指定

selectコマンドにおいて、output_columnsパラメータを用いることで、検索結果で表示するカラムを指定することが出来ます。

複数のカラムを指定する場合は、カンマ(,)区切りで指定します。

実行例

> select --table Site --output_columns _key,title,_score --query title:@test
[[0,1294292499.35613,0.000371444],[[[9],[["_key","ShortText"],["title","ShortText"],["_score","Int32"]],["http://example.org/","This is test record 1!",1],["http://example.net/","test record 2.",1],["http://example.com/","test test record three.",2],["http://example.net/afr","test record four.",1],["http://example.org/aba","test test test record five.",3],["http://example.com/rab","test test test test record six.",4],["http://example.net/atv","test test test record seven.",3],["http://example.org/gat","test test record eight.",2],["http://example.com/vdw","test test record nine.",2]]]]

groongaの検索結果には、「_score」という名前のカラムが追加されています。このカラムは、全文検索の条件が合致する文書ほど高い数値が入ります。

  表示範囲指定

selectコマンドにおいて、offset,limitパラメータを用いることで、検索結果から指定された範囲のみを表示することが出来ます。大量の検索結果をページで分けて、1ページ分のみを表示したい場合に有効です。

offsetパラメータには、検索結果を返す始点を指定します。1件目から結果を返す場合には、0を指定します。

limitパラメータには、検索結果を何件表示するのかを指定します。

実行例

> select --table Site --offset 0 --limit 3
[[0,1294292499.56296,0.00011524],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"],[2,"http://example.net/","test record 2."],[3,"http://example.com/","test test record three."]]]]
> select --table Site --offset 3 --limit 3
[[0,1294292499.76592,0.000110122],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[4,"http://example.net/afr","test record four."],[5,"http://example.org/aba","test test test record five."],[6,"http://example.com/rab","test test test test record six."]]]]
> select --table Site --offset 7 --limit 3
[[0,1294292499.96901,0.00010214],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[8,"http://example.org/gat","test test record eight."],[9,"http://example.com/vdw","test test record nine."]]]]

  並び替え

selectコマンドにおいて、sortbyパラメータを用いることで、検索結果を並び替えることが出来ます。

sortbyパラメータにカラム名を指定することで、そのカラムの値で昇順にソートします。また、カラム名の前にハイフン（-）を付けることで、降順にソートすることも出来ます。

実行例

> select --table Site --sortby -_id
[[0,1294292500.17182,0.000239255],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[9,"http://example.com/vdw","test test record nine."],[8,"http://example.org/gat","test test record eight."],[7,"http://example.net/atv","test test test record seven."],[6,"http://example.com/rab","test test test test record six."],[5,"http://example.org/aba","test test test record five."],[4,"http://example.net/afr","test record four."],[3,"http://example.com/","test test record three."],[2,"http://example.net/","test record 2."],[1,"http://example.org/","This is test record 1!"]]]]

出力カラムの指定で紹介した「_score」カラムは、ソートの条件としても使うことができます。

実行例

> select --table Site --query title:@test --output_columns _id,_score,title --sortby _score
[[0,1294292500.37864,0.000452891],[[[9],[["_id","UInt32"],["_score","Int32"],["title","ShortText"]],[1,1,"This is test record 1!"],[2,1,"test record 2."],[4,1,"test record four."],[3,2,"test test record three."],[9,2,"test test record nine."],[8,2,"test test record eight."],[7,3,"test test test record seven."],[5,3,"test test test record five."],[6,4,"test test test test record six."]]]]

ソートするカラム名を複数指定したい場合は、カンマ(,)区切りで指定します。複数のカラムを指定した場合、最初のカラムで同一の値のレコードがあった場合に、次のカラムの値でソートさせることができます。

実行例

> select --table Site --query title:@test --output_columns _id,_score,title --sortby _score,_id
[[0,1294292500.58351,0.000449563],[[[9],[["_id","UInt32"],["_score","Int32"],["title","ShortText"]],[1,1,"This is test record 1!"],[2,1,"test record 2."],[4,1,"test record four."],[3,2,"test test record three."],[8,2,"test test record eight."],[9,2,"test test record nine."],[5,3,"test test test record five."],[7,3,"test test test record seven."],[6,4,"test test test test record six."]]]]
脚注

[1] 現在のバージョンでは、全文検索インデックスが存在する場合にのみ、match_columnsパラメータを利用することをができます。通常のカラムでの絞り込みには利用できません。

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

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

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

  groongaデーモンの起動

書式

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

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

実行例:

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

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

  groongaサーバへの接続

書式

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

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

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

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

実行例

% groonga -c
> status
[[0,1294292493.17513,3.4655e-05],{"alloc_count":466,"starttime":1294292404,"uptime":89,"version":"1.0.6-10-gba9df76","n_queries":105,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
> ctrl-d
%

  groongaデーモンの終了

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

実行例

% groonga -c
> shutdown
%

  HTTPによる通信

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

書式

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

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

  HTML管理ツール

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

  HTTPでのコマンド実行

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

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

実行例

http://[IPまたはホスト名]:[ポート番号]/d/status
実行される処理：
> status
[[0,1294292493.37913,2.8547e-05],{"alloc_count":466,"starttime":1294292404,"uptime":89,"version":"1.0.6-10-gba9df76","n_queries":105,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
http://[IPまたはホスト名]:[ポート番号]/d/select?table=Site&query=title:@this
実行される処理：
> select --table Site --query title:@this
[[0,1294292493.58185,6.4853e-05],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"]],[1,"http://example.org/","This is test record 1!"]]]]

  セキュリティ

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

  さまざまな種類をもったデータの保存

groongaでは、さまざまなデータを格納させることが出来ます。

  データ型

groongaでは、数値（整数・小数）や文字列や時刻や経緯度などの情報を格納することができます。

ここでは、Int32型のカラムに整数を格納、Float型のカラムに浮動小数点の小数を、ShortText型のカラムに文字列を、Time型のカラムに時間を格納する例を示します。経緯度の格納については、のちのチュートリアルで触れます。

その他のデータ型の一覧は、 ../type を参照してください。

実行例

> table_create --name Type --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292421.12314,0.058638912],true]
> column_create --table Type --name number --type Int32
[[0,1294292421.38263,0.049456503],true]
> column_create --table Type --name float --type Float
[[0,1294292421.63286,0.049592924],true]
> column_create --table Type --name string --type ShortText
> column_create --table Type --name time --type Time
> load --table Type
> [{"_key":"sample","number":12345,"float":42.195,"string":"GROONGA","time":1234567890.12}]
> select --table Type

  テーブル型

table_createで作成したテーブルを、カラムの型として使うことが出来ます。

また、output_columnsにおいて「.」を区切りとして、参照先のテーブルに存在するカラムを指定すると、指定したカラムの値を表示することができます。

ここでは、先のチュートリアルで作成したSiteテーブルに手を加え、どのサイトをリンクしているのかを保存してみましょう。

他のテーブルを参照するカラムにデータを入力する場合には、参照先のテーブルの_keyカラムの値を代入する必要があります。

実行例

> column_create --table Site --name link --type Site
[[0,1294292421.88324,1.758091494],true]
[[0,1294292423.64139,0.096956537],true]
[[0,1294292423.73839,0.001444368],1]
[[0,1294292423.73987,0.000161184],[[[1],[["_id","UInt32"],["_key","ShortText"],["time","Time"],["string","ShortText"],["number","Int32"],["float","Float"]],[1,"sample",1234567890.0,"GROONGA",12345,42.195]]]]
[[0,1294292423.74005,0.057032974],true]
> load --table Site
> [{"_key":"http://example.org/","link":"http://example.net/"}]
[[0,1294292423.99784,0.200585743],1]
> select --table Site --output_columns _key,title,link._key,link.title --query title:@this
[[0,1294292424.39909,0.000545272],[[[1],[["_key","ShortText"],["title","ShortText"],["link._key","ShortText"],["link.title","ShortText"]],["http://example.org/","This is test record 1!","http://example.net/","test record 2."]]]]

このように、linkカラムに他のサイトへの参照を保存することができました。また、参照先の_keyとtitleカラムの内容を表示することができました。

  ベクターカラム

column_createコマンドでカラムを作成するとき、--flagsオプションでCOLUMN_VECTORフラグを指定すると、複数の値を配列で格納できるカラムが作成されます。

テーブル型で配列を格納するカラムは、1対多の参照関係を表すのに有効です。

テーブル型のチュートリアルでは、Siteテーブルに手を加え、どのサイトをリンクしているのかを保存しました。しかし、通常は1つのサイトから多くのサイトにリンクが張られています。複数のリンク情報を格納するために、複数の参照関係を保存するカラムを作成してみましょう。

他のテーブルを参照するベクターカラムにデータを入力する場合には、参照先のテーブルの_keyカラムの値の「配列」を代入する必要があります。

実行例

> column_create --table Site --name links --flags COLUMN_VECTOR --type Site
[[0,1294292424.60248,0.062420461],true]
> load --table Site
> [{"_key":"http://example.org/","links":["http://example.net/","http://example.org/","http://example.com/"]}]
[[0,1294292424.86574,0.200708196],1]
> select --table Site --output_columns _key,title,links._key,links.title --query title:@this
[[0,1294292425.26717,0.000522302],[[[1],[["_key","ShortText"],["title","ShortText"],["links._key","ShortText"],["links.title","ShortText"]],["http://example.org/","This is test record 1!",["http://example.net/","http://example.org/","http://example.com/"],["test record 2.","This is test record 1!","test test record three."]]]]]

このように、複数の参照関係が保存できました。また、output_columnsによって、複数の参照先のカラム値も表示させることができました。

  さまざまな検索条件の指定

groongaは、JavaScriptに似た文法での条件絞込や、計算した値を用いたソートを行うことができます。また、位置情報(緯度・経度)を用いた絞込・ソートを行うことができます。

  JavaScriptに似た文法での絞込・全文検索

selectコマンドのfilterパラメータは、queryパラメータと同様に、レコードの検索条件を指定します。filterパラメータとqueryパラメータが異なる点は、filterパラメータには、JavaScriptの式に似た文法で条件を指定する点です。

実行例

> select --table Site --filter "_id <= 1" --output_columns _id,_key
[[0,1294292483.15552,0.000315671],[[[1],[["_id","UInt32"],["_key","ShortText"]],[1,"http://example.org/"]]]]

ここで、filterパラメータには

_id <= 1

という条件を指定しています。この場合は_idの値が1以下のレコードが検索結果として得られます。

また、&& や || を使って、条件のAND・OR指定をすることもできます。

実行例

> select --table Site --filter "_id >= 4 && _id <= 6" --output_columns _id,_key
[[0,1294292483.35765,0.000332343],[[[3],[["_id","UInt32"],["_key","ShortText"]],[4,"http://example.net/afr"],[5,"http://example.org/aba"],[6,"http://example.com/rab"]]]]
> select --table Site --filter "_id <= 2 || _id >= 7" --output_columns _id,_key
[[0,1294292483.55992,0.000325242],[[[5],[["_id","UInt32"],["_key","ShortText"]],[1,"http://example.org/"],[2,"http://example.net/"],[7,"http://example.net/atv"],[8,"http://example.org/gat"],[9,"http://example.com/vdw"]]]]

queryパラメータとfilterパラメータを同時に指定すると、両者の条件をともに満たすレコードが結果として返ります。

  scorerを利用したソート

selectコマンドのscorerパラメータは、 全文検索を行った結果の各レコードに対して処理を行うためのパラメータです。

filterパラメータと同様に、 JavaScriptの式に似たな文法で様々な条件を指定することができます。

実行例

> select --table Site --filter "1" --scorer "_score = rand()" --output_columns _id,_key,_score --sortby _score
[[0,1294292483.76306,0.00050586],[[[9],[["_id","UInt32"],["_key","ShortText"],["_score","Int32"]],[3,"http://example.com/",35005211],[9,"http://example.com/vdw",278722862],[5,"http://example.org/aba",294702567],[1,"http://example.org/",304089172],[7,"http://example.net/atv",336465782],[4,"http://example.net/afr",521595368],[8,"http://example.org/gat",861021530],[2,"http://example.net/",1303455736],[6,"http://example.com/rab",1726956429]]]]
> select --table Site --filter "1" --scorer "_score = rand()" --output_columns _id,_key,_score --sortby _score
[[0,1294292483.96835,0.000502458],[[[9],[["_id","UInt32"],["_key","ShortText"],["_score","Int32"]],[1,"http://example.org/",233665123],[3,"http://example.com/",468703135],[7,"http://example.net/atv",635723058],[4,"http://example.net/afr",1101513929],[9,"http://example.com/vdw",1125898167],[6,"http://example.com/rab",1315634022],[8,"http://example.org/gat",1369133069],[5,"http://example.org/aba",1801979802],[2,"http://example.net/",2145174067]]]]

検索結果には、'_score'という名前の、全文検索のスコアが代入されている仮想的なカラムが付与されることをチュートリアル中ソートの項目で説明しました。

上記の実行例では、scorerパラメータに

_score = rand()

という条件を指定しています。ここでは、rand()という乱数を返す関数を用いて、全文検索のスコアを乱数で上書きしています。

sortbyパラメータには、

_score

を指定しています。これは、スコア順に昇順にソートすることを意味しています。

よって、上記のクエリは実行されるたびに検索結果の並び順がランダムに変わります。

  位置情報を用いた絞込・ソート

groongaでは、位置情報（経緯度）を保存することができます。また、保存した経緯度を用いて絞込やソートができます。

位置情報を保存するためのカラムの型として、TokyoGeoPoint/WGS84GeoPointの２つの型があります。前者は日本測地系、後者は世界測地系(WGS84相当)の経緯度を保存します。

経緯度をデータを入力するためには、"緯度のミリ秒x経度のミリ秒"という形式の文字列を代入する必要があります。

ここでは、ためしに東京駅と新宿駅とついて、世界測地系での位置情報を保存してみましょう。東京駅は緯度が35度40分52.975秒、経度が139度45分57.902秒です。新宿駅は緯度が35度41分27.316秒、経度が139度42分0.929秒です。よって、代入する文字列はそれぞれ"128452975x503157902"/"128487316x502920929"となります。

実行例

> column_create --table Site --name location --type WGS84GeoPoint
[[0,1294292484.17389,0.064924593],true]
> load --table Site
> [
>  {"_key":"http://example.org/","location":"128452975x503157902"}
>  {"_key":"http://example.net/","location":"128487316x502920929"},
> ]
[[0,1294292484.43963,0.801132263],2]
> select --table Site --query "_id:1 OR _id:2" --output_columns _key,location
[[0,1294292485.44153,0.000398502],[[[2],[["_key","ShortText"],["location","WGS84GeoPoint"]],["http://example.org/","128452975x503157902"],["http://example.net/","128487316x502920929"]]]]

scorerパラメータにおいて、 ../functions/geo_distance 関数を用いることにより、２点間の距離を計算することができます。

ここでは、秋葉原駅からの距離を表示させてみましょう。世界測地系では、秋葉原駅の位置は緯度が35度41分55.259秒、経度が139度46分27.188秒です。よって、geo_distance関数に与える文字列は"128515259x503187188"となります。

実行例

> select --table Site --query "_id:1 OR _id:2" --output_columns _key,location,_score --scorer '_score = geo_distance(location, "128515259x503187188")'
[[0,1294292485.64428,0.00042649],[[[2],[["_key","ShortText"],["location","WGS84GeoPoint"],["_score","Int32"]],["http://example.org/","128452975x503157902",2054],["http://example.net/","128487316x502920929",6720]]]]

この結果を見ると、東京駅と秋葉原駅は2054m、秋葉原駅と新宿駅は6720m離れているようです。

geo_distance関数は、_scoreを通じてソートでも用いることができます。

実行例

> select --table Site --query "_id:1 OR _id:2" --output_columns _key,location,_score --scorer '_score = geo_distance(location, "128515259x503187188")' --sortby -_score
[[0,1294292485.84748,0.000516522],[[[2],[["_key","ShortText"],["location","WGS84GeoPoint"],["_score","Int32"]],["http://example.net/","128487316x502920929",6720],["http://example.org/","128452975x503157902",2054]]]]

「ある地点から何m以内に存在する」といった絞込も可能です。

filterパラメータにおいて、 ../functions/geo_in_circle 関数を用いることにより、２点間の距離が指定のm以下におさまるかどうかを判定することができます。

たとえば、秋葉原駅から5000m以内にあるレコードを検索してみましょう。

実行例

> select --table Site --output_columns _key,location --filter 'geo_in_circle(location, "128515259x503187188", 5000)'
[[0,1294292486.0507,0.000333268],[[[1],[["_key","ShortText"],["location","WGS84GeoPoint"]],["http://example.org/","128452975x503157902"]]]]

また、経緯度が指定の矩形領域内であるかどうかを判定する ../functions/geo_in_rectangle 関数も存在します。

  ドリルダウン

groongaでは、特定のカラム値で検索結果をグループ化することができます。これをドリルダウンと呼びます。

Siteテーブルに２つのカラムを追加します。TLDドメイン名を格納するdomainカラムと、国名を格納するcountryカラムです。これらのカラムの型は、それぞれドメイン名を主キーとするSiteDomainテーブルと、国名を主キーとするSiteCounteryテーブルとします。

実行例

> table_create --name SiteDomain --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292439.68952,0.086450272],true]
> table_create --name SiteCountry --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292439.97679,0.049583906],true]
> column_create --table Site --name domain --flags COLUMN_SCALAR --type SiteDomain
[[0,1294292440.22716,0.04950764],true]
> column_create --table Site --name country --flags COLUMN_SCALAR --type SiteCountry
[[0,1294292440.47743,0.049554444],true]
> load --table Site
> [
> {"_key":"http://example.org/","domain":".org","country":"japan"},
> {"_key":"http://example.net/","domain":".net","country":"brazil"},
> {"_key":"http://example.com/","domain":".com","country":"japan"},
> {"_key":"http://example.net/afr","domain":".net","country":"usa"},
> {"_key":"http://example.org/aba","domain":".org","country":"korea"},
> {"_key":"http://example.com/rab","domain":".com","country":"china"},
> {"_key":"http://example.net/atv","domain":".net","country":"china"},
> {"_key":"http://example.org/gat","domain":".org","country":"usa"},
> {"_key":"http://example.com/vdw","domain":".com","country":"japan"}
> ]
[[0,1294292440.72776,2.203006717],9]

domainカラムとcountryカラムでドリルダウンを行う例を以下に示します。

実行例

> select --table Site --limit 0 --drilldown domain
[[0,1294292443.13172,0.000424923],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["location","WGS84GeoPoint"],["links","Site"],["link","Site"],["domain","SiteDomain"],["country","SiteCountry"]]],[[3],[["_key","ShortText"],["_nsubrecs","Int32"]],[".org",3],[".net",3],[".com",3]]]]

テーブル型を持つカラムに対してドリルダウンを行った場合、参照先のテーブルに存在するカラム値を取得することもできます。ドリルダウンを行ったテーブルには、_nsubrecsという仮想的なカラムが追加されます。このカラムには、グループ化されたレコード数が入ります。

実行例

> select --table Site --limit 0 --drilldown domain --drilldown_output_columns _id,_key,_nsubrecs
[[0,1294292443.33582,0.00027157],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["location","WGS84GeoPoint"],["links","Site"],["link","Site"],["domain","SiteDomain"],["country","SiteCountry"]]],[[3],[["_id","UInt32"],["_key","ShortText"],["_nsubrecs","Int32"]],[1,".org",3],[2,".net",3],[3,".com",3]]]]

複数のカラムに対してドリルダウンを行うことができます。複数のカラムに対してドリルダウンを行う場合には、drilldownパラメータにカラム名をカンマ区切りで与えます。

実行例

> select --table Site --limit 0 --drilldown domain,country
[[0,1294292443.53984,0.000373005],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["location","WGS84GeoPoint"],["links","Site"],["link","Site"],["domain","SiteDomain"],["country","SiteCountry"]]],[[3],[["_key","ShortText"],["_nsubrecs","Int32"]],[".org",3],[".net",3],[".com",3]],[[5],[["_key","ShortText"],["_nsubrecs","Int32"]],["japan",3],["brazil",1],["usa",2],["korea",1],["china",2]]]]

ドリルダウン結果を並びかえることができます。例えば、_nsubrecsパラメータの降順で並び替えることができます。

実行例

> select --table Site --limit 0 --drilldown country --drilldown_sortby _nsubrecs
[[0,1294292443.74477,0.000352156],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["location","WGS84GeoPoint"],["links","Site"],["link","Site"],["domain","SiteDomain"],["country","SiteCountry"]]],[[5],[["_key","ShortText"],["_nsubrecs","Int32"]],["brazil",1],["korea",1],["usa",2],["china",2],["japan",3]]]]

ドリルダウン結果は、デフォルトでは10件のみ表示されます。drilldown_offsetパラメータと、drilldown_limitパラメータによって、offsetとlimitを指定することができます。

実行例

> select --table Site --limit 0 --drilldown country --drilldown_sortby _nsubrecs --drilldown_limit 2 --drilldown_offset 2
[[0,1294292443.94881,0.000324308],[[[9],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["location","WGS84GeoPoint"],["links","Site"],["link","Site"],["domain","SiteDomain"],["country","SiteCountry"]]],[[5],[["_key","ShortText"],["_nsubrecs","Int32"]],["usa",2],["china",2]]]]

文字列型のカラムに対するドリルダウンは、他の型でのドリルダウンに比べて低速です。文字列でのドリルダウンを行いたい場合には、このチュートリアルのように、文字列型を主キーとするテーブルを別途作成し、そのテーブルを型とするカラムを作成します。

  タグ検索・参照関係の逆引き

本チュートリアルで、groongaはカラム値として他のテーブルへの参照の配列を持つことができることを紹介いたしました。実は、テーブルへの参照の配列データを用いることによって、いわゆるタグ検索を行うことが可能となります。

タグ検索はgroongaの転置インデックスというデータ構造を用いて高速に行われます。

  タグ検索

動画共有サイトの検索エンジンを作ることを想定します。1つの動画には、その動画の特徴を表す、複数の語句が付与されています。「ある語句が付与されている動画の一覧を取得する」検索を行いたいとします。

実際に、動画情報のテーブルを作成し、検索をしてみましょう。

動画の情報を保存する、Videoテーブルを作成します。Videoテーブルでは、動画のタイトルをtitleカラムに、動画のタグ情報をtagsカラムにTagテーブル型で複数格納しています。 タグの情報を保存する、Tagテーブルを作成します。Tagテーブルでは、タグ文字列を主キーに格納し、Videoテーブルのtagsカラムに対するインデックスをindex_tagsカラムに格納しています。

実行例

> table_create --name Video --flags TABLE_HASH_KEY --key_type UInt32
[[0,1294292519.76797,0.049499306],true]
> table_create --name Tag --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292520.01828,0.057850258],true]
> column_create --table Video --name title --flags COLUMN_SCALAR --type ShortText
[[0,1294292520.27693,0.050379447],true]
> column_create --table Video --name tags --flags COLUMN_VECTOR --type Tag
[[0,1294292520.52812,0.049635833],true]
> column_create --table Tag --name index_tags --flags COLUMN_INDEX --type Video --source tags
[[0,1294292520.77859,0.105692363],true]
> load --table Video
> [
> {"_key":1,"title":"Soccer 2010","tags":["Sports","Soccer"]},
> {"_key":2,"title":"Zenigata Kinjirou","tags":["Variety","Money"]},
> {"_key":3,"title":"groonga Demo","tags":["IT","Server","groonga"]},
> {"_key":4,"title":"Moero!! Ultra Baseball","tags":["Sports","Baseball"]},
> {"_key":5,"title":"Hex Gone!","tags":["Variety","Quiz"]},
> {"_key":6,"title":"Pikonyan 1","tags":["Animation","Pikonyan"]},
> {"_key":7,"title":"Draw 8 Month","tags":["Animation","Raccoon"]},
> {"_key":8,"title":"K.O.","tags":["Animation","Music"]}
> ]
[[0,1294292521.0851,2.002679112],8]

インデックスカラムを作成すると、全文検索が高速に行えるようになります。インデックスカラムは、対象のカラムに保存されたデータに更新があったとき、自動的に更新されます。

「ある語句が付与されている動画の一覧を取得する」検索を行いましょう。

実行例

> select --table Video --query tags:@Variety --output_columns _key,title
[[0,1294292523.28874,0.000475294],[[[2],[["_key","UInt32"],["title","ShortText"]],[2,"Zenigata Kinjirou"],[5,"Hex Gone!"]]]]
> select --table Video --query tags:@Sports --output_columns _key,title
[[0,1294292523.49078,0.000311404],[[[2],[["_key","UInt32"],["title","ShortText"]],[1,"Soccer 2010"],[4,"Moero!! Ultra Baseball"]]]]
> select --table Video --query tags:@Animation --output_columns _key,title
[[0,1294292523.69268,0.000299391],[[[3],[["_key","UInt32"],["title","ShortText"]],[6,"Pikonyan 1"],[7,"Draw 8 Month"],[8,"K.O."]]]]

このように、「Variety」、「Sports」、「Animation」のようなタグで検索を行うことができました。

  参照関係の逆引き

groongaはテーブル間の参照関係の逆引きを高速に行うためのインデックスを付与することができます。タグ検索は、その1例にすぎません。

例えば、ソーシャルネットワーキングサイトにおける友人関係を逆引き検索することができます。

以下の例では、ユーザー情報を格納するUserテーブルを作成し、ユーザー名を格納するusernameカラム、ユーザーの友人一覧を配列で格納するfriendsカラムとそのインデックスのindex_friendsカラムを追加しています。

実行例

> table_create --name User --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292523.89479,0.074787397],true]
> column_create --table User --name username --flags COLUMN_SCALAR --type ShortText
[[0,1294292524.1704,0.050363618],true]
> column_create --table User --name friends --flags COLUMN_VECTOR --type User
[[0,1294292524.42158,0.049597919],true]
> column_create --table User --name index_friends --flags COLUMN_INDEX --type User --source friends
[[0,1294292524.67201,0.104947934],true]
> load --table User
> [
> {"_key":"ken","username":"健作","friends":["taro","jiro","tomo","moritapo"]}
> {"_key":"moritapo","username":"森田","friends":["ken","tomo"]}
> {"_key":"taro","username":"ぐるんが太郎","friends":["jiro","tomo"]}
> {"_key":"jiro","username":"ぐるんが次郎","friends":["taro","tomo"]}
> {"_key":"tomo","username":"トモちゃん","friends":["ken","hana"]}
> {"_key":"hana","username":"花子","friends":["ken","taro","jiro","moritapo","tomo"]}
> ]
[[0,1294292524.97774,1.60223701],6]

指定したユーザーを友人リストに入れているユーザーの一覧を表示してみましょう。

実行例

> select --table User --query friends:@tomo --output_columns _key,username
[[0,1294292526.78097,0.000456954],[[[5],[["_key","ShortText"],["username","ShortText"]],["ken","健作"],["taro","ぐるんが太郎"],["jiro","ぐるんが次郎"],["moritapo","森田"],["hana","花子"]]]]
> select --table User --query friends:@jiro --output_columns _key,username
[[0,1294292526.9838,0.000304224],[[[3],[["_key","ShortText"],["username","ShortText"]],["ken","健作"],["taro","ぐるんが太郎"],["hana","花子"]]]]

さらに、ドリルダウンを使って、友人リストに入っている数の一覧を表示してみましょう。

実行例

> select --table User --limit 0 --drilldown friends
[[0,1294292527.18622,0.000269477],[[[6],[["_id","UInt32"],["_key","ShortText"],["username","ShortText"],["index_friends","User"],["friends","User"]]],[[6],[["_key","ShortText"],["_nsubrecs","Int32"]],["taro",3],["jiro",3],["tomo",5],["moritapo",2],["ken",3],["hana",1]]]]

このように、テーブルの参照関係を逆にたどる検索ができました。

  インデックス付きジオサーチ

位置情報のカラムに対して、インデックスを付与することが出来ます。大量の位置情報レコードを検索する場合に、検索速度が速くなります。

実行例

> table_create --name GeoIndex --flags TABLE_HASH_KEY --key_type WGS84GeoPoint
[[0,1295945106.95941,0.042948258],true]
> column_create --table GeoIndex --name index_point --type Site --flags COLUMN_INDEX --source location
[[0,1295945107.20325,0.090239769],true]
> load --table Site
> [
>  {"_key":"http://example.org/","location":"128452975x503157902"}
>  {"_key":"http://example.net/","location":"128487316x502920929"},
> ]
[[0,1295945107.49464,0.801677814],2]
> select --table Site --filter 'geo_in_circle(location, "128515259x503187188", 5000)' --output_columns _key,location
[[0,1295945108.49712,0.000941181],[[[1],[["_key","ShortText"],["location","WGS84GeoPoint"]],["http://example.org/","128452975x503157902"]]]]

同様に、位置情報レコードを用いてソートする場合に、ソート速度が速くなります。

  match_columnsパラメータ

  複数のカラムを対象とした全文検索

groongaでは、複数のカラムを対象とした全文検索を行うことができます。例えば、ブログのテーブルで、タイトルと内容とがそれぞれ別のカラムに入ったものがあるとしましょう。「タイトルもしくは内容に特定の単語を含む」検索を行いたいとします。

この場合、2つのインデックス作成方式があります。1つは、それぞれのカラムに1つずつインデックスを付与する方式です。もう1つは、複数のカラムに対して1つのインデックスを付与する方式です。groongaでは、どちらの形式のインデックスが存在している場合でも、同一の記法で全文検索を行うことができます。

  カラムごとにインデックスを付与する場合

Blog1テーブルを作り、タイトル文字列のtitleカラム、本文のmessageカラムを追加しています。 インデックス用のIndexBlog1テーブルも作り、titleカラムのインデックス用にindex_titleカラム、messageカラムのインデック用にindex_messageカラムと、それぞれ1カラムごとに1つずつ追加しています。

実行例

> table_create --name Blog1 --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292405.5139,0.046640501],true]
> column_create --table Blog1 --name title --flags COLUMN_SCALAR --type ShortText
[[0,1294292405.76135,0.05035077],true]
> column_create --table Blog1 --name message --flags COLUMN_SCALAR --type ShortText
[[0,1294292406.01251,0.049535938],true]
> table_create --name IndexBlog1 --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
[[0,1294292406.2629,0.040450231],true]
> column_create --table IndexBlog1 --name index_title --flags COLUMN_INDEX|WITH_POSITION --type Blog1 --source title
[[0,1294292406.50413,0.089260402],true]
> column_create --table IndexBlog1 --name index_message --flags COLUMN_INDEX|WITH_POSITION --type Blog1 --source message
[[0,1294292406.7942,0.116405104],true]
> load --table Blog1
> [
> {"_key":"grn1","title":"groonga test","message":"groonga message"},
> {"_key":"grn2","title":"baseball result","message":"rakutan eggs 4 - 4 groonga moritars"},
> {"_key":"grn3","title":"groonga message","message":"none"}
> ]
[[0,1294292407.11144,1.001433691],3]

match_columnsオプションで、検索対象のカラムを複数指定することが出来ます。検索する文字列はqueryオプションで指定します。これを使うことで、タイトルと本文を全文検索することができます。

実際に検索してみましょう。

実行例

> select --table Blog1 --match_columns title||message --query groonga
[[0,1294292408.31388,0.000823528],[[[3],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["message","ShortText"]],[1,"grn1","groonga test","groonga message"],[3,"grn3","groonga message","none"],[2,"grn2","baseball result","rakutan eggs 4 - 4 groonga moritars"]]]]
> select --table Blog1 --match_columns title||message --query message
[[0,1294292408.5178,0.000566064],[[[2],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["message","ShortText"]],[3,"grn3","groonga message","none"],[1,"grn1","groonga test","groonga message"]]]]
> select --table Blog1 --match_columns title --query message
[[0,1294292408.72074,0.0004798],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["message","ShortText"]],[3,"grn3","groonga message","none"]]]]

  複数のカラムにまたがったインデックスを付与する場合

内容は上の例とほぼ同じですが、titleとmessageの2つのカラムに対するインデックスが共通になっており、インデックスカラムが1つしかありません。

共通のインデックスを用いても、titleカラムのみでの検索、messageカラムのみでの検索、titleもしくはmessageカラムでの検索、全ての検索を行うことができます。

実行例

> table_create --name Blog2 --flags TABLE_HASH_KEY --key_type ShortText
[[0,1294292408.92333,0.107518903],true]
> column_create --table Blog2 --name title --flags COLUMN_SCALAR --type ShortText
[[0,1294292409.23168,0.050369538],true]
> column_create --table Blog2 --name message --flags COLUMN_SCALAR --type ShortText
[[0,1294292409.48288,0.049530167],true]
> table_create --name IndexBlog2 --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
[[0,1294292409.73325,0.04885075],true]
> column_create --table IndexBlog2 --name index_blog --flags COLUMN_INDEX|WITH_POSITION|WITH_SECTION --type Blog2 --source title,message
[[0,1294292409.98288,0.105489516],true]
> load --table Blog2
> [
> {"_key":"grn1","title":"groonga test","message":"groonga message"},
> {"_key":"grn2","title":"baseball result","message":"rakutan eggs 4 - 4 groonga moritars"},
> {"_key":"grn3","title":"groonga message","message":"none"}
> ]
[[0,1294292410.28918,1.001414874],3]

実際に検索してみましょう。結果は上の例と同じになります。

実行例

> select --table Blog2 --match_columns title||message --query groonga
[[0,1294292411.49151,0.000575701],[[[3],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["message","ShortText"]],[1,"grn1","groonga test","groonga message"],[2,"grn2","baseball result","rakutan eggs 4 - 4 groonga moritars"],[3,"grn3","groonga message","none"]]]]
> select --table Blog2 --match_columns title||message --query message
[[0,1294292411.69532,0.000523916],[[[2],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["message","ShortText"]],[1,"grn1","groonga test","groonga message"],[3,"grn3","groonga message","none"]]]]
> select --table Blog2 --match_columns title --query message
[[0,1294292411.89825,0.000508446],[[[1],[["_id","UInt32"],["_key","ShortText"],["title","ShortText"],["message","ShortText"]],[3,"grn3","groonga message","none"]]]]

  インデックス名を指定した全文検索

執筆中です。

  インデックスの重み

執筆中です。

  主キーによる前方一致検索

groongaのテーブルは、テーブル作成時にパトリシア木オプションを指定すると、前方一致検索を行うことができます。また、追加のオプションを指定することにより、主キーの後方一致検索をも行うことができます。

  主キーによる前方一致検索

table_createコマンドのflagsオプションにTABLE_PAT_KEYを指定することで、主キーによる前方一致検索ができるようになります。

実行例

>    table_create --name PatPre --flags TABLE_PAT_KEY --key_type ShortText
[[0,1294292412.30259,0.079878298],true]
>    load --table PatPre
>    [
>    {"_key":"ひろゆき"},
>    {"_key":"まろゆき"},
>    {"_key":"ひろあき"}
>    ]
[[0,1294292412.58327,1.001299934],3]
>    select --table PatPre --query _key:@ひろ
[[0,1294292413.78527,0.000581025],[[[2],[["_id","UInt32"],["_key","ShortText"]],[3,"ひろあき"],[1,"ひろゆき"]]]]

  全文検索の語彙表に対する追加情報

groongaでは、全文検索に用いるための語意表がテーブルとして扱えます。よって、語彙ごとに複数の情報を保持することができます。例えば、語彙の出現数や検索ストップワードのフラグ、単語の重要度などを保持することができます。

この項目については、現在執筆中です。

  マイクロブログ検索システムの作成

これまで学んだgroongaの機能を用いて、マイクロブログの検索システムを作成してみましょう。マイクロブログとは、Twitterのような短いメッセージを投稿するブログです。

  テーブルの作成

まずは、テーブルを作成します。

table_create --name Users --flags TABLE_HASH_KEY --key_type ShortText
table_create --name Comments --flags TABLE_HASH_KEY --key_type ShortText
table_create --name HashTags --flags TABLE_HASH_KEY --key_type ShortText
table_create --name Bigram --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
column_create --table Users --name name --flags COLUMN_SCALAR --type ShortText
column_create --table Users --name follower --flags COLUMN_VECTOR --type Users
column_create --table Users --name favorites --flags COLUMN_VECTOR --type Comments
column_create --table Users --name location --flags COLUMN_SCALAR --type WGS84GeoPoint
column_create --table Users --name location_str --flags COLUMN_SCALAR --type ShortText
column_create --table Users --name description --flags COLUMN_SCALAR --type ShortText
column_create --table Users --name folowee --flags COLUMN_INDEX --type Users --source follower
column_create --table Comments --name comment --flags COLUMN_SCALAR --type ShortText
column_create --table Comments --name last_modified --flags COLUMN_SCALAR --type Time
column_create --table Comments --name replied_to --flags COLUMN_SCALAR --type Comments
column_create --table Comments --name replied_users --flags COLUMN_VECTOR --type Users
column_create --table Comments --name hash_tags --flags COLUMN_VECTOR --type HashTags
column_create --table Comments --name location --flags COLUMN_SCALAR --type WGS84GeoPoint
column_create --table Comments --name posted_by --flags COLUMN_SCALAR --type Users
column_create --table Comments --name favorited_by --flags COLUMN_INDEX --type Users --source favorites
column_create --table HashTags --name hash_index --flags COLUMN_INDEX --type Comments --source hash_tags
column_create --table Bigram --name users_index --flags COLUMN_INDEX|WITH_POSITION|WITH_SECTION --type Users --source name,location_str,description
column_create --table Bigram --name comment_index --flags COLUMN_INDEX|WITH_POSITION --type Comments --source comment

  Usersテーブル

ユーザーの名前や自己紹介文、フォローしているユーザー一覧など、ユーザー情報を格納するためのテーブルです。

_key

    ユーザーID

name

    ユーザー名

follower

    フォローしているユーザーの一覧

favorites

    お気に入りのコメント一覧

location

    ユーザーの現在地（緯度経度座標）

location_str

    ユーザーの現在地（文字列）

description

    ユーザーの自己紹介

folowee

    Usersテーブルのfollowerカラムに対するインデックス。 このインデックスを作ることで、あるユーザーをフォローしているユーザーを検索できるようになります。

  Commentsテーブル

コメント内容や投稿日時、返信先情報など、コメントに関する内容を格納するテーブルです。

_key

    コメントID

comment

    コメント内容

last_modified

    投稿日時

replied_to

    返信元のコメント内容

replied_users

    返信先のユーザーの一覧

hash_tags

    コメントのハッシュタグの一覧

location

    投稿場所(緯度経度座標のため)

posted_by

    コメントを書いたユーザー

favorited_by

    Usersテーブルのfavoritesカラムに対するインデックス。 このインデックスを作ることで、指定したコメントを誰がお気に入りに入れているのかを検索できるようになります。

  HashTagsテーブル

コメントのハッシュタグを一覧で保存するためのテーブルです。

_key

    ハッシュタグ

hash_index

    「Comments.hash_tags」のインデックス。 このインデックスを作ることで、指定したハッシュタグのついているコメントの一覧を出すことが出来るようになります。

  Bigramテーブル

ユーザー情報・コメントで全文検索が出来るようにするためのインデックスを格納するテーブルです。

_key

    単語

users_index

    ユーザー情報のインデックス。 このカラムは、ユーザー名「Users.name」、現在地「Users.location_str」、自己紹介文「Users.description」のインデックスになっています。

comment_index

    コメント内容「Comments.comment」のインデックス

  データのロード

つづいて、テスト用データをロードします。

load --table Users
[
  {
    "_key": "daijiro",
    "name": "hsiomaneki",
    "follower": ["tasukuchan"],
    "favorites": [],
    "location": "127678039x502643091",
    "location_str": "神奈川県",
    "description": "groonga developer"
  },
  {
    "_key": "tasukuchan",
    "name": "グニャラくん",
    "follower": ["daijiro","OffGao"],
    "favorites": ["daijiro:1","OffGao:1"],
    "location": "128423343x502929252",
    "location_str": "東京都渋谷区",
    "description": "エロいおっさん"
  },
  {
    "_key": "OffGao",
    "name": "OffGao",
    "follower": ["tasukuchan","daijiro"],
    "favorites": ["tasukuchan:1","daijiro:1"],
    "location": "128544408x502801502",
    "location_str": "東京都中野区",
    "description": "がおがお"
  }
]
load --table Comments
[
  {
    "_key": "daijiro:1",
    "comment": "マイクロブログ作ってみました（甘栗むいちゃいました的な感じで）。",
    "last_modified": "2010/03/17 12:05:00",
    "posted_by": "daijiro",
  },
  {
    "_key": "tasukuchan:1",
    "comment": "初の書き込み。テストテスト。",
    "last_modified": "2010/03/17 12:00:00",
    "posted_by": "tasukuchan",
  },
  {
    "_key": "daijiro:2",
    "comment": "@tasukuchan ようこそ!!!",
    "last_modified": "2010/03/17 12:05:00",
    "replied_to": "tasukuchan:1",
    "replied_users": ["tasukuchan"],
    "posted_by": "daijiro",
  },
  {
    "_key": "tasukuchan:2",
    "comment": "@daijiro ありがとう！",
    "last_modified": "2010/03/17 13:00:00",
    "replied_to": "daijiro:2",
    "replied_users": ["daijiro"],
    "posted_by": "tasukuchan",
  },
  {
    "_key": "tasukuchan:3",
    "comment": "groongaなう #groonga",
    "last_modified": "2010/03/17 14:00:00",
    "hash_tags": ["groonga"],
    "location": "127972422x503117107",
    "posted_by": "tasukuchan",
  },
  {
    "_key": "tasukuchan:4",
    "comment": "groonga開発合宿のため羽田空港に来ました！ #groonga #travel",
    "last_modified": "2010/03/17 14:05:00",
    "hash_tags": ["groonga", "travel"],
    "location": "127975798x502919856",
    "posted_by": "tasukuchan",
  },
  {
    "_key": "OffGao:1",
    "comment": "@daijiro @tasukuchan 登録してみましたよー！",
    "last_modified": "2010/03/17 15:00:00",
    "replied_users": ["daijiro", "tasukuchan"],
    "location": "128551935x502796433",
    "posted_by": "OffGao",
  }
  {
    "_key": "OffGao:2",
    "comment": "中野ブロードウェイなうなう",
    "last_modified": "2010/03/17 15:05:00",
    "location": "128551935x502796434",
    "posted_by": "OffGao",
  }
]

Usersテーブルのfollowerカラムとfavoritesカラム、そしてCommentsテーブルのreplied_usersカラムは、ベクターカラムです。そのため、これらのカラムは配列で値を指定します。

Usersテーブルのlocationカラムと、Commentsテーブルのlocationカラムは、GeoPoint型です。この型での値の指定は、"[緯度]x[経度]"と記述して指定します。

Commentsテーブルのlast_modifiedカラムは、Time型です。この型での値の指定方法は、マイクロ秒数の値を直接指定する方法のほかに、文字列で指定する方法もあります。"年/月/日 時:分:秒"というフォーマットで記述することで、データロードの際に文字列からキャストされ、マイクロ秒数の値が格納されます。

  検索

それでは、実際に検索をしてみましょう。

  キーワードでユーザー検索

ここでは、 tutorial07 で扱った、複数カラムを対象とした検索を行います。 指定された文字列で、ユーザー名・現在地・自己紹介文を対象に検索をします。

実行例

> select --table Users --match_columns name,location_str,description --query 東京 --output_columns _key,name
[[0,1294292470.41307,0.000532663],[[[2],[["_key","ShortText"],["name","ShortText"]],["tasukuchan","グニャラくん"],["OffGao","OffGao"]]]]

「東京」をキーワードにユーザー検索した結果、東京都に住んでいる「グニャラくん」と「OffGao」がヒットしました。

  GeoPointでユーザー検索

ここでは、 tutorial04 で扱った、GeoPoint型のカラムで検索をします。 以下の例では、指定された位置から5000m以内にいるユーザーを検索しています。

実行例

> select --table Users --filter 'geo_in_circle(location,"128484216x502919856",5000)' --output_columns _key,name
[[0,1294292470.6155,0.000343137],[[[2],[["_key","ShortText"],["name","ShortText"]],["tasukuchan","グニャラくん"],["OffGao","OffGao"]]]]

新宿駅から5km以内にすんでいるユーザーを検索したところ、「グニャラくん」と「OffGao」がヒットしました。

  あるユーザーをフォローしているユーザーの検索

ここでは、 tutorial06 で扱った、参照関係の逆引きをします。 以下の例では、Usersテーブルのfollowerカラムにあるフォローリストを逆引きします。

実行例

> select --table Users --query follower:@tasukuchan --output_columns _key,name
[[0,1294292470.81784,0.000305006],[[[2],[["_key","ShortText"],["name","ShortText"]],["daijiro","hsiomaneki"],["OffGao","OffGao"]]]]

「グニャラくん」をフォローしている「hsiomaneki」と「OffGao」がヒットしました。

  GeoPointでコメント検索

ある範囲内で書かれたコメントを検索します。 また、 tutorial05 で扱ったドリルダウンも行います。検索結果をハッシュタグとユーザーでドリルダウンし、ユーザー別・ハッシュタグ別のカウントを出します。

実行例

> select --table Comments --filter 'geo_in_circle(location,"127975798x502919856",20000)' --output_columns posted_by.name,comment --drilldown hash_tags,posted_by
[[0,1294292471.01995,0.000683663],[[[4],[["posted_by.name","ShortText"],["comment","ShortText"]],["OffGao","@daijiro @tasukuchan 登録してみましたよー！"],["グニャラくん","groongaなう #groonga"],["グニャラくん","groonga開発合宿のため羽田空港に来ました！ #groonga #travel"],["OffGao","中野ブロードウェイなうなう"]],[[2],[["_key","ShortText"],["_nsubrecs","Int32"]],["groonga",2],["travel",1]],[[2],[["_key","ShortText"],["_nsubrecs","Int32"]],["OffGao",2],["tasukuchan",2]]]]

範囲を広く指定したため、位置情報のあるすべてのコメントがヒットしました。そして、ヒットしたコメントからドリルダウンされた結果も返ってきており、ハッシュタグは「#groonga」が2つに「#travel」が1つ、投稿者は「グニャラくん」「OffGao」がそれぞれ2件ずつであることがわかります。

  キーワードでコメント検索

あるキーワードを含むコメントを検索します。 さらに、 tutorial04 で扱った、スコア値_scoreも出してみましょう。

実行例

> select --table Comments --query comment:@なう --output_columns comment,_score
[[0,1294292471.22683,0.000339904],[[[2],[["comment","ShortText"],["_score","Int32"]],["groongaなう #groonga",1],["中野ブロードウェイなうなう",2]]]]

「なう」をキーワードにコメント検索した結果、2件のコメントがヒットしました。また、_scoreの値も返ってきており、「なう」の数が出力されていることが確認できます。

  GeoPointとキーワードでコメント検索

今度は、キーワードとGeoPointの両方を条件に検索をしてみます。--queryと--filterの両方を使用した場合、両方の条件に一致するレコードがヒットします。

実行例

> select --table Comments --query comment:@羽田 --filter 'geo_in_circle(location,"127975798x502919856",20000)' --output_columns posted_by.name,comment --drilldown hash_tags,posted_by
[[0,1294292471.42922,0.00063973],[[[1],[["posted_by.name","ShortText"],["comment","ShortText"]],["グニャラくん","groonga開発合宿のため羽田空港に来ました！ #groonga #travel"]],[[2],[["_key","ShortText"],["_nsubrecs","Int32"]],["groonga",1],["travel",1]],[[1],[["_key","ShortText"],["_nsubrecs","Int32"]],["tasukuchan",1]]]]

両方の条件を満たすコメントが1件ヒットしました。また、ドリルダウンの結果も返ってきており、「グニャラくん」のコメント1件であることがわかります。

  ハッシュタグでコメント検索

あるハッシュタグのついているコメントを検索します。 これも、 tutorial06 で扱った、参照関係の逆引きを使います。

実行例

> select --table Comments --query hash_tags:@groonga --output_columns posted_by.name,comment --drilldown posted_by
[[0,1294292471.6339,0.000473975],[[[2],[["posted_by.name","ShortText"],["comment","ShortText"]],["グニャラくん","groongaなう #groonga"],["グニャラくん","groonga開発合宿のため羽田空港に来ました！ #groonga #travel"]],[[1],[["_key","ShortText"],["_nsubrecs","Int32"]],["tasukuchan",2]]]]

#groongaタグの付いている2件のコメントがヒットしました。また、投稿者のドリルダウンも返ってきており、2件とも「グニャラくん」のものであることがわかります。

  ユーザーIDでコメント検索

あるユーザーが投稿したコメントを検索します。

実行例

> select --table Comments --query posted_by:tasukuchan --output_columns comment --drilldown hash_tags
[[0,1294292471.83804,0.000471649],[[[4],[["comment","ShortText"]],["初の書き込み。テストテスト。"],["@daijiro ありがとう！"],["groongaなう #groonga"],["groonga開発合宿のため羽田空港に来ました！ #groonga #travel"]],[[2],[["_key","ShortText"],["_nsubrecs","Int32"]],["groonga",2],["travel",1]]]]

「グニャラくん」が書き込んだ4件のコメントがヒットしました。また、ハッシュタグでドリルダウンした結果も返ってきており、ハッシュタグは「#groonga」が2つに「#travel」が1つあることがわかります。

  ユーザーのお気に入りコメントを検索

あるユーザーがお気に入りに入れているコメントを検索します。

実行例

> select --table Users --query _key:tasukuchan --output_columns favorites.posted_by,favorites.comment
[[0,1294292472.04238,0.000320089],[[[1],[["favorites.posted_by","Users"],["favorites.comment","ShortText"]],[["daijiro","OffGao"],["マイクロブログ作ってみました（甘栗むいちゃいました的な感じで）。","@daijiro @tasukuchan 登録してみましたよー！"]]]]]

「グニャラくん」がお気に入りに入れている2件のコメントがヒットしました。

  投稿時間でコメント検索

コメントの投稿時間で検索をします。Time型については tutorial03 で扱っています。 この例では、指定した時間よりも前に投稿されているコメントを検索します。

実行例

> select Comments --filter 'last_modified<=1268802000' --output_columns posted_by.name,comment,last_modified --drilldown hash_tags,posted_by
[[0,1294292472.24623,0.000634424],[[[5],[["posted_by.name","ShortText"],["comment","ShortText"],["last_modified","Time"]],["hsiomaneki","マイクロブログ作ってみました（甘栗むいちゃいました的な感じで）。",1268795100.0],["グニャラくん","初の書き込み。テストテスト。",1268794800.0],["hsiomaneki","@tasukuchan ようこそ!!!",1268795100.0],["グニャラくん","@daijiro ありがとう！",1268798400.0],["グニャラくん","groongaなう #groonga",1268802000.0]],[[1],[["_key","ShortText"],["_nsubrecs","Int32"]],["groonga",1]],[[2],[["_key","ShortText"],["_nsubrecs","Int32"]],["daijiro",2],["tasukuchan",3]]]]

2010/03/17 14:00:00以前に書かれたコメント5件がヒットしました。また、ドリルダウンの結果も返ってきており、「hsiomaneki」が2件、「グニャラくん」が3件ヒットしていることがわかります。

リファレンスマニュアル

  実行環境

  groonga実行ファイル

  名前

groonga - 列指向データベース機能を持つ全文検索エンジンソフトウェア

  書式

groonga [options] [dest] [command [args]]

  説明

groongaは列指向のデータベース機能を持つ高速でスケーラブルな全文検索エンジンです。 groongaのデータベースは、groonga実行ファイルかCライブラリインタフェースを通して操作することができます。このマニュアルページでは、groonga実行ファイルの使い方について説明します。

  オプション

-n  新たなデータベースを作成します。

-c  クライアントモードで実行します。

-s  サーバモードで実行します。

-d  デーモンモードで実行します。(forkする点がサーバモードと異なる)

-e, --encoding <encoding>

    データベースで使用する文字エンコーディング方式を指定します。新たなデータベースを作成する時のみ有効です。none, euc, utf8, sjis, latin, koi8rのいずれかが指定できます。

-l, --log-level <log level>

    ログレベルを指定します。0〜8までの数値が指定可能で、数が大きいほど多くのログが出力されます。

-a, --address <ip/hostname>

    サーバモードかデーモンモードで実行するとき、listenするアドレスを指定します。(デフォルトは`hostname`の返すホスト名)

-p, --port <port number>

    クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。 (デフォルトは10041番)

-i, --server-id <ip/hostname>

    サーバモードかデーモンモードで実行するとき、サーバのIDとなるアドレスを指定します。(デフォルトは`hostname`の返すホスト名)

-h, --help

    ヘルプメッセージを出力します。

--document-root <path>

    httpサーバとしてgroongaを使用する場合に静的ページを格納するディレクトリを指定します。

    デフォルトでは、データベースを管理するための汎用的なページに対応するファイルが/usr/share/groonga/admin_html以下にインストールされます。このディレクトリをdocument-rootオプションの値に指定して起動した場合、ウェブブラウザでhttp://hostname:port/index.htmlにアクセスすると、ウェブベースのデータベース管理ツールを使用できます。

--protocol <protocol>

    http,gqtpのいずれかを指定します。(デフォルトはgqtp)

--log-path <path>

    ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)

--query-log-path <path>

    クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)

-t, --max-threads <max threasd>

    最大で利用するスレッド数を指定します。(デフォルトはマシンのCPUコア数と同じ数です)

--pid-path <path>

    PIDを保存するパスを指定します。(デフォルトでは保存しません)

--config-path <path>

    設定ファイルのパスを指定します。設定ファイルは以下のようなフォーマットになります。:

    # '#'以降はコメント。
    ; ';'以降もコメント。
    # 'キー = 値'でオプションを指定。
    pid-file = /var/run/groonga.pid
    # '='の前後の空白はは無視される。↓は↑と同じ意味。
    pid-file=/var/run/groonga.pid
    # 'キー'は'--XXX'スタイルのオプション名と同じものが使える。
    # 例えば、'--pid-path'に対応するキーは'pid-path'。
    # ただし、キーが'config-path'のオプションは無視される。

--cache-limit <limit>

    キャッシュ数の最大値を指定します。(デフォルトは100です)

--default-match-escalation-threshold <threshold>

    検索の挙動をエスカレーションする閾値を指定します。(デフォルトは0です)

  引数

dest
    使用するデータベースのパス名を指定します。

    クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は'localhost:10041')。ポート番号を指定しない場合には、10041が指定されたものとします。

command [args]
    スタンドアロンおよびクライアントモードの場合は、実行するコマンドとその引数をコマンドライン引数に指定できます。コマンドライン引数にcommandを与えなかった場合は、標準入力から一行ずつEOFに達するまでコマンド文字列を読み取り、順次実行します。

  コマンド

groonga実行ファイルを通してデータベースを操作する命令をコマンドと呼びます。コマンドは主にC言語で記述され、groongaプロセスにロードすることによって使用できるようになります。 それぞれのコマンドは一意な名前と、0個以上の引数を持ちます。

引数は以下の2種類の方法のいずれかで指定することができます。:

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

形式1でコマンドを実行する場合は、定義された順番で値を指定しなければならず、途中の引数の値を省略することはできません。形式2でコマンドを実行する場合は、「--引数名」のように引数の名前を明示しなければならない代わりに、任意の順番で引数を指定することが可能で、途中の引数の指定を省略することもできます。

標準入力からコマンド文字列を与える場合は、コマンド名と引数名と値は、空白( )で区切ります。空白や、記号「"'()」のうちいずれかを含む値を指定したい場合は、シングルクォート(')かダブルクォート(")で値を囲みます。値として指定する文字列の中では、改行文字は'n'に置き換えて指定します。また、引用符に使用した文字を値の中で指定する場合には、その文字の前にバックスラッシュ('') を指定します。バックスラッシュ文字自身を値として指定する場合には、その前にバックスラッシュを指定します。

  組み込みコマンド

以下のコマンドは組み込みコマンドとして予め定義されています。

status

    groongaプロセスの状態を表示します。

table_list

    DBに定義されているテーブルのリストを表示します。

column_list

    テーブルに定義されているカラムのリストを表示します。

table_create

    DBにテーブルを追加します。

column_create

    テーブルにカラムを追加します。

table_remove

    DBに定義されているテーブルを削除します。

column_remove

    テーブルに定義されているカラムを削除します。

view_add

    VIEW型のテーブルに要素となるテーブルを定義します。

load

    テーブルにレコードを挿入します。

select

    テーブルに含まれるレコードを検索して表示します。

define_selector

    検索条件をカスタマイズした新たな検索コマンドを定義します。

quit

    データベースとのセッションを終了します。

shutdown

    サーバ(デーモン)プロセスを停止します。

log_level

    ログ出力レベルを設定します。

log_put

    ログ出力を行います。

clearlock

    ロックを解除します。

  例

新しいデータベースを作成します。:

% groonga -n /tmp/hoge.db quit
%

作成済みのデータベースにテーブルを定義します。:

% groonga /tmp/hoge.db table_create Table 0 ShortText
[[0]]
%

サーバを起動します。:

% groonga -d /tmp/hoge.db
%

httpサーバとして起動します。:

% groonga -d -p 80 --protocol http --document-root /usr/share/groonga/admin_html /tmp/hoge.db
%

サーバに接続し、テーブル一覧を表示します。:

% groonga -c localhost table_list
[[0],[["id","name","path","flags","domain"],[256,"Table","/tmp/hoge.db.0000100",49152,14]]]
%

  http

  名前

groonga httpサービス

  書式

groonga -d --protocol http --document-root /usr/share/groonga/admin_html dest

  説明

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

デフォルトでは/usr/share/groonga/admin_html配下に、データベース管理ツールとなるファイル群がインストールされますので、このパスを指定してgroongaサーバを起動し、ウェブブラウザでhttp://hostname:port/index.htmlにアクセスすると、管理ツールが使用可能になります。

  コマンド

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

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

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

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

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

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

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

形式: /d/コマンド名.output_type?引数名1=値1&引数名2=値2&...

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

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

output_typeにはjson, tsv, xmlが指定可能です。

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

  返値

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

  grnslap

  名前

grnslap - groongaプロセスの通信層のパフォーマンスをチェックするツール

  書式

grnslap [options] [dest]

  説明

grnslapは、groongaプロセスに対してリクエストを多重に行い、パフォーマンスをチェックするためのツールです。

groonga独自プロトコルであるgqtpと、httpの両プロトコルでリクエストを行うことができます。また、リクエストの多重度を指定することができます。

クエリの内容を標準入力から与えることができます。実稼動環境でのクエリパタンに近いクエリを標準入力に与えることによって、実稼動環境に近い状態での検証を行うことができます。

現在は、make installしてもインストールは行われない。

  オプション

-P  リクエストのプロトコルを指定します。

    http

    httpでリクエストします。対象のhttpのパス群(GETパラメータを含む)をLF区切り形式で標準入力に与えると、それらのパスに順次アクセスします。

    gqtp

    gqtpでリクエストします。gqtpのリクエストをLF区切り形式で標準入力に与えると、それらのリクエストを順次行います。

-m  リクエストの多重度を指定します。初期値は10です。

  引数

dest
    接続先のホスト名とポート番号をを指定します(デフォルト値は'localhost:10041')。ポート番号を指定しない場合には、10041が指定されたものとします。

  サンプル

http://localhost:10041/d/status に、多重度100でリクエストを行う。

> yes /d/status | head -n 100 | grnslap -P http -m 100 localhost:10041
2009-11-12 19:34:09.998696|begin: max_concurrency=100 max_tp=10000
2009-11-12 19:34:10.011208|end  : n=100 min=46 max=382 avg=0 qps=7992.966190 etime=0.012511

  grntest

  名前

grntest - groongaテストプログラム

  書式

grntest  [options...] [script] [db]

  説明

grntestは、groonga汎用テストツールです。

groongaを単独のプロセスとして利用する場合はもちろん、サーバプログラムとして利用する場合の動作確認や実行速度測定が可能です。

grntest を利用するために必要なデータファイルは、ftp.groonga.orgから必要に応じダウンロードしますので、groonga及びgrntestが動作し、インターネットに接続できる環境であればgroongaコマンドの知識がなくてもgroongaの動作を確認できます。

現在は、linux 及びWindows上で動作します。make installしてもインストールは行われません。

  オプション

-i, --host <ip/hostname>

    接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、grntestは自動的にlocalhostのgroongaサーバを起動して接続します。

-p, --port <port number>

    自動的に起動するgroongaサーバ、または明示的に指定した接続先のgroonga サーバが利用するポート番号を指定します。接続先のgroongaサーバが利用しているポートと、このオプションで指定したポート番号が異なる場合、接続不能となることに注意してください。

--dir
    ftp.groonga.org に用意されているスクリプトファイルを表示します。

--noftp
    通常grntestはftp.groonga.orgとftp通信を行い、scriptファイルの同期やログファイルの送信を行います。--noftp オプションを指定するとftp 通信を一切行わないようになります。存在しないスクリプトファイルを指定した場合、エラーとなることに注意してください。

--log-output-dir
    デフォルトでは、grntest終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。

--groonga <groonga_path>

    groongaコマンドのパスを指定します。デフォルトでは、PATHの中からgroongaコマンドを探します。

--protocol <gqtp|http>

    groongaコマンドが使うプロトコルとして``gqtp``または``http``を指定します。

  引数

script
    grntestの動作方法(以下、grntest命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。

db  grntestが利用するgroonga データベースです。指定されたデータベースが存在しない場合、grntestが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。

  使い方

まず、シェル上(Windowsならコマンドプロンプト上)で

grntest test.scr 任意のDB名

とタイプしてください。もしgrntestが正常に動作すれば、

test-ユーザ名-数字.log

というファイルが作成されるはずです。作成されない場合、このドキュメントの「トラブルシューティング」の章を参照してください。

  スクリプトファイル

スクリプトファイルは、grntest命令を記述したテキストファイルです。 ";"セミコロンを利用して、一行に複数のgrntest命令を記述することができます。一行に複数のgrntest命令がある場合、各命令は並列に実行されます。 "#"で始まる行はコメントとして扱われます。

  grntest命令

現在サポートされているgrntest命令は以下の8つです。

do_local コマンドファイル [スレッド数] [繰り返し数]

コマンドファイルをgrntest単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。

do_gqpt コマンドファイル [スレッド数] [繰り返し数]

コマンドファイルをgroongaサーバで実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。

rep_local コマンドファイル [スレッド数] [繰り返し数]

コマンドファイルをgrntest単体で実行し、より詳細な報告を行います。

rep_gqpt コマンドファイル [スレッド数] [繰り返し数]

コマンドファイルをgroongaサーバで実行し、より詳細な報告を行います。 スレッド数や繰り返し数の意味はdo_localと 同じです。

out_local コマンドファイル 入力ファイル名

コマンドファイルをgrntest単体で実行し、各コマンドの実行結果をすべて”出力ファイル"に書きだします。この結果は、test_local,　test_gqtp命令で利用します。なおこの命令の「出力ファイル」とは、grntest実行時に自動的に作成されるログとは別のものです。grntestではコメントが利用できる以外、:

groonga < コマンドファイル > 出力ファイル

とした場合と同じです。

out_gqtp コマンドファイル 出力ファイル名

コマンドファイルをgroongaサーバで実行します。その他はout_local命令と同等です。

test_local コマンドファイル 入力ファイル名
    コマンドファイルをgrntest単体で実行し、各コマンドの実行結果を入力ファイルと比較します。処理時間など本質的要素以外に差分があった場合、差分を、入力ファイル.diffというファイルに書きだします。

  コマンドファイル

コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては./commands.htmlを参照してください。

  サンプル

スクリプトファイルのサンプルです。:

# sample script
rep_local test.ddl
do_local test.load;
do_gqtp test.select 10 10; do_local test.status 10

上記の意味は以下のとおりです。:

1行目:コメント行。
2行目:test.dll というコマンドファイルをgroonga単体で実行し、詳細に報告する。
3行目:test.load というコマンドファイルをgroonga単体で実行する。(最後の";"セミコロンは複数のgrntest命令を記述する場合に必要ですが、この例のように1つのgrntest命令を実行する場合に付与しても問題ありません。)
4行目:test.select というコマンドファイルをgroongaサーバで10個のスレッドで同時に実行する。各スレッドはtest.selectの中身を10回繰り返す。また同時に、groonga単体でtest.statusというコマンドファイルを10個のスレッドで実行する。

  特殊命令

スクリプトファイルのコメント行には特殊コマンドを埋め込むことが可能です。現在サポートされている特殊命令は以下の二つです。

#SET_HOST <ip/hostname> -i, --hostオプションと同等の機能です。コマンドラインオプションに指定したIPアドレス/ホスト名と、SET_HOSTで指定したIPアドレス/ホスト名が異なる場合、またコマンドラインオプションを指定しなかった場合にもSET_HOSTが優先されます。SET_HOSTを利用した場合、サーバが自動的には起動されないのもコマンドラインオプションで指定した場合と同様です。

#SET_PORT <port number>

-p, --port オプションと同等の機能です。コマンドラインオプションに指定したポート番号とSET_PORTで指定したポート番号が異なる場合、またコマンドラインオプションを指定しなかった場合にもSET_PORTが優先されます。

特殊命令はスクリプトファイルの任意の場所に書き込むことができます。同一ファイル内に複数回特殊命令を記述した場合、「最後の」特殊命令が有効となります。

例えば、

$ ./grntest --port 20010 test.scr testdb

とコマンド上でポートを指定した場合でも、もしtest.scrの中身が

::  #SET_PORT 10900 rep_local test.ddl do_local test.load; rep_gqtp test.select 10 10; rep_local test.status 10 #SET_PORT 10400

    であれば、自動的に起動されるgroongaサーバはポート番号10400を利用します。

  grntest実行結果

grntestが正常に終了すると、(拡張子を除いた)スクリプト名-ユーザ名-実行開始時刻.logという形式のログファイルがカレントディレクトリに作られます。ログファイルは自動的にftp.groonga.org に送信されます。ログファイルは以下のようなjson形式のテキストです。

[{"script": "test.scr",
  "user": "homepage",
  "date": "2010-04-14 22:47:04",
  "CPU": Intel(R) Pentium(R) 4 CPU 2.80GHz",
  "BIT": 32,
  "CORE": 1,
  "RAM": "975MBytes",
  "HDD": "257662232KBytes",
  "OS": "Linux 2.4.20-24.7-i686",
  "HOST": "localhost",
  "PORT": "10041",
  "VERSION": "0.1.8-100-ga54c5f8"
},
{"jobs": "rep_local test.ddl",
"detail": [
[0, "table_create res_table --key_type ShortText", 1490, 3086, [0,1271252824.25846,0.00144
7]],
[0, "column_create res_table res_column --type Text", 3137, 5956, [0,1271252824.2601,0.002
741]],
[0, "column_create res_table user_column --type Text", 6020, 8935, [0,1271252824.26298,0.0
02841]],
[0, "column_create res_table mail_column --type Text", 8990, 11925, [0,1271252824.26595,0.
002861]],
[0, "column_create res_table time_column --type Time", 12008, 13192, [0,1271252824.26897,0
.001147]],
[0, "status", 13214, 13277, [0,1271252824.27018,3.0e-05]],
[0, "table_create thread_table --key_type ShortText", 13289, 14541, [0,1271252824.27025,0.
001213]],
[0, "column_create thread_table thread_title_column --type ShortText", 14570, 17380, [0,12
71252824.27153,0.002741]],
[0, "status", 17435, 17480, [0,1271252824.2744,2.7e-05]],
[0, "table_create lexicon_table --flags 129 --key_type ShortText --default_tokenizer Token
Bigram", 17491, 18970, [0,1271252824.27446,0.001431]],
[0, "column_create lexicon_table inv_res_column 514 res_table res_column ", 18998, 33248,
[0,1271252824.27596,0.01418]],
[0, "column_create lexicon_table inv_thread_column 514 thread_table thread_title_column ",
 33285, 48472, [0,1271252824.29025,0.015119]],
[0, "status", 48509, 48554, [0,1271252824.30547,2.7e-05]]],
"summary" :[{"job": "rep_local test.ddl", "latency": 48607, "self": 47719, "qps": 272.4281
73, "min": 45, "max": 15187, "queries": 13}]},
{"jobs": "do_local test.load; ",
"summary" :[{"job": "do_local test.load", "latency": 68693, "self": 19801, "qps": 1010.049
997, "min": 202, "max": 5453, "queries": 20}]},
{"jobs": "do_gqtp test.select 10 10; do_local test.status 10",
"summary" :[{"job": " do_local test.status 10", "latency": 805990, "self": 737014, "qps":
54.273053, "min": 24, "max": 218, "queries": 40},{"job": "do_gqtp test.select 10 10", "lat
ency": 831495, "self": 762519, "qps": 1967.164097, "min": 73, "max": 135631, "queries": 15
00}]},
{"total": 915408, "qps": 1718.359464, "queries": 1573}]

  制限事項

•   スクリプトファイルの一行には複数のgrntest命令を記述できますが、すべてのスレッド数の合計は最大64までに制限されます。

•   コマンドファイル中のgroongaコマンドの長さは最長5000000byteです。

  トラブルシューティング

もし、grntestが正常に動作しない場合、まず以下を確認してください。

•   インターネットに接続しているか？　--noftp モードを指定しない限り、grntestは動作のたびにftp.groonga.orgと通信します。ftp.groonga.orgと通信可能でない場合、grntestは正常に動作しません。

•   groonga サーバが動作していないか？　grntestは、-i, --host オプションで明示的にサーバを指定しないかぎり、自動的にlocalhostのgroongaサーバを立ち上げます。すでにgroongaサーバが動作している場合、grntestは正常に動作しない可能性があります。

•   指定したDBが適切か？ grntestは、引数で指定したDBの中身はチェックしません。もし指定されたDBが存在しなければ自動的にDBを作成しますが、もしファイルとして存在する場合は中身に関わらず動作を続けてしまい、結果が異常になる可能性があります。

    以上の原因でなければ、問題はgrntestかgroongaにあります。ご報告をお願いします。

  コマンド

まず、すべてのコマンドに関係するコマンドバージョンについて説明します。その後、組み込みのコマンドを順に説明します。

  コマンドバージョン

  概要

groonga1.1からコマンドバージョンという概念が導入されます。コマンドバージョンは、selectやloadなどのgroongaのコマンドの仕様の互換性を表します。groongaパッケージのバージョンが新しくなったとしても、同一のコマンドバージョンが使用可能であるなら、すべてのコマンドについて互換性が保証されます。コマンドバージョンが異なれば、同じ名前のコマンドであっても、動作に互換性がない可能性があります。

あるバージョンのgroongaは、二つのコマンドバージョンを同時にサポートするようになります。 使用するコマンドバージョンは、groongaを起動する際のコマンドラインオプションないしコンフィグファイルにdefault-commnad-versionパラメータを与えることによって指定できます。また、個々のコマンドを実行する際に、command_versionパラメータを与えることによっても指定することができます。

コマンドバージョンは1からはじまり、更新されるたびに1ずつ大きくなります。現状のgroongaのコマンドの仕様はcommand-version 1という扱いになります。次回提供するgroongaは、command-version 1とcommand-version 2の二つをサポートすることになります。

  バージョンの位置づけ

あるバージョンのgroongaにおいてサポートされるコマンドバージョンは、develop, stable,deprecatedのいずれかの位置づけとなります。

develop
    まだ開発中であり、仕様が変更される可能性があります。

stable
    使用可能であり仕様も安定しています。その時点で使用することが推奨されます。

deprecated
    使用可能であり仕様も安定していますが、廃止予定であり使用が推奨されません。

    あるバージョンのgroongaがサポートする二つのコマンドバージョンのうち、いずれか一つが必ずstableの位置づけとなります。残りの一つは、developないしdeprecatedとなります。

    たとえば下記のようにgroongaのサポートするコマンドバージョンは推移します。:

    groonga1.1: command-version1=stable     command-version2=develop
    groonga1.2: command-version1=deprecated command-version2=stable
    groonga1.3: command-version2=stable     command-version3=develop
    groonga1.4: command-version2=deprecated command-version3=stable
    groonga1.5: command-version3=stable     command-version4=develop

    あるコマンドバージョンははじめにdevelop扱いとしてリリースされ、やがてstableに移行します。 その後二世代経過するとそのコマンドバージョンはdeprecated扱いとなります。さらに次のコマンドバージョンがリリースされると、deprecatedだったコマンドバージョンはサポート対象外となります。

    default-commnad-versionパラメータやcommand_versionパラメータを指定せずにgroongaコマンドを実行した際には、その時点でstableであるコマンドバージョンが指定されたものとみなします。

    groongaプロセス起動時に、default-command-versionパラメータにstable扱いでないコマンドバージョンを指定した場合には、警告メッセージがログファイルに出力されます。また、サポート範囲外のコマンドバージョンを指定した場合にはエラーとなり、プロセスは速やかに停止します。

  コマンドバージョンの指定方法

コマンドバージョンの指定方法はgroonga実行モジュールの引数として指定する方法と各コマンドの引数として指定する方法があります。

  default-command-versionパラメータ

groonga実行モジュールの引数としてdefault-command-versionパラメータを指定できます。 (configファイルの中に指定することも可能です)

実行例:

groonga --default-command-version 1

そのプロセスで実行するすべてのコマンドについて、デフォルトのコマンドバージョンとして指定されたバージョンを使用します。指定されたコマンドバージョンがstableであった場合にはなんのメッセージも表示されずそのまま起動します。指定されたコマンドバージョンがdevelopあるいはdeprecatedであった場合には、groonga.logファイルに警告メッセージを出力します。指定されたコマンドバージョンがサポート対象外であった場合には標準エラー出力にエラーメッセージを出力し、プロセスは速やかに終了します。

  command_versionパラメータ

select,loadなどのすべてのgroongaコマンドにcommand_versionが指定できます。

実行例:

select --command_version 1 --table tablename

指定されたコマンドバージョンでコマンドを実行します。指定されたコマンドバージョンがサポート対象外であった場合にはエラーが返されます。command-versionが指定されなかった場合は、当該プロセス起動時にdefault-command-versionに指定した値が指定されたものとみなします。

  cache_limit

  名前

cache_limit - cacheサイズの設定・取得

  書式

cache_limit max

  説明

groonga組込コマンドの一つであるcache_limitについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

cache_limitは、クエリキャッシュの最大件数を取得したり設定したりします。

  引数

max

クエリキャッシュの最大件数を整数で指定します。 maxが指定されなかった場合には、クエリキャッシュの最大件数は変更せず、 現在の設定値のみが返されます。

  返値

  json

[以前の設定値]
``以前の設定値``
  すでに設定されていたクエリキャッシュの最大件数を返す。

  例

cache_limit 4
[100]

  check

  名前

check - オブジェクトの状態表示

  書式

check obj

  説明

groonga組込コマンドの一つであるcheckについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

checkコマンドは、groongaプロセス内の指定したオブジェクトの状態を表示します。主にデータベースが壊れた場合など異常時の問題解決のために使用することを想定しています。デバッグ用のため、返値のフォーマットが安定しているということは保証されません。（フォーマットが変更される可能性が高い）

  引数

obj

状態を表示するオブジェクトの名前を指定します。

  返値

  json形式

チェックするオブジェクトにより返される値が変わります。

インデックスカラムの場合:

下記のような配列が出力されます。
  [インデックスの状態, バッファの状態1, バッファの状態2, ...]
``インデックスの状態``には下記の項目がハッシュ形式で出力されます。
``flags``
  指定されているフラグ値です。16進数で表現されています。
``max sid``
  セグメントのうち最も大きなIDです。
``number of garbage segments``
  ゴミセグメントの数です。
``number of array segments``
  配列セグメントの数です。
``max id of array segment``
  配列セグメントのうち最も大きなIDです。
``number of buffer segments``
  バッファセグメントの数です。
``max id of buffer segment``
  バッファセグメントのうち最も大きなIDです。
``max id of physical segment in use``
  使用中の論理セグメントのうち最も大きなIDです。
``number of unmanaged segments``
  管理されていないセグメントの数です。
``total chunk size``
  チャンクサイズの合計です。
``max id of chunk segments in use``
  使用中のチャンクセグメントのうち最も大きなIDです。
``number of garbage chunk``
  各チャンク毎のゴミの数です。
``バッファの状態``には下記の項目がハッシュ形式で出力されます。
``buffer id``
  バッファIDです。
``chunk size``
  チャンクのサイズです。
``buffer term``
  バッファ内にある語の一覧です。各語の状態は以下のような配列となっています。
    [語, バッファに登録されている語のID, 用語集に登録されている語のID, バッファ内でのサイズ, チャンク内でのサイズ]
``buffer free``
  バッファの空き容量です。
``size in buffer``
  バッファの使用量です。
``nterms``
  バッファ内にある語の数です。
``nterms with chunk``
  バッファ内にある語のうち、チャンクを使っている語の数です。

  例

テーブルTermsのインデックスカラムnameの状態を表示します。:

check Terms.name
[{"flags":"00008202",
  "max sid":1,
  "number of garbage segments":0,
  "number of array segments":1,
  "max id of array segment":1,
  "number of buffer segments":110,
  "max id of buffer segment":111,
  "max id of physical segment in use":111,
  "number of unmanaged segments":4294967185,
  "total chunk size":7470239,
  "max id of chunk segments in use":127,
  "number of garbage chunk":[0,0,0,0,0,0,0,0,2,2,0,0,0,0,0]},
 {"buffer id":0,
  "chunk size":94392,
  "buffer term":["596","59777","6",...],
  "buffer free":152944,
  "size in buffer":7361,
  "nterms":237,
  "nterms with chunk":216,
  "buffer id":1,
  "chunk size":71236,
  "buffer term":[["に述",18149,18149,2,25,6,6],
                 ["に追",4505,4505,76,485,136,174],
                 ["に退",26568,26568,2,9,2,2],
                 ...],
  "buffer free":120000,
  "size in buffer":11155,
  "nterms":121,
  "nterms with chunk":116},
  {"buffer id":1,
   ...},
  ...]

  clearlock

  名前

clearlock - オブジェクトにセットされたロックを解除する

  書式

clearlock objname

  説明

groonga組込コマンドの一つであるclearlockについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

clearlockは、対象となるオブジェクト(データベース,テーブル,インデックス等)を指定し、オブジェクトにかけられたロックを再帰的に解除します。

  引数

objname

対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。

返値 ---

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

開いているデータベースのロックをすべて解除する:

clearlock
[true]

テーブル名 Entry のカラム body のロックを解除する:

clearlock Entry.body
[true]

  関連項目

load

  column_create

  名前

column_create - カラムの追加

  書式

column_create table name flags type [source]

  説明

groonga組込コマンドの一つであるcolumn_createについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

column_createは、使用しているデータベースのテーブルに対してカラムを追加します。

  引数

table

カラムを追加するテーブルの名前を指定します。

name

作成するカラムの名前を指定します。カラム名は、テーブルの中で一意でなければなりません。

ピリオド('.'), コロン(':')を含む名前のカラムは作成できません。また、アンダースコア('_')で始まる名前は予約済みであり、使用できません。

flags

カラムの属性を表す以下の数値か、パイプ('|')で組み合わせたシンボル名を指定します。

0, COLUMN_SCALAR

    単一の値が格納できるカラムを作成します。

1, COLUMN_VECTOR

    複数の値の配列を格納できるカラムを作成します。

2, COLUMN_INDEX

    インデックス型のカラムを作成します。

    インデックス型のカラムについては、flagsの値に以下の値を加えることによって、追加の属 性を指定することができます。

128, WITH_SECTION

    段落情報を格納するインデックスを作成します。

256, WITH_WEIGHT

    ウェイト情報を格納するインデックスを作成します。

512, WITH_POSITION

    位置情報を格納するインデックス(完全転置インデックス)を作成します。

    type

    値の型を指定します。groongaの組込型か、同一データベースに定義済みのユーザ定義型、定義済みのテーブルを指定することができます。

    source

    インデックス型のカラムを作成した場合は、インデックス対象となるカラムをsource引数に指定します。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

テーブルEntryに、ShortText型の値を格納するカラム、bodyを作成します。:

column_create Entry body --type ShortText
[true]

テーブルTermに、Entryテーブルのbodyカラムの値を対象とする完全転置インデックス型カラム、entry_bodyを作成します。:

column_create Term entry_body COLUMN_INDEX|WITH_POSITION Entry body
[true]

  column_list

  名前

column_list - テーブルに定義されているカラムのリスト表示

  書式

column_list table

  説明

groonga組込コマンドの一つであるcolumn_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

column_listはテーブルに定義されているカラムをリスト表示します。

  引数

table

    カラム情報を出力するテーブルの名前を指定します。

  返値

  json形式

テーブル名一覧が以下の形式で返却されます。
  [[検索件数], [[カラム名1,カラム型1],..], 検索結果1,..]
``検索件数``
  検索件数が出力されます。
``カラム名n``
  output_columnsに指定された条件に従って、対象となるカラム名が出力されます。
  カラム名ごとに格納されている情報は、以下のとおりです。
  ``id``
    カラムオブジェクトに割り当てられたID
  ``name``
    カラム名
  ``path``
    カラム値を格納するファイル名
  ``type``
    スカラ型,ベクタ型,インデックス型の種別
  ``flags``
    カラムのflags属性
  ``domain``
    カラムの値の属する型
  ``range``
    テーブルのkeyの型
  ``source``
    インデックスカラムのとき、インデックス対象カラム名の配列
``カラム型n``
  output_columnsに指定された条件に従って、対象となるカラム型が出力されます。
``テーブル情報n``
  テーブル情報が出力されます。

  例

column_list Entry
[[["id", "UInt32"],["name","ShortText"],["path","ShortText"],["type","ShortText"],["flags","ShortText"],["domain", "ShortText"],["range", "ShortText"],["source","ShortText"]],[258,"Entry.body","test.db.0000102","var","COLUMN_SCALAR|COMPRESS_NONE|PERSISTENT","Entry","ShortText",[]]]

  column_remove

  名前

column_remove - テーブルに定義されているカラムの削除

  書式

column_remove table name

  説明

groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

column_removeはテーブルに定義されているカラムを削除します。 また、付随するインデックスも削除されます。[#]_

  引数

table

    削除対象のカラムが定義されているテーブルの名前を指定します。

name

    削除対象のカラム名を指定します。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

column_remove Entry body
[true]
脚注

[1] マルチセクションインデックスの一部である場合も、インデックスが削除されます。

  define_selector

  名前

define_selector - 検索コマンドを定義

  書式

define_selector name table [match_columns [query [filter [scorer [sortby
                [output_columns [offset [limit [drilldown [drilldown_sortby
                [drilldown_output_columns [drilldown_offset [drilldown_limit]]]]]]]]]]]]]

  説明

groonga組込コマンドの一つであるdefine_selectorについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

define_selectorは、検索条件をカスタマイズした新たな検索コマンドを定義します。

  引数

name

定義するselectorコマンドの名前を指定します。

table

検索対象のテーブルを指定します。

match_columns

追加するselectorコマンドのmatch_columns引数のデフォルト値を指定します。

query

追加するselectorコマンドのquery引数のデフォルト値を指定します。

filter

追加するselectorコマンドのfilter引数のデフォルト値を指定します。

scorer

追加するselectorコマンドのscorer引数のデフォルト値を指定します。

sortby

追加するselectorコマンドのsortby引数のデフォルト値を指定します。

output_columns

追加するselectorコマンドのoutput_columns引数のデフォルト値を指定します。

offset

追加するselectorコマンドのoffset引数のデフォルト値を指定します。

limit

追加するselectorコマンドのlimit引数のデフォルト値を指定します。

drilldown

追加するselectorコマンドのdrilldown引数のデフォルト値を指定します。

drilldown_sortby

追加するselectorコマンドのdrilldown_sortby引数のデフォルト値を指定します。

drilldown_output_columns

追加するselectorコマンドのdrilldown_output_columns引数のデフォルト値を指定します。

drilldown_offset

追加するselectorコマンドのdrilldown_offset引数のデフォルト値を指定します。

drilldown_limit

追加するselectorコマンドのdrilldown_limit引数のデフォルト値を指定します。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。:

define_selector entry_selector Entry
[true]

  関連項目

../expr

  defrag

  名前

defrag - オブジェクトにセットされたロックを解除する

  書式

defrag objname threshold

  説明

groonga組込コマンドの一つであるdefragについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

defragは、対象となるオブジェクト(データベースか可変長サイズカラム)を指定し、オブジェクトのフラグメンテーションを解消します。

  引数

objname

対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。

  返値

  json形式

[フラグメンテーション解消を実行したセグメントの数]
``フラグメンテーション解消を実行したセグメントの数``
  フラグメンテーション解消を実行したセグメントの数を返す。

  例

開いているデータベースのフラグメンテーションを解消する:

defrag
[300]

テーブル名 Entry のカラム body のフラグメンテーションを解消する:

defrag Entry.body
[30]

  delete

  名前

delete - 一件のレコードの削除

  書式

delete table [key [id]]

  説明

groonga組込コマンドの一つであるdeleteについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

deleteは、使用しているデータベースのテーブルに1件のレコードを削除します。

  引数

table

レコードを削除しようとするテーブルの名前を指定します。

key

削除するレコードの主キー値を指定します。主キーなしのテーブルの場合はこのパラメータを指定しても無視されます(idパラメータを代わりに指定します)。

id

レコードIDによってレコードを指定します。idパラメータを指定する場合は、keyパラメータを指定してはいけません。

返値 ---

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

テーブルEntryからレコードを削除します。:

delete Entry abandon
[true]

  関連項目

load

  dump

  名前

dump - データベースのスキーマとデータを出力する

  書式

dump [tables]

  説明

groonga組込コマンドの一つであるdumpについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

dumpはデータベースのスキーマとデータを後から読み込めるフォーマットで出力します。dumpの結果は大きくなるため、主にコマンドラインから使うことを想定しています。データベースのバックアップが主な利用方法です。

dumpが出力するフォーマットは直接groongaが解釈できるフォーマットです。そのため、以下のようにしてデータベースをコピーすることができます。:

% groonga original/db dump > dump.grn
% mkdir backup
% groonga -n backup/db < dump.grn

  引数

tables

出力対象のテーブルを「,」（カンマ）区切りで指定します。存在しないテーブルを指定した場合は無視されます。

  返値

データベースのスキーマとデータをgroongaの組み込みコマンド呼び出し形式で出力します。output_type指定は無視されます。

  例

データベース内のすべてのデータを出力:

> dump
table_create LocalNames 48 ShortText
table_create Entries 48 ShortText
column_create Entries local_name 0 LocalNames
column_create LocalNames Entries_local_name 2 Entries local_name
...
load --table LocalNames
[
["_key"],
["Items"],
["BLT"],
...
]
...

データベース内のスキーマと特定のテーブルのデータのみ出力:

> dump --tables Users,Sites
table_create Users TABLE_HASH_KEY ShortText
column_create Users name COLUMN_SCALAR ShortText
table_create Comments TABLE_PAT_KEY ShortText
column_create Comments text COLUMN_SCALAR ShortText
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
load --table Users
[
["_key"],
["mori"],
["yu"],
...
]
load --table Sites
[
["_id","url"],
[1,"http://groonga.org/"],
[2,"http://qwik.jp/senna/"],
...
]

  load

  名前

load - データのロード

  書式

load values table [columns [ifexists [input_type]]]

  説明

groonga組込コマンドの一つであるloadについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

loadは、使用しているデータベースのテーブルにレコードを登録し、カラムの値を更新します。

  引数

values

input_typeに指定する形式で登録するレコードの値を表現した文字列を渡します。

input_typeがjsonである場合には、以下のいずれかの形式が使用できます。

形式1

    [[カラム名1, カラム名2,..], [カラム値1, カラム値2,..], [カラム値1, カラム値2,..],..]

形式2

    [{カラム名1: カラム値1, カラム名2: カラム値2}, {カラム名1: カラム値1, カラム名2: カラム値2},..]

    形式1の[カラム名1, カラム名2,..]の要素はcolumns引数が省略された場合のみ有効です。

    対象のテーブルが主キーを持つテーブルであった場合は、カラム名の中に'_key'(主キーを示す疑似カラム名)が含まれていなければなりません。

    values引数が省略された場合には、括弧の対応が取れるまで標準入力からvaluesの値を読み取ります。引数として値を指定する場合は、文字列のエスケープが必要ですが、標準入力から与える文字列はエスケープする必要がありません。

    続きの文字列については、空白文字(' ')をエスケープする必要はありません。

    table

    レコードを追加しようとするテーブルの名前を指定します。

    columns

    テーブルに登録するレコードに値を設定するカラム名のリストを、カンマ区切りで指定します。

    ifexists

    指定した主キーに対応するレコードが既にテーブルに登録済みであった場合に実行するscript形式のgrn_expr文字列を指定します。ifexistsにgrn_exprが指定された場合は、式の値が真である場合に限り、その他のカラムの値が更新されます。(デフォルトはtrue)

    input_type

    入力形式を指定します。jsonのみに対応しています。

    返値 ---

  json形式

[登録件数]

登録件数

テーブルに登録されたレコードの件数が返されます。

  例

テーブルEntryにレコードを登録します。:

load --table Entry --input_type json --values [{\"_key\":\"abandon\",\"body\":\"放棄する\"}]
[1]

標準入力からvaluesの値を与えます。:

load --table Entry --input_type json
[
{"_key": "abbreviate", "body": "短縮する"}
]
[1]

  関連項目

../expr

  log_level

  名前

log_level - ログ出力レベルの設定

  書式

log_level level

  説明

groonga組込コマンドの一つであるlog_levelについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

log_levelは、ログ出力レベルを設定します。

  引数

level

設定するログ出力レベルの値を以下のいずれかで指定します。

EMERG ALERT CRIT error warning notice info debug

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

log_level warning
[true]

  関連項目

log_put log_reopen

  log_put

  名前

log_put - ログ出力

  書式

log_put level message

  説明

groonga組込コマンドの一つであるlog_putについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

log_putは、ログにmessageを出力します。

  引数

level

設定するログ出力レベルの値を以下のいずれかで指定します。

EMERG ALERT CRIT error warning notice info debug

message

出力する文字列を指定します。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

log_put ERROR ****MESSAGE****
[true]

  関連項目

log_level log_reopen

  log_reopen

  名前

log_reopen - ログファイルの再読み込み

  書式

log_reopen

  説明

groonga組込コマンドの一つであるlog_reopenについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

log_reopenは、ログファイルを再読み込みします。

現在、デフォルトのログ関数を用いている場合のみに対応しています。

  引数

ありません。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

log_reopen
[true]

  log_reopenを用いたログのローテーション

1.  ログファイルをmvなどで移動する。 ログはmvで移動された先のファイルに書き込まれる。

2.  log_reopenコマンドを実行する。

3.  既存のログファイル名と同じファイル名で、新たなログファイルが作成される。 今後のログは新たなログファイルに書き込まれる。

  関連項目

log_level log_put

  quit

  名前

quit - セッション終了

  書式

quit

  説明

groonga組込コマンドの一つであるquitについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

quitは、groongaプロセスとのセッションを終了します。クライアントプロセスならばgroongaプロセスとの接続を切ります。

  引数

ありません。

  返値

ありません。

  例

quit

  select

  名前

select - テーブルの中から条件にマッチするレコードを検索して出力する

  書式

select table [match_columns [query [filter [scorer [sortby [output_columns
             [offset [limit [drilldown [drilldown_sortby [drilldown_output_columns
             [drilldown_offset [drilldown_limit [cache
             [match_escalation_threshold]]]]]]]]]]]]]]]

  説明

groonga組込コマンドの一つであるselectについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

selectは、使用しているデータベースのテーブルの中から条件にマッチするレコードを検索して出力します。

  引数

table

検索対象のテーブルを指定します。存在しないテーブルを指定した場合はエラーになります。

match_columns

query引数に指定する検索条件文字列でデフォルトの検索対象となるカラムを指定します。

カラム名

カラム名の後ろに'* 数値'を指定することによって、そのカラムにヒットした際のスコアに積算される重みを指定することができます。

カラム名 * 重み

複数のカラムを'||'で結合して指定することもできます。

カラム名1 * 重み1 || カラム名2 * 重み2

また、カラム名ではなく、検索に使用するインデックス名を指定することもできます。

query

以下の形式の文字列によって検索条件を指定します。

  条件式

以下の条件式が使用できます。

文字列 全文検索条件(デフォルト検索対象カラムの値が指定された文字列を含んでいる)

文字列 フレーズ検索条件(デフォルト検索対象カラムの値が指定されたフレーズを含んでいる)

カラム名:値
    一致条件(カラム値 == 値)

カラム名:!値
    不一致条件(カラム値 != 値)

カラム名:<値
    比較条件(カラム値 < 値)

カラム名:>値
    比較条件(カラム値 > 値)

カラム名:<=値
    比較条件(カラム値 <= 値)

カラム名:>=値
    比較条件(カラム値 >= 値)

カラム名:@文字列
    全文検索条件(カラム値が指定された文字列を含んでいる)

  結合演算子

複数の条件式を結合するために以下の演算子が使用できます。

a OR b
    論理和(aとbといずれかの条件がマッチする)

a + b
    論理積(aとbの両方がマッチする)

a - b
    aにマッチし、bにはマッチしない

( ) 複数の条件をまとめる

    filter

    絞り込み条件をscript形式のgrn_expr文字列によって指定します。

    query引数とfilter引数をどちらも指定した場合は、両方の条件を満足するレコードのみがヒットします。どちらも指定しない場合は全件がヒットします。

    scorer

    検索条件にマッチする全てのレコードに対して適用するgrn_exprをscript形式で指定します。

    scorerは、検索処理が完了し、ソート処理が実行される前に呼び出されます。従って、各レコードのスコアを操作する式を指定しておけば、検索結果のソート順序をカスタマイズできるようになります。

    sortby

    ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。:

    [-]カラム名1, [-]カラム名2, [-]カラム名3, ...

    カラム名1の値でソートし、値が同一である場合はカラム名2でソート、と順次比較を行いソートします。カラム名の前に - を付加した場合は降順にソートします。付加しない場合には昇順にソートします。

    query引数またはfilter引数を指定した場合はカラム名に'_score'を使えます。'_score'を指定することでスコアでソートすることができます。query引数もfilter引数も指定していない状態で'_score'を指定するとエラーになります。

    output_columns

    出力するカラム名のリストをカンマ(',')区切りで指定します。

    アスタリスク('*')を指定すると、全てのカラムが指定されたものとみなされます。または、script形式のgrn_expr文字列を指定します。 (デフォルトは、'_id, _key, *')

    offset

    検索条件にマッチしたレコードのうち、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。offsetに負の値を指定した場合は、ヒットした件数 + offset によって算出される値が指定されたものとみなされます。

    limit

    検索条件にマッチしたレコードのうち、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、offset + limit がヒットした件数を超えない範囲でレコードが出力されます。limitに負の値を指定した場合は、ヒットした件数 + limit + 1 によって算出される値が指定されたものとみなされます。

    drilldown

    グループ化のキーとなるカラム名のリストをカンマ(',')区切りで指定します。検索条件にマッチした各レコードを出力したのちに、drilldownに指定されたカラムの値が同一であるレコードをとりまとめて、それぞれについて結果レコードを出力します。

    drilldown_sortby

    drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。sortbyパラメータと同様に昇降順を指定できます。

    drilldown_output_columns

    drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力するカラム名のリストをカンマ(',')区切りで指定します。

    drilldown_offset

    drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。drilldown_offsetに負の値を指定した場合は、ヒットした件数 + drilldown_offsetによって算出される値が指定されたものとみなされます。

    drilldown_limit

    drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、drilldown_offset + drilldown_limit がヒットした件数を超えない範囲でレコードが出力されます。drilldown_limitに負の値を指定した場合は、ヒットした件数 + drilldown_limit + 1 によって算出される値が指定されたものとみなされます。

    cache

    クエリキャッシュに関する動作を設定します。

    no

    検索結果をクエリキャッシュに残しません。キャッシュして再利用される可能性が低いクエリに対して用います。キャッシュ容量は有限です。有効なキャッシュが多くヒットするために、このパラメータは有効です。

    match_escalation_threshold

    検索の挙動をエスカレーションするかどうかの閾値を設定します。デフォルト値は0です。デフォルト値は以下のいずれかの方法で設定できます。

•   configureの--with-match-escalation-thresholdオプション

•   groongaコマンド起動時の--match-escalation-thresholdオプション

•   設定ファイル中のmatch-escalation-threshold設定項目

    クエリのヒット件数が閾値を越えない場合は:ref:spec_search で説明している方法で検索方法をエスカレーションしてきます。

  返値

以下のようなjson形式で値が返却されます。

[[リターンコード, 処理開始時間, 処理時間], [検索結果, ドリルダウン結果]]

リターンコード

grn_rcに対応する数値が返されます。0(GRN_SUCCESS)以外の場合は、続いてエラー内容を示す 文字列が返されます。

処理開始時間

処理を開始した時間について、1970年1月1日0時0分0秒を起点とした秒数を小数で返します。

処理時間

処理にかかった秒数を返します。

検索結果

drilldown条件が実行される前の検索結果が以下のように出力されます。:

[[検索件数], [[カラム名1,カラム型1],..], 検索結果1,..]

検索件数

検索件数が出力されます。

カラム名n

output_columnsに指定された条件に従って、対象となるカラム名が出力されます。

カラム型n

output_columnsに指定された条件に従って、対象となるカラム型が出力されます。

検索結果n

output_columns, offset, limitによって指定された条件に従って各レコードの値が出力されます。

drilldown結果

drilldown処理の結果が以下のように出力されます。:

[[[件数], [[カラム名1,カラム型1],..], 検索結果1,..],..]

件数

drilldownに指定されたカラムの値の異なり数が出力されます。

カラム名n

drilldown_output_columnsに指定された条件に従って、対象となるカラム名が出力されます。

カラム型n

drilldown_output_columnsに指定された条件に従って、対象となるカラム型が出力されます。

ドリルダウン結果n

drilldown_output_columns, drilldown_offset, drilldown_limitによって指定された条件に従って各レコードの値が出力されます。

  例

テーブルEntryの全レコード・全カラムの値を出力します。:

select Entry
[[[2],[["_id", "UInt32"],["_key","ShortText"],["body","ShortText"]],[1,"abandon","放棄する"],[2,"abbreviate","短縮する"]]]

  関連項目

../expr

  shutdown

  名前

shutdown - サーバプロセスの停止

  書式

shutdown

  説明

groonga組込コマンドの一つであるshutdownについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

shutdownは、接続しているgroongaサーバプロセスを停止します。

  引数

ありません。

  返値

ありません。

  例

shutdown

  status

  名前

status - groongaプロセスの状態表示

  書式

status

  説明

groonga組込コマンドの一つであるstatusについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

statusコマンドは、groongaプロセスの状態を表示します。主にgroongaサーバプロセスに対して使用することを想定しています。

  引数

ありません。

  返値

  json形式

下記の項目がハッシュ形式で出力されます。
``alloc_count``
  groongaプロセスの内部でアロケートされ、まだ解放されてないメモリブロックの数を示します。groongaをbuildする際に、configureオプションで --enable-exact-alloc-countが指定されていたならば、正確な値を返します。それ以外の場合は不正確な値を返す場合があります。
``starttime``
  groongaプロセスが起動した時刻のtvsec値を返します。
``uptime``
  groongaプロセスが起動してから経過した秒数を返します。

  例

status
{"alloc_count":104,
 "starttime":1268213679,
 "uptime":1}

  suggest

** 未だ仕様は確定しておりません。利用のためには特定のデータを持つテーブルが必要となります。 **

  名前

suggest - 指定したクエリに対する補完・修正・提案を行う。

  書式

suggest types table column query

  説明

suggestコマンドは、指定したクエリに対して補完・修正・提案を行います。

補完とは、クエリの未入力・未変換部分を補うことです。修正とは、クエリ内のミスタイプや誤変換を修正することです。提案とは、さらなる絞込みを行うための候補となるクエリを提案することです。

  引数

types

補完・修正・提案のいずれを行うかを、パイプ('|')で組み合わせたシンボル名で指定します(例: correct|suggest)

complete

補完を行います。

correct

修正を行います。

suggest

提案を行います。

table

基礎となるデータが格納されているテーブル名を指定します。

column

基礎となるデータが格納されているテーブルにおいて、「ヨミガナ」が格納されているカラム名を指定します。

query

補完・修正・提案の対象となるクエリを指定します。

  返値

  json形式

{"タイプ1":[["候補1", 候補1のスコア], ["候補2", 候補2のスコア], ...], ...}
``タイプ``
  types引数に指定した値。
``候補``
  補完・修正・提案の候補。
``候補のスコア``
  補完・修正・提案として優れたものほど高くなる数値。結果は、スコア順にソートされている。

  table_create

  名前

table_create - テーブルの追加

  書式

table_create name [flags [key_type [value_type [default_tokenizer]]]]

  説明

groonga組込コマンドの一つであるtable_createについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

table_createコマンドは、使用しているデータベースに対してテーブルを追加します。groongaには名前付きテーブルと名前なしテーブル、永続テーブルと一時テーブルがありますが、table_createコマンドでは、名前付きの永続テーブルのみが作成できます。テーブルはレコードの集合であり、全てのレコードは一意なIDを持ちます。IDはレコードを追加した順序に従って自動的に付与されます。

テーブルにカラムを追加する時にはcolumn_createコマンドを使用します。また、テーブルを作成した時点でいくつかの疑似カラムが使用可能になっています。

  引数

name

作成するテーブルの名前を指定します。nameはデータベース内で一意な、未定義の名前でなければなりません。組込型名・組込コマンド名・組込関数名は予約済みであり、テーブル名には 使用できません。また、ピリオド('.'), コロン(':')を含む名前のテーブルは作成できません。

flags

作成するテーブルの属性を示す数値か、パイプ('|')で組み合わせたシンボル名を指定します。(デフォルト値は0(="TABLE_HASH_KEY"))

0, TABLE_HASH_KEY

    主キー値をハッシュ表で管理するテーブルを作成します。ハッシュ表を使用したテーブルでは、主キー値に完全一致するレコードを高速に検索することができます。

1, TABLE_PAT_KEY

    主キー値をパトリシア木で管理するテーブルを作成します。パトリシア木を使用したテーブルでは、主キー値に完全一致するレコード、前方一致するレコード、および最長共通接頭辞となるレコードを高速に検索することができます。また、キー値の昇降順でレコードを取り出したり、キー値の範囲での検索を行うことができます。また、flagsの値に64を加えることによって、後方一致検索も可能となります。

3, TABLE_NO_KEY

    主キーを持たないテーブルを作成します。各レコードはIDのみによって特定することができます。

4, TABLE_VIEW

    複数のテーブルをまとめて操作するための仮想的なテーブル(view)を作成します。

64, KEY_WITH_SIS

    語彙表となるパトリシア木型のテーブルにおいて、後方一致検索を可能とします。

128, KEY_NORMALIZE

    ハッシュ表型か、パトリシア木型のテーブルにおいて、主キー値を正規化した上で登録します。この値が指定されたテーブルではたとえば、主キー値'abc'と'ABC' は同一のレコードに対応するものとみなされます。

    key_type

    主キー値の型を指定します。主キー値を持つテーブルに限り有効です。型にはgroongaの組込型か、同一データベースに定義済みのユーザ定義型、定義済みのテーブルを指定することができます。

    value_type

    値の型を指定します。tableの値には固定長の型のみが指定できます。(可変長の値が必要な場合は別途カラムを作成します) 型にはgroongaの組込型か、同一データベースに定義済みのユーザ定義型、またはテーブルを指定することができます。(デフォルトはvalueなし)

    default_tokenizer

    作成するテーブルを語彙表として使用する場合、文字列を分割するトークナイザを指定します。

    組込のトークナイザとして、以下が準備されています。

TokenDelimit

    空白で区切られた文字列をトークンとする

TokenUnigram

    unigram(1文字を1トークンとする)

TokenBigram

    bigram(2文字の文字列要素をトークンとする)

TokenTrigram

    trigram(3文字の文字列要素をトークンとする)

TokenMecab

    形態素解析器mecabで解析した形態素をトークンとする。(mecabを組み込んだ場合のみ有効)

    トークナイザが指定されなかった場合は、対象の文字列を分割せずに語彙表に登録します。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

ShortText型の主キーを持つハッシュ表型のテーブル、Entryを作成します。:

table_create Entry --key_type ShortText
[true]

ShortText型の主キーを持つパトリシア木型のテーブル、Termを作成します。主キー値は正規化して管理します。また、このテーブルを語彙表とする転置索引を作成する場合には、バイグラムの索引を作成します。:

table_create Term --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
[true]

  table_list

  名前

table_list - DBに定義されているテーブルをリスト表示

  書式

table_list

  説明

groonga組込コマンドの一つであるtable_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

table_listは、DBに定義されているテーブルのリストを表示します。

  引数

ありません。

  返値

  json形式

::  テーブル名一覧が以下の形式で返却されます。

    [[検索件数], [[カラム名1,カラム型1],..], 検索結果1,..]

    検索件数

    検索件数が出力されます。

    カラム名n

    output_columnsに指定された条件に従って、対象となるカラム名が出力されます。 カラム名ごとに格納されている情報は、以下のとおりです。

    id

    テーブルオブジェクトに割り当てられたID

    name

    テーブル名

    path

    テーブルのレコードを格納するファイル名

    flags

    テーブルのflags属性

    domain

    主キー値の属する型のID

    range

    range

    カラム型n

    output_columnsに指定された条件に従って、対象となるカラム型が出力されます。

    テーブル情報n

    テーブル情報が出力されます。

  例

table_list Entry
[[["id", "UInt32"],["name","ShortText"],["path","ShortText"],["flags","ShortText"],["domain", "ShortText"],["range","ShortText"]],[256,"Entry","test.db.0000100","TABLE_HASH_KEY|PERSISTENT","ShortText","null"],[257,"Term","test.db.0000101","TABLE_PAT_KEY|KEY_NORMALIZE|PERSISTENT","ShortText","null"]]

  table_remove

  名前

table_remove - テーブルの削除

  書式

table_remove table

  説明

groonga組込コマンドの一つであるtable_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

table_removeはテーブルと定義されているカラムを削除します。カラムに付随するインデックスも再帰的に削除されます。

  引数

table

    削除対象のカラムが定義されているテーブルの名前を指定します。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

column_remove Entry body
[true]

  view_add

  名前

view_add - view型のテーブルに要素となるテーブルを追加

  書式

view_add view table

  説明

groonga組込コマンドの一つであるview_addについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

view_addは、view型のテーブルに要素となるテーブルを定義します。

  引数

view

テーブルを追加するview型のテーブルの名前を指定します。

table

view型のテーブルに追加されるテーブルの名前を指定します。

  返値

  json形式

[成功かどうかのフラグ]
``成功かどうかのフラグ``
  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。

  例

::  view_add Ventry Entry [true]

  データ型

  名前

groonga データ型

  説明

groonga は、格納するデータの型を区別します。

groongaのデータベースでは、テーブルの主キーや、カラムの値はいずれも何らかの型に属します。また通常は、一つのテーブルの中の全てのレコードについて、カラムの値は共通となります。

主キーの型とカラムの型には、groongaで予め定義済みの型か、ユーザが定義する型、またはユーザが定義したテーブルを指定することができます。

主キーの型に他のテーブルを指定する場合は、そのテーブルは、主キーの型となるテーブルのサブセットとなります。

カラムの型に他のテーブルを指定する場合は、そのカラムは、カラムの型となるテーブルの参照キーとなります。

  組込型

以下の型が組込型としてあらかじめ定義されています。

Object

任意のテーブルに属する全てのレコード [1]

Bool

bool型。trueとfalse。

Int8

8bit符号付き整数。

UInt8

8bit符号なし整数。

Int16

16bit符号付き整数。

UInt16

16bit符号なし整数。

Int32

32bit符号付き整数。

UInt32

32bit符号なし整数。

Int64

64bit符号付き整数。

UInt64

64bit符号なし整数。

Float

ieee754形式の64bit浮動小数点数。

Time

1970年1月1日0時0分0秒からの経過マイクロ秒数を64bit符号付き整数で表現した値。

ShortText

4Kbyte以下の文字列。

Text

64Kbyte以下の文字列。

LongText

2Gbyte以下の文字列。

TokyoGeoPoint

日本測地系緯度経度座標。緯度と経度はミリ秒単位での整数。 "経度のミリ秒x緯度のミリ秒"という文字列表現を持つ。 度分秒形式であれば、x度y分z秒は(((x * 60) + y) * 60 + z) * 1000という計算式で変換した値を代入します。

WGS84GeoPoint

世界測地系緯度経度座標。緯度と経度はミリ秒単位での整数。 "経度のミリ秒x緯度のミリ秒"という文字列表現を持つ。 度分秒形式であれば、x度y分z秒は(((x * 60) + y) * 60 + z) * 1000という計算式で変換した値を代入します。

  型に関する制限事項

  テーブルの主キーに指定できない型

Text型とLongText型については、テーブルの主キーに指定することはできません。

  ベクトルとして格納できない型

groongaのカラムは、ある型のベクトルを保存することができます。しかし、ShortText, Text, LongTextの３つの型についてはベクトルとして保存することはできません。

テーブル型は、ベクトルとして格納することができます。よって、ShortTextのベクトルを保存したい場合には、主キーがShortText型のテーブルを別途作成し、そのテーブルを型として利用します。 脚注

[1] Object型はv1.2でサポートされます。

  疑似カラム (pseudo_column)

  名前

疑似カラム

  説明

groongaのデータベースで作成したテーブルには、いくつかのカラムが自動的に定義されます。

これらのカラムはいずれもアンダースコア('_')で始まる名前が付与されます。定義される疑似カラムは、テーブルの種類によって異なります。

_id

レコードに付与される一意な番号です。全てのテーブルに定義されます。値の範囲は1〜1073741824の整数で、通常はレコードを追加した順に1ずつ加算されます。_idの値は不変で、レコードが存在する限り変更することはできません。ただし、削除されたレコードの_idの値は再利用されます。

_key

レコードの主キー値を表します。主キーを持つテーブルのみに定義されます。主キー値はテーブルの中で一意であり、変更することはできません。

_value

レコードの値を表します。value_typeを指定したテーブルのみに定義されます。自由に変更可能です。

_score

各レコードのスコア値を表します。検索結果として生成されたテーブルのみに定義されます。

検索処理を実行する過程で値が設定されますが、自由に変更可能です。

_nsubrecs

主キーの値が同一であったレコードの件数を表します。検索結果として生成されたテーブルのみに定義されます。グループ化(drilldown)処理を実行すると、グループ化前のテーブルにおいて、グループ化キーの値が同一であったレコードの件数が、グループ化処理の結果を格納するテーブルの_nsubrecsに記録されます。

  grn_expr

  名前

grn_expr - 検索条件やデータベースへの操作を表現するデータ構造(読み方:"ぐるんしき")

  説明

grn_exprは、検索条件やデータベースへの操作を表現するために使用されるデータ構造の形式です。

データベースの中から特定の条件を満たすレコードを取り出すために、様々な条件をand,or,notなどの演算子で結合して自由に表現することができます。grn_exprは、一連のAPI関数を呼ぶことによって組み立てることができます。特定の文字列形式には依存していません。組み込みコマンドselectのqueryパラメータでは、検索エンジンのユーザがフォームで入力する文字列を直接受け取ることを想定して、文字列からgrn_exprを生成しています。また、多くの組み込みコマンドで共通に使用するために、ECMAScript形式の文字列からgrn_exprを生成するAPI関数grn_expr_parse()を用意しています。grn_expr_parseでパースできる文字列を特にscript形式のgrn_exprと呼びます。

grn_exprを使うことによって非常に柔軟に検索条件を記述することができます。類似文書検索や近傍検索のような高度な検索もすべてgrn_exprによって記述できます。また、全文検索クエリにおいて、特定の文字列を含むレコードのスコアを細かく制御したり、検索結果数の多寡に応じてより検索漏れの少ないアルゴリズムで再検索するような機能も、grn_exprとgrn_table_select()API関数を組み合わせることによって自由に定義できます。

  script形式のgrn_expr

ECMAScript風の構文で検索条件やレコードへの操作を記述します。

式中のIDENTIFIER(識別子)は、以下のいずれかを指します。

引数名 grn_exprが受け取る引数の名前

カラム名
    操作対象としているレコードのカラム名

型名・関数名・テーブル名
    データベースに定義された型・テーブル・関数の名前

  例

script形式でcolumn1の値が'hoge'に等しいという条件

column1 == "hoge" 脚注.SS 組み込み関数一覧

  edit_distance

  名前

edit_distance - 指定した2つの文字列の編集距離を計算する

  書式

edit_distance(string1, string2)

  説明

groonga組込関数の一つであるedit_distanceについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

edit_distance() 関数は、string1に指定した文字列とstring2に指定した文字列の間の編集距離を求めます。

  引数

string1

文字列を指定します

string2

もうひとつの文字列を指定します

  返値

指定した2つ文字列の編集距離をUint32型の値として返します。

  例

edit_distance(title, "hoge")
1

  geo_distance

  名前

geo_distance - 指定した2点の距離を計算する

  書式

geo_distance(point1, point2)

  説明

groonga組込関数の一つであるgeo_distanceについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

geo_distance() 関数は、point1に指定した座標とpoint2に指定した座標の間の距離(近似値)を求めます。 geo_distance()の他に、距離計算アルゴリズムの異なる、geo_distance2()、geo_distance3()が使用できます。それぞれ、長方形近似、球面近似、ヒュベニの距離計算式によって距離を算出します。

  引数

point1

距離を求める2点のうち一つを指定します。GeoPoint型の値を指定できます。 [1]

point2

距離を求める2点のうちもう一つを指定します。GeoPoint型の値、あるいは座標を示す文字列を指定できます。

  返値

指定した2点の距離をFloat型の値(単位:メートル)として返します。

  例

geo_distance(pos, "150x150")
100
脚注

[1] TokyoGeoPoint(日本測地系座標)かWGS84GeoPoint(世界測地系座標)のいずれかを指定できます。

  geo_in_circle

  名前

geo_in_circle - 座標が円の範囲内に存在するかどうかを調べます。

  書式

geo_in_circle(point, center, radious_or_point)

  説明

groonga組込関数の一つであるgeo_in_circleについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

geo_in_circle() 関数は、pointに指定した座標が、centerに指定した座標を中心とする円の範囲内にあるかどうかを調べます。

  引数

point

円の範囲内に存在するかどうかを調べる座標を指定します。Point型の値を指定できます。 [1]

center

円の中心となる座標を指定します。Point型の値、あるいは座標を示す文字列を指定できます。

radious_or_point

円の半径を指定します。数値を指定した場合には、半径(単位:メートル)が指定されたものとみなします。 Point型の値、あるいは座標を示す文字列を指定した場合は、円周上の点の一つの座標が指定されたものとみなします。

  返値

pointに指定した座標が円の範囲内にあるかどうかをBool型の値で返します。

  例

geo_in_circle(pos, "100x100", 100)
true
脚注

[1] TokyoGeoPoint(日本測地系座標)かWGS84GeoPoint(世界測地系座標)のいずれかを指定できます。

  geo_in_rectangle

  名前

geo_in_rectangle - 座標が矩形の範囲内に存在するかどうかを調べます。

  書式

geo_in_rectangle(point, top_left, bottom_right)

  説明

groonga組込関数の一つであるgeo_in_rectangleについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

geo_in_rectangle() 関数は、pointに指定した座標が、top_leftとbottom_rightがなす矩形の範囲内にあるかどうかを調べます。

  引数

point

矩形の範囲内に存在するかどうかを調べる座標を指定します。Point型の値を指定できます。 [1]

top_left

矩形の左上隅となる座標を指定します。Point型の値、あるいは座標を示す文字列を指定できます。

bottom_right

矩形の右下隅となる座標を指定します。Point型の値、あるいは座標を示す文字列を指定できます。

  返値

pointに指定した座標が矩形の範囲内にあるかどうかをBool型の値で返します。

  例

geo_in_rectangle(pos, "150x100", "100x150")
true
脚注

[1] TokyoGeoPoint(日本測地系座標)かWGS84GeoPoint(世界測地系座標)のいずれかを指定できます。

  now

  名前

now - 現在時刻を返す

  書式

now()

  説明

groonga組込関数の一つであるnowについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

now() 関数は現在時刻に対応するTime型の値を返します。

  返値

現在時刻に対応するTime型のオブジェクトを返します。

  例

now()
1256791194.55541

  rand

  名前

rand - 乱数を生成する

  書式

rand([max])

  説明

groonga組込関数の一つであるrandについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

rand() 関数は 0 から max の間の疑似乱数整数を返します。

  引数

max

返値の最大値を指定します。省略した場合は RAND_MAX が指定されたものとみなされます。

  返値

0 と max の間の数を表すInt32型の値を返します。

  例

rand(10)
3

仕様

  検索

select コマンドがqueryパラメータを使ってどのように検索するのかを説明します。

  検索の挙動

検索の挙動には以下の3種類あり、検索結果によって動的に使い分けています。

1.  完全一致検索

2.  非わかち書き検索

3.  部分一致検索

    どのように検索の挙動を使い分けているかを説明する前に、まず、それぞれの検索の挙動を説明します。

  完全一致検索

検索対象文書は複数の語彙にトークナイズ(分割)され、それぞれを単位とした語彙表に索引を管理します。 検索キーワードも同一の方法でトークナイズされます。

このとき、検索キーワードをトークナイズした結果得られる語彙の配列と同一の配列を含む文書を検索する処理を完全一致検索と呼んでいます。

たとえば、TokenMecabトークナイザを使用した索引では「東京都民」という文字列は

東京 / 都民

という二つの語彙の配列として格納されます。この索引に対して「東京都」というキーワードで検索した時、このキーワードは、

東京 / 都

という二つの語彙の配列として処理されます。この語彙の並びは、「東京 / 都民」という語彙の並びには一致しませんので、完全一致検索ではヒットしません。

これに対して、TokenBigramトークナイザを使用した索引では「東京都民」という文字列は

東京 / 京都 / 都民 / 民

という四つの語彙の配列として格納されます。この索引に対して「東京都」というキーワードで検索した時、このキーワードは、

東京 / 京都

という二つの語彙の配列として処理されます。この語彙の並びは、「東京 / 京都 / 都民」という語彙の並びに含まれますので、完全一致検索でヒットします。

なお、TokenBigramトークナイザでは、アルファベット・数値・記号文字列についてはbigramを生成せず、一つの連続したトークンとして扱います。たとえば、「楽しいbilliard」という文字列は、

楽し / しい / billiard

という三つの語彙の配列として格納されます。これに対して「bill」というキーワードで検索した時、このキーワードは、

bill

という一つの語彙として処理されます。この語彙の並びは「楽し / しい / billiard」という語彙の並びには含まれないので、完全一致でヒットしません。

これに対して、TokenBigramSplitSymbolAlphaトークナイザではアルファベット文字列についてもbigramを生成し、「楽しいbilliard」という文字列は、

楽し / しい / いb / bi / il / ll / li / ia / ar / rd / d

という十一の語彙の配列として格納されます。これに対して「bill」というキーワードで検索した時、このキーワードは、

bi / il / ll

という三つの語彙として処理されます。この語彙の並びは「楽し / しい / いb / bi / il / ll / li / ia / ar / rd / d」という語彙の並びに含まれるので、完全一致でヒットします。

  非わかち書き検索

非わかち書き検索はパトリシア木で語彙表を構築している場合のみ利用可能です。

非わかち書き検索の挙動はTokenBigramなどN-gram系のトークナイザーを利用している場合とTokenMecabトークナイザーを利用しようしている場合で挙動が変わります。

N-gram系のトークナイザーを利用している場合はキーワードで前方一致検索をします。

例えば、「bill」というキーワードで検索した場合、「bill」も「billiard」もヒットします。

TokenMeCabトークナイザーの場合はわかち書き前のキーワードで前方一致検索をします。

例えば、「スープカレー」というキーワードで検索した場合、「スープカレーバー」（1単語扱い）にヒットしますが、「スープカレー」（"スープ"と"カレー"の2単語扱い）や「スープカレーライス」（"スープ"と"カレーライス"の2単語扱い）にはヒットしません。

  部分一致検索

部分一致検索はパトリシア木で語彙表を構築していて、かつ、KEY_WITH_SISオプションを指定している場合のみ利用可能です。KEY_WITH_SISオプションが指定されていない場合は非わかち書き検索と同等です。

部分一致検索の挙動はTokenBigramなどN-gram系のトークナイザーを利用している場合とTokenMecabトークナイザーを利用しようしている場合で挙動が変わります。

Bigramの場合は前方一致検索と中間一致検索と後方一致検索を行います。

例えば、「ill」というキーワードで検索した場合、「bill」も「billiard」もヒットします。

TokenMeCabトークナイザーの場合はわかち書き後のキーワードで前方一致検索と中間一致検索と後方一致検索をします。

例えば、「スープカレー」というキーワードで検索した場合、「スープカレー」（"スープ"と"カレー"の2単語扱い）や「スープカレーライス」（"スープ"と"カレーライス"の2単語扱い）、「スープカレーバー」（1単語扱い）にもヒットします。

  検索の使い分け

groongaは基本的に完全一致検索のみを行います。完全一致検索でのヒット件数が所定の閾値を超えない場合に限り、非わかち書き検索を行い、それでもヒット件数が閾値を超えない場合は部分一致検索を行います。(閾値は1がデフォルト値となっています)

ただし、すでに検索結果セットが存在する場合はたとえヒット件数が閾値に満たなくても完全一致検索のみを行います。

例えば、以下のようなクエリの場合は、それぞれの検索でヒット件数が閾値に満たない場合は完全一致検索、非わかち書き検索、部分一致検索を順に行います。:

select Shops --match_column description --query スープカレー

しかし、以下のように全文検索を行う前に検索結果セットが存在する場合は完全一致検索のみを行います。（point > 3で閾値の件数以上ヒットしている場合）:

select Shops --filter '"point > 3 && description @ \"スープカレー\""'

そのため、descriptionに「スープカレーライス」が含まれていても、「スープカレーライス」は「スープカレー」に完全一致しないのでヒットしません。

トラブルシューティング

  同じ検索キーワードなのに全文検索結果が異なる

同じ検索キーワードでも一緒に指定するクエリによっては全文検索の結果が異なることがあります。ここでは、その原因と対策方法を説明します。

  例

まず、実際に検索結果が異なる例を説明します。

DDLは以下の通りです。BlogsテーブルのbodyカラムをTokenMecabトークナイザーを使ってトークナイズしてからインデックスを作成しています。:

table_create Blogs TABLE_NO_KEY
column_create Blogs body COLUMN_SCALAR ShortText
column_create Blogs updated_at COLUMN_SCALAR Time
table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenMecab
column_create Terms blog_body COLUMN_INDEX|WITH_POSITION Blogs body

テスト用のデータは1件だけ投入します。:

load --table Blogs
[
  ["body", "updated_at"],
  ["東京都民に深刻なダメージを与えました。", "2010/9/21 10:18:34"],
]

まず、全文検索のみで検索します。この場合ヒットします。:

> select Blogs --filter 'body @ "東京都"'
[[0,4102.268052438,0.000743783],[[[1],[["_id","UInt32"],["updated_at","Time"],["body","ShortText"]],[1,1285031914.0,"東京都民に深刻なダメージを与えました。"]]]]

続いて、範囲指定と全文検索を組み合わせて検索します（1285858800は2010/10/1 0:0:0の秒表記）。この場合もヒットします。:

> select Blogs --filter 'body @ "東京都" && updated_at < 1285858800'
[[0,4387.524084839,0.001525487],[[[1],[["_id","UInt32"],["updated_at","Time"],["body","ShortText"]],[1,1285031914.0,"東京都民に深刻なダメージを与えました。"]]]]

最後に、範囲指定と全文検索の順番を入れ替えて検索します。個々の条件は同じですが、この場合はヒットしません。:

> select Blogs --filter 'updated_at < 1285858800 && body @ "東京都"'
[[0,4400.292570838,0.000647716],[[[0],[["_id","UInt32"],["updated_at","Time"],["body","ShortText"]]]]]

どうしてこのような挙動になるかを説明します。

  原因

このような挙動になるのは全文検索時に複数の検索の挙動を使い分けているからです。ここでは簡単に説明するので、詳細は spec_search を参照してください。

検索の挙動には以下の3種類があります。

1.  完全一致検索

2.  非わかち書き検索

3.  部分一致検索

    groongaは基本的に完全一致検索のみを行います。上記の例では「東京都民に深刻なダメージを与えました。」を「東京都」というクエリで検索していますが、TokenMecabトークナイザーを使っている場合はこのクエリはマッチしません。

    検索対象の「東京都民に深刻なダメージを与えました。」は

    東京 / 都民 / に / 深刻 / な / ダメージ / を / 与え / まし / た / 。

    とトークナイズされますが、クエリの「東京都」は

    東京 / 都

    とトークナイズされるため、完全一致しません。

    groongaは完全一致検索した結果のヒット件数が所定の閾値を超えない場合に限り、非わかち書き検索を行い、それでもヒット件数が閾値を超えない場合は部分一致検索を行います（閾値は1がデフォルト値となっています）。このケースのデータは部分一致検索ではヒットするので、「東京都」クエリのみを指定するとヒットします。

    しかし、以下のように全文検索前にすでに閾値が越えている場合（「updated_at < 1285858800」で1件ヒットし、閾値を越える）は、たとえ完全一致検索で1件もヒットしない場合でも部分一致検索などを行いません。:

    select Blogs --filter 'updated_at < 1285858800 && body @ "東京都"'

    そのため、条件の順序を変えると検索結果が変わるという状況が発生します。以下で、この情報を回避する方法を2種類紹介しますが、それぞれトレードオフとなる条件があるので採用するかどうかを十分検討してください。

  対策方法1: トークナイザーを変更する

TokenMecabトークナイザーは事前に準備した辞書を用いてトークナイズするため、再現率よりも適合率を重視したトークナイザーと言えます。一方、TokenBigramなど、N-gram系のトークナイザーは適合率を重視したトークナイザーと言えます。例えば、TokenMecabの場合「東京都」で「京都」に完全一致することはありませんが、TokenBigramでは完全一致します。一方、TokenMecabでは「東京都民」に完全一致しませんが、TokenBigramでは完全一致します。

このようにN-gram系のトークナイザーを指定することにより再現率をあげることができますが、適合率が下がり検索ノイズが含まれる可能性が高くなります。この度合いを調整するためには select のmatch_columnsで使用する索引毎に重み付けを指定します。

ここでも、前述の例を使って具体例を示します。まず、TokenBigramを用いた索引を追加します。:

table_create Bigram TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
column_create Bigram blog_body COLUMN_INDEX|WITH_POSITION Blogs body

この状態でも以前はマッチしなかったレコードがヒットするようになります。:

> select Blogs --filter 'updated_at < 1285858800 && body @ "東京都"'
[[0,7163.448064902,0.000418127],[[[1],[["_id","UInt32"],["updated_at","Time"],["body","ShortText"]],[1,1285031914.0,"東京都民に深刻なダメージを与えました。"]]]]

しかし、N-gram系のトークナイザーの方がTokenMecabトークナイザーよりも語のヒット数が多いため、N-gram系のヒットスコアの方が重く扱われてしまいます。N-gram系のトークナイザーの方がTokenMecabトークナイザーよりも適合率の低い場合が多いので、このままでは検索ノイズが上位に表示される可能性が高くなります。

そこで、TokenMecabトークナイザーを使って作った索引の方をTokenBigramトークナイザーを使って作った索引よりも重視するように重み付けを指定します。これは、match_columnsオプションで指定できます。:

> select Blogs --match_columns 'Terms.blog_body * 10 || Bigram.blog_body * 3' --query '東京都' --output_columns '_score, body'
[[0,8167.364602632,0.000647003],[[[1],[["_score","Int32"],["body","ShortText"]],[13,"東京都民に深刻なダメージを与えました。"]]]]

この場合はスコアが11になっています。内訳は、Terms.blog_body索引（TokenMecabトークナイザーを使用）でマッチしたので10、Bigram.blog_body索引（TokenBigramトークナイザーを使用）でマッチしたので3、これらを合計して13になっています。このようにTokenMecabトークナイザーの重みを高くすることにより、検索ノイズが上位にくることを抑えつつ再現率を上げることができます。

この例は日本語だったのですが、TokenBigramトークナイザーでよかったのですが、アルファベットの場合はTokenBigramSplitSymbolAlphaトークナイザーなども利用する必要があります。例えば、「楽しいbilliard」はTokenBigramトークナイザーでは

楽し / しい / billiard

となり、「bill」では完全一致しません。一方、TokenBigramSplitSymbolAlphaトークナイザーを使うと

楽し / しい / いb / bi / il / ll / li / ia / ar / rd / d

となり、「bill」でも完全一致します。

TokenBigramSplitSymbolAlphaトークナイザーを使う場合も重み付けを考慮する必要があることはかわりありません。

利用できるバイグラム系のトークナイザーの一覧は以下の通りです。

•   TokenBigram: バイグラムでトークナイズする。連続する記号・アルファベット・数字は一語として扱う。

•   TokenBigramSplitSymbol: 記号もバイグラムでトークナイズする。連続するアルファベット・数字は一語として扱う。

•   TokenBigramSplitSymbolAlpha: 記号とアルファベットもバイグラムでトークナイズする。連続する数字は一語として扱う。

•   TokenBigramSplitSymbolAlphaDigit: 記号・アルファベット・数字もバイグラムでトークナイズする。

•   TokenBigramIgnoreBlank: バイグラムでトークナイズする。連続する記号・アルファベット・数字は一語として扱う。空白は無視する。

•   TokenBigramIgnoreBlankSplitSymbol: 記号もバイグラムでトークナイズする。連続するアルファベット・数字は一語として扱う。空白は無視する。

•   TokenBigramIgnoreBlankSplitSymbolAlpha: 記号とアルファベットもバイグラムでトークナイズする。連続する数字は一語として扱う。空白は無視する。

•   TokenBigramIgnoreBlankSplitSymbolAlphaDigit: 記号・アルファベット・数字もバイグラムでトークナイズする。空白は無視する。

  対策方法2: 閾値をあげる

非わかち書き検索・部分一致検索を利用するかどうかの閾値は--with-match-escalation-threshold configureオプションで変更することができます。以下のように指定すると、100件以下のヒット数であれば、たとえ完全一致検索でヒットしても、非わかち書き検索・部分一致検索を行います。:

% ./configure --with-match-escalation-threashold=100

この場合も対策方法1同様、検索ノイズが上位に現れる可能性が高くなることに注意してください。検索ノイズが多くなった場合は指定する値を低くする必要があります。

GROONGA開発者向け情報

  groonga 通信アーキテクチャ

  gqtpでのアーキテクチャ

•   comが外部からの接続を受け付ける。

•   comは1スレッド。

•   comがedgeを作る。

•   edgeは接続と１対１対応。

•   edgeはctxを含む。

•   workerはthreadと１対１対応。

•   workerは上限が個定数。

•   workerは、１つのedgeと結びつくことができる。

•   edgeごとにqueueを持つ。

•   msgはcomによって、edgeのqueueにenqueueされる。 edgeがworkerに結びついていないときは、同時に、ctx_newというqueueに、msgをenqueueした対象のedgeをenqueueする。

  ドキュメント作成

  Sphinxのインストール

groongaのドキュメントは、Sphinxというツールを用いて作成されています。Sphinxは以下のように導入します。:

# aptitude install python-setuptools
# easy_install -U sphinx

  htmlの作成

以下のコマンドでhtmlが作成されます。:

% make html

  pdfの作成

groongaのドキュメントは、pdf出力することもできます。rst2pdfと、IPAフォント(IPA Gothic/IPAexGothic)が必要となります。

  rst2pdfのインストール

以下のようにしてインストールできます。:

# eazy_install rst2pdf

  pdfの作成

以下のコマンドでpdfが作成されます。:

% make pdf

  クエリの実現

groongaのデータベースには大量のデータを格納し、その中から必要な部分を高速に取り出すことができます。必要な部分をgroongaのデータベースに問い合わせるためのクエリの表現と実行に関して、groongaは複数の手段を用意しています。

  クエリ実行のためのインタフェース

groongaは低機能で単純なライブラリインタフェースから、高機能で複雑なコマンドインタフェースまでいくつかの階層的なインタフェースをユーザプログラムに提供しています。

クエリ実行のためのインタフェースも階層的なインタフェースのそれぞれに対応する形で用意されています。以下に低レイヤなインタフェースから順に説明します。

  DB_API

DB_APIは、groongaデータベースを操作するための一群のC言語向けAPI関数を提供します。DB_APIはデータベースを構成する個々の部分に対する単純な操作関数を提供します。DB_APIの機能を組み合わせることによって複雑なクエリを実行することができます。後述のすべてのクエリインタフェースはDB_APIの機能を組み合わせることによって実現されています。

  grn_expr

grn_exprは、groongaデータベースに対する検索処理や更新処理のための条件を表現するためのデータ構造で、複数の条件を再帰的に組み合わせてより複雑な条件を表現することができます。grn_exprによって表現されたクエリを実行するためには、grn_table_select()関数を使用します。

  groonga実行ファイル

groongaデータベースを操作するためのコマンドインタープリタです。渡されたコマンドを解釈し、実行結果を返します。コマンドの実処理はC言語で記述されます。ユーザがC言語で定義した関数を新たなコマンドとしてgroonga実行ファイルに組み込むことができます。各コマンドはいくつかの文字列引数を受け取り、これをクエリとして解釈して実行します。引数をgrn_exprとして解釈するか、別の形式として解釈してDB_APIを使ってデータベースを操作するかはコマンド毎に自由に決めることができます。

  grn_exprで表現できるクエリ

grn_exprは代入や関数呼び出しのような様々な操作を表現できますが、この中で検索クエリを表現するgrn_exprのことを特に条件式とよびます。条件式を構成する個々の要素を関係式と呼びます。条件式は一個以上の関係式か、あるいは条件式を論理演算子で結合したものです。

論理演算子は、以下の3種類があります。

&& (論理積)
|| (論理和)
!  (否定)

関係式は、下記の11種類が用意されています。また、ユーザが定義した関数を新たな関係式として使うこともできます。

equal(==)
not_equal(!=)
less(<)
greater(>)
less_equal(<=)
greater_equal(>=)
contain()
near()
similar()
prefix()
suffix()

  grn_table_select()

grn_table_select()関数は、grn_exprで表現された検索クエリを実行するときに使います。引数として、検索対象となるテーブル、クエリを表すgrn_expr、検索結果を格納するテーブル、それに検索にマッチしたレコードを検索結果にどのように反映するかを指定する演算子を渡します。演算子と指定できるのは下記の4種類です。

GRN_OP_OR
GRN_OP_AND
GRN_OP_BUT
GRN_OP_ADJUST

GRN_OP_ORは、検索対象テーブルの中からクエリにマッチするレコードを検索結果テーブルに加えます。GRN_OP_OR以外の演算子は、検索結果テーブルが空でない場合にだけ意味を持ちます。GRN_OP_ANDは、検索結果テーブルの中からクエリにマッチしないレコードを取り除きます。GRN_OP_BUTは、検索結果テーブルの中からクエリにマッチするレコードを取り除きます。GRN_OP_ADJUSTは、検索結果テーブルの中でクエリにマッチするレコードに対してスコア値の更新のみを行います。

grn_table_select()は、データベース上に定義されたテーブルや索引などを組み合わせて可能な限り高速に指定されたクエリを実行しようとします。

  関係式

関係式は、検索しようとしているデータが満たすべき条件を、指定した値の間の関係として表現します。いずれの関係式も、その関係が成り立ったときに評価されるcallback、コールバック関数に渡されるargとを引数として指定することができます。callbackが与えられず、argのみが数値で与えられた場合はスコア値の係数とみなされます。主な関係式について説明します。

  equal(v1, v2, arg, callback)

v1の値とv2の値が等しいことを表します。

  not_equal(v1, v2, arg, callback)

v1の値とv2の値が等しくないことを表します。

  less(v1, v2, arg, callback)

v1の値がv2の値よりも小さいことを表します。

  greater(v1, v2, arg, callback)

v1の値がv2の値よりも大きいことを表します。

  less_equal(v1, v2, arg, callback)

v1の値がv2の値と等しいか小さいことを表します。

  greater_equal(v1, v2, arg, callback)

v1の値がv2の値と等しいか大きいことを表します。

  contain(v1, v2, mode, arg, callback)

v1の値がv2の値を含んでいることを表します。また、v1の値が要素に分解されるとき、それぞれの要素に対して二つ目の要素が一致するためのmodeとして下記のいずれかを指定することができます。

EXACT: v2の値もv1の値と同様に要素に分解したとき、それぞれの要素が完全に一致する(デフォルト)
UNSPLIT: v2の値は要素に分解しない
PREFIX: v1の値の要素がv2の値に前方一致する
SUFFIX: v1の値の要素がv2の値に後方一致する
PARTIAL: v1の値の要素がv2の値に中間一致する

  near(v1, v2, arg, callback)

v1の値の中に、v2の値の要素が接近して含まれていることを表します。(v2には値の配列を渡します)

  similar(v1, v2, arg, callback)

v1の値とv2の値が類似していることを表します。

  prefix(v1, v2, arg, callback)

v1の値がv2の値に対して前方一致することを表します。

  suffix(v1, v2, arg, callback)

v1の値がv2の値に対して後方一致することを表します。

  クエリの実例

grn_exprを使って様々な検索クエリを表現することができます。

  検索例1

GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
grn_expr_append_obj(ctx, query, column, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
grn_expr_append_op(ctx, query, GRN_OP_CALL, 3);
result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);

tableのcolumnの値がstringを含むレコードをresultに返します。columnの値が'needle in haystack'であるレコードr1と、columnの値が'haystack'であるレコードr2がtableに登録されていたとき、stringに'needle'を指定したなら、レコードr1のみがヒットします。

  検索例2

GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, exact, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, score1, GRN_OP_PUSH, 1);
grn_expr_append_op(ctx, query, GRN_OP_CALL, 5);
result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);
grn_obj_close(ctx, query);
GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
grn_expr_append_obj(ctx, query, column2, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, exact, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, score2, GRN_OP_PUSH, 1);
grn_expr_append_op(ctx, query, GRN_OP_CALL, 5);
grn_table_select(ctx, table, query, result, GRN_OP_ADJUST);
grn_obj_close(ctx, query);

tableのcolumn1の値がstringにexactモードでヒットするレコードについて得られるスコア値にscore1を積算してresultにセットします。次に、resultにセットされたレコードのうち、column2の値がstringにexactモードでヒットするレコードについては、得られたスコア値にscore2を積算したものを、元のスコア値に加えます。

  検索例3

GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, exact, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, score1, GRN_OP_PUSH, 1);
grn_expr_append_op(ctx, query, GRN_OP_CALL, 5);
result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);
grn_obj_close(ctx, query);
if (grn_table_size(ctx, result) < t1) {
  GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
  grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
  grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1);
  grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
  grn_expr_append_const(ctx, query, partial, GRN_OP_PUSH, 1);
  grn_expr_append_const(ctx, query, score2, GRN_OP_PUSH, 1);
  grn_expr_append_op(ctx, query, GRN_OP_CALL, 3);
  grn_table_select(ctx, table, query, result, GRN_OP_OR);
  grn_obj_close(ctx, query);
}

tableのcolumn1の値がstringにexactモードでヒットするレコードについて得られるスコア値にscore1を積算してresultにセットします。得られた検索結果数がt1よりも小さい場合は、partialモードで再度検索し、ヒットしたレコードについて得られるスコア値にscore2を積算してresultに追加します。

  検索例4

GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
grn_expr_append_obj(ctx, query, column, GRN_OP_PUSH, 1);
grn_expr_append_op(ctx, query, GRN_OP_CALL, 3);
result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);

tableのcolumnの値がstringに含まれるレコードをresultに返します。 columnの値が'needle'であるレコードr1と、columnの値が'haystack'であるレコードr2がtableに登録されていたとき、stringに'hay in haystack'を指定したなら、レコードr2のみがヒットします。

  テスト方法

  テスト環境の構築

  Cutterのインストール

groongaは、テストのフレームワークとして Cutter を用いています。

Cutterのインストール方法は プラットフォーム毎のCutterのインストール方法 をご覧下さい。

  lcovのインストール

カバレッジ情報を計測するためには、lcov 1.6以上が必要です。DebianやUbuntuでは以下のようにしてインストールできます。:

% sudo aptitude install -y lcov

  clangのインストール

ソースコードの静的解析を行うためには、clang(scan-build)をインストールする必要があります。DebianやUbuntuでは以下のようにしてインストールできます。:

% sudo aptitude install -y clang

  libmemcachedのインストール

memcachedのバイナリプロトコルのテストを動作させるためには、libmemcachedの導入が必要です。squeeze以降のDebianやKarmic以降のUubntuでは以下の用にしてインストールできます。:

% sudo aptitude install -y libmemcached-dev

  テストの動作

groongaのトップディレクトリで、以下のコマンドを実行します。:

make check

  カバレッジ情報

groongaのトップディレクトリで、以下のコマンドを実行します。:

make coverage

すると、coverageディレクトリ以下に、カバレッジ情報が入ったhtmlが出力されます。

カバレッジには、Lines/Functions/Branchesの3つの対象があります。それぞれ、行／関数／分岐に対応します。Functionsがもっとも重要な対象です。すべての関数がテストされるようになっていることを心がけてください。

テストがカバーしていない部分の編集は慎重に行ってください。また、テストがカバーしている部分を増やすことも重要です。

  様々なテスト

テストは、test/unitディレクトリにおいて、./run-test.shを実行することによっても行えます。run-test.shはいくつかのオプションをとります。詳細は、./run-test.sh --helpを実行しヘルプをご覧ください。

  特定のテスト関数のみテストする

特定のテスト関数(Cutterではテストと呼ぶ)のみをテストすることができます。

実行例:

% ./run-test.sh -n test_text_otoj

  特定のテストファイルのみテストする

特定のテストファイル(Cutterではテストケースと呼ぶ)のみテストすることができます。

実行例:

% ./run-test.sh -t test_string

  不正メモリアクセス・メモリリーク検出

環境変数CUTTER_CHECK_LEAKをyesと設定すると、valgrindを用いて不正メモリアクセスやメモリリークを検出しつつ、テストを動作させることができます。

run-test.shのみならず、make checkでも利用可能です。

実行例:

% CUTTER_CHECK_LEAK=yes make check

  デバッガ上でのテスト実行

環境変数CUTTER_DEBUGをyesと設定すると、テストが実行できる環境が整ったgdbが実行されます。gdb上でrunを行うと、テストの実行が開始されます。

run-test.shのみならず、make checkでも利用可能です。

実行例:

% CUTTER_DEBUG=yes make check

  静的解析

scan-buildを用いて、ソースコードの静的解析を行うことができます。scan_buildというディレクトリに解析結果のhtmlが出力されます。:

% scan-build ./configure --prefix=/usr
% make clean
% scan-build -o ./scan_build make -j4

configureは１度のみ実行する必要があります。

•   genindex

•   modindex

•   search

AUTHOR
groonga project

COPYRIGHT
2009-2011, Brazil, Inc