whombx
null+****@clear*****
Wed Aug 7 20:10:12 JST 2013
whombx 2013-08-07 20:10:12 +0900 (Wed, 07 Aug 2013) New Revision: e604c059f66daba58a48dabbfe46e94ec95d87bd https://github.com/groonga/groonga/commit/e604c059f66daba58a48dabbfe46e94ec95d87bd Merged 1ae7a8d: Merge pull request #72 from whombx/grn-index-cursor Message: doc: move grn_index_cursor_open/next document from groonga.h to Sphinx text Added files: doc/source/reference/api/grn_index_cursor.txt Modified files: doc/files.am include/groonga.h Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2013-08-07 13:46:53 +0900 (593766e) +++ doc/files.am 2013-08-07 20:10:12 +0900 (4ab13ca) @@ -350,6 +350,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/api/grn_ctx.txt \ $(top_srcdir)/doc/source/reference/api/grn_db.txt \ $(top_srcdir)/doc/source/reference/api/grn_expr.txt \ + $(top_srcdir)/doc/source/reference/api/grn_index_cursor.txt \ $(top_srcdir)/doc/source/reference/api/grn_table_cursor.txt \ $(top_srcdir)/doc/source/reference/cast.txt \ $(top_srcdir)/doc/source/reference/command.txt \ @@ -814,6 +815,7 @@ source_files_relative_from_doc_dir = \ source/reference/api/grn_ctx.txt \ source/reference/api/grn_db.txt \ source/reference/api/grn_expr.txt \ + source/reference/api/grn_index_cursor.txt \ source/reference/api/grn_table_cursor.txt \ source/reference/cast.txt \ source/reference/command.txt \ @@ -1045,6 +1047,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/api/grn_ctx.txt \ html/_sources/reference/api/grn_db.txt \ html/_sources/reference/api/grn_expr.txt \ + html/_sources/reference/api/grn_index_cursor.txt \ html/_sources/reference/api/grn_table_cursor.txt \ html/_sources/reference/cast.txt \ html/_sources/reference/command.txt \ @@ -1209,6 +1212,7 @@ html_files_relative_from_locale_dir = \ html/reference/api/grn_ctx.html \ html/reference/api/grn_db.html \ html/reference/api/grn_expr.html \ + html/reference/api/grn_index_cursor.html \ html/reference/api/grn_table_cursor.html \ html/reference/cast.html \ html/reference/command.html \ Added: doc/source/reference/api/grn_index_cursor.txt (+44 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/api/grn_index_cursor.txt 2013-08-07 20:10:12 +0900 (c94f368) @@ -0,0 +1,44 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grn_index_cursor`` +==================== + +Summary +------- + +TODO... + +Example +------- + +TODO... + +Reference +--------- + +.. c:function:: 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) + + :c:type:`grn_table_cursor` から取得できるそれぞれのレコードについて、 ``GRN_OBJ_COLUMN_INDEX`` 型のカラムの値を順番に取り出すためのカーソルを生成して返します。 + + rid_min, rid_maxを指定して取得するレコードidの値を制限することができます。 + + 戻り値であるgrn_index_cursorは :c:func:`grn_obj_close()` を使って解放します。 + + :param tc: 対象cursorを指定します。 + :param index: 対象インデックスカラムを指定します。 + :param rid_min: 出力するレコードidの下限を指定します。 + :param rid_max: 出力するレコードidの上限を指定します。 + +.. c:function:: grn_posting *grn_index_cursor_next(grn_ctx *ctx, grn_obj *ic, grn_id *tid) + + cursorの範囲内のインデックスの値を順番に取り出します。 + + tidにNULL以外を指定した場合は、index_cursorを作成するときに指定したtable_cursorの現在の対象レコードのidを返します。 + + 戻り値である :c:type:`grn_posting` 構造体は解放する必要はありません。 + + :param ic: 対象cursorを指定します。 + :param tid: テーブルレコードIDを指定します。 + Modified: include/groonga.h (+0 -23) =================================================================== --- include/groonga.h 2013-08-07 13:46:53 +0900 (9438149) +++ include/groonga.h 2013-08-07 20:10:12 +0900 (a80e706) @@ -815,31 +815,8 @@ typedef struct { unsigned int rest; } grn_posting; -/** - * grn_index_cursor_open - * @tc: 対象cursor - * @index: 対象インデックスカラム - * @rid_min: 出力するレコードidの下限 - * @rid_max: 出力するレコードidの上限 - * - * grn_table_cursorから取得できるそれぞれのレコードについて、 - * GRN_OBJ_COLUMN_INDEX型のカラムの値を順番に取り出すためのカーソルを生成して返す。 - * rid_min,rid_maxを指定して取得するレコードidの値を制限することができる。 - * 戻り値であるgrn_index_cursorはgrn_obj_closeを使って解放する。 - **/ GRN_API 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_index_cursor_next - * @ic: 対象cursor - * @tid: テーブルレコードID - * - * cursorの範囲内のインデックスの値を順番に取り出す。 - * tidにNULL以外を指定した場合は、 - * index_cursorを作成するときに指定したtable_cursorの現在の対象レコードのidを返す。 - * 戻り値であるgrn_posting構造体は解放する必要はない。 - **/ GRN_API grn_posting *grn_index_cursor_next(grn_ctx *ctx, grn_obj *ic, grn_id *tid); #define GRN_TABLE_EACH(ctx,table,head,tail,id,key,key_size,value,block) do {\ -------------- next part -------------- HTML����������������������������...下載
