null+****@clear*****
null+****@clear*****
2010年 8月 5日 (木) 09:55:22 JST
Daijiro MORI 2010-08-05 00:55:22 +0000 (Thu, 05 Aug 2010)
New Revision: 77bae620f22160274048511b0a07c03ad6783e5a
Log:
Updated documents.
Modified files:
doc/ja/source/commands/delete.txt
doc/ja/source/commands/load.txt
doc/ja/source/commands/select.txt
doc/ja/source/commands_not_implemented/add.txt
doc/ja/source/commands_not_implemented/get.txt
doc/ja/source/commands_not_implemented/set.txt
doc/ja/source/developer/query.txt
doc/ja/source/expr.txt
doc/ja/source/functions/geo_distance.txt
doc/ja/source/functions/geo_in_circle.txt
doc/ja/source/functions/geo_in_rectangle.txt
doc/ja/source/functions/now.txt
doc/ja/source/functions/rand.txt
doc/ja/source/http.txt
Modified: doc/ja/source/commands/delete.txt (+0 -1)
===================================================================
--- doc/ja/source/commands/delete.txt 2010-08-04 13:56:58 +0000 (61eaf8e)
+++ doc/ja/source/commands/delete.txt 2010-08-05 00:55:22 +0000 (0c11ca3)
@@ -64,4 +64,3 @@ json形式
:doc:`load`
-.. [#] tsv,xml出力はv1.0でサポートされます。また、処理開始時間・処理時間については正確でない場合があります。
Modified: doc/ja/source/commands/load.txt (+1 -1)
===================================================================
--- doc/ja/source/commands/load.txt 2010-08-04 13:56:58 +0000 (cca357a)
+++ doc/ja/source/commands/load.txt 2010-08-05 00:55:22 +0000 (290ef4c)
@@ -54,7 +54,7 @@ loadは、使用しているデータベースのテーブルにレコードを
``ifexists``
- 指定した主キーに対応するレコードが既にテーブルに登録済みであった場合に実行するscript形式のgrn式文字列を指定します。ifexistsにgrn式が指定された場合は、式の値が真である場合に限り、その他のカラムの値が更新されます。(デフォルトはtrue)
+ 指定した主キーに対応するレコードが既にテーブルに登録済みであった場合に実行するscript形式のgrn_expr文字列を指定します。ifexistsにgrn_exprが指定された場合は、式の値が真である場合に限り、その他のカラムの値が更新されます。(デフォルトはtrue)
``input_type``
Modified: doc/ja/source/commands/select.txt (+54 -4)
===================================================================
--- doc/ja/source/commands/select.txt 2010-08-04 13:56:58 +0000 (bea8536)
+++ doc/ja/source/commands/select.txt 2010-08-05 00:55:22 +0000 (c189b77)
@@ -48,17 +48,67 @@ selectは、使用しているデータベースのテーブルの中から条
``query``
- 検索条件をquery形式のgrn式文字列によって指定します。
+ 以下の形式の文字列によって検索条件を指定します。
+
+条件式
+^^^^^^
+
+以下の条件式が使用できます。
+
+文字列
+ 全文検索条件(デフォルト検索対象カラムの値が指定された文字列を含んでいる)
+
+\"文字列\"
+ フレーズ検索条件(デフォルト検索対象カラムの値が指定されたフレーズを含んでいる)
+
+カラム名:値
+ 一致条件(カラム値 == 値)
+
+カラム名:!値
+ 不一致条件(カラム値 != 値)
+
+カラム名:<値
+ 比較条件(カラム値 < 値)
+
+カラム名:>値
+ 比較条件(カラム値 > 値)
+
+カラム名:<=値
+ 比較条件(カラム値 <= 値)
+
+カラム名:>=値
+ 比較条件(カラム値 >= 値)
+
+カラム名:@文字列
+ 全文検索条件(カラム値が指定された文字列を含んでいる)
+
+結合演算子
+^^^^^^^^^^
+
+複数の条件式を結合するために以下の演算子が使用できます。
+
+a OR b
+ 論理和(aとbといずれかの条件がマッチする)
+
+a + b
+ 論理積(aとbの両方がマッチする)
+
+a - b
+ aにマッチし、bにはマッチしない
+
+( )
+ 複数の条件をまとめる
+
``filter``
- 絞り込み条件をscript形式のgrn式文字列によって指定します。
+ 絞り込み条件をscript形式のgrn_expr文字列によって指定します。
query引数とfilter引数をどちらも指定した場合は、両方の条件を満足するレコードのみがヒットします。どちらも指定しない場合は全件がヒットします。
``scorer``
- 検索条件にマッチする全てのレコードに対して適用するgrn式をscript形式で指定します。
+ 検索条件にマッチする全てのレコードに対して適用するgrn_exprをscript形式で指定します。
scorerは、検索処理が完了し、ソート処理が実行される前に呼び出されます。従って、各レコードのスコアを操作する式を指定しておけば、検索結果のソート順序をカスタマイズできるようになります。
@@ -76,7 +126,7 @@ selectは、使用しているデータベースのテーブルの中から条
出力するカラム名のリストをカンマ(',')区切りで指定します。
- アスタリスク('*')を指定すると、全てのカラムが指定されたものとみなされます。または、script形式のgrn式文字列を指定します。 (デフォルトは、'_id \*')
+ アスタリスク('*')を指定すると、全てのカラムが指定されたものとみなされます。または、script形式のgrn_expr文字列を指定します。 (デフォルトは、'_id \*')
``offset``
Modified: doc/ja/source/commands_not_implemented/add.txt (+0 -3)
===================================================================
--- doc/ja/source/commands_not_implemented/add.txt 2010-08-04 13:56:58 +0000 (7931978)
+++ doc/ja/source/commands_not_implemented/add.txt 2010-08-05 00:55:22 +0000 (9b639d1)
@@ -104,6 +104,3 @@ addは、使用しているデータベースのテーブルに１件のレコ
:doc:`load`
-.. rubric:: 脚注
-
-.. [#] tsv,xml出力はv1.0でサポートされます。また、処理開始時間・処理時間については正確でない場合があります。
Modified: doc/ja/source/commands_not_implemented/get.txt (+1 -9)
===================================================================
--- doc/ja/source/commands_not_implemented/get.txt 2010-08-04 13:56:58 +0000 (4d13490)
+++ doc/ja/source/commands_not_implemented/get.txt 2010-08-05 00:55:22 +0000 (e6657b9)
@@ -34,16 +34,12 @@ getは、使用しているデータベースのテーブルの中の１件の
``output_columns``
- 出力するカラム名のリストをカンマ(',')区切りで指定します。 [#]_
+ 出力するカラム名のリストをカンマ(',')区切りで指定します。
``output_type``
出力形式を、json,tsv,xmlのいずれかで指定します。
-``id``
-
- レコードIDによってレコードを指定します。idパラメータを指定する場合は、keyパラメータを指定してはいけません。 [#]_
-
返値
---
@@ -84,7 +80,3 @@ getは、使用しているデータベースのテーブルの中の１件の
--------
:doc:`load`
-
-.. [#] output_columnsでのgrn式指定はv1.0でサポートされます。
-.. [#] idパラメータはv1.0でサポートされます。
-.. [#] tsv,xml出力はv1.0でサポートされます。また、処理開始時間・処理時間については正確でない場合があります。
Modified: doc/ja/source/commands_not_implemented/set.txt (+0 -2)
===================================================================
--- doc/ja/source/commands_not_implemented/set.txt 2010-08-04 13:56:58 +0000 (60d5b6e)
+++ doc/ja/source/commands_not_implemented/set.txt 2010-08-05 00:55:22 +0000 (c8bb102)
@@ -105,5 +105,3 @@ setは、使用しているデータベースのテーブルの中の１件の
--------
:doc:`load`
-
-.. [#] tsv,xml出力はv1.0でサポートされます。また、処理開始時間・処理時間については正確でない場合があります。
Modified: doc/ja/source/developer/query.txt (+5 -5)
===================================================================
--- doc/ja/source/developer/query.txt 2010-08-04 13:56:58 +0000 (5433bf9)
+++ doc/ja/source/developer/query.txt 2010-08-05 00:55:22 +0000 (206d85e)
@@ -3,7 +3,7 @@
クエリの実現
============
-groongaのデータストアには大量のデータを格納し、その中から必要な部分を高速に取り出すことができます。必要な部分をgroongaのデータストアに問い合わせるためのクエリの表現と実行に関して、groongaは複数の手段を用意しています。
+groongaのデータベースには大量のデータを格納し、その中から必要な部分を高速に取り出すことができます。必要な部分をgroongaのデータベースに問い合わせるためのクエリの表現と実行に関して、groongaは複数の手段を用意しています。
クエリ実行のためのインタフェース
--------------------------------
@@ -15,17 +15,17 @@ groongaは低機能で単純なライブラリインタフェースから、高
DB_API
^^^^^^
-DB_APIは、groongaデータストアを操作するための一群のC言語向けAPI関数を提供します。DB_APIはデータストアを構成する個々の部分に対する単純な操作関数を提供します。DB_APIの機能を組み合わせることによって複雑なクエリを実行することができます。後述のすべてのクエリインタフェースはDB_APIの機能を組み合わせることによって実現されています。
+DB_APIは、groongaデータベースを操作するための一群のC言語向けAPI関数を提供します。DB_APIはデータベースを構成する個々の部分に対する単純な操作関数を提供します。DB_APIの機能を組み合わせることによって複雑なクエリを実行することができます。後述のすべてのクエリインタフェースはDB_APIの機能を組み合わせることによって実現されています。
grn_expr
^^^^^^^^
-grn_exprは、groongaデータストアに対する検索処理や更新処理のための条件を表現するためのデータ構造で、複数の条件を再帰的に組み合わせてより複雑な条件を表現することができます。grn_exprによって表現されたクエリを実行するためには、grn_table_select()関数を使用します。
+grn_exprは、groongaデータベースに対する検索処理や更新処理のための条件を表現するためのデータ構造で、複数の条件を再帰的に組み合わせてより複雑な条件を表現することができます。grn_exprによって表現されたクエリを実行するためには、grn_table_select()関数を使用します。
groonga実行ファイル
^^^^^^^^^^^^^^^^^^^
-groongaデータストアを操作するためのコマンドインタープリタです。渡されたコマンドを解釈し、実行結果を返します。コマンドの実処理はC言語で記述されます。ユーザがC言語で定義した関数を新たなコマンドとしてgroonga実行ファイルに組み込むことができます。各コマンドはいくつかの文字列引数を受け取り、これをクエリとして解釈して実行します。引数をgrn_exprとして解釈するか、別の形式として解釈してDB_APIを使ってデータストアを操作するかはコマンド毎に自由に決めることができます。
+groongaデータベースを操作するためのコマンドインタープリタです。渡されたコマンドを解釈し、実行結果を返します。コマンドの実処理はC言語で記述されます。ユーザがC言語で定義した関数を新たなコマンドとしてgroonga実行ファイルに組み込むことができます。各コマンドはいくつかの文字列引数を受け取り、これをクエリとして解釈して実行します。引数をgrn_exprとして解釈するか、別の形式として解釈してDB_APIを使ってデータベースを操作するかはコマンド毎に自由に決めることができます。
grn_exprで表現できるクエリ
--------------------------
@@ -64,7 +64,7 @@ grn_table_select()関数は、grn_exprで表現された検索クエリを実行
GRN_OP_ORは、検索対象テーブルの中からクエリにマッチするレコードを検索結果テーブルに加えます。GRN_OP_OR以外の演算子は、検索結果テーブルが空でない場合にだけ意味を持ちます。GRN_OP_ANDは、検索結果テーブルの中からクエリにマッチしないレコードを取り除きます。GRN_OP_BUTは、検索結果テーブルの中からクエリにマッチするレコードを取り除きます。GRN_OP_ADJUSTは、検索結果テーブルの中でクエリにマッチするレコードに対してスコア値の更新のみを行います。
-grn_table_select()は、データストア上にデータ構造を組み合わせて可能な限り高速に指定されたクエリを実行しようとします。
+grn_table_select()は、データベース上に定義されたテーブルや索引などを組み合わせて可能な限り高速に指定されたクエリを実行しようとします。
関係式
------
Modified: doc/ja/source/expr.txt (+7 -162)
===================================================================
--- doc/ja/source/expr.txt 2010-08-04 13:56:58 +0000 (fc7ed68)
+++ doc/ja/source/expr.txt 2010-08-05 00:55:22 +0000 (46a9244)
@@ -1,187 +1,36 @@
.. highlightlang:: none
-grn式 (grn_expr)
-================
+grn_expr
+========
名前
----
-grn式 - 検索条件やデータベースへの操作を表現する文字列の形式。(読み方:"ぐるんしき")
+grn_expr - 検索条件やデータベースへの操作を表現するデータ構造(読み方:"ぐるんしき")
説明
----
-grn式は、検索条件やデータベースへの操作を表現するために使用される文字列の形式です。
+grn_exprは、検索条件やデータベースへの操作を表現するために使用されるデータ構造の形式です。
-selectやloadなどのいくつかの組込コマンドや、API関数grn_table_select()などで使用されます。grn式はquery形式とscript形式という2種類の方式で記述することができます。query形式は、多くのweb検索エンジンなどで検索フォームにユーザが指定可能なクエリ文字列の書式に合わせた形式です。script形式は、ECMAScriptの構文から式(expression)以下の構文要素を抜粋した形式になっており、文(statement)や制御構造などは表現できません。
-
-query形式のgrn式もscript形式のgrn式も、共通の中間形式に翻訳された上で処理されますので、処理速度や効率には差違はありません。記述できる処理の範囲はscript形式の方がquery形式より広くなっています。たとえば更新系の操作はscript形式のみで記述できます。
-
-DB-APIレイヤでは、異なる形式で記述された複数のgrn式を結合することも可能です。
+データベースの中から特定の条件を満たすレコードを取り出すために、様々な条件をand,or,notなどの演算子で結合して自由に表現することができます。grn_exprは、一連のAPI関数を呼ぶことによって組み立てることができます。特定の文字列形式には依存していません。組み込みコマンドselectのqueryパラメータでは、検索エンジンのユーザがフォームで入力する文字列を直接受け取ることを想定して、文字列からgrn_exprを生成しています。また、多くの組み込みコマンドで共通に使用するために、ECMAScript形式の文字列からgrn_exprを生成するAPI関数grn_expr_parse()を用意しています。grn_expr_parseでパースできる文字列を特にscript形式grn_expr文字列と呼びます。
例
--
-query形式でcolumn1の値が'hoge'に等しいという条件
-
- column1:hoge
-
script形式でcolumn1の値が'hoge'に等しいという条件
column1 == "hoge"
-query形式
----------
-
-条件式
-^^^^^^
-
-以下の条件式が使用できます。
-
-文字列
- 全文検索条件(デフォルト検索対象カラムの値が指定された文字列を含んでいる)
-
-\"文字列\"
- フレーズ検索条件(デフォルト検索対象カラムの値が指定されたフレーズを含んでいる)
-
-カラム名:値
- 一致条件(カラム値 == 値)
-
-カラム名:!値
- 不一致条件(カラム値 != 値)
-
-カラム名:<値
- 比較条件(カラム値 < 値)
-
-カラム名:>値
- 比較条件(カラム値 > 値)
-
-カラム名:<=値
- 比較条件(カラム値 <= 値)
-
-カラム名:>=値
- 比較条件(カラム値 >= 値)
-
-カラム名:@文字列
- 全文検索条件(カラム値が指定された文字列を含んでいる)
-
-カラム名:^文字列
- 前方一致条件(カラム値が指定された文字列に前方一致する)
-
-カラム名:$文字列
- 後方一致条件(カラム値が指定された文字列に後方一致する)
-
-補助演算子
-^^^^^^^^^^
-
-全文検索条件の挙動を制御する以下の演算子が指定できます。[#]_
-
-~文字列
- 文字列を含んでいた場合は、そのレコードのスコアを下げます。
-
-<文字列
- 文字列を含んでいた場合に加算されるスコアの値を小さくします。
-
->文字列
- 文字列を含んでいた場合に加算されるスコアの値を大きくします。
-
-文字列*
- 文字列に前方一致する条件を示します。
-
-\*S[数値]\"文字列\"
- 文字列と関連する文書を検索します。文字列から抽出する特徴語の数を数値に指定します。
-
-\*N[数値]\"文字列\"
- 文字列に含まれる複数の語が、近傍に含まれる文書を検索します。近傍の範囲の上限となる語数を数値に指定します。N-gramの場合は、文字数を指定します。
-
-結合演算子
-^^^^^^^^^^
-
-複数の条件式を結合するために以下の演算子が使用できる。演算子を伴わずに複数の条件式が空白(' ')区切りで指定された場合は、デフォルトの結合演算子が指定されたものとみなされる。
-
-a OR b
- 論理和(aとbといずれかの条件がマッチする)
-
-a + b
- 論理積(aとbの両方がマッチする)
-
-a - b
- aにマッチし、bにはマッチしない
-
-( )
- 複数の条件をまとめる
-
-プラグマ
-^^^^^^^^
-
-query形式文字列の先頭に、処理方法を指定するプラグマを埋め込むことができます。[#]_
-
-プラグマは必ずクエリ文字列の冒頭に存在しなければなりません。(先頭に空白を入れてはいけません)
-
-一つのクエリに複数のプラグマを指定することができます。
-
-複数のプラグマを指定する場合は、間に空白を入れてはいけません。
-
-\*E数値1[,数値2]
-
- 検索結果の数が数値1よりも小さい場合、完全一致→非わかち書き→部分一致の順に自動的に検索処理方法を切り替えます。完全一致でヒットした文書と比べて非わかち書き一致、部分一致でヒットした文書には数値2分だけ小さいスコアを付与します。数値2を省略した場合は既定値(=2)と解釈されます。数値1に負の数を指定した場合は以下のように処理します。
-
- -1
- 完全一致検索のみを行う
-
- -2
- 非わかち書き検索のみを行う
-
- -3
- 完全一致検索と非わかち書き検索のみを行う
-
- -4
- 部分一致検索のみを行う
-
- -5
- 完全一致検索と部分一致検索のみを行う
-
- -6
- 非わかち書き検索と部分一致検索のみを行う
-
- -7
- 完全一致検索,非わかち書き検索,部分一致検索の全てを行う
-
- 例:
-
- \*E10,3
-
- 検索結果数が10件以下だった場合に検索処理方法を順次切り替え、スコアを3ずつ小さくします。
-
-\*D演算子
-
- 結合演算子の既定値(演算子を省略した場合にどの演算を行うか)を指定します。指定できる演算子は、OR, +, - のいずれかです。
-
- 例1:
-
- \*D+ abc def
-
- abcとdefを両方含む文書を検索します。
-
- 例2:
-
- \*DOR abc def
-
- abcとdefのいずれかを含む文書を検索します。
-
-\*W[数値[:重み][,数値[:重み]]...
-
- 数値で指定されたセクション番号のみを対象に検索します。セクションごとに検索スコアの倍数を指定することができます。重みは、省略された場合1となります。負の重みも指定することができます。
-
script形式
----------
-ECMAScript風の構文で検索条件やレコードへの操作を記述します。[#]_
+ECMAScript風の構文で検索条件やレコードへの操作を記述します。
式中のIDENTIFIER(識別子)は、以下のいずれかを指します。
:引数名:
- grn式が受け取る引数の名前
+ grn_exprが受け取る引数の名前
:カラム名:
操作対象としているレコードのカラム名
@@ -190,7 +39,3 @@ ECMAScript風の構文で検索条件やレコードへの操作を記述しま
データベースに定義された型・テーブル・関数の名前
.. rubric:: 脚注
-
-.. [#] 補助演算子はv1.0でサポートされます。
-.. [#] プラグマはv1.0でサポートされます。
-.. [#] script形式のgrn式はv1.0でサポートされます。
Modified: doc/ja/source/functions/geo_distance.txt (+1 -1)
===================================================================
--- doc/ja/source/functions/geo_distance.txt 2010-08-04 13:56:58 +0000 (bc90847)
+++ doc/ja/source/functions/geo_distance.txt 2010-08-05 00:55:22 +0000 (a160f29)
@@ -17,7 +17,7 @@ geo_distance - 指定した2点の距離を計算する
説明
----
-groonga組込関数の一つであるgeo_distanceについて説明します。組込関数は、script形式のgrn式中で呼び出すことができます。
+groonga組込関数の一つであるgeo_distanceについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。
geo_distance() 関数は、point1に指定した座標とpoint2に指定した座標の間の距離(近似値)を求めます。
geo_distance()の他に、距離計算アルゴリズムの異なる、geo_distance2()、geo_distance3()が使用できます。それぞれ、長方形近似、球面近似、ヒュベニの距離計算式によって距離を算出します。
Modified: doc/ja/source/functions/geo_in_circle.txt (+1 -1)
===================================================================
--- doc/ja/source/functions/geo_in_circle.txt 2010-08-04 13:56:58 +0000 (9685357)
+++ doc/ja/source/functions/geo_in_circle.txt 2010-08-05 00:55:22 +0000 (53b0c8c)
@@ -17,7 +17,7 @@ geo_in_circle - 座標が円の範囲内に存在するかどうかを調べま
説明
----
-groonga組込関数の一つであるgeo_in_circleについて説明します。組込関数は、script形式のgrn式中で呼び出すことができます。
+groonga組込関数の一つであるgeo_in_circleについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。
geo_in_circle() 関数は、pointに指定した座標が、centerに指定した座標を中心とする円の範囲内にあるかどうかを調べます。
Modified: doc/ja/source/functions/geo_in_rectangle.txt (+1 -1)
===================================================================
--- doc/ja/source/functions/geo_in_rectangle.txt 2010-08-04 13:56:58 +0000 (e97ad23)
+++ doc/ja/source/functions/geo_in_rectangle.txt 2010-08-05 00:55:22 +0000 (1ce7777)
@@ -17,7 +17,7 @@ geo_in_rectangle - 座標が矩形の範囲内に存在するかどうかを調
説明
----
-groonga組込関数の一つであるgeo_in_rectangleについて説明します。組込関数は、script形式のgrn式中で呼び出すことができます。
+groonga組込関数の一つであるgeo_in_rectangleについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。
geo_in_rectangle() 関数は、pointに指定した座標が、top_leftとbottom_rightがなす矩形の範囲内にあるかどうかを調べます。
Modified: doc/ja/source/functions/now.txt (+1 -1)
===================================================================
--- doc/ja/source/functions/now.txt 2010-08-04 13:56:58 +0000 (1c633c0)
+++ doc/ja/source/functions/now.txt 2010-08-05 00:55:22 +0000 (12bde37)
@@ -17,7 +17,7 @@ now - 現在時刻を返す
説明
----
-groonga組込関数の一つであるnowについて説明します。組込関数は、script形式のgrn式中で呼び出すことができます。
+groonga組込関数の一つであるnowについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。
now() 関数は現在時刻に対応するTime型の値を返します。
Modified: doc/ja/source/functions/rand.txt (+1 -1)
===================================================================
--- doc/ja/source/functions/rand.txt 2010-08-04 13:56:58 +0000 (38e2b57)
+++ doc/ja/source/functions/rand.txt 2010-08-05 00:55:22 +0000 (0055ae9)
@@ -17,7 +17,7 @@ rand - 乱数を生成する
説明
----
-groonga組込関数の一つであるrandについて説明します。組込関数は、script形式のgrn式中で呼び出すことができます。
+groonga組込関数の一つであるrandについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。
rand() 関数は 0 から max の間の疑似乱数整数を返します。
Modified: doc/ja/source/http.txt (+2 -7)
===================================================================
--- doc/ja/source/http.txt 2010-08-04 13:56:58 +0000 (3286f9b)
+++ doc/ja/source/http.txt 2010-08-05 00:55:22 +0000 (c5d9035)
@@ -38,16 +38,11 @@ httpでgroongaサーバと通信する際には、以下のような形式でコ
ただし、コマンド名、引数名、値はURLエンコードが必要です。
-output_typeにはjson, tsv, xmlが指定可能です。 [#]_
+output_typeにはjson, tsv, xmlが指定可能です。
-GETメソッドおよびPOSTメソッドが使用可能です。 [#]_
+GETメソッドのみが使用可能です。
返値
----
output_typeの指定に従って、コマンドの実行結果を出力します。
-
-.. rubric:: 脚注
-
-.. [#] xml, tsv出力はv1.0でサポートされます。
-.. [#] POSTメソッドはv1.0でサポートされます。