null+****@clear*****
null+****@clear*****
2012年 4月 27日 (金) 18:16:07 JST
Kouhei Sutou 2012-04-27 18:16:07 +0900 (Fri, 27 Apr 2012)
New Revision: 9c7f15a71c9df1639c05bf093353eaa212d8f9d3
Log:
doc: update document about select
But it's not completed yet...
Added files:
doc/source/example/commands/select/match_columns_simple.log
doc/source/example/commands/select/match_columns_some_columns.log
doc/source/example/commands/select/match_columns_weight.log
doc/source/example/commands/select/no_limit.log
doc/source/example/commands/select/paging.log
doc/source/example/commands/select/simple_filter.log
doc/source/example/commands/select/simple_query.log
doc/source/example/commands/select/simple_usage.log
doc/source/example/commands/select/table_nonexistent.log
doc/source/example/commands/select/usage_setup.log
doc/source/spec/query_syntax.txt
doc/source/spec/script_syntax.txt
Modified files:
doc/source/commands/select.txt
Modified: doc/source/commands/select.txt (+315 -105)
===================================================================
--- doc/source/commands/select.txt 2012-04-27 14:25:56 +0900 (b41de48)
+++ doc/source/commands/select.txt 2012-04-27 18:16:07 +0900 (05aedfe)
@@ -2,186 +2,395 @@
.. highlightlang:: none
+.. groonga-command
+.. database: commands_select
+
select
======
-名前
-----
-
-select - テーブルの中から条件にマッチするレコードを検索して出力する
-
-書式
-----
-::
+Summary
+-------
+
+``select`` searches records that are matched to specified conditions
+from a table and then outputs them.
+
+``select`` is the most important command in groonga. You need to
+understand ``select`` to use the full power of groonga.
+
+Syntax
+------
+
+``select`` has many parameters. The required parameter is only
+``table`` and others are optional::
+
+ select table
+ [match_columns=null]
+ [query=null]
+ [filter=null]
+ [scorer=null]
+ [sortby=null]
+ [output_columns="_id, _key, *"]
+ [offset=0]
+ [limit=10]
+ [drilldown=null]
+ [drilldown_sortby=null]
+ [drilldown_output_columns=null]
+ [drilldown_offset=0]
+ [drilldown_limit=10]
+ [cache=yes]
+ [match_escalation_threshold=0]
+ [query_expansion=null]
+
+Usage
+-----
+
+Let's learn about ``select`` usage with examples. This section shows
+many popular usages.
+
+Here are a schema definition and sample data to show usage.
+
+.. groonga-command
+.. include:: ../example/commands/select/usage_setup.log
+.. table_create Entries TABLE_HASH_KEY ShortText
+.. column_create Entries content COLUMN_SCALAR Text
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram
+.. column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
+.. column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
+.. load --table Entries
+.. [
+.. {"_key": "The first post!", "content": "Welcome! This is my first post!"},
+.. {"_key": "Groonga", "content": "I started to use groonga. It's very fast!"}
+.. {"_key": "Mroonga", "content": "I also started to use mroonga. It's also very fast! Really fast!"}
+.. ]
+
+There is a table, ``Entries``, for blog entries. An entry has title
+and content. Title is key of ``Entries``. Content is value of
+``Entries.content`` column.
+
+``Entries._key`` column and ``Entries.content`` column are indexed
+using ``TokenBigram`` tokenizer. So both ``Entries._key`` and
+``Entries.content`` are fulltext search ready.
+
+OK. The schema and data for examples are ready.
+
+Simple usage
+^^^^^^^^^^^^
+
+Here is the most simple usage with the above shema and data. It shows
+all records in ``Entries`` table.
+
+.. groonga-command
+.. include:: ../example/commands/select/simple_usage.log
+.. select Entries
+
+Why doest the command output all records? There are two reasons. The
+first reason is that the command doesn't specify any search
+conditions. No search condition means all records are matched. The
+second reason is that the number of all records is 2. ``select``
+command outputs 10 records at a maximum by default. There are only 3
+records. It is less than 10. So the command outputs all records.
+
+Search conditions
+^^^^^^^^^^^^^^^^^
+
+Search conditions are specified by ``query`` or ``filter``. You can
+also specify both ``query`` and ``filter``. It means that selected
+records must be matched against both ``query`` and ``filter``.
+
+Search condition: ``query``
+"""""""""""""""""""""""""""
+
+``query`` is designed for search box in Web page. Imagine a search box
+in google.com. You specify search conditions for ``query`` as space
+separated keywords. For example, ``search engine`` means a matched
+record should contain two words, ``search`` and ``engine``.
+
+Normally, ``query`` parameter is used for specifying fulltext search
+conditions. It can be used for non fulltext search conditions but
+``filter`` is used for the propose.
+
+``query`` parameter is used with ``match_columns`` parameter when
+``query`` parameter is used for specifying fulltext search
+conditions. ``match_columns`` specifies which columnes and indexes are
+matched against ``query``.
+
+Here is a simple ``query`` usage example.
+
+.. groonga-command
+.. include:: ../example/commands/select/simple_query.log
+.. select Entries --match_columns content --query fast
+
+The ``select`` command searches records that contain a word ``fast``
+in ``content`` column value from ``Entries`` table.
+
+``query`` has query syntax but its deatils aren't described here. See
+:doc:`/spec/query_syntax` for datails.
+
+Search condition: ``filter``
+""""""""""""""""""""""""""""
+
+``filter`` is designed for complex search conditions. You specify
+search conditions for ``filter`` as ECMAScript like syntax.
+
+Here is a simple ``filter`` usage example.
+
+.. groonga-command
+.. include:: ../example/commands/select/simple_filter.log
+.. select Entries --filter 'cotent @ "fast" && _key == "Groonga"'
- select table [match_columns [query [filter [scorer [sortby [output_columns
- [offset [limit [drilldown [drilldown_sortby [drilldown_output_columns
- [drilldown_offset [drilldown_limit [cache
- [match_escalation_threshold [query_expansion]]]]]]]]]]]]]]]]
+The ``select`` command searches records that contain a word ``fast``
+in ``content`` column value and has ``Groonga`` as ``_key`` from
+``Entries`` table. There are three operators in the command, ``@``,
+``&&`` and ``==``. ``@`` is fulltext search operator. ``&&`` and
+``==`` are the same as ECMAScript. ``&&`` is logical AND operator and
+``==`` is equal operator.
-説明
-----
+``filter`` has more operators and syntax like grouping by ``(...)``
+its deatils aren't described here. See :doc:`/spec/script_syntax` for
+datails.
-groonga組込コマンドの一つであるselectについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+Paging
+^^^^^^
-selectは、使用しているデータベースのテーブルの中から条件にマッチするレコードを検索して出力します。
+You can specify range of returned records by ``offset`` and ``limit``.
+Here is an example to output only the 2nd record.
-引数
-----
+.. groonga-command
+.. include:: ../example/commands/select/paging.log
+.. select Entries --offset 1 --limit 1
-``table``
+``offset`` is zero-origin. ``--offset 1`` means output range is
+started from the 2nd record.
- 検索対象のテーブルを指定します。存在しないテーブルを指定した場合はエラーになります。
+``limit`` specifies the max number of output records. ``--limit 1``
+means the number of output records is 1 at a maximium. If no records
+are matched, ``select`` command outputs no records.
-``match_columns``
+The total number of records
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
- query引数に指定する検索条件文字列でデフォルトの検索対象となるカラムを指定します。
+You can use ``--limit 0`` to retrieve the total number of recrods
+without any contents of matched records.
- カラム名
+.. groonga-command
+.. include:: ../example/commands/select/no_limit.log
+.. select Entries --limit 0
- カラム名の後ろに'* 数値'を指定することによって、そのカラムにヒットした際のスコアに積算される重みを指定することができます。
+``--limit 0`` is useful for retrieving only the number of matched
+records.
- カラム名 * 重み
+Parameters
+----------
- 複数のカラムを'||'で結合して指定することもできます。
+This section describes all parameters. Parameters are categorized.
- カラム名1 * 重み1 || カラム名2 * 重み2
+Required parameter
+^^^^^^^^^^^^^^^^^^
- また、カラム名ではなく、検索に使用するインデックス名を指定することもできます。
+There is a required parameter, ``table``.
-``query``
+``table``
+"""""""""
- 以下の形式の文字列によって検索条件を指定します。
+It specifies a table to be searched. ``table`` must be specified.
-条件式
-^^^^^^
+If nonexistent table is specified, an error is returned.
-以下の条件式が使用できます。
+.. groonga-command
+.. include:: ../example/commands/select/table_nonexistent.log
+.. select Nonexistent
-文字列
- 全文検索条件(デフォルト検索対象カラムの値が指定された文字列を含んでいる)
+Search related parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^
-\"文字列\"
- フレーズ検索条件(デフォルト検索対象カラムの値が指定されたフレーズを含んでいる)
+There are search related parameters. Typically, ``match_columns`` and
+``query`` parameters are used for implementing a search
+box. ``filter`` parameters is used for implementing complex search
+feature.
-カラム名:値
- 一致条件(カラム値 == 値)
+If both ``query`` and ``filter`` are specified, selected records must
+be matched against both ``query`` and ``filter``. If both ``query``
+and ``filter`` aren't specified, all records are selected.
-カラム名:!値
- 不一致条件(カラム値 != 値)
+``match_columns``
+"""""""""""""""""
+
+It specifies the default target column for fulltext search by
+``query`` parameter value. A target column for fulltext search can be
+specified in ``query`` parameter. The difference between
+``match_columns`` and ``query`` is whether weight is supported or
+not. ``match_columns`` supports weight but ``query`` doesn't.
+
+Weight is relative importance of target column. A higher weight target
+column gets more hit score rather than a lower weight target column
+when a record is matched by fulltext search. The default weight is 1.
+
+Here is a simple ``match_columns`` usage example.
+
+.. groonga-command
+.. include:: ../example/commands/select/match_columns_simple.log
+.. select Entries --match_columns content --query fast --output_columns '_key, _score'
+
+``--match_columns content`` means the default target column for
+fulltext search is ``content`` column and its weight
+is 1. ``--output_columns '_key, _score'`` means that the ``select``
+command outputs ``_key`` value and ``_score`` value for matched
+records.
+
+Pay attention to ``_score`` value. ``_score`` value is the number of
+matched counts against ``query`` parameter value. In the example,
+``query`` parameter value is ``fast``. The fact that ``_score`` value
+is 1 means that ``fast`` appers in ``content`` column only once. The
+fact that ``_score`` value is 2 means that ``fast`` appears in
+``content`` column twice.
+
+To specify weight, ``column * weight`` syntax is used. Here is a
+weight usage example.
+
+.. groonga-command
+.. include:: ../example/commands/select/match_columns_weight.log
+.. select Entries --match_columns 'content * 2' --query fast --output_columns '_key, _score'
+
+``--match_columns 'content * 2'`` means the default target column for
+fulltext search is ``content`` column and its weight is 2.
+
+Pay attention to ``_score`` value. ``_score`` value is doubled because
+weight is 2.
+
+You can specify one or more columns as the default target columns for
+fulltext search. If one or more columns are specified, fulltext search
+is done for all columns and scores are accumulated. If one of the
+columns is matched against ``query`` parameter value, the record is
+treated as matched.
+
+To specify one or more columns, ``column1 * weight1 || column2 *
+weight2 || ...`` syntax is used. ``* weight`` can be omitted. If it is
+omitted, 1 is used for weight. Here is a one or more columns usage
+example.
+
+.. groonga-command
+.. include:: ../example/commands/select/match_columns_some_columns.log
+.. select Entries --match_columns '_key * 10 || content' --query groonga --output_columns '_key, _score'
+
+``--match_columns '_key * 10 || content'`` means the default target
+columns for fulltext search are ``_key`` and ``content`` columns and
+``_key`` column's weight is 10 and ``content`` column's weight
+is 1. This weight allocation means ``_key`` column value is more
+important rather than ``content`` column value. In this example, title
+of blog entry is more important rather thatn content of blog entry.
-カラム名:<値
- 比較条件(カラム値 < 値)
+``query``
+"""""""""
-カラム名:>値
- 比較条件(カラム値 > 値)
+TODO: write short description.
-カラム名:<=値
- 比較条件(カラム値 <= 値)
+See :doc:`/doc/query_syntax`.
-カラム名:>=値
- 比較条件(カラム値 >= 値)
+``filter``
+""""""""""
-カラム名:@文字列
- 全文検索条件(カラム値が指定された文字列を含んでいる)
+TODO: write short description.
-結合演算子
-^^^^^^^^^^
+See :doc:`/doc/script_syntax``.
-複数の条件式を結合するために以下の演算子が使用できます。
+Advanced search parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^^
-a OR b
- 論理和(aとbといずれかの条件がマッチする)
+``match_escalation_threshold``
+""""""""""""""""""""""""""""""
-a + b
- 論理積(aとbの両方がマッチする)
+検索の挙動をエスカレーションするかどうかの閾値を設定します。デフォルト値は0です。デフォルト値は以下のいずれかの方法で設定できます。
-a - b
- aにマッチし、bにはマッチしない
+ * configureの--with-match-escalation-thresholdオプション
+ * groongaコマンド起動時の--match-escalation-thresholdオプション
+ * 設定ファイル中のmatch-escalation-threshold設定項目
-( )
- 複数の条件をまとめる
+クエリのヒット件数が閾値を越えない場合は :doc:`/spec/search` で説明している方法で検索方法をエスカレーションしてきます。
+``query_expansion``
+"""""""""""""""""""
-``filter``
+query_expansionパラメータには、queryパラメータに指定された文字列を置換(拡張)する条件となるテーブル・カラムを指定します。フォーマットは「${テーブル名}.${カラム名}」となります。指定するテーブルは文字列を主キーとするハッシュ型あるいはパトリシア木型のテーブルで、一つ以上の文字列型のカラムが定義されている必要があります。(ここでは置換テーブルと呼びます。)
- 絞り込み条件をscript形式のgrn_expr文字列によって指定します。
+queryパラメータに指定された文字列が、指定されたテーブルの主キーと完全一致する場合、その文字列を指定されたカラム値の文字列に置換します。queryパラメータが、空白、括弧、演算子などを含む場合は、その演算子によって区切られた文字列の単位で置換が実行されます。ダブルクォート("")で括られた範囲は、その内部に空白を含んでいても一つの置換される単位と見なされます。検索文字列と置換テーブルの主キー値との比較に際して大文字小文字等を区別したくない場合には、置換テーブルを定義する際にKEY_NORMALIZEを指定します。置換後の文字列となるカラムの値には、括弧や*, ORなど、queryパラメータで利用可能な全ての演算子を指定することができます。
- query引数とfilter引数をどちらも指定した場合は、両方の条件を満足するレコードのみがヒットします。どちらも指定しない場合は全件がヒットします。
+Output related parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^
-``scorer``
+``output_columns``
+""""""""""""""""""
- 検索条件にマッチする全てのレコードに対して適用するgrn_exprをscript形式で指定します。
+出力するカラム名のリストをカンマ(',')区切りで指定します。
- scorerは、検索処理が完了し、ソート処理が実行される前に呼び出されます。従って、各レコードのスコアを操作する式を指定しておけば、検索結果のソート順序をカスタマイズできるようになります。
+アスタリスク('*')を指定すると、全てのカラムが指定されたものとみなされます。または、script形式のgrn_expr文字列を指定します。 (デフォルトは、'_id, _key, \*')
``sortby``
+""""""""""
- ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。::
+ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。::
- [-]カラム名1, [-]カラム名2, [-]カラム名3, ...
+ [-]カラム名1, [-]カラム名2, [-]カラム名3, ...
- カラム名1の値でソートし、値が同一である場合はカラム名2でソート、と順次比較を行いソートします。カラム名の前に - を付加した場合は降順にソートします。付加しない場合には昇順にソートします。
+カラム名1の値でソートし、値が同一である場合はカラム名2でソート、と順次比較を行いソートします。カラム名の前に - を付加した場合は降順にソートします。付加しない場合には昇順にソートします。
- query引数またはfilter引数を指定した場合はカラム名に'_score'を使えます。'_score'を指定することでスコアでソートすることができます。query引数もfilter引数も指定していない状態で'_score'を指定するとエラーになります。
+query引数またはfilter引数を指定した場合はカラム名に'_score'を使えます。'_score'を指定することでスコアでソートすることができます。query引数もfilter引数も指定していない状態で'_score'を指定するとエラーになります。
-``output_columns``
+``offset``
+""""""""""
+
+検索条件にマッチしたレコードのうち、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。offsetに負の値を指定した場合は、ヒットした件数 + offset によって算出される値が指定されたものとみなされます。
- 出力するカラム名のリストをカンマ(',')区切りで指定します。
+``limit``
+"""""""""
- アスタリスク('*')を指定すると、全てのカラムが指定されたものとみなされます。または、script形式のgrn_expr文字列を指定します。 (デフォルトは、'_id, _key, \*')
+検索条件にマッチしたレコードのうち、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、offset + limit がヒットした件数を超えない範囲でレコードが出力されます。limitに負の値を指定した場合は、ヒットした件数 + limit + 1 によって算出される値が指定されたものとみなされます。
-``offset``
+``scorer``
+""""""""""
- 検索条件にマッチしたレコードのうち、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。offsetに負の値を指定した場合は、ヒットした件数 + offset によって算出される値が指定されたものとみなされます。
+検索条件にマッチする全てのレコードに対して適用するgrn_exprをscript形式で指定します。
-``limit``
+scorerは、検索処理が完了し、ソート処理が実行される前に呼び出されます。従って、各レコードのスコアを操作する式を指定しておけば、検索結果のソート順序をカスタマイズできるようになります。
- 検索条件にマッチしたレコードのうち、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、offset + limit がヒットした件数を超えない範囲でレコードが出力されます。limitに負の値を指定した場合は、ヒットした件数 + limit + 1 によって算出される値が指定されたものとみなされます。
+Facet related parameters
+^^^^^^^^^^^^^^^^^^^^^^^^
``drilldown``
+"""""""""""""
- グループ化のキーとなるカラム名のリストをカンマ(',')区切りで指定します。検索条件にマッチした各レコードを出力したのちに、drilldownに指定されたカラムの値が同一であるレコードをとりまとめて、それぞれについて結果レコードを出力します。
+グループ化のキーとなるカラム名のリストをカンマ(',')区切りで指定します。検索条件にマッチした各レコードを出力したのちに、drilldownに指定されたカラムの値が同一であるレコードをとりまとめて、それぞれについて結果レコードを出力します。
``drilldown_sortby``
+""""""""""""""""""""
- drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。sortbyパラメータと同様に昇降順を指定できます。
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、ソートキーとなるカラム名のリストをカンマ(',')区切りで指定します。sortbyパラメータと同様に昇降順を指定できます。
``drilldown_output_columns``
+""""""""""""""""""""""""""""
- drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力するカラム名のリストをカンマ(',')区切りで指定します。
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力するカラム名のリストをカンマ(',')区切りで指定します。
``drilldown_offset``
+""""""""""""""""""""
- drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。drilldown_offsetに負の値を指定した場合は、ヒットした件数 + drilldown_offsetによって算出される値が指定されたものとみなされます。
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力対象となる最初のレコードの番号を0ベースで指定します。デフォルト値は0です。drilldown_offsetに負の値を指定した場合は、ヒットした件数 + drilldown_offsetによって算出される値が指定されたものとみなされます。
``drilldown_limit``
+"""""""""""""""""""
- drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、drilldown_offset + drilldown_limit がヒットした件数を超えない範囲でレコードが出力されます。drilldown_limitに負の値を指定した場合は、ヒットした件数 + drilldown_limit + 1 によって算出される値が指定されたものとみなされます。
+drilldown条件に指定されたカラムの値毎にとりまとめられたレコードについて、出力を行うレコードの件数を指定します。デフォルト値は10です。実際には、drilldown_offset + drilldown_limit がヒットした件数を超えない範囲でレコードが出力されます。drilldown_limitに負の値を指定した場合は、ヒットした件数 + drilldown_limit + 1 によって算出される値が指定されたものとみなされます。
-``cache``
+Cache related parameter
+^^^^^^^^^^^^^^^^^^^^^^^
- クエリキャッシュに関する動作を設定します。
-
- ``no``
-
- 検索結果をクエリキャッシュに残しません。キャッシュして再利用される可能性が低いクエリに対して用います。キャッシュ容量は有限です。有効なキャッシュが多くヒットするために、このパラメータは有効です。
-
-``match_escalation_threshold``
-
- 検索の挙動をエスカレーションするかどうかの閾値を設定します。デフォルト値は0です。デフォルト値は以下のいずれかの方法で設定できます。
-
- * configureの--with-match-escalation-thresholdオプション
- * groongaコマンド起動時の--match-escalation-thresholdオプション
- * 設定ファイル中のmatch-escalation-threshold設定項目
-
- クエリのヒット件数が閾値を越えない場合は :doc:`/spec/search` で説明している方法で検索方法をエスカレーションしてきます。
+``cache``
+"""""""""
-``query_expansion``
+クエリキャッシュに関する動作を設定します。
- query_expansionパラメータには、queryパラメータに指定された文字列を置換(拡張)する条件となるテーブル・カラムを指定します。フォーマットは「${テーブル名}.${カラム名}」となります。指定するテーブルは文字列を主キーとするハッシュ型あるいはパトリシア木型のテーブルで、一つ以上の文字列型のカラムが定義されている必要があります。(ここでは置換テーブルと呼びます。)
+``no``
- queryパラメータに指定された文字列が、指定されたテーブルの主キーと完全一致する場合、その文字列を指定されたカラム値の文字列に置換します。queryパラメータが、空白、括弧、演算子などを含む場合は、その演算子によって区切られた文字列の単位で置換が実行されます。ダブルクォート("")で括られた範囲は、その内部に空白を含んでいても一つの置換される単位と見なされます。検索文字列と置換テーブルの主キー値との比較に際して大文字小文字等を区別したくない場合には、置換テーブルを定義する際にKEY_NORMALIZEを指定します。置換後の文字列となるカラムの値には、括弧や*, ORなど、queryパラメータで利用可能な全ての演算子を指定することができます。
+ 検索結果をクエリキャッシュに残しません。キャッシュして再利用される可能性が低いクエリに対して用います。キャッシュ容量は有限です。有効なキャッシュが多くヒットするために、このパラメータは有効です。
返値
----
@@ -258,7 +467,8 @@ a - b
[[[2],[["_id", "UInt32"],["_key","ShortText"],["body","ShortText"]],[1,"abandon","放棄する"],[2,"abbreviate","短縮する"]]]
-関連項目
+See also
--------
-:doc:`../expr`
+ * :doc:`/spec/query_syntax`
+ * :doc:`/spec/script_syntax`
Added: doc/source/example/commands/select/match_columns_simple.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/match_columns_simple.log 2012-04-27 18:16:07 +0900 (840569b)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries --match_columns content --query fast --output_columns '_key, _score'
+ [[0,1335517902.36602,0.000338554382324219],[[[2],[["_key","ShortText"],["_score","Int32"]],["Groonga",1],["Mroonga",2]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/match_columns_some_columns.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/match_columns_some_columns.log 2012-04-27 18:16:07 +0900 (0347fc7)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries --match_columns '_key * 10 || content' --query groonga --output_columns '_key, _score'
+ [[0,1335517902.76925,0.000515937805175781],[[[1],[["_key","ShortText"],["_score","Int32"]],["Groonga",1]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/match_columns_weight.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/match_columns_weight.log 2012-04-27 18:16:07 +0900 (51b74b8)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries --match_columns 'content * 2' --query fast --output_columns '_key, _score'
+ [[0,1335517902.56734,0.000602245330810547],[[[2],[["_key","ShortText"],["_score","Int32"]],["Groonga",2],["Mroonga",4]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/no_limit.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/no_limit.log 2012-04-27 18:16:07 +0900 (778c835)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries --limit 0
+ [[0,1335517901.96388,0.000146389007568359],[[[3],[["_id","UInt32"],["_key","ShortText"],["content","Text"]]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/paging.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/paging.log 2012-04-27 18:16:07 +0900 (fa402d2)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries --offset 1 --limit 1
+ [[0,1335517901.76199,0.000247716903686523],[[[3],[["_id","UInt32"],["_key","ShortText"],["content","Text"]],[2,"Groonga","I started to use groonga. It's very fast!"]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/simple_filter.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/simple_filter.log 2012-04-27 18:16:07 +0900 (82af909)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries --filter 'cotent @ "fast" && _key == "Groonga"'
+ [[-63,1335517901.55923,0.000976085662841797,"Syntax error! (cotent @ \"fast\" && _key == \"Groonga\")",[["yy_syntax_error","ecmascript.y",19]]],[]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/simple_query.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/simple_query.log 2012-04-27 18:16:07 +0900 (6f657ed)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries --match_columns content --query fast
+ [[0,1335517901.35577,0.000925779342651367],[[[2],[["_id","UInt32"],["_key","ShortText"],["content","Text"]],[2,"Groonga","I started to use groonga. It's very fast!"],[3,"Mroonga","I also started to use mroonga. It's also very fast! Really fast!"]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/simple_usage.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/simple_usage.log 2012-04-27 18:16:07 +0900 (a040d1f)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Entries
+ [[0,1335517901.15261,0.000388622283935547],[[[3],[["_id","UInt32"],["_key","ShortText"],["content","Text"]],[1,"The first post!","Welcome! This is my first post!"],[2,"Groonga","I started to use groonga. It's very fast!"],[3,"Mroonga","I also started to use mroonga. It's also very fast! Really fast!"]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/table_nonexistent.log (+5 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/table_nonexistent.log 2012-04-27 18:16:07 +0900 (b2598b2)
@@ -0,0 +1,5 @@
+Execution example::
+
+ > select Nonexistent
+ [[-22,1335517902.16486,0.000264406204223633,"invalid table name: <Nonexistent>",[["grn_select","proc.c",542]]]]
+
\ No newline at end of file
Added: doc/source/example/commands/select/usage_setup.log (+20 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/commands/select/usage_setup.log 2012-04-27 18:16:07 +0900 (6dda4a9)
@@ -0,0 +1,20 @@
+Execution example::
+
+ > table_create Entries TABLE_HASH_KEY ShortText
+ [[0,1335517898.93429,0.000363588333129883],true]
+ > column_create Entries content COLUMN_SCALAR Text
+ [[0,1335517899.13557,0.000916481018066406],true]
+ > table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram
+ [[0,1335517899.33727,0.000235080718994141],true]
+ > column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
+ [[0,1335517899.53841,0.00336003303527832],true]
+ > column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
+ [[0,1335517899.74272,0.00641012191772461],true]
+ > load --table Entries
+ > [
+ > {"_key": "The first post!", "content": "Welcome! This is my first post!"},
+ > {"_key": "Groonga", "content": "I started to use groonga. It's very fast!"}
+ > {"_key": "Mroonga", "content": "I also started to use mroonga. It's also very fast! Really fast!"}
+ > ]
+ [[0,1335517899.95004,1.00170755386353],3]
+
\ No newline at end of file
Added: doc/source/spec/query_syntax.txt (+90 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/spec/query_syntax.txt 2012-04-27 18:16:07 +0900 (bee574e)
@@ -0,0 +1,90 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: spec_query_syntax
+
+Query syntax
+============
+
+TODO: revised.
+
+一般的なWebページの検索フォームで使われるような書式を使って検索条件を指定することができます。これをクエリ構文と呼びます。
+
+クエリ構文は「条件式」と条件式を組み合わせる「結合式」からなります。
+
+条件式
+------
+
+以下の条件式が使用できます。
+
+``文字列``
+^^^^^^^^^^
+
+全文検索条件(デフォルト検索対象カラムの値が指定された文字列を含んでいる)
+
+``"文字列"``
+^^^^^^^^^^^^
+
+フレーズ検索条件(デフォルト検索対象カラムの値が指定されたフレーズを含んでいる)
+
+``カラム名:値``
+^^^^^^^^^^^^^^^
+
+一致条件( ``カラム値 == 値`` )
+
+``カラム名:!値``
+^^^^^^^^^^^^^^^^
+
+不一致条件( ``カラム値 != 値`` )
+
+``カラム名:<値``
+^^^^^^^^^^^^^^^^
+
+比較条件( ``カラム値 < 値`` )
+
+``カラム名:>値``
+^^^^^^^^^^^^^^^^
+
+比較条件( ``カラム値 > 値`` )
+
+``カラム名:<=値``
+^^^^^^^^^^^^^^^^
+
+比較条件( ``カラム値 <= 値`` )
+
+``カラム名:>=値``
+^^^^^^^^^^^^^^^^
+
+比較条件( ``カラム値 >= 値`` )
+
+``カラム名:@文字列``
+^^^^^^^^^^^^^^^^^^^
+
+全文検索条件(カラム値が指定された文字列を含んでいる)
+
+結合演算子
+---------
+
+複数の条件式を結合するために以下の演算子が使用できます。
+
+``a OR b``
+^^^^^^^^^^
+
+論理和( ``a`` と ``b`` といずれかの条件がマッチする)
+
+``a + b``
+^^^^^^^^^
+
+論理積( ``a`` と ``b`` の両方がマッチする)
+
+``a - b``
+^^^^^^^^^
+
+``a`` にマッチし、 ``b`` にはマッチしない
+
+``(...)``
+^^^^^^^^^
+
+複数の条件をまとめる
Added: doc/source/spec/script_syntax.txt (+11 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/spec/script_syntax.txt 2012-04-27 18:16:07 +0900 (f44149c)
@@ -0,0 +1,11 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: spec_script_syntax
+
+Script Syntax
+=============
+
+TODO...