rroonga 7.0.2-x64-mingw32 → 7.1.1-x64-mingw32

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

@@ -1,134 +0,0 @@
-.. -*- 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を指定します。
-
-.. c:function:: grn_rc grn_db_recover(grn_ctx *ctx, grn_obj *db)
-
-   .. note::
-
-      This is an experimental API.
-
-   .. note::
-
-      This is a dangerous API. You must not use this API when other
-      thread or process opens the target database. If you use this API
-      against shared database, the database may be broken.
-
-   .. versionadded:: 4.0.9
-
-   Checks the passed database and recovers it if it is broken and it
-   can be recovered.
-
-   This API uses lock existence for checking whether the database is
-   broken or not.
-
-   Here are recoverable cases:
-
-     * Index column is broken. The index column must have source column.
-
-   Here are unrecoverable cases:
-
-     * Object name management feature is broken.
-     * Table is broken.
-     * Data column is broken.
-
-   Object name management feature is used for managing table name,
-   column name and so on. If the feature is broken, the database can't
-   be recovered. Please re-create the database from backup.
-
-   Table and data column can be recovered by removing an existence
-   lock and re-add data.
-
-   :param db: The database to be recovered.
-   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
-
-.. c:function:: grn_rc grn_db_unmap(grn_ctx *ctx, grn_obj *db)
-
-   .. note::
-
-      This is an experimental API.
-
-   .. note::
-
-      This is a thread unsafe API. You can't touch the database while
-      this API is running.
-
-   .. versionadded:: 5.0.7
-
-   Unmaps all opened tables and columns in the passed
-   database. Resources used by these opened tables and columns are
-   freed.
-
-   Normally, this API isn't useless. Because resources used by opened
-   tables and columns are managed by OS automatically.
-
-   :param db: The database to be recovered.
-   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.

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

@@ -1,49 +0,0 @@
-.. -*- 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/en/html/_sources/reference/api/grn_expr.txt

@@ -1,136 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: c
-
-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_get_keywords(grn_ctx *ctx, grn_obj *expr, grn_obj *keywords)
-
-   Extracts keywords from ``expr`` and stores to
-   ``keywords``. Keywords in ``keywords`` are owned by ``expr``. Don't
-   unlink them. Each keyword is ``GRN_BULK`` and its domain is
-   ``GRN_DB_TEXT``.
-
-   ``keywords`` must be ``GRN_PVECTOR``.
-
-   Here is an example code::
-
-      grn_obj keywords;
-      GRN_PTR_INIT(&keywords, GRN_OBJ_VECTOR, GRN_ID_NIL);
-      grn_expr_get_keywords(ctx, expr, &keywords);
-      {
-        int i, n_keywords;
-        n_keywords = GRN_BULK_VSIZE(&keywords) / sizeof(grn_obj *);
-        for (i = 0; i < n_keywords; i++) {
-          grn_obj *keyword = GRN_PTR_VALUE_AT(&keywords, i);
-          const char *keyword_content;
-          int keyword_size;
-          keyword_content = GRN_TEXT_VALUE(keyword);
-          keyword_size = GRN_TEXT_LEN(keyword);
-          /*
-            Use keyword_content and keyword_size.
-            You don't need to unlink keyword.
-            keyword is owned by expr.
-          */
-        }
-      }
-      GRN_OBJ_FIN(ctx, &keywords);
-
-
-   :param ctx: The context that creates the ``expr``.
-   :param expr: The expression to be extracted.
-   :param keywords: The container to store extracted keywords.
-                    It must be ``GRN_PVECTOR``.
-
-                    Each extracted keyword is ``GRN_BULK`` and its
-                    domain is ``GRN_DB_TEXT``.
-
-                    Extracted keywords are owned by ``expr``. Don't
-                    unlink them.
-   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
-
-.. 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)

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

