-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathstreamsql.go
More file actions
417 lines (382 loc) · 12.1 KB
/
streamsql.go
File metadata and controls
417 lines (382 loc) · 12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
/*
* Copyright 2025 The RuleGo Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package streamsql
import (
"fmt"
"sync/atomic"
"github.com/rulego/streamsql/rsql"
"github.com/rulego/streamsql/stream"
"github.com/rulego/streamsql/types"
"github.com/rulego/streamsql/utils/table"
)
// Streamsql is the main interface for the StreamSQL streaming engine.
// It encapsulates core functionality including SQL parsing, stream processing, and window management.
//
// Usage example:
//
// ssql := streamsql.New()
// err := ssql.Execute("SELECT AVG(temperature) FROM stream GROUP BY TumblingWindow('5s')")
// ssql.Emit(map[string]interface{}{"temperature": 25.5})
type Streamsql struct {
stream *stream.Stream
// Performance configuration mode
performanceMode string // "default", "high_performance", "low_latency", "zero_data_loss", "custom"
customConfig *types.PerformanceConfig
// Save original SELECT field order to maintain field order for table output
fieldOrder []string
// Flag to track if Execute has been called
executed int32
}
// New creates a new StreamSQL instance.
// Supports configuration through optional Option parameters.
//
// Parameters:
// - options: Variable configuration options for customizing StreamSQL behavior
//
// Returns:
// - *Streamsql: Newly created StreamSQL instance
//
// Examples:
//
// // Create default instance
// ssql := streamsql.New()
//
// // Create high performance instance
// ssql := streamsql.New(streamsql.WithHighPerformance())
//
// // Create zero data loss instance
// ssql := streamsql.New(streamsql.WithZeroDataLoss())
func New(options ...Option) *Streamsql {
s := &Streamsql{
performanceMode: "default", // Default to standard performance configuration
}
// Apply all configuration options
for _, option := range options {
option(s)
}
return s
}
// Execute parses and executes SQL queries, creating corresponding stream processing pipelines.
// This is the core method of StreamSQL, responsible for converting SQL into actual stream processing logic.
//
// Supported SQL syntax:
// - SELECT clause: Select fields and aggregate functions
// - FROM clause: Specify data source (usually 'stream')
// - WHERE clause: Data filtering conditions
// - GROUP BY clause: Grouping fields and window functions
// - HAVING clause: Aggregate result filtering
// - LIMIT clause: Limit result count
// - DISTINCT: Result deduplication
//
// Window functions:
// - TumblingWindow('5s'): Tumbling window
// - SlidingWindow('30s', '10s'): Sliding window
// - CountingWindow(100): Counting window
// - SessionWindow('5m'): Session window
//
// Parameters:
// - sql: SQL query statement to execute
//
// Returns:
// - error: Returns error if SQL parsing or execution fails
//
// Examples:
//
// // Basic aggregation query
// err := ssql.Execute("SELECT deviceId, AVG(temperature) FROM stream GROUP BY deviceId, TumblingWindow('5s')")
//
// // Query with filtering conditions
// err := ssql.Execute("SELECT * FROM stream WHERE temperature > 30")
//
// // Complex window aggregation
// err := ssql.Execute(`
// SELECT deviceId,
// AVG(temperature) as avg_temp,
// MAX(humidity) as max_humidity
// FROM stream
// WHERE deviceId != 'test'
// GROUP BY deviceId, SlidingWindow('1m', '30s')
// HAVING avg_temp > 25
// LIMIT 100
// `)
func (s *Streamsql) Execute(sql string) error {
// Try to acquire execution lock using CAS operation
if !atomic.CompareAndSwapInt32(&s.executed, 0, 1) {
return fmt.Errorf("Execute() has already been called, create a new Streamsql instance for different queries")
}
// Parse SQL statement
config, condition, err := rsql.Parse(sql)
if err != nil {
// Reset executed flag on error
atomic.StoreInt32(&s.executed, 0)
return fmt.Errorf("SQL parsing failed: %w", err)
}
// Get field order information from parsing result
s.fieldOrder = config.FieldOrder
// Create stream processor based on performance mode
var streamInstance *stream.Stream
switch s.performanceMode {
case "high_performance":
streamInstance, err = stream.NewStreamWithHighPerformance(*config)
case "low_latency":
streamInstance, err = stream.NewStreamWithLowLatency(*config)
case "custom":
if s.customConfig != nil {
streamInstance, err = stream.NewStreamWithCustomPerformance(*config, *s.customConfig)
} else {
streamInstance, err = stream.NewStream(*config)
}
default: // "default"
streamInstance, err = stream.NewStream(*config)
}
if err != nil {
// Reset executed flag on error
atomic.StoreInt32(&s.executed, 0)
return fmt.Errorf("failed to create stream processor: %w", err)
}
s.stream = streamInstance
// Register filter condition
if err = s.stream.RegisterFilter(condition); err != nil {
// Reset executed flag on error
atomic.StoreInt32(&s.executed, 0)
return fmt.Errorf("failed to register filter condition: %w", err)
}
// Start stream processing
s.stream.Start()
return nil
}
// Emit adds data to the stream processing pipeline.
// Accepts type-safe map[string]interface{} format data.
//
// Parameters:
// - data: Data to add, must be map[string]interface{} type
//
// Examples:
//
// // Add device data
// ssql.Emit(map[string]interface{}{
// "deviceId": "sensor001",
// "temperature": 25.5,
// "humidity": 60.0,
// "timestamp": time.Now(),
// })
//
// // Add user behavior data
// ssql.Emit(map[string]interface{}{
// "userId": "user123",
// "action": "click",
// "page": "/home",
// })
func (s *Streamsql) Emit(data map[string]interface{}) {
if s.stream != nil {
s.stream.Emit(data)
}
}
// EmitSync processes data synchronously, returning results immediately.
// Only applicable for non-aggregation queries, aggregation queries will return an error.
// Accepts type-safe map[string]interface{} format data.
//
// Parameters:
// - data: Data to process, must be map[string]interface{} type
//
// Returns:
// - map[string]interface{}: Processed result data, returns nil if filter conditions don't match
// - error: Processing error
//
// Examples:
//
// result, err := ssql.EmitSync(map[string]interface{}{
// "deviceId": "sensor001",
// "temperature": 25.5,
// })
// if err != nil {
// log.Printf("processing error: %v", err)
// } else if result != nil {
// // Use processed result immediately (result is map[string]interface{} type)
// fmt.Printf("Processing result: %v\n", result)
// }
func (s *Streamsql) EmitSync(data map[string]interface{}) (map[string]interface{}, error) {
if s.stream == nil {
return nil, fmt.Errorf("stream not initialized")
}
// Check if it's a non-aggregation query
if s.stream.IsAggregationQuery() {
return nil, fmt.Errorf("synchronous mode only supports non-aggregation queries, use Emit() method for aggregation queries")
}
return s.stream.ProcessSync(data)
}
// IsAggregationQuery checks if the current query is an aggregation query
func (s *Streamsql) IsAggregationQuery() bool {
if s.stream == nil {
return false
}
return s.stream.IsAggregationQuery()
}
// Stream returns the underlying stream processor instance.
// Provides access to lower-level stream processing functionality.
//
// Returns:
// - *stream.Stream: Underlying stream processor instance, returns nil if SQL not executed
//
// Common use cases:
// - Add result processing callbacks
// - Get result channel
// - Manually control stream processing lifecycle
//
// Examples:
//
// // Add result processing callback
// ssql.Stream().AddSink(func(results []map[string]interface{}) {
// fmt.Printf("Processing results: %v\n", results)
// })
//
// // Get result channel
// resultChan := ssql.Stream().GetResultsChan()
// go func() {
// for result := range resultChan {
// // Process result
// }
// }()
func (s *Streamsql) Stream() *stream.Stream {
return s.stream
}
// GetStats returns stream processing statistics
func (s *Streamsql) GetStats() map[string]int64 {
if s.stream != nil {
return s.stream.GetStats()
}
return make(map[string]int64)
}
// GetDetailedStats returns detailed performance statistics
func (s *Streamsql) GetDetailedStats() map[string]interface{} {
if s.stream != nil {
return s.stream.GetDetailedStats()
}
return make(map[string]interface{})
}
// Stop stops the stream processor and releases related resources.
// After calling this method, the stream processor will stop receiving and processing new data.
//
// Recommended to call this method for cleanup before application exit:
//
// defer ssql.Stop()
//
// Note: StreamSQL instance cannot be restarted after stopping, create a new instance.
func (s *Streamsql) Stop() {
if s.stream != nil {
s.stream.Stop()
}
}
// AddSink directly adds result processing callback functions.
// Convenience wrapper for Stream().AddSink() for cleaner API calls.
//
// Parameters:
// - sink: Result processing function, receives []map[string]interface{} type result data
//
// Examples:
//
// // Directly add result processing
// ssql.AddSink(func(results []map[string]interface{}) {
// fmt.Printf("Processing results: %v\n", results)
// })
//
// // Add multiple processors
// ssql.AddSink(func(results []map[string]interface{}) {
// // Save to database
// saveToDatabase(results)
// })
// ssql.AddSink(func(results []map[string]interface{}) {
// // Send to message queue
// sendToQueue(results)
// })
func (s *Streamsql) AddSink(sink func([]map[string]interface{})) {
if s.stream != nil {
s.stream.AddSink(sink)
}
}
// AddSyncSink directly adds synchronous result processing callback functions.
// Convenience wrapper for Stream().AddSyncSink() for cleaner API calls.
//
// Parameters:
// - sink: Result processing function, receives []map[string]interface{} type result data
//
// Note: Sync sinks are executed sequentially in the result processing goroutine.
// Use this when order of execution matters.
func (s *Streamsql) AddSyncSink(sink func([]map[string]interface{})) {
if s.stream != nil {
s.stream.AddSyncSink(sink)
}
}
// PrintTable prints results to console in table format, similar to database output.
// Displays column names first, then data rows.
//
// Supported data formats:
// - []map[string]interface{}: Multiple rows
// - map[string]interface{}: Single row
// - Other types: Direct print
//
// Example:
//
// // Print results in table format
// ssql.PrintTable()
//
// // Output format:
// // +--------+----------+
// // | device | max_temp |
// // +--------+----------+
// // | aa | 30.0 |
// // | bb | 22.0 |
// // +--------+----------+
func (s *Streamsql) PrintTable() {
s.AddSink(func(results []map[string]interface{}) {
s.printTableFormat(results)
})
}
// printTableFormat formats and prints table data
// Parameters:
// - results: Result data of type []map[string]interface{}
func (s *Streamsql) printTableFormat(results []map[string]interface{}) {
table.FormatTableData(results, s.fieldOrder)
}
// ToChannel returns result channel for asynchronous result retrieval.
// Provides non-blocking access to stream processing results.
//
// Returns:
// - <-chan interface{}: Read-only result channel, returns nil if SQL not executed
//
// Example:
//
// // Get result channel
// resultChan := ssql.ToChannel()
// if resultChan != nil {
// go func() {
// for result := range resultChan {
// fmt.Printf("Async result: %v\n", result)
// }
// }()
// }
// ToChannel converts query results to channel output
// Returns a read-only channel for receiving query results
//
// Notes:
// - Consumer must continuously read from channel to prevent stream processing blocking
// - Channel transmits batch result data
func (s *Streamsql) ToChannel() <-chan []map[string]interface{} {
if s.stream != nil {
return s.stream.GetResultsChan()
}
return nil
}