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

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/config_get.txt

@@ -1,96 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: config_get
-
-``config_get``
-==============
-
-Summary
--------
-
-.. versionadded:: 5.1.2
-
-``config_get`` command returns the value of the specified
-configuration item.
-
-Syntax
-------
-
-This command takes only one required parameter::
-
-  config_get key
-
-Usage
------
-
-Here is an example to set a value to ``alias.column``
-configuration item and get the value:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/config_get/existent.log
-.. config_set alias.column Aliases.real_name
-.. config_get alias.column
-
-Here is an example to get nonexistent configuration item value:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/config_get/nonexistent.log
-.. config_get nonexistent
-
-``config_get`` returns an empty string for nonexistent configuration
-item key.
-
-Parameters
-----------
-
-This section describes all parameters.
-
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is one required parameter.
-
-.. _config-get-key:
-
-``key``
-"""""""
-
-Specifies the key of target configuration item.
-
-The max key size is 4KiB.
-
-You can't use an empty string as key.
-
-Optional parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is no optional parameter.
-
-Return value
-------------
-
-``config_get`` command returns the value of the specified
-configuration item::
-
-  [HEADER, VALUE]
-
-``HEADER``
-^^^^^^^^^^
-
-See :doc:`/reference/command/output_format` about ``HEADER``.
-
-``VALUE``
-^^^^^^^^^^
-
-``VALUE`` is the value of the configuration item specified by
-``key``. It's a string.
-
-See also
---------
-
-  * :doc:`/reference/configuration`
-  * :doc:`config_set`
-  * :doc:`config_delete`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/config_set.txt

