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

data/vendor/local/share/doc/groonga/en/html/_sources/news/4.x.txt

@@ -29,7 +29,7 @@ Improvements
   groonga-httpd uses multi-process model instead of multi-threading.
 * groonga-httpd: Supported long error message over 2048 bytes.
   By this change, long error message (>2048) is not truncated.
-* groonga-httpd: Supported streaming dump functionality.
+* [:doc:`/reference/commands/dump`] Supported streaming output.
 
 Fixes
 ^^^^^

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

@@ -16,6 +16,7 @@ This section describes about command and built-in commands.
 
    command/command_version
    command/output_format
+   command/pretty_print
    command/request_id
    command/return_code
    commands/*

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

@@ -0,0 +1,45 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Pretty print
+============
+
+Summary
+-------
+
+.. versionadded:: 5.1.0
+
+Groonga supports pretty print when you choose JSON for
+:doc:`output_format`.
+
+Usage
+-----
+
+Just specify ``yes`` to ``output_pretty`` parameter::
+
+  > status --output_pretty yes
+  [
+    [
+      0,
+      1448344438.43783,
+      5.29289245605469e-05
+    ],
+    {
+      "alloc_count": 233,
+      "starttime": 1448344437,
+      "start_time": 1448344437,
+      "uptime": 1,
+      "version": "5.0.9-135-g0763d91",
+      "n_queries": 0,
+      "cache_hit_rate": 0.0,
+      "command_version": 1,
+      "default_command_version": 1,
+      "max_command_version": 2
+    }
+  ]
+
+Here is a result without ``output_pretty`` parameter::
+
+  > status
+  [[0,1448344438.43783,5.29289245605469e-05],{"alloc_count":233,"starttime":1448344437,...}]

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

@@ -76,7 +76,7 @@ The default is none. It means that the target object is database.
 Return value
 ------------
 
-::
+``lock_clear`` command returns whether lock is acquired or not::
 
  [HEADER, SUCCEEDED_OR_NOT]
 

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

@@ -0,0 +1,142 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: reindex
+
+``reindex``
+===========
+
+Summary
+-------
+
+.. versionadded:: 5.1.0
+
+``reindex`` command recreates one or more index columns.
+
+If you specify a database as target object, all index columns are
+recreated.
+
+If you specify a table as target object, all index columns in the
+table are recreated.
+
+If you specify a data column as target object, all index columns for
+the data column are recreated.
+
+If you specify an index column as target object, the index column is
+recreated.
+
+This command is a useful when your index column is broken.
+The target object is one of database, table and column.
+
+.. note::
+
+   You can't use target index columns while ``reindex`` command is
+   running. If you use the same database from multiple processes, all
+   processes except running ``reindex`` should reopen the
+   database. You can use :doc:`database_unmap` for reopening database.
+
+Syntax
+------
+
+This command takes only one optional parameter::
+
+  reindex [target_name=null]
+
+If ``target_name`` parameters is omitted, database is used for the
+target object. It means that all index columns in the database are
+recreated.
+
+Usage
+-----
+
+Here is an example to recreate all index columns in the database:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/reindex/database.log
+.. reindex
+
+Here is an example to recreate all index columns
+(``Lexicon.entry_key`` and ``Lexicon.entry_body``) in ``Lexicon``
+table:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/reindex/table.log
+.. table_create Entry TABLE_HASH_KEY ShortText
+.. column_create Entry body COLUMN_SCALAR Text
+..
+.. table_create Lexicon TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto
+.. column_create Lexicon entry_key COLUMN_INDEX|WITH_POSITION \
+..   Entry _key
+.. column_create Lexicon entry_body COLUMN_INDEX|WITH_POSITION \
+..   Entry body
+..
+.. reindex Lexicon
+
+Here is an example to recreate all index columns
+(``BigramLexicon.site_title`` and ``RegexpLexicon.site_title``) of
+``Site.title`` data column:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/reindex/data_column.log
+.. table_create Site TABLE_HASH_KEY ShortText
+.. column_create Site title COLUMN_SCALAR ShortText
+..
+.. table_create BigramLexicon TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto
+.. column_create BigramLexicon site_title COLUMN_INDEX|WITH_POSITION \
+..   Site title
+..
+.. table_create RegexpLexicon TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenRegexp \
+..   --normalizer NormalizerAuto
+.. column_create RegexpLexicon site_title COLUMN_INDEX|WITH_POSITION \
+..   Site title
+..
+.. reindex Site.title
+
+Here is an example to recreate an index column (``Timestamp.index``):
+
+.. groonga-command
+.. include:: ../../example/reference/commands/reindex/index_column.log
+.. table_create Logs TABLE_NO_KEY
+.. column_create Logs timestamp COLUMN_SCALAR Time
+..
+.. table_create Timestamp TABLE_PAT_KEY Time
+.. column_create Timestamp logs_timestamp COLUMN_INDEX  Logs timestamp
+..
+.. reindex Timestamp.logs_timestamp
+
+Parameters
+----------
+
+This section describes all parameters.
+
+``target_name``
+"""""""""""""""
+
+Specifies the name of table or column.
+
+If you don't specify it, database is used for the target object.
+
+The default is none. It means that the target object is database.
+
+Return value
+------------
+
+``reindex`` command returns whether recreation 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.

data/vendor/local/share/doc/groonga/en/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/en/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/en/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/en/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/en/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/en/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/en/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`