rroonga 7.0.2-x86-mingw32 → 7.1.1-x86-mingw32

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

@@ -1,209 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_column_list
-
-``column_list``
-===============
-
-Summary
--------
-
-``column_list`` command lists columns in a table.
-
-Syntax
-------
-
-This command takes only one required parameter::
-
-  column_list table
-
-Usage
------
-
-Here is a simple example of ``column_list`` command.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/column_list/column_list.log
-.. table_create Users TABLE_PAT_KEY ShortText
-.. column_create Users age COLUMN_SCALAR UInt8
-.. column_create Users tags COLUMN_VECTOR ShortText
-.. column_list Users
-
-
-Parameters
-----------
-
-This section describes parameters of ``column_list``.
-
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-
-All parameters are required.
-
-``table``
-"""""""""
-
-Specifies the name of table to be listed columns.
-
-Return value
-------------
-
-``column_list`` returns the list of column information in the table::
-
-  [
-    HEADER,
-    [
-      COLUMN_LIST_HEADER,
-      COLUMN_INFORMATION1,
-      COLUMN_INFORMATION2,
-      ...
-    ]
-  ]
-
-``HEADER``
-
-  See :doc:`/reference/command/output_format` about ``HEADER``.
-
-``COLUMN_LIST_HEADER``
-
-  ``COLUMN_LIST_HEADER`` describes about content of each
-  ``COLUMN_INFORMATION``.
-
-  ``COLUMN_LIST_HEADER`` is the following format::
-
-    [
-      ["id",     "UInt32"],
-      ["name",   "ShortText"],
-      ["path",   "ShortText"],
-      ["type",   "ShortText"],
-      ["flags",  "ShortText"],
-      ["domain", "ShortText"],
-      ["range",  "ShortText"],
-      ["source", "ShortText"]
-    ]
-
-  It means the following:
-
-    * The first content in ``COLUMN_INFORMATION`` is ``id`` value and
-      the value type is ``UInt32``.
-    * The second content in ``COLUMN_INFORMATION`` is ``name`` value and
-      the value type is ``ShortText``.
-    * The third content ....
-
-  See the following ``COLUMN_INFORMATION`` description for details.
-
-  This field provides meta-data of column information. So this field
-  will be useful for programs rather than humans.
-
-``COLUMN_INFORMATION``
-
-  Each ``COLUMN_INFORMATION`` is the following format::
-
-    [
-      ID,
-      NAME,
-      PATH,
-      TYPE,
-      FLAGS,
-      DOMAIN,
-      RANGE,
-      SOURCES
-    ]
-
-  ``ID``
-
-    The column ID in the Groonga database. Normally, you don't care
-    about it.
-
-  ``NAME``
-
-    The column name.
-
-  ``PATH``
-
-    The path for storing column data.
-
-  ``TYPE``
-
-    The type of the column. It is one of the followings:
-
-    .. list-table::
-       :header-rows: 1
-
-       * - Value
-         - Description
-       * - ``fix``
-         - The column is a fixed size column. Scalar column that its
-           type is fixed size type is fixed size column.
-       * - ``var``
-         - The column is a variable size column. Vector column or
-           scalar column that its type is variable size type are
-           variable size column.
-       * - ``index``
-         - The column is an index column.
-
-  ``FLAGS``
-
-    The flags of the column. Each flag is separated by ``|`` like
-    ``COLUMN_VECTOR|WITH_WEIGHT``. ``FLAGS`` must include one of
-    ``COLUMN_SCALAR``, ``COLUMN_VECTOR`` or ``COLUMN_INDEX``. Other
-    flags are optional.
-
-    Here is the available flags:
-
-    .. list-table::
-       :header-rows: 1
-
-       * - Flag
-         - Description
-       * - ``COLUMN_SCALAR``
-         - The column is a scalar column.
-       * - ``COLUMN_VECTOR``
-         - The column is a vector column.
-       * - ``COLUMN_INDEX``
-         - The column is an index column.
-       * - ``WITH_WEIGHT``
-         - The column can have weight. ``COLUMN_VECTOR`` and ``COLUMN_INDEX``
-           may have it. ``COLUMN_SCALAR`` doesn't have it.
-       * - ``WITH_SECTION``
-         - The column can have section information. ``COLUMN_INDEX``
-           may have it.  ``COLUMN_SCALAR`` and ``COLUMN_VECTOR`` don't
-           have it.
-
-           Multiple column index has it.
-       * - ``WITH_POSITION``
-         - The column can have position information. ``COLUMN_INDEX``
-           may have it.  ``COLUMN_SCALAR`` and ``COLUMN_VECTOR`` don't
-           have it.
-
-           Full text search index must has it.
-       * - ``PERSISTENT``
-         - The column is a persistent column. It means that the column
-           isn't a :doc:`/reference/columns/pseudo`.
-
-  ``DOMAIN``
-
-      The name of table that has the column.
-
-  ``RANGE``
-
-      The value type name of the column. It is a type name or a table
-      name.
-
-  ``SOURCES``
-
-      An array of the source column names of the index. If the index
-      column is multiple column index, the array has two or more
-      source column names.
-
-      It is always an empty array for ``COLUMN_SCALAR`` and
-      ``COLUMN_VECTOR``.
-
-See also
---------
-
-* :doc:`/reference/commands/column_create`
-* :doc:`/reference/column`

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

@@ -1,57 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``column_remove``
-=================
-
-Summary
--------
-
-column_remove - テーブルに定義されているカラムの削除
-
-Groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、>標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-column_removeはテーブルに定義されているカラムを削除します。
-また、付随するインデックスも削除されます。[#]_
-
-Syntax
-------
-::
-
- column_remove table name
-
-Usage
------
-::
-
- column_remove Entry body
-
- [true]
-
-.. rubric:: 脚注
-
-.. [#] マルチセクションインデックスの一部である場合も、インデックスが削除されます。
-
-Parameters
-----------
-
-``table``
-
-  削除対象のカラムが定義されているテーブルの名前を指定します。
-
-``name``
-
-  削除対象のカラム名を指定します。
-
-Return value
-------------
-
-::
-
- [成功かどうかのフラグ]
-
-``成功かどうかのフラグ``
-
-   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
-

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

@@ -1,101 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_column_rename
-
-``column_rename``
-=================
-
-Summary
--------
-
-``column_rename`` command renames a column.
-
-It is a light operation. It just changes a relationship between name
-and the column object. It doesn't copy column values.
-
-It is a dangerous operation. You must stop all operations including
-read operations while you run ``column_rename``. If the following case
-is occurred, Groonga process may be crashed:
-
-  * Starts an operation (like ``select``) that accesses the column to
-    be renamed by the current column name. The current column name is
-    called as ``the old column name`` in the below because the column
-    name is renamed.
-  * Runs ``column_rename``. The ``select`` is still running.
-  * The ``select`` accesses the column to be renamed by the old column
-    name. But the ``select`` can't find the column by the old name
-    because the column has been renamed to the new column name. It may
-    crash the Groonga process.
-
-Syntax
-------
-
-This command takes three parameters.
-
-All parameters are required::
-
-  column_rename table name new_name
-
-Usage
------
-
-Here is a simple example of ``column_rename`` command.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/column_rename/column_rename.log
-.. table_create Users TABLE_PAT_KEY ShortText
-.. column_create Users score COLUMN_SCALAR Int32
-.. load --table Users
-.. [
-.. {"_key": "Alice",  "score": 2},
-.. {"_key": "Bob",    "score": 0},
-.. {"_key": "Carlos", "score": -1}
-.. ]
-.. column_rename Users score point
-.. column_list Users
-.. select Users
-
-Parameters
-----------
-
-This section describes parameters of ``column_rename``.
-
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-
-All parameters are required.
-
-``table``
-"""""""""
-
-Specifies the name of table that has the column to be renamed.
-
-``name``
-""""""""
-
-Specifies the column name to be renamed.
-
-``new_name``
-""""""""""""
-
-Specifies the new column name.
-
-
-Return value
-------------
-
-::
-
- [HEADER, SUCCEEDED_OR_NOT]
-
-``HEADER``
-
-  See :doc:`/reference/command/output_format` about ``HEADER``.
-
-``SUCCEEDED_OR_NOT``
-
-  It is ``true`` on success, ``false`` otherwise.
-

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

@@ -1,95 +0,0 @@
-.. -*- 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 parameter.
-
-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`