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

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

@@ -1,177 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Tuning
-======
-
-Summary
--------
-
-There are some tuning parameters for handling a large database.
-
-Parameters
-----------
-
-This section describes tuning parameters.
-
-.. _tuning-max-n-open-files:
-
-The max number of open files per process
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This parameter is for handling a large database.
-
-Groonga creates one or more files per table and column. If your
-database has many tables and columns, Groonga process needs to open
-many files.
-
-System limits the max number of open files per process. So you need to
-relax the limitation.
-
-Here is an expression that compute how many files are opened by
-Groonga::
-
-  3 (for DB) +
-    N tables +
-    N columns (except index clumns) +
-    (N index columns * 2) +
-    X (the number of plugins etc.)
-
-Here is an example schema::
-
-  table_create Entries TABLE_HASH_KEY ShortText
-  column_create Entries content COLUMN_SCALAR Text
-  column_create Entries n_likes COLUMN_SCALAR UInt32
-  table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
-  column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
-  column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
-
-This example opens at least 11 files::
-
-  3 +
-    2 (Entries and Terms) +
-    2 (Entries.content and Entries.n_likes) +
-    4 (Terms.entries_key_index and Terms.entries_content_index) +
-    X = 11 + X
-
-.. _tuning-memory-usage:
-
-Memory usage
-^^^^^^^^^^^^
-
-This parameter is for handling a large database.
-
-Groonga maps database files onto memory and accesses to them. Groonga
-doesn't maps unnecessary files onto memory. Groonga maps files when
-they are needed.
-
-If you access to all data in database, all database files are mapped
-onto memory. If total size of your database files is 6GiB, your
-Groonga process uses 6GiB memory.
-
-Normally, your all database files aren't mapped onto memory. But it may
-be occurred. It is an example case that you dump your database.
-
-Normally, you must have memory and swap that is larger than
-database. Linux has tuning parameter to work with less memory and swap
-than database size.
-
-.. _tuning-linux:
-
-Linux
------
-
-This section describes how to configure parameters on Linux.
-
-.. _tuning-linux-nofile:
-
-``nofile``
-^^^^^^^^^^
-
-You can relax the :ref:`tuning-max-n-open-files` parameter by creating
-a configuration file ``/etc/security/limits.d/groonga.conf`` that has
-the following content::
-
-  ${USER} soft nofile ${MAX_VALUE}
-  ${USER} hard nofile ${MAX_VALUE}
-
-If you run Groonga process by ``groonga`` user and your Groonga
-process needs to open less than 10000 files, use the following
-configuration::
-
-  groonga soft nofile 10000
-  groonga hard nofile 10000
-
-The configuration is applied after your Groonga service is restarted
-or re-login as your ``groonga`` user.
-
-.. _tuning-linux-overcommit-memory:
-
-``vm.overcommit_memory``
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-This is :ref:`tuning-memory-usage` related parameter. You can handle a
-database that is larger than your memory and swap by setting
-``vm.overcommit_memory`` kernel parameter to ``1``. ``1`` means that
-Groonga can always map database files onto memory. Groonga recommends
-the configuration.
-
-See `Linux kernel documentation about overcommit
-<https://www.kernel.org/doc/Documentation/vm/overcommit-accounting>`_
-about ``vm.overcommit_memory`` parameter details.
-
-You can set the configuration by putting a configuration file
-``/etc/sysctl.d/groonga.conf`` that has the following content::
-
-  vm.overcommit_memory = 1
-
-The configuration can be applied by restarting your system or run the
-following command::
-
-  % sudo sysctl --system
-
-.. _tuning-linux-max-map-count:
-
-``vm.max_map_count``
-^^^^^^^^^^^^^^^^^^^^
-
-This is :ref:`tuning-memory-usage` related parameter. You can handle a
-16GiB or more larger size database by increasing ``vm.max_map_count``
-kernel parameter. The parameter limits the max number of memory maps.
-
-The default value of the kernel parameter may be ``65530`` or
-``65536``.  Groonga maps 256KiB memory chunk at one time. If a
-database is larger than 16GiB, Groonga reaches the
-limitation. (``256KiB * 65536 = 16GiB``)
-
-You needs to increase the value of the kernel parameter to handle
-16GiB or more larger size database. For example, you can handle almost
-32GiB size database by ``65536 * 2 = 131072``. You can set the
-configuration by putting a configuration file
-``/etc/sysctl.d/groonga.conf`` that has the following content::
-
-  vm.max_map_count = 131072
-
-Note that your real configuration file will be the following because
-you already have ``vm.overcommit_memory`` configuration::
-
-  vm.overcommit_memory = 1
-  vm.max_map_count = 131072
-
-The configuration can be applied by restarting your system or run the
-following command::
-
-  % sudo sysctl -p
-
-FreeBSD
--------
-
-This section describes how to configure parameters on FreeBSD.
-
-.. _tuning-freebsd-maxfilesperproc:
-
-``kern.maxfileperproc``
-^^^^^^^^^^^^^^^^^^^^^^^
-
-TODO

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

