RubyGems - rroonga - Versions diffs - 7.0.2-x64-mingw32 → 7.1.1-x64-mingw32 - Mend

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

Files changed (1237) hide show

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_column.txt DELETED Viewed

@@ -1,198 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: c
-``grn_column``
-==============
-Summary
--------
-TODO...
-Example
--------
-TODO...
-Reference
----------
-.. c:macro:: GRN_COLUMN_NAME_ID
-   It returns the name of :doc:`/reference/columns/pseudo` ``_id``.
-   It is useful to use with :c:macro:`GRN_COLUMN_NAME_ID_LEN` like
-   the following::
-     grn_obj *id_column;
-     id_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_ID, GRN_COLUMN_NAME_ID_LEN);
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_ID_LEN
-   It returns the byte size of :c:macro:`GRN_COLUMN_NAME_ID`.
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_KEY
-   It returns the name of :doc:`/reference/columns/pseudo` ``_key``.
-   It is useful to use with :c:macro:`GRN_COLUMN_NAME_KEY_LEN` like
-   the following::
-     grn_obj *key_column;
-     key_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_KEY, GRN_COLUMN_NAME_KEY_LEN);
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_KEY_LEN
-   It returns the byte size of :c:macro:`GRN_COLUMN_NAME_KEY`.
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_VALUE
-   It returns the name of :doc:`/reference/columns/pseudo` ``_value``.
-   It is useful to use with :c:macro:`GRN_COLUMN_NAME_VALUE_LEN` like
-   the following::
-     grn_obj *value_column;
-     value_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_VALUE, GRN_COLUMN_NAME_VALUE_LEN);
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_VALUE_LEN
-   It returns the byte size of :c:macro:`GRN_COLUMN_NAME_VALUE`.
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_SCORE
-   It returns the name of :doc:`/reference/columns/pseudo` ``_score``.
-   It is useful to use with :c:macro:`GRN_COLUMN_NAME_SCORE_LEN` like
-   the following::
-     grn_obj *score_column;
-     score_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_SCORE, GRN_COLUMN_NAME_SCORE_LEN);
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_SCORE_LEN
-   It returns the byte size of :c:macro:`GRN_COLUMN_NAME_SCORE`.
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_NSUBRECS
-   It returns the name of :doc:`/reference/columns/pseudo` ``_nsubrecs``.
-   It is useful to use with :c:macro:`GRN_COLUMN_NAME_NSUBRECS_LEN` like
-   the following::
-     grn_obj *nsubrecs_column;
-     nsubrecs_column = grn_ctx_get(ctx, GRN_COLUMN_NAME_NSUBRECS, GRN_COLUMN_NAME_NSUBRECS_LEN);
-   Since 3.1.1.
-.. c:macro:: GRN_COLUMN_NAME_NSUBRECS_LEN
-   It returns the byte size of :c:macro:`GRN_COLUMN_NAME_NSUBRECS`.
-   Since 3.1.1.
-.. 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長バッファ（呼出側で準備する）を指定します。
-.. c:function:: grn_rc grn_column_truncate(grn_ctx *ctx, grn_obj *column)
-   .. note::
-      This is a dangerous API. You must not use this API when other
-      thread or process accesses the target column. If you use this
-      API against shared column, the process that accesses the column
-      may be broken and the column may be broken.
-   .. versionadded:: 4.0.9
-   Clears all values in the column.
-   :param column: The column to be truncated.
-   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_command_version.txt DELETED Viewed

@@ -1,37 +0,0 @@
-.. -*- 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/en/html/_sources/reference/api/grn_content_type.txt DELETED Viewed

@@ -1,39 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: c
-``grn_content_type``
-====================
-Summary
--------
-:c:type:`grn_content_type` shows input type and output
-type. Currently, it is used only for output type.
-Normally, you don't need to use this type. It is used internally in
-:c:func:`grn_ctx_send()`.
-Reference
----------
-.. c:type:: grn_content_type
-   Here are available values:
-   `GRN_CONTENT_NONE`
-     It means that outputting nothing or using the original format.
-     :doc:`/reference/commands/dump` uses the type.
-   `GRN_CONTENT_TSV`
-     It means tab separated values format.
-   `GRN_CONTENT_JSON`
-     It means JSON format.
-   `GRN_CONTENT_XML`
-     It means XML format.
-   `GRN_CONTENT_MSGPACK`
-     It means MessagePack format. You need MessagePack library on building
-     Groonga. If you don't have MessagePack library, you can't use this type.