@@ -1,55 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``grn_geo``
-===========
-
-Summary
--------
-
-TODO...
-
-Example
--------
-
-TODO...
-
-Reference
----------
-
-.. c:type:: grn_geo_point
-
-.. c:function:: grn_rc grn_geo_select_in_rectangle(grn_ctx *ctx, grn_obj *index, grn_obj *top_left_point, grn_obj *bottom_right_point, grn_obj *res, grn_operator op)
-
-   It selects records that are in the rectangle specified by top_left_point parameter and bottom_right_point parameter. Records are searched by index parameter. Found records are added to res parameter table with op parameter operation.
-
-   :param index: the index column for TokyoGeoPoint or WGS84GeoPpoint type.
-   :param top_left_point: the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or  WGS84GeoPoint)
-   :param bottom_right_point: the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
-   :param res: the table to store found record IDs. It must be ``GRN_TABLE_HASH_KEY`` type table.
-   :param op: the operator for matched records.
-
-.. c:function:: int grn_geo_estimate_in_rectangle(grn_ctx *ctx, grn_obj *index, grn_obj *top_left_point, grn_obj *bottom_right_point)
-
-   It estimates number of records in the rectangle specified by top_left_point parameter and bottom_right_point parameter. Number of records is estimated by index parameter. If an error is occurred, -1 is returned.
-
-   :param index: the index column for TokyoGeoPoint or WGS84GeoPpoint type.
-   :param top_left_point: the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
-   :param bottom_right_point: the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
-
-.. c:function:: grn_obj *grn_geo_cursor_open_in_rectangle(grn_ctx *ctx, grn_obj *index, grn_obj *top_left_point, grn_obj *bottom_right_point, int offset, int limit)
-
-   It opens a cursor to get records in the rectangle specified by top_left_point parameter and bottom_right_point parameter.
-
-   :param index: the index column for TokyoGeoPoint or WGS84GeoPpoint type.
-   :param top_left_point: the top left point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
-   :param bottom_right_point: the bottom right point of the target rectangle. (ShortText, Text, LongText, TokyoGeoPoint or WGS84GeoPoint)
-   :param offset: the cursor returns records from offset parameter position. offset parameter is based on 0.
-   :param limit: the cursor returns at most limit parameter records. -1 means no limit.
-
-.. c:function:: grn_posting *grn_geo_cursor_next(grn_ctx *ctx, grn_obj *cursor)
-
-   It returns the next posting that has record ID. It returns NULL after all records are returned.
-
-   :param cursor: the geo cursor.

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

@@ -1,67 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``grn_hook``
-============
-
-Summary
--------
-
-TODO...
-
-Example
--------
-
-TODO...
-
-Reference
----------
-
-.. c:type:: grn_hook_entry
-
-   TODO...
-
-.. c:function:: grn_rc grn_obj_add_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *proc, grn_obj *data)
-
-   objに対してhookを追加します。
-
-   :param obj: 対象objectを指定します。
-   :param entry:
-      ``GRN_HOOK_GET`` は、objectの参照時に呼び出されるhookを定義します。
-
-      ``GRN_HOOK_SET`` は、objectの更新時に呼び出されるhookを定義します。
-
-      ``GRN_HOOK_SELECT`` は、検索処理の実行中に適時呼び出され、処理の実行状況を調べたり、実行の中断を指示することができます。
-   :param offset:
-      hookの実行順位。offsetに対応するhookの直前に新たなhookを挿入します。
-
-      0を指定した場合は先頭に挿入されます。-1を指定した場合は末尾に挿入されます。
-
-      objectに複数のhookが定義されている場合は順位の順に呼び出されます。
-   :param proc: 手続きを指定します。
-   :param data: hook固有情報を指定します。
-
-.. c:function:: int grn_obj_get_nhooks(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry)
-
-   objに定義されているhookの数を返します。
-
-   :param obj: 対象objectを指定します。
-   :param entry: hookタイプを指定します。
-
-.. c:function:: grn_obj *grn_obj_get_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset, grn_obj *data)
-
-   objに定義されているhookの手続き（proc）を返します。hook固有情報が定義されている場合は、その内容をdataにコピーして返します。
-
-   :param obj: 対象objectを指定します。
-   :param entry: hookタイプを指定します。
-   :param offset: 実行順位を指定します。
-   :param data: hook固有情報格納バッファを指定します。
-
-.. c:function:: grn_rc grn_obj_delete_hook(grn_ctx *ctx, grn_obj *obj, grn_hook_entry entry, int offset)
-
-   objに定義されているhookを削除します。
-
-   :param obj: 対象objectを指定します。
-   :param entry: hookタイプを指定します。
-   :param offset: 実行順位を指定します。

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

@@ -1,35 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``grn_ii``
-==========
-
-Summary
--------
-
-buffered index builder
-
-特定のアプリケーション用に準備した内部APIです。
-
-TODO...
-
-Example
--------
-
-TODO...
-
-Reference
----------
-
-.. c:type:: grn_ii
-
-.. c:type:: grn_ii_buffer
-
-.. c:function:: grn_ii_buffer *grn_ii_buffer_open(grn_ctx *ctx, grn_ii *ii, long long unsigned int update_buffer_size)
-
-.. c:function:: grn_rc grn_ii_buffer_append(grn_ctx *ctx, grn_ii_buffer *ii_buffer, grn_id rid, unsigned int section, grn_obj *value)
-
-.. c:function:: grn_rc grn_ii_buffer_commit(grn_ctx *ctx, grn_ii_buffer *ii_buffer)
-
-.. c:function:: grn_rc grn_ii_buffer_close(grn_ctx *ctx, grn_ii_buffer *ii_buffer)