rroonga 2.0.7-x86-mingw32 → 2.0.8-x86-mingw32

data/vendor/local/share/doc/groonga/source/reference/command/return_code.txt

@@ -0,0 +1,110 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Return code
+===========
+
+Summary
+-------
+
+Return code is used to show whether a processing is succeeded or
+not. If the processing is not succeeded, return code shows error type.
+
+Return code is used in C API and query API. You can check return code
+via ``grn_ctx_t::rc`` in C API. You can check return code by looking
+the header element in query API. See :doc:`output_format` about the
+header element in query API.
+
+List
+----
+
+Here is a list of return codes. ``GRN_SUCCESS`` (= 0) means that the
+processing is succeeded. Return codes that have negative value show
+error type. ``GRN_END_OF_DATA`` is a special return code. It is used
+only C API. It is not showen in query API.
+
+* 0: ``GRN_SUCCESS``
+* 1: ``GRN_END_OF_DATA``
+* -1: ``GRN_UNKNOWN_ERROR``
+* -2: ``GRN_OPERATION_NOT_PERMITTED``
+* -3: ``GRN_NO_SUCH_FILE_OR_DIRECTORY``
+* -4: ``GRN_NO_SUCH_PROCESS``
+* -5: ``GRN_INTERRUPTED_FUNCTION_CALL``
+* -6: ``GRN_INPUT_OUTPUT_ERROR``
+* -7: ``GRN_NO_SUCH_DEVICE_OR_ADDRESS``
+* -8: ``GRN_ARG_LIST_TOO_LONG``
+* -9: ``GRN_EXEC_FORMAT_ERROR``
+* -10: ``GRN_BAD_FILE_DESCRIPTOR``
+* -11: ``GRN_NO_CHILD_PROCESSES``
+* -12: ``GRN_RESOURCE_TEMPORARILY_UNAVAILABLE``
+* -13: ``GRN_NOT_ENOUGH_SPACE``
+* -14: ``GRN_PERMISSION_DENIED``
+* -15: ``GRN_BAD_ADDRESS``
+* -16: ``GRN_RESOURCE_BUSY``
+* -17: ``GRN_FILE_EXISTS``
+* -18: ``GRN_IMPROPER_LINK``
+* -19: ``GRN_NO_SUCH_DEVICE``
+* -20: ``GRN_NOT_A_DIRECTORY``
+* -21: ``GRN_IS_A_DIRECTORY``
+* -22: ``GRN_INVALID_ARGUMENT``
+* -23: ``GRN_TOO_MANY_OPEN_FILES_IN_SYSTEM``
+* -24: ``GRN_TOO_MANY_OPEN_FILES``
+* -25: ``GRN_INAPPROPRIATE_I_O_CONTROL_OPERATION``
+* -26: ``GRN_FILE_TOO_LARGE``
+* -27: ``GRN_NO_SPACE_LEFT_ON_DEVICE``
+* -28: ``GRN_INVALID_SEEK``
+* -29: ``GRN_READ_ONLY_FILE_SYSTEM``
+* -30: ``GRN_TOO_MANY_LINKS``
+* -31: ``GRN_BROKEN_PIPE``
+* -32: ``GRN_DOMAIN_ERROR``
+* -33: ``GRN_RESULT_TOO_LARGE``
+* -34: ``GRN_RESOURCE_DEADLOCK_AVOIDED``
+* -35: ``GRN_NO_MEMORY_AVAILABLE``
+* -36: ``GRN_FILENAME_TOO_LONG``
+* -37: ``GRN_NO_LOCKS_AVAILABLE``
+* -38: ``GRN_FUNCTION_NOT_IMPLEMENTED``
+* -39: ``GRN_DIRECTORY_NOT_EMPTY``
+* -40: ``GRN_ILLEGAL_BYTE_SEQUENCE``
+* -41: ``GRN_SOCKET_NOT_INITIALIZED``
+* -42: ``GRN_OPERATION_WOULD_BLOCK``
+* -43: ``GRN_ADDRESS_IS_NOT_AVAILABLE``
+* -44: ``GRN_NETWORK_IS_DOWN``
+* -45: ``GRN_NO_BUFFER``
+* -46: ``GRN_SOCKET_IS_ALREADY_CONNECTED``
+* -47: ``GRN_SOCKET_IS_NOT_CONNECTED``
+* -48: ``GRN_SOCKET_IS_ALREADY_SHUTDOWNED``
+* -49: ``GRN_OPERATION_TIMEOUT``
+* -50: ``GRN_CONNECTION_REFUSED``
+* -51: ``GRN_RANGE_ERROR``
+* -52: ``GRN_TOKENIZER_ERROR``
+* -53: ``GRN_FILE_CORRUPT``
+* -54: ``GRN_INVALID_FORMAT``
+* -55: ``GRN_OBJECT_CORRUPT``
+* -56: ``GRN_TOO_MANY_SYMBOLIC_LINKS``
+* -57: ``GRN_NOT_SOCKET``
+* -58: ``GRN_OPERATION_NOT_SUPPORTED``
+* -59: ``GRN_ADDRESS_IS_IN_USE``
+* -60: ``GRN_ZLIB_ERROR``
+* -61: ``GRN_LZO_ERROR``
+* -62: ``GRN_STACK_OVER_FLOW``
+* -63: ``GRN_SYNTAX_ERROR``
+* -64: ``GRN_RETRY_MAX``
+* -65: ``GRN_INCOMPATIBLE_FILE_FORMAT``
+* -66: ``GRN_UPDATE_NOT_ALLOWED``
+* -67: ``GRN_TOO_SMALL_OFFSET``
+* -68: ``GRN_TOO_LARGE_OFFSET``
+* -69: ``GRN_TOO_SMALL_LIMIT``
+* -70: ``GRN_CAS_ERROR``
+* -71: ``GRN_UNSUPPORTED_COMMAND_VERSION``
+
+See also
+--------
+
+* :doc:`output_format` shows where return code is appeared in query
+  API response.
+* :doc:`/spec/gqtp`: GQTP protocol also uses return code as status but
+  it uses 2byte unsigned integer. So return codes that have negative
+  value are statuses that have positive value in GQTP protocol. You
+  can convert status value in GQTP protocol to return code by
+  handling it as 2byte signed integer.

