droonga/droonga.org at 0684905 [gh-pages] Add description of output parameters (Groonga-commit) - Groonga - fulltext search engine.

YUKI Hiroshi	2013-11-14 17:40:07 +0900 (Thu, 14 Nov 2013)

  New Revision: 068490552f5412b0030d2c7198908e49bfbd11d7
  https://github.com/droonga/droonga.org/commit/068490552f5412b0030d2c7198908e49bfbd11d7

  Message:
    Add description of output parameters

  Modified files:
    ja/reference/commands/search/index.md

  Modified: ja/reference/commands/search/index.md (+23 -17)
===================================================================

--- ja/reference/commands/search/index.md    2013-11-14 17:27:14 +0900 (442190d)
+++ ja/reference/commands/search/index.md    2013-11-14 17:40:07 +0900 (cef6e16)
@@ -337,24 +337,24 @@ layout: documents
 集約操作などのために必要な中間テーブルにあたる検索結果を求めるだけの検索クエリにおいては、 `output` を省略して処理時間や転送するデータ量を減らすことができます。
 
 `elements`
-: （未稿）
-
-<!--
-            "elements": [
-              "startTime",
-              "elapsedTime",
-              "count",
-              "attributes",
-              "records"
-            ],
-            // only the elements assigned in this array will be output.
--->
+: その検索クエリの結果として[レスポンス](#response)に出力する情報を、プロパティ名の文字列の配列で指定します。
+  以下の項目を指定できます。項目は1つだけ指定する場合であっても必ず配列で指定します。
+  
+   * `"startTime"`   : 検索を開始した時刻の文字列。
+   * `"elapsedTime"` : 検索にかかった時間の数値（単位：ミリ秒）。
+   * `"count"`       : 検索条件にヒットしたレコードの総数の数値。
+   * `"attributes"`  : 返却されたレコードのカラムの情報。
+   * `"records"`     : 返却されたレコードの配列。
+  
+  このパラメータは省略可能で、省略時の初期値はありません（結果を何も出力しません）。
 
 `format`
 : 以下のいずれかの値（文字列）を取ります。
   
-   * `"simple"`  : 単純なレコードの形式で検索結果を返却する。
-   * `"complex"` : 複雑なレコードの形式で検索結果を返却する
+   * `"simple"`  : 単純なレコードの形式で検索結果を返却します。
+   * `"complex"` : 複雑なレコードの形式で検索結果を返却します。
+  
+  このパラメータは省略可能で、省略時の初期値は `"simple"` です。
 
 `offset`
 : 返却するレコードのページングの起点を示す `0` または正の整数。
@@ -368,8 +368,14 @@ layout: documents
   このパラメータは省略可能で、省略時の既定値は `0` です。
 
 `attributes`
-: レコードのカラムの値についての、出力形式の指定の配列。
-  （未稿）
+: レコードのカラムの値について、出力形式を配列で指定します。
+  カラムの値の出力形式は、以下のいずれかで指定します。
+  
+   * カラム名の文字列。
+   * 詳細な出力形式指定のハッシュ。
+  
+  このパラメータは省略可能で、省略時の既定値はありません（カラムを何も出力しません）。
+
 
 <!--
             // The result can be sliced here
@@ -393,7 +399,7 @@ layout: documents
 -->
 
 
-## レスポンス
+## レスポンス {#response}
 
 このコマンドは、個々の検索クエリの名前をキー、[個々の検索クエリ](#query-parameters)の処理結果を値とした、以下のようなハッシュを返却します。
 
-------------- next part --------------
HTML����������������������������...
Download 


Groonga - fulltext search engine.

[Groonga-commit] droonga/droonga.org at 0684905 [gh-pages] Add description of output parameters