@@ -1,170 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Data types
-==========
-
-Name
-----
-
-Groonga data types
-
-Description
------------
-
-Groonga identifies data types to store.
-
-A primary key of table and column value belong to some kind of data types in Groonga database. And normally, column values become in common with all records in one table.
-
-A primary key type and column type can be specified Groonga defined types, user defined types or user defined table.
-
-If you specify other table to primary key type, this table becomes subset of the table of primary key type.
-
-If you specify other table to column type, this column becomes reference key of the table of column type.
-
-Builtin types
--------------
-
-The following types are defined as builtin types.
-
-.. _builtin-type-bool:
-
-``Bool``
-^^^^^^^^
-
-Boolean type. The possible values are true and false. (default: false)
-
-To store a value by :doc:`/reference/commands/load` command, becomes false if you specify false, 0 or empty string, becomes true if you specify others.
-
-.. _builtin-type-int8:
-
-``Int8``
-^^^^^^^^
-
-Signed 8bit integer. It's -128 or more and 127 or less. (default: 0)
-
-.. _builtin-type-uint8:
-
-``UInt8``
-^^^^^^^^^
-
-Unsigned 8bit integer. Is't 0 or more and 255 or less. (default: 0)
-
-.. _builtin-type-int16:
-
-``Int16``
-^^^^^^^^^
-
-Signed 16bit integer. It's -32,768 or more and 32,767 or less. (default: 0)
-
-.. _builtin-type-uint16:
-
-``UInt16``
-^^^^^^^^^^
-
-Unsigned 16bit integer. It's 0 or more and 65,535 or less. (default: 0)
-
-.. _builtin-type-int32:
-
-``Int32``
-^^^^^^^^^
-
-Signed 32bit integer. It's -2,147,483,648 or more and 2,147,483,647 or less. (default: 0)
-
-.. _builtin-type-uint32:
-
-``UInt32``
-^^^^^^^^^^
-
-Unsigned 32bit integer. It's 0 or more and 4,294,967,295 or less. (default: 0)
-
-.. _builtin-type-int64:
-
-``Int64``
-^^^^^^^^^
-
-Signed 64bit integer. It's -9,223,372,036,854,775,808 or more and 9,223,372,036,854,775,807 or less. (default: 0)
-
-.. _builtin-type-uint64:
-
-``UInt64``
-^^^^^^^^^^
-
-Unsigned 64bit integer. It's 0 or more and 18,446,744,073,709,551,615 or less. (default: 0)
-
-.. _builtin-type-float:
-
-``Float``
-^^^^^^^^^
-
-Double-precision floating-point number of IEEE 754 as a real number. (default: 0.0)
-
-See `IEEE floating point - Wikipedia, the free encyclopedia <http://en.wikipedia.org/wiki/IEEE_floating_point>`_ or `IEEE 754: Standard for Binary Floating-Point <http://grouper.ieee.org/groups/754/>`_ for details of IEEE 754 format.
-
-.. _builtin-type-time:
-
-``Time``
-^^^^^^^^
-
-Date and Time, the number of seconds that have elapsed since 1970-01-01 00:00:00 by 64 bit signed integer. (default: 0)
-
-To store a value by :doc:`/reference/commands/load` command, specifies the number of elapsed seconds since 1970-01-01 00:00:00. To specify the detailed date and time than seconds, use the decimal.
-
-.. _builtin-type-short-text:
-
-``ShortText``
-^^^^^^^^^^^^^
-
-String of 4,095 or less bytes. (default: "")
-
-.. _builtin-type-text:
-
-``Text``
-^^^^^^^^
-
-String of 65,535 or less bytes. (default: "")
-
-.. _builtin-type-long-text:
-
-``LongText``
-^^^^^^^^^^^^
-
-String of 2,147,483,647 or less bytes. (default: "")
-
-.. _builtin-type-tokyo-geo-point:
-
-``TokyoGeoPoint``
-^^^^^^^^^^^^^^^^^
-
-旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）
-
-度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。
-
-:doc:`/reference/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。
-
-測地系の詳細については、 `測地系 - Wikipedia <http://ja.wikipedia.org/wiki/%E6%B8%AC%E5%9C%B0%E7%B3%BB>`_ を参照してください。
-
-.. _builtin-type-wgs84-geo-point:
-
-``WGS84GeoPoint``
-^^^^^^^^^^^^^^^^^
-
-世界測地系（World Geodetic System, WGS 84）による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0）
-
-度分秒形式からミリ秒形式への変換方法や :doc:`/reference/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。
-
-Limitations about types
------------------------
-
-Types that can't be specified in primary key of table
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-``Text`` and ``LongText`` can't be specified in primary key of table.
-
-ベクターとして格納できない型
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Groongaのカラムは、ある型のベクターを保存することができます。しかし、ShortText, Text, LongTextの３つの型についてはベクターとして保存したり出力したりすることはできますが、検索条件やドリルダウン条件に指定することができません。
-
-テーブル型は、ベクターとして格納することができます。よって、ShortTextのベクターを検索条件やドリルダウン条件に使用したい場合には、主キーがShortText型のテーブルを別途作成し、そのテーブルを型として利用します。

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

@@ -1,22 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Window function
-===============
-
-.. versionadded:: 6.0.3
-
-Window function can be used in :doc:`commands/select` and
-:doc:`commands/logical_select`. See
-:ref:`select-window-function-related-parameters` for details.
-
-This section describes window function and built-in window functions.
-
-TODO: Add documentations about window function.
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   window_functions/*

data/vendor/local/share/doc/groonga/en/html/_sources/reference/window_functions/record_number.txt

@@ -1,28 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``record_number``
-=================
-
-Summary
--------
-
-.. deprecated:: 7.0.0
-
-   ``record_number()`` is deprecated. Use :doc:`window_record_number`
-   instead.
-
-Syntax
-------
-::
-
- record_number()
-
-Usage
------
-
-Return value
-------------
-
-

data/vendor/local/share/doc/groonga/en/html/_sources/reference/window_functions/window_record_number.txt

@@ -1,25 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``window_record_number``
-========================
-
-Summary
--------
-
-.. versionadded:: 7.0.0
-
-Syntax
-------
-::
-
- window_record_number()
-
-Usage
------
-
-Return value
-------------
-
-

data/vendor/local/share/doc/groonga/en/html/_sources/reference/window_functions/window_sum.txt

@@ -1,25 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-``window_sum``
-==============
-
-Summary
--------
-
-.. versionadded:: 7.0.0
-
-Syntax
-------
-::
-
- window_sum()
-
-Usage
------
-
-Return value
-------------
-
-