@@ -1,96 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: config_set
-
-``config_set``
-==============
-
-Summary
--------
-
-.. versionadded:: 5.1.2
-
-``config_set`` command sets a value to the specified
-configuration item.
-
-Syntax
-------
-
-This command takes two required parameters::
-
-  config_set key value
-
-Usage
------
-
-Here is an example to set a value to ``alias.column``
-configuration item and confirm the set value:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/config_set/set_and_get.log
-.. config_set alias.column Aliases.real_name
-.. config_get alias.column
-
-Parameters
-----------
-
-This section describes all parameters.
-
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-
-There are required parameters.
-
-.. _config-set-key:
-
-``key``
-"""""""
-
-Specifies the key of target configuration item.
-
-The max key size is 4KiB.
-
-You can't use an empty string as key.
-
-.. _config-set-value:
-
-``value``
-"""""""""
-
-Specifies the value of the target configuration item specified by
-``key``.
-
-The max value size is 4091B (= 4KiB - 5B).
-
-Optional parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is no optional parameter.
-
-Return value
-------------
-
-``config_set`` command returns whether setting a configuration item
-value is succeeded or not::
-
-  [HEADER, SUCCEEDED_OR_NOT]
-
-``HEADER``
-^^^^^^^^^^
-
-See :doc:`/reference/command/output_format` about ``HEADER``.
-
-``SUCCEEDED_OR_NOT``
-^^^^^^^^^^^^^^^^^^^^
-
-If command succeeded, it returns true, otherwise it returns false on error.
-
-See also
---------
-
-  * :doc:`/reference/configuration`
-  * :doc:`config_get`
-  * :doc:`config_delete`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/database_unmap.txt

@@ -1,85 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_database_unmap
-
-.. groonga-command
-.. thread_limit 2
-
-``database_unmap``
-==================
-
-Summary
--------
-
-.. versionadded:: 5.0.7
-
-``database_unmap`` unmaps already mapped tables and columns in the
-database. "Map" means that loading from disk to memory. "Unmap" means
-that releasing mapped memory.
-
-.. note::
-
-   Normally, you don't need to use ``database_unmap`` because OS
-   manages memory cleverly. If remained system memory is reduced, OS
-   moves memory used by Groonga to disk until Groonga needs the
-   memory. OS moves unused memory preferentially.
-
-.. caution::
-
-   You can use this command only when :doc:`thread_limit` returns
-   ``1``. It means that this command doesn't work with multithreading.
-
-Syntax
-------
-
-This command takes no parameters::
-
-  database_unmap
-
-Usage
------
-
-You can unmap database after you change the max number of threads to
-``1``:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/database_unmap/usage_success.log
-.. thread_limit --max 1
-.. database_unmap
-
-If the max number of threads is larger than ``1``, ``database_unmap``
-fails:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/database_unmap/usage_failure.log
-.. thread_limit --max 2
-.. database_unmap
-
-Parameters
-----------
-
-This section describes all parameters.
-
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is no required parameter.
-
-Optional parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is no optional parameter.
-
-Return value
-------------
-
-The command returns ``true`` as body on success such as::
-
-  [HEADER, true]
-
-If the command fails, error details are in ``HEADER``.
-
-See :doc:`/reference/command/output_format` for ``HEADER``.

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/define_selector.txt

@@ -1,110 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``define_selector``
-===================
-
-Summary
--------
-
-define_selector - 検索コマンドを定義
-
-Groonga組込コマンドの一つであるdefine_selectorについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-define_selectorは、検索条件をカスタマイズした新たな検索コマンドを定義します。
-
-Syntax
-------
-::
-
- define_selector name table [match_columns [query [filter [scorer [sortby
-                 [output_columns [offset [limit [drilldown [drilldown_sortby
-                 [drilldown_output_columns [drilldown_offset [drilldown_limit]]]]]]]]]]]]]
-
-Usage
------
-
-テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。::
-
- define_selector entry_selector Entry
- [true]
-
-Parameters
-----------
-
-``name``
-
-  定義するselectorコマンドの名前を指定します。
-
-``table``
-
-  検索対象のテーブルを指定します。
-
-``match_columns``
-
-  追加するselectorコマンドのmatch_columns引数のデフォルト値を指定します。
-
-``query``
-
-  追加するselectorコマンドのquery引数のデフォルト値を指定します。
-
-``filter``
-
-  追加するselectorコマンドのfilter引数のデフォルト値を指定します。
-
-``scorer``
-
-  追加するselectorコマンドのscorer引数のデフォルト値を指定します。
-
-``sortby``
-
-  追加するselectorコマンドのsortby引数のデフォルト値を指定します。
-
-``output_columns``
-
-  追加するselectorコマンドのoutput_columns引数のデフォルト値を指定します。
-
-``offset``
-
-  追加するselectorコマンドのoffset引数のデフォルト値を指定します。
-
-``limit``
-
-  追加するselectorコマンドのlimit引数のデフォルト値を指定します。
-
-``drilldown``
-
-  追加するselectorコマンドのdrilldown引数のデフォルト値を指定します。
-
-``drilldown_sortby``
-
-  追加するselectorコマンドのdrilldown_sortby引数のデフォルト値を指定します。
-
-``drilldown_output_columns``
-
-  追加するselectorコマンドのdrilldown_output_columns引数のデフォルト値を指定します。
-
-``drilldown_offset``
-
-  追加するselectorコマンドのdrilldown_offset引数のデフォルト値を指定します。
-
-``drilldown_limit``
-
-  追加するselectorコマンドのdrilldown_limit引数のデフォルト値を指定します。
-
-Return value
-------------
-
-::
-
- [成功かどうかのフラグ]
-
-``成功かどうかのフラグ``
-
-  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
-
-See also
---------
-
-:doc:`/reference/grn_expr`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/defrag.txt

@@ -1,55 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``defrag``
-==========
-
-Summary
--------
-
-``defrag`` command resolves fragmentation of specified objects.
-
-Groonga組込コマンドの一つであるdefragについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力
-、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-defragは、対象となるオブジェクト(データベースか可変長サイズカラム)を指定し、オブジェクトのフラグメンテーショ
-ンを解消します。
-
-Syntax
-------
-::
-
- defrag objname threshold
-
-Usage
------
-
-開いているデータベースのフラグメンテーションを解消する::
-
- defrag
- [300]
-
-テーブル名 Entry のカラム body のフラグメンテーションを解消する::
-
- defrag Entry.body
- [30]
-
-Parameters
-----------
-
-``objname``
-
-  対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。
-
-Return value
-------------
-
-::
-
- [フラグメンテーション解消を実行したセグメントの数]
-
-``フラグメンテーション解消を実行したセグメントの数``
-
-  フラグメンテーション解消を実行したセグメントの数を返す。
-

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/delete.txt

@@ -1,122 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_delete
-
-``delete``
-==========
-
-Summary
--------
-
-``delete`` command deletes specified record of table.
-
-.. _cascade-delete:
-
-Cascade delete
-^^^^^^^^^^^^^^
-
-There is a case that multiple table is associated. For example, the key of one table are referenced by other table's records. In such a case, if you delete the key of one table, other table's records are also removed.
-
-Note that the type of other table's column is COLUMN_VECTOR, only the value of referencing key is removed from the vector value.
-
-Syntax
-------
-::
-
- delete table [key [id [filter]]]
-
-Usage
------
-
-Here are a schema definition and sample data to show usage.
-
-.. groonga-command
-.. table_create Entry TABLE_HASH_KEY UInt32
-.. column_create Entry status --type ShortText
-.. load --table Entry
-.. [
-.. {"_key": 1, "status": "OK"}
-.. {"_key": 2, "status": "NG"}
-.. ]
-
-Delete the record from Entry table which has "2" as the key.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/delete/status.log
-.. delete Entry 2
-.. select Entry
-
-Here is the example about cascaded delete.
-
-The country column of Users table associates with Country table.
-
-"Cascaded delete" removes the records which matches specified key and refers that key.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/delete/cascade.log
-.. table_create Country TABLE_HASH_KEY ShortText
-.. table_create Users TABLE_HASH_KEY UInt32
-.. column_create Users name COLUMN_SCALAR ShortText
-.. column_create Users country COLUMN_SCALAR Country
-.. load --table Users
-.. [
-.. {"_key": 1, "name": "John", country: "United States"}
-.. {"_key": 2, "name": "Mike", country: "United States"}
-.. {"_key": 3, "name": "Takashi", country: "Japan"}
-.. {"_key": 4, "name": "Hanako", country: "Japan"}
-.. ]
-.. load --table Country
-.. [
-.. {"_key": "United States"}
-.. {"_key": "Japan"}
-.. ]
-.. delete Country "United States"
-.. select Country
-.. select Users
-
-
-Parameters
-----------
-
-``table``
-
-  Specifies the name of table to delete the records.
-
-``key``
-
-  Specifies the key of record to delete. If you use the table with TABLE_NO_KEY, the key is just ignored.
-  (Use ``id`` parameter in such a case)
-
-``id``
-
-  Specifies the id of record to delete. If you specify ``id`` parameter, you must not specify ``key`` parameter.
-
-``filter``
-
-  Specifies the expression of grn_expr to identify the record. If you specify ``filter`` parameter,
-  you must not specify ``key`` and ``id`` parameter.
-
-Return value
-------------
-
-::
-
- [HEADER, SUCCEEDED_OR_NOT]
-
-``HEADER``
-
-  See :doc:`/reference/command/output_format` about ``HEADER``.
-
-``SUCCEEDED_OR_NOT``
-
-  If command succeeded, it returns true, otherwise it returns false on error.
-
-
-See also
---------
-
-:doc:`load`
-