rroonga 5.0.9-x86-mingw32 → 5.1.1-x86-mingw32

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/between.txt

@@ -3,10 +3,10 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. database: between
+.. database: functions_between
 
-between
-=======
+``between``
+===========
 
 Summary
 -------
@@ -25,23 +25,10 @@ Syntax
 Usage
 -----
 
-Here are a schema definition and sample data to show usage.::
-
-  table_create Users TABLE_HASH_KEY ShortText
-  column_create Users age COLUMN_SCALAR Int32
-  table_create Ages TABLE_HASH_KEY Int32
-  column_create Ages user_age COLUMN_INDEX Users age
-  load --table Users
-  [
-  {"_key": "Alice",  "age": 12},
-  {"_key": "Bob",    "age": 13},
-  {"_key": "Calros", "age": 15},
-  {"_key": "Dave",   "age": 16},
-  {"_key": "Eric",   "age": 20}
-  {"_key": "Frank",  "age": 21}
-  ]
- 
+Here are a schema definition and sample data to show usage:
+
 .. groonga-command
+.. include:: ../../example/reference/functions/between/usage_setup.log
 .. table_create Users TABLE_HASH_KEY ShortText
 .. column_create Users age COLUMN_SCALAR Int32
 .. table_create Ages TABLE_HASH_KEY Int32
@@ -88,25 +75,25 @@ There are five required parameters, ``column_or_value``, and ``min``, ``min_bord
 Specifies a column of the table or the value.
 
 ``min``
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^
 
 Specifies the minimal border value of the range.
 You can control the behavior that the value of ``max`` is included or excluded by ``max_border`` parameter.
 
 ``min_border``
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^
 
 Specifies whether the specified range contains the value of ``min`` or not.
 The value of ``min_border`` are either "include" or "exclude". If it is "include", ``min`` value is included. If it is "exclude", ``min`` value is not included.
 
 ``max``
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^
 
 Specifies the maximum border value of the range.
 You can control the behavior that the value of ``max`` is included or excluded by ``max_border`` parameter.
 
 ``max_border``
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^
 
 Specifies whether the specified range contains the value of ``max`` or not.
 The value of ``max_border`` are either "include" or "exclude". If it is "include", ``max`` value is included. If it is "exclude", ``max`` value is not included.

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/geo_distance.txt

@@ -3,11 +3,11 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. database: geo_distance
+.. database: functions_geo_distance
 
 
-geo_distance
-============
+``geo_distance``
+================
 
 Summary
 -------
@@ -272,7 +272,7 @@ Here is a sample about calculating the value of distance with column value.
 .. select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "sphere")'
 
 ``ellipsoid``
-...............
+.............
 
 This parameter require to approximate the geographical features
 by ellipsoid approximation for calculating the distance.

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/highlight_full.txt

@@ -5,8 +5,8 @@
 .. groonga-command
 .. database: functions_highlight_full
 
-highlight_full
-==============
+``highlight_full``
+==================
 
 .. caution::
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/highlight_html.txt

@@ -5,8 +5,8 @@
 .. groonga-command
 .. database: functions_highlight_html
 
-highlight_html
-==============
+``highlight_html``
+==================
 
 .. caution::
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/html_untag.txt

@@ -5,8 +5,8 @@
 .. groonga-command
 .. database: functions_html_untag
 
-html_untag
-==========
+``html_untag``
+==============
 
 Summary
 -------

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

@@ -3,10 +3,10 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. database: in_values
+.. database: functions_in_values
 
-in_values
-=========
+``in_values``
+=============
 
 Summary
 -------

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/prefix_rk_search.txt

