rroonga 3.0.7-x86-mingw32 → 3.0.8-x86-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_proc.txt

@@ -0,0 +1,56 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_proc``
+============
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_proc_type
+
+   TODO...
+
+.. c:type:: grn_proc_func
+
+   TODO...
+
+.. c:function:: grn_obj *grn_proc_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_type type, grn_proc_func *init, grn_proc_func *next, grn_proc_func *fin, unsigned int nvars, grn_expr_var *vars)
+
+   nameに対応する新たなproc(手続き)をctxが使用するdbに定義します。
+
+   :param name: 作成するprocの名前を指定します。
+   :param name_size: The number of bytes of name parameter. If negative value is specified, name parameter is assumed that NULL-terminated string.
+   :param type: procの種類を指定します。
+   :param init: 初期化関数のポインタを指定します。
+   :param next: 実処理関数のポインタを指定します。
+   :param fin: 終了関数のポインタを指定します。
+   :param nvars: procで使用する変数の数を指定します。
+   :param vars: procで使用する変数の定義を指定します。( :c:type:`grn_expr_var` 構造体の配列)
+
+.. c:function:: grn_obj *grn_proc_get_info(grn_ctx *ctx, grn_user_data *user_data, grn_expr_var **vars, unsigned int *nvars, grn_obj **caller)
+
+   user_dataをキーとして、現在実行中の :c:type:`grn_proc_func` 関数および定義されている変数( :c:type:`grn_expr_var` )の配列とその数を取得します。
+
+   :param user_data: :c:type:`grn_proc_func` に渡されたuser_dataを指定します。
+   :param nvars: 変数の数を取得します。
+
+.. c:function:: grn_rc grn_obj_set_finalizer(grn_ctx *ctx, grn_obj *obj, grn_proc_func *func)
+
+   objectを破棄するときに呼ばれる関数を設定します。
+
+   table, column, proc, exprのみ設定可能です。
+
+   :param obj: 対象objectを指定します。
+   :param func: objectを破棄するときに呼ばれる関数を指定します。

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_search.txt

@@ -0,0 +1,31 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_search``
+==============
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+ 
+.. c:type:: grn_search_optarg
+
+.. c:function:: grn_rc grn_obj_search(grn_ctx *ctx, grn_obj *obj, grn_obj *query, grn_obj *res, grn_operator op, grn_search_optarg *optarg)
+
+   objを対象としてqueryにマッチするレコードを検索し、opの指定に従ってresにレコードを追加あるいは削除します。
+
+   :param obj: 検索対象のobjectを指定します。
+   :param query: 検索クエリを指定します。
+   :param res: 検索結果を格納するテーブルを指定します。
+   :param op: ``GRN_OP_OR``, ``GRN_OP_AND``, ``GRN_OP_AND_NOT``, ``GRN_OP_ADJUST`` のいずれかを指定します。
+   :param optarg: 詳細検索条件を指定します。

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_table.txt

