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

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/api/grn_cache.txt

@@ -0,0 +1,114 @@
+.. -*- rst -*-
+
+.. highlightlang:: c
+
+``grn_cache``
+=============
+
+Summary
+-------
+
+.. note::
+
+   This API is experimental.
+
+``grn_cache`` is a data store that keeps responses of
+:doc:`/reference/commands/select` command. It is not general use cache
+object. It is only for :doc:`/reference/commands/select` command.
+
+You can just change the current cache object by
+:c:func:`grn_cache_current_set()`. :doc:`/reference/commands/select`
+command response cache is done internally.
+
+:doc:`/reference/commands/select` command uses one global cache
+object. If you open multiple databases, the one cache is shared. It is
+an important problem.
+
+If you open multiple databases and use
+:doc:`/reference/commands/select` command, you need to use
+``grn_cache`` object. It is :doc:`/reference/executables/groonga-httpd`
+case. If you open only one database or don't use
+:doc:`/reference/commands/select` command, you don't need to use
+``grn_cache`` object. It is `rroonga
+<http://ranguba.org/#about-rroonga>`_ case.
+
+Example
+-------
+
+Here is an example that change the current cache object.
+
+.. code-block:: c
+
+   grn_cache *cache;
+   grn_cache *cache_previous;
+   cache = grn_cache_open(ctx);
+   cache_previous = grn_cache_current_get(ctx);
+   grn_cache_current_set(ctx, cache);
+   /* grn_ctx_send(ctx, ...); */
+   grn_cache_current_set(ctx, cache_previous);
+
+
+Reference
+---------
+
+.. c:type:: grn_cache
+
+   It is an opaque cache object. You can create a ``grn_cache`` by
+   :c:func:`grn_cache_open()` and free the created object by
+   :c:func:`grn_cache_close()`.
+
+.. c:function:: grn_cache *grn_cache_open(grn_ctx *ctx)
+
+   Creates a new cache object.
+
+   If memory allocation for the new cache object is failed, ``NULL``
+   is returned. Error information is stored into the ``ctx``.
+
+   :param ctx: The context.
+   :return: A newly allocated cache object on success, ``NULL``
+            otherwise. The returned cache object must be freed by
+            :c:func:`grn_cache_close()`.
+
+.. c:function:: grn_rc grn_cache_close(grn_ctx *ctx, grn_cache *cache)
+
+   Frees resourses of the ``cache``.
+
+   :param ctx: The context.
+   :param cache: The cache object to be freed.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` otherwise.
+
+.. c:function:: grn_rc grn_cache_current_set(grn_ctx *ctx, grn_cache *cache)
+
+   Sets the cache object that is used in
+   :doc:`/reference/commands/select` command.
+
+   :param ctx: The context.
+   :param cache: The cache object that is used in
+                 :doc:`/reference/commands/select` command.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` otherwise.
+
+.. c:function:: grn_cache *grn_cache_current_get(grn_ctx *ctx)
+
+   Gets the cache object that is used in
+   :doc:`/reference/commands/select` command.
+
+   :param ctx: The context.
+   :return: The cache object that is used in
+            :doc:`/reference/commands/select` command. It may be ``NULL``.
+
+.. c:function:: grn_rc grn_cache_set_max_n_entries(grn_ctx *ctx, grn_cache *cache, unsigned int n)
+
+   Sets the max number of entries of the cache object.
+
+   :param ctx: The context.
+   :param cache: The cache object to be changed.
+   :param n: The new max number of entries of the cache object.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` otherwise.
+
+.. c:function:: unsigned int grn_cache_get_max_n_entries(grn_ctx *ctx, grn_cache *cache)
+
+   Gets the max number of entries of the cache object.
+
+   :param ctx: The context.
+   :param cache: The target cache object.
+   :return: The max number of entries of the cache object.

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/api/grn_column.txt

@@ -0,0 +1,92 @@
+.. -*- 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: 更新後の値を指定します。
+
+.. 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長バッファ（呼出側で準備する）を指定します。

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/api/grn_command_version.txt

@@ -0,0 +1,37 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_command_version``
+=======================
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_command_version
+
+.. c:macro:: GRN_COMMAND_VERSION_MIN
+
+.. c:macro:: GRN_COMMAND_VERSION_STABLE
+
+.. c:macro:: GRN_COMMAND_VERSION_MAX
+
+.. c:function:: grn_command_version grn_get_default_command_version(void)
+
+   デフォルトのcommand_versionを返します。
+
+.. c:function:: grn_rc grn_set_default_command_version(grn_command_version version)
+
+   デフォルトのcommand_versionを変更します。
+
+   :param version: 変更後のデフォルトのcommand_versionを指定します。

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/api/grn_ctx.txt

@@ -47,3 +47,73 @@ Reference
    :param ctx: 初期化するctx構造体へのポインタを指定します。
    :param flags: 初期化する ``ctx`` のオプションを指定します。
    :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_rc grn_ctx_fin(grn_ctx *ctx)
+
+   ctxの管理するメモリを解放し、使用を終了します。
+
+   If ``ctx`` is initialized by :c:func:`grn_ctx_open()` not :c:func:`grn_ctx_init()`. You need also to call :c:func:`grn_ctx_close()`.
+
+   :param ctx: 解放するctx構造体へのポインタを指定します。
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_ctx *grn_ctx_open(int flags)
+
+   初期化された :c:type:`grn_ctx` オブジェクトを返します。
+
+   :c:func:`grn_ctx_init()` で初期化された :c:type:`grn_ctx` オブジェクトは構造体の実体をAPIの呼び元で確保するのに対して、 :c:func:`grn_ctx_open()` ではgroongaライブラリの内部で、実体を確保します。
+   どちらで初期化された :c:type:`grn_ctx` も、 :c:func:`grn_ctx_fin()` で解放できます。
+   :c:func:`grn_ctx_open()` で確保した :c:type:`grn_ctx` 構造体に関しては、:c:func:`grn_ctx_fin()` で解放した後に、その :c:type:`grn_ctx` で作成した :c:type:`grn_obj` を :c:func:`grn_obj_close()` によって解放しても問題ありません。
+
+   :param flags: 初期化する ``ctx`` のオプションを指定します。
+   :return: 初期化された :c:type:`grn_ctx` オブジェクトを返します。
+
+.. c:function:: grn_rc grn_ctx_close(grn_ctx *ctx)
+
+   It calls :c:func:`grn_ctx_fin()` and frees allocated memory for ``ctx`` by :c:func:`grn_ctx_open()`.
+
+   :param ctx: no longer needed :c:type:`grn_ctx`.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_rc grn_ctx_set_finalizer(grn_ctx *ctx, grn_proc_func *func)
+
+   ctxを破棄するときに呼ばれる関数を設定します。
+
+   :param ctx: 対象ctxを指定します。
+   :param func: ``ctx`` を破棄するときに呼ばれる関数を指定します。
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_command_version grn_ctx_get_command_version(grn_ctx *ctx)
+
+   command_versionを返します。
+
+.. c:function:: grn_rc grn_ctx_set_command_version(grn_ctx *ctx, grn_command_version version)
+
+   command_versionを変更します。
+
+   :param version: 変更後のcommand_versionを指定します。
+
+.. c:function:: grn_rc grn_ctx_use(grn_ctx *ctx, grn_obj *db)
+
+   ctxが操作対象とするdbを指定します。NULLを指定した場合は、dbを操作しない状態(init直後の状態)になります。
+
+   Don't use it with :c:type:`grn_ctx` that has ``GRN_CTX_PER_DB`` flag.
+
+   :param db: ctxが使用するdbを指定します。
+
+.. c:function:: grn_obj *grn_ctx_db(grn_ctx *ctx)
+
+   ctxが現在操作対象としているdbを返します。dbを使用していない場合はNULLを返します。
+
+.. c:function:: grn_obj *grn_ctx_get(grn_ctx *ctx, const char *name, int name_size)
+
+   ctxが使用するdbからnameに対応するオブジェクトを検索して返す。nameに一致するオブジェクトが存在しなければNULLを返す。
+
+   :param name: 検索しようとするオブジェクトの名前。
+   :param name_size: The number of bytes of name. If negative value is specified, name is assumed that NULL-terminated string.
+
+.. c:function:: grn_obj *grn_ctx_at(grn_ctx *ctx, grn_id id)
+
+   ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。idに一致するオブジェクトが存在しなければNULLを返す。
+
+   :param id: 検索しようとするオブジェクトのidを指定します。

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/api/grn_db.txt

@@ -0,0 +1,71 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_db``
+==========
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+TODO...
+
+.. c:type:: grn_db
+
+   TODO...
+
+.. c:type:: grn_db_create_optarg
+
+   It is used for specifying options for :c:func:`grn_db_create`.
+
+.. c:member:: char **grn_db_create_optarg.builtin_type_names
+
+   組み込み型の名前となるnul終端文字列の配列を指定する。
+
+.. c:member:: int grn_db_create_optarg.n_builtin_type_names
+
+   n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を
+   指定する。配列のoffsetはenum型grn_builtin_typeの値に対応する。
+
+.. c:function:: grn_obj *grn_db_create(grn_ctx *ctx, const char *path, grn_db_create_optarg *optarg)
+
+   新たなdbを作成します。
+
+   :param ctx: 初期化済みの :c:type:`grn_ctx` を指定します。
+   :param path: 作成するdbを格納するファイルパスを指定します。NULLならtemporary dbとなります。NULL以外のパスを指定した場合はpersistent dbとなります。
+   :param optarg:
+      Currently, it is not used. It is just ignored.
+
+      作成するdbの組み込み型の名前を変更する時に指定します。
+
+      optarg.builtin_type_namesには、組み込み型の名前となるnull終端文字列の配列を指定します。optarg.n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を指定します。配列のoffsetはenum型grn_builtin_typeの値に対応します。
+
+.. c:function:: grn_obj *grn_db_open(grn_ctx *ctx, const char *path)
+
+   既存のdbを開きます。
+
+   :param path: 開こうとするdbを格納するファイルパスを指定します。
+
+.. c:function:: void grn_db_touch(grn_ctx *ctx, grn_obj *db)
+
+   dbの内容の最終更新時刻を現在時刻にします。
+
+   最終更新時刻はキャッシュが有効かどうかの判断などに利用されます。
+
+   :param db: 内容が変更されたdbを指定します。
+
+.. c:function:: grn_obj *grn_obj_db(grn_ctx *ctx, grn_obj *obj)
+
+   objの属するdbを返します。
+
+   :param obj: 対象objectを指定します。

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/api/grn_encoding.txt

@@ -0,0 +1,49 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_encoding``
+================
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. c:type:: grn_encoding
+
+   TODO...
+
+.. c:function:: grn_encoding grn_get_default_encoding(void)
+
+   デフォルトのencodingを返します。
+
+.. c:function:: grn_rc grn_set_default_encoding(grn_encoding encoding)
+
+   デフォルトのencodingを変更します。
+
+   :param encoding: 変更後のデフォルトのencodingを指定します。
+
+.. c:function:: const char *grn_encoding_to_string(grn_encoding encoding)
+
+   Returns string representation for the encoding. For example, 'grn_encoding_to_string(``GRN_ENC_UTF8``)' returns '"utf8"'.
+ 
+   "unknown" is returned for invalid encoding.
+
+   :param encoding: The encoding.
+
+.. c:function:: grn_encoding grn_encoding_parse(const char *name)
+ 
+   Parses encoding name and returns grn_encoding. For example, 'grn_encoding_parse("UTF8")' returns '``GRN_ENC_UTF8``'.
+ 
+   ``GRN_ENC_UTF8`` is returned for invalid encoding name.
+
+   :param name: The encoding name.

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/api/grn_expr.txt

@@ -5,4 +5,87 @@
 grn_expr
 ========
 
+`grn_expr` is an :c:type:`grn_obj` that represents an expression. Here
+is a list of what expression can do:
+
+  * Expression can apply some operations to a record by
+    :c:func:`grn_expr_exec`.
+  * Expression can represents search condition. :c:func:`grn_table_select`
+    can select records that match against the search condition represented
+    by expression.
+
+There are two string representations of expression:
+
+  * :doc:`/reference/grn_expr/query_syntax`
+  * :doc:`/reference/grn_expr/script_syntax`
+
+:c:func:`grn_expr_parse` parses string represented expression and
+appends the parsed expression to another expression.
+
+Example
+-------
+
 TODO...
+
+Reference
+---------
+
+.. c:function:: GRN_API grn_obj *grn_expr_create(grn_ctx *ctx, const char *name, unsigned int name_size)
+
+.. c:function:: GRN_API grn_rc grn_expr_close(grn_ctx *ctx, grn_obj *expr)
+
+.. c:function:: GRN_API grn_obj *grn_expr_add_var(grn_ctx *ctx, grn_obj *expr, const char *name, unsigned int name_size)
+
+.. c:function:: GRN_API grn_obj *grn_expr_get_var_by_offset(grn_ctx *ctx, grn_obj *expr, unsigned int offset)
+
+.. c:function:: GRN_API grn_obj *grn_expr_append_obj(grn_ctx *ctx, grn_obj *expr, grn_obj *obj, grn_operator op, int nargs);
+
+.. c:function:: GRN_API grn_obj *grn_expr_append_const(grn_ctx *ctx, grn_obj *expr, grn_obj *obj, grn_operator op, int nargs)
+
+.. c:function:: GRN_API grn_obj *grn_expr_append_const_str(grn_ctx *ctx, grn_obj *expr, const char *str, unsigned int str_size, grn_operator op, int nargs)
+
+.. c:function:: GRN_API grn_obj *grn_expr_append_const_int(grn_ctx *ctx, grn_obj *expr, int i, grn_operator op, int nargs)
+
+.. c:function:: GRN_API grn_rc grn_expr_append_op(grn_ctx *ctx, grn_obj *expr, grn_operator op, int nargs)
+
+.. c:function:: grn_rc grn_expr_syntax_escape(grn_ctx *ctx, const char *string, int string_size, const char *target_characters, char escape_character, grn_obj *escaped_string)
+
+   Escapes ``target_characters`` in ``string`` by ``escape_character``.
+
+   :param ctx: Its encoding must be the same encoding of ``string``.
+               It is used for allocating buffer for ``escaped_string``.
+   :param string: String expression representation.
+   :param string_size: The byte size of ``string``. ``-1`` means ``string``
+                       is NULL terminated string.
+   :param target_characters: NULL terminated escape target characters.
+                             For example, ``"+-><~*()\"\\:"`` is
+                             ``target_characters`` for
+                             :doc:`/reference/grn_expr/query_syntax`.
+   :param escape_character: The character to use escape a character in
+                            ``target_characters``. For example, ``\\``
+                            (backslash) is ``escaped_character`` for
+                            :doc:`/reference/grn_expr/query_syntax`.
+   :param escaped_string: The output of escaped ``string``. It should be
+                          text typed bulk.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_rc grn_expr_syntax_escape_query(grn_ctx *ctx, const char *query, int query_size, grn_obj *escaped_query)
+
+   Escapes special characters in
+   :doc:`/reference/grn_expr/query_syntax`.
+
+   :param ctx: Its encoding must be the same encoding of ``query``.
+               It is used for allocating buffer for ``escaped_query``.
+   :param query: String expression representation in
+                 :doc:`/reference/grn_expr/query_syntax`.
+   :param query_size: The byte size of ``query``. ``-1`` means ``query``
+                      is NULL terminated string.
+   :param escaped_query: The output of escaped ``query``. It should be
+                         text typed bulk.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: GRN_API grn_rc grn_expr_compile(grn_ctx *ctx, grn_obj *expr)
+
+.. c:function:: GRN_API grn_obj *grn_expr_exec(grn_ctx *ctx, grn_obj *expr, int nargs)
+
+.. c:function:: GRN_API grn_obj *grn_expr_alloc(grn_ctx *ctx, grn_obj *expr, grn_id domain, grn_obj_flags flags)