rroonga 4.0.6-x64-mingw32 → 4.0.7-x64-mingw32

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

@@ -0,0 +1,39 @@
+.. -*- 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/commands/range_filter.txt

@@ -0,0 +1,28 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: range_filter
+
+``range_filter``
+===================
+
+Summary
+-------
+
+TODO: write me
+
+Syntax
+------
+
+Usage
+-----
+
+Return value
+------------
+
+See also
+--------
+
+* :doc:`/reference/commands/select`

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

@@ -135,7 +135,7 @@ range index table. Range index table needs range search support but
 Here is an example to create ``TABLE_DAT_KEY`` table:
 
 .. groonga-command
-.. include:: ../../example/reference/commands/table_create/tag_index_table_hash_key.log
+.. include:: ../../example/reference/commands/table_create/range_index_table_dat_key.log
 .. table_create Ages TABLE_DAT_KEY UInt32
 
 The ``table_create`` command creates a table that is named ``Ages``,

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

@@ -0,0 +1,109 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_table_tokenize
+
+``table_tokenize``
+==================
+
+Summary
+-------
+
+``table_tokenize`` command tokenizes text by the specified table's tokenizer.
+
+Syntax
+------
+
+``table_tokenize`` command has required parameters and optional parameters.
+``table`` and ``string`` are required parameters. Others are
+optional::
+
+  table_tokenize table
+                 string
+                 [flags=NONE]
+                 [mode=GET]
+
+Usage
+-----
+
+Here is a simple example.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_tokenize/simple_example.log
+.. register token_filters/stop_word
+.. table_create Terms TABLE_PAT_KEY ShortText   --default_tokenizer TokenBigram   --normalizer NormalizerAuto   --token_filters TokenFilterStopWord
+.. column_create Terms is_stop_word COLUMN_SCALAR Bool
+.. load --table Terms
+.. [
+.. {"_key": "and", "is_stop_word": true}
+.. ]
+.. table_tokenize Terms "Hello and Good-bye" --mode GET
+
+``Terms`` table is set ``TokenBigram`` tokenizer, ``NormalizerAuto`` normalizer,
+``TokenFilterStopWord`` token filter. It returns tokens that is
+generated by tokenizeing ``"Hello and Good-bye"`` with ``TokenBigram`` tokenizer.
+It is normalized by ``NormalizerAuto`` normalizer.
+``and`` token is removed with ``TokenFilterStopWord`` token filter.
+
+Parameters
+----------
+
+This section describes all parameters. Parameters are categorized.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are required parameters, ``table`` and ``string``.
+
+``table``
+"""""""""
+
+It specifies the lexicon table. ``table_tokenize`` command uses the
+tokenizer, the normalizer, the token filters that is set the
+lexicon table.
+
+``string``
+""""""""""
+
+It specifies any string which you want to tokenize.
+
+See :ref:`tokenize-string` option in :doc:`/reference/commands/tokenize` about details.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are optional parameters.
+
+``flags``
+"""""""""
+
+It specifies a tokenization customize options. You can specify
+multiple options separated by "``|``".
+
+The default value is ``NONE``.
+
+See :ref:`tokenize-flags` option in :doc:`/reference/commands/tokenize` about details.
+
+``mode``
+""""""""
+
+It specifies a tokenize mode.
+
+The default value is ``GET``.
+
+See :ref:`tokenize-mode` option in :doc:`/reference/commands/tokenize` about details.
+
+Return value
+------------
+
+``table_tokenize`` command returns tokenized tokens.
+
+See :ref:`tokenize-return-value` option in :doc:`/reference/commands/tokenize` about details.
+
+See also
+--------
+
+* :doc:`/reference/tokenizers`
+* :doc:`/reference/commands/tokenize`

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

@@ -0,0 +1,30 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: in_values
+
+in_values
+=========
+
+Summary
+-------
+
+TODO
+
+Syntax
+------
+
+TODO
+
+Usage
+-----
+
+Parameters
+----------
+
+Return value
+------------
+
+

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

@@ -0,0 +1,111 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: token_filters
+
+Token filters
+=============
+
+Summary
+-------
+
+Groonga has token filter module that some processes tokenized token.
+
+Token filter module can be added as a plugin.
+
+You can customize tokenized token by registering your token filters plugins to Groonga.
+
+A table can have zero or more token filters. You can attach token
+filters to a table by :ref:`table-create-token-filters` option in
+:doc:`/reference/commands/table_create`.
+
+Here is an example ``table_create`` that uses ``TokenFilterStopWord``
+token filter module:
+
+.. groonga-command
+.. include:: ../example/reference/token_filters/example-table-create.log
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto --token_filters TokenFilterStopWord
+
+Available token filters
+-----------------------
+
+Here is the list of available token filters:
+
+* ``TokenFilterStopWord``
+* ``TokenFilterStem``
+
+.. _token-filter-stop-word:
+
+``TokenFilterStopWord``
+^^^^^^^^^^^^^^^^^^^^^^^
+
+``TokenFilterStopWord`` removes stop words from tokenized token
+in searching the documents.
+
+``TokenFilterStopWord`` can specify stop word after adding the
+documents because it removes token in searching the documents.
+
+The stop word is specified ``is_stop_word`` column on lexicon table.
+
+Here is an example that uses ``TokenFilterStopWord`` token filter:
+
+.. groonga-command
+.. include:: ../example/reference/token_filters/stop_word.log
+.. register token_filters/stop_word
+.. table_create Memos TABLE_NO_KEY
+.. column_create Memos content COLUMN_SCALAR ShortText
+.. table_create Terms TABLE_PAT_KEY ShortText   --default_tokenizer TokenBigram   --normalizer NormalizerAuto   --token_filters TokenFilterStopWord
+.. column_create Terms memos_content COLUMN_INDEX|WITH_POSITION Memos content
+.. column_create Terms is_stop_word COLUMN_SCALAR Bool
+.. load --table Terms
+.. [
+.. {"_key": "and", "is_stop_word": true}
+.. ]
+.. load --table Memos
+.. [
+.. {"content": "Hello"},
+.. {"content": "Hello and Good-bye"},
+.. {"content": "Good-bye"}
+.. ]
+.. select Memos --match_columns content --query "Hello and"
+
+``and`` token is marked as stop word in ``Terms`` table.
+
+``"Hello"`` that doesn't have ``and`` in content is matched. Because
+``and`` is a stop word and ``and`` is removed from query.
+
+.. _token-filter-stem:
+
+``TokenFilterStem``
+^^^^^^^^^^^^^^^^^^^
+
+``TokenFilterStem`` stems tokenized token.
+
+Here is an example that uses ``TokenFilterStem`` token filter:
+
+.. groonga-command
+.. include:: ../example/reference/token_filters/stem.log
+.. register token_filters/stop_word
+.. register token_filters/stem
+.. table_create Memos TABLE_NO_KEY
+.. column_create Memos content COLUMN_SCALAR ShortText
+.. table_create Terms TABLE_PAT_KEY ShortText   --default_tokenizer TokenBigram   --normalizer NormalizerAuto   --token_filters TokenFilterStem
+.. column_create Terms memos_content COLUMN_INDEX|WITH_POSITION Memos content
+.. load --table Memos
+.. [
+.. {"content": "I develop Groonga"},
+.. {"content": "I'm developing Groonga"},
+.. {"content": "I developed Groonga"}
+.. ]
+.. select Memos --match_columns content --query "develops"
+
+All of ``develop``, ``developing``, ``developed`` and ``develops``
+tokens are stemmed as ``develop``. So we can find ``develop``,
+``developing`` and ``developed`` by ``develops`` query.
+
+See also
+--------
+
+* :doc:`/reference/commands/table_create`

data/vendor/local/share/doc/groonga/en/html/_sources/server/http.txt

@@ -17,10 +17,6 @@ requires just a few command line options to run.
 :doc:`http/groonga-httpd` is a `nginx <http://nginx.org/>`_ based
 implementation. It is also fast and has many HTTP features.
 
-.. note::
-
-   :doc:`http/groonga-httpd` is still experimental.
-
 .. toctree::
    :maxdepth: 2
 

data/vendor/local/share/doc/groonga/en/html/_sources/server/package.txt

@@ -9,10 +9,9 @@ The package ``groonga`` is the mininum set of fulltext search engine.
 If you want to use groonga for server use, you can install
 additional preconfigured packages.
 
-There are three packages for server use.
+There are two packages for server use.
 
 * ``groonga-httpd`` (nginx and HTTP protocol based server package)
-* ``groonga-server-http`` (simple HTTP protocol based server package)
 * ``groonga-server-gqtp`` (:doc:`/spec/gqtp` protocol based server package)
 
 There is the reason why groonga supports not only GQTP but also two HTTP server
@@ -22,15 +21,14 @@ As HTTP is matured protocol, you can take advantage of existing tool and there a
 library (See `related projects <http://groonga.org/related-projects.html>`_ for details).
 If you use ``groonga-httpd`` package, you can also take benefits of nginx functionality.
 
-We recommend to use ``groonga-server-http`` at first, then if you want to use more 
-fullfilling functionality, use ``groonga-httpd`` package. If you have performance issues which
-is derived from protocol overheads, consider to use ``groonga-server-gqtp``.
+We recommend to use ``groonga-httpd`` at first, because it provides fullfilling server functionality.
+If you have performance issues which is derived from protocol overheads, consider to use ``groonga-server-gqtp``.
 
  .. note::
 
-   There is a conflict between ``groonga-httpd`` and ``groonga-server-http``
-   package because of port number.
-   See :doc:`/server/http/comparison` if you want to know which package meets your demands.
+   In the previous versions, there is a ``groonga-server-http`` package (simple HTTP protocol
+   based server package). It is now marked as obsolete, please use ``groonga-httpd`` packages
+   instead. ``groonga-server-http`` package became a transitional package for ``groonga-httpd``.
 
 groonga-httpd
 -------------
@@ -86,120 +84,126 @@ Restarting groonga HTTP server(Fedora)::
 
   % sudo systemctl restart groonga-httpd
 
-groonga-server-http
+groonga-server-gqtp
 -------------------
 
-``groonga-server-http`` is a simple HTTP protocol based server package.
-
-Preconfigured setting:
+``groonga-server-gqtp`` is a :doc:`/spec/gqtp` protocol based server package.
 
 +--------------------+---------------------------------------+
 | Item               | Default value                         |
 +====================+=======================================+
-| Port number        | 10041                                 |
+| Port number        | 10043                                 |
 +--------------------+---------------------------------------+
-| :ref:`process-log` | /var/log/groonga/groonga-http.log     |
+| :ref:`process-log` | /var/log/groonga/groonga-gqtp.log     |
 +--------------------+---------------------------------------+
-| :ref:`query-log`   | /var/log/groonga/http-query.log       |
+| :ref:`query-log`   | /var/log/groonga/gqtp-query.log       |
 +--------------------+---------------------------------------+
 | Database           | /var/lib/groonga/db/*                 |
 +--------------------+---------------------------------------+
 
 Configuration file for server setting (Debian/Ubuntu)::
 
-  /etc/default/groonga/groonga-server-http
+  /etc/default/groonga/groonga-server-gqtp
 
 Configuration file for server setting (CentOS)::
 
-  /etc/sysconfig/groonga-server-http
+  /etc/sysconfig/groonga-server-gqtp
 
-Start HTTP server
+Start GQTP server
 ^^^^^^^^^^^^^^^^^
 
-Starting groonga HTTP server(Debian/Ubuntu/CentOS)::
+Starting groonga GQTP server(Debian/Ubuntu/CentOS)::
 
-  % sudo service groonga-server-http start
+  % sudo service groonga-server-gqtp start
  
-Starting groonga HTTP server(Fedora)::
+Starting groonga GQTP server(Fedora)::
 
-  % sudo systemctl start groonga-server-http
- 
-Stop HTTP server
+  % sudo systemctl start groonga-server-gqtp
+
+Stop GQTP server
 ^^^^^^^^^^^^^^^^
 
-Stopping groonga HTTP server(Debian/Ubuntu/CentOS)::
+Stopping groonga GQTP server(Debian/Ubuntu/CentOS)::
 
   % sudo service groonga-server-http stop
  
-Stopping groonga HTTP server(Fedora)::
+Stopping groonga GQTP server(Fedora)::
 
-  % sudo systemctl stop groonga-server-http
+  % sudo systemctl stop groonga-server-gqtp
 
-Restart HTTP server
+Restart GQTP server
 ^^^^^^^^^^^^^^^^^^^
 
 Restarting groonga HTTP server(Debian/Ubuntu/CentOS)::
 
-  % sudo service groonga-server-http restart
+  % sudo service groonga-server-gqtp restart
  
 Restarting groonga HTTP server(Fedora)::
 
-  % sudo systemctl restart groonga-server-http
+  % sudo systemctl restart groonga-server-gqtp
 
-groonga-server-gqtp
+groonga-server-http
 -------------------
 
-``groonga-server-gqtp`` is a :doc:`/spec/gqtp` protocol based server package.
+``groonga-server-http`` is a simple HTTP protocol based server package.
+
+ .. note::
+
+   ``groonga-server-http`` package is the transitional package since Groonga 4.0.8.
+   Please use ``groonga-httpd`` instead.
+
+Preconfigured setting:
 
 +--------------------+---------------------------------------+
 | Item               | Default value                         |
 +====================+=======================================+
-| Port number        | 10043                                 |
+| Port number        | 10041                                 |
 +--------------------+---------------------------------------+
-| :ref:`process-log` | /var/log/groonga/groonga-gqtp.log     |
+| :ref:`process-log` | /var/log/groonga/groonga-http.log     |
 +--------------------+---------------------------------------+
-| :ref:`query-log`   | /var/log/groonga/gqtp-query.log       |
+| :ref:`query-log`   | /var/log/groonga/http-query.log       |
 +--------------------+---------------------------------------+
 | Database           | /var/lib/groonga/db/*                 |
 +--------------------+---------------------------------------+
 
 Configuration file for server setting (Debian/Ubuntu)::
 
-  /etc/default/groonga/groonga-server-gqtp
+  /etc/default/groonga/groonga-server-http
 
 Configuration file for server setting (CentOS)::
 
-  /etc/sysconfig/groonga-server-gqtp
+  /etc/sysconfig/groonga-server-http
 
-Start GQTP server
+Start HTTP server
 ^^^^^^^^^^^^^^^^^
 
-Starting groonga GQTP server(Debian/Ubuntu/CentOS)::
+Starting groonga HTTP server(Debian/Ubuntu/CentOS)::
 
-  % sudo service groonga-server-gqtp start
+  % sudo service groonga-server-http start
  
-Starting groonga GQTP server(Fedora)::
-
-  % sudo systemctl start groonga-server-gqtp
+Starting groonga HTTP server(Fedora)::
 
-Stop GQTP server
+  % sudo systemctl start groonga-server-http
+ 
+Stop HTTP server
 ^^^^^^^^^^^^^^^^
 
-Stopping groonga GQTP server(Debian/Ubuntu/CentOS)::
+Stopping groonga HTTP server(Debian/Ubuntu/CentOS)::
 
   % sudo service groonga-server-http stop
  
-Stopping groonga GQTP server(Fedora)::
+Stopping groonga HTTP server(Fedora)::
 
-  % sudo systemctl stop groonga-server-gqtp
+  % sudo systemctl stop groonga-server-http
 
-Restart GQTP server
+Restart HTTP server
 ^^^^^^^^^^^^^^^^^^^
 
 Restarting groonga HTTP server(Debian/Ubuntu/CentOS)::
 
-  % sudo service groonga-server-gqtp restart
+  % sudo service groonga-server-http restart
  
 Restarting groonga HTTP server(Fedora)::
 
-  % sudo systemctl restart groonga-server-gqtp
+  % sudo systemctl restart groonga-server-http
+