rroonga 5.0.0-x64-mingw32 → 5.0.1-x64-mingw32

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

@@ -7,6 +7,200 @@
 News
 ====
 
+.. _release-5-0-2:
+
+Release 5.0.2 - 2015/03/31
+--------------------------
+
+It's a bug fix release of 5.0.1.
+
+Improvements
+^^^^^^^^^^^^
+
+* Supported MessagePack 1.0.1. [Reported by Hiroshi Hatake]
+* [logical_range_filter] Disabled range index by default. It's enabled
+  when you set the enviromnent variable ``GRN_LOGICAL_RANGE_FILTER_ENABLED``
+  to ``yes``.
+
+Fixes
+^^^^^
+
+* Fixed a regression bug that JSONP doesn't work. It was introduced
+  in Groonga 4.1.1.
+* [windows] Fixed a bug that crash on x86 for Groonga 5.0.1.
+  [groonga-dev,03131] [Reported by Atsushi Shinoda]
+* Fixed a crash bug that libedit is not properly initialized. The
+  problem is fixed in the environment such as CentOS 7.
+
+Thanks
+^^^^^^
+
+* Atsushi Shinoda
+* Hiroshi Hatake
+
+.. _release-5-0-1:
+
+Release 5.0.1 - 2015/03/29
+--------------------------
+
+Improvements
+^^^^^^^^^^^^
+
+* [:doc:`/reference/commands/logical_range_filter`] Supported filter
+  and sort.
+* Supported range search by multiple column index.
+* Added API :doc:`/reference/api/overview` document for users who want
+  to use Groonga as library.
+* [incompatible] Changed internal type of ``_score`` to floating point
+  number from 32bit integer number. This is incompatible change for DB
+  API users. This *isn't* incompatible change for query API users. It
+  means that users who just use :doc:`/reference/commands/select`
+  aren't affected. Use the following code that works with both older
+  and newer Groonga:
+
+  .. code-block:: c
+
+     grn_obj *score;
+     double score_value;
+
+     if (score->header.domain == GRN_DB_FLOAT) {
+       score_value = GRN_FLOAT_VALUE(score);
+     } else {
+       score_value = (double)GRN_INT32_VALUE_FLOAT_VALUE(score);
+     }
+
+* [:doc:`/reference/commands/select`] Added more strict check for
+  invalid drilldown parameter.
+* Added :c:func:`grn_ctx_get_all_tables()`. [Suggested by Masatoshi
+  Teruya]
+* Supported to customize score function. See :doc:`/reference/scorer`
+  for details.
+* [incompatible] Custom score function feature introduced API and ABI
+  incompatibilities in DB API layer. If you're using
+  :c:type:`grn_search_optarg`, please check that your code initializes
+  your :c:type:`grn_search_optarg` by ``0`` like the following:
+
+  .. code-block:: c
+
+     grn_search_optarg options;
+     memset(&options, 0, sizeof(grn_search_optarg));
+
+  If your code do the above thing, your code is API compatible and ABI
+  incompatible. You just need to rebuild your code without
+  modification.
+
+  If your code doesn't the above thing, you need to added the above
+  thing to your code.
+
+* Added the following predicates that check :c:type:`grn_obj` type to
+  DB API:
+
+  * :c:func:`grn_obj_is_table()`
+  * :c:func:`grn_obj_is_proc_proc()`
+  * :c:func:`grn_obj_is_function_proc()`
+  * :c:func:`grn_obj_is_selector_proc()`
+  * :c:func:`grn_obj_is_scorer_proc()`
+
+* [experimental] Supported skipping posting list when searching
+  popular term and rare term at the same time. It will improve
+  performance. Set ``GRN_II_CURSOR_SET_MIN_ENABLE`` environment
+  variable to ``1`` to enable the feature. The feature is disabled by
+  default.
+* [doc] Added :doc:`/reference/functions/in_values` document.
+* [doc] Added :doc:`/reference/commands/logical_count` document.
+* [mruby] Implemented custom ``#inspect`` method. Is is useful for
+  debugging.
+* Added :doc:`/reference/scorers/scorer_tf_at_most` scorer. It
+  limits not to exceed specified score regardless of term frequency.
+* [mruby] Supported estimating matched records for selecting index
+  search or sequential search.
+* Added the following functions to estimate size by index:
+
+  * :c:func:`grn_expr_estimate_size()`
+  * :c:func:`grn_ii_estimate_size_for_query()`
+  * :c:func:`grn_ii_estimate_size_for_lexicon_cursor()`
+
+* Added missing :ref:`normalizer-auto` availability check. [GitHub#283]
+  [Reported by Tasuku SUENAGA]
+* Dropped Visual Studio 2010 support.
+* [experimental][mecab] Supported chunked tokenization. This feature
+  is a workaround for MeCab's "too long sentense" error.  Specify
+  ``yes`` to ``GRN_MECAB_CHUNKED_TOKENIZE_ENABLED`` environment
+  variable to enable it. By this configuration, Groonga splits a long
+  text (8192 bytes over text by default) into small chunks and passes
+  each chunk to MeCab. By this process, the above error isn't
+  occurred. Additionally, you can customize chunk threshold bytes by
+  ``GRN_MECAB_CHUNK_SIZE_THRESHOLD`` environment variable. Note that
+  ``,``, ``.``, ``!``, ``?``, ``U+3001 IDEOGRAPHIC COMMA``, ``U+3002
+  IDEOGRAPHIC FULL STOP``, ``U+FF01 FULLWIDTH EXCLAMATION MARK`` and
+  ``U+FF1F FULLWIDTH QUESTION MARK`` are treated as chunk delimiter
+  characters.
+* Supported ``--pid-file`` in server mode of
+  :doc:`/reference/executables/groonga`.
+* [groonga-httpd] Supported graceful stop to clean Groonga. It doesn't
+  terminate the open connections immediately.
+* [experimental] Supported regular expression. See
+  :doc:`/reference/regular_expression` to know about how to use regular
+  expression.
+* [experimental] Added :doc:`/reference/commands/plugin_unregister`
+  command.
+* [http][:doc:`/reference/commands/load`] Added "," as chunk separator
+  in POST data. It decreases internal buffer size and improves load
+  time when POST data don't include any new line.
+* [doc] Added :doc:`/reference/tokenizers` document.
+* Improved POSIX.2 compatibility by using ``.`` as bash's "source"
+  command replacement. [GitHub#317] [Patch by Jun Kuriyama]
+* [windows] Changed to the default IO version 1. It reduces disk usage
+  on Windows. [groonga-dev,03118] [Tested by ongaeshi]
+* [httpd] Updated bundled nginx version to the latest mainline
+  (1.7.11).
+* Changed mime-type for TSV output to ``text/tab-separated-values``
+  from ``text/plain``.
+* [:ref:`token-filter-stop-word`] Supported
+  :ref:`offline-index-construction`. [GitHub#296] [Patch by Naoya
+  Murakami]
+
+Fixes
+^^^^^
+
+* Fixed not to use obsolete ``--address`` parameter in the default
+  groonga.conf. ``--bind-address`` is used instead.  [Groonga-talk]
+  [Reported by Dewangga]
+* [:doc:`/reference/commands/truncate`] Fixed a bug that
+  :ref:`table-no-key` table can't be truncated.
+* [mecab] Reduced needless logs for "empty token" and "ignore empty
+  token".
+* Fixed a bug that wrong section in index is used. It means that wrong
+  search result is returned. If you satisfy all of the following
+  conditions, this bug is occurred:
+
+  * Multiple indexes are available.
+  * The first defined index or the last defined index are
+    multi-column indexes.
+  * When both of the first defined index and the last defined index are
+    multi-column indexes, source column orders are different in them.
+
+* Fixed a bug that passing Groonga command line to
+  :doc:`/reference/executables/groonga` from shell command line style
+  usage always returns ``0`` as exit code. For example, ``groonga
+  DB_PATH nonexistent_command`` always returned ``0`` as exist code.
+* Fixed a bug that plugin path may be broken when two or more plugins
+  registered. [Reported by Naoya Murakami]
+* Fixed a bug that ``Lexicon.index.source_column_name`` style in
+  :ref:`select-match-columns` doesn't work when source
+  column specified by ``source_column_name`` has two or more
+  indexes. [Reported by Naoya Murakami]
+
+Thanks
+^^^^^^
+
+* Masatoshi Teruya
+* Tasuku SUENAGA
+* Dewangga
+* Jun Kuriyama
+* ongaeshi
+* Naoya Murakami
+
 .. _release-5-0-0:
 
 Release 5.0.0 - 2015/02/09

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

@@ -120,6 +120,48 @@ Reference
 
    :param id: 検索しようとするオブジェクトのidを指定します。
 
+.. c:function:: grn_rc grn_ctx_get_all_tables(grn_ctx *ctx, grn_obj *tables_buffer)
+
+   It pushes all tables in the database of ``ctx`` into
+   ``tables_buffer``. ``tables_buffer`` should be initialized as
+   ``GRN_PVECTOR``. You can use ``GRN_PTR_INIT()`` with
+   ``GRN_OBJ_VECTOR`` flags to initialize ``tables_buffer``.
+
+   Here is an example:
+
+   .. code-block :: c
+
+      grn_rc rc;
+      grn_obj tables;
+      int i;
+      int n_tables;
+
+      GRN_PTR_INIT(&tables, GRN_OBJ_VECTOR, GRN_ID_NIL);
+      rc = grn_ctx_get_all_tables(ctx, &tables);
+      if (rc != GRN_SUCCESS) {
+        GRN_OBJ_FIN(ctx, &tables);
+        /* Handle error. */
+        return;
+      }
+
+      n_tables = GRN_BULK_VSIZE(&tables) / sizeof(grn_obj *);
+      for (i = 0; i < n_tables; i++) {
+        grn_obj *table = GRN_PTR_VALUE_AT(&tables, i);
+        /* Use table. */
+      }
+
+      /* Free resources. */
+      for (i = 0; i < n_tables; i++) {
+        grn_obj *table = GRN_PTR_VALUE_AT(&tables, i);
+        grn_obj_unlink(ctx, table);
+      }
+      GRN_OBJ_FIN(ctx, &tables);
+
+
+   :param ctx: The context object.
+   :param table_buffer: The output buffer to store tables.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
 .. c:function:: grn_content_type grn_ctx_get_output_type(grn_ctx *ctx)
 
    Gets the current output type of the context.

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

@@ -0,0 +1,54 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Overview
+========
+
+Summary
+-------
+
+You can use Groonga as a library. You need to use the following APIs to
+initialize and finalize Groonga.
+
+:c:func:`grn_init()` initializes Groonga.
+In contrast, :c:func:`grn_fin()` finalizes Groonga.
+
+You must call :c:func:`grn_init()` only once before you use APIs which
+are provided by Groonga. You must call :c:func:`grn_fin()` only once
+after you finish to use APIs which are provided by Groonga.
+
+Example
+-------
+
+Here is an example that uses Groonga as a full-text search library.
+
+.. code-block :: c
+
+   grn_rc rc;
+   /* It initializes resources used by Groonga. */
+   rc = grn_init();
+   if (rc != GRN_SUCCESS) {
+     return EXIT_FAILURE;
+   }
+   /* Some Groonga API calling codes... */
+   /* It releases resources used by Groonga. */
+   grn_fin();
+   return EXIT_SUCCESS;
+
+Reference
+---------
+
+.. c:function:: grn_rc grn_init(void)
+
+  ``grn_init()`` initializes resources that are used by Groonga. You
+  must call it just once before you call other Groonga APIs.
+
+  :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+
+.. c:function:: grn_rc grn_fin(void)
+
+  ``grn_fin()`` releases resources that are used by Groonga. You can't
+  call other Groonga APIs after you call ``grn_fin()``.
+
+  :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.

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

@@ -12,4 +12,7 @@ describes APIs that are provided by groonga.
    :maxdepth: 1
    :glob:
 
+   api/overview
+   api/global_configurations
+   api/plugin
    api/*

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

@@ -59,7 +59,7 @@ This section describes all parameters.
 ``max``
 """""""
 
-It specifies the max number of query cache entries as a number.
+Specifies the max number of query cache entries as a number.
 
 If ``max`` parameter isn't specified, the current max number of query
 cache entries isn't changed. ``cache_limit`` just returns the current

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

@@ -61,9 +61,9 @@ Parameters
   There are two flags to compress the value of column, but you can't specify these flags for now because there are memory leaks issue `GitHub#6 <https://github.com/groonga/groonga/issues/6>`_ when refers the value of column. This issue occurs both of them (zlib and lzo).
 
   16, ``COMPRESS_ZLIB``
-    Reserved. Compress the value of column by using zlib. This flag is disabled feature even if you build groonga with ``--with-zlib``.
+    Compress the value of column by using zlib. This flag is enabled when you build Groonga with ``--with-zlib``.
   32, ``COMPRESS_LZO``
-    Reserved. Compress the value of column by using lzo. This flag is disabled feature even if you build groonga with ``--with-lzo``.
+    Compress the value of column by using lzo. This flag is enabled when you build Groonga with ``--with-lzo``.
 
   インデックス型のカラムについては、flagsの値に以下の値を加えることによって、追加の属
   性を指定することができます。

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

@@ -46,7 +46,7 @@ All parameters are required.
 ``table``
 """""""""
 
-It specifies the name of table to be listed columns.
+Specifies the name of table to be listed columns.
 
 Return value
 ------------

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

@@ -69,17 +69,17 @@ All parameters are required.
 ``table``
 """""""""
 
-It specifies the name of table that has the column to be renamed.
+Specifies the name of table that has the column to be renamed.
 
 ``name``
 """"""""
 
-It specifies the column name to be renamed.
+Specifies the column name to be renamed.
 
 ``new_name``
 """"""""""""
 
-It specifies the new column name.
+Specifies the new column name.
 
 
 Return value

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

@@ -83,20 +83,20 @@ Parameters
 
 ``table``
 
-  It specifies the name of table to delete the records.
+  Specifies the name of table to delete the records.
 
 ``key``
 
-  It specifies the key of record to delete. If you use the table with TABLE_NO_KEY, the key is just ignored.
+  Specifies the key of record to delete. If you use the table with TABLE_NO_KEY, the key is just ignored.
   (Use ``id`` parameter in such a case)
 
 ``id``
 
-  It specifies the id of record to delete. If you specify ``id`` parameter, you must not specify ``key`` parameter.
+  Specifies the id of record to delete. If you specify ``id`` parameter, you must not specify ``key`` parameter.
 
 ``filter``
 
-  It specifies the expression of grn_expr to identify the record. If you specify ``filter`` parameter,
+  Specifies the expression of grn_expr to identify the record. If you specify ``filter`` parameter,
   you must not specify ``key`` and ``id`` parameter.
 
 Return value

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

@@ -27,7 +27,7 @@ This section describes all parameters.
 
 ``values``
 
-  It specifies values loaded to records.
+  Specifies values loaded to records.
   Values should satisfy ``input_type`` format.
   If you specify "json" as ``input_type``, you can choose a format from below:
 
@@ -48,15 +48,15 @@ This section describes all parameters.
 
 ``table``
 
-  It specifies a table name you want to add records.
+  Specifies a table name you want to add records.
 
 ``columns``
 
-  It specifies column names in added records with comma separations.
+  Specifies column names in added records with comma separations.
 
 ``ifexists``
 
-  It specifies executed ``grn_expr`` string when the same primary key
+  Specifies executed ``grn_expr`` string when the same primary key
   as added records already exists in your table.
   If ``ifexists`` specifies ``grn_expr`` string (default: true) and
   its value is true, values in other (all columns excluding ``_key``
@@ -64,7 +64,7 @@ This section describes all parameters.
 
 ``input_type``
 
-  It specifies an input format for ``values``. It supports JSON only.
+  Specifies an input format for ``values``. It supports JSON only.
 
 Usage
 -----

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

@@ -38,14 +38,14 @@ target object. It means that all locks in the database are cleared.
 Usage
 -----
 
-Here is an example to clear all locks in the database::
+Here is an example to clear all locks in the database:
 
 .. groonga-command
 .. include:: ../../example/reference/commands/lock_clear/database.log
 .. lock_clear
 
 Here is an example to clear locks of ``Entry`` table and ``Entry``
-table columns::
+table columns:
 
 .. groonga-command
 .. include:: ../../example/reference/commands/lock_clear/table.log
@@ -53,7 +53,7 @@ table columns::
 .. column_create Entry body COLUMN_SCALAR Text
 .. lock_clear Entry
 
-Here is an example to clear the lock of ``Site.title`` column::
+Here is an example to clear the lock of ``Site.title`` column:
 
 .. groonga-command
 .. include:: ../../example/reference/commands/lock_clear/column.log
@@ -69,7 +69,7 @@ This section describes all parameters.
 ``target_name``
 """""""""""""""
 
-It specifies the name of table or column.
+Specifies the name of table or column.
 
 If you don't specify it, database is used for the target object.
 

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

@@ -0,0 +1,173 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: logical_count
+
+``logical_count``
+=================
+
+Summary
+-------
+
+.. note::
+
+   This command is an experimental feature.
+
+.. versionadded:: 5.0.0
+
+``logical_count`` is a command to count matched records even though actual records are stored into parted tables. It is useful for users because there is less need to care about maximum records of table :doc:`/limitations`.
+
+Note that this feature is not matured yet, so there are some limitations.
+
+* Create parted tables which contains "_YYYYMMDD" postfix. It is hardcoded, so you must create tables by each day.
+* Load proper data into parted tables on your own.
+
+Syntax
+------
+
+``logical_count`` command has seven parameters.
+
+The required parameters are ``logical_table`` and ``shard_key``::
+
+  logical_count logical_table
+                shard_key
+                [min]
+                [min_border]
+                [max]
+                [max_border]
+                [filter]
+
+Usage
+-----
+
+Register ``sharding`` plugin to use ``logical_count`` command in advance.
+
+.. groonga-command
+.. register sharding
+
+Note that ``logical_count`` is implemented as an experimental plugin, and the specification may be changed in the future.
+
+Here is the simple example which shows how to use this feature. Let's consider to count specified logs which are stored into multiple tables.
+
+Here is the schema and data.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_count/setup_schema.log
+.. table_create Logs_20150203 TABLE_NO_KEY
+.. column_create Logs_20150203 timestamp COLUMN_SCALAR Time
+.. column_create Logs_20150203 message COLUMN_SCALAR Text
+.. table_create Logs_20150204 TABLE_NO_KEY
+.. column_create Logs_20150204 timestamp COLUMN_SCALAR Time
+.. column_create Logs_20150204 message COLUMN_SCALAR Text
+.. table_create Logs_20150205 TABLE_NO_KEY
+.. column_create Logs_20150205 timestamp COLUMN_SCALAR Time
+.. column_create Logs_20150205 message COLUMN_SCALAR Text
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_count/setup_data.log
+.. load --table Logs_20150203
+.. [
+.. {"timestamp": "2015-02-03 23:59:58", "message": "Start"},
+.. {"timestamp": "2015-02-03 23:59:58", "message": "Shutdown"},
+.. {"timestamp": "2015-02-03 23:59:59", "message": "Start"},
+.. {"timestamp": "2015-02-03 23:59:59", "message": "Shutdown"}
+.. ]
+.. load --table Logs_20150204
+.. [
+.. {"timestamp": "2015-02-04 00:00:00", "message": "Start"},
+.. {"timestamp": "2015-02-04 00:00:00", "message": "Shutdown"},
+.. {"timestamp": "2015-02-04 00:00:01", "message": "Start"},
+.. {"timestamp": "2015-02-04 00:00:01", "message": "Shutdown"},
+.. {"timestamp": "2015-02-04 23:59:59", "message": "Start"},
+.. {"timestamp": "2015-02-04 23:59:59", "message": "Shutdown"}
+.. ]
+.. load --table Logs_20150205
+.. [
+.. {"timestamp": "2015-02-05 00:00:00", "message": "Start"},
+.. {"timestamp": "2015-02-05 00:00:00", "message": "Shutdown"},
+.. {"timestamp": "2015-02-05 00:00:01", "message": "Start"},
+.. {"timestamp": "2015-02-05 00:00:01", "message": "Shutdown"}
+.. ]
+
+There are three tables which are mapped each day from 2015 Feb 03 to 2015 Feb 05.
+
+* Logs_20150203
+* Logs_20150204
+* Logs_20150205
+
+Then, it loads data into each table which correspond to.
+
+Let's count logs which contains "Shutdown" in ``message`` column and the value of timestamp is "2015-02-04 00:00:00" or later.
+
+Here is the query to achieve above purpose.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_count/count_shutdown.log
+.. logical_count Logs timestamp --filter 'message == "Shutdown"' --min "2015-02-04 00:00:00" --min_border "include"
+
+There is a well known limitation about the number of records. By sharding feature, you can overcome such limitations because such a limitation is applied per table.
+
+.. note::
+
+   There is no convenient query such as ``PARTITIONING BY`` in SQL. Thus, you must create table by ``table_create`` for each tables which contains "_YYYYMMDD" postfix in table name.
+
+Parameters
+----------
+
+This section describes parameters of ``logical_count``.
+
+Required parameter
+^^^^^^^^^^^^^^^^^^
+
+There are required parameters, ``logical_table`` and ``shard_key``.
+
+``logical_table``
+"""""""""""""""""
+
+Specifies logical table name. It means table name without "_YYYYMMDD" postfix.
+If you use actual table such as "Logs_20150203", "Logs_20150203" and so on, logical table name is "Logs".
+
+``shard_key``
+"""""""""""""
+
+Specifies column name which is treated as shared key in each parted table.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are optional parameters.
+
+``min``
+"""""""
+
+Specifies the min value of ``shard_key``
+
+``min_border``
+""""""""""""""
+
+Specifies whether the min value of borderline must be include or not.
+Specify ``include`` or ``exclude`` as the value of this parameter.
+
+``max``
+"""""""
+
+Specifies the max value of ``shard_key``.
+
+``max_border``
+""""""""""""""
+
+Specifies whether the max value of borderline must be include or not.
+Specify ``include`` or ``exclude`` as the value of this parameter.
+
+``filter``
+""""""""""
+
+
+Return value
+------------
+
+::
+
+  [HEADER, LOGICAL_COUNT]