null+****@clear*****
null+****@clear*****
2010年 8月 3日 (火) 17:56:41 JST
Tasuku SUENAGA a.k.a. gunyarakun 2010-08-03 08:56:41 +0000 (Tue, 03 Aug 2010)
New Revision: 6ebb4c519036b292710337c0e1f7be43596c89e0
Log:
Changed API document for GRN_CURSOR_PREFIX flag.
Modified files:
groonga.h
Modified: groonga.h (+17 -6)
===================================================================
--- groonga.h 2010-08-03 08:28:33 +0000 (84d7177)
+++ groonga.h 2010-08-03 08:56:41 +0000 (a9a65dc)
@@ -674,19 +674,23 @@ typedef grn_obj grn_table_cursor;
* @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/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は無視される)
@@ -694,15 +698,20 @@ typedef grn_obj grn_table_cursor;
* 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の場合には、minとkeyが前方一致するレコードを取り出す。
- * maxが指定され、かつ、テーブルのkeyがShortText型である場合、
+ *
+ * maxがNULLの場合には、keyがminと前方一致するレコードを取り出す。
+ * max_sizeパラメータは無視される。
+ *
+ * maxとmax_sizeが指定され、かつ、テーブルのkeyがShortText型である場合、
* maxとcommon prefix searchを行い、
* common prefixがmin_sizeバイト以上のレコードを取り出す。
- * この場合、minパラメータは無視される。
- * maxが指定され、かつ、テーブルのkeyが固定長型の場合、
+ * minは無視される。
+ *
+ * maxとmax_sizeが指定され、かつ、テーブルのkeyが固定長型の場合、
* maxと値が近い順番にレコードを取り出す。
* ただし、keyのパトリシア木で、min_sizeバイト未満のビットに対する
* ノードで、maxと異なった方向にあるノードに対応するレコードについては
@@ -712,10 +721,12 @@ typedef grn_obj grn_table_cursor;
* 数値型では、数値が近いものほど近いものとする)
* この場合、maxで与えられるポインタが指す値は、
* 対象テーブルのkeyサイズと同じか超える幅である必要がある。
- * minとmax_sizeは無視される。
+ * minは無視される。
+ *
* GRN_CURSOR_BY_ID/GRN_CURSOR_BY_KEY/GRN_CURSOR_PREFIXの3フラグは、
* 同時に指定することができない。
- * @offset: 該当する範囲のレコードのうち、(0ベースで)offset番目からレコードを取り出す。
+ * @offset: 該当する範囲のレコードのうち、
+ (0ベースで)offset番目からレコードを取り出す。
* @limit: 該当する範囲のレコードのうち、limit件のみを取り出す。
* -1が指定された場合は、全件が指定されたものとみなす。
*