@@ -0,0 +1,158 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: functions_prefix_rk_search
+
+``prefix_rk_search()``
+======================
+
+Summary
+-------
+
+``prefix_rk_search()`` selects records by
+:doc:`/reference/operations/prefix_rk_search`.
+
+You need to create :ref:`table-pat-key` table for prefix RK search.
+
+You can't use ``prefix_rk_search()`` for sequential scan. It's a
+selector only procedure.
+
+Syntax
+------
+
+``prefix_rk_search()`` requires two arguments. They are ``column`` and
+``query``::
+
+  prefix_rk_search(column, query)
+
+``column`` must be ``_key`` for now.
+
+``query`` must be string.
+
+Usage
+-----
+
+Here are a schema definition and sample data to show usage:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_setup.log
+.. table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
+.. load --table Readings
+.. [
+.. {"_key": "ニホン"},
+.. {"_key": "ニッポン"},
+.. {"_key": "ローマジ"}
+.. ]
+
+Here is the simple usage of ``prefix_rk_search()`` function which
+selects ``ニホン`` and ``ニッポン`` by ``ni``:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_simple.log
+.. select Readings --filter 'prefix_rk_search(_key, "ni")'
+
+You can implement :doc:`/reference/suggest/completion` like feature by
+combining :doc:`sub_filter`.
+
+Create a table that has candidates of completion as records. Each
+records have zero or more readings. They are stored into ``Readings``
+table. Don't forget define an index column for ``Items.readings`` in
+``Readings`` table. The index column is needed for :doc:`sub_filter`:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_setup_completion.log
+.. table_create Items TABLE_HASH_KEY ShortText
+.. column_create Items readings COLUMN_VECTOR Readings
+..
+.. column_create Readings items_index COLUMN_INDEX Items readings
+..
+.. load --table Items
+.. [
+.. {"_key": "日本",     "readings": ["ニホン", "ニッポン"]},
+.. {"_key": "ローマ字", "readings": ["ローマジ"]},
+.. {"_key": "漢字",     "readings": ["カンジ"]}
+.. ]
+
+You can find ``日本`` record in ``Items`` table by ``niho``. Because
+prefix RK search with ``niho`` selects ``ニホン`` reading and ``ニホン``
+reading is one of readings of ``日本`` record:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_prefix_rk_only_completion.log
+.. select Items \
+..  --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")")'
+
+You need to combine :ref:`script-syntax-prefix-search-operator` to
+support no reading completion targets.
+
+Add one no reading completion target:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_add_no_reading_completion_target.log
+.. load --table Items
+.. [
+.. {"_key": "nihon", "readings": []}
+.. ]
+
+Combine :ref:`script-syntax-prefix-search-operator` to
+support no reading completion targets:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_prefix_search_combined_completion.log
+.. select Items \
+..  --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")") || _key @^ "niho"'
+
+Normally, you want to use case insensitive search for completion. Use
+``--normalizer NormalizerAuto`` and ``label`` column for the case:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_setup_loose_completion.log
+.. table_create LooseItems TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
+.. column_create LooseItems label COLUMN_SCALAR ShortText
+.. column_create LooseItems readings COLUMN_VECTOR Readings
+..
+.. column_create Readings loose_items_index COLUMN_INDEX LooseItems readings
+..
+.. load --table LooseItems
+.. [
+.. {"_key": "日本",     "label": "日本",     "readings": ["ニホン", "ニッポン"]},
+.. {"_key": "ローマ字", "label": "ローマ字", "readings": ["ローマジ"]},
+.. {"_key": "漢字",     "label": "漢字",     "readings": ["カンジ"]},
+.. {"_key": "Nihon",    "label": "日本",     "readings": []}
+.. ]
+
+Use ``LooseItems.label`` for display:
+
+.. groonga-command
+.. include:: ../../example/reference/functions/prefix_rk_search/usage_loose_completion.log
+.. select LooseItems \
+..  --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"nIhO\\")") || _key @^ "nIhO"' \
+..  --output_columns '_key,label'
+
+Parameters
+----------
+
+There are two required parameter, ``column`` and ``query``.
+
+``column``
+^^^^^^^^^^
+
+Always specifies ``_key`` for now.
+
+``query``
+^^^^^^^^^
+
+Specifies a query in romaji, katakana or hiragana as string.
+
+Return value
+------------
+
+``prefix_rk_search()`` function returns matched records.
+
+See also
+--------
+
+* :doc:`/reference/operations/prefix_rk_search`
+* :doc:`/reference/functions/sub_filter`

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/query.txt