data/vendor/local/share/doc/groonga/source/reference/commands/register.txt

@@ -0,0 +1,59 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_register
+
+register
+========
+
+Summary
+-------
+
+``register`` command registers a plugin. You need to register a plugin
+before you use a plugin.
+
+You need just one ``register`` command for a plugin in the same
+database because registered plugin information is written into the
+database.  When you restart your ``groonga`` process, ``groonga``
+process loads all registered plugins without ``register`` command.
+
+.. note::
+
+   Registered plugins can't be removed for now.
+
+Syntax
+------
+
+``register`` has a parameter ``path``. It is required parameter::
+
+  register path
+
+Usage
+-----
+
+Here is a sample that registers ``QueryExpanderTSV`` query expander
+that is included in
+``${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so``.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/register/query_expanders_tsv.log
+.. register query_expanders/tsv
+
+You can omit ``${PREFIX}/lib/groonga/plugins/`` and suffix (``.so``).
+They are completed automatically.
+
+You can specify absolute path such as ``register
+/usr/lib/groonga/plugins/query_expanders/tsv.so``.
+
+Return value
+------------
+
+``register`` returns ``true`` as body on success such as::
+
+  [HEADER, true]
+
+If ``register`` fails, error details are in ``HEADER``.
+
+See :doc:`/reference/command/output_format` for ``HEADER``.

data/vendor/local/share/doc/groonga/source/reference/commands/select.txt

@@ -442,6 +442,8 @@ storategy escalation is not used because the number of matched
 records (0) is larger than ``match_escalation_threshold`` (-1). So no
 more searches aren't executed. And no records are matched.
 
+.. _query-expansion:
+
 ``query_expansion``
 """""""""""""""""""
 

data/vendor/local/share/doc/groonga/source/reference/function.txt

@@ -0,0 +1,20 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Function
+========
+
+Function can be used in some commands. For example, you can use
+function in ``--filter``, ``--scorer`` and ``output_columns``
+options of :doc:`commands/select`.
+
+This section describes about function and built-in functions.
+
+TODO: Add documentations about function.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   functions/*

data/vendor/local/share/doc/groonga/source/reference/functions/geo_distance.txt

@@ -192,17 +192,11 @@ You can specify the value of ``approximate_type`` by one of the followings.
 
     There is a limitation about ``geo_distance``. ``geo_distance`` can not
     calculate the value of distance between two points across meridian,
-    euator or the date line.
+    equator or the date line if you use ``sphere`` or ``ellipsoid`` as
+    approximate type. There is not such a limitation for ``rectangle``.
     This is temporary limitation according to the implementation of groonga,
     but it will be fixed in the future release.
 
-.. note::
-
-    There is a limitation about ``geo_distance`` above notice.
-    But it relaxes the limitation if you use ``rectangle`` as approximate type.
-    You can calculate the correct distance if two point are placed at northern
-    hemisphere or southern hemisphere.
-
 ``rectangle``
 ...............
 
@@ -223,6 +217,29 @@ Here is a sample about calculating the value of distance with explicitly specifi
 
 .. include:: ../../example/reference/functions/geo_distance_distance_rectangle.log
 
+Here are samples about calculating the value of distance with explicitly specified point across meridian, equator, the date line.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/geo_distance_distance_rectangle_across_meridian.log
+.. select Geo --output_columns distance --scorer 'distance = geo_distance("175904000x8464000", "145508000x-13291000", "rectangle")'
+
+This sample shows the value of distance across meridian.
+The return value of ``geo_distance("175904000x8464000", "145508000x-13291000", "rectangle")`` is the value of distance from Paris, Flance to Madrid, Spain.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/geo_distance_distance_rectangle_across_equator.log
+.. select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "-56880000x-172310000", "rectangle")'
+
+This sample shows the value of distance across equator.
+The return value of ``geo_distance("146566000x-266422000", "-56880000x-172310000", "rectangle")`` is the value of distance from New York, The United Status to Brasillia, Brasil.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/geo_distance_distance_rectangle_across_the_date_line.log
+.. select Geo --output_columns distance --scorer 'distance = geo_distance("143660000x419009000", "135960000x-440760000", "rectangle")'
+
+This sample shows the value of distance across the date line.
+The return value of ``geo_distance("143660000x419009000", "135960000x-440760000", "rectangle")`` is the value of distance from Beijin, China to San Francisco, The United States.
+
 .. note::
 
     ``geo_distance`` uses square approximation as default. If you omit ``approximate_type``, ``geo_distance`` behaves like ``rectangle`` was specified.

data/vendor/local/share/doc/groonga/source/reference/functions/snippet_html.txt

@@ -0,0 +1,120 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: functions_snippet_html
+
+snippet_html
+============
+
+.. caution::
+
+   This feature is experimental. API will be changed.
+
+Summary
+-------
+
+``snippet_html`` extracts snippets of target text around search
+keywords (``KWIC``. ``KeyWord In Context``). The snippets are prepared
+for embedding HTML. Special characters such as ``<`` and ``>`` are
+escapsed as ``&lt;`` and ``&gt;``. Keyword is surrounded with ``<span
+class="keyword">`` and ``</span>``. For example, a snippet of ``I am a
+groonga user. <3`` for keyword ``groonga`` is ``I am a <span
+class="keyword">groonga</span> user. &lt;3``.
+
+Syntax
+------
+
+``snippet_html`` has only one parameter::
+
+  snippet_html(column)
+
+``snippet_html`` has many parameters internally but they can't be
+specified for now. You will be able to custom those parameters soon.
+
+Usage
+-----
+
+Here are a schema definition and sample data to show usage.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/snippet_html/usage_setup.log
+.. table_create Documents TABLE_NO_KEY
+.. column_create Documents content COLUMN_SCALAR Text
+.. table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText --default_tokenizer TokenBigram
+.. column_create Terms documents_content_index COLUMN_INDEX|WITH_POSITION Documents content
+.. load --table Documents
+.. [
+.. ["content"],
+.. ["Groonga is a fast and accurate full text search engine based on inverted index. One of the characteristics of groonga is that a newly registered document instantly appears in search results. Also, groonga allows updates without read locks. These characteristics result in superior performance on real-time applications."],
+.. ["Groonga is also a column-oriented database management system (DBMS). Compared with well-known row-oriented systems, such as MySQL and PostgreSQL, column-oriented systems are more suited for aggregate queries. Due to this advantage, groonga can cover weakness of row-oriented systems."]
+.. ]
+
+``snippet_html`` can be used in only ``--output_columns`` in
+:doc:`/reference/commands/select`.
+
+You need to specify ``--command_version 2`` argument explicitly
+because function call in ``--output_columns`` is experimental feature
+in groonga 2.0.9. It will be enabled by default soon.
+
+You also need to specify ``--query`` and/or ``--filter``. Keywords are
+extracted from ``--query`` and ``--filter`` arguments.
+
+The following example uses ``--query "fast performance"``. In this
+case, ``fast`` and ``performance`` are used as keywords.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/snippet_html/usage_basic.log
+.. select Documents --output_columns "snippet_html(content)" --command_version 2 --match_columns content --query "fast performance"
+
+``--query "fast performance"`` matches to only the first record's
+content. ``snippet_html(content)`` extracts two text parts that
+include the keywords ``fast`` or ``performance`` and surronds the
+keywords with ``<span class="keyword">`` and ``</span>``.
+
+The max number of text parts is 3. If there are 4 or more text parts
+that include the keywords, only the leading 3 parts are only used.
+
+The max size of a text part is 200byte. The unit is bytes not
+chracters. The size doesn't include inserted ``<span keyword="keyword">``
+and ``</span>``.
+
+Both the max number of text parts and the max size of a text part
+aren't customizable.
+
+You can specify string literal instead of column.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/snippet_html/usage_string_literal.log
+.. select Documents --output_columns 'snippet_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns content --query "fast performance"
+
+Return value
+------------
+
+``snippet_html`` returns an array of string. An element of array is a
+snippet::
+
+  [SNIPPET1, SNIPPET2, SNIPPET3]
+
+A snippet includes one or more keywords. The max byte size of a
+snippet except ``<span keyword="keyword">`` and ``</span>`` is
+200byte. The unit isn't the number of chracters.
+
+The array size is larger than or equal to 0 and less than or equal
+to 3. The max size 3 will be customizable soon.
+
+TODO
+----
+
+* Make the max number of text parts customizable.
+* Make the max size of a text part customizable.
+* Make keywords customizable.
+* Make tag that surrounds a keyword customizable.
+* Make normalization customizable.
+* Support options by object literal.
+
+See also
+--------
+
+* :doc:`/reference/commands/select`

data/vendor/local/share/doc/groonga/source/reference/indexing.txt

@@ -9,7 +9,7 @@ Indexing
 ========
 
 Groonga supports both online index construction and offline
-index construction since 1.3.1.
+index construction since 2.0.0.
 
 Online index construction
 -------------------------
@@ -25,6 +25,8 @@ tweets, news, blog posts and so on will value
 freshness. Online index construction can make fresh
 documents searchable and keep searchable while indexing.
 
+.. _offline-index-construction:
+
 Offline index construction
 --------------------------
 

data/vendor/local/share/doc/groonga/{en/html/_sources/reference/functions.txt → source/reference/query_expanders.txt}

@@ -2,11 +2,11 @@
 
 .. highlightlang:: none
 
-組み込み関数一覧
-================
+Query expanders
+===============
 
 .. toctree::
    :maxdepth: 1
    :glob:
 
-   functions/*
+   query_expanders/*

data/vendor/local/share/doc/groonga/source/reference/query_expanders/tsv.txt

@@ -0,0 +1,153 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+QueryExpanderTSV
+================
+
+Summary
+-------
+
+``QueryExpanderTSV`` is a query expander plugin that reads synonyms
+from TSV (Tab Separated Values) file. This plugin provides poor
+feature than the embedded query expansion feature. For example, it
+doesn't support word normalization. But it may be easy to use because
+you can manage your synonyms by TSV file. You can edit your synonyms
+by spreadsheet application such as Excel. With the embedded query
+expansion feature, you manage your synonyms by groonga's table.
+
+Install
+-------
+
+You need to register ``query_expanders/tsv`` as a plugin before you
+use ``QueryExpanderTSV``::
+
+  register query_expanders/tsv
+
+Usage
+-----
+
+You just add ``--query_expansion QueryExpanderTSV`` parameter to
+``select`` command::
+
+  select --query "QUERY" --query_expansion QueryExpanderTSV
+
+If ``QUERY`` has registered synonyms, they are expanded. For example,
+there are the following synonyms.
+
++----------------------------+------------------------+----------------------+
+|            word            |       synonym 1        |      synonym 2       |
++============================+========================+======================+
+|          groonga           |        groonga         |        Senna         |
++----------------------------+------------------------+----------------------+
+|          mroonga           |        mroonga         |    groonga MySQL     |
++----------------------------+------------------------+----------------------+
+
+The table means that ``synonym 1`` and ``synonym 2`` are synonyms of
+``word``. For example, ``groonga`` and ``Senna`` are synonyms of
+``groonga``. And ``mroonga`` and ``groonga MySQL`` are synonyms of
+``mroonga``.
+
+Here is an example of query expnasion that uses ``groonga`` as query::
+
+  select --query "groonga" --query_expansion QueryExpanderTSV
+
+The above command equals to the following command::
+
+  select --query "groonga OR Senna" --query_expansion QueryExpanderTSV
+
+Here is another example of query expnasion that uses ``mroonga
+search`` as query::
+
+  select --query "mroonga search" --query_expansion QueryExpanderTSV
+
+The above command equals to the following command::
+
+  select --query "(mroonga OR (groonga MySQL)) search" --query_expansion QueryExpanderTSV
+
+It is important that registered words (``groonga`` and ``mroonga``)
+are only expanded to synonyms and not registered words (``search``)
+are not expanded. Query expansion isn't occurred
+recursively. ``groonga`` is appeared in ``(mroonga OR (groonga
+MySQL))`` as query expansion result but it isn't expanded.
+
+Normally, you need to include ``word`` itself into synonyms. For
+example, ``groonga`` and ``mroonga`` are included in synonyms of
+themselves. If you want to ignore ``word`` itself, you don't include
+``word`` itself into synonyms. For example, if you want to use query
+expansion as spelling correction, you should use the following
+synonyms.
+
++----------------------------+------------------------+
+|            word            |        synonym         |
++============================+========================+
+|           gronga           |        groonga         |
++----------------------------+------------------------+
+
+``gronga`` in ``word`` has a typo. A ``o`` is missing. ``groonga`` in
+``synonym`` is the correct word.
+
+Here is an example of using query expnasion as spelling correction::
+
+  select --query "gronga" --query_expansion QueryExpanderTSV
+
+The above command equals to the following command::
+
+  select --query "groonga" --query_expansion QueryExpanderTSV
+
+The former command has a typo in ``--query`` value but the latter
+command doesn't have any typos.
+
+TSV File
+--------
+
+Synonyms are defined in TSV format file. This section describes about
+it.
+
+Location
+^^^^^^^^
+
+The file name should be ``synonyms.tsv`` and it is located at
+configuration directory. For example, ``/etc/groonga/synonyms.tsv`` is
+a TSV file location. The location is decided at build time.
+
+You can change the location by environment variable
+``GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE`` at run time::
+
+  % env GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE=/tmp/synonyms.tsv groonga
+
+With the above command, ``/tmp/synonyms.tsv`` file is used.
+
+Format
+^^^^^^
+
+You can define zero or more synonyms in a TSV file. You define a
+``word`` and ``synonyms`` pair by a line. ``word`` is expanded to
+``synonyms`` in ``--query`` value. ``Synonyms`` are combined by
+``OR``. For example, ``groonga`` and ``Senna`` synonyms are expanded
+as ``groonga OR Senna``.
+
+The first column is ``word`` and the rest columns are ``synonyms`` of
+the ``word``. Here is a sample line for ``word`` is ``groonga`` and
+``synonyms`` are ``groonga`` and ``Senna``. ``(TAB)`` means a tab
+character (``U+0009``)::
+
+  groonga(TAB)groonga(TAB)Senna
+
+Comment line is supported. Lines that start with ``#`` are ignored.
+Here is an example for comment line. ``groonga`` line is ignored as
+comment line::
+
+  #groonga(TAB)groonga(TAB)Senna
+  mroonga(TAB)mroonga(TAB)groonga MySQL
+
+Limitation
+----------
+
+You need to restart groonga to reload your synonyms. TSV file is
+loaded only at the plugin load time.
+
+See also
+--------
+
+  * :ref:`query-expansion`