YUKI Hiroshi
null+****@clear*****
Fri Nov 15 17:06:51 JST 2013
YUKI Hiroshi 2013-11-15 17:06:51 +0900 (Fri, 15 Nov 2013) New Revision: 05b6458eae225f7dfedbfe01ce693afc6b19b230 https://github.com/droonga/droonga.org/commit/05b6458eae225f7dfedbfe01ce693afc6b19b230 Message: Add description for "complex" format response Modified files: ja/reference/commands/search/index.md Modified: ja/reference/commands/search/index.md (+49 -17) =================================================================== --- ja/reference/commands/search/index.md 2013-11-15 16:53:00 +0900 (bc07f72) +++ ja/reference/commands/search/index.md 2013-11-15 17:06:51 +0900 (ec75e82) @@ -468,12 +468,15 @@ layout: documents ... ], "records" : [ - [レコード1のカラム1の値, レコード1のカラム2の値], - [レコード2のカラム1の値, レコード2のカラム2の値], + [レコード1のカラム1の値, レコード1のカラム2の値, ...], + [レコード2のカラム1の値, レコード2のカラム2の値, ...], ... ] } +これは、受け取ったデータの扱いやすさよりも、データの転送量を小さく抑える事を優先する出力形式です。 +大量のレコードを検索結果として受け取る場合や、多量のアクセスが想定される場合などに適しています。 + ##### `attributes` 出力されたレコードのカラムについての情報の配列で、[検索クエリの `output`](#query-output) における `attributes` で指定された順番で個々のカラムの情報を含みます。 @@ -505,26 +508,55 @@ layout: documents #### 複雑な形式のレスポンス -`type` が `"complex"` の場合のレスポンスは以下の形を取ります。 +`type` が `"complex"` の場合、個々の検索クエリの結果は以下の形を取ります。 { - "people" : { - "startTime" : "2001-08-02T10:45:23.5+09:00", - "elapsedTime" : 123.456, - "count" : 123, - "attributes" : { - "name" : { "type": "ShortText", "vector": false }, - "age" : { "type": "UInt32", "vector": false } - ], - "records" : [ - { "name" : "Alice", "age" : 10 }, - { "name" : "Bob", "age" : 20 } - ] - }, - ... + "startTime" : "検索を開始した時刻", + "elapsedTime" : 検索にかかった時間, + "count" : レコードの総数, + "attributes" : { + "カラム1の名前" : { "type" : "カラム1の型", + "vector" : カラム1がベクターカラムかどうか }, + "カラム2の名前" : { "type" : "カラム2の型", + "vector" : カラム2がベクターカラムかどうか }, + ... + ], + "records" : [ + { "カラム1" : "レコード1のカラム1の値", + "カラム2" : "レコード1のカラム2の値", + ... }, + { "カラム1" : "レコード2のカラム1の値", + "カラム2" : "レコード2のカラム2の値", + ... }, + ... + ] } +これは、データの転送量を小さく抑える事よりも、受け取ったデータの扱いやすさを優先する出力形式です。 +検索結果の件数が小さい事があらかじめ分かっている場合や、管理機能などのそれほど多量のアクセスが見込まれない場合などに適しています。 + ##### `attributes` +出力されたレコードのカラムについての情報を含むハッシュで、[検索クエリの `output`](#query-output) における `attributes` で指定された出力カラム名がキー、カラムの情報が値となります。 + +個々のカラムの情報はハッシュの形をとり、以下の情報を持ちます。 + +`type` +: カラムの値の型を示す文字列です。 + 値は[Groonga のプリミティブなデータ型](http://groonga.org/ja/docs/reference/types.html)の名前か、もしくはテーブル名です。 + +`vector` +: カラムが[ベクター型](http://groonga.org/ja/docs/tutorial/data.html#vector-types)かどうかを示す真偽値です。 + 以下のいずれかの値をとります。 + + * `true` : カラムはベクター型である。 + * `false` : カラムはベクター型ではない（スカラー型である）。 + ##### `records` +出力されたレコードの配列です。 + +個々のレコードは、[検索クエリの `output`](#query-output) における `attributes` で指定された出力カラム名をキー、カラムの値を値としたハッシュとなります。 + +[日時型](http://groonga.org/ja/docs/tutorial/data.html#date-and-time-type)のカラムの値は、[W3C-DTF](http://www.w3.org/TR/NOTE-datetime "Date and Time Formats")のタイムゾーンを含む形式の文字列として出力されます。 + -------------- next part -------------- HTML����������������������������...Download