YUKI Hiroshi
null+****@clear*****
Thu Mar 6 13:56:56 JST 2014
YUKI Hiroshi 2014-03-06 13:56:56 +0900 (Thu, 06 Mar 2014) New Revision: 966afeb4c5fc8d5a321e92af851287dcb2e9c510 https://github.com/droonga/droonga.org/commit/966afeb4c5fc8d5a321e92af851287dcb2e9c510 Message: Describe about SingleStepDefinition#write= Modified files: reference/plugin/handler/index.md Modified: reference/plugin/handler/index.md (+11 -2) =================================================================== --- reference/plugin/handler/index.md 2014-03-06 13:47:51 +0900 (c0ad46b) +++ reference/plugin/handler/index.md 2014-03-06 13:56:56 +0900 (7ef2e87) @@ -91,6 +91,8 @@ This provides methods to describe the "step" corresponding to the handler. #### `#name=(name)` {#classes-Droonga-SingleStepDefinition-name} Describes the name of the step itself. +Possible value is a string. + The Droonga Engine treats an incoming message as a request of a "command", if there is any step with the `name` which equals to the message's `type`. In other words, this defines the name of the command corresponding to the step itself. @@ -109,7 +111,6 @@ You can specify the class as any one of following choices: This is also useful to define the class itself after the description. You must define the class by the time it is actually used. - #### `#collector=(collector)` {#classes-Droonga-SingleStepDefinition-collector} Associates a specific collector class to the step itself. @@ -128,7 +129,15 @@ See also [descriptions of collectors][collector]. #### `#write=(write)` {#classes-Droonga-SingleStepDefinition-write} -(TBD) +Describes whether the step modifies any data in the storage or don't. +If a request aims to modify some data in the storage, the request must be processed for all replicas. +Otherwise the Droonga Engine can optimize handling of the step. +For example, caching of results, reducing of CPU/memory resources, and so on. + +Possible values are: + + * `true`, means "this step can modify the storage." + * `false`, means "this step never modifies the storage." #### `#inputs=(inputs)` {#classes-Droonga-SingleStepDefinition-inputs} -------------- next part -------------- HTML����������������������������...Download
