rroonga 5.0.0-x86-mingw32 → 5.0.1-x86-mingw32

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

@@ -170,7 +170,7 @@
 * テキストから数値へのキャスト処理を強化。#612, #613
   （Itagaki Takahiroさんが報告）
 * クライアントモードでの--fileオプションのサポート。#578
-* :doc:`/spec/search` の挙動を動的に変更する``--match-escalation-threashold``
+* :doc:`/spec/search` の挙動を動的に変更する``--match-escalation-threshold``
   起動オプションと``--match_escalation_threshold``selectオプションを追加。 #628
 
 変更

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

@@ -135,8 +135,8 @@ Improvements
   It enables HTTP server process to handle over 4096 files.
 * [experimental] Added some API to integrate mruby into groonga. [GitHub#109, #110, #111, #112, #113, #114, #115, #116, #117, #118] [Patch by wanabe]
 * [travis] Supported CMake build on Travis-CI.
-* [doc] Added documentation about :doc:`reference/tuning`.
-* [experimental] Added :doc:`ruby_load` command.
+* [doc] Added documentation about :doc:`/reference/tuning`.
+* [experimental] Added :doc:`/reference/commands/ruby_load` command.
 * [httpd] Supported multiple buffered body of POST request.
   The load command caused timeout in such a case. [GitHub #120] [Patch by Motoi Washida]
 * [gqtp] Supported error message. The body is changed to return

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

@@ -542,7 +542,7 @@ Improvements
 ^^^^^^^^^^^^
 
 * [doc] Updated documentation about
-  :doc:`/reference/executables/groonga-suggest-leaner`.
+  :doc:`/reference/executables/groonga-suggest-learner`.
 * [doc] Added documentation about how to update files.
   [GitHub#160] [Patch by cosmo0920]
 * [doc] Updated to caplitalized "Groonga" terms in
@@ -633,7 +633,7 @@ Fixes
 * Fixed a bug that a division overflow caused a fatal error.
   For example, it occurs when you execute 'COLUMN / -1' operation to Int32 or Int64 column. [#2307]
 * Fixed a bug that '%' operations performs '/' operations. [#2307]
-* [doc] Fixed a wrong documentation about :doc:`reference/commands/column_rename`. [Reported by nise_nabe]
+* [doc] Fixed a wrong documentation about :doc:`/reference/commands/column_rename`. [Reported by nise_nabe]
 * Fixed the issue that out of bound array element access may occurs. [GitHub#158] [Reported by dcb314]
 
 Thanks

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

@@ -19,7 +19,9 @@ Reference manual
    reference/tokenizers
    reference/token_filters
    reference/query_expanders
+   reference/scorer
    reference/grn_expr
+   reference/regular_expression
    reference/function
    reference/operations
    reference/suggest

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/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/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]