@@ -0,0 +1,219 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_table``
+=============
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:function:: grn_obj *grn_table_create(grn_ctx *ctx, const char *name, unsigned int name_size, const char *path, grn_obj_flags flags, grn_obj *key_type, grn_obj *value_type)
+
+   nameパラメータに対応する新たなtableをctxが使用するdbに定義します。
+
+   :param name:
+      作成するtableの名前を指定します。NULLなら無名tableとなります。
+
+      persistent dbに対して名前をありのtableを作成するときには、flagsに ``GRN_OBJ_PERSISTENT`` が指定されていなけれなりません。
+   :param path:
+      作成するtableのファイルパスを指定します。
+      flagsに ``GRN_OBJ_PERSISTENT`` が指定されている場合のみ有効です。
+      NULLなら自動的にファイルパスが付与されます。
+   :param flags:
+      ``GRN_OBJ_PERSISTENT`` を指定すると永続tableとなります。
+
+      ``GRN_OBJ_TABLE_PAT_KEY``, ``GRN_OBJ_TABLE_HASH_KEY``, ``GRN_OBJ_TABLE_NO_KEY`` のいずれかを指定します。
+
+      ``GRN_OBJ_KEY_NORMALIZE`` を指定すると正規化された文字列がkeyとなります。
+
+      ``GRN_OBJ_KEY_WITH_SIS`` を指定するとkey文字列の全suffixが自動的に登録されます。
+   :param key_type:
+      keyの型を指定します。``GRN_OBJ_TABLE_NO_KEY`` が指定された場合は無効です。
+      既存のtypeあるいはtableを指定できます。
+
+      key_typeにtable Aを指定してtable Bを作成した場合、Bは必ずAのサブセットとなります。
+   :param value_type:
+      keyに対応する値を格納する領域の型を指定します。
+      tableはcolumnとは別に、keyに対応する値を格納する領域を一つだけ持つことができます。
+
+.. c:function:: grn_id grn_table_add(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size, int *added)
+
+   keyに対応する新しいrecordをtableに追加し、そのIDを返します。keyに対応するrecordがすでにtableに存在するならば、そのrecordのIDを返します。
+
+   ``GRN_OBJ_TABLE_NO_KEY`` が指定されたtableでは、key, key_size は無視されます。
+
+   :param table: 対象tableを指定します。
+   :param key: 検索keyを指定します。
+   :param added: NULL以外の値が指定された場合、新たにrecordが追加された時には1が、既存recordだった時には0がセットされます。
+
+.. c:function:: grn_id grn_table_get(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size)
+
+   It finds a record that has key parameter and returns ID of the found record. If table parameter is a database, it finds an object (table, column and so on) that has key parameter  and returns ID of the found object.
+
+   :param table: The table or database.
+   :param key: The record or object key to be found.
+ 
+.. c:function:: grn_id grn_table_at(grn_ctx *ctx, grn_obj *table, grn_id id)
+
+   tableにidに対応するrecordが存在するか確認し、存在すれば指定されたIDを、存在しなければ ``GRN_ID_NIL`` を返します。
+
+   注意: 実行には相応のコストがかかるのであまり頻繁に呼ばないようにして下さい。
+
+   :param table: 対象tableを指定します。
+   :param id: 検索idを指定します。
+
+.. c:function:: grn_id grn_table_lcp_search(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size)
+
+   tableが ``GRN_TABLE_PAT_KEY`` もしくは ``GRN_TABLE_DAT_KEY`` を指定して作ったtableなら、longest common prefix searchを行い、対応するIDを返します。
+
+   tableが ``GRN_TABLE_HASH_KEY`` を指定して作ったtableなら、完全に一致するキーを検索し、対応するIDを返します。
+
+   :param table: 対象tableを指定します。
+   :param key: 検索keyを指定します。
+
+.. c:function:: int grn_table_get_key(grn_ctx *ctx, grn_obj *table, grn_id id, void *keybuf, int buf_size)
+
+   tableのIDに対応するレコードのkeyを取得します。
+
+   対応するレコードが存在する場合はkey長を返します。見つからない場合は0を返します。対応するキーの検索に成功し、またbuf_sizeの長さがkey長以上であった場合は、keybufに該当するkeyをコピーします。
+
+   :param table: 対象tableを指定します。
+   :param id: 対象レコードのIDを指定します。
+   :param keybuf: keyを格納するバッファ(呼出側で準備する)を指定します。
+   :param buf_size: keybufのサイズ(byte長)を指定します。
+ 
+.. c:function:: grn_rc grn_table_delete(grn_ctx *ctx, grn_obj *table, const void *key, unsigned int key_size)
+
+   tableのkeyに対応するレコードを削除します。対応するレコードが存在しない場合は ``GRN_INVALID_ARGUMENT`` を返します。
+ 
+   :param table: 対象tableを指定します。
+   :param key: 検索keyを指定します。
+   :param key_size: 検索keyのサイズを指定します。
+
+.. c:function:: grn_rc grn_table_delete_by_id(grn_ctx *ctx, grn_obj *table, grn_id id)
+
+   tableのidに対応するレコードを削除します。対応するレコードが存在しない場合は ``GRN_INVALID_ARGUMENT`` を返します。
+
+   :param table: 対象tableを指定します。
+   :param id: レコードIDを指定します。
+
+.. c:function:: grn_rc grn_table_update_by_id(grn_ctx *ctx, grn_obj *table, grn_id id, const void *dest_key, unsigned int dest_key_size)
+
+   tableのidに対応するレコードのkeyを変更します。新しいkeyとそのbyte長をdest_keyとdest_key_sizeに指定します。
+
+   この操作は、``GRN_TABLE_DAT_KEY`` 型のテーブルのみ使用できます。
+
+   :param table: 対象tableを指定します。
+   :param id: レコードIDを指定します。
+
+.. c:function:: grn_rc grn_table_update(grn_ctx *ctx, grn_obj *table, const void *src_key, unsigned int src_key_size, const void *dest_key, unsigned int dest_key_size)
+ 
+   tableのsrc_keyに対応するレコードのkeyを変更します。新しいkeyとそのbyte長をdest_keyとdest_key_sizeに指定します。
+
+   この操作は、``GRN_TABLE_DAT_KEY`` 型のテーブルのみ使用できます。
+
+   :param table: 対象tableを指定します。
+   :param src_key: 対象レコードのkeyを指定します。
+   :param src_key_size: 対象レコードのkeyの長さ(byte)を指定します。
+   :param dest_key: 変更後のkeyを指定します。
+   :param dest_key_size: 変更後のkeyの長さ(byte)を指定します。
+
+.. c:function:: grn_rc grn_table_truncate(grn_ctx *ctx, grn_obj *table)
+
+   tableの全レコードを一括して削除します。
+
+   注意: multithread環境では他のthreadのアクセスによって、存在しないアドレスへアクセスし、SIGSEGVが発生する可能性があります。
+
+   :param table: 対象tableを指定します。
+
+.. c:type:: grn_table_sort_key
+
+   TODO...
+
+.. c:type:: grn_table_sort_flags
+
+   TODO...
+
+.. c:function:: int grn_table_sort(grn_ctx *ctx, grn_obj *table, int offset, int limit, grn_obj *result, grn_table_sort_key *keys, int n_keys)
+
+   table内のレコードをソートし、上位limit個の要素をresultに格納します。
+
+   keys.keyには、tableのcolumn,accessor,procのいずれかが指定できます。keys.flagsには、``GRN_TABLE_SORT_ASC`` / ``GRN_TABLE_SORT_DESC`` のいずれかを指定できます。``GRN_TABLE_SORT_ASC`` では昇順、``GRN_TABLE_SORT_DESC`` では降順でソートされます。keys.offsetは、内部利用のためのメンバです。
+
+   :param table: 対象tableを指定します。
+   :param offset: sortされたレコードのうち、(0ベースで)offset番目から順にresにレコードを格納します。
+   :param limit: resに格納するレコードの上限を指定します。
+   :param result: 結果を格納するtableを指定します。
+   :param keys: ソートキー配列へのポインタを指定します。
+   :param n_keys: ソートキー配列のサイズを指定します。
+ 
+.. c:type:: grn_table_group_result
+
+   TODO...
+
+.. c:type:: grn_table_group_flags
+
+   TODO...
+
+.. c:function:: grn_rc grn_table_group(grn_ctx *ctx, grn_obj *table, grn_table_sort_key *keys, int n_keys, grn_table_group_result *results, int n_results)
+
+   tableのレコードを特定の条件でグループ化します。
+
+   :param table: 対象tableを指定します。
+   :param keys: group化キー構造体の配列へのポインタを指定します。
+   :param n_keys: group化キー構造体の配列のサイズを指定します。
+   :param results: group化の結果を格納する構造体の配列へのポインタを指定します。
+   :param n_results: group化の結果を格納する構造体の配列のサイズを指定します。
+
+.. c:function:: grn_rc grn_table_setoperation(grn_ctx *ctx, grn_obj *table1, grn_obj *table2, grn_obj *res, grn_operator op)
+
+   table1とtable2をopの指定に従って集合演算した結果をresに格納します。
+
+   resにtable1あるいはtable2そのものを指定した場合を除けば、table1, table2は破壊されません。
+
+   :param table1: 対象table1を指定します。
+   :param table2: 対象table2を指定します。
+   :param res: 結果を格納するtableを指定します。
+   :param op: 実行する演算の種類を指定します。
+
+.. c:function:: grn_rc grn_table_difference(grn_ctx *ctx, grn_obj *table1, grn_obj *table2, grn_obj *res1, grn_obj *res2)
+
+   table1とtable2から重複するレコードを取り除いた結果をそれぞれres1, res2に格納します。
+
+   :param table1: 対象table1を指定します。
+   :param table2: 対象table2を指定します。
+   :param res1: 結果を格納するtableを指定します。
+   :param res2: 結果を格納するtableを指定します。
+
+.. c:function:: int grn_table_columns(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size, grn_obj *res)
+ 
+   nameパラメータから始まるtableのカラムIDをresパラメータに格納します。name_sizeパラメータが0の場合はすべてのカラムIDを格納します。
+
+   :param table: 対象tableを指定します。
+   :param name: 取得したいカラム名のprefixを指定します。
+   :param name_size: nameパラメータの長さを指定します。
+   :param res: 結果を格納する ``GRN_TABLE_HASH_KEY`` のtableを指定します。
+   :return: 格納したカラムIDの数を返します。
+
+.. c:function:: unsigned int grn_table_size(grn_ctx *ctx, grn_obj *table)
+
+   tableに登録されているレコードの件数を返します。
+
+   :param table: 対象tableを指定します。
+
+.. c:function:: grn_rc grn_table_rename(grn_ctx *ctx, grn_obj *table, const char *name, unsigned int name_size)
+
+   ctxが使用するdbにおいてtableに対応する名前をnameに更新します。tableの全てのcolumnも同時に名前が変更されます。tableは永続オブジェクトでなければいけません。
+
+   :param name_size: nameパラメータのsize(byte)を指定します。

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_table_cursor.txt

