rroonga 5.1.1-x86-mingw32 → 6.0.0-x86-mingw32

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

@@ -9,7 +9,7 @@ Summary
 -------
 
 :c:type:`grn_ctx` is the most important object. :c:type:`grn_ctx`
-keeps the current infomation such as:
+keeps the current information such as:
 
 * The last occurred error.
 * The current encoding.

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

@@ -40,7 +40,7 @@ Reference
 
 .. 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 specfied by top_left_point parameter and bottom_right_point parameter.
+   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)

data/vendor/local/share/doc/groonga/en/html/_sources/reference/command/command_version.txt

@@ -2,8 +2,8 @@
 
 .. highlightlang:: none
 
-コマンドバージョン
-==================
+Command version
+===============
 
 概要
 ----

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

@@ -3,7 +3,7 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. database: commands_select
+.. database: commands_copy
 
 ``column_copy``
 ===============

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

@@ -0,0 +1,95 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: config_delete
+
+``config_delete``
+=================
+
+Summary
+-------
+
+.. versionadded:: 5.1.2
+
+``config_delete`` command deletes the specified configuration item.
+
+Syntax
+------
+
+This command takes only one required parameter::
+
+  config_delete key
+
+Usage
+-----
+
+Here is an example to delete ``alias.column`` configuration item:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/config_delete/existent.log
+.. config_set alias.column Aliases.real_name
+.. config_get alias.column
+.. config_delete alias.column
+.. config_get alias.column
+
+Here is an example to delete nonexistent configuration item:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/config_delete/nonexistent.log
+.. config_delete nonexistent
+
+``config_delete`` returns an error when you try to delete nonexistent
+configuration item.
+
+Parameters
+----------
+
+This section describes all parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is one required parameter.
+
+.. _config-delete-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 parameters.
+
+Return value
+------------
+
+``config_delete`` command returns whether deleting a configuration
+item 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_set`

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

@@ -0,0 +1,96 @@
+.. -*- 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 parameters.
+
+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

@@ -0,0 +1,96 @@
+.. -*- 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 parameters.
+
+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/lock_acquire.txt

@@ -0,0 +1,102 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: lock_acquire
+
+``lock_acquire``
+================
+
+Summary
+-------
+
+.. versionadded:: 5.1.2
+
+``lock_acquire`` command acquires the lock of the target object. The
+target object is one of database, table and column.
+
+.. note::
+
+   This is a dangerous command. You must release locks by
+   :doc:`lock_release` that you acquire when these locks are no longer
+   needed. If you forget to release these locks, your database may be
+   broken.
+
+Syntax
+------
+
+This command takes only one optional parameter::
+
+  lock_clear [target_name=null]
+
+If ``target_name`` parameters is omitted, database is used for the
+target object.
+
+Usage
+-----
+
+Here is an example to acquire the lock of the database:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/lock_acquire/database.log
+.. lock_acquire
+
+If the database is locked, you can't create a new table and
+column. Release the lock of the database to show another examples.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/lock_acquire/database_release.log
+.. lock_release
+
+Here is an example to acquire the lock of ``Entries`` table:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/lock_acquire/table.log
+.. table_create Entries TABLE_NO_KEY
+.. lock_acquire Entries
+
+Here is an example to acquire the lock of ``Sites.title`` column:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/lock_acquire/column.log
+.. table_create Sites TABLE_HASH_KEY ShortText
+.. column_create Sites title COLUMN_SCALAR ShortText
+.. lock_acquire Sites.title
+
+Parameters
+----------
+
+This section describes all parameters.
+
+``target_name``
+"""""""""""""""
+
+Specifies the name of table or column.
+
+If you don't specify it, database is used for the target object.
+
+The default is none. It means that the target object is database.
+
+Return value
+------------
+
+``lock_acquire`` command returns whether lock is acquired 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:`lock_release`
+  * :doc:`lock_clear`

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

@@ -42,22 +42,22 @@ Here is an example to clear all locks in the database:
 .. include:: ../../example/reference/commands/lock_clear/database.log
 .. lock_clear
 
-Here is an example to clear locks of ``Entry`` table and ``Entry``
+Here is an example to clear locks of ``Entries`` table and ``Entries``
 table columns:
 
 .. groonga-command
 .. include:: ../../example/reference/commands/lock_clear/table.log
-.. table_create Entry TABLE_NO_KEY
-.. column_create Entry body COLUMN_SCALAR Text
-.. lock_clear Entry
+.. table_create Entries TABLE_NO_KEY
+.. column_create Entries body COLUMN_SCALAR Text
+.. lock_clear Entries
 
-Here is an example to clear the lock of ``Site.title`` column:
+Here is an example to clear the lock of ``Sites.title`` column:
 
 .. groonga-command
 .. include:: ../../example/reference/commands/lock_clear/column.log
-.. table_create Site TABLE_HASH_KEY ShortText
-.. column_create Site title COLUMN_SCALAR ShortText
-.. lock_clear Site.title
+.. table_create Sites TABLE_HASH_KEY ShortText
+.. column_create Sites title COLUMN_SCALAR ShortText
+.. lock_clear Sites.title
 
 Parameters
 ----------
@@ -76,7 +76,8 @@ The default is none. It means that the target object is database.
 Return value
 ------------
 
-``lock_clear`` command returns whether lock is acquired or not::
+``lock_clear`` command returns whether lock is cleared successfully or
+not::
 
  [HEADER, SUCCEEDED_OR_NOT]