Yoji Shidara
null+****@clear*****
Thu Jan 30 15:07:45 JST 2014
Yoji Shidara 2014-01-30 15:07:45 +0900 (Thu, 30 Jan 2014) New Revision: 3b87dee793dfa382fb8d9cceac9f3f66e1fb6c82 https://github.com/droonga/droonga.org/commit/3b87dee793dfa382fb8d9cceac9f3f66e1fb6c82 Message: Write introduction to plugin development Added files: tutorial/plugin-development/index.md Added: tutorial/plugin-development/index.md (+49 -0) 100644 =================================================================== --- /dev/null +++ tutorial/plugin-development/index.md 2014-01-30 15:07:45 +0900 (5e40b42) @@ -0,0 +1,49 @@ +--- +title: Droonga plugin development tutorial +layout: en +--- + +!!WORK IN PROGRESS!! + +* TOC +{:toc} + +## The goal of this tutorial + +Learning steps to develop a Droonga plugin by yourself. + + +## Plugin + +Plugin is one of the most important concept of Droonga. +This makes droonga flexible. + +Generally, data processing tasks in real word need custom treatments of the data, in various stages of the data stream. This is not easy to done in one-size-fits-all approach. + +One may want to modify input queries to work well with other systems, one may want to modify output to help other systems understand the result. One may want to do more complex data processing than that provided by Droonga as built-in, to have direct storage access for efficiency. One may need to control data distribution logic and collection logic of Droonga to profit from distributed nature of Droonga. + +You can use plugins in those situations. + +## Types of plugins + +Droonga has 5 types of plugins corresponding to the purpose of plugin. +In other words, from the point of view of Droonga internal, the type of a plugin is distinguished by the component which the plugin is plugged in. See [overview][] to grasp the big picture. + +InputAdapterPlugin +: used to modify requests. + +OutputAdapterPlugin +: used to modify responses. + +HandlerPlugin +: used for low-level data handling. + +DistributorPlugin +: used to control internal message distribution. + +CollectorPlugin +: used to control internal message collection. + +In this tutorial, we focus on InputAdapterPlugin. This is the most "basic" plugin, so it will help you to understand the overview of Droonga plugin development. + + [overview]: ../../overview/ -------------- next part -------------- HTML����������������������������...Download