@@ -0,0 +1,109 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_table_cursor``
+====================
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_table_cursor
+
+   TODO...
+
+.. c:function:: grn_table_cursor *grn_table_cursor_open(grn_ctx *ctx, grn_obj *table, const void *min, unsigned int min_size, const void *max, unsigned int max_size, int offset, int limit, int flags)
+
+   tableに登録されているレコードを順番に取り出すためのカーソルを生成して返します。
+
+   :param table: 対象tableを指定します。
+   :param min: keyの下限を指定します。（NULLは下限なしと見なします。） ``GRN_CURSOR_PREFIX`` については後述。
+   :param min_size: minのsizeを指定します。``GRN_CURSOR_PREFIX`` については後述。
+   :param max: keyの上限を指定します。（NULLは上限なしと見なします。） ``GRN_CURSOR_PREFIX`` については後述。
+   :param max_size: maxのsizeを指定します。``GRN_CURSOR_PREFIX`` については無視される場合があります。
+   :param flags:
+      ``GRN_CURSOR_ASCENDING`` を指定すると昇順にレコードを取り出します。
+
+      ``GRN_CURSOR_DESCENDING`` を指定すると降順にレコードを取り出します。(下記 ``GRN_CURSOR_PREFIX`` を指定し、keyが近いレコードを取得する場合、もしくは、common prefix searchを行う場合には、``GRN_CURSOR_ASCENDING`` / ``GRN_CURSOR_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`` は無視されます。) ``GRN_OBJ_TABLE_PAT_KEY`` を指定したtableについては、``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の場合には、keyがminと前方一致するレコードを取り出します。max_sizeパラメータは無視されます。
+
+      maxとmax_sizeが指定され、かつ、テーブルのkeyがShortText型である場合、maxとcommon prefix searchを行い、common prefixがmin_sizeバイト以上のレコードを取り出します。minは無視されます。
+
+      maxとmax_sizeが指定され、かつ、テーブルのkeyが固定長型の場合、maxとPAT木上で近い位置にあるノードから順番にレコードを取り出します。ただし、keyのパトリシア木で、min_sizeバイト未満のビットに対するノードで、maxと異なった方向にあるノードに対応するレコードについては取り出しません。PAT木上で位置が近いこととkeyの値が近いことは同一ではありません。この場合、maxで与えられるポインタが指す値は、対象テーブルのkeyサイズと同じか超える幅である必要があります。minは無視されます。
+
+      ``GRN_CURSOR_BY_ID`` / ``GRN_CURSOR_BY_KEY`` / ``GRN_CURSOR_PREFIX`` の3フラグは、同時に指定することができません。
+
+      ``GRN_OBJ_TABLE_PAT_KEY`` を指定して作ったテーブルで、``GRN_CURSOR_PREFIX`` と ``GRN_CURSOR_RK`` を指定すると、半角小文字のアルファベット文字列から、それを旧JIS X 4063:2000規格に従って全角カタカナに変換した文字列に前方一致する値をkeyとするレコードを取り出します。``GRN_ENC_UTF8`` のみをサポートしています。``GRN_CURSOR_ASCENDING`` / ``GRN_CURSOR_DESCENDING`` は無効であり、レコードをkey値の昇降順で取り出すことはできません。
+  
+   :param offset:
+      該当する範囲のレコードのうち、(0ベースで)offset番目からレコードを取り出します。
+
+      ``GRN_CURSOR_PREFIX`` を指定したときは負の数を指定することはできません。
+
+   :param limit:
+      該当する範囲のレコードのうち、limit件のみを取り出します。-1が指定された場合は、全件が指定されたものとみなします。
+
+      ``GRN_CURSOR_PREFIX`` を指定したときは-1より小さい負の数を指定することはできません。
+
+.. c:function:: grn_rc grn_table_cursor_close(grn_ctx *ctx, grn_table_cursor *tc)
+
+   :c:func:`grn_table_cursor_open` で生成したcursorを解放します。
+
+   :param tc: 対象cursorを指定します。
+
+.. c:function:: grn_id grn_table_cursor_next(grn_ctx *ctx, grn_table_cursor *tc)
+
+   cursorのカレントレコードを一件進めてそのIDを返します。cursorの対象範囲の末尾に達すると ``GRN_ID_NIL`` を返します。
+
+   :param tc: 対象cursorを指定します。
+
+.. c:function:: int grn_table_cursor_get_key(grn_ctx *ctx, grn_table_cursor *tc, void **key)
+
+   cursorのカレントレコードのkeyをkeyパラメータにセットし、その長さを返します。
+
+   :param tc: 対象cursorを指定します。
+   :param key: カレントレコードのkeyへのポインタがセットされます。
+
+.. c:function:: int grn_table_cursor_get_value(grn_ctx *ctx, grn_table_cursor *tc, void **value)
+
+   cursorパラメータのカレントレコードのvalueをvalueパラメータにセットし、その長さを返します。
+
+   :param tc: 対象cursorを指定します。
+   :param value: カレントレコードのvalueへのポインタがセットされます。
+
+.. c:function:: grn_rc grn_table_cursor_set_value(grn_ctx *ctx, grn_table_cursor *tc, const void *value, int flags)
+
+   cursorのカレントレコードのvalueを引数の内容に置き換えます。cursorのカレントレコードが存在しない場合は ``GRN_INVALID_ARGUMENT`` を返します。
+
+   :param tc: 対象cursorを指定します。
+   :param value: 新しいvalueの値を指定します。
+   :param flags: :c:func:`grn_obj_set_value()` のflagsと同様の値を指定できます。
+
+.. c:function:: grn_rc grn_table_cursor_delete(grn_ctx *ctx, grn_table_cursor *tc)
+
+   cursorのカレントレコードを削除します。cursorのカレントレコードが存在しない場合は ``GRN_INVALID_ARGUMENT`` を返します。
+
+   :param tc: 対象cursorを指定します。
+
+.. c:function:: grn_obj *grn_table_cursor_table(grn_ctx *ctx, grn_table_cursor *tc)
+
+   cursorが属するtableを返します。
+
+   :param tc: 対象cursorを指定します。

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_type.txt

@@ -0,0 +1,31 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_type``
+============
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_builtin_type
+
+   TODO...
+
+.. c:function:: grn_obj *grn_type_create(grn_ctx *ctx, const char *name, unsigned int name_size, grn_obj_flags flags, unsigned int size)
+
+   nameに対応する新たなtype（型）をdbに定義します。
+
+   :param name: 作成するtypeの名前を指定します。
+   :param flags: ``GRN_OBJ_KEY_VAR_SIZE``, ``GRN_OBJ_KEY_FLOAT``, ``GRN_OBJ_KEY_INT``, ``GRN_OBJ_KEY_UINT`` のいずれかを指定します。
+   :param size: ``GRN_OBJ_KEY_VAR_SIZE`` の場合は最大長、それ以外の場合は長さ（単位:byte）を指定します。