whombx
null+****@clear*****
Fri Aug 9 23:56:54 JST 2013
whombx 2013-08-09 23:56:54 +0900 (Fri, 09 Aug 2013) New Revision: 69807d630819b750185580fc0185e5d4bc98cabc https://github.com/groonga/groonga/commit/69807d630819b750185580fc0185e5d4bc98cabc Merged c0fd188: Merge branch 'grn-obj-id' of https://github.com/whombx/groonga into whombx-grn-obj-id Message: doc: move grn_obj_id(), grn_obj_delete_by_id() and grn_obj_path_by_id() documents from groonga.h to Sphinx text Modified files: doc/source/reference/api/grn_obj.txt include/groonga.h Modified: doc/source/reference/api/grn_obj.txt (+23 -0) =================================================================== --- doc/source/reference/api/grn_obj.txt 2013-08-09 23:39:17 +0900 (202a731) +++ doc/source/reference/api/grn_obj.txt 2013-08-09 23:56:54 +0900 (eeb9239) @@ -133,3 +133,26 @@ Reference :param obj: 対象objectを指定します。 :param name: 新しい名前を指定します。 :param name_size: nameパラメータのsize（byte）を指定します。 + +.. c:function:: grn_id grn_obj_id(grn_ctx *ctx, grn_obj *obj) + + objのidを返します。 + + :param obj: 対象objectを指定します。 + +.. c:function:: grn_rc grn_obj_delete_by_id(grn_ctx *ctx, grn_obj *db, grn_id id, grn_bool removep) + + dbからidに対応するテーブルやカラムなどを削除します。mroonga向けに用意した内部APIです。 + + :param db: The target database. + :param id: The object (table, column and so on) ID to be deleted. + :param removep: If ``GRN_TRUE``, clear object cache and remove relation between ID and key in database. Otherwise, just clear object cache. + +.. c:function:: grn_rc grn_obj_path_by_id(grn_ctx *ctx, grn_obj *db, grn_id id, char *buffer) + + dbのidに対応するpathを返します。mroonga向けに用意した内部APIです。 + + :param db: The target database. + :param id: The object (table, column and so on) ID to be deleted. + :param buffer: path string corresponding to the id will be set in this buffer. + Modified: include/groonga.h (+0 -26) =================================================================== --- include/groonga.h 2013-08-09 23:39:17 +0900 (d99e79d) +++ include/groonga.h 2013-08-09 23:56:54 +0900 (ad6f0ef) @@ -1014,15 +1014,8 @@ GRN_API int grn_obj_defrag(grn_ctx *ctx, grn_obj *obj, int threshold); **/ GRN_API grn_obj *grn_obj_db(grn_ctx *ctx, grn_obj *obj); -/** - * grn_obj_id: - * @obj: 対象object - * - * objのidを返す。 - **/ GRN_API grn_id grn_obj_id(grn_ctx *ctx, grn_obj *obj); - /** * grn_obj_search: * @obj: 検索対象のobject @@ -1146,26 +1139,7 @@ GRN_API grn_obj *grn_obj_open(grn_ctx *ctx, unsigned char type, grn_obj_flags fl 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. - * @id: The object (table, column and so on) ID to be deleted. - * @removep: If GRN_TRUE, clear object cache and remove relation - * between ID and key in database. Otherwise, just clear object cache. - * - * dbからidに対応するテーブルやカラムなどを削除します。mroonga向けに用意した内部APIです。 - **/ GRN_API grn_rc grn_obj_delete_by_id(grn_ctx *ctx, grn_obj *db, grn_id id, grn_bool removep); - -/** - * grn_obj_path_by_id: - * @db: The target database. - * @id: The object (table, column and so on) ID to be deleted. - * @buffer: path string corresponding to the id will be set in this buffer. - * - * dbのidに対応するpathを返します。mroonga向けに用意した内部APIです。 - **/ GRN_API grn_rc grn_obj_path_by_id(grn_ctx *ctx, grn_obj *db, grn_id id, char *buffer); /* geo */ -------------- next part -------------- HTML����������������������������...Download