Kouhei Sutou
null+****@clear*****
Fri Dec 27 16:57:48 JST 2013
Kouhei Sutou 2013-12-27 16:57:48 +0900 (Fri, 27 Dec 2013) New Revision: 1ed8baabbb65d2039ff103082be7a21308c0e220 https://github.com/droonga/droonga.org/commit/1ed8baabbb65d2039ff103082be7a21308c0e220 Message: catalog: describe version and effective_date Modified files: reference/catalog/index.md Modified: reference/catalog/index.md (+32 -2) =================================================================== --- reference/catalog/index.md 2013-12-27 16:50:03 +0900 (5f94cd8) +++ reference/catalog/index.md 2013-12-27 16:57:48 +0900 (21f14fa) @@ -163,11 +163,40 @@ Here are descriptions about parameters in `catalog.json`. ### `version` -It is the format version of the catalog file. +It is format version of the catalog file. + +Droonga Engine will change `catalog.json` format in the +future. Droonga Engine can provide auto format update feature with the +information. + +The value must be `1`. + +This is a required parameter. + +Example: + +~~~json +{ + "version": 1 +} +~~~ ### `effective_date` -A date string representing the day the **catalog** becomes effective. +It is a date string representing the day the catalog becomes +effective. + +The date string format must be [W3C-DTF][]. + +Note: Droonga Engine 0.8.0 doesn't use this value yet. + +Example: + +~~~json +{ + "effective_date": "2013-11-29T11:29:29Z" +} +~~~ ### `zones` @@ -206,3 +235,4 @@ If `0` is specified, no worker is forked and all operations are done in the mast `number_of_replicas` represents the number of replicas of dataset maintained in the network. [Fluentd]: http://fluentd.org/ + [W3C-DTF]: http://www.w3.org/TR/NOTE-datetime "Date and Time Formats" -------------- next part -------------- HTML����������������������������...Download