rroonga 0.9.5-x86-mingw32 → 1.0.1-x86-mingw32

data/vendor/local/share/groonga/doc/ja/html/_sources/developer/test.txt

@@ -0,0 +1,114 @@
+.. highlightlang:: none
+
+テスト方法
+===========
+
+テスト環境の構築
+----------------
+
+Cutterのインストール
+^^^^^^^^^^^^^^^^^^^^
+
+groongaは、テストのフレームワークとして Cutter_ を用いています。
+
+Cutterのインストール方法は プラットフォーム毎のCutterのインストール方法_ をご覧下さい。
+
+.. _Cutter: http://cutter.sourceforge.net/
+.. _プラットフォーム毎のCutterのインストール方法: http://cutter.sourceforge.net/reference/ja/install.html
+
+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は１度のみ実行する必要があります。

data/vendor/local/share/groonga/doc/ja/html/_sources/execfile.txt

@@ -0,0 +1,226 @@
+.. highlightlang:: none
+
+groonga実行ファイル
+===================
+
+名前
+----
+
+groonga - 列指向データベース機能を持つ全文検索エンジンソフトウェア
+
+書式
+----
+
+::
+
+ groonga [options] [dest] [command [args]]
+
+説明
+----
+
+groongaは列指向のデータベース機能を持つ高速でスケーラブルな全文検索エンジンです。
+groongaのデータベースは、groonga実行ファイルかCライブラリインタフェースを通して操作することができます。このマニュアルページでは、groonga実行ファイルの使い方について説明します。
+
+オプション
+----------
+
+.. cmdoption:: -n
+
+   新たなデータベースを作成します。
+
+.. cmdoption:: -c
+
+   クライアントモードで実行します。
+
+.. cmdoption:: -s
+
+   サーバモードで実行します。
+
+.. cmdoption:: -d
+
+   デーモンモードで実行します。(forkする点がサーバモードと異なる)
+
+.. cmdoption:: -e, --encoding <encoding>
+
+   データベースで使用する文字エンコーディング方式を指定します。新たなデータベースを作成する時のみ有効です。none, euc, utf8, sjis, latin, koi8rのいずれかが指定できます。
+
+.. cmdoption:: -l, --log-level <log level>
+
+   ログレベルを指定します。0〜8までの数値が指定可能で、数が大きいほど多くのログが出力されます。
+
+.. cmdoption:: -a, --address <ip/hostname>
+
+   サーバモードかデーモンモードで実行するとき、listenするアドレスを指定します。(デフォルトは`hostname`の返すホスト名)
+
+.. cmdoption:: -p, --port <port number>
+
+   クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。
+   (デフォルトは10041番)
+
+.. cmdoption:: -i, --server-id <ip/hostname>
+
+   サーバモードかデーモンモードで実行するとき、サーバのIDとなるアドレスを指定します。(デフォルトは`hostname`の返すホスト名)
+
+.. cmdoption:: -h, --help
+
+   ヘルプメッセージを出力します。
+
+.. cmdoption:: --document-root <path>
+
+   httpサーバとしてgroongaを使用する場合に静的ページを格納するディレクトリを指定します。
+
+   デフォルトでは、データベースを管理するための汎用的なページに対応するファイルが/usr/share/groonga/admin_html以下にインストールされます。このディレクトリをdocument-rootオプションの値に指定して起動した場合、ウェブブラウザでhttp://hostname:port/index.htmlにアクセスすると、ウェブベースのデータベース管理ツールを使用できます。
+
+.. cmdoption:: --protocol <protocol>
+
+   http,gqtpのいずれかを指定します。(デフォルトはgqtp)
+
+.. cmdoption:: --log-path <path>
+
+   ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)
+
+.. cmdoption:: --query-log-path <path>
+
+   クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)
+
+.. cmdoption:: -t, --max-threads <max threasd>
+
+   最大で利用するスレッド数を指定します。(デフォルトはマシンのCPUコア数と同じ数です)
+
+.. cmdoption:: --pid-path <path>
+
+   PIDを保存するパスを指定します。(デフォルトでは保存しません)
+
+.. cmdoption:: --config-path <path>
+
+   設定ファイルのパスを指定します。設定ファイルは以下のようなフォーマットになります。::
+
+     # '#'以降はコメント。
+     ; ';'以降もコメント。
+
+     # 'キー = 値'でオプションを指定。
+     pid-file = /var/run/groonga.pid
+
+     # '='の前後の空白はは無視される。↓は↑と同じ意味。
+     pid-file=/var/run/groonga.pid
+
+     # 'キー'は'--XXX'スタイルのオプション名と同じものが使える。
+     # 例えば、'--pid-path'に対応するキーは'pid-path'。
+     # ただし、キーが'config-path'のオプションは無視される。
+
+.. cmdoption:: --cache-limit <limit>
+
+   キャッシュ数の最大値を指定します。(デフォルトは100です)
+
+引数
+----
+
+.. cmdoption:: dest
+
+   使用するデータベースのパス名を指定します。
+
+   クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は'localhost:10041')。ポート番号を指定しない場合には、10041が指定されたものとします。
+
+.. cmdoption:: command [args]
+
+   スタンドアロンおよびクライアントモードの場合は、実行するコマンドとその引数をコマンドライン引数に指定できます。コマンドライン引数にcommandを与えなかった場合は、標準入力から一行ずつEOFに達するまでコマンド文字列を読み取り、順次実行します。
+
+コマンド
+--------
+
+groonga実行ファイルを通してデータベースを操作する命令をコマンドと呼びます。コマンドは主にC言語で記述され、groongaプロセスにロードすることによって使用できるようになります。
+それぞれのコマンドは一意な名前と、0個以上の引数を持ちます。
+
+引数は以下の2種類の方法のいずれかで指定することができます。::
+
+ 形式1: コマンド名 値1 値2,..
+
+ 形式2: コマンド名 --引数名1 値1 --引数名2 値2,..
+
+形式1でコマンドを実行する場合は、定義された順番で値を指定しなければならず、途中の引数の値を省略することはできません。形式2でコマンドを実行する場合は、「--引数名」のように引数の名前を明示しなければならない代わりに、任意の順番で引数を指定することが可能で、途中の引数の指定を省略することもできます。
+
+標準入力からコマンド文字列を与える場合は、コマンド名と引数名と値は、空白( )で区切ります。空白や、記号「"'()\」のうちいずれかを含む値を指定したい場合は、シングルクォート(')かダブルクォート(")で値を囲みます。値として指定する文字列の中では、改行文字は'\n'に置き換えて指定します。また、引用符に使用した文字を値の中で指定する場合には、その文字の前にバックスラッシュ('\') を指定します。バックスラッシュ文字自身を値として指定する場合には、その前にバックスラッシュを指定します。
+
+組み込みコマンド
+----------------
+
+以下のコマンドは組み込みコマンドとして予め定義されています。
+
+ ``status``
+   groongaプロセスの状態を表示します。
+
+ ``table_list``
+   DBに定義されているテーブルのリストを表示します。
+
+ ``column_list``
+   テーブルに定義されているカラムのリストを表示します。
+
+ ``table_create``
+   DBにテーブルを追加します。
+
+ ``column_create``
+   テーブルにカラムを追加します。
+
+ ``table_remove``
+   DBに定義されているテーブルを削除します。
+
+ ``column_remove``
+   テーブルに定義されているカラムを削除します。
+
+ ``view_add``
+   VIEW型のテーブルに要素となるテーブルを定義します。
+
+ ``load``
+   テーブルにレコードを挿入します。
+
+ ``select``
+   テーブルに含まれるレコードを検索して表示します。
+
+ ``define_selector``
+   検索条件をカスタマイズした新たな検索コマンドを定義します。
+
+ ``quit``
+   データベースとのセッションを終了します。
+
+ ``shutdown``
+   サーバ(デーモン)プロセスを停止します。
+
+ ``log_level``
+   ログ出力レベルを設定します。
+
+ ``log_put``
+   ログ出力を行います。
+
+ ``clearlock``
+   ロックを解除します。
+
+
+例
+--
+
+新しいデータベースを作成します。::
+
+   % groonga -n /tmp/hoge.db quit
+   %
+
+作成済みのデータベースにテーブルを定義します。::
+
+   % groonga /tmp/hoge.db table_create Table 0 ShortText
+   [[0]]
+   %
+
+サーバを起動します。::
+
+   % groonga -d /tmp/hoge.db
+   %
+
+httpサーバとして起動します。::
+
+   % groonga -d -p 80 --protocol http --document-root /usr/share/groonga/admin_html /tmp/hoge.db
+   %
+
+サーバに接続し、テーブル一覧を表示します。::
+
+   % groonga -c localhost table_list
+   [[0],[["id","name","path","flags","domain"],[256,"Table","/tmp/hoge.db.0000100",49152,14]]]
+   %

data/vendor/local/share/groonga/doc/ja/html/_sources/expr.txt

@@ -0,0 +1,43 @@
+.. highlightlang:: none
+
+grn_expr
+========
+
+名前
+----
+
+grn_expr - 検索条件やデータベースへの操作を表現するデータ構造(読み方:"ぐるんしき")
+
+説明
+----
+
+grn_exprは、検索条件やデータベースへの操作を表現するために使用されるデータ構造の形式です。
+
+データベースの中から特定の条件を満たすレコードを取り出すために、様々な条件をand,or,notなどの演算子で結合して自由に表現することができます。grn_exprは、一連のAPI関数を呼ぶことによって組み立てることができます。特定の文字列形式には依存していません。組み込みコマンドselectのqueryパラメータでは、検索エンジンのユーザがフォームで入力する文字列を直接受け取ることを想定して、文字列からgrn_exprを生成しています。また、多くの組み込みコマンドで共通に使用するために、ECMAScript形式の文字列からgrn_exprを生成するAPI関数grn_expr_parse()を用意しています。grn_expr_parseでパースできる文字列を特にscript形式のgrn_exprと呼びます。
+
+grn_exprを使うことによって非常に柔軟に検索条件を記述することができます。類似文書検索や近傍検索のような高度な検索もすべてgrn_exprによって記述できます。また、全文検索クエリにおいて、特定の文字列を含むレコードのスコアを細かく制御したり、検索結果数の多寡に応じてより検索漏れの少ないアルゴリズムで再検索するような機能も、grn_exprとgrn_table_select()API関数を組み合わせることによって自由に定義できます。
+
+script形式のgrn_expr
+--------------------
+
+ECMAScript風の構文で検索条件やレコードへの操作を記述します。
+
+式中のIDENTIFIER(識別子)は、以下のいずれかを指します。
+
+:引数名:
+  grn_exprが受け取る引数の名前
+
+:カラム名:
+  操作対象としているレコードのカラム名
+
+:型名・関数名・テーブル名:
+  データベースに定義された型・テーブル・関数の名前
+
+例
+--
+
+script形式でcolumn1の値が'hoge'に等しいという条件
+
+  column1 == "hoge"
+
+.. rubric:: 脚注

data/vendor/local/share/groonga/doc/ja/html/_sources/functions.txt

@@ -0,0 +1,10 @@
+.. highlightlang:: none
+
+組み込み関数一覧
+================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   functions/*

data/vendor/local/share/groonga/doc/ja/html/_sources/functions/edit_distance.txt

@@ -0,0 +1,48 @@
+.. highlightlang:: none
+
+.. _edit_distance:
+
+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

data/vendor/local/share/groonga/doc/ja/html/_sources/functions/geo_distance.txt

@@ -0,0 +1,51 @@
+.. highlightlang:: none
+
+geo_distance
+============
+
+名前
+----
+
+geo_distance - 指定した2点の距離を計算する
+
+書式
+----
+::
+
+ geo_distance(point1, point2)
+
+説明
+----
+
+groonga組込関数の一つであるgeo_distanceについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。
+
+geo_distance() 関数は、point1に指定した座標とpoint2に指定した座標の間の距離(近似値)を求めます。
+geo_distance()の他に、距離計算アルゴリズムの異なる、geo_distance2()、geo_distance3()が使用できます。それぞれ、長方形近似、球面近似、ヒュベニの距離計算式によって距離を算出します。
+
+引数
+----
+
+``point1``
+
+  距離を求める2点のうち一つを指定します。GeoPoint型の値を指定できます。 [#]_
+
+``point2``
+
+  距離を求める2点のうちもう一つを指定します。GeoPoint型の値、あるいは座標を示す文字列を指定できます。
+
+
+返値
+----
+
+指定した2点の距離をFloat型の値(単位:メートル)として返します。
+
+例
+--
+::
+
+ geo_distance(pos, "150x150")
+ 100
+
+.. rubric:: 脚注
+
+.. [#] TokyoGeoPoint(日本測地系座標)かWGS84GeoPoint(世界測地系座標)のいずれかを指定できます。