GROONGA(1)

NAME
groonga - Groonga documentation

•   news

GROONGAの特徴

  Groonga の概要

Groonga は転置索引を用いた高速・高精度な全文検索エンジンであり、登録された文書をすぐに検索結果に反映できます。また、参照をブロックせずに更新できることから、即時更新の必要なアプリケーションにおいても高い性能を発揮します。

全文検索エンジンとして開発された Groonga ですが、独自のカラムストアを持つ列指向のデータベースとしての側面も持っています。そのため、MySQL や PostgreSQL など、既存の代表的なデータベースが苦手とする集計クエリを高速に処理できるという特徴があり、組み合わせによって弱点を補うような使い方もできます。

Groonga の基本機能は C ライブラリとして提供されていますが、MySQL や PostgreSQL と連携させたり、Ruby から呼び出したりすることもできます。そのため、任意のアプリケーションに組み込むことが可能であり、多様な使い方が考えられます。 興味のある方は 利用例 をご覧ください。

  全文検索と即時更新

一般的なデータベースにおいては、追加・削除などの操作がすぐに反映されます。一方、全文検索においては、転置索引が逐次更新の難しいデータ構造であることから、文書の追加・削除に対応しないエンジンが少なくありません。

これに対し、転置索引を用いた全文検索エンジンでありながら、Groonga は文書を短時間で追加・削除することができます。その上、更新しながらでも検索できるという優れた特徴を持っているため、全文検索エンジンとしてはとても柔軟性があります。また、複数の転置索引を統合するような重い処理を必要としないので、安定して高い性能を発揮することが期待できます。

  カラムストアと集計クエリ

現代は、インターネットを情報源とすれば、いくらでも情報を収集できる時代です。しかし、膨大な情報から有益な情報を引き出すのは困難であり、多面的な分析による試行錯誤が必要となります。たとえば、日付や時間帯により絞り込んでみたり、地域により絞り込んでみたり、性別や年齢により絞り込んでみたりすることでしょう。そして、そのようなときに便利な存在が集計クエリです。

集計クエリとは、指定したカラムの値によってレコードをグループ化し、各グループに含まれるレコードの数を求めるクエリです。たとえば、地域の ID を格納しているカラムを指定すれば、地域毎のレコード数が求まります。日付のカラムを指定したときの出力をグラフ化すれば、レコード数の時間変化を視覚化することができます。さらに、地域による絞り込みと日付に対する集計クエリを組み合わせれば、特定の地域におけるレコード数の時間変化を視覚化ことも可能です。このように、尺度を自由に選択して絞り込み・集計できることは、膨大な情報を扱う上でとても重要になります。

Groonga が集計クエリを高速に処理できる理由は、データベースの論理構造にカラムストアを採用しているからです。集計クエリが参照するのは指定されたカラムのみであるため、カラム単位でデータを格納する列指向のデータベースでは、必要なカラムのみを無駄なく読み出せることが利点となります。一方、レコード単位でデータを格納する行指向のデータベースでは、隣接するカラムをまとめて読み出してしまうことが欠点となります。

  転置索引とトークナイザ

転置索引は大規模な全文検索に用いられる伝統的なデータ構造です。転置索引を用いた全文検索エンジンでは、文書を追加するときに索引語を記録しておき、検索するときはクエリを索引語に分割して出現文書を求めます。そのため、文書やクエリから索引語を抜き出す方法が重要になります。

トークナイザは、文字列から索引語を抜き出すモジュールです。日本語を対象とする全文検索においては、形態素を索引語として抜き出す方式と文字 N-gram を抜き出す方式のいずれか、あるいは両方を用いるのが一般的です。形態素方式は検索時間や索引サイズの面で優れているほか、検索結果に不要な文書が含まれにくいという利点を持っています。一方、N-gram 方式には検索漏れが発生しにくいという利点があり、状況によって適した方式を選択することが望ましいとされています。

Groonga は形態素方式と N-gram 方式の両方に対応しています。初期状態で利用できるトークナイザは空白を区切り文字として用いる方式と N-gram 方式のみですが、形態素解析器 MeCab を組み込んだときは MeCab による分かち書きの結果を用いる形態素方式が有効になります。トークナイザはプラグインとして追加できるため、特徴的なキーワードのみを索引語として採用するなど、独自のトークナイザを開発することが可能です。

  共有可能なストレージと参照ロックフリー

CPU のマルチコア化が進んでいるため、同時に複数のクエリを実行したり、一つのクエリを複数のスレッドで実行したりすることの重要性はますます高まっています。

Groonga のストレージは、複数のスレッド・プロセスで共有することができます。また、参照ロックフリーなデータ構造を採用しているため、更新クエリを実行している状況でも参照クエリを実行することができます。参照クエリを実行できる状態を維持しながら更新クエリを実行できるので、リアルタイムなシステムに適しています。さらには、MySQL を介して更新クエリを実行している最中に Groonga の HTTP サーバを介して参照クエリを実行するなど、多彩な運用が可能となっています。

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

GPS に代表される測位システムを搭載した高機能な携帯端末の普及などによって、位置情報を扱うサービスはますます便利になっています。たとえば、近くにあるレストランを探しているときは、現在地からの距離を基準として検索をおこない、検索結果を地図上に表示してくれるようなサービスが便利です。そのため、位置情報検索を高速に実現できることが重要になっています。

Groonga では転置索引を応用して高速な位置情報検索を実現しています。矩形・円による範囲検索に対応しているほか、基準点の近くを優先的に探索させることができます。また、距離計算をサポートしているので、位置情報検索の結果を基準点からの距離によって整列することも可能です。

  Groonga ライブラリ

Groonga の基本機能は C ライブラリとして提供されているので、任意のアプリケーションに組み込んで利用することができます。C/C++ 以外については、Ruby から Groonga を利用するライブラリなどが関連プロジェクトにおいて提供されています。詳しくは 関連プロジェクト を参照してください。

  Groonga サーバ

Groonga にはサーバ機能があるため、レンタルサーバなどの新しいライブラリをインストールできない環境においても利用できます。対応しているのは HTTP、memcached binary プロトコル、およびGroongaの独自プロトコルであるGroonga Query Transfer Protocol（ /spec/gqtp ）です。サーバとして利用するときはクエリのキャッシュ機能が有効になるため、同じクエリを受け取ったときは応答時間が短くなるという特徴があります。

  Mroonga ストレージエンジン

Groonga は独自のカラムストアを持つ列指向のデータベースとしての側面を持っていますが、既存の RDBMS のストレージエンジンとして利用することもできます。たとえば、Groonga をベースとする MySQL のストレージエンジンとして Mroonga が開発されています。Mroonga は MySQL のプラグインとして動的にロードすることが可能であり、Groonga のカラムストアをストレージとして利用したり、全文検索エンジンとして Groonga を MyISAM や InnoDB と連携させたりすることができます。Groonga 単体での利用、および MyISAM, InnoDB との連携には一長一短があるので、用途に応じて適切な組み合わせを選ぶことが大切です。詳しくは 関連プロジェクト を参照してください。

インストール

このセクションではGroongaのインストール方法を環境毎に説明します。主要なプラットフォームにはパッケージがあります。自分でGroongaをビルドするよりもパッケージを使うことを推奨します。しかし、心配しないでください。ソースからGroongaをビルドするためのドキュメントもあります。

32-bit用と64-bit用のパッケージを配布していますが、サーバ用途には64-bitパッケージを利用することをオススメします。32-bit用パッケージはテスト用か開発用にだけ使って下さい。32-bit用パッケージを使った場合は、中程度のサイズのデータでもメモリ不足エラーになることがあります。

  Windows

このセクションではWindows上でGroongaをインストールする方法を説明します。Groongaをインストールするにはzipパッケージを展開する方法とインストーラーを実行する方法があります。

32-bit用と64-bit用のパッケージを配布していますが、サーバ用途には64-bitパッケージを利用することをオススメします。32-bit用パッケージはテスト用か開発用にだけ使って下さい。32-bit用パッケージを使った場合は、中程度のサイズのデータでもメモリ不足エラーになることがあります。

  インストーラー

32-bit環境の場合は、x86のバイナリをpackages.groonga.orgからダウンロードしてください。

•   http://packages.groonga.org/windows/groonga/groonga-6.0.1-x86.exe

    その後、バイナリを実行します。

    64-bit環境の場合は、x64のバイナリをpackages.groonga.orgからダウンロードしてください。

•   http://packages.groonga.org/windows/groonga/groonga-6.0.1-x64.exe

    その後、バイナリを実行します。

    スタートメニュー内にあるコマンドプロンプトを使って /reference/executables/groonga を起動してください。

  zip

32-bit環境の場合は、x86のzipアーカイブをpackages.groonga.orgからダウンロードしてください。

•   http://packages.groonga.org/windows/groonga/groonga-6.0.1-x86.zip

    その後、アーカイブを展開します。

    64-bit環境の場合は、x64のzipアーカイブをpackages.groonga.orgからダウンロードしてください。

•   http://packages.groonga.org/windows/groonga/groonga-6.0.1-x64.zip

    その後、アーカイブを展開します。

    bin フォルダーに /reference/executables/groonga があるのでそれを起動してください。

  ソースからビルド

まずWindows上でGroongaをビルドするために必須のツールをインストールします。以下が必須のツールです。

•   Microsoft Visual Studio Express 2013 for Windows Desktop

•   CMake

    zipアーカイブをpackages.groonga.orgからダウンロードしてください。

•   http://packages.groonga.org/source/groonga/groonga-6.0.1.zip

    その後、アーカイブを展開します。

    Groongaのソースフォルダへと移動します:

    > cd c:\Users\%USERNAME%\Downloads\groonga-6.0.1

    cmake でビルドオプションを設定します。以下のコマンドラインは64-bit用のGroongaをビルドするためのものです。32-bit用のGroongaをビルドする場合は代わりに -G "Visual Studio 12 2013" パラメーターを指定してください:

    groonga-6.0.1> cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga

    ビルド:

    groonga-6.0.1> cmake --build . --config Release

    インストール:

    groonga-6.0.1> cmake --build . --config Release --target Install

    以上の手順で /reference/executables/groonga が c:\Groonga\bin\groonga.exe にインストールされます。

  Mac OS X

このセクションではMac OS X上でGroongaをインストールする方法を説明します。 MacPorts か Homebrew を使ってインストールできます。

  MacPorts

インストール:

% sudo port install groonga

  Homebrew

インストール:

% brew install groonga

MeCab をトークナイザーとして使いたいときは、 --with-mecab オプションを指定してください。

% brew install groonga --with-mecab

それからMeCabの辞書をインストール・設定します。

インストール:

% brew install mecab-ipadic

設定:

% sed -i '' -e 's,dicrc.*=.*,dicrc = /usr/local/lib/mecab/dic/ipadic,g' /usr/local/etc/mecabrc

  ソースからビルド

Xcode をインストールしてください。

ソースをダウンロードします:

% curl -O http://packages.groonga.org/source/groonga/groonga-6.0.1.tar.gz
% tar xvzf groonga-6.0.1.tar.gz
% cd groonga-6.0.1

configureを実行します（ configure のオプションについては source-configure を参照してください）:

% ./configure

ビルド:

% make -j$(/usr/sbin/sysctl -n hw.ncpu)

インストール:

% sudo make install

  Debian GNU/Linux

このセクションではDebian GNU/Linux上でGroonga関連のdebパッケージをインストールする方法を説明します。これらのパッケージは apt でインストールできます。

32-bit用と64-bit用のパッケージを配布していますが、サーバ用途には64-bitパッケージを利用することをオススメします。32-bit用パッケージはテスト用か開発用にだけ使って下さい。32-bit用パッケージを使った場合は、中程度のサイズのデータでもメモリ不足エラーになることがあります。

  wheezy

Groongaのaptリポジトリを追加します。

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

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

インストール:

% sudo apt-get update
% sudo apt-get install -y --allow-unauthenticated groonga-keyring
% sudo apt-get update
% sudo apt-get install -y -V groonga

注釈: groonga パッケージは全文検索のための最小構成パッケージです。Groongaをサーバー用途で使うなら、設定済みの追加パッケージをインストールすることができます。

サーバー用途のための2つのパッケージがあります。

•   groonga-httpd (nginxを元にしたHTTPサーバー)

•   groonga-server-gqtp (GQTPサーバー)

    詳細は /server を参照してください。

    MeCab をトークナイザーとして使いたいときは、groonga-tokenizer-mecabパッケージをインストールしてください。

    groonga-tokenizer-mecabパッケージのインストール:

    % sudo apt-get install -y -V groonga-tokenizer-mecab

    TokenFilterStem をトークンフィルターとして使いたいときはgroonga-tokenizer-filter-stemパッケージをインストールしてください。

    groonga-token-filter-stemパッケージのインストール:

    % sudo apt-get install -y -V groonga-token-filter-stem

    Munin プラグインを提供するパッケージもあります。MuninでGroongaの状態をモニターしたい場合は、groonga-munin-pluginsパッケージをインストールしてください。

    groonga-munin-pluginsパッケージのインストール:

    % sudo apt-get install -y -V groonga-munin-plugins

    MySQL互換のノーマライザーをGroongaのプラグインとして提供するパッケージがあります。MySQL互換のノーマライザーを使うには groonga-normalizer-mysql パッケージをインストールしてください。

    groonga-normalizer-mysqlパッケージのインストール:

    % sudo apt-get install -y -V groonga-normalizer-mysql

  jessie

バージョン 5.0.3 で追加.

Groongaのaptリポジトリを追加します。

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

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

インストール:

% sudo apt-get update
% sudo apt-get install -y --allow-unauthenticated groonga-keyring
% sudo apt-get update
% sudo apt-get install -y -V groonga

注釈: groonga パッケージは全文検索のための最小構成パッケージです。Groongaをサーバー用途で使うなら、設定済みの追加パッケージをインストールすることができます。

サーバー用途のための2つのパッケージがあります。

•   groonga-httpd (nginxを元にしたHTTPサーバー)

•   groonga-server-gqtp (GQTPサーバー)

    詳細は /server を参照してください。

    MeCab をトークナイザーとして使いたいときは、groonga-tokenizer-mecabパッケージをインストールしてください。

    groonga-tokenizer-mecabパッケージのインストール:

    % sudo apt-get install -y -V groonga-tokenizer-mecab

    TokenFilterStem をトークンフィルターとして使いたいときはgroonga-tokenizer-filter-stemパッケージをインストールしてください。

    groonga-token-filter-stemパッケージのインストール:

    % sudo apt-get install -y -V groonga-token-filter-stem

    Munin プラグインを提供するパッケージもあります。MuninでGroongaの状態をモニターしたい場合は、groonga-munin-pluginsパッケージをインストールしてください。

    groonga-munin-pluginsパッケージのインストール:

    % sudo apt-get install -y -V groonga-munin-plugins

    MySQL互換のノーマライザーをGroongaのプラグインとして提供するパッケージがあります。MySQL互換のノーマライザーを使うには groonga-normalizer-mysql パッケージをインストールしてください。

    groonga-normalizer-mysqlパッケージのインストール:

    % sudo apt-get install -y -V groonga-normalizer-mysql

  ソースからビルド

Groongaをビルドするために必要なパッケージをインストールします:

% sudo apt-get install -y -V  wget tar build-essential zlib1g-dev liblzo2-dev libmsgpack-dev libzmq-dev libevent-dev libmecab-dev

ソースをダウンロードします:

% wget http://packages.groonga.org/source/groonga/groonga-6.0.1.tar.gz
% tar xvzf groonga-6.0.1.tar.gz
% cd groonga-6.0.1

configureを実行します（ configure のオプションについては source-configure を参照してください）:

% ./configure

ビルド:

% make -j$(grep '^processor' /proc/cpuinfo | wc -l)

インストール:

% sudo make install

  Ubuntu

このセクションではUbuntu上でGroonga関連のdebパッケージをインストールする方法を説明します。これらのパッケージは apt でインストールできます。

32-bit用と64-bit用のパッケージを配布していますが、サーバ用途には64-bitパッケージを利用することをオススメします。32-bit用パッケージはテスト用か開発用にだけ使って下さい。32-bit用パッケージを使った場合は、中程度のサイズのデータでもメモリ不足エラーになることがあります。

  PPA（Personal Package Archive）

Ubuntu用のGroongaのAPTリポジトリーはLaunchpad上のPPA（Personal Package Archive）を使っています。このPPAからAPTでGroongaをインストールできます。

サポートしているUbuntuのバージョンは次の通りです。

•   12.04 LTS Precise Pangolin

•   14.04 LTS Trusty Tahr

•   15.04 Vivid Vervet

•   15.10 Wily Werewolf

    Groongaをインストールするためにuniverseリポジトリを有効にしてください:

    % sudo apt-get -y install software-properties-common
    % sudo add-apt-repository -y universe

    ppa:groonga/ppa PPAをシステムに登録します:

    % sudo add-apt-repository -y ppa:groonga/ppa
    % sudo apt-get update

    インストール:

    % sudo apt-get -y install groonga

    注釈: groonga パッケージは全文検索のための最小構成パッケージです。Groongaをサーバー用途で使うなら、設定済みの追加パッケージをインストールすることができます。

    サーバー用途のための2つのパッケージがあります。

•   groonga-httpd (nginxを元にしたHTTPサーバー)

•   groonga-server-gqtp (GQTPサーバー)

    詳細は /server を参照してください。

    MeCab をトークナイザーとして使いたいときは、groonga-tokenizer-mecabパッケージをインストールしてください。

    groonga-tokenizer-mecabパッケージのインストール:

    % sudo apt-get -y install groonga-tokenizer-mecab

    TokenFilterStem をトークンフィルターとして使いたいときはgroonga-tokenizer-filter-stemパッケージをインストールしてください。

    groonga-token-filter-stemパッケージのインストール:

    % sudo apt-get -y install groonga-token-filter-stem

    Munin プラグインを提供するパッケージもあります。MuninでGroongaの状態をモニターしたい場合は、groonga-munin-pluginsパッケージをインストールしてください。

    groonga-munin-pluginsパッケージのインストール:

    % sudo apt-get -y install groonga-munin-plugins

    MySQL互換のノーマライザーをGroongaのプラグインとして提供するパッケージがあります。MySQL互換のノーマライザーを使うには groonga-normalizer-mysql パッケージをインストールしてください。

    groonga-normalizer-mysqlパッケージのインストール:

    % sudo apt-get -y install groonga-normalizer-mysql

  ソースからビルド

Groongaをビルドするために必要なパッケージをインストールします:

% sudo apt-get -V -y install wget tar build-essential zlib1g-dev liblzo2-dev libmsgpack-dev libzmq-dev libevent-dev libmecab-dev

ソースをダウンロードします:

% wget http://packages.groonga.org/source/groonga/groonga-6.0.1.tar.gz
% tar xvzf groonga-6.0.1.tar.gz
% cd groonga-6.0.1

configureを実行します（ configure のオプションについては source-configure を参照してください）:

% ./configure

ビルド:

% make -j$(grep '^processor' /proc/cpuinfo | wc -l)

インストール:

% sudo make install

  CentOS

このセクションではCentOS上でGroonga関連のRPMパッケージをインストールする方法を説明します。これらのパッケージは yum でインストールできます。

32-bit用と64-bit用のパッケージを配布していますが、サーバ用途には64-bitパッケージを利用することをオススメします。32-bit用パッケージはテスト用か開発用にだけ使って下さい。32-bit用パッケージを使った場合は、中程度のサイズのデータでもメモリ不足エラーになることがあります。

  CentOS 5

インストール:

% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm
% sudo yum makecache
% sudo yum install -y groonga

注釈: groonga パッケージは全文検索のための最小構成パッケージです。Groongaをサーバー用途で使うなら、設定済みの追加パッケージをインストールすることができます。

サーバー用途のための2つのパッケージがあります。

•   groonga-httpd (nginxを元にしたHTTPサーバー)

•   groonga-server-gqtp (GQTPサーバー)

    詳細は /server を参照してください。

    MeCab をトークナイザーとして使いたいときは、groonga-tokenizer-mecabパッケージをインストールしてください。

    groonga-tokenizer-mecabパッケージのインストール:

    % sudo yum install -y groonga-tokenizer-mecab

    Munin プラグインを提供するパッケージもあります。MuninでGroongaの状態をモニターしたい場合は、groonga-munin-pluginsパッケージをインストールしてください。

    注釈: groonga-munin-pluginsパッケージはmunin-nodeパッケージを必要としますが、munin-nodeパッケージはCentOSの公式リポジトリには含まれていません。munin-nodeパッケージを yum でインストールするために Repoforge (RPMforge) リポジトリか EPEL リポジトリを有効にする必要があります。

    i386環境でRepoforge (RPMforge)リポジトリを有効にする:

    % wget http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.3-1.el5.rf.i386.rpm
    % sudo rpm -ivh rpmforge-release-0.5.2-2.el5.rf.i386.rpm

    x86_64環境でRepoforge (RPMforge)リポジトリを有効にする:

    % wget http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.3-1.el5.rf.x86_64.rpm
    % sudo rpm -ivh rpmforge-release-0.5.2-2.el5.rf.x86_64.rpm

    EPELリポジトリを有効にする（環境非依存）:

    % wget http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm
    % sudo rpm -ivh epel-release-5-4.noarch.rpm

    groonga-munin-pluginsパッケージのインストール:

    % sudo yum install -y groonga-munin-plugins

    MySQL互換のノーマライザーをGroongaのプラグインとして提供するパッケージがあります。MySQL互換のノーマライザーを使うには groonga-normalizer-mysql パッケージをインストールしてください。

    groonga-normalizer-mysqlパッケージのインストール:

    % sudo yum install -y groonga-normalizer-mysql

  CentOS 6

インストール:

% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm
% sudo yum makecache
% sudo yum install -y groonga

注釈: groonga パッケージは全文検索のための最小構成パッケージです。Groongaをサーバー用途で使うなら、設定済みの追加パッケージをインストールすることができます。

サーバー用途のための2つのパッケージがあります。

•   groonga-httpd (nginxを元にしたHTTPサーバー)

•   groonga-server-gqtp (GQTPサーバー)

    詳細は /server を参照してください。

    MeCab をトークナイザーとして使いたいときは、groonga-tokenizer-mecabパッケージをインストールしてください。

    groonga-tokenizer-mecabパッケージのインストール:

    % sudo yum install -y groonga-tokenizer-mecab

    Munin プラグインを提供するパッケージもあります。MuninでGroongaの状態をモニターしたい場合は、groonga-munin-pluginsパッケージをインストールしてください。

    注釈: groonga-munin-pluginsパッケージはmunin-nodeパッケージを必要としますが、munin-nodeパッケージはCentOSの公式リポジトリには含まれていません。munin-nodeパッケージを yum でインストールするために EPEL リポジトリを有効にする必要があります。

    EPELリポジトリを有効にする（環境非依存）:

    % sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm

    groonga-munin-pluginsパッケージのインストール:

    % sudo yum install -y groonga-munin-plugins

    MySQL互換のノーマライザーをGroongaのプラグインとして提供するパッケージがあります。MySQL互換のノーマライザーを使うには groonga-normalizer-mysql パッケージをインストールしてください。

    groonga-normalizer-mysqlパッケージのインストール:

    % sudo yum install -y groonga-normalizer-mysql

  CentOS 7

インストール:

% sudo yum install -y http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm
% sudo yum install -y groonga

注釈: groonga パッケージは全文検索のための最小構成パッケージです。Groongaをサーバー用途で使うなら、設定済みの追加パッケージをインストールすることができます。

サーバー用途のための2つのパッケージがあります。

•   groonga-httpd (nginxを元にしたHTTPサーバー)

•   groonga-server-gqtp (GQTPサーバー)

    詳細は /server を参照してください。

    MeCab をトークナイザーとして使いたいときは、groonga-tokenizer-mecabパッケージをインストールしてください。

    groonga-tokenizer-mecabパッケージのインストール:

    % sudo yum install -y groonga-tokenizer-mecab

    Munin プラグインを提供するパッケージもあります。MuninでGroongaの状態をモニターしたい場合は、groonga-munin-pluginsパッケージをインストールしてください。

    注釈: groonga-munin-pluginsパッケージはmunin-nodeパッケージを必要としますが、munin-nodeパッケージはCentOSの公式リポジトリには含まれていません。munin-nodeパッケージを yum でインストールするために EPEL リポジトリを有効にする必要があります。

    EPELリポジトリを有効にする:

    % sudo yum install -y epel-release

    groonga-munin-pluginsパッケージのインストール:

    % sudo yum install -y groonga-munin-plugins

    MySQL互換のノーマライザーをGroongaのプラグインとして提供するパッケージがあります。MySQL互換のノーマライザーを使うには groonga-normalizer-mysql パッケージをインストールしてください。

    groonga-normalizer-mysqlパッケージのインストール:

    % sudo yum install -y groonga-normalizer-mysql

  ソースからビルド

Groongaをビルドするために必要なパッケージをインストールします:

% sudo yum install -y wget tar gcc-c++ make mecab-devel

ソースをダウンロードします:

% wget http://packages.groonga.org/source/groonga/groonga-6.0.1.tar.gz
% tar xvzf groonga-6.0.1.tar.gz
% cd groonga-6.0.1

configureを実行します（ configure のオプションについては source-configure を参照してください）:

% ./configure

ビルド:

% make -j$(grep '^processor' /proc/cpuinfo | wc -l)

インストール:

% sudo make install

  Fedora

このセクションではFedora上でGroonga関連のRPMパッケージをインストールする方法を説明します。これらのパッケージは yum でインストールできます。

注釈: 3.0.2のリリースから、Groonga関連のRPMパッケージはFedoraの公式yumリポジトリでリリースしています。GroongaのyumリポジトリのかわりにFedoraの公式リポジトリを使います。ただ、いくつか例外があって、MeCabの辞書（ mecab-ipadic や mecab-jumandic ）パッケージを使うにはGroongaのyumリポジトリを使います。

32-bit用と64-bit用のパッケージを配布していますが、サーバ用途には64-bitパッケージを利用することをオススメします。32-bit用パッケージはテスト用か開発用にだけ使って下さい。32-bit用パッケージを使った場合は、中程度のサイズのデータでもメモリ不足エラーになることがあります。

  Fedora 21

インストール:

% sudo yum install -y groonga

mecab-ipadic 、 mecab-jumandic といったパッケージを使うには Groongaのyumリポジトリを提供する groonga-release パッケージをあらかじめインストールします。

% sudo rpm -ivh http://packages.groonga.org/fedora/groonga-release-1.1.0-1.noarch.rpm
% sudo yum update

注釈: groonga パッケージは全文検索のための最小構成パッケージです。Groongaをサーバー用途で使うなら、設定済みの追加パッケージをインストールすることができます。

サーバー用途のための2つのパッケージがあります。

•   groonga-httpd (nginxを元にしたHTTPサーバー)

•   groonga-server-gqtp (GQTPサーバー)

    詳細は /server を参照してください。

    MeCab をトークナイザーとして使いたいときは、groonga-tokenizer-mecabパッケージをインストールしてください。

    groonga-tokenizer-mecabパッケージのインストール:

    % sudo yum install -y groonga-tokenizer-mecab

    それからMeCabの辞書をインストールします。(mecab-ipadicもしくはmecab-jumandic)

    IPA辞書をインストールします:

    % sudo yum install -y mecab-ipadic

    あるいはJuman辞書をインストールします:

    % sudo yum install -y mecab-jumandic

    Munin プラグインを提供するパッケージもあります。MuninでGroongaの状態をモニターしたい場合は、groonga-munin-pluginsパッケージをインストールしてください。

    groonga-munin-pluginsパッケージのインストール:

    % sudo yum install -y groonga-munin-plugins

    MySQL互換のノーマライザーをGroongaのプラグインとして提供するパッケージがあります。MySQL互換のノーマライザーを使うには groonga-normalizer-mysql パッケージをインストールしてください。

    groonga-normalizer-mysqlパッケージのインストール:

    % sudo yum install -y install groonga-normalizer-mysql

  ソースからビルド

Groongaをビルドするために必要なパッケージをインストールします:

% sudo yum install -y wget tar gcc-c++ make mecab-devel libedit-devel

ソースをダウンロードします:

% wget http://packages.groonga.org/source/groonga/groonga-6.0.1.tar.gz
% tar xvzf groonga-6.0.1.tar.gz
% cd groonga-6.0.1

configureを実行します（ configure のオプションについては source-configure を参照してください）:

% ./configure

ビルド:

% make -j$(grep '^processor' /proc/cpuinfo | wc -l)

インストール:

% sudo make install

  Oracle Solaris

このセクションではOracle Solaris上でGroongaをソースコードからインストールする方法を説明します。

  Oracle Solaris 11

Groongaをビルドするために必要なパッケージをインストールします:

% sudo pkg install gnu-tar gcc-45 system/header

ソースをダウンロードします:

% wget http://packages.groonga.org/source/groonga/groonga-6.0.1.tar.gz
% gtar xvzf groonga-6.0.1.tar.gz
% cd groonga-6.0.1

CFLAGS="-m64" CXXFLAGS="-m64" 変数付きでconfigureを実行します。これらの変数は64-bit版をビルドするために必要です。32-bit版をビルドする場合はこれらの変数を指定しないでしてください。 （ configure のオプションについては source-configure を参照してください）:

% ./configure CFLAGS="-m64" CXXFLAGS="-m64"

ビルド:

% make

インストール:

% sudo make install

  その他

このセクションではUNIX系の環境でGroongaをソースコードからインストールする方法を説明します。

/install にある特定環境用のドキュメントに、その環境向けのより詳細な情報があります。特定環境用のドキュメントがある場合は、まずそちらを参照してください。

  依存関係

Groongaは特別なライブラリを必要としませんが、いくつかビルドに必要なツールがあります。

  ツール

以下が必要なツールです:

•   wget 、 curl または Web ブラウザ（ソースアーカイブをダウンロードするため）

•   tar と gzip （ソースアーカイブを展開するため）

•   シェル（ dash 、 bash 、 zsh など、どのようなシェルでもたぶん大丈夫）

•   CコンパイラーとC++コンパイラー （ gcc と g++ がサポート対象だが、他のコンパイラーでもたぶん大丈夫）

•   make （GNU makeがサポート対象だが、BSD makeなど他のmakeでもたぶん大丈夫）

    これらを用意してください。

    シェルの代わりに CMake を使うこともできますが、このドキュメントではCMakeを使ってビルドする方法については説明しません。

    以下はあるとよいツールです:

•   pkg-config （ライブラリを検出するため）

•   sudo （ビルドしたGroongaをインストールするため）

    追加のライブラリを使いたい場合はこれらのツールを用意しておかなければいけません。

  ライブラリ

どのライブラリも必須ではありません。以下はオプションとして使えるライブラリです:

•   MeCab （全文検索対象のドキュメントを形態素解析でトークナイズするため）

•   KyTea （全文検索対象のドキュメントを形態素解析でトークナイズするため）

•   ZeroMQ （ /reference/suggest 用）

•   libevent （ /reference/suggest 用）

•   MessagePack （MessagePack出力サポート用および /reference/suggest 用）

•   libedit （ /reference/executables/groonga のコマンドライン編集用）

•   zlib （カラム値の圧縮用）

•   LZ4 （カラム値の圧縮用）

    これらのライブラリを使いたい場合は、Groongaをインストールする前にライブラリをインストールしてください。

  ソースからビルド

GroongaはGNUビルドシステムを使っています。以下は一番簡単なビルド手順です:

% wget http://packages.groonga.org/source/groonga/groonga-6.0.1.tar.gz
% tar xvzf groonga-6.0.1.tar.gz
% cd groonga-6.0.1
% ./configure
% make
% sudo make install

上記の手順を実行すると /usr/local/bin/groonga に /reference/executables/groonga がインストールされます。

デフォルトのビルドでもうまく動くでしょうが、 configure のときにGroongaをカスタマイズすることができます。

以下、それぞれの手順の詳細を説明します。

  configure

まず configure を実行します。重要な configure のオプションは以下の通りです:

  --prefix=PATH

インストール先となるディレクトリを指定します。Groonga関連のファイルは ${PATH}/ ディレクトリ以下にインストールされます。

デフォルトは /usr/local 。デフォルトの場合は /reference/executables/groonga は /usr/local/bin/groonga にインストールされます。

以下はシステム全体にGroongaをインストールするのではなく、ユーザーが個人で使う目的で ~/local にインストールする例です:

% ./configure --prefix=$HOME/local

  --localstatedir=PATH

ログファイル、PIDファイル、データベースなど頻繁に変更されるファイルを置くディレクトリを指定します。たとえば、ログファイルは ${PATH}/log/groonga.log に置かれます。

デフォルトは /usr/local/var です。

以下は頻繁に変更されるファイルをシステム全体で使う領域である /var に置く例です:

% ./configure --localstatedir=/var

  --with-log-path=PATH

ログファイルのデフォルトのパスを指定します。ログファイルのデフォルトのパスは /reference/executables/groonga の --log-path コマンドラインオプションで変更できます。そのため、このオプションはそんなに重要なビルドオプションではありません。少し便利にするためのオプションです。

デフォルトは /usr/local/var/log/groonga.log です。 /usr/local/var の部分は --localstatedir オプションで変更できます。

以下はログファイルを共有しているNFSディレクトリ /nfs/log/groonga.log に置く例です:

% ./configure --with-log-path=/nfs/log/groonga.log

  --with-default-encoding=ENCODING

デフォルトのエンコーディングを指定します。有効なエンコーディングは euc_jp 、 sjis 、 utf8 、 latin1 、 koi8r 、 none です。

デフォルトは utf-8 です。

以下はデフォルトのエンコーディングとしてShift_JISを使う例です:

% ./configure --with-default-encoding=sjis

  --with-match-escalation-threshold=NUMBER

マッチ演算でエスカレーションをするかどうかのデフォルトの閾値を指定します。この閾値については select-match-escalation-threshold を参照してください。-1はマッチ演算でエスカレーションしないという意味です。

デフォルトは0です。

以下はデフォルトではマッチエスカレーションをしないという例です:

% ./configure --with-match-escalation-threshold=-1

  --with-zlib

zlibを使ってカラム値を圧縮する機能を有効にします。

デフォルトでは無効です。

以下はzlibを使ってカラム値を圧縮する機能を有効にする例です:

% ./configure --with-zlib

  --with-lz4

LZ4を使ってカラム値を圧縮する機能を有効にします。

デフォルトでは無効です。

以下はLZ4を使ってカラム値を圧縮する機能を有効にする例です:

% ./configure --with-lz4

  --with-message-pack=MESSAGE_PACK_INSTALL_PREFIX

MessagePackがどこにインストールされているかを指定します。MessagePackを --prefix=/usr という configure オプションでインストールしていない場合は、MessagePackをビルドするときに指定したパスをこのオプションで指定してください。

もし、MessagePackを --prefix=$HOME/local という configure オプションでインストールした場合は、Groongaの configure では --with-message-pack=$HOME/local と指定してください。

デフォルトは /usr です。

以下はMessagePackが --prefix=$HOME/local という configure オプションでインストールされている場合の例です:

% ./configure --with-message-pack=$HOME/local

  --with-munin-plugins

Groonga用のMuninプラグインをインストールします。プラグインは ${PREFIX}/share/groonga/munin/plugins/ 以下にインストールされます。

デフォルトではプラグインはインストールされません。

以下はGroonga用のMuninプラグインをインストールする例です:

% ./configure --with-munin-plugins

  --with-package-platform=PLATFORM

initスクリプトなどプラットフォーム依存のシステム管理ファイルをインストールします。利用可能なプラットフォームは redhat と fedora です。 redhat はRed HatおよびCentOSなどのRed Hatクローンのディストリビューション用です。 fedora はFedora用です。

デフォルトではシステム管理ファイルはインストールされません。

以下はCentOS用のシステム管理ファイルをインストールする例です:

% ./configure --with-package-platform=redhat

  --help

すべての configure オプションを表示します。

  make

configure が成功したら make でGroongaをビルドします:

% make

マルチコアCPUを使っている場合は -j オプションを使うとより速くmakeを実行できます。もし、4コアのCPUを使っている場合は、 -j4 オプションを使うともっと速くビルドできます:

% make -j4

make で何かエラーが発生した場合は、そのエラーをレポートしてください: /contribution/report

  make install

これでビルドしたGroongaをインストールできます！:

% sudo make install

${PREFIX} への書き込み権限がある場合は sudo を使う必要はありません。例えば、 --prefix=$HOME/local と指定した場合です。この場合は make install を使ってください:

% make install

コミュニティ

Groongaに関する情報を共有するための場所がいくつかあります。あなたの参加をお待ちしています！

  メーリングリスト

Groongaに関する話題を扱うメーリングリストがあります。

英語  groonga-talk@lists.sourceforge.net

日本語 groonga-dev@lists.osdn.me

  チャットルーム

Groongaに関する話題を扱うチャットルームがあります。

英語  Gitterにあるgroonga/enチャットルーム

日本語 Gitterにあるgroonga/jaチャットルーム

  Twitter

@groonga がGroonga関連情報をツイートしています。

このアカウントをフォローして最新のGroonga関連情報をゲットしてください！

  Facebook

FacebookのGroongaページ ではGroonga関連情報をシェアしています。

このページをいいね！して最新のGroonga関連情報をゲットしてください！

チュートリアル

  基本的な操作

Groongaには、Cのライブラリとして使用する方法と、groonga実行ファイルを通して使用する方法があります。本チュートリアルでは、groonga実行ファイルを使用する方法について説明します。groonga実行ファイルを使って、データベースの作成・操作・サーバの起動・サーバへの接続などの操作が行えます。

  データベースの作成

Groongaユーザへの第一歩はデータベースの作成です。まずは以下の書式をご覧ください。

書式:

groonga -n DB_PATH

-n オプションは、データベースの作成を指示します。DB_PATHは、新しく作成するデータベースのパスを指定します。データベースは複数のファイルによって構成されるため、正確には、データベースの入り口となるファイルのパスとして使用されます。また、データベースを構成する他のファイルについては、DB_PATHがパスのプレフィックスとして使用されます。指定されたパスにファイルが存在しているときは失敗するので注意してください（失敗例: db open failed (DB_PATH): syscall error 'DB_PATH' (ファイルが存在します)。 次の章で、既存のデータベースを開く方法を説明します）。

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

実行例:

% groonga -n /tmp/groonga-databases/introduction.db

データベースの作成に成功すれば、/tmp/groonga-databases以下にデータベースを構成するファイルが配置されます。

  データベースの操作

以下の書式は、既存のデータベースを操作する方法を示しています。

書式:

groonga DB_PATH [COMMAND]

DB_PATHには操作対象のデータベースを指定します。指定したデータベースが存在しないときは失敗します。

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

それでは、 /reference/commands/status コマンドを実行して、Groongaの実行状態を確認してみましょう。

実行例:

% groonga /tmp/groonga-databases/introduction.db
status
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "uptime": 0,
#     "max_command_version": 2,
#     "n_queries": 0,
#     "cache_hit_rate": 0.0,
#     "version": "5.0.6-128-g8029ddb",
#     "alloc_count": 206,
#     "command_version": 1,
#     "starttime": 1439995916,
#     "default_command_version": 1
#   }
# ]

以上のように、コマンドの実行結果は基本的にjson形式の配列として返却されます。配列の先頭には、エラーコードや実行時間などの情報が入ります。2番目の要素には、指示された操作の実行結果が入ります。

注釈: 他のツールを使うことで、JSONを整形できます。例えば、 grnwrap や Grnline 、 jq などが使えます。

  コマンドの書式

データベースを操作するコマンドには、以下の書式で引数を与えます。:

Form_1: COMMAND VALUE_1 VALUE_2 ..
Form_2: COMMAND --NAME_1 VALUE_1 --NAME_2 VALUE_2 ..

書式1では値を適切な順番で渡す必要があります。このような引数は、位置によって値の意味が決まるため、位置固定引数などと呼ばれることもあります。

書式2では値を名前と一緒に渡します。そのため、任意の順序で引数を指定することができます。このような引数は、名前付き引数やキーワード引数と呼ばれることもあります。

空白や特殊な記号（ダブルクォート、シングルクォート、および丸括弧）を含む値を指定したいときは、シングルクォート(')かダブルクォート(")で値を囲むようにしてください。

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

  主なコマンド

/reference/commands/status
    Groongaプロセスの状態を表示します。

/reference/commands/table_list
    データベースに定義されているテーブルのリストを表示します。

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

/reference/commands/table_create
    データベースにテーブルを追加します。

/reference/commands/column_create
    テーブルにカラムを追加します。

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

/reference/commands/load
    テーブルにレコードを挿入します。

  テーブルの作成

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

Groongaのテーブルには基本的に主キーが必要であり、テーブルを作成する際には型と格納方法も併せて指定する必要があります。

型には数値や文字列などがあります。ここではデータの種類を表しているものという程度に考えてください。詳細は /reference/types に記述されています。主キーの格納方法は、主キーを条件とする検索にかかる時間や、前方一致検索の可否などを左右します。こちらも後で説明します。

それでは、テーブルを作成してみましょう。以下の例では、主キーのあるテーブルを作成します。 name 引数はテーブルの名前を指定します。 flags 引数は主キーの格納方法を指定するために使っています。 key_type 引数は主キーの型を指定します。

実行例:

table_create --name Site --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

実行結果の第2要素は、操作が成功したことを示しています。

  テーブルの表示

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

実行例:

select --table Site
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         0
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ]
#       ]
#     ]
#   ]
# ]

/reference/commands/select に table 引数のみを指定すると、指定したテーブルの中身を10件まで表示します。実行結果の[0]はテーブルに含まれるレコードの数を示しています。今回は何も登録されていないため0件です。レコード数の次に表示されている配列はテーブルの構成を示しています。["_id","Uint32"]はUInt32型の値を持つ_idという名前のカラム、["_key","ShortText"]はShortText型の値を持つ_keyという名前のカラムをそれぞれ表しています。

上記の_idカラムと_keyカラムの2つのカラムは必須のカラムです。_idカラムはGroongaが自動的に割り当てるIDを格納します。_keyカラムは主キーを格納します。これらのカラム名を変更することはできません。

  カラムの作成

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

それでは、カラムを作成してみましょう。以下の例では、新しいカラムをSiteテーブルに追加します。 table 引数はテーブルの名前を指定します。 name 引数は新しいカラムの名前を指定します。 type 引数はカラムに格納する値の型を指定します。

実行例:

column_create --table Site --name title --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
select --table Site
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         0
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ]
#     ]
#   ]
# ]

  データのロード

/reference/commands/load コマンドは、JSON形式のレコードを受け取り、テーブルに格納します。

以下の例では9つのレコードをSiteテーブルに格納します。

実行例:

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, 1337566253.89858, 0.000355720520019531], 9]

実行結果の第2要素はロードされたレコードの数を示しています。上記の操作では、すべてのレコードを問題なくロードできています。

念のため、データが入っていることを確認してみましょう。

実行例:

select --table Site
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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."
#       ]
#     ]
#   ]
# ]

  レコードの取得

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

query 引数を使って検索条件が指定された場合、 /reference/commands/select コマンドは検索条件に適合するレコードを検索し、検索結果を出力します。

それでは、IDを指定してレコードを取り出してみましょう。以下の例では、Siteテーブルの先頭レコードを取り出します。正確には、 query 引数を使って _id カラムに1が格納されているレコードを要求しています。

実行例:

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

次に、主キーを指定してレコードを取り出してみましょう。以下の例では、主キーが "http://example.org/" のキーを取り出します。正確には、 query 引数を使って _key カラムに "http://example.org/" が格納されているレコードを要求しています。

実行例:

select --table Site --query '_key:"http://example.org/"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "http://example.org/",
#         "This is test record 1!"
#       ]
#     ]
#   ]
# ]

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

そろそろ全文検索の使い方について見ていきましょう。

Groongaでは転置インデックスを使って高速な全文検索を実現しています。そのため、まずは転置インデックスとして用いるテーブルを作成する必要があります。テーブルの内容は、文書に含まれる単語やN-gramなどの索引語を主キーとして、各カラムに索引語の位置情報を格納するという構成になります。結果として、主キーのカラムは全文検索における語彙表の役割を果たします。

以下の例では、Termsという名前のテーブルを転置インデックスの語彙表として作成しています。索引語を格納するため、主キーの型はShortTextです。

実行例:

table_create --name Terms --flags TABLE_PAT_KEY --key_type ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]

/reference/commands/table_create には多くの引数が指定されているものの、本チュートリアルではすべてを理解する必要はありません。以下に簡単な説明を述べますが、読み飛ばしてもらってかまいません。

TABLE_PAT_KEYフラグは、主キーをパトリシア木に格納することを指示しています。 default_tokenizer 引数には、検索対象の文書をトークナイズする方式を指定するようになっています。上記の例では、一般的にN-gramと呼ばれるインデックス方式に対応するTokenBigramを指定しています。

normalizer 引数はインデックスの単語をノーマライズするかどうかを指定しています。

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

次に必要なのは、インデックス型のカラムを作成することです。このカラムは、関連付けられたカラムに対する全文検索に利用されます。つまり、全文検索を行いたいカラムに対してインデックスを作成することに相当します。

それでは、インデックスカラムを作成してみましょう。以下の例では、Siteテーブルのカラムに対するインデックスカラムを作成します。それでは、Siteテーブルのtitleカラムを全文検索の対象とするべく、インデックス型のカラムを作成してみましょう。

実行例:

column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
# [[0, 1337566253.89858, 0.000355720520019531], true]

table 引数は語彙表を指定し、 name 引数はインデックスカラムを指定します。また、 type 引数はインデックスの対象となるテーブルを指定し、 source 引数はインデックスの対象となるカラムを指定します。COLUMN_INDEXフラグはインデックスカラムの作成を指示し、WITH_POSITIONフラグは各索引語の位置情報をインデックスに含めることを指示します。一般的な全文検索インデックスを作成したいときは、COLUMN_INDEX|WITH_POSITIONを指定してください。索引語の位置情報については、本チュートリアルでは触れません。

注釈: 語彙表とインデックスカラムを作成するタイミングは、データをロードする前後のどちらでも問題ありません。データをロードした後でインデックスを作成し、さらに新しいデータをロードすることもできます。インデックスの作成を指示したタイミングでレコードが既に存在するときは、静的にインデックスを作成します。一方、インデックスを作成した後で追加されたレコードについては、動的にインデックスを更新します。

  全文検索

インデックスを作成したことにより、 /reference/commands/select コマンドによる全文検索が可能になります。

全文検索のクエリは query 引数により指定することができます。以下の例では、titleカラムに "this" という文字列が含まれているレコードを検索します。 query 引数に含まれる '@' は、全文検索を指示しています。語彙表の作成において NormalizerAuto を指定したときは、全角・半角や大文字・小文字などの違いが吸収されることに注意してください。

実行例:

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

上記の例では、"This" という単語を含む先頭レコードのみが検索条件に適合します。

/reference/commands/select コマンドには、 match_columns という引数が存在します。このパラメータはデフォルトで検索対象にするカラムを指定するもので、カラム名を指定しない検索条件にのみ適用されます。 [1]

"--match_columns title" と "--query this" の組み合わせを指定すると、 "--query title:@this" を指定したときと同じ検索条件になります。

実行例:

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

  出力カラムの指定

/reference/commands/select コマンドにおいて output_columns 引数を用いることで、検索結果に含めるカラムを指定することができます。複数のカラムを指定するときは、カンマ（,）区切りでカラムを列挙します。

実行例:

select --table Site --output_columns _key,title,_score --query title:@test
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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
#       ]
#     ]
#   ]
# ]

上記の例では、_scoreカラムを含む3つのカラムを指定しています。_scoreカラムはGroongaの検索結果に含まれるカラムであり、全文検索の条件に合致するレコードほど高い数値が入ります。

  表示範囲指定

/reference/commands/select コマンドにおいて offset 引数と limit 引数を用いることで、検索結果の一部のみを表示することができます。大量の検索結果を分割してページ単位で表示したい場合などに有用です。

offset 引数には、検索結果における始点を指定します。検索結果の1件目が必要な場合、 offset 引数を省略するか、0を指定するようにしてください。 limit 引数には、検索結果の表示件数を指定します。

実行例:

select --table Site --offset 0 --limit 3
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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."
#       ]
#     ]
#   ]
# ]

  検索結果の並べ替え

/reference/commands/select コマンドに sortby 引数を渡すことにより、検索結果を並べ替えることができます。

sortby 引数には、整列の基準として用いるカラムを指定します。検索結果は指定したカラムの値が昇順になるように並べ替えられます。 sortby 引数の中でカラム名の前にハイフン（-）を付けることにより、降順に並べ替えることもできます。

以下の例では、Siteテーブルのレコードを逆順に表示しています。

実行例:

select --table Site --sortby -_id
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         9
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         6,
#         4,
#         "test test test test record six."
#       ],
#       [
#         5,
#         3,
#         "test test test record five."
#       ],
#       [
#         7,
#         3,
#         "test test test record seven."
#       ],
#       [
#         8,
#         2,
#         "test test record eight."
#       ],
#       [
#         3,
#         2,
#         "test test record three."
#       ],
#       [
#         9,
#         2,
#         "test test record nine."
#       ],
#       [
#         1,
#         1,
#         "This is test record 1!"
#       ],
#       [
#         4,
#         1,
#         "test record four."
#       ],
#       [
#         2,
#         1,
#         "test record 2."
#       ]
#     ]
#   ]
# ]

整列の基準となるカラムを複数指定したいときは、カンマ（,）区切りでカラムを列挙します。複数のカラムを指定したときは、最初のカラムを基準として整列した後、最初のカラムに同じ値が格納されているレコードを次のカラムを基準として整列します。

実行例:

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

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

  リモートアクセス

Groongaをサーバとして起動することにより、ネットワークを介してデータベースにアクセスできるようになります。Groongaがサポートしているプロトコルは、Groongaの専用プロトコルであるGQTP、memcachedバイナリプロトコル、HTTPの三種類です。

  HTTP

  HTTPサーバの起動

GroongaはHTTPをサポートしています。以下の書式はHTTPサーバをデーモンとして起動する方法を示しています。

書式:

groonga [-p PORT_NUMBER] -d --protocol http DB_PATH

--protocol オプションとその引数により、サーバのプロトコルを指定することができます。"http"はHTTPサーバの起動を指示しています。-p オプションを省略した場合は10041のポート番号が使用されます。

以下のコマンドは、ポート番号80で待ち受けるHTTPサーバをデーモンとして起動します。

実行例:

% sudo groonga -p 80 -d --protocol http /tmp/groonga-databases/introduction.db
%

注釈: 80番ポートで待ち受けるにはroot権限が必須です。1024番以降のポート番号にはそのような制限はありません。

  HTTPサーバへのコマンド送信

GroongaがHTTPサーバとして起動されているときは、/d/COMMAND_NAME というURLにアクセスすることにより、コマンドを実行することができます。コマンドの引数は、HTTPのGETパラメータとして渡します。引数の書式は "?NAME_1=VALUE_1&NAME_2=VALUE_2&..." となります。

以下の例は、HTTPサーバに対するコマンドの送り方を示しています。

実行例:

http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/status
Executed command:
status
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "uptime": 0,
#     "max_command_version": 2,
#     "n_queries": 0,
#     "cache_hit_rate": 0.0,
#     "version": "5.0.6-128-g8029ddb",
#     "alloc_count": 185,
#     "command_version": 1,
#     "starttime": 1439995935,
#     "default_command_version": 1
#   }
# ]
http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/select?table=Site&query=title:@this
Executed command:
select --table Site --query title:@this
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "country",
#           "SiteCountry"
#         ],
#         [
#           "domain",
#           "SiteDomain"
#         ],
#         [
#           "link",
#           "Site"
#         ],
#         [
#           "links",
#           "Site"
#         ],
#         [
#           "location",
#           "WGS84GeoPoint"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "http://example.org/",
#         "japan",
#         ".org",
#         "http://example.net/",
#         [
#           "http://example.net/",
#           "http://example.org/",
#           "http://example.com/"
#         ],
#         "128452975x503157902",
#         "This is test record 1!"
#       ]
#     ]
#   ]
# ]

  ブラウザベースの管理ツール

GroongaをHTTPサーバとして起動しているときは、ブラウザベースの管理ツールを使うことにより、データベースを簡単に管理することができます。管理ツールを使いたいときは、ブラウザを使って http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/ へとアクセスしてください。管理ツールの使用には、JavaScriptの実行が有効になっている必要があります。

  セキュリティ

Groongaのサーバには認証機能がありません。誰でもデータベースの内容を閲覧・修正することができます。iptablesなどを用いてアクセス元IPアドレスを制限することを推奨します。

  いろいろなデータの保存

Groongaは全文検索エンジンを起源として独自のカラムストアを持つに至るわけですが、索引語や文書を保存するだけでなく、数値や文字列、日時や経緯度など、いろいろなデータを保存することができます。本チュートリアルでは、Groongaで保存できるデータの種類、および保存の方法を説明します。

  データの種類

Groongaにおいて利用できる基本型は、真偽値、数値、文字列、日時、経緯度の5種類に大別できます。基本型において、数値は整数・浮動小数点数の違い、符号の有無と割り当てるビット数によって細分化できるほか、文字列は長さの上限によって細分化できます。また、経緯度には測地系による分類があります。詳しくは /reference/types を参照してください。

拡張型としては、別テーブルを参照するための情報であるテーブル参照を保存することができます。また、基本型もしくはテーブル参照を複数まとめて保存できるように、ベクターカラムをサポートしています。

それでは、本チュートリアルで使用するテーブルを作成しておきましょう。

実行例:

table_create --name ToyBox --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

  真偽値

ブール型は真偽値（true/false）を表現するための型です。ブール型のカラムを作成するには、 /reference/commands/column_create コマンドの type 引数に Bool を指定します。ブール型のデフォルト値はfalseです。

以下の例では、ブール型のカラムを作成し、3つのレコードを追加します。3番目のレコードについては、値を省略しているため、デフォルト値が格納されます。

実行例:

column_create --table ToyBox --name is_animal --type Bool
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table ToyBox
[
{"_key":"Monkey","is_animal":true}
{"_key":"Flower","is_animal":false}
{"_key":"Block"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select --table ToyBox --output_columns _key,is_animal
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "is_animal",
#           "Bool"
#         ]
#       ],
#       [
#         "Monkey",
#         true
#       ],
#       [
#         "Flower",
#         false
#       ],
#       [
#         "Block",
#         false
#       ]
#     ]
#   ]
# ]

  数値

数値型は、整数と浮動小数点数に分けることができます。整数は、符号付き整数と符号なし整数に分けることができるだけでなく、割り当てるビット数によっても分けることができます。割り当てるビット数を大きくすると、カラムのサイズは大きくなってしまいますが、表現できる整数の範囲を大きくすることができます。詳しくは /reference/types を参照してください。数値型のデフォルト値はいずれも0です。

以下の例では、Int8型のカラムとFloat型のカラムを作成し、既存のレコードを更新します。 /reference/commands/load コマンドはweightカラムの値を期待したとおりに更新しています。一方、priceカラムに指定した小数については、小数点以下を切り捨てた値が格納されています。また、表現できる範囲を超える値を格納しようとした2番目のレコードについては、指定した値とは異なる値が格納されています。このように、表現できる範囲を超える値を指定すると、操作後の値は未定義になるので注意してください。

実行例:

column_create --table ToyBox --name price --type Int8
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table ToyBox --name weight --type Float
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table ToyBox
[
{"_key":"Monkey","price":15.9}
{"_key":"Flower","price":200,"weight":0.13}
{"_key":"Block","weight":25.7}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select --table ToyBox --output_columns _key,price,weight
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "price",
#           "Int8"
#         ],
#         [
#           "weight",
#           "Float"
#         ]
#       ],
#       [
#         "Monkey",
#         15,
#         0.0
#       ],
#       [
#         "Flower",
#         -56,
#         0.13
#       ],
#       [
#         "Block",
#         0,
#         25.7
#       ]
#     ]
#   ]
# ]

  文字列

文字列型は、長さの上限によって分けることができます。詳しくは /reference/types を参照してください。文字列型のデフォルト値は長さ0の文字列です。

以下の例では、 ShortText 型のカラムを作成し、既存のレコードを更新します。3つ目のレコード（キーが "Block" のレコード）は更新していないのでデフォルト値（長さが0の文字列）になります。

実行例:

column_create --table ToyBox --name name --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table ToyBox
[
{"_key":"Monkey","name":"Grease"}
{"_key":"Flower","name":"Rose"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
select --table ToyBox --output_columns _key,name
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "name",
#           "ShortText"
#         ]
#       ],
#       [
#         "Monkey",
#         "Grease"
#       ],
#       [
#         "Flower",
#         "Rose"
#       ],
#       [
#         "Block",
#         ""
#       ]
#     ]
#   ]
# ]

  日時

日時を表現するための型はTimeです。内部では1970年1月1日0時0分0秒を基準とする経過時間をマイクロ秒単位で表現します。符号付きの整数を用いるため、1970年以前の日時も表現することができます。内部表現はマイクロ秒単位の整数ですが、 /reference/commands/load コマンドおよび /reference/commands/select コマンドでは、経過秒数による指定・表示となります。デフォルト値は1970年1月1日0時0分0秒のことを表す0.0です。

注釈: Groonga内部では経過秒数を整数のペアで保持しています。最初の整数で秒を表現し、もう一方でマイクロ秒を表現します。それゆえGroongaでは小数で経過秒数を表示します。整数部が秒数で、小数部はマイクロ秒の値です。

以下の例では、 Time 型のカラムを作成し、既存のレコードを更新します。1つ目のレコード（キーが "Monkey" のレコード）は更新していないのでデフォルト値（ 0.0 ）になります。

実行例:

column_create --table ToyBox --name time --type Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table ToyBox
[
{"_key":"Flower","time":1234567890.1234569999}
{"_key":"Block","time":-1234567890}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
select --table ToyBox --output_columns _key,time
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "time",
#           "Time"
#         ]
#       ],
#       [
#         "Monkey",
#         0.0
#       ],
#       [
#         "Flower",
#         1234567890.12346
#       ],
#       [
#         "Block",
#         -1234567890.0
#       ]
#     ]
#   ]
# ]

  経緯度

経緯度を表現するための型は、測地系によって分けることができます。詳しくは /reference/types を参照してください。経緯度の指定・表示には、以下に示す形式の文字列を使います。

•   "経度のミリ秒表記x緯度のミリ秒表記" （例: "128452975x503157902"）

•   "経度の度数表記x緯度の度数表記" （例: "35.6813819x139.7660839"）

    小数点を含んでいなければミリ秒表記、小数点を含んでいれば度数表記として扱われます。ミリ秒表記と度数表記を混ぜたときの動作は未定義なので注意してください。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。経緯度のデフォルト値は "0x0" です。

    以下の例では、世界測地系を用いる WGS84GeoPoint 型のカラムを作成し、既存のレコードを更新します。2つ目のレコード（キーが "Flower" のレコード）は更新していないのでデフォルト値（ "0x0" ）になります。

    実行例:

    column_create --table ToyBox --name location --type WGS84GeoPoint
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table ToyBox
    [
    {"_key":"Monkey","location":"128452975x503157902"}
    {"_key":"Block","location":"35.6813819x139.7660839"}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 2]
    select --table ToyBox --output_columns _key,location
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         3
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "location",
    #           "WGS84GeoPoint"
    #         ]
    #       ],
    #       [
    #         "Monkey",
    #         "128452975x503157902"
    #       ],
    #       [
    #         "Flower",
    #         "0x0"
    #       ],
    #       [
    #         "Block",
    #         "128452975x503157902"
    #       ]
    #     ]
    #   ]
    # ]

  テーブル参照

Groongaでは、テーブル参照のカラム、すなわち関連付けたテーブルを参照するカラムを作成できます。より正確には、カラム作成時に参照先となるテーブルとの関連付けをおこない、参照先テーブルにおけるレコードIDを格納しておくことにより、参照先のレコードにアクセスできるようにします。

テーブル参照のカラムがあるときは、 /reference/commands/select コマンドの output_columns 引数に 参照元カラム.参照先カラム と指定することにより、参照先カラムの値を取り出すことができます。参照元カラムのみを指定したときは、 参照元カラム名._key と同様の扱いとなり、参照先レコードの主キーが取り出されます。テーブル参照が有効なレコードを指していないときは、 /reference/commands/select コマンドは参照先カラムのデフォルト値を取り出すようになっています。

ここでは、 tutorial-introduction-create-table で作成した Site テーブルに参照カラムを作成します。作成する参照カラムは link という名前にします。このカラムには Site テーブルのレコード間でのリンク関係を保存します。

実行例:

column_create --table Site --name link --type Site
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Site
[
{"_key":"http://example.org/","link":"http://example.net/"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
select --table Site --output_columns _key,title,link._key,link.title --query title:@this
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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."
#       ]
#     ]
#   ]
# ]

テーブル参照のカラムを作成するときは、 /reference/commands/column_create コマンドの type 引数に参照先テーブルを指定します。この例では、同じテーブルに含まれる別のレコードを参照させたいので、Siteを指定することになります。次に、 /reference/commands/load コマンドで "http://example.org/" から "http://example.net/" へのリンクを登録しています。テーブル参照を作成するときは、IDではなく主キーを指定することに注意してください。最後に、 /reference/commands/select コマンドでリンクの内容を確認しています。この例では、 output_columns 引数に link._key と link.title を指定しているので、参照先の主キーとタイトルが表示されています。

  ベクターカラム

/reference/commands/column_create コマンドでカラムを作成するとき、 flags 引数にCOLUMN_VECTORフラグを指定すると、 type 引数に指定した型の配列を格納するカラムになります。このようなカラムのことを、ベクターカラムと呼びます。ベクターカラムは、各レコードに複数の値を格納できるため、一対多の参照関係を表すのに便利です。

さきほどテーブル参照の例として作成したカラムでは、各サイトに一つのリンクしか保存できませんでした。通常は一つのサイトから多くのサイトにリンクが張られているので、これでは残念な仕様になってしまいます。そこで、ベクターカラムを使って、複数のリンクを保存できるようにしてみましょう。

実行例:

column_create --table Site --name links --flags COLUMN_VECTOR --type Site
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Site
[
{"_key":"http://example.org/","links":["http://example.net/","http://example.org/","http://example.com/"]},
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
select --table Site --output_columns _key,title,links._key,links.title --query title:@this
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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."
#         ]
#       ]
#     ]
#   ]
# ]

新たなカラムにはSiteテーブルに対する参照の配列を格納するので、 type 引数にSiteを指定するとともに、 flags 引数にCOLUMN_VECTORフラグを指定しています。 /reference/commands/column_create コマンドの type パラメーターは前の例と同じです。次に、 /reference/commands/load コマンドによる更新では、 "http://example.org/" から "http://example.net/" へのリンクに加えて、 "http://example.org/" と "http://example.com/" へのリンクも登録しています。そして、最後に /reference/commands/select コマンドでリンクの内容を確認しています。この例では、 output_columns 引数に links._key と links.title を指定しているので、参照先の主キーとタイトルをそれぞれ配列にしたものが表示されています。

  さまざまな検索条件

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

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

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

実行例:

select --table Site --filter "_id <= 1" --output_columns _id,_key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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 "true" --scorer "_score = rand()" --output_columns _id,_key,_score --sortby _score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         9
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         6,
#         "http://example.com/rab",
#         424238335
#       ],
#       [
#         9,
#         "http://example.com/vdw",
#         596516649
#       ],
#       [
#         7,
#         "http://example.net/atv",
#         719885386
#       ],
#       [
#         2,
#         "http://example.net/",
#         846930886
#       ],
#       [
#         8,
#         "http://example.org/gat",
#         1649760492
#       ],
#       [
#         3,
#         "http://example.com/",
#         1681692777
#       ],
#       [
#         4,
#         "http://example.net/afr",
#         1714636915
#       ],
#       [
#         1,
#         "http://example.org/",
#         1804289383
#       ],
#       [
#         5,
#         "http://example.org/aba",
#         1957747793
#       ]
#     ]
#   ]
# ]
select --table Site --filter "true" --scorer "_score = rand()" --output_columns _id,_key,_score --sortby _score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         9
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         4,
#         "http://example.net/afr",
#         783368690
#       ],
#       [
#         2,
#         "http://example.net/",
#         1025202362
#       ],
#       [
#         5,
#         "http://example.org/aba",
#         1102520059
#       ],
#       [
#         1,
#         "http://example.org/",
#         1189641421
#       ],
#       [
#         3,
#         "http://example.com/",
#         1350490027
#       ],
#       [
#         8,
#         "http://example.org/gat",
#         1365180540
#       ],
#       [
#         9,
#         "http://example.com/vdw",
#         1540383426
#       ],
#       [
#         7,
#         "http://example.net/atv",
#         1967513926
#       ],
#       [
#         6,
#         "http://example.com/rab",
#         2044897763
#       ]
#     ]
#   ]
# ]

'_score'は仮想的なカラムです。全文検索のスコアが代入されています。仮想的なカラムの詳細については、 /reference/columns/pseudo を参照してください。

上記のクエリでは scorer パラメータの条件はこのとおりです:

_score = rand()

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

sortby パラメータの条件は次のとおりです:

_score

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

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

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

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

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

以下のようにして経緯度を指定します:

•   "経度のミリ秒表記x緯度のミリ秒表記" （例: "128452975x503157902"）

•   "経度のミリ秒表記,緯度のミリ秒表記" （例: "128452975,503157902"）

•   "経度の度数表記x緯度の度数表記" （例: "35.6813819x139.7660839"）

•   "経度の度数表記,緯度の度数表記" （例: "35.6813819,139.7660839"）

    ここでは、ためしに東京駅と新宿駅とついて、世界測地系での位置情報を保存してみましょう。東京駅は緯度が35度40分52.975秒、経度が139度45分57.902秒です。新宿駅は緯度が35度41分27.316秒、経度が139度42分0.929秒です。よって、ミリ秒表記の場合はそれぞれ"128452975x503157902"/"128487316x502920929"となります。度数表記の場合はそれぞれ"35.6813819x139.7660839"/"35.6909211x139.7002581"となります。

    ミリ秒表記で位置情報を登録してみましょう。

    実行例:

    column_create --table Site --name location --type WGS84GeoPoint
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Site
    [
     {"_key":"http://example.org/","location":"128452975x503157902"}
     {"_key":"http://example.net/","location":"128487316x502920929"},
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 2]
    select --table Site --query "_id:1 OR _id:2" --output_columns _key,location
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "location",
    #           "WGS84GeoPoint"
    #         ]
    #       ],
    #       [
    #         "http://example.org/",
    #         "128452975x503157902"
    #       ],
    #       [
    #         "http://example.net/",
    #         "128487316x502920929"
    #       ]
    #     ]
    #   ]
    # ]

    scorer パラメータに /reference/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,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "location",
    #           "WGS84GeoPoint"
    #         ],
    #         [
    #           "_score",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         "http://example.org/",
    #         "128452975x503157902",
    #         2054
    #       ],
    #       [
    #         "http://example.net/",
    #         "128487316x502920929",
    #         6720
    #       ]
    #     ]
    #   ]
    # ]

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

    geo_distance 関数は、_score に値を設定することで、sortby パラメータによるソートでも用いることができます。

    実行例:

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

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

    その場合には、 filter パラメータで /reference/functions/geo_in_circle を指定します。

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

    実行例:

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

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

  ドリルダウン

これまでのセクションで検索方法と検索結果をどのようにソートするかを学びました。思うがままに検索できるようになりましたね。それでは、次のことをするにはどうすればよいでしょか。まず、あるカラムに注目します。そして、そのカラムの値が同じレコードを集め、それぞれの値毎に集まったレコードの数を数えます。

素朴な実現方法は、カラムのそれぞれの値で検索する方法です。結果として、すべてのカラムの値についてレコード数を求めることができます。シンプルな方法ですが、たくさんのレコードがある場合には現実的ではありません。

SQLに慣れている人は、「GroongaにはSQLでいう GROUP BY 相当の機能はないの？」と思うでしょう。

もちろん、Groongaはそのような機能を提供しています。それが drilldown と呼んでいる機能です。

drilldown はカラムの値ごとにレコード数を数える機能を提供します。値ごとに別々のクエリーになるのではなく、1回のクエリーですべての値に対してレコード数を数えます。

この機能を説明するために次のケースを考えます。ドメインで分類し、ドメインが属している国ごとにグループ化する、というケースです。

この機能を使った具体的な例を示します。

この例では、 Site テーブルに2つのカラムを追加しています。 domain カラムはTLD(トップレベルドメイン)に使います。 country カラムは国名に使います。これらのカラムの型はドメイン名を主キーとする SiteDomain テーブルと国名を主キーとする SiteCountry テーブルです。

実行例:

table_create --name SiteDomain --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create --name SiteCountry --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Site --name domain --flags COLUMN_SCALAR --type SiteDomain
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Site --name country --flags COLUMN_SCALAR --type SiteCountry
# [[0, 1337566253.89858, 0.000355720520019531], 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, 1337566253.89858, 0.000355720520019531], 9]

domain カラムでドリルダウンする例を示します。 3つの値が domain カラムでは使われています。".org"、".net"そして".com"です。

実行例:

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

上記のクエリの集計結果です。

  domain カラムによるドリルダウン
グループ化するカラムの値 | グループ化されたレコード数 | グループ化されたレコードは次のとおり
.org | 3 | http://example.org/ http://example.org/aba http://example.org/gat
.net | 3 | http://example.net/ http://example.net/afr http://example.net/atv
.com | 3 | http://example.com/ http://example.com/rab http://example.com/vdw

ドリルダウン結果は _nsubrecs カラムの値として返ります。この場合は、Site テーブルは ".org"、".net"、".com"ドメインでグループ化されています。 _nsubrecs はグループ化されたドメインが3つのレコードをそれぞれもつことを意味します。

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

では、参照されているテーブルの詳細を調べてみましょう。 Site テーブルは SiteDomain テーブルを domain カラムの型として使っています。 --drilldown_output_columns を参照されているカラムの詳細を知るのに使えます。

実行例:

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

これでグループ化されたドメインの詳細がわかります。 domain の値が".org"であるレコードに対して country カラムを使ってドリルダウンしてみましょう。

実行例:

select --table Site --limit 0 --filter "domain._id == 1" --drilldown country
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "country",
#           "SiteCountry"
#         ],
#         [
#           "domain",
#           "SiteDomain"
#         ],
#         [
#           "link",
#           "Site"
#         ],
#         [
#           "links",
#           "Site"
#         ],
#         [
#           "location",
#           "WGS84GeoPoint"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "japan",
#         1
#       ],
#       [
#         "korea",
#         1
#       ],
#       [
#         "usa",
#         1
#       ]
#     ]
#   ]
# ]

  複数のカラムでドリルダウン

ドリルダウンでは複数のカラムをサポートしています。 drilldown パラメータの引数にカンマ区切りの値を指定します。すると一度にまとめてドリルダウン結果を取得できます。

実行例:

select --table Site --limit 0 --drilldown domain,country
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         9
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "country",
#           "SiteCountry"
#         ],
#         [
#           "domain",
#           "SiteDomain"
#         ],
#         [
#           "link",
#           "Site"
#         ],
#         [
#           "links",
#           "Site"
#         ],
#         [
#           "location",
#           "WGS84GeoPoint"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         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
#       ]
#     ]
#   ]
# ]

  ドリルダウン結果をソートする

ドリルダウン結果をソートしたい場合には --drilldown_sortby を使います。指定した _nsubrecs カラムを昇順でソートします。

実行例:

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

  ドリルダウン結果の制限

ドリルダウン結果はデフォルト10件に制限されています。 drilldown_limit と drilldown_offset パラメータをドリルダウン結果をカスタマイズするのに使います。

実行例:

select --table Site --limit 0 --drilldown country --drilldown_sortby _nsubrecs --drilldown_limit 2 --drilldown_offset 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         9
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "country",
#           "SiteCountry"
#         ],
#         [
#           "domain",
#           "SiteDomain"
#         ],
#         [
#           "link",
#           "Site"
#         ],
#         [
#           "links",
#           "Site"
#         ],
#         [
#           "location",
#           "WGS84GeoPoint"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         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, 1337566253.89858, 0.000355720520019531], true]
table_create --name Tag --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Video --name title --flags COLUMN_SCALAR --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Video --name tags --flags COLUMN_VECTOR --type Tag
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Tag --name index_tags --flags COLUMN_INDEX --type Video --source tags
# [[0, 1337566253.89858, 0.000355720520019531], 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, 1337566253.89858, 0.000355720520019531], 8]

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

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

実行例:

select --table Video --query tags:@Variety --output_columns _key,title
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "UInt32"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Zenigata Kinjirou"
#       ],
#       [
#         5,
#         "Hex Gone!"
#       ]
#     ]
#   ]
# ]
select --table Video --query tags:@Sports --output_columns _key,title
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "UInt32"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "Soccer 2010"
#       ],
#       [
#         4,
#         "Moero!! Ultra Baseball"
#       ]
#     ]
#   ]
# ]
select --table Video --query tags:@Animation --output_columns _key,title
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         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, 1337566253.89858, 0.000355720520019531], true]
column_create --table User --name username --flags COLUMN_SCALAR --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table User --name friends --flags COLUMN_VECTOR --type User
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table User --name index_friends --flags COLUMN_INDEX --type User --source friends
# [[0, 1337566253.89858, 0.000355720520019531], 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, 1337566253.89858, 0.000355720520019531], 6]

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

実行例:

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

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

実行例:

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

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

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

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

実行例:

table_create --name GeoSite --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table GeoSite --name location --type WGS84GeoPoint
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create --name GeoIndex --flags TABLE_PAT_KEY --key_type WGS84GeoPoint
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table GeoIndex --name index_point --type GeoSite --flags COLUMN_INDEX --source location
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table GeoSite
[
 {"_key":"http://example.org/","location":"128452975x503157902"},
 {"_key":"http://example.net/","location":"128487316x502920929"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
select --table GeoSite --filter 'geo_in_circle(location, "128515259x503187188", 5000)' --output_columns _key,location
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "location",
#           "WGS84GeoPoint"
#         ]
#       ],
#       [
#         "http://example.org/",
#         "128452975x503157902"
#       ]
#     ]
#   ]
# ]

これらのインデックスは、位置情報レコードを用いてソートする場合に使われます。

実行例:

select --table GeoSite --filter 'geo_in_circle(location, "128515259x503187188", 50000)' --output_columns _key,location,_score --sortby '-geo_distance(location, "128515259x503187188")' --scorer '_score = geo_distance(location, "128515259x503187188")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "location",
#           "WGS84GeoPoint"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "http://example.org/",
#         "128452975x503157902",
#         2054
#       ],
#       [
#         "http://example.net/",
#         "128487316x502920929",
#         6720
#       ]
#     ]
#   ]
# ]

  match_columnsパラメータ

  複数のカラムに対する全文検索

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

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

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

カラムごとにインデックスを作成する方法はこの通りです。

まず、 Blog1 テーブルを作成し、 title カラムと message カラムを追加します。 title カラムにブログのタイトルを保存し、 message カラムにブログの本文を保存します。

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

実行例:

table_create --name Blog1 --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Blog1 --name title --flags COLUMN_SCALAR --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Blog1 --name message --flags COLUMN_SCALAR --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create --name IndexBlog1 --flags TABLE_PAT_KEY --key_type ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table IndexBlog1 --name index_title --flags COLUMN_INDEX|WITH_POSITION --type Blog1 --source title
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table IndexBlog1 --name index_message --flags COLUMN_INDEX|WITH_POSITION --type Blog1 --source message
# [[0, 1337566253.89858, 0.000355720520019531], 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, 1337566253.89858, 0.000355720520019531], 3]

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

実際にブログエントリを検索してみましょう。

実行例:

select --table Blog1 --match_columns title||message --query groonga
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "message",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "grn1",
#         "Groonga message",
#         "Groonga test"
#       ],
#       [
#         3,
#         "grn3",
#         "none",
#         "Groonga message"
#       ],
#       [
#         2,
#         "grn2",
#         "rakutan eggs 4 - 4 Groonga moritars",
#         "baseball result"
#       ]
#     ]
#   ]
# ]
select --table Blog1 --match_columns title||message --query message
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "message",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "grn3",
#         "none",
#         "Groonga message"
#       ],
#       [
#         1,
#         "grn1",
#         "Groonga message",
#         "Groonga test"
#       ]
#     ]
#   ]
# ]
select --table Blog1 --match_columns title --query message
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "message",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "grn3",
#         "none",
#         "Groonga message"
#       ]
#     ]
#   ]
# ]

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

Groongaでは複数のカラムにまたがったインデックスもサポートしています。

インデックスカラムが1つしかないというのが違いです。 title と message の2つのカラムに対するインデックスが共通になっています。

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

実行例:

table_create --name Blog2 --flags TABLE_HASH_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Blog2 --name title --flags COLUMN_SCALAR --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table Blog2 --name message --flags COLUMN_SCALAR --type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create --name IndexBlog2 --flags TABLE_PAT_KEY --key_type ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table IndexBlog2 --name index_blog --flags COLUMN_INDEX|WITH_POSITION|WITH_SECTION --type Blog2 --source title,message
# [[0, 1337566253.89858, 0.000355720520019531], 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, 1337566253.89858, 0.000355720520019531], 3]

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

実行例:

select --table Blog2 --match_columns title||message --query groonga
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "message",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "grn1",
#         "Groonga message",
#         "Groonga test"
#       ],
#       [
#         2,
#         "grn2",
#         "rakutan eggs 4 - 4 Groonga moritars",
#         "baseball result"
#       ],
#       [
#         3,
#         "grn3",
#         "none",
#         "Groonga message"
#       ]
#     ]
#   ]
# ]
select --table Blog2 --match_columns title||message --query message
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "message",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "grn1",
#         "Groonga message",
#         "Groonga test"
#       ],
#       [
#         3,
#         "grn3",
#         "none",
#         "Groonga message"
#       ]
#     ]
#   ]
# ]
select --table Blog2 --match_columns title --query message
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "message",
#           "ShortText"
#         ],
#         [
#           "title",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "grn3",
#         "none",
#         "Groonga message"
#       ]
#     ]
#   ]
# ]

注釈: "インデックスはどちらがよい方法なのか"と疑問に思うかもしれません。それは場合によります。

•   カラムごとのインデックス - マルチカラムインデックスよりも更新性能が良い傾向があります。一方、ディスク使用効率はあまり良くありません。

•   マルチカラムインデックス - バッファを共有するためディスク使用効率が良いです。一方、更新性能があまり良くありません。

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

執筆中です。

  カラムインデックスによる関連テーブルをまたぐ検索

複数のテーブルがカラムインデックスで関連付けられているなら、参照カラム名を指定して複数のテーブルにまたがって検索することができます。

具体的な例を示します。

ブログ記事や記事のコメントを保存するテーブルがあります。記事を保存するテーブルには記事とコメントのためのカラムがあります。そしてそのコメントカラムはCommentsテーブルを参照しています。コメントを保存するテーブルにはコメントと記事テーブルに対するカラムインデックスが設定されています。

特定のキーワードをコメントに含む記事を探すには、コメントテーブルを全文検索する必要があり、全文検索結果を含むレコードをさらに検索する必要があります。

しかし、カラムインデックスを指定することで一度にレコードを検索することができます。

サンプルのスキーマ定義はこちらです。

実行例:

table_create Comments TABLE_HASH_KEY UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comments content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Articles TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Articles content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Articles comment COLUMN_SCALAR Comments
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Lexicon TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon articles_content COLUMN_INDEX|WITH_POSITION Articles content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon comments_content COLUMN_INDEX|WITH_POSITION Comments content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comments article COLUMN_INDEX Articles comment
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータはこちらです。

実行例:

load --table Comments
[
{"_key": 1, "content": "I'm using Groonga too!"},
{"_key": 2, "content": "I'm using Groonga and Mroonga!"},
{"_key": 3, "content": "I'm using Mroonga too!"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
load --table Articles
[
{"content": "Groonga is fast!", "comment": 1},
{"content": "Groonga is useful!"},
{"content": "Mroonga is fast!", "comment": 3}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

特定のキーワードをコメントに含むレコードを検索するクエリを書くことができ、それによりレコードを参照する記事を取得します。

これまでに記述したレコードを検索するクエリ:

select Articles --match_columns comment.content --query groonga --output_columns "_id, _score, *"

ArticlesテーブルのcommentカラムとCommentsテーブルのcontentカラムをピリオド( . )で連結し --match_columns の引数とする必要があります。

最初に、このクエリはCommentsテーブルのcontentを全文検索し、次にCommentsテーブルを検索した結果のレコードを参照するArticlesテーブルのレコードを取得します。(これにより、Commentsテーブルの article インデックスカラムを生成するクエリをコメントアウトすると、意図した検索結果が得られません。)

実行例:

select Articles --match_columns comment.content --query groonga --output_columns "_id, _score, *"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ],
#         [
#           "comment",
#           "Comments"
#         ],
#         [
#           "content",
#           "Text"
#         ]
#       ],
#       [
#         1,
#         1,
#         1,
#         "Groonga is fast!"
#       ]
#     ]
#   ]
# ]

これで、特定のキーワードをコメントとして含む記事を検索できます。

このネストしたインデックスの検索という特徴には関連するテーブルが2つだけに制限されません。

前のものと似たサンプルのスキーマ定義です。違いは'返信'を表現するテーブルの追加と関連するテーブルが3つに増えたことです。

実行例:

table_create Replies2 TABLE_HASH_KEY UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Replies2 content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Comments2 TABLE_HASH_KEY UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comments2 content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comments2 comment COLUMN_SCALAR Replies2
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Articles2 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Articles2 content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Articles2 comment COLUMN_SCALAR Comments2
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Lexicon2 TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon2 articles_content COLUMN_INDEX|WITH_POSITION Articles2 content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon2 comments_content COLUMN_INDEX|WITH_POSITION Comments2 content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon2 replies_content COLUMN_INDEX|WITH_POSITION Replies2 content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comments2 article COLUMN_INDEX Articles2 comment
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Replies2 reply_to COLUMN_INDEX Comments2 comment
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータはこちらです。

実行例:

load --table Replies2
[
{"_key": 1, "content": "I'm using Rroonga too!"},
{"_key": 2, "content": "I'm using Groonga and Mroonga and Rroonga!"},
{"_key": 3, "content": "I'm using Nroonga too!"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
load --table Comments2
[
{"_key": 1, "content": "I'm using Groonga too!", "comment": 1},
{"_key": 2, "content": "I'm using Groonga and Mroonga!", "comment": 2},
{"_key": 3, "content": "I'm using Mroonga too!"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
load --table Articles2
[
{"content": "Groonga is fast!", "comment": 1},
{"content": "Groonga is useful!", "comment": 2},
{"content": "Mroonga is fast!", "comment": 3}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

これまでに記述したレコードを検索するクエリ:

select Articles2 --match_columns comment.content --query mroonga --output_columns "_id, _score, *"
select Articles2 --match_columns comment.comment.content --query mroonga --output_columns "_id, _score, *"

最初のクエリは Comments2 テーブルから mroonga を検索します。2つめのクエリは Replies2 と Comments2 テーブルからカラムインデックスによる参照を用いて``mroonga``を検索します。

実行例:

select Articles2 --match_columns comment.content --query mroonga --output_columns "_id, _score, *"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ],
#         [
#           "comment",
#           "Comments2"
#         ],
#         [
#           "content",
#           "Text"
#         ]
#       ],
#       [
#         2,
#         1,
#         2,
#         "Groonga is useful!"
#       ],
#       [
#         3,
#         1,
#         3,
#         "Mroonga is fast!"
#       ]
#     ]
#   ]
# ]
select Articles2 --match_columns comment.comment.content --query mroonga --output_columns "_id, _score, *"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ],
#         [
#           "comment",
#           "Comments2"
#         ],
#         [
#           "content",
#           "Text"
#         ]
#       ],
#       [
#         2,
#         1,
#         2,
#         "Groonga is useful!"
#       ]
#     ]
#   ]
# ]

結果として、最初のクエリは Comments2 テーブルに mroonga をキーワードとして含むレコードが2つあるので、該当する記事2つにマッチします。

一方、2つめのクエリは Replies2 テーブルに mroonga というキーワードにマッチするレコードが1つしかなく、 Comments2 テーブルでそのキーワードを含むレコードを参照するコメントが1つなので、該当する記事は1つだけとなります。

  インデックスの重み

執筆中です。

  パトリシア木による前方一致検索

Groongaのテーブルは、テーブル作成時にパトリシア木オプションを指定すると、前方一致検索を行うことができます。

また、追加のオプションを指定することにより、主キーの後方一致検索をも行うことができます。

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

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

実行例:

table_create --name PatPrefix --flags TABLE_PAT_KEY --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table PatPrefix
[
{"_key":"James"}
{"_key":"Jason"}
{"_key":"Jennifer"},
{"_key":"Jeff"},
{"_key":"John"},
{"_key":"Joseph"},
]
# [[0, 1337566253.89858, 0.000355720520019531], 6]
select --table PatPrefix --query _key:^Je
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "Jennifer"
#       ],
#       [
#         4,
#         "Jeff"
#       ]
#     ]
#   ]
# ]

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

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

KEY_WITH_SISフラグを付与すると、データを追加する際に後方一致用のレコードも追加されてしまいます。そのため、単純に検索すると、元のレコードに加えて自動的に追加されたレコードまでヒットしてしまいます。元のレコードのみ検索するために、一工夫必要になります。

例えば、元のレコードと自動的に追加されたレコードとの区別をつけるために、元のレコードであることを示すoriginalカラムを追加して、検索時にはoriginalカラムが true も検索条件に加えます。 --query オプションでは Bool 型の値を直感的に指定することができないので --filter オプションを使っていることに注意してください。

実行例:

table_create --name PatSuffix --flags TABLE_PAT_KEY|KEY_WITH_SIS --key_type ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create --table PatSuffix --name original --type Bool
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table PatSuffix
[
{"_key":"ひろゆき","original":true},
{"_key":"まろゆき","original":true},
{"_key":"ひろあき","original":true},
{"_key":"ゆきひろ","original":true}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
select --table PatSuffix --query _key:$ゆき
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "original",
#           "Bool"
#         ]
#       ],
#       [
#         3,
#         "ゆき",
#         false
#       ],
#       [
#         2,
#         "ろゆき",
#         false
#       ],
#       [
#         5,
#         "まろゆき",
#         true
#       ],
#       [
#         1,
#         "ひろゆき",
#         true
#       ]
#     ]
#   ]
# ]
select --table PatSuffix --filter '_key @$ "ゆき" && original == true'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "original",
#           "Bool"
#         ]
#       ],
#       [
#         5,
#         "まろゆき",
#         true
#       ],
#       [
#         1,
#         "ひろゆき",
#         true
#       ]
#     ]
#   ]
# ]

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

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

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

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

これまで学んだ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_type ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
table_create --name GeoIndex --flags TABLE_PAT_KEY --key_type WGS84GeoPoint
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 followee --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
column_create --table GeoIndex --name users_location --type Users --flags COLUMN_INDEX --source location
column_create --table GeoIndex --name comments_location --type Comments --flags COLUMN_INDEX --source location

  Usersテーブル

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

_key
    ユーザーID

name
    ユーザー名

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

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

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

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

description
    ユーザーの自己紹介

followee
    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」のインデックス

  GeoIndexテーブル

位置情報検索を効果的に行うための locationカラムのインデックスを保持するテーブルです。

users_location
    Usersテーブルのlocationカラムに対するインデックス

comments_location
    Commentsテーブルのlocationカラムに対するインデックス

  データのロード

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

load --table Users
[
  {
    "_key": "alice",
    "name": "Alice",
    "follower": ["bob"],
    "favorites": [],
    "location": "152489000x-255829000",
    "location_str": "Boston, Massachusetts",
    "description": "Groonga developer"
  },
  {
    "_key": "bob",
    "name": "Bob",
    "follower": ["alice","charlie"],
    "favorites": ["alice:1","charlie:1"],
    "location": "146249000x-266228000",
    "location_str": "Brooklyn, New York City",
    "description": ""
  },
  {
    "_key": "charlie",
    "name": "Charlie",
    "follower": ["alice","bob"],
    "favorites": ["alice:1","bob:1"],
    "location": "146607190x-267021260",
    "location_str": "Newark, New Jersey",
    "description": "Hmm,Hmm"
  }
]
load --table Comments
[
  {
    "_key": "alice:1",
    "comment": "I've created micro-blog!",
    "last_modified": "2010/03/17 12:05:00",
    "posted_by": "alice",
  },
  {
    "_key": "bob:1",
    "comment": "First post. test,test...",
    "last_modified": "2010/03/17 12:00:00",
    "posted_by": "bob",
  },
  {
    "_key": "alice:2",
    "comment": "@bob Welcome!!!",
    "last_modified": "2010/03/17 12:05:00",
    "replied_to": "bob:1",
    "replied_users": ["bob"],
    "posted_by": "alice",
  },
  {
    "_key": "bob:2",
    "comment": "@alice Thanks!",
    "last_modified": "2010/03/17 13:00:00",
    "replied_to": "alice:2",
    "replied_users": ["alice"],
    "posted_by": "bob",
  },
  {
    "_key": "bob:3",
    "comment": "I've just used 'Try-Groonga' now! #groonga",
    "last_modified": "2010/03/17 14:00:00",
    "hash_tags": ["groonga"],
    "location": "146566000x-266422000",
    "posted_by": "bob",
  },
  {
    "_key": "bob:4",
    "comment": "I'm come at city of New York for development camp! #groonga #travel",
    "last_modified": "2010/03/17 14:05:00",
    "hash_tags": ["groonga", "travel"],
    "location": "146566000x-266422000",
    "posted_by": "bob",
  },
  {
    "_key": "charlie:1",
    "comment": "@alice @bob I've tried to register!",
    "last_modified": "2010/03/17 15:00:00",
    "replied_users": ["alice", "bob"],
    "location": "146607190x-267021260",
    "posted_by": "charlie",
  }
  {
    "_key": "charlie:2",
    "comment": "I'm at the Museum of Modern Art in NY now!",
    "last_modified": "2010/03/17 15:05:00",
    "location": "146741340x-266319590",
    "posted_by": "charlie",
  }
]

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

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

Comments テーブルの last_modified カラムは、Time型です。

この型での値を指定する方法は2つあります。1つ目の方法は、1970年1月1日0時0分0秒からの経過秒数の値を直接指定する方法です。このとき、小数部分を指定することでマイクロ秒数での指定が可能です。指定した値は、データのロードの際にマイクロ秒を単位とする整数値に変換後、格納されます。 2つ目の方法は、文字列で日時と時刻を指定する方法です。"年/月/日 時:分:秒"というフォーマットで記述することで、データロードの際に文字列からキャストされ、マイクロ秒数の値が格納されます。

  検索

マイクロブログを検索してみましょう。

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

ここでは、 match_columns で扱った、複数カラムを対象とした検索を行います。

指定された文字列で、ユーザー名・現在地・自己紹介文を対象に検索をします。

実行例:

select --table Users --match_columns name,location_str,description --query "New York" --output_columns _key,name
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], true]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
# [[0, 1337566253.89858, 0.000355720520019531], 8]
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "name",
#           "ShortText"
#         ]
#       ],
#       [
#         "bob",
#         "Bob"
#       ]
#     ]
#   ]
# ]

「New York」をキーワードにユーザー検索した結果、New Yorkに住んでいる「Bob」がヒットしました。

  位置情報(GeoPoint)でユーザー検索

ここでは、GeoPoint型のカラムで検索をします。GeoPoint型については search を参照してください。

次の例では、特定の場所から20km以内に住んでいる人を検索します。

実行例:

select --table Users --filter 'geo_in_circle(location,"146710080x-266315480",20000)' --output_columns _key,name
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "name",
#           "ShortText"
#         ]
#       ],
#       [
#         "charlie",
#         "Charlie"
#       ],
#       [
#         "bob",
#         "Bob"
#       ]
#     ]
#   ]
# ]

「Bob」と「Charlie」が「Grand Central Terminal」から20km以内に住んでいることがわかります。

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

ここでは、 index の参照関係の逆引きをします。

次の例は、 Users テーブルの follower カラムにあるフォローリストを逆引きします。

実行例:

select --table Users --query follower:@bob --output_columns _key,name
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "name",
#           "ShortText"
#         ]
#       ],
#       [
#         "alice",
#         "Alice"
#       ],
#       [
#         "charlie",
#         "Charlie"
#       ]
#     ]
#   ]
# ]

「Alice」と「Charlie」が「Bob」をフォローしていることがわかります。

  GeoPointでコメント検索

ある範囲内で書かれたコメントを検索します。

また、 drilldown をおこないます。検索結果をハッシュタグとユーザーでドリルダウンし、ユーザー別・ハッシュタグ別のカウントを出します。

実行例:

select --table Comments --filter 'geo_in_circle(location,"146867000x-266280000",20000)' --output_columns posted_by.name,comment --drilldown hash_tags,posted_by
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "posted_by.name",
#           "ShortText"
#         ],
#         [
#           "comment",
#           "ShortText"
#         ]
#       ],
#       [
#         "Charlie",
#         "I'm at the Museum of Modern Art in NY now!"
#       ],
#       [
#         "Bob",
#         "I've just used 'Try-Groonga' now! #groonga"
#       ],
#       [
#         "Bob",
#         "I'm come at city of New York for development camp! #groonga #travel"
#       ],
#       [
#         "Charlie",
#         "@alice @bob I've tried to register!"
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "groonga",
#         2
#       ],
#       [
#         "travel",
#         1
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "charlie",
#         2
#       ],
#       [
#         "bob",
#         2
#       ]
#     ]
#   ]
# ]

このクエリは、ニューヨークのセントラルパークから20km圏内で投稿されたコメントを検索します。

指定した範囲が20kmなので、位置情報を含むすべてのコメントが検索されました。#groongaというハッシュタグが2件、#travelというハッシュタグが1件で、BobとCharlieがコメントしているのは2件あります。

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

あるキーワードを含むコメントを検索します。そして、 search で言及している _score を出してみます。

実行例:

select --table Comments --query comment:@Now --output_columns comment,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "comment",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "I've just used 'Try-Groonga' now! #groonga",
#         1
#       ],
#       [
#         "I'm at the Museum of Modern Art in NY now!",
#         1
#       ]
#     ]
#   ]
# ]

'Now'をキーワードに使っているので、このクエリは2件のコメントを返します。 _score の値として 'Now'のカウントを含んでいます。

  キーワードと位置情報で検索

あるキーワードと位置情報の両方でコメントを検索します。 --query と --filter オプションの両方を使用した場合、両方の条件に一致するレコードを返します。

実行例:

select --table Comments --query comment:@New --filter 'geo_in_circle(location,"146867000x-266280000",20000)' --output_columns posted_by.name,comment --drilldown hash_tags,posted_by
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "posted_by.name",
#           "ShortText"
#         ],
#         [
#           "comment",
#           "ShortText"
#         ]
#       ],
#       [
#         "Bob",
#         "I'm come at city of New York for development camp! #groonga #travel"
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "groonga",
#         1
#       ],
#       [
#         "travel",
#         1
#       ]
#     ],
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "bob",
#         1
#       ]
#     ]
#   ]
# ]

両方の条件をみたすコメントが1件あります。ドリルダウンの結果も含まれ、Bobによるコメントであることがわかります。

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

あるハッシュタグのついているコメントを検索します。テーブルの参照関係を逆にたどってみましょう。

実行例:

select --table Comments --query hash_tags:@groonga --output_columns posted_by.name,comment --drilldown posted_by
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "posted_by.name",
#           "ShortText"
#         ],
#         [
#           "comment",
#           "ShortText"
#         ]
#       ],
#       [
#         "Bob",
#         "I've just used 'Try-Groonga' now! #groonga"
#       ],
#       [
#         "Bob",
#         "I'm come at city of New York for development camp! #groonga #travel"
#       ]
#     ],
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "bob",
#         2
#       ]
#     ]
#   ]
# ]

このクエリは#groongaハッシュタグを含む2件のコメントを返します。投稿者のドリルダウン結果を2件含んでいて、Bobが投稿したことがわかります。

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

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

実行例:

select --table Comments --query posted_by:bob --output_columns comment --drilldown hash_tags
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "comment",
#           "ShortText"
#         ]
#       ],
#       [
#         "First post. test,test..."
#       ],
#       [
#         "@alice Thanks!"
#       ],
#       [
#         "I've just used 'Try-Groonga' now! #groonga"
#       ],
#       [
#         "I'm come at city of New York for development camp! #groonga #travel"
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "groonga",
#         2
#       ],
#       [
#         "travel",
#         1
#       ]
#     ]
#   ]
# ]

このクエリはBobによる4件のコメントを返します。ハッシュタグによるドリルダウン結果も含まれ、#groongaが2件、#travelが1件であることがわかります。

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

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

実行例:

select --table Users --query _key:bob --output_columns favorites.posted_by,favorites.comment
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "favorites.posted_by",
#           "Users"
#         ],
#         [
#           "favorites.comment",
#           "ShortText"
#         ]
#       ],
#       [
#         [
#           "alice",
#           "charlie"
#         ],
#         [
#           "I've created micro-blog!",
#           "@alice @bob I've tried to register!"
#         ]
#       ]
#     ]
#   ]
# ]

このクエリはBobのお気に入りのコメント一覧を返します。

  投稿時間でコメントを検索

コメントの投稿時間で検索をします。Time 型については data を参照してください。

ある時刻よりも古いコメントを検索します。

実行例:

select Comments --filter 'last_modified<=1268802000' --output_columns posted_by.name,comment,last_modified --drilldown hash_tags,posted_by
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "posted_by.name",
#           "ShortText"
#         ],
#         [
#           "comment",
#           "ShortText"
#         ],
#         [
#           "last_modified",
#           "Time"
#         ]
#       ],
#       [
#         "Alice",
#         "I've created micro-blog!",
#         1268795100.0
#       ],
#       [
#         "Bob",
#         "First post. test,test...",
#         1268794800.0
#       ],
#       [
#         "Alice",
#         "@bob Welcome!!!",
#         1268795100.0
#       ],
#       [
#         "Bob",
#         "@alice Thanks!",
#         1268798400.0
#       ],
#       [
#         "Bob",
#         "I've just used 'Try-Groonga' now! #groonga",
#         1268802000.0
#       ]
#     ],
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "groonga",
#         1
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "alice",
#         2
#       ],
#       [
#         "bob",
#         3
#       ]
#     ]
#   ]
# ]

このクエリは2010/03/17 14:00:00以前の5件のコメントを返します。投稿者によるドリルダウン結果も含まれ、Aliceが2件、Bobが3件であることがわかります。

  クエリ拡張

Groongaの /reference/commands/select コマンドは query_expander 引数を受付ます。これを使うとクエリ文字列を拡張することができます。

例えば、"theater"ではなく"theatre"で検索したとしましょう。クエリ拡張では"theater OR theatre"の結果を返します。このようなやりかたで検索漏れを減らせます。これはユーザーが本当にやりたかったことです。

  準備

クエリ拡張を使うには、文書を格納するテーブルと検索文字列と置換文字列のペアを格納する置換テーブルを作る必要があります。置換テーブルでは主キーが元の文字列、ShortText型のカラムが置換後の文字列をあらわします。

それでは文書テーブルと置換テーブルを作成しましょう。

実行例:

table_create Doc TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Doc body COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Term TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Term Doc_body COLUMN_INDEX|WITH_POSITION Doc body
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Synonym TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Synonym body COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Doc
[
{"_key": "001", "body": "Play all night in this theater."},
{"_key": "002", "body": "theatre is British spelling."},
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
load --table Synonym
[
{"_key": "theater", "body": "(theater OR theatre)"},
{"_key": "theatre", "body": "(theater OR theatre)"},
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

このようにすると、検索漏れは起こりません。これは置換テーブルがクエリ文字列として"theater"も"theatre"のいずれも受け付けるからです。

  検索

では、準備した置換テーブルを使ってみます。まずは query_expander を使わずに select コマンドを実行してみましょう。

実行例:

select Doc --match_columns body --query "theater"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "body",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "001",
#         "Play all night in this theater."
#       ]
#     ]
#   ]
# ]
select Doc --match_columns body --query "theatre"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "body",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "002",
#         "theatre is British spelling."
#       ]
#     ]
#   ]
# ]

このクエリではクエリ文字列に完全に一致するレコードを返します。

では、 query_expander を Synonym テーブルの body カラムに対して使ってみましょう。

実行例:

select Doc --match_columns body --query "theater" --query_expander Synonym.body
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "body",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "001",
#         "Play all night in this theater."
#       ],
#       [
#         2,
#         "002",
#         "theatre is British spelling."
#       ]
#     ]
#   ]
# ]
select Doc --match_columns body --query "theatre" --query_expander Synonym.body
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "body",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "001",
#         "Play all night in this theater."
#       ],
#       [
#         2,
#         "002",
#         "theatre is British spelling."
#       ]
#     ]
#   ]
# ]

この場合、クエリ文字列は "theater OR theatre" へと置き換えられます。つまり、検索時に表記揺れを考慮して検索できます。

サーバー

  サーバーパッケージ

groonga パッケージは全文検索を行うための最小構成のパッケージです。サーバー用途で使うために、設定済みのパッケージを追加でインストールすることができます。

サーバー用途の2つのパッケージがあります。

•   groonga-httpd (nginxをベースにしたHTTPサーバー)

•   groonga-server-gqtp (/spec/gqtp サーバー)

    groongaがGQTPだけでなく、2つのHTTPサーバーパッケージをサポートしているのには理由があります。 /spec/gqtp - Groonga Query Transfer Protocol はオーバーヘッドを低減し、パフォーマンスを向上させるように設計されていますが、HTTPプロトコルほどクライアントライブラリのサポートがありません。HTTPは枯れたプロトコルなので既存のツールを活用できたり、多くのクライアントライブラリが存在します。(詳細は 関連プロジェクト を参照) groonga-httpd パッケージを使うと nginxの機能の恩恵を受けることができます。

    最初は groonga-httpd パッケージを使うことをおすすめします。プロトコルのオーバーヘッドがパフォーマンス上問題となったら groonga-server-gqtp を検討してください。

    注釈: In the previous versions, there is a groonga-server-http package (simple HTTP protocol based server package). It is now marked as obsolete, please use groonga-httpd packages instead. groonga-server-http package became a transitional package for groonga-httpd.

  groonga-httpd

groonga-httpd はnginxをベースにしたHTTPサーバーパッケージです。

設定済みの内容:
項目 | 既定値
ポート番号 | 10041
アクセスログ | /var/log/groonga/httpd/acccess.log
エラーログ | /var/log/groonga/http-query.log
データベース | /var/lib/groonga/db/*
設定ファイル | /etc/groonga/httpd/groonga-httpd.conf

  HTTPサーバーを起動

groonga HTTPサーバーを起動(Debian/Ubuntu/CentOS):

% sudo service groonga-httpd start

groonga HTTPサーバーを起動(Fedora):

% sudo systemctl start groonga-httpd

  HTTPサーバーを終了

groonga HTTPサーバーを終了(Debian/Ubuntu/CentOS):

% sudo service groonga-httpd stop

groonga HTTPサーバーを起動(Fedora):

% sudo systemctl stop groonga-httpd

  HTTPサーバーを再起動

groonga HTTPサーバーを再起動(Debian/Ubuntu/CentOS):

% sudo service groonga-httpd restart

groonga HTTPサーバーを再起動(Fedora):

% sudo systemctl restart groonga-httpd

  groonga-server-gqtp

groonga-server-gqtp は /spec/gqtp サーバーパッケージです。
項目 | 既定値
ポート番号 | 10043
process-log | /var/log/groonga/groonga-gqtp.log
query-log | /var/log/groonga/gqtp-query.log
データベース | /var/lib/groonga/db/*

サーバー設定ファイル (Debian/Ubuntu):

/etc/default/groonga/groonga-server-gqtp

サーバー設定ファイル(CentOS):

/etc/sysconfig/groonga-server-gqtp

  GQTPサーバーを起動

groonga GQTPサーバーを起動(Debian/Ubuntu/CentOS):

% sudo service groonga-server-gqtp start

groonga GQTPサーバーを起動(Fedora):

% sudo systemctl start groonga-server-gqtp

  GQTPサーバーを終了

groonga GQTPサーバーを終了(Debian/Ubuntu/CentOS):

% sudo service groonga-server-http stop

groonga GQTPサーバーを終了(Fedora):

% sudo systemctl stop groonga-server-gqtp

  GQTPサーバーを再起動

groonga HTTPサーバーを再起動(Debian/Ubuntu/CentOS):

% sudo service groonga-server-gqtp restart

groonga HTTPサーバーを再起動(Fedora):

% sudo systemctl restart groonga-server-gqtp

  groonga-server-http

groonga-server-http は簡易HTTPサーバーパッケージです。

注釈: groonga-server-http package is the transitional package since Groonga 4.0.8. Please use groonga-httpd instead.

設定済みの内容:
項目 | 既定値
ポート番号 | 10041
process-log | /var/log/groonga/groonga-http.log
query-log | /var/log/groonga/http-query.log
データベース | /var/lib/groonga/db/*

サーバー設定ファイル (Debian/Ubuntu):

/etc/default/groonga/groonga-server-http

サーバー設定ファイル(CentOS):

/etc/sysconfig/groonga-server-http

  HTTPサーバーを起動

groonga HTTPサーバーを起動(Debian/Ubuntu/CentOS):

% sudo service groonga-server-http start

groonga HTTPサーバーを起動(Fedora):

% sudo systemctl start groonga-server-http

  HTTPサーバーを終了

groonga HTTPサーバーを終了(Debian/Ubuntu/CentOS):

% sudo service groonga-server-http stop

groonga HTTPサーバーを終了(Fedora):

% sudo systemctl stop groonga-server-http

  HTTPサーバーを再起動

groonga HTTPサーバーを再起動(Debian/Ubuntu/CentOS):

% sudo service groonga-server-http restart

groonga HTTPサーバーを再起動(Fedora):

% sudo systemctl restart groonga-server-http

  HTTP

Groongaは2つのHTTPサーバー実装を提供しています。

•   http/groonga

•   http/groonga-httpd

    http/groonga はシンプルな実装です。高速に動作しますがHTTPの機能の多くは実装されていません。コマンドラインオプションをいくつか指定するだけで動くのでGroongaを簡単に試すことができます。

    http/groonga-httpd は nginx をベースにした実装です。この実装も高速に動作します。しかも多くのHTTPの機能を使えます。

  比較

groonga と groonga-httpd にはたくさんの違いがあります。以下はそれらの違いを示す比較表です。
 | groonga | groonga-httpd
性能 | ○ | ○
複数CPUコア対応 | ○（マルチスレッドで対応） | ○（マルチプロセスで対応）
設定ファイル | なくてもよい | 必須
プレフィックスパスの変更 | × | ○
コマンドバージョンの変更 | ○ | ○
複数データベース | × | ○
認証 | × | ○
gzip圧縮 | × | ○
POST | ○ | ○
HTTPS | × | ○
アクセスログ | × | ○
ダウンタイムなしでのアップグレード | × | ○

  性能

groonga と groonga-httpd はどちらも非常に高速です。どちらも同じスループットで動きます。

  複数CPUコア対応

Groongaは複数のCPUコアを使って性能を向上できます。 groonga はマルチスレッドを使って性能を向上させます。 groonga-httpd はマルチプロセスを使って性能を向上させます。

groonga はデフォルトでCPUコアと同じ数のスレッドを使います。もし、CPUコアが8個あった場合は、デフォルトで8個のスレッドを使います。

groonga-httpd はデフォルトで1つのプロセスを使います。複数のCPUコアを使う場合は worker_processes ディレクティブを設定する必要があります。CPUコアが8個ある場合は、以下のように設定ファイルに worker_processes 8 と指定します。:

worker_processes 8;
http {
  # ...
}

  設定ファイル

groonga は設定ファイルがなくても動きます。ポート番号や最大スレッド数などといった設定項目はすべてコマンドラインから指定できます。設定ファイルを使っても設定項目を指定することができます。

groonga はいくつかのオプションを指定するだけで実行できるので、非常に簡単にgroonga用のHTTPサーバーを起動することができます。以下は groonga でHTTPサーバーを起動する一番簡単なコマンドラインです。:

% groonga --protocol http -d /PATH/TO/DATABASE

groonga-httpd を実行するには設定ファイルが必須です。以下は groonga-httpd でHTTPサーバーを実行する一番簡単な設定ファイルです。:

events {
}
http {
  server {
    listen 10041;
    location /d/ {
      groonga on;
      groonga_database /PATH/TO/DATABASE;
    }
  }
}

  プレフィックスパスの変更

groonga は /d/ から始まるパスをコマンドURLとして受け付けます。例えば、 http://localhost:10041/d/status となります。この /d/ というプレフィックスパスを変更することはできません。

groonga-httpd はプレフィックスパスを変更することができます。例えば、 http://localhost:10041/api/status というコマンドURLを使うことができます。以下は /api/ をプレフィックスパスとして使う設定例です。:

events {
}
http {
  server {
    listen 10041;
    location /api/ { # <- change this
      groonga on;
      groonga_database /PATH/TO/DATABASE;
    }
  }
}

  コマンドバージョンの変更

Groongaには /reference/command/command_version という仕組みがあります。これは後方互換性を維持したままgroongaコマンドをアップグレードするための仕組みです。

groonga は --default-command-version オプションでデフォルトのコマンドバージョンを変更できます。以下はデフォルトのコマンドバージョンとしてコマンドバージョン2を使うコマンドライン例です。:

% groonga --protocol http --default-command-version 2 -d /PATH/TO/DATABASE

groonga-httpd はまだデフォルトのコマンドバージョンを変更できません。しかし、すぐにサポートする予定です。サポートされたら、同じ groonga-httpd プロセス内で異なったコマンドバージョンのgroongaコマンドを提供できます。以下はコマンドバージョン1のコマンドを /api/1/ 以下で、コマンドバージョン2のコマンドを /api/2/ 以下で提供するための設定例です。:

events {
}
http {
  server {
    listen 10041;
    groonga_database /PATH/TO/DATABASE;
    location /api/1/ {
      groonga on;
      groogna_default_command_version 1;
    }
    location /api/2/ {
      groonga on;
      groogna_default_command_version 2;
    }
  }
}

  複数データベース

groonga は1つのプロセスで1つのデータベースしか使うことができません。

groonga-httpd は同一プロセス内で複数のデータベースを使うことができます。以下は /tmp/db1 にあるデータベースを /db1/ 以下で、 /tmp/db2 にあるデータベースを /db2/ 以下で提供する設定例です。:

events {
}
http {
  server {
    listen 10041;
    location /db1/ {
      groonga on;
      groonga_database /tmp/db1;
    }
    location /db2/ {
      groonga on;
      groonga_database /tmp/db2;
    }
  }
}

  認証

HTTPではベーシック認証やダイジェスト認証などの認証方法をサポートしています。認証することにより /reference/commands/shutdown などのように危険なコマンドの実行を制限することができます。

groonga では認証できません。危険なコマンドの使用を制限するためには、iptablesやリバースプロキシなど他のツールを使う必要があります。

groonga-httpd はベーシック認証をサポートしています。以下は /reference/commands/shutdown コマンドの使用を制限する設定例です。:

events {
}
http {
  server {
    listen 10041;
    groonga_database /PATH/TO/DATABASE;
    location /d/shutdown {
      groonga on;
      auth_basic           "manager is required!";
      auth_basic_user_file "/etc/managers.htpasswd";
    }
    location /d/ {
      groonga on;
    }
  }
}

  gzip圧縮

HTTPは Content-Encoding: gzip レスポンスヘッダーを付けてgzipでレスポンスを圧縮する機能をサポートしています。これはネットワーク流量を小さくすることができます。大きな検索結果を返すときに有用です。

groonga は圧縮をサポートしていません。圧縮をサポートするためには、リバースプロキシを使う必要があります。

groonga-httpd はgzip圧縮をサポートしています。以下はレスポンスをgzipで圧縮する設定例です。:

events {
}
http {
  server {
    listen 10041;
    groonga_database /PATH/TO/DATABASE;
    location /d/ {
      groonga    on;
      gzip       on;
      gzip_types *;
    }
  }
}

gzip_types * を指定していることに注意してください。この設定はとても重要な設定です。 gzip_types はgzip対象のデータフォーマットをMIMEタイプで指定します。 groonga-httpd は JSON、XML、MessagePackのどれかのフォーマットでデータを返します。しかし、これらのフォーマットは gzip_types のデフォルト値に含まれていません。 gzip_types のデフォルト値は text/html です。

groonga-httpd のレスポンスデータをgzip圧縮するには、明示的に gzip_types * または gzip_types application/json text/xml application/x-msgpack と指定する必要があります。 gzip_types * の方がおすすめです。理由は2つあります。1つは、groongaが、将来、他のフォーマットもサポートする可能性もあるからという理由です。2つめは、この location のすべてのリクエストはgroongaが処理するので、他のモジュールのことについて考えなくてもよいからという理由です。

  POST

JSONデータをPOSTすることでデータをロードすることができます。POSTでロードする場合は以下のルールに従ってください。

•   Content-Type ヘッダーの値を application/json にする。

•   JSONデータはbodyとして送る。

•   テーブル名は table=名前 というようにクエリーパラメーターで指定する。

    以下はcurlを使って alice と bob という2人のユーザーを Users テーブルにロードするコマンドラインの例です:

    % curl --data-binary '[{"_key": "alice"}, {"_key": "bob"}]' -H "Content-Type: application/json" "http://localhost:10041/d/load?table=Users"

  HTTPS

TODO

  アクセスログ

TODO

  ダウンタイムなしでのアップグレード

TODO

  groonga

TODO

  groonga-httpd

TODO

  GQTP

  Summary

GQTP is the acronym standing for "Groonga Query Transfer Protocol".

GQTP is a protocol designed for Groonga. It's a stateful protocol. You can send multiple commands in one session.

GQTP will be faster rather than /server/http when you send many light commands like /reference/commands/status. GQTP will be almost same performance as HTTP when you send heavy commands like /reference/commands/select.

We recommend that you use HTTP for many cases. Because there are many HTTP client libraries.

If you want to use GQTP, you can use the following libraries:

•   Ruby: groonga-client

•   Python: poyonga

•   Go: goroo

•   PHP: proonga

•   C/C++: Groonga (Groonga can be also used as library)

    ライブラリではありませんが、/reference/executables/groonga をGQTPクライアントとして使えます。

  How to run

/reference/executables/groonga is a GQTP server implementation. You can run a Groonga server by the following command line:

groonga --protocol gqtp -s [options] DB_PATH

You can run a Groonga server as a daemon by the following command line:

groonga --protocol gqtp -d [options] DB_PATH

利用可能なオプションについては、 /reference/executables/groonga を参照してください。

  Memcachedバイナリプロトコル

Groongaはmemcachedバイナリプロトコルをサポートしています。以下の書式はmemcachedバイナリプロトコルのサーバをデーモンとして起動する方法を示しています。

Form:

groonga [-p PORT_NUMBER] -d --protocol memcached DB_PATH

--protocol オプションとその引数により、サーバのプロトコルを指定することができます。"memcached"はmemcachedバイナリプロトコルを示しています。

テーブルの作成は不要です。Groongaは要求を受けつけると自動的にテーブルを作成するからです。テーブルの名前は Memcache になります。

クライアント

Groongaは、Groongaの専用プロトコルである /spec/gqtp 、memcachedバイナリプロトコル、HTTPの三種類をサポートしています。

HTTPとmemcachedバイナリプロトコルは、枯れたプロトコルなので既存のクライアントライブラリを利用することができます。

いくつかのプログラミング言語ではGroongaサーバーに接続するための便利なAPIを提供するクライアントライブラリがあります。詳細は、クライアントライブラリ を参照して下さい。

リファレンスマニュアル

  実行ファイル

groongaパッケージが提供する実行ファイルについて説明します。

  grndb

  概要

注釈: この実行ファイルは実験的な機能です。

バージョン 4.0.9 で追加.

grndb はGroongaのデータベースを管理します。

機能は次の通りです。

•   データベースが壊れているかどうかをチェックする。

•   壊れたデータベースが復旧可能なら自動でデータベースを復旧する。

  構文

grndb にはコマンドとデータベースのパスを渡します。:

grndb COMMAND [OPTIONS] DATABASE_PATH

利用可能なコマンドは以下の通りです。

•   check - データベースが壊れているかどうかをチェックします。

•   recover - データベースを復旧します。

  使い方

以下は /var/lib/groonga/db/db にあるデータベースをチェックする例です:

% grndb check /var/lib/groonga/db/db

以下は /var/lib/groonga/db/db にあるデータベースを復旧する例です:

% grndb recover /var/lib/groonga/db/db

  コマンド一覧

このセクションでは利用可能なコマンドについて説明します。

  check

既存のGroongaデータベースをチェックします。もし、データベースが壊れていたら grndb は詳細を報告し、 0 以外の終了ステータスで終了します。

注釈: このコマンドを他のプロセスが開いているデータベースに対しては使ってはいけません。もし、データベースが他のプロセスから開かれていると、このコマンドは間違った結果を報告する可能性があります。

check にはいくつかオプションがあります。

  --target

バージョン 5.1.2 で追加.

チェック対象のオブジェクトを指定します。

もし、データベースが大きく、かつ、信頼できないオブジェクトがわかっているなら、このオプションが役に立つでしょう。 check は大きなデータベースほど処理に時間がかかります。 --target オプションでチェック対象を限定することでチェック時間を削減できます。

check はチェック対象を再帰的にチェックします。なぜなら、信頼できないオブジェクトに関連するオブジェクトも信頼できないことが多いからです。

チェック対象がテーブルの場合、そのテーブルのすべてのカラムも再帰的にチェックします。

チェック対象がテーブルでテーブルのキーの型が他のテーブルの場合、他のテーブルも再帰的にチェックします。

チェック対象がカラムで値の型がテーブルの場合、そのテーブルも再帰的にチェックします。

チェック対象がインデックスカラムの場合、値の型に指定したテーブルとすべてのソースも再帰的にチェックします。

以下は Entries テーブルとそのカラムだけをチェックする例です。:

% grndb check --target Entries /var/lib/groonga/db/db

以下は Entries.name カラムだけをチェックする例です。:

% grndb check --target Entries.name /var/lib/groonga/db/db

  recover

既存の壊れたGroongaデータベースを復旧します。

もしデータベースが壊れていなかったら、 grndb は何もせず終了ステータス 0 で終了します。

もしデータベースが壊れていて、壊れているのがインデックスカラムだけなら、 grndb は壊れているインデックスカラムを復旧して終了ステータス 0 で終了します。インデックス対象のデータが大きい場合は復旧に長時間かかることもあります。

もしデータベースが壊れていて、壊れているのがテーブルまたはデータカラムの場合は、 grndb は壊れている原因を報告して 0 以外の終了ステータスで終了します。データベースを復旧可能かどうかは check コマンドで確認できます。

注釈: このコマンドを他のプロセスが開いているデータベースに対しては使ってはいけません。もし、データベースが他のプロセスから開かれていると、このコマンドはデータベースを壊してしまう可能性があります。

  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

  groonga executable file

  概要

groonga 実行ファイルは以下の機能を提供します。:

•   全文検索(サーバー)

•   全文検索(シェル)

•   Client for Groonga fulltext search server

    Groonga can be used as a library. If you want to use Groonga as a library, you need to write a program in C, C++ and so on. Library use is useful for embedding fulltext search feature to your application, but it's not easy to use.

    You can use groonga executable file to get fulltext search feature.

    If you want to try Groonga, fulltext search shell usage is useful. You don't need any server and client. You just need one terminal. You can try Groonga like the following:

    % groonga -n db
    > status
    [[0,1429687763.70845,0.000115633010864258],{"alloc_count":195,...}]
    > quit
    %

    If you want to create an application that has fulltext search feature, fulltext search server usage is useful. You can use Groonga as a server like RDBMS (Relational DataBase Management System). Client-server model is a popular architecture.

    Normally, client for Groonga fulltext server usage isn't used.

  構文

groonga 実行ファイルには以下の4つのモードがあります。

•   Standalone mode

•   Server mode

•   Daemon mode

•   Client mode

    There are common options in these modes. These common options is described later section.

  Standalone mode

In standalone mode, groonga executable file runs one or more Groonga /reference/command against a local Groonga database.

Here is the syntax to run shell that executes Groonga command against temporary database:

groonga [options]

Here is the syntax to create a new database and run shell that executes Groonga command against the new database:

groonga [options] -n DB_PATH

Here is the syntax to run shell that executes Groonga command against existing database:

groonga [options] DB_PATH

Here is the syntax to run Groonga command against existing database and exit:

groonga [options] DB_PATH COMMAND [command arguments]

  Server mode

In server mode, groonga executable file runs as a server. The server accepts connections from other processes at local machine or remote machine and executes received Groonga /reference/command against a local Groonga database.

You can choose one protocol from /server/http and /server/gqtp. Normally, HTTP is suitable but GQTP is the default protocol. This section describes only about HTTP protocol usage.

In server mode, groonga executable file runs in the foreground. If you want to run Groonga server in the background, see Daemon mode.

Here is the syntax to run Groonga server with temporary database:

groonga [options] --protocol http -s

Here is the syntax to create a new database and run Groonga server with the new database:

groonga [options] --protocol http -s -n DB_PATH

Here is the syntax to run Groonga server with existing database:

groonga [options] --protocol http -s DB_PATH

  Daemon mode

In daemon mode, groonga executable file runs as a daemon. Daemon is similar to server but it runs in the background. See Server mode about server.

Here is the syntax to run Groonga daemon with temporary database:

groonga [options] --protocol http -d

Here is the syntax to create a new database and run Groonga daemon with the new database:

groonga [options] --protocol http -d -n DB_PATH

Here is the syntax to run Groonga daemon with existing database:

groonga [options] --protocol http -d DB_PATH

--pid-path option will be useful for daemon mode.

  Client mode

In client mode, groonga executable file runs as a client for GQTP protocol Groonga server. Its usage is similar to Standalone mode. You can run shell and execute one command. You need to specify server address instead of local database.

Note that you can use groonga executable file as a client for HTTP protocol Groonga server.

Here is the syntax to run shell that executes Groonga command against Groonga server that is running at 192.168.0.1:10043:

groonga [options] -c --host 192.168.0.1 --port 10043

Here is the syntax to run Groonga command against Groonga server that is running at 192.168.0.1:10043 and exit:

groonga [options] -c --host 192.168.0.1 --port 10043 COMMAND [command arguments]

  Options

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

-c  Executes groonga command in client mode.

-s  Executes groonga command in server mode. Use "Ctrl+C" to stop the groonga process.

-d  Executes groonga command in daemon mode. In contrast to server mode, groonga command forks in daemon mode. For example, to stop local daemon process, use "curl http://127.0.0.1:10041/d/shutdown".

-e, --encoding <encoding>
    Specifies encoding which is used for Groonga database. This option is effective when you create new Groonga database. This parameter specifies one of the following values: none, euc, utf8, sjis, latin or koi8r.

-l, --log-level <log level>
    Specifies log level. A integer value between 0 and 8. The meaning of value is:
    log level | 説明
    0 | なし
    1 | Emergency
    2 | Alert
    3 | Critical
    4 | Error
    5 | Warning
    6 | Notice
    7 | Info
    8 | Debug

-a, --address <ip/hostname>
    バージョン 1.2.2 で撤廃: Use --bind-address instead.

--bind-address <ip/hostname>
    バージョン 1.2.2 で追加.

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

-p, --port <port number>
    クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。 (クライアントモードのデフォルトは10043番、サーバ、またはデーモンモードのデフォルトは、HTTPの場合、10041番、GQTPの場合、10043番)

-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です)

--log-rotate-threshold-size <threshold>
    バージョン 5.0.3 で追加.

    ログローテーションの閾値を指定します。ログファイルのサイズが閾値に指定した値以上になると、ローテートされます。（デフォルトは0（無効）です）

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

--query-log-rotate-threshold-size <threshold>
    バージョン 5.0.3 で追加.

    クエリーログのローテーションの閾値を指定します。クエリーログファイルのサイズが閾値に指定した値以上になると、ローテートされます。（デフォルトは0（無効）です）

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

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

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

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

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

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

  コマンドライン引数

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

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

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

  コマンド

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

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

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

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

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

'\'文字で継続行であることを明示してコマンドリストを記述することができます。

table_create --name Terms \
             --flags TABLE_PAT_KEY \
             --key_type ShortText \
             --default_tokenizer TokenBigram

  組み込みコマンド

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

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

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

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

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

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

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

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

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]]]
%

  groonga-benchmark

  名前

groonga-benchmark - groongaテストプログラム

  書式

groonga-benchmark  [options...] [script] [db]

  説明

groonga-benchmarkは、groonga汎用ベンチマークツールです。

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

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

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

  オプション

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

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

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

--ftp
    ftp.groonga.orgとFTP通信を行い、scriptファイルの同期やログファイルの送信を行います。

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

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

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

  引数

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

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

  使い方

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

groonga-benchmark test.scr 任意のDB名

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

test-ユーザ名-数字.log

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

  スクリプトファイル

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

  groonga-benchmark命令

現在サポートされているgroonga-benchmark命令は以下の11種類です。 do_local コマンドファイル [スレッド数] [繰り返し数] コマンドファイルをgroonga-benchmark単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。

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

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

rep_local コマンドファイル [スレッド数] [繰り返し数] コマンドファイルをgroonga-benchmark単体で実行し、より詳細な報告を行います。

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

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

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

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

とした場合と同じです。

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

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

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

  コマンドファイル

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

  サンプル

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

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

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

1行目 コメント行。

2行目 test.ddl というコマンドファイルをgroonga単体で実行し、詳細に報告する。

3行目 test.load というコマンドファイルをgroonga単体で実行する。(最後の";"セミコロンは複数のgroonga-benchmark命令を記述する場合に必要ですが、この例のように1つのgroonga-benchmark命令を実行する場合に付与しても問題ありません。)

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が優先されます。

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

    例えば、

    $ ./groonga-benchmark --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を利用します。

  groonga-benchmark実行結果

groonga-benchmarkが正常に終了すると、(拡張子を除いた)スクリプト名-ユーザ名-実行開始時刻.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}]

  制限事項

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

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

  トラブルシューティング

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

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

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

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

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

  groonga-httpd

  概要

groonga-httpdはGroongaサーバーとHTTPプロトコルで通信するプログラムです。 機能的には、 groonga-server-http と同じです。 groonga-server-http はHTTPサーバーとしては最小限の機能しか持ちませんが、groonga-httpdは nginx を組み込むことでnginxが準拠しているHTTPの仕様と機能をすべて利用できます。

groonga-httpdにはHTML + JavaScriptで実装された管理ツールが標準で付属しています。ウェブブラウザでhttp://hostname:port/にアクセスすると、管理ツールを利用できます。

  書式

groonga-httpd [nginx options]

  使い方

  設定をする

まずは、データベースを指定するためにgroonga-httpdの設定ファイルを編集する必要があります。次のように/etc/groonga/httpd/groonga-httpd.confを編集して groonga_database ディレクティブを有効にしてます。

# Match this to the file owner of groonga database files if groonga-httpd is
# run as root.
#user groonga;
...
http {
  ...
  # Don't change the location; currently only /d/ is supported.
  location /d/ {
    groonga on; # <= This means to turn on groonga-httpd.
    # Specify an actual database and enable this.
    groonga_database /var/lib/groonga/db/db;
  }
  ...
}

次に、groonga-httpdを実行してください。すぐにターミナルに制御が戻ってきます。これはgroonga-httpdはデフォルトでデーモンプロセスになるからです。

% groonga-httpd

  クエリーを実行する

動作を確認するため、簡単なクエリー（ /reference/commands/status ）をリクエストしてみます。

実行例:

% curl http://localhost:10041/d/status
[
  [
    0,
    1337566253.89858,
    0.000355720520019531
  ],
  {
    "uptime": 0,
    "max_command_version": 2,
    "n_queries": 0,
    "cache_hit_rate": 0.0,
    "version": "4.0.1",
    "alloc_count": 161,
    "command_version": 1,
    "starttime": 1395806036,
    "default_command_version": 1
  }
]

  POSTでのデータロード

JSONデータをPOSTするとデータをロードできます。

Users テーブルに alice と bob ユーザーをロードする curl のコマンドライン例は次の通りです:

% curl --data-binary '[{"_key": "alice"}, {"_key": "bob"}]' -H "Content-Type: application/json" "http://localhost:10041/d/load?table=Users"

JSONファイルからユーザーをロードする場合は、次のようなJSONファイルを準備します:

[
{"_key": "alice"},
{"_key": "bob"}
]

それから curl のコマンドラインでJSONファイルを指定します:

% curl -X POST 'http://localhost:10041/d/load?table=Users' -H 'Content-Type: application/json' -d @users.json

  管理ツールを使う

補足ですが、 http://localhost:10041/ にアクセスすると管理ツールを利用できます。

  終了する

最後に、次のコマンドで動作中のgroonga-httpdデーモンを終了できます。

% groonga-httpd -s stop

  設定ディレクティブ

このセクションでは重要なディレクティブのみ説明します。重要なディレクティブとはgroonga-http特有のディレクティブと性能に関するディレクティブです。

以下のディレクティブはgroonga-httpdの設定ファイル中で使用することができます。デフォルトでは、設定ファイルは/etc/groonga/httpd/groonga-httpd.confに置かれています。

  groonga-httpd特有のディレクティブ

以下のディレクティブはnginxが提供しているものではなく、groonga-httpd関連の設定をするためにgroonga-httpdが提供しているディレクティブです。

  groonga

書式:

groonga on | off;

Default
    groonga off;

Context
    location

    この location ブロックでGroongaを使うかどうかを指定します。デフォルトは off です。Groongaを使うためには on を指定してください。

    例:

    location /d/ {
      groonga on;  # Enables groonga under /d/... path
    }
    location /d/ {
      groonga off; # Disables groonga under /d/... path
    }

  groonga_database

書式:

groonga_database /path/to/groonga/database;

Default
    groonga_database /usr/local/var/lib/groonga/db/db;

Context
    http, server, location

    Groongaデータベースのパスを指定します。このディレクティブは必須です。

  groonga_database_auto_create

書式:

groonga_database_auto_create on | off;

Default
    groonga_database_auto_create on;

Context
    http, server, location

    Groongaのデータベースを自動で作成するかどうかを指定します。もし、この値が on で groonga_database に指定したGroongaのデータベースが存在しない場合は自動でGroongaのデータベースを作成します。Groongaのデータベースが存在している場合は何もしません。

    もし、親ディレクトリが存在しな場合は再帰的に親ディレクトリも作成します。

    デフォルト値は on です。通常、この値を変更する必要はありません。

  groonga_base_path

書式:

groonga_base_path /d/;

Default
    location の名前と同じ値。

Context
    location

    URIのベースパスを指定します。Groongaは command を実行するために /d/command?parameter1=value1&... というパスを使います。groonga-httpdでもこのパスの形式を使いますが、groonga-httpdは /other-prefix/command?parameter1=value1&... というように /d/ ではなく別のプレフィックスを使った形式もサポートしています。この別の形式もサポートするために、groonga-httpdはリクエストURIの先頭からベースパスを削除し、先頭に /d/ を追加します。このパスの変換をすることにより、ユーザーはプレフィックスをカスタムできるようになりますが、Groongaは常に /d/command?parameter1=value1&... という形式で処理できます。

    通常、このディレクティブを使う必要はありません。このディレクティブはコマンド毎に設定をしたい場合に使います。

    以下は /reference/commands/shutdown コマンドに認証をかける設定例です。:

    groonga_database /var/lib/groonga/db/db;
    location /d/shutdown {
      groonga on;
      # groonga_base_path is needed.
      # Because /d/shutdown is handled as the base path.
      # Without this configuration, /d/shutdown/shutdown path is required
      # to run shutdown command.
      groonga_base_path /d/;
      auth_basic           "manager is required!";
      auth_basic_user_file "/etc/managers.htpasswd";
    }
    location /d/ {
      groonga on;
      # groonga_base_path doesn't needed.
      # Because location name is the base path.
    }

  groonga_log_path

書式:

groonga_log_path path | off;

Default
    /var/log/groonga/httpd/groonga.log

Context
    http, server, location

    Groongaのログ保存先を http 、server もしくは location ブロックで指定します。デフォルトは /var/log/groonga/httpd/groonga.log です。ログを無効にするには off を指定します。

    例:

    location /d/ {
      groonga on;
      # You can disable log for groonga.
      groonga_log_path off;
    }

  groonga_log_level

書式:

groonga_log_level none | emergency | alert | ciritical | error | warning | notice | info | debug | dump;

Default
    notice

Context
    http, server, location

    Groongaのログレベルを http 、 server もしくは location ブロックで指定します。デフォルトは notice です。 none を指定することでログを無効にできます。

    例:

    location /d/ {
      groonga on;
      # You can customize log level for groonga.
      groonga_log_level notice;
    }

  groonga_query_log_path

書式:

groonga_query_log_path path | off;

Default
    /var/log/groonga/httpd/groonga-query.log

Context
    http, server, location

    Groongaのクエリーログの保存先を http 、server もしくは location ブロックで指定します。デフォルトは /var/log/groonga/httpd/groonga-query.log です。ログを無効にするには off を指定します。

    例:

    location /d/ {
      groonga on;
      # You can disable query log for groonga.
      groonga_query_log_path off;
    }

    クエリーログは以下のようなケースで有用です:

•   スロークエリーを見つける。

•   デバッグ。

    groonga-query-log パッケージ でクエリーログを解析できます。このパッケージは有用なツールを提供しています。

    例えば、クエリーログを解析するツールがあります。これを使えば、スロークエリーを見つけることができます。クエリーログ内のすべてのクエリーを再生するツールもあります。これを使えば、新しいGroongaをプロダクション環境にデプロイする前に網羅的にテストすることができます。

  性能関連のディレクティブ

以下のディレクティブはgronoga-httpdの性能に関連しているディレクティブです。

  worker_processes

最適なパフォーマンスを得るためには、CPU数あるいはコア数と同じ数になるようにこのディレクティブを設定してください。大抵の場合、GroongaのクエリーはCPU負荷が高いものとなり、複数のCPU/コアを使い切るためには、このディレクティブを設定する必要があります。

このディレクティブはgroonga-httpdのディレクティブではなく、nginxのディレクティブです。詳細は、 http://wiki.nginx.org/CoreModule#worker_processes を参照してください。

デフォルトで、このディレクティブには1が設定されています。

  groonga_cache_limit

This directive is introduced to customize cache limit for each worker process.

書式:

groonga_cache_limit CACHE_LIMIT;

Default
    100

Context
    http, server, location

    Groongaのクエリキャッシュの制限を http 、 server もしくは location ブロックで指定します。デフォルトは 100 です。 0 を指定することで groonga_cache_limit を明示的に無効にできます。

    例:

    location /d/ {
      groonga on;
      # You can customize query cache limit for groonga.
      groonga_cache_limit 100;
    }

  proxy_cache

まとめると、Groonga組み込みのクエリーキャッシュ機能の代わりにnginxのリバースプロキシとキャッシュの仕組みを使うこともできます。

  クエリーキャッシュ

groongaは /reference/commands/select コマンド用にクエリーキャッシュ機能を提供しています。この機能は多くのケースで性能向上を実現します。

クエリーキャッシュ機能は /reference/commands/cache_limit コマンドを使っていないあるいはワーカー数が1だけの場合はgroonga-httpd上でもきちんと動作します。通常、 /reference/commands/cache_limit コマンドは使わないので、多くの場合は問題がありません。

2ワーカー以上で /reference/commands/cache_limit コマンドを使ったときの問題点を説明します。

groongaのクエリーキャッシュは同じプロセス内で有効です。これは、同じキャッシュを複数のワーカー間で共有できないということです。キャッシュサイズを変更しないならこれは大きな問題ではありません。もし、 /reference/commands/cache_limit コマンドでキャッシュサイズを変更したいなら問題になります。

すべてのワーカーのキャッシュサイズを変更する汎用的な方法がないのです。

例えば、3ワーカーいるとします:

                                   +-- worker 1
client -- groonga-httpd (master) --+-- worker 2
                                   +-- worker 3

クライアントが /reference/commands/cache_limit コマンドをリクエストし、worker 1が受け取りました:

                                   +-> worker 1 (changed!)
client -> groonga-httpd (master) --+-- worker 2
                                   +-- worker 3

クライアントがもう一度 /reference/commands/cache_limit コマンドをリクエストし、またworker 1が受け取りました:

                                   +-> worker 1 (changed again!!!)
client -> groonga-httpd (master) --+-- worker 2
                                   +-- worker 3

この場合、worker 2とworker 3は1つもリクエストを受けとっていません。そのため、これらのワーカーのキャッシュサイズは変更されていません。

クライアントはワーカーを選ぶことができないので、 /reference/commands/cache_limit コマンドですべてのワーカのキャッシュサイズを変更することができないのです。

  リバースプロキシとキャッシュ

nginxのリバースプロキシ機能とキャッシュ機能を使ってクエリーキャッシュを実現できます:

                                                            +-- worker 1
client -- groonga-httpd (master) -- reverse proxy + cache --+-- worker 2
                                                            +-- worker 3

この方法ではすべてのワーカーで同じキャッシュの設定をりようできますが、HTTPで動的にキャッシュの設定を変更することはできません。

以下はサンプルの設定です:

...
http {
  proxy_cache_path /var/cache/groonga-httpd levels=1:2 keys_zone=groonga:10m;
  proxy_cache_valid 10m;
  ...
  # Reverse proxy and cache
  server {
    listen 10041;
    ...
    # Only select command
    location /d/select {
      # Pass through groonga with cache
      proxy_cache groonga;
      proxy_pass http://localhost:20041;
    }
    location / {
      # Pass through groonga
      proxy_pass http://localhost:20041;
    }
  }
  # groonga
  server {
    location 20041;
    location /d/ {
      groonga on;
      groonga_database /var/lib/groonga/db/db;
    }
  }
  ...
}

パラメーターの詳細は以下のnginxのドキュメントを見てください:

•   http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path

•   http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid

•   http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache

•   http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass

    Groongaに新しいデータをロードしたときは自分でnginxが作ったキャッシュファイルを削除しなければいけないことに注意してください。前述のサンプル設定では、以下のコマンドでキャッシュを消せます:

    % groonga DB_PATH < load.grn
    % rm -rf /var/cache/groonga-httpd/*

    Groongaのクエリーキャッシュ機能を使うと、手動でキャッシュを失効する必要はありません。自動で失効します。

  利用可能なnginxモジュール

全てのHTTPの標準モジュールが利用可能です。PCRE（Perl Compatible Regular Expressions）がない場合はHttpRewriteModuleは無効になります。標準モジュールの一覧は、 http://wiki.nginx.org/Modules を参照してください。

  Groonga HTTPサーバー

  名前

Groonga HTTPサーバー

  書式

groonga -d --protocol http DB_PATH

  概要

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

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

  コマンド

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

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

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

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

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

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

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

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

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

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

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

  戻り値

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

  groonga-suggest-create-dataset

  名前

groonga-suggest-create-dataset - Defines schema for a suggestion dataset

  SYNOPSTIS

groonga-suggest-create-dataset [options] DATABASE DATASET

  DESCTIPION

groonga-suggest-create-dataset creates a dataset for /reference/suggest. A database has many datasets. This command just defines schema for a suggestion dataset.

This command generates some tables and columns for /reference/suggest.

Here is the list of such tables. If you specify 'query' as dataset name, following '_DATASET' suffix are replaced. Thus, 'item_query', 'pair_query', 'sequence_query', 'event_query' tables are generated.

•   event_type

•   bigram

•   kana

•   item_DATASET

•   pair_DATASET

•   sequence_DATASET

•   event_DATASET

•   設定ディレクティブ

  オプション

None.

  EXIT STATUS

TODO

  FILES

TODO

  例

TODO

  参考

/reference/suggest groonga-suggest-httpd groonga-suggest-learner

  groonga-suggest-httpd

  概要

groonga-suggest-httpd is a program to provide interface which accepts HTTP request and returns suggestion dataset, then saves logs for learning. groonga-suggest-httpd behaves similar in point of view of suggestion functionality, but the name of parameter is different.

  書式

groonga-suggest-httpd [options] database_path

  使い方

  設定をする

最初に提案用のデータベースをセットアップする必要があります。

実行例:

% groonga-suggest-create-dataset /tmp/groonga-databases/groonga-suggest-httpd query

  Launch groonga-suggest-httpd

Execute groonga-suggest-httpd command:

実行例:

% groonga-suggest-httpd /tmp/groonga-databases/groonga-suggest-httpd

After executing above command, groonga-suggest-httpd accepts HTTP request on 8080 port.

If you just want to save requests into log file, use -l option.

Here is the example to save log files under logs directory with log prefix for each file.:

% groonga-suggest-httpd -l logs/log /tmp/groonga-databases/groonga-suggest-httpd

Under logs directory, log files such as logYYYYmmddHHMMSS-00 are created.

  Request to groonga-suggest-httpd

Here is the sample requests to learn groonga for query dataset:

% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=92619&t=complete&q=g'
% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=93850&t=complete&q=gr'
% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=94293&t=complete&q=gro'
% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=94734&t=complete&q=groo'
% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=95147&t=complete&q=grooon'
% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=95553&t=complete&q=groonga'
% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=95959&t=submit&q=groonga

  Options

-p, --port
    Specify http server port number. The default value is 8080.

-t, --n-threads
    Specify number of threads. The default value is 8. This option accepts 128 as the max value, but use the number of CPU cores for performance.

-s, --send-endpoint
    Specify endpoint for sender.

-r, --receive-endpoint
    Specify endpoint for receiver.

-l, --log-base-path
    Specify path prefix of log.

--n-lines-per-log-file
    Specify the number of lines in a log file. The default value is 1,000,000.

-d, --daemon
    Specify this option to daemonize.

--disable-max-fd-check
    Specify this option to disable checking max fd on start.

  コマンドライン引数

database_path だけが必須の引数です。

  database_path

Specifies the path to a Groonga database. This database must be created by groonga-suggest-create-dataset command because it executes required initialization for suggestion.

  GETの引数

groonga-suggest-httpd accepts following GET parameters.

必須の引数があります。どれが必須かはクエリーの種類に依存します。

  必須引数
キー | 説明 | Note
q | UTF-8 encoded string which user fills in form |
t | The type of query. The value of type must be complete, correct, suggest or submit. It also accepts multiple type of query which is concatinated by |. Note that submit is invalid value when you specify multiple type of query. |

  学習時に必須の引数
キー | 説明 | Note
s | Elapsed time from 0:00 January 1, 1970 | Note that you need specify the value of s in milliseconds
i | Unique ID to distinct user | Use session ID or IP address for example
l | Specify the name of dataset for learning. It also accepts multiple dataset name which is concatinated by | | Note that dataset name must be matched to following regular expression [A-Za-z ][A-Za-z0-9 ]{0,15}

  提案時に必須の引数
キー | 説明 | Note
n | 提案用のデータベース名を指定します。 | This dataset name is used to calculate suggestion results

  省略可能引数
キー | 説明 | Note
callback | Specify the name of function if you prefer JSONP as response format | The name of function must be matched to reqular expression [A-Za-z ][A-Za-z0-9 ]{0,15}

  戻り値

groonga-suggest-httpd command returns following response in JSON or JSONP format.

JSON形式:

{TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]}

JSONP形式:

FUNCTION({TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]})

TYPE complete 、 correct 、 suggest のどれか。

CANDIDATE_N The string of candidate (UTF-8).

SCORE_N スコア。

  groonga-suggest-learner

  概要

groonga-suggest-learner is a program to learn suggest result from data which derived from groonga-suggest-httpd. Usually, it is used with groonga-suggest-httpd, but It is allowed to launch standalone. In such a case, groonga-suggest-learner loads data from log directory.

  書式

groonga-suggest-learner [options] database_path

  使い方

groonga-suggest-leaner supports the two way of learning data. One is learning data from groonga-suggest-httpd, the other is learning data from already existing log files.

  Learning data from groonga-suggest-httpd

Execute groonga-suggest-learner.:

groonga-suggest-learner testdb/db

  Learning data from log files

Execute groonga-suggest-learner with -l option.

Here is the sample to load log data under logs directory:

groonga-suggest-learner -l logs testdb/db

  Options

-r <endpoint>, --receive-endpoint <endpoint>
    Uses <endpoint> as the receiver endpoint.

-s <endpoint>, --send-endpoint <endpoint>
    Uses <endpoint> as the sender endpoint.

-d, --daemon
    Runs as a daemon.

-l <directory>, --log-base-path <directory>
    Reads logs from <directory>.

--log-path <path>
    Outputs log to <path>.

--log-level <level>
    Uses <level> for log level. <level> must be between 1 and 9. Larger level outputs more logs.

  引数

database_path だけが必須の引数です。

  database_path

groongaデータベースのパスを指定します。

  関連するテーブル

Here is the list of table which learned data is stored. If you specify query as dataset name, following _DATASET suffix are replaced. Thus, event_query table is used.

•   event_DATASET

  出力

Groongaは以下の出力形式をサポートしています。

•   JSON

•   XML

•   TSV（タブ区切り形式）

•   MessagePack

    JSONがデフォルトの出力形式です。

  使い方

Groongaには以下のクエリーインターフェイスがあります。

•   コマンドライン

•   HTTP

    それぞれのインターフェイスで出力形式を変更する方法は異なります。

  コマンドライン

groonga DB_PATH または groonga -c でコマンドラインクエリーインターフェイスを使うことができます。これらのgroongaコマンドでは > というプロンプトが表示されます。クエリーインターフェイスでは output_type オプションで出力形式を指定できます。

output_type オプションを指定しない場合はJSON形式の出力になります:

> status
[[0,1327721628.10738,0.000131845474243164],{"alloc_count":142,"starttime":1327721626,"uptime":2,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]

明示的に output_type に json を指定することもできます。この場合はJSON形式の出力になります:

> status --output_type json
[[0,1327721639.08321,7.93933868408203e-05],{"alloc_count":144,"starttime":1327721626,"uptime":13,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]

XML形式の出力にする場合は output_type に xml を指定します:

> status --output_type xml
<?xml version="1.0" encoding="utf-8"?>
<RESULT CODE="0" UP="1327721649.61095" ELAPSED="0.000126361846923828">
<RESULT>
<TEXT>alloc_count</TEXT>
<INT>146</INT>
<TEXT>starttime</TEXT>
<INT>1327721626</INT>
<TEXT>uptime</TEXT>
<INT>23</INT>
<TEXT>version</TEXT>
<TEXT>1.2.9-92-gb87d9f8</TEXT>
<TEXT>n_queries</TEXT>
<INT>0</INT>
<TEXT>cache_hit_rate</TEXT>
<FLOAT>0.0</FLOAT>
<TEXT>command_version</TEXT>
<INT>1</INT>
<TEXT>default_command_version</TEXT>
<INT>1</INT>
<TEXT>max_command_version</TEXT>
<INT>2</INT></RESULT>
</RESULT>

TSV形式の出力にする場合は output_type に tsv を指定します::<

> status --output_type tsv
0     1327721664.82675        0.000113964080810547
"alloc_count" 146
"starttime"   1327721626
"uptime"      38
"version"     "1.2.9-92-gb87d9f8"
"n_queries"   0
"cache_hit_rate"      0.0
"command_version"     1
"default_command_version"     1
"max_command_version" 2
END

MessagePack形式の出力にする場合は output_type に msgpack を指定します::<

> status --output_type msgpack
(... omitted because MessagePack is binary data format. ...)

  HTTP

groonga --protocol http -s DB_PATH でHTTPクエリーインターフェイスを使うことができます。groonga HTTPサーバーはデフォルトで10041番ポートで起動します。このクエリーインターフェイスでは拡張子で出力形式を指定します。

拡張子を指定しない場合はJSON形式の出力になります:

% curl http://localhost:10041/d/status
[[0,1327809294.54311,0.00082087516784668],{"alloc_count":155,"starttime":1327809282,"uptime":12,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]

明示的に json 拡張子を指定することもできます。この場合はJSON形式の出力になります:

% curl http://localhost:10041/d/status.json
[[0,1327809319.01929,9.5367431640625e-05],{"alloc_count":157,"starttime":1327809282,"uptime":37,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]

XML形式の出力にする場合は xml 拡張子を指定します:

% curl http://localhost:10041/d/status.xml
<?xml version="1.0" encoding="utf-8"?>
<RESULT CODE="0" UP="1327809339.5782" ELAPSED="9.56058502197266e-05">
<RESULT>
<TEXT>alloc_count</TEXT>
<INT>159</INT>
<TEXT>starttime</TEXT>
<INT>1327809282</INT>
<TEXT>uptime</TEXT>
<INT>57</INT>
<TEXT>version</TEXT>
<TEXT>1.2.9-92-gb87d9f8</TEXT>
<TEXT>n_queries</TEXT>
<INT>0</INT>
<TEXT>cache_hit_rate</TEXT>
<FLOAT>0.0</FLOAT>
<TEXT>command_version</TEXT>
<INT>1</INT>
<TEXT>default_command_version</TEXT>
<INT>1</INT>
<TEXT>max_command_version</TEXT>
<INT>2</INT></RESULT>
</RESULT>

TSV形式の出力にする場合は tsv 拡張子を指定します:

% curl http://localhost:10041/d/status.tsv
0     1327809366.84187        8.44001770019531e-05
"alloc_count" 159
"starttime"   1327809282
"uptime"      84
"version"     "1.2.9-92-gb87d9f8"
"n_queries"   0
"cache_hit_rate"      0.0
"command_version"     1
"default_command_version"     1
"max_command_version" 2
END

MessagePack形式の出力にする場合は msgpack 拡張子を指定します:

% curl http://localhost:10041/d/status.msgpack
(... omitted because MessagePack is binary data format. ...)

  コマンド

コマンドはクエリーAPIでもっとも重要な処理単位です。コマンドで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に指定した値が指定されたものとみなします。

  出力形式

  概要

コマンドは実行結果をJSONまたはMessagePack、XML、TSVのどれかで出力します。

JSONとMessagePackの出力は同じ構造になっています。XMLとTSVはそれぞれ独自の構造になっています。

JSONまたはMessagePackの利用を推奨します。XMLは目視で結果を確認する時に便利です。TSVは特殊な用途では有用です。通常はTSVを使う必要はありません。

  JSONとMessagePack

このセクションではJSONとMessagePack形式を使った時のコマンド実行結果の構造を説明します。MessagePackはバイナリー形式なのでここでは構造を示すためにJSONを使います。バイナリー形式はドキュメントには向いていません。

JSON形式、MessagePack形式のときは以下のような構造になります:

[HEADER, BODY]

実行例:

[
  [
    0,
    1337566253.89858,
    0.000355720520019531
  ],
  [
    [
      [
        1
      ],
      [
        [
          "_id",
          "UInt32"
        ],
        [
          "_key",
          "ShortText"
        ],
        [
          "content",
          "Text"
        ],
        [
          "n_likes",
          "UInt32"
        ]
      ],
      [
        2,
        "Groonga",
        "I started to use groonga. It's very fast!",
        10
      ]
    ]
  ]
]

この例では、以下の部分が HEADER に相当します:

[
  0,
  1337566253.89858,
  0.000355720520019531
]

BODY に相当する部分は以下です:

[
  [
    [
      1
    ],
    [
      [
        "_id",
        "UInt32"
      ],
      [
        "_key",
        "ShortText"
      ],
      [
        "content",
        "Text"
      ],
      [
        "n_likes",
        "UInt32"
      ]
    ],
    [
      2,
      "Groonga",
      "I started to use groonga. It's very fast!",
      10
    ]
  ]
]

  HEADER

HEADER は配列です。 HEADER の内容にはいくつかのパターンがあります。

  成功した場合

コマンドが成功した場合は HEADER には3つの要素があります:

[0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME]

最初の値は常に 0 です。

UNIX_TIME_WHEN_COMMAND_IS_STARTED はコマンドの実行が始まったときの時刻です。時刻は1970-01-01 00:00:00から経過した秒数で表現されています。 ELAPSED_TIME はコマンドの実行にかかった時間です。単位は秒です。 UNIX_TIME_WHEN_COMMAND_IS_STARTED も ELAPSED_TIME も浮動小数点数です。小数部分はナノ秒を表します。

  エラーの場合

エラーの場合、 HEADER には4個または5個の要素があります:

[
  RETURN_CODE,
  UNIX_TIME_WHEN_COMMAND_IS_STARTED,
  ELAPSED_TIME,
  ERROR_MESSAGE,
  ERROR_LOCATION
]

ERROR_LOCATION は HEADER には含まれないかもしれませんが、他の4個の要素は常に含まれます。

RETURN_CODE は0ではない値です。リターンコードの詳細は return_code を見てください。

UNIX_TIME_WHEN_COMMAND_IS_STARTED と ELAPSED_TIME は成功した時と同じです。

ERROR_MESSAGE はエラーメッセージです。文字列です。

ERROR_LOCATION は存在しないことがあります。もし、エラーが発生した場所の情報を収集できていた場合は ERROR_LOCATION が含まれます。 ERROR_LOCATION は配列です。 ERROR_LOCATION は1個または2個の要素を含みます:

[
  LOCATION_IN_GROONGA,
  LOCATION_IN_INPUT
]

LOCATION_IN_GROONGA はGroonga内でエラーが発生したソースコードの場所です。この情報はGroonga開発者には役に立ちますが、ユーザーの役には立ちません。 LOCATION_IN_GROONGA は配列です。 LOCATION_IN_GROONGA には3個の要素があります:

[
  FUNCTION_NAME,
  SOURCE_FILE_NAME,
  LINE_NUMBER
]

FUNCTION_NAME はエラーが発生した関数の名前です。

SOURCE_FILE_NAME はエラーが発生した箇所を含んだGroongaのソースコードのファイル名です。

LINE_NUMBER はエラーが発生した箇所の SOURCE_FILE_NAME での行番号です。

LOCATION_IN_INPUT は存在しないことがあります。 LOCATION_IN_INPUT は入力ファイルでエラーが発生した場所の情報を収集できたときに含まれます。入力ファイルは groonga コマンドのコマンドラインオプション --file で指定できます。 LOCATION_IN_GROONGA は配列です。 LOCATION_IN_GROONGA には3個の要素があります:

[
  INPUT_FILE_NAME,
  LINE_NUMBER,
  LINE_CONTENT
]

INPUT_FILE_NAME はエラーが発生した入力ファイルのファイル名です。

LINE_NUMBER はエラーが発生した箇所の INPUT_FILE_NAME での行番号です。

LINE_CONTENT は INPUT_FILE_NAME 内の LINE_NUMBER 行目の内容です。

  BODY

BODY の内容は実行したコマンドに依存します。 BODY がないこともあります。

エラーが発生した時に、 BODY にエラーメッセージが入っていることもあります。

  XML

TODO

  TSV

TODO

  参考

•   return_code はリターンコードについて説明しています。

  プリティープリント

  概要

バージョン 5.1.0 で追加.

Groongaでは output_format にJSONを選んだときはプリティープリント（読みやすく整形して出力）できます。

  使い方

output_pretty パラメーターに yes を指定するだけです。:

> status --output_pretty yes
[
  [
    0,
    1448344438.43783,
    5.29289245605469e-05
  ],
  {
    "alloc_count": 233,
    "starttime": 1448344437,
    "start_time": 1448344437,
    "uptime": 1,
    "version": "5.0.9-135-g0763d91",
    "n_queries": 0,
    "cache_hit_rate": 0.0,
    "command_version": 1,
    "default_command_version": 1,
    "max_command_version": 2
  }
]

以下は output_pretty パラメーターを指定しなかったときの結果です。:

> status
[[0,1448344438.43783,5.29289245605469e-05],{"alloc_count":233,"starttime":1448344437,...}]

  リクエストID

  概要

バージョン 4.0.9 で追加.

各リクエストにIDを割り当てることができます。

リクエストをキャンセルするためにこのIDを使うことができます。リクエストをキャンセルする方法の詳細は /reference/commands/request_cancel を参照してください。

リクエストIDはユーザーが管理します。もし、実行中の複数のリクエストに同じIDを割り当てるとそのリクエストはキャンセルできません。

もっとも単純なIDの付け方は 1, 2, .. というように数値をインクリメントしていく付け方です。

リクエストIDは文字列です。リクエストIDの最長サイズは4096バイトです。

  リクエストにIDを割り当てる方法

すべてのコマンドは request_id パラメーターを受け付けます。 request_id パラメーターを追加することでリクエストにIDを割り当てることができます。

以下は id-1 というIDをリクエストに割り当てる例です:

select Users --request_id id-1

  参考

•   /reference/commands/request_cancel

  リターンコード

  概要

リターンコードは処理が成功したかどうかを示すために使われます。もし、処理が成功していなければリターンコードはエラーの種類を示します。

リターンコードはCのAPIでもクエリーAPIでも使われます。CのAPIでは grn_ctx_t::rc でリターンコードを確認できます。クエリーAPIではヘッダー要素を見るとリターンコードを確認できます。クエリーAPIでのヘッダー要素については output_format を参照してください。

  一覧

以下はリターンコードの一覧です。 GRN_SUCCESS (= 0) は処理が成功したことを示しています。負の値のリターンコードはエラーの種類を表しています。 GRN_END_OF_DATA は特別なリターンコードです。このリターンコードはCのAPIでだけ使われていて、クエリーAPIにはでてきません。

•   0: GRN_SUCCESS

•   1: GRN_END_OF_DATA

•   -1: GRN_UNKNOWN_ERROR

•   -2: GRN_OPERATION_NOT_PERMITTED

•   -3: GRN_NO_SUCH_FILE_OR_DIRECTORY

•   -4: GRN_NO_SUCH_PROCESS

•   -5: GRN_INTERRUPTED_FUNCTION_CALL

•   -6: GRN_INPUT_OUTPUT_ERROR

•   -7: GRN_NO_SUCH_DEVICE_OR_ADDRESS

•   -8: GRN_ARG_LIST_TOO_LONG

•   -9: GRN_EXEC_FORMAT_ERROR

•   -10: GRN_BAD_FILE_DESCRIPTOR

•   -11: GRN_NO_CHILD_PROCESSES

•   -12: GRN_RESOURCE_TEMPORARILY_UNAVAILABLE

•   -13: GRN_NOT_ENOUGH_SPACE

•   -14: GRN_PERMISSION_DENIED

•   -15: GRN_BAD_ADDRESS

•   -16: GRN_RESOURCE_BUSY

•   -17: GRN_FILE_EXISTS

•   -18: GRN_IMPROPER_LINK

•   -19: GRN_NO_SUCH_DEVICE

•   -20: GRN_NOT_A_DIRECTORY

•   -21: GRN_IS_A_DIRECTORY

•   -22: GRN_INVALID_ARGUMENT

•   -23: GRN_TOO_MANY_OPEN_FILES_IN_SYSTEM

•   -24: GRN_TOO_MANY_OPEN_FILES

•   -25: GRN_INAPPROPRIATE_I_O_CONTROL_OPERATION

•   -26: GRN_FILE_TOO_LARGE

•   -27: GRN_NO_SPACE_LEFT_ON_DEVICE

•   -28: GRN_INVALID_SEEK

•   -29: GRN_READ_ONLY_FILE_SYSTEM

•   -30: GRN_TOO_MANY_LINKS

•   -31: GRN_BROKEN_PIPE

•   -32: GRN_DOMAIN_ERROR

•   -33: GRN_RESULT_TOO_LARGE

•   -34: GRN_RESOURCE_DEADLOCK_AVOIDED

•   -35: GRN_NO_MEMORY_AVAILABLE

•   -36: GRN_FILENAME_TOO_LONG

•   -37: GRN_NO_LOCKS_AVAILABLE

•   -38: GRN_FUNCTION_NOT_IMPLEMENTED

•   -39: GRN_DIRECTORY_NOT_EMPTY

•   -40: GRN_ILLEGAL_BYTE_SEQUENCE

•   -41: GRN_SOCKET_NOT_INITIALIZED

•   -42: GRN_OPERATION_WOULD_BLOCK

•   -43: GRN_ADDRESS_IS_NOT_AVAILABLE

•   -44: GRN_NETWORK_IS_DOWN

•   -45: GRN_NO_BUFFER

•   -46: GRN_SOCKET_IS_ALREADY_CONNECTED

•   -47: GRN_SOCKET_IS_NOT_CONNECTED

•   -48: GRN_SOCKET_IS_ALREADY_SHUTDOWNED

•   -49: GRN_OPERATION_TIMEOUT

•   -50: GRN_CONNECTION_REFUSED

•   -51: GRN_RANGE_ERROR

•   -52: GRN_TOKENIZER_ERROR

•   -53: GRN_FILE_CORRUPT

•   -54: GRN_INVALID_FORMAT

•   -55: GRN_OBJECT_CORRUPT

•   -56: GRN_TOO_MANY_SYMBOLIC_LINKS

•   -57: GRN_NOT_SOCKET

•   -58: GRN_OPERATION_NOT_SUPPORTED

•   -59: GRN_ADDRESS_IS_IN_USE

•   -60: GRN_ZLIB_ERROR

•   -61: GRN_LZO_ERROR

•   -62: GRN_STACK_OVER_FLOW

•   -63: GRN_SYNTAX_ERROR

•   -64: GRN_RETRY_MAX

•   -65: GRN_INCOMPATIBLE_FILE_FORMAT

•   -66: GRN_UPDATE_NOT_ALLOWED

•   -67: GRN_TOO_SMALL_OFFSET

•   -68: GRN_TOO_LARGE_OFFSET

•   -69: GRN_TOO_SMALL_LIMIT

•   -70: GRN_CAS_ERROR

•   -71: GRN_UNSUPPORTED_COMMAND_VERSION

  参考

•   output_format はクエリーAPIでのレスポンスの中でどこにリターンコードがあるかを説明しています。

•   /spec/gqtp: GQTPプロトコルもステータスとしてリターンコードを使っていますが、ステータスは2バイトの符号なし整数です。そのため、GQTPプロトコルでは、負の値のリターンコードは正の値のステータスになります。GQTPプロトコルのステータスの値を2バイトの符号付き整数として扱うとステータスをリターンコードに変換できます。

  cache_limit

  概要

cache_limit は最大クエリーキャッシュエントリー数を取得・設定します。クエリーキャッシュを使っているのは select コマンドだけです。

最大クエリーキャッシュエントリー数が100の場合は、最新の100 select コマンドの結果だけキャッシュします。キャッシュを失効するアルゴリズムはLRU（Least Recently Used）です。

  構文

このコマンドの引数は1つで省略できます:

cache_limit [max=null]

  使い方

引数なしで cache_limit を実行すると現在の最大キャッシュエントリー数を取得できます。

実行例:

cache_limit
# [[0, 1337566253.89858, 0.000355720520019531], 100]

max 引数つきで cache_limit を実行すると最大キャッシュエントリー数を設定できます。

次の例は最大キャッシュエントリー数を 10 に設定する例です。

実行例:

cache_limit 10
# [[0, 1337566253.89858, 0.000355720520019531], 100]
cache_limit
# [[0, 1337566253.89858, 0.000355720520019531], 10]

max 引数を使うと、指定した値に設定される前の最大キャッシュエントリー数が戻り値になります。

  引数

このセクションではすべての引数について説明します。

  max

数値で最大クエリーキャッシュエントリー数を指定します。

max 引数が指定されていない場合は、現在の最大クエリーキャッシュエントリー数は変わりません。 cache_limit は単に現在の最大クエリーキャッシュエントリー数を返します。

  戻り値

cache_limit は現在の最大クエリーキャッシュエントリー数を返します:

[HEADER, N_ENTRIES]

HEADER HEADER については /reference/command/output_format を参照してください。

N_ENTRIES N_ENTRIES は現在の最大クエリーキャッシュエントリー数です。これは数値です。

  参考

•   select

  check

  概要

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

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

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

  構文

check obj

  使い方

テーブル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,
   ...},
  ...]

  引数

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

  戻り値

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

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

下記のような配列が出力されます。
  [インデックスの状態, バッファの状態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 バッファ内にある語のうち、チャンクを使っている語の数です。

  clearlock

  概要

バージョン 4.0.9 で撤廃: Use lock_clear instead.

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

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

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

  構文

clearlock objname

  使い方

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

clearlock
[true]

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

clearlock Entry.body
[true]

  引数

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

  戻り値

[成功かどうかのフラグ]

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

  参考

load

  column_copy

  概要

バージョン 5.0.7 で追加.

column_copy はカラムのすべての値を他のカラムにコピーします。

このコマンドを使うと、次のような機能を実装できます。

•   カラムの設定を変更

•   テーブルの設定を変更

    次のステップでカラムの設定を変更できます。

1.  新しい設定で新しいカラムを作る

2.  現在のカラムから新しいカラムへすべての値をコピーする

3.  現在のカラムを削除する

4.  新しいカラムを現在のカラムにリネームする

    次のステップでテーブルの設定を変更できます。

1.  新しい設定で新しいテーブルを作る

2.  すべてのカラムを同じ設定で新しいテーブルに作る

3.  現在のテーブルから新しいテーブルへすべてのカラムの値をコピーする

4.  現在のテーブルを削除する

5.  新しいテーブルを現在のテーブルにリネームする

    具体例は後で示します。

    TABLE_NO_KEY テーブルから他のテーブルにカラムの値をコピーすることはできません。また、他のテーブルから TABLE_NO_KEY テーブルにカラムの値をコピーすることもできません。これは、レコードのキーがないとどのレコードとどのレコードを対応させればよいか決められないからです。

    TABLE_NO_KEY テーブルから同じ TABLE_NO_KEY テーブルにカラムの値をコピーすることはできます。

    TABLE_HASH_KEY / TABLE_PAT_KEY / TABLE_DAT_KEY テーブルから他の TABLE_HASH_KEY / TABLE_PAT_KEY / TABLE_DAT_KEY テーブルにカラムの値をコピーすることができます。同じテーブルに対してもできます。

  構文

このコマンドには4つの引数があります。

すべての引数は必須です:

column_copy from_table
            from_name
            to_table
            to_name

  使い方

このコマンドのユースケースは次の通りです。

•   カラムの設定を変更

•   テーブルの設定を変更

  カラムの設定の変更方法

カラムの値の型を変えることができます。たとえば、カラムの型を UInt32 から ShortText に変えることができます。

カラムの種類を変えることができます。たとえば、 COLUMN_SCALAR カラムを COLUMN_VECTOR カラムに変えることができます。

カラムを他のテーブルに移動することができます。たとえば、 high_score カラムを Players テーブルから Users テーブルに移動できます。

カラムの設定を変更する基本的なステップは次の通りです。

1.  新しい設定で新しいカラムを作る

2.  現在のカラムから新しいカラムへすべての値をコピーする

3.  現在のカラムを削除する

4.  新しいカラムを現在のカラムにリネームする

    カラムの値の型を ShortText から Int32 に変更する例です。

    スキーマ定義とサンプルデータは以下の通りです。

    実行例:

    table_create Logs TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Logs serial COLUMN_SCALAR Int32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Logs
    [
    {"_key": "log1", "serial": 1}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 1]

    次のコマンドは Logs.serial カラムの値の型を Int32 から ShortText に変えています。

    実行例:

    column_create Logs new_serial COLUMN_SCALAR ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_copy Logs serial Logs new_serial
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_remove Logs serial
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_rename Logs new_serial serial
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    select Logs
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "serial",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         1,
    #         "log1",
    #         "1"
    #       ]
    #     ]
    #   ]
    # ]

    select のレスポンスを見ると Logs.serial が ShortText の値を保存していることがわかります。

    カラムの種類を COLUMN_SCALAR から COLUMN_VECTOR に変更する例です。

    スキーマ定義とサンプルデータは以下の通りです。

    実行例:

    table_create Entries TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Entries tag COLUMN_SCALAR ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Entries
    [
    {"_key": "entry1", "tag": "Groonga"}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 1]

    次のコマンドは Entries.tag を COLUMN_SCALAR から COLUMN_VECTOR へ変更します。

    実行例:

    column_create Entries new_tag COLUMN_VECTOR ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_copy Entries tag Entries new_tag
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_remove Entries tag
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_rename Entries new_tag tag
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    select Entries
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         1,
    #         "entry1",
    #         [
    #           "Groonga"
    #         ]
    #       ]
    #     ]
    #   ]
    # ]

    select のレスポンスを見ると、 Entries.tag が COLUMN_VECTOR の値を保存していることがわかります。

    high_score カラムを Players テーブルから Users テーブルに移動する例です。

    スキーマ定義とサンプルデータは以下の通りです。

    実行例:

    table_create Players TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Players high_score COLUMN_SCALAR Int32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Players
    [
    {"_key": "player1", "high_score": 100}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 1]

    次のコマンドは high_score カラムを Players テーブルから Users テーブルに移動します。

    実行例:

    table_create Users TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Users high_score COLUMN_SCALAR Int32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_copy Players high_score Users high_score
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_remove Players high_score
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    select Users
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "high_score",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         1,
    #         "player1",
    #         100
    #       ]
    #     ]
    #   ]
    # ]

    select の結果を見ると、 Players.high_score を Users.high_score に移動できていることがわかります。

  テーブルの設定の変更方法

テーブルのキーの型を変更できます。たとえば、キーの型を Int32 から ShortText に変更できます。

テーブルの種類を変更できます。たとえば、 TABLE_HASH_KEY テーブルを TABLE_PAT_KEY テーブルに変更できます。

デフォルトトークナイザーやノーマライザーなど他のオプションも変更できます。たとえば、デフォルトトークナイザーを TokenBigrm から TokenBigramSplitSymbolAlphaDigit に変更できます。

注釈: TABLE_NO_KEY テーブルは変更できません。なぜなら、 TABLE_NO_KEY レコードのキーがないからです。レコードのキーがないとコピー先のレコードを特定することができません。

テーブルの設定を変更する基本的なステップは次の通りです。

1.  新しい設定で新しいテーブルを作る

2.  すべてのカラムを同じ設定で新しいテーブルに作る

3.  現在のテーブルから新しいテーブルへすべてのカラムの値をコピーする

4.  現在のテーブルを削除する

5.  新しいテーブルを現在のテーブルにリネームする

    テーブルのキーの型を Int32 から ShortText に変更する例です。

    スキーマ定義とサンプルデータは以下の通りです。

    実行例:

    table_create IDs TABLE_HASH_KEY Int32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create IDs label COLUMN_SCALAR ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create IDs used COLUMN_SCALAR Bool
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table IDs
    [
    {"_key": 100, "label": "ID 100", used: true}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 1]

    次のコマンドは IDs テーブルのキーの型を Int32 から ShortText に変更します。

    実行例:

    table_create NewIDs TABLE_HASH_KEY Int32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create NewIDs label COLUMN_SCALAR ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create NewIDs used COLUMN_SCALAR Bool
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_copy IDs label NewIDs label
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_copy IDs used  NewIDs used
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_remove IDs
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_rename NewIDs IDs
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    select IDs
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "Int32"
    #         ],
    #         [
    #           "label",
    #           "ShortText"
    #         ],
    #         [
    #           "used",
    #           "Bool"
    #         ]
    #       ],
    #       [
    #         1,
    #         100,
    #         "ID 100",
    #         true
    #       ]
    #     ]
    #   ]
    # ]

    select のレスポンスを見ると、 IDs は ShortText のキーを保存していることがわかります。

    テーブルの種類を TABLE_HASH_KEY から TABLE_PAT_KEY に変更する例です。

    スキーマ定義とサンプルデータは以下の通りです。

    実行例:

    table_create Names TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Names used COLUMN_SCALAR Bool
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Entries
    [
    {"_key": "alice", "used": false}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 1]

    次のコマンドは Names テーブルを TABLE_HASH_KEY から TABLE_PAT_KEY に変更します。

    実行例:

    table_create NewNames TABLE_PAT_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create NewNames used COLUMN_SCALAR Bool
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_copy Names used NewNames used
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_remove Names
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_rename NewNames Names
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    select Names --filter '_key @^ "ali"'
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         0
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "used",
    #           "Bool"
    #         ]
    #       ]
    #     ]
    #   ]
    # ]

    select で script-syntax-prefix-search-operator を使えているので、 Names が TABLE_PAT_KEY に変わったことがわかります。TABLE_HASH_KEY では script-syntax-prefix-search-operator を使えません。

  引数

このセクションでは引数について説明します。

  必須引数

すべての引数は必須です。

  from_table

ソースカラムのテーブル名を指定します。

TABLE_NO_KEY テーブルを含むすべてのテーブルを指定できます。

TABLE_NO_KEY テーブルを指定するときは、 to_table には同じテーブルを指定しなければいけません。

from_table の使用例です。

スキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create FromTable TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create FromTable from_column COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create FromTable to_column   COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table FromTable
[
{"_key": "key1", "from_column": "value1"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
select FromTable --output_columns _key,from_column,to_column
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "from_column",
#           "ShortText"
#         ],
#         [
#           "to_column",
#           "ShortText"
#         ]
#       ],
#       [
#         "key1",
#         "value1",
#         ""
#       ]
#     ]
#   ]
# ]

すべての値を from_column から to_column にコピーできます。

実行例:

column_copy FromTable from_column FromTable to_column
# [[0, 1337566253.89858, 0.000355720520019531], true]
select FromTable --output_columns _key,from_column,to_column
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "from_column",
#           "ShortText"
#         ],
#         [
#           "to_column",
#           "ShortText"
#         ]
#       ],
#       [
#         "key1",
#         "value1",
#         "value1"
#       ]
#     ]
#   ]
# ]

  from_name

値をコピーするカラムの名前を指定します。

具体例は from_table を見てください。

  to_table

コピー先のカラムのテーブル名を指定します。

同じテーブル内でカラムの値をコピーしたいときは、 from_table に指定した名前と同じ名前を指定します。

to_table に TABLE_NO_KEY テーブルを指定することはできません。なぜなら、レコードのキーがないとGroongaはコピー先のレコードを特定できないからです。

例外が1つあります。 from_table と to_table に同じテーブル名を指定した場合は、 to_table に TABLE_NO_KEY テーブルを指定できます。なぜなら、コピー元テーブルとコピー先テーブルが同じテーブルならGroongaはコピー先のレコードを特定できるからです。

to_table を使った例です。

スキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Table TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Table column COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create ToTable TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create ToTable to_column COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Table
[
{"_key": "key1", "column": "value1"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

Table.column から ToTable.to_column にすべての値をコピーできます。

実行例:

column_copy Table column ToTable to_column
# [[0, 1337566253.89858, 0.000355720520019531], true]
select ToTable --output_columns _key,to_column
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "to_column",
#           "ShortText"
#         ]
#       ],
#       [
#         "key1",
#         "value1"
#       ]
#     ]
#   ]
# ]

  to_name

コピー先のカラム名を指定します。

具体例は to_table を見てください。

  省略可能引数

省略可能な引数はありません。

  戻り値

このコマンドが成功したときは以下のようにボディは true になります:

[HEADER, true]

このコマンドが失敗すると、 HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

  column_create

  概要

column_create - カラムの追加

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

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

  構文

column_create table name flags type [source]

  使い方

テーブル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]

  引数

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

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

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

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

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

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

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

    カラムの値を圧縮するためのフラグが2つあります。ただしそれらのフラグを指定することは今のところできません。これはカラムの値を参照するときにメモリリークする問題 GitHub#6 があるためです。 この問題はzlib、lzoいずれでも発生します。

16, COMPRESS_ZLIB
    zlibを使ってカラムの値を圧縮します。このフラグはGroongaを --with-zlib つきでビルドすると有効になります。

32, COMPRESS_LZO
    lzoを使ってカラムの値を圧縮します。このフラグはGroongaを --with-lzo つきでビルドすると有効になります。

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

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

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

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

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

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

  戻り値

[HEADER, SUCCEEDED]

HEADER HEADER については /reference/command/output_format を参照してください。

SUCCEEDED コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  column_list

  概要

column_list コマンドはテーブルにあるカラムの一覧を返します。

  構文

このコマンドの引数は1つで必須です:

column_list table

  使い方

以下は column_list コマンドの簡単な使用例です。

実行例:

table_create Users TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users age COLUMN_SCALAR UInt8
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users tags COLUMN_VECTOR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_list Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         "id",
#         "UInt32"
#       ],
#       [
#         "name",
#         "ShortText"
#       ],
#       [
#         "path",
#         "ShortText"
#       ],
#       [
#         "type",
#         "ShortText"
#       ],
#       [
#         "flags",
#         "ShortText"
#       ],
#       [
#         "domain",
#         "ShortText"
#       ],
#       [
#         "range",
#         "ShortText"
#       ],
#       [
#         "source",
#         "ShortText"
#       ]
#     ],
#     [
#       256,
#       "_key",
#       "",
#       "",
#       "COLUMN_SCALAR",
#       "Users",
#       "ShortText",
#       []
#     ],
#     [
#       257,
#       "age",
#       "/tmp/groonga-databases/commands_column_list.0000101",
#       "fix",
#       "COLUMN_SCALAR|PERSISTENT",
#       "Users",
#       "UInt8",
#       []
#     ],
#     [
#       258,
#       "tags",
#       "/tmp/groonga-databases/commands_column_list.0000102",
#       "var",
#       "COLUMN_VECTOR|PERSISTENT",
#       "Users",
#       "ShortText",
#       []
#     ]
#   ]
# ]

  引数

このセクションでは column_list の引数について説明します。

  必須引数

すべての引数は必須です。

  table

カラムの一覧を取得するテーブルの名前を指定します。

  戻り値

column_list はテーブルのカラム一覧を返します。

[
  HEADER,
  [
    COLUMN_LIST_HEADER,
    COLUMN_INFORMATION1,
    COLUMN_INFORMATION2,
    ...
  ]
]

HEADER HEADER については /reference/command/output_format を参照してください。

COLUMN_LIST_HEADER COLUMN_LIST_HEADER は 各 COLUMN_INFORMATION の内容を説明します。

COLUMN_LIST_HEADER は以下の形式です:

[
  ["id",     "UInt32"],
  ["name",   "ShortText"],
  ["path",   "ShortText"],
  ["type",   "ShortText"],
  ["flags",  "ShortText"],
  ["domain", "ShortText"],
  ["range",  "ShortText"],
  ["source", "ShortText"]
]

以下のことを意味します。

•   COLUMN_INFORMATION の1番目の要素は id の値で、その値の型は UInt32 です。

•   COLUMN_INFORMATION の2番目の要素は name の値で、その値の型は ShortText です。

•   COLUMN_INFORMATION の3番目の要素は…

    詳細については、次の COLUMN_INFORMATION の説明を参照して下さい。

    このフィールドはカラムの情報のメタデータを提供します。したがって、このフィールドは人ではなくプログラムに有用です。

    COLUMN_INFORMATION 各 COLUMN_INFORMATION は以下の形式です:

    [
      ID,
      NAME,
      PATH,
      TYPE,
      FLAGS,
      DOMAIN,
      RANGE,
      SOURCES
    ]

    ID GroongaデータベースのカラムIDです。通常、それを気にする必要はありません。

    NAME カラム名。

    PATH カラムのデータを保存しているパス。

    TYPE カラムの型。次のうちのどれかです。
    Value | 説明
    fix | このカラムは、固定長カラムです。固定長型のスカラーカラムは、固定長カラムです。
    var | このカラムは、可変長カラムです。ベクターカラムまたは可変長型のスカラーカラムは、可変長カラムです。
    index | このカラムはインデックスカラムです。

    FLAGS カラムのフラグです。各フラグは、COLUMN_VECTOR|WITH_WEIGHT のように | で分けられています。 FLAGS は、COLUMN_SCALAR , COLUMN_VECTOR , COLUMN_INDEX のいずれか１つを含まなければいけません。他のフラグは省略可能です。

    有効なフラグは以下の通りです。
    フラグ | 説明
    COLUMN_SCALAR | このカラムはスカラーカラムです。
    COLUMN_VECTOR | このカラムはベクターカラムです。
    COLUMN_INDEX | このカラムはインデックスカラムです。
    WITH_WEIGHT | このカラムは、重みを持つことができます。 COLUMN_VECTOR と COLUMN_INDEX は重みを持てます。 COLUMN_SCALAR は、重みを持ちません。
    WITH_SECTION | このカラムはセクション(段落)情報を持つことができます。 COLUMN_INDEX はセクション(段落)情報を持てます。 COLUMN_SCALAR と COLUMN_VECTOR はセクション(段落)情報を持ちません。 マルチカラムインデックスはこのフラグを持ちます。
    WITH_POSITION | このカラムは出現位置情報を持つことができます。 COLUMN_INDEX は出現位置情報を持てます。 COLUMN_SCALAR と COLUMN_VECTOR は出現位置情報を持ちません。 全文検索インデックスはこのフラグを持つべきです。
    PERSISTENT | このカラムは永続カラムです。それは /reference/columns/pseudo ではないことを意味します。

    DOMAIN カラムを持っているテーブルの名前です。

    RANGE カラムの型名です。型名かテーブル名です。

    SOURCES インデックスのソースカラム名の配列です。インデックスカラムがマルチカラムインデックスの場合、配列は2つまたはそれ以上のソースカラム名を有します。

    COLUMN_SCALAR と COLUMN_VECTOR では常に空の配列です。

  参考

•   /reference/commands/column_create

•   /reference/column

  column_remove

  概要

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

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

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

  構文

column_remove table name

  使い方

column_remove Entry body
[true]
脚注

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

  引数

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

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

  戻り値

[成功かどうかのフラグ]

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

  column_rename

  概要

column_rename コマンドはカラム名を変更します。

これは軽い操作です。名前とカラムオブジェクト間の関係を変更するだけです。カラムの値をコピーしません。

これは危険な操作です。 column_rename を実行している間、読み取り操作を含む全ての操作を停止しなければいけません。以下のケースが起こった場合、Groongaプロセスはクラッシュするかもしれません。

•   現在のカラム名で名前を変更しようとしているカラムにアクセスする操作（たとえば select ）を開始します。以降、現在のカラム名を 古いカラム名 と呼ぶことにします。これは、今、このカラム名を変更しようとしているからです。

•   column_rename を実行します。 select は実行中です。

•   select は古いカラム名で名前が変更されたカラムにアクセスします。しかし、カラムはすでに新しいカラム名に変更されているため、 select は古いカラム名でカラムを見つけることができません。このときGroongaプロセスがクラッシュするかもしれません。

  構文

このコマンドの引数は3つです。

すべての引数は必須です:

column_rename table name new_name

  使い方

以下は column_rename コマンドの簡単な使用例です。

実行例:

table_create Users TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users score COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "Alice",  "score": 2},
{"_key": "Bob",    "score": 0},
{"_key": "Carlos", "score": -1}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
column_rename Users score point
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_list Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         "id",
#         "UInt32"
#       ],
#       [
#         "name",
#         "ShortText"
#       ],
#       [
#         "path",
#         "ShortText"
#       ],
#       [
#         "type",
#         "ShortText"
#       ],
#       [
#         "flags",
#         "ShortText"
#       ],
#       [
#         "domain",
#         "ShortText"
#       ],
#       [
#         "range",
#         "ShortText"
#       ],
#       [
#         "source",
#         "ShortText"
#       ]
#     ],
#     [
#       256,
#       "_key",
#       "",
#       "",
#       "COLUMN_SCALAR",
#       "Users",
#       "ShortText",
#       []
#     ],
#     [
#       257,
#       "point",
#       "/tmp/groonga-databases/commands_column_rename.0000101",
#       "fix",
#       "COLUMN_SCALAR|PERSISTENT",
#       "Users",
#       "Int32",
#       []
#     ]
#   ]
# ]
select Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "point",
#           "Int32"
#         ]
#       ],
#       [
#         1,
#         "Alice",
#         2
#       ],
#       [
#         2,
#         "Bob",
#         0
#       ],
#       [
#         3,
#         "Carlos",
#         -1
#       ]
#     ]
#   ]
# ]

  引数

このセクションでは column_rename の引数について説明します。

  必須引数

すべての引数は必須です。

  table

名前を変更したいカラムが所属するテーブルの名前を指定します。

  name

名前を変更するカラムの名前を指定します。

  new_name

新しいカラム名を指定します。

  戻り値

[HEADER, SUCCEEDED_OR_NOT]

HEADER HEADER については /reference/command/output_format を参照してください。

SUCCEEDED_OR_NOT コマンドの実行が成功するとtrueを返します。失敗するとfalseを返します。

  config_delete

  概要

バージョン 5.1.2 で追加.

config_delete コマンドは指定した設定項目を削除します。

  構文

このコマンドの引数は1つで必須です:

config_delete key

  使い方

以下は alias.column 設定項目を削除する例です。

実行例:

config_set alias.column Aliases.real_name
# [[0, 1337566253.89858, 0.000355720520019531], true]
config_get alias.column
# [[0, 1337566253.89858, 0.000355720520019531], "Aliases.real_name"]
config_delete alias.column
# [[0, 1337566253.89858, 0.000355720520019531], true]
config_get alias.column
# [[0, 1337566253.89858, 0.000355720520019531], ""]

以下は存在しない設定項目を削除する例です。

実行例:

config_delete nonexistent
# [
#   [
#     -22,
#     1337566253.89858,
#     0.000355720520019531,
#     "[config][delete] failed to delete",
#     [
#       [
#         "grn_config_delete",
#         "config.c",
#         166
#       ]
#     ]
#   ],
#   false
# ]

config_delete は存在しない設定項目を削除しようとするとエラーを返します。

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数が1つあります。

  key

対象設定項目のキーを指定します。

最大キーサイズは4KiBです。

キーには空文字列を使うことはできません。

  省略可能引数

省略可能な引数はありません。

  戻り値

config_delete コマンドは設定項目の削除に成功したかどうかを返します。:

[HEADER, SUCCEEDED_OR_NOT]

  HEADER

HEADER については /reference/command/output_format を参照してください。

  SUCCEEDED_OR_NOT

コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  参考

•   /reference/configuration

•   config_get

•   config_set

  config_get

  概要

バージョン 5.1.2 で追加.

config_get コマンドは指定した設定項目の値を返します。

  構文

このコマンドの引数は1つで必須です:

config_get key

  使い方

以下は alias.column 設定項目に値を設定して、設定した値を取得する例です。

実行例:

config_set alias.column Aliases.real_name
# [[0, 1337566253.89858, 0.000355720520019531], true]
config_get alias.column
# [[0, 1337566253.89858, 0.000355720520019531], "Aliases.real_name"]

以下は存在しない設定項目の値を取得する例です。

実行例:

config_get nonexistent
# [[0, 1337566253.89858, 0.000355720520019531], ""]

config_get は存在しない設定項目の場合は空文字列を返します。

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数が1つあります。

  key

対象設定項目のキーを指定します。

最大キーサイズは4KiBです。

キーには空文字列を使うことはできません。

  省略可能引数

省略可能な引数はありません。

  戻り値

config_get コマンドは指定した設定項目の値を返します。:

[HEADER, VALUE]

  HEADER

HEADER については /reference/command/output_format を参照してください。

  VALUE

VALUE は key で指定した設定項目の値です。文字列です。

  参考

•   /reference/configuration

•   config_set

•   config_delete

  config_set

  概要

バージョン 5.1.2 で追加.

config_set コマンドは指定した設定項目に値を設定します。

  構文

このコマンドの引数は2つで必須です。:

config_set key value

  使い方

以下は alias.column 設定項目に値を設定して、設定した値を確認する例です。

実行例:

config_set alias.column Aliases.real_name
# [[0, 1337566253.89858, 0.000355720520019531], true]
config_get alias.column
# [[0, 1337566253.89858, 0.000355720520019531], "Aliases.real_name"]

  引数

このセクションではすべての引数について説明します。

  必須引数

いくつか必須の引数があります。

  key

対象設定項目のキーを指定します。

最大キーサイズは4KiBです。

キーには空文字列を使うことはできません。

  value

key で指定した対象設定項目の値を指定します。

値の最大サイズは4091B（= 4KiB - 5B）です。

  省略可能引数

省略可能な引数はありません。

  戻り値

config_set コマンドは設定項目に値を設定できたかどうかを返します。:

[HEADER, SUCCEEDED_OR_NOT]

  HEADER

HEADER については /reference/command/output_format を参照してください。

  SUCCEEDED_OR_NOT

コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  参考

•   /reference/configuration

•   config_get

•   config_delete

  database_unmap

  概要

バージョン 5.0.7 で追加.

database_unmap はデータベース中のすでにマップしてあるテーブルとカラムをアンマップします。「マップ」とはテーブルとカラムをディスクからロードしてメモリー上に展開することです。「アンマップ」とはマップしたメモリーを解放することです。

注釈: 通常、 database_unmap を使う必要はありません。なぜなら、OSが賢くメモリーを管理してくれるからです。もし、システムの残メモリーが少なくなったら、OSはGroongaが使っているメモリーをディスクに退避します。退避したメモリーは必要になったらまたメモリーに戻します。OSは使っていないメモリーを優先して退避します。

ご用心: このコマンドは thread_limit が 1 を返すときしか使えません。つまり、マルチスレッド環境ではこのコマンドは動かないということです。

  構文

このコマンドに引数はありません:

database_unmap

  使い方

最大スレッド数を 1 に変更したあとならデータベースをアンマップできます。

実行例:

thread_limit --max 1
# [[0, 1337566253.89858, 0.000355720520019531], 2]
database_unmap
# [[0, 1337566253.89858, 0.000355720520019531], true]

最大スレッド数が 1 より大きい場合は database_unmap は失敗します。

実行例:

thread_limit --max 2
# [[0, 1337566253.89858, 0.000355720520019531], 1]
database_unmap
# [
#   [
#     -2,
#     1337566253.89858,
#     0.000355720520019531,
#     "[database_unmap] the max number of threads must be 1: <2>",
#     [
#       [
#         "proc_database_unmap",
#         "proc.c",
#         6931
#       ]
#     ]
#   ],
#   false
# ]

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数はありません。

  省略可能引数

省略可能な引数はありません。

  戻り値

このコマンドが成功したときは以下のようにボディは true になります:

[HEADER, true]

このコマンドが失敗すると、 HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

  define_selector

  概要

define_selector - 検索コマンドを定義

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

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]]]]]]]]]]]]]

  使い方

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

define_selector entry_selector Entry
[true]

  引数

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引数のデフォルト値を指定します。

  戻り値

[成功かどうかのフラグ]

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

  参考

/reference/grn_expr

  defrag

  概要

defrag コマンドは指定されたオブジェクトのフラグメンテーションを解消します。

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

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

  構文

defrag objname threshold

  使い方

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

defrag
[300]

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

defrag Entry.body
[30]

  引数

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

  戻り値

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

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

  delete

  概要

delete コマンドは指定したテーブルのレコードを削除します。

  カスケード削除

複数のテーブルが関連付けられていることがあります。例えば、あるテーブルのキーが他のテーブルのレコードで参照されているような場合です。そのような場合にそのテーブルのキーを削除するなら、他のテーブルのレコードも削除されます。

他のテーブルのカラムの型がCOLUMN_VECTORなら、ベクターで参照しているキーだけが削除されます。

  構文

delete table [key [id [filter]]]

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

"2"をキーとしてもつEntryテーブルからレコードを削除します。

実行例:

delete Entry 2
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Entry
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "UInt32"
#         ],
#         [
#           "status",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         1,
#         "OK"
#       ]
#     ]
#   ]
# ]

以下はカスケード削除の例です。

UsersテーブルのcountryカラムはCountryテーブルと関連しています。

"カスケード削除"は指定されたキーやそのキーを参照しているレコードを削除します。

実行例:

table_create Country TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Users TABLE_HASH_KEY UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users name COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users country COLUMN_SCALAR Country
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": 1, "name": "John", country: "United States"}
{"_key": 2, "name": "Mike", country: "United States"}
{"_key": 3, "name": "Takashi", country: "Japan"}
{"_key": 4, "name": "Hanako", country: "Japan"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
load --table Country
[
{"_key": "United States"}
{"_key": "Japan"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
delete Country "United States"
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Country
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Japan"
#       ]
#     ]
#   ]
# ]
select Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "UInt32"
#         ],
#         [
#           "country",
#           "Country"
#         ],
#         [
#           "name",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         1,
#         "",
#         "John"
#       ],
#       [
#         2,
#         2,
#         "",
#         "Mike"
#       ],
#       [
#         3,
#         3,
#         "Japan",
#         "Takashi"
#       ],
#       [
#         4,
#         4,
#         "Japan",
#         "Hanako"
#       ]
#     ]
#   ]
# ]

  引数

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

key 削除するレコードのキーを指定します。TABLE_NO_KEYを対象となるテーブルに使用しているなら、指定したキーは無視されます。(そのような場合には 引数 id を使います。)

id 削除するレコードのIDを指定します。 引数 id を指定する場合、引数 key を指定してはいけません。

filter レコードを特定するためのgrn_exprの式を指定します。引数 filter を指定するなら、引数 key や id を指定してはいけません。

  戻り値

[HEADER, SUCCEEDED_OR_NOT]

HEADER HEADER については /reference/command/output_format を参照してください。

SUCCEEDED_OR_NOT コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  参考

load

  dump

  概要

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

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

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

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

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

  構文

dump [tables]
     [dump_plugins]
     [dump_schema]
     [dump_records]
     [dump_indexes]

  使い方

dumpの挙動を確認するためのスキーマ定義とサンプルデータは以下の通りです。

plugin_register token_filters/stop_word
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
load --table Bookmarks
[
{"_key":"Groonga", "title":"Introduction to Groonga"},
{"_key":"Mroonga", "title":"Introduction to Mroonga"}
]
load --table Sites
[
{"_key": 1, "url":"http://groonga.org"},
{"_key": 2, "url":"http://mroonga.org"}
]

データベースのすべてのデータをダンプ:

> dump
plugin_register token_filters/stop_word
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
load --table Sites
[
["_id","url"],
[1,"http://groonga.org"],
[2,"http://mroonga.org"]
]
load --table Bookmarks
[
["_key","title"],
["Groonga","Introduction to Groonga"],
["Mroonga","Introduction to Mroonga"]
]
create Lexicon bookmark_title COLUMN_INDEX Bookmarks title

スキーマと指定したテーブルのデータをダンプ:

> dump Bookmarks
plugin_register token_filters/stop_word
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText
load --table Bookmarks
[
["_key","title"],
["Groonga","Introduction to Groonga"],
["Mroonga","Introduction to Mroonga"]
]
column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title

プラグインのみダンプ:

> dump --dump_schema no --dump_records no --dump_indexes no
plugin_register token_filters/stop_word

レコードのみダンプ:

> dump --dump_schema no --dump_plugins no --dump_indexes no
load --table Sites
[
["_id","url"],
[1,"http://groonga.org"],
[2,"http://mroonga.org"]
]
load --table Bookmarks
[
["_key","title"],
["Groonga","Introduction to Groonga"],
["Mroonga","Introduction to Mroonga"]
]

スキーマのみダンプ:

> dump --dump_records no --dump_plugins no --dump_indexes no
table_create Sites TABLE_NO_KEY
column_create Sites url COLUMN_SCALAR ShortText
table_create Bookmarks TABLE_HASH_KEY ShortText
column_create Bookmarks title COLUMN_SCALAR ShortText
table_create Lexicon TABLE_PAT_KEY ShortText

  引数

いくつか省略可能な引数があります。

  省略可能引数

  tables

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

  dump_plugins

バージョン 5.0.3 で追加.

登録されたプラグインを出力に含めるかどうかをカスタマイズすることができます。登録されたプラグインを出力から除外する場合、 no を指定します。

デフォルト値は yes です。

  dump_schema

バージョン 5.0.3 で追加.

データベーススキーマを出力に含めるかどうかをカスタマイズすることができます。データベーススキーマを出力から除外する場合、 no を指定します。

デフォルト値は yes です。

  dump_records

バージョン 5.0.3 で追加.

レコードを出力に含めるかどうかをカスタマイズすることができます。レコードを出力から除外する場合、 no を指定します。

デフォルト値は yes です。

  dump_indexes

バージョン 5.0.3 で追加.

インデックスを出力に含めるかどうかをカスタマイズすることができます。インデックスを出力から除外する場合、 no を指定します。

デフォルト値は yes です。

  戻り値

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

  io_flush

  概要

注釈: このコマンドは実験的な機能です。

バージョン 5.0.5 で追加.

io_flush はメモリー上のすべての変更を明示的にディスクに書き出します。通常、明示的に io_flush を使う必要はありません。なぜなら、OSが自動的に書き出してくれるからです。また、OSが書き出した方が効率的だからです。

いくつか明示的に io_flush を使う必要があるケースがあります。1つは、システムが不意にクラッシュすることがよくあるケースです。もう1つは、Groongaプロセスを通常の終了プロセスで終了できない可能性があるケースです。（通常の終了プロセスとは、例えば、 shutdown を使った終了プロセスです。）これらのケースでは、Groongaデータベースに変更を加えた後に io_flush を使うとよいです。以下はGroongaデータベースに変更を加えるコマンドのリストです。

•   load

•   delete

•   truncate

•   table_create

•   table_remove

•   table_rename

•   column_create

•   column_remove

•   column_rename

•   plugin_register

•   plugin_unregister

    もし、 select の select-scorer パラメーターをカラムの値を変更するために使っているなら、 select もこのリストに入ります。

    io_flush は重い処理になる可能性があることに注意してください。もし、メモリー上に多くの変更があるなら、それらをディスクに書き出す処理は重い処理になります。

  構文

このコマンドには2つの引数があります。

すべての引数は省略可能です:

io_flush [target_name=null]
         [recursive=yes]

  使い方

引数無しで実行するとメモリー上のすべての変更をディスクに書き出すことができます。

実行例:

io_flush
# [[0, 1337566253.89858, 0.000355720520019531], true]

もし変更点を把握しているなら、書き出し対象を狭めることができます。以下はコマンドと書き出し対象の対応表です。
コマンド | 書き出し対象 | io_flush の引数
load と delete | テーブルとそのテーブルのカラム。 カラムの中に参照カラムがある場合、参照されているテーブルも書き出し対象になる。 インデックスが張られているカラムがある場合、対応するインデックスカラムとそのインデックスカラムのテーブルも書き出し対象になる。 | テーブルとそのテーブルのカラム: io_flush --target_name TABLE_NAME 参照されているテーブル: io_flush --target_name REFERENCED_TABLE_NAME --recursive no インデックスカラムのテーブル: io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no インデックスカラム: io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN
truncate | テーブルとそのテーブルのカラム。 カラムの中に参照カラムがある場合、参照されているテーブルも書き出し対象になる。 インデックスが張られているカラムがある場合、対応するインデックスカラムとそのインデックスカラムのテーブルも書き出し対象になる。 データベースも書き出し対象。 | テーブルとそのテーブルのカラム: io_flush --target_name TABLE_NAME 参照されているテーブル: io_flush --target_name REFERENCED_TABLE_NAME --recursive no インデックスカラムのテーブル: io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no インデックスカラム: io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN データベース: io_flush --recursive no
table_create | 処理対象のテーブルとデータベース。 | テーブル: io_flush --target_name TABLE_NAME データベース: io_flush --recursive no
table_remove と table_rename | データベース。 | データベース: io_flush --recursive no
column_create | 処理対象のカラムとデータベース。 | テーブル: io_flush --target_name TABLE_NAME.COLUMN_NAME データベース: io_flush --recursive no
column_remove と column_rename | データベース。 | データベース: io_flush --recursive no
plugin_register と plugin_unregister | データベース。 | データベース: io_flush --recursive no

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数はありません。

  省略可能引数

いくつか省略可能な引数があります。

  target_name

書き出し対象オブジェクトの名前を指定します。書き出し対象オブジェクトはデータベース、テーブル、カラムのどれかです。

このパラメーターを省略すると、データベースが書き出し対象オブジェクトになります。

実行例:

io_flush
# [[0, 1337566253.89858, 0.000355720520019531], true]

テーブル名を指定すると、そのテーブルが書き出し対象オブジェクトになります。

実行例:

table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
io_flush --target_name Users
# [[0, 1337566253.89858, 0.000355720520019531], true]

カラム名を指定すると、そのカラムが書き出し対象オブジェクトになります。

実行例:

column_create Users age COLUMN_SCALAR UInt8
# [[0, 1337566253.89858, 0.000355720520019531], true]
io_flush --target_name Users.age
# [[0, 1337566253.89858, 0.000355720520019531], true]

  recursive

書き出し対象オブジェクトの子オブジェクトも書き出し対象にするかどうかを指定します。

データベースの子オブジェクトはすべてのテーブルとすべてのカラムです。

テーブルの子オブジェクトはそのテーブルのすべてのカラムです。

カラムの子オブジェクトはありません。

recursive の値は yes または no でなければいけません。 yes は指定した書き出し対象オブジェクトとその子オブジェクトすべてを書き出し対象オブジェクトにするという意味です。 no は指定した書き出し対象オブジェクトのみを書き出し対象オブジェクトにするという意味です。

次の io_flush はデータベースとすべてのテーブルとすべてのカラムのすべての変更を書き出します。

実行例:

io_flush --recursive yes
# [[0, 1337566253.89858, 0.000355720520019531], true]

次の io_flush はデータベースの変更だけを書き出します。

実行例:

io_flush --recursive no
# [[0, 1337566253.89858, 0.000355720520019531], true]

他の値（つまり、 yes でも no でもない値）を指定した場合、または recursive パラメーターを指定しない場合は yes が使われます。

recursive 引数の値が不正なので、次のケースでは yes が使われます。

実行例:

io_flush --recursive invalid
# [[0, 1337566253.89858, 0.000355720520019531], true]

recursive パラメーターが指定されていないので、次のケースでは yes が使われます。

実行例:

io_flush
# [[0, 1337566253.89858, 0.000355720520019531], true]

  戻り値

このコマンドが成功したときは以下のようにボディは true になります:

[HEADER, true]

このコマンドが失敗すると、 HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

  load

  概要

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

  構文

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

  引数

このセクションではすべての引数について説明します。

values input_typeに指定する形式で登録するレコードの値を表現した文字列を渡します。 input_typeがjsonである場合には、以下のいずれかの形式が使用できます。

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

Format 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のみに対応しています。

  使い方

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

load --table Entry --input_type json --values [{\"_key\":\"Groonga\",\"body\":\"It's very fast!!\"}]
[1]

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

load --table Entry --input_type json
[
{"_key": "Groonga", "body": "It's very fast!!"}
]
[1]

  戻り値

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

[NUMBER]

  参考

/reference/grn_expr

  lock_acquire

  概要

バージョン 5.1.2 で追加.

lock_acquire コマンドは対象オブジェクトのロックを獲得します。対象オブジェクトはデータベース、テーブル、カラムのどれかです。

注釈: これは危険なコマンドです。獲得したロックはロックが必要なくなったときに lock_release で解放してください。もし、解放し忘れるとデータベースが壊れるかもしれません。

  構文

このコマンドの引数は1つで省略できます:

lock_clear [target_name=null]

target_name パラメーターを省略した場合は対象オブジェクトはデータベースになります。

  使い方

以下はデータベースのロックを獲得する例です。

実行例:

lock_acquire
# [[0, 1337566253.89858, 0.000355720520019531], true]

もし、データベースがロックされていると、新しいテーブル・カラムを作れなくなります。ここでは、他の例を示すためにデータベースのロックを解放します。

実行例:

lock_release
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Entries テーブルのロックを獲得する例です。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_acquire Entries
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Sites.title カラムのロックを獲得する例です。

実行例:

table_create Sites TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Sites title COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_acquire Sites.title
# [[0, 1337566253.89858, 0.000355720520019531], true]

  引数

このセクションではすべての引数について説明します。

  target_name

テーブル名またはカラム名を指定します。

指定しなかったら対象オブジェクトはデータベースになります。

デフォルト値はありません。これは対象オブジェクトはデータベースになるということです。

  戻り値

lock_acquire コマンドはロックを獲得できたかどうかを返します。:

[HEADER, SUCCEEDED_OR_NOT]

  HEADER

HEADER については /reference/command/output_format を参照してください。

  SUCCEEDED_OR_NOT

コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  参考

•   lock_release

•   lock_clear

  lock_clear

  概要

バージョン 4.0.9 で追加.

lock_clear コマンドは対象オブジェクトのロックを再帰的に解除します。対象オブジェクトはデータベース、テーブル、カラムのどれかです。

注釈: これは危険なコマンドです。他のプロセスまたは他のスレッドが対象オブジェクトに書き込み処理を実行している間はこのコマンドを使ってはいけません。もし使ったなら、データベースは壊れるかもしれませんし、実行中のプロセスはクラッシュするかもしれません。

  構文

このコマンドの引数は1つで省略できます:

lock_clear [target_name=null]

target_name パラメーターを省略した場合は対象オブジェクトはデータベースになります。これはデータベース中のすべてのロックを解除するという意味です。

  使い方

以下はデータベースの中のすべてのロックを解除する例です。

実行例:

lock_clear
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Entries テーブルと Entries テーブルのカラムのロックを解除する例です。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries body COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_clear Entries
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Sites.title カラムのロックを解除する例です。

実行例:

table_create Sites TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Sites title COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_clear Sites.title
# [[0, 1337566253.89858, 0.000355720520019531], true]

  引数

このセクションではすべての引数について説明します。

  target_name

テーブル名またはカラム名を指定します。

指定しなかったら対象オブジェクトはデータベースになります。

デフォルト値はありません。これは対象オブジェクトはデータベースになるということです。

  戻り値

lock_clear コマンドはロックを解除できたかどうかを返します。:

[HEADER, SUCCEEDED_OR_NOT]

HEADER HEADER については /reference/command/output_format を参照してください。

SUCCEEDED_OR_NOT コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  lock_release

  概要

バージョン 5.1.2 で追加.

lock_release コマンドは対象オブジェクトのロックを解放します。対象オブジェクトはデータベース、テーブル、カラムのどれかです。

注釈: これは危険なコマンドです。 lock_acquire で獲得したロックだけを解放してください。もし、 lock_acquire せずにロックを解放すると、データベースが壊れる可能性があります。

  構文

このコマンドの引数は1つで省略できます:

lock_clear [target_name=null]

target_name パラメーターを省略した場合は対象オブジェクトはデータベースになります。

  使い方

以下はデータベースのロックを解放する例です。

実行例:

lock_acquire
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_release
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Entries テーブルのロックを解放する例です。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_acquire Entries
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_release Entries
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Sites.title カラムのロックを解放する例です。

実行例:

table_create Sites TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Sites title COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_acquire Sites.title
# [[0, 1337566253.89858, 0.000355720520019531], true]
lock_release Sites.title
# [[0, 1337566253.89858, 0.000355720520019531], true]

  引数

このセクションではすべての引数について説明します。

  target_name

テーブル名またはカラム名を指定します。

指定しなかったら対象オブジェクトはデータベースになります。

デフォルト値はありません。これは対象オブジェクトはデータベースになるということです。

  戻り値

lock_release コマンドはロックを開放できたかどうかを返します。:

[HEADER, SUCCEEDED_OR_NOT]

  HEADER

HEADER については /reference/command/output_format を参照してください。

  SUCCEEDED_OR_NOT

コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  参考

•   lock_acquire

•   lock_clear

  log_level

  概要

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

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

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

  構文

log_level level

  使い方

log_level warning
[true]

  引数

level 設定するログ出力レベルの値を以下のいずれかで指定します。 EMERG ALERT CRIT error warning notice info debug

  戻り値

[成功かどうかのフラグ]

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

  参考

log_put log_reopen

  log_put

  概要

log_put - ログ出力

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

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

  構文

log_put level message

  使い方

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

  引数

level 設定するログ出力レベルの値を以下のいずれかで指定します。 EMERG ALERT CRIT error warning notice info debug

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

  戻り値

[成功かどうかのフラグ]

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

  参考

log_level log_reopen

  log_reopen

  概要

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

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

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

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

  構文

log_reopen

  使い方

log_reopen
[true]

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

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

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

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

  引数

ありません。

  戻り値

[成功かどうかのフラグ]

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

  参考

log_level log_put

  logical_count

  概要

バージョン 5.0.0 で追加.

logical_count は別のテーブルに保存されているレコードであっても、マッチするレコードをカウントするためのコマンドです。テーブルの最大レコード数の /limitations を気にしなくてすむようになります。

この機能はまだこなれていないので、いくつか制限があります。

•   名前の末尾は "_YYYYMMDD" をつけてテーブルを作成します。これは決め打ちになっていて、日ごとにテーブルを作成しないといけない

•   自分で個々のテーブルへ適切なデータをロードしないといけない

  構文

このコマンドにはたくさんの引数があります。

必須引数は2つあります。 logical_table と shard_key です。

logical_count logical_table
              shard_key
              [min]
              [min_border]
              [max]
              [max_border]
              [filter]

  使い方

logical_count コマンドを使うには事前に sharding プラグインを登録します。

logical_count コマンドは実験的なプラグインです。このコマンドは将来的に変更されるかもしれません。

この機能を使う簡単な例を示します。複数のテーブルに保存されている特定のログをカウントしてみましょう。

スキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Logs_20150203 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150203 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150203 message COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Logs_20150204 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150204 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150204 message COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Logs_20150205 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150205 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150205 message COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]

実行例:

load --table Logs_20150203
[
{"timestamp": "2015-02-03 23:59:58", "message": "Start"},
{"timestamp": "2015-02-03 23:59:58", "message": "Shutdown"},
{"timestamp": "2015-02-03 23:59:59", "message": "Start"},
{"timestamp": "2015-02-03 23:59:59", "message": "Shutdown"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
load --table Logs_20150204
[
{"timestamp": "2015-02-04 00:00:00", "message": "Start"},
{"timestamp": "2015-02-04 00:00:00", "message": "Shutdown"},
{"timestamp": "2015-02-04 00:00:01", "message": "Start"},
{"timestamp": "2015-02-04 00:00:01", "message": "Shutdown"},
{"timestamp": "2015-02-04 23:59:59", "message": "Start"},
{"timestamp": "2015-02-04 23:59:59", "message": "Shutdown"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 6]
load --table Logs_20150205
[
{"timestamp": "2015-02-05 00:00:00", "message": "Start"},
{"timestamp": "2015-02-05 00:00:00", "message": "Shutdown"},
{"timestamp": "2015-02-05 00:00:01", "message": "Start"},
{"timestamp": "2015-02-05 00:00:01", "message": "Shutdown"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]

2015年の2月3日から5日までに対応したテーブルが3つあります。

•   Logs_20150203

•   Logs_20150204

•   Logs_20150205

    対応するテーブルへとデータを投入します。

    message カラムに "Shutdown" が含まれていて、 timestamp カラムの値が "2015-02-04 00:00:00" 以降であるログをカウントしましょう。

    上記目的を達成するためのクエリがこちらです。

    実行例:

    logical_count Logs timestamp --filter 'message == "Shutdown"' --min "2015-02-04 00:00:00" --min_border "include"
    # [[0, 1337566253.89858, 0.000355720520019531], 5]

    レコード数には既知の制限があります。制限はテーブルごとなので、シャーディング機能によってその制限を乗り越えることができます。

    注釈: SQLの PARTITIONING BY のような便利なクエリはありません。つまり、 table_create で "_YYYYMMDD" を名前の末尾に含むテーブルをそれぞれの作らなければなりません。

  引数

このセクションでは logical_count の引数について説明します。

  必須引数

必須引数は二つあります。 logical_table と shard_key です。

  logical_table

論理テーブル名を指定します。これは "_YYYYMMDD" をテーブル名から除いたものです。実際のテーブルが "Logs_20150203" や "Logs_20150203" といったものなら、論理テーブル名は "Logs" です。

  shard_key

個々のテーブルで共通のキーとして扱うカラム名を指定します。

  省略可能引数

いくつか省略可能な引数があります。

  min

shard_key の最小値を指定します。

  min_border

最小値を境界値として含めるのか否かを指定します。 include もしくは exclude を指定します。

  max

shard_key の最大値を指定します。

  max_border

最大値を境界値として含めるのか否かを指定します。 include もしくは exclude を指定します。

  filter

  戻り値

TODO

[HEADER, LOGICAL_COUNT]

  logical_parameters

  概要

バージョン 5.0.6 で追加.

logical_parameters はテスト用のコマンドです。通常はこのコマンドを使う必要はありません。

logical_parameters は次の2つの機能を提供します。

•   logical_* コマンドが使うパラメーターの現在値を返します。

•   logical_* コマンドが使うパラメーターを新しく設定します。

    以下はパラメーターのリストです。

•   range_index

    注釈: これらのパラメーターの値は各スレッドごとで独立しています。（正確に言うと、 grn_ctx 毎に独立しています。）これらのパラメーターを完全に制御したい場合は、これらのパラメーターを使っている間は /reference/commands/thread_limit を使って最大スレッド数を 1 にしてください。

  構文

このコマンドの引数は1つで省略できます:

logical_parameters [range_index=null]

  使い方

このコマンドを使うには事前に sharding プラグインを登録します。

実行例:

plugin_register sharding
# [[0, 1337566253.89858, 0.000355720520019531], true]

引数無しで呼び出すとすべてのパラメーターの現在の値を返します。

実行例:

logical_parameters
# [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}]

引数を指定して呼び出すと新しい値を設定できます。

実行例:

logical_parameters --range_index never
# [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}]

logical_parameters は、新しい値を設定するときは、新しい値を設定する前の値を返します。

  引数

このセクションでは引数について説明します。

  必須引数

必須の引数はありません。

  省略可能引数

省略可能な引数が1つあります。

  range_index

logical_range_filter でどのように範囲インデックスを使うかをキーワードで指定します。

指定できるキーワードは以下の通りです。

•   auto （デフォルト）

•   always

•   never

    auto を指定すると、効果がでそうなときだけ範囲インデックスを使います。これがデフォルトの値です。

    実行例:

    logical_parameters --range_index auto
    # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "never"}]

    always を指定すると、常に範囲インデックスを使います。範囲インデックスが使われるケースをテストするときに便利です。

    実行例:

    logical_parameters --range_index always
    # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}]

    never を指定すると、範囲インデックスは使いません。範囲インデックスが使われないケースをテストするときに便利です。

    実行例:

    logical_parameters --range_index never
    # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "always"}]

  戻り値

このコマンドは logical_* コマンドが使うパラメーターの現在地を返します:

[
  HEADER,
  {"range_index": HOW_TO_USE_RANGE_INDEX}
]

HOW_TO_USE_RANGE_INDEX の値は次のどれかです。

•   "auto"

•   "always"

•   "never"

    HEADER については /reference/command/output_format を参照してください。

  logical_range_filter

  概要

バージョン 5.0.0 で追加.

TODO: Write summary

  構文

このコマンドにはたくさんの引数があります。

必須引数は2つあります。 logical_table と shard_key です。

logical_range_filter
  logical_table
  shard_key
  [min=null]
  [min_border=null]
  [max=null]
  [max_border=null]
  [order=ascending]
  [filter=null]
  [offset=0]
  [limit=10]
  [output_columns=_key,*]
  [use_range_index=null]

いくつか名前付き引数としてしか使えない引数があります。これらの引数を「○番目の引数」として使うことはできません。必ず名前を指定する必要があります。

名前付き引数としてしか使えない引数は次の通りです。

•   cache=no

  使い方

logical_range_filter コマンドを使うには事前に sharding プラグインを登録します。

TODO: Add examples

  引数

このセクションでは logical_range_filter の引数について説明します。

  必須引数

必須引数は二つあります。 logical_table と shard_key です。

  logical_table

論理テーブル名を指定します。これは "_YYYYMMDD" をテーブル名から除いたものです。実際のテーブルが "Logs_20150203" や "Logs_20150203" といったものなら、論理テーブル名は "Logs" です。

TODO: Add examples

  shard_key

個々のテーブルで共通のキーとして扱うカラム名を指定します。

TODO: Add examples

  省略可能引数

いくつか省略可能な引数があります。

  min

shard_key の最小値を指定します。

TODO: Add examples

  min_border

最小値を境界値として含めるのか否かを指定します。 include もしくは exclude を指定します。

TODO: Add examples

  max

shard_key の最大値を指定します。

TODO: Add examples

  max_border

最大値を境界値として含めるのか否かを指定します。 include もしくは exclude を指定します。

TODO: Add examples

  order

TODO

  filter

TODO

  offset

TODO

  limit

TODO

  output_columns

TODO

  use_range_index

range_indexを使うかどうかを指定します。ただし、この引数はテスト用なので、本番で使うべきではありません。

TODO: Add examples

  キャッシュ関連の引数

  cache

このクエリーの結果をキャッシュするかどうかを指定します。

このクエリーの結果がキャッシュしてあると、次に同じクエリーを実行するときはキャッシュを使って高速にレスポンスを返すことができます。

これは既存のキャッシュされた結果を使うかどうかを指定するものではありません。

指定可能な値は以下の通りです。
Value | 説明
no | このクエリーの出力をキャッシュしない。
yes | このクエリーの出力をキャッシュする。デフォルト値。

TODO: Add examples

デフォルト値は yes です。

  戻り値

TODO

[HEADER, LOGICAL_FILTERED]

  logical_select

  概要

バージョン 5.0.5 で追加.

logical_select は select のシャーディングバージョンです。 logical_select は複数のテーブルからレコードを検索し、マッチしたレコードを出力します。

logical_select は sharding プラグインに含まれているので、 sharding プラグインを plugin_register する必要があります。

  構文

このコマンドにはたくさんの引数があります。

必須の引数は logical_table と shard_key です。それ以外の引数は省略可能です:

logical_select logical_table
               shard_key
               [min=null]
               [min_border="include"]
               [max=null]
               [max_border="include"]
               [filter=null]
               [sortby=null]
               [output_columns="_id, _key, *"]
               [offset=0]
               [limit=10]
               [drilldown=null]
               [drilldown_sortby=null]
               [drilldown_output_columns="_key, _nsubrecs"]
               [drilldown_offset=0]
               [drilldown_limit=10]
               [drilldown_calc_types=NONE]
               [drilldown_calc_target=null]

logical_select には高度なドリルダウン機能のために以下の名前付き引数があります。

•   drilldown[${LABEL}].keys=null

•   drilldown[${LABEL}].sortby=null

•   drilldown[${LABEL}].output_columns="_key, _nsubrecs"

•   drilldown[${LABEL}].offset=0

•   drilldown[${LABEL}].limit=10

•   drilldown[${LABEL}].calc_types=NONE

•   drilldown[${LABEL}].calc_target=null

    ${LABEL} には1つ以上のアルファベット、数字、 _ 、 . を使うことができます。たとえば、 parent.sub1 は有効な ${LABEL} です。

    同じ ${LABEL} も持つ引数は同じグループになります。

    たとえば、以下の引数は1つのドリルダウンを指定しています。

•   --drilldown[label].keys column

•   --drilldown[label].sortby -_nsubrecs

    以下の引数は2つのドリルダウンを指定しています。

•   --drilldown[label1].keys column1

•   --drilldown[label1].sortby -_nsubrecs

•   --drilldown[label2].keys column2

•   --drilldown[label2].sortby _key

  select との違い

logical_select の多くの機能は select の機能と対応しています。たとえば、引数名は同じですし、出力フォーマットも同じです。

しかし、いくつか select と違うところもあります。

•   table 引数ではなく、 logical_table と shard_key 引数が必須です。

•   複数のシャードを使った場合の sortby はサポートしていません。（1つのシャードのみを使った場合はサポートしています。）

•   複数のシャードを使った場合、 drilldown[${LABEL}].sortby の中で _value.${KEY_NAME} を使えません。1つのシャードのみを使った場合は使えます。

•   match_columns と query はまだサポートしていません。

•   cache はまだサポートしていません。

•   match_escalation_threshold はまだサポートしていません。

•   query_flags はまだサポートしていません。

•   query_expander はまだサポートしていません。

•   adjuster はまだサポートしていません。

  使い方

例を使いながら logical_select の使い方を学びましょう。このセクションではよく使われる使い方を紹介します。

logical_select は sharding プラグインに含まれているので sharding プラグインを登録する必要があります。

実行例:

plugin_register sharding
# [[0, 1337566253.89858, 0.000355720520019531], true]

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Entries_20150708 TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150708 created_at COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150708 content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150708 n_likes COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150708 tag COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Entries_20150709 TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150709 created_at COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150709 content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150709 n_likes COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries_20150709 tag COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_key_index_20150708 \
  COLUMN_INDEX|WITH_POSITION Entries_20150708 _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_content_index_20150708 \
  COLUMN_INDEX|WITH_POSITION Entries_20150708 content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_key_index_20150709 \
  COLUMN_INDEX|WITH_POSITION Entries_20150709 _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_content_index_20150709 \
  COLUMN_INDEX|WITH_POSITION Entries_20150709 content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries_20150708
[
{"_key":       "The first post!",
 "created_at": "2015/07/08 00:00:00",
 "content":    "Welcome! This is my first post!",
 "n_likes":    5,
 "tag":        "Hello"},
{"_key":       "Groonga",
 "created_at": "2015/07/08 01:00:00",
 "content":    "I started to use Groonga. It's very fast!",
 "n_likes":    10,
 "tag":        "Groonga"},
{"_key":       "Mroonga",
 "created_at": "2015/07/08 02:00:00",
 "content":    "I also started to use Mroonga. It's also very fast! Really fast!",
 "n_likes":    15,
 "tag":        "Groonga"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
load --table Entries_20150709
[
{"_key":       "Good-bye Senna",
 "created_at": "2015/07/09 00:00:00",
 "content":    "I migrated all Senna system!",
 "n_likes":    3,
 "tag":        "Senna"},
{"_key":       "Good-bye Tritonn",
 "created_at": "2015/07/09 01:00:00",
 "content":    "I also migrated all Tritonn system!",
 "n_likes":    3,
 "tag":        "Senna"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

ブログエントリー用に Entries_20150708 と Entries_20150709 の2つのテーブルがあります。

注釈: テーブル名には ${論理テーブル名}_${YYYYMMDD} という命名規則を使う必要があります。この例では、 論理テーブル名 は Entries で YYYYMMDD は 20150708 または 20150709 です。

各エントリはタイトルと作成日時と内容と「いいね！」数、タグを持っています。タイトルは Entries_YYYYMMDD のキーとします。作成日時は Entries_YYYYMMDD.created_at カラムの値とします。内容は Entries_YYYYMMDD.content カラムの値とします。「いいね！」数は Entries_YYYYMMDD.n_likes カラムの値とします。タグは Entries_YYYYMMDD.tag カラムの値とします。

Entries_YYYYMMDD._key カラムと Entries_YYYYMMDD.content カラムには TokenBigram トークナイザーを使ったインデックスを作成します。そのため、 Entries_YYYYMMDD._key と Entries_YYYYMMDD.content は両方とも全文検索できます。

これで例を示すためのスキーマとデータの準備ができました。

  簡単な使い方

TODO

  引数

このセクションでは logical_select の引数について説明します。

  必須引数

必須引数は二つあります。 logical_table と shard_key です。

  logical_table

論理テーブル名を指定します。これは _YYYYMMDD をテーブル名からのぞいたものです。実際のテーブルが Entries_20150708 や Entries_20150709 といったものなら、論理テーブル名は Entries です。

logical_table と shard_key 引数を指定すると10レコード表示できます。これらの引数は必須の引数です。

実行例:

logical_select --logical_table Entries --shard_key created_at
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         1436281200.0,
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         1436284800.0,
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         1436288400.0,
#         15,
#         "Groonga"
#       ],
#       [
#         1,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         1436367600.0,
#         3,
#         "Senna"
#       ],
#       [
#         2,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         1436371200.0,
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

存在しないテーブルを指定するとエラーが返ります。

実行例:

logical_select --logical_table Nonexistent --shard_key created_at
# [
#   [
#     -22,
#     1337566253.89858,
#     0.000355720520019531,
#     "[logical_select] no shard exists: logical_table: <Nonexistent>: shard_key: <created_at>",
#     [
#       [
#         "Groonga::Context.set_groonga_error",
#         "lib/mrb/scripts/context.rb",
#         27
#       ]
#     ]
#   ]
# ]

  shard_key

シャードキーとして使うカラム名を指定します。シャードキーは適切なシャードへレコードを分配するために使う値を保存しているカラムです。

今のところ、シャードキーは Time 型でなければいけません。

shard_key の指定方法は logical_table を見てください。

  省略可能引数

いくつか省略可能な引数があります。

  min

shard_key カラムの最小値を指定します。シャードにマッチするレコードがない場合は、そのシャードは検索対象外になります。

たとえば、 min が "2015/07/09 00:00:00" なら、 Entry_20150708 は検索対象外です。なぜなら、 Entry_20150708 は "2015/07/08" のレコードしかないからです。

以下の例は Entry_20150709 テーブルだけを使う例です。 Entry_20150708 は使われません。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --min "2015/07/09 00:00:00"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         1436367600.0,
#         3,
#         "Senna"
#       ],
#       [
#         2,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         1436371200.0,
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

  min_border

最小値を含めるかどうかを指定します。指定可能な値は次の通りです。
Value | 説明
include | min の値を含みます。これがデフォルト値です。
exclude | min の値を含みません。

次の例は exclude の使用例です。結果には "Good-bye Senna" レコードは含まれません。このレコードの created_at の値が "2015/07/09 00:00:00" だからです。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --min "2015/07/09 00:00:00" \
  --min_border "exclude"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         1436371200.0,
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

  max

shard_key カラムの最大値を指定します。シャードにマッチするレコードがない場合、そのシャードは検索対象外になります。

たとえば、 max が "2015/07/08 23:59:59" なら Entry_20150709 は検索対象外です。なぜなら Entry_20150709 には ""2015/07/09" のレコードしかないからです。

以下の例は Entry_20150708 テーブルだけを使います。 Entry_20150709 は使いません。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --max "2015/07/08 23:59:59"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         1436281200.0,
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         1436284800.0,
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         1436288400.0,
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

  max_border

最大値を含めるかどうかを指定します。指定可能な値は次の通りです。
Value | 説明
include | max の値を含みます。これがデフォルト値です。
exclude | max の値を含みません。

次の例は exclude の使用例です。結果には "Good-bye Senna" レコードは含まれません。このレコードの created_at の値が "2015/07/09 00:00:00" だからです。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --max "2015/07/09 00:00:00" \
  --max_border "exclude"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         1436281200.0,
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         1436284800.0,
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         1436288400.0,
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

  検索関係の引数

logical_select は select 互換の検索関連パラメーターをサポートしています。

match_columns と query はまだサポートしていません。今のところ、 filter だけサポートしています。

  match_columns

未実装です。

  query

未実装です。

  filter

select の select-filter に対応しています。詳細は select-filter を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --filter "n_likes <= 5"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         1436281200.0,
#         5,
#         "Hello"
#       ],
#       [
#         1,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         1436367600.0,
#         3,
#         "Senna"
#       ],
#       [
#         2,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         1436371200.0,
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

  高度な検索のための引数

logical_select は高度な検索パラメーターをまだ実装していません。

  match_escalation_threshold

未実装です。

  query_flags

未実装です。

  query_expander

未実装です。

  出力関連の引数

  output_columns

select の select-output-columns に対応しています。詳細は select-output-columns を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --output_columns '_key, *'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         "The first post!",
#         "Welcome! This is my first post!",
#         1436281200.0,
#         5,
#         "Hello"
#       ],
#       [
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         1436284800.0,
#         10,
#         "Groonga"
#       ],
#       [
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         1436288400.0,
#         15,
#         "Groonga"
#       ],
#       [
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         1436367600.0,
#         3,
#         "Senna"
#       ],
#       [
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         1436371200.0,
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

  sortby

select の select-sortby に対応しています。詳細は select-sortby を見てください。

sortby には制限があります。検索対象のシャードが1つの場合のみ動作します。もし、検索対象のシャードが複数ある場合、 sortby は正常な動作をしません。

以下は1つのシャードのみを使っている例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --min "2015/07/08 00:00:00" \
  --min_border "include" \
  --max "2015/07/09 00:00:00" \
  --max_border "exclude" \
  --sortby _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         1436284800.0,
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         1436288400.0,
#         15,
#         "Groonga"
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         1436281200.0,
#         5,
#         "Hello"
#       ]
#     ]
#   ]
# ]

  offset

select の select-offset に対応しています。詳細は select-offset を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --offset 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         1436288400.0,
#         15,
#         "Groonga"
#       ],
#       [
#         1,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         1436367600.0,
#         3,
#         "Senna"
#       ],
#       [
#         2,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         1436371200.0,
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

  limit

select の select-limit に対応しています。詳細は select-limit を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "created_at",
#           "Time"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         1436281200.0,
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         1436284800.0,
#         10,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

  scorer

未実装です。

  ドリルダウン関連の引数

select のすべてのドリルダウン関連パラメーターをサポートしています。詳細は select-drilldown-related-parameters を見てください。

  drilldown

select の select-drilldown に対応しています。詳細は select-drilldown を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --output_columns _key,tag \
  --drilldown tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         "The first post!",
#         "Hello"
#       ],
#       [
#         "Groonga",
#         "Groonga"
#       ],
#       [
#         "Mroonga",
#         "Groonga"
#       ],
#       [
#         "Good-bye Senna",
#         "Senna"
#       ],
#       [
#         "Good-bye Tritonn",
#         "Senna"
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Hello",
#         1
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Senna",
#         2
#       ]
#     ]
#   ]
# ]

  drilldown_sortby

select の select-drilldown-sortby に対応しています。詳細は select-drilldown-sortby を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_sortby -_nsubrecs,_key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Senna",
#         2
#       ],
#       [
#         "Hello",
#         1
#       ]
#     ]
#   ]
# ]

  drilldown_output_columns

select の select-drilldown-output-columns に対応しています。詳細は select-drilldown-output-columns を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "Hello"
#       ],
#       [
#         "Groonga"
#       ],
#       [
#         "Senna"
#       ]
#     ]
#   ]
# ]

  drilldown_offset

select の select-drilldown-offset に対応しています。詳細は select-drilldown-offset を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_offset 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Senna",
#         2
#       ]
#     ]
#   ]
# ]

  drilldown_limit

select の select-drilldown-limit に対応しています。詳細は select-drilldown-limit を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_limit 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Hello",
#         1
#       ],
#       [
#         "Groonga",
#         2
#       ]
#     ]
#   ]
# ]

  drilldown_calc_types

select の select-drilldown-calc-types に対応しています。詳細は select-drilldown-calc-types を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit -1 \
  --output_columns tag,n_likes \
  --drilldown tag \
  --drilldown_calc_types MAX,MIN,SUM,AVG \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_nsubrecs,_max,_min,_sum,_avg
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "tag",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         "Hello",
#         5
#       ],
#       [
#         "Groonga",
#         10
#       ],
#       [
#         "Groonga",
#         15
#       ],
#       [
#         "Senna",
#         3
#       ],
#       [
#         "Senna",
#         3
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ],
#         [
#           "_max",
#           "Int64"
#         ],
#         [
#           "_min",
#           "Int64"
#         ],
#         [
#           "_sum",
#           "Int64"
#         ],
#         [
#           "_avg",
#           "Float"
#         ]
#       ],
#       [
#         "Hello",
#         1,
#         5,
#         5,
#         5,
#         5.0
#       ],
#       [
#         "Groonga",
#         2,
#         15,
#         10,
#         25,
#         12.5
#       ],
#       [
#         "Senna",
#         2,
#         3,
#         3,
#         6,
#         3.0
#       ]
#     ]
#   ]
# ]

  drilldown_calc_target

select の select-drilldown-calc-target に対応しています。詳細は select-drilldown-calc-target を見てください。

具体例は select-drilldown-calc-types を見てください。

  高度なドリルダウン関連のパラメーター

select のすべての高度なドリルダウン関連のパラメーターをサポートしています。詳細は select-advanced-drilldown-related-parameters を見てください。

いくつか制限があります。

•   複数のシャードを使った場合、 drilldown[${LABEL}].sortby の中で _value.${KEY_NAME} を使えません。1つのシャードのみを使った場合は使えます。

  drilldown[${LABEL}].keys

select の select-drilldown-label-keys に対応しています。詳細は select-drilldown-label-keys を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown[tag.n_likes].keys tag,n_likes \
  --drilldown[tag.n_likes].output_columns _value.tag,_value.n_likes,_nsubrecs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     {
#       "tag.n_likes": [
#         [
#           4
#         ],
#         [
#           [
#             "tag",
#             "ShortText"
#           ],
#           [
#             "n_likes",
#             "UInt32"
#           ],
#           [
#             "_nsubrecs",
#             "Int32"
#           ]
#         ],
#         [
#           "Hello",
#           5,
#           1
#         ],
#         [
#           "Groonga",
#           10,
#           1
#         ],
#         [
#           "Groonga",
#           15,
#           1
#         ],
#         [
#           "Senna",
#           3,
#           2
#         ]
#       ]
#     }
#   ]
# ]

  drilldown[${LABEL}].output_columns

select の select-drilldown-label-output-columns に対応しています。詳細は select-drilldown-label-output-columns を見てください。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown[tag].keys tag \
  --drilldown[tag].output_columns _key,_nsubrecs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     {
#       "tag": [
#         [
#           3
#         ],
#         [
#           [
#             "_key",
#             "ShortText"
#           ],
#           [
#             "_nsubrecs",
#             "Int32"
#           ]
#         ],
#         [
#           "Hello",
#           1
#         ],
#         [
#           "Groonga",
#           2
#         ],
#         [
#           "Senna",
#           2
#         ]
#       ]
#     }
#   ]
# ]

  drilldown[${LABEL}].sortby

ラベルなしドリルダウンの drilldown_sortby に対応しています。

drilldown[${LABEL}].sortby には制限があります。

複数のシャードを使った場合、 drilldown[${LABEL}].sortby の中で _value.${KEY_NAME} を使えません。1つのシャードのみを使った場合は使えます。

以下は1つのシャードに対して _value.${KEY_NAME} を使う例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --min "2015/07/08 00:00:00" \
  --min_border "include" \
  --max "2015/07/09 00:00:00" \
  --max_border "exclude" \
  --limit 0 \
  --output_columns _id \
  --drilldown[tag.n_likes].keys tag,n_likes \
  --drilldown[tag.n_likes].output_columns _nsubrecs,_value.n_likes,_value.tag \
  --drilldown[tag.n_likes].sortby -_nsubrecs,_value.n_likes,_value.tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     {
#       "tag.n_likes": [
#         [
#           3
#         ],
#         [
#           [
#             "_nsubrecs",
#             "Int32"
#           ],
#           [
#             "n_likes",
#             "UInt32"
#           ],
#           [
#             "tag",
#             "ShortText"
#           ]
#         ],
#         [
#           1,
#           5,
#           "Hello"
#         ],
#         [
#           1,
#           10,
#           "Groonga"
#         ],
#         [
#           1,
#           15,
#           "Groonga"
#         ]
#       ]
#     }
#   ]
# ]

  drilldown[${LABEL}].offset

ラベルなしドリルダウンの drilldown_offset に対応しています。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown[tag.n_likes].keys tag \
  --drilldown[tag.n_likes].offset 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     {
#       "tag.n_likes": [
#         [
#           3
#         ],
#         [
#           [
#             "_key",
#             "ShortText"
#           ],
#           [
#             "_nsubrecs",
#             "Int32"
#           ]
#         ],
#         [
#           "Groonga",
#           2
#         ],
#         [
#           "Senna",
#           2
#         ]
#       ]
#     }
#   ]
# ]

  drilldown[${LABEL}].limit

ラベルなしドリルダウンの drilldown_limit に対応しています。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown[tag.n_likes].keys tag \
  --drilldown[tag.n_likes].limit 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     {
#       "tag.n_likes": [
#         [
#           3
#         ],
#         [
#           [
#             "_key",
#             "ShortText"
#           ],
#           [
#             "_nsubrecs",
#             "Int32"
#           ]
#         ],
#         [
#           "Hello",
#           1
#         ],
#         [
#           "Groonga",
#           2
#         ]
#       ]
#     }
#   ]
# ]

  drilldown[${LABEL}].calc_types

ラベルなしドリルダウンの drilldown_calc_types に対応しています。

以下は例です。

実行例:

logical_select \
  --logical_table Entries \
  --shard_key created_at \
  --limit 0 \
  --output_columns _id \
  --drilldown[tag].keys tag \
  --drilldown[tag].calc_types MAX,MIN,SUM,AVG \
  --drilldown[tag].calc_target n_likes \
  --drilldown[tag].output_columns _key,_nsubrecs,_max,_min,_sum,_avg
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ]
#       ]
#     ],
#     {
#       "tag": [
#         [
#           3
#         ],
#         [
#           [
#             "_key",
#             "ShortText"
#           ],
#           [
#             "_nsubrecs",
#             "Int32"
#           ],
#           [
#             "_max",
#             "Int64"
#           ],
#           [
#             "_min",
#             "Int64"
#           ],
#           [
#             "_sum",
#             "Int64"
#           ],
#           [
#             "_avg",
#             "Float"
#           ]
#         ],
#         [
#           "Hello",
#           1,
#           5,
#           5,
#           5,
#           5.0
#         ],
#         [
#           "Groonga",
#           2,
#           15,
#           10,
#           25,
#           12.5
#         ],
#         [
#           "Senna",
#           2,
#           3,
#           3,
#           6,
#           3.0
#         ]
#       ]
#     }
#   ]
# ]

  drilldown[${LABEL}].calc_target

ラベルなしドリルダウンの drilldown_calc_target に対応しています。

例は drilldown[${LABEL}].calc_types を参照してください。

  戻り値

logical_select の戻り値のフォーマットは select と同じです。詳細は select-return-value を見てください。

  logical_shard_list

  概要

バージョン 5.0.7 で追加.

logical_shard_list は指定した論理テーブル名に対するすべてのシャード名を返します。

  構文

このコマンドの引数は1つで必須です:

logical_shard_list logical_table

  使い方

このコマンドを使うには事前に sharding プラグインを登録します。

実行例:

plugin_register sharding
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルシャードは次の通りです。

実行例:

table_create  Logs_20150801           TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150801 timestamp COLUMN_SCALAR  Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create  Logs_20150802           TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150802 timestamp COLUMN_SCALAR  Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create  Logs_20150930           TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20150930 timestamp COLUMN_SCALAR  Time
# [[0, 1337566253.89858, 0.000355720520019531], true]

論理テーブル名として Logs を指定すると昇順ですべてのシャード名を取得できます。

実行例:

logical_shard_list --logical_table Logs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "name": "Logs_20150801"
#     },
#     {
#       "name": "Logs_20150802"
#     },
#     {
#       "name": "Logs_20150930"
#     }
#   ]
# ]

  引数

このセクションでは引数について説明します。

  必須引数

必須の引数が1つあります。

  logical_table

論理テーブル名を指定します。 logical_shard_list は指定した論理テーブルのシャード名のリストを返します。

実行例:

logical_shard_list --logical_table Logs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "name": "Logs_20150801"
#     },
#     {
#       "name": "Logs_20150802"
#     },
#     {
#       "name": "Logs_20150930"
#     }
#   ]
# ]

このリストは昇順でソート済みです。

  省略可能引数

省略可能な引数はありません。

  戻り値

このコマンドは昇順でソートしたシャード名のリストを返します:

[
  HEADER,
  [
    {"name": "SHARD_NAME_1"},
    {"name": "SHARD_NAME_2"},
    ...
    {"name": "SHARD_NAME_N"}
  ]
]

HEADER については /reference/command/output_format を参照してください。

  参考

•   /reference/sharding

  logical_table_remove

  概要

バージョン 5.0.5 で追加.

logical_table_remove は指定した論理テーブルのテーブルとそのカラムを削除します。もし、テーブルのキーあるいはそのテーブルのカラムにインデックスが張ってある場合はそれらも削除します。

シャードの一部を指定すると、そのシャードのテーブルは削除しません。テーブル内のレコードを削除するだけです。

例えば、テーブル内に以下のレコードがあるとします。

•   レコード1： 2016-03-18 00:30:00

•   レコード2： 2016-03-18 01:00:00

•   レコード3： 2016-03-18 02:00:00

    範囲として 2016-03-18 00:00:00 から 2016-03-18 01:30:00 までを指定すると、「レコード1」と「レコード2」を削除します。「レコード3」は削除しません。テーブルも削除しません。

    バージョン 6.0.1 で追加: dependent パラメーターを使うと、対象テーブルを参照しているテーブル・カラムと対象シャードに関連しているテーブルも一緒に削除できます。

  構文

このコマンドにはたくさんの引数があります。

必須引数は2つあります。 logical_table と shard_key です。

logical_table_remove logical_table
                     shard_key
                     [min=null]
                     [min_border="include"]
                     [max=null]
                     [max_border="include"]
                     [dependent=no]

  使い方

削除したい論理テーブル名とシャードキーを指定します。

このセクションでは次のことについて説明します。

•   基本的な使い方

•   論理テーブルの一部を削除

•   削除できないケース

•   関連するテーブルと一緒に削除

•   利用リソースの削減

  基本的な使い方

この コマンドを使うには事前に sharding プラグインを登録します。

実行例:

register sharding
# [[0, 1337566253.89858, 0.000355720520019531], true]

logical_table と shard_key だけを指定することで対象論理テーブル用のすべてのテーブルを削除できます。

以下は2つのシャードを作成するコマンドです。

実行例:

table_create  Logs_20160318 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160318 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create  Logs_20160319 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs_20160319 timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]

存在するシャードは logical_shard_list で確認できます。

実行例:

logical_shard_list --logical_table Logs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "name": "Logs_20160318"
#     },
#     {
#       "name": "Logs_20160319"
#     }
#   ]
# ]

すべてのシャードを削除できます。

実行例:

logical_table_remove \
  --logical_table Logs \
  --shard_key timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]

すべてのシャードを削除した後はシャードは存在しません。

実行例:

logical_shard_list --logical_table Logs
# [[0, 1337566253.89858, 0.000355720520019531], []]

  論理テーブルの一部を削除

次のパラメーターでシャードの範囲を指定できます。

•   min

•   min_border

•   max

•   max_border

    各パラメーターについては logical_select の以下のドキュメントを参照してください。

•   logical-select-min

•   logical-select-min-border

•   logical-select-max

•   logical-select-max-border

    指定した範囲がシャード内のすべてのレコードを含んでいなかったら、そのシャードのテーブルは削除しません。テーブル内の対象レコードのみ削除します。

    指定した範囲がシャード内のすべてのレコードを含んでいれば、そのシャード用のテーブルを削除します。

    以下はこの挙動を示すための論理テーブルです。この論理テーブルには2つのシャードがあります。

    実行例:

    table_create  Logs_20160318 TABLE_NO_KEY
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Logs_20160318 timestamp COLUMN_SCALAR Time
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Logs_20160318
    [
    {"timestamp": "2016-03-18 00:30:00"},
    {"timestamp": "2016-03-18 01:00:00"},
    {"timestamp": "2016-03-18 02:00:00"}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 3]
    table_create  Logs_20160319 TABLE_NO_KEY
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Logs_20160319 timestamp COLUMN_SCALAR Time
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Logs_20160319
    [
    {"timestamp": "2016-03-19 00:30:00"},
    {"timestamp": "2016-03-19 01:00:00"}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 2]

    Logs_20160318 テーブルには次のレコードがあります。

•   レコード1： "2016-03-18 00:30:00"

•   レコード2： "2016-03-18 01:00:00"

•   レコード3： "2016-03-18 02:00:00"

    Logs_20160319 テーブルには次のレコードがあります。

•   レコード1： "2016-03-19 00:30:00"

•   レコード2： "2016-03-19 01:00:00"

    次の範囲は Logs_20160318 テーブル内の「レコード1」を含んでいませんが、 Logs_20160319 テーブルのすべてのレコードを含んでいます。
    パラメーター | Value
    min | "2016-03-18 01:00:00"
    min_border | "include"
    max | "2016-03-19 01:30:00"
    max_border | "include"

    この範囲を指定した logical_table_remove は Logs_20160318 テーブルの「レコード2」と「レコード3」を削除します。しかし、 Logs_20160318 テーブルは削除しません。なぜなら、 Logs_20160318 テーブルには「レコード1」があるからです。

    この範囲を指定した logical_table_remove は Logs_20160319 テーブルを削除します。なぜなら、この範囲は Logs_20160319 テーブルのすべてのレコードを含んでいるからです。

    この範囲を指定した logical_table_remove を使う例です。

    実行例:

    logical_table_remove \
      --logical_table Logs \
      --shard_key timestamp \
      --min "2016-03-18 01:00:00" \
      --min_border "include" \
      --max "2016-03-19 01:30:00" \
      --max_border "include"
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    dump を使うと Logs_20160318 テーブルに「レコード1」があることを確認できます。

    実行例:

    dump
    # plugin_register sharding
    #
    # table_create Logs_20160318 TABLE_NO_KEY
    # column_create Logs_20160318 timestamp COLUMN_SCALAR Time
    #
    # load --table Logs_20160318
    # [
    # ["_id","timestamp"],
    # [1,1458228600.0]
    # ]

  削除できないケース

いくつか削除できない場合があります。詳細は table-remove-unremovable-cases を参照してください。なぜなら logical_table_remove も同じようにチェックしているからです。

  関連するテーブルと一緒に削除

バージョン 6.0.1 で追加.

もし、自分がなにをしようとしているかちゃんと理解しているのであれば、 --dependent yes パラメーターを使うことで1回の logical_table_remove で対象シャードに依存しているテーブルとカラムも削除することができます。

以下が依存していると判断する条件です。もし、テーブル・カラムがこれらの条件のどれか1つでも満たしていてれば、そのテーブル・カラムは対象シャードに依存しています。

•   対象シャードを参照しているテーブル・カラム

•   対象シャード用のテーブル（= 名前の末尾が対象シャードと同じ _YYYYMMDD で、対象シャードが参照しているテーブル)

    対象シャードを参照しているテーブル・カラムが1つ以上あれば、 logical_table_remove は失敗します。これは、参照先がなくなることを防ぐためです。

    以下の Bookmarks.log_20160320 カラムは対象シャードを参照しています。

    実行例:

    table_create  Logs_20160320 TABLE_NO_KEY
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Logs_20160320 timestamp COLUMN_SCALAR Time
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_create Bookmarks TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Bookmarks log_20160320 COLUMN_SCALAR Logs_20160320
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    デフォルトでは logical_table_remove で Logs_20160320 を削除できません。

    実行例:

    logical_table_remove \
      --logical_table Logs \
      --shard_key timestamp
    # [
    #   [
    #     -2,
    #     1337566253.89858,
    #     0.000355720520019531,
    #     "operation not permitted: <[table][remove] a column that references the table exists: <Bookmarks.log_20160320> -> <Logs_20160320",
    #     [
    #       [
    #         "Groonga::Sharding::LogicalTableRemoveCommand.remove_table",
    #         "/home/kou/work/c/groonga.clean/plugins/sharding/logical_table_remove.rb",
    #         80
    #       ]
    #     ]
    #   ]
    # ]

    --dependent yes パラメーター付きの logical_table_remove では Logs_20160320 を削除できます。 Bookmarks.log_20160320 も一緒に削除します。

    実行例:

    logical_table_remove \
      --logical_table Logs \
      --shard_key timestamp \
      --dependent yes
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    object_exist で Logs_20160320 テーブルと Bookmarks.log_20160320 カラムが削除されていることを確認できます。

    実行例:

    object_exist Logs_20160320
    # [[0, 1337566253.89858, 0.000355720520019531], false]
    object_exist Bookmarks.log_20160320
    # [[0, 1337566253.89858, 0.000355720520019531], false]

    対象シャード用のテーブルが1つ以上ある場合、 --dependent yes 付きの logical_table_remove はそれらも一緒に削除します。 対象シャード用のテーブルかどうかは対象シャードと同じ _YYYYMMDD がテーブル名の末尾にあるかどうかで判断します。

    末尾が _20160320 のテーブルは2つあります。 NotRelated_20160320 テーブルは Logs_20160320 テーブルから使われていません。 Users_20160320 テーブルは Logs_20160320 テーブルが使っています。 Servers テーブルもあり、これは Logs_20160320 テーブルが使っています。

    実行例:

    table_create  NotRelated_20160320 TABLE_PAT_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_create  Users_20160320 TABLE_PAT_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_create  Servers TABLE_PAT_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_create  Logs_20160320 TABLE_NO_KEY
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Logs_20160320 timestamp COLUMN_SCALAR Time
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Logs_20160320 user COLUMN_SCALAR Users_20160320
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Logs_20160320 server COLUMN_SCALAR Servers
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    --dependent yes パラメーター付きの``logical_table_remove`` は Logs_20160320 テーブルと Users_20160320 テーブルだけ削除します。なぜなら、 Users_20160320 テーブルは名前の末尾が _20160320 で、 Logs_20160320 テーブルが使っているからです。 NotRelated_20160320 テーブルと Servers テーブルは削除しません。なぜなら、 NotRelated_20160320 は名前の末尾が _20160320 ですが、 Logs_20160320 テーブルは使っていないからです。 Servers テーブルは Logs_20160320 テーブルが使っていますが、名前の末尾は _20160320 ではありません。

    実行例:

    logical_table_remove \
      --logical_table Logs \
      --shard_key timestamp \
      --dependent yes
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    Logs_20160320 テーブルと Users_20160320 テーブルは削除されていて、 NotRelated_20160320 テーブルと Servers テーブルは削除されていないことを確認します。

    実行例:

    object_exist Logs_20160320
    # [[0, 1337566253.89858, 0.000355720520019531], false]
    object_exist Users_20160320
    # [[0, 1337566253.89858, 0.000355720520019531], false]
    object_exist NotRelated_20160320
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    object_exist Servers
    # [[0, 1337566253.89858, 0.000355720520019531], true]

  利用リソースの削減

このコマンドが使うリソースを削減できます。詳細は table-remove-decreases-used-resources を参照してください。なぜなら logical_table_remove は table_remove と同じロジックを使っているからです。

  引数

このセクションでは logical_table_remove の引数について説明します。

  必須引数

いくつか必須の引数があります。

  logical_table

論理テーブル名を指定します。これは "_YYYYMMDD" をテーブル名から除いたものです。実際のテーブルが "Logs_20150203" や "Logs_20150203" といったものなら、論理テーブル名は "Logs" です。

logical-select-logical-table も参照してください。

  shard_key

シャードキーとして使うカラム名を指定します。

logical-select-shard-key も参照してください。

  省略可能引数

いくつか省略可能な引数があります。

  min

shard_key カラムの最小値を指定します。

logical-select-min も参照してください。

  min_border

最小値を含めるかどうかを指定します。 include か exclude を指定します。デフォルトは include です。

logical-select-min-border も参照してください。

  max

shard_key カラムの最大値を指定します。

logical-select-max も参照してください。

  max_border

最大値を含めるかどうかを指定します。 include か exclude を指定します。デフォルトは include です。

logical-select-max-border も参照してください。

  dependent

バージョン 6.0.1 で追加.

対象シャードに依存しているテーブル・カラムも一緒に削除するかどうかを指定します。

以下が依存していると判断する条件です。もし、テーブル・カラムがこれらの条件のどれか1つでも満たしていてれば、そのテーブル・カラムは対象シャードに依存しています。

•   対象シャードを参照しているテーブル・カラム

•   対象シャード用のテーブル（= 名前の末尾が対象シャードと同じ _YYYYMMDD で、対象シャードが参照しているテーブル)

    yes を指定した場合は、対象シャードに依存しているテーブル・カラムも削除します。 yes を指定しなければ削除しません。もし、対象シャードを参照しているテーブル・カラムが1つ以上あればエラーになります。もし、対象シャード用のテーブルがあっても、それらを削除しません。

    このパラメーターは注意して使ってください。危険なパラメーターです。

    このパラメーターの使い方は 関連するテーブルと一緒に削除 を参照してください。

  戻り値

このコマンドが成功したときは以下のようにボディは true になります:

[HEADER, true]

このコマンドが失敗すると、 HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

  normalize

注釈: このコマンドは実験的な機能です。

このコマンドは将来的に変更されるかもしれません。

  概要

normalize コマンドは指定したノーマライザーでテキストを正規化します。

normalize コマンドを使うのにテーブルを作成する必要はありません。このコマンドは、ノーマライザーの結果を確認するのに便利です。

  構文

このコマンドの引数は3つです。

normalizer と string が必須です。他は省略できます:

normalize normalizer
          string
          [flags=NONE]

  使い方

以下は normalize コマンドの簡単な使用例です。

実行例:

normalize NormalizerAuto "aBcDe 123"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "normalized": "abcde 123",
#     "types": [],
#     "checks": []
#   }
# ]

  引数

このセクションでは normalizer の引数について説明します。

  必須引数

必須引数は二つあります。 normalizer と string です。

  normalizer

ノーマライザー名を指定します。 normalize コマンドは normalizer で指定された名前のノーマライザーを使います。

組み込みのノーマライザーの一覧は /reference/normalizers にあります。

以下は NormalizerAuto ノーマライザーを使う例です。

TODO

他のノーマライザーを使いたい場合は、 register コマンドでノーマライザープラグインを登録する必要があります。例えば、 groonga-normalizer-mysql を登録することでMySQL互換の正規化方法を使うことができます。

  string

正規化したい文字列を指定します。

string の中に文字列を含める場合は、シングルクォート（ ' ）またはダブルクォート（ " ）で string をクォートする必要があります。

string の中で空白を使う例です。

TODO

  省略可能引数

いくつか省略可能な引数があります。

  flags

ノーマライズ処理をカスタマイズするオプションを指定します。「 | 」で区切って複数のオプションを指定することができます。例えば、 REMOVE_BLANK|WITH_TYPES というように指定できます。

指定可能なフラグは以下の通りです。
フラグ | 説明
NONE | 無視されます。
REMOVE_BLANK | TODO
WITH_TYPES | TODO
WITH_CHECKS | TODO
REMOVE_TOKENIZED_DELIMITER | TODO

以下は REMOVE_BLANK を使った例です。

TODO

以下は WITH_TYPES を使った例です。

TODO

以下は REMOVE_TOKENIZED_DELIMITER を使った例です。

TODO

  戻り値

[HEADER, normalized_text]

HEADER HEADER については /reference/command/output_format を参照してください。

normalized_text normalized_text はオブジェクトです。このオブジェクトは以下の属性を持っています。
名前 | 説明
normalized | 正規化されたテキスト。
types | 正規化されたテキストのtype(文字種別)の配列です。N番目の types は正規化されたテキストのN番目の文字のtype(文字種別)を示しています。

  参考

•   /reference/normalizers

  normalizer_list

  概要

normalizer_list コマンドはデータベースに登録されているノーマライザーの一覧を返します。

  構文

このコマンドに引数はありません:

normalizer_list

  使い方

以下は簡単な使用例です。

実行例:

normalizer_list
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "name": "NormalizerAuto"
#     },
#     {
#       "name": "NormalizerNFKC51"
#     }
#   ]
# ]

データベースに登録されているノーマライザーの一覧を返します。

  戻り値

normalizer_list コマンドはノーマライザーの一覧を返します。各ノーマライザーは属性を持っています。例えば名前です。将来、属性は増えるかもしれません。:

[HEADER, normalizers]

HEADER HEADER については /reference/command/output_format を参照してください。

normalizers normalizers はノーマライザーの配列です。ノーマライザーは次の属性を持つオブジェクトです。
名前 | 説明
name | ノーマライザー名。

  参考

•   /reference/normalizers

•   /reference/commands/normalize

  object_exist

  概要

バージョン 5.0.6 で追加.

object_exist は指定した名前のオブジェクトがデータベースに存在するかどうかを返します。

これは軽い操作です。データベース内に名前が存在するかだけをチェックします。ディスクから該当オブジェクトをロードしません。

object_exist はオブジェクトの種類をチェックしません。存在しているオブジェクトはテーブルかもしれませんし、カラムや関数かもしれません。

  構文

このコマンドの引数は1つで必須です:

object_exist name

  使い方

データベース内で指定した名前がすでに使われているかをチェックできます。

実行例:

object_exist Users
# [[0, 1337566253.89858, 0.000355720520019531], false]
table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
object_exist Users
# [[0, 1337566253.89858, 0.000355720520019531], true]

object_exist Users は Users テーブルを作る前は false を返します。

object_exist Users は Users テーブルを作った後は true を返します。

  引数

このセクションではすべての引数について説明します。

  必須引数

1つだけ必須の引数があります。

  name

チェック対象のオブジェクト名を指定してください。

カラムが存在するかどうかをチェックしたいときは、次のように テーブル名.カラム名 という書式を使ってください。

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
object_exist Logs.timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]

Logs.timestamp 内の Logs がテーブル名で timestamp がカラム名です。

  省略可能引数

省略可能な引数はありません。

  戻り値

データベース内に指定した名前のオブジェクトが存在するときは、このコマンドは以下のようにボディとして true を返します:

[HEADER, true]

そうでない場合は false を返します:

[HEADER, false]

HEADER については /reference/command/output_format を参照してください。

  object_inspect

  概要

バージョン 6.0.0 で追加.

object_inspect はオブジェクトを調査します。オブジェクトの詳細を確認することができます。

例：

•   オブジェクトがテーブルの場合、テーブル内のレコード数を確認できます。

•   オブジェクトがカラムの場合、値の型を確認できます。

  構文

このコマンドの引数は1つで省略できます:

object_inspect [name=null]

  使い方

name で指定したデータベース内のオブジェクトを調査できます。

実行例:

table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "Alice"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
object_inspect Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "name": "Users",
#     "n_records": 1,
#     "value": {
#       "type": null
#     },
#     "key": {
#       "total_size": 5,
#       "max_total_size": 4294967295,
#       "type": {
#         "size": 4096,
#         "type": {
#           "id": 32,
#           "name": "type"
#         },
#         "id": 14,
#         "name": "ShortText"
#       }
#     },
#     "type": {
#       "id": 48,
#       "name": "table:hash_key"
#     },
#     "id": 256
#   }
# ]

object_inspect Users は以下の情報を返します。

•   テーブル名： "name": Users

•   総キーサイズ： "key": {"total_size": 5} （ "Alice" は5バイトのデータです。）

•   最大総キーサイズ： "key": {"max_total_size": 4294967295}

•   などなど。

    name を指定しないとデータベースを調査できます。

    実行例:

    object_inspect
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   {
    #     "name_table": {
    #       "name": "",
    #       "n_records": 256,
    #       "value": null,
    #       "key": {
    #         "type": null
    #       },
    #       "type": {
    #         "id": 50,
    #         "name": "table:dat_key"
    #       },
    #       "id": 0
    #     },
    #     "type": {
    #       "id": 55,
    #       "name": "db"
    #     }
    #   }
    # ]

    object_inspect は以下の情報を返します。

•   オブジェクトの名前管理をしているテーブルの種類： "key": {"type": {"name": "table:dat_key"}}

•   などなど。

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数はありません。

  省略可能引数

省略可能な引数が1つあります。

  name

調査対象のオブジェクト名を指定してください。

name を指定しないとデータベースを調査します。

  戻り値

このコマンドはボディとしてオブジェクト（たとえばテーブル）の詳細を含んだオブジェクト（ネストしたキーと値のペア）を返します。:

[HEADER, object]

HEADER については /reference/command/output_format を参照してください。

オブジェクトの詳細のフォーマットはオブジェクトの種類に依存します。たとえば、テーブルはキーの情報を含みますが、関数はキーの情報を含みません。

  データベース

データベースを調査すると次の情報を返します。:

{
  "type": {
    "id": DATABASE_TYPE_ID,
    "name": DATABASE_TYPE_NAME
  },
  "name_table": DATABASE_NAME_TABLE
}

  DATABASE_TYPE_ID

DATABASE_TYPE_ID は常に 55 です。

  DATABASE_TYPE_NAME

DATABASE_TYPE_NAME は常に "db" です。

  DATABASE_NAME_TABLE

DATABASE_NAME_TABLE はデータベース内のオブジェクト名を管理するテーブルです。このテーブルは table-pat-key または table-dat-key です。通常、 table-dat-key です。

フォーマットの詳細は テーブル を参照してください。

  テーブル

テーブルを調査すると次の情報を返します。:

{
  "name": TABLE_NAME,
  "type": {
    "id": TABLE_TYPE_ID,
    "name": TABLE_TYPE_NAME
  },
  "key": {
    "type": TABLE_KEY_TYPE,
    "total_size": TABLE_KEY_TOTAL_SIZE
    "max_total_size": TABLE_KEY_MAX_TOTAL_SIZE
  },
  "value": {
    "type": TABLE_VALUE_TYPE,
  },
  "n_records": TABLE_N_RECORDS
}

いくつか例外があります。

•   table-no-key はキーの情報を返しません。なぜならキーを持っていないからです。

•   table-dat-key は値の情報を返しません。なぜなら値を持っていないからです。

  TABLE_NAME

調査対象のテーブルの名前。

  TABLE_TYPE_ID

調査対象のテーブルの種類のID

以下は種類のIDのリストです。
テーブルの種類 | ID
table-hash-key | 48
table-pat-key | 49
table-dat-key | 50
table-no-key | 51

  TABLE_TYPE_NAME

調査対象のテーブルの種類の名前。

以下は種類の名前のリストです。
テーブルの種類 | 名前
table-hash-key | "table:hash_key"
table-pat-key | "table:pat_key"
table-dat-key | "table:dat_key"
table-no-key | "table:no_key"

  TABLE_KEY_TYPE

調査対象のテーブルのキーの型。

フォーマットの詳細は 型 を参照してください。

  TABLE_KEY_TOTAL_SIZE

調査対象のテーブルの総キーサイズ。単位はバイト。

  TABLE_KEY_MAX_TOTAL_SIZE

調査対象のテーブルの最大総キーサイズ。単位はバイト。

  TABLE_VALUE_TYPE

調査対象のテーブルの値の型。

フォーマットの詳細は 型 を参照してください。

  TABLE_N_RECORDS

調査対象のテーブルのレコード数。

64bitの正の整数です。

  型

型を調査すると次の情報を返します。

{
  "id": TYPE_ID,
  "name": TYPE_NAME,
  "type": {
    "id": TYPE_ID_OF_TYPE,
    "name": TYPE_NAME_OF_TYPE
  },
  "size": TYPE_SIZE
}

  TYPE_ID

対象の型のIDです。

以下は組み込みの型のIDのリストです。
型 | ID
builtin-type-bool | 3
builtin-type-int8 | 4
builtin-type-uint8 | 5
builtin-type-int16 | 6
builtin-type-uint16 | 7
builtin-type-int32 | 8
builtin-type-uint32 | 9
builtin-type-int64 | 10
builtin-type-uint64 | 11
builtin-type-float | 12
builtin-type-time | 13
builtin-type-short-text | 14
builtin-type-text | 15
builtin-type-long-text | 16
builtin-type-tokyo-geo-point | 17
builtin-type-wgs84-geo-point | 18

  TYPE_NAME

調査対象の型の名前。

以下は組み込みの型の名前のリストです。

•   builtin-type-bool

•   builtin-type-int8

•   builtin-type-uint8

•   builtin-type-int16

•   builtin-type-uint16

•   builtin-type-int32

•   builtin-type-uint32

•   builtin-type-int64

•   builtin-type-uint64

•   builtin-type-float

•   builtin-type-time

•   builtin-type-short-text

•   builtin-type-text

•   builtin-type-long-text

•   builtin-type-tokyo-geo-point

•   builtin-type-wgs84-geo-point

  TYPE_ID_OF_TYPE

TYPE_ID_OF_TYPE は常に 32 です。

  TYPE_NAME_OF_TYPE

TYPE_NAME_OF_TYPE は常に type です。

  TYPE_SIZE

TYPE_SIZE は調査対象の型のサイズです。単位はバイトです。調査対象の型が可変長型の場合は、サイズは最大サイズという意味です。

  object_remove

  概要

バージョン 6.0.0 で追加.

object_remove はオブジェクトを削除します。テーブル・カラム・コマンドなどあらゆるオブジェクトを削除できます。通常は table_remove 、 column_remove といった対象オブジェクト専用のコマンドを使うべきです。

object_remove はあらゆるオブジェクトを削除できるため危険です。 object_remove を使うときは注意してください。

object_remove には「強制モード」があります。「強制モード」を使うと壊れたオブジェクトを削除できます。「強制モード」は /reference/executables/grndb が報告した問題を解決するために有用です。

  構文

このコマンドには2つの引数があります。:

object_remove name
              [force=no]

  使い方

name で指定したデータベース内のオブジェクトを削除できます。

実行例:

object_remove Users
# [
#   [
#     -22,
#     1337566253.89858,
#     0.000355720520019531,
#     "[object][remove] target object doesn't exist: <Users>",
#     [
#       [
#         "command_object_remove",
#         "proc_object.c",
#         121
#       ]
#     ]
#   ],
#   false
# ]
table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
object_remove Users
# [[0, 1337566253.89858, 0.000355720520019531], true]

object_remove Users は Users テーブルを作る前は false を返します。

object_remove Users は Users テーブルを作った後は true を返します。

デフォルトでは壊れたオブジェクトを削除することはできません。

実行例:

table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
thread_limit 1
# [[0, 1337566253.89858, 0.000355720520019531], 1]
database_unmap
# [[0, 1337566253.89858, 0.000355720520019531], true]
echo "BROKEN" > ${DB_PATH}.0000100
object_remove Users
# [
#   [
#     -22,
#     1337566253.89858,
#     0.000355720520019531,
#     "[object][remove] failed to open the target object: <Users>",
#     [
#       [
#         "command_object_remove",
#         "proc_object.c",
#         116
#       ]
#     ]
#   ],
#   false
# ]
object_exist Users
# [[0, 1337566253.89858, 0.000355720520019531], true]

force yes を指定することで壊れたオブジェクトを削除できます。

実行例:

object_remove Users --force yes
# [
#   [
#     -65,
#     1337566253.89858,
#     0.000355720520019531,
#     "[io][open] file size is too small: <7>(required: >= 64): </tmp/groonga-databases/commands_object_remove.0000100>",
#     [
#       [
#         "grn_io_open",
#         "io.c",
#         565
#       ]
#     ]
#   ],
#   false
# ]
object_exist Users
# [[0, 1337566253.89858, 0.000355720520019531], false]

--force yes は「強制モード」を有効にするという意味です。「強制モード」では壊れたオブジェクトを削除することができます。

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数は1つです。

  name

削除するテーブルの名前を指定します。

カラムを削除したいときは、次のように テーブル名.カラム名 という書式を使ってください。

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
object_remove Logs.timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]

Logs.timestamp 内の Logs がテーブル名で timestamp がカラム名です。

  省略可能引数

省略可能な引数が1つあります。

  force

「強制モード」でオブジェクトを削除するかどうかを指定します。

デフォルトでは壊れたオブジェクトを削除できません。しかし、「強制モード」を使えば壊れたオブジェクトを削除できます。

force の値は yes または no でなければいけません。 yes は「強制モード」を有効にするという意味です。 no は「強制モード」を無効にするという意味です。

デフォルト値は no です。デフォルトでは「強制モード」は無効ということです。

  戻り値

エラーなしでデータベース内に指定した名前のオブジェクトを削除したときはボディは true をになります。例:

[HEADER, true]

このコマンドを実行している最中になにかしらエラーが発生したときはボディは false になります。例:

[HEADER, false]

HEADER については /reference/command/output_format を参照してください。

false が「このコマンドはオブジェクトを削除できなかった」ということを表すわけではないことに注意してください。「強制モード」を有効にすると、オブジェクトが壊れていても削除します。この場合、オブジェクトは削除されますが、ボディは false になります。

  plugin_register

バージョン 5.0.1 で追加.

  概要

plugin_register コマンドはプラグインを登録します。プラグインを使う前にプラグインを登録する必要があります。

同じデータベースに対しては1つのプラグインについて一度だけ plugin_register コマンドを実行すれば十分です。これは、登録されたプラグイン情報はデータベースに記録されているからです。 groonga プロセスを再起動したときは、 register コマンドを実行しなくてもすでに登録されているプラグインを読み込みます。

plugin_unregister でプラグインの登録を解除することができます。

  構文

このコマンドの引数は1つで必須です:

plugin_register name

  使い方

これは ${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so に含まれている QueryExpanderTSV クエリー展開オブジェクトを登録する例です。

実行例:

plugin_register query_expanders/tsv
# [[0, 1337566253.89858, 0.000355720520019531], true]

${PREFIX}/lib/groonga/plugins/ と拡張子（ .so ）は省略可能です。これらは自動で補完されます。

plugin_register /usr/lib/groonga/plugins/query_expanders/tsv.so というように絶対パスを指定することもできます。

  戻り値

plugin_register が成功したときは以下のようにボディは true になります:

[HEADER, true]

plugin_register が失敗すると、エラーの詳細は HEADER に含まれます。

HEADER については /reference/command/output_format を参照してください。

  参考

•   plugin_unregister

  plugin_unregister

注釈: このコマンドは実験的な機能です。

バージョン 5.0.1 で追加.

  概要

plugin_unregister コマンドはプラグインの登録を解除します。

  構文

このコマンドの引数は1つで必須です:

plugin_unregister name

  使い方

これは ${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so に含まれている QueryExpanderTSV クエリー展開オブジェクトの登録を解除する例です。

実行例:

plugin_unregister query_expanders/tsv
# [[0, 1337566253.89858, 0.000355720520019531], true]

${PREFIX}/lib/groonga/plugins/ と拡張子（ .so ）は省略可能です。これらは自動で補完されます。

plugin_unregister /usr/lib/groonga/plugins/query_expanders/tsv.so というように絶対パスを指定することもできます。

  戻り値

plugin_unregister が成功したときは以下のようにボディは true になります:

[HEADER, true]

plugin_unregister が失敗すると、エラーの詳細は HEADER に含まれます。

HEADER については /reference/command/output_format を参照してください。

  参考

•   plugin_register

  quit

  概要

quit - セッション終了

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

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

  構文

quit

  使い方

quit

  引数

ありません。

  戻り値

ありません。

  range_filter

  概要

TODO: write me

  構文

  使い方

  戻り値

  参考

•   /reference/commands/select

  register

バージョン 5.0.1 で撤廃: Use plugin_register instead.

  概要

register コマンドはプラグインを登録します。プラグインを使う前にプラグインを登録する必要があります。

同じデータベースに対しては1つのプラグインについて一度だけ register` コマンドを実行すれば十分です。これは、登録されたプラグイン情報はデータベースに記録されているからです。 groonga プロセスを再起動したときは、 register コマンドを実行しなくてもすでに登録されているプラグインを読み込みます。

注釈: Registered plugins can be removed since Groonga 5.0.1. Use plugin_unregister in such a case.

  構文

このコマンドの引数は1つで必須です:

register path

  使い方

これは ${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so に含まれている QueryExpanderTSV クエリー展開オブジェクトを登録する例です。

実行例:

register query_expanders/tsv
# [[0, 1337566253.89858, 0.000355720520019531], true]

${PREFIX}/lib/groonga/plugins/ と拡張子（ .so ）は省略可能です。これらは自動で補完されます。

register /usr/lib/groonga/plugins/query_expanders/tsv.so というように絶対パスを指定することもできます。

  戻り値

register が成功したときは以下のようにボディは true になります:

[HEADER, true]

register が失敗すると、エラーの詳細は HEADER に含まれます。

HEADER については /reference/command/output_format を参照してください。

  参考

•   plugin_register

•   plugin_unregister

  reindex

  概要

バージョン 5.1.0 で追加.

reindex コマンドは1つ以上のインデックスカラムを作り直します。

対象オブジェクトにデータベースを指定するとすべてのインデックスカラムを作り直します。

対象オブジェクトにテーブルを指定すると、そのテーブル内のすべてのインデックスカラムを作り直します。

対象オブジェクトにデータカラムを指定すると、そのデータカラム用のすべてのインデックスカラムを作り直します。

対象オブジェクトにインデックスカラムを指定すると、そのインデックスカラムを作り直します。

このコマンドはインデックスカラムが壊れたときに便利です。対象オブジェクトはデータベース、テーブル、カラムのどれかです。

注釈: reindex コマンドを実行している間は対象インデックスカラムを使うことはできません。もし、複数のプロセスから同じデータベースを使っている場合、 reindex を実行したプロセス以外のすべてのプロセスはデータベースを開き直すべきです。データベースを開き直すには database_unmap を使えます。

  構文

このコマンドの引数は1つで省略できます:

reindex [target_name=null]

target_name パラメーターを省略した場合は対象オブジェクトはデータベースになります。これは、データベース中のすべてのインデックスカラムを作りなおすという意味です。

  使い方

以下はデータベースの中のすべてのインデックスカラムを作り直す例です。

実行例:

reindex
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Lexicon テーブルの中のすべてのインデックスカラム（ Lexicon.entry_key と Lexicon.entry_body ）を作り直す例です。

実行例:

table_create Entry TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entry body COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Lexicon TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon entry_key COLUMN_INDEX|WITH_POSITION \
  Entry _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon entry_body COLUMN_INDEX|WITH_POSITION \
  Entry body
# [[0, 1337566253.89858, 0.000355720520019531], true]
reindex Lexicon
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は Site.title データカラムのすべてのインデックスカラム（ BigramLexicon.site_title と RegexpLexicon.site_title ）を作り直す例です。

実行例:

table_create Site TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Site title COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create BigramLexicon TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create BigramLexicon site_title COLUMN_INDEX|WITH_POSITION \
  Site title
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create RegexpLexicon TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenRegexp \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create RegexpLexicon site_title COLUMN_INDEX|WITH_POSITION \
  Site title
# [[0, 1337566253.89858, 0.000355720520019531], true]
reindex Site.title
# [[0, 1337566253.89858, 0.000355720520019531], true]

以下は1つのインデックスカラム（ Timestamp.index ）を作り直す例です。

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Timestamp TABLE_PAT_KEY Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Timestamp logs_timestamp COLUMN_INDEX  Logs timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]
reindex Timestamp.logs_timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]

  引数

このセクションではすべての引数について説明します。

  target_name

テーブル名またはカラム名を指定します。

指定しなかったら対象オブジェクトはデータベースになります。

デフォルト値はありません。これは対象オブジェクトはデータベースになるということです。

  戻り値

reindex コマンドは作り直しが成功したかどうかを返します。:

[HEADER, SUCCEEDED_OR_NOT]

HEADER HEADER については /reference/command/output_format を参照してください。

SUCCEEDED_OR_NOT コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  request_cancel

  概要

注釈: このコマンドは実験的な機能です。

バージョン 4.0.9 で追加.

request_cancel コマンドは実行中のリクエストをキャンセルします。

いくつか制限があります。

•   リクエストIDはユーザーが管理する必要があります。（各リクエストに一意のキーを割り当てる必要があります。）

•   キャンセルリクエストは無視されることもあります。（同じリクエストIDに対して何度も request_cancel コマンドを送信することができます。）

•   マルチスレッド型のGroongaサーバーのみサポートしています。（ /reference/executables/groonga ベースのサーバーでは使えますが、 /reference/executables/groonga-httpd では使えません。）

    リクエストIDについては /reference/command/request_id を参照してください。

    リクエストがキャンセルされたら、キャンセルされたリクエストの /reference/command/return_code は -5 （ GRN_INTERRUPTED_FUNCTION_CALL ）になります。

  構文

このコマンドの引数は1つで必須です:

request_cancel id

  使い方

以下は request_cancel コマンドの使用例です:

$ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' &
# The above "select" takes a long time...
# Point: "request_id=unique-id-1"
$ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
[[...], {"id": "unique-id-1", "canceled": true}]
# Point: "id=unique-id-1"

最初の select コマンドが長時間かかると仮定します。 request_id=unique-id-1 パラメーターを指定することで unique-id-1 というリクエストIDをこの select コマンドに割り当てます。

2つめの request_cancel コマンドで id=unique-id-1 パラメーターを指定しています。 unique-id-1 は select コマンドに渡したリクエストIDと同じリクエストIDです。

この select コマンドはすぐにはキャンセルされないかもしれません。また、このキャンセルリクエストは無視されることもあります。

同じリクエストIDに対するキャンセルリクエストを複数回送ることができます。もし、対象のリクエストがキャンセルされたか終了した場合は戻り値の中の "canceled" の値が true から false に変わります。

$ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
[[...], {"id": "unique-id-1", "canceled": true}]
# "select" is still running... ("canceled" is "true")
$ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
[[...], {"id": "unique-id-1", "canceled": true}]
# "select" is still running... ("canceled" is "true")
$ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
[[...], {"id": "unique-id-1", "canceled": false}]
# "select" is canceled or finished. ("canceled" is "false")

もし、この select コマンドがキャンセルされたら、 select コマンドの /reference/command/return_code は -5 （ GRN_INTERRUPTED_FUNCTION_CALL ）になります。:

$ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' &
[[-5, ...], ...]

  引数

このセクションでは request_cancel の引数について説明します。

  必須引数

id だけが必須の引数です。

  id

対象リクエストのIDを指定します。

  戻り値

request_cancel コマンドはキャンセルリクエストの結果を返します。:

[
  HEADER,
  {
    "id":       ID,
    "canceled": CANCEL_REQUEST_IS_ACCEPTED_OR_NOT
  }
]

HEADER HEADER については /reference/command/output_format を参照してください。

ID 対象のリクエストのIDです。

CANCEL_REQUEST_IS_ACCEPTED_OR_NOT もし、このキャンセルリクエストが受け付けられたら true 、そうでなければ false になります。

「キャンセルリクエストが受け付けられた」というのは「対象リクエストがキャンセルされた」という意味ではないことに注意してください。これは「キャンセルリクエストは対象リクエストに通知したが、対象リクエストはそのキャンセルリクエストを無視するかもしれない」という意味です。

指定したリクエストIDが割り当てられているリクエストが存在しなければ false になります。

  参考

•   /reference/command/request_id

  ruby_eval

  概要

ruby_eval コマンドはRubyスクリプトを評価して評価結果を返します。

  構文

このコマンドの引数は1つで必須です:

ruby_eval script

  使い方

ruby_eval を使うと、mrubyがサポートしているスクリプトを実行できます。

Rubyスクリプトとして 1 + 2 という計算するだけの例です。

実行例:

register ruby/eval
# [[0, 1337566253.89858, 0.000355720520019531], true]
ruby_eval "1 + 2"
# [[0, 1337566253.89858, 0.000355720520019531], {"value": 3}]

ruby_eval コマンドを使うには事前に ruby/eval プラグインを登録します。

ruby_eval コマンドは実験的なプラグインです。このコマンドは将来的に変更されるかもしれません。

  引数

このセクションではすべての引数について説明します。

  script

評価したいrubyスクリプトを指定します。

  戻り値

ruby_eval は例外情報などのメタデータつきで評価結果を返します（メタデータはまだ実装されていないので今のところ含まれません）:

[HEADER, {"value": EVALUATED_VALUE}]

HEADER HEADER については /reference/command/output_format を参照してください。

EVALUATED_VALUE EVALUATED_VALUE は ruby_script を評価した値です。

今のところ、 ruby_eval は評価された値として数値だけサポートしています。サポートしている型は今後増えていく予定です。

  参考

  ruby_load

  概要

ruby_load コマンドは指定したRubyスクリプトを読み込みます。

  構文

このコマンドの引数は1つで必須です:

ruby_load path

  使い方

ruby_load を使ってmrubyがサポートしているスクリプトを読み込むことができます。

Rubyスクリプトとして expression.rb を単に読み込む例です。

実行例:

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

ruby_load コマンドを使うには事前に ruby/load プラグインを登録します。

ruby_load コマンドは実験的なプラグインです。このコマンドは将来的に変更されるかもしれません。

  引数

このセクションではすべての引数について説明します。

  path

読み込みたいrubyスクリプトを指定します。

  戻り値

ruby_load は例外情報などのメタデータつきで読み込んだ結果を返します（メタデータはまだ実装されていないので今のところ含まれません）:

[HEADER, {"value": LOADED_VALUE}]

HEADER HEADER については /reference/command/output_format を参照してください。

LOADED_VALUE LOADED_VALUE はrubyスクリプトを読み込んだ結果です。

ruby_load は LOADED_VALUE としていまのところは単に null を返します。将来的には LOADED_VALUE がサポートされる予定です。

  参考

/reference/commands/ruby_eval

  schema

  概要

バージョン 5.0.9 で追加.

schema コマンドはデータベース内のスキーマを返します。

このコマンドはデータベースの詳細を知りたいときに便利です。たとえば、データベースを視覚化したり、データベースのGUIを作ったりするときに便利です。

  構文

このコマンドに引数はありません:

schema

  使い方

以下は出力例を示すためのサンプルスキーマです。

実行例:

table_create Memos TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms memos_content_index \
  COLUMN_INDEX|WITH_POSITION \
  Memos content
# [[0, 1337566253.89858, 0.000355720520019531], true]

このサンプルスキーマに対する schema コマンドの出力は次の通りです。

実行例:

schema
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "tables": {
#       "Terms": {
#         "normalizer": {
#           "name": "NormalizerAuto"
#         },
#         "name": "Terms",
#         "tokenizer": {
#           "name": "TokenBigram"
#         },
#         "command": {
#           "command_line": "table_create --name Terms --flags TABLE_PAT_KEY --key_type ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto",
#           "name": "table_create",
#           "arguments": {
#             "key_type": "ShortText",
#             "default_tokenizer": "TokenBigram",
#             "normalizer": "NormalizerAuto",
#             "flags": "TABLE_PAT_KEY",
#             "name": "Terms"
#           }
#         },
#         "indexes": [],
#         "key_type": {
#           "type": "type",
#           "name": "ShortText"
#         },
#         "value_type": null,
#         "token_filters": [],
#         "type": "patricia trie",
#         "columns": {
#           "memos_content_index": {
#             "name": "memos_content_index",
#             "weight": false,
#             "section": false,
#             "compress": null,
#             "command": {
#               "command_line": "column_create --table Terms --name memos_content_index --flags COLUMN_INDEX|WITH_POSITION --type Memos --sources content",
#               "name": "column_create",
#               "arguments": {
#                 "table": "Terms",
#                 "flags": "COLUMN_INDEX|WITH_POSITION",
#                 "name": "memos_content_index",
#                 "sources": "content",
#                 "type": "Memos"
#               }
#             },
#             "indexes": [],
#             "sources": [
#               {
#                 "table": "Memos",
#                 "name": "content",
#                 "full_name": "Memos.content"
#               }
#             ],
#             "value_type": {
#               "type": "reference",
#               "name": "Memos"
#             },
#             "full_name": "Terms.memos_content_index",
#             "position": true,
#             "table": "Terms",
#             "type": "index"
#           }
#         }
#       },
#       "Memos": {
#         "normalizer": null,
#         "name": "Memos",
#         "tokenizer": null,
#         "command": {
#           "command_line": "table_create --name Memos --flags TABLE_HASH_KEY --key_type ShortText",
#           "name": "table_create",
#           "arguments": {
#             "key_type": "ShortText",
#             "flags": "TABLE_HASH_KEY",
#             "name": "Memos"
#           }
#         },
#         "indexes": [],
#         "key_type": {
#           "type": "type",
#           "name": "ShortText"
#         },
#         "value_type": null,
#         "token_filters": [],
#         "type": "hash table",
#         "columns": {
#           "content": {
#             "name": "content",
#             "weight": false,
#             "section": false,
#             "compress": null,
#             "command": {
#               "command_line": "column_create --table Memos --name content --flags COLUMN_SCALAR --type Text",
#               "name": "column_create",
#               "arguments": {
#                 "table": "Memos",
#                 "flags": "COLUMN_SCALAR",
#                 "name": "content",
#                 "type": "Text"
#               }
#             },
#             "indexes": [
#               {
#                 "table": "Terms",
#                 "section": 0,
#                 "name": "memos_content_index",
#                 "full_name": "Terms.memos_content_index"
#               }
#             ],
#             "sources": [],
#             "value_type": {
#               "type": "type",
#               "name": "Text"
#             },
#             "full_name": "Memos.content",
#             "position": false,
#             "table": "Memos",
#             "type": "scalar"
#           }
#         }
#       }
#     },
#     "normalizers": {
#       "NormalizerNFKC51": {
#         "name": "NormalizerNFKC51"
#       },
#       "NormalizerAuto": {
#         "name": "NormalizerAuto"
#       }
#     },
#     "token_filters": {},
#     "tokenizers": {
#       "TokenBigramSplitSymbolAlphaDigit": {
#         "name": "TokenBigramSplitSymbolAlphaDigit"
#       },
#       "TokenRegexp": {
#         "name": "TokenRegexp"
#       },
#       "TokenBigramIgnoreBlankSplitSymbolAlphaDigit": {
#         "name": "TokenBigramIgnoreBlankSplitSymbolAlphaDigit"
#       },
#       "TokenBigram": {
#         "name": "TokenBigram"
#       },
#       "TokenDelimit": {
#         "name": "TokenDelimit"
#       },
#       "TokenUnigram": {
#         "name": "TokenUnigram"
#       },
#       "TokenBigramSplitSymbol": {
#         "name": "TokenBigramSplitSymbol"
#       },
#       "TokenDelimitNull": {
#         "name": "TokenDelimitNull"
#       },
#       "TokenBigramIgnoreBlankSplitSymbolAlpha": {
#         "name": "TokenBigramIgnoreBlankSplitSymbolAlpha"
#       },
#       "TokenBigramSplitSymbolAlpha": {
#         "name": "TokenBigramSplitSymbolAlpha"
#       },
#       "TokenTrigram": {
#         "name": "TokenTrigram"
#       },
#       "TokenMecab": {
#         "name": "TokenMecab"
#       },
#       "TokenBigramIgnoreBlankSplitSymbol": {
#         "name": "TokenBigramIgnoreBlankSplitSymbol"
#       },
#       "TokenBigramIgnoreBlank": {
#         "name": "TokenBigramIgnoreBlank"
#       }
#     },
#     "plugins": {},
#     "types": {
#       "UInt64": {
#         "can_be_key_type": true,
#         "name": "UInt64",
#         "can_be_value_type": true,
#         "size": 8
#       },
#       "Int32": {
#         "can_be_key_type": true,
#         "name": "Int32",
#         "can_be_value_type": true,
#         "size": 4
#       },
#       "Int16": {
#         "can_be_key_type": true,
#         "name": "Int16",
#         "can_be_value_type": true,
#         "size": 2
#       },
#       "LongText": {
#         "can_be_key_type": false,
#         "name": "LongText",
#         "can_be_value_type": false,
#         "size": 2147483648
#       },
#       "TokyoGeoPoint": {
#         "can_be_key_type": true,
#         "name": "TokyoGeoPoint",
#         "can_be_value_type": true,
#         "size": 8
#       },
#       "Text": {
#         "can_be_key_type": false,
#         "name": "Text",
#         "can_be_value_type": false,
#         "size": 65536
#       },
#       "ShortText": {
#         "can_be_key_type": true,
#         "name": "ShortText",
#         "can_be_value_type": false,
#         "size": 4096
#       },
#       "Float": {
#         "can_be_key_type": true,
#         "name": "Float",
#         "can_be_value_type": true,
#         "size": 8
#       },
#       "UInt8": {
#         "can_be_key_type": true,
#         "name": "UInt8",
#         "can_be_value_type": true,
#         "size": 1
#       },
#       "UInt32": {
#         "can_be_key_type": true,
#         "name": "UInt32",
#         "can_be_value_type": true,
#         "size": 4
#       },
#       "Object": {
#         "can_be_key_type": true,
#         "name": "Object",
#         "can_be_value_type": true,
#         "size": 8
#       },
#       "UInt16": {
#         "can_be_key_type": true,
#         "name": "UInt16",
#         "can_be_value_type": true,
#         "size": 2
#       },
#       "Int64": {
#         "can_be_key_type": true,
#         "name": "Int64",
#         "can_be_value_type": true,
#         "size": 8
#       },
#       "Time": {
#         "can_be_key_type": true,
#         "name": "Time",
#         "can_be_value_type": true,
#         "size": 8
#       },
#       "Bool": {
#         "can_be_key_type": true,
#         "name": "Bool",
#         "can_be_value_type": true,
#         "size": 1
#       },
#       "WGS84GeoPoint": {
#         "can_be_key_type": true,
#         "name": "WGS84GeoPoint",
#         "can_be_value_type": true,
#         "size": 8
#       },
#       "Int8": {
#         "can_be_key_type": true,
#         "name": "Int8",
#         "can_be_value_type": true,
#         "size": 1
#       }
#     }
#   }
# ]

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数はありません。

  省略可能引数

省略可能な引数はありません。

  戻り値

schema はこのデータベースのスキーマを返します。:

[HEADER, SCHEMA]

  HEADER

HEADER については /reference/command/output_format を参照してください。

  SCHEMA

SCHEMA は以下の情報を含んだオブジェクトです。:

{
  "plugins":       PLUGINS,
  "types":         TYPES,
  "tokenizers":    TOKENIZERS,
  "normalizers":   NORMALIZERS,
  "token_filters": TOKEN_FITLERS,
  "tables":        TABLES
}

  PLUGINS

PLUGINS はオブジェクトです。キーはプラグイン名で値はプラグインの詳細です。:

{
  "PLUGIN_NAME_1": PLUGIN_1,
  "PLUGIN_NAME_2": PLUGIN_2,
  ...
  "PLUGIN_NAME_n": PLUGIN_n
}

  PLUGIN

PLUGIN はプラグインの詳細を示すオブジェクトです。

{
  "name": PLUGIN_NAME
}

以下は PLUGIN のプロパティです。
名前 | 説明
name | プラグイン名。 plugin_register で使います。

  TYPES

TYPES はオブジェクトです。キーは型名で、値は型の詳細です。:

{
  "TYPE_NAME_1": TYPE_1,
  "TYPE_NAME_2": TYPE_2,
  ...
  "TYPE_NAME_n": TYPE_n
}

  TYPE

TYPE は型の詳細を示すオブジェクトです。:

{
  "name": TYPE_NAME,
  "size": SIZE_OF_ONE_VALUE_IN_BYTE,
  "can_be_key_type": BOOLEAN,
  "can_be_value_type": BOOLEAN
}

以下は TYPE のプロパティです。
名前 | 説明
name | 型名。
size | 1つの値のバイト数です。
can_be_key_type | この型をテーブルのキーの型に使えるなら true 、そうでないなら false 。
can_be_value_type | この型をテーブルの値の型に使えるなら true 、そうでないなら false 。

  TOKENIZERS

TOKENIZERS はオブジェクトです。キーはトークナイザー名で値はトークナイザーの詳細です。:

{
  "TOKENIZER_NAME_1": TOKENIZER_1,
  "TOKENIZER_NAME_2": TOKENIZER_2,
  ...
  "TOKENIZER_NAME_n": TOKENIZER_n
}

  TOKENIZER

TOKENIZER はトークナイザーの詳細を示すオブジェクトです。:

{
  "name": TOKENIZER_NAME
}

以下は TOKENIZER のプロパティです。
名前 | 説明
name | トークナイザー名。 table-create-default-tokenizer で使います。

  NORMALIZERS

NORMALIZERS はオブジェクトです。キーはノーマライザー名で値はノーマライザーの詳細です。:

{
  "NORMALIZER_NAME_1": NORMALIZER_1,
  "NORMALIZER_NAME_2": NORMALIZER_2,
  ...
  "NORMALIZER_NAME_n": NORMALIZER_n
}

  NORMALIZER

NORMALIZER はノーマライザーの詳細を示すオブジェクトです。:

{
  "name": NORMALIZER_NAME
}

以下は NORMALIZER のプロパティです。
名前 | 説明
name | ノーマライザー名。 table-create-normalizer で使います。

  TOKEN_FILTERS

TOKEN_FILTERS はオブジェクトです。キーはトークンフィルター名で値はトークンフィルターの詳細です。:

{
  "TOKEN_FILTER_NAME_1": TOKEN_FILTER_1,
  "TOKEN_FILTER_NAME_2": TOKEN_FILTER_2,
  ...
  "TOKEN_FILTER_NAME_n": TOKEN_FILTER_n
}

  TOKEN_FILTER

TOKEN_FILTER はトークンフィルターの詳細を示すオブジェクトです。:

{
  "name": TOKEN_FILTER_NAME
}

以下は TOKEN_FILTER のプロパティです。
名前 | 説明
name | トークンフィルター名。 table-create-token-filters で使います。

  TABLES

TABLES はオブジェクトです。キーはテーブル名で値はテーブルの詳細です。:

{
  "TABLE_NAME_1": TABLE_1,
  "TABLE_NAME_2": TABLE_2,
  ...
  "TABLE_NAME_n": TABLE_n
}

  TABLE

TABLE はテーブルの詳細を示すオブジェクトです。

{
  "name": TABLE_NAME
  "type": TYPE,
  "key_type": KEY_TYPE,
  "value_type": VALUE_TYPE,
  "tokenizer": TOKENIZER,
  "normalizer": NORMALIZER,
  "token_filters": [
    TOKEN_FILTER_1,
    TOKEN_FILTER_2,
    ...,
    TOKEN_FILTER_n,
  ],
  "indexes": [
    INDEX_1,
    INDEX_2,
    ...,
    INDEX_n
  ],
  "command": COMMAND,
  "columns": {
    "COLUMN_NAME_1": COLUMN_1,
    "COLUMN_NAME_2": COLUMN_2,
    ...,
    "COLUMN_NAME_3": COLUMN_3,
  }
}

以下は TABLE のプロパティです。
名前 | 説明
name | テーブル名。
type | テーブルの種類。 以下のどれかです。 array: table-no-key hash: table-hash-key patricia trie: table-pat-key double array trie: table-dat-key
key_type | テーブルのキーの型。 テーブルの種類が array なら null になります。 テーブルの種類が array でなければオブジェクトになります。オブジェクトは次のプロパティを持ちます。 name ：型名。 type ：もし型がテーブルなら reference 、そうでないなら type 。
value_type | テーブルの値の型。 テーブルが「値」を使っていない場合は null になります。 テーブルが「値」を使っている場合はオブジェクトになります。オブジェクトは次のプロパティを持ちます。 name ：型名。 type ：もし型がテーブルなら reference 、そうでないなら type 。
tokenizer | テーブルのトークナイザー。 table-create-default-tokenizer で指定されたものです。 テーブルがトークナイザーを使っていない場合は null になります。 テーブルがトークナイザーを使っている場合はオブジェクトになります。オブジェクトは次のプロパティを持ちます。 name ：トークナイザー名。
normalizer | テーブルのノーマライザー。 table-create-normalizer で指定されたものです。 テーブルがノーマライザーを使っていない場合は null になります。 テーブルがノーマライザーを使っている場合はオブジェクトになります。オブジェクトは次のプロパティを持ちます。 name ：ノーマライザー名。
token_filters | テーブルのトークンフィルターです。 table-create-token-filters で指定されたものです。 オブジェクトの配列です。オブジェクトは次のプロパティを持ちます。 name ：トークンフィルター名。
indexes | テーブルのキーに対するインデックス。 INDEX の配列です。
command | このテーブルを作るためのGroongaコマンドに関する情報。 COMMAND になります。
columns | テーブルのカラム。 オブジェクトです。キーはカラム名で値は COLUMN です。

  INDEX

INDEX はインデックスの詳細を示すオブジェクトです。:

{
  "full_name": INDEX_COLUMN_NAME_WITH_TABLE_NAME,
  "table":     TABLE_NAME,
  "name":      INDEX_COLUMN_NAME,
  "section":   SECTION
}

以下は INDEX のプロパティです。
名前 | 説明
full_name | テーブル名を含むインデックスカラム名。 例： Terms.index
table | インデックスカラムのテーブル名。 例： Terms
name | インデックスカラム名。 例： index
section | テーブルのキーに対するインデックスカラムのセクション番号。 インデックスカラムがマルチカラムインデックスでない場合は 0 になります。

  COMMAND

COMMAND はこのテーブル・カラムを作る方法を示したオブジェクトです。:

{
  "name": COMMAND_NAME,
  "arguments": {
    "KEY_1": "VALUE_1",
    "KEY_2": "VALUE_2",
    ...,
    "KEY_n": "VALUE_n"
  },
  "command_line": COMMAND_LINE
}

以下は COMMAND のプロパティです。
名前 | 説明
name | このテーブル・カラムを作るGroongaコマンドの名前。
arguments | このテーブル・カラムを作るためのGroongaコマンドの引数。 オブジェクトになります。キーは引数名で値は引数の値です。
command_line | このテーブル・カラムを作るGroongaコマンドのコマンドラインです。 この文字列はGroongaが評価できます。

  COLUMN

COLUMN はカラムの詳細を示したオブジェクトです。:

{
  "name": COLUMN_NAME,
  "table": TABLE_NAME,
  "full_name": COLUMN_NAME_WITH_TABLE,
  "type": TYPE,
  "value_type": VALUE_TYPE,
  "compress": COMPRESS,
  "section": SECTION,
  "weight": WEIGHT,
  "compress": COMPRESS,
  "section": BOOLEAN,
  "weight": BOOLEAN,
  "position": BOOLEAN,
  "sources": [
    SOURCE_1,
    SOURCE_2,
    ...,
    SOURCE_n
  ],
  "indexes": [
    INDEX_1,
    INDEX_2,
    ...,
    INDEX_n
  ],
  "command": COMMAND
}

以下は COLUMN のプロパティです。
名前 | 説明
name | カラム名。 例： age
table | カラムのテーブル名。 例： Users
full_name | テーブル名を含むカラム名。 例： Users.age
type | カラムの種類。 以下のどれかです。 scalar: /reference/columns/scalar vector: /reference/columns/vector index: /reference/columns/index
value_type | カラムの値の型。 オブジェクトです。このオブジェクトは次のプロパティを持ちます。 name ：型名。 type ：もし型がテーブルなら reference 、そうでないなら type 。
compress | カラムの圧縮方法です。 カラムがどの圧縮方法も使っていない場合は null になります。 カラムが圧縮方法を使っている場合は次のどれかになります。 zlib ：カラムの値を圧縮するためにzlibを使います。 lz4 ：カラムの値を圧縮するためにLZ4を使います。
section | カラムがセクション情報を保存できるかどうか。 WITH_SECTION フラグ付きでカラムを作ったときは true 、そうでないときは false になります。 通常、インデックスカラムでない場合は false になります。
weight | カラムが重み情報を保存できるかどうか。 WITH_WEIGHT フラグ付きでカラムを作ったときは true 、そうでないときは false になります。
position | カラムが位置情報を保存できるかどうか。 WITH_POSITION フラグ付きでカラムを作ったときは true 、そうでないときは false になります。 通常、インデックスカラムでない場合は false になります。
sources | インデックスカラムのソースカラム。 SOURCE の配列になります。 通常、カラムがインデックスカラムでない場合は空配列になります。
indexes | カラムのインデックス。 INDEX の配列です。
command | このカラムを作るためのGroongaコマンド情報。 COMMAND になります。

  SOURCE

SOURCE はソースの詳細を示すオブジェクトです。:

{
  "name":      COLUMN_NAME,
  "table":     TABLE_NAME,
  "full_name": COLUMN_NAME_WITH_TABLE_NAME
}

以下は SOURCE のプロパティです。
名前 | 説明
name | ソースカラム名。 例： content _key 擬似カラムになるかもしれません。
table | ソースカラムのテーブル名。 例： Memos
full_name | テーブル名を含むソースカラム名。 例： Memos.content

  参考

•   table_create

•   column_create

  select

  概要

select はテーブルから指定された条件にマッチするレコードを検索し、見つかったレコードを出力します。

select は最も重要なgroongaのコマンドです。Groongaの力を最大限に活かすためには select を理解する必要があります。

  構文

このコマンドにはたくさんの引数があります。

必須の引数は table だけです。残りは省略できます:

select table
       [match_columns=null]
       [query=null]
       [filter=null]
       [scorer=null]
       [sortby=null]
       [output_columns="_id, _key, *"]
       [offset=0]
       [limit=10]
       [drilldown=null]
       [drilldown_sortby=null]
       [drilldown_output_columns="_key, _nsubrecs"]
       [drilldown_offset=0]
       [drilldown_limit=10]
       [cache=yes]
       [match_escalation_threshold=0]
       [query_expansion=null]
       [query_flags=ALLOW_PRAGMA|ALLOW_COLUMN|ALLOW_UPDATE|ALLOW_LEADING_NOT|NONE]
       [query_expander=null]
       [adjuster=null]
       [drilldown_calc_types=NONE]
       [drilldown_calc_target=null]

select には高度なドリルダウン機能のために以下の名前付き引数があります。

•   drilldown[${LABEL}].keys=null

•   drilldown[${LABEL}].sortby=null

•   drilldown[${LABEL}].output_columns="_key, _nsubrecs"

•   drilldown[${LABEL}].offset=0

•   drilldown[${LABEL}].limit=10

•   drilldown[${LABEL}].calc_types=NONE

•   drilldown[${LABEL}].calc_target=null

    ${LABEL} には1つ以上のアルファベット、数字、 _ 、 . を使うことができます。たとえば、 parent.sub1 は有効な ${LABEL} です。

    同じ ${LABEL} も持つ引数は同じグループになります。

    たとえば、以下の引数は1つのドリルダウンを指定しています。

•   --drilldown[label].keys column

•   --drilldown[label].sortby -_nsubrecs

    以下の引数は2つのドリルダウンを指定しています。

•   --drilldown[label1].keys column1

•   --drilldown[label1].sortby -_nsubrecs

•   --drilldown[label2].keys column2

•   --drilldown[label2].sortby _key

  使い方

例を使いながら select の使い方を学びましょう。このセクションではよく使われる使い方を紹介します。

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Entries TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries n_likes COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries tag COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{"_key":    "The first post!",
 "content": "Welcome! This is my first post!",
 "n_likes": 5,
 "tag": "Hello"},
{"_key":    "Groonga",
 "content": "I started to use Groonga. It's very fast!",
 "n_likes": 10,
 "tag": "Groonga"},
{"_key":    "Mroonga",
 "content": "I also started to use Mroonga. It's also very fast! Really fast!",
 "n_likes": 15,
 "tag": "Groonga"},
{"_key":    "Good-bye Senna",
 "content": "I migrated all Senna system!",
 "n_likes": 3,
 "tag": "Senna"},
{"_key":    "Good-bye Tritonn",
 "content": "I also migrated all Tritonn system!",
 "n_likes": 3,
 "tag": "Senna"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]

ブログエントリ用の Entries テーブルがあります。各エントリはタイトルと内容と「いいね！」数、タグを持っています。タイトルは Entries のキーとします。内容は Entries.content カラムの値とします。「いいね！」数は Entries.n_likes カラムの値とします。タグは Entries.tag カラムの値とします。

Entries._key カラムと Entries.content カラムには TokenBigram トークナイザーを使ったインデックスを作成します。そのため、 Entries._key と Entries.content は両方とも全文検索できます。

これで例を示すためのスキーマとデータの準備ができました。

  簡単な使い方

上記のスキーマとデータを使った一番簡単な使い方は以下の通りです。これは Entries テーブルのすべてのレコードを出力します。

実行例:

select Entries
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

どうしてこのコマンドがすべてのレコードを出力するのでしょうか？理由は2つです。1つ目の理由はこのコマンドが検索条件を何も指定していないからです。検索条件を指定しないとすべてのレコードがマッチします。2つ目の理由は全レコード数が5だからです。 select コマンドはデフォルトでは最大10レコードを出力します。この例では5レコードしかありません。これは10よりも少ないのですべてのレコードを出力します。

  検索条件

検索条件は query または filter で指定します。 query と filter を両方指定することもできます。この場合は query と filter の両方の条件にマッチしたレコードが出力されます。

  検索条件: query

query はWebページの検索ボックス用に用意されています。例えば、google.co.jpにあるような検索ボックスです。 query の検索条件はスペース区切りでキーワードを指定します。例えば、 検索 エンジン は 検索 と エンジン という2つのキーワードを含むレコードを検索します。

通常は query 引数は全文検索条件を指定するために使います。全文検索条件以外も指定できますが、その用途には filter 引数の方が向いています。

query 引数で全文検索条件を指定する場合は、 match_columns 引数と一緒に使います。 match_columns はどのカラムまたはインデックスを使って query を検索するかを指定します。

以下は簡単な query の使用例です。

実行例:

select Entries --match_columns content --query fast
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中から content カラムの値に fast を含んでいるレコードを検索します。

query はクエリー構文という構文を使いますが、詳細はここでは説明しません。詳細は /reference/grn_expr/query_syntax を参照してください。

  検索条件: filter

filter は複雑な検索条件を指定するために用意されています。ECMAScriptのような構文で filter に検索条件を指定します。

以下は簡単な filter の使用例です。

実行例:

select Entries --filter 'content @ "fast" && _key == "Groonga"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中の content カラムの値に fast という単語を含んでいて、かつ、 _key が Groonga のレコードを検索します。このコマンドの中には @ と && と == という3つの演算子があります。 @ は全文検索用の演算子です。 && と == はECMAScriptと同じ意味です。 && が論理積用の演算子で == が等価演算子です。

filter にはもっと演算子や構文があります。例えば、 (...) を使った検索条件のグループ化などです。しかし、ここでは詳細は説明しません。詳細は /reference/grn_expr/script_syntax を参照してください。

  ページング

offset と limit を指定することで出力されるレコードの範囲を指定できます。以下は2番目のレコードだけを出力する例です。

実行例:

select Entries --offset 1 --limit 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

offset は0始まりです。 --offset 1 は2番目以降のレコードを出力するという意味になります。

limit は出力レコード数の最大値を指定します。 --limit 1 は多くても1レコードを出力するという意味になります。もし、1つもレコードがマッチしていなければ select コマンドはどのレコードも出力しません。

  全レコード数

--limit 0 を使うとレコードの内容は取得せずに全レコード数だけを取得できます。

実行例:

select Entries --limit 0
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ]
#   ]
# ]

--limit 0 はマッチしたレコード数だけを取得したいときにも便利です。

  ドリルダウン

1回の select で検索結果だけでなく、検索結果をグループ化した結果も一緒に取得できます。SQLでは2回以上 SELECT を使わなければいけない場合でも、Groongaの場合は1回の select で実現できます。

Groongaではこの機能を ドリルダウン と呼んでいます。他の検索エンジンでは ファセット検索 とも呼ばれています。

例えば、以下の状況を考えてみましょう。

fast という単語を含むエントリーを探します。

実行例:

select Entries --filter 'content @ "fast"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

--filter 'content @ "fast" && tag == "???" というように、追加の検索条件として tag を使いたいとします。しかし、 content @ "fast" の結果を見るまでは適切なタグはわかりません。

もし、有効なタグそれぞれについてマッチするレコード数がわかれば、その中から適切なタグを選ぶことができます。このような用途のためにドリルダウンを使えます。

実行例:

select Entries --filter 'content @ "fast"' --drilldown tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ]
#     ],
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         2
#       ]
#     ]
#   ]
# ]

--drilldown tag は「有効なタグ」と「そのタグを持っているレコード数」のペアをリストにして返します。このリストからタグを選ぶと「検索したけどヒット数0」という状況を避けることができます。また、リストの中からレコード数が少ないタグを選べば「検索結果が多すぎる」という状況も避けることができます。

ドリルダウン結果を使うと次のようなUIを作ることができます。

•   検索結果を絞り込むリンク。（ユーザーはキーボードから検索クエリーを入力する必要がなくなります。単にリンクをクリックすればよいからです。)

    多くのECサイトではこのUIを使っています。Amazonのサイドメニューを見てください。

    Groongaはグループ化したレコードの数を数えるだけでなく、グループ化したレコードのカラムの値の中から最大値・最小値を見つけたり、合計値を計算したりすることができます。詳細は ドリルダウン関連の引数 を参照してください。

  引数

このセクションではすべての引数について説明します。引数はカテゴリわけしています。

  必須引数

table だけが必須の引数です。

  table

検索対象のテーブルを指定します。 table は必ず指定しなければいけません。

存在しないテーブルを指定するとエラーが返ります。

実行例:

select Nonexistent
# [
#   [
#     -22,
#     1337566253.89858,
#     0.000355720520019531,
#     "invalid table name: <Nonexistent>",
#     [
#       [
#         "grn_select",
#         "proc.c",
#         1217
#       ]
#     ]
#   ]
# ]

  検索関係の引数

検索関係の引数がいくつかあります。一般的には、検索ボックスを実装するために match_columns と query 引数を使い、複雑な検索機能を実装するために filter 引数を使います。

query と filter を指定した場合は、 query と filter にマッチしたレコードが選択されます。 query と filter のどちらも指定しなかった場合はすべてのレコードが選択されます。

  match_columns

query 引数の値で全文検索をするときに使うデフォルトの検索対象カラムを指定します。全文検索対象のカラムは query 引数でも指定できます。検索対象カラムを match_columns で指定する場合と query で指定する場合の違いは重みとスコアー関数を指定できるかどうかです。 match_columns では指定できますが、 query では指定できません。

重みは検索対象カラムの相対的な重要度です。重みの大きい検索対象カラムでマッチした場合は小さい検索対象カラムでマッチした場合よりも多くのヒットスコアがつきます。デフォルトの重みは1です。

以下は簡単な match_columns の使用例です。

実行例:

select Entries --match_columns content --query fast --output_columns '_key, _score'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         1
#       ],
#       [
#         "Mroonga",
#         2
#       ]
#     ]
#   ]
# ]

--match_columns content はデフォルトの全文検索対象カラムに content カラムを使用し、その重みは1、という意味になります。 --output_columns '_key, _score' はこの select コマンドがマッチしたレコードの _key の値と _score の値を出力する、ということを指定しています。

_score の値に注目してください。 _score の値は query 引数の値に何個マッチしたかになっています。この例では、 query 引数の値は fast です。 _score の値が1ということは content カラムの中に fast が1つだけあるということです。 _score の値が2ということは content カラムの中に fast が2つあるということです。

重みを指定するためには column * weight という構文を使います。以下は重みの使用例です。

実行例:

select Entries --match_columns 'content * 2' --query fast --output_columns '_key, _score'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Mroonga",
#         4
#       ]
#     ]
#   ]
# ]

--match_columns 'content * 2' はデフォルトの全文検索用カラムとして content カラムを使い、その重みは2という意味です。

_score の値に注目してください。 _score の値が2倍になっています。これは重みを2にしたからです。

デフォルトの全文検索対象カラムとして複数のカラムを指定することができます。複数のカラムを指定した場合はすべてのカラムに対して全文検索が行われ、ヒットスコアが積算されます。つまり、 query 引数の値がどれか1つでも全文検索対象カラムにマッチしたら、そのレコードはマッチしたものとして扱われます。

複数のカラムを指定するには column1 * weight1 || column2 * weight2 || ... という構文を使います。 * weight は省略することができます。省略した場合は重みが1になります。以下は複数カラムの使用例です。

実行例:

select Entries --match_columns '_key * 10 || content' --query groonga --output_columns '_key, _score'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         11
#       ]
#     ]
#   ]
# ]

--match_columns '_key * 10 || content' はデフォルト検索対象カラムが _key カラムと content カラムで、 _key カラムの重みは10、 content カラムの重みは1という意味です。この重み付けは _key カラムの値は content カラムの値よりも重要だという意味になります。この例では、ブログエントリのタイトルはブログエントリの内容よりも重要だということです。

スコアー関数を指定することもできます。詳細は /reference/scorer を参照してください。

スコアー関数と scorer パラメーターは関係ないので注意してください。

  query

クエリーテキストを指定します。通常、全文検索をするために match_columns 引数と一緒に使います。 query 引数はWebページにある全文検索フォームで使いやすいように設計されています。クエリーテキストは /reference/grn_expr/query_syntax という書式を使います。この書式はGoogleの検索フォームのように一般的な検索フォームと似ています。例えば、 word1 word2 は word1 と word2 を含んでいるレコードを検索するという意味になります。 word1 OR word2 は word1 または word2 を含んでいるレコードを検索するという意味になります。

以下は論理積を使った検索の簡単な例です。

実行例:

select Entries --match_columns content --query "fast groonga"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中から content カラムの値に fast と groonga の2つの単語を含んでいるレコードを検索します。

以下は論理和を使った検索の簡単な例です。

実行例:

select Entries --match_columns content --query "groonga OR mroonga"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中から content カラムの値に fast または groonga のどちらかの単語を含んでいるレコードを検索します。

他の構文は /reference/grn_expr/query_syntax を参照してください。

query では全文検索だけではなく他の条件も使えます。例えば、 column:value は column の値が value と等しいという意味です。 column:<value は column の値が value より小さいという意味です。

以下は等価演算子を使った検索の簡単な例です。

実行例:

select Entries --query _key:Groonga
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中から _key カラムの値が Groonga であるレコードを検索します。

以下は比較演算子を使った検索の簡単な例です。

実行例:

select Entries --query n_likes:<11
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中から n_likes カラムの値が 11 より小さいレコードを検索します。

他の演算子は /reference/grn_expr/query_syntax を参照してください。

  filter

フィルターテキストを指定します。通常、 filter は複雑な条件を指定するために使います。 filter は query 引数と一緒に使うこともできます。 filter と query を両方指定した場合はそれらを論理積で組み合わせます。つまり、マッチするレコードは filter にも query にもマッチしなければいけないということです。

filter 引数は複雑な条件用に設計されています。フィルターテキストは /reference/grn_expr/script_syntax 書式で指定します。この書式はECMAScriptに似ています。例えば、 column == "value" は column カラムの値が "value" と等しいという意味です。 column < value は column カラムの値が value よりも小さいという意味です。

以下は等価演算子を使った検索の簡単な例です。

実行例:

select Entries --filter '_key == "Groonga"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中から _key カラムの値が Groonga であるレコードを検索します。

以下は比較演算子を使った検索の簡単な例です。

実行例:

select Entries --filter 'n_likes < 11'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

この select コマンドは Entries テーブルの中から n_likes カラムの値が 11 より小さいレコードを検索します。

他の演算子は /reference/grn_expr/script_syntax を参照してください。

  高度な検索のための引数

  match_escalation_threshold

検索方法をエスカレーションするかどうかを決定するための閾値を指定します。この閾値はマッチしたレコード数との比較に使われます。マッチしたレコード数がこの閾値以下の場合は検索方法をエスカレーションします。検索方法のエスカレーションについては /spec/search を参照してください。

デフォルトの閾値は0です。これは1つもレコードがマッチしなかったときだけ検索方法をエスカレーションするということです。

デフォルトの閾値は以下の方法でカスタマイズできます。

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

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

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

    以下は簡単な match_escalation_threshold の使用例です。最初の select は match_escalation_threshold 引数がありません。2番目の select は match_escalation_threshold 引数があります。

    実行例:

    select Entries --match_columns content --query groo
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "n_likes",
    #           "UInt32"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         2,
    #         "Groonga",
    #         "I started to use Groonga. It's very fast!",
    #         10,
    #         "Groonga"
    #       ]
    #     ]
    #   ]
    # ]
    select Entries --match_columns content --query groo --match_escalation_threshold -1
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         0
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "n_likes",
    #           "UInt32"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ]
    #     ]
    #   ]
    # ]

    最初の select コマンドは Entries テーブルから content カラムの値に groo という単語を含むレコードを検索します。しかし、この検索ではどのレコードにもマッチしません。これは、 TokenBigram トークナイザーは groonga を gr|ro|oo|on|ng|ga ではなく groonga にトークナイズするからです。（ TokenBigramSplitSymbolAlpha は groonga を gr|ro|oo|on|ng|ga にトークナイズします。詳細は /reference/tokenizers を見てください。）つまり、 groonga はインデックスに登録されていますが、 groo はインデックスに登録されていないということです。インデックスに登録されていないので完全一致検索では groo はどのレコードにもマッチしません。このケースでは検索方法のエスカレーションが行われています。なぜならばマッチしたレコード数（0）が match_escalation_threshold （0）の値と等しいからです。非分かち書き検索では groo で1つのレコードがマッチします。

    2番目の select コマンドも Entries テーブルから content カラムの値に groo という単語を含むレコードを検索します。そして、この select コマンドもマッチしません。この場合、マッチしたレコード数（0）が match_escalation_threshold （-1）より大きいので、検索方法をエスカレーションしません。そして、1つもレコードがマッチしません。

  query_expansion

非推奨です。代わりに query_expander を使ってください。

  query_flags

query パラメーターの構文をカスタマイズします。デフォルトでは query パラメーターでカラムの値を更新することはできません。しかし、 query_flags に ALLOW_COLUMN|ALLOW_UPDATE を指定することで query でカラムの値を更新することができます。

指定可能な値は以下の通りです。

•   ALLOW_PRAGMA

•   ALLOW_COLUMN

•   ALLOW_UPDATE

•   ALLOW_LEADING_NOT

•   NONE

    ALLOW_PRAGMA を指定すると query の先頭でプラグマを指定することができます。この機能はまだ実装されていません。

    ALLOW_COLUMN を指定すると match_columns で指定していないカラムでも検索できるように成ります。カラムを指定するには COLUMN:... というような構文を使います。

    ALLOW_UPDATE を指定すると COLUMN:=NEW_VALUE という構文を使って query でカラムの値を更新できます。カラム更新用の構文ではカラムを指定する必要があるため、 ALLOW_COLUMN も一緒に指定する必要があります。

    ALLOW_LEADING_NOT を指定すると -WORD という構文を使って最初の条件として否定条件を指定できます。このクエリーは WORD にマッチしないレコードを検索します。最初の条件に否定条件を使ったクエリーは多くの場合重いクエリーになります。これは多くのレコードにマッチするからです。そのため、このフラグはデフォルトでは無効になっています。もし、このフラグを使う場合は重いクエリーとなるということを十分気をつけてください。

    NONE は単に無視されます。フラグを指定しないときに NONE を使えます。

    これらのフラグは ALLOW_COLUMN|ALLOW_UPDATE のように | で区切って同時に指定することができます。

    デフォルト値は ALLOW_PRAGMA|ALLOW_COLUMN です。

    以下は ALLOW_COLUMN の使用例です。

    実行例:

    select Entries --query content:@mroonga --query_flags ALLOW_COLUMN
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "n_likes",
    #           "UInt32"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         3,
    #         "Mroonga",
    #         "I also started to use Mroonga. It's also very fast! Really fast!",
    #         15,
    #         "Groonga"
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドは Entries テーブルの中から content カラムの値に mroonga を含んでいるレコードを検索します。

    以下は ALLOW_UPDATE の使用例です。

    実行例:

    table_create Users TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Users age COLUMN_SCALAR UInt32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    load --table Users
    [
    {"_key": "alice", "age": 18},
    {"_key": "bob",   "age": 20}
    ]
    # [[0, 1337566253.89858, 0.000355720520019531], 2]
    select Users --query age:=19 --query_flags ALLOW_COLUMN|ALLOW_UPDATE
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "age",
    #           "UInt32"
    #         ]
    #       ],
    #       [
    #         1,
    #         "alice",
    #         19
    #       ],
    #       [
    #         2,
    #         "bob",
    #         19
    #       ]
    #     ]
    #   ]
    # ]
    select Users
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "age",
    #           "UInt32"
    #         ]
    #       ],
    #       [
    #         1,
    #         "alice",
    #         19
    #       ],
    #       [
    #         2,
    #         "bob",
    #         19
    #       ]
    #     ]
    #   ]
    # ]

    最初の select コマンドは全てのレコードの age カラムの値を 19 にします。二番目の select コマンドは age カラムの値を出力します。

    以下は ALLOW_LEADING_NOT の使用例です。

    実行例:

    select Entries --match_columns content --query -mroonga --query_flags ALLOW_LEADING_NOT
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         4
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "n_likes",
    #           "UInt32"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         1,
    #         "The first post!",
    #         "Welcome! This is my first post!",
    #         5,
    #         "Hello"
    #       ],
    #       [
    #         2,
    #         "Groonga",
    #         "I started to use Groonga. It's very fast!",
    #         10,
    #         "Groonga"
    #       ],
    #       [
    #         4,
    #         "Good-bye Senna",
    #         "I migrated all Senna system!",
    #         3,
    #         "Senna"
    #       ],
    #       [
    #         5,
    #         "Good-bye Tritonn",
    #         "I also migrated all Tritonn system!",
    #         3,
    #         "Senna"
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドは Entries テーブルの中から content カラムの値に mroonga を含んでいないレコードを検索します。

    以下は NONE の使用例です。

    実行例:

    select Entries --match_columns content --query 'mroonga OR _key:Groonga' --query_flags NONE
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "n_likes",
    #           "UInt32"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         3,
    #         "Mroonga",
    #         "I also started to use Mroonga. It's also very fast! Really fast!",
    #         15,
    #         "Groonga"
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドは Entries テーブルの中から content カラムの値に mroonga または _key:Groonga のどちらかの単語を含んでいるレコードを検索します。 _key:Groonga が _key カラムの値が Groonga という条件にはならないことに注意してください。これは ALLOW_COLUMN フラグが指定されていないからです。

    /reference/grn_expr/query_syntax も見てください。

  query_expander

クエリー展開用の引数です。クエリー展開はクエリー中の特定の単語を別の単語に置換します。通常は類義語検索に使います。

query 引数の値を置換するために使うカラムを指定します。この引数の値の書式は「 ${TABLE}.${COLUMN} 」です。例えば、 「 Terms.synonym 」は Terms テーブルの synonym カラムを指定しています。

クエリー展開用のテーブルを「置換テーブル」と呼びます。置換テーブルのキーは ShortText にしてください。そのため、配列テーブル（ TABLE_NO_KEY ）は置換テーブルに使うことはできません。なぜなら、配列テーブルにはキーがないからです。

クエリー展開用のカラムを「置換カラム」と呼びます。置換カラムの値の型は ShortText にしてください。カラムの種類はベクター（ COLUMN_VECTOR ）にしてください。

クエリー展開はクエリーの中にある置換テーブルのキーを置換カラムの値で置換します。 query の中にある単語が置換テーブルのキーだったら、キーに対応する置換カラムの値でその単語を置換します。置換は再帰的に実行しません。これは、置換されたクエリー内に置換対象の単語があっても置換されないということです。

以下は query_expander の簡単な使用例を示すためのサンプル置換テーブルです。

実行例:

table_create Thesaurus TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Thesaurus synonym COLUMN_VECTOR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Thesaurus
[
{"_key": "mroonga", "synonym": ["mroonga", "tritonn", "groonga mysql"]},
{"_key": "groonga", "synonym": ["groonga", "senna"]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

Thesaurus 置換テーブルは2つの類義語があります。 "mroonga" と "groonga" です。ユーザが "mroonga" で検索すると、Groongaは "((mroonga) OR (tritonn) OR (groonga mysql))" で検索します。ユーザーが "groonga" で検索すると、Groongaは "((groonga) OR (senna))" で検索します。

通常、置換テーブルにはノーマライザーを指定したほうがよいです。たとえば、ノーマライザーを指定すると、置換対象の単語に対して大文字小文字区別せずにマッチするようになります。利用可能なノーマライザーは /reference/normalizers を参照してください。

これらの類義語の値の中に "mroonga" や "groonga" といったキーの値も含まれていることに注意してください。このように類義語にキーの値も含めることを推奨します。もしキーの値を含めないと、置換した値には元の置換対象の値が含まれません。通常、元の値が含まれていた方がよい検索結果になります。もし、検索してほしくない単語がある場合は、元の単語を含めないでください。例えば、空のベクター値を指定することで「ストップワード」機能を実現することもできます。

以下は簡単な query_expander の使用例です。

実行例:

select Entries --match_columns content --query "mroonga"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]
select Entries --match_columns content --query "mroonga" --query_expander Thesaurus.synonym
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]
select Entries --match_columns content --query "((mroonga) OR (tritonn) OR (groonga mysql))"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

最初の select コマンドはクエリー展開を使いません。そのため、 "tritonn" という単語を含んでいるレコードは見つかりません。2番目の select コマンドはクエリー展開を使っています。そのため、 "tritonn" という単語を含んでいるレコードが見つかります。3番目の select コマンドはクエリー展開を使っていませんが、2番目の select コマンドと同じ結果になります。これは、3番目の select コマンドは展開後のクエリーを使っているからです。

それぞれの置換する値は (...) や OR といった /reference/grn_expr/query_syntax を使えます。これらの構文を使うことにより複雑な置換をすることができます。

以下はクエリー構文を使った複雑な置換の使用例です。

実行例:

load --table Thesaurus
[
{"_key": "popular", "synonym": ["popular", "n_likes:>=10"]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
select Entries --match_columns content --query "popular" --query_expander Thesaurus.synonym
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この load コマンドは新しく "popular" という類義語を登録しています。これは ((popular) OR (n_likes:>=10)) に置換されます。置換されたクエリーは、「popular」というのは「popular」という単語を含んでいるか10以上の「いいね！」数を持つエントリという意味になります。

この select コマンドは Entries テーブルの中から n_likes カラムの値が 10 以上のレコードを出力します。

  出力関連の引数

  output_columns

出力するカラムを , 区切りで指定します。

以下は簡単な output_columns の使用例です。

実行例:

select Entries --output_columns '_id, _key' --limit 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!"
#       ]
#     ]
#   ]
# ]

この select コマンドは _id と _key カラムの値だけを出力します。

* は特別な値で /reference/columns/pseudo 以外のすべてのカラムという意味です。

以下は * の使用例です。

実行例:

select Entries --output_columns '_key, *' --limit 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ]
#     ]
#   ]
# ]

この select コマンドは _key 擬似カラム、 content カラム、 n_likes カラムの値を出力しますが、 _id 擬似カラムの値は出力しません。

デフォルト値は _id, _key, * です。これは _score 以外の全てのカラムを出力するという意味です。

  sortby

ソートキーを , 区切りで指定します。それぞれのソートキーはカラム名を指定します。

以下は簡単な sortby の使用例です。

実行例:

select Entries --sortby 'n_likes, _id'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ]
#     ]
#   ]
# ]

この select コマンドは n_likes カラムの値で昇順にソートします。 n_likes の値が同じレコードについては _id カラムの値で昇順にソートします。 "Good-bye Senna" と "Good-bye Tritonn" が _id カラムの値でソートしているケースです。

降順でソートしたい場合はカラム名の前に - をつけてください。

以下は降順の sortby の使用例です。

実行例:

select Entries --sortby '-n_likes, _id'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

この select コマンドは n_likes カラムの値で降順にソートします。しかし、 _id でソートするときは昇順でソートします。

もし、 query または filter 引数を使っているときは、 sortby の中で _score 擬似カラムを使うことができます。

実行例:

select Entries --match_columns content --query fast --sortby -_score --output_columns '_key, _score'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Mroonga",
#         2
#       ],
#       [
#         "Groonga",
#         1
#       ]
#     ]
#   ]
# ]

この select コマンドはマッチしたレコードをヒットスコアで降順にソートし、レコードのキーとヒットスコアを出力します。

query 引数も filter 引数も指定しないで _score を使った場合は、 _score を無視して、ログファイルに警告を出力します。

  offset

出力するレコードの範囲を決めるためのオフセットを指定します。オフセットは0始まりです。 --offset 1 は2番目以降のレコードを出力するという意味になります。

実行例:

select Entries --sortby _id --offset 3 --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "Good-bye Senna"
#       ],
#       [
#         "Good-bye Tritonn"
#       ]
#     ]
#   ]
# ]

この select コマンドは4番目以降のレコードを出力します。

負の値を指定することもできます。負の値の場合は マッチしたレコード数 + offset 番目のレコードから始まる範囲という意味になります。もし、マッチしたレコードが3つあり、 --offset -2 を指定した場合は2番目（ 3 + -2 = 1 。 1 は2番目という意味です。オフセットは0始まりということを思い出してください。） のレコードから3番目のレコードを取得します。

実行例:

select Entries --sortby _id --offset -2 --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "Good-bye Senna"
#       ],
#       [
#         "Good-bye Tritonn"
#       ]
#     ]
#   ]
# ]

この select コマンドは4番目以降のレコードを出力します。なぜなら、全レコード数が 5 だからです。

デフォルト値は 0 です。

  limit

limit は出力レコード数の最大値を指定します。 もし、マッチしたレコード数が limit よりも小さい場合はすべてのレコードが出力されます。

以下は簡単な limit の使用例です。

実行例:

select Entries --sortby _id --offset 2 --limit 3 --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "Mroonga"
#       ],
#       [
#         "Good-bye Senna"
#       ],
#       [
#         "Good-bye Tritonn"
#       ]
#     ]
#   ]
# ]

この select コマンドは3番目、4番目、5番目のレコードを出力します。

負の値を指定することもできます。負の値の場合は、最大で マッチしたレコード数 + limit + 1 件のレコードを出力するという意味になります。 例えば、 --limit -1 はすべてのレコードを出力します。これはすべてのレコードを表示する場合にとても便利です。

以下は負の値を使った limit の簡単な使用例です。

実行例:

select Entries --limit -1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

この select コマンドはすべてのレコードを出力します。

デフォルト値は 10 です。

  scorer

TODO: write in English and add example.

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

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

  ドリルダウン関連の引数

このセクションでは基本的なドリルダウン関連の引数について説明します。高度なドリルダウン関連の引数は他のセクションで説明します。

  drilldown

グループ化するときに使うキーを , 区切りで指定します。

指定した検索条件にマッチしたレコードを指定したキーのそれぞれでグループ化します。検索条件を指定していない場合はすべてのレコードを指定したキーのそれぞれでグループ化します。

以下は簡単な drilldown の使用例です。

実行例:

select Entries \
  --output_columns _key,tag \
  --drilldown tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         "The first post!",
#         "Hello"
#       ],
#       [
#         "Groonga",
#         "Groonga"
#       ],
#       [
#         "Mroonga",
#         "Groonga"
#       ],
#       [
#         "Good-bye Senna",
#         "Senna"
#       ],
#       [
#         "Good-bye Tritonn",
#         "Senna"
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Hello",
#         1
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Senna",
#         2
#       ]
#     ]
#   ]
# ]

この select コマンドは次の情報を出力します。

•   「Hello」タグを持つレコードが1つある。

•   「Groonga」タグを持つレコードが2つある。

•   「Senna」タグを持つレコードが2つある。

    以下は検索条件付きで drilldown を使う例です。

    実行例:

    select Entries \
      --output_columns _key,tag \
      --filter 'n_likes >= 5' \
      --drilldown tag
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         3
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         "The first post!",
    #         "Hello"
    #       ],
    #       [
    #         "Groonga",
    #         "Groonga"
    #       ],
    #       [
    #         "Mroonga",
    #         "Groonga"
    #       ]
    #     ],
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "_nsubrecs",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         "Hello",
    #         1
    #       ],
    #       [
    #         "Groonga",
    #         2
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドは次の情報を出力します。

•   n_likes の値が5以上のレコードの中には…

•   「Hello」タグを持つレコードが1つある。

•   「Groonga」タグを持つレコードが2つある。

    以下は複数のグループ化キーを指定する drilldown の例です。

    実行例:

    select Entries \
      --limit 0 \
      --output_column _id \
      --drilldown tag,n_likes
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         5
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "n_likes",
    #           "UInt32"
    #         ],
    #         [
    #           "tag",
    #           "ShortText"
    #         ]
    #       ]
    #     ],
    #     [
    #       [
    #         3
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "_nsubrecs",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         "Hello",
    #         1
    #       ],
    #       [
    #         "Groonga",
    #         2
    #       ],
    #       [
    #         "Senna",
    #         2
    #       ]
    #     ],
    #     [
    #       [
    #         4
    #       ],
    #       [
    #         [
    #           "_key",
    #           "UInt32"
    #         ],
    #         [
    #           "_nsubrecs",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         5,
    #         1
    #       ],
    #       [
    #         10,
    #         1
    #       ],
    #       [
    #         15,
    #         1
    #       ],
    #       [
    #         3,
    #         2
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドは次の情報を出力します。

•   tag について:

•   「Hello」タグを持つレコードが1つある。

•   「Groonga」タグを持つレコードが2つある。

•   「Senna」タグを持つレコードが2つある。

•   n_likes について:

•   「Hello」タグを持つレコードが1つある。

•   「Groonga」タグを持つレコードが2つある。

•   「Senna」タグを持つレコードが2つある。

  drilldown_sortby

ドリルダウン結果のソートキーを , 区切りで指定します。それぞれのソートキーはカラム名を指定します。

グループ化されたレコード数は _nsubrecs /reference/columns/pseudo 擬似カラムで参照できます。

以下は簡単な drilldown_sortby の使用例です。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown 'tag, n_likes' \
  --drilldown_sortby '-_nsubrecs, _key'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Senna",
#         2
#       ],
#       [
#         "Hello",
#         1
#       ]
#     ],
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_key",
#           "UInt32"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         3,
#         2
#       ],
#       [
#         5,
#         1
#       ],
#       [
#         10,
#         1
#       ],
#       [
#         15,
#         1
#       ]
#     ]
#   ]
# ]

ドリルダウン結果は「グループに含まれるレコード数」（= _nsubrecs ）で降順にソートします。「グループに含まれるレコード数」が同じグループが複数あった場合は、グループ化に使ったキー（= _key ）で昇順にソートします。

drilldown で指定したすべてのグループキーで同じソートキーを使います。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown 'tag, n_likes' \
  --drilldown_sortby '-_nsubrecs, _key'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Senna",
#         2
#       ],
#       [
#         "Hello",
#         1
#       ]
#     ],
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_key",
#           "UInt32"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         3,
#         2
#       ],
#       [
#         5,
#         1
#       ],
#       [
#         10,
#         1
#       ],
#       [
#         15,
#         1
#       ]
#     ]
#   ]
# ]

tag のドリルダウンでも n_likes のドリルダウンでも同じソートキーを使っています。

それぞれのドリルダウンで異なるソートキーを使いたい場合は 高度なドリルダウン関連のパラメーター を参照してください。

  drilldown_output_columns

ドリルダウン結果から出力するカラムを , 区切りで指定します。

以下は drilldown_output_columns の使用例です。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown tag \
  --drilldown_output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "Hello"
#       ],
#       [
#         "Groonga"
#       ],
#       [
#         "Senna"
#       ]
#     ]
#   ]
# ]

この select コマンドはグループ化したキーを出力していくだけです。

グループ化したキーが参照型のカラム（型がテーブルのカラム）だった場合、参照型のカラムが参照しているテーブルのカラムにもアクセスできます。

参照型に対してドリルダウンする方法を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Tags TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tags label COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tags priority COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Items TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Items tag COLUMN_SCALAR Tags
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Tags
[
{"_key": "groonga", label: "Groonga", priority: 10},
{"_key": "mroonga", label: "Mroonga", priority: 5}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
load --table Items
[
{"_key": "A", "tag": "groonga"},
{"_key": "B", "tag": "groonga"},
{"_key": "C", "tag": "mroonga"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

Tags テーブルは参照されているテーブルです。 Items.tag は参照型のカラムです。

Tags.label は drilldown_output_columns の中では label で参照できます。

実行例:

select Items \
  --limit 0 \
  --output_column _id \
  --drilldown tag \
  --drilldown_output_columns '_key, label'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tag",
#           "Tags"
#         ]
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "label",
#           "ShortText"
#         ]
#       ],
#       [
#         "groonga",
#         "Groonga"
#       ],
#       [
#         "mroonga",
#         "Mroonga"
#       ]
#     ]
#   ]
# ]

* を使うと、参照されているテーブル（= Tags ）のすべてのカラムを参照できます。

実行例:

select Items \
  --limit 0 \
  --output_column _id \
  --drilldown tag \
  --drilldown_output_columns '_key, *'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tag",
#           "Tags"
#         ]
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "label",
#           "ShortText"
#         ],
#         [
#           "priority",
#           "Int32"
#         ]
#       ],
#       [
#         "groonga",
#         "Groonga",
#         10
#       ],
#       [
#         "mroonga",
#         "Mroonga",
#         5
#       ]
#     ]
#   ]
# ]

* は label, priority に展開されます。

drilldown_output_columns のデフォルト値は _key, _nsubrecs です。グループ化に使ったキーとグループのレコード数を出力する、ということです。

drilldown_calc_types を使うと、 drilldown_output_columns の中で _max 、 _min 、 _sum 、 _avg といった /reference/columns/pseudo も使えるようになります。詳細は drilldown_calc_types のドキュメントを参照してください。

  drilldown_offset

ドリルダウン結果を出力するレコードの範囲を決めるためのオフセットを指定します。オフセットは0始まりです。 --offset 1 は2番目以降のレコードを出力するという意味になります。

以下は簡単な drilldown_offset の使用例です。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown tag \
  --drilldown_sortby _key \
  --drilldown_offset 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Hello",
#         1
#       ],
#       [
#         "Senna",
#         2
#       ]
#     ]
#   ]
# ]

この select コマンドは2番目以降のレコードを出力します。

負の値を指定することもできます。負の値の場合は グループの数 + offset 番目のレコードから始まる範囲という意味になります。もし、グループの数が3つあり、 --offset -2 を指定した場合は1番目（ 3 + -2 = 1 。 1 は2番目です。オフセットは0始まりということを思い出してください。） のグループから3番目のグループが出力されます。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown tag \
  --drilldown_sortby _key \
  --drilldown_offset -2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Hello",
#         1
#       ],
#       [
#         "Senna",
#         2
#       ]
#     ]
#   ]
# ]

この select コマンドは2番目以降のグループを出力します。なぜなら、全グループ数が 3 だからです。

drilldown_offset のデフォルト値は 0 です。

  drilldown_limit

drilldown_limit は出力グループ数の最大値を指定します。もし、グループ数 limit よりも小さい場合はすべてのグループが出力されます。

以下は drilldown_limit の使用例です。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown tag \
  --drilldown_sortby _key \
  --drilldown_offset 1 \
  --drilldown_limit 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Hello",
#         1
#       ],
#       [
#         "Senna",
#         2
#       ]
#     ]
#   ]
# ]

この select コマンドは2番目、3番目のレコードを出力します。

負の値を指定することもできます。負の値の場合は、最大で マッチしたレコード数 + drilldown_limit + 1 件のレコードを出力するという意味になります。 例えば、 --drilldown_limit -1 はすべてのレコードを出力します。これはすべてのレコードを表示する場合にとても便利です。

以下は drilldown_limit に負の値を指定する例です。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown tag \
  --drilldown_sortby _key \
  --drilldown_limit -1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga",
#         2
#       ],
#       [
#         "Hello",
#         1
#       ],
#       [
#         "Senna",
#         2
#       ]
#     ]
#   ]
# ]

この select コマンドはすべてのグループを出力します。

drilldown_limit のデフォルト値は 10 です。

  drilldown_calc_types

ドリルダウンでグループ内のレコードの値を計算（集計）する方法を指定します。「 , 」で区切ることで複数の計算タイプを指定することもできます。たとえば、 MAX,MIN といった具合です。

計算対象の値はグループ内のレコードのカラムから取得します。このカラムは drilldown_calc_target で指定します。

計算した値は drilldown_output_columns の中で _max や _min のような /reference/columns/pseudo を指定すると取得できます。

以下の計算タイプを使えます。
タイプ名 | /reference/columns/pseudo 名 | drilldown_calc_target が必要か | 説明
NONE | なし。 | 必要ない。 | 無視されます。
COUNT | _nsubrecs | 必要ない。 | グループ内のレコードの数を数える。常に有効なので指定する必要はない。
MAX | _max | 必要。 | グループ内のレコードの整数値の中で最大の値を見つける。
MIN | _min | 必要。 | グループ内のレコードの整数値の中で最小の値を見つける。
SUM | _sum | 必要。 | グループ内のレコードの整数値の合計を計算する。
AVG | _avg | 必要。 | グループ内のレコードの整数値・浮動小数点数値の平均を計算する。

以下は MAX の使用例です。

実行例:

select Entries \
  --limit -1 \
  --output_column _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types MAX \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_max
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_max",
#           "Int64"
#         ]
#       ],
#       [
#         "Hello",
#         5
#       ],
#       [
#         "Groonga",
#         15
#       ],
#       [
#         "Senna",
#         3
#       ]
#     ]
#   ]
# ]

この select コマンドは tag カラムの値ですべてのレコードをグループ化します。その後、各グループについて最大の n_likes カラムの値を探し、「グループ化に使ったキー」と「 n_likes カラムの値の最大値」のペアのリストを出力します。 n_likes カラムの値の最大値を参照するために _max /reference/columns/pseudo を使っています。

以下は MIN の使用例です。

実行例:

select Entries \
  --limit -1 \
  --output_column _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types MIN \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_min
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_min",
#           "Int64"
#         ]
#       ],
#       [
#         "Hello",
#         5
#       ],
#       [
#         "Groonga",
#         10
#       ],
#       [
#         "Senna",
#         3
#       ]
#     ]
#   ]
# ]

この select コマンドは tag カラムの値ですべてのレコードをグループ化します。その後、各グループについて最小の n_likes カラムの値を探し、「グループ化に使ったキー」と「 n_likes カラムの値の最小値」のペアのリストを出力します。 n_likes カラムの値の最小値を参照するために _min /reference/columns/pseudo を使っています。

以下は SUM の使用例です。

実行例:

select Entries \
  --limit -1 \
  --output_column _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types SUM \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_sum
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_sum",
#           "Int64"
#         ]
#       ],
#       [
#         "Hello",
#         5
#       ],
#       [
#         "Groonga",
#         25
#       ],
#       [
#         "Senna",
#         6
#       ]
#     ]
#   ]
# ]

この select コマンドは tag カラムの値ですべてのレコードをグループ化します。その後、各グループについて n_likes カラムの合計を計算し、「グループ化に使ったキー」と「 n_likes カラムの値の合計」のペアのリストを出力します。 n_likes カラムの値の合計を参照するために _sum /reference/columns/pseudo を使っています。

以下は AVG の使用例です。

実行例:

select Entries \
  --limit -1 \
  --output_column _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types AVG \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_avg
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_avg",
#           "Float"
#         ]
#       ],
#       [
#         "Hello",
#         5.0
#       ],
#       [
#         "Groonga",
#         12.5
#       ],
#       [
#         "Senna",
#         3.0
#       ]
#     ]
#   ]
# ]

この select コマンドは tag カラムの値ですべてのレコードをグループ化します。その後、各グループについて n_likes カラムの平均を計算し、「グループ化に使ったキー」と「 n_likes カラムの値の平均」のペアのリストを出力します。 n_likes カラムの値の合計を参照するために _avg /reference/columns/pseudo を使っています。

以下はすべての計算タイプを使う例です。

実行例:

select Entries \
  --limit -1 \
  --output_column _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types MAX,MIN,SUM,AVG \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_nsubrecs,_max,_min,_sum,_avg
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_nsubrecs",
#           "Int32"
#         ],
#         [
#           "_max",
#           "Int64"
#         ],
#         [
#           "_min",
#           "Int64"
#         ],
#         [
#           "_sum",
#           "Int64"
#         ],
#         [
#           "_avg",
#           "Float"
#         ]
#       ],
#       [
#         "Hello",
#         1,
#         5,
#         5,
#         5,
#         5.0
#       ],
#       [
#         "Groonga",
#         2,
#         15,
#         10,
#         25,
#         12.5
#       ],
#       [
#         "Senna",
#         2,
#         3,
#         3,
#         6,
#         3.0
#       ]
#     ]
#   ]
# ]

この select コマンドは複数の計算タイプを MAX,MIN,SUM,AVG というように「 , 」で区切って指定しています。 drilldown_output_columns で COUNT を指定していなくても _nsubrecs /reference/columns/pseudo を使えます。これは、 COUNT は常に有効だからです。

drilldown_calc_types のデフォルト値は NONE です。これは、 COUNT だけが有効になっているという意味です。なぜなら、 NONE は単に無視されて、 COUNT は常に有効だからです。

  drilldown_calc_target

drilldown_calc_types の計算対象のカラムを指定します。

drilldown_calc_types で MAX のように計算対象のカラムが必要な計算タイプを指定したにも関わらず drilldown_calc_target を省略すると、計算結果は常に 0 になります。

--drilldown_calc_target n_likes というように1つのカラム名だけしか指定できません。 --drilldown_calc_target _key,n_likes というように複数のカラムを指定することはできません。

--drilldown_calc_target reference_column.nested_reference_column.value というように「 . 」でつなげることで対象レコードから参照している値を使うことができます。

drilldown_calc_target の使い方は drilldown_calc_types を参照してください。

drilldown_calc_target のデフォルト値は null です。これは計算対象カラムは何も指定されていないということです。

  高度なドリルダウン関連のパラメーター

drilldown に複数のグループキーを指定することで複数のドリルダウン結果を取得できます。しかし、すべてのドリルダウンで同じ設定を使う必要があります。例えば、すべてのドリルダウンで同じ drilldown_output_columns の値が使われます。

以下の引数を使うことで、各ドリルダウンで別々の設定を使うことができます。

•   drilldown[${LABEL}].keys

•   drilldown[${LABEL}].sortby

•   drilldown[${LABEL}].output_columns

•   drilldown[${LABEL}].offset

•   drilldown[${LABEL}].limit

•   drilldown[${LABEL}].calc_types

•   drilldown[${LABEL}].calc_target

    ${LABEL} は変数です。 ${LABEL} には次の文字を使うことができます。

•   アルファベット

•   数字

•   .

•   _

    注釈: 他の文字も使えますが、これらの文字だけを使ってください。

    同じ ${LABEL} の値を持つ引数は同じグループになります。1つのドリルダウンで同じグループの引数を一緒に使います。

    例えば、以下の引数は2つのグループにわかれます。

•   --drilldown[label1].keys _key

•   --drilldown[label1].output_columns _nsubrecs

•   --drilldown[label2].keys tag

•   --drilldown[label2].output_columns _key,_nsubrecs

    drilldown[label1].keys と drilldown[label1].output_columns が同じグループです。 drilldown[label2].keys と drilldown[label2].output_columns は別のグループです。

    label1 グループでは、グループキーとして _key を使って、出力カラムとして _nsubrecs を使います。

    label2 グループでは、グループキーとして tag を使って、出力カラムとして _key,_nsubrecs を使います。

    以下の引数の使い方は対応する drilldown_XXX 引数のドキュメントを参照してください。

•   drilldown[${LABEL}].sortby: drilldown_sortby

•   drilldown[${LABEL}].offset: drilldown_offset

•   drilldown[${LABEL}].limit: drilldown_limit

•   drilldown[${LABEL}].calc_types: drilldown_calc_types

•   drilldown[${LABEL}].calc_target: drilldown_calc_target

    以下の引数は追加の説明が必要です。

•   drilldown[${LABEL}].keys

•   drilldown[${LABEL}].output_columns

    出力フォーマットは少し違います。これも追加の説明が必要です。

  drilldown[${LABEL}].keys

drilldown は複数のキーを指定して複数のドリルダウンを指定できます。しかし、1つのドリルダウンに複数のキーを指定することはできません。

drilldown[${LABEL}].keys は複数のキーを指定して複数のドリルダウンを指定することはできません。しかし、1つのドリルダウンに複数のキーを指定することができます。

複数のキーを , 区切りで指定します。

以下は tag カラムと n_likes カラムの値を使った複数キーでのグループ化の例です。

実行例:

select Entries \
  --limit -1 \
  --output_column tag,n_likes \
  --drilldown[tag.n_likes].keys tag,n_likes \
  --drilldown[tag.n_likes].output_columns _value.tag,_value.n_likes,_nsubrecs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ],
#     {
#       "tag.n_likes": [
#         [
#           4
#         ],
#         [
#           [
#             "tag",
#             "ShortText"
#           ],
#           [
#             "n_likes",
#             "UInt32"
#           ],
#           [
#             "_nsubrecs",
#             "Int32"
#           ]
#         ],
#         [
#           "Hello",
#           5,
#           1
#         ],
#         [
#           "Groonga",
#           10,
#           1
#         ],
#         [
#           "Groonga",
#           15,
#           1
#         ],
#         [
#           "Senna",
#           3,
#           2
#         ]
#       ]
#     }
#   ]
# ]

tag.n_likes はドリルダウン引数グループのラベルです。グループ化に使ったそれぞれのキーを参照するときは drilldown[${LABEL}].output_columns で _value.${KEY_NAME} という構文を使います。 ${KEY_NAME} にはグループキーを指定したときに使ったカラム名を使います。この場合は ${KEY_NAME} に tag と n_keys を使います。

--drilldown[tag].keys tag のように drilldown[${LABEL}].keys にキーを1つだけしか指定していない場合は _value.${KEY_NAME} 構文を使うことはできません。この場合は _key を使ってください。これは、 drilldown_output_columns と同じルールです。

  drilldown[${LABEL}].output_columns

drilldown[${LABEL}].output_columns はほとんど drilldown_output_columns と同じです。 drilldown_output_columns と drilldown[${LABEL}].output_columns の違いはグループキーの参照方法です。

drilldown_output_columns はグループキーを参照するために _key /reference/columns/pseudo を使います。 drilldown[${LABEL}].output_columns も drilldown[${LABEL}].keys で1つだけしかグループキーを指定していない場合は、グループキーを参照するために _key /reference/columns/pseudo を使います。

以下は1つだけ指定したグループキーを参照するために _key /reference/columns/pseudo を使う例です。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown[tag.n_likes].keys tag,n_likes \
  --drilldown[tag.n_likes].output_columns _value.tag,_value.n_likes
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     {
#       "tag.n_likes": [
#         [
#           4
#         ],
#         [
#           [
#             "tag",
#             "ShortText"
#           ],
#           [
#             "n_likes",
#             "UInt32"
#           ]
#         ],
#         [
#           "Hello",
#           5
#         ],
#         [
#           "Groonga",
#           10
#         ],
#         [
#           "Groonga",
#           15
#         ],
#         [
#           "Senna",
#           3
#         ]
#       ]
#     }
#   ]
# ]

drilldown[${LABEL}].output_columns で各グループキーを参照するために _key /reference/columns/pseudo を使うことはできません。 _value.${KEY_NAME} 構文を使います。 ${KEY_NAME} には drilldown[${LABEL}].keys でグループキーを指定するために使ったカラム名を使います。

以下は複数のグループキーを使ったときに _value.${KEY_NAME} 構文でそれぞれのグループキーを参照する例です。

実行例:

select Entries \
  --limit 0 \
  --output_column _id \
  --drilldown[tag.n_likes].keys tag,n_likes \
  --drilldown[tag.n_likes].output_columns _value.tag,_value.n_likes
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ]
#     ],
#     {
#       "tag.n_likes": [
#         [
#           4
#         ],
#         [
#           [
#             "tag",
#             "ShortText"
#           ],
#           [
#             "n_likes",
#             "UInt32"
#           ]
#         ],
#         [
#           "Hello",
#           5
#         ],
#         [
#           "Groonga",
#           10
#         ],
#         [
#           "Groonga",
#           15
#         ],
#         [
#           "Senna",
#           3
#         ]
#       ]
#     }
#   ]
# ]

ちなみに: どうして _value.${KEY_NAME} 構文なの？

これは実装よりの情報です。

_key はベクターの値です。このベクターの値はすべてのグループキーから成ります。 drilldown[${LABEL}].output_columns で _key を参照するとこのベクターの値のバイト列を確認することができます。

drilldown[${LABEL}].keys に複数のグループキーを指定したとき、各グループの値を参照するために _value にグループのレコードが1つだけ保存されています。そのため、各グループキーを参照するために _value.${KEY_NAME} 構文を使えます。

一方、 drilldown[${LABEL}].keys に1つのグループキーしか指定していない場合は、 _value にグループのレコードを保存しません。そのため、 _value.${KEY_NAME} 構文でグループキーを参照できません。

  drilldown[${LABEL}] スタイルの出力フォーマット

drilldown と drilldown[${LABEL}].keys には出力フォーマットに違いがあります。 drilldown は複数のドリルダウン結果を出力するために配列を使います。 drilldown[${LABEL}].keys は「ラベル」と「ドリルダウン結果」のペアの集まりを使います。

drilldown の出力フォーマットは以下の通りです:

[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT1,
    DRILLDOWN_RESULT2,
    ...
  ]
]

drilldown[${LABEL}].keys の出力フォーマットは以下の通りです:

[
  HEADER,
  [
    SEARCH_RESULT,
    {
      "LABEL1": DRILLDOWN_RESULT1,
      "LABEL2": DRILLDOWN_RESULT2,
      ...
    }
  ]
]

  キャッシュ関連の引数

  cache

このクエリーの結果をキャッシュするかどうかを指定します。

このクエリーの結果がキャッシュしてあると、次に同じクエリーを実行するときはキャッシュを使って高速にレスポンスを返すことができます。

これは既存のキャッシュされた結果を使うかどうかを指定するものではありません。

指定可能な値は以下の通りです。
Value | 説明
no | このクエリーの出力をキャッシュしない。
yes | このクエリーの出力をキャッシュする。デフォルト値。

このクエリーの結果をキャッシュしないようにする例です。

実行例:

select Entries --cache no
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5,
#         "Hello"
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10,
#         "Groonga"
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15,
#         "Groonga"
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3,
#         "Senna"
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3,
#         "Senna"
#       ]
#     ]
#   ]
# ]

デフォルト値は yes です。

  スコアー関連の引数

スコアー関連のパラメーターは adjuster だけです。

  adjuster

1つ以上のスコアー調整式（score adjust expression）を指定します。 adjuster は query または filter と一緒に使います。検索しないリクエストでは adjuster は動きません。

adjuster を使うと特定のレコードのスコアーを増やすことができます。重要なレコードに高いスコアーをつけるために adjuster を使えます。

例えば、 groonga タグがついたレコードのスコアーを増やすために adjuster を使えます。

以下が構文です:

--adjuster "SCORE_ADJUST_EXPRESSION1 + SCORE_ADJUST_EXPRESSION2 + ..."

以下が SCORE_ADJUST_EXPRESSION の構文です:

COLUMN @ "KEYWORD" * FACTOR

以下のことに注意してください:

•   COLUMN にはインデックスが張っていないといけません。

•   "KEYWORD" は文字列でないといけません。

•   FACTOR は正の整数でないといけません。

    以下は1つだけ SCORE_ADJUST_EXPRESSION を使った adjuster の使用例です。

    実行例:

    select Entries \
      --filter true \
      --adjuster 'content @ "groonga" * 5' \
      --output_columns _key,content,_score
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         5
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "_score",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         "The first post!",
    #         "Welcome! This is my first post!",
    #         1
    #       ],
    #       [
    #         "Groonga",
    #         "I started to use Groonga. It's very fast!",
    #         6
    #       ],
    #       [
    #         "Mroonga",
    #         "I also started to use Mroonga. It's also very fast! Really fast!",
    #         1
    #       ],
    #       [
    #         "Good-bye Senna",
    #         "I migrated all Senna system!",
    #         1
    #       ],
    #       [
    #         "Good-bye Tritonn",
    #         "I also migrated all Tritonn system!",
    #         1
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドはすべてのレコードにマッチします。それから、 adjuster を適用します。このアジャスターは Entries.content カラムの中に "groonga" を含むレコードのスコアーを5増やします。 Entries.content カラムに "groonga" が含まれているレコードは1つだけです。 "Groonga" というキーのレコードです。このレコードのスコアーは6（ = 1 + 5 ）になります。

    FACTOR は省略できます。 FACTOR を省略すると、1を指定したとみなします。

    FACTOR を省略した adjuster の使用例です。

    実行例:

    select Entries \
      --filter true \
      --adjuster 'content @ "groonga"' \
      --output_columns _key,content,_score
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         5
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "_score",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         "The first post!",
    #         "Welcome! This is my first post!",
    #         1
    #       ],
    #       [
    #         "Groonga",
    #         "I started to use Groonga. It's very fast!",
    #         2
    #       ],
    #       [
    #         "Mroonga",
    #         "I also started to use Mroonga. It's also very fast! Really fast!",
    #         1
    #       ],
    #       [
    #         "Good-bye Senna",
    #         "I migrated all Senna system!",
    #         1
    #       ],
    #       [
    #         "Good-bye Tritonn",
    #         "I also migrated all Tritonn system!",
    #         1
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドの adjuster は FACTOR がありません。そのため、係数は1になります。 Entries.content カラムに "groonga" を含むレコードは1つだけです。キーが "Groonga" のレコードです。このレコードのスコアーは2（ = 1 + 1 ）になります。

    複数の SCORE_ADJUST_EXPRESSION を使った adjuster の使用例です。

    実行例:

    select Entries \
      --filter true \
      --adjuster 'content @ "groonga" * 5 + content @ "started" * 3' \
      --output_columns _key,content,_score
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         5
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "_score",
    #           "Int32"
    #         ]
    #       ],
    #       [
    #         "The first post!",
    #         "Welcome! This is my first post!",
    #         1
    #       ],
    #       [
    #         "Groonga",
    #         "I started to use Groonga. It's very fast!",
    #         9
    #       ],
    #       [
    #         "Mroonga",
    #         "I also started to use Mroonga. It's also very fast! Really fast!",
    #         4
    #       ],
    #       [
    #         "Good-bye Senna",
    #         "I migrated all Senna system!",
    #         1
    #       ],
    #       [
    #         "Good-bye Tritonn",
    #         "I also migrated all Tritonn system!",
    #         1
    #       ]
    #     ]
    #   ]
    # ]

    この select コマンドの adjuster には2つの SCORE_ADJUST_EXPRESSION があります。最終的なスコアーの増分はすこれらの SCORE_ADJUST_EXPRESSION のスコアーの合計になります。この select コマンドのすべての SCORE_ADJUST_EXPRESSION はキーが "Groonga" のレコードに適用されます。そのため、このレコードの最終的なスコアーの増分はすべての SCORE_ADJUST_EXPRESSION の合計になります。

    最初の SCORE_ADJUST_EXPRESSION は content @ "groonga" * 5 です。これは、スコアーを5増やします。

    2番目の SCORE_ADJUST_EXPRESSION は content @ "started" * 3 です。これはスコアーを3増やします。

    最終的なスコアーの増分は9（ = 1 + 5 + 3 ）です。

    1つの SCORE_ADJUST_EXPRESSION は "KEYWORD" に対して1つの係数を持ちます。これは、 "KEYWORD" を持つすべてのレコードでスコアーの増加分は同じということです。 "KEYWORD" を持つそれぞれのレコード毎にスコアーの増加分を変えることができます。これは検索スコアーをチューニングするときに便利です。詳細は weight-vector-column を参照してください。

  戻り値

select は以下のフォーマットのレスポンスを返します:

[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT_1,
    DRILLDOWN_RESULT_2,
    ...,
    DRILLDOWN_RESULT_N
  ]
]

select が失敗すると、 HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

0個以上の DRILLDOWN_RESULT があります。もし、 drilldown も drilldown[${LABEL}].keys も指定していない場合、次のように DRILLDOWN_RESULT は出力されません:

[
  HEADER,
  [
    SEARCH_RESULT
  ]
]

--drilldown "_key, column1, column2" というように drilldown に2つ以上のキーがある場合、複数の DRILLDOWN_RESULT が存在します:

[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT_FOR_KEY,
    DRILLDOWN_RESULT_FOR_COLUMN1,
    DRILLDOWN_RESULT_FOR_COLUMN2
  ]
]

もし drilldown[${LABEL}].keys を使っているなら、 DRILLDOWN_RESULT が1つだけ存在します:

[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT_FOR_LABELED_DRILLDOWN
  ]
]

DRILLDOWN_RESULT のフォーマットは drilldown と drilldown[${LABEL}].keys で違います。これについては後述します。

SEARCH_RESULT は以下のフォーマットです:

[
  [N_HITS],
  COLUMNS,
  RECORDS
]

このフォーマットの具体例は 簡単な使い方 を見てください。

N_HITS は limit を適用する前のマッチしたレコード数です。

COLUMNS は output_columns で指定した出力カラムの情報を表しています。これは次のフォーマットになっています:

[
  [COLUMN_NAME_1, COLUMN_TYPE_1],
  [COLUMN_NAME_2, COLUMN_TYPE_2],
  ...,
  [COLUMN_NAME_N, COLUMN_TYPE_N]
]

COLUMNS は1つ以上の出力カラムの情報を含んでいます。各出力カラムの情報は次の情報を含んでいます。

•   カラム名（文字列）

•   カラムの型（文字列または null ）

    カラム名は output_columns で指定された値から抽出しています。

    カラムの方はGroongaでの型名または null です。カラムがベクターかスカラーかの情報は持っていません。実際のカラムの値が配列かどうかで判断する必要があります。

    型の詳細は /reference/types を見てください。

    null になるときはカラムの値の型を決められないときです。たとえば、 --output_columns "snippet_html(content)" というように output_columns の中で関数呼び出しを使ったときは null になります。

    以下は COLUMNS の使用例です:

    [
      ["_id",     "UInt32"],
      ["_key",    "ShortText"],
      ["n_likes", "UInt32"],
    ]

    RECORDS はマッチした各レコードのカラムの値を含んでいます。 RECORDS に含まれるレコードは offset と limit で選択されたレコードです。 RECORDS は次のフォーマットです:

    [
      [
        RECORD_1_COLUMN_1,
        RECORD_1_COLUMN_2,
        ...,
        RECORD_1_COLUMN_N
      ],
      [
        RECORD_2_COLUMN_1,
        RECORD_2_COLUMN_2,
        ...,
        RECORD_2_COLUMN_N
      ],
      ...
      [
        RECORD_N_COLUMN_1,
        RECORD_N_COLUMN_2,
        ...,
        RECORD_N_COLUMN_N
      ]
    ]

    以下は RECORDS の例です:

    [
      [
        1,
        "The first post!",
        5
      ],
      [
        2,
        "Groonga",
        10
      ],
      [
        3,
        "Mroonga",
        15
      ]
    ]

    DRILLDOWN_RESULT のフォーマットは drilldown と drilldown[${LABEL}].keys で違います。

    drilldown は SEARCH_RESULT と同じフォーマットです:

    [
      [N_HITS],
      COLUMNS,
      RECORDS
    ]

    drilldown で1つ以上のキーを指定すると、 drilldown は1つ以上の DRILLDOWN_RESULT を出力します。

    drilldown[${LABEL}].keys は次のフォーマットを使います。複数の drilldown[${LABEL}].keys は1つのオブジェクト（キーと値のペアの集合）になります:

    {
      "LABEL_1": [
        [N_HITS],
        COLUMNS,
        RECORDS
      ],
      "LABEL_2": [
        [N_HITS],
        COLUMNS,
        RECORDS
      ],
      ...,
      "LABEL_N": [
        [N_HITS],
        COLUMNS,
        RECORDS
      ]
    }

    各 drilldown[${LABEL}].keys は次の部分に対応します:

    "LABEL": [
      [N_HITS],
      COLUMNS,
      RECORDS
    ]

    以下の値の部分は SEARCH_RESULT と同じフォーマットです:

    [
      [N_HITS],
      COLUMNS,
      RECORDS
    ]

    drilldown[${LABEL}] スタイルのドリルダウンの出力形式については drilldown[${LABEL}] スタイルの出力フォーマット も見てください。

  参考

•   /reference/grn_expr/query_syntax

•   /reference/grn_expr/script_syntax

  shutdown

  概要

shutdown はGroongaサーバープロセスを終了します。

shutdown はデフォルトではgraceful shutdownを使います。もし、実行中のコマンドがあるならそれらのコマンドが終了してからGroongaサーバープロセスを終了します。 shutdown コマンドを実行した後は新しいコマンドを実行されません。

バージョン 6.0.1 で追加: shutdown は mode パラメーターに immediate を指定するとimmediate shutdownを使います。たとえ実行中のコマンドがあってもGroongaサーバープロセスをすぐに終了します。

注釈: immediate shutdownを使うにはすべてのリクエストに /reference/command/request_id を設定する必要があります。

  構文

このコマンドの引数は1つで省略できます:

shutdown [mode=graceful]

  使い方

shutdown はデフォルトではgraceful shutdownを使います。

実行例:

shutdown
# [[0, 1337566253.89858, 0.000355720520019531], true]

明示的に mode パラメーターに graceful を指定することもできます。

実行例:

shutdown --mode graceful
# [[0, 1337566253.89858, 0.000355720520019531], true]

mode パラメーターに immediate を指定することでimmediate shutdownを使うことができます。

実行例:

shutdown --mode immediate
# [[0, 1337566253.89858, 0.000355720520019531], true]

immediate shutdownはgraceful shutdownする時間がないときに便利です。たとえば、WindowsはWindowsをシャットダウンするときに時間内に終了しないサービスを強制終了します。

  引数

このセクションではこのコマンドのパラメーターを説明します。

  必須引数

必須の引数はありません。

  省略可能引数

いくつか省略可能な引数があります。

  mode

シャットダウンのモードを指定します。利用可能なモードは次の通りです。
Value | 説明
graceful | 実行中のコマンドが終了してから終了します。 これがデフォルトです。
immediate | バージョン 6.0.1 で追加: 実行中のコマンドがあってもすぐに終了します。

  戻り値

shutdown はシャットダウンを受け付けたときは以下のようにボディが true になります。:

[HEADER, true]

shutdown がシャットダウンを受け付けなかったら HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

  status

  概要

status はこのリクエストを処理しているコンテキストの現在のステータスを返します。

コンテキストはリクエストを処理する単位です。通常、各スレッドごとにコンテキストを作ります。

  構文

このコマンドに引数はありません:

status

  使い方

以下は簡単な使用例です。

実行例:

status
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "uptime": 0,
#     "max_command_version": 2,
#     "start_time": 1441980651,
#     "cache_hit_rate": 0.0,
#     "version": "5.0.7-126-gb6fd7f7",
#     "alloc_count": 206,
#     "command_version": 1,
#     "starttime": 1441980651,
#     "default_command_version": 1,
#     "n_queries": 0
#   }
# ]

このリクエストを処理しているコンテキストの現在のステータスを返します。詳細は 戻り値 を参照してください。

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数はありません。

  省略可能引数

省略可能な引数はありません。

  戻り値

このコマンドはオブジェクトとして現在のステータスを返します。:

[
  HEADER,
  {
    "alloc_count": ALLOC_COUNT,
    "cache_hit_rate": CACHE_HIT_RATE,
    "command_version": COMMAND_VERSION,
    "default_command_version": DEFAULT_COMMAND_VERSION,
    "max_command_version": MAX_COMMAND_VERSION,
    "n_queries": N_QUERIES,
    "start_time": START_TIME,
    "starttime": STARTTIME,
    "uptime": UPTIME,
    "version": VERSION
  }
]

HEADER については /reference/command/output_format を参照してください。

以下は値の説明です。実際の値は 使い方 を参照してください。
キー | 説明 | 例
alloc_count | まだ解放されていないメモリーブロックの数です。もし、この値が継続的に増えていっているならメモリーリークがあるかもしれません。 | 1400
cache_hit_rate | このGroongaプロセスがキャッシュを使って返したレスポンスの割合です。もし、10リクエストのうち7つのレスポンスはキャッシュを使ったなら、 cache_hit_rate は 70.0 になります。この割合はキャッシュをサポートしているコマンドを使ったリクエストのみで計算します。 以下はキャッシュをサポートしているコマンドです。 select logical_select logical_range_filter logical_count | 29.4
command_version | このコンテキストが使っている /reference/command/command_version です。 | 1
default_command_version | このGroongaプロセスのデフォルト /reference/command/command_version です。 | 1
max_command_version | このGroongaプロセスがサポートしている最大 /reference/command/command_version です。 | 2
n_queries | このGroongaプロセスが処理したリクエスト数です。ただし、キャッシュをサポートしたコマンドを使ったリクエストだけを数えます。 以下はキャッシュをサポートしているコマンドです。 select logical_select logical_range_filter logical_count | 29
start_time | バージョン 5.0.8 で追加. このGroongaプロセスが起動した時間です。UNIX時間です。 | 1441761403
starttime | バージョン 5.0.8 で撤廃: 代わりに start_time を使ってください。 | 1441761403
uptime | このGroongaプロセスが起動してから経過した時間です。単位は秒です。 たとえば、 216639 は 2.5 （= 216639 / 60 / 60 / 24 = 2.507 ）日という意味です。 | 216639
version | このGroongaプロセスのバージョンです。 | 5.0.7

  suggest

注釈: サジェスト機能の仕様はまだ確定していません。仕様は変更される可能性があります。

  概要

suggest - 指定されたクエリーに対する補完・補正・提案候補を返す。

suggestコマンドは指定されたクエリーに対する補完・補正・提案候補を返します。

補完・補正・提案については /reference/suggest/introduction を参照してください。

  構文

suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]]

  使い方

以下は補完用の学習データです。

実行例:

load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "1", "time": 1312950803.86057, "item": "e"},
{"sequence": "1", "time": 1312950803.96857, "item": "en"},
{"sequence": "1", "time": 1312950804.26057, "item": "eng"},
{"sequence": "1", "time": 1312950804.56057, "item": "engi"},
{"sequence": "1", "time": 1312950804.76057, "item": "engin"},
{"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 6]

以下は補正用の学習データです。

実行例:

load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "2", "time": 1312950803.86057, "item": "s"},
{"sequence": "2", "time": 1312950803.96857, "item": "sa"},
{"sequence": "2", "time": 1312950804.26057, "item": "sae"},
{"sequence": "2", "time": 1312950804.56057, "item": "saer"},
{"sequence": "2", "time": 1312950804.76057, "item": "saerc"},
{"sequence": "2", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
{"sequence": "2", "time": 1312950809.76057, "item": "serch"},
{"sequence": "2", "time": 1312950810.86057, "item": "search", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 8]

以下は提案用の学習データです。

実行例:

load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "3", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
{"sequence": "3", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

以下は補完例です。

実行例:

suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "complete": [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "engine",
#         1
#       ]
#     ]
#   }
# ]

以下は補正例です。

実行例:

suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "correct": [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "search",
#         1
#       ]
#     ]
#   }
# ]

以下は提案例です。

実行例:

suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "suggest": [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "search engine",
#         1
#       ],
#       [
#         "web search realtime",
#         1
#       ]
#     ]
#   }
# ]

以下は補完・補正・提案を混ぜた例です。

実行例:

suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "suggest": [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "search engine",
#         1
#       ],
#       [
#         "web search realtime",
#         1
#       ]
#     ],
#     "complete": [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "search",
#         2
#       ],
#       [
#         "search engine",
#         2
#       ]
#     ],
#     "correct": [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "search",
#         2
#       ]
#     ]
#   }
# ]

  引数

types
    suggestコマンドでどの種類の候補を返すかを指定します。

    指定できる種類は以下の通りです。

complete
    補完を実行します。

correct
    補正を実行します。

suggest
    提案を実行します。

    1つ以上の種類を指定できます。複数の種類を指定する場合は | で区切ります。以下が例です。: 補正候補を返します:

    correct

    補正候補と提案候補を返します:

    correct|suggest

    補完候補と補正候補と提案候補を返します:

    complete|correct|suggest

table
    item_${データセット名} というフォーマットのテーブル名を指定します。例えば、以下のコマンドでデータセットを作成した場合はテーブル名として item_query を指定します:

    groonga-suggest-create-dataset /tmp/db-path query

column
    table で指定したテーブルにあるふりがな情報を含むカラムを指定します。ふりがなはカタカナで指定します。

query
    補完・補正・提案対象のクエリーを指定します。

sortby
    ソートキーを指定します。

Default:
    -_score

output_columns
    出力するカラムを指定します。

Default:
    _key,_score

offset
    返されるレコードのオフセットを指定します。

Default:
    0

limit
    返されるレコード数を指定します。

Default:
    10

frequency_threshold
    出現頻度に対する閾値を指定します。返されるレコードの _score 値は frequency_threshold 以上になります。

Default:
    100

    conditional_probability_threshold 条件付き確率に対する閾値を指定します。学習データに対して条件付き確率を使います。ここで使う条件付き確率は、入力した query と同じ入力があったときにクエリが検索された確率です。返されるレコードの条件付き確率は conditional_probability_threshold 以上になります。

Default:
    0.2

prefix_search
    補完時に前方一致検索を実行するかどうかを指定します。

    指定可能な値は以下の通りです。

yes 常に前方一致検索を実行します。

no  前方一致検索を実行しません。

auto
    他の検索でレコードが見つからない場合のみ前方一致検索を実行します。

Default:
    auto

similar_search
    補正時に類似検索を実行するかどうかを指定します。

    指定可能な値は以下の通りです。

yes 常に類似検索を実行します。

no  類似検索を実行しません。

auto
    他の検索でレコードが見つからない場合のみ類似検索を実行します。

Default:
    auto

  戻り値

返されるJSON形式は以下の通りです:

{"type1": [["candidate1", score of candidate1],
           ["candidate2", score of candidate2],
           ...],
 "type2": [["candidate1", score of candidate1],
           ["candidate2", score of candidate2],
           ...],
 ...}

type types で指定した値。

candidate 補完・補正・提案候補。

score of candidate 対応する candidate のスコアです。スコアが高いほど補完・補正・提案候補として有力という意味になります。デフォルトでは候補は score of candidate の降順でソートされています。

  参考

•   /reference/suggest

•   /reference/executables/groonga-suggest-create-dataset

  table_create

  概要

table_create は現在のデータベースに新しいテーブルを作成します。データを保存したり検索したりするために、1つ以上のテーブルを作成する必要があります。

  構文

このコマンドにはたくさんの引数があります。

必須の引数は name だけで、残りは省略できます:

table_create name
             [flags=TABLE_HASH_KEY]
             [key_type=null]
             [value_type=null]
             [default_tokenizer=null]
             [normalizer=null]
             [token_filters=null]

  使い方

table_create コマンドは新しく永続テーブルを作成します。テーブルの詳細については /reference/tables を参照してください。

  データ保存用テーブルの作成

データ保存用のテーブルにはどの種類のテーブルでも使えます。テーブルの種類については /reference/tables を参照してください。

テーブルの型は TABLE_${TYPE} を flags 引数に指定します。

以下は TABLE_NO_KEY テーブルを使う例です。

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]

この table_create コマンドは Logs という名前で TABLE_NO_KEY 型のテーブルを作成します。

キーでレコードを検索しないのであれば、 TABLE_NO_KEY 型のテーブルが適切です。なぜなら、 TABLE_NO_KEY はキーをサポートしていませんが、速くて小さいサイズのテーブルだからです。ログをGroongaのデータベースに保存するという使い方はこのケースです。

キーでレコードを検索したり、カラムからレコードを参照したりする場合は、 TABLE_NO_KEY 型は適していません。全文検索用の語彙表として使うケースはこのケースです。

  大きなデータ保存用テーブルの作成

たくさんの大きなキーを保存したいとき、テーブルにすべてのキーを保存できないかもしれません。もし、総キーデータが4GiBより大きいなら、デフォルトではすべてのキーデータをテーブルに保存できません。

KEY_LARGE フラグを使うと4GiBから1TiBに最大総キーサイズを拡張できます。 KEY_LARGE フラグは TABLE_HASH_KEY を使っているときだけ使えます。 KEY_LARGE フラグは TABLE_NO_KEY 、 TABLE_PAT_KEY 、 TABLE_DAT_KEY と一緒に使えません。

以下はたくさんの大きなキーを保存することができるテーブルを作る例です。

実行例:

table_create Paths TABLE_HASH_KEY|KEY_LARGE ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

この table_create コマンドは、名前が Paths で TABLE_HASH_KEY 型のテーブルを作成します。 Paths テーブルはたくさんの大きなキーを保存できます。

  語彙表テーブルの作成

語彙表テーブル用のテーブルには TABLE_NO_KEY 以外の型のテーブルを使います。語彙表テーブルはキーをサポートしていないといけませんが、 TABLE_NO_KEY はキーをサポートしていません。

以下は TABLE_PAT_KEY テーブルを作る例です。

実行例:

table_create Lexicon TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]

この table_create コマンドは以下のテーブルを作成します。

•   このテーブルは Lexicon という名前です。

•   このテーブルは TABLE_PAT_KEY 型のテーブルです。

•   このテーブルのキーは ShortText 型です。

•   このテーブルは正規化されたテキストからトークンを抽出するために TokenBigram トークナイザーを使います。

•   このテーブルはテキストを正規化するために NormalizerAuto ノーマライザーを使います。

    語彙表テーブルには TABLE_PAT_KEY が適切なテーブルの型です。語彙表テーブルは全文検索に使われます。

    全文検索では、あいまい検索をするために前方一致検索を使っています。前方一致検索は TABLE_PAT_KEY と TABLE_DAT_KEY がサポートしています。

    全文検索対象のテキストには大量のトークンが含まれるので、語彙表テーブルのキーも大量になります。大量のキーを格納するテーブルの場合はテーブルのサイズを意識する必要があります。これは、大きなテーブルはそれだけ多くのメモリーを必要とするからです。多くのメモリーが必要になると、ディスクI/Oが発生することもあります。ディスクI/Oが発生すると高速に検索できなくなります。そのため、大量のキーがあるテーブルの場合はテーブルのサイズが重要になります。 TABLE_PAT_KEY は TABLE_DAT_KEY よりもテーブルのサイズが小さいです。

    上記の理由から、 TABLE_PAT_KEY が語彙表テーブルに適したテーブルの型です。

  タグインデックス用テーブルの作成

タグインデックス用のテーブルには TABLE_NO_KEY 以外の型のテーブルを使えます。タグインデックス用のテーブルはキーのサポートが必要ですが、 TABLE_NO_KEY はキーをサポートしていません。

以下は TABLE_HASH_KEY 型のテーブルを作る例です。

実行例:

table_create Tags TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

この table_create コマンドは Tags という名前で TABLE_HASH_KEY 型のテーブルを作ります。このテーブルのキーは ShortText 型です。

タグインデックス用のテーブルには TABLE_HASH_KEY あるいは TABLE_DAT_KEY が適切なテーブルの型です。

完全一致でタグを検索する機能だけが必要なら、 TABLE_HASH_KEY が適切です。多くの場合はこのケースです。

もし、前方一致検索機能も必要な場合（例えば、 "gr" というキーワードで "groonga" を検索する場合）は、 TABLE_DAT_KEY が適切です。 TABLE_DAT_KEY はサイズの大きなテーブルですが、タグの数はそれほど多くならないので、サイズは重要ではありません。

  範囲検索用のインデックステーブルの作成

範囲検索用のインデックステーブルには TABLE_PAT_KEY 型と TABLE_DAT_KEY 型を使えます。範囲検索用のインデックステーブルは範囲検索をサポートしている必要がありますが、 TABLE_NO_KEY 型と TABLE_HASH_KEY 型はサポートしていません。

以下は TABLE_DAT_KEY テーブルを作成する例です。

実行例:

table_create Ages TABLE_DAT_KEY UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]

この table_create コマンドは Ages という名前で TABLE_DAT_KEY 型のテーブルを作成します。このテーブルのキーの型は UInt32 です。

範囲検索用のインデックステーブルには TABLE_PAT_KEY 型と TABLE_DAT_KEY 型が適切なテーブルの型です。

インデックス対象の項目が少なければ、 TABLE_DAT_KEY 型が適切です。前述の例では、年齢（age）用のインデックスがこのケースになります。年齢のインデックスはせいぜい0から100項目くらいにしかなりません。これは、人はそんなに長生きできないからです。

インデックス対象が大量にある場合は、 TABLE_PAT_KEY 型が適切です。なぜなら、 TABLE_PAT_KEY 型は TABLE_DAT_KEY 型よりもサイズが小さいからです。

  引数

このセクションではすべての引数について説明します。

  name

作成するテーブル名を指定します。 name は必ず指定しなければいけません。

利用可能な文字は以下の通りです。

•   0 .. 9 （数字）

•   a .. z （アルファベット。小文字）

•   A .. Z （アルファベット。大文字）

•   # （シャープ）

•   @ （アットマーク）

•   - （ハイフン）

•   _ （アンダースコア）（注: 最初の文字としてアンダースコアを使うことはできません。）

    上記の文字を1つ以上使って名前を決めます。 _name というように、最初の文字に _ を使えないことに注意してください。

  flags

テーブルの型とテーブルをカスタマイズするオプションを指定します。

指定可能なフラグは以下の通りです。
フラグ | 説明
TABLE_NO_KEY | 配列テーブル。 table-no-key 参照。
TABLE_HASH_KEY | ハッシュテーブル。 table-hash-key 参照。
TABLE_PAT_KEY | パトリシアトライ。 table-pat-key 参照。
TABLE_DAT_KEY | ダブル配列トライ。 table-dat-key 参照。
KEY_WITH_SIS | 半無限文字列を有効にします。 TABLE_PAT_KEY と使う必要があります。
KEY_LARGE | 最大総キーサイズを4GiBから1TiBへ拡張します。 TABLE_HASH_KEY と使う必要があります。

注釈: Groonga 2.1.0から KEY_NORMALIZE フラグは非推奨になりました。代わりに、 normalizer オプションに NormalizerAuto を指定してください。

TABLE_${TYPE} フラグのどれか1つを指定します。 TABLE_${TYPE} フラグを2つ以上指定することはできません。例えば、 TABLE_NO_KEY|TABLE_HASH_KEY は不正な指定方法です。

TABLE_PAT_KEY|KEY_WITH_SIS というように、 | （縦棒）で複数のフラグを組み合わせることができます。

それぞれのテーブルの型の違いは /reference/tables を参照してください。

デフォルトのフラグは TABLE_HASH_KEY です。

  key_type

キーの型を指定します。

flags パラメーターに TABLE_HASH_KEY 、 TABLE_PAT_KEY または TABLE_DAT_KEY を指定した場合は、 key_type オプションを指定する必要があります。

型の一覧は /reference/types にあります。

デフォルト値はありません。

  value_type

値の型を指定します。

flags パラメーターに TABLE_NO_KEY 、 TABLE_HASH_KEY または TABLE_PAT_KEY を指定した場合は「値」を使うことができます。「値」の型は固定長でなければいけません。例えば、 UInt32 は使えますが、 ShortText は使えません。この場合は値ではなく、カラムを使ってください。

デフォルト値はありません。

  default_tokenizer

デフォルトトークナイザーを指定します。これは、検索時とデータロード時に使われます。

テーブルを全文検索インデックスの語彙表として使う場合は default_tokenizer を指定しなければいけません。利用可能なトークナイザーは /reference/tokenizers を参照してください。全文検索する場合はこのリストの中からトークナイザーを選んでください。

次の場合は default_tokenizer を指定する必要はありません。

•   テーブルを語彙表として使わないとき。

•   テーブルを語彙表として使うが、全文検索をしないとき。例：

•   インデックス対象のデータが Int32 や Time のようにテキストデータでないとき。

•   完全一致検索や前方一致検索などだけが必要なとき。

    TABLE_NO_KEY フラグと一緒に default_tokenizer を使うことはできません。これは、 TABLE_NO_KEY フラグを使っているテーブルは語彙表として使うことはできないからです。

    テーブルを語彙表として使いたいときは、 flags に TABLE_HASH_KEY 、 TABLE_PAT_KEY 、 TABLE_DAT_KEY のどれかを指定してください。

    デフォルト値はありません。

  normalizer

キーを正規化するために使うノーマライザーを指定します。

TABLE_NO_KEY はキーをサポートしていないので、 TABLE_NO_KEY と normalizer を一緒に指定することはできません。

ノーマライザーの一覧は /reference/normalizers にあります。

デフォルト値はありません。

  token_filters

トークナイズされたトークンに所定の処理を行うために使うトークンフィルターを指定します。

TABLE_NO_KEY はキーをサポートしていないので、 TABLE_NO_KEY と token_filters を一緒に指定することはできません。

トークンフィルターの一覧は /reference/token_filters にあります。

デフォルト値はありません。

  戻り値

table_create が成功したときは以下のようにボディは true になります:

[HEADER, true]

table_create が失敗すると、エラーの詳細は HEADER に含まれます。

HEADER については /reference/command/output_format を参照してください。

  参考

•   /reference/tables

•   /reference/commands/column_create

•   /reference/tokenizers

•   /reference/normalizers

•   /reference/command/output_format

  table_list

  概要

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

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

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

  構文

table_list

  使い方

実行例:

table_list
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         "id",
#         "UInt32"
#       ],
#       [
#         "name",
#         "ShortText"
#       ],
#       [
#         "path",
#         "ShortText"
#       ],
#       [
#         "flags",
#         "ShortText"
#       ],
#       [
#         "domain",
#         "ShortText"
#       ],
#       [
#         "range",
#         "ShortText"
#       ],
#       [
#         "default_tokenizer",
#         "ShortText"
#       ],
#       [
#         "normalizer",
#         "ShortText"
#       ]
#     ],
#     [
#       259,
#       "Ages",
#       "/tmp/groonga-databases/commands_table_create.0000103",
#       "TABLE_DAT_KEY|PERSISTENT",
#       "UInt32",
#       null,
#       null,
#       null
#     ],
#     [
#       257,
#       "Lexicon",
#       "/tmp/groonga-databases/commands_table_create.0000101",
#       "TABLE_PAT_KEY|PERSISTENT",
#       "ShortText",
#       null,
#       "TokenBigram",
#       "NormalizerAuto"
#     ],
#     [
#       256,
#       "Logs",
#       "/tmp/groonga-databases/commands_table_create.0000100",
#       "TABLE_NO_KEY|PERSISTENT",
#       null,
#       null,
#       null,
#       null
#     ],
#     [
#       258,
#       "Tags",
#       "/tmp/groonga-databases/commands_table_create.0000102",
#       "TABLE_HASH_KEY|PERSISTENT",
#       "ShortText",
#       null,
#       null,
#       null
#     ]
#   ]
# ]

  引数

ありません。

  戻り値

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

[[[テーブル情報名1,テーブル情報型1],...], テーブル情報1,...]

テーブル情報名n テーブル情報n には複数の情報が含まれますが、そこに入る情報がどんな内容かを示す名前を出力します。 情報名は以下の通りです。

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

name テーブル名

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

flags テーブルのflags属性

domain 主キー値の属する型

range valueが属する型

テーブル情報型n テーブル情報の型を出力します。

テーブル情報n テーブル情報名n で示された情報の配列を出力します。 情報の順序は テーブル情報名n の順序と同じです。

  table_remove

  概要

table_remove はテーブルとそのカラムを削除します。もし、テーブルのキーあるいはそのテーブルのカラムにインデックスが張ってある場合はそれらも削除されます。

バージョン 6.0.1 で追加: もし、自分がなにをしようとしているかちゃんと理解しているのであれば、 --dependent yes パラメーターを使うことで1回の table_remove で対象テーブルを参照しているテーブルとカラムも削除することができます。

  構文

このコマンドには2つの引数があります。:

table_remove name
             [dependent=no]

  使い方

削除したいテーブルの名前を指定するだけです。 table_remove は指定されたテーブルとそのテーブルのカラムを削除します。もし、テーブルとそのテーブルのカラムにインデックスが張ってある場合は、張ってあるすべてのインデックスも削除します。

このセクションでは次のことについて説明します。

•   基本的な使い方

•   削除できないケース

•   対象テーブルを参照しているテーブル・カラムも一緒に削除

•   利用リソースの削減

  基本的な使い方

次のケースを考えてみましょう。

•   Entries というテーブルがあります。

•   Entries テーブルにはいくつかカラムがあります。

•   Entries テーブルのキーにはインデックスが張ってあります。

•   Entries のあるカラムにはインデックスが張ってあります。

    以下は Entries テーブルを作成するコマンドです。

    実行例:

    table_create Entries TABLE_HASH_KEY UInt32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Entries title COLUMN_SCALAR ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Entries content COLUMN_SCALAR Text
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    以下は Entries テーブルのキーにインデックスを張るコマンドです。

    実行例:

    table_create EntryKeys TABLE_HASH_KEY UInt32
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create EntryKeys key_index COLUMN_INDEX Entries _key
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    以下は Entries テーブルのカラムにインデックスを張るコマンドです。

    実行例:

    table_create Terms TABLE_PAT_KEY ShortText \
      --default_tokenizer TokenBigram \
      --normalizer NormalizerAuto
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Terms content_index COLUMN_INDEX Entries content
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    table_remove を実行する前に現在のスキーマを確認しましょう。

    実行例:

    dump
    # table_create Entries TABLE_HASH_KEY UInt32
    # column_create Entries content COLUMN_SCALAR Text
    # column_create Entries title COLUMN_SCALAR ShortText
    #
    # table_create EntryKeys TABLE_HASH_KEY UInt32
    #
    # table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
    #
    # column_create EntryKeys key_index COLUMN_INDEX Entries _key
    # column_create Terms content_index COLUMN_INDEX Entries content

    Entries テーブルを削除すると、次のテーブルとカラムが削除されます。

•   Entries

•   Entries.title

•   Entries.context

•   EntryKeys.key_index

•   Terms.content_index

    次のテーブル（語彙表）は削除されません。

•   EntryKeys

•   Terms

    table_remove を実行しましょう。

    実行例:

    table_remove Entries
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    以下が table_remove 実行後のスキーマです。 EntryKeys と Terms だけが残っています。

    実行例:

    dump
    # table_create EntryKeys TABLE_HASH_KEY UInt32
    #
    # table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto

  削除できないケース

以下は削除できないケースです。

•   1つ以上のテーブルがこの削除対象のテーブルをキーの型として使っている。

•   1つ以上のカラムがこの削除対象のテーブルを値の型として使っている。

    どちらのケースも参照先がなくなることを防ぎます。もし、削除対象のテーブルが型として参照されているままそのテーブルが削除されてしまうと、そのテーブルを参照しているテーブルとカラムは壊れてしまいます。

    もし、削除対象のテーブルがどれかの条件を満たしたら table_remove は失敗します。削除対象のテーブルも削除対象のテーブルのカラムも削除されません。

    以下は削除対象のテーブルがキーの型に使われるケースの例です。

    次のコマンドは削除対象のテーブルとそのテーブルをキーの型として使うテーブルを作成します。

    実行例:

    table_create ReferencedByTable TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_create ReferenceTable TABLE_HASH_KEY ReferencedByTable
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    ReferencedByTable に対する table_remove は失敗します。

    実行例:

    table_remove ReferencedByTable
    # [
    #   [
    #     -2,
    #     1337566253.89858,
    #     0.000355720520019531,
    #     "[table][remove] a table that references the table exists: <ReferenceTable._key> -> <ReferencedByTable>",
    #     [
    #       [
    #         "is_removable_table",
    #         "db.c",
    #         8831
    #       ]
    #     ]
    #   ],
    #   false
    # ]

    ReferencedByTable を削除する前に ReferenceTable を削除する必要があります。

    実行例:

    table_remove ReferenceTable
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_remove ReferencedByTable
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    以下は削除対象のテーブルが値の型に使われるケースの例です。

    次のコマンドは削除対象のテーブルとそのテーブルを値の型として使うカラムを作成します。

    実行例:

    table_create ReferencedByColumn TABLE_HASH_KEY ShortText
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_create Table TABLE_NO_KEY
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create Table reference_column COLUMN_SCALAR ReferencedByColumn
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    ReferencedByColumn に対する table_remove は失敗します。

    実行例:

    table_remove ReferencedByColumn
    # [
    #   [
    #     -2,
    #     1337566253.89858,
    #     0.000355720520019531,
    #     "[table][remove] a column that references the table exists: <Table.reference_column> -> <ReferencedByColumn>",
    #     [
    #       [
    #         "is_removable_table",
    #         "db.c",
    #         8851
    #       ]
    #     ]
    #   ],
    #   false
    # ]

    ReferencedByColumn を削除する前に Table.reference_column を削除する必要があります。

    実行例:

    column_remove Table reference_column
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    table_remove ReferencedByColumn
    # [[0, 1337566253.89858, 0.000355720520019531], true]

  対象テーブルを参照しているテーブル・カラムも一緒に削除

バージョン 6.0.1 で追加.

もし、自分がなにをしようとしているかちゃんと理解しているのであれば、 --dependent yes パラメーターを使うことで1回の table_remove で対象テーブルを参照しているテーブルとカラムも削除することができます。

以下のスキーマの ReferencedTable は1つのテーブルと1つのカラムから参照されています。

実行例:

table_create ReferencedTable TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Table1 TABLE_HASH_KEY ReferencedTable
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Table2 TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Table2 reference_column COLUMN_SCALAR ReferencedTable
# [[0, 1337566253.89858, 0.000355720520019531], true]

デフォルトでは ReferencedTable を削除することはできません。

実行例:

table_remove ReferencedTable
# [
#   [
#     -2,
#     1337566253.89858,
#     0.000355720520019531,
#     "[table][remove] a table that references the table exists: <Table1._key> -> <ReferencedTable>",
#     [
#       [
#         "is_removable_table",
#         "db.c",
#         8831
#       ]
#     ]
#   ],
#   false
# ]

--dependent yes パラメーターを使うことで ReferencedTable と Table1 と Table2.reference_column を削除できます。 Table1 と Table2.reference_column は ReferencedTable を参照しています。

実行例:

table_remove ReferencedTable --dependent yes
# [[0, 1337566253.89858, 0.000355720520019531], true]

  利用リソースの削減

table_remove は 削除できないケース のチェックをするためにデータベース内のすべてのテーブルとカラムを開きます。

もし、大量のテーブルとカラムがある場合、 table_remove はたくさんのリソースを使うかもしれません。このケース用の回避策があります。

table_remove は最大スレッド数が 1 のときはチェック用に一時的に開いたテーブルとカラムを閉じます。

thread_limit を使うと現在の最大スレッド数を確認・変更できます。

この機能は次のケースでは使われます。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
thread_limit 2
# [[0, 1337566253.89858, 0.000355720520019531], 1]
table_remove Entries
# [[0, 1337566253.89858, 0.000355720520019531], true]

この機能は次のケースでは使われません。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
thread_limit 2
# [[0, 1337566253.89858, 0.000355720520019531], 1]
table_remove Entries
# [[0, 1337566253.89858, 0.000355720520019531], true]

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数は1つです。

  name

削除するテーブルの名前を指定します。

このパラメーターの使い方は 使い方 を参照してください。

  省略可能引数

省略可能な引数が1つあります。

  dependent

バージョン 6.0.1 で追加.

対象テーブルを参照しているテーブル・カラムも一緒に削除するかどうかを指定します。

yes を指定した場合は、対象テーブルを参照しているテーブル・カラムも一緒に削除します。それ以外の場合は、どれも削除せずにエラーが返ります。

言い換えると、デフォルトでは、対象テーブルを参照しているテーブル・カラムが1つでもあると、対象テーブルを削除しません。

このパラメーターは注意して使ってください。危険なパラメーターです。

このパラメーターの使い方は 対象テーブルを参照しているテーブル・カラムも一緒に削除 を参照してください。

  戻り値

このコマンドが成功したときは以下のようにボディは true になります:

[HEADER, true]

このコマンドが失敗すると、 HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

  table_rename

  概要

table_rename コマンドはテーブル名を変更します。

これは軽い操作です。名前とテーブルオブジェクト間の関係を変更するだけです。テーブルの値とテーブルのカラムの値をコピーしません。

これは危険な操作です。 table_rename を実行している間、読み取り操作を含むすべての操作を停止しなければいけません。以下のケースが起こった場合、Groongaプロセスはクラッシュするかもしれません。

•   現在のテーブル名で名前を変更しようとしているテーブルにアクセスする操作（たとえば select ）を開始します。以降、現在のテーブル名を 古いテーブル名 と呼ぶことにします。これは、今、このテーブル名を変更しようとしているからです。

•   table_rename を実行します。 select は実行中です。

•   select は古いテーブル名で、名前が変更されたテーブルにアクセスします。しかし、テーブルはすでに新しいテーブル名に変更されているため、 select は古いテーブル名でテーブルを見つけることができません。このときGroongaプロセスがクラッシュするかもしれません。

  構文

このコマンドには2つの引数があります。

すべての引数は必須です:

table_rename name new_name

  使い方

以下は table_rename コマンドの簡単な使用例です。

実行例:

table_create Users TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users score COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "Alice",  "score": 2},
{"_key": "Bob",    "score": 0},
{"_key": "Carlos", "score": -1}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
table_rename Users Players
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_list
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         "id",
#         "UInt32"
#       ],
#       [
#         "name",
#         "ShortText"
#       ],
#       [
#         "path",
#         "ShortText"
#       ],
#       [
#         "flags",
#         "ShortText"
#       ],
#       [
#         "domain",
#         "ShortText"
#       ],
#       [
#         "range",
#         "ShortText"
#       ],
#       [
#         "default_tokenizer",
#         "ShortText"
#       ],
#       [
#         "normalizer",
#         "ShortText"
#       ]
#     ],
#     [
#       256,
#       "Players",
#       "/tmp/groonga-databases/commands_table_rename.0000100",
#       "TABLE_PAT_KEY|PERSISTENT",
#       "ShortText",
#       null,
#       null,
#       null
#     ]
#   ]
# ]
select Players
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "score",
#           "Int32"
#         ]
#       ],
#       [
#         1,
#         "Alice",
#         2
#       ],
#       [
#         2,
#         "Bob",
#         0
#       ],
#       [
#         3,
#         "Carlos",
#         -1
#       ]
#     ]
#   ]
# ]

  引数

このセクションでは table_rename の引数について説明します。

  必須引数

すべての引数は必須です。

  name

名前を変更するテーブルの名前を指定します。

  new_name

新しいテーブル名を指定します。

  戻り値

このコマンドが成功したときは以下のようにボディは true になります:

[HEADER, true]

このコマンドが失敗すると、 HEADER にエラーの詳細が含まれます。

HEADER については /reference/command/output_format を参照してください。

  table_tokenize

  概要

table_tokenize コマンドは指定したテーブルのトークナイザーでテキストをトークナイズします。

  構文

このコマンドにはたくさんの引数があります。

table と string は必須の引数です。残りは省略できます:

table_tokenize table
               string
               [flags=NONE]
               [mode=GET]

  使い方

以下は簡単な使用例です。

実行例:

register token_filters/stop_word
# [[0,0.0,0.0],true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto \
  --token_filters TokenFilterStopWord
# [[0,0.0,0.0],true]
column_create Terms is_stop_word COLUMN_SCALAR Bool
# [[0,0.0,0.0],true]
load --table Terms
[
{"_key": "and", "is_stop_word": true}
]
# [[0,0.0,0.0],1]
table_tokenize Terms "Hello and Good-bye" --mode GET
# [
#  [
#    0,
#    0.0,
#    0.0
#  ],
#  [
#    {
#      "value": "hello",
#      "position": 0
#    },
#    {
#      "value": "good",
#      "position": 2
#    },
#    {
#      "value": "-",
#      "position": 3
#    },
#    {
#      "value": "bye",
#      "position": 4
#    }
#  ]
# ]

Terms テーブルには、 TokenBigram トークナイザーと、 NormalizerAuto ノーマライザーと、 TokenFilterStopWord トークンフィルターがセットされています。 この例は TokenBigram トークナイザーで "Hello and Good-bye" をトークナイズしたトークンを返します。トークンは、 NormalizerAuto ノーマライザーで正規化されています。 and トークンは、 TokenFilterStopWord トークンフィルターで除去されています。

  引数

このセクションではすべての引数について説明します。引数はカテゴリわけしています。

  必須引数

必須の引数は2つです。 table と string です。

  table

語彙表テーブルを指定します。 table_tokenize コマンドは、語彙表テーブルにセットされたトークナイザーとノーマライザーとトークンフィルターを使います。

  string

トークナイズしたい文字列を指定します。

詳細は、 /reference/commands/tokenize の tokenize-string オプションを参照してください。

  省略可能引数

いくつか省略可能な引数があります。

  flags

トークナイズ処理をカスタマイズするオプションを指定します。「 | 」で区切って複数のオプションを指定することができます。

デフォルト値は NONE です。

詳細は、 /reference/commands/tokenize の tokenize-flags オプションを参照してください。

  mode

トークナイズモードを指定します。

デフォルト値は GET です。

詳細は、 /reference/commands/tokenize の tokenize-mode オプションを参照してください。

  戻り値

table_tokenize コマンドはトークナイズしたトークンを返します。

詳細は、 /reference/commands/tokenize の tokenize-return-value オプションを参照してください。

  参考

•   /reference/tokenizers

•   /reference/commands/tokenize

  thread_limit

  概要

バージョン 5.0.7 で追加.

thread_limit は次の2つの機能を提供します。

•   最大スレッド数を返します。

•   最大スレッド数を設定します。

    /reference/executables/groonga は thread_limit のすべての機能を提供する唯一のGroongaサーバーです。

    /reference/executables/groonga-httpd は最大スレッド数を返す機能だけをサポートしています。 /reference/executables/groonga-httpd の最大スレッド数は常に1です。なぜなら、 /reference/executables/groonga-httpd はシングルスレッドモデルを採用しているからです。

    Groongaをライブラリーとして使っている場合、 grn_thread_set_get_limit_func() と grn_thread_set_set_limit_func() でカスタム関数を設定しない限り動きません。 grn_thread_set_get_limit_func() でカスタム関数を設定すると最大スレッド数を返す機能が動きます。 grn_thread_set_set_limit_func() でカスタム関数を設定すると最大スレッド数を設定する機能が動きます。

  構文

このコマンドの引数は1つで省略できます:

thread_limit [max=null]

  使い方

引数なしで呼び出すと最大スレッド数を得られます。

実行例:

thread_limit
# [[0, 1337566253.89858, 0.000355720520019531], 2]

0 が返ってきたら、そのGroongaサーバーはこの機能をサポートしていないということです。

max 引数つきで呼び出すと最大スレッド数を設定できます。

実行例:

thread_limit --max 4
# [[0, 1337566253.89858, 0.000355720520019531], 2]

max 引数を渡したときは設定前の最大スレッド数が返ります。

  引数

このセクションではすべての引数について説明します。

  必須引数

必須の引数はありません。

  省略可能引数

省略可能な引数が1つあります。

  max

新しい最大スレッド数を指定します。

正の整数を指定してください。

実行例:

thread_limit --max 3
# [[0, 1337566253.89858, 0.000355720520019531], 4]

max 引数を指定した場合、 thread_limit は max を適用する前の最大スレッド数を返します。

  戻り値

このコマンドのボディは最大スレッド数になります:

[HEADER, N_MAX_THREADS]

max を指定したときは N_MAX_THREADS は max を適用する前の最大スレッド数になります。

HEADER については /reference/command/output_format を参照してください。

  tokenize

  概要

tokenize コマンドは指定したトークナイザーでテキストをトークナイズします。これはトークナイズ処理のデバッグに便利です。

  構文

このコマンドにはたくさんの引数があります。

tokenizer と string が必須の引数で、他の引数はすべて省略できます:

tokenize tokenizer
         string
         [normalizer=null]
         [flags=NONE]
         [mode=ADD]
         [token_filters=NONE]

  使い方

以下は簡単な使用例です。

実行例:

tokenize TokenBigram "Fulltext Search"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "Fu"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ul"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "ll"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "lt"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "te"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "ex"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "xt"
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "t "
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": " S"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "Se"
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": "ea"
#     },
#     {
#       "position": 11,
#       "force_prefix": false,
#       "value": "ar"
#     },
#     {
#       "position": 12,
#       "force_prefix": false,
#       "value": "rc"
#     },
#     {
#       "position": 13,
#       "force_prefix": false,
#       "value": "ch"
#     },
#     {
#       "position": 14,
#       "force_prefix": false,
#       "value": "h"
#     }
#   ]
# ]

この例では必須のパラメーターだけ使っています。 tokenizer には TokenBigram を、 string には "Fulltext Search" を指定しています。この例は TokenBigram トークナイザーで "Fulltext Search" をトークナイズしたトークンを返します。この例では "Fulltext Search" を正規化していません。

  引数

このセクションではすべての引数について説明します。引数はカテゴリわけしています。

  必須引数

必須引数は二つあります。 tokenizer と string です。

  tokenizer

トークナイザー名を指定します。 tokenize コマンドは tokenizer で指定された名前のトークナイザーを使います。

組み込みのトークナイザーについては /reference/tokenizers を参照してください。

以下は組み込みの TokenTrigram トークナイザーを使う例です。

実行例:

tokenize TokenTrigram "Fulltext Search"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "Ful"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ull"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "llt"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "lte"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "tex"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "ext"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "xt "
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "t S"
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": " Se"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "Sea"
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": "ear"
#     },
#     {
#       "position": 11,
#       "force_prefix": false,
#       "value": "arc"
#     },
#     {
#       "position": 12,
#       "force_prefix": false,
#       "value": "rch"
#     },
#     {
#       "position": 13,
#       "force_prefix": false,
#       "value": "ch"
#     },
#     {
#       "position": 14,
#       "force_prefix": false,
#       "value": "h"
#     }
#   ]
# ]

他のトークナイザーを使いたい場合は、 register コマンドでトークナイザープラグインを登録する必要があります。例えば、 KyTea ベースのトークナイザーを tokenizers/kytea を登録することで使えます。

  string

トークナイズしたい文字列を指定します。

string の中に文字列を含める場合は、シングルクォート（ ' ）またはダブルクォート（ " ）で string をクォートする必要があります。

string の中で空白を使う例です。

実行例:

tokenize TokenBigram "Groonga is a fast fulltext earch engine!"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "Gr"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ro"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "oo"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "on"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "ng"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "ga"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "a "
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": " i"
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": "is"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "s "
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": " a"
#     },
#     {
#       "position": 11,
#       "force_prefix": false,
#       "value": "a "
#     },
#     {
#       "position": 12,
#       "force_prefix": false,
#       "value": " f"
#     },
#     {
#       "position": 13,
#       "force_prefix": false,
#       "value": "fa"
#     },
#     {
#       "position": 14,
#       "force_prefix": false,
#       "value": "as"
#     },
#     {
#       "position": 15,
#       "force_prefix": false,
#       "value": "st"
#     },
#     {
#       "position": 16,
#       "force_prefix": false,
#       "value": "t "
#     },
#     {
#       "position": 17,
#       "force_prefix": false,
#       "value": " f"
#     },
#     {
#       "position": 18,
#       "force_prefix": false,
#       "value": "fu"
#     },
#     {
#       "position": 19,
#       "force_prefix": false,
#       "value": "ul"
#     },
#     {
#       "position": 20,
#       "force_prefix": false,
#       "value": "ll"
#     },
#     {
#       "position": 21,
#       "force_prefix": false,
#       "value": "lt"
#     },
#     {
#       "position": 22,
#       "force_prefix": false,
#       "value": "te"
#     },
#     {
#       "position": 23,
#       "force_prefix": false,
#       "value": "ex"
#     },
#     {
#       "position": 24,
#       "force_prefix": false,
#       "value": "xt"
#     },
#     {
#       "position": 25,
#       "force_prefix": false,
#       "value": "t "
#     },
#     {
#       "position": 26,
#       "force_prefix": false,
#       "value": " e"
#     },
#     {
#       "position": 27,
#       "force_prefix": false,
#       "value": "ea"
#     },
#     {
#       "position": 28,
#       "force_prefix": false,
#       "value": "ar"
#     },
#     {
#       "position": 29,
#       "force_prefix": false,
#       "value": "rc"
#     },
#     {
#       "position": 30,
#       "force_prefix": false,
#       "value": "ch"
#     },
#     {
#       "position": 31,
#       "force_prefix": false,
#       "value": "h "
#     },
#     {
#       "position": 32,
#       "force_prefix": false,
#       "value": " e"
#     },
#     {
#       "position": 33,
#       "force_prefix": false,
#       "value": "en"
#     },
#     {
#       "position": 34,
#       "force_prefix": false,
#       "value": "ng"
#     },
#     {
#       "position": 35,
#       "force_prefix": false,
#       "value": "gi"
#     },
#     {
#       "position": 36,
#       "force_prefix": false,
#       "value": "in"
#     },
#     {
#       "position": 37,
#       "force_prefix": false,
#       "value": "ne"
#     },
#     {
#       "position": 38,
#       "force_prefix": false,
#       "value": "e!"
#     },
#     {
#       "position": 39,
#       "force_prefix": false,
#       "value": "!"
#     }
#   ]
# ]

  省略可能引数

いくつか省略可能な引数があります。

  normalizer

ノーマライザー名を指定します。 tokenize コマンドは normalizer という名前のノーマライザーを使います。ノーマライザーは TokenBigrma など、N-gram関連のトークナイザーにとってとても重要です。

ノーマライザーはノーマライズ中にそれぞれの文字の種類を検出します。N-gram系のトークナイザーはトークナイズ中に文字の種類を利用します。

以下はノーマライザーを使わない例です。

実行例:

tokenize TokenBigram "Fulltext Search"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "Fu"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ul"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "ll"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "lt"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "te"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "ex"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "xt"
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "t "
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": " S"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "Se"
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": "ea"
#     },
#     {
#       "position": 11,
#       "force_prefix": false,
#       "value": "ar"
#     },
#     {
#       "position": 12,
#       "force_prefix": false,
#       "value": "rc"
#     },
#     {
#       "position": 13,
#       "force_prefix": false,
#       "value": "ch"
#     },
#     {
#       "position": 14,
#       "force_prefix": false,
#       "value": "h"
#     }
#   ]
# ]

すべてのアルファベットが2文字ごとトークナイズされています。例えば、 Fu で1つのトークンになっています。

以下はノーマライザーを使う例です。

実行例:

tokenize TokenBigram "Fulltext Search" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "fulltext"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "search"
#     }
#   ]
# ]

連続するアルファベットが1つのトークンにトークナイズされています。例えば、 fulltext で1つのトークンになっています。

ノーマライザーを使いながら2文字でトークナイズしたい場合は TokenBigramSplitSymbolAlpha を使って下さい。

実行例:

tokenize TokenBigramSplitSymbolAlpha "Fulltext Search" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "fu"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ul"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "ll"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "lt"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "te"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "ex"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "xt"
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "t"
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": "se"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "ea"
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": "ar"
#     },
#     {
#       "position": 11,
#       "force_prefix": false,
#       "value": "rc"
#     },
#     {
#       "position": 12,
#       "force_prefix": false,
#       "value": "ch"
#     },
#     {
#       "position": 13,
#       "force_prefix": false,
#       "value": "h"
#     }
#   ]
# ]

すべてのアルファベットが2文字ごとにトークナイズされています。そして、すべての文字が小文字にノーマライズされています。例えば、 fu で1つのトークンになっています。

  flags

トークナイズ処理をカスタマイズするオプションを指定します。「 | 」で区切って複数のオプションを指定することができます。例えば、 NONE|ENABLE_TOKENIZED_DELIMITER というように指定できます。

指定可能なフラグは以下の通りです。
フラグ | 説明
NONE | 無視されます。
ENABLE_TOKENIZED_DELIMITER | トークナイズ済み区切り文字を有効にします。トークナイズ済み区切り文字の詳細は /reference/tokenizers を参照してください。

以下は ENABLE_TOKENIZED_DELIMITER を使った例です。

実行例:

tokenize TokenDelimit "Fulltext Seacrch" NormalizerAuto ENABLE_TOKENIZED_DELIMITER
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "full"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "text sea"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "crch"
#     }
#   ]
# ]

TokenDelimit トークナイザーはトークナイズ済み区切り文字をサポートしているトークナイザーの1つです。 ENABLE_TOKENIZED_DELIMITER でトークナイズ済み区切り文字を有効に出来ます。トークナイズ済み区切り文字はトークンの区切りを表す特別な文字です。この文字は U+FFFE です。この文字コードはどの文字にも割り当てられていません。つまり、通常の文字列にはこの文字は現れません。よって、トークンの区切りを表すという目的には適切な文字です。 ENABLE_TOKENIZED_DELIMITER が有効のときは、対象文字列はすでにトークナイズ済みであると扱われます。トークナイザーは単にトークナイズ済み区切り文字で区切ってトークナイズします。

  mode

トークナイズモードを指定します。 ADD を指定すると、ドキュメント追加時と同じルールでトークナイズされます。 GET を指定すると、ドキュメント検索時と同じルールでトークナイズされます。省略された場合、 ADD モードでトークナイズされます。

デフォルトのモードは ADD です。

以下は ADD モードの例です。

実行例:

tokenize TokenBigram "Fulltext Search" --mode ADD
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "Fu"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ul"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "ll"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "lt"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "te"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "ex"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "xt"
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "t "
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": " S"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "Se"
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": "ea"
#     },
#     {
#       "position": 11,
#       "force_prefix": false,
#       "value": "ar"
#     },
#     {
#       "position": 12,
#       "force_prefix": false,
#       "value": "rc"
#     },
#     {
#       "position": 13,
#       "force_prefix": false,
#       "value": "ch"
#     },
#     {
#       "position": 14,
#       "force_prefix": false,
#       "value": "h"
#     }
#   ]
# ]

最後のアルファベットは1文字でトークナイズされています。

以下は GET モードの例です。

実行例:

tokenize TokenBigram "Fulltext Search" --mode GET
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "Fu"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ul"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "ll"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "lt"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "te"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "ex"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "xt"
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "t "
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": " S"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "Se"
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": "ea"
#     },
#     {
#       "position": 11,
#       "force_prefix": false,
#       "value": "ar"
#     },
#     {
#       "position": 12,
#       "force_prefix": false,
#       "value": "rc"
#     },
#     {
#       "position": 13,
#       "force_prefix": false,
#       "value": "ch"
#     }
#   ]
# ]

最後のアルファベットは2文字でトークナイズされています。

  token_filters

トークンフィルターを指定します。 tokenize コマンドは token_filters という名前のトークンフィルターを使います。

トークンフィルターについては /reference/token_filters を参照してください。

  戻り値

tokenize コマンドはトークナイズしたトークンをすべて返します。各トークンはトークン自身の文字列情報以外にいくつかの属性を持ちます。属性は今後増えていく可能性があります:

[HEADER, tokens]

HEADER HEADER については /reference/command/output_format を参照してください。

tokens tokens はトークンの配列です。トークンは以下の属性を持ったオブジェクトです。
名前 | 説明
value | トークン自身
position | N番目のトークン。

  参考

•   /reference/tokenizers

  tokenizer_list

  概要

tokenizer_list コマンドはデータベースに登録されているトークナイザーの一覧を返します。

  構文

このコマンドに引数はありません:

tokenizer_list

  使い方

以下は簡単な使用例です。

実行例:

tokenizer_list
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "name": "TokenMecab"
#     },
#     {
#       "name": "TokenDelimit"
#     },
#     {
#       "name": "TokenUnigram"
#     },
#     {
#       "name": "TokenBigram"
#     },
#     {
#       "name": "TokenTrigram"
#     },
#     {
#       "name": "TokenBigramSplitSymbol"
#     },
#     {
#       "name": "TokenBigramSplitSymbolAlpha"
#     },
#     {
#       "name": "TokenBigramSplitSymbolAlphaDigit"
#     },
#     {
#       "name": "TokenBigramIgnoreBlank"
#     },
#     {
#       "name": "TokenBigramIgnoreBlankSplitSymbol"
#     },
#     {
#       "name": "TokenBigramIgnoreBlankSplitSymbolAlpha"
#     },
#     {
#       "name": "TokenBigramIgnoreBlankSplitSymbolAlphaDigit"
#     },
#     {
#       "name": "TokenDelimitNull"
#     },
#     {
#       "name": "TokenRegexp"
#     }
#   ]
# ]

データベースに登録されているトークナイザーの一覧を返します。

  戻り値

tokenizer_list コマンドはトークナイザーの一覧を返します。各トークナイザーは属性を持っています。例えば名前です。将来、属性は増えるかもしれません。:

[HEADER, tokenizers]

HEADER HEADER については /reference/command/output_format を参照してください。

tokenizers tokenizers はトークナイザーの配列です。トークナイザーは次の属性を持つオブジェクトです。
名前 | 説明
name | トークナイザー名。

  参考

•   /reference/tokenizers

•   /reference/commands/tokenize

  truncate

  概要

truncate コマンドは指定したテーブルのレコードをすべて削除します。カラムを指定した場合はカラムの値をすべて削除します。

  構文

このコマンドの引数は1つで必須です:

truncate target_name

バージョン 4.0.9 で追加: target_name parameter can be used since 4.0.9. You need to use table parameter for 4.0.8 or earlier.

For backward compatibility, truncate command accepts table parameter. But it should not be used for newly written code.

  使い方

以下はテーブルに対して truncate コマンドを実行する簡単な使用例です。

実行例:

table_create Users TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users score COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "Alice",  "score": 2},
{"_key": "Bob",    "score": 0},
{"_key": "Carlos", "score": -1}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "score",
#           "Int32"
#         ]
#       ],
#       [
#         1,
#         "Alice",
#         2
#       ],
#       [
#         2,
#         "Bob",
#         0
#       ],
#       [
#         3,
#         "Carlos",
#         -1
#       ]
#     ]
#   ]
# ]
truncate Users
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         0
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "score",
#           "Int32"
#         ]
#       ]
#     ]
#   ]
# ]

以下はカラムに対して truncate コマンドを実行する簡単な使用例です。

実行例:

table_create Users TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users score COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "Alice",  "score": 2},
{"_key": "Bob",    "score": 0},
{"_key": "Carlos", "score": -1}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "score",
#           "Int32"
#         ]
#       ],
#       [
#         1,
#         "Alice",
#         2
#       ],
#       [
#         2,
#         "Bob",
#         0
#       ],
#       [
#         3,
#         "Carlos",
#         -1
#       ]
#     ]
#   ]
# ]
truncate Users.score
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "score",
#           "Int32"
#         ]
#       ],
#       [
#         1,
#         "Alice",
#         0
#       ],
#       [
#         2,
#         "Bob",
#         0
#       ],
#       [
#         3,
#         "Carlos",
#         0
#       ]
#     ]
#   ]
# ]

  引数

このセクションでは truncate の引数について説明します。

  必須引数

target_name だけが必須の引数です。

  target_name

テーブル名またはカラム名を指定します。

  戻り値

truncate コマンドは全削除が成功したかどうかを返します。:

[HEADER, SUCCEEDED_OR_NOT]

HEADER HEADER については /reference/command/output_format を参照してください。

SUCCEEDED_OR_NOT コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

  データ型

  名前

Groonga データ型

  説明

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

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

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

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

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

  組込型

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

  Bool

ブーリアン型やブール型などと呼ばれる型であり、真偽値を表します。取り得る値はtrueとfalseです。（デフォルト値: false）

/reference/commands/load コマンドで値を格納するときは、false、0、空文字列のいずれかを指定するとfalseになり、それ以外を指定するとtrueになります。

  Int8

8bit符号付き整数であり、-128以上127以下の整数を表します。（デフォルト値: 0）

  UInt8

8bit符号なし整数であり、0以上255以下の整数を表します。（デフォルト値: 0）

  Int16

16bit符号付き整数であり、-32,768以上32,767以下の整数を表します。（デフォルト値: 0）

  UInt16

16bit符号なし整数であり、0以上65,535以下の整数を表します。（デフォルト値: 0）

  Int32

32bit符号付き整数であり、-2,147,483,648以上2,147,483,647以下の整数を表します。（デフォルト値: 0）

  UInt32

32bit符号なし整数であり、0以上4,294,967,295以下の整数を表します。（デフォルト値: 0）

  Int64

64bit符号付き整数であり、-9,223,372,036,854,775,808以上9,223,372,036,854,775,807以下の整数を表します。（デフォルト値: 0）

  UInt64

64bit符号なし整数であり、0以上18,446,744,073,709,551,615以下の整数を表します。（デフォルト値: 0）

  Float

IEEE 754形式の倍精度浮動小数点数であり、実数を表します。（デフォルト値: 0.0）

IEEE 754形式の詳細については、 IEEE 754 - Wikipedia や IEEE 754: Standard for Binary Floating-Point を参照してください。

  Time

日時を表す型であり、1970年1月1日0時0分0秒からの経過時間を、マイクロ秒単位で64bit符号付き整数により表現します。（デフォルト値: 0）

/reference/commands/load コマンドで値を格納するときは、1970年1月1日0時0分0秒からの経過秒数を指定します。秒単位より詳細な日時を指定するには、小数を使います。

  ShortText

4,095バイト以下の文字列を表します。（デフォルト値: ""）

  Text

65,535バイト以下の文字列を表します。（デフォルト値: ""）

  LongText

2,147,483,647バイト以下の文字列を表します。（デフォルト値: ""）

  TokyoGeoPoint

旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）

度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。

/reference/commands/load コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。

測地系の詳細については、 測地系 - Wikipedia を参照してください。

  WGS84GeoPoint

世界測地系（World Geodetic System, WGS 84）による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）

度分秒形式からミリ秒形式への変換方法や /reference/commands/load コマンドにおける指定方法はTokyoGeoPointと同じです。

  型に関する制限事項

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

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

  ベクターとして格納できない型

Groongaのカラムは、ある型のベクターを保存することができます。しかし、ShortText, Text, LongTextの３つの型についてはベクターとして保存したり出力したりすることはできますが、検索条件やドリルダウン条件に指定することができません。

テーブル型は、ベクターとして格納することができます。よって、ShortTextのベクターを検索条件やドリルダウン条件に使用したい場合には、主キーがShortText型のテーブルを別途作成し、そのテーブルを型として利用します。

  テーブル

  概要

GroongaのテーブルはIDとキーの対応を管理します。Groongaは4つの種類のテーブルを提供しています。 TABLE_NO_KEY 、 TABLE_HASH_KEY 、 TABLE_PAT_KEY 、 TABLE_DAT_KEY です。

TABLE_NO_KEY 以外のすべてのテーブルは高速なキー→ID検索とID→キー検索の両方をサポートしています。 TABLE_NO_KEY はキーをサポートしていません。 TABLE_NO_KEY はIDだけを管理します。そのため、 TABLE_NO_KEY はID検索もキー検索もサポートしていません。

  特徴

以下はGroongaにあるすべてのテーブルの特性表です。（この表の中では TABLE_ プレフィックスは省略しています。）
 | NO_KEY | HASH_KEY | PAT_KEY | DAT_KEY
データ構造 | 配列 | ハッシュテーブル | パトリシアトライ | ダブル配列トライ
IDサポート | o | o | o | o
キーサポート | x | o | o | o
バリューサポート | o | o | o | x
キー→ID検索速度 o: 速い x: 遅い | - | oo | x | o
更新速度 o: 速い x: 遅い | ooo | o | o | x
サイズ o: 小さい x: 大きい | ooo | o | oo | x
キー変更 | - | x | x | o
共通接頭辞検索 | - | x | o | o
前方一致検索 | - | x | o | o
範囲検索 | - | x | o | o

  TABLE_NO_KEY

TABLE_NO_KEY はとても高速でとても小さいのですが、キーをサポートしていません。キーをサポートしていないテーブルは TABLE_NO_KEY だけです。

TABLE_NO_KEY を全文検索用の語彙表として使うことはできません。これは、語彙表はトークンをキーとして保存する必要があるからです。 TABLE_NO_KEY はログのようにキーのないレコードを管理するテーブルとして有用です。

  TABLE_HASH_KEY

TABLE_HASH_KEY は高速ですが、共通接頭辞検索や前方一致検索といった高度な検索機能をサポートしていません。

TABLE_HASH_KEY はタグ検索のように完全一致検索用のインデックスとして有用です。

  TABLE_PAT_KEY

TABLE_PAT_KEY は、小さく、高度な検索機能もサポートしています。

TABLE_PAT_KEY は全文検索用の語彙表としても有用ですし、範囲検索用のインデックスとしても有用です。

  TABLE_DAT_KEY

TABLE_DAT_KEY は高速でキーの更新もサポートしていますが、サイズが大きいです。大量のレコードを保存する用途には向いていません。キーの更新をサポートしているテーブルは TABLE_DAT_KEY だけです。

TABLE_DAT_KEY はGroongaのデータベース内で使われています。Groongaのデータベースは ShortText や TokenBigram 、テーブル名などオブジェクトの名前をオブジェクトのIDに変換する必要があります。さらに、Groongaのデータベースはオブジェクト名の変更もサポートする必要があります。これらの機能は TABLE_DAT_KEY で実現されています。オブジェクト数は小さいので TABLE_DAT_KEY のサイズが大きいというデメリットは無視できます。

  レコードID

レコードIDは自動的に割り当てられます。明示的に割り当てるレコードIDを指定することはできません。

削除されたレコードのレコードIDは再利用される可能性があります。

妥当なレコードIDの範囲は1から268435455までです。（1も268435455も妥当なIDです。）

  永続テーブルと一時テーブル

テーブルは永続テーブルまたは一時テーブルです。

  永続テーブル

永続テーブルは名前がついていてデータベースに登録されています。永続テーブルの中のレコードはテーブルやデータベースを閉じた後でも消えません。

永続テーブルは /reference/commands/table_create コマンドで作成します。

  一時テーブル

一時テーブルには名前がありません。一時テーブルのレコードはテーブルを閉じると削除されます。一時テーブルは検索結果やソート結果、グループ（ドリルダウン）結果などを格納するために使われています。検索結果とグループ結果には TABLE_HASH_KEY が使われています。ソート結果には TABLE_NO_KEY が使われています。

  制限

最大レコード数は268435455です。1つのテーブルに268435456以上のレコードを追加できません。

最大キーサイズは4096バイトです。4097バイト以上の大きいキーは使うことができません。4097バイト以上の大きなサイズのデータはキーではなくカラムに保存してください。 Text と LargeText 型は4097バイト以上の大きさのサイズのデータをサポートしています。

キーサイズの合計の最大値は4GiBです。キーサイズの合計が4GiBを超える場合は、テーブルを分割したり、データベースを分割したり（シャーディング）、それぞれのキーのサイズを減らしてください。

  参考

•   /reference/commands/table_create

  カラム

カラムはデータストアオブジェクトまたは高速な検索のための転置索引オブジェクトです。

カラムは必ず1つのテーブルに属します。テーブルは0個以上のカラムを持ちます。

データストアカラムもインデックスカラムもどちらも型を持ちます。データストアカラムの型は値域を指定します。言い換えると、データストアカラムの型は「値の型」です。インデックスカラムの型はインデックス対象のドキュメント集合を指定します。Groongaではテーブルがドキュメント集合になります。よって、インデックスカラムの型はテーブルにしなければいけません。

以下がデータストアカラムです。

  スカラーカラム

  概要

TODO

  使い方

TODO

  ベクターカラム

  概要

ベクターカラムはデータストアオブジェクトです。ベクターカラムは0個以上のスカラー値を保存できます。ざっくり言うと、スカラー値とは数値や文字列といった1つの値のことです。スカラー値の詳細は scalar を参照してください。

ベクターカラムのユースケースの1つはタグの保存です。ベクターカラムを使うとタグの値を複数保存できます。

スカラーカラムと同じように、ベクターカラムもインデックスを使って検索できます。各要素に重みをつけることもできます。1以上の重みがついた要素がマッチすると、重みがついていない場合よりも大きなスコアがつきます。これはベクターカラム特有の機能です。重みも保存できるベクターカラムのことは重み付きベクターカラムと呼びます。

各要素がテキストなら、各要素に対して全文検索することもできます。しかし、重みを使った場合は検索スコアが高くなりすぎることに注意してください。重み付きベクターカラムに対して全文検索をするときは注意してください。

  使い方

ベクターカラムには3種類あります。

•   ノーマルベクターカラム

•   参照型ベクターカラム

•   重み付きベクターカラム

    このセクションではこれらの種類の使い方について説明します。

  ノーマルベクターカラム

ノーマルベクターカラムは0個以上のスカラーデータを保存します。スカラーデータとは、例えば、数値や文字列です。

ノーマルベクターカラムは同じ型の要素だけを保存できます。型を混ぜることはできません。例えば、同じノーマルベクターカラムに数値と文字列を保存できません。

ノーマルベクターカラムは、1つのレコードが、1つのキーに対して複数の値を持っているときに便利です。タグは一番よくあるユースケースです。

  作り方

ノーマルベクターカラムを作るためには /reference/commands/column_create コマンドを使います。ポイントは COLUMN_VECTOR フラグです。

実行例:

table_create Bookmarks TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Bookmarks tags COLUMN_VECTOR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

1つのブックマークに0個以上のタグを設定できます。

  ロード方法

JSONの配列構文で指定してベクターデータをロードします:

[ELEMENT1, ELEMENT2, ELEMENT3, ...]

以下のデータをロードしましょう。
_key | tags
http://groonga.org/ | ["groonga"]
http://mroonga.org/ | ["mroonga", "mysql", "groonga"]
http://ranguba.org/ | ["ruby", "groonga"]

以下がデータをロードするコマンドです。

実行例:

load --table Bookmarks
[
{"_key": "http://groonga.org/", "tags": ["groonga"]},
{"_key": "http://mroonga.org/", "tags": ["mroonga", "mysql", "groonga"]},
{"_key": "http://ranguba.org/", "tags": ["ruby", "groonga"]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

ロードしたデータはJSONの配列構文で出力されます。

実行例:

select Bookmarks
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "http://groonga.org/",
#         [
#           "groonga"
#         ]
#       ],
#       [
#         2,
#         "http://mroonga.org/",
#         [
#           "mroonga",
#           "mysql",
#           "groonga"
#         ]
#       ],
#       [
#         3,
#         "http://ranguba.org/",
#         [
#           "ruby",
#           "groonga"
#         ]
#       ]
#     ]
#   ]
# ]

  検索方法

ノーマルベクターカラムを検索するにはインデックスを作る必要があります。

実行例:

table_create Tags TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tags bookmark_index COLUMN_INDEX Bookmarks tags
# [[0, 1337566253.89858, 0.000355720520019531], true]

ベクターカラム固有の方法はありません。スカラーカラムにインデックスを作る方法と同じです。

全文検索と同じ構文で tags 内の要素を検索できます。

select-match-columns と select-query を使った場合:

実行例:

select Bookmarks --match_columns tags --query mysql --output_columns _key,tags,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "http://mroonga.org/",
#         [
#           "mroonga",
#           "mysql",
#           "groonga"
#         ],
#         1
#       ]
#     ]
#   ]
# ]

select-match-columns の中で重みを使うこともできます。

実行例:

select Bookmarks --match_columns 'tags * 3' --query mysql --output_columns _key,tags,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "http://mroonga.org/",
#         [
#           "mroonga",
#           "mysql",
#           "groonga"
#         ],
#         3
#       ]
#     ]
#   ]
# ]

select-filter を使った場合:

実行例:

select Bookmarks --filter 'tags @ "msyql"' --output_columns _key,tags,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         0
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ]
#     ]
#   ]
# ]

  参照型ベクターカラム

TODO

Reference vector column is space-efficient if there are many same value elements. Reference vector column keeps reference record IDs not value itself. Record ID is smaller than value itself.

  作り方

TODO

  ロード方法

TODO

  検索方法

TODO

  重み付きベクターカラム

重み付きベクターカラムはノーマルベクターカラムに似ています。複数の要素を保存できます。さらに、要素の重みも保存できます。重みとはその要素の重要度です。

重みは正の整数です。デフォルトの重みは 0 です。これは重みがないという意味になります。

重みが1以上なら、検索スコアーに重みが加算されます。重みが 0 なら検索スコアーは 1 です。重みが 10 なら検索スコアーは 11 （ = 1 + 10 ）です。

重み付きベクターカラムは検索スコアーのチューニングに便利です。 select-adjuster も参照してください。特定のレコードの検索スコアーを増やすことができます。

  制限

今のところいくつか制限があります。将来的には解消される予定です。

以下が制限です。

•   ロード時に要素の値を文字列での表現で指定しなければいけません。例えば、数値の29を指定するために、 29 を使うことはできません。 "29" と文字列で表記する必要があります。

  作り方

重み付きベクターカラムを作るには /reference/commands/column_create を使います。ポイントは COLUMN_VECTOR|WITH_WEIGHT フラグです。

実行例:

table_create Bookmarks TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Bookmarks tags COLUMN_VECTOR|WITH_WEIGHT ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

WITH_WEIGHT フラグを指定しないと、ただのノーマルベクターカラムになります。

1つのブックマークに重み付きで0個以上のタグを設定できます。

  ロード方法

JSONのオブジェクト構文でベクターデータをロードします:

{"ELEMENT1": WEIGHT1, "ELEMENT2": WEIGHT2, "ELEMENT3": WEIGHT3, ...}

以下のデータをロードしましょう。
_key | tags
http://groonga.org/ | {"groonga": 100}
http://mroonga.org/ | {"mroonga": 100, "mysql": 50, "groonga": 10}
http://ranguba.org/ | {"ruby": 100, "groonga": 50}

以下がデータをロードするコマンドです。

実行例:

load --table Bookmarks
[
{"_key": "http://groonga.org/",
 "tags": {"groonga": 100}},
{"_key": "http://mroonga.org/",
 "tags": {"mroonga": 100,
          "mysql":   50,
          "groonga": 10}},
{"_key": "http://ranguba.org/",
 "tags": {"ruby": 100,
          "groonga": 50}}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

ロードしたデータはJSONのオブジェクト構文で出力されます。

実行例:

select Bookmarks
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "http://groonga.org/",
#         {
#           "groonga": 100
#         }
#       ],
#       [
#         2,
#         "http://mroonga.org/",
#         {
#           "mroonga": 100,
#           "groonga": 10,
#           "mysql": 50
#         }
#       ],
#       [
#         3,
#         "http://ranguba.org/",
#         {
#           "ruby": 100,
#           "groonga": 50
#         }
#       ]
#     ]
#   ]
# ]

  検索方法

重み付きベクターを検索するためにはインデックスを作る必要があります。 column_create に WITH_WEIGHT フラグを指定することを忘れないでください。

実行例:

table_create Tags TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tags bookmark_index COLUMN_INDEX|WITH_WEIGHT Bookmarks tags
# [[0, 1337566253.89858, 0.000355720520019531], true]

WITH_WEIGHT 以外は重み付きベクターカラムに特有の方法はありません。スカラーカラムにインデックスを作る方法と同じです。

全文検索と同じ構文で tags 内の要素を検索できます。

select-match-columns と select-query を使った場合:

実行例:

select Bookmarks --match_columns tags --query groonga --output_columns _key,tags,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "http://groonga.org/",
#         {
#           "groonga": 100
#         },
#         101
#       ],
#       [
#         "http://mroonga.org/",
#         {
#           "mroonga": 100,
#           "groonga": 10,
#           "mysql": 50
#         },
#         11
#       ],
#       [
#         "http://ranguba.org/",
#         {
#           "ruby": 100,
#           "groonga": 50
#         },
#         51
#       ]
#     ]
#   ]
# ]

select-match-columns の重みと一緒に使うこともできます。スコアーは (1 + 重み付きベクターの重み) * match_columnsの重み 。

実行例:

select Bookmarks --match_columns 'tags * 3' --query groonga --output_columns _key,tags,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "http://groonga.org/",
#         {
#           "groonga": 100
#         },
#         303
#       ],
#       [
#         "http://mroonga.org/",
#         {
#           "mroonga": 100,
#           "groonga": 10,
#           "mysql": 50
#         },
#         33
#       ],
#       [
#         "http://ranguba.org/",
#         {
#           "ruby": 100,
#           "groonga": 50
#         },
#         153
#       ]
#     ]
#   ]
# ]

select-filter を使った場合:

実行例:

select Bookmarks --filter 'tags @ "groonga"' --output_columns _key,tags,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "http://groonga.org/",
#         {
#           "groonga": 100
#         },
#         101
#       ],
#       [
#         "http://mroonga.org/",
#         {
#           "mroonga": 100,
#           "groonga": 10,
#           "mysql": 50
#         },
#         11
#       ],
#       [
#         "http://ranguba.org/",
#         {
#           "ruby": 100,
#           "groonga": 50
#         },
#         51
#       ]
#     ]
#   ]
# ]

  重みだけを適用する方法

マッチしたレコード集合を変更せずに、重み付きベクターカラムの重みの分だけ検索スコアーを増やすことができます。

この用途には select-adjuster を使います。

実行例:

select Bookmarks \
  --filter true \
  --adjuster 'tags @ "mysql" * 10 + tags @ "groonga" * 5' \
  --output_columns _key,tags,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "http://groonga.org/",
#         {
#           "groonga": 100
#         },
#         506
#       ],
#       [
#         "http://mroonga.org/",
#         {
#           "mroonga": 100,
#           "groonga": 10,
#           "mysql": 50
#         },
#         566
#       ],
#       [
#         "http://ranguba.org/",
#         {
#           "ruby": 100,
#           "groonga": 50
#         },
#         256
#       ]
#     ]
#   ]
# ]

この select コマンドは --filter true を使っています。そのため、すべてのレコードがマッチし、スコアーは1になります。それから、 --adjuster を適用します。アジャスターは以下のことをします。

•   tags @ "mysql" * 10 は "mysql" タグを含むレコードのスコアーを (1 + 重み) * 10 増やします。

•   tags @ "groonga" * 5 は "groonga" タグを含むレコードのスコアーを (1 + 重み) * 5 増やします。

    例えば、 "http://mroonga.org/" レコードは "mysql" タグと "groonga" タグを両方持っています。そのため、スコアーは 565 （ = ((1 + 50) * 10) + ((1 + 10) * 5) = (51 * 10) + (11 * 5) = 510 + 55 ）増えます。 --adjuster を適用する前は、--filter true によって検索スコアーは1になっています。そのため、 "http://mroonga.org/" レコードの最終的な検索スコアーは 566 （ = 1 + 565 ）になります。

  擬似カラム

  名前

疑似カラム

  説明

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

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

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

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

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

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

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

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

以下がインデックスカラムです。

  インデックスカラム

  概要

TODO

  使い方

TODO

  ノーマライザー

  概要

Groongaには正規化をするノーマライザーモジュールがあります。これはテキストをトークナイズするときとテーブルのキーを保存するときに使われます。例えば、正規化をした後は A と a は同じ文字として扱われます。

ノーマライザーモジュールはプラグインとして追加できます。ノーマライザープラグインをGroongaに追加することでテキストの正規化方法をカスタマイズできます。

ノーマライザーモジュールはテーブルに関連付いています。テーブルは0個か1個のノーマライザーモジュールを持つことができます。 /reference/commands/table_create の table-create-normalizer オプションでテーブルにノーマライザーオプションを関連付けることができます。

以下は NormalizerAuto ノーマライザーモジュールを使う table_create の例です。

実行例:

table_create Dictionary TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]

注釈: Groonga 2.0.9以前には table_create に --normalizer オプションはありません。代わりに KEY_NORMALIZE フラグを使っていました。

Groonga 2.1.0以降で古いデータベースを開くことができます。ここでいう古いデータベースとはGroonga 2.0.9以前で作ったデータベースということです。しかし、一度新しいGroongaで開いたデータベースを2.0.9以前のGroongaで開くことはできません。一度 Groonga 2.1.0以降のGroongaでデータベースを開くと、 KEY_NORMALIZE フラグ情報がノーマライザー情報に変換されます。そのため、2.0.9以前のGroongaは、一度Groonga 2.1.0以降で開いたデータベース内から KEY_NROMALIZE フラグの情報を見つけることができません。

ノーマライザーモジュールを持っているテーブルのキーは正規化されます。

実行例:

load --table Dictionary
[
{"_key": "Apple"},
{"_key": "black"},
{"_key": "COLOR"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select Dictionary
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "apple"
#       ],
#       [
#         2,
#         "black"
#       ],
#       [
#         3,
#         "color"
#       ]
#     ]
#   ]
# ]

NormalizerAuto ノーマライザーはテキストを小文字に正規化します。例えば、 "Apple" は "apple" に正規化され、 "black" は "blank" に正規化され、 "COLOR" は "color" に正規化されます。

テーブルが全文検索用の語彙表の場合、トークナイズされたトークンは正規化されます。なぜなら、トークンはテーブルのキーとして保存されるからです。テーブルのキーは前述のように正規化されます。

  組み込みノーマライザー

以下は組み込みのノーマライザーのリストです。

•   NormalizerAuto

•   NormalizerNFKC51

  NormalizerAuto

通常は NormalizerAuto ノーマライザーを使うべきです。 NormalizerAuto はGroonga 2.0.9以前で使っていたノーマライザーと同じものです。2.0.9以前のGroongaの table_create の KEY_NORMALIZE フラグは、2.1.0以降のGroongaの table_create の --normalizer NormalizerAuto と同じです。

NormalizerAuto はすべてのエンコーディングに対応しています。UTF-8でエンコードされたテキストにはUnicodeのNFKC（Normalization Form Compatibility Composition）を使います。他のエンコーディング用にはエンコーディング毎に独自の正規化をします。これらの独自の正規化の結果はNFKCでの結果と似たものになります。

例えば、半角カタカナ（例えば「ｶ」: U+FF76 HALFWIDTH KATAKANA LETTER KA） + 半角カタカナの濁点（「ﾞ」: U+FF9E HALFWIDTH KATAKANA VOICED SOUND MARK）は濁点付きの全角カタカナ（「ガ」: U+30AC KATAKANA LETTER GA）に正規化されます。前者は2文字ですが、後者は1文字です。

以下は NormalizerAuto ノーマライザーを使う例です。

実行例:

table_create NormalLexicon TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]

  NormalizerNFKC51

NormalizerNFKC51 はUnicode 5.1用のUnicode NFKC（Normalization Form Compatibility Composition）を使ってテキストを正規化します。UTF-8エンコーディングのみをサポートしています。

通常、 NormalizerNFKC51 を明示的に使う必要はありません。代わりに NormalizerAuto を使ってください。

以下は NormalizerNFKC51 ノーマライザーを使う例です。

実行例:

table_create NFKC51Lexicon TABLE_HASH_KEY ShortText --normalizer NormalizerNFKC51
# [[0, 1337566253.89858, 0.000355720520019531], true]

  追加のノーマライザー一覧

いくつか追加のノーマライザーがあります。

•   groonga-normalizer-mysql

  参考

•   /reference/commands/table_create

  トークナイザー

  概要

Groongaにはテキストをトークナイズするトークナイザーモージュールがあります。次のケースのときにトークナイザーを使います。

•   テキストのインデックスを構築するとき [画像] テキストのインデックスを構築するときにトークナイザーを使います。.UNINDENT

•   クエリーで検索するとき [画像] クエリーで検索するときにトークナイザーを使います。.UNINDENT

    全文検索ではトークナイザーは重要なモジュールです。トークナイザーを変えることで 適合率と再現率 のトレードオフを調整することができます。

    一般的に TokenBigram が適切なトークナイザーです。トークナイザーについてよく知らない場合は TokenBigram を使うことをオススメします。

    /reference/commands/tokenize コマンドと /reference/commands/table_tokenize コマンドを使うことでトークナイザーを試すことができます。 /reference/commands/tokenize コマンドを使って TokenBigram トークナイザーを試す例を以下に示します。

    実行例:

    tokenize TokenBigram "Hello World"
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "He"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "el"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "ll"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "lo"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "o "
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": " W"
    #     },
    #     {
    #       "position": 6,
    #       "force_prefix": false,
    #       "value": "Wo"
    #     },
    #     {
    #       "position": 7,
    #       "force_prefix": false,
    #       "value": "or"
    #     },
    #     {
    #       "position": 8,
    #       "force_prefix": false,
    #       "value": "rl"
    #     },
    #     {
    #       "position": 9,
    #       "force_prefix": false,
    #       "value": "ld"
    #     },
    #     {
    #       "position": 10,
    #       "force_prefix": false,
    #       "value": "d"
    #     }
    #   ]
    # ]

  「トークナイズ」とはなにか

「トークナイズ」はテキストから0個以上のトークンを抽出する処理です。「トークナイズ」する方法はいくつかあります。

例えば、バイグラムというトークナイズ方法では Hello World は次のトークンにトークナイズされます。

•   He

•   el

•   ll

•   lo

•   o_ （ _ は空白文字という意味）

•   _W （ _ は空白文字という意味）

•   Wo

•   or

•   rl

•   ld

    上記の例では、 Hello World から10個のトークンを抽出しました。

    例えば、空白区切りのトークナイズ方法では Hello World は次のトークンにトークナイズされます。

•   Hello

•   World

    上記の例では、Hello World から2つのトークンを抽出しました。

    トークンは検索時のキーとして使われます。使用したトークナイズ方法で抽出したトークンでしかインデックス化されたドキュメントを探すことはできません。例えば、トークナイズ方法としてバイグラムを使った場合は ll で Hello World を見つけることができます。しかし、空白区切りのトークナイズ方法を使ったときは ll で Hello World を見つけることはできません。なぜなら、空白区切りのトークナイズ方法は ll というトークンを抽出していないからです。空白区切りのトークナイズ方法は Hello というトークンと World というトークンしか抽出していません。

    一般的に、小さいトークンを生成するトークナイズ方法は再現率が高い代わりに適合率が低くなりがちです。一方、大きいトークンを生成するトークナイズ方法は適合率が高い代わりに再現率が低くなりがちです。

    例えば、バイグラムというトークナイズ方法では or で Hello World と A or B を検索できます。しかし、「論理和」を検索したい人にとっては Hello World は不要な結果です。これは、適合率が下がったということです。しかし、再現率は上がっています。

    空白区切りのトークナイズ方法を使った場合は or で A or B だけが見つかります。なぜなら、空白区切りのトークナイズ方法では World は World という1つのトークンだけにトークナイズされるからです。これは、「論理和」を探したい人にとっては適合率が挙がっています。しかし、 Hello World も or を含んでいるのに見つかっていないので再現率が下がっています。

  組み込みトークナイザー

以下は組み込みのトークナイザーのリストです。

•   TokenBigram

•   TokenBigramSplitSymbol

•   TokenBigramSplitSymbolAlpha

•   TokenBigramSplitSymbolAlphaDigit

•   TokenBigramIgnoreBlank

•   TokenBigramIgnoreBlankSplitSymbol

•   TokenBigramIgnoreBlankSplitAlpha

•   TokenBigramIgnoreBlankSplitAlphaDigit

•   TokenUnigram

•   TokenTrigram

•   TokenDelimit

•   TokenDelimitNull

•   TokenMecab

•   TokenRegexp

  TokenBigram

TokenBigram はバイグラムベースのトークナイザーです。多くのケースでは、このトークナイザーを使うことをオススメします。

バイグラムというトークナイズ方法は、隣り合った2つの文字を1つのトークンとしてテキストをトークナイズします。例えば、 Hello は次のトークンにトークナイズします。

•   He

•   el

•   ll

•   lo

    バイグラムというトークナイズ方法は再現性に優れています。なぜなら、2文字以上の文字のクエリーに対してはすべてのテキストを見つけることができるからです。

    一般的に、1文字のクエリーではすべてのテキストを見つけることはできません。なぜなら、1つの文字のトークンが存在しないからです。しかし、Groongaでは1文字のクエリーでもすべてのテキストを見つけることができます。なぜなら、Groongaは前方一致検索によりクエリーで指定した文字で始まるトークンをすべて見つけることができるからです。例えば、Groongaは l というクエリーから ll というトークンと lo というトークンを見つけることができます。

    バイグラムというトークナイズ方法は適合率はそれほど優れていません。なぜなら、単語の一部にクエリーが含まれていればすべてのテキストが見つかってしまうからです。例えば、 or で world が見つかります。これは非ASCIIを使う言語よりASCIIのみを使う言語で顕著です。以降の説明で触れる通り、 TokenBigram はこの問題を解決しています。

    TokenBigram の挙動は /reference/normalizers を使うかどうかで変わります。

    ノーマライザーを使っていない場合は TokenBigram は純粋なバイグラム（最後のトークンをのぞいてすべてのトークンを2文字にする）のトークナイズ方法を使います。

    実行例:

    tokenize TokenBigram "Hello World"
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "He"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "el"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "ll"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "lo"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "o "
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": " W"
    #     },
    #     {
    #       "position": 6,
    #       "force_prefix": false,
    #       "value": "Wo"
    #     },
    #     {
    #       "position": 7,
    #       "force_prefix": false,
    #       "value": "or"
    #     },
    #     {
    #       "position": 8,
    #       "force_prefix": false,
    #       "value": "rl"
    #     },
    #     {
    #       "position": 9,
    #       "force_prefix": false,
    #       "value": "ld"
    #     },
    #     {
    #       "position": 10,
    #       "force_prefix": false,
    #       "value": "d"
    #     }
    #   ]
    # ]

    ノーマライザーを使っている場合は TokenBigram はASCIIの文字には空白区切りのようなトークナイズ方法を使います。非ASCII文字にはバイグラムのトークナイズ方法を使います。

    もしかしたら、複数の方法が混ざったこの挙動はわかりにくいかもしれません。しかし、英語のテキスト（ASCII文字列のみ）や日本語テキスト（ASCII文字列と非ASCII文字列が混ざっている）ような多くのユースケースでは合理的な方法です。

    ASCII文字しか使わない多くの言語は単語の区切りに空白文字を使っています。このようなケースに空白区切りのトークナイズ方法は適切です。

    非ASCII文字を使う言語では単語の区切りに空白文字を使いません。このケースにはバイグラムなトークナイズ方法は適切です。

    複数の言語が混ざっている場合は、複数の方法を組み合わせたトークナイズ方法が適切です。

    ASCII文字にバイグラムなトークナイズ方法を使いたい場合は TokenBigramSplitSymbolAlpha のような TokenBigramSplitXXX というトークナイザーを参照してください。

    例を使いながら TokenBigram の挙動を確認しましょう。

    TokenBigram はASCII文字には1つ以上の空白文字をトークンの区切りとして使います。

    実行例:

    tokenize TokenBigram "Hello World" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "hello"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "world"
    #     }
    #   ]
    # ]

    TokenBigram はASCII文字には文字の種類が変わったところをトークンの区切りとします。文字の種類は次のどれかです。

•   アルファベット

•   数字

•   記号（たとえば ( 、 ) 、 ! など）

•   ひらがな

•   カタカナ

•   漢字

•   その他

    次の例は2つのトークン区切りを示しています。

•   100 （数字）と cents （アルファベット）の間のところ

•   cents （アルファベット）と !!! （記号）の間のところ

    実行例:

    tokenize TokenBigram "100cents!!!" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "100"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "cents"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "!!!"
    #     }
    #   ]
    # ]

    以下は TokenBigram が非ASCII文字にはトークナイズ方法としてバイグラムを使う例です。

    実行例:

    tokenize TokenBigram "日本語の勉強" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "日本"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "本語"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "語の"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "の勉"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "勉強"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "強"
    #     }
    #   ]
    # ]

  TokenBigramSplitSymbol

TokenBigramSplitSymbol は TokenBigram と似ています。違いは記号の扱いです。 TokenBigramSplitSymbol は記号のトークナイズ方法にバイグラムを使います。

実行例:

tokenize TokenBigramSplitSymbol "100cents!!!" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "100"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "cents"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "!!"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "!!"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "!"
#     }
#   ]
# ]

  TokenBigramSplitSymbolAlpha

TokenBigramSplitSymbolAlpha は TokenBigram と似ています。違いは記号とアルファベットの扱いです。 TokenBigramSplitSymbolAlpha は記号とアルファベットのトークナイズ方法にバイグラムを使います。

実行例:

tokenize TokenBigramSplitSymbolAlpha "100cents!!!" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "100"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "ce"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "en"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "nt"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "ts"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "s!"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "!!"
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "!!"
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": "!"
#     }
#   ]
# ]

  TokenBigramSplitSymbolAlphaDigit

TokenBigramSplitSymbolAlphaDigit は TokenBigram と似ています。違いは記号とアルファベットと数字の扱いです。 TokenBigramSplitSymbolAlphaDigit は記号とアルファベット数字のトークナイズ方法にバイグラムを使います。つまり、すべての文字をバイグラムでトークナイズします。

実行例:

tokenize TokenBigramSplitSymbolAlphaDigit "100cents!!!" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "10"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "00"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "0c"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "ce"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "en"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "nt"
#     },
#     {
#       "position": 6,
#       "force_prefix": false,
#       "value": "ts"
#     },
#     {
#       "position": 7,
#       "force_prefix": false,
#       "value": "s!"
#     },
#     {
#       "position": 8,
#       "force_prefix": false,
#       "value": "!!"
#     },
#     {
#       "position": 9,
#       "force_prefix": false,
#       "value": "!!"
#     },
#     {
#       "position": 10,
#       "force_prefix": false,
#       "value": "!"
#     }
#   ]
# ]

  TokenBigramIgnoreBlank

TokenBigramIgnoreBlank は TokenBigram と似ています。違いは空白文字の扱いです。 TokenBigramIgnoreBlank は連続する記号と非ASCII文字の間にある空白文字を無視します。

日 本 語 ! ! ! というテキストを使うと違いがわかります。なぜならこのテキストは記号と非ASCII文字を両方含んでいるからです。

TokenBigram での実行結果です。

実行例:

tokenize TokenBigram "日 本 語 ! ! !" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "日"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "本"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "語"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "!"
#     },
#     {
#       "position": 4,
#       "force_prefix": false,
#       "value": "!"
#     },
#     {
#       "position": 5,
#       "force_prefix": false,
#       "value": "!"
#     }
#   ]
# ]

TokenBigramIgnoreBlank での実行結果です。

実行例:

tokenize TokenBigramIgnoreBlank "日 本 語 ! ! !" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "日本"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "本語"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "語"
#     },
#     {
#       "position": 3,
#       "force_prefix": false,
#       "value": "!!!"
#     }
#   ]
# ]

  TokenBigramIgnoreBlankSplitSymbol

TokenBigramIgnoreBlankSplitSymbol は TokenBigram と似ています。違いは次の通りです。

•   空白文字の扱い

•   記号の扱い

    TokenBigramIgnoreBlankSplitSymbol は連続した記号と非ASCII文字の間の空白文字を無視します。

    TokenBigramIgnoreBlankSplitSymbol は記号をバイグラムでトークナイズします。

    日 本 語 ! ! ! というテキストを使うと違いがわかります。なぜならこのテキストは記号と非ASCII文字を両方含んでいるからです。

    TokenBigram での実行結果です。

    実行例:

    tokenize TokenBigram "日 本 語 ! ! !" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "日"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "本"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "語"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "!"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "!"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "!"
    #     }
    #   ]
    # ]

    TokenBigramIgnoreBlankSplitSymbol の実行結果です。

    実行例:

    tokenize TokenBigramIgnoreBlankSplitSymbol "日 本 語 ! ! !" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "日本"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "本語"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "語!"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "!!"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "!!"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "!"
    #     }
    #   ]
    # ]

  TokenBigramIgnoreBlankSplitSymbolAlpha

TokenBigramIgnoreBlankSplitSymbolAlpha は TokenBigram と似ています。違いは次の通りです。

•   空白文字の扱い

•   記号とアルファベットの扱い

    TokenBigramIgnoreBlankSplitSymbolAlpha は連続した記号と非ASCII文字の間の空白文字を無視します。

    TokenBigramIgnoreBlankSplitSymbolAlpha は記号とアルファベットをバイグラムでトークナイズします。

    Hello 日 本 語 ! ! ! というテキストを使うと違いがわかります。なぜなら空白文字入りの記号と非ASCII文字だけでなく、アルファベットも含んでいるからです。

    TokenBigram での実行結果です。

    実行例:

    tokenize TokenBigram "Hello 日 本 語 ! ! !" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "hello"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "日"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "本"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "語"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "!"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "!"
    #     },
    #     {
    #       "position": 6,
    #       "force_prefix": false,
    #       "value": "!"
    #     }
    #   ]
    # ]

    TokenBigramIgnoreBlankSplitSymbolAlpha の実行結果です。

    実行例:

    tokenize TokenBigramIgnoreBlankSplitSymbolAlpha "Hello 日 本 語 ! ! !" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "he"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "el"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "ll"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "lo"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "o日"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "日本"
    #     },
    #     {
    #       "position": 6,
    #       "force_prefix": false,
    #       "value": "本語"
    #     },
    #     {
    #       "position": 7,
    #       "force_prefix": false,
    #       "value": "語!"
    #     },
    #     {
    #       "position": 8,
    #       "force_prefix": false,
    #       "value": "!!"
    #     },
    #     {
    #       "position": 9,
    #       "force_prefix": false,
    #       "value": "!!"
    #     },
    #     {
    #       "position": 10,
    #       "force_prefix": false,
    #       "value": "!"
    #     }
    #   ]
    # ]

  TokenBigramIgnoreBlankSplitSymbolAlphaDigit

TokenBigramIgnoreBlankSplitSymbolAlphaDigit は TokenBigram と似ています。違いは次の通りです。

•   空白文字の扱い

•   記号とアルファベットと数字の扱い

    TokenBigramIgnoreBlankSplitSymbolAlphaDigit は連続した記号と非ASCII文字の間の空白文字を無視します。

    TokenBigramIgnoreBlankSplitSymbolAlphaDigit は記号、アルファベット、数字をバイグラムでトークナイズします。つまり、すべての文字をバイグラムでトークナイズします。

    Hello 日 本 語 ! ! ! 777 というテキストを使うと違いがわかります。なぜなら、このテキストは空白文字入りの記号と非ASCII文字だけでなく、アルファベットと数字も含んでいるからです。

    TokenBigram での実行結果です。

    実行例:

    tokenize TokenBigram "Hello 日 本 語 ! ! ! 777" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "hello"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "日"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "本"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "語"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "!"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "!"
    #     },
    #     {
    #       "position": 6,
    #       "force_prefix": false,
    #       "value": "!"
    #     },
    #     {
    #       "position": 7,
    #       "force_prefix": false,
    #       "value": "777"
    #     }
    #   ]
    # ]

    TokenBigramIgnoreBlankSplitSymbolAlphaDigit の実行結果です。

    実行例:

    tokenize TokenBigramIgnoreBlankSplitSymbolAlphaDigit "Hello 日 本 語 ! ! ! 777" NormalizerAuto
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "he"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "el"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "ll"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "lo"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "o日"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "日本"
    #     },
    #     {
    #       "position": 6,
    #       "force_prefix": false,
    #       "value": "本語"
    #     },
    #     {
    #       "position": 7,
    #       "force_prefix": false,
    #       "value": "語!"
    #     },
    #     {
    #       "position": 8,
    #       "force_prefix": false,
    #       "value": "!!"
    #     },
    #     {
    #       "position": 9,
    #       "force_prefix": false,
    #       "value": "!!"
    #     },
    #     {
    #       "position": 10,
    #       "force_prefix": false,
    #       "value": "!7"
    #     },
    #     {
    #       "position": 11,
    #       "force_prefix": false,
    #       "value": "77"
    #     },
    #     {
    #       "position": 12,
    #       "force_prefix": false,
    #       "value": "77"
    #     },
    #     {
    #       "position": 13,
    #       "force_prefix": false,
    #       "value": "7"
    #     }
    #   ]
    # ]

  TokenUnigram

TokenUnigram は TokenBigram に似ています。違いはトークンの単位です。 TokenBigram は各トークンが2文字ですが、 TokenUnigram は各トークンが1文字です。

実行例:

tokenize TokenUnigram "100cents!!!" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "100"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "cents"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "!!!"
#     }
#   ]
# ]

  TokenTrigram

TokenTrigram は TokenBigram に似ています。違いはトークンの単位です。 TokenBigram は各トークンが2文字ですが、 TokenTrigram は各トークンが3文字です。

実行例:

tokenize TokenTrigram "10000cents!!!!!" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "10000"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "cents"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "!!!!!"
#     }
#   ]
# ]

  TokenDelimit

TokenDelimit は1つ以上の空白文字（ U+0020 ）で分割してトークンを抽出します。たとえば、 Hello World は Hello と World にトークナイズされます。

TokenDelimit はタグテキストに適切です。 groonga full-text-search http というテキストから groonga 、 full-text-search 、 http を抽出します。

以下は TokenDelimit の例です。

実行例:

tokenize TokenDelimit "Groonga full-text-search HTTP" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "groonga"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "full-text-search"
#     },
#     {
#       "position": 2,
#       "force_prefix": false,
#       "value": "http"
#     }
#   ]
# ]

  TokenDelimitNull

TokenDelimitNull は TokenDelimit に似ています。違いは区切り文字です。 TokenDelimit は空白文字（ U+0020 ）を使いますが、 TokenDelimitNull はNUL文字（ U+0000 ）を使います。

TokenDelimitNull もタグテキストに適切です。

以下は TokenDelimitNull の例です。

実行例:

tokenize TokenDelimitNull "Groonga\u0000full-text-search\u0000HTTP" NormalizerAuto
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "groongau0000full-text-searchu0000http"
#     }
#   ]
# ]

  TokenMecab

TokenMecab は MeCab 形態素解析器をベースにしたトークナイザーです。

MeCabは日本語に依存していません。その言語用の辞書を用意すれば日本語以外でもMeCabを使えます。日本語用の辞書には NAIST Japanese Dictionary を使えます。

TokenMecab は再現率より適合率に優れています。 TokenBigram では 京都 というクエリーで 東京都 も 京都 も見つかりますが、この場合は 東京都 は期待した結果ではありません。 TokenMecab を使うと 京都 というクエリーで 京都 だけを見つけられます。

新語をサポートしたい場合は、MeCabの辞書を更新し続ける必要があります。これはメンテナンスコストがかかります。（ TokenBigram には辞書のメンテナンスコストはありません。なぜなら、 TokenBigram は辞書を使っていないからです。）新語への対応に mecab-ipadic-NEologd : Neologism dictionary for MeCab が役に立つかもしれません。

以下は TokenMeCab の例です。 東京都 は 東京 と 都 にトークナイズされています。 京都 というトークンはありません。

実行例:

tokenize TokenMecab "東京都"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     {
#       "position": 0,
#       "force_prefix": false,
#       "value": "東京"
#     },
#     {
#       "position": 1,
#       "force_prefix": false,
#       "value": "都"
#     }
#   ]
# ]

  TokenRegexp

バージョン 5.0.1 で追加.

ご用心: このトークナイザーは実験的です。仕様が変わる可能性があります。

ご用心: このトークナイザーはUTF-8でしか使えません。EUC-JPやShift_JISなどと一緒には使えません。

TokenRegexp はインデックスを使った正規表現検索をサポートするトークナイザーです。

一般的に、正規表現検索は逐次検索で実行します。しかし、次のケースはインデックスを使って検索できます。

•   hello のようにリテラルしかないケース

•   \A/home/alice のようにテキストの最初でのマッチとリテラルのみのケース

•   \.txt\z のようにテキストの最後でのマッチとリテラルのみのケース

    多くのケースでは、逐次検索よりもインデックスを使った検索の方が高速です。

    TokenRegexp はベースはバイグラムを使います。 TokenRegexp は、インデックス時に、テキストの先頭にテキストの先頭であるというマーク（ U+FFEF ）を入れ、テキストの最後にテキストの最後であるというマーク（ U+FFF0 ）を入れます。

    実行例:

    tokenize TokenRegexp "/home/alice/test.txt" NormalizerAuto --mode ADD
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     {
    #       "position": 0,
    #       "force_prefix": false,
    #       "value": "￯"
    #     },
    #     {
    #       "position": 1,
    #       "force_prefix": false,
    #       "value": "/h"
    #     },
    #     {
    #       "position": 2,
    #       "force_prefix": false,
    #       "value": "ho"
    #     },
    #     {
    #       "position": 3,
    #       "force_prefix": false,
    #       "value": "om"
    #     },
    #     {
    #       "position": 4,
    #       "force_prefix": false,
    #       "value": "me"
    #     },
    #     {
    #       "position": 5,
    #       "force_prefix": false,
    #       "value": "e/"
    #     },
    #     {
    #       "position": 6,
    #       "force_prefix": false,
    #       "value": "/a"
    #     },
    #     {
    #       "position": 7,
    #       "force_prefix": false,
    #       "value": "al"
    #     },
    #     {
    #       "position": 8,
    #       "force_prefix": false,
    #       "value": "li"
    #     },
    #     {
    #       "position": 9,
    #       "force_prefix": false,
    #       "value": "ic"
    #     },
    #     {
    #       "position": 10,
    #       "force_prefix": false,
    #       "value": "ce"
    #     },
    #     {
    #       "position": 11,
    #       "force_prefix": false,
    #       "value": "e/"
    #     },
    #     {
    #       "position": 12,
    #       "force_prefix": false,
    #       "value": "/t"
    #     },
    #     {
    #       "position": 13,
    #       "force_prefix": false,
    #       "value": "te"
    #     },
    #     {
    #       "position": 14,
    #       "force_prefix": false,
    #       "value": "es"
    #     },
    #     {
    #       "position": 15,
    #       "force_prefix": false,
    #       "value": "st"
    #     },
    #     {
    #       "position": 16,
    #       "force_prefix": false,
    #       "value": "t."
    #     },
    #     {
    #       "position": 17,
    #       "force_prefix": false,
    #       "value": ".t"
    #     },
    #     {
    #       "position": 18,
    #       "force_prefix": false,
    #       "value": "tx"
    #     },
    #     {
    #       "position": 19,
    #       "force_prefix": false,
    #       "value": "xt"
    #     },
    #     {
    #       "position": 20,
    #       "force_prefix": false,
    #       "value": "t"
    #     },
    #     {
    #       "position": 21,
    #       "force_prefix": false,
    #       "value": "￰"
    #     }
    #   ]
    # ]

  トークンフィルター

  概要

Groongaにはトークナイズされたトークンに所定の処理を行うトークンフィルターモジュールがあります。

トークンフィルターモジュールはプラグインとして追加できます。

トークンフィルタープラグインをGroongaに追加することでトークナイズされたトークンをカスタマイズできます。

テーブルは0個以上のトークンフィルターを持てます。テーブルにトークンフィルターを付けるには /reference/commands/table_create の table-create-token-filters オプションを使います。

以下は TokenFilterStopWord トークンフィルターモジュールを使う table_create の例です。

実行例:

register token_filters/stop_word
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto \
  --token_filters TokenFilterStopWord
# [[0, 1337566253.89858, 0.000355720520019531], true]

  利用可能なトークンフィルター

以下は組み込みのトークンフィルターのリストです。

•   TokenFilterStopWord

•   TokenFilterStem

  TokenFilterStopWord

TokenFilterStopWord は、文書を検索する時にトークナイズされたトークンからストップワードを除去します。

TokenFilterStopWord は、文書を検索する時のみトークン除去するため、文書を追加した後でストップワードを指定することもできます。

ストップワードは、語彙表の is_stop_word カラムで指定します。

以下は TokenFilterStopWord トークンフィルターを使う例です。

実行例:

register token_filters/stop_word
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Memos TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto \
  --token_filters TokenFilterStopWord
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms memos_content COLUMN_INDEX|WITH_POSITION Memos content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms is_stop_word COLUMN_SCALAR Bool
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Terms
[
{"_key": "and", "is_stop_word": true}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
load --table Memos
[
{"content": "Hello"},
{"content": "Hello and Good-bye"},
{"content": "Good-bye"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select Memos --match_columns content --query "Hello and"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "content",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "Hello"
#       ],
#       [
#         2,
#         "Hello and Good-bye"
#       ]
#     ]
#   ]
# ]

and というトークンは Terms テーブルでストップワードと指定されています。

"Hello" は文書内に and がありませんがマッチしています。なぜなら、 and はストップワードと指定されているため、クエリーから除去されているからです。

  TokenFilterStem

TokenFilterStem は、トークナイズされたトークンをステミングします。

以下は TokenFilterStem トークンフィルターを使う例です。

実行例:

register token_filters/stem
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Memos TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto \
  --token_filters TokenFilterStem
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms memos_content COLUMN_INDEX|WITH_POSITION Memos content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Memos
[
{"content": "I develop Groonga"},
{"content": "I'm developing Groonga"},
{"content": "I developed Groonga"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
select Memos --match_columns content --query "develops"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "content",
#           "ShortText"
#         ]
#       ],
#       [
#         1,
#         "I develop Groonga"
#       ],
#       [
#         2,
#         "I'm developing Groonga"
#       ],
#       [
#         3,
#         "I developed Groonga"
#       ]
#     ]
#   ]
# ]

develop も developing も developed も develops も、すべてステミングすると develop になります。そのため、 develops というクエリーで develop も developing も developed も検索できます。

  参考

•   /reference/commands/table_create

  クエリー展開オブジェクト一覧

  QueryExpanderTSV

  概要

QueryExpanderTSV はクエリー展開プラグインです。同義語はTSV（データをタブで区切るファイルフォーマット）ファイルから読み込みます。このプラグインは組み込みのクエリー展開機能よりも機能が少ないです。例えば、単語の正規化をサポートしていません。しかし、TSVファイルで同義語を管理できるためこちらの方が使いやすいかもしれません。TSVファイルなのでExcelなどの表計算ソフトで同義語を編集できます。組み込みのクエリー展開機能では、Groongaのテーブルとして同義語を管理します。

  インストール

QueryExpanderTSV を使う前に query_expanders/tsv をプラグインとして登録します:

plugin_register query_expanders/tsv

  使い方

select コマンドに --query_expander QueryExpanderTSV パラメーターを追加します:

select --query "QUERY" --query_expander QueryExpanderTSV

QUERY 内に登録済みの同義語がある場合はそれらが展開されます。例えば、以下の同義語があるとします。
単語 | 同義語1 | 同義語2
groonga | groonga | Senna
mroonga | mroonga | groonga MySQL

この表は、 単語 の同義語は 同義語1 と 同義語2 という意味です。例えば、 groonga の同義語は groonga と Senna です。また、 mroonga の同義語は mroonga と groonga MySQL です。

クエリーが groonga のときのクエリー展開の例です:

select --query "groonga" --query_expander QueryExpanderTSV

上記のコマンドは以下のコマンドと同じ意味です:

select --query "groonga OR Senna" --query_expander QueryExpanderTSV

クエリーが mroonga search のときのクエリー展開の例です:

select --query "mroonga search" --query_expander QueryExpanderTSV

上記のコマンドは以下のコマンドと同じ意味です:

select --query "(mroonga OR (groonga MySQL)) search" --query_expander QueryExpanderTSV

登録されている単語だけ（ここでは groonga と mroonga ）クエリー展開されて、登録されていない単語（ここでは search ）はクエリー展開されていないことが大事なポイントです。また、再帰的にクエリー展開しません。クエリー展開した結果の (mroonga OR (groonga MySQL)) の中に groonga がありますが、これは展開されません。

通常、同義語の中に 単語 自身も含める必要があります。例えば、 groonga と mroonga が同義語の中に含まれています。もし、 単語 自身を無視したい場合は同義語の中に 単語 を含めないでください。例えば、クエリー展開機能をスペル訂正機能として使う場合は、以下のような同義語を使ってください。
単語 | 同義語
gronga | groonga

単語 の gronga には誤字があります。 o がひとつ足りません。 同義語 の groonga が正しい単語です。

スペル訂正機能としてクエリー展開機能を使う例です:

select --query "gronga" --query_expander QueryExpanderTSV

上記のコマンドは以下のコマンドと同じ意味です:

select --query "groonga" --query_expander QueryExpanderTSV

前者のコマンドは --query の値に誤字がありますが、後者のコマンドは誤字がありません。

  TSVファイル

同義語はTSVフォーマットのファイルで定義します。このセクションでは定義方法について説明します。

  場所

TSVファイルのファイル名は synonyms.tsv で、設定ディレクトリに置かなければいけません。例えば、 /etc/groonga/synonyms.tsv がTSVファイルの場所になります。場所はビルド時に決まります。

環境変数 GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE を指定することで実行時に場所を変更することもできます:

% env GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE=/tmp/synonyms.tsv groonga

上述のコマンドでは /tmp/synonyms.tsv ファイルが使われます。

  フォーマット

TSVファイル内に0個以上の同義語を定義することができます。1行につき 単語 と 同義語リスト のペアを定義します。 --query の値の中にでてきた 単語 は 同義語リスト に展開されます。 同義語リスト は OR でまとめます。例えば、同義語リスト groonga と Senna は groonga OR Senna と展開されます。

最初のカラムが 単語 で、残りのカラムが 単語 の 同義語リスト になります。以下は、 単語 が groonga で、 同義語リスト が groonga と synonyms の例です。 (TAB) はタブ文字（ U+0009 ）という意味です:

groonga(TAB)groonga(TAB)Senna

コメント行をサポートしています。 # から始まる行は無視します。以下はコメント行の例です。 groonga とある行はコメント行として無視されます:

#groonga(TAB)groonga(TAB)Senna
mroonga(TAB)mroonga(TAB)groonga MySQL

  制限

同義語を再読み込みするにはgroongaを再起動する必要があります。TSVファイルはプラグイン読み込み時に一度だけ読み込みます。

  参考

•   詳細については select-query-expander を参照してください。

  スコアラー

  概要

Groongaにはスコアー関数をカスタマイズするスコアーモジュールがあります。スコアー関数はマッチしたレコードのスコアーを計算します。デフォルトのスコアー関数は出現単語数をスコアーにします。これはTF（term frequency。単語の出現数）と呼ばれている計算方法です。

TFは高速なスコアー関数ですが、次のケースには適していません。

•   検索クエリーが「the」や「a」のように非常によく出現する単語を含んでいる。

•   文書中に「They are keyword, keyword, keyword ... and keyword」というように同じキーワードが大量に含まれている。検索エンジンのスパマーはこのテクニックを使うかもしれません。

    スコアー関数でこれらのケースを解決できます。例えば、 TF-IDF （term frequency-inverse document frequency。その文書中での単語の出現数を、文書全体での単語の出現数で割ったもの）は最初のケースを解決できます。 Okapi BM25 は2番目のケースを解決できます。しかし、これらはTFより遅いです。

    Groongaは /reference/scorers/scorer_tf_idf としてTF-IDFベースのスコアラーを提供しています。しかし、Okapi BM25ベースのスコアラーはまだ提供していません。 スコアー関数だけでスコアの計算をする必要はありません。スコアー関数は検索クエリーに非常に依存しています。検索クエリーだけでなく、マッチしたレコードのメタデータも使えないか検討しましょう。

    たとえば、Googleはスコアーの計算に ページランク を使っています。あなたも、データの種類（たとえば、「メモ」データよりも「タイトル」データの方が重要など）、タグ、位置情報などを使えないか検討してみましょう。

    スコアーの計算をスコアー関数だけで考えることはやめましょう。

  使い方

このセクションではスコアラーの使い方について説明します。

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create Memos TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos title COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms title_index COLUMN_INDEX|WITH_POSITION Memos title
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms content_index COLUMN_INDEX|WITH_POSITION Memos content
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table Memos
[
{
  "_key": "memo1",
  "title": "Groonga is easy",
  "content": "Groonga is very easy full text search engine!"
},
{
  "_key": "memo2",
  "title": "Mroonga is easy",
  "content": "Mroonga is more easier full text search engine!"
},
{
  "_key": "memo3",
  "title": "Rroonga is easy",
  "content": "Ruby is very helpful."
},
{
  "_key": "memo4",
  "title": "Groonga is fast",
  "content": "Groonga! Groonga! Groonga! Groonga is very fast!"
},
{
  "_key": "memo5",
  "title": "PGroonga is fast",
  "content": "PGroonga is very fast!"
},
{
  "_key": "memo6",
  "title": "PGroonga is useful",
  "content": "SQL is easy because many client libraries exist."
},
{
  "_key": "memo7",
  "title": "Mroonga is also useful",
  "content": "MySQL has replication feature. Mroonga can use it."
}
]
# [[0, 1337566253.89858, 0.000355720520019531], 7]

select-match-columns の中でscore関数を使うことができます。次に構文を示します。

/reference/scorers/scorer_tf_idf のように、いくつかのスコアー関数には引数はありません。:

SCORE_FUNCTION(COLUMN)

重みを指定することができます。:

SCORE_FUNCTION(COLUMN) * WEIGHT

/reference/scorers/scorer_tf_at_most のように引数が必要なスコアー関数もあります。:

SCORE_FUNCTION(COLUMN, ARGUMENT1, ARGUMENT2, ...)

重みを指定することができます。:

SCORE_FUNCTION(COLUMN, ARGUMENT1, ARGUMENT2, ...) * WEIGHT

select-match-columns ではカラムごとに異なるスコア関数を使うことができます。:

SCORE_FUNCTION1(COLUMN1) ||
  SCORE_FUNCTION2(COLUMN2) * WEIGHT ||
  SCORE_FUNCTION3(COLUMN3, ARGUMENT1) ||
  ...

以下は簡単な使用例です。

実行例:

select Memos \
  --match_columns "scorer_tf_idf(content)" \
  --query "Groonga" \
  --output_columns "content, _score" \
  --sortby "-_score"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga! Groonga! Groonga! Groonga is very fast!",
#         2
#       ],
#       [
#         "Groonga is very easy full text search engine!",
#         1
#       ]
#     ]
#   ]
# ]

Groonga! Groonga! Groonga! Groonga is very fast! には Groonga が4つ含まれています。デフォルトのTFベースのスコアラーを使うと、 _score は 4 です。しかし、実際は _score は 2 になります。なぜなら、この select コマンドはTF-IDFベースの scorer_tf_idf() スコアラーを使っているからです。

以下は重みを使った例です。

実行例:

select Memos \
  --match_columns "scorer_tf_idf(content) * 10" \
  --query "Groonga" \
  --output_columns "content, _score" \
  --sortby "-_score"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga! Groonga! Groonga! Groonga is very fast!",
#         22
#       ],
#       [
#         "Groonga is very easy full text search engine!",
#         10
#       ]
#     ]
#   ]
# ]

Groonga! Groonga! Groonga! Groonga is very fast! の _score は 22 です。重みを指定していない前の例では _score は 2 でした。

以下は必ず引数を1つ指定しなければいけないスコアラーを使う例です。 /reference/scorers/scorer_tf_at_most スコアラーには引数を1つ指定しなければいけません。このスコアラーを使うと、TFのスコアーの最大値を制限することができます。

実行例:

select Memos \
  --match_columns "scorer_tf_at_most(content, 2.0)" \
  --query "Groonga" \
  --output_columns "content, _score" \
  --sortby "-_score"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga! Groonga! Groonga! Groonga is very fast!",
#         2
#       ],
#       [
#         "Groonga is very easy full text search engine!",
#         1
#       ]
#     ]
#   ]
# ]

Groonga! Groonga! Groonga! Groonga is very fast! は Groonga を4つ含んでいます。もし、デフォルトのスコアラーである標準のTFベースのスコアラーを使っていた場合、 _score は 4 になります。しかし、実際の _score は 2 です。なぜなら、この select コマンドが使っているスコアラーは最大スコアーを 2 に制限しているからです。

以下は複数のスコアラーを使う例です。

実行例:

select Memos \
  --match_columns "scorer_tf_idf(title) || scorer_tf_at_most(content, 2.0)" \
  --query "Groonga" \
  --output_columns "title, content, _score" \
  --sortby "-_score"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "title",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga is fast",
#         "Groonga! Groonga! Groonga! Groonga is very fast!",
#         3
#       ],
#       [
#         "Groonga is easy",
#         "Groonga is very easy full text search engine!",
#         2
#       ]
#     ]
#   ]
# ]

この --match_columns は scorer_tf_idf(title) と scorer_tf_at_most(content, 2.0) を使っています。 _score の値はこれら2つの値の合計になります。

同じ --match_columns の中でデフォルトのスコアラーとカスタムスコアラーを使うことができます。単にマッチ対象のカラムを指定するとデフォルトのスコアラーを使います。

実行例:

select Memos \
  --match_columns "title || scorer_tf_at_most(content, 2.0)" \
  --query "Groonga" \
  --output_columns "title, content, _score" \
  --sortby "-_score"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "title",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Groonga is fast",
#         "Groonga! Groonga! Groonga! Groonga is very fast!",
#         3
#       ],
#       [
#         "Groonga is easy",
#         "Groonga is very easy full text search engine!",
#         2
#       ]
#     ]
#   ]
# ]

この --match_columns は title にはデフォルトのスコアラー（TF）を使い、 content には /reference/scorers/scorer_tf_at_most を使います。 _score の値はこれらのスコアラーの結果の合計になります。

  組み込みスコアラー

以下は組み込みのスコアラーです。

  scorer_tf_at_most

注釈: スコアラーは実験的な機能です。

バージョン 5.0.1 で追加.

  概要

scorer_tf_at_most はTF（term frequency。単語の出現数）ベースのスコアラーです。

TF-IDFベースのスコアラーを含むTFベースのスコアラーは次のケースに対して適していません。

文書中に「They are keyword, keyword, keyword ... and keyword」というように同じキーワードが大量に含まれているとその文書のスコアーが高くなってしまいます。これは意図した挙動ではありません。検索エンジンのスパマーはこのテクニックを使うかもしれません。

scorer_tf_at_most はTFベースのスコアラーですが、このケースを解決できます。

scorer_tf_at_most はスコアーの最大値を制限します。つまり、 scorer_tf_at_most は1つのマッチの影響を制限することができるということです。

文書中に「They are keyword, keyword, keyword ... and keyword」というように同じキーワードが大量に含まれていても、 scorer_tf_at_most(column, 2.0) はスコアーの値として大きくても 2 しか返しません。 スコアー関数だけでスコアの計算をする必要はありません。スコアー関数は検索クエリーに非常に依存しています。検索クエリーだけでなく、マッチしたレコードのメタデータも使えないか検討しましょう。

たとえば、Googleはスコアーの計算に ページランク を使っています。あなたも、データの種類（たとえば、「メモ」データよりも「タイトル」データの方が重要など）、タグ、位置情報などを使えないか検討してみましょう。

スコアーの計算をスコアー関数だけで考えることはやめましょう。

  構文

このスコアラーの引数は1つです。:

scorer_tf_at_most(column, max)
scorer_tf_at_most(index, max)

  使い方

このセクションではscorerの使い方について説明します。

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs message COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table Logs
[
{"message": "Notice"},
{"message": "Notice Notice"},
{"message": "Notice Notice Notice"},
{"message": "Notice Notice Notice Notice"},
{"message": "Notice Notice Notice Notice Notice"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]

次のように select-match-columns で scorer_tf_at_most を指定します。

実行例:

select Logs \
  --match_columns "scorer_tf_at_most(message, 3.0)" \
  --query "Notice" \
  --output_columns "message, _score" \
  --sortby "-_score"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "message",
#           "Text"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Notice Notice Notice Notice Notice",
#         3
#       ],
#       [
#         "Notice Notice Notice Notice",
#         3
#       ],
#       [
#         "Notice Notice Notice",
#         3
#       ],
#       [
#         "Notice Notice",
#         2
#       ],
#       [
#         "Notice",
#         1
#       ]
#     ]
#   ]
# ]

もし、文書が Notice という単語を3個以上含んでいたら、スコアーは 3 になります。なぜなら、この select ではスコアーの最大値を 3.0 と指定しているからです。

もし、文書が Notice という単語を1つか2つしか含んでいなかったら、スコアーは 1 か 2 になります。なぜなら、スコアーが指定された最大値 3.0 より小さいからです。

  引数

このセクションではすべての引数について説明します。

  必須引数

1つだけ必須の引数があります。

  column

マッチ対象のデータカラムです。このデータカラムにはインデックスが張られていなければいけません。

  index

検索に使うインデックスカラムです。

  省略可能引数

省略可能な引数はありません。

  戻り値

このスコアラーは builtin-type-float でスコアーの値を返します。

/reference/commands/select は Float ではなく Int32 で _score を返します。これは、後方互換性を維持するために Float から Int32 にキャストしているためです。

スコアーは制限つきのTFで計算します。

  参考

•   ../scorer

  scorer_tf_idf

注釈: スコアラーは実験的な機能です。

バージョン 5.0.1 で追加.

  概要

scorer_tf_idf は TF-IDF （term frequency-inverse document frequency。その文書中での単語の出現数を、その単語を文書の数で割ったもの）ベースのスコアー関数です。

簡単に言うと、TF-IDFとはTF（term frequency。その文書中での単語出現数）をDF（document frequency。その単語を含むドキュメント数）で割ったものです。「TF」は「単語がたくさん出現している方がより重要」という意味を表します。「TFをDFで割る」というのは「重要な単語がたくさん出現している方がより重要」という意味を表します。

Groongaのデフォルトのスコアー関数はTF（term frequency。単語の出現数）です。この関数は単語の重要度は考慮しませんが高速です。

TF-IDFは単語の重要度を考慮しますが、TFより遅くなります。

TF-IDFは多くの場合でTFよりも適切なスコアーを計算しますが、完璧ではありません。

「They are keyword, keyword, keyword ... and keyword」のように文書中に同じキーワードがたくさん含まれている場合、TFでもTF-IDFでもスコアーが増えます。検索エンジンのスパマーはこのテクニックを使うかもしれません。しかし、TF-IDFはこのテクニックを防ぐことができません。

Okapi BM25 はこのケースを解決できます。しかし、TF-IDFよりも遅くなります。また、Groongaではまだ実装されていません。

Groongaは scorer_tf_at_most スコアラーという別の方法でこのケースを解決できるスコアラーを提供しています。 スコアー関数だけでスコアの計算をする必要はありません。スコアー関数は検索クエリーに非常に依存しています。検索クエリーだけでなく、マッチしたレコードのメタデータも使えないか検討しましょう。

たとえば、Googleはスコアーの計算に ページランク を使っています。あなたも、データの種類（たとえば、「メモ」データよりも「タイトル」データの方が重要など）、タグ、位置情報などを使えないか検討してみましょう。

スコアーの計算をスコアー関数だけで考えることはやめましょう。

  構文

このスコアラーの引数は1つです。:

scorer_tf_idf(column)
scorer_tf_idf(index)

  使い方

このセクションではscorerの使い方について説明します。

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs message COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText \
  --default_tokenizer TokenBigram \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table Logs
[
{"message": "Error"},
{"message": "Warning"},
{"message": "Warning Warning"},
{"message": "Warning Warning Warning"},
{"message": "Info"},
{"message": "Info Info"},
{"message": "Info Info Info"},
{"message": "Info Info Info Info"},
{"message": "Notice"},
{"message": "Notice Notice"},
{"message": "Notice Notice Notice"},
{"message": "Notice Notice Notice Notice"},
{"message": "Notice Notice Notice Notice Notice"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 13]

select-match-columns の中で scorer_tf_idf を次のようにして指定できます:

実行例:

select Logs \
  --match_columns "scorer_tf_idf(message)" \
  --query "Error OR Info" \
  --output_columns "message, _score" \
  --sortby "-_score"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "message",
#           "Text"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Info Info Info Info",
#         3
#       ],
#       [
#         "Error",
#         2
#       ],
#       [
#         "Info Info Info",
#         2
#       ],
#       [
#         "Info Info",
#         1
#       ],
#       [
#         "Info",
#         1
#       ]
#     ]
#   ]
# ]

Info Info Info には Info という単語が3回もでてきますが、 Info Info Info も Error もどちらもスコアーは 2 です。なぜなら、 Error は Info よりもより重要な単語だからです。 Info を含むドキュメントの数は 4 です。 Error を含むドキュメントの数は 1 です。少しのドキュメントにしか含まれていない単語はより特徴的な単語です。特徴的な単語は重要な単語です。

  引数

このセクションではすべての引数について説明します。

  必須引数

1つだけ必須の引数があります。

  column

マッチ対象のデータカラムです。このデータカラムにはインデックスが張られていなければいけません。

  index

検索に使うインデックスカラムです。

  省略可能引数

省略可能な引数はありません。

  戻り値

このスコアラーは builtin-type-float でスコアーの値を返します。

/reference/commands/select は Float ではなく Int32 で _score を返します。これは、後方互換性を維持するために Float から Int32 にキャストしているためです。

スコアーはTF-IDFベースのアルゴリズムで計算します。

  参考

•   ../scorer

  grn_expr

grn_exprは特定の条件にマッチするレコードを検索したり、データベースを操作するオブジェクトです。 ぐるんしき と読みます。（由来は「Groongaの式」。）

データベースからレコードを検索する条件は条件式を集合演算で結合して表現できます。例えば、条件式には 等価条件式 や 小なり条件式 などがあります。集合演算には 積（AND） 、 和（OR） 、 差（NOT） などがあります。gnr_exprはこれらの条件を使ってレコードを検索します。類似文書検索や近傍検索などといった高度な検索もgrn_exprで実行できます。柔軟な全文検索も実行できます。例えば、特定の単語にマッチしたときのヒットスコアを調整したり、検索結果数によって検索漏れの少ないアルゴリズムで再検索し、再現率を向上するといったことも実現できます。

grn_exprを作る方法は3つあります:

•   /reference/grn_expr/query_syntax の文字列をパースする。

•   /reference/grn_expr/script_syntax の文字列をパースする。

•   grn_expr関連のAPIを呼ぶ。

    /reference/grn_expr/query_syntax は一般的なインターネット検索サイトにある検索フォーム用の構文です。シンプルで使いやすいですが、制限があります。 /reference/grn_expr/query_syntax では実行できない条件式や集合演算があります。 /reference/grn_expr/query_syntax は /reference/commands/select の query オプションで指定する検索条件で使えます。

    /reference/grn_expr/script_syntax はECMAScriptに似た構文です。 /reference/grn_expr/script_syntax ではすべての条件式と集合演算を使えます。 /reference/grn_expr/script_syntax は /reference/commands/select の filter オプションで指定する検索条件や scorer オプションで指定する式で使えます。

    groongaをライブラリとして使うと、grn_expr関連のAPIを呼び出してgrn_exprを作ることができます。 /reference/grn_expr/script_syntax のように、APIを呼び出すと全ての機能を使えます。grn_exprを作る構文を新しく作るときにはAPIが便利です。APIは rroonga というGroongaのRubyバインディングで使われています。rroongaでは文字列をパースするのではなく、Rubyの構文を使ってgrn_exprを作ることができます。

  クエリー構文

クエリー構文は一般的なWebの検索フォームで検索条件を指定するための構文です。Googleの検索フォームで使われている構文に似ています。例えば、 word1 word2 は word1 と word2 の両方の単語を含んだレコードを検索するという意味です。 word1 OR word2 は word1 または word2 のどちらかの単語を含んだレコードを検索します。

クエリー構文は 条件式 と 結合式 と 代入式 から成ります。通常、 代入式 は考えなくてよいです。なぜなら、 代入式 は /reference/commands/select の --query オプションでは無効になっているからです。groongaをライブラリとして使ったときは、クエリー構文のパーサーのオプションをカスタマイズすることで 代入式 を有効にすることができます。

条件式 は条件を指定します。 結合式 は1つ以上の 条件式 、 結合式 、 代入式 から成ります。 代入式 はカラムに値を代入します。

  サンプルデータ

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Entries TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries n_likes COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{"_key":    "The first post!",
 "content": "Welcome! This is my first post!",
 "n_likes": 5},
{"_key":    "Groonga",
 "content": "I started to use Groonga. It's very fast!",
 "n_likes": 10},
{"_key":    "Mroonga",
 "content": "I also started to use Mroonga. It's also very fast! Really fast!",
 "n_likes": 15},
{"_key":    "Good-bye Senna",
 "content": "I migrated all Senna system!",
 "n_likes": 3},
{"_key":    "Good-bye Tritonn",
 "content": "I also migrated all Tritonn system!",
 "n_likes": 3}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]

ブログエントリ用の Entries テーブルがあります。各エントリはタイトルと内容と「いいね！」数を持っています。タイトルは Entries のキーとします。内容は Entries.content カラムの値とします。「いいね！」数は Entries.n_likes カラムの値とします。

Entries._key カラムと Entries.content カラムには TokenBigram トークナイザーを使ったインデックスを作成します。そのため、 Entries._key と Entries.content は両方とも全文検索できます。

これで例を示すためのスキーマとデータの準備ができました。

  エスケープ

クエリー構文には特別な文字があります。特別な文字それ自体を使うためには文字の前に \ をつけてエスケープしなければいけません。例えば、 " は特別な文字です。これは \" というようにエスケープします。

以下が特別な文字のリストです:

•   [space] （ [backslash][space] とエスケープする。）（ [space] をASCIIで言えば0x20の空白文字に置き換えて、 [backslash] を \\ に置き換えてください。）

•   " （ \" とエスケープする。）

•   ' （ \' とエスケープする。）

•   ( （ \( とエスケープする。）

•   ) （ \) とエスケープする。）

•   \ （ \\ とエスケープする。）

    \ （バックスラッシュ）以外はエスケープする代わりにクォートすることもできます。クォート中でバックスラッシュをエスケープするときは \\ というようにバックスラッシュを使います。

    クォート構文は "..." または '...' です。 "..." クォート構文中では " を \" にエスケープする必要があります。 '...' クォート構文中では ' を \' にエスケープする必要があります。例えば、 Alice's brother (Bob) は "Alice's brother (Bob)" あるいは 'Alice\'s brother (Bob)' とクォートします。

    注釈: 注意しなければならない大事な点があります。\ (バックスラッシュ)はコマンドラインシェルが解釈します。それゆえ例えば ( それ自体を検索したいならシェルでは二重にエスケープ (\\() しなければなりません。コマンドラインシェルは \\( を \( と解釈してからGroongaに渡します。Groongaは \( を ( とみなし、( 自体をデータベースから検索します。もし意図した検索がGroongaで行えないなら、特別な文字を正しくエスケープしているか確認します。

  条件式

以下は利用可能な条件式の一覧です。

  全文検索条件

構文は keyword です。

全文検索条件 はデフォルトのマッチカラムに対して全文検索するという条件を指定します。マッチカラムとは全文検索対象のカラムのことです。

全文検索に使うデフォルトのマッチカラムを指定する必要があります。マッチカラムは /reference//commands/select の --match_columns オプションで指定します。デフォルトのマッチカラムを指定していない場合、この条件式は失敗します。

この条件式は keyword で全文検索をします。 keyword には空白を含めることはできません。 search keyword というように空白を含んでいる場合は、 search と keyword という2つの全文検索条件を指定したことになります。もし、キーワードに空白を含めたい場合は以下で説明する フレーズ検索条件 を使ってください。

以下は簡単な使用例です。

実行例:

select Entries --match_columns content --query fast
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は content カラムの値に fast という単語を含んでいるレコードにマッチします。

content カラムはデフォルトのマッチカラムです。

  フレーズ検索条件

構文は "search keyword" です。

フレーズ検索条件 はデフォルトのマッチカラムに対してフレーズ検索するという条件を指定します。

全文検索に使うデフォルトのマッチカラムを指定する必要があります。マッチカラムは /reference//commands/select の --match_columns オプションで指定します。デフォルトのマッチカラムを指定していない場合、この条件式は失敗します。

この条件式は search keyword でフレーズ検索をします。フレーズ検索は search と keyword がこの順番で隣接して含まれているレコードにマッチします。つまり、 Put a search keyword in the form にはマッチしますが、 Search by the keyword や There is a keyword. Search by it! にはマッチしません。

以下は簡単な使用例です。

実行例:

select Entries --match_columns content --query '"I started"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ]
#     ]
#   ]
# ]

この式は content カラムの値に I started というフレーズを含んでいるレコードにマッチします。 I also started にはマッチしません。これは I と started が隣接していないからです。

content カラムはデフォルトのマッチカラムです。

  全文検索条件（マッチカラム指定あり）

構文は column:@keyword です。

これは 全文検索条件 と似ていますが、デフォルトのマッチカラムは必要ありません。全文検索用のマッチカラムは /reference/commands/select の --match_columns オプションではなく column: で指定します。

この条件式は異なったカラムに対して複数の全文検索をしたい場合に便利です。 --match_columns オプションで指定するデフォルトのマッチカラムは複数回指定することができません。2つめのマッチカラムを指定するためにはこの条件式を使う必要があります。

全文検索条件 と 全文検索条件（マッチカラム指定あり） の違いは高度なマッチカラムをサポートしているかどうかです。 全文検索条件 は高度なマッチカラムをサポートしていますが、 全文検索条件（マッチカラム指定あり） はサポートしていません。高度なマッチカラムには以下の機能があります:

•   重みをサポートしている。

•   複数のカラムを指定できる。

•   マッチカラムとしてインデックスカラムを使える。

    これらについては /reference/commands/select の --match_columns オプションを参照してください。

    以下は簡単な使用例です。

    実行例:

    select Entries --query content:@fast
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "_key",
    #           "ShortText"
    #         ],
    #         [
    #           "content",
    #           "Text"
    #         ],
    #         [
    #           "n_likes",
    #           "UInt32"
    #         ]
    #       ],
    #       [
    #         2,
    #         "Groonga",
    #         "I started to use Groonga. It's very fast!",
    #         10
    #       ],
    #       [
    #         3,
    #         "Mroonga",
    #         "I also started to use Mroonga. It's also very fast! Really fast!",
    #         15
    #       ]
    #     ]
    #   ]
    # ]

    この式は content カラムの値に fast という単語を含んでいるレコードにマッチします。

  フレーズ検索条件（マッチカラム指定あり）

構文は column:@"search keyword" です。

これは フレーズ検索条件 に似ていますが、デフォルトのマッチカラムは必要ありません。フレーズ検索用のマッチカラムは /reference/commands/select の --match_columns オプションではなく column: で指定します。

フレーズ検索条件 と フレーズ検索条件（マッチカラム指定あり） は 全文検索条件 と 全文検索条件（マッチカラム指定あり） の関係と似ています。 フレーズ検索条件 は高度なマッチカラムをサポートしていますが、 フレーズ検索条件（マッチカラム指定あり） はサポートしていません。高度なマッチカラムについては 全文検索条件（マッチカラム指定あり） を参照してください。

以下は簡単な使用例です。

実行例:

select Entries --query 'content:@"I started"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ]
#     ]
#   ]
# ]

この式は content カラムの値に I started というフレーズを含んでいるレコードにマッチします。 I also started にはマッチしません。これは I と started が隣接していないからです。

  前方一致検索条件

構文は column:^value または value* です。

この条件式は value で前方一致検索をします。前方一致検索は value で始まる単語を含むレコードを検索します。

カラムの値を高速に前方一致検索できます。ただし、そのカラムにはインデックスを作成し、そのインデックス用のテーブルをパトリシアトライ（ TABLE_PAT_KEY ）またはダブル配列トライ（ TABLE_DAT_KEY ）にしなければいけません。あるいは、パトリシアトライテーブルまたはダブル配列テーブルの _key も高速に前方一致検索できます。 _key にインデックスを作成する必要はありません。

他の種類のテーブルでも前方一致検索を使えますがレコード全件を処理します。レコード数が少ない場合には問題ありませんが、レコード数が多いと時間がかかります。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

以下は簡単な使用例です。

実行例:

select Entries --query '_key:^Goo'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ]
#     ]
#   ]
# ]

この式は _key カラムの値が Goo で始まる単語を含むレコードにマッチします。この式には Good-bye Senna と Good-bye Tritonn がマッチします。

  後方一致検索条件

構文は column:$value です。

この条件式は value で後方一致検索します。後方一致検索は value で終わる単語を含むレコードを検索します。

カラムの値を高速に後方一致検索できます。ただし、そのカラムにはインデックスを作成し、そのインデックス用のテーブルを KEY_WITH_SIS フラグ付きのパトリシアトライテーブル（ TABLE_PAT_KEY ）にしなければいけません。 KEY_WITH_SIS フラグ付きのパトリシアトライテーブル（ TABLE_PAT_KEY ）の _key 擬似カラムの値も高速に後方一致検索できます。 _key にはインデックスを作成する必要はありません。 _key ベースの高速な後方一致検索よりもカラムベースの高速な後方一致検索を使うことをおすすめします。 _key ベースの高速な後方一致検索は自動的に登録された部分文字列も返ってきます。（TODO: 後方一致検索に関するドキュメントを書いてここからリンクを張る。）

注釈: 高速な後方一致検索は日本語のひらがななど非ASCII文字にしか使えません。ASCII文字には高速な後方一致検索を使えません。

後方一致検索は他の種類のテーブルもしくはパトリシアトライを KEY_WITH_SIS フラグなしで使用しているテーブルに対しても使えますが、レコード全件を処理します。レコード数が少ない場合には問題ありませんが、レコード数が多いと時間がかかります。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

簡単な例です。ASCII文字ではない文字である日本語のひらがなに対して高速な後方一致検索をしています。

実行例:

table_create Titles TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Titles content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create SuffixSearchTerms TABLE_PAT_KEY|KEY_WITH_SIS ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create SuffixSearchTerms index COLUMN_INDEX Titles content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Titles
[
{"content": "ぐるんが"},
{"content": "むるんが"},
{"content": "せな"},
{"content": "とりとん"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
select Titles --query 'content:$んが'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "content",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "むるんが"
#       ],
#       [
#         1,
#         "ぐるんが"
#       ]
#     ]
#   ]
# ]

この式は content カラムの値が んが で終わるレコードにマッチします。この場合は ぐるんが と むるんが にマッチします。

  等価条件

構文は column:value です。

column の値が value と等しいレコードにマッチします。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

以下は簡単な使用例です。

実行例:

select Entries --query _key:Groonga
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ]
#     ]
#   ]
# ]

この式は _key カラムの値が Groonga のレコードにマッチします。

  不等価条件

構文は column:!value です。

column の値が value と等しくないレコードにマッチします。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

以下は簡単な使用例です。

実行例:

select Entries --query _key:!Groonga
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は _key カラムの値が Groonga ではないレコードにマッチします。

  小なり条件

構文は column:<value です。

column の値が value 未満のレコードにマッチします。

column の型が Int32 などの数値型の場合、 column の値と value は数値として比較します。もし、 column の型が ShortText のような文字列型の場合は column の値と value はビット列として比較します。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

以下は簡単な使用例です。

実行例:

select Entries --query n_likes:<10
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 より小さいレコードにマッチします。

  大なり条件

構文は column:>value です。

column の値が value より大きいレコードにマッチします。

column の型が Int32 などの数値型の場合、 column の値と value は数値として比較します。もし、 column の型が ShortText のような文字列型の場合は column の値と value はビット列として比較します。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

以下は簡単な使用例です。

実行例:

select Entries --query n_likes:>10
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 より大きいレコードにマッチします。

  以下条件

構文は column:<=value です。

column の値が value 以下のレコードにマッチします。

column の型が Int32 などの数値型の場合、 column の値と value は数値として比較します。もし、 column の型が ShortText のような文字列型の場合は column の値と value はビット列として比較します。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

以下は簡単な使用例です。

実行例:

select Entries --query n_likes:<=10
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 以下のレコードにマッチします。

  以上条件

構文は column:>=value です。

column の値が value 以上のレコードにマッチします。

column の型が Int32 などの数値型の場合、 column の値と value は数値として比較します。もし、 column の型が ShortText のような文字列型の場合は column の値と value はビット列として比較します。

全文検索条件 や フレーズ検索条件 と異なり、デフォルトのマッチカラムは必要ありません。

以下は簡単な使用例です。

実行例:

select Entries --query n_likes:>=10
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 以上のレコードにマッチします。

  正規表現条件

バージョン 5.0.1 で追加.

構文は column:~pattern です。

column の値が pattern にマッチするレコードにマッチします。 pattern は正しい /reference/regular_expression でなければいけません。

以下の例はパターンとして .roonga を使っています。このパターンは Groonga 、 Mroonga といった文字列にマッチします。

実行例:

select Entries --query content:~.roonga
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

多くの場合、各レコードに対して順に正規表現を評価します。そのため、多くのレコードがある場合は遅くなるかもしれません。

いくつかのケースでは、Groongaはインデックスを使って正規表現を評価します。これはとても高速です。詳細は /reference/regular_expression を参照してください。

  結合式

以下は利用可能な結合式のリストです。

  論理和

構文は a OR b です。

a と b は条件式または結合式または代入式です。

a と b のうち少なくともひとつの式がマッチすれば a OR b はマッチします。

以下は簡単な使用例です。

実行例:

select Entries --query 'n_likes:>10 OR content:@senna'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 より大きいか content カラムの値に senna という単語を含んでいるレコードにマッチします。

  論理積

構文は a + b です。あるいは単に a b と書くこともできます。

a と b は条件式または結合式または代入式です。

a と b の両方にマッチすれば a + b はマッチします。

+a というように最初の式に + を指定することもできます。この場合は + は単に無視されます。

以下は簡単な使用例です。

実行例:

select Entries --query 'n_likes:>=10 + content:@groonga'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 以上で content カラムの値に groonga という単語を含むレコードにマッチします。

  論理否定

構文は a - b です。

a と b は条件式または結合式または代入式です。

a にマッチして b にマッチしなければ、 a - b はマッチします。

-a というように最初の式に - を指定することはできません。この場合は構文エラーになります。

以下は簡単な使用例です。

実行例:

select Entries --query 'n_likes:>=10 - content:@groonga'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 以上で content カラムの値に groonga という単語を含まないレコードにマッチします。

  グループ化

構文は (...) です。 ... は空白区切りの式のリストです。

(...) は1つ以上の式をグループ化します。グループ化された式は1つの式として処理されます。 a b OR c は a と b の両方がマッチするか、 c がマッチすれば式全体がマッチする、という意味になります。 a (b OR c) は a がマッチして b と c はどちらか一方がマッチすれば式全体がマッチする、という意味になります。

以下は簡単な使用例です。

実行例:

select Entries --query 'n_likes:<5 content:@senna OR content:@fast'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]
select Entries --query 'n_likes:<5 (content:@senna OR content:@fast)'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ]
#     ]
#   ]
# ]

最初の式はグループ化していません。この式は n_likes:<5 と content:@senna の両方がマッチするか content:@fast がマッチするレコードにマッチします。

2番目の式はグループ化しています。この式は n_likes:<5 にマッチして、 content:@senna と content:@fast は少なくともどちらか一方にマッチするレコードにマッチします。

  代入式

このセクションは高度なユーザー向けです。それは、代入式は /reference/commands/select の --query オプションではデフォルトでは無効になっているからです。代入式を有効にするには --query_flags オプションに ALLOW_COLUMN|ALLOW_UPDATE を指定してください。

クエリー構文における代入式にはいくつか制限があります。代入にはクエリー構文の代りに /reference/grn_expr/script_syntax を使ってください。

代入式の構文は1つだけです。 column:=value となります。

value は column に代入されます。 value は常にクエリー構文では文字列として扱われます。 value は column の型へと自動的にキャストされます。 キャストにはいくつか制限があります。例えば true や false といった真偽値のリテラルを Bool 型のカラムに使用することができません。 false については空文字列を使う必要がありますが、クエリー構文は column:= 構文をサポートしていません。

キャストについては /reference/cast を参照してください。

  スクリプト構文

スクリプト構文は複雑な検索条件を指定するための構文です。この構文はECMAScriptに似ています。例えば、 _key == "book" は _key の値が "book" のレコードを検索するという意味です。 query_syntax ではすべての値は文字列でしたが、スクリプト構文では値に型があります。例えば、 "book" は文字列で 1 は整数で、 TokenBigram は TokenBigram という名前のオブジェクトです。

スクリプト構文はECMAScriptの構文と完全に互換性があるわけではありません。例えば、 if 制御文や for 繰り返し文や変数定義文といった文をサポートしていません。関数定義もサポートしていません。しかし、独自の演算子を追加しています。独自の演算子はECMAScriptの構文を説明した後に説明します。

  セキュリティー

セキュリティーの観点からユーザーからの入力をそのままGroongaに渡すべきではありません。悪意のあるユーザーがそのユーザーには参照できてはいけないレコードを取得するクエリーを入力するかもしれないからです。

例えば、以下の状況を考えてみましょう。

あるGroongaアプリケーションがGroongaへのリクエストを次のようなプログラムで構築していたとします。:

filter = "column @ \"#{user_input}\""
select_options = {
  # ...
  :filter => filter,
}
groonga_client.select(select_options)

user_input はユーザーからの入力です。入力が query だった場合は構築された select-filter 引数は次のようになります。:

column @ "query"

もし、入力が x" || true || " だった場合は構築された select-filter 引数は次のようになります。:

column @ "x" || true || ""

このクエリーはすべてのレコードにマッチします。このユーザーはデータベース中のすべてのレコードを取得するでしょう。このユーザーには悪意があったのかもしれません。

ユーザーからの入力では値だけを受け取るようにする方がよいです。これは、ユーザーからの入力には @ や && のような演算子を受け付けないようにするということです。もし、演算子も受け付けるようにするなら、ユーザーは悪意のあるクエリーを作ることができます。

ユーザーの入力が値だけなら、入力された値をエスケープすることで悪意のあるクエリーを防ぐことができます。以下はユーザーの入力をどのようにエスケープすればよいかのリストです。

•   真の値： true に変換してください。

•   負の値： false に変換してください。

•   数値: 整数 または 浮動小数点数 に変換してください。例えば、 1.2 、 -10 、 314e-2 といった具合です。

•   文字列：文字列中の " を \" で、 \ を \\ で置換してください。その後、置換した文字列を " で囲んでください。例えば、 double " quote and back \ slash は "double \" quote and back \\ slash" に変換します。

  サンプルデータ

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Entries TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries n_likes COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{"_key":    "The first post!",
 "content": "Welcome! This is my first post!",
 "n_likes": 5},
{"_key":    "Groonga",
 "content": "I started to use Groonga. It's very fast!",
 "n_likes": 10},
{"_key":    "Mroonga",
 "content": "I also started to use Mroonga. It's also very fast! Really fast!",
 "n_likes": 15},
{"_key":    "Good-bye Senna",
 "content": "I migrated all Senna system!",
 "n_likes": 3},
{"_key":    "Good-bye Tritonn",
 "content": "I also migrated all Tritonn system!",
 "n_likes": 3}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]

ブログエントリ用の Entries テーブルがあります。各エントリはタイトルと内容と「いいね！」数を持っています。タイトルは Entries のキーとします。内容は Entries.content カラムの値とします。「いいね！」数は Entries.n_likes カラムの値とします。

Entries._key カラムと Entries.content カラムには TokenBigram トークナイザーを使ったインデックスを作成します。そのため、 Entries._key と Entries.content は両方とも全文検索できます。

これで例を示すためのスキーマとデータの準備ができました。

  リテラル

  整数

整数リテラルは 1234567890 のような 0 から 9 の並びです。 +29 や -29 のように符号として最初に + または - をつけることができます。整数リテラルは10進数です。8進数や16進数などは使えません。

整数リテラルの最大値は 9223372036854775807 （ = 2 ** 63 - 1 ）です。最小値は -9223372036854775808 （ = -(2 ** 63) ）です。

  浮動小数点数

浮動小数点数リテラルは 3.14 のように、まず 0 から 9 、次に . 、最後に 0 から 9 という並びです。 +3.14 や -3.14 のように符号として最初に + または - をつけることができます。 ${基数}e${指数} や ${基数}E${指数} というフォーマットもサポートしています。例えば、 314e-2 は 3.14 と同じです。

  文字列

文字列リテラルは "..." です。リテラル中の " は \" というように \ を前につけてエスケープします。例えば、 "Say \"Hello!\"." は Say "Hello!". という文字列のリテラルです。

文字列エンコーディングはデータベースのエンコーディングと合わせなければいけません。デフォルトのエンコーディングはUTF-8です。これは configure の --with-default-encoding オプションや /reference/executables/groonga の --encodiong などで変更できます。

  真偽値

真偽値のリテラルは true と false です。 true は真という意味で、 false は偽という意味です。

  NULL

NULLのリテラルは null です。GroongaはNULL値をサポートしてませんが、NULLリテラルをサポートしています。

  時間

注釈: これはgroonga独自の記法です。

時間のリテラルはありません。文字列での時間記法、整数での時間記法または浮動小数点数での時間記法を使ってください。

文字列での時間記法は "YYYY/MM/DD hh:mm:ss.uuuuuu" または "YYYY-MM-DD hh:mm:ss.uuuuuu" です。 YYYY は西暦、 MM は月、 DD は日、 hh は時、 mm は分、 ss は秒、 uuuuuu はマイクロ秒です。ローカル時間です。例えば、 "2012/07/23 02:41:10.436218" はISO 8601形式では 2012-07-23T02:41:10.436218 になります。

整数での時間記法はUTC時間で1970年1月1日0時0分0秒からの経過秒数を使います。この時間はPOSIX時間とも呼ばれています。例えば、 1343011270 はISO 8601形式では 2012-07-23T02:41:10Z になります。

浮動小数点数での時間記法はUTC時間で1970年1月1日0時0分0秒からの経過秒数と経過マイクロ秒数を使います。例えば、 1343011270.436218 はISO 8601形式では 2012-07-23T02:41:10.346218Z になります。

  座標値

注釈: これはgroonga独自の記法です。

座標値のリテラルはありません。文字列での座標値記法を使ってください。

文字列での座標値記法には以下のパターンがあります。

•   "ミリ秒表記の緯度xミリ秒表記の経度"

•   "ミリ秒表記の緯度,ミリ秒表記の経度"

•   "度数表記の緯度x度数表記の経度"

•   "度数表記の緯度,度数表記の経度"

    x と , のどちらも区切り文字として使えます。緯度と経度はミリ秒または度数で指定します。

  配列

配列リテラルは [element1, element2, ...] です。

  オブジェクトリテラル

オブジェクトのリテラルは {name1: value1, name2: value2, ...} です。groongaはまだオブジェクトリテラルをサポートしていません。

  制御構文

スクリプト構文は文をサポートしていません。そのため、 if のような制御文を使うことはできません。制御用の構文は A ? B : C 式だけ使うことができます。

A ? B : C は A が真なら B を返して、そうでなかったら C を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == (_id == 1 ? 5 : 3)'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は _id カラムの値が 1 で n_likes カラムの値が 5 または _id カラムの値が 1 ではなく n_likes カラムの値が 3 のレコードにマッチします。

  グループ化

構文は (...) です。 ... はカンマ区切りの式のリストです。

(...) は1つ以上の式をグループ化します。グループ化された式は1つの式として処理されます。 a && b || c は a と b の両方がマッチするか、 c がマッチすれば式全体がマッチする、という意味になります。 a && (b || c) は a がマッチして b と c はどちらか一方がマッチすれば式全体がマッチする、という意味になります。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes < 5 && content @ "senna" || content @ "fast"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]
select Entries --filter 'n_likes < 5 && (content @ "senna" || content @ "fast")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ]
#     ]
#   ]
# ]

最初の式はグループ化していません。この式は n_likes < 5 と content @ "senna" の両方がマッチするか content @ "fast" がマッチするレコードにマッチします。

2番目の式はグループ化しています。この式は n_likes < 5 にマッチして、 content @ "senna" と content @ "fast" は少なくともどちらか一方にマッチするレコードにマッチします。

  関数呼び出し

構文は name(arugment1, argument2, ...) です。

name(argument1, argument2, ...) は name という関数を引数 argument1, argument2, ... で呼び出します。

利用可能な関数の一覧は /reference/function を参照してください。

以下は簡単な使用例です。

実行例:

select Entries --filter 'edit_distance(_key, "Groonga") <= 1'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は /reference/functions/edit_distance を使っています。この式は _key カラムの値が "Groonga" に似ているレコードにマッチします。 "Groonga" との類似度は編集距離で計算します。編集距離が1文字以下なら似ているとします。この場合は "Groonga" と "Mroonga" が似ている値です。

  基本的な演算子

groongaはECMAScriptで定義されている演算子をサポートしています。

  算術演算子

以下は算術演算子の説明です。

  加算演算子

構文は number1 + number2 です。

この演算子は number1 と number2 を足した結果を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == 10 + 5'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 15 (= 10 + 5) のレコードにマッチします。

  減算演算子

構文は number1 - number2 です。

この演算子は number2 から number1 を引いた結果を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == 20 - 5'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 15 (= 20 - 5) のレコードにマッチします。

  乗算演算子

構文は number1 * number2 です。

この演算子は number1 と number2 を掛けた結果を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == 3 * 5'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 15 (= 3 * 5) のレコードにマッチします。

  除算演算子

構文は number1 / number2 と number1 % number2 です。

この演算子は number2 を number1 で割ります。 / は商を返します。 % は余りを返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == 26 / 7'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 3 (= 26 / 7) のレコードにマッチします。

実行例:

select Entries --filter 'n_likes == 26 % 7'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 (= 26 % 7) の値にマッチします。

  論理演算子

以下は論理演算子の説明です。

  論理否定演算子

構文は !condition です。

この演算子は condition の真偽値を反転します。

以下は簡単な使用例です。

実行例:

select Entries --filter '!(n_likes == 5)'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 ではない式にマッチします。

  論理積演算子

構文は condition1 && condition2 です。

この演算子は condition1 と condition2 の両方が真のときに真を返し、そうでなければ偽を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'content @ "fast" && n_likes >= 10'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は content カラムの値が fast を含んでいて、 n_likes カラムの値が 10 以上のレコードにマッチします。

  論理和演算子

構文は condition1 || condition2 です。

この演算子は condition1 と condition2 のどちらか一方が真のときに真を返し、そうでなければ偽を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == 5 || n_likes == 10'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 または 10 のレコードにマッチします。

  論理差演算子

構文は condition1 &! condition2 です。

この演算子は condition1 が真で condition2 が偽のときに真を返し、そうでなければ偽を返します。差集合を返すということです。

以下は簡単な使用例です。

実行例:

select Entries --filter 'content @ "fast" &! content @ "mroonga"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ]
#     ]
#   ]
# ]

この式は content カラムの値が fast を含んでいるが mroonga を含んでいないレコードにマッチします。

  ビット演算子

以下はビット演算子の説明です。

  ビット否定演算子

構文は ~number です。

この演算子は number の各ビットを反転した結果を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter '~n_likes == -6'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 のレコードにマッチします。なぜならば、 5 の各ビットを反転すると -6 になるからです。

  ビット論理積演算子

構文は number1 & number2 です。

この演算子は number1 と number2 をビット単位で論理積をした結果を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter '(n_likes & 1) == 1'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が偶数のレコードにマッチします。なぜならば、偶数と 1 のビット単位の論理積は 1 になり、奇数と 1 のビット単位の論理積は 0 になるからです。

  ビット論理和演算子

構文は number1 | number2 です。

この演算子は number1 と number2 をビット単位で論理和した結果を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == (1 | 4)'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 (= 1 | 4) のレコードにマッチします。

  ビット排他的論理和演算子

構文は number1 ^ number2 です。

この演算子は number1 と number2 をビット単位で排他的論理和した結果を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == (10 ^ 15)'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 (= 10 ^ 15) の値にマッチします。

  シフト演算子

以下はシフト演算子の説明です。

  左シフト演算子

構文は number1 << number2 です。

この演算子は number1 のビットを左に number2 ビットシフトする。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == (5 << 1)'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 10 (= 5 << 1) のレコードにマッチします。

  符号付き右シフト演算子

構文は number1 >> number2 です。

この演算子は number1 のビットを右に number2 ビットシフトします。結果の符号は number1 の符号と同じです。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == -(-10 >> 1)'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 (= -(-10 >> 1) = -(-5)) のレコードにマッチします。

  符号なし右シフト演算子

構文は number1 >>> number2 です。

この演算子は number1 のビットを右に number2 ビットシフトします。一番左の number2 ビットには 0 が入ります。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == (2147483648 - (-10 >>> 1))'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 (= 2147483648 - (-10 >>> 1) = 2147483648 - 2147483643) のレコードにマッチします。

  比較演算子

以下は比較演算子の説明です。

  等価演算子

構文は object1 == object2 です。

この演算子は object1 が object2 と等しいときは真を返し、そうでなければ偽を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes == 5'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         1,
#         "The first post!",
#         "Welcome! This is my first post!",
#         5
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 の値にマッチします。

  不等価演算子

構文は object1 != object2 です。

この演算子は object1 が object2 と等しくないときに真を返し、そうでなければ偽を返します。

以下は簡単な使用例です。

実行例:

select Entries --filter 'n_likes != 5'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         4,
#         "Good-bye Senna",
#         "I migrated all Senna system!",
#         3
#       ],
#       [
#         5,
#         "Good-bye Tritonn",
#         "I also migrated all Tritonn system!",
#         3
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

この式は n_likes カラムの値が 5 ではない式にマッチします。

  小なり演算子

TODO: ...

  以下演算子

TODO: ...

  大なり演算子

TODO: ...

  以上演算子

TODO: ...

  代入演算子

  加算代入演算子

構文は column += value です。

この演算子は column1 に column2 を加算代入します。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score += n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         4
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         4
#       ],
#       [
#         "Groonga",
#         10,
#         11
#       ],
#       [
#         "Mroonga",
#         15,
#         16
#       ],
#       [
#         "The first post!",
#         5,
#         6
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score + n_likes' という加算代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Good-bye Senna"を格納しているレコードの _score の値は3です。

そのため、 1 + 3 という式が評価されてから _score カラムへと演算結果が保存されます。

  減算代入演算子

構文は column1 -= column2 です。

この演算子は column1 から column2 を減算代入します。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score -= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         -2
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         -2
#       ],
#       [
#         "Groonga",
#         10,
#         -9
#       ],
#       [
#         "Mroonga",
#         15,
#         -14
#       ],
#       [
#         "The first post!",
#         5,
#         -4
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score - n_likes' という減算代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Good-bye Senna"を格納しているレコードの _score の値は3です。

そのため、 1 - 3 という式が評価されてから _score カラムへと演算結果が保存されます。

  乗算代入演算子

構文は column1 *= column2 です。

この演算子は column1 に column2 を乗算演算する。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score *= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         3
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         3
#       ],
#       [
#         "Groonga",
#         10,
#         10
#       ],
#       [
#         "Mroonga",
#         15,
#         15
#       ],
#       [
#         "The first post!",
#         5,
#         5
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score * n_likes' という乗算代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Good-bye Senna"を格納しているレコードの _score の値は3です。

そのため、 1 * 3 という式が評価されてから _score カラムへと演算結果が保存されます。

  除算代入演算子

構文は column1 /= column2 です。

この演算子は column1 に column2 を除算代入します。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score /= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         0
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         0
#       ],
#       [
#         "Groonga",
#         10,
#         0
#       ],
#       [
#         "Mroonga",
#         15,
#         0
#       ],
#       [
#         "The first post!",
#         5,
#         0
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score / n_likes' という除算代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Good-bye Senna"を格納しているレコードの _score の値は3です。

そのため、 1 / 3 という式が評価されてから _score カラムへと演算結果が保存されます。

  剰余代入演算子

構文は column1 %= column2 です。

この演算子は column1 に column2 を剰余代入します。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score %= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         1
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         1
#       ],
#       [
#         "Groonga",
#         10,
#         1
#       ],
#       [
#         "Mroonga",
#         15,
#         1
#       ],
#       [
#         "The first post!",
#         5,
#         1
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score % n_likes' という除算代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Good-bye Senna"を格納しているレコードの _score の値は3です。

そのため、 1 % 3 という式が評価されてから _score カラムへと演算結果が保存されます。

  左シフト代入演算子

構文は column1 << column2 です。

この演算子は column1 のビットを左に column2 左ビットシフト代入演算します。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score <<= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         8
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         8
#       ],
#       [
#         "Groonga",
#         10,
#         1024
#       ],
#       [
#         "Mroonga",
#         15,
#         32768
#       ],
#       [
#         "The first post!",
#         5,
#         32
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score << n_likes' という左ビットシフト代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Good-bye Senna"を格納しているレコードの _score の値は3です。

そのため、 1 << 3 という式が評価されてから _score カラムへと演算結果が保存されます。

  符号あり右シフト代入演算子

構文は column1 >>= column2 です。

この演算子は column1 のビットを column2 右ビットシフト代入演算します。

  符号なし右シフト代入演算子

構文は column1 >>>= column2 です。

この演算子は column1 のビットを column2 符号なし右ビットシフト代入演算します。

  ビット論理積代入演算子

構文は column1 &= column2 です。

この演算子は column1 に column2 をビット論理積代入演算します。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score &= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         1
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         1
#       ],
#       [
#         "Groonga",
#         10,
#         0
#       ],
#       [
#         "Mroonga",
#         15,
#         1
#       ],
#       [
#         "The first post!",
#         5,
#         1
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score & n_likes' というビット論理積代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Groonga"を格納しているレコードの値は10です。

そのため、 1 & 10 という式が評価されてから _score カラムへと演算結果が保存されます。

  ビット論理和代入演算子

構文は column1 |= column2 です。

この演算子は column1 に column2 をビット論理和代入演算する。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score |= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         3
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         3
#       ],
#       [
#         "Groonga",
#         10,
#         11
#       ],
#       [
#         "Mroonga",
#         15,
#         15
#       ],
#       [
#         "The first post!",
#         5,
#         5
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score | n_likes' というビット論理和代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Groonga"を格納しているレコードの値は10です。

そのため、 1 | 10 という式が評価されてから _score カラムへと演算結果が保存されます。

  ビット排他的論理和代入演算子

構文は column1 ^= column2 です。

この演算子は column1 に column2 をビット論理和代入演算する。

実行例:

select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score ^= n_likes'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Good-bye Senna",
#         3,
#         2
#       ],
#       [
#         "Good-bye Tritonn",
#         3,
#         2
#       ],
#       [
#         "Groonga",
#         10,
#         11
#       ],
#       [
#         "Mroonga",
#         15,
#         14
#       ],
#       [
#         "The first post!",
#         5,
#         4
#       ]
#     ]
#   ]
# ]

--filter による _score の値はこの場合は常に1です。その後、'_score = _score ^ n_likes' という減算代入演算をそれぞれのレコードへ適用します。

例えば、 _key として"Good-bye Senna"を格納しているレコードの _score の値は3です。

そのため、 1 ^ 3 という式が評価されてから _score カラムへと演算結果が保存されます。

  独自の演算子

スクリプト構文はECMAScriptの構文に独自の二項演算子を追加しています。これらは検索に特化した操作をします。演算子の最初の文字は @ または * です。

  マッチ演算子

構文は column @ value です。

この演算子は column の転置インデックスを使って value を検索します。普通は全文検索をしますが、タグ検索もできます。これは、タグ検索も転置インデックスを使って実現しているからです。

query_syntax はデフォルトでこの演算子を使っています。

以下は簡単な使用例です。

実行例:

select Entries --filter 'content @ "fast"' --output_columns content
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "content",
#           "Text"
#         ]
#       ],
#       [
#         "I started to use Groonga. It's very fast!"
#       ],
#       [
#         "I also started to use Mroonga. It's also very fast! Really fast!"
#       ]
#     ]
#   ]
# ]

この式は content カラムの値に fast という単語を含んでいるレコードにマッチします。

  前方一致検索演算子

構文は column @^ value です。

この条件式は value で前方一致検索します。前方一致検索は value で始まる単語を含むレコードを検索します。

カラムの値を高速に前方一致検索できます。ただし、そのカラムにはインデックスを作成し、そのインデックス用のテーブルをパトリシアトライ（ TABLE_PAT_KEY ）またはダブル配列トライ（ TABLE_DAT_KEY ）にしなければいけません。あるいは、パトリシアトライテーブルまたはダブル配列テーブルの _key も高速に前方一致検索できます。 _key にインデックスを作成する必要はありません。

他の種類のテーブルでも前方一致検索を使えますがレコード全件を処理します。レコード数が少ない場合には問題ありませんが、レコード数が多いと時間がかかります。

以下は簡単な使用例です。

実行例:

select Entries --filter '_key @^ "Goo"' --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "Good-bye Tritonn"
#       ],
#       [
#         "Good-bye Senna"
#       ]
#     ]
#   ]
# ]

この式は _key カラムの値が Goo で始まる単語を含むレコードにマッチします。この式には Good-bye Senna と Good-bye Tritonn がマッチします。

  後方一致検索演算子

構文は column @$ value です。

この演算子は value で後方一致検索します。後方一致検索は value で終わる単語を含むレコードを検索します。

カラムの値を高速に後方一致検索できます。ただし、そのカラムにはインデックスを作成し、そのインデックス用のテーブルを KEY_WITH_SIS フラグ付きのパトリシアトライテーブル（ TABLE_PAT_KEY ）にしなければいけません。 KEY_WITH_SIS フラグ付きのパトリシアトライテーブル（ TABLE_PAT_KEY ）の _key 擬似カラムの値も高速に後方一致検索できます。 _key にはインデックスを作成する必要はありません。 _key ベースの高速な後方一致検索よりもカラムベースの高速な後方一致検索を使うことをおすすめします。 _key ベースの高速な後方一致検索は自動的に登録された部分文字列も返ってきます。（TODO: 後方一致検索に関するドキュメントを書いてここからリンクを張る。）

注釈: 高速な後方一致検索は日本語のひらがななど非ASCII文字にしか使えません。ASCII文字には高速な後方一致検索を使えません。

後方一致検索は他の種類のテーブルもしくはパトリシアトライを KEY_WITH_SIS フラグなしで使用しているテーブルに対しても使えますが、レコード全件を処理します。レコード数が少ない場合には問題ありませんが、レコード数が多いと時間がかかります。

簡単な例です。ASCII文字ではない文字である日本語のひらがなに対して高速な後方一致検索をしています。

実行例:

table_create Titles TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Titles content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create SuffixSearchTerms TABLE_PAT_KEY|KEY_WITH_SIS ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create SuffixSearchTerms index COLUMN_INDEX Titles content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Titles
[
{"content": "ぐるんが"},
{"content": "むるんが"},
{"content": "せな"},
{"content": "とりとん"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
select Titles --query 'content:$んが'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "content",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "むるんが"
#       ],
#       [
#         1,
#         "ぐるんが"
#       ]
#     ]
#   ]
# ]

この式は content カラムの値が んが で終わるレコードにマッチします。この場合は ぐるんが と むるんが にマッチします。

  近傍検索演算子

構文は column *N "word1 word2 ..." です。

この演算子は word1 word2 ... という単語で近傍検索します。近傍検索はすべての単語が含まれていてかつそれぞれの単語が近くにあるレコードを検索します。距離が 10 以内の近さであれば近くにあると判断します。今のところ、この値は変更できません。距離の単位はN-gram系のトークナイザーでは文字数で、形態素解析系のトークナイザーでは単語数です。

（TODO: TokenBigram はASCIIだけの単語はトークンに分割しないという説明を追加すること。このため、 TokenBigram はN-gram系のトークナイザーだけどASCIIだけの単語を扱う時の単位は単語数になる。）

column 用の全文検索用インデックスカラムを定義しておく必要があることに注意してください。

以下は簡単な使用例です。

実行例:

select Entries --filter 'content *N "I fast"'      --output_columns content
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "content",
#           "Text"
#         ]
#       ],
#       [
#         "I started to use Groonga. It's very fast!"
#       ]
#     ]
#   ]
# ]
select Entries --filter 'content *N "I Really"'    --output_columns content
# [[0, 1337566253.89858, 0.000355720520019531], [[[0], [["content", "Text"]]]]]
select Entries --filter 'content *N "also Really"' --output_columns content
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "content",
#           "Text"
#         ]
#       ],
#       [
#         "I also started to use Mroonga. It's also very fast! Really fast!"
#       ]
#     ]
#   ]
# ]

最初の式は I と fast が含まれていて、かつ、これらの単語が10単語以内近くにあるレコードにマッチします。そのため I also started to use mroonga. It's also very fast! ... にマッチします。 I と fast の間の単語数はちょうど10です。

二番目の式は I と Really が含まれていて、かつ、これらの単語が10単語以内近くにあるレコードにマッチします。そのため、 I also st arted to use mroonga. It's also very fast! Really fast! はマッチしません。 I と Really の間の単語数は11です。

三番目の式は also と Really が含まれていて、かつ、これらの単語が10単語以内近くにあるレコードにマッチします。そのため、 I also started to use mroonga. It's also very fast! Really fast! にマッチします。 also と Really の間の単語数は10です。

  類似文書検索

構文は column *S "document" です。

この演算子は document という文書で類似文書検索します。類似文書検索は document と似た内容を持つレコードを検索します。

column 用の全文検索用インデックスカラムを定義しておく必要があることに注意してください。

以下は簡単な使用例です。

実行例:

select Entries --filter 'content *S "I migrated all Solr system!"' --output_columns content
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "content",
#           "Text"
#         ]
#       ],
#       [
#         "I migrated all Senna system!"
#       ],
#       [
#         "I also migrated all Tritonn system!"
#       ]
#     ]
#   ]
# ]

この式は I migrated all Solr system! と似た内容を持つレコードを検索します。この場合は、 I migrated all XXX system! という内容のレコードがマッチします。

  単語抽出演算子

構文は _key *T "document" です。

この演算子は document から単語を抽出します。単語は _key のテーブルのキーとして登録されていなければいけません。

テーブルはパトリシアトライ（ TABLE_PAT_KEY ）またはダブル配列トライ（ TABLE_DAT_KEY ）でなければいけません。ハッシュテーブル（ TABLE_HASH_KEY ）や配列（ TABLE_NO_KEY ）は最長共通接頭辞検索（Longest Common Prefix Search）できないため使えません。この演算子は最長共通接頭辞検索を使っています。

以下は簡単な使用例です。

実行例:

table_create Words TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Words
[
{"_key": "groonga"},
{"_key": "mroonga"},
{"_key": "Senna"},
{"_key": "Tritonn"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
select Words --filter '_key *T "Groonga is the successor project to Senna."' --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "groonga"
#       ],
#       [
#         "senna"
#       ]
#     ]
#   ]
# ]

この式は文書 Groonga is the successor project to Senna. に含まれている単語を抽出します。今回は Words に NormalizerAuto ノーマライザーが指定されています。そのため、 Words には groonga とロードしていますが Groonga も抽出できています。また、すべてての抽出された単語も正規化されています。

  正規表現演算子

バージョン 5.0.1 で追加.

構文は column @~ "pattern" です。

この演算子は正規表現 pattern でレコードを検索します。もし、レコードの column の値が pattern にマッチしたら、そのレコードはマッチしたということです。

pattern は正規表現の構文になっていなければいけません。正規表現の構文の詳細は /reference/regular_expression を参照してください。

以下の例はパターンとして .roonga を使っています。このパターンは Groonga 、 Mroonga といった文字列にマッチします。

実行例:

select Entries --filter 'content @~ ".roonga"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "content",
#           "Text"
#         ],
#         [
#           "n_likes",
#           "UInt32"
#         ]
#       ],
#       [
#         2,
#         "Groonga",
#         "I started to use Groonga. It's very fast!",
#         10
#       ],
#       [
#         3,
#         "Mroonga",
#         "I also started to use Mroonga. It's also very fast! Really fast!",
#         15
#       ]
#     ]
#   ]
# ]

多くの場合、各レコードに対して順に正規表現を評価します。そのため、多くのレコードがある場合は遅くなるかもしれません。

いくつかのケースでは、Groongaはインデックスを使って正規表現を評価します。これはとても高速です。詳細は /reference/regular_expression を参照してください。

  参考

•   /reference/api/grn_expr: grn_expr関連のAPI

  正規表現

  概要

注釈: 正規表現は実験的な機能です。

バージョン 5.0.1 で追加.

Groongaは正規表現を用いたパターンマッチをサポートしています。正規表現はパターンを表現するために広く使われています。正規表現は複雑なパターンを表現するときに便利です。

多くの場合は、正規表現検索は逐次検索で実行します。これはたくさんのレコードがあったり、たくさんのテキストがある場合は遅くなります。

いくつかの場合では、正規表現を使ったパターンマッチをインデックスを使って実現します。これは逐次検索よりも非常に高速です。インデックスを使って評価できるパターンについては後述します。

バージョン 5.0.7 で追加: Groongaは正規表現検索にインデックスを使わないときは、 normalizer-auto ノーマライザーでマッチ対象のテキストを正規化します。これは、 Groonga というような大文字を使った正規表現は必ずマッチに失敗するということです。なぜなら、 normalizer-auto ノーマライザーはすべてのアルファベットを小文字に正規化するからです。 groonga は Groonga にも groonga にも両方にマッチします。

なぜマッチ対象のテキストを正規化するのでしょうか？それは、インデックスを使って検索できるパターンを増やすためです。もし、Groongaがマッチ対象のテキストを正規化しなかった場合、大文字小文字を区別しないマッチをするために、 [Dd][Ii][Ss][Kk] や (?i)disk のような複雑な正規表現を書く必要があります。Groongaは複雑な正規表現に対してインデックスを使うことができません。

もし、大文字小文字を区別しないマッチに disk という正規表現を使うなら、Groongaはインデックスを使ってこのパターンを検索できます。これは高速です。

この挙動を奇妙に思うかもしれません。しかし、この挙動のおかげで高速に検索できることはきっとあなたの役に立つはずです。

正規表現の構文はたくさんあります。GroongaはRubyと同じ構文を使います。なぜなら、Groongaが使っている正規表現エンジンはRubyが使っている正規表現エンジンと同じだからです。この正規表現エンジンは Onigmo といいます。他の正規表現の構文との特徴的な違いは ^ と $ です。Rubyの正規表現の構文では ^ は行頭を表し、 $ は行末を表します。他の多くの正規表現の構文では、 ^ はテキストの先頭を表し、 $ はテキストの最後を表します。Rubyの正規表現の構文ではテキストの先頭を表す場合は \A を使い、テキストの最後を表す場合は \z を使います。

バージョン 5.0.6 で追加: Groongaは5.0.6からマルチラインモードを有効にしています。これは、 . が \n にマッチするということです。

しかし、この挙動は意味がありません。なぜなら、 \n は normalizer-auto ノーマライザーが削除するからです。

/reference/commands/select コマンドの select-query オプションと select-filter オプションで正規表現を使えます。

  使い方

以下は使い方を説明するためのスキーマ定義とサンプルデータです。このスキーマにはテーブルは1つだけです。 Logs というテーブルです。 Logs テーブルは1つだけカラムを持ちます。 message というカラムです。ログメッセージは message カラムに保存されています。

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs message COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Logs
[
{"message": "host1:[error]: No memory"},
{"message": "host1:[warning]: Remained disk space is less than 30%"},
{"message": "host1:[error]: Disk full"},
{"message": "host2:[error]: No memory"},
{"message": "host2:[info]: Shutdown"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]

select-query で正規表現を使う例です。 ${COLUMN}:~${REGULAR_EXPRESSION} という構文を使います。

実行例:

select Logs --query 'message:~"disk (space|full)"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "message",
#           "Text"
#         ]
#       ],
#       [
#         2,
#         "host1:[warning]: Remained disk space is less than 30%"
#       ],
#       [
#         3,
#         "host1:[error]: Disk full"
#       ]
#     ]
#   ]
# ]

select-filter で正規表現を使う例です。 ${COLUMN} @~ ${REGULAR_EXPRESSION} という構文を使います。

実行例:

select Logs --filter 'message @~ "disk (space|full)"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "message",
#           "Text"
#         ]
#       ],
#       [
#         2,
#         "host1:[warning]: Remained disk space is less than 30%"
#       ],
#       [
#         3,
#         "host1:[error]: Disk full"
#       ]
#     ]
#   ]
# ]

  インデックス

Groongaは正規表現を使った検索をインデックスを使って実現することができます。これは逐次検索より非常に高速です。

しかし、すべての正規表現には対応していません。以下の正規表現にのみ対応しています。対応している正規表現は今後増えていく予定です。

•   disk のようにリテラルしかないパターン

•   \A/disk のようにテキストの最初でのマッチとリテラルのみのケース

•   disk\z のようにテキストの最後でのマッチとリテラルのみのケース

    高速に正規表現検索を実現するためにはインデックスを作る必要があります。以下は正規表現用のインデックスが満たさなければいけないことのリストです。

•   語彙表は table-pat-key テーブルであること。

•   語彙表は token-regexp トークナイザーを使っていること。

•   インデックスカラムは WITH_POSITION フラグ付きであること。

    語彙表のノーマライザーといった他の設定は用途に応じて適切なものを設定してください。もし、大文字小文字を区別せずに検索したい場合は normalizer-auto ノーマライザーを使ってください。

    以下はオススメのインデックス定義です。多くの場合はこのインデックス定義が適切です。

    実行例:

    table_create RegexpLexicon TABLE_PAT_KEY ShortText \
      --default_tokenizer TokenRegexp \
      --normalizer NormalizerAuto
    # [[0, 1337566253.89858, 0.000355720520019531], true]
    column_create RegexpLexicon logs_message_index \
      COLUMN_INDEX|WITH_POSITION Logs message
    # [[0, 1337566253.89858, 0.000355720520019531], true]

    これでインデックスを使って正規表現検索をできるようになりました。以下の正規表現は「テキストの先頭」と「リテラル」しか使っていないのでインデックスを使って検索できます。

    実行例:

    select Logs --query message:~\\\\Ahost1
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         3
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "message",
    #           "Text"
    #         ]
    #       ],
    #       [
    #         1,
    #         "host1:[error]: No memory"
    #       ],
    #       [
    #         2,
    #         "host1:[warning]: Remained disk space is less than 30%"
    #       ],
    #       [
    #         3,
    #         "host1:[error]: Disk full"
    #       ]
    #     ]
    #   ]
    # ]

    以下は select-query の代わりに select-filter を使った例です。前の例と同じ正規表現を使っています。

    実行例:

    select Logs --filter 'message @~ "\\\\Ahost1:"'
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         3
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "message",
    #           "Text"
    #         ]
    #       ],
    #       [
    #         1,
    #         "host1:[error]: No memory"
    #       ],
    #       [
    #         2,
    #         "host1:[warning]: Remained disk space is less than 30%"
    #       ],
    #       [
    #         3,
    #         "host1:[error]: Disk full"
    #       ]
    #     ]
    #   ]
    # ]

    \ エスケープは紛らわしいかもしれません。あなたが書いたクエリーをGroongaが実行するまでにエスケープが必要なステップがいくつもあるからです。以下は \ エスケープが必要なステップです。

•   シェル。ただし、次のようにGroongaのコマンドをコマンドラインで指定した場合のみ:

    % groonga /tmp/db select Logs --filter '"message @~ \"\\\\Ahost1:"\"'

    --filter '"message @~ \"\\\\Ahost1:\""' はシェルが評価して次の2つの引数になります。

•   --filter

•   "message @~ \"\\\\Ahost1:\""

•   Groongaコマンドパーサー。ただし、GroongaのコマンドをHTTPパススタイル （ /d/COMMAND?ARG1_NAME=ARG1_VALUE&ARG2_NAME=ARG3_VALUE ） ではなく、コマンドラインスタイル （ COMMAND ARG1_VALUE ARG2_VALUE ... ）で指定した場合のみ。

    "message @~ \"\\\\Ahost1:\"" はGroongaコマンドパーサーが評価して次の値になります。

•   message @~ "\\Ahost1:"

•   /reference/grn_expr パーサー。 /reference/grn_expr/query_syntax でも /reference/grn_expr/script_syntax でも \ エスケープが必要です。

    スクリプト構文で "\\Ahost1:" という文字列リテラルを評価すると次の値になります。

•   \Ahost1

    この値が正規表現として評価されます。

  構文

このセクションでは広く使われている構文だけ説明します。他の構文と詳細は Onigmoの構文ドキュメント を参照してください。

  エスケープ

正規表現で特別な文字は次の通りです。

•   \

•   |

•   (

•   )

•   [

•   ]

•   .

•   *

•   +

•   ?

•   {

•   }

•   ^

•   $

    これらの特別な文字そのものにマッチするパターンを書きたいときはこれらの文字をエスケープする必要があります。

    特別な文字の前に \ を入れることでエスケープできます。以下は特別な文字そのものにマッチする正規表現です。

•   \\

•   \|

•   \(

•   \)

•   \[

•   \]

•   \.

•   \*

•   \+

•   \?

•   \{

•   \}

•   \^

•   \$

    実行例:

    select Logs --filter 'message @~ "warning|info"'
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "message",
    #           "Text"
    #         ]
    #       ],
    #       [
    #         2,
    #         "host1:[warning]: Remained disk space is less than 30%"
    #       ],
    #       [
    #         5,
    #         "host2:[info]: Shutdown"
    #       ]
    #     ]
    #   ]
    # ]

    正規表現が期待した通りに動かないときはエスケープ無しで特別な文字が使われていないか確認してください。

  選択

選択の構文は A|B です。 A パターンまたは B パターンにマッチするとこの正規表現にマッチしたことになります。

実行例:

select Logs --filter 'message @~ "warning|info"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "message",
#           "Text"
#         ]
#       ],
#       [
#         2,
#         "host1:[warning]: Remained disk space is less than 30%"
#       ],
#       [
#         5,
#         "host2:[info]: Shutdown"
#       ]
#     ]
#   ]
# ]

ご用心: この構文を使った正規表現はインデックスを使って評価できません。

  グループ

グループの構文は (...) です。グループは次の機能を提供します。

•   後方参照

•   スケープの限定

    マッチしたグループを \n （ n はグループの番号とする） という構文で参照できます。例えば、 e(r)\1o\1 は error にマッチします。なぜなら、 \1 は1番目ののグループ (r) のマッチ結果（ r ）に置き換えられるからです。

    実行例:

    select Logs --filter 'message @~ "e(r)\\\\1o\\\\1"'
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         3
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "message",
    #           "Text"
    #         ]
    #       ],
    #       [
    #         1,
    #         "host1:[error]: No memory"
    #       ],
    #       [
    #         3,
    #         "host1:[error]: Disk full"
    #       ],
    #       [
    #         4,
    #         "host2:[error]: No memory"
    #       ]
    #     ]
    #   ]
    # ]

    より強力な後方参照機能を使うこともできます。詳細は Onigmoのドキュメントの「8. 後方参照」セクション を参照してください。

    グループ構文はスコープを小さくします。例えば、 \[(warning|info)\] は選択構文のスコープを小さくしています。この正規表現は [warning] と [info] にマッチします。

    実行例:

    select Logs --filter 'message @~ "\\\\[(warning|info)\\\\]"'
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         2
    #       ],
    #       [
    #         [
    #           "_id",
    #           "UInt32"
    #         ],
    #         [
    #           "message",
    #           "Text"
    #         ]
    #       ],
    #       [
    #         2,
    #         "host1:[warning]: Remained disk space is less than 30%"
    #       ],
    #       [
    #         5,
    #         "host2:[info]: Shutdown"
    #       ]
    #     ]
    #   ]
    # ]

    より強力なグループ関連の機能を使うこともできます。詳細は Onigmoのドキュメントの「7. 拡張式集合」セクション を参照してください。

    ご用心: この構文を使った正規表現はインデックスを使って評価できません。

  文字クラス

文字クラスの構文は [...] です。文字クラスはマッチする文字を複数指定するときに便利です。

たとえば、 [12] は 1 または 2 にマッチします。

実行例:

select Logs --filter 'message @~ "host[12]"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "message",
#           "Text"
#         ]
#       ],
#       [
#         1,
#         "host1:[error]: No memory"
#       ],
#       [
#         2,
#         "host1:[warning]: Remained disk space is less than 30%"
#       ],
#       [
#         3,
#         "host1:[error]: Disk full"
#       ],
#       [
#         4,
#         "host2:[error]: No memory"
#       ],
#       [
#         5,
#         "host2:[info]: Shutdown"
#       ]
#     ]
#   ]
# ]

範囲で文字を指定することもできます。たとえば、 [0-9] は1文字の数字にマッチします。

実行例:

select Logs --filter 'message @~ "[0-9][0-9]%"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "message",
#           "Text"
#         ]
#       ],
#       [
#         2,
#         "host1:[warning]: Remained disk space is less than 30%"
#       ]
#     ]
#   ]
# ]

より強力な文字クラス関連の機能も使うことができます。詳細は Onigmoのドキュメントの「6. 文字集合」セクション を参照してください。

ご用心: この構文を使った正規表現はインデックスを使って評価できません。

  アンカー

以下はよく使われるアンカーの構文です。いくつかのアンカーはインデックスを使って評価できます。
アンカー | 説明 | インデックスを使えるか
^ | 行頭 | o
$ | 行末 | x
\A | テキストの先頭 | o
\z | テキストの末尾 | x

以下は \z を使った例です。

実行例:

select Logs --filter 'message @~ "%\\\\z"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "message",
#           "Text"
#         ]
#       ],
#       [
#         2,
#         "host1:[warning]: Remained disk space is less than 30%"
#       ]
#     ]
#   ]
# ]

他にも使えるアンカーがあります。詳細は Onigmoのドキュメントの「5. 錨」セクション を参照してください。

ご用心: \A と \z 以外のアンカーを使った正規表現はインデックスを使って評価できません。

  量指定子

以下はよく使われる量指定子の構文です。
量指定子 | 説明
? | 0回か1回
* | 0回以上
+ | 1回以上

例えば、 er+or は error 、 errror などにマッチします。

実行例:

select Logs --filter 'message @~ "er+or"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "message",
#           "Text"
#         ]
#       ],
#       [
#         1,
#         "host1:[error]: No memory"
#       ],
#       [
#         3,
#         "host1:[error]: Disk full"
#       ],
#       [
#         4,
#         "host2:[error]: No memory"
#       ]
#     ]
#   ]
# ]

他の量指定子を使うこともできます。詳細は Onigmoのドキュメントの「4. 量指定子」セクション を参照してください。

ご用心: この構文を使った正規表現はインデックスを使って評価できません。

  その他

他にも構文があります。それらに興味がある場合は Onigmoのドキュメント を参照してください。「文字種」や「文字」の構文に興味があるかもしれません。

  関数

関数はいくつかのコマンドの中で使えます。 commands/select コマンドの --filter 、 --scorer 、 output_columns オプションで使えます。

このセクションでは関数についての説明と組み込みの関数について説明します。

TODO: Add documentations about function.

  between

  概要

between は、指定された値が指定された範囲にあるかをチェックするために使われます。これは /reference/commands/select の select-filter オプションと組み合わせてよく使われます。

  構文

between には引数が5つあります。

between(column_or_value, min, min_border, max, max_border)

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users age COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Ages TABLE_HASH_KEY Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Ages user_age COLUMN_INDEX Users age
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "Alice",  "age": 12},
{"_key": "Bob",    "age": 13},
{"_key": "Calros", "age": 15},
{"_key": "Dave",   "age": 16},
{"_key": "Eric",   "age": 20}
{"_key": "Frank",  "age": 21}
]
# [[0, 1337566253.89858, 0.000355720520019531], 6]

これはPG-13 (MPAA)のレーティングに該当する人を示すクエリです。

実行例:

select Users --filter 'between(age, 13, "include", 16, "include")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "age",
#           "Int32"
#         ]
#       ],
#       [
#         2,
#         "Bob",
#         13
#       ],
#       [
#         3,
#         "Calros",
#         15
#       ],
#       [
#         4,
#         "Dave",
#         16
#       ]
#     ]
#   ]
# ]

13から16歳までのユーザーを返します。

between 関数はテーブルのカラムだけでなく、値も受け付けます。

最初の引数に値を指定した場合、その値が含まれているか否かをチェックします。もし、指定した範囲にマッチしたら、( between 関数がtrueを返すので)すべてのレコードを返します。

もし、指定した範囲にマッチしなかった場合、( between 関数がfalseを返すので)1件もレコードを返しません。

実行例:

select Users --filter 'between(14, 13, "include", 16, "include")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         6
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "age",
#           "Int32"
#         ]
#       ],
#       [
#         1,
#         "Alice",
#         12
#       ],
#       [
#         2,
#         "Bob",
#         13
#       ],
#       [
#         3,
#         "Calros",
#         15
#       ],
#       [
#         4,
#         "Dave",
#         16
#       ],
#       [
#         5,
#         "Eric",
#         20
#       ],
#       [
#         6,
#         "Frank",
#         21
#       ]
#     ]
#   ]
# ]

上記の例では、すべてのレコードを返します。これは、14は指定した範囲である13から16の間にあるからです。この振舞いは指定した値がテーブルに存在するかどうかの確認に使えます。

  引数

引数は5つあります。 column_or_value と min と min_border と max と max_border です。

  column_or_value

テーブルのカラムもしくは値を指定します。

  min

範囲のうち最小値を指定します。値 min が含まれるかどうかは min_border 引数で制御することができます。

  min_border

min の値を含めた範囲となるかどうかを指定します。 min_border に指定できるのは "include" または "exclude" のどちらかです。 "include" を指定すれば、min が含まれます。 "exclude" を指定すれば min は含まれません。

  max

範囲のうち最大値を指定します。値 max が含まれるかどうかは max_border 引数で制御することができます。

  max_border

man の値を含めた範囲となるかどうかを指定します。 max_border に指定できるのは "include" または "exclude" のどちらかです。 "include" を指定すれば、max が含まれます。 "exclude" を指定すれば max は含まれません。

  戻り値

between は指定した範囲にカラムの値が含まれるかを返します。もし該当するレコードがあれば、 true を返します。そうでなければ false を返します。

  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 は二点間の距離を計算します。

  構文

geo_distance は二つの点を指定します。引数 approximate_type は省略可能です。

geo_distance(point1, point2)
geo_distance(point1, point2, approximate_type)

approximate_type のデフォルト値は "rectangle" です。 approximate_type を省略した場合、 geo_distance は二点間の距離を "rectangle" が指定されたものとして計算します。

  使い方

geo_distance はGroongaの組み込み関数の一つです。

組み込み関数を /reference/grn_expr にて使うことができます。

geo_distance 関数は point1 と point2 の座標値から二点間の距離(近似値)を計算します。

注釈: Groongaは三つの組み込み関数を距離の計算のために提供しています。 geo_distance() 、 geo_distance2() 、 geo_distance3() です。これらの違いは距離の計算アルゴリズムにあります。 geo_distance2() と geo_distance3() はバージョン1.2.9より非推奨となりました。 geo_distance2(point1, point2) の代りに geo_distance(point1, point2, "sphere") を使用してください。 geo_distance3(point1, point2) の代りに geo_distance(point1, point2, "ellipsoid") を使用してください。

例とともに geo_distance について学びましょう。このセクションでは簡単な例を示します。

使い方による違いがわかるようにスキーマ定義とサンプルデータを用意しました。これらのサンプルはニューヨークとロンドンを例に距離の計算方法を示します。

1.  距離の計算にlocationカラムの値を使う ( Cities テーブル)

2.  距離の計算に明示的に指定した座標値を使う ( Geo テーブル)

  locationカラムの値を使う

使用例を示すための Cities テーブルのスキーマ定義とサンプルデータは以下の通りです。

table_create Cities TABLE_HASH_KEY ShortText
column_create Cities location COLUMN_SCALAR WGS84GeoPoint
load --table Cities
[
  {
    "_key", "location"
  },
  {
    "New York City", "146566000x-266422000",
  },
]

実行例:

table_create Cities TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Cities location COLUMN_SCALAR WGS84GeoPoint
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Cities
[
  {
     "_key", "location"
  },
  {
     "New York City", "146566000x-266422000",
  },
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

この実行例では location というカラムを持つ Cities テーブルを作成します。 location カラムには座標値を保存します。東京の座標値がサンプルデータとして保存されています。

実行例:

select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "rectangle")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         5715104
#       ]
#     ]
#   ]
# ]

このサンプルは geo_distance が location カラムと座標値から距離を計算していることを示します。

geo_distance の第二引数として渡された値 ("185428000x-461000")はロンドンの座標値です。

  明示的に指定した位置を使う

使用例を示すための Geo テーブルのスキーマ定義とサンプルデータは以下の通りです。

table_create Geo TABLE_HASH_KEY ShortText
column_create Geo distance COLUMN_SCALAR Int32
load --table Geo
[
  {
    "_key": "the record for geo_distance() result"
  }
]

実行例:

table_create Geo TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Geo distance COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Geo
[
  {
    "_key": "the record for geo_distance() result"
  }
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

この実行例では distance カラムを持つ Geo テーブルを作成します。 distance カラムには距離を保存します。

実行例:

select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "185428000x-461000", "rectangle")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "distance",
#           "Int32"
#         ]
#       ],
#       [
#         5807750
#       ]
#     ]
#   ]
# ]

このサンプルは geo_distance がロンドンの座標とニューヨークの座標から距離を計算していることを示します。

  引数

  必須引数

必須引数は二つあります。 point1 と point2 です。

  point1

計算しようとしている二点間の開始地点を指定します。

GeoPoint型の値を指定することができます。 [1]

GeoPointについては /reference/types を参照してください。

  point2

計算しようとしている二点間の終了地点を指定します。

GeoPoint型の値か座標を表す文字列を指定することができます。

GeoPointと座標については /reference/types を参照してください。

  省略可能引数

省略可能な引数として approximate_type があります。

  approximate_type

距離を計算するときに地形をどのように近似するかを指定します。

approximate_type の値は以下を指定することができます。

•   rectangle

•   sphere

•   ellipsoid

    注釈: geo_distance には制限があります。 sphere や ellipsoid を近似方法として選択した場合、子午線や日付変更線、赤道といった境界をまたぐ距離の計算を行うことができません。この制限は rectangle を近似方法として選択した場合にはありません。これはGroongaの実装上の一時的な制限ですが、将来的には修正される予定です。

  rectangle

この引数を指定すると地形を方形近似して距離を計算します。

簡易な式で距離の計算を行うので、高速に距離を求めることができますが、極付近では誤差が増大します。

rect を省略表記として指定することができます。

カラムの値で距離を計算するサンプルは以下の通りです。

実行例:

select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "rectangle")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         5715104
#       ]
#     ]
#   ]
# ]

明示的に位置を指定して距離を計算するサンプルは以下の通りです。

実行例:

select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "185428000x-461000", "rectangle")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "distance",
#           "Int32"
#         ]
#       ],
#       [
#         5807750
#       ]
#     ]
#   ]
# ]

明示的に子午線や赤道、日付変更線をまたぐような位置を指定して距離を計算するサンプルは以下の通りです。

実行例:

select Geo --output_columns distance --scorer 'distance = geo_distance("175904000x8464000", "145508000x-13291000", "rectangle")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "distance",
#           "Int32"
#         ]
#       ],
#       [
#         1051293
#       ]
#     ]
#   ]
# ]

このサンプルは子午線をまたいだ場合の距離を示します。 geo_distance("175904000x8464000", "145508000x-13291000", "rectangle") はパリ(フランス)からマドリード(スペイン)間の距離を返します。

実行例:

select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "-56880000x-172310000", "rectangle")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "distance",
#           "Int32"
#         ]
#       ],
#       [
#         6880439
#       ]
#     ]
#   ]
# ]

このサンプルは赤道をまたいだ場合の距離を示します。 geo_distance("146566000x-266422000", "-56880000x-172310000", "rectangle") はニューヨーク(アメリカ)からブラジリア(ブラジル)間の距離を返します。

実行例:

select Geo --output_columns distance --scorer 'distance = geo_distance("143660000x419009000", "135960000x-440760000", "rectangle")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "distance",
#           "Int32"
#         ]
#       ],
#       [
#         10475205
#       ]
#     ]
#   ]
# ]

このサンプルは日付変更線をまたいだ場合の距離を示します。 geo_distance("143660000x419009000", "135960000x-440760000", "rectangle") は北京(中国)からサンフランシスコ(アメリカ)間の距離を返します。

注釈: geo_distance は方形近似をデフォルトとして使用します。 approximate_type を省略すると geo_distance は rectangle が指定されたものとして振舞います。

注釈: geo_distance は approximate_type の値が "rectangle" であるときに point1 の値として座標を表す文字列を受けつけます。もし sphere や ellipsoid と一緒に座標を表す文字列を point1 へ指定した場合、 geo_distance は距離の値として0を返します。

  sphere

この引数を指定すると球面近似で地形を近似して距離を計算します。

球面近似は rectangle よりも遅いです。しかし rectangle よりも誤差は小さくなります。

sphr を省略表記として指定することができます。

カラムの値で距離を計算するサンプルは以下の通りです。

実行例:

select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "sphere")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         5715102
#       ]
#     ]
#   ]
# ]

  ellipsoid

この引数を指定すると楕円近似で地形を近似して距離を計算します。

ヒュベニの距離計算式により距離を計算します。 sphere よりも遅いですが、 sphere より誤差は小さくなります。

ellip を省略表記として指定することができます。

カラムの値で距離を計算するサンプルは以下の通りです。

実行例:

select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "ellipsoid")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         5706263
#       ]
#     ]
#   ]
# ]

  戻り値

geo_distance はFloat型の値を距離として返します。単位はメートルです。 脚注

[1] 日本測地系座標か世界測地系座標のいずれかを指定することができます。

  geo_in_circle

  名前

geo_in_circle - 座標が円の範囲内に存在するかどうかを調べます。

  書式

geo_in_circle(point, center, radious_or_point[, approximate_type])

  説明

Groonga組込関数の一つであるgeo_in_circleについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

geo_in_circle() 関数は、pointに指定した座標が、centerに指定した座標を中心とする円の範囲内にあるかどうかを調べます。

  引数

point 円の範囲内に存在するかどうかを調べる座標を指定します。Point型の値を指定できます。 [1]

center 円の中心となる座標を指定します。Point型の値、あるいは座標を示す文字列を指定できます。

radious_or_point 円の半径を指定します。数値を指定した場合には、半径(単位:メートル)が指定されたものとみなします。 Point型の値、あるいは座標を示す文字列を指定した場合は、円周上の点の一つの座標が指定されたものとみなします。

approximate_type 半径からの距離を求めるために地形をどのように近似するかを指定します。指定できる値は以下の通りです。

"rectangle" 方形近似で近似します。単純な計算式で距離を求めることができるため高速ですが、極付近では誤差が大きくなります。

"rect" と省略して指定することもできます。

この近似方法がデフォルト値です。 approximate_type を省略した場合は方形近似になります。

"sphere" 球面近似で近似します。 "rectangle" よりも遅くなりますが、誤差は小さいです。

"sphr" と省略して指定することもできます。

"ellipsoid" 楕円体近似で近似します。距離の計算にはヒュベニの距離計算式を用います。 "sphere" よりも遅くなりますが、誤差は小さくなります。

"ellip" と省略して指定することもできます。

  返値

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(世界測地系座標)のいずれかを指定できます。

  highlight_full

ご用心: この機能は実験的です。APIが変わる可能性があります。

  概要

highlight_full は対象テキストをタグ付けします。検索文字列をハイライトさせるために利用することができます。HTMLエスケープの有無、ノーマライザー名を指定することができ、キーワードごとにタグを変更することができます。

  構文

highlight_full には必須引数と省略可能引数とがあります:

highlight_full(column, normalizer_name, use_html_escape,
               keyword1, open_tag1, close_tag1,
               ...
               [keywordN, open_tagN, close_tagN])

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries body COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms document_index COLUMN_INDEX|WITH_POSITION Entries body
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{"body": "Mroonga is a ＭｙＳＱＬ storage engine based on Groonga. <b>Rroonga</b> is a Ruby binding of Groonga."}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

highlight_full は /reference/commands/select コマンドの --output_columns 内でのみ指定できます。

highlight_full を使うにはGroonga 4.0.5以降が必要です。

highlight_full を使うには /reference/command/command_version 2以降を使う必要があります。

以下の例はHTMLエスケープを使用し、ノーマライザーに NormalizerAuto を指定しています。この例では キーワード groonga に <span class="keyword1"> と </span> のタグを指定し、キーワード mysql に <span class="keyword2"> と </span> のタグを指定しています。

実行例:

select Entries --output_columns 'highlight_full(body, "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "highlight_full",
#           "null"
#         ]
#       ],
#       [
#         "Mroonga is a <span class=\"keyword2\">ＭｙＳＱＬ</span> storage engine based on <span class=\"keyword1\">Groonga</span>. &lt;b&gt;Rroonga&lt;/b&gt; is a Ruby binding of <span class=\"keyword1\">Groonga</span>."
#       ]
#     ]
#   ]
# ]

キーワードとテキストは NormalizerAuto ノーマライザーで正規化されてタグ付けのためにスキャンされます。

--query "groonga mysql" は最初のレコードにマッチします。 highlight_full は、テキスト中に含まれるキーワード groonga を <span class="keyword1"> と </span> で囲み、 キーワード mysql を <span class="keyword2"> と </span> で囲みます。

< や > などの特殊文字は &lt; や &gt; にエスケープされています。

カラムの代わりに文字列リテラルを指定することもできます。

実行例:

select Entries --output_columns 'highlight_full("Groonga is very fast fulltext search engine.", "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2 --match_columns body --query "groonga"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "highlight_full",
#           "null"
#         ]
#       ],
#       [
#         "<span class=\"keyword1\">Groonga</span> is very fast fulltext search engine."
#       ]
#     ]
#   ]
# ]

  引数

必須引数は3つあります。 column と normalizer_name と use_html_escape です。省略可能引数は3つ以上あります。 keywordN と open_tagN と end_tagN です。

  column

テーブルのカラムを指定します。

  normalizer_name

ノーマライザー名を指定します。

  use_html_escape

HTMLエスケープの有無を指定します。 true を指定すればHTMLエスケープされます。 false を指定すればHTMLエスケープされません。

  keywordN

タグ付けするキーワードを指定します。3つの引数ごとに複数のキーワードを指定することができます。

  open_tagN

開始タグを指定します。3つの引数ごとに複数の開始タグを指定することができます。

  close_tagN

終了タグを指定します。3つの引数ごとに複数の終了タグを指定することができます。

  戻り値

highlight_full はタグ付の文字列もしくは null を返します。highlight_full は該当するキーワードがない場合に null を返します。

  参考

•   /reference/commands/select

•   /reference/functions/highlight_html

  highlight_html

ご用心: この機能は実験的です。APIが変わる可能性があります。

バージョン 4.0.5 で追加.

  概要

highlight_html は対象テキストをタグ付けします。検索文字列をハイライトさせるために利用することができます。タグ付けされたテキストはHTML中に埋め込みやすいように処理されています。< や > などの特殊文字は &lt; や &gt; にエスケープされています。キーワードは <span class="keyword"> と </span> で囲まれています。たとえば、 I am a groonga user. <3 という対象テキストのキーワード groonga でタグ付けされたテキストは I am a <span class="keyword">groonga</span> user. &lt;3 となります。

  構文

この関数の引数は1つです。:

highlight_html(text)

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Entries TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries body COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms document_index COLUMN_INDEX|WITH_POSITION Entries body
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{"body": "Mroonga is a ＭｙＳＱＬ storage engine based on Groonga. <b>Rroonga</b> is a Ruby binding of Groonga."}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

highlight_html は /reference/commands/select コマンドの --output_columns 内でのみ指定できます。

highlight_html を使うには /reference/command/command_version 2以降を使う必要があります。

また、 --query と --filter オプションも指定する必要があります。（どちらか一方でも構いません。）これは、 --query と --filter オプションからキーワードを抽出しているためです。

以下の例は --query "groonga mysql" を使っています。この場合は、キーワードとして groonga と mysql を使います。

実行例:

select Entries --output_columns --match_columns body --query 'groonga mysql' --output_columns 'highlight_html(body)' --command_version 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "highlight_html",
#           "null"
#         ]
#       ],
#       [
#         "Mroonga is a <span class=\"keyword\">ＭｙＳＱＬ</span> storage engine based on <span class=\"keyword\">Groonga</span>. &lt;b&gt;Rroonga&lt;/b&gt; is a Ruby binding of <span class=\"keyword\">Groonga</span>."
#       ]
#     ]
#   ]
# ]

キーワードとテキストは NormalizerAuto ノーマライザーで正規化されてタグ付けのためにスキャンされます。

--query "groonga mysql" は最初のレコードにマッチします。highlight_html(body) は、テキスト中に含まれるキーワード groonga と mysql を <span class="keyword"> と </span> で囲みます。

カラムの代わりに文字列リテラルを指定することもできます。

実行例:

select Entries --output_columns 'highlight_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns body --query "groonga"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "highlight_html",
#           "null"
#         ]
#       ],
#       [
#         "<span class=\"keyword\">Groonga</span> is very fast fulltext search engine."
#       ]
#     ]
#   ]
# ]

  引数

このセクションではすべての引数について説明します。

  必須引数

1つだけ必須の引数があります。

  text

HTMLでハイライトする対象のテキストです。

  省略可能引数

省略可能な引数はありません。

  戻り値

highlight_html はタグ付の文字列もしくは null を返します。highlight_html は該当するキーワードがない場合に null を返します。

  参考

•   /reference/commands/select

•   /reference/functions/highlight_full

  html_untag

  概要

html_untag はHTMLタグをHTMLから除去したテキストを出力します。

html_untag は select-output-columns で説明している --output_columns で使います。

  構文

html_untag は引数を一つだけとります。 それは html です。

html_untag(html)

  必要条件

html_untag を使うにはGroonga 3.0.5以降が必要です。

html_untag を使うには /reference/command/command_version 2以降を使う必要があります。

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create WebClips TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create WebClips content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table WebClips
[
{"_key": "http://groonga.org", "content": "groonga is <span class='emphasize'>fast</span>"},
{"_key": "http://mroonga.org", "content": "mroonga is <span class=\"emphasize\">fast</span>"},
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

カラムの本文からHTMLタグを除去する html_untag 関数の簡単な例はこちらです。

実行例:

select WebClips --output_columns "html_untag(content)" --command_version 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "html_untag",
#           "null"
#         ]
#       ],
#       [
#         "groonga is fast"
#       ],
#       [
#         "mroonga is fast"
#       ]
#     ]
#   ]
# ]

上記クエリを実行すると、"class" 属性つきの "span" タグが除去されているのがわかります。html_untag 関数を使うのには --command_vesion 2 を指定しなければならないことに注意してください。

  引数

必須引数が一つあり、それは html です。

  html

タグを取り除きたいHTMLを指定します。

  戻り値

html_untag はHTMLテキストからHTMLタグを除去したタグなしのテキストを返します。

  in_values

  概要

バージョン 4.0.7 で追加.

in_values は 複数の OR や == を使っているクエリを簡略化できます。複数の OR や == を使うよりは in_values を使うのがパフォーマンスの観点からおすすめです。

  構文

query は2以上の引数 - target_value と 複数の value が必要です。

in_values(target_value, value1, ..., valueN)

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create Tags TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Memos TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos tag COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tags memos_tag COLUMN_INDEX Memos tag
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table Memos
[
{"_key": "Groonga is fast",          "tag": "groonga"},
{"_key": "Mroonga is fast",          "tag": "mroonga"},
{"_key": "Rroonga is fast",          "tag": "rroonga"},
{"_key": "Droonga is fast",          "tag": "droonga"},
{"_key": "Groonga is a HTTP server", "tag": "groonga"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]

in_values 関数を使って tag カラムの値が "groonga" 、 "mroonga" あるいは "droonga" であるものを選択する例を示します。

実行例:

select Memos --output_columns _key,tag --filter 'in_values(tag, "groonga", "mroonga", "droonga")' --sortby _id
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "tag",
#           "ShortText"
#         ]
#       ],
#       [
#         "Groonga is fast",
#         "groonga"
#       ],
#       [
#         "Mroonga is fast",
#         "mroonga"
#       ],
#       [
#         "Droonga is fast",
#         "droonga"
#       ],
#       [
#         "Groonga is a HTTP server",
#         "groonga"
#       ]
#     ]
#   ]
# ]

クエリを実行すると、"rroonga"を除いた結果を得られます。"rroonga"は in_values には指定していないからです。

  引数

二つ以上の引数が必須です。 target_valule と 1つ以上の value です。

  target_value

select 対象の table に指定されたテーブルのカラムを指定します。

  value

選択したいカラムの値を指定します。

  戻り値

in_values は対象となるカラムに指定した値が含まれるかを返します。

もし該当するレコードがあれば、 true を返します。そうでなければ false を返します。

  now

  名前

now - 現在時刻を返す

  書式

now()

  説明

Groonga組込関数の一つであるnowについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

now() 関数は現在時刻に対応するTime型の値を返します。

  返値

現在時刻に対応するTime型のオブジェクトを返します。

  例

now()
1256791194.55541

  prefix_rk_search()

  概要

prefix_rk_search() は /reference/operations/prefix_rk_search を使ってレコードを選択します。

前方一致RK検索を使うには table-pat-key テーブルを作る必要があります。

シーケンシャルスキャンでは prefix_rk_search() を使うことはできません。これはセレクターのみのプロシージャです。

  構文

prefix_rk_search() には2つ引数があります。 column と query です。

prefix_rk_search(column, query)

今のところ、 column は必ず _key にしなければいけません。

query は文字列です。

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Readings
[
{"_key": "ニホン"},
{"_key": "ニッポン"},
{"_key": "ローマジ"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

以下は簡単な prefix_rk_search() 関数の使い方です。この使い方では ni で ニホン と ニッポン を検索しています。

実行例:

select Readings --filter 'prefix_rk_search(_key, "ni")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         2,
#         "ニッポン"
#       ],
#       [
#         1,
#         "ニホン"
#       ]
#     ]
#   ]
# ]

sub_filter と組み合わせることで /reference/suggest/completion のような機能を実現することができます。

レコードが補完候補となるテーブルを作成します。各レコードには0個以上の読みがあります。読みは Readings テーブルに格納します。 Readings テーブルに Items.readings 用のインデックスカラムを定義することを忘れないでください。このインデックスカラムは sub_filter で必要になります。

実行例:

table_create Items TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Items readings COLUMN_VECTOR Readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Readings items_index COLUMN_INDEX Items readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Items
[
{"_key": "日本",     "readings": ["ニホン", "ニッポン"]},
{"_key": "ローマ字", "readings": ["ローマジ"]},
{"_key": "漢字",     "readings": ["カンジ"]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

niho で Items テーブルの中にある 日本 レコードを見つけることができます。なぜなら、 niho で前方一致RK検索をすると ニホン という読みが見つかり、 ニホン という読みは 日本 レコードの読みの1つだからです。

実行例:

select Items \
 --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "readings",
#           "Readings"
#         ]
#       ],
#       [
#         1,
#         "日本",
#         [
#           "ニホン",
#           "ニッポン"
#         ]
#       ]
#     ]
#   ]
# ]

読みがない補完候補をサポートするために script-syntax-prefix-search-operator も組み合わせる必要があります。

読みがない補完候補を1つ追加します。

実行例:

load --table Items
[
{"_key": "nihon", "readings": []}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

読みがない補完候補をサポートするために script-syntax-prefix-search-operator を組み合わせます。

実行例:

select Items \
 --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")") || \
           _key @^ "niho"'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "readings",
#           "Readings"
#         ]
#       ],
#       [
#         1,
#         "日本",
#         [
#           "ニホン",
#           "ニッポン"
#         ]
#       ],
#       [
#         4,
#         "nihon",
#         []
#       ]
#     ]
#   ]
# ]

多くの場合、補完時は大文字小文字を無視して検索したいものです。その場合は、 --normalizer NormalizerAuto と label カラムを使います。

実行例:

table_create LooseItems TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create LooseItems label COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create LooseItems readings COLUMN_VECTOR Readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Readings loose_items_index COLUMN_INDEX LooseItems readings
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table LooseItems
[
{"_key": "日本",     "label": "日本",     "readings": ["ニホン", "ニッポン"]},
{"_key": "ローマ字", "label": "ローマ字", "readings": ["ローマジ"]},
{"_key": "漢字",     "label": "漢字",     "readings": ["カンジ"]},
{"_key": "Nihon",    "label": "日本",     "readings": []}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]

表示するときは LooseItems.label を使います。

実行例:

select LooseItems \
 --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"nIhO\\")") || \
           _key @^ "nIhO"' \
 --output_columns '_key,label'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "label",
#           "ShortText"
#         ]
#       ],
#       [
#         "日本",
#         "日本"
#       ],
#       [
#         "nihon",
#         "日本"
#       ]
#     ]
#   ]
# ]

  引数

必須引数は二つあります。 column と query です。

  column

今のところ、常に _key を指定してください。

  query

クエリー文字列をローマ字、カタカナ、ひらがなのどれかで指定します。

  戻り値

prefix_rk_search() 関数はマッチしたレコードを返します。

  参考

•   /reference/operations/prefix_rk_search

•   /reference/functions/sub_filter

  query

  概要

query は、/reference/commands/select の --match_columns と --query 引数の機能を関数として提供します。/reference/commands/select の --filter 引数で複数の query 関数を指定することができます。

そのような柔軟性があるので、 複数の query 関数を組合せることで全文検索の振舞いを制御することができます。

query は /reference/commands/select コマンドの --filter 内でのみ指定できます。

  構文

query は2つの引数が必要です。 match_columns と query_string です。

引数の query_expander や substitution_table は省略可能です。

query(match_columns, query_string)
query(match_columns, query_string, query_expander)
query(match_columns, query_string, substitution_table)

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create Documents TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Documents content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms documents_content_index COLUMN_INDEX|WITH_POSITION Documents content
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Users TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users name COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users memo COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Lexicon TABLE_HASH_KEY ShortText \
  --default_tokenizer TokenBigramSplitSymbolAlphaDigit \
  --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon users_name COLUMN_INDEX|WITH_POSITION Users name
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon users_memo COLUMN_INDEX|WITH_POSITION Users memo
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table Users
[
{"name": "Alice", "memo": "groonga user"},
{"name": "Alisa", "memo": "mroonga user"},
{"name": "Bob",   "memo": "rroonga user"},
{"name": "Tom",   "memo": "nroonga user"},
{"name": "Tobby", "memo": "groonga and mroonga user. mroonga is ..."},
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]

--match_columns と --query 引数を使わずにキーワード'alice'を query 関数を使って検索する簡単な使用例です。

実行例:

select Users --output_columns name,_score --filter 'query("name * 10", "alice")'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "name",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Alice",
#         10
#       ]
#     ]
#   ]
# ]

上記のクエリを実行する際、'alice'というキーワードには重みづけとして値10を設定します。

query あり/なしで対照的な例がこちらです。

実行例:

select Users --output_columns name,memo,_score --match_columns "memo * 10" --query "memo:@groonga OR memo:@mroonga OR memo:@user" --sortby -_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "name",
#           "ShortText"
#         ],
#         [
#           "memo",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Tobby",
#         "groonga and mroonga user. mroonga is ...",
#         4
#       ],
#       [
#         "Alice",
#         "groonga user",
#         2
#       ],
#       [
#         "Alisa",
#         "mroonga user",
#         2
#       ],
#       [
#         "Bob",
#         "rroonga user",
#         1
#       ],
#       [
#         "Tom",
#         "nroonga user",
#         1
#       ]
#     ]
#   ]
# ]

この場合、'groonga'と'mroonga'と'user'というキーワードは同じ重みづけがされています。この方法ではキーワードごとに異なる重みづけを行うことはできません。

実行例:

select Users --output_columns name,memo,_score --filter 'query("memo * 10", "groonga") || query("memo * 20", "mroonga") || query("memo * 1", "user")' --sortby -_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           "name",
#           "ShortText"
#         ],
#         [
#           "memo",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "Tobby",
#         "groonga and mroonga user. mroonga is ...",
#         51
#       ],
#       [
#         "Alisa",
#         "mroonga user",
#         21
#       ],
#       [
#         "Alice",
#         "groonga user",
#         11
#       ],
#       [
#         "Tom",
#         "nroonga user",
#         1
#       ],
#       [
#         "Bob",
#         "rroonga user",
#         1
#       ]
#     ]
#   ]
# ]

一方、複数の query を指定することで、'groonga'と'mroonga'と'user'それぞれのキーワードに対し異なる重みづけを行えます。

結果として、意図した様に異なる重みづけを行いつつ全文検索の振舞いを制御することができます。

  引数

  必須引数

必須引数は二つあります。 match_columns と query_string です。

  match_columns

query_string パラメーターの値で全文検索するときのデフォルトの検索対象カラムを指定します。このパラメーターは select の select-match-columns パラメーターと同じ役割です。

  query_string

/reference/grn_expr/query_syntax で検索条件を指定します。このパラメーターは select コマンドの query パラメーターと同じ役割です。

select コマンドの query については select-match-columns を参照してください。

  省略可能引数

いくつか省略可能な引数があります。

  query_expander

クエリ展開に使うプラグイン名を指定します。

/reference/query_expanders/tsv は公式リリースに含まれているプラグインの1つです。

詳細については /reference/query_expanders/tsv を参照してください。

  置換テーブル

置換テーブルとカラム名を ${TABLE}.${COLUMN} という書式でクエリ展開のために指定します。

詳細については select-query-expander を参照してください。

  戻り値

query は1つでもレコードがマッチしたかどうかを返します。もし、1つ以上のレコードがマッチしたら true を返します。1つもマッチしなかったら false を返します。

  TODO

•   query_flagsのサポート

  参考

•   /reference/commands/select

  rand

  名前

rand - 乱数を生成する

  書式

rand([max])

  説明

Groonga組込関数の一つであるrandについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。

rand() 関数は 0 から max の間の疑似乱数整数を返します。

  引数

max 返値の最大値を指定します。省略した場合は RAND_MAX が指定されたものとみなされます。

  返値

0 と max の間の数を表すInt32型の値を返します。

  例

rand(10)
3

  snippet_html

ご用心: この機能は実験的です。APIが変わる可能性があります。

  概要

snippet_html は対象テキスト中から検索キーワード周辺のテキスト（ KWIC 。 KeyWord In Context ）を抽出します。抽出されたテキストのことをスニペットと呼びます。スニペットはHTML中に埋め込みやすいように処理されています。 < や > などの特殊文字は &lt; や &gt; にエスケープされています。キーワードは <span class="keyword"> と </span> で囲まれています。たとえば、 I am a groonga user. <3 という対象テキストのキーワード groonga でのスニペットは I am a <span class="keyword">groonga</span> user. &lt;3 となります。

  構文

snippet_html の引数は1つだけです:

snippet_html(column)

snippet_html は内部にはたくさんのオプションがありますが、今はまだ指定できません。じきに指定できるようになる予定です。

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

実行例:

table_create Documents TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Documents content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms documents_content_index COLUMN_INDEX|WITH_POSITION Documents content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Documents
[
["content"],
["Groonga is a fast and accurate full text search engine based on inverted index. One of the characteristics of groonga is that a newly registered document instantly appears in search results. Also, groonga allows updates without read locks. These characteristics result in superior performance on real-time applications."],
["Groonga is also a column-oriented database management system (DBMS). Compared with well-known row-oriented systems, such as MySQL and PostgreSQL, column-oriented systems are more suited for aggregate queries. Due to this advantage, groonga can cover weakness of row-oriented systems."]
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

snippet_html は /reference/commands/select コマンドの --output_columns 内でのみ指定できます。

Groonga 2.0.9では output_columns 内での関数呼び出しはまだ実験的な機能なので、明示的に --command_version 2 オプションを指定する必要があります。この機能はじきに有効になる予定です。

また、 --query と --filter オプションも指定する必要があります。（どちらか一方でも構いません。）これは、 --query と --filter オプションからキーワードを抽出しているためです。

以下の例は --query "fast performance" を使っています。この場合は、キーワードとして fast と performance を使います。

実行例:

select Documents --output_columns "snippet_html(content)" --command_version 2 --match_columns content --query "fast performance"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "snippet_html",
#           "null"
#         ]
#       ],
#       [
#         [
#           "Groonga is a <span class=\"keyword\">fast</span> and accurate full text search engine based on inverted index. One of the characteristics of groonga is that a newly registered document instantly appears in search results. Also, gro",
#           "onga allows updates without read locks. These characteristics result in superior <span class=\"keyword\">performance</span> on real-time applications."
#         ]
#       ]
#     ]
#   ]
# ]

--query "fast performance" は最初のレコードの内容にだけマッチします。 snippet_html(content) は、テキスト中からキーワード fast と performance の少なくともどちらか一方を含んでいるテキストの断片を抽出します。今回は2箇所抽出しています。そして、抽出したテキストの断片内にあるキーワードを <span class="keyword"> と </span> で囲みます。

テキストの断片数は多くても3です。4つ以上のテキストの断片が抽出できるときは、最初の3つだけを使います。

テキストの断片の最大サイズは200バイトです。単位は文字数ではなくバイトです。挿入される <span keyword="keyword"> と </span> のバイト数はこのサイズの中には含まれません。

テキストの断片の最大数とテキストの断片の最大サイズはカスタマイズできません。

カラムの代わりに文字列リテラルを指定することもできます。

実行例:

select Documents --output_columns 'snippet_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns content --query "fast performance"
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "snippet_html",
#           "null"
#         ]
#       ],
#       [
#         [
#           "Groonga is very <span class=\"keyword\">fast</span> fulltext search engine."
#         ]
#       ]
#     ]
#   ]
# ]

  戻り値

snippet_html は文字列の配列もしくは null を返します。 snippet_html は該当するスニペットがない場合に null を返します。

配列の要素がスニペットになります:

[SNIPPET1, SNIPPET2, SNIPPET3]

スニペットには1つ以上のキーワードが含まれています。 <span keyword="keyword"> と </span> を除いたスニペットの最大サイズは200byteです。単位は文字数ではなくてバイトです。

配列のサイズは0以上3以下です。最大サイズの3は、じきにカスタマイズできるようになる予定です。

  TODO

•   テキストの断片の最大数をカスタマイズできるようにする。

•   テキストの断片最大サイズをカスタマイズできるようにする。

•   キーワードをカスタマイズできるようにする。

•   キーワードを囲むタグをカスタマイズできるようにする。

•   正規化の方法をカスタマイズできるようにする。

•   オブジェクトリテラル形式でのオプション指定をサポートする。

  参考

•   /reference/commands/select

  sub_filter

  概要

sub_filter は filter_string を scope のコンテキストで評価します。

sub_filter は /reference/commands/select コマンドの --filter 内でのみ指定できます。

  構文

sub_filter は2つの引数が必要です。 scope と filter_string です。

sub_filter(scope, filter_string)

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create Comment TABLE_PAT_KEY UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comment name COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comment content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Blog TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Blog title COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Blog content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Blog comments COLUMN_VECTOR Comment
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Comment blog_comment_index COLUMN_INDEX Blog comments
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Lexicon TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon comment_content COLUMN_INDEX|WITH_POSITION Comment content
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon comment_name COLUMN_INDEX|WITH_POSITION Comment name
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Lexicon blog_content COLUMN_INDEX|WITH_POSITION Blog content
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table Comment
[
{"_key": 1, "name": "A", "content": "groonga"},
{"_key": 2, "name": "B", "content": "groonga"},
{"_key": 3, "name": "C", "content": "rroonga"},
{"_key": 4, "name": "A", "content": "mroonga"},
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
load --table Blog
[
{"_key": "groonga's blog", "content": "content of groonga's blog", comments: [1, 2, 3]},
{"_key": "mroonga's blog", "content": "content of mroonga's blog", comments: [2, 3, 4]},
{"_key": "rroonga's blog", "content": "content of rroonga's blog", comments: [3]},
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

ブログのエントリを抽出する sub_filter 関数の使用例です。

実行例:

select Blog --output_columns _key --filter "comments.name @ \"A\" && comments.content @ \"groonga\""
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ]
#       ],
#       [
#         "groonga's blog"
#       ],
#       [
#         "mroonga's blog"
#       ]
#     ]
#   ]
# ]

上記のクエリを実行すると、"groonga's blog"だけでなく、"mroonga's blog"もマッチします。ユーザー"A"は"mroonga's blog"に対しては"groonga"に言及していないので、これは意図していない結果です。

sub_filterなしでは、以下の条件が満たされます。

•   すくなくとも一つはユーザー"A"がコメントしたレコードがある。

•   すくなくとも一つは"groonga"について言及したレコードがある。

    実行例:

    select Blog --output_columns _key --filter 'sub_filter(comments, "name @ \\"A\\" && content @ \\"groonga\\"")'
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   [
    #     [
    #       [
    #         1
    #       ],
    #       [
    #         [
    #           "_key",
    #           "ShortText"
    #         ]
    #       ],
    #       [
    #         "groonga's blog"
    #       ]
    #     ]
    #   ]
    # ]

    一方、上記のクエリは意図した結果を返します。これは、sub_filterの引数がcommentsカラムのコンテキストで評価されるからです。

    sub_filterは以下の条件が満たされていることを要求します。

•   ユーザー"A"が"groonga"について言及しているレコードがある。

  引数

必須引数は二つあります。 scope と filter_string です。

  scope

select コマンドの table パラメーターで指定したテーブルが持つカラムを指定します。このカラムには制限があります。制限については後述します。 filter_string はこのカラムの文脈で評価されます。これは、 filter_string は select --table カラムの型 --filter フィルター文字列 というように評価されるということです。

指定したカラムの型はテーブルでなければいけません。言いかえると、カラムの型は参照型でなければいけないということです。

カラム1.カラム2.カラム3...カラムN という構文でカラムを数珠つなぎにできます。例えば、 user.group.name とできます。

select コマンドの table 引数については select-table を参照してください。

  filter_string

/reference/grn_expr/script_syntax の検索条件を指定します。これは scope のコンテキストで評価されます。

  戻り値

sub_filter は1つでもレコードがマッチしたかどうかを返します。もし、1つ以上のレコードがマッチしたら true を返します。1つもマッチしなかったら false を返します。

  参考

•   /reference/commands/select

•   /reference/grn_expr/script_syntax

  vector_size

  概要

バージョン 5.0.3 で追加.

vector_size はベクターカラムのサイズを返します。

この関数を有効にするには、以下のコマンドで functions/vector プラグインを登録します:

plugin_register functions/vector

その後、 --command_version 2 オプションと一緒に vector_size 関数を使ってください。vector_size を使うには --command_vesion 2 を指定しなければならないことに注意してください。

  構文

vector_size は引数を一つだけとります。 それは target です。

vector_size(target)

  使い方

使い方を示すために使うスキーマ定義とサンプルデータは以下の通りです。

サンプルスキーマ:

実行例:

table_create Memos TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Memos tags COLUMN_VECTOR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

サンプルデータ:

実行例:

load --table Memos
[
{"_key": "Groonga",          "tags": ["Groonga"]},
{"_key": "Rroonga",          "tags": ["Groonga", "Ruby"]},
{"_key": "Nothing"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

vector_size 関数が tag カラムの値とそのサイズを返す例です。

実行例:

select Memos --output_columns 'tags, vector_size(tags)' --command_version 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           "tags",
#           "ShortText"
#         ],
#         [
#           "vector_size",
#           "Object"
#         ]
#       ],
#       [
#         [
#           "Groonga"
#         ],
#         1
#       ],
#       [
#         [
#           "Groonga",
#           "Ruby"
#         ],
#         2
#       ],
#       [
#         [],
#         0
#       ]
#     ]
#   ]
# ]

  引数

必須引数が一つあり、それは target です。

  target

select 対象の table に指定されたテーブルのベクターカラムを指定します。

  戻り値

vector_size は対象のベクターカラムのサイズを返します。

  操作方法

Groongaには複数の検索機能があります。このセクションではこの検索の操作方法を説明します。

  位置情報検索

Groongaは位置情報検索をサポートしています。検索にはインデックスを使うので全文検索と同様に位置情報も高速に検索できます。

  対応している機能

Groongaは位置情報データのうち座標データのみサポートしています。線や面などはサポートしています。よってGroongaができることは以下の通りです。

1.  カラムに座標データを保存できる。

2.  指定した四角形の中にある座標を持つレコードを検索できる。

3.  指定した円の中にある座標を持つレコードを検索できる。

4.  2点間の距離を計算できる。

5.  指定した座標からの距離が近い順にレコードをソートできる。

    以下はGroongaの位置情報検索の利用例です。

•   駅の近くにあるマクドナルドをリストする。

•   現在地から近い順にケンタッキーをソートし、現在地からの距離付きでリストする。

    以下はGroongaではできないことです。

•   市内にあるマクドナルドを検索する。（Groongaは四角形と円以外の形状の位置情報検索をサポートしていません。）

•   湖を表すレコードに位置情報として座標ではなく範囲を格納する。（カラムには座標データ以外を格納できません。）

    以下の図はGroongaの位置情報検索機能を示しています。

    以下の図はレコードのみがある図です。黒い点がレコードを表しています。以降の図ではレコードがどのように扱われるかを示します。 [画像: only records] [画像]

    執筆中。。。 （ 下書き ）

  前方一致RK検索

  概要

Groongaは前方一致RK検索をサポートしています。RKはローマ字（Romaji）と仮名（Kana、読み）を意味しています。前方一致RK検索はカタカナで登録されているテキストをローマ字、ひらがな、カタカナで指定したクエリーで検索します。ヒットしたテキストは検索したクエリーで始まっています。

前方一致RK検索は日本語テキストを補完するときに便利です。なぜなら、コンピューター上で日本語を入力するときはローマ字を使うことが多いからです。詳細は Wikipediaの日本語入力システム を参照してください。

ユーザーがローマ字で日本語テキストを検索することができると、ユーザーは自分でローマ字をひらがな、カタカナ、漢字に変換する必要がなくなります。たとえば、「日本」の読みとして「ニホン」を登録しておけば、「ni」でも「に」でも「二」でも「日本」を探すことができます。

この機能は便利です。なぜならユーザーの操作が減るからです。

この機能は /reference/suggest/completion でも使われています。

/reference/functions/prefix_rk_search を使えば、この機能を select-filter で使うことができます。

  使い方

前方一致RK検索を使うには table-pat-key テーブルが必要です。

読みをカタカナで TABLE_PAT_KEY のキーとして登録する必要があります。

実行例:

table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Readings
[
{"_key": "ニホン"},
{"_key": "ニッポン"},
{"_key": "ローマジ"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

クエリーに ni を指定して前方一致RK検索をすると、 Readings テーブルから ニホン と ニッポン を見つけることができます。

クエリーに r を指定して前方一致RK検索をすると、 Readings テーブルから ローマジ を見つけることができます。

  ローマ字から読みへの変換

前方一致RK検索はJIS X 4063:2000をベースにしています。

この使用はすでに廃止されています。JIS X 4063:2000については Wikipediaのローマ字入力 を参照してください。

通常、期待した通りの変換結果を得ることができます。

  参考

•   /reference/suggest/completion

•   /reference/functions/prefix_rk_search

  設定

バージョン 5.1.2 で追加.

Groongaはデータベース単位で設定項目を管理できます。これらの設定項目は永続化されます。つまり、Groongaプロセスが終了した後も設定項目を利用できるということです。

  概要

/spec/search のようにGroongaのいくつか挙動はリクエストパラメーター（ select-match-escalation-threshold ）やビルドパラメーター（ install-configure-with-match-escalation-threshold ）などいくつかの方法で変更できます。

設定はそれらの方法のうちの1つです。設定を使うことでデータベース単位でGroongaの挙動を変更できます。

1つの設定項目はキーと値のペアです。キーも値も文字列です。キーの最大サイズは4KiBです。値の最大サイズは4091B（= 4KiB - 5B）です。

設定項目は /reference/commands/config_set で設定できます。

設定項目の値は /reference/commands/config_get で取得できます。

設定項目は /reference/commands/config_delete で削除できます。

/reference/commands/dump ですべての設定項目を確認できます。

  コマンド一覧

  エイリアス

バージョン 5.1.2 で追加.

エイリアス機能を使うと複数の名前で1つのテーブル・カラムを参照できます。

  概要

このエイリアス機能は次のケースで有用です。

•   テーブルをリネームしたいが現在のテーブル名を使っているGroongaクライアントがいてそれらは変更できない。

•   ダウンタイムなしでカラムの型を変更したい。

    前者のケースでは、テーブルをリネームした後も既存のGroongaクライアントは現在のテーブル名（リネーム前のテーブル名）でアクセスできます。なぜなら、エイリアス機能は現在のテーブル名を新しいリネーム後のテーブル名に対応づけるからです。

    後者のケースでは、前提として、すべてのGroongaクライアントは aliased_column のようなエイリアスされた名前でアクセスするようにしておきます。 aliased_column は current_column （現在のテーブル）を参照するようにします。この状態で、 new_column という新しいカラムを新しい型で作成し、 /reference/commands/column_copy を使ってそのカラムに current_column からデータをコピーします。その後、 aliased_column の参照先を current_column から new_column に変更します。これですべてのGroongaクライアントは aliased_column で new_column を参照するようになります。検索リクエストを止める必要はありません。

  使い方

エイリアスと実際の名前の対応は通常のテーブルとカラムで管理します。

エイリアス管理テーブルには table-no-key 以外であればどの種類でも使えます。オススメは table-hash-key です。なぜなら、エイリアス機能ではキーの完全一致検索しか使わないからです。キーの完全一致検索が一番速いのは table-hash-key です。

カラムは、種類を /reference/columns/scalar 、型を ShortText にします。 Text または LongText 型も使えますが、意味がありません。なぜなら、テーブル・カラム名の最大サイズは4KiBだからです。 ShortText は4KiBのデータを格納できます。

以下はエイリアス管理用のテーブル・カラムの定義例です。

実行例:

table_create Aliases TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Aliases real_name COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]

configuration を使ってこのテーブルとカラムを登録する必要があります。エイリアス機能は設定項目 alias.column を使います。次のように /reference/commands/config_set を使ってこのテーブルとカラムを登録します。

実行例:

config_set alias.column Aliases.real_name
# [[0, 1337566253.89858, 0.000355720520019531], true]

エイリアスの使い方を示すためのスキーマとデータは次の通りです。

実行例:

table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users age COLUMN_SCALAR UInt8
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{"_key": "alice", "age": 14},
{"_key": "bob",   "age": 29}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

/reference/commands/select で Users.age を使えます。

実行例:

select Users --filter 'age < 20'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "age",
#           "UInt8"
#         ]
#       ],
#       [
#         1,
#         "alice",
#         14
#       ]
#     ]
#   ]
# ]

/reference/commands/column_rename で Users.age を Users.years にリネームすると Users.age にはアクセスできなくなります。

実行例:

column_rename Users age years
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Users --filter 'age < 20'
# [
#   [
#     -63,
#     1337566253.89858,
#     0.000355720520019531,
#     "Syntax error: <age| |< 20>",
#     [
#       [
#         "yy_syntax_error",
#         "grn_ecmascript.lemon",
#         34
#       ]
#     ]
#   ],
#   []
# ]

Aliases テーブルに Users.age から Users.years の対応を追加すると Users.age を使うことができます。

実行例:

load --table Aliases
[
{"_key": "Users.age", "real_name": "Users.years"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
select Users --filter 'age < 20'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "years",
#           "UInt8"
#         ]
#       ],
#       [
#         1,
#         "alice",
#         14
#       ]
#     ]
#   ]
# ]

これで、 Users.years のエイリアスとして Users.age を使うことができます。

  エイリアスの解決方法

このセクションではエイリアスの解決方法について説明します。

Groongaは存在しない名前（テーブル名、カラム名、コマンド名、関数名など）が参照されたときにエイリアス機能を使います。エイリアス機能で既存のオブジェクト（テーブル、カラム、コマンド、関数など）を置き換えることはできません。

たとえば、以下の例ではエイリアスは解決されません。なぜなら Users.years が存在するからです。

実行例:

column_rename Users years years_old
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Users --filter 'age < 20'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "years_old",
#           "UInt8"
#         ]
#       ],
#       [
#         1,
#         "alice",
#         14
#       ]
#     ]
#   ]
# ]

Groongaはエイリアスを再帰的に解決します。 Users.years を Users.years_old にリネームし、 Users.age を参照したとします。Groongaは Users.age を Users.years に置き換え、その後、 Users.years を Users.years_old に置き換えます。なぜなら、 Aliases テーブルには次のレコードがあるからです。
_key | real_name
Users.age | Users.years
Users.years | Users.years_old

以下は Users.age が再帰的に解決される例です。

実行例:

column_rename Users years years_old
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Users --filter 'age < 20'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "years_old",
#           "UInt8"
#         ]
#       ],
#       [
#         1,
#         "alice",
#         14
#       ]
#     ]
#   ]
# ]

  参考

•   /reference/configuration

•   /reference/commands/config_set

•   /reference/commands/table_create

•   /reference/commands/column_create

•   /reference/commands/select

  サジェスト

Groongaにはサジェスト機能があります。このセクションではこの機能の使い方とどのように動作しているかを説明します。

  はじめに

Groongaのサジェスト機能は以下の機能を提供します。:

•   補完

•   補正

•   提案

  補完

補完はユーザの入力を支援します。ユーザが単語の一部分のみしか入力していないときに、登録済みの語の中から補完候補の語を返します。

例えば、以下が登録済みの語とします。:

•   "groonga"

•   "complete"

•   "correction"

•   "suggest"

    ユーザが"co"と入力したとき、"complete"と"correction"を補完候補として返します。これはどちらも"co"で始まっているからです。

    ユーザが"sug"と入力したとき、"suggest"を返します。これは"suggest"が"sug"から始まっているからです。

    ユーザが"ab"と入力したときは何も返しません。これは"ab"から始まる語が1つも登録されていないからです。

  補正

補正もユーザの入力を支援します。ユーザが間違った語を入力したときに登録済みの補正ペアの中から補正された語を返します。

例えば、以下のような補正ペアが登録されていたとします。
間違った語 | 正しい語
grroonga | groonga
gronga | groonga
gronnga | groonga

ユーザが"gronga"と入力したとき、"groonga"を返します。これは、"gronga"が「間違った語」にあり、対応する「正しい語」カラムの値が"groonga"だからです。

ユーザが"roonga"と入力したときは何も返しません。これは"roonga"が「間違った語」カラムにないからです。

  提案

提案は、たくさんの文書が見つかったときに、ユーザがさらに絞り込むことを支援します。ユーザがクエリを入力したとき、登録済みの関連クエリペアから追加のキーワードを選び、追加のキーワードを含んだ新しいクエリを返します。

例えば、以下の関連クエリペアが登録されているとします。:
キーワード | 関連クエリ
groonga | groonga search engine
search | Google search
speed | groonga speed

ユーザが"groonga"と入力したとき、"groonga search engine"を返します。これは、"groonga"が「キーワード」カラムの値にあり、対応する「関連クエリ」カラムの値が"groonga search engine"だからです。

ユーザが"MySQL"と入力したときは何も返しません。これは"MySQL"が「キーワード」カラムにないからです。

  学習

サジェスト機能を使う場合は、事前に登録済みのデータを用意する必要があります。これらのデータはユーザの入力を使って登録できます。これ用にgroonga-suggest-httpdコマンドとgroonga-suggest-learnerコマンドがあります。

  補完

このセクションでは以下の補完機能について説明します。:

•   どのように動作するか

•   使い方

•   学習方法

  どのように動作するか

補完機能は補完される語を計算するために3種類の検索を使います。

1.  登録されている語を前方一致RK検索。

2.  学習したデータを共起検索。

3.  登録されている語を前方一致検索。（実行しないこともある）

  前方一致RK検索

前方一致RK検索については /reference/operations/prefix_rk_search を見てください。

/reference/executables/groonga-suggest-create-dataset 実行ファイルで example という名前のデータセットを作ったとします。前方一致RK検索で使うために item_example テーブルの _key と kana カラムに登録済みの単語と読みのペアを指定することで更新できます。

  共起検索

共起検索は入力途中のユーザのクエリから登録されている語を見つけます。共起検索では検索データベースとしてユーザの入力シーケンスを使います。これはクエリログやアクセスログなどから学習します。

例えば、以下のようなユーザの入力シーケンスがあるとします。
入力 | 検索実行
s | していない
se | していない
sea | していない
sear | していない
searc | していない
search | した
e | していない
en | していない
eng | していない
engi | していない
engin | していない
engine | していない
enginen | していない（入力ミス！）
engine | した

Groongaは以下のような補完ペアを作ります。:
入力 | 補完語
s | search
se | search
sea | search
sear | search
searc | search
e | engine
en | engine
eng | engine
engi | engine
engin | engine
engine | engine
enginen | engine

ユーザが検索を実行する前のすべての入力（例では"s"、"se"など）を検索を実行した語（例では"search"）に対応付けます。

厳密に言うとこの説明は正しくありません。なぜならタイムスタンプに関することを省略しているからです。groongaは本当は「ユーザが検索を実行する前のすべての入力を」使いません。厳密には「ユーザが検索を実行する前の1分以内の入力のみ」を使います。検索実行時から1分より前の入力は使われません。

ユーザが"sea"と入力したら、共起検索は"search"を返します。なぜなら、「入力」カラムには"sea"という値があり、対応する「補完語」カラムには"search"という値が入っているからです。

  前方一致検索

前方一致検索はユーザが入力した文字列から始まる登録済みの語を検索します。この検索は前方一致RK検索とは違ってローマ字、カタカナ、ひらがなを特別扱いしません。

この検索はいつも実行されるわけではありません。この検索は明示的に実行するように指示するか、前方一致RK検索と共起検索の両方がなにもヒットしないときのみ実行されます。

例えば、"search"が登録されているとします。ユーザは"s"、"se"、"sea"、"sear"、"searc"、"search"のどれでも"search"を補完候補として利用できます。

  使い方

Groongaは補完機能を使うために /reference/commands/suggest コマンドを用意しています。 --type complete オプションを使うと補完機能を利用できます。

例えば、"en"と入力したときの補完結果を取得するコマンドは以下のようになります。:

実行例:

suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "complete": [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "engine",
#         1
#       ]
#     ]
#   }
# ]

  学習方法

共起検索は学習データを使います。学習データはクエリログやアクセスログなどを元に作成します。学習データを作成するには、タイムスタンプ付きの入力シーケンスと、タイムスタンプ付きの検索実行時の入力内容が必要です。

例えば、ユーザが"engine"で検索したいとします。ユーザが以下のようなシーケンスで検索クエリを入力したとします。:

1.  2011-08-10T13:33:23+09:00: e

2.  2011-08-10T13:33:23+09:00: en

3.  2011-08-10T13:33:24+09:00: eng

4.  2011-08-10T13:33:24+09:00: engi

5.  2011-08-10T13:33:24+09:00: engin

6.  2011-08-10T13:33:25+09:00: engine （検索実行！）

    以下のコマンドでこの入力シーケンスから学習できます。:

    load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
    [
    {"sequence": "1", "time": 1312950803.86057, "item": "e"},
    {"sequence": "1", "time": 1312950803.96857, "item": "en"},
    {"sequence": "1", "time": 1312950804.26057, "item": "eng"},
    {"sequence": "1", "time": 1312950804.56057, "item": "engi"},
    {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
    {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
    ]

  読みデータの更新方法

前方一致RK検索をするために単語とその読みが必要になります。このセクションではどのように単語と読みを登録するかを説明します。

以下は「日本」を登録する例です:

実行例:

load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

以下は「日本」を補完するために読みデータを登録する例です:

実行例:

load --table item_query
[
{"_key":"日本", "kana":["ニホン", "ニッポン"]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]

これで「nihon」というローマ字で登録済みの「日本」という単語を補完できます。

実行例:

suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "complete": [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "日本",
#         2
#       ]
#     ]
#   }
# ]

この読みデータがないと登録済みの「日本」という単語を「nihon」というクエリーで補完できません。

item_query テーブルの kana カラムは /reference/columns/vector なので、複数の読みを登録できます。

これが「nippon」でも「日本」を補完できる理由です。

実行例:

suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "complete": [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "日本",
#         2
#       ]
#     ]
#   }
# ]

日本語入力システムが無効になっている状態でも登録済みの単語を検索できるのでこの機能はとても便利です。

補完候補が複数ある場合、 item_query テーブルの boost カラムに値を設定することで優先度をカスタマイズすることができます。

以下は前方一致RK検索での優先度をカスタマイズする例です:

実行例:

load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"}
{"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
load --table item_query
[
{"_key":"日本語", "kana":"ニホンゴ"}
{"_key":"日本人", "kana":"ニホンジン"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "complete": [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "日本",
#         2
#       ],
#       [
#         "日本人",
#         2
#       ],
#       [
#         "日本語",
#         2
#       ]
#     ]
#   }
# ]
load --table item_query
[
{"_key":"日本人", "boost": 100},
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "complete": [
#       [
#         3
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "日本人",
#         102
#       ],
#       [
#         "日本",
#         2
#       ],
#       [
#         "日本語",
#         2
#       ]
#     ]
#   }
# ]

  補正

このセクションでは以下の補正機能について説明します。:

•   どのように動作するか

•   使い方

•   学習方法

  どのように動作するか

補正機能は補正した語を計算するために3種類の検索を使います。:

1.  学習したデータを共起検索。

2.  登録されている語を類似検索。（実行しないこともある）

  共起検索

共起検索はユーザの間違って入力した文字列から登録済みの語を検索します。共起検索ではユーザがどのように検索を実行したかを使います。ユーザがどのように検索したかはクエリログやアクセスログから学習します。

例えば、ユーザが以下のように検索を実行したとします。:
query | 時刻
serach （入力ミス！） | 2011-08-10T22:20:50+09:00
search （修正！） | 2011-08-10T22:20:52+09:00

上記の検索実行ログから以下のような補正ペアを作ります。
入力 | 補正された語
serach | search

1分以内の連続して実行された検索をユーザが入力を補正したものとみなします。検索を実行した間の入力途中の入力シーケンスは、補正用の学習データとしては利用しません。

ユーザが"serach"と入力した場合、共起検索は"saerch"を返します。なぜなら、"serach"が「入力」カラムにあり、対応する「補正される語」カラムの値が"search"だからです。

  類似文書検索

類似検索はユーザの入力をトークナイズし、同じトークンを含んだ登録済みの語を検索します。トークナイズにはTokenBigramトークナイザーを使います。これは /reference/executables/groonga-suggest-create-dataset が作るサジェストデータセットスキーマではデフォルトトークナイザーとしてTokenBigramトークナイザーを使っているからです。

例えば、"search engine"という語が登録されているとします。ユーザが"web search service"や"sound engine"などで検索すると"search engine"が補正候補になります。なぜなら、"search engine"と"web search engine"は"search"という同じトークンを持つからです。また、"search engine"と"sound engine"は"engine"という同じトークンを持っています。

"search engine"は"search"トークンと"engine"トークンにトークナイズされます。（GroongaのTokenBigramトークナイザーは連続するアルファベットと数字を2文字にトークナイズしません。これは検索ノイズを減らす為です。確実に2文字でトークナイズするためにはTokenBigramSplitSymbolAlphaDigitを使います。）"web search service"は"web"トークンと"search"トークンと"service"トークンにトークナイズされます。"sound engine"は"sound"トークンと"engine"トークンにトークナイズされます。

  使い方

Groongaは補正機能を使うために /reference/commands/suggest コマンドを用意しています。 --type correct オプションを使うと補正機能を利用できます。

例えば、"saerch"と入力した時の補正結果取得するコマンドは以下のようになります。:

実行例:

suggest --table item_query --column kana --types correction --frequency_threshold 1 --query saerch
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "correct": [
#       [
#         1
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "search",
#         1
#       ]
#     ]
#   }
# ]

  学習方法

共起検索は学習データを使います。学習データはクエリログやアクセスログから作ります。学習データを作るためにはユーザが検索を実行したときの検索クエリとタイムスタンプが必要です。

例えば、ユーザが"search"で検索したかったとします。しかし、ユーザは正しい"search"というクエリで検索を実行する前に間違って"saerch"で検索してしまいました。このユーザの入力シーケンスは以下のようになります。:

1.  2011-08-10T13:33:23+09:00: s

2.  2011-08-10T13:33:23+09:00: sa

3.  2011-08-10T13:33:24+09:00: sae

4.  2011-08-10T13:33:24+09:00: saer

5.  2011-08-10T13:33:24+09:00: saerc

6.  2011-08-10T13:33:25+09:00: saerch （検索実行！）

7.  2011-08-10T13:33:29+09:00: serch （修正中…）

8.  2011-08-10T13:33:30+09:00: search （検索実行！）

    以下のコマンドでこの入力シーケンスから学習できます。:

    load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
    [
    {"sequence": "1", "time": 1312950803.86057, "item": "s"},
    {"sequence": "1", "time": 1312950803.96857, "item": "sa"},
    {"sequence": "1", "time": 1312950804.26057, "item": "sae"},
    {"sequence": "1", "time": 1312950804.56057, "item": "saer"},
    {"sequence": "1", "time": 1312950804.76057, "item": "saerc"},
    {"sequence": "1", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
    {"sequence": "1", "time": 1312950809.76057, "item": "serch"},
    {"sequence": "1", "time": 1312950810.86057, "item": "search", "type": "submit"}
    ]

  提案

このセクションでは以下の補完機能について説明します。:

•   どのように動作するか

•   使い方

•   学習方法

  どのように動作するか

提案機能は提案する語を計算するために1種類の検索を使います。:

1.  学習したデータを共起検索。

  共起検索

共起検索はユーザの入力と関連する語を検索します。共起検索ではユーザの実行したときの検索クエリを使います。このデータはクエリログやアクセスログなどから学習します。

例えば、ユーザが以下のように検索を実行したとします。:
query
search engine
web search realtime

Groongaは以下のような提案ペアを作成します。
入力 | 提案される語
search | search engine
engine | search engine
web | web search realtime
search | web search realtime
realtime | web search realtime

これらのペアは以下の手順で作成します。:

1.  ユーザの入力をTokenDelimitトークナイザーでトークナイズします。TokenDelimitは空白をトークンの区切りに使います。（例えば、"search engine"は"search"トークンと"engine"トークンの2つのトークンにトークナイズされます。）

2.  各トークンについて、トークンと元のクエリからなるペアを作成する。

    ユーザが"search"と入力したとき、共起検索は"search engine"と"web search raltime"を返します。これは、"search"が2つの「入力」カラムに含まれていて、対応するそれぞれの「提案される語」カラムの値が"search engine"と"web search realtime"だからです。

  使い方

Groongaは提案機能を使うために /reference/commands/suggest コマンドを用意しています。 --type suggest オプションを使うと提案機能を利用できます。

例えば、"search"と入力した時の提案結果を取得するコマンドは以下の通りです。:

実行例:

suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "suggest": [
#       [
#         2
#       ],
#       [
#         [
#           "_key",
#           "ShortText"
#         ],
#         [
#           "_score",
#           "Int32"
#         ]
#       ],
#       [
#         "search engine",
#         1
#       ],
#       [
#         "web search realtime",
#         1
#       ]
#     ]
#   }
# ]

  学習方法

共起検索は学習データを使います。学習データはクエリログやアクセスログなどを元に作成します。学習データを作成するには、タイムスタンプ付きの入力シーケンスと、タイムスタンプ付きの検索実行時の入力内容が必要です。

例えば、ユーザが"engine"で検索したいとします。ユーザが以下のようなシーケンスで検索クエリを入力したとします。:

1.  2011-08-10T13:33:25+09:00: search engine （検索実行）

2.  2011-08-10T13:33:28+09:00: web search realtime （検索実行）

    以下のコマンドで上記の検索実行結果から学習します。:

    load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
    [
    {"sequence": "1", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
    {"sequence": "1", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
    ]

  学習データを抽出する方法

The learning data is stored into item_DATASET and pair_DATASET tables. By using select command for such tables, you can all extract learing data.

Here is the query to extract all learning data:

select item_DATASET --limit -1
select pair_DATASET --filter 'freq0 > 0 || freq1 > 0 || freq2 > 0' --limit -1

Without '--limit -1', you can't get all data. In pair table, the valid value of freq0, freq1 and freq2 column must be larger than 0.

Don't execute above query via HTTP request because enourmous number of records are fetched.

  インデックス構築

Groongaは2.0.0から動的なインデックス構築方法と静的なインデックス構築方法を両方サポートしています。

  動的なインデックス構築方法

動的なインデックス構築方法では、登録された文書はインデックス構築中にすぐに検索できるようになります。しかし、静的なインデックス構築方法に比べてコストがかかります。

動的なインデックス構築方法は鮮度が重要な検索システムに適しています。例えば、つぶやきやニュースやブログ記事などを検索するシステムは鮮度が重要になるでしょう。動的なインデックス構築方法はできたばかりの文書を検索できるようにし、インデックス構築中も検索できます。

  静的なインデックス構築方法

静的なインデックス構築方法では、動的なインデックス構築方法よりもインデックス構築にかかるコストが小さくなります。インデックス構築時間は短くなるでしょう。インデックスは小さくなるでしょう。インデックス構築に必要なリソースは少なくなるでしょう。しかし、登録中の文書は登録しようとしている全ての文書のインデックス構築が終わるまで検索できません。

静的なインデックス構築方法は消費リソースが少ないことが重要な検索システムに適しています。鮮度が重要でないシステムであれば静的なインデックス構築方法が適しているでしょう。例えば、リファレンスマニュアルを検索するシステムは鮮度を重視しません。これは、リファレンスマニュアルはリリース時にだけ更新されるだけだからです。

  使い方

Groongaはデフォルトで動的なインデックス構築方法を使います。文書を登録するとすぐに検索できるようになります。

すでにデータが格納されているカラムにインデックスを追加した場合は静的なインデックス構築方法を使います。

スキーマを定義します。

実行例:

table_create Tweets TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tweets content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Lexicon TABLE_HASH_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]

データを登録します:

実行例:

load --table Tweets
[
{"content":"Hello!"},
{"content":"I just start it!"},
{"content":"I'm sleepy... Have a nice day... Good night..."}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]

インデックスがないときはシーケンシャルサーチで検索できます。

実行例:

select Tweets --match_columns content --query 'good nice'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "content",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "I'm sleepy... Have a nice day... Good night..."
#       ]
#     ]
#   ]
# ]

Tweets.content 用のインデックスを作成します。すでに Tweets.content に登録されているデータは静的なインデックス構築方法でインデックスを構築します:

実行例:

column_create Lexicon tweet COLUMN_INDEX|WITH_POSITION Tweets content
# [[0, 1337566253.89858, 0.000355720520019531], true]

インデックスありで検索します。1件ヒットします:

実行例:

select Tweets --match_columns content --query 'good nice'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "content",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "I'm sleepy... Have a nice day... Good night..."
#       ]
#     ]
#   ]
# ]

もう一度データを登録します。このデータ用のインデックスは動的なインデックス構築方法で構築します。

実行例:

load --table Tweets
[
{"content":"Good morning! Nice day."},
{"content":"Let's go shopping."}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]

検索すると新しく登録されたレコードもヒットします:

実行例:

select Tweets --match_columns content --query 'good nice'
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           "_id",
#           "UInt32"
#         ],
#         [
#           "content",
#           "ShortText"
#         ]
#       ],
#       [
#         3,
#         "I'm sleepy... Have a nice day... Good night..."
#       ],
#       [
#         4,
#         "Good morning! Nice day."
#       ]
#     ]
#   ]
# ]

  シャーディング

バージョン 5.0.0 で追加.

Groongaにはテーブルに格納できるレコード数に /limitations があります。1つのテーブルに268,435,455以上のレコードを追加できません。

この制限を解決するために、Groongaは時間ベースのシャーディング機能をサポートしています。

この機能は同一データベース内で動きます。複数のデータベースをまたいでは動きません。これは、このシャーディング機能はデータを複数のマシンに分散する用途では使えないということです。

もし、分散対応のシャーディング機能が欲しい場合は、 Mroonga または PGroonga を使ってください。MySQLまたはPostgreSQLが提供しているシャーディング機能を使うことができます。近い将来、 Droonga でも分散対応のシャーディング機能を使えるようになる予定です。

  概要

シャーディングは sharding プラグインとして実装されています。このプラグインはmrubyで書かれています。そのため、Groongaをビルドするときにmrubyを有効にする必要があります。

Groongaがmrubyをサポートしているかは /reference/executables/groonga の --version 引数を使うとわかります:

% groonga --version
groonga 5.0.5 [...,mruby,...]
configure options: <...>

mruby があればあなたのGroongaはmrubyをサポートしています。

sharding プラグインは検索系のコマンドだけを提供しています。これらのコマンドは /reference/commands/logical_select や /reference/commands/logical_range_filter というように、コマンド名に logical_ プレフィックスがついています。

sharding プラグインはスキーマ定義コマンドとデータロードコマンドをまだ提供していません。そのため、既存の /reference/commands/table_create 、 /reference/commands/column_create 、 /reference/commands/load コマンドを使う必要があります。

sharding プラグインを使うにはいくつかのルールに則ってテーブルとカラムを作る必要があります。これについては後述します。

  用語集
名前 | 説明
論理テーブル | 複数のシャードをあわせて1つに見せているテーブルです。Groongaのデータベースの中には存在しません。私たちの頭の中にだけあります。
論理テーブル名 | 論理テーブルの名前です。これはシャード名のプレフィックスです。例えば、 Logs が論理テーブル名で、 Logs_20150814 と Logs_20150815 がシャード名です。
シャード | 1日分または1ヶ月分のレコードを格納しているテーブルです。1つのシャードには一部のレコードのみがあります。 シャード名（＝テーブル名）は ${LOGICAL_TABLE_NAME}_${YYYYMMDD} というフォーマットか ${LOGICAL_TABLE_NAME}_${YYYYMM} というフォーマットになっています。 ${LOGICAL_TABLE_NAME} は論理テーブル名に置き換えてください。 ${YYYYMMDD} は日に置き換えてください。 ${YYYYMM} は月に置き換えてください。 例えば、 Logs_20150814 を分解すると Logs という論理テーブル名と 20150814 という日になります。

  ルール

TODO

  コマンド一覧

  Log

Groonga has two log files. They are process log and query log. Process log is for all of executables/groonga works. Query log is just for query processing.

  Process log

Process log is enabled by default. Log path can be customized by --log-path option. Each log has its log level. If a log is smaller than groonga process' log level, it's not logged. Log level can be customized by -l or commands/log_level.

  フォーマット

Process log uses the following format:

#{TIME_STAMP}|#{L}| #{MESSAGE}

TIME_STAMP
    It's time stamp uses the following format:

    YYYY-MM-DD hh:mm:ss.SSSSSS

YYYY
    Year with four digits.

MM  Month with two digits.

DD  Day with two digits.

hh  Hour with two digits.

mm  Minute with two digits.

ss  Second with two digits.

SSSSSS
    Microsecond with six digits.

    実行例:

    2011-07-05 06:25:18.345734

L   Log level with a character. Here is a character and log level map.

E   Emergency

A   Alert

C   Critical

e   Error

w   Warning

n   Notification

i   Information

d   Debug

-   Dump

    実行例:

    E

MESSAGE
    Details about the log with free format.

    実行例:

    log opened.

    実行例:

    2011-07-05 08:35:09.276421|n| grn_init
    2011-07-05 08:35:09.276553|n| RLIMIT_NOFILE(4096,4096)

  Query log

Query log is disabled by default. It can be enabled by --query-log-path option.

  フォーマット

Query log uses the following formats:

#{TIME_STAMP}|#{MESSAGE}
#{TIME_STAMP}|#{ID}|>#{QUERY}
#{TIME_STAMP}|#{ID}|:#{ELAPSED_TIME} #{PROGRESS}
#{TIME_STAMP}|#{ID}|<#{ELAPSED_TIME} #{RETURN_CODE}

TIME_STAMP
    It's time stamp uses the following format:

    YYYY-MM-DD hh:mm:ss.SSSSSS

YYYY
    Year with four digits.

MM  Month with two digits.

DD  Day with two digits.

hh  Hour with two digits.

mm  Minute with two digits.

ss  Second with two digits.

SSSSSS
    Microsecond with six digits.

    実行例:

    2011-07-05 06:25:18.345734

ID  ID of a thread. Groonga process creates threads to process requests concurrently. Each thread outputs some logs for a request. This ID can be used to extract a log sequence by a thread.

    実行例:

    45ea3034

>   A character that indicates query is started.

:   A character that indicates query is processing.

<   A character that indicates query is finished.

MESSAGE
    Details about the log with free format.

    実行例:

    query log opened.

QUERY
    A query to be processed.

    実行例:

    select users --match_columns hobby --query music

ELAPSED_TIME
    Elapsed time in nanoseconds since query is started.

    実行例:

    000000000075770
    (It means 75,770 nanoseconds.)

PROGRESS
    A processed work at the time.

    実行例:

    select(313401)
    (It means that 'select' is processed and 313,401 records are remained.)

RETURN_CODE
    A return code for the query.

    実行例:

    rc=0
    (It means return code is 0. 0 means GRN_SUCCESS.)

    実行例:

    2011-07-05 06:25:19.458756|45ea3034|>select Properties --limit 0
    2011-07-05 06:25:19.458829|45ea3034|:000000000072779 select(19)
    2011-07-05 06:25:19.458856|45ea3034|:000000000099998 output(0)
    2011-07-05 06:25:19.458875|45ea3034|<000000000119062 rc=0
    2011-07-05 06:25:19.458986|45ea3034|>quit

  チューニング

  概要

大きなデータベースを扱うためのチューニングパラメーターがいくつかあります。

  引数

このセクションではチューニングパラメーターについて説明します。

  1プロセスで開ける最大ファイル数

このパラメーターは大きなデータベースを扱うためのパラメーターです。

Groongaは1つのテーブル・カラムごとに1つ以上のファイルを作ります。もし、データベース内にたくさんのテーブル・カラムがある場合は、Groongaプロセスはたくさんのファイルを開く必要があります。

システムでは1プロセスごとに開ける最大ファイル数を制限しています。そのため、この制限を緩和する必要があります。

Groongaがどのくらいファイルを開くのかを計算する式は次の通りです。:

3 (for DB) +
  N tables +
  N columns (except index clumns) +
  (N index columns * 2) +
  X (the number of plugins etc.)

次のスキーマを例として考えます。:

table_create Entries TABLE_HASH_KEY ShortText
column_create Entries content COLUMN_SCALAR Text
column_create Entries n_likes COLUMN_SCALAR UInt32
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content

この例では少なくとも11ファイル開きます。:

3 +
  2 (Entries and Terms) +
  2 (Entries.content and Entries.n_likes) +
  4 (Terms.entries_key_index and Terms.entries_content_index) +
  X = 11 + X

  メモリ使用量

このパラメーターは大きなデータベースを扱うためのパラメーターです。

Groongaはデータベースファイルをメモリー上にマップしてデータベース内のデータにアクセスします。Groongaはすべてのファイルをマップするわけではなく、そのファイルの内容が必要になった段階でマップします。

データベース内のすべてのデータにアクセスすると、データベースのすべてのファイルをメモリー上にマップします。もし、データベースファイルの総サイズが6GiBなら、Groongaプロセスも6GiBのメモリーを使います。

通常、データベースのすべてのファイルをメモリー上にマップすることはありません。しかし、マップすることもあります。たとえば、データベースの内容をダンプするときです。

通常、メモリーとスワップをあわせてデータベースのサイズより大きな量を用意する必要があります。Linuxにはメモリーとスワップの総量がデータベースサイズよりも小さくても動くようにできるチューニングパラメーターがあります。

  Linux

このセクションではLinux上でパラメーターをカスタマイズする方法について説明します。

  nofile

次の内容の /etc/security/limits.d/groonga.conf 設定ファイルを作ることで 1プロセスで開ける最大ファイル数 パラメーターの制限を緩和することができます。:

${USER} soft nofile ${MAX_VALUE}
${USER} hard nofile ${MAX_VALUE}

Groongaプロセスを groonga ユーザーで動かし、Groongaプロセスが10000以下のファイルを開くなら、次の設定を使います。:

groonga soft nofile 10000
groonga hard nofile 10000

この設定はGroongaサービスが再起動したあと、あるいは、 groonga ユーザーがログインし直したときに反映されます。

  vm.overcommit_memory

これは メモリ使用量 関連のパラメーターです。 vm.overcommit_memory カーネルパラメーターを 1 に設定することで、メモリーとスワップの総量以上のサイズのデータベースを扱うことができます。 1 は「Groongaは常にデータベースファイルをメモリー上にマップできる」という意味です。Groongaはこの設定を推奨しています。

vm.overcommit_memory パラメーターの詳細は overcommitに関するLinuxカーネルのドキュメント を参照してください。

次の内容の /etc/sysctl.d/groonga.conf 設定ファイルを作成することでこの設定をすることができます。:

vm.overcommit_memory = 1

設定した内容はシステムを再起動するか、次のコマンドを実行することで反映されます。:

% sudo sysctl --system

  vm.max_map_count

これは メモリ使用量 関連のパラメーターです。 vm.max_map_count カーネルパラメーターの値を増やすことで16GiB以上のサイズのデータベースを扱うことができます。このパラメーターはメモリーマップの回数を制限します。

このカーネルパラメーターのデフォルト値は 65530 か 65536 です。Groongaは一度に256KiBずつメモリー上にマップします。データベースが16GiBよりも大きい場合、Groongaはこの制限に達します。（ 256KiB * 65536 = 16GiB ）

16GiB以上のサイズのデータベースを扱う場合はこのカーネルパラメーターの値を増やす必要があります。たとえば、 65536 * 2 = 131072 まで増やすと32GiBくらいのデータベースを扱うことができます。次の内容の設定ファイルを /etc/sysctl.d/groonga.conf に置くとこの設定適用できます。:

vm.max_map_count = 131072

すでに vm.overcommit_memory の設定があるはずなので、実際の設定ファイルの内容は次のようになることに注意してください。:

vm.overcommit_memory = 1
vm.max_map_count = 131072

設定した内容はシステムを再起動するか、次のコマンドを実行することで反映されます。:

% sudo sysctl -p

  FreeBSD

このセクションではFreeBSD上で引数をカスタマイズする方法を説明します。

  kern.maxfileperproc

TODO

  API

Groongaを全文検索ライブラリとして使うことができます。この節ではGroongaが提供しているAPIを示します。

  概要

  概要

Groongaをライブラリーとして使うことができます。Groongaを初期化・終了するために次のAPIを使う必要があります。

grn_init() はGroongaを初期化します。一方、 grn_fin() はGroongaを終了します。

Groongaが提供するAPIを使う前に grn_init() を1度だけ呼ぶ必要があります。Groongaが提供するAPIを呼び終わったら、 grn_fin() を1度だけ呼ぶ必要があります。

  例

以下はGroongaを全文検索ライブラリーとして使う例です。

grn_rc rc;
/* It initializes resources used by Groonga. */
rc = grn_init();
if (rc != GRN_SUCCESS) {
  return EXIT_FAILURE;
}
/* Some Groonga API calling codes... */
/* It releases resources used by Groonga. */
grn_fin();
return EXIT_SUCCESS;

  リファレンス

grn_rc grn_init(void)
    grn_init() はGroongaが使うリソースを初期化します。他のGroongaのAPIを呼ぶ前に1度だけこれを呼ぶ必要があります。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_rc grn_fin(void)
    grn_fin() はGroongaが使ったリソースを解放します。 grn_fin() を呼んだ後はGroongaのAPIを呼ぶことはできません。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

  全体設定

  概要

Groongaにはグローバルな設定があります。それらにアクセスするにはAPIを使います。

  リファレンス

int grn_get_lock_timeout(void)
    ロックタイムアウトを返します。

    grn_ctx acquires a lock for updating a shared value. If other grn_ctx is already updating the same value, grn_ctx that try to acquire a lock can't acquires a lock. The grn_ctx that can't acquires a lock waits 1 millisecond and try to acquire a lock again. The try is done timeout times. If the grn_ctx that can't acquires a lock until timeout times, the tries are failed.

    デフォルトのロックタイムアウトは 10000000 です。つまりGroongaはロックの失敗をおよそ3時間経過するまで報告しません。(1 * 10000000 [msec] = 10000 [sec] = 166.666... [min] = 2.777... [hour])

戻り値 ロックタイムアウト。

grn_rc grn_set_lock_timeout(int timeout)
    ロックタイムアウトを設定します。

    ロックタイムアウトについては、 grn_get_lock_timeout() を参照してください。

    timeout にはいくつか特別な値があります。

•   0: Groongaがロックを再度取得しようとしません。一度ロックの取得に失敗した時点でGroongaはその失敗を報告します。

•   負数: Groongaはロックを取得できるまでリトライします。

パラメタ

•   timeuot -- 新しいロックのタイムアウト。

戻り値 GRN_SUCCESS 。この関数は失敗しません。

  Plugin

  概要

Groonga supports plugin. You can create a new plugin with the following API.

TOOD: Describe about how to create the minimum plugin here or create a tutorial about it.

  リファレンス

grn_rc GRN_PLUGIN_INIT(grn_ctx *ctx)

grn_rc GRN_PLUGIN_REGISTER(grn_ctx *ctx)

grn_rc GRN_PLUGIN_FIN(grn_ctx *ctx)

GRN_PLUGIN_MALLOC(ctx, size)
    GRN_PLUGIN_MALLOC() allocates size bytes and returns a pointer to the allocated memory space. Note that the memory space is associated with ctx.

GRN_PLUGIN_REALLOC(ctx, ptr, size)
    GRN_PLUGIN_REALLOC() resizes the memory space pointed to by ptr or allocates a new memory space of size bytes. GRN_PLUGIN_REALLOC() returns a pointer to the memory space. The contents is unchanged or copied from the old memory space to the new memory space.

GRN_PLUGIN_FREE(ctx, ptr)
    GRN_PLUGIN_FREE() frees a memory space allocated by GRN_PLUGIN_MALLOC() or GRN_PLUGIN_REALLOC(). This means that ptr must be a pointer returned by GRN_PLUGIN_MALLOC() or GRN_PLUGIN_REALLOC().

GRN_PLUGIN_LOG(ctx, level, ...)
    GRN_PLUGIN_LOG() reports a log of level. Its error message is generated from the varying number of arguments, in which the first one is the format string and the rest are its arguments. See grn_log_level in "groonga.h" for more details of level.

GRN_PLUGIN_ERROR(ctx, error_code, ...)
    GRN_PLUGIN_ERROR() reports an error of error_code. Its error message is generated from the varying number of arguments, in which the first one is the format string and the rest are its arguments. See grn_rc in "groonga.h" for more details of error_code.

grn_plugin_mutex
    grn_plugin_mutex is available to make a critical section. See the following functions.

grn_plugin_mutex *grn_plugin_mutex_open(grn_ctx *ctx)
    grn_plugin_mutex_open() returns a pointer to a new object of grn_plugin_mutex. Memory for the new object is obtained with GRN_PLUGIN_MALLOC(). grn_plugin_mutex_open() returns NULL if sufficient memory is not available.

void grn_plugin_mutex_close(grn_ctx *ctx, grn_plugin_mutex *mutex)
    grn_plugin_mutex_close() finalizes an object of grn_plugin_mutex and then frees memory allocated for that object.

void grn_plugin_mutex_lock(grn_ctx *ctx, grn_plugin_mutex *mutex)
    grn_plugin_mutex_lock() locks a mutex object. If the object is already locked, the calling thread waits until the object will be unlocked.

void grn_plugin_mutex_unlock(grn_ctx *ctx, grn_plugin_mutex *mutex)
    grn_plugin_mutex_unlock() unlocks a mutex object. grn_plugin_mutex_unlock() should not be called for an unlocked object.

grn_obj *grn_plugin_proc_alloc(grn_ctx *ctx, grn_user_data *user_data, grn_id domain, grn_obj_flags flags)
    grn_plugin_proc_alloc() allocates a grn_obj object. You can use it in function that is registered as GRN_PROC_FUNCTION.

grn_obj grn_plugin_proc_get_var(grn_ctx *ctx, grn_user_data *user_data, const char *name, int name_size)
    It gets a variable value from grn_user_data by specifying the variable name.

パラメタ

•   name -- 変数名。

•   name_size -- The number of bytes of name. If name_size is negative, name must be NUL-terminated. name_size is computed by strlen(name) for the case.

戻り値 成功すると変数の値を返します。失敗するとNULLを返します。

grn_obj *grn_plugin_proc_get_var_by_offset(grn_ctx *ctx, grn_user_data *user_data, unsigned int offset)
    It gets a variable value from grn_user_data by specifying the offset position of the variable.

パラメタ

•   offset -- The offset position of the variable.

戻り値 成功すると変数の値を返します。失敗するとNULLを返します。

const char *grn_plugin_win32_base_dir(void)
    バージョン 5.0.9. で撤廃: Use grn_plugin_windows_base_dir() instead.

    It returns the Groonga install directory. The install directory is computed from the directory that has groonga.dll. You can use the directory to generate install directory aware path. It only works on Windows. It returns NULL on other platforms.

const char *grn_plugin_windows_base_dir(void)
    バージョン 5.0.9 で追加.

    It returns the Groonga install directory. The install directory is computed from the directory that has groonga.dll. You can use the directory to generate install directory aware path. It only works on Windows. It returns NULL on other platforms.

int grn_plugin_charlen(grn_ctx *ctx, const char *str_ptr, unsigned int str_length, grn_encoding encoding)
    grn_plugin_charlen() returns the length (#bytes) of the first character in the string specified by str_ptr and str_length. If the starting bytes are invalid as a character, grn_plugin_charlen() returns 0. See grn_encoding in "groonga.h" for more details of encoding.

int grn_plugin_isspace(grn_ctx *ctx, const char *str_ptr, unsigned int str_length, grn_encoding encoding)
    grn_plugin_isspace() returns the length (#bytes) of the first character in the string specified by str_ptr and str_length if it is a space character. Otherwise, grn_plugin_isspace() returns 0.

grn_rc grn_plugin_expr_var_init(grn_ctx *ctx, grn_expr_var *var, const char *name, int name_size)
    It initializes a grn_expr_var.

パラメタ

•   var -- The pointer of grn_expr_var object to be initialized.

•   name -- The name of grn_expr_var object to be initialized.

•   name_size -- The number of bytes of name. If name_size is negative, name must be NUL-terminated. name_size is computed by strlen(name) for the case.

戻り値 GRN_SUCCESS 。この関数は失敗しません。

grn_obj * grn_plugin_command_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_func func, unsigned int n_vars, grn_expr_var *vars)
    It creates a command.

パラメタ

•   name -- The proc name of the command to be created.

•   name_size -- The number of bytes of name. If name_size is negative, name must be NUL-terminated. name_size is computed by strlen(name) for the case.

•   func -- The function name to be called by the created command.

•   n_vars -- The number of the variables of the command to create.

•   vars -- The pointer of initialized grn_expr_var object.

戻り値 The created command object if it creates a command successfully, NULL otherwise. See ctx for error details.

  grn_cache

  概要

注釈: このAPIは実験的です。

grn_cache は /reference/commands/select コマンドのレスポンスを保持するためのデータストアです。一般的なオブジェクトのキャッシュとして使うものではありません。あくまで /reference/commands/select コマンドのためのものです。

grn_cache_current_set() を使うことで現在のキャッシュオブジェクトを変更することができます。 /reference/commands/select コマンドのレスポンスが内部的に用いられます。

/reference/commands/select コマンドは、一つのグローバルキャッシュオブジェクトを利用します。もし複数のデータベースをオープンしていた場合、そのキャッシュオブジェクトは共有されます。これは重要な問題です。

もし複数のデータベースを開き、 /reference/commands/select コマンドを使用するのであれば、 grn_cache オブジェクトを使う必要があります。 /reference/executables/groonga-httpd のようなケースが該当します。もし一つのデータベースのみを開く場合や、 /reference/commands/select コマンドを使わない場合は、 grn_cache オブジェクトを使う必要はありません。 Rroonga <http://ranguba.org/ja/#about-rroonga> のようなケースです。

  例

以下はキャッシュを変更する例です。

grn_cache *cache;
grn_cache *cache_previous;
cache = grn_cache_open(ctx);
cache_previous = grn_cache_current_get(ctx);
grn_cache_current_set(ctx, cache);
/* grn_ctx_send(ctx, ...); */
grn_cache_current_set(ctx, cache_previous);

  リファレンス

grn_cache
    grn_cache は詳細を公開していないオブジェクトです。 grn_cache_open() で作成し、 grn_cache_close() で解放できます。

grn_cache *grn_cache_open(grn_ctx *ctx)
    新規にキャッシュオブジェクトを作成します。

    新しいキャッシュオブジェクト作成のためのメモリ割り当てに失敗した場合、 NULL を返します。エラー情報は ctx に格納されます。

パラメタ

•   ctx -- その時点のコンテキスト。

戻り値 新しいキャッシュオブジェクトの作成に成功した場合は NULL 以外の値を返します。このキャッシュオブジェクトは grn_cache_close() で解放されなければなりません。

grn_rc grn_cache_close(grn_ctx *ctx, grn_cache *cache)
    cache のリソースを解放。

パラメタ

•   ctx -- その時点のコンテキスト。

•   cache -- キャッシュオブジェクトを解放する。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_rc grn_cache_current_set(grn_ctx *ctx, grn_cache *cache)
    /reference/commands/select コマンドで使われるキャッシュオブジェクトを設定します。

パラメタ

•   ctx -- その時点のコンテキスト。

•   cache -- /reference/commands/select コマンドで使われるキャッシュオブジェクト。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_cache *grn_cache_current_get(grn_ctx *ctx)
    /reference/commands/select コマンドで使われるキャッシュオブジェクトを取得します。

パラメタ

•   ctx -- その時点のコンテキスト。

戻り値 /reference/commands/select コマンドで使われるキャッシュオブジェクト。 NULL のこともあります。

grn_rc grn_cache_set_max_n_entries(grn_ctx *ctx, grn_cache *cache, unsigned int n)
    キャッシュオブジェクトのエントリの最大数を設定します。

パラメタ

•   ctx -- その時点のコンテキスト。

•   cache -- 変更するキャッシュオブジェクト。

•   n -- キャッシュオブジェクトの新しい最大エントリ数。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

unsigned int grn_cache_get_max_n_entries(grn_ctx *ctx, grn_cache *cache)
    キャッシュオブジェクトのエントリの最大数を取得します。

パラメタ

•   ctx -- その時点のコンテキスト。

•   cache -- ターゲットキャッシュオブジェクト。

戻り値 キャッシュオブジェクトの最大エントリ数。

  grn_column

  概要

TODO...

  例

TODO...

  リファレンス

GRN_COLUMN_NAME_ID
    /reference/columns/pseudo _id の名前を返します。

    以下のように GRN_COLUMN_NAME_ID_LEN と一緒に使うと便利です:

    grn_obj *id_column;
    id_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_ID, GRN_COLUMN_NAME_ID_LEN);

    3.1.1から。

GRN_COLUMN_NAME_ID_LEN
    It returns the byte size of GRN_COLUMN_NAME_ID.

    3.1.1から。

GRN_COLUMN_NAME_KEY
    It returns the name of /reference/columns/pseudo _key.

    It is useful to use with GRN_COLUMN_NAME_KEY_LEN like the following:

    grn_obj *key_column;
    key_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_KEY, GRN_COLUMN_NAME_KEY_LEN);

    3.1.1から。

GRN_COLUMN_NAME_KEY_LEN
    It returns the byte size of GRN_COLUMN_NAME_KEY.

    3.1.1から。

GRN_COLUMN_NAME_VALUE
    It returns the name of /reference/columns/pseudo _value.

    It is useful to use with GRN_COLUMN_NAME_VALUE_LEN like the following:

    grn_obj *value_column;
    value_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_VALUE, GRN_COLUMN_NAME_VALUE_LEN);

    3.1.1から。

GRN_COLUMN_NAME_VALUE_LEN
    It returns the byte size of GRN_COLUMN_NAME_VALUE.

    3.1.1から。

GRN_COLUMN_NAME_SCORE
    /reference/columns/pseudo _score の名前を返します。

    以下のように GRN_COLUMN_NAME_SCORE_LEN と一緒に使うと便利です:

    grn_obj *score_column;
    score_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_SCORE, GRN_COLUMN_NAME_SCORE_LEN);

    3.1.1から。

GRN_COLUMN_NAME_SCORE_LEN
    GRN_COLUMN_NAME_SCORE のサイズをバイト数で返します。

    3.1.1から。

GRN_COLUMN_NAME_NSUBRECS
    /reference/columns/pseudo _nsubrecs の名前を返します

    以下のように GRN_COLUMN_NAME_NSUBRECS_LEN と一緒に使うと便利です:

    grn_obj *nsubrecs_column;
    nsubrecs_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_NSUBRECS, GRN_COLUMN_NAME_NSUBRECS_LEN);

    3.1.1から。

GRN_COLUMN_NAME_NSUBRECS_LEN
    GRN_COLUMN_NAME_NSUBRECS のサイズをバイト数で返す。

    3.1.1から。

grn_obj *grn_column_create(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size, const char *path, grn_obj_flags flags, grn_obj *type)
    tableに新たなカラムを定義します。nameは省略できません。一つのtableに同一のnameのcolumnを複数定義することはできません。

パラメタ

•   table -- 対象tableを指定します。

•   name -- カラム名を指定します。

•   name_size -- nameパラメータのsize(byte)を指定します。

•   path -- カラムを格納するファイルパスを指定します。 flagsに GRN_OBJ_PERSISTENT が指定されている場合のみ有効です。 NULLなら自動的にファイルパスが付与されます。

•   flags --

    GRN_OBJ_PERSISTENT を指定すると永続columnとなります。

    GRN_OBJ_COLUMN_INDEX を指定すると転置インデックスとなります。

    GRN_OBJ_COLUMN_SCALAR を指定するとスカラ値(単独の値)を格納します。

    GRN_OBJ_COLUMN_VECTOR を指定すると値の配列を格納します。

    GRN_OBJ_COMPRESS_ZLIB を指定すると値をzlib圧縮して格納します。

    GRN_OBJ_COMPRESS_LZO を指定すると値をlzo圧縮して格納します。

    GRN_OBJ_COLUMN_INDEX と共に GRN_OBJ_WITH_SECTION を指定すると、転置索引にsection(段落情報)を合わせて格納します。

    GRN_OBJ_COLUMN_INDEX と共に GRN_OBJ_WITH_WEIGHT を指定すると、転置索引にweight情報を合わせて格納します。

    GRN_OBJ_COLUMN_INDEX と共に GRN_OBJ_WITH_POSITION を指定すると、転置索引に出現位置情報を合わせて格納します。

•   type -- カラム値の型を指定します。定義済みのtypeあるいはtableを指定できます。

grn_rc grn_column_index_update(grn_ctx *ctx, grn_obj *column, grn_id id, unsigned int section, grn_obj *oldvalue, grn_obj *newvalue)
    oldvalue, newvalueの値から得られるキーに対応するcolumnの値の中の、id, sectionに対応するエントリを更新します。columnは GRN_OBJ_COLUMN_INDEX 型のカラムでなければなりません。

パラメタ

•   column -- 対象columnを指定します。

•   id -- 対象レコードのIDを指定します。

•   section -- 対象レコードのセクション番号を指定します。

•   oldvalue -- 更新前の値を指定します。

•   newvalue -- 更新後の値を指定します。

grn_obj *grn_column_table(grn_ctx *ctx, grn_obj *column)
    columnが属するtableを返します。

パラメタ

•   column -- 対象columnを指定します。

grn_rc grn_column_rename(grn_ctx *ctx, grn_obj *column, const char *name, unsigned int name_size)
    ctxが使用するdbにおいてcolumnに対応する名前をnameに更新します。columnは永続オブジェクトでなければいけません。

パラメタ

•   column -- 対象columnを指定します。

•   name -- 新しい名前を指定します。

•   name_size -- nameパラメータのsize（byte）を指定します。

int grn_column_name(grn_ctx *ctx, grn_obj *obj, char *namebuf, int buf_size)
    カラムobjの名前の長さを返します。buf_sizeの長さが名前の長さ以上であった場合は、namebufに該当する名前をコピーします。

パラメタ

•   obj -- 対象objectを指定します。

•   namebuf -- 名前を格納するバッファ（呼出側で準備する）を指定します。

•   buf_size -- namebufのサイズ（byte長）を指定します。

int grn_column_index(grn_ctx *ctx, grn_obj *column, grn_operator op, grn_obj **indexbuf, int buf_size, int *section)
    columnに張られているindexのうち、opの操作を実行可能なものの数を返します。またそれらのidを、buf_sizeに指定された個数を上限としてindexbufに返します。

パラメタ

•   column -- 対象のcolumnを指定します。

•   op -- indexで実行したい操作を指定します。

•   indexbuf -- indexを格納するバッファ（呼出側で準備する）を指定します。

•   buf_size -- indexbufのサイズ（byte長）を指定します。

•   section -- section番号を格納するint長バッファ（呼出側で準備する）を指定します。

grn_rc grn_column_truncate(grn_ctx *ctx, grn_obj *column)

    注釈: This is a dangerous API. You must not use this API when other thread or process accesses the target column. If you use this API against shared column, the process that accesses the column may be broken and the column may be broken.

    バージョン 4.0.9 で追加.

    Clears all values in the column.

パラメタ

•   column -- truncate対象のカラム。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

  grn_command_version

  概要

TODO...

  例

TODO...

  リファレンス

grn_command_version

GRN_COMMAND_VERSION_MIN

GRN_COMMAND_VERSION_STABLE

GRN_COMMAND_VERSION_MAX

grn_command_version grn_get_default_command_version(void)
    デフォルトのcommand_versionを返します。

grn_rc grn_set_default_command_version(grn_command_version version)
    デフォルトのcommand_versionを変更します。

パラメタ

•   version -- 変更後のデフォルトのcommand_versionを指定します。

  grn_content_type

  概要

grn_content_type shows input type and output type. Currently, it is used only for output type.

Normally, you don't need to use this type. It is used internally in grn_ctx_send().

  リファレンス

grn_content_type
    指定可能な値は以下の通りです。

GRN_CONTENT_NONE
    It means that outputting nothing or using the original format. /reference/commands/dump uses the type.

GRN_CONTENT_TSV
    It means tab separated values format.

GRN_CONTENT_JSON
    JSON形式:

GRN_CONTENT_XML
    It means XML format.

GRN_CONTENT_MSGPACK
    It means MessagePack format. You need MessagePack library on building Groonga. If you don't have MessagePack library, you can't use this type.

  grn_ctx

  概要

grn_ctx は最も重要なオブジェクトです。grn_ctx はその時点の情報を保持します:

•   最後に発生したエラー。

•   その時点のエンコーディング。

•   デフォルトの閾値。（例: select-match-escalation-threshold）

•   デフォルトのコマンドバージョン。（ /reference/command/command_version ）を参照のこと。

    grn_ctx は基盤となる機能を提供します:

•   メモリ管理機能

•   ロギング機能

    ほとんどのAPIは grn_ctx を最初の引数にとります。

    同じ grn_ctx を二つ以上のスレッドからは扱えません。grn_ctx はスレッドごとに作成する必要があります。一つのスレッドでは grn_ctx を二つ以上扱えますが、通常はその必要はありません。

  例

TODO...

  リファレンス

grn_ctx
    TODO...

grn_rc grn_ctx_init(grn_ctx *ctx, int flags)
    ctxを初期化します。

パラメタ

•   ctx -- 初期化するctx構造体へのポインタを指定します。

•   flags -- 初期化する ctx のオプションを指定します。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_rc grn_ctx_fin(grn_ctx *ctx)
    ctxの管理するメモリを解放し、使用を終了します。

    grn_ctx_init() ではなく grn_ctx_open() で ctx を初期化した場合、 grn_ctx_fin() ではなく grn_ctx_close() を使わなければいけません。

パラメタ

•   ctx -- 解放するctx構造体へのポインタを指定します。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_ctx *grn_ctx_open(int flags)
    初期化された grn_ctx オブジェクトを返します。

    grn_ctx_init() で初期化された grn_ctx オブジェクトは構造体の実体をAPIの呼び元で確保するのに対して、 grn_ctx_open() ではGroongaライブラリの内部で、実体を確保します。 どちらで初期化された grn_ctx も、 grn_ctx_fin() で解放できます。 grn_ctx_open() で確保した grn_ctx 構造体に関しては、grn_ctx_fin() で解放した後に、その grn_ctx で作成した grn_obj を grn_obj_close() によって解放しても問題ありません。

パラメタ

•   flags -- 初期化する ctx のオプションを指定します。

戻り値 初期化された grn_ctx オブジェクトを返します。

grn_rc grn_ctx_close(grn_ctx *ctx)
    grn_ctx_fin() を呼び出し、その後、 grn_ctx_open() によって割り当てた ctx のメモリを解放する。

パラメタ

•   ctx -- もう使わない grn_ctx 。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_rc grn_ctx_set_finalizer(grn_ctx *ctx, grn_proc_func *func)
    ctxを破棄するときに呼ばれる関数を設定します。

パラメタ

•   ctx -- 対象ctxを指定します。

•   func -- ctx を破棄するときに呼ばれる関数を指定します。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_command_version grn_ctx_get_command_version(grn_ctx *ctx)
    command_versionを返します。

grn_rc grn_ctx_set_command_version(grn_ctx *ctx, grn_command_version version)
    command_versionを変更します。

パラメタ

•   version -- 変更後のcommand_versionを指定します。

grn_rc grn_ctx_use(grn_ctx *ctx, grn_obj *db)
    ctxが操作対象とするdbを指定します。NULLを指定した場合は、dbを操作しない状態(init直後の状態)になります。

    GRN_CTX_PER_DB フラグを指定した grn_ctx と一緒に使ってはいけません。

パラメタ

•   db -- ctxが使用するdbを指定します。

grn_obj *grn_ctx_db(grn_ctx *ctx)
    ctxが現在操作対象としているdbを返します。dbを使用していない場合はNULLを返します。

grn_obj *grn_ctx_get(grn_ctx *ctx, const char *name, int name_size)
    ctxが使用するdbからnameに対応するオブジェクトを検索して返す。nameに一致するオブジェクトが存在しなければNULLを返す。

パラメタ

•   name -- 検索しようとするオブジェクトの名前。

•   name_size -- 名前のバイト数。負の値が指定された場合は、終端をNULL文字とした文字列として扱われる。

grn_obj *grn_ctx_at(grn_ctx *ctx, grn_id id)
    ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。idに一致するオブジェクトが存在しなければNULLを返す。

パラメタ

•   id -- 検索しようとするオブジェクトのidを指定します。

grn_rc grn_ctx_get_all_tables(grn_ctx *ctx, grn_obj *tables_buffer)
    It pushes all tables in the database of ctx into tables_buffer. tables_buffer should be initialized as GRN_PVECTOR. You can use GRN_PTR_INIT() with GRN_OBJ_VECTOR flags to initialize tables_buffer.

    以下は例です。

    grn_rc rc;
    grn_obj tables;
    int i;
    int n_tables;
    GRN_PTR_INIT(&tables, GRN_OBJ_VECTOR, GRN_ID_NIL);
    rc = grn_ctx_get_all_tables(ctx, &tables);
    if (rc != GRN_SUCCESS) {
      GRN_OBJ_FIN(ctx, &tables);
      /* Handle error. */
      return;
    }
    n_tables = GRN_BULK_VSIZE(&tables) / sizeof(grn_obj *);
    for (i = 0; i < n_tables; i++) {
      grn_obj *table = GRN_PTR_VALUE_AT(&tables, i);
      /* Use table. */
    }
    /* Free resources. */
    for (i = 0; i < n_tables; i++) {
      grn_obj *table = GRN_PTR_VALUE_AT(&tables, i);
      grn_obj_unlink(ctx, table);
    }
    GRN_OBJ_FIN(ctx, &tables);

パラメタ

•   ctx -- その時点のコンテキスト。

•   table_buffer -- The output buffer to store tables.

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_content_type grn_ctx_get_output_type(grn_ctx *ctx)
    コンテキストの出力形式を取得します。

    Normally, this function isn't needed.

パラメタ

•   ctx -- その時点のコンテキスト。

戻り値 The output type of the context.

grn_rc grn_ctx_set_output_type(grn_ctx *ctx, grn_content_type type)
    Sets the new output type to the context. It is used by executing a command by grn_expr_exec(). If you use grn_ctx_send(), the new output type isn't used. grn_ctx_send() sets output type from command line internally.

    Normally, this function isn't needed.

パラメタ

•   ctx -- その時点のコンテキスト。

•   type -- 新しい出力形式。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_bool_rc grn_ctx_is_opened(grn_ctx *ctx, grn_id id)
    指定したIDのオブジェクトが開かれているかどうかをチェックします。

パラメタ

•   ctx -- その時点のコンテキスト。

•   id -- チェック対象のオブジェクトのID。

戻り値 指定したIDのオブジェクトが開かれていたら GRN_TRUE 、そうでなければ GRN_FALSE 。

  grn_db

  概要

TODO...

  例

TODO...

  リファレンス

TODO...

grn_db
    TODO...

grn_db_create_optarg
    grn_db_create() のオプションを指定するために使います。

char **grn_db_create_optarg.builtin_type_names
    組み込み型の名前となるnul終端文字列の配列を指定する。

int grn_db_create_optarg.n_builtin_type_names
    n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を 指定する。配列のoffsetはenum型grn_builtin_typeの値に対応する。

grn_obj *grn_db_create(grn_ctx *ctx, const char *path, grn_db_create_optarg *optarg)
    新たなdbを作成します。

パラメタ

•   ctx -- 初期化済みの grn_ctx を指定します。

•   path -- 作成するdbを格納するファイルパスを指定します。NULLならtemporary dbとなります。NULL以外のパスを指定した場合はpersistent dbとなります。

•   optarg --

    Currently, it is not used. It is just ignored.

    作成するdbの組み込み型の名前を変更する時に指定します。

    optarg.builtin_type_namesには、組み込み型の名前となるnull終端文字列の配列を指定します。optarg.n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を指定します。配列のoffsetはenum型grn_builtin_typeの値に対応します。

grn_obj *grn_db_open(grn_ctx *ctx, const char *path)
    既存のdbを開きます。

パラメタ

•   path -- 開こうとするdbを格納するファイルパスを指定します。

void grn_db_touch(grn_ctx *ctx, grn_obj *db)
    dbの内容の最終更新時刻を現在時刻にします。

    最終更新時刻はキャッシュが有効かどうかの判断などに利用されます。

パラメタ

•   db -- 内容が変更されたdbを指定します。

grn_obj *grn_obj_db(grn_ctx *ctx, grn_obj *obj)
    objの属するdbを返します。

パラメタ

•   obj -- 対象objectを指定します。

grn_rc grn_db_recover(grn_ctx *ctx, grn_obj *db)

    注釈: これは実験的なAPIです。

    注釈: This is a dangerous API. You must not use this API when other thread or process opens the target database. If you use this API against shared database, the database may be broken.

    バージョン 4.0.9 で追加.

    Checks the passed database and recovers it if it is broken and it can be recovered.

    This API uses lock existence for checking whether the database is broken or not.

    以下は復旧可能なケースです。

•   Index column is broken. The index column must have source column.

    以下は復旧できないケースです。

•   Object name management feature is broken.

•   Table is broken.

•   Data column is broken.

    Object name management feature is used for managing table name, column name and so on. If the feature is broken, the database can't be recovered. Please re-create the database from backup.

    Table and data column can be recovered by removing an existence lock and re-add data.

パラメタ

•   db -- 復旧対象のデータベース。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_rc grn_db_unmap(grn_ctx *ctx, grn_obj *db)

    注釈: これは実験的なAPIです。

    注釈: This is a thread unsafe API. You can't touch the database while this API is running.

    バージョン 5.0.7 で追加.

    Unmaps all opened tables and columns in the passed database. Resources used by these opened tables and columns are freed.

    Normally, this API isn't useless. Because resources used by opened tables and columns are managed by OS automatically.

パラメタ

•   db -- 復旧対象のデータベース。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

  grn_encoding

  概要

TODO...

  例

TODO...

  リファレンス

grn_encoding
    TODO...

grn_encoding grn_get_default_encoding(void)
    デフォルトのencodingを返します。

grn_rc grn_set_default_encoding(grn_encoding encoding)
    デフォルトのencodingを変更します。

パラメタ

•   encoding -- 変更後のデフォルトのencodingを指定します。

const char *grn_encoding_to_string(grn_encoding encoding)
    エンコーディングの形式を文字列で返します。たとえば'grn_encoding_to_string(GRN_ENC_UTF8)' は"utf8"を返します。

    無効なエンコーディングの場合は"unknown"を返します。

パラメタ

•   encoding -- その時点のエンコーディング。

grn_encoding grn_encoding_parse(const char *name)
    エンコーディング名をパースし、grn_encodingを返します。たとえば、'grn_encoding_parse("UTF8")' は'GRN_ENC_UTF8'を返します。

    GRN_ENC_UTF8 は無効なエンコーディング名が与えた時に返されます。

パラメタ

•   name -- エンコーディング名。

  grn_expr

grn_expr は「式」を表現した grn_obj です。以下は式が何をできるかのリストです。

•   式は grn_expr_exec() を使うと1つのレコードに複数の操作を適用できます。

•   式は検索条件を表現できます。 grn_table_select() を使うと、式で表現した検索条件にマッチしたレコードだけを選択できます。

    文字列を式で表現する手段は2種類あります。

•   /reference/grn_expr/query_syntax

•   /reference/grn_expr/script_syntax

    grn_expr_parse() は式の文字列表現をパースし、パースした式を別の式に追加します。

  例

TODO...

  リファレンス

GRN_API grn_obj *grn_expr_create(grn_ctx *ctx, const char *name, unsigned int name_size)

GRN_API grn_rc grn_expr_close(grn_ctx *ctx, grn_obj *expr)

GRN_API grn_obj *grn_expr_add_var(grn_ctx *ctx, grn_obj *expr, const char *name, unsigned int name_size)

GRN_API grn_obj *grn_expr_get_var_by_offset(grn_ctx *ctx, grn_obj *expr, unsigned int offset)

GRN_API grn_obj *grn_expr_append_obj(grn_ctx *ctx, grn_obj *expr, grn_obj *obj, grn_operator op, int nargs);

GRN_API grn_obj *grn_expr_append_const(grn_ctx *ctx, grn_obj *expr, grn_obj *obj, grn_operator op, int nargs)

GRN_API grn_obj *grn_expr_append_const_str(grn_ctx *ctx, grn_obj *expr, const char *str, unsigned int str_size, grn_operator op, int nargs)

GRN_API grn_obj *grn_expr_append_const_int(grn_ctx *ctx, grn_obj *expr, int i, grn_operator op, int nargs)

GRN_API grn_rc grn_expr_append_op(grn_ctx *ctx, grn_obj *expr, grn_operator op, int nargs)

grn_rc grn_expr_get_keywords(grn_ctx *ctx, grn_obj *expr, grn_obj *keywords)
    Extracts keywords from expr and stores to keywords. Keywords in keywords are owned by expr. Don't unlink them. Each keyword is GRN_BULK and its domain is GRN_DB_TEXT.

    keywords must be GRN_PVECTOR.

    以下はスキーマの例です。

    grn_obj keywords;
    GRN_PTR_INIT(&keywords, GRN_OBJ_VECTOR, GRN_ID_NIL);
    grn_expr_get_keywords(ctx, expr, &keywords);
    {
      int i, n_keywords;
      n_keywords = GRN_BULK_VSIZE(&keywords) / sizeof(grn_obj *);
      for (i = 0; i < n_keywords; i++) {
        grn_obj *keyword = GRN_PTR_VALUE_AT(&keywords, i);
        const char *keyword_content;
        int keyword_size;
        keyword_content = GRN_TEXT_VALUE(keyword);
        keyword_size = GRN_TEXT_LEN(keyword);
        /*
          Use keyword_content and keyword_size.
          You don't need to unlink keyword.
          keyword is owned by expr.
        */
      }
    }
    GRN_OBJ_FIN(ctx, &keywords);

パラメタ

•   ctx -- The context that creates the expr.

•   expr -- The expression to be extracted.

•   keywords --

    The container to store extracted keywords. It must be GRN_PVECTOR.

    Each extracted keyword is GRN_BULK and its domain is GRN_DB_TEXT.

    Extracted keywords are owned by expr. Don't unlink them.

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_rc grn_expr_syntax_escape(grn_ctx *ctx, const char *string, int string_size, const char *target_characters, char escape_character, grn_obj *escaped_string)
    string 中の target_characters を escape_character でエスケープします。

パラメタ

•   ctx -- エンコーディングは string と同じでなければいけません。 escaped_string 用のバッファを確保するために使います。

•   string -- 文字列式表現

•   string_size -- string のバイトサイズです。 -1 を指定した場合は string がNULL終端文字列であるという意味になります。

•   target_characters -- NULL終端されたエスケープ対象文字。たとえば、 /reference/grn_expr/query_syntax 用の target_characters は "+-><~*()\"\\:" になります。

•   escape_character -- target_characters の文字をエスケープする文字です。たとえば、 /reference/grn_expr/query_syntax 用の escaped_character は \\ （バックスラッシュ）になります。

•   escaped_string -- エスケープされた string の出力先です。テキスト型のbulkでなければいけません。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

grn_rc grn_expr_syntax_escape_query(grn_ctx *ctx, const char *query, int query_size, grn_obj *escaped_query)
    /reference/grn_expr/query_syntax にある特別な文字をエスケープします。

パラメタ

•   ctx -- このエンコーディングは query のエンコーディングと同じでなければなりません。 escaped_query 用のバッファを確保するために使います。

•   query -- /reference/grn_expr/query_syntax にある文字列式の表現。

•   query_size -- query のバイトサイズです。 -1 を指定した場合は query がNULL終端文字列であるという意味になります。

•   escaped_query -- エスケープされた``query``の出力。テキスト型用のbulkを返す。

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

GRN_API grn_rc grn_expr_compile(grn_ctx *ctx, grn_obj *expr)

GRN_API grn_obj *grn_expr_exec(grn_ctx *ctx, grn_obj *expr, int nargs)

GRN_API grn_obj *grn_expr_alloc(grn_ctx *ctx, grn_obj *expr, grn_id domain, grn_obj_flags flags)

  grn_geo

  概要

TODO...

  例

TODO...

  リファレンス

grn_geo_point

grn_rc grn_geo_select_in_rectangle(grn_ctx *ctx, grn_obj *index, grn_obj *top_left_point, grn_obj *bottom_right_point, grn_obj *res, grn_operator op)
    It selects records that are in the rectangle specified by top_left_point parameter and bottom_right_point parameter. Records are searched by index parameter. Found records are added to res parameter table with op parameter operation.

パラメタ

•   index -- the index column for TokyoGeoPoint or WGS84GeoPpoint type.

•   top_left_point -- the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)

•   bottom_right_point -- the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)

•   res -- the table to store found record IDs. It must be GRN_TABLE_HASH_KEY type table.

•   op -- the operator for matched records.

int grn_geo_estimate_in_rectangle(grn_ctx *ctx, grn_obj *index, grn_obj *top_left_point, grn_obj *bottom_right_point)
    It estimates number of records in the rectangle specified by top_left_point parameter and bottom_right_point parameter. Number of records is estimated by index parameter. If an error is occurred, -1 is returned.

パラメタ

•   index -- the index column for TokyoGeoPoint or WGS84GeoPpoint type.

•   top_left_point -- the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)

•   bottom_right_point -- the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)

grn_obj *grn_geo_cursor_open_in_rectangle(grn_ctx *ctx, grn_obj *index, grn_obj *top_left_point, grn_obj *bottom_right_point, int offset, int limit)
    It opens a cursor to get records in the rectangle specified by top_left_point parameter and bottom_right_point parameter.

パラメタ

•   index -- the index column for TokyoGeoPoint or WGS84GeoPpoint type.

•   top_left_point -- the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)

•   bottom_right_point -- the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)

•   offset -- the cursor returns records from offset parameter position. offset parameter is based on 0.

•   limit -- the cursor returns at most limit parameter records. -1 means no limit.

grn_posting *grn_geo_cursor_next(grn_ctx *ctx, grn_obj *cursor)
    It returns the next posting that has record ID. It returns NULL after all records are returned.

パラメタ

•   cursor -- the geo cursor.

  grn_hook

  概要

TODO...

  例

TODO...

  リファレンス

grn_hook_entry
    TODO...

grn_rc grn_obj_add_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *proc, grn_obj *data)
    objに対してhookを追加します。

パラメタ

•   obj -- 対象objectを指定します。

•   entry --

    GRN_HOOK_GET は、objectの参照時に呼び出されるhookを定義します。

    GRN_HOOK_SET は、objectの更新時に呼び出されるhookを定義します。

    GRN_HOOK_SELECT は、検索処理の実行中に適時呼び出され、処理の実行状況を調べたり、実行の中断を指示することができます。

•   offset --

    hookの実行順位。offsetに対応するhookの直前に新たなhookを挿入します。

    0を指定した場合は先頭に挿入されます。-1を指定した場合は末尾に挿入されます。

    objectに複数のhookが定義されている場合は順位の順に呼び出されます。

•   proc -- 手続きを指定します。

•   data -- hook固有情報を指定します。

int grn_obj_get_nhooks(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry)
    objに定義されているhookの数を返します。

パラメタ

•   obj -- 対象objectを指定します。

•   entry -- hookタイプを指定します。

grn_obj *grn_obj_get_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *data)
    objに定義されているhookの手続き（proc）を返します。hook固有情報が定義されている場合は、その内容をdataにコピーして返します。

パラメタ

•   obj -- 対象objectを指定します。

•   entry -- hookタイプを指定します。

•   offset -- 実行順位を指定します。

•   data -- hook固有情報格納バッファを指定します。

grn_rc grn_obj_delete_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset)
    objに定義されているhookを削除します。

パラメタ

•   obj -- 対象objectを指定します。

•   entry -- hookタイプを指定します。

•   offset -- 実行順位を指定します。

  grn_ii

  概要

buffered index builder

特定のアプリケーション用に準備した内部APIです。

TODO...

  例

TODO...

  リファレンス

grn_ii

grn_ii_buffer

grn_ii_buffer *grn_ii_buffer_open(grn_ctx *ctx, grn_ii *ii, long long unsigned int update_buffer_size)

grn_rc grn_ii_buffer_append(grn_ctx *ctx, grn_ii_buffer *ii_buffer, grn_id rid, unsigned int section, grn_obj *value)

grn_rc grn_ii_buffer_commit(grn_ctx *ctx, grn_ii_buffer *ii_buffer)

grn_rc grn_ii_buffer_close(grn_ctx *ctx, grn_ii_buffer *ii_buffer)

  grn_index_cursor

  概要

TODO...

  例

TODO...

  リファレンス

grn_obj *grn_index_cursor_open(grn_ctx *ctx, grn_table_cursor *tc, grn_obj *index, grn_id rid_min, grn_id rid_max, int flags)
    grn_table_cursor から取得できるそれぞれのレコードについて、 GRN_OBJ_COLUMN_INDEX 型のカラムの値を順番に取り出すためのカーソルを生成して返します。

    rid_min, rid_maxを指定して取得するレコードidの値を制限することができます。

    戻り値であるgrn_index_cursorは grn_obj_close() を使って解放します。

パラメタ

•   tc -- 対象cursorを指定します。

•   index -- 対象インデックスカラムを指定します。

•   rid_min -- 出力するレコードidの下限を指定します。

•   rid_max -- 出力するレコードidの上限を指定します。

grn_posting *grn_index_cursor_next(grn_ctx *ctx, grn_obj *ic, grn_id *tid)
    cursorの範囲内のインデックスの値を順番に取り出します。

    tidにNULL以外を指定した場合は、index_cursorを作成するときに指定したtable_cursorの現在の対象レコードのidを返します。

    戻り値である grn_posting 構造体は解放する必要はありません。

パラメタ

•   ic -- 対象cursorを指定します。

•   tid -- テーブルレコードIDを指定します。

  grn_info

  概要

TODO...

  例

TODO...

  リファレンス

grn_info_type
    TODO...

grn_obj *grn_obj_get_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *valuebuf)
    objのtypeに対応する情報をvaluebufに格納します。

パラメタ

•   obj -- 対象objを指定します。

•   type -- 取得する情報の種類を指定します。

•   valuebuf -- 値を格納するバッファ（呼出側で準備）を指定します。

grn_rc grn_obj_set_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *value)
    objのtypeに対応する情報をvalueの内容に更新します。

パラメタ

•   obj -- 対象objを指定します。

•   type -- 設定する情報の種類を指定します。

grn_obj *grn_obj_get_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value)
    objのidに対応するレコードの、typeに対応する情報をvaluebufに格納します。呼出側ではtypeに応じて十分なサイズのバッファを確保しなければいけません。

パラメタ

•   obj -- 対象objを指定します。

•   id -- 対象IDを指定します。

•   type -- 取得する情報の種類を指定します。

•   value -- 値を格納するバッファ（呼出側で準備）を指定します。

grn_rc grn_obj_set_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value)
    objのidに対応するレコードのtypeに対応する情報をvalueの内容に更新します。

パラメタ

•   obj -- 対象objectを指定します。

•   id -- 対象IDを指定します。

•   type -- 設定する情報の種類を指定します。

•   value -- 設定しようとする値を指定します。

  grn_match_escalation

  概要

TODO...

  例

TODO...

  リファレンス

long long int grn_ctx_get_match_escalation_threshold(grn_ctx *ctx)
    検索の挙動をエスカレーションする閾値を返します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。

grn_rc grn_ctx_set_match_escalation_threshold(grn_ctx *ctx, long long int threshold)
    検索の挙動をエスカレーションする閾値を変更します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。

パラメタ

•   threshold -- 変更後の検索の挙動をエスカレーションする閾値を指定します。

long long int grn_get_default_match_escalation_threshold(void)
    デフォルトの検索の挙動をエスカレーションする閾値を返します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。

grn_rc grn_set_default_match_escalation_threshold(long long int threshold)
    デフォルトの検索の挙動をエスカレーションする閾値を変更します。エスカレーションの詳細は詳細は検索の仕様に関するドキュメントを参照してください。

パラメタ

•   threshold -- 変更後のデフォルトの検索の挙動をエスカレーションする閾値を指定します。

  grn_obj

  概要

TODO...

  例

TODO...

  リファレンス

grn_obj
    TODO...

grn_obj *grn_obj_column(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size)
    nameがカラム名の場合、それに対応するtableのカラムを返します。対応するカラムが存在しなければNULLを返します。

    nameはアクセサ文字列の場合、それに対応するaccessorを返します。アクセサ文字列とは、カラム名等を'.'で連結した文字列です。'_id', '_key'は特殊なアクセサで、それぞれレコードID/keyを返します。例) 'col1' / 'col2.col3' / 'col2._id'

パラメタ

•   table -- 対象tableを指定します。

•   name -- カラム名を指定します。

grn_bool grn_obj_is_builtin(grn_ctx *ctx, grn_obj *obj)
    Check whether Groonga built-in object.

パラメタ

•   ctx -- context

•   obj -- target object

戻り値 GRN_TRUE for built-in groonga object, GRN_FALSE otherwise.

grn_obj *grn_obj_get_value(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_obj *value)
    objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。

パラメタ

•   obj -- 対象objectを指定します。

•   id -- 対象レコードのIDを指定します。

•   value -- 値を格納するバッファ（呼出側で準備する）を指定します。

int grn_obj_get_values(grn_ctx *ctx, grn_obj *obj, grn_id offset, void **values)
    objに指定されたカラムについて、offsetに指定されたレコードIDを開始位置として、IDが連続するレコードに対応するカラム値が昇順に格納された配列へのポインタをvaluesにセットします。

    取得できた件数が戻り値として返されます。エラーが発生した場合は -1 が返されます。

    注釈: 値が固定長であるカラムのみがobjに指定できます。範囲内のIDに対応するレコードが有効であるとは限りません。delete操作を実行したことのあるテーブルに対しては、grn_table_at() などによって各レコードの存否を別途確認しなければなりません。

パラメタ

•   obj -- 対象objectを指定します。

•   offset -- 値を取得する範囲の開始位置となるレコードIDを指定します。

•   values -- 値の配列がセットされます。

grn_rc grn_obj_set_value(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_obj *value, int flags)
    objのIDに対応するレコードの値を更新します。対応するレコードが存在しない場合は GRN_INVALID_ARGUMENT を返します。

パラメタ

•   obj -- 対象objectを指定します。

•   id -- 対象レコードのIDを指定します。

•   value -- 格納する値を指定します。

•   flags --

    以下の値を指定できます。

•   GRN_OBJ_SET

•   GRN_OBJ_INCR

•   GRN_OBJ_DECR

•   GRN_OBJ_APPEND

•   GRN_OBJ_PREPEND

•   GRN_OBJ_GET

•   GRN_OBJ_COMPARE

•   GRN_OBJ_LOCK

•   GRN_OBJ_UNLOCK

GRN_OBJ_SET_MASK

GRN_OBJ_SET
    レコードの値をvalueと置き換えます。

GRN_OBJ_INCR
    レコードの値にvalueを加算します。

GRN_OBJ_DECR
    レコードの値にvalueを減算します。

GRN_OBJ_APPEND
    レコードの値の末尾にvalueを追加します。

GRN_OBJ_PREPEND
    レコードの値の先頭にvalueを追加します。

GRN_OBJ_GET
    新しいレコードの値をvalueにセットします。

GRN_OBJ_COMPARE
    レコードの値とvalueが等しいか調べます。

GRN_OBJ_LOCK
    当該レコードをロックします。GRN_OBJ_COMPARE と共に指定された場合は、レコードの値とvalueが等しい場合に限ってロックします。

GRN_OBJ_UNLOCK
    当該レコードのロックを解除します。

grn_rc grn_obj_remove(grn_ctx *ctx, grn_obj *obj)
    objをメモリから解放し、それが永続オブジェクトであった場合は、該当するファイル一式を削除します。

パラメタ

•   obj -- 対象objectを指定します。

grn_rc grn_obj_rename(grn_ctx *ctx, grn_obj *obj, const char *name, unsigned int name_size)
    ctxが使用するdbにおいてobjに対応する名前をnameに更新します。objは永続オブジェクトでなければいけません。

パラメタ

•   obj -- 対象objectを指定します。

•   name -- 新しい名前を指定します。

•   name_size -- nameパラメータのsize（byte）を指定します。

grn_rc grn_obj_close(grn_ctx *ctx, grn_obj *obj)
    一時的なobjectであるobjをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。

    永続的な、table, column, exprなどは解放してはいけません。一般的には、一時的か永続的かを気にしなくてよい grn_obj_unlink() を用いるべきです。

パラメタ

•   obj -- 対象objectを指定します。

grn_rc grn_obj_reinit(grn_ctx *ctx, grn_obj *obj, grn_id domain, unsigned char flags)
    objの型を変更します。

    objは GRN_OBJ_INIT() マクロなどで初期化済みでなければいけません。

パラメタ

•   obj -- 対象objectを指定します。

•   domain -- 変更後のobjの型を指定します。

•   flags -- GRN_OBJ_VECTOR を指定するとdomain型の値のベクタを格納するオブジェクトになります。

void grn_obj_unlink(grn_ctx *ctx, grn_obj *obj)
    objをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。

const char *grn_obj_path(grn_ctx *ctx, grn_obj *obj)
    objに対応するファイルパスを返します。一時objectならNULLを返します。

パラメタ

•   obj -- 対象objectを指定します。

int grn_obj_name(grn_ctx *ctx, grn_obj *obj, char *namebuf, int buf_size)
    objの名前の長さを返します。無名objectなら0を返します。

    名前付きのobjectであり、buf_sizeの長さが名前の長以上であった場合は、namebufに該当する名前をコピーします。

パラメタ

•   obj -- 対象objectを指定します。

•   namebuf -- 名前を格納するバッファ（呼出側で準備する）を指定します。

•   buf_size -- namebufのサイズ（byte長）を指定します。

grn_id grn_obj_get_range(grn_ctx *ctx, grn_obj *obj)
    objパラメータのとる値の範囲を表わしているオブジェクトのIDを返します。例えば、grn_builtin_type にある GRN_DB_INT などを返します。

パラメタ

•   obj -- 対象objectを指定します。

int grn_obj_expire(grn_ctx *ctx, grn_obj *obj, int threshold)
    objの占有するメモリのうち、可能な領域をthresholdを指標として解放します。

パラメタ

•   obj -- 対象objectを指定します。

int grn_obj_check(grn_ctx *ctx, grn_obj *obj)
    objに対応するファイルの整合性を検査します。

パラメタ

•   obj -- 対象objectを指定します。

grn_rc grn_obj_lock(grn_ctx *ctx, grn_obj *obj, grn_id id, int timeout)
    objをlockします。timeout（秒）経過してもlockを取得できない場合は GRN_RESOURCE_DEADLOCK_AVOIDED を返します。

パラメタ

•   obj -- 対象objectを指定します。

grn_rc grn_obj_unlock(grn_ctx *ctx, grn_obj *obj, grn_id id)
    objをunlockします。

パラメタ

•   obj -- 対象objectを指定します。

grn_rc grn_obj_clear_lock(grn_ctx *ctx, grn_obj *obj)
    強制的にロックをクリアします。

パラメタ

•   obj -- 対象objectを指定します。

unsigned int grn_obj_is_locked(grn_ctx *ctx, grn_obj *obj)
    objが現在lockされていれば0以外の値を返します。

パラメタ

•   obj -- 対象objectを指定します。

int grn_obj_defrag(grn_ctx *ctx, grn_obj *obj, int threshold)
    objの占有するDBファイル領域のうち、可能な領域をthresholdを指標としてフラグメントの解消を行います。

    フラグメント解消が実行されたセグメントの数を返します。

パラメタ

•   obj -- 対象objectを指定します。

grn_id grn_obj_id(grn_ctx *ctx, grn_obj *obj)
    objのidを返します。

パラメタ

•   obj -- 対象objectを指定します。

grn_rc grn_obj_delete_by_id(grn_ctx *ctx, grn_obj *db, grn_id id, grn_bool removep)
    dbからidに対応するテーブルやカラムなどを削除します。mroonga向けに用意した内部APIです。

パラメタ

•   db -- The target database.

•   id -- The object (table, column and so on) ID to be deleted.

•   removep -- If GRN_TRUE, clear object cache and remove relation between ID and key in database. Otherwise, just clear object cache.

grn_rc grn_obj_path_by_id(grn_ctx *ctx, grn_obj *db, grn_id id, char *buffer)
    dbのidに対応するpathを返します。mroonga向けに用意した内部APIです。

パラメタ

•   db -- The target database.

•   id -- The object (table, column and so on) ID to be deleted.

•   buffer -- path string corresponding to the id will be set in this buffer.

grn_rc grn_obj_cast_by_id(grn_ctx *ctx, grn_obj *source, grn_obj *destination, grn_bool add_record_if_not_exist)
    It casts value of source to value with type of destination. Casted value is appended to destination.

    Both source and destination must be bulk.

    If destination is a reference type bulk. (Reference type bulk means that type of destination is a table.) add_record_if_not_exist is used. If source value doesn't exist in the table that is a type of destination. The source value is added to the table.

パラメタ

•   ctx -- その時点のコンテキスト。

•   source -- The bulk to be casted.

•   destination -- The bulk to specify cast target type and store casted value.

•   add_record_if_not_exist -- Whether adding a new record if source value doesn't exist in cast target table. This parameter is only used when destination is a reference type bulk.

戻り値 成功時は GRN_SUCCESS 、エラー時は GRN_SUCCESS 以外。

  grn_proc

  概要

TODO...

  例

TODO...

  リファレンス

grn_proc_type
    TODO...

grn_proc_func
    TODO...

grn_obj *grn_proc_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_type type, grn_proc_func *init, grn_proc_func *next, grn_proc_func *fin, unsigned int nvars, grn_expr_var *vars)
    nameに対応する新たなproc(手続き)をctxが使用するdbに定義します。

パラメタ

•   name -- 作成するprocの名前を指定します。

•   name_size -- The number of bytes of name parameter. If negative value is specified, name parameter is assumed that NULL-terminated string.

•   type -- procの種類を指定します。

•   init -- 初期化関数のポインタを指定します。

•   next -- 実処理関数のポインタを指定します。

•   fin -- 終了関数のポインタを指定します。

•   nvars -- procで使用する変数の数を指定します。

•   vars -- procで使用する変数の定義を指定します。( grn_expr_var 構造体の配列)

grn_obj *grn_proc_get_info(grn_ctx *ctx, grn_user_data *user_data, grn_expr_var **vars, unsigned int *nvars, grn_obj **caller)
    user_dataをキーとして、現在実行中の grn_proc_func 関数および定義されている変数( grn_expr_var )の配列とその数を取得します。

パラメタ

•   user_data -- grn_proc_func に渡されたuser_dataを指定します。

•   nvars -- 変数の数を取得します。

grn_rc grn_obj_set_finalizer(grn_ctx *ctx, grn_obj *obj, grn_proc_func *func)
    objectを破棄するときに呼ばれる関数を設定します。

    table, column, proc, exprのみ設定可能です。

パラメタ

•   obj -- 対象objectを指定します。

•   func -- objectを破棄するときに呼ばれる関数を指定します。

  grn_search

  概要

TODO...

  例

TODO...

  リファレンス

grn_search_optarg

grn_rc grn_obj_search(grn_ctx *ctx, grn_obj *obj, grn_obj *query, grn_obj *res, grn_operator op, grn_search_optarg *optarg)
    objを対象としてqueryにマッチするレコードを検索し、opの指定に従ってresにレコードを追加あるいは削除します。

パラメタ

•   obj -- 検索対象のobjectを指定します。

•   query -- 検索クエリを指定します。

•   res -- 検索結果を格納するテーブルを指定します。

•   op -- GRN_OP_OR, GRN_OP_AND, GRN_OP_AND_NOT, GRN_OP_ADJUST のいずれかを指定します。

•   optarg -- 詳細検索条件を指定します。

  grn_table

  概要

TODO...

  例

TODO...

  リファレンス

grn_obj *grn_table_create(grn_ctx *ctx, const char *name, unsigned int name_size, const char *path, grn_obj_flags flags, grn_obj *key_type, grn_obj *value_type)
    nameパラメータに対応する新たなtableをctxが使用するdbに定義します。

パラメタ

•   name --

    作成するtableの名前を指定します。NULLなら無名tableとなります。

    persistent dbに対して名前をありのtableを作成するときには、flagsに GRN_OBJ_PERSISTENT が指定されていなけれなりません。

•   path -- 作成するtableのファイルパスを指定します。 flagsに GRN_OBJ_PERSISTENT が指定されている場合のみ有効です。 NULLなら自動的にファイルパスが付与されます。

•   flags --

    GRN_OBJ_PERSISTENT を指定すると永続tableとなります。

    GRN_OBJ_TABLE_PAT_KEY, GRN_OBJ_TABLE_HASH_KEY, GRN_OBJ_TABLE_NO_KEY のいずれかを指定します。

    GRN_OBJ_KEY_NORMALIZE を指定すると正規化された文字列がkeyとなります。

    GRN_OBJ_KEY_WITH_SIS を指定するとkey文字列の全suffixが自動的に登録されます。

•   key_type --

    keyの型を指定します。GRN_OBJ_TABLE_NO_KEY が指定された場合は無効です。 既存のtypeあるいはtableを指定できます。

    key_typeにtable Aを指定してtable Bを作成した場合、Bは必ずAのサブセットとなります。

•   value_type -- keyに対応する値を格納する領域の型を指定します。 tableはcolumnとは別に、keyに対応する値を格納する領域を一つだけ持つことができます。

grn_id grn_table_add(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size, int *added)
    keyに対応する新しいrecordをtableに追加し、そのIDを返します。keyに対応するrecordがすでにtableに存在するならば、そのrecordのIDを返します。

    GRN_OBJ_TABLE_NO_KEY が指定されたtableでは、key, key_size は無視されます。

パラメタ

•   table -- 対象tableを指定します。

•   key -- 検索keyを指定します。

•   added -- NULL以外の値が指定された場合、新たにrecordが追加された時には1が、既存recordだった時には0がセットされます。

grn_id grn_table_get(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size)
    It finds a record that has key parameter and returns ID of the found record. If table parameter is a database, it finds an object (table, column and so on) that has key parameter and returns ID of the found object.

パラメタ

•   table -- The table or database.

•   key -- The record or object key to be found.

grn_id grn_table_at(grn_ctx *ctx, grn_obj *table, grn_id id)
    tableにidに対応するrecordが存在するか確認し、存在すれば指定されたIDを、存在しなければ GRN_ID_NIL を返します。

    注意: 実行には相応のコストがかかるのであまり頻繁に呼ばないようにして下さい。

パラメタ

•   table -- 対象tableを指定します。

•   id -- 検索idを指定します。

grn_id grn_table_lcp_search(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size)
    tableが GRN_TABLE_PAT_KEY もしくは GRN_TABLE_DAT_KEY を指定して作ったtableなら、longest common prefix searchを行い、対応するIDを返します。

    tableが GRN_TABLE_HASH_KEY を指定して作ったtableなら、完全に一致するキーを検索し、対応するIDを返します。

パラメタ

•   table -- 対象tableを指定します。

•   key -- 検索keyを指定します。

int grn_table_get_key(grn_ctx *ctx, grn_obj *table, grn_id id, void *keybuf, int buf_size)
    tableのIDに対応するレコードのkeyを取得します。

    対応するレコードが存在する場合はkey長を返します。見つからない場合は0を返します。対応するキーの検索に成功し、またbuf_sizeの長さがkey長以上であった場合は、keybufに該当するkeyをコピーします。

パラメタ

•   table -- 対象tableを指定します。

•   id -- 対象レコードのIDを指定します。

•   keybuf -- keyを格納するバッファ(呼出側で準備する)を指定します。

•   buf_size -- keybufのサイズ(byte長)を指定します。

grn_rc grn_table_delete(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size)
    tableのkeyに対応するレコードを削除します。対応するレコードが存在しない場合は GRN_INVALID_ARGUMENT を返します。

パラメタ

•   table -- 対象tableを指定します。

•   key -- 検索keyを指定します。

•   key_size -- 検索keyのサイズを指定します。

grn_rc grn_table_delete_by_id(grn_ctx *ctx, grn_obj *table, grn_id id)
    tableのidに対応するレコードを削除します。対応するレコードが存在しない場合は GRN_INVALID_ARGUMENT を返します。

パラメタ

•   table -- 対象tableを指定します。

•   id -- レコードIDを指定します。

grn_rc grn_table_update_by_id(grn_ctx *ctx, grn_obj *table, grn_id id, const void *dest_key, unsigned int dest_key_size)
    tableのidに対応するレコードのkeyを変更します。新しいkeyとそのbyte長をdest_keyとdest_key_sizeに指定します。

    この操作は、GRN_TABLE_DAT_KEY 型のテーブルのみ使用できます。

パラメタ

•   table -- 対象tableを指定します。

•   id -- レコードIDを指定します。

grn_rc grn_table_update(grn_ctx *ctx, grn_obj *table, const void *src_key, unsigned int src_key_size, const void *dest_key, unsigned int dest_key_size)
    tableのsrc_keyに対応するレコードのkeyを変更します。新しいkeyとそのbyte長をdest_keyとdest_key_sizeに指定します。

    この操作は、GRN_TABLE_DAT_KEY 型のテーブルのみ使用できます。

パラメタ

•   table -- 対象tableを指定します。

•   src_key -- 対象レコードのkeyを指定します。

•   src_key_size -- 対象レコードのkeyの長さ(byte)を指定します。

•   dest_key -- 変更後のkeyを指定します。

•   dest_key_size -- 変更後のkeyの長さ(byte)を指定します。

grn_rc grn_table_truncate(grn_ctx *ctx, grn_obj *table)
    tableの全レコードを一括して削除します。

    注意: multithread環境では他のthreadのアクセスによって、存在しないアドレスへアクセスし、SIGSEGVが発生する可能性があります。

パラメタ

•   table -- 対象tableを指定します。

grn_table_sort_key
    TODO...

grn_table_sort_flags
    TODO...

int grn_table_sort(grn_ctx *ctx, grn_obj *table, int offset, int limit, grn_obj *result, grn_table_sort_key *keys, int n_keys)
    table内のレコードをソートし、上位limit個の要素をresultに格納します。

    keys.keyには、tableのcolumn,accessor,procのいずれかが指定できます。keys.flagsには、GRN_TABLE_SORT_ASC / GRN_TABLE_SORT_DESC のいずれかを指定できます。GRN_TABLE_SORT_ASC では昇順、GRN_TABLE_SORT_DESC では降順でソートされます。keys.offsetは、内部利用のためのメンバです。

パラメタ

•   table -- 対象tableを指定します。

•   offset -- sortされたレコードのうち、(0ベースで)offset番目から順にresにレコードを格納します。

•   limit -- resに格納するレコードの上限を指定します。

•   result -- 結果を格納するtableを指定します。

•   keys -- ソートキー配列へのポインタを指定します。

•   n_keys -- ソートキー配列のサイズを指定します。

grn_table_group_result
    TODO...

grn_table_group_flags
    TODO...

grn_rc grn_table_group(grn_ctx *ctx, grn_obj *table, grn_table_sort_key *keys, int n_keys, grn_table_group_result *results, int n_results)
    tableのレコードを特定の条件でグループ化します。

パラメタ

•   table -- 対象tableを指定します。

•   keys -- group化キー構造体の配列へのポインタを指定します。

•   n_keys -- group化キー構造体の配列のサイズを指定します。

•   results -- group化の結果を格納する構造体の配列へのポインタを指定します。

•   n_results -- group化の結果を格納する構造体の配列のサイズを指定します。

grn_rc grn_table_setoperation(grn_ctx *ctx, grn_obj *table1, grn_obj *table2, grn_obj *res, grn_operator op)
    table1とtable2をopの指定に従って集合演算した結果をresに格納します。

    resにtable1あるいはtable2そのものを指定した場合を除けば、table1, table2は破壊されません。

パラメタ

•   table1 -- 対象table1を指定します。

•   table2 -- 対象table2を指定します。

•   res -- 結果を格納するtableを指定します。

•   op -- 実行する演算の種類を指定します。

grn_rc grn_table_difference(grn_ctx *ctx, grn_obj *table1, grn_obj *table2, grn_obj *res1, grn_obj *res2)
    table1とtable2から重複するレコードを取り除いた結果をそれぞれres1, res2に格納します。

パラメタ

•   table1 -- 対象table1を指定します。

•   table2 -- 対象table2を指定します。

•   res1 -- 結果を格納するtableを指定します。

•   res2 -- 結果を格納するtableを指定します。

int grn_table_columns(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size, grn_obj *res)
    nameパラメータから始まるtableのカラムIDをresパラメータに格納します。name_sizeパラメータが0の場合はすべてのカラムIDを格納します。

パラメタ

•   table -- 対象tableを指定します。

•   name -- 取得したいカラム名のprefixを指定します。

•   name_size -- nameパラメータの長さを指定します。

•   res -- 結果を格納する GRN_TABLE_HASH_KEY のtableを指定します。

戻り値 格納したカラムIDの数を返します。

unsigned int grn_table_size(grn_ctx *ctx, grn_obj *table)
    tableに登録されているレコードの件数を返します。

パラメタ

•   table -- 対象tableを指定します。

grn_rc grn_table_rename(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size)
    ctxが使用するdbにおいてtableに対応する名前をnameに更新します。tableの全てのcolumnも同時に名前が変更されます。tableは永続オブジェクトでなければいけません。

パラメタ

•   name_size -- nameパラメータのsize(byte)を指定します。

  grn_table_cursor

  概要

TODO...

  例

TODO...

  リファレンス

grn_table_cursor
    TODO...

grn_table_cursor *grn_table_cursor_open(grn_ctx *ctx, grn_obj *table, const void *min, unsigned int min_size, const void *max, unsigned int max_size, int offset, int limit, int flags)
    tableに登録されているレコードを順番に取り出すためのカーソルを生成して返します。

パラメタ

•   table -- 対象tableを指定します。

•   min -- keyの下限を指定します。（NULLは下限なしと見なします。） GRN_CURSOR_PREFIX については後述。

•   min_size -- minのsizeを指定します。GRN_CURSOR_PREFIX については後述。

•   max -- keyの上限を指定します。（NULLは上限なしと見なします。） GRN_CURSOR_PREFIX については後述。

•   max_size -- maxのsizeを指定します。GRN_CURSOR_PREFIX については無視される場合があります。

•   flags --

    GRN_CURSOR_ASCENDING を指定すると昇順にレコードを取り出します。

    GRN_CURSOR_DESCENDING を指定すると降順にレコードを取り出します。(下記 GRN_CURSOR_PREFIX を指定し、keyが近いレコードを取得する場合、もしくは、common prefix searchを行う場合には、GRN_CURSOR_ASCENDING / GRN_CURSOR_DESCENDING は無視されます。)

    GRN_CURSOR_GT を指定するとminに一致したkeyをcursorの範囲に含みません。(minがNULLの場合もしくは、下記 GRN_CURSOR_PREFIX を指定し、keyが近いレコードを取得する場合、もしくは、common prefix searchを行う場合には、GRN_CURSOR_GT は無視されます。)

    GRN_CURSOR_LT を指定するとmaxに一致したkeyをcursorの範囲に含みません。(maxがNULLの場合もしくは、下記 GRN_CURSOR_PREFIX を指定した場合には、GRN_CURSOR_LT は無視されます。)

    GRN_CURSOR_BY_ID を指定するとID順にレコードを取り出します。(下記 GRN_CURSOR_PREFIX を指定した場合には、GRN_CURSOR_BY_ID は無視されます。) GRN_OBJ_TABLE_PAT_KEY を指定したtableについては、GRN_CURSOR_BY_KEY を指定するとkey順にレコードを取り出します。( GRN_OBJ_TABLE_HASH_KEY , GRN_OBJ_TABLE_NO_KEY を指定したテーブルでは GRN_CURSOR_BY_KEY は無視されます。)

    GRN_CURSOR_PREFIX を指定すると、 GRN_OBJ_TABLE_PAT_KEY を指定したテーブルに関する下記のレコードを取り出すカーソルが作成されます。maxがNULLの場合には、keyがminと前方一致するレコードを取り出します。max_sizeパラメータは無視されます。

    maxとmax_sizeが指定され、かつ、テーブルのkeyがShortText型である場合、maxとcommon prefix searchを行い、common prefixがmin_sizeバイト以上のレコードを取り出します。minは無視されます。

    maxとmax_sizeが指定され、かつ、テーブルのkeyが固定長型の場合、maxとPAT木上で近い位置にあるノードから順番にレコードを取り出します。ただし、keyのパトリシア木で、min_sizeバイト未満のビットに対するノードで、maxと異なった方向にあるノードに対応するレコードについては取り出しません。PAT木上で位置が近いこととkeyの値が近いことは同一ではありません。この場合、maxで与えられるポインタが指す値は、対象テーブルのkeyサイズと同じか超える幅である必要があります。minは無視されます。

    GRN_CURSOR_BY_ID / GRN_CURSOR_BY_KEY / GRN_CURSOR_PREFIX の3フラグは、同時に指定することができません。

    GRN_OBJ_TABLE_PAT_KEY を指定して作ったテーブルで、GRN_CURSOR_PREFIX と GRN_CURSOR_RK を指定すると、半角小文字のアルファベット文字列から、それを旧JIS X 4063:2000規格に従って全角カタカナに変換した文字列に前方一致する値をkeyとするレコードを取り出します。GRN_ENC_UTF8 のみをサポートしています。GRN_CURSOR_ASCENDING / GRN_CURSOR_DESCENDING は無効であり、レコードをkey値の昇降順で取り出すことはできません。

•   offset --

    該当する範囲のレコードのうち、(0ベースで)offset番目からレコードを取り出します。

    GRN_CURSOR_PREFIX を指定したときは負の数を指定することはできません。

•   limit --

    該当する範囲のレコードのうち、limit件のみを取り出します。-1が指定された場合は、全件が指定されたものとみなします。

    GRN_CURSOR_PREFIX を指定したときは-1より小さい負の数を指定することはできません。

grn_rc grn_table_cursor_close(grn_ctx *ctx, grn_table_cursor *tc)
    grn_table_cursor_open() で生成したcursorを解放します。

パラメタ

•   tc -- 対象cursorを指定します。

grn_id grn_table_cursor_next(grn_ctx *ctx, grn_table_cursor *tc)
    cursorのカレントレコードを一件進めてそのIDを返します。cursorの対象範囲の末尾に達すると GRN_ID_NIL を返します。

パラメタ

•   tc -- 対象cursorを指定します。

int grn_table_cursor_get_key(grn_ctx *ctx, grn_table_cursor *tc, void **key)
    cursorのカレントレコードのkeyをkeyパラメータにセットし、その長さを返します。

パラメタ

•   tc -- 対象cursorを指定します。

•   key -- カレントレコードのkeyへのポインタがセットされます。

int grn_table_cursor_get_value(grn_ctx *ctx, grn_table_cursor *tc, void **value)
    cursorパラメータのカレントレコードのvalueをvalueパラメータにセットし、その長さを返します。

パラメタ

•   tc -- 対象cursorを指定します。

•   value -- カレントレコードのvalueへのポインタがセットされます。

grn_rc grn_table_cursor_set_value(grn_ctx *ctx, grn_table_cursor *tc, const void *value, int flags)
    cursorのカレントレコードのvalueを引数の内容に置き換えます。cursorのカレントレコードが存在しない場合は GRN_INVALID_ARGUMENT を返します。

パラメタ

•   tc -- 対象cursorを指定します。

•   value -- 新しいvalueの値を指定します。

•   flags -- grn_obj_set_value() のflagsと同様の値を指定できます。

grn_rc grn_table_cursor_delete(grn_ctx *ctx, grn_table_cursor *tc)
    cursorのカレントレコードを削除します。cursorのカレントレコードが存在しない場合は GRN_INVALID_ARGUMENT を返します。

パラメタ

•   tc -- 対象cursorを指定します。

grn_obj *grn_table_cursor_table(grn_ctx *ctx, grn_table_cursor *tc)
    cursorが属するtableを返します。

パラメタ

•   tc -- 対象cursorを指定します。

  grn_thread_*

  概要

スレッド関連のAPIには grn_thread_ プレフィックスがついています。

通常、このAPIを使う必要はありません。

Groongaサーバーを実装するときにこのAPIを使いたくなるかもしれません。

  例

以下は、 /reference/executables/groonga が実際に使っている grn_thread_* APIの使い方です。 /reference/executables/groonga は最大スレッド数を増やすと、スレッドプールのサイズを増やします。一方、 /reference/executables/groonga は最大スレッド数を減らすと、スレッドプールのサイズを減らします。もし、すでに減少後のスレッドプールのサイズ以上のスレッドが動いていたらそれらを止めます。

static grn_mutex q_mutex;
static grn_cond q_cond;
static uint32_t nfthreads;
static uint32_t max_nfthreads;
static uint32_t
groonga_get_thread_limit(void *data)
{
  return max_nfthreads;
}
static void
groonga_set_thread_limit(uint32_t new_limit, void *data)
{
  uint32_t i;
  uint32_t current_nfthreads;
  MUTEX_LOCK(q_mutex);
  current_nfthreads = nfthreads;
  max_nfthreads = new_limit;
  MUTEX_UNLOCK(q_mutex);
  if (current_nfthreads > new_limit) {
    for (i = 0; i < current_nfthreads; i++) {
      MUTEX_LOCK(q_mutex);
      COND_SIGNAL(q_cond);
      MUTEX_UNLOCK(q_mutex);
    }
  }
}
int
main(int argc, char *argv)
{
  /* ... */
  grn_thread_set_get_limit_func(groonga_get_thread_limit, NULL);
  grn_thread_set_set_limit_func(groonga_set_thread_limit, NULL);
  grn_init();
  /* ... */
}

  リファレンス

uint32_t (*grn_thread_get_limit_func)(void *data)
    最大スレッド数を返す関数の型です。

void (*grn_thread_set_limit_func)(uint32_t new_limit, void *data)
    最大スレッド数を設定する関数の型です。

uint32_t grn_thread_get_limit(void)
    最大スレッド数を返します。

    grn_thread_set_get_limit_func() で grn_thread_get_limit_func を設定していない場合は、常に 0 を返します。

戻り値 最大スレッド数または 0 。

void_t grn_thread_set_limit(uint32_t new_limit)
    最大スレッド数を設定します。

    grn_thread_set_set_limit_func() で grn_thread_set_limit_func を設定していない場合はなにもしません。

パラメタ

•   new_limit -- 新しい最大スレッド数。

void grn_thread_set_get_limit_func(grn_thread_get_limit_func func, void *data)
    最大スレッド数を返すカスタム関数を設定します。

    data は grn_thread_get_limit() が func を呼ぶときに func に渡されます。

パラメタ

•   func -- 最大スレッド数を返すカスタム関数。

•   data -- func が呼ばれるときに func に渡されるユーザーのためのデータ。

void grn_thread_set_set_limit_func(grn_thread_set_limit_func func, void *data)
    最大スレッド数を設定するカスタム関数を設定します。

    data は grn_thread_set_limit() が func を呼ぶときに func に渡されます。

パラメタ

•   func -- 最大スレッド数を設定するカスタム関数。

•   data -- func が呼ばれるときに func に渡されるユーザーのためのデータ。

  grn_type

  概要

TODO...

  例

TODO...

  リファレンス

grn_builtin_type
    TODO...

grn_obj *grn_type_create(grn_ctx *ctx, const char *name, unsigned int name_size, grn_obj_flags flags, unsigned int size)
    nameに対応する新たなtype（型）をdbに定義します。

パラメタ

•   name -- 作成するtypeの名前を指定します。

•   flags -- GRN_OBJ_KEY_VAR_SIZE, GRN_OBJ_KEY_FLOAT, GRN_OBJ_KEY_INT, GRN_OBJ_KEY_UINT のいずれかを指定します。

•   size -- GRN_OBJ_KEY_VAR_SIZE の場合は最大長、それ以外の場合は長さ（単位:byte）を指定します。

  grn_user_data

  概要

TODO...

  例

TODO...

  リファレンス

grn_user_data
    TODO...

grn_user_data *grn_obj_user_data(grn_ctx *ctx, grn_obj *obj)
    objectに登録できるユーザデータへのポインタを返します。table, column, proc, exprのみ使用可能です。

パラメタ

•   obj -- 対象objectを指定します。

仕様

  GQTP

GQTPはGroonga Query Transfer Protocolの頭文字です。GQTPはgroonga用の独自プロトコルです。

  プロトコル

GQTPはステートフルなクライアント・サーバーモデルのプロトコルです。以下の流れが1つの処理単位です:

•   クライアントがリクエストを送る

•   サーバーがリクエストを受け取る

•   サーバーがリクエストを処理する

•   サーバーがレスポンスを返す

•   クライアントがレスポンスを受け取る

    1つのセッション内で0個以上の処理単位を実行できます。

    リクエストもレスポンスもGQTPヘッダーとボディから成ります。GQTPヘッダーは固定長のデータです。ボディは可変長サイズのデータです。ボディのサイズはGQTPヘッダーの中に入っています。GQTPではボディの中身については何も定義しません。

  GQTPヘッダー

GQTPヘッダーは以下の符号なし整数値から成ります:
名前 | サイズ | 説明
protocol | 1byte | プロトコルの種類。
query_type | 1byte | ボディのコンテントタイプ。
key_length | 2byte | 未使用。
level | 1byte | 未使用。
flags | 1byte | フラグ。
status | 2byte | リターンコード。
size | 4byte | ボディのサイズ。
opaque | 4byte | 未使用。
cas | 8byte | 未使用。

ヘッダーのすべての値はネットワークバイトオーダーを使っています。

以下のセクションではそれぞれのヘッダーの値で利用可能な値について説明します。

GQTPヘッダーは全部で24byteになります。

  protocol

リクエストのGQTPヘッダーでもレスポンスのGQTPヘッダーでも、この値は常に 0xc7 になります。

  query_type

この値は以下のいずれかの値です:
名前 | 値 | 説明
NONE | 0 | 自由形式。
TSV | 1 | 値をタブで区切った形式。
JSON | 2 | JSON。
XML | 3 | XML。
MSGPACK | 4 | MessagePack。

リクエストGQTPヘッダーでは使われません。

レスポンスGQTPヘッダーで使われます。ボディは指定した形式にします。

  flags

この値は以下の値をビット単位ORしたものになります:
名前 | 値 | 説明
MORE | 0x01 | まだデータがあります。
TAIL | 0x02 | これ以上データはありません。
HEAD | 0x04 | 未使用。
QUIET | 0x08 | レスポンスを出力しません。
QUIT | 0x10 | 終了します。

MORE あるいは TAIL フラグは必ず指定しないといけません。

MORE フラグを使うときは QUIET フラグも使うべきです。リクエストが途中のときはレスポンスを出力する必要がないからです。

セッションを終了するときは QUIT フラグを使ってください。

  status

利用可能な値です。将来的に新しいステータスが追加される可能性があります。

•   0: SUCCESS

•   1: END_OF_DATA

•   65535: UNKNOWN_ERROR

•   65534: OPERATION_NOT_PERMITTED

•   65533: NO_SUCH_FILE_OR_DIRECTORY

•   65532: NO_SUCH_PROCESS

•   65531: INTERRUPTED_FUNCTION_CALL

•   65530: INPUT_OUTPUT_ERROR

•   65529: NO_SUCH_DEVICE_OR_ADDRESS

•   65528: ARG_LIST_TOO_LONG

•   65527: EXEC_FORMAT_ERROR

•   65526: BAD_FILE_DESCRIPTOR

•   65525: NO_CHILD_PROCESSES

•   65524: RESOURCE_TEMPORARILY_UNAVAILABLE

•   65523: NOT_ENOUGH_SPACE

•   65522: PERMISSION_DENIED

•   65521: BAD_ADDRESS

•   65520: RESOURCE_BUSY

•   65519: FILE_EXISTS

•   65518: IMPROPER_LINK

•   65517: NO_SUCH_DEVICE

•   65516: NOT_A_DIRECTORY

•   65515: IS_A_DIRECTORY

•   65514: INVALID_ARGUMENT

•   65513: TOO_MANY_OPEN_FILES_IN_SYSTEM

•   65512: TOO_MANY_OPEN_FILES

•   65511: INAPPROPRIATE_I_O_CONTROL_OPERATION

•   65510: FILE_TOO_LARGE

•   65509: NO_SPACE_LEFT_ON_DEVICE

•   65508: INVALID_SEEK

•   65507: READ_ONLY_FILE_SYSTEM

•   65506: TOO_MANY_LINKS

•   65505: BROKEN_PIPE

•   65504: DOMAIN_ERROR

•   65503: RESULT_TOO_LARGE

•   65502: RESOURCE_DEADLOCK_AVOIDED

•   65501: NO_MEMORY_AVAILABLE

•   65500: FILENAME_TOO_LONG

•   65499: NO_LOCKS_AVAILABLE

•   65498: FUNCTION_NOT_IMPLEMENTED

•   65497: DIRECTORY_NOT_EMPTY

•   65496: ILLEGAL_BYTE_SEQUENCE

•   65495: SOCKET_NOT_INITIALIZED

•   65494: OPERATION_WOULD_BLOCK

•   65493: ADDRESS_IS_NOT_AVAILABLE

•   65492: NETWORK_IS_DOWN

•   65491: NO_BUFFER

•   65490: SOCKET_IS_ALREADY_CONNECTED

•   65489: SOCKET_IS_NOT_CONNECTED

•   65488: SOCKET_IS_ALREADY_SHUTDOWNED

•   65487: OPERATION_TIMEOUT

•   65486: CONNECTION_REFUSED

•   65485: RANGE_ERROR

•   65484: TOKENIZER_ERROR

•   65483: FILE_CORRUPT

•   65482: INVALID_FORMAT

•   65481: OBJECT_CORRUPT

•   65480: TOO_MANY_SYMBOLIC_LINKS

•   65479: NOT_SOCKET

•   65478: OPERATION_NOT_SUPPORTED

•   65477: ADDRESS_IS_IN_USE

•   65476: ZLIB_ERROR

•   65475: LZO_ERROR

•   65474: STACK_OVER_FLOW

•   65473: SYNTAX_ERROR

•   65472: RETRY_MAX

•   65471: INCOMPATIBLE_FILE_FORMAT

•   65470: UPDATE_NOT_ALLOWED

•   65469: TOO_SMALL_OFFSET

•   65468: TOO_LARGE_OFFSET

•   65467: TOO_SMALL_LIMIT

•   65466: CAS_ERROR

•   65465: UNSUPPORTED_COMMAND_VERSION

  size

ボディのサイズです。ボディの最大サイズは4GiBです。これは size が4byteの符号なし整数だからです。4GiB以上のサイズのデータを送りたい場合は MORE フラグを使ってください。

  例

  GQTPサーバの起動

Groongaには、専用のプロトコルであるGQTPが存在します。GQTPを用いることにより、データベースへとリモートアクセスすることができます。以下の書式はGQTPサーバの起動方法を示しています。

Form:

groonga [-p PORT_NUMBER] -s DB_PATH

-s オプションはGroongaをサーバとして起動するためのオプションです。DB_PATHには既存のデータベースのパスを指定します。 -p オプションとその引数により、サーバのポート番号を指定することができます。ポート番号を省略した場合は10043が使用されます。

以下のコマンドにより、デフォルトのポート番号で待ち受けるサーバを起動することができます。サーバは指定されたデータベースへの操作を受け付けます。

実行例:

% groonga -s /tmp/groonga-databases/introduction.db
Ctrl-c
%

  GQTPデーモンの起動

GQTPサーバはデーモンとして起動することができます。オプションとして、 -s の代わりに -d を与えてください。

Form:

groonga [-p PORT_NUMBER] -d DB_PATH

Groongaをデーモンとして起動したときは、デーモンのプロセスIDが表示されます。以下の例では、12345というプロセスIDが表示されています。サーバとして起動した場合と同様に、指定されたデータベースへの操作を受け付けます。

実行例:

% groonga -d /tmp/groonga-databases/introduction.db
12345
%

  GQTPサーバへの接続

GQTPサーバに接続するクライアントは、以下のように起動します。

Form:

groonga [-p PORT_NUMBER] -c [HOST_NAME_OR_IP_ADDRESS]

上記のコマンドによって起動されたクライアントは、サーバとの接続に成功すると対話モードに入ります。HOST_NAME_OR_IP_ADDRESSにはサーバのホスト名もしくはIPアドレスを指定します。HOST_NAME_OR_IP_ADDRESSが省略されたときは"localhost"をサーバのホスト名として採用します。また、 -p オプションとその引数により、サーバのポート番号を指定することができます。ポート番号を省略した場合は10043が使用されます。

実行例:

% groonga -c
status
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     "uptime": 0,
#     "max_command_version": 2,
#     "n_queries": 0,
#     "cache_hit_rate": 0.0,
#     "version": "4.0.1",
#     "alloc_count": 140,
#     "command_version": 1,
#     "starttime": 1395806078,
#     "default_command_version": 1
#   }
# ]
> ctrl-d
%

対話モードでは、標準入力からコマンドを読み込んで順次実行します。

  GQTPサーバの終了

GQTPサーバを終了する安全は方法は、クライアントを起動して /reference/commands/shutdown を発行することです。

実行例:

% groonga -c
> shutdown
%

  参照

•   /reference/executables/groonga

•   /server/gqtp

  検索

/reference/commands/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は基本的に完全一致検索のみを行います。完全一致検索でのヒット件数が所定の閾値以下の場合に限り、非わかち書き検索を行い、それでもヒット件数が閾値以下の場合は部分一致検索を行います。（閾値のデフォルト値は0です。）

ただし、すでに検索結果セットが存在する場合はたとえヒット件数が閾値以下でも完全一致検索のみを行います。

例えば、以下のようなクエリの場合は、それぞれの検索でヒット件数が閾値以下の場合は完全一致検索、非わかち書き検索、部分一致検索を順に行います。:

select Shops --match_column description --query スープカレー

しかし、以下のように全文検索を行う前に検索結果セットが存在する場合は完全一致検索のみを行います。（point > 3で閾値の件数よりヒットしている場合）:

select Shops --filter '"point > 3 && description @ \"スープカレー\""'

そのため、descriptionに「スープカレーライス」が含まれていても、「スープカレーライス」は「スープカレー」に完全一致しないのでヒットしません。

制限事項

Groongaにはいくつか制限事項があります。

  テーブルの制限

テーブルには以下の制限があります。

•   1つのキーの最大サイズ: 4KiB

•   最大総キーサイズ: 4GiBまたは1TiB（ table-create-flags に KEY_LARGE フラグを指定した場合）

•   最大レコード数: 268,435,455 (約2億6千万)

    実際には他の諸条件の制約により上記の値まで到達しない場合もあります。

  インデックス上限値

1つのインデックスにおける論理上の上限値は以下のとおりです。

•   最大語彙数: 268,435,455 (約2億6千万)

•   最大インデックスサイズ: 256GiB

    実際には他の諸条件の制約により上記の値まで到達しない場合もあります。

  カラムの制限

1つのカラムにつき、次の制限があります。

•   カラムに格納した値の合計サイズの上限値: 256GiB

トラブルシューティング

  同じ検索キーワードなのに全文検索結果が異なる

同じ検索キーワードでも一緒に指定するクエリによっては全文検索の結果が異なることがあります。ここでは、その原因と対策方法を説明します。

  例

まず、実際に検索結果が異なる例を説明します。

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 ShortText --default_tokenizer TokenMecab  --normalizer NormalizerAuto
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系のトークナイザーを指定することにより再現率をあげることができますが、適合率が下がり検索ノイズが含まれる可能性が高くなります。この度合いを調整するためには /reference/commands/select のmatch_columnsで使用する索引毎に重み付けを指定します。

ここでも、前述の例を使って具体例を示します。まず、TokenBigramを用いた索引を追加します。:

table_create Bigram TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram  --normalizer NormalizerAuto
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-threshold=100

この場合も対策方法1同様、検索ノイズが上位に現れる可能性が高くなることに注意してください。検索ノイズが多くなった場合は指定する値を低くする必要があります。

  mmap Cannot allocate memoryエラーを回避するには

  例

ログファイルに以下のようなmmapエラーが存在する場合があります。: 2013-06-04 08:19:34.835218|A|4e86e700|mmap(4194304,551,432017408)=Cannot allocate memory <13036498944>

<13036498944> はこの場合mmapの合計サイズ(約12GB)です。

  対策方法

以下の観点を確認する必要があります。

•   十分なメモリの空きが存在するか？

•   マッピング最大数を超過していないか？

    十分な空きメモリがあるかを調べるために、vmstat コマンドを使うことができます。

    最大マッピング数を超過しているかどうかを確認するために、 vm.max_map_count の値を調べることができます。

    もしこの問題が vm.max_map_count の値を調整することで解決するなら、これが原因です。

    groongaはメモリを256KBごとに確保するので、扱えるデータベースのサイズを以下の式で見積ることができます: (database size) = vm.max_map_count * (memory chunks)

    16GBを超えるデータベースを扱うには、少くとも65536を vm.max_map_count の値として設定しないといけません。 database size (16GB) = vm.max_map_count (65536) * memory chunks (256KB)

    sudo sysctl -w vm.max_map_count=65536 で一時的に vm.max_map_count を調整することができます。

    その後、設定値を /etc/sysctl.conf もしくは /etc/sysctl.d/*.conf へと保存します。

    チューニング関連のパラメータについては、 /reference/tuning のドキュメントを参照してください。

開発

このセクションではGroongaを使った開発について説明します。例えば、Groongaをデータベースとして使ったアプリケーション、libgroongaを使ったライブラリ、libgroongaの言語バインディングなどを開発することがあるでしょう。

  Travis CI

このセクションでは Travis CI 上でGroongaを使う方法について説明します。Travis CIはオープンソースコミュニティ用の継続的インテグレーション（CI）サービスです。

オープンソースソフトウェアを開発しているならTravis CIを使えます。このセクションではGroonga関連の設定のみ説明します。Travis CI一般については Travis CI: Documentation を読んでください。

  設定

Travis CIは64-bit版のUbuntu 12.04 LTS サーバ版を使っています。（ Travis CI: About Travis CI Environment 参照。）Travis CIにGroongaをインストールするために、Groongaプロジェクトが提供しているUbuntu 12.04 LTS用のapt-lineを使えます。

.travis.yml でビルド方法を変更することができます。（ Travis CI: Conifugration your Travis CI build with .travis.yml 参照。） before_install フックまたは install フックを使います。もし、Travis CIがサポートしている言語（例えばRuby）を使ったソフトウェアの場合は before_install を使います。そうでない場合は install を使います。

以下の sudo と before_install の設定を .travis.yml に加えます:

sudo: required
before_install:
  - curl --silent --location https://github.com/groonga/groonga/raw/master/data/travis/setup.sh | sh

ここで使っているセットアップスクリプトの中で sudo コマンドを使っているので、 sudo: required の設定が必要になります。

before_install フックではなく install フックを使わなければいけない場合は、単に before_install: を install: に書き換えてください。

上記の設定でビルド中にGroongaを使えるようになります。

  例

Travis CI上でGroongaを使っているオープンソースソフトウェアは以下の通りです

•   rroonga （Rubyバインディング）

•   Travis CIでのrroongaのビルド結果

•   rroonga用の.travis.yml

•   nroonga （node.jsバインディング）

•   Travis CIでのnroongaのビルド結果

•   nroonga用の.travis.yml

•   logaling-command (A glossary management command line tool)

•   Travis CIでのlogaling-commandのビルド結果

•   logaling-command用の.travis.yml

GROONGAへのコントリビュート方法

Groongaプロジェクトではみなさんからのコントリビュートを歓迎します！コントリビュートの方法はいくつもあります。Groongaを使ったり誰かに紹介することもコントリビュートですし、バグレポートを送ったり、Groonga本体やGroonga関連の開発に参加することもコントリビュートです。プログラムではなく、ドキュメントでのコントリビュートも歓迎します！

ユーザーの立場で:
    このドキュメントを読んでください。

布教する立場で:
    Groongaについてまわりの人に話してください。

開発者の立場で: 不具合報告や開発、ドキュメント
    これらについてはこのセクションで説明します。

  バグレポートの送り方

バグレポートを送るには2つやり方があります:

•   課題追跡システムへ登録する

•   メーリングリストへ報告する

    どちらのやり方でも大丈夫です。

  課題追跡システムへ登録する

Groongaプロジェクトは Github issue tracker を使っています。

GitHub issue tracker へのバグレポートは英語または日本語で大丈夫です。

  メーリングリストへ報告する

GroongaプロジェクトではGroongaについて議論するための /community があります。バグを説明したメールを送ってください。

  ドキュメント関連のコントリビュート方法

ドキュメントツールとして Sphinx を使います。

  Introduction

This documentation describes about how to write, generate and manage Groonga documentation.

  必要なソフトウェアのインストール

Groongaはドキュメントツールとして Sphinx を使います。

以下はSphinxをインストールするコマンドラインです。

Debian GNU/Linux, Ubuntu:

% sudo apt-get install -V -y python-sphinx

CentOS, Fedora:

% sudo yum install -y python-pip
% sudo pip install sphinx

OS X:

% brew install python
% brew install gettext
% export PATH=`brew --prefix gettext`/bin:$PATH
% pip install sphinx

プラットフォームに存在するPythonのバージョンが古すぎる場合は、Python 2.7のより新しいバージョンを手動でインストールする必要があります。例えば、 pyenv を使ったインストール手順は以下の通りです:

% pyenv install 2.7.11
% pyenv global 2.7.11
% pip install sphinx

  Run configure with --enable-document

Groonga disables documentation generation by default. You need to enable it explicitly by adding --enable-document option to configure:

% ./configure --enable-document

Now, your Groonga build is documentation ready.

  HTMLファイルを生成

You can generate HTML by the following command:

% make -C doc html

You can find generated HTML documentation at doc/locale/en/html/.

  Update

You can find sources of documentation at doc/source/. The sources should be written in English. See i18n about how to translate documentation.

You can update the target file when you update the existing documentation file.

You need to update file list after you add a new file, change file path and delete existing file. You can update file list by the following command:

% make -C doc update-files

The command updates doc/files.am.

  国際化

今のところ、Groongaには日本語でのドキュメントしかありません。1.2.2からgettextベースの Sphinx I18N feature を使ってドキュメントの国際化対応を始めました。この仕組みではベースの言語として英語を使い、日本語などの他の言語には英語からその言語に翻訳します。すべてのドキュメントはdoc/source/以下において、それをSphinxで処理します。

しかし、今のところ、doc/source/では日本語を使っています。そのため、まずは、doc/source/以下にある日本語のドキュメントを英語に翻訳する必要があります。ドキュメントを翻訳して、パッチを送ってくれるととても喜びます。

  翻訳の流れ

doc/source/*.txtを更新したら、翻訳を始めます。

これが翻訳の流れです:

1.  Sphinxをインストールします。（インストールされていない場合）

2.  Groongaのリポジトリをcloneします。

3.  .poファイルを更新します。

4.  .poファイルを編集します。

5.  HTMLファイルを生成します。

6.  HTMLの出力を確認します。

7.  翻訳が完了するまで、2.-4.を繰り返します。

8.  翻訳作業の成果をGroongaプロジェクトに送ってください！

    上記の流れを実行するコマンドラインです。詳細は以降のセクションで説明します。

    # Please fork https://github.com/groonga/groonga on GitHub
    % git clone https://github.com/${YOUR_GITHUB_ACCOUNT}/groonga.git
    % ./autogen.sh
    % ./configure --enable-document
    % cd doc/locale/${LANGUAGE}/LC_MESSAGES # ${LANGUAGE} is language code such as 'ja'.
    % make update # *.po are updated
    % editor *.po # translate *.po # you can use your favorite editor
    % cd ..
    % make html
    % browser html/index.html # confirm translation
    % git add LC_MESSAGES/*.po
    % git commit
    % git push

  Sphinxのインストール方法

introduction を参照してください。

  Groongaリポジトリのcloneの仕方

はじめに、GitHub上のGroongaリポジトリをforkしてください。 https://github.com/groonga/groonga にアクセスして Fork ボタンを押すだけです。これで自分のGroongaリポジトリをcloneすることができます。:

% git clone https://github.com/${YOUR_GITHUB_ACCOUNT}/groonga.git

cloneした後はconfigureする必要があります。:

% cd groonga
% ./autogen.sh
% ./configure --enable-document

この作業は初回セットアップ時のみだけの作業です。

以上の作業で問題があった場合は、 http://packages.groonga.org/source/groonga/ にあるソースファイルを利用してもよいです。

  .poファイルの更新の仕方

doc/locale/${LANGUAGE}/LC_MESSAGESディレクトリで make update を実行すると.poファイルを更新できます。（${LANGUAGE} は'ja'など自分の言語の言語コードに置き換えてください。）:

% cd doc/locale/ja/LC_MESSAGES
% make update

  .poの編集の仕方

.poファイルを編集するためのツールがあります。.poファイルは単なるテキストなので好きなエディタで編集できます。以下は.poファイルの編集に特化したエディタのリストです。

Emacs's po-mode
    gettextに同梱されています。

Poedit
    .po専用エディタです。たくさんのプラットフォームで動作します。

gted
    これも.po専用エディタです。Eclipseプラグインとして実装されています。

  HTMLファイルの生成方法

doc/locale/${LANGUAGE}ディレクトリで make html を実行すると更新した.poファイルを使ってHTMLファイルを生成できます。（${LANGUAGE} は'ja'など自分の言語の言語コードに置き換えてください。）:

% cd doc/locale/ja/
% make html

全ての言語のHTMLファイルを生成するにはdoc/locale/ディレクトリで make html を実行します。:

% cd doc/locale
% make html

注釈: .moファイルは make html で自動的に更新されるので、.moファイルのことを気にする必要はありません。

  HTML出力の確認の仕方

HTMLファイルはdoc/locale/${LANGUAGE}/html/以下に出力されます。（${LANGUAGE} は'ja'など自分の言語の言語コードに置き換えてください。）好きなブラウザで出力されたHTMLを確認してください。:

% firefox doc/locale/ja/html/index.html

  翻訳の成果の送り方

翻訳の成果はGitHubのpull requestかメールで送ってください。メールで送る場合はパッチでも.poファイルそのものでも構いません。

  pull requestの送り方

pull requestを送るためのコマンドライン:

% git add doc/locale/ja/LC_MESSAGES/*.po
% git commit
% git push

これでGitHub上でpull requestを送る準備ができました。あとは、GitHub上の自分のリポジトリのページへアクセスして Pull Request ボタンを押すだけです。

参考: Help.GitHub - pull requestを送る.

  パッチの送り方

パッチを作るためのコマンドライン

% git add doc/locale/ja/LC_MESSAGES/*.po
% git commit
% git format-patch origin/master

カレントディレクトリに000X-YYY.patchという名前のファイルができていると思います。これをGroongaプロジェクトに送ってください！

参考: /community に連絡先の情報があります。

  .poファイルの送り方

doc/locale/${LANGUAGE}/LC_MESSAGES/以下を.tar.gzや.zipなどでアーカイブにしてGroongaプロジェクトに送ってください！（${LANGUAGE} は'ja'など自分の言語の言語コードに置き換えてください。）こちらでアーカイブの中の内容をマージします。

参考: /community に連絡先の情報があります。

  新しい言語の追加方法

新しい翻訳対象の言語を追加するコマンドライン:

% cd doc/locale
% make add LOCALE=${LANGUAGE} # specify your language code such as 'de'.

${LANGUAGE} は'ja'などの自分の言語の言語コードに置き換えてください。

参考: 言語名を表記するためのコードの一覧.

  C API

今のところ、C APIのドキュメントはinclude/groonga.hにありますが、これをdoc/source/c-api/*.txtに移動したいと思っています。C APIのドキュメントを移動して、パッチを送ってくれるととても喜びます。

Sphinxの the C domain markup を使う予定です。

  Groonga開発者向け情報

  リポジトリ

Groongaのリポジトリは GitHub 上にあります。次のコマンドでcloneできます。

% git clone --recursive https://github.com/groonga/groonga.git

Groonga関係のプロジェクト（grntest, fluent-plugin-groongaなど） のリストはリンク先をごらんください。

  リポジトリーのGroongaをビルドする方法

このドキュメントではビルドシステム毎にリポジトリーにあるGroongaをビルドする方法を説明します。GNU/LinuxまたはUnix（*BSDやSolaris、OS Xなど）でGroongaを開発する場合はGNU AutotoolsかCMakeを選べます。Windowsで開発する場合はCMakeを使う必要があります。

  GNU Autotoolsを使ってリポジトリーのGroongaをビルドする方法

このドキュメントはGNU Autotoolsを使ってリポジトリーのGroongaをビルドする方法を説明します。

WindowsでGroongaを開発する場合はこの方法を使えません。Groongaの開発にWindowsを使いたい場合は windows_cmake を参照してください。

  必要なソフトウェアのインストール

TODO

•   Autoconf

•   Automake

•   GNU Libtool

•   Ruby

•   Git

•   Cutter

•   ...

  リポジトリーからGroongaをチェックアウト

ユーザーはリリースされたソースアーカイブを使います。しかし、開発者はリポジトリーからGroongaをビルドするべきです。なぜなら、リポジトリーにあるソースコードが最新のソースコードだからです。

Groongaのリポジトリーは GitHub にあります。リポジトリーから最新のソースコードをチェックアウトします:

% git clone --recursive git@github.com:groonga/groonga.git

  configure を作る

configure を作る必要があります。 configure はソースアーカイブには含まれていますが、リポジトリーには含まれていません。

configure はあなたのシステムを検出してあなたの環境用のビルドパラメーターを生成するビルドツールです。

configure を作るために autogen.sh を実行します:

% ./autogen.sh

  configure を実行

configure にオプションを渡してビルドパラメーターをカスタマイズできます。

開発者向けのオススメの configure オプションは次の通りです:

% ./configure --prefix=/tmp/local --enable-debug --enable-mruby --with-ruby

それぞれのオプションの説明です。

--prefix=/tmp/local
    あなたのGroongaを一時ディレクトリーにインストールように指定しています。 /tmp/local ディレクトリーを削除することで「クリーンインストール」を試すことができます。インストール処理をデバッグするときに便利です。

--enable-debug
    C/C++コンパイラーのデバッグオプションを有効にします。GDBやLLDBなどのデバッガーでデバッグするときに便利です。

--eanble-mruby
    mrubyサポートを有効にします。この機能はデフォルトで無効になっていますが、開発者はこの機能を有効にするべきです。

--with-ruby
    --enable-mruby オプションと機能テストの実行に必要です。

  make を実行

これでGroongaをビルドできるようになりました。

開発者向けのオススメの make のコマンドラインです:

% make -j8 > /dev/null

-j8 はビルド時間を短縮します。並列ビルドが有効になっているためです。もし、CPUコアが8よりもたくさんあるのであれば、 8 をもっと増やすとさらにビルドタイムを短縮できるでしょう。

> /dev/null をつけることで警告メッセージとエラーメッセージだけが見えるようになります。開発者は新しいコミットで警告メッセージもエラーメッセージも増やすべきではありません。

  参考

•   /contribution/development/test

  GNU/LinuxまたはUnix上でCMakeを使ってリポジトリーのGroongaをビルドする方法

このドキュメントではGNU/LinuxまたはUnix上でCMakeを使ってリポジトリーのGroongaをビルドする方法を説明します。

Unixとは*BSDやSolaris、OS Xなどのことです。

Groongaの開発にWindowsを使いたい場合は windows_cmake を参照してください。

Groongaをリリースするときはこの方法を使うことはできません。GroongaのリリースシステムはGNU Autotoolsを使ったビルドでしかサポートしてません。GNU Autotoolsを使ったビルドについては unix_autotools を参照してください。

  必要なソフトウェアのインストール

TODO

•   CMake

•   Ruby

•   Git

•   Cutter

•   ...

  リポジトリーからGroongaをチェックアウト

ユーザーはリリースされたソースアーカイブを使います。しかし、開発者はリポジトリーからGroongaをビルドするべきです。なぜなら、リポジトリーにあるソースコードが最新のソースコードだからです。

Groongaのリポジトリーは GitHub にあります。リポジトリーから最新のソースコードをチェックアウトします:

% git clone --recursive git@github.com:groonga/groonga.git

  cmake を実行

あなたの環境用の Makefile を作る必要があります。

cmake へオプションを渡してビルドパラメーターをカスタマイズできます。

開発者向けのオススメ cmake オプションは次の通りです:

% cmake . -DCMAKE_INSTALL_PREFIX=/tmp/local -DGRN_WITH_DEBUG=on -DGRN_WITH_MRUBY=on

それぞれのオプションの説明です。

-DCMAKE_INSTALL_PREFIX=/tmp/local あなたのGroongaを一時ディレクトリーにインストールように指定しています。 /tmp/local ディレクトリーを削除することで「クリーンインストール」を試すことができます。インストール処理をデバッグするときに便利です。

-DGRN_WITH_DEBUG=on C/C++コンパイラーのデバッグオプションを有効にします。GDBやLLDBなどのデバッガーでデバッグするときに便利です。

-DGRN_WITH_MRUBY=on mrubyサポートを有効にします。この機能はデフォルトで無効になっていますが、開発者はこの機能を有効にするべきです。

  make を実行

これでGroongaをビルドできるようになりました。

開発者向けのオススメの make のコマンドラインです:

% make -j8 > /dev/null

-j8 はビルド時間を短縮します。並列ビルドが有効になっているためです。もし、CPUコアが8よりもたくさんあるのであれば、 8 をもっと増やすとさらにビルドタイムを短縮できるでしょう。

> /dev/null をつけることで警告メッセージとエラーメッセージだけが見えるようになります。開発者は新しいコミットで警告メッセージもエラーメッセージも増やすべきではありません。

  参考

•   /contribution/development/test

  Windows上でCMakeを使ってリポジトリーのGroongaをビルドする方法

このドキュメントではWindows上でCMakeを使ってリポジトリーのGroongaをビルドする方法を説明します。

Groongaの開発にGNU/LinuxまたはUnixを使いたい人は unix_cmake を参照してください。

Unixとは*BSDやSolaris、OS Xなどのことです。

  必要なソフトウェアのインストール

•   Microsoft Visual Studio Express 2013 for Windows Desktop

•   CMake

•   Ruby

•   RubyInstaller for Windows をオススメします。

•   Git: Windows用のGitクライアントはいくつかあります。例：

•   公式のGitパッケージ

•   TortoiseGit

•   Git for Windows

•   GitHub Desktop

  リポジトリーからGroongaをチェックアウト

ユーザーはリリースされたソースアーカイブを使います。しかし、開発者はリポジトリーからGroongaをビルドするべきです。なぜなら、リポジトリーにあるソースコードが最新のソースコードだからです。

Groongaのリポジトリーは GitHub にあります。リポジトリーから最新のソースコードをチェックアウトします:

> git clone --recursive git@github.com:groonga/groonga.git

  cmake を実行

あなたの環境用の Makefile を作る必要があります。

cmake へオプションを渡してビルドパラメーターをカスタマイズできます。

-G オプションを指定する必要があります。有効な -G の値は次の通りです。

•   "Visual Studio 12 2013": 32bitビルド用。

•   "Visual Studio 12 2013 Win64": 64bitビルド用。

    開発者向けのオススメ cmake オプションは次の通りです:

    > cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga -DGRN_WITH_MRUBY=on

    それぞれのオプションの説明です。

    -G "Visual Studio 12 2013 Win64"

    -DCMAKE_INSTALL_PREFIX=C:\Groonga ビルドしたGroongaを C:\\Groonga にインストールする、と指定しています。

    -DGRN_WITH_MRUBY=on mrubyサポートを有効にします。この機能はデフォルトで無効になっていますが、開発者はこの機能を有効にするべきです。

  Groongaをビルド

これでGroongaをビルドできるようになりました。

Visual Studioまたは cmake --build を使えます。

cmake --build でGroongaをビルドするコマンドラインは次の通りです:

> cmake --build . --config Debug

  参考

•   /contribution/development/test

  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する。

  ユーザーと協力して開発をうまく進めていくための指針

Groongaを使ってくれているユーザーと協力して 開発をうまく進めていくためにこうするといい、という事柄をまとめました。 まとめておくと、新しく開発に加わる人とも共有することができます。

  twitter編

Groongaを使ってもらえるようにtwitterのアカウントGroongaを取得して 日々、リリースの案内をしたり、ユーザーサポートをしたりしています。

リリースの案内に利用する場合には、やりとりを考えなくて良いですが、 複数人によるサポートをGroongaで行う場合に、どうサポートするのが 良いのか/どうしてそうするのかという共通認識を持っていないと一貫性のないサポートとなってしま います。

twitterでサポートされている安心感からGroongaユーザーの拡大に繋げる ことができるようにサポートの際に気をつけることをまとめます。

  過去のツイートはおさらいしておく

  理由

自分がツイートした内容を把握していない返信をされたら普通いい気はしません。

  対応

過去のツイートをおさらいし、こうすれば良いという提案をできるのが望ましいです。:

良い例: ○○だと原因は□□ですね。××すると大丈夫です。

  こちらから情報を提供する

  理由

困っているユーザーが複数回ツイートして限られたなかで情報を提供してくれていることがあります。 その限られたツイートから解決方法が見つかればユーザーにとって余計な手間が少なくて済みます。 あれこれ情報提供を要求すると、ユーザーはそのぶん確認する作業が必要になります。

  対応

最初に声をかけるときに解決策を1つか2つ提案できると望ましいです。ユーザーにあまり負担を感じさせないようにすると良いです。:

良い例: ○○の場合は□□の可能性があるので、××を試してもらえますか？

  twitterでのやりとりはできるだけ他の場所(例えばredmine)へと誘導しない

  理由

twitterは気軽につぶやけることが重要なので、気軽にできないことを相手に要求すると萎縮されてしまう可能性があります。

いきなりredmineでバグ報告をお願いすると、しりごみしてしまうかもしれません。:

駄目な例: 再現手順をMLかredmineに報告してもらえますか?

Groonga関連で気軽につぶやけないとなると開発者は困っている人を見つけられないし、利用者は困ったままとなるので、双方にとって嬉しくない状態になってしまいます。

  対応

twitterでやりとりを完結できるようにします。

  クエリの実現

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のみがヒットします。

  リリース手順

  前提条件

リリース手順の前提条件は以下の通りです。

•   ビルド環境は Debian GNU/Linux (sid)

•   コマンドラインの実行例はzsh

    作業ディレクトリ例は以下を使用します。

•   GROONGA_DIR=$HOME/work/groonga

•   GROONGA_CLONE_DIR=$HOME/work/groonga/groonga.clean

•   GROONGA_ORG_PATH=$HOME/work/groonga/groonga.org

•   CUTTER_DIR=$HOME/work/cutter

•   CUTTER_SOURCE_PATH=$HOME/work/cutter/cutter

  ビルド環境の準備

以下にGroongaのリリース作業を行うために事前にインストール しておくべきパッケージを示します。

なお、ビルド環境としては Debian GNU/Linux (sid)を前提として説明しているため、その他の環境では適宜読み替えて下さい。:

% sudo apt-get install -V debootstrap createrepo rpm mercurial python-docutils python-jinja2 ruby-full mingw-w64 g++-mingw-w64 mecab libmecab-dev nsis gnupg2 dh-autoreconf python-sphinx bison

Debian系（.deb）やRed Hat系（.rpm）パッケージのビルドには Vagrant を使用します。apt-getでインストールできるのは古いバージョンなので、Webサイトから最新版をダウンロードしてインストールすることをおすすめします。

Vagrantで使用する仮想化ソフトウェア（VirtualBox、VMwareなど）がない場合、合わせてインストールしてください。なお、VirtualBoxはsources.listにcontribセクションを追加すればapt-getでインストールできます。:

% cat /etc/apt/sources.list
deb http://ftp.jp.debian.org/debian/ sid main contrib
deb-src http://ftp.jp.debian.org/debian/ sid main contrib
% sudo apt-get update
% sudo apt-get install virtualbox

また、rubyのrakeパッケージを以下のコマンドによりインストールします。:

% sudo gem install rake

  パッケージ署名用秘密鍵のインポート

リリース作業ではRPMパッケージに対する署名を行います。 その際、パッケージ署名用の鍵が必要です。

Groongaプロジェクトでは署名用の鍵をリリース担当者の公開鍵で暗号化してリポジトリのpackages/ディレクトリ以下へと登録しています。

リリース担当者はリポジトリに登録された秘密鍵を復号した後に鍵のインポートを以下のコマンドにて行います。:

% cd packages
% gpg --decrypt release-key-secret.asc.gpg.(担当者) > (復号した鍵
ファイル)
% gpg --import  (復号した鍵ファイル)

鍵のインポートが正常終了すると gpg --list-keys でGroongaの署名用の鍵を確認することができます。:

pub   1024R/F10399C0 2012-04-24
uid                  groonga Key (groonga Official Signing Key)
<packages@groonga.org>
sub   1024R/BC009774 2012-04-24

鍵をインポートしただけでは使用することができないため、インポートした鍵に対してtrust,signを行う必要があります。

以下のコマンドを実行して署名を行います。(途中の選択肢は省略):

% gpg --edit-key packages@groonga.org
gpg> trust
gpg> sign
gpg> save
gpg> quit

この作業は、新規にリリースを行うことになった担当者やパッケージに署名する鍵に変更があった場合などに行います。

  リリース作業用ディレクトリの作成

Groongaのリリース作業ではリリース専用の環境下(コンパイルフラグ)でビルドする必要があります。

リリース時と開発時でディレクトリを分けずに作業することもできますが、誤ったコンパイルフラグでリリースしてしまう危険があります。

そのため、以降の説明では$GROONGA_DIR以下のディレクトリにリリース用の作業ディレクトリ(groonga.clean)としてソースコードをcloneしたものとして説明します。

リリース用のクリーンな状態でソースコードを取得するために$GROONGA_DIRにて以下のコマンドを実行します。:

% git clone --recursive git@github.com:groonga/groonga.git groonga.clean

この作業はリリース作業ごとに行います。

  変更点のまとめ

前回リリース時からの変更点を$GROONGA_CLONE_DIR/doc/source/news.txtにまとめます。 ここでまとめた内容についてはリリースアナウンスにも使用します。

前回リリースからの変更履歴を参照するには以下のコマンドを実行します。:

% git log -p --reverse $(git tag | tail -1)..

ログを^commitで検索しながら、以下の基準を目安として変更点を追記していきます。

含めるもの

•   ユーザへ影響するような変更

•   互換性がなくなるような変更

    含めないもの

•   内部的な変更(変数名の変更やらリファクタリング)

  Groongaのウェブサイトの取得

GroongaのウェブサイトのソースはGroonga同様にgithubにリポジトリを置いています。

リリース作業では後述するコマンド(make update-latest-release)にてトップページのバージョンを置き換えることができるようになっています。

Groongaのウェブサイトのソースコードを$GROONGA_ORG_PATHとして取得するためには、$GROONGA_DIRにて以下のコマンドを実行します。:

% git clone git@github.com:groonga/groonga.org.git

これで、$GROONGA_ORG_PATHにgroonga.orgのソースを取得できます。

  cutterのソースコード取得

Groongaのリリース作業では、cutterに含まれるスクリプトを使用しています。

そこであらかじめ用意しておいた$HOME/work/cutterディレクトリにてcutterのソースコードを以下のコマンドにて取得します。:

% git clone git@github.com:clear-code/cutter.git

これで、$CUTTER_SOURCE_PATHディレクトリにcutterのソースを取得できます。

  configureスクリプトの生成

Groongaのソースコードをcloneした時点ではconfigureスクリプトが含まれておらず、そのままmakeコマンドにてビルドすることができません。

$GROONGA_CLONE_DIRにてautogen.shを以下のように実行します。:

% sh autogen.sh

このコマンドの実行により、configureスクリプトが生成されます。

  configureスクリプトの実行

Makefileを生成するためにconfigureスクリプトを実行します。

リリース用にビルドするためには以下のオプションを指定してconfigureを実行します。:

% ./configure \
      --prefix=/tmp/local \
      --with-launchpad-uploader-pgp-key=(Launchpadに登録したkeyID) \
      --with-groonga-org-path=$HOME/work/groonga/groonga.org \
      --enable-document \
      --with-ruby \
      --enable-mruby \
      --with-cutter-source-path=$HOME/work/cutter/cutter

configureオプションである--with-groonga-org-pathにはGroongaのウェブサイトのリポジトリをcloneした場所を指定します。

configureオプションである--with-cutter-source-pathにはcutterのソースをcloneした場所を指定します。

以下のようにGroongaのソースコードをcloneした先からの相対パスを指定することもできます。:

% ./configure \
      --prefix=/tmp/local \
      --with-launchpad-uploader-pgp-key=(Launchpadに登録したkeyID) \
      --with-groonga-org-path=../groonga.org \
      --enable-document \
      --with-ruby \
      --enable-mruby \
      --with-cutter-source-path=../../cutter/cutter

あらかじめpackagesユーザでpackages.groonga.orgにsshログインできることを確認しておいてください。

ログイン可能であるかの確認は以下のようにコマンドを実行して行います。:

% ssh packages@packages.groonga.org

  make update-latest-releaseの実行

make update-latest-releaseコマンドでは、OLD_RELEASE_DATEに前回のリリースの日付を、NEW_RELEASE_DATEに次回リリースの日付を指定します。

2.0.2のリリースを行った際は以下のコマンドを実行しました。::

% make update-latest-release OLD_RELEASE=2.0.1 OLD_RELEASE_DATE=2012-03-29 NEW_RELEASE_DATE=2012-04-29

これにより、clone済みのGroongaのWebサイトのトップページのソース(index.html,ja/index.html)やRPMパッケージのspecファイルのバージョン表記などが更新されます。

  make update-filesの実行

ロケールメッセージの更新や変更されたファイルのリスト等を更新するために以下のコマンドを実行します。:

% make update-files

make update-filesを実行すると新規に追加されたファイルなどが各種.amファイルへとリストアップされます。

リリースに必要なファイルですので漏れなくコミットします。

  make update-poの実行

ドキュメントの最新版と各国語版の内容を同期するために、poファイルの更新を以下のコマンドにて実行します。:

% make update-po

make update-poを実行すると、doc/locale/ja/LC_MESSAGES以下の各種.poファイルが更新されます。

  poファイルの翻訳

make update-poコマンドの実行により更新した各種.poファイルを翻訳します。

翻訳結果をHTMLで確認するために、以下のコマンドを実行します。:

% make -C doc/locale/ja html
% make -C doc/locale/en html

確認が完了したら、翻訳済みpoファイルをコミットします。

  リリースタグの設定

リリース用のタグを打つには以下のコマンドを実行します。:

% make tag

注釈: タグを打った後にconfigureを実行することで、ドキュメント生成時のバージョン番号に反映されます。

  リリース用アーカイブファイルの作成

リリース用のソースアーカイブファイルを作成するために以下のコマンドを$GROONGA_CLONE_DIRにて実行します。:

% make dist

これにより$GROONGA_CLONE_DIR/groonga-(バージョン).tar.gzが作成されます。

注釈: タグを打つ前にmake distを行うとversionが古いままになることがあります。 するとgroonga --versionで表示されるバージョン表記が更新されないので注意が必要です。 make distで生成したtar.gzのversionおよびversion.shがタグと一致することを確認するのが望ましいです。

  パッケージのビルド

リリース用のアーカイブファイルができたので、パッケージ化する作業を行います。

パッケージ化作業は以下の3種類を対象に行います。

•   Debian系(.deb)

•   Red Hat系(.rpm)

•   Windows系(.exe,.zip)

    パッケージのビルドではいくつかのサブタスクから構成されています。

  ビルド用パッケージのダウンロード

debパッケージのビルドに必要なパッケージをダウンロードするには以下のコマンドを実行します。:

% cd packages/apt
% make download

これにより、lucid以降の関連する.debパッケージやソースアーカイブなどがカレントディレクトリ以下へとダウンロードされます。

rpmパッケージのビルドに必要なパッケージをダウンロードするには以下のコマンドを実行します。:

% cd packages/yum
% make download

これにより、GroongaやMySQLのRPM/SRPMパッケージなどがカレントディレクトリ以下へとダウンロードされます。

Windowsパッケージのビルドに必要なパッケージをダウンロードするには以下のコマンドを実行します。:

% cd packages/windows
% make download

これにより、Groongaのインストーラやzipアーカイブがカレントディレクトリ以下へとダウンロードされます。

sourceパッケージに必要なものをダウンロードするには以下のコマンドを実行します。:

% cd packages/source
% make download

これにより過去にリリースしたソースアーカイブ(.tar.gz)が packages/source/filesディレクトリ以下へとダウンロードされます。

  Debian系パッケージのビルド

Groongaのpackages/aptサブディレクトリに移動して、以下のコマンドを実行します。:

% cd packages/apt
% make build PALALLEL=yes

make build PALALLEL=yesコマンドを実行すると、ディストリビューションのリリースとアーキテクチャの組み合わせでビルドを平行して行うことができます。

現在サポートされているのは以下の通りです。

•   Debian GNU/Linux

•   wheezy i386/amd64

•   jessie i386/amd64

    正常にビルドが終了すると$GROONGA_CLONE_DIR/packages/apt/repositories配下に.debパッケージが生成されます。

    make build ではまとめてビルドできないこともあります。 その場合にはディストリビューションごとやアーキテクチャごとなど、個別にビルドすることで問題が発生している箇所を切り分ける必要があります。

    生成したパッケージへの署名を行うには以下のコマンドを実行します。:

    % make sign-packages

    リリース対象のファイルをリポジトリに反映するには以下のコマンドを実行します。:

    % make update-repository

    リポジトリにGnuPGで署名を行うために以下のコマンドを実行します。:

    % make sign-repository

  Red Hat系パッケージのビルド

Groongaのpackages/yumサブディレクトリに移動して、以下のコマンドを実行します。:

% cd packages/yum
% make build PALALLEL=yes

make build PALALLEL=yesコマンドを実行すると、ディストリビューションのリリースとアーキテクチャの組み合わせでビルドを平行して行うことができます。

現在サポートされているのは以下の通りです。

•   centos-5 i386/x86_64

•   centos-6 i386/x86_64

•   centos-7 i386/x86_64

    ビルドが正常終了すると$GROONGA_CLONE_DIR/packages/yum/repositories配下にRPMパッケージが生成されます。

•   repositories/yum/centos/5/i386/Packages

•   repositories/yum/centos/5/x86_64/Packages

•   repositories/yum/centos/6/i386/Packages

•   repositories/yum/centos/6/x86_64/Packages

•   repositories/yum/centos/7/i386/Packages

•   repositories/yum/centos/7/x86_64/Packages

    リリース対象のRPMに署名を行うには以下のコマンドを実行します。:

    % make sign-packages

    リリース対象のファイルをリポジトリに反映するには以下のコマンドを実行します。:

    % make update-repository

  Windows用パッケージのビルド

packages/windowsサブディレクトリに移動して、以下のコマンドを実行します。:

% cd packages/windows
% make build
% make package
% make installer

make releaseを実行することでbuildからuploadまで一気に実行することができますが、途中で失敗することもあるので順に実行することをおすすめします。

make buildでクロスコンパイルを行います。 正常に終了するとdist-x64/dist-x86ディレクトリ以下にx64/x86バイナリを作成します。

make packageが正常に終了するとzipアーカイブをfilesディレクトリ以下に作成します。

make installerが正常に終了するとWindowsインストーラをfilesディレクトリ以下に作成します。

  パッケージの動作確認

ビルドしたパッケージに対しリリース前の動作確認を行います。

Debian系もしくはRed Hat系の場合には本番環境へとアップロードする前にローカルのaptないしyumのリポジトリを参照して正常に更新できることを確認します。

ここでは以下のようにrubyを利用してリポジトリをwebサーバ経由で参照できるようにします。:

% ruby -run -e httpd -- packages/yum/repositories (yumの場合)
% ruby -run -e httpd -- packages/apt/repositories (aptの場合)

  grntestの準備

grntestを実行するためにはGroongaのテストデータとgrntestのソースが必要です。

まずGroongaのソースを任意のディレクトリへと展開します。:

% tar zxvf groonga-(バージョン).tar.gz

次にGroongaのtest/functionディレクトリ以下にgrntestのソースを展開します。 つまりtest/function/grntestという名前でgrntestのソースを配置します。:

% ls test/function/grntest/
README.md  binlib  license  test

  grntestの実行方法

grntestではGroongaコマンドを明示的にしていすることができます。 後述のパッケージごとのgrntestによる動作確認では以下のようにして実行します。:

% GROONGA=(groongaのパス指定) test/function/run-test.sh

最後にgrntestによる実行結果が以下のようにまとめて表示されます。:

55 tests, 52 passes, 0 failures, 3 not checked tests.
94.55% passed.

grntestでエラーが発生しないことを確認します。

  Debian系の場合

Debian系の場合の動作確認手順は以下の通りとなります。

•   旧バージョンをchroot環境へとインストールする

•   chroot環境の/etc/hostsを書き換えてpackages.groonga.orgがホストを 参照するように変更する

•   ホストでwebサーバを起動してドキュメントルートをビルド環境のもの (repositories/apt/packages)に設定する

•   アップグレード手順を実行する

•   grntestのアーカイブを展開してインストールしたバージョンでテストを実 行する

•   grntestの正常終了を確認する

  Red Hat系の場合

Red Hat系の場合の動作確認手順は以下の通りとなります。

•   旧バージョンをchroot環境へとインストール

•   chroot環境の/etc/hostsを書き換えてpackages.groonga.orgがホストを参照するように変更する

•   ホストでwebサーバを起動してドキュメントルートをビルド環境のもの(packages/yum/repositories)に設定する

•   アップグレード手順を実行する

•   grntestのアーカイブを展開してインストールしたバージョンでテストを実行する

•   grntestの正常終了を確認する

  Windows向けの場合

•   新規インストール/上書きインストールを行う

•   grntestのアーカイブを展開してインストールしたバージョンでテストを実行する

•   grntestの正常終了を確認する

    zipアーカイブも同様にしてgrntestを実行し動作確認を行います。

  リリースアナウンスの作成

リリースの際にはリリースアナウンスを流して、Groongaを広く通知します。

news.txtに変更点をまとめましたが、それを元にリリースアナウンスを作成します。

リリースアナウンスには以下を含めます。

•   インストール方法へのリンク

•   リリースのトピック紹介

•   リリース変更点へのリンク

•   リリース変更点(news.txtの内容)

    リリースのトピック紹介では、これからGroongaを使う人へアピールする点や既存のバージョンを利用している人がアップグレードする際に必要な情報を提供します。

    非互換な変更が含まれるのであれば、回避方法等の案内を載せることも重要です。

    参考までに過去のリリースアナウンスへのリンクを以下に示します。

•   [Groonga-talk] [ANN] Groonga 2.0.2

•   http://sourceforge.net/mailarchive/message.php?msg_id=29195195

•   [groonga-dev,00794] [ANN] Groonga 2.0.2

•   http://osdn.jp/projects/groonga/lists/archive/dev/2012-April/000794.html

  パッケージのアップロード

動作確認が完了し、Debian系、Red Hat系、Windows向け、ソースコードそれぞれにおいてパッケージやアーカイブのアップロードを行います。

Debian系のパッケージのアップロードには以下のコマンドを実行します。:

% cd packages/apt
% make upload

Red Hat系のパッケージのアップロードには以下のコマンドを実行します。:

% cd packages/yum
% make upload

Windows向けのパッケージのアップロードには以下のコマンドを実行します。:

% cd packages/windows
% make upload

ソースアーカイブのアップロードには以下のコマンドを実行します。:

% cd packages/source
% make upload

アップロードが正常終了すると、リリース対象のリポジトリデータやパッケージ、アーカイブ等がpackages.groonga.orgへと反映されます。

  Ubuntu用パッケージのアップロード

Ubuntu向けのパッケージのアップロードには以下のコマンドを実行します。:

% cd packages/ubuntu
% make upload

現在サポートされているのは以下の通りです。

•   precise i386/amd64

•   trusty i386/amd64

•   vivid i386/amd64

    アップロードが正常終了すると、launchpad.net上でビルドが実行され、ビルド結果がメールで通知されます。ビルドに成功すると、リリース対象のパッケージがlaunchpad.netのGroongaチームのPPAへと反映されます。公開されているパッケージは以下のURLで確認できます。 https://launchpad.net/~groonga/+archive/ubuntu/ppa

  blogroonga(ブログ)の更新

http://groonga.org/blog/ および http://groonga.org/blog/ にて公開されているリリース案内を作成します。

基本的にはリリースアナウンスの内容をそのまま記載します。

cloneしたWebサイトのソースに対して以下のファイルを新規追加します。

•   groonga.org/en/_post/(リリース日)-release.md

•   groonga.org/ja/_post/(リリース日)-release.md

    編集した内容をpushする前に確認したい場合にはJekyllおよびRedCloth（Textileパーサー）、RDiscount（Markdownパーサー）、JavaScript interpreter（therubyracer、Node.jsなど）が必要です。 インストールするには以下のコマンドを実行します。:

    % sudo gem install jekyll RedCloth rdiscount therubyracer

    jekyllのインストールを行ったら、以下のコマンドでローカルにwebサーバを起動します。:

    % jekyll serve --watch

    あとはブラウザにてhttp://localhost:4000にアクセスして内容に問題がないかを確認します。

    注釈: 記事を非公開の状態でアップロードするには.mdファイルのpublished:をfalseに設定します。:

    ---
    layout: post.en
    title: Groonga 2.0.5 has been released
    published: false
    ---

  ドキュメントのアップロード

doc/source以下のドキュメントを更新、翻訳まで完了している状態で、ドキュメントのアップロード作業を行います。

そのためにはまず以下のコマンドを実行します。:

% make update-document

これによりcloneしておいたgroonga.orgのdoc/locale以下に更新したドキュメントがコピーされます。

生成されているドキュメントに問題のないことを確認できたら、コミット、pushしてgroonga.orgへと反映します。

  Homebrewの更新

OS Xでのパッケージ管理方法として Homebrew があります。

Groongaを簡単にインストールできるようにするために、Homebrewへpull requestを送ります。 https://github.com/mxcl/homebrew

すでにGroongaのFormulaは取り込まれているので、リリースのたびにFormulaの内容を更新する作業を実施します。

Groonga 3.0.6のときは以下のように更新してpull requestを送りました。 https://github.com/mxcl/homebrew/pull/21456/files

上記URLを参照するとわかるようにソースアーカイブのurlとsha1チェックサムを更新します。

  リリースアナウンス

作成したリリースアナウンスをメーリングリストへと流します。

•   groonga-dev groonga-dev@lists.osdn.me

•   Groonga-talk groonga-talk@lists.sourceforge.net

  Twitterでリリースアナウンスをする

blogroongaのリリースエントリには「リンクをあなたのフォロワーに共有する」ためのツイートボタンがあるので、そのボタンを使ってリリースアナウンスします。(画面下部に配置されている)

このボタンを経由する場合、ツイート内容に自動的にリリースタイトル(「groonga 2.0.8リリース」など)とblogroongaのリリースエントリのURLが挿入されます。

この作業はblogroongaの英語版、日本語版それぞれで行います。 あらかじめgroongaアカウントでログインしておくとアナウンスを円滑に行うことができます。

以上でリリース作業は終了です。

  リリース後にやること

リリースアナウンスを流し終えたら、次期バージョンの開発が始まります。

•   Groonga プロジェクトの新規バージョン追加

•   Groonga のbase_versionの更新

  Groonga プロジェクトの新規バージョン追加

Groonga プロジェクトの設定ページ にて新規バージョンを追加します。(例: release-2.0.6)

  Groonga バージョン更新

$GROONGA_CLONE_DIRにて以下のコマンドを実行します。:

% make update-version NEW_VERSION=2.0.6

これにより$GROONGA_CLONE_DIR/base_versionが更新されるのでコミットしておきます。

注釈: base_versionはtar.gzなどのリリース用のファイル名で使用します。

  ビルド時のTIPS

  ビルドを並列化したい

make build PALALLEL=yesを指定するとchroot環境で並列にビルドを 実行できます。

  特定の環境向けのみビルドしたい

Debian系の場合、CODES,ARCHITECTURESオプションを明示的に指定することで、特定のリリース、アーキテクチャのみビルドすることができます。

squeezeのi386のみビルドしたい場合には以下のコマンドを実行します。:

% make build ARCHITECTURES=i386 CODES=squeeze

buildコマンド以外でも build-package-deb build-repository-debなどのサブタスクでもARCHITECTURES,CODES指定は有効です。

Red Hat系の場合、ARCHITECTURES,DISTRIBUTIONSオプションを明示的に指定することで、特定のリリース、アーキテクチャのみビルドすることができます。

fedoraのi386のみビルドしたい場合には以下のコマンドを実行します。:

% make build ARCHITECTURES=i386 DISTRIBUTIONS=fedora

buildコマンド以外でも build-in-chroot build-repository-rpmなどのサブタスクでもARCHITECTURES,DISTRIBUTIONSの指定は有効です。

centosの場合、CENTOS_VERSIONSを指定することで特定のバージョンのみビルドすることができます。

  パッケージの署名用のパスフレーズを知りたい

パッケージの署名に必要な秘密鍵のパスフレーズについては リリース担当者向けの秘密鍵を復号したテキストの1行目に記載してあります。

  バージョンを明示的に指定してドキュメントを生成したい

リリース後にドキュメントの一部を差し替えたい場合、特に何も指定しないと生成したHTMLに埋め込まれるバージョンが「v3.0.1-xxxxxドキュメント」となってしまうことがあります。gitでのコミット時ハッシュの一部が使われるためです。

これを回避するには、以下のようにDOCUMENT_VERSIONやDOCUMENT_VERSION_FULLを明示的に指定します。:

% make update-document DOCUMENT_VERSION=3.0.1 DOCUMENT_VERSION_FULL=3.0.1

  テスト方法

TODO: Write in English.

TODO: Write about test/command/run-test.sh.

  テスト環境の構築

  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-2016, Brazil, Inc