whombx
null+****@clear*****
Sat Aug 10 08:11:53 JST 2013
whombx 2013-08-10 08:11:53 +0900 (Sat, 10 Aug 2013) New Revision: b53406a7dbfbcf2d2622cad0c6138d49a88d2cd3 https://github.com/groonga/groonga/commit/b53406a7dbfbcf2d2622cad0c6138d49a88d2cd3 Merged 587f55a: Merge branch 'grn-column-table' of https://github.com/whombx/groonga into whombx-grn-column-table Message: doc: move grn_column_table(), grn_column_rename(), grn_column_name() and grn_column_index() documents from groonga.h to Sphinx text Modified files: doc/source/reference/api/grn_column.txt include/groonga.h Modified: doc/source/reference/api/grn_column.txt (+32 -0) =================================================================== --- doc/source/reference/api/grn_column.txt 2013-08-08 13:34:50 +0900 (3095d51) +++ doc/source/reference/api/grn_column.txt 2013-08-10 08:11:53 +0900 (bac1fa5) @@ -58,3 +58,35 @@ Reference :param section: 対象レコードのセクション番号を指定します。 :param oldvalue: 更新前の値を指定します。 :param newvalue: 更新後の値を指定します。 + +.. c:function:: grn_obj *grn_column_table(grn_ctx *ctx, grn_obj *column) + + columnが属するtableを返します。 + + :param column: 対象columnを指定します。 + +.. c:function:: grn_rc grn_column_rename(grn_ctx *ctx, grn_obj *column, const char *name, unsigned int name_size) + + ctxが使用するdbにおいてcolumnに対応する名前をnameに更新します。columnは永続オブジェクトでなければいけません。 + + :param column: 対象columnを指定します。 + :param name: 新しい名前を指定します。 + :param name_size: nameパラメータのsize（byte）を指定します。 + +.. c:function:: int grn_column_name(grn_ctx *ctx, grn_obj *obj, char *namebuf, int buf_size) + + カラムobjの名前の長さを返します。buf_sizeの長さが名前の長さ以上であった場合は、namebufに該当する名前をコピーします。 + + :param obj: 対象objectを指定します。 + :param namebuf: 名前を格納するバッファ（呼出側で準備する）を指定します。 + :param buf_size: namebufのサイズ（byte長）を指定します。 + +.. c:function:: 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に返します。 + + :param column: 対象のcolumnを指定します。 + :param op: indexで実行したい操作を指定します。 + :param indexbuf: indexを格納するバッファ（呼出側で準備する）を指定します。 + :param buf_size: indexbufのサイズ（byte長）を指定します。 + :param section: section番号を格納するint長バッファ（呼出側で準備する）を指定します。 Modified: include/groonga.h (+0 -38) =================================================================== --- include/groonga.h 2013-08-08 13:34:50 +0900 (fbe1f4f) +++ include/groonga.h 2013-08-10 08:11:53 +0900 (8d20770) @@ -989,13 +989,6 @@ GRN_API grn_obj *grn_column_create(grn_ctx *ctx, grn_obj *table, GRN_API grn_rc grn_column_index_update(grn_ctx *ctx, grn_obj *column, grn_id id, unsigned int section, grn_obj *oldvalue, grn_obj *newvalue); - -/** - * grn_column_table: - * @column: 対象column - * - * columnが属するtableを返す。 - **/ GRN_API grn_obj *grn_column_table(grn_ctx *ctx, grn_obj *column); /*------------------------------------------------------------- @@ -1198,15 +1191,6 @@ GRN_API grn_rc grn_obj_rename(grn_ctx *ctx, grn_obj *obj, GRN_API grn_rc grn_table_rename(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size); -/** - * grn_column_rename: - * @column: 対象column - * @name: 新しい名前 - * @name_size: @nameのsize(byte) - * - * ctxが使用するdbにおいてcolumnに対応する名前をnameに更新する。 - * columnは永続オブジェクトでなければならない。 - **/ GRN_API grn_rc grn_column_rename(grn_ctx *ctx, grn_obj *column, const char *name, unsigned int name_size); @@ -1277,16 +1261,6 @@ GRN_API const char *grn_obj_path(grn_ctx *ctx, grn_obj *obj); **/ GRN_API int grn_obj_name(grn_ctx *ctx, grn_obj *obj, char *namebuf, int buf_size); -/** - * grn_column_name: - * @obj: 対象object - * @namebuf: 名前を格納するバッファ(呼出側で準備する) - * @buf_size: namebufのサイズ(byte長) - * - * カラムobjの名前の長さを返す。 - * buf_sizeの長さが名前の長以上であった場合は、 - * namebufに該当する名前をコピーする。 - **/ GRN_API int grn_column_name(grn_ctx *ctx, grn_obj *obj, char *namebuf, int buf_size); /** @@ -1485,21 +1459,9 @@ GRN_API grn_rc grn_obj_delete_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry en GRN_API grn_obj *grn_obj_open(grn_ctx *ctx, unsigned char type, grn_obj_flags flags, grn_id domain); -/** - * grn_column_index: - * @column: 対象のcolumn - * @op: indexで実行したい操作 - * @indexbuf: indexを格納するバッファ(呼出側で準備する) - * @buf_size: namebufのサイズ(byte長) - * @section: section番号を格納するint長バッファ(呼出側で準備する) - * - * columnに張られているindexのうち、opの操作を実行可能なものの数を返す。 - * またそれらのidを、buf_sizeに指定された個数を上限としてindexbufに返す。 - **/ GRN_API int grn_column_index(grn_ctx *ctx, grn_obj *column, grn_operator op, grn_obj **indexbuf, int buf_size, int *section); - /** * grn_obj_delete_by_id: * @db: The target database. -------------- next part -------------- HTML����������������������������...Download