Kouhei Sutou
null+****@clear*****
Fri Dec 27 16:30:51 JST 2013
Kouhei Sutou 2013-12-27 16:30:51 +0900 (Fri, 27 Dec 2013) New Revision: f50f6aa6fd49533113a782edbee6b2259e1cc78c https://github.com/droonga/droonga.org/commit/f50f6aa6fd49533113a782edbee6b2259e1cc78c Message: catalog: add glossary Modified files: reference/catalog/index.md Modified: reference/catalog/index.md (+82 -7) =================================================================== --- reference/catalog/index.md 2013-12-27 16:21:46 +0900 (542faef) +++ reference/catalog/index.md 2013-12-27 16:30:51 +0900 (8611003) @@ -3,16 +3,89 @@ title: catalog.json layout: documents --- -A droonga network consists of several resources. -**Catalog** is a series of data which represent the resources in the network. -**Catalog** is shared all the nodes in the network. -So far, a **catalog** is only a json file which must be written and delivered manually. -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. +A Droonga network consists of several resources. You need to describe +them in **catalog**. All the nodes in the network shares the same +catalog. + +This documentation describes about catalog. + +## How to share + +So far, you need to share catalog to all the nodes manually. + +Some utility programs will generate catalog in near feature. +Furthermore Droonga network will maintain and share catalog +automatically. + +## Glossary + +This section describes terms in catalog. + +Catalog +: Catalog is a series of data which represents the resources in the + network. + +Zone +: Zone is a set of farms. Each farm in a zone are expected to close to + each other, like in the same host, in the same switch, in the same + network. + +Farm +: Farm is a Droonga Engine instance. Droonga Engine is implemented as + a [Fluentd][] plugin, fluent-plugin-droonga. + + A `fluentd` process can have multiple Droonga Engines. If you add + one or more `match` entries with type `droonga` into `fluentd.conf`, + a `fluentd` process instantiates one or more Droonga Engines. + +Dataset +: Dataset is a set of logical tables. A logical table must belong to + only one dataset. + + Each dataset must have an unique name in the same Droonga network. + +Logical table +: Logical table consists of one or more partitioned physical tables. + Logical table doesn't have physical records. It returns physical + records from physical tables. + + You can custom how to partition a logical table into one or more + physical tables. For example, you can custom partition key, the + number of partitions and so on. + +Physical table +: Physical table is a table in Groonga database. It stores physical + records of the table. + +Ring +: Ring is a series of partition sets. Dataset must have one + ring. Dataset creates logical tables on the ring. + + Droonga Engine replicates each record in a logical table into one or + more partition sets. + +Partition set +: Partition set is a set of partitions. A partition set stores all + records in all logical tables in the same Droonga network. In other + words, dataset is partitioned in a partition set. + + A partition set is a replication of other partition set. + + Droonga Engine may support partitioning in one or more partition + sets in the future. It will be useful to use different partition + size for old data and new data. Normally, old data are smaller and + new data are bigger. It is reasonable that you use larger partition + size for bigger data. + +Partition +: Partition is a Groonga database. It has zero or more physical + tables. + + Note: Handler plugins in Droonga Engine work on a partition. ## Example -Here is a sample **catalog** for (TODO: describes about the +Here is a sample catalog for (TODO: describes about the configuration by the catalog): ~~~json @@ -102,3 +175,5 @@ If `0` is specified, no worker is forked and all operations are done in the mast ### `number_of_replicas` `number_of_replicas` represents the number of replicas of dataset maintained in the network. + + [Fluentd]: http://fluentd.org/ -------------- next part -------------- HTML����������������������������...Download