whombx
null+****@clear*****
Wed Aug 7 21:37:58 JST 2013
whombx 2013-08-07 21:37:58 +0900 (Wed, 07 Aug 2013) New Revision: ec9495d8284ccadac04a412a176442d1ede4ed31 https://github.com/groonga/groonga/commit/ec9495d8284ccadac04a412a176442d1ede4ed31 Merged 5ae3e9e: Merge pull request #75 from whombx/grn-column-create Message: doc: move grn_column_create() and grn_column_index_update() document from groonga.h to Sphinx text Added files: doc/source/reference/api/grn_column.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 21:37:58 +0900 (7685bdb) @@ -347,6 +347,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/rdoc.py \ $(top_srcdir)/doc/source/reference.txt \ $(top_srcdir)/doc/source/reference/api.txt \ + $(top_srcdir)/doc/source/reference/api/grn_column.txt \ $(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 \ @@ -811,6 +812,7 @@ source_files_relative_from_doc_dir = \ source/rdoc.py \ source/reference.txt \ source/reference/api.txt \ + source/reference/api/grn_column.txt \ source/reference/api/grn_ctx.txt \ source/reference/api/grn_db.txt \ source/reference/api/grn_expr.txt \ @@ -1042,6 +1044,7 @@ html_files_relative_from_locale_dir = \ html/_sources/news/senna.txt \ html/_sources/reference.txt \ html/_sources/reference/api.txt \ + html/_sources/reference/api/grn_column.txt \ html/_sources/reference/api/grn_ctx.txt \ html/_sources/reference/api/grn_db.txt \ html/_sources/reference/api/grn_expr.txt \ @@ -1206,6 +1209,7 @@ html_files_relative_from_locale_dir = \ html/objects.inv \ html/reference.html \ html/reference/api.html \ + html/reference/api/grn_column.html \ html/reference/api/grn_ctx.html \ html/reference/api/grn_db.html \ html/reference/api/grn_expr.html \ Added: doc/source/reference/api/grn_column.txt (+60 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/api/grn_column.txt 2013-08-07 21:37:58 +0900 (3095d51) @@ -0,0 +1,60 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grn_column`` +============== + +Summary +------- + +TODO... + +Example +------- + +TODO... + +Reference +--------- + +.. c:function:: grn_obj *grn_column_create(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size, const char *path, grn_obj_flags flags, grn_obj *type) + + tableに新たなカラムを定義します。nameは省略できません。一つのtableに同一のnameのcolumnを複数定義することはできません。 + + :param table: 対象tableを指定します。 + :param name: カラム名を指定します。 + :param name_size: nameパラメータのsize(byte)を指定します。 + :param path: + カラムを格納するファイルパスを指定します。 + flagsに ``GRN_OBJ_PERSISTENT`` が指定されている場合のみ有効です。 + NULLなら自動的にファイルパスが付与されます。 + :param flags: + ``GRN_OBJ_PERSISTENT`` を指定すると永続columnとなります。 + + ``GRN_OBJ_COLUMN_INDEX`` を指定すると転置インデックスとなります。 + + ``GRN_OBJ_COLUMN_SCALAR`` を指定するとスカラ値(単独の値)を格納します。 + + ``GRN_OBJ_COLUMN_VECTOR`` を指定すると値の配列を格納します。 + + ``GRN_OBJ_COMPRESS_ZLIB`` を指定すると値をzlib圧縮して格納します。 + + ``GRN_OBJ_COMPRESS_LZO`` を指定すると値をlzo圧縮して格納します。 + + ``GRN_OBJ_COLUMN_INDEX`` と共に ``GRN_OBJ_WITH_SECTION`` を指定すると、転置索引にsection(段落情報)を合わせて格納します。 + + ``GRN_OBJ_COLUMN_INDEX`` と共に ``GRN_OBJ_WITH_WEIGHT`` を指定すると、転置索引にweight情報を合わせて格納します。 + + ``GRN_OBJ_COLUMN_INDEX`` と共に ``GRN_OBJ_WITH_POSITION`` を指定すると、転置索引に出現位置情報を合わせて格納します。 + :param type: カラム値の型を指定します。定義済みのtypeあるいはtableを指定できます。 + +.. c:function:: grn_rc grn_column_index_update(grn_ctx *ctx, grn_obj *column, grn_id id, unsigned int section, grn_obj *oldvalue, grn_obj *newvalue) + + oldvalue, newvalueの値から得られるキーに対応するcolumnの値の中の、id, sectionに対応するエントリを更新します。columnは ``GRN_OBJ_COLUMN_INDEX`` 型のカラムでなければなりません。 + + :param column: 対象columnを指定します。 + :param id: 対象レコードのIDを指定します。 + :param section: 対象レコードのセクション番号を指定します。 + :param oldvalue: 更新前の値を指定します。 + :param newvalue: 更新後の値を指定します。 Modified: include/groonga.h (+0 -37) =================================================================== --- include/groonga.h 2013-08-07 13:46:53 +0900 (9438149) +++ include/groonga.h 2013-08-07 21:37:58 +0900 (7a54e3d) @@ -1087,31 +1087,6 @@ GRN_API unsigned int grn_table_size(grn_ctx *ctx, grn_obj *table); * column操作のための関数 */ -/** - * grn_column_create: - * @table: 対象table - * @name: カラム名 - * @name_size: @nameのsize(byte) - * @path: カラムを格納するファイルパス。 - * flagsにGRN_OBJ_PERSISTENTが指定されている場合のみ有効。 - * NULLなら自動的にファイルパスが付与される。 - * @flags: GRN_OBJ_PERSISTENTを指定すると永続columnとなる。 - * GRN_OBJ_COLUMN_INDEXを指定すると転置インデックスとなる。 - * GRN_OBJ_COLUMN_SCALARを指定するとスカラ値(単独の値)を格納する。 - * GRN_OBJ_COLUMN_VECTORを指定すると値の配列を格納する。 - * GRN_OBJ_COMPRESS_ZLIBを指定すると値をzlib圧縮して格納する。 - * GRN_OBJ_COMPRESS_LZOを指定すると値をlzo圧縮して格納する。 - * GRN_OBJ_COLUMN_INDEXと共にGRN_OBJ_WITH_SECTIONを指定すると、 - * 転置索引にsection(段落情報)を合わせて格納する。 - * GRN_OBJ_COLUMN_INDEXと共にGRN_OBJ_WITH_WEIGHTを指定すると、 - * 転置索引にweight情報を合わせて格納する。 - * GRN_OBJ_COLUMN_INDEXと共にGRN_OBJ_WITH_POSITIONを指定すると、 - * 転置索引に出現位置情報を合わせて格納する。 - * @type: カラム値の型。定義済みのtypeあるいはtableを指定できる。 - * - * tableに新たなカラムを定義する。nameは省略できない。 - * 一つのtableに同一のnameのcolumnを複数定義することはできない。 - **/ GRN_API grn_obj *grn_column_create(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size, const char *path, grn_obj_flags flags, grn_obj *type); @@ -1120,18 +1095,6 @@ GRN_API grn_obj *grn_column_create(grn_ctx *ctx, grn_obj *table, (((column) = grn_obj_column((ctx), (table), (name), (name_size))) ||\ ((column) = grn_column_create((ctx), (table), (name), (name_size), (path), (flags), (type)))) -/** - * grn_column_index_update - * @column: 対象column - * @id: 対象レコードのID - * @section: 対象レコードのセクション番号 - * @oldvalue: 更新前の値 - * @newvalue: 更新後の値 - * - * oldvalue, newvalueの値から得られるキーに対応するcolumnの値の中の、 - * id, sectionに対応するエントリを更新する。 - * columnはGRN_OBJ_COLUMN_INDEX型のカラムでなければならない。 - **/ 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); -------------- next part -------------- HTML����������������������������...ダウンロード