data/vendor/local/share/doc/groonga/en/html/_sources/reference/api/grn_ctx.txt DELETED Viewed

@@ -1,195 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-``grn_ctx``
-===========
-Summary
--------
-:c:type:`grn_ctx` is the most important object. :c:type:`grn_ctx`
-keeps the current information such as:
-* The last occurred error.
-* The current encoding.
-* The default thresholds. (e.g. :ref:`select-match-escalation-threshold`)
-* The default command version. (See :doc:`/reference/command/command_version`)
-:c:type:`grn_ctx` provides platform features such as:
-* Memory management.
-* Logging.
-Most APIs receive :c:type:`grn_ctx` as the first argument.
-You can't use the same :c:type:`grn_ctx` from two or more threads. You
-need to create a :c:type:`grn_ctx` for a thread. You can use two or
-more :c:type:`grn_ctx` in a thread but it is not needed for usual
-use-case.
-Example
--------
-TODO...
-Reference
----------
-.. c:type:: grn_ctx
-   TODO...
-.. c:function:: grn_rc grn_ctx_init(grn_ctx *ctx, int flags)
-   ctxを初期化します。
-   :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 to use
-   :c:func:`grn_ctx_close()` instead of :c:func:`grn_ctx_fin()`.
-   :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を指定します。
-.. c:function:: grn_rc grn_ctx_get_all_tables(grn_ctx *ctx, grn_obj *tables_buffer)
-   It pushes all tables in the database of ``ctx`` into
-   ``tables_buffer``. ``tables_buffer`` should be initialized as
-   ``GRN_PVECTOR``. You can use ``GRN_PTR_INIT()`` with
-   ``GRN_OBJ_VECTOR`` flags to initialize ``tables_buffer``.
-   Here is an example:
-   .. code-block :: c
-      grn_rc rc;
-      grn_obj tables;
-      int i;
-      int n_tables;
-      GRN_PTR_INIT(&tables, GRN_OBJ_VECTOR, GRN_ID_NIL);
-      rc = grn_ctx_get_all_tables(ctx, &tables);
-      if (rc != GRN_SUCCESS) {
-        GRN_OBJ_FIN(ctx, &tables);
-        /* Handle error. */
-        return;
-      }
-      n_tables = GRN_BULK_VSIZE(&tables) / sizeof(grn_obj *);
-      for (i = 0; i < n_tables; i++) {
-        grn_obj *table = GRN_PTR_VALUE_AT(&tables, i);
-        /* Use table. */
-      }
-      /* Free resources. */
-      for (i = 0; i < n_tables; i++) {
-        grn_obj *table = GRN_PTR_VALUE_AT(&tables, i);
-        grn_obj_unlink(ctx, table);
-      }
-      GRN_OBJ_FIN(ctx, &tables);
-   :param ctx: The context object.
-   :param table_buffer: The output buffer to store tables.
-   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
-.. c:function:: grn_content_type grn_ctx_get_output_type(grn_ctx *ctx)
-   Gets the current output type of the context.
-   Normally, this function isn't needed.
-   :param ctx: The context object.
-   :return: The output type of the context.
-.. c:function:: grn_rc grn_ctx_set_output_type(grn_ctx *ctx, grn_content_type type)
-   Sets the new output type to the context. It is used by executing a
-   command by :c:func:`grn_expr_exec()`. If you use
-   :c:func:`grn_ctx_send()`, the new output type isn't
-   used. :c:func:`grn_ctx_send()` sets output type from command line
-   internally.
-   Normally, this function isn't needed.
-   :param ctx: The context object.
-   :param type: The new output type.
-   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
-.. c:function:: grn_bool_rc grn_ctx_is_opened(grn_ctx *ctx, grn_id id)
-   Checks whether object with the ID is opened or not.
-   :param ctx: The context object.
-   :param id: The object ID to be checked.
-   :return: ``GRN_TRUE`` if object with the ID is opened,
-            ``GRN_FALSE`` otherwise.