Kouhei Sutou
null+****@clear*****
Fri Dec 27 14:24:23 JST 2013
Kouhei Sutou 2013-12-27 14:24:23 +0900 (Fri, 27 Dec 2013) New Revision: 5fe5d9dd609b74e762252af27df7ae2ecd258552 https://github.com/droonga/droonga.org/commit/5fe5d9dd609b74e762252af27df7ae2ecd258552 Message: doc catalog: move example before parameters descriptions Modified files: reference/catalog/index.md Modified: reference/catalog/index.md (+45 -40) =================================================================== --- reference/catalog/index.md 2013-12-26 19:49:34 +0900 (dfba838) +++ reference/catalog/index.md 2013-12-27 14:24:23 +0900 (7554da3) @@ -10,47 +10,10 @@ So far, a **catalog** is only a json file which must be written and delivered ma Hopefully it would be generated by some utility program in near future, furthermore it would be maintained automatically and shared via droonga network itself. Resources which **catalog** manages are as following. -### effective_date - -A date string representing the day the **catalog** becomes effective. - -### zones - -**Zone** is an array of **farms** (or other **zones**). The elements in a **zone** are expected to be close to each other, like in the same host, in the same switch, in the same network. - -### farms - -**Farms** correspond with fluent-plugin-droonga instances. A fluentd process may have multiple **farms** if more than one **match** entry with type **droonga** appear in the "fluentd.conf". -Each **farm** has its own job queue. -Each **farm** can attach to a data partition which is a part of a **dataset**. - -### datasets - -A **dataset** is a set of **tables** which comprise a single logical **table** virtually. -Each **dataset** must have a unique name in the network. - -### ring +## Example -**Ring** is a series of partitions which comprise a dataset. **replica_count**, **number\_of\_partitons** and **time-slice** factors affect the number of partitions in a **ring**. - -### workers - -**workers** is an integer number which specifies the number of worker processes to deal with the dataset. -If `0` is specified, no worker is forked and all operations are done in the master process. - -### number\_of\_partitions - -**number\_of\_partitions** is an integer number which represents the number of partitions divided by the hash function. The hash function which determines where each record resides the partition in a dataset is compatible with memcached. - -### date_range - -**date_range** determines when to split the dataset. If a string "infinity" is assigned, dataset is never split by time factor. - -### number\_of\_replicas - -**number\_of\_replicas** represents the number of replicas of dataset maintained in the network. - -### examples +Here is a sample **catalog** for (TODO: describes about the +configuration by the catalog): { "effective_date": "2013-06-05T00:05:51Z", @@ -95,3 +58,45 @@ If `0` is specified, no worker is forked and all operations are done in the mast } } } + +## Parameters + +### effective_date + +A date string representing the day the **catalog** becomes effective. + +### zones + +**Zone** is an array of **farms** (or other **zones**). The elements in a **zone** are expected to be close to each other, like in the same host, in the same switch, in the same network. + +### farms + +**Farms** correspond with fluent-plugin-droonga instances. A fluentd process may have multiple **farms** if more than one **match** entry with type **droonga** appear in the "fluentd.conf". +Each **farm** has its own job queue. +Each **farm** can attach to a data partition which is a part of a **dataset**. + +### datasets + +A **dataset** is a set of **tables** which comprise a single logical **table** virtually. +Each **dataset** must have a unique name in the network. + +### ring + +**Ring** is a series of partitions which comprise a dataset. **replica_count**, **number\_of\_partitons** and **time-slice** factors affect the number of partitions in a **ring**. + +### workers + +**workers** is an integer number which specifies the number of worker processes to deal with the dataset. +If `0` is specified, no worker is forked and all operations are done in the master process. + +### number\_of\_partitions + +**number\_of\_partitions** is an integer number which represents the number of partitions divided by the hash function. The hash function which determines where each record resides the partition in a dataset is compatible with memcached. + +### date_range + +**date_range** determines when to split the dataset. If a string "infinity" is assigned, dataset is never split by time factor. + +### number\_of\_replicas + +**number\_of\_replicas** represents the number of replicas of dataset maintained in the network. -------------- next part -------------- HTML����������������������������...Download