@@ -5,8 +5,8 @@
 .. groonga-command
 .. database: functions_query
 
-query
-=====
+``query``
+=========
 
 Summary
 -------

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/snippet_html.txt

@@ -5,8 +5,8 @@
 .. groonga-command
 .. database: functions_snippet_html
 
-snippet_html
-============
+``snippet_html``
+================
 
 .. caution::
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/sub_filter.txt

@@ -5,8 +5,8 @@
 .. groonga-command
 .. database: functions_sub_filter
 
-sub_filter
-==========
+``sub_filter``
+==============
 
 Summary
 -------

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/functions/vector_size.txt

@@ -5,8 +5,8 @@
 .. groonga-command
 .. database: vector_size
 
-vector_size
-===========
+``vector_size``
+===============
 
 Summary
 -------
@@ -66,7 +66,7 @@ Parameters
 There is one required parameter, ``target``.
 
 ``target``
-^^^^^^^^^^^^^^^^
+^^^^^^^^^^
 
 Specifies a vector column of table that is specified by ``table`` parameter in ``select``.
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/operations.txt

@@ -10,6 +10,7 @@ Groonga has the multiple search operations. This section describes
 about search operations.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+   :glob:
 
-   operations/geolocation_search
+   operations/*

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/operations/geolocation_search.txt

@@ -1,9 +1,8 @@
 .. -*- rst -*-
-.. Groonga Project
 
 .. highlightlang:: none
 
-Geolocation Search
+Geolocation search
 ==================
 
 Groonga supports geolocation search. It uses index for

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/operations/prefix_rk_search.txt

@@ -0,0 +1,76 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: operations_prefix_rk_search
+
+Prefix RK search
+================
+
+Summary
+-------
+
+Groonga supports prefix RK search. RK means Romaji and Kana (reading).
+Prefix RK search can find registered text in katakana by query in
+romaji, hiragana or katakana. Found registered texts are started with
+query.
+
+Prefix RK search is useful for completing Japanese text. Because
+romaji is widely used to input Japanese on computer. See also
+`Japanese input methods on Wikipedia
+<https://en.wikipedia.org/wiki/Japanese_input_methods>`_.
+
+If users can search Japanese text in romaji, users doesn't need to
+convert romaji to hiragana, katakana or kanji by themselves. For
+example, if you register a reading for "日本" as "ニホン", users can
+find "日本" by "ni", "に" or "二".
+
+The feature is helpful because it reduces one or more operations of
+users.
+
+This feature is used in :doc:`/reference/suggest/completion`.
+
+You can use this feature in :ref:`select-filter` by
+:doc:`/reference/functions/prefix_rk_search`.
+
+Usage
+-----
+
+You need :ref:`table-pat-key` table for using prefix RK search.
+
+You need to put reading in katakana to ``TABLE_PAT_KEY`` as key:
+
+.. groonga-command
+.. include:: ../../example/reference/operations/prefix_rk_search/usage_register_kana.log
+.. table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
+.. load --table Readings
+.. [
+.. {"_key": "ニホン"},
+.. {"_key": "ニッポン"},
+.. {"_key": "ローマジ"}
+.. ]
+
+You can finds ``ニホン`` and ``ニッポン`` by prefix RK search with
+``ni`` as query from the ``Readings`` table.
+
+You can finds ``ローマジ`` by prefix RK search with ``r`` as query
+from the ``Readings`` table.
+
+How to convert romaji to reading
+--------------------------------
+
+Prefix RK search is based on JIS X 4063:2000 specification.
+
+The specification was obsoleted. See `ローマ字入力 on Japanese
+Wikipedia
+<https://ja.wikipedia.org/wiki/%E3%83%AD%E3%83%BC%E3%83%9E%E5%AD%97%E5%85%A5%E5%8A%9B>`_
+for JIS X 4063:2000.
+
+Normally, you can get converted results as expected.
+
+See also
+--------
+
+  * :doc:`/reference/suggest/completion`
+  * :doc:`/reference/functions/prefix_rk_search`