xsql_processor.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532
  1. package processors
  2. import (
  3. "bytes"
  4. "encoding/json"
  5. "github.com/emqx/kuiper/common"
  6. "github.com/emqx/kuiper/common/plugin_manager"
  7. "github.com/emqx/kuiper/xsql"
  8. "github.com/emqx/kuiper/xsql/plans"
  9. "github.com/emqx/kuiper/xstream"
  10. "github.com/emqx/kuiper/xstream/api"
  11. "github.com/emqx/kuiper/xstream/extensions"
  12. "github.com/emqx/kuiper/xstream/nodes"
  13. "github.com/emqx/kuiper/xstream/operators"
  14. "github.com/emqx/kuiper/xstream/sinks"
  15. "fmt"
  16. "github.com/go-yaml/yaml"
  17. "path"
  18. "strings"
  19. )
  20. var log = common.Log
  21. type StreamProcessor struct {
  22. statement string
  23. badgerDir string
  24. }
  25. //@params s : the sql string of create stream statement
  26. //@params d : the directory of the badger DB to save the stream info
  27. func NewStreamProcessor(s, d string) *StreamProcessor {
  28. processor := &StreamProcessor{
  29. statement: s,
  30. badgerDir: d,
  31. }
  32. return processor
  33. }
  34. func (p *StreamProcessor) Exec() (result []string, err error) {
  35. parser := xsql.NewParser(strings.NewReader(p.statement))
  36. stmt, err := xsql.Language.Parse(parser)
  37. if err != nil {
  38. return
  39. }
  40. store := common.GetSimpleKVStore(p.badgerDir)
  41. err = store.Open()
  42. if err != nil {
  43. return
  44. }
  45. defer store.Close()
  46. switch s := stmt.(type) {
  47. case *xsql.StreamStmt:
  48. var r string
  49. r, err = p.execCreateStream(s, store)
  50. result = append(result, r)
  51. case *xsql.ShowStreamsStatement:
  52. result, err = p.execShowStream(s, store)
  53. case *xsql.DescribeStreamStatement:
  54. var r string
  55. r, err = p.execDescribeStream(s, store)
  56. result = append(result, r)
  57. case *xsql.ExplainStreamStatement:
  58. var r string
  59. r, err = p.execExplainStream(s, store)
  60. result = append(result, r)
  61. case *xsql.DropStreamStatement:
  62. var r string
  63. r, err = p.execDropStream(s, store)
  64. result = append(result, r)
  65. }
  66. return
  67. }
  68. func (p *StreamProcessor) execCreateStream(stmt *xsql.StreamStmt, db common.KeyValue) (string, error) {
  69. err := db.Set(string(stmt.Name), p.statement)
  70. if err != nil {
  71. return "", err
  72. }else{
  73. return fmt.Sprintf("Stream %s is created.", stmt.Name), nil
  74. }
  75. }
  76. func (p *StreamProcessor) execShowStream(stmt *xsql.ShowStreamsStatement, db common.KeyValue) ([]string,error) {
  77. keys, err := db.Keys()
  78. if len(keys) == 0 {
  79. keys = append(keys, "No stream definitions are found.")
  80. }
  81. return keys, err
  82. }
  83. func (p *StreamProcessor) execDescribeStream(stmt *xsql.DescribeStreamStatement, db common.KeyValue) (string,error) {
  84. s, f := db.Get(string(stmt.Name))
  85. s1, _ := s.(string)
  86. if !f {
  87. return "", fmt.Errorf("Stream %s is not found.", stmt.Name)
  88. }
  89. parser := xsql.NewParser(strings.NewReader(s1))
  90. stream, err := xsql.Language.Parse(parser)
  91. streamStmt, ok := stream.(*xsql.StreamStmt)
  92. if !ok{
  93. return "", fmt.Errorf("Error resolving the stream %s, the data in db may be corrupted.", stmt.Name)
  94. }
  95. var buff bytes.Buffer
  96. buff.WriteString("Fields\n--------------------------------------------------------------------------------\n")
  97. for _, f := range streamStmt.StreamFields {
  98. buff.WriteString(f.Name + "\t")
  99. xsql.PrintFieldType(f.FieldType, &buff)
  100. buff.WriteString("\n")
  101. }
  102. buff.WriteString("\n")
  103. common.PrintMap(streamStmt.Options, &buff)
  104. return buff.String(), err
  105. }
  106. func (p *StreamProcessor) execExplainStream(stmt *xsql.ExplainStreamStatement, db common.KeyValue) (string,error) {
  107. _, f := db.Get(string(stmt.Name))
  108. if !f {
  109. return "", fmt.Errorf("Stream %s is not found.", stmt.Name)
  110. }
  111. return "TO BE SUPPORTED", nil
  112. }
  113. func (p *StreamProcessor) execDropStream(stmt *xsql.DropStreamStatement, db common.KeyValue) (string, error) {
  114. err := db.Delete(string(stmt.Name))
  115. if err != nil {
  116. return "", err
  117. }else{
  118. return fmt.Sprintf("Stream %s is dropped.", stmt.Name), nil
  119. }
  120. }
  121. func GetStream(m *common.SimpleKVStore, name string) (stmt *xsql.StreamStmt, err error){
  122. s, f := m.Get(name)
  123. if !f {
  124. return nil, fmt.Errorf("Cannot find key %s. ", name)
  125. }
  126. s1, _ := s.(string)
  127. parser := xsql.NewParser(strings.NewReader(s1))
  128. stream, err := xsql.Language.Parse(parser)
  129. stmt, ok := stream.(*xsql.StreamStmt)
  130. if !ok{
  131. err = fmt.Errorf("Error resolving the stream %s, the data in db may be corrupted.", name)
  132. }
  133. return
  134. }
  135. type RuleProcessor struct {
  136. badgerDir string
  137. }
  138. func NewRuleProcessor(d string) *RuleProcessor {
  139. processor := &RuleProcessor{
  140. badgerDir: d,
  141. }
  142. return processor
  143. }
  144. func (p *RuleProcessor) ExecCreate(name, ruleJson string) (*api.Rule, error) {
  145. rule, err := p.getRuleByJson(name, ruleJson)
  146. if err != nil {
  147. return nil, err
  148. }
  149. store := common.GetSimpleKVStore(path.Join(p.badgerDir, "rule"))
  150. err = store.Open()
  151. if err != nil {
  152. return nil, err
  153. }
  154. err = store.Set(string(name), ruleJson)
  155. defer store.Close()
  156. if err != nil {
  157. return nil, err
  158. }else{
  159. log.Infof("Rule %s is created.", name)
  160. }
  161. return rule, nil
  162. }
  163. func (p *RuleProcessor) GetRuleByName(name string) (*api.Rule, error) {
  164. store := common.GetSimpleKVStore(path.Join(p.badgerDir, "rule"))
  165. err := store.Open()
  166. if err != nil {
  167. return nil, err
  168. }
  169. defer store.Close()
  170. s, f := store.Get(string(name))
  171. if !f {
  172. return nil, fmt.Errorf("Rule %s is not found.", name)
  173. }
  174. s1, _ := s.(string)
  175. return p.getRuleByJson(name, s1)
  176. }
  177. func (p *RuleProcessor) getRuleByJson(name, ruleJson string) (*api.Rule, error) {
  178. var rule api.Rule
  179. if err := json.Unmarshal([]byte(ruleJson), &rule); err != nil {
  180. return nil, fmt.Errorf("Parse rule %s error : %s.", ruleJson, err)
  181. }
  182. rule.Id = name
  183. //validation
  184. if name == ""{
  185. return nil, fmt.Errorf("Missing rule id.")
  186. }
  187. if rule.Sql == ""{
  188. return nil, fmt.Errorf("Missing rule SQL.")
  189. }
  190. if rule.Actions == nil || len(rule.Actions) == 0{
  191. return nil, fmt.Errorf("Missing rule actions.")
  192. }
  193. return &rule, nil
  194. }
  195. func (p *RuleProcessor) ExecInitRule(rule *api.Rule) (*xstream.TopologyNew, error) {
  196. if tp, inputs, err := p.createTopo(rule); err != nil {
  197. return nil, err
  198. }else{
  199. for _, m := range rule.Actions {
  200. for name, action := range m {
  201. props, ok := action.(map[string]interface{})
  202. if !ok {
  203. return nil, fmt.Errorf("expect map[string]interface{} type for the action properties, but found %v", action)
  204. }
  205. if s, err := getSink(name, props); err != nil{
  206. return nil, err
  207. }else{
  208. tp.AddSink(inputs, nodes.NewSinkNode("sink_" + name, s))
  209. }
  210. }
  211. }
  212. return tp, nil
  213. }
  214. }
  215. func (p *RuleProcessor) ExecQuery(ruleid, sql string) (*xstream.TopologyNew, error) {
  216. if tp, inputs, err := p.createTopo(&api.Rule{Id: ruleid, Sql: sql}); err != nil {
  217. return nil, err
  218. } else {
  219. tp.AddSink(inputs, nodes.NewSinkNode("sink_memory_log", sinks.NewLogSinkToMemory()))
  220. go func() {
  221. select {
  222. case err := <-tp.Open():
  223. log.Println(err)
  224. tp.Cancel()
  225. }
  226. }()
  227. return tp, nil
  228. }
  229. }
  230. func (p *RuleProcessor) ExecDesc(name string) (string, error) {
  231. store := common.GetSimpleKVStore(path.Join(p.badgerDir, "rule"))
  232. err := store.Open()
  233. if err != nil {
  234. return "", err
  235. }
  236. defer store.Close()
  237. s, f := store.Get(string(name))
  238. if !f {
  239. return "", fmt.Errorf("Rule %s is not found.", name)
  240. }
  241. s1, _ := s.(string)
  242. dst := &bytes.Buffer{}
  243. if err := json.Indent(dst, []byte(s1), "", " "); err != nil {
  244. return "", err
  245. }
  246. return fmt.Sprintln(dst.String()), nil
  247. }
  248. func (p *RuleProcessor) ExecShow() (string, error) {
  249. keys, err := p.GetAllRules()
  250. if err != nil{
  251. return "", err
  252. }
  253. if len(keys) == 0 {
  254. keys = append(keys, "No rule definitions are found.")
  255. }
  256. var result string
  257. for _, c := range keys{
  258. result = result + fmt.Sprintln(c)
  259. }
  260. return result, nil
  261. }
  262. func (p *RuleProcessor) GetAllRules() ([]string, error) {
  263. store := common.GetSimpleKVStore(path.Join(p.badgerDir, "rule"))
  264. err := store.Open()
  265. if err != nil {
  266. return nil, err
  267. }
  268. defer store.Close()
  269. return store.Keys()
  270. }
  271. func (p *RuleProcessor) ExecDrop(name string) (string, error) {
  272. store := common.GetSimpleKVStore(path.Join(p.badgerDir, "rule"))
  273. err := store.Open()
  274. if err != nil {
  275. return "", err
  276. }
  277. defer store.Close()
  278. err = store.Delete(string(name))
  279. if err != nil {
  280. return "", err
  281. }else{
  282. return fmt.Sprintf("Rule %s is dropped.", name), nil
  283. }
  284. }
  285. func (p *RuleProcessor) createTopo(rule *api.Rule) (*xstream.TopologyNew, []api.Emitter, error) {
  286. return p.createTopoWithSources(rule, nil)
  287. }
  288. //For test to mock source
  289. func (p *RuleProcessor) createTopoWithSources(rule *api.Rule, sources []*nodes.SourceNode) (*xstream.TopologyNew, []api.Emitter, error){
  290. name := rule.Id
  291. sql := rule.Sql
  292. var isEventTime bool
  293. var lateTol int64
  294. if iet, ok := rule.Options["isEventTime"]; ok{
  295. isEventTime, ok = iet.(bool)
  296. if !ok{
  297. return nil, nil, fmt.Errorf("Invalid rule option isEventTime %v, bool type is required.", iet)
  298. }
  299. }
  300. if isEventTime {
  301. if l, ok := rule.Options["lateTolerance"]; ok{
  302. if fl, ok := l.(float64); ok{
  303. lateTol = int64(fl)
  304. }else{
  305. return nil, nil, fmt.Errorf("Invalid rule option lateTolerance %v, int type is required.", l)
  306. }
  307. }
  308. }
  309. shouldCreateSource := sources == nil
  310. parser := xsql.NewParser(strings.NewReader(sql))
  311. if stmt, err := xsql.Language.Parse(parser); err != nil{
  312. return nil, nil, fmt.Errorf("Parse SQL %s error: %s.", sql , err)
  313. }else {
  314. if selectStmt, ok := stmt.(*xsql.SelectStatement); !ok {
  315. return nil, nil, fmt.Errorf("SQL %s is not a select statement.", sql)
  316. } else {
  317. tp := xstream.NewWithName(name)
  318. var inputs []api.Emitter
  319. streamsFromStmt := xsql.GetStreams(selectStmt)
  320. if !shouldCreateSource && len(streamsFromStmt) != len(sources){
  321. return nil, nil, fmt.Errorf("Invalid parameter sources or streams, the length cannot match the statement, expect %d sources.", len(streamsFromStmt))
  322. }
  323. store := common.GetSimpleKVStore(path.Join(p.badgerDir, "stream"))
  324. err := store.Open()
  325. if err != nil {
  326. return nil, nil, err
  327. }
  328. defer store.Close()
  329. for i, s := range streamsFromStmt {
  330. streamStmt, err := GetStream(store, s)
  331. if err != nil {
  332. return nil, nil, fmt.Errorf("fail to get stream %s, please check if stream is created", s)
  333. }
  334. pp, err := plans.NewPreprocessor(streamStmt, selectStmt.Fields, isEventTime)
  335. if err != nil{
  336. return nil, nil, err
  337. }
  338. if shouldCreateSource{
  339. src, err := getSource(streamStmt)
  340. if err != nil {
  341. return nil, nil, fmt.Errorf("fail to get source: %v", err)
  342. }
  343. node := nodes.NewSourceNode(s, src)
  344. tp.AddSrc(node)
  345. preprocessorOp := xstream.Transform(pp, "preprocessor_"+s)
  346. tp.AddOperator([]api.Emitter{node}, preprocessorOp)
  347. inputs = append(inputs, preprocessorOp)
  348. } else {
  349. tp.AddSrc(sources[i])
  350. preprocessorOp := xstream.Transform(pp, "preprocessor_"+s)
  351. tp.AddOperator([]api.Emitter{sources[i]}, preprocessorOp)
  352. inputs = append(inputs, preprocessorOp)
  353. }
  354. }
  355. dimensions := selectStmt.Dimensions
  356. var w *xsql.Window
  357. if dimensions != nil {
  358. w = dimensions.GetWindow()
  359. if w != nil {
  360. wop, err := operators.NewWindowOp("window", w, isEventTime, lateTol, streamsFromStmt)
  361. if err != nil {
  362. return nil, nil, err
  363. }
  364. tp.AddOperator(inputs, wop)
  365. inputs = []api.Emitter{wop}
  366. }
  367. }
  368. if w != nil && selectStmt.Joins != nil {
  369. joinOp := xstream.Transform(&plans.JoinPlan{Joins: selectStmt.Joins, From: selectStmt.Sources[0].(*xsql.Table)}, "join")
  370. //TODO concurrency setting by command
  371. //joinOp.SetConcurrency(3)
  372. tp.AddOperator(inputs, joinOp)
  373. inputs = []api.Emitter{joinOp}
  374. }
  375. if selectStmt.Condition != nil {
  376. filterOp := xstream.Transform(&plans.FilterPlan{Condition: selectStmt.Condition}, "filter")
  377. //TODO concurrency setting by command
  378. // filterOp.SetConcurrency(3)
  379. tp.AddOperator(inputs, filterOp)
  380. inputs = []api.Emitter{filterOp}
  381. }
  382. var ds xsql.Dimensions
  383. if dimensions != nil {
  384. ds = dimensions.GetGroups()
  385. if ds != nil && len(ds) > 0 {
  386. aggregateOp := xstream.Transform(&plans.AggregatePlan{Dimensions: ds}, "aggregate")
  387. tp.AddOperator(inputs, aggregateOp)
  388. inputs = []api.Emitter{aggregateOp}
  389. }
  390. }
  391. if selectStmt.Having != nil {
  392. havingOp := xstream.Transform(&plans.HavingPlan{selectStmt.Having}, "having")
  393. tp.AddOperator(inputs, havingOp)
  394. inputs = []api.Emitter{havingOp}
  395. }
  396. if selectStmt.SortFields != nil {
  397. orderOp := xstream.Transform(&plans.OrderPlan{SortFields: selectStmt.SortFields}, "order")
  398. tp.AddOperator(inputs, orderOp)
  399. inputs = []api.Emitter{orderOp}
  400. }
  401. if selectStmt.Fields != nil {
  402. projectOp := xstream.Transform(&plans.ProjectPlan{Fields: selectStmt.Fields, IsAggregate: xsql.IsAggStatement(selectStmt)}, "project")
  403. tp.AddOperator(inputs, projectOp)
  404. inputs = []api.Emitter{projectOp}
  405. }
  406. return tp, inputs, nil
  407. }
  408. }
  409. }
  410. func getSource(streamStmt *xsql.StreamStmt) (api.Source, error) {
  411. t, ok := streamStmt.Options["TYPE"]
  412. if !ok{
  413. t = "mqtt"
  414. }
  415. var s api.Source
  416. switch t {
  417. case "mqtt":
  418. s = &extensions.MQTTSource{}
  419. log.Debugf("Source mqtt created")
  420. default:
  421. nf, err := plugin_manager.GetPlugin(t, "sources")
  422. if err != nil {
  423. return nil, err
  424. }
  425. s, ok = nf.(api.Source)
  426. if !ok {
  427. return nil, fmt.Errorf("exported symbol %s is not type of api.Source", t)
  428. }
  429. }
  430. props := getConf(t, streamStmt.Options["CONF_KEY"])
  431. err := s.Configure(streamStmt.Options["DATASOURCE"], props)
  432. if err != nil{
  433. return nil, err
  434. }
  435. log.Debugf("Source %s created", t)
  436. return s, nil
  437. }
  438. func getConf(t string, confkey string) map[string]interface{} {
  439. conf, err := common.LoadConf("sources/" + t + ".yaml")
  440. props := make(map[string]interface{})
  441. if err == nil {
  442. cfg := make(map[string]map[string]interface{})
  443. if err := yaml.Unmarshal(conf, &cfg); err != nil {
  444. log.Warnf("fail to parse yaml for source %s. Return an empty configuration", t)
  445. } else {
  446. var ok bool
  447. props, ok = cfg["default"]
  448. if !ok {
  449. log.Warnf("default conf is not found", confkey)
  450. }
  451. if c, ok := cfg[confkey]; ok {
  452. for k, v := range c {
  453. props[k] = v
  454. }
  455. }
  456. }
  457. } else {
  458. log.Warnf("config file %s.yaml is not loaded properly. Return an empty configuration", t)
  459. }
  460. log.Debugf("get conf for %s with conf key %s: %v", t, confkey, props)
  461. return props
  462. }
  463. func getSink(name string, action map[string]interface{}) (api.Sink, error) {
  464. log.Tracef("trying to get sink %s with action %v", name, action)
  465. var s api.Sink
  466. switch name {
  467. case "log":
  468. s = sinks.NewLogSink()
  469. case "mqtt":
  470. s = &sinks.MQTTSink{}
  471. default:
  472. nf, err := plugin_manager.GetPlugin(name, "sinks")
  473. if err != nil {
  474. return nil, err
  475. }
  476. var ok bool
  477. s, ok = nf.(api.Sink)
  478. if !ok {
  479. return nil, fmt.Errorf("exported symbol %s is not type of api.Sink", name)
  480. }
  481. }
  482. err := s.Configure(action)
  483. if err != nil{
  484. return nil, err
  485. }
  486. log.Debugf("Sink %s created", name)
  487. return s, nil
  488. }