Yoji Shidara
null+****@clear*****
Thu Mar 6 16:54:20 JST 2014
Yoji Shidara 2014-03-06 16:54:20 +0900 (Thu, 06 Mar 2014) New Revision: 683992ffbd4e61f52b9fa168ff2b3f6bcf39b154 https://github.com/droonga/droonga.org/commit/683992ffbd4e61f52b9fa168ff2b3f6bcf39b154 Message: ja: Update translations on catalog/version2 Modified files: _po/ja/reference/catalog/version2/index.po ja/reference/catalog/version2/index.md Modified: _po/ja/reference/catalog/version2/index.po (+301 -28) =================================================================== --- _po/ja/reference/catalog/version2/index.po 2014-03-06 16:50:38 +0900 (eb86726) +++ _po/ja/reference/catalog/version2/index.po 2014-03-06 16:54:20 +0900 (8432746) @@ -123,7 +123,10 @@ msgstr "" "値\n" ": 以下のキーと値のペアを持つオブジェクト。" -msgid "#### `version` {#parameter-version}" +msgid "#### Parameters" +msgstr "" + +msgid "##### `version` {#parameter-version}" msgstr "" msgid "" @@ -155,7 +158,7 @@ msgstr "" "継承可能性\n" ": 不可。" -msgid "#### `effectiveDate` {#parameter-effective_date}" +msgid "##### `effectiveDate` {#parameter-effective_date}" msgstr "" msgid "" @@ -174,7 +177,7 @@ msgstr "" ": [W3C-DTF](http://www.w3.org/TR/NOTE-datetime \"Date and Time Formats\") でフォーマッ" "トされたタイムゾーン付きの時刻。" -msgid "#### `datasets` {#parameter-datasets}" +msgid "##### `datasets` {#parameter-datasets}" msgstr "" msgid "" @@ -190,7 +193,7 @@ msgid "" "ion](#dataset)." msgstr ": データセット名をキーとし、[`dataset` 定義](#dataset) を値とするオブジェクト。" -msgid "#### `nWorkers` {#parameter-n_workers}" +msgid "##### `nWorkers` {#parameter-n_workers}" msgstr "" msgid "" @@ -221,10 +224,27 @@ msgstr "" "継承可能性\n" ": 可。`dataset`と`volume`の定義でオーバライドできます。" +msgid "#### Example" +msgstr "" + +msgid "A version 2 catalog effective after `2013-09-01T00:00:00Z`, with no datasets:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"version\": 2,\n" +" \"effectiveDate\": \"2013-09-01T00:00:00Z\",\n" +" \"datasets\": {\n" +" }\n" +"}\n" +"~~~" +msgstr "" + msgid "### Dataset definition {#dataset}" msgstr "### Dataset 定義 {#dataset}" -msgid "#### `plugins` {#parameter-plugins}" +msgid "##### `plugins` {#parameter-plugins}" msgstr "" msgid "" @@ -241,7 +261,7 @@ msgstr "" "値\n" ": 文字列の配列。" -msgid "#### `schema` {#parameter-schema}" +msgid "##### `schema` {#parameter-schema}" msgstr "" msgid "" @@ -259,7 +279,7 @@ msgstr "" "値\n" ": テーブル名をキーとし、[`table` 定義](#table)を値とするオブジェクト。" -msgid "#### `fact` {#parameter-fact}" +msgid "##### `fact` {#parameter-fact}" msgstr "" msgid "" @@ -287,7 +307,7 @@ msgstr "" "デフォルト値\n" ": なし。" -msgid "#### `replicas` {#parameter-replicas}" +msgid "##### `replicas` {#parameter-replicas}" msgstr "" msgid "" @@ -304,10 +324,26 @@ msgstr "" "値\n" ": [`volume` 定義](#volume)の配列。" +msgid "A dataset with 4 workers, with plugins `groonga`, `crud` and `search`:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"nWorkers\": 4,\n" +" \"plugins\": [\"groonga\", \"crud\", \"search\"],\n" +" \"schema\": {\n" +" },\n" +" \"replicas\": [\n" +" ]\n" +"}\n" +"~~~" +msgstr "" + msgid "### Table definition {#table}" msgstr "### Table 定義 {#table}" -msgid "#### `type` {#parameter-table-type}" +msgid "##### `type` {#parameter-table-type}" msgstr "" msgid "" @@ -332,7 +368,7 @@ msgid "" ": \"Hash\"" msgstr "" -msgid "#### `keyType` {#parameter-keyType}" +msgid "##### `keyType` {#parameter-keyType}" msgstr "" msgid "" @@ -361,7 +397,7 @@ msgid "" ": None. Mandatory for tables with keys." msgstr "" -msgid "#### `tokenizer` {#parameter-tokenizer}" +msgid "##### `tokenizer` {#parameter-tokenizer}" msgstr "" msgid "" @@ -390,7 +426,7 @@ msgid "" "* \"TokenDelimitNull\"" msgstr "" -msgid "#### `normalizer` {#parameter-normalizer}" +msgid "##### `normalizer` {#parameter-normalizer}" msgstr "" msgid "" @@ -409,7 +445,7 @@ msgid "" "* \"NormalizerNFKC51\"" msgstr "" -msgid "#### `columns` {#parameter-columns}" +msgid "##### `columns` {#parameter-columns}" msgstr "" msgid "" @@ -423,6 +459,47 @@ msgid "" "n](#column)." msgstr "" +msgid "#### Examples" +msgstr "" + +msgid "##### Example 1: Hash table" +msgstr "" + +msgid "A `Hash` table whose key is `ShortText` type, with no columns:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"type\": \"Hash\",\n" +" \"keyType\": \"ShortText\",\n" +" \"columns\": {\n" +" }\n" +"}\n" +"~~~" +msgstr "" + +msgid "##### Example 2: PatriciaTrie table" +msgstr "" + +msgid "" +"A `PatriciaTrie` table with `TokenBigram` tokenizer and `NormalizerAuto` norma" +"lizer, with no columns:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"type\": \"PatriciaTrie\",\n" +" \"keyType\": \"ShortText\",\n" +" \"tokenizer\": \"TokenBigram\",\n" +" \"normalizer\": \"NormalizerAuto\",\n" +" \"columns\": {\n" +" }\n" +"}\n" +"~~~" +msgstr "" + msgid "### Column definition {#column}" msgstr "### Column 定義 {#column}" @@ -432,7 +509,7 @@ msgstr "値" msgid ": An object with the following key/value pairs." msgstr "" -msgid "#### `type` {#parameter-column-type}" +msgid "##### `type` {#parameter-column-type}" msgstr "" msgid "" @@ -457,7 +534,7 @@ msgid "" ": \"Scalar\"" msgstr "" -msgid "#### `valueType` {#parameter-valueType}" +msgid "##### `valueType` {#parameter-valueType}" msgstr "" msgid "" @@ -484,7 +561,7 @@ msgid "" ") based geometric point value." msgstr "" -msgid "#### `indexOptions` {#parameter-indexOptions}" +msgid "##### `indexOptions` {#parameter-indexOptions}" msgstr "" msgid "" @@ -502,10 +579,45 @@ msgid "" ": `{}` (Void object)." msgstr "" +msgid "##### Example 1: Scalar column" +msgstr "" + +msgid "A scaler column to store `ShortText` values:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"type\": \"Scalar\",\n" +" \"valueType\": \"ShortText\"\n" +"}\n" +"~~~" +msgstr "" + +msgid "##### Example 2: Index column" +msgstr "" + +msgid "A column to index `address` column on `Store` table:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"type\": \"Index\",\n" +" \"valueType\": \"Store\",\n" +" \"indexOptions\": {\n" +" \"sources\": [\n" +" \"address\"\n" +" ]\n" +" }\n" +"}\n" +"~~~" +msgstr "" + msgid "### indexOption definition {#indexOption}" msgstr "### indexOption 定義 {#indexOption}" -msgid "#### `section` {#parameter-section}" +msgid "##### `section` {#parameter-section}" msgstr "" msgid "" @@ -525,7 +637,7 @@ msgid "" ": `false`." msgstr "" -msgid "#### `weight` {#parameter-weight}" +msgid "##### `weight` {#parameter-weight}" msgstr "" msgid "" @@ -534,7 +646,7 @@ msgid "" "a is used for indicating the importance of the value in the sources." msgstr "" -msgid "#### `position` {#parameter-position}" +msgid "##### `position` {#parameter-position}" msgstr "" msgid "" @@ -544,7 +656,7 @@ msgid "" "es. It is indispensable for fast and accurate phrase-search." msgstr "" -msgid "#### `sources` {#parameter-sources}" +msgid "##### `sources` {#parameter-sources}" msgstr "" msgid "" @@ -558,6 +670,25 @@ msgid "" "#parameter-valueType)." msgstr "" +msgid "" +"Store the section data, the weight data and the position data.\n" +"Index `name` and `address` on the referencing table." +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"section\": true,\n" +" \"weight\": true,\n" +" \"position\": true\n" +" \"sources\": [\n" +" \"name\",\n" +" \"address\"\n" +" ]\n" +"}\n" +"~~~" +msgstr "" + msgid "### Volume definition {#volume}" msgstr "### Volume 定義 {#volume}" @@ -574,7 +705,50 @@ msgstr "" "集合で構成されます。ボリュームが単一のデータベースインスタンスから構成される場合は、`address`パラメータを指定しなければなりません。このとき、それ以" "外のパラメータを指定してはいけません。そうでない場合は、`dimension`と`slicer`と`slices`が必須で、他は指定してはいけません。" -msgid "#### `address` {#parameter-address}" +msgid "#### Types of Slicers {#types-of-slicers}" +msgstr "" + +msgid "" +"In order to define a volume which consists of a collection of `slices`,\n" +"the way how slice recodes into slices must be decided." +msgstr "" + +msgid "" +"The slicer function that specified as `slicer` and\n" +"the column (or key) specified as `dimension`,\n" +"which is input for the slicer function, defines that." +msgstr "" + +msgid "Slicers are categorized into three types. Here are three types of slicers:" +msgstr "" + +msgid "##### Ratio-scaled" +msgstr "" + +msgid "" +"*Ratio-scaled slicers* slice datapoints in the specified ratio,\n" +"e.g. hash function of _key." +msgstr "" + +msgid "##### Ordinal-scaled" +msgstr "" + +msgid "" +"*Ordinal-scaled slicers* slice datapoints with ordinal values;\n" +"the values have some ranking, e.g. time, integer,\n" +"element of `{High, Middle, Low}`." +msgstr "" + +msgid "##### Nominal-scaled" +msgstr "" + +msgid "" +"*Nominal-scaled slicers* slice datapoints with nominal values;\n" +"the values denotes categories,which have no order,\n" +"e.g. country, zip code, color." +msgstr "" + +msgid "##### `address` {#parameter-address}" msgstr "" msgid "" @@ -601,7 +775,7 @@ msgstr "" "* database_type: 省略可能。デフォルト値は\"groonga\"。\n" "* port_number: 省略可能。デフォルト値は 10047。" -msgid "#### `dimension` {#parameter-dimension}" +msgid "##### `dimension` {#parameter-dimension}" msgstr "" msgid "" @@ -623,7 +797,7 @@ msgstr "" "デフォルト値\n" ": \"_key\"" -msgid "#### `slicer` {#parameter-slicer}" +msgid "##### `slicer` {#parameter-slicer}" msgstr "" msgid "" @@ -647,7 +821,7 @@ msgstr "" "デフォルト値\n" ": \"hash\"" -msgid "#### `slices` {#parameter-slices}" +msgid "##### `slices` {#parameter-slices}" msgstr "" msgid "" @@ -664,6 +838,48 @@ msgstr "" "値\n" ": [`slice` 定義](#slice)の配列。" +msgid "##### Example 1: Single instance" +msgstr "" + +msgid "A volume at \"localhost:24224/volume.000\":" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"address\": \"localhost:24224/volume.000\"\n" +"}\n" +"~~~" +msgstr "" + +msgid "##### Example 2: Slices" +msgstr "" + +msgid "" +"A volume that consists of three slices, records are to be distributed accordin" +"g to `hash`,\n" +"which is ratio-scaled slicer function, of `_key`." +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"dimension\": \"_key\",\n" +" \"slicer\": \"hash\",\n" +" \"slices\": {\n" +" \"volume\": {\n" +" \"address\": \"localhost:24224/volume.000\"\n" +" },\n" +" \"volume\": {\n" +" \"address\": \"localhost:24224/volume.001\"\n" +" },\n" +" \"volume\": {\n" +" \"address\": \"localhost:24224/volume.002\"\n" +" }\n" +" }\n" +"~~~" +msgstr "" + msgid "### Slice definition {#slice}" msgstr "### Slice 定義 {#slice}" @@ -675,7 +891,7 @@ msgstr "" "概要\n" ": スライスの定義。スライスされたデータの範囲と、それを保存するボリュームを指定する。" -msgid "#### `weight` {#parameter-slice-weight}" +msgid "##### `weight` {#parameter-slice-weight}" msgstr "" msgid "" @@ -700,7 +916,7 @@ msgstr "" "デフォルト値\n" ": `1`" -msgid "#### `label` {#parameter-label}" +msgid "##### `label` {#parameter-label}" msgstr "" msgid "" @@ -718,7 +934,7 @@ msgid "" "hed. Therefore, only one slice without `label` is allowed in slices." msgstr "" -msgid "#### `boundary` {#parameter-boundary}" +msgid "##### `boundary` {#parameter-boundary}" msgstr "" msgid "" @@ -736,7 +952,7 @@ msgid "" ", only one slice without `boundary` is allowed in a slices." msgstr "" -msgid "#### `volume` {#parameter-volume}" +msgid "##### `volume` {#parameter-volume}" msgstr "" msgid "" @@ -748,3 +964,60 @@ msgstr "" msgid ": An object which is a [`volume` definition](#volume)" msgstr ": [`volume` 定義](#volume)オブジェクト" + +msgid "##### Example 1: Ratio-scaled" +msgstr "" + +msgid "Slice for a ratio-scaled slicer, with the weight `1`:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"weight\": 1,\n" +" \"volume\": {\n" +" }\n" +"}\n" +"~~~" +msgstr "" + +msgid "##### Example 2: Nominal-scaled" +msgstr "" + +msgid "Slice for a nominal-scaled slicer, with the label `\"1\"`:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"label\": \"1\",\n" +" \"volume\": {\n" +" }\n" +"}\n" +"~~~" +msgstr "" + +msgid "##### Example 3: Ordinal-scaled" +msgstr "" + +msgid "Slice for a ordinal-scaled slicer, with the boundary `100`:" +msgstr "" + +msgid "" +"~~~\n" +"{\n" +" \"boundary\": 100,\n" +" \"volume\": {\n" +" }\n" +"}\n" +"~~~" +msgstr "" + +msgid "## Realworld example" +msgstr "" + +msgid "See the catalog of [basic tutorial]." +msgstr "" + +msgid " [basic tutorial]: ../../../tutorial/basic" +msgstr "" Modified: ja/reference/catalog/version2/index.md (+253 -28) =================================================================== --- ja/reference/catalog/version2/index.md 2014-03-06 16:50:38 +0900 (21b712b) +++ ja/reference/catalog/version2/index.md 2014-03-06 16:54:20 +0900 (9c52799) @@ -92,7 +92,9 @@ layout: ja 値 : 以下のキーと値のペアを持つオブジェクト。 -#### `version` {#parameter-version} +#### Parameters + +##### `version` {#parameter-version} 概要 : カタログファイルのバージョン番号。 @@ -106,7 +108,7 @@ layout: ja 継承可能性 : 不可。 -#### `effectiveDate` {#parameter-effective_date} +##### `effectiveDate` {#parameter-effective_date} 概要 : このカタログが有効になる時刻。 @@ -120,7 +122,7 @@ layout: ja 継承可能性 : 不可。 -#### `datasets` {#parameter-datasets} +##### `datasets` {#parameter-datasets} 概要 : データセットの定義。 @@ -133,7 +135,7 @@ layout: ja 継承可能性 : 不可。 -#### `nWorkers` {#parameter-n_workers} +##### `nWorkers` {#parameter-n_workers} 概要 : データベースインスタンス毎にspawnされるワーカの数。 @@ -147,12 +149,28 @@ layout: ja 継承可能性 : 可。`dataset`と`volume`の定義でオーバライドできます。 + +#### Example + +A version 2 catalog effective after `2013-09-01T00:00:00Z`, with no datasets: + +~~~ +{ + "version": 2, + "effectiveDate": "2013-09-01T00:00:00Z", + "datasets": { + } +} +~~~ + ### Dataset 定義 {#dataset} 値 : 以下のキーと値のペアを持つオブジェクト。 -#### `plugins` {#parameter-plugins} +#### Parameters + +##### `plugins` {#parameter-plugins} 概要 : このデータセットにおいて有効にするプラグイン名文字列の配列。 @@ -166,7 +184,7 @@ layout: ja 継承可能性 : 可。`dataset`と`volume`の定義でオーバライドできます。 -#### `schema` {#parameter-schema} +##### `schema` {#parameter-schema} 概要 : テーブルとそのカラムの定義。 @@ -180,7 +198,7 @@ layout: ja 継承可能性 : 可。`dataset`と`volume`の定義でオーバライドできます。 -#### `fact` {#parameter-fact} +##### `fact` {#parameter-fact} 概要 : fact テーブルの名前。`dataset`が複数の`slice`に格納される場合、[`schema`](#parameter-schema)パラメータで定義されたテーブルの中から、1つ[fact table](http://en.wikipedia.org/wiki/Fact_table)を選択する必要があります。 @@ -194,7 +212,7 @@ layout: ja 継承可能性 : 可。`dataset`と`volume`の定義でオーバライドできます。 -#### `replicas` {#parameter-replicas} +##### `replicas` {#parameter-replicas} 概要 : 互いに複製されるボリュームの集合。 @@ -208,12 +226,29 @@ layout: ja 継承可能性 : 不可。 +#### Example + +A dataset with 4 workers, with plugins `groonga`, `crud` and `search`: + +~~~ +{ + "nWorkers": 4, + "plugins": ["groonga", "crud", "search"], + "schema": { + }, + "replicas": [ + ] +} +~~~ + ### Table 定義 {#table} 値 : 以下のキーと値のペアを持つオブジェクト。 -#### `type` {#parameter-table-type} +#### Parameters + +##### `type` {#parameter-table-type} Abstract : Specifies which data structure is used for managing keys of the table. @@ -232,7 +267,7 @@ Default value 継承可能性 : 不可。 -#### `keyType` {#parameter-keyType} +##### `keyType` {#parameter-keyType} Abstract : Data type of the key of the table. Mustn't be assigned when the `type` is "Array". @@ -253,7 +288,7 @@ Default value 継承可能性 : 不可。 -#### `tokenizer` {#parameter-tokenizer} +##### `tokenizer` {#parameter-tokenizer} Abstract : Specifies the type of tokenizer used for splitting each text value, when the table is used as a lexicon. Only available when the `keyType` is "ShortText". @@ -280,7 +315,7 @@ Value 継承可能性 : 不可。 -#### `normalizer` {#parameter-normalizer} +##### `normalizer` {#parameter-normalizer} Abstract : Specifies the type of normalizer which normalizes and restricts the key values. Only available when the `keyType` is "ShortText". @@ -297,7 +332,7 @@ Value 継承可能性 : 不可。 -#### `columns` {#parameter-columns} +##### `columns` {#parameter-columns} Abstract : Column definition for the table. @@ -311,13 +346,45 @@ Value 継承可能性 : 不可。 +#### Examples + +##### Example 1: Hash table + +A `Hash` table whose key is `ShortText` type, with no columns: + +~~~ +{ + "type": "Hash", + "keyType": "ShortText", + "columns": { + } +} +~~~ + +##### Example 2: PatriciaTrie table + +A `PatriciaTrie` table with `TokenBigram` tokenizer and `NormalizerAuto` normalizer, with no columns: + +~~~ +{ + "type": "PatriciaTrie", + "keyType": "ShortText", + "tokenizer": "TokenBigram", + "normalizer": "NormalizerAuto", + "columns": { + } +} +~~~ + ### Column 定義 {#column} 値 : An object with the following key/value pairs. -#### `type` {#parameter-column-type} +#### Parameters + +##### `type` {#parameter-column-type} Abstract : Specifies the quantity of data stored as each column value. @@ -335,7 +402,7 @@ Default value 継承可能性 : 不可。 -#### `valueType` {#parameter-valueType} +##### `valueType` {#parameter-valueType} Abstract : Data type of the column value. @@ -358,7 +425,7 @@ Value 継承可能性 : 不可。 -#### `indexOptions` {#parameter-indexOptions} +##### `indexOptions` {#parameter-indexOptions} Abstract : Specifies the optional properties of a "Index" column. @@ -372,12 +439,43 @@ Default value 継承可能性 : 不可。 +#### Examples + +##### Example 1: Scalar column + +A scaler column to store `ShortText` values: + +~~~ +{ + "type": "Scalar", + "valueType": "ShortText" +} +~~~ + +##### Example 2: Index column + +A column to index `address` column on `Store` table: + +~~~ +{ + "type": "Index", + "valueType": "Store", + "indexOptions": { + "sources": [ + "address" + ] + } +} +~~~ + ### indexOption 定義 {#indexOption} 値 : 以下のキーと値のペアを持つオブジェクト。 -#### `section` {#parameter-section} +#### Parameters + +##### `section` {#parameter-section} Abstract : Specifies whether the index column stores the section data or not. Section data is typically used for distinguishing in which part of the sources the value appears. @@ -391,7 +489,7 @@ Default value 継承可能性 : 不可。 -#### `weight` {#parameter-weight} +##### `weight` {#parameter-weight} Abstract : Specifies whether the index column stores the weight data or not. Weight data is used for indicating the importance of the value in the sources. @@ -405,7 +503,7 @@ Default value 継承可能性 : 不可。 -#### `position` {#parameter-position} +##### `position` {#parameter-position} Abstract : Specifies whether the index column stores the position data or not. Position data is used for specifying the position where the value appears in the sources. It is indispensable for fast and accurate phrase-search. @@ -419,7 +517,7 @@ Default value 継承可能性 : 不可。 -#### `sources` {#parameter-sources} +##### `sources` {#parameter-sources} Abstract : Makes the column an inverted index of the referencing table's columns. @@ -433,6 +531,23 @@ Value 継承可能性 : 不可。 +#### Example + +Store the section data, the weight data and the position data. +Index `name` and `address` on the referencing table. + +~~~ +{ + "section": true, + "weight": true, + "position": true + "sources": [ + "name", + "address" + ] +} +~~~ + ### Volume 定義 {#volume} 概要 @@ -441,7 +556,37 @@ Value 値 : 以下のキーと値のペアを持つオブジェクト。 -#### `address` {#parameter-address} +#### Types of Slicers {#types-of-slicers} + +In order to define a volume which consists of a collection of `slices`, +the way how slice recodes into slices must be decided. + +The slicer function that specified as `slicer` and +the column (or key) specified as `dimension`, +which is input for the slicer function, defines that. + +Slicers are categorized into three types. Here are three types of slicers: + +##### Ratio-scaled + +*Ratio-scaled slicers* slice datapoints in the specified ratio, +e.g. hash function of _key. + +##### Ordinal-scaled + +*Ordinal-scaled slicers* slice datapoints with ordinal values; +the values have some ranking, e.g. time, integer, +element of `{High, Middle, Low}`. + +##### Nominal-scaled + +*Nominal-scaled slicers* slice datapoints with nominal values; +the values denotes categories,which have no order, +e.g. country, zip code, color. + +#### Parameters + +##### `address` {#parameter-address} 概要 : データベースインスタンスの場所を指定します。 @@ -460,7 +605,7 @@ Value 継承可能性 : 不可。 -#### `dimension` {#parameter-dimension} +##### `dimension` {#parameter-dimension} 概要 : fact表の中でレコードをスライスする次元を指定します。fact表の'_key'または[`columns`](#parameter-columns)からスカラー型のカラムを選択します。[dimension](http://en.wikipedia.org/wiki/Dimension_%28data_warehouse%29)を参照してください。 @@ -474,7 +619,7 @@ Value 継承可能性 : 可。`dataset`と`volume`の定義でオーバライドできます。 -#### `slicer` {#parameter-slicer} +##### `slicer` {#parameter-slicer} 概要 : dimensionカラムをsliceする関数。 @@ -488,7 +633,7 @@ Value 継承可能性 : 可。`dataset`と`volume`の定義でオーバライドできます。 -#### `slices` {#parameter-slices} +##### `slices` {#parameter-slices} 概要 : データを格納するスライスの定義。 @@ -502,6 +647,40 @@ Value 継承可能性 : 不可。 +#### Examples + +##### Example 1: Single instance + +A volume at "localhost:24224/volume.000": + +~~~ +{ + "address": "localhost:24224/volume.000" +} +~~~ + +##### Example 2: Slices + +A volume that consists of three slices, records are to be distributed according to `hash`, +which is ratio-scaled slicer function, of `_key`. + +~~~ +{ + "dimension": "_key", + "slicer": "hash", + "slices": { + "volume": { + "address": "localhost:24224/volume.000" + }, + "volume": { + "address": "localhost:24224/volume.001" + }, + "volume": { + "address": "localhost:24224/volume.002" + } + } +~~~ + ### Slice 定義 {#slice} 概要 @@ -510,7 +689,9 @@ Value 値 : 以下のキーと値のペアを持つオブジェクト。 -#### `weight` {#parameter-slice-weight} +#### Parameters + +##### `weight` {#parameter-slice-weight} 概要 : スライス内での割り当て量を指定します。`slicer`が atio-scaledの場合のみ有効。 @@ -524,7 +705,7 @@ Value 継承可能性 : 不可。 -#### `label` {#parameter-label} +##### `label` {#parameter-label} 概要 : slicer が返す具体的な値。 slicerがnominal-scaledの場合のみ有効。 @@ -538,7 +719,7 @@ Value 継承可能性 : 不可。 -#### `boundary` {#parameter-boundary} +##### `boundary` {#parameter-boundary} 概要 : `slicer`の返す値と比較可能な具体的な値。`slicer`がordinal-scaledの場合のみ有効。 @@ -552,7 +733,7 @@ Value 継承可能性 : 不可。 -#### `volume` {#parameter-volume} +##### `volume` {#parameter-volume} 概要 : スライスに対応するデータを格納するボリューム。 @@ -566,3 +747,47 @@ Value 継承可能性 : 不可。 + +#### Examples + +##### Example 1: Ratio-scaled + +Slice for a ratio-scaled slicer, with the weight `1`: + +~~~ +{ + "weight": 1, + "volume": { + } +} +~~~ + +##### Example 2: Nominal-scaled + +Slice for a nominal-scaled slicer, with the label `"1"`: + +~~~ +{ + "label": "1", + "volume": { + } +} +~~~ + +##### Example 3: Ordinal-scaled + +Slice for a ordinal-scaled slicer, with the boundary `100`: + +~~~ +{ + "boundary": 100, + "volume": { + } +} +~~~ + +## Realworld example + +See the catalog of [basic tutorial]. + + [basic tutorial]: ../../../tutorial/basic -------------- next part -------------- HTML����������������������������...Download