rroonga 2.1.2-x86-mingw32 → 2.1.3-x86-mingw32

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

@@ -1,248 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-groonga command
-===============
-
-名前
-----
-
-groonga - 列指向データベース機能を持つ全文検索エンジンソフトウェア
-
-書式
-----
-
-::
-
- groonga [options] [dest] [command [args]]
-
-説明
-----
-
-groongaは列指向のデータベース機能を持つ高速でスケーラブルな全文検索エンジンです。
-groongaのデータベースは、groongaコマンドかCライブラリインタフェースを通して操作することができます。このマニュアルページでは、groongaコマンドの使い方について説明します。
-
-オプション
-----------
-
-.. cmdoption:: -n
-
-   新たなデータベースを作成します。
-
-.. cmdoption:: -c
-
-   クライアントモードで実行します。
-
-.. cmdoption:: -s
-
-   サーバモードで実行します。
-
-.. cmdoption:: -d
-
-   デーモンモードで実行します。(forkする点がサーバモードと異なる)
-
-.. cmdoption:: -e, --encoding <encoding>
-
-   データベースで使用する文字エンコーディング方式を指定します。新たなデータベースを作成する時のみ有効です。none, euc, utf8, sjis, latin, koi8rのいずれかが指定できます。
-
-.. cmdoption:: -l, --log-level <log level>
-
-   ログレベルを指定します。0〜8までの数値が指定可能で、数が大きいほど多くのログが出力されます。
-
-.. cmdoption:: -a, --address <ip/hostname>
-
-   .. deprecated:: 1.2.2
-      Use :option:`--bind-address` instead.
-
-.. cmdoption:: --bind-address <ip/hostname>
-
-   .. versionadded:: 1.2.2
-
-   サーバモードかデーモンモードで実行するとき、listenするアドレスを指定します。(デフォルトは `hostname` の返すホスト名)
-
-.. cmdoption:: -p, --port <port number>
-
-   クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。
-   (デフォルトは10041番)
-
-.. cmdoption:: -i, --server-id <ip/hostname>
-
-   サーバモードかデーモンモードで実行するとき、サーバのIDとなるアドレスを指定します。(デフォルトは`hostname`の返すホスト名)
-
-.. cmdoption:: -h, --help
-
-   ヘルプメッセージを出力します。
-
-.. cmdoption:: --document-root <path>
-
-   httpサーバとしてgroongaを使用する場合に静的ページを格納するディレクトリを指定します。
-
-   デフォルトでは、データベースを管理するための汎用的なページに対応するファイルが/usr/share/groonga/admin_html以下にインストールされます。このディレクトリをdocument-rootオプションの値に指定して起動した場合、ウェブブラウザでhttp://hostname:port/index.htmlにアクセスすると、ウェブベースのデータベース管理ツールを使用できます。
-
-.. cmdoption:: --protocol <protocol>
-
-   http,gqtpのいずれかを指定します。(デフォルトはgqtp)
-
-.. cmdoption:: --log-path <path>
-
-   ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)
-
-.. cmdoption:: --query-log-path <path>
-
-   クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)
-
-.. cmdoption:: -t, --max-threads <max threasd>
-
-   最大で利用するスレッド数を指定します。(デフォルトはマシンのCPUコア数と同じ数です)
-
-.. cmdoption:: --pid-path <path>
-
-   PIDを保存するパスを指定します。(デフォルトでは保存しません)
-
-.. cmdoption:: --config-path <path>
-
-   設定ファイルのパスを指定します。設定ファイルは以下のようなフォーマットになります。::
-
-     # '#'以降はコメント。
-     ; ';'以降もコメント。
-
-     # 'キー = 値'でオプションを指定。
-     pid-file = /var/run/groonga.pid
-
-     # '='の前後の空白はは無視される。↓は↑と同じ意味。
-     pid-file=/var/run/groonga.pid
-
-     # 'キー'は'--XXX'スタイルのオプション名と同じものが使える。
-     # 例えば、'--pid-path'に対応するキーは'pid-path'。
-     # ただし、キーが'config-path'のオプションは無視される。
-
-.. cmdoption:: --cache-limit <limit>
-
-   キャッシュ数の最大値を指定します。(デフォルトは100です)
-
-.. cmdoption:: --default-match-escalation-threshold <threshold>
-
-   検索の挙動をエスカレーションする閾値を指定します。(デフォルトは0です)
-
-引数
-----
-
-.. cmdoption:: dest
-
-   使用するデータベースのパス名を指定します。
-
-   クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は'localhost:10041')。ポート番号を指定しない場合には、10041が指定されたものとします。
-
-.. cmdoption:: command [args]
-
-   スタンドアロンおよびクライアントモードの場合は、実行するコマンドとその引数をコマンドライン引数に指定できます。コマンドライン引数にcommandを与えなかった場合は、標準入力から一行ずつEOFに達するまでコマンド文字列を読み取り、順次実行します。
-
-.. _command-list-with-continuous-line:
-
-コマンド
---------
-
-groongaコマンドを通してデータベースを操作する命令をコマンドと呼びます。コマンドは主にC言語で記述され、groongaプロセスにロードすることによって使用できるようになります。
-それぞれのコマンドは一意な名前と、0個以上の引数を持ちます。
-
-引数は以下の2種類の方法のいずれかで指定することができます。::
-
- 形式1: コマンド名 値1 値2,..
-
- 形式2: コマンド名 --引数名1 値1 --引数名2 値2,..
-
-形式1でコマンドを実行する場合は、定義された順番で値を指定しなければならず、途中の引数の値を省略することはできません。形式2でコマンドを実行する場合は、「--引数名」のように引数の名前を明示しなければならない代わりに、任意の順番で引数を指定することが可能で、途中の引数の指定を省略することもできます。
-
-標準入力からコマンド文字列を与える場合は、コマンド名と引数名と値は、空白( )で区切ります。空白や、記号「"'()\」のうちいずれかを含む値を指定したい場合は、シングルクォート(')かダブルクォート(")で値を囲みます。値として指定する文字列の中では、改行文字は'\n'に置き換えて指定します。また、引用符に使用した文字を値の中で指定する場合には、その文字の前にバックスラッシュ('\') を指定します。バックスラッシュ文字自身を値として指定する場合には、その前にバックスラッシュを指定します。
-
-You can write command list with continuous line which is represented by '\\' character.::
-
-  table_create --name Terms \
-               --flags TABLE_PAT_KEY \
-               --key_type ShortText \
-               --default_tokenizer TokenBigram
-
-組み込みコマンド
-----------------
-
-以下のコマンドは組み込みコマンドとして予め定義されています。
-
- ``status``
-   groongaプロセスの状態を表示します。
-
- ``table_list``
-   DBに定義されているテーブルのリストを表示します。
-
- ``column_list``
-   テーブルに定義されているカラムのリストを表示します。
-
- ``table_create``
-   DBにテーブルを追加します。
-
- ``column_create``
-   テーブルにカラムを追加します。
-
- ``table_remove``
-   DBに定義されているテーブルを削除します。
-
- ``column_remove``
-   テーブルに定義されているカラムを削除します。
-
- ``view_add``
-   VIEW型のテーブルに要素となるテーブルを定義します。
-
- ``load``
-   テーブルにレコードを挿入します。
-
- ``select``
-   テーブルに含まれるレコードを検索して表示します。
-
- ``define_selector``
-   検索条件をカスタマイズした新たな検索コマンドを定義します。
-
- ``quit``
-   データベースとのセッションを終了します。
-
- ``shutdown``
-   サーバ(デーモン)プロセスを停止します。
-
- ``log_level``
-   ログ出力レベルを設定します。
-
- ``log_put``
-   ログ出力を行います。
-
- ``clearlock``
-   ロックを解除します。
-
-
-例
---
-
-新しいデータベースを作成します。::
-
-   % groonga -n /tmp/hoge.db quit
-   %
-
-作成済みのデータベースにテーブルを定義します。::
-
-   % groonga /tmp/hoge.db table_create Table 0 ShortText
-   [[0]]
-   %
-
-サーバを起動します。::
-
-   % groonga -d /tmp/hoge.db
-   %
-
-httpサーバとして起動します。::
-
-   % groonga -d -p 80 --protocol http --document-root /usr/share/groonga/admin_html /tmp/hoge.db
-   %
-
-サーバに接続し、テーブル一覧を表示します。::
-
-   % groonga -c localhost table_list
-   [[0],[["id","name","path","flags","domain"],[256,"Table","/tmp/hoge.db.0000100",49152,14]]]
-   %

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

@@ -1,14 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-実行ファイル
-============
-
-groongaパッケージが提供する実行ファイルについて説明します。
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   executables/*

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

@@ -1,20 +0,0 @@
-.. -*- 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/edit_distance.txt

@@ -1,48 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-edit_distance
-=============
-
-名前
-----
-
-edit_distance - 指定した2つの文字列の編集距離を計算する
-
-書式
-----
-::
-
- edit_distance(string1, string2)
-
-説明
-----
-
-groonga組込関数の一つであるedit_distanceについて説明します。組込関数は、script形式のgrn_expr中で呼び出すことができます。
-
-edit_distance() 関数は、string1に指定した文字列とstring2に指定した文字列の間の編集距離を求めます。
-
-引数
-----
-
-``string1``
-
-  文字列を指定します
-
-``string2``
-
-  もうひとつの文字列を指定します
-
-
-返値
-----
-
-指定した2つ文字列の編集距離をUint32型の値として返します。
-
-例
---
-::
-
- edit_distance(title, "hoge")
- 1

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

@@ -1,301 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: geo_distance
-
-
-geo_distance
-============
-
-Summary
--------
-
-``geo_distance`` calculates the value of distance between specified two points.
-
-Syntax
-------
-
-``geo_distance`` requires two point.
-The parameter ``approximate_type`` is optional::
-
-    geo_distance(point1, point2)
-    geo_distance(point1, point2, approximate_type)
-
-The default value of ``approximate_type`` is ``"rectangle"``.
-If you omit ``approximate_type``, ``geo_distance`` calculates the value of
-distance as if ``"rectangle"`` was specified.
-
-Usage
------
-
-``geo_distance`` is one of the groonga builtin functions.
-
-You can call a builtin function in :doc:`/reference/grn_expr` 
-
-``geo_distance`` function calculates the value of distance (approximate value)
-between the coordinate of ``point1`` and the coordinate of ``point2``.
-
-.. note::
-
-    groonga provides three built in functions for calculating the value of distance. 
-    There are ``geo_distance()``, ``geo_distance2()`` and ``geo_distance3()``.
-    The difference of them is the algorithm of calculating distance.
-    ``geo_distance2()`` and ``geo_distance3()`` were deprecated since version 1.2.9.
-    Use ``geo_distance(point1, point2, "sphere")`` instead of ``geo_distance2(point1, point2)``.
-    Use ``geo_distance(point1, point2, "ellipsoid")`` instead of ``geo_distance3(point1, point2)``.
-
-Lets's learn about ``geo_distance`` usage with examples.
-This section shows simple usages.
-
-Here are two schema definition and sample data to show the difference according to the usage.
-Those samples show how to calculate the value of distance between New York City and London.
-
-#. Using the column value of location for calculating the distance (``Cities`` table)
-#. Using the explicitly specified coordinates for calculating the distance (``Geo`` table)
-
-Using the column value of location
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Here are a schema definition of ``Cities`` table and sample data to show usage.
-
-::
-
-  table_create Cities TABLE_HASH_KEY ShortText
-  column_create Cities location COLUMN_SCALAR WGS84GeoPoint
-  load --table Cities
-  [
-    {
-      "_key", "location"
-    },
-    {
-      "New York City", "146566000x-266422000",
-    },
-  ]
-
-.. groonga-command
-.. include:: ../../example/reference/functions/geo_distance_setup_location.log
-.. table_create Cities TABLE_HASH_KEY ShortText
-.. column_create Cities location COLUMN_SCALAR WGS84GeoPoint
-.. load --table Cities
-.. [
-..   {
-..      "_key", "location"
-..   },
-..   {
-..      "New York City", "146566000x-266422000",
-..   },
-.. ]
-
-
-This execution example creates a table named ``Cities`` which has one column named ``location``.
-``location`` column stores the value of coordinate.
-The coordinate of Tokyo is stored as sample data.
-
-.. groonga-command
-.. include:: ../../example/reference/functions/geo_distance_location_rectangle.log
-.. select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "rectangle")'
-
-This sample shows that ``geo_distance`` use the value of ``location`` column
-and the value of coordinate to calculate distance.
-
-The value ("185428000x-461000") passed to ``geo_distance`` as the second argument is
-the coordinate of London.
-
-
-Using the explicitly specified value of location
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Here are a schema definition of ``Geo`` table and sample data to show usage.
-
-::
-
- table_create Geo TABLE_HASH_KEY ShortText
- column_create Geo distance COLUMN_SCALAR Int32
- load --table Geo
- [
-   {
-     "_key": "the record for geo_distance() result"
-   }
- ]
-
-
-.. groonga-command
-.. include:: ../../example/reference/functions/geo_distance_setup_distance.log
-.. table_create Geo TABLE_HASH_KEY ShortText
-.. column_create Geo distance COLUMN_SCALAR Int32
-.. load --table Geo
-.. [
-..   {
-..     "_key": "the record for geo_distance() result"
-..   }
-.. ]
-
-This execution example creates a table named ``Geo`` which has one column named ``distance``.
-``distance`` column stores the value of distance.
-
-.. groonga-command
-.. include:: ../../example/reference/functions/geo_distance_distance_rectangle.log
-.. select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "185428000x-461000", "rectangle")'
-
-This sample shows that ``geo_distance`` use the coordinate of London
-and the coordinate of New York to calculate distance.
-
-Parameters
-----------
-
-Required parameter
-^^^^^^^^^^^^^^^^^^
-
-There are two required parameter, ``point1`` and ``point2``.
-
-``point1``
-""""""""""
-
-It specifies the start point that
-you want to calculate the value of distance between two points.
-
-You can specify the value of GeoPoint type. [#]_
-
-See :doc:`/reference/types` about GeoPoint.
-
-``point2``
-""""""""""
-
-It specifies the end point that
-you want to calculate the value of distance between two points.
-
-You can specify the value of GeoPoint type or 
-the string indicating the coordinate.
-
-See :doc:`/reference/types` about GeoPoint and the coordinate.
-
-Optional parameter
-^^^^^^^^^^^^^^^^^^
-
-There is a optional parameter, ``approximate_type``.
-
-``approximate_type``
-""""""""""""""""""""
-
-It specifies how to approximate the geographical features for calculating
-the value of distance.
-
-You can specify the value of ``approximate_type`` by one of the followings.
-
-  * ``rectangle``
-  * ``sphere``
-  * ``ellipsoid``
-
-.. note::
-
-    There is a limitation about ``geo_distance``. ``geo_distance`` can not
-    calculate the value of distance between two points across meridian,
-    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.
-
-``rectangle``
-...............
-
-This parameter require to approximate the geographical features
-by square approximation for calculating the distance.
-
-Since the value of distance is calculated by simple formula,
-you can calculate the value of distance fast.
-But, the error of distance increases as it approaches the pole.
-
-You can also specify ``rect`` as abbrev expression.
-
-Here is a sample about calculating the value of distance with column value.
-
-.. include:: ../../example/reference/functions/geo_distance_location_rectangle.log
-
-Here is a sample about calculating the value of distance with explicitly specified point.
-
-.. 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.
-
-.. note::
-
-    ``geo_distance`` accepts the string indicating the coordinate as
-    the value of ``point1`` when the value of ``approximate_type`` is
-    ``"rectangle"``.
-    If you specified the string indicating the coordinate as the value
-    of ``point1`` with ``sphere`` or ``ellipsoid``, ``geo_distance``
-    returns 0 as the value of distance.
-
-
-``sphere``
-...............
-
-This parameter require to approximate the geographical features
-by spherical approximation for calculating the distance.
-
-It is slower than ``rectangle``, but the error of distance becomes
-smaller than ``rectangle``.
-
-You can also specify ``sphr`` as abbrev expression.
-
-Here is a sample about calculating the value of distance with column value.
-
-.. groonga-command
-.. include:: ../../example/reference/functions/geo_distance_location_sphere.log
-.. 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.
-
-It uses the calculation of distance by the formula of Hubeny.
-It is slower than ``sphere``, but the error of distance becomes
-smaller than ``sphere``.
-
-You can also specify ``ellip`` as abbrev expression.
-
-Here is a sample about calculating the value of distance with column value.
-
-.. groonga-command
-.. include:: ../../example/reference/functions/geo_distance_location_ellipsoid.log
-.. select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "ellipsoid")'
-
-Return value
-------------
-
-``geo_distance`` returns the value of distance in float type.
-The unit of return value is meter.
-
-.. rubric:: Footnote
-
-.. [#] You can specify whether TokyoGeoPoint or WGS84GeoPoint.
-