overview.md

命名

建议插件名使用 camel case 形式。插件命名有一些限制：

1. 插件输出变量必须为插件名的首字母大写形式。 例如，插件名为 file ，则其输出变量名必须为 File。
2. .so 文件的名字必须与输出变量名或者插件名相同。例如， MySource.so 或 mySink.so。

扩展

Kuiper 允许用户自定义不同类型的扩展。

• 源扩展用于扩展不同的流源，例如使用来自其他消息服务器的数据。Kuiper 对 MQTT 消息服务器的内置源提供支持。
• Sink/Action 扩展用于将发布/推送数据扩展到不同的目标，例如数据库，其他消息系统，Web 界面或文件系统。Kuiper 中提供内置动作支持，请参阅 MQTT & 日志文件.。
• 函数扩展允许用户扩展 SQL 中使用的不同函数。 Kuiper支持内置函数，请参见 functions。

请阅读以下内容，了解如何实现不同的扩展。

• 源扩展
• Sink/Action 扩展
• 函数扩展

状态存储

Kuiper 扩展通过 context 参数暴露了一个基于键值对的状态存储接口，可用于所有类型的扩展，包括 Source，Sink 和 Function 扩展.

状态为键值对，其中键为 string 类型而值为任意数据。键的作用域仅为当前扩展的实例。

用户可通过 context 对象访问状态存储。状态相关方法包括 putState, getState, incrCounter, getCounter and deleteState。

以下代码为函数扩展访问状态的实例。该函数将计算传入的单词数，并将累积数目保存在状态中。

func (f *accumulateWordCountFunc) Exec(args []interface{}, ctx api.FunctionContext) (interface{}, bool) {
    logger := ctx.GetLogger()    
	err := ctx.IncrCounter("allwordcount", len(strings.Split(args[0], args[1])))
	if err != nil {
		return err, false
	}
	if c, err := ctx.GetCounter("allwordcount"); err != nil   {
		return err, false
	} else {
		return c, true
	}
}