-
Notifications
You must be signed in to change notification settings - Fork 40
/
kusto.go
408 lines (345 loc) · 10.9 KB
/
kusto.go
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
package kusto
import (
"context"
"io"
"net/http"
"net/url"
"strings"
"sync"
"time"
"github.com/Azure/azure-kusto-go/kusto/data/errors"
"github.com/Azure/azure-kusto-go/kusto/internal/frames"
v2 "github.com/Azure/azure-kusto-go/kusto/internal/frames/v2"
)
// queryer provides for getting a stream of Kusto frames. Exists to allow fake Kusto streams in tests.
type queryer interface {
io.Closer
query(ctx context.Context, db string, query Stmt, options *queryOptions) (execResp, error)
mgmt(ctx context.Context, db string, query Stmt, options *mgmtOptions) (execResp, error)
queryToJson(ctx context.Context, db string, query Stmt, options *queryOptions) (string, error)
}
// Authorization provides the TokenProvider needed to acquire the auth token.
type Authorization struct {
// Token provider that can be used to get the access token.
TokenProvider *TokenProvider
}
// Client is a client to a Kusto instance.
type Client struct {
conn, ingestConn queryer
endpoint string
auth Authorization
mgmtConnMu sync.Mutex
http *http.Client
clientDetails *ClientDetails
}
// Option is an optional argument type for New().
type Option func(c *Client)
// New returns a new Client.
func New(kcsb *ConnectionStringBuilder, options ...Option) (*Client, error) {
tkp, err := kcsb.newTokenProvider()
if err != nil {
return nil, err
}
auth := &Authorization{
TokenProvider: tkp,
}
endpoint := kcsb.DataSource
u, err := url.Parse(endpoint)
if err != nil {
return nil, errors.ES(errors.OpServConn, errors.KClientArgs, "could not parse the endpoint(%s): %s", endpoint, err).SetNoRetry()
}
if strings.HasPrefix(u.Hostname(), "ingest-") {
return nil, errors.ES(
errors.OpServConn,
errors.KClientArgs,
"endpoint argument started with 'ingest-'. Adding 'ingest-' is taken care of by the client. "+
"If using Mgmt() on an ingestion endpoint, use option QueryIngestion(). This is very uncommon",
)
}
client := &Client{auth: *auth, endpoint: endpoint, clientDetails: NewClientDetails(kcsb.ApplicationForTracing, kcsb.UserForTracing)}
for _, o := range options {
o(client)
}
if client.http == nil {
client.http = &http.Client{}
}
conn, err := NewConn(endpoint, *auth, client.http, client.clientDetails)
if err != nil {
return nil, err
}
client.conn = conn
return client, nil
}
func WithHttpClient(client *http.Client) Option {
return func(c *Client) {
c.http = client
}
}
// QueryOption is an option type for a call to Query().
type QueryOption func(q *queryOptions) error
// Note: QueryOption are defined in queryopts.go file
// MgmtOption is an option type for a call to Mgmt().
type MgmtOption func(m *mgmtOptions) error
// Note: MgmtOption are defined in queryopts.go file
// Auth returns the Authorization passed to New().
func (c *Client) Auth() Authorization {
return c.auth
}
// Endpoint returns the endpoint passed to New().
func (c *Client) Endpoint() string {
return c.endpoint
}
type callType int8
const (
unknownCallType = 0
queryCall = 1
mgmtCall = 2
)
// Query queries Kusto for data. context can set a timeout or cancel the query.
// query is a injection safe Stmt object. Queries cannot take longer than 5 minutes by default and have row/size limitations.
// Note that the server has a timeout of 4 minutes for a query by default unless the context deadline is set. Queries can
// take a maximum of 1 hour.
func (c *Client) Query(ctx context.Context, db string, query Stmt, options ...QueryOption) (*RowIterator, error) {
ctx, cancel, err := contextSetup(ctx, false) // Note: cancel is called when *RowIterator has Stop() called.
if err != nil {
return nil, err
}
opts, err := setQueryOptions(ctx, errors.OpQuery, query, options...)
if err != nil {
return nil, err
}
conn, err := c.getConn(queryCall, connOptions{queryOptions: opts})
if err != nil {
return nil, err
}
execResp, err := conn.query(ctx, db, query, opts)
if err != nil {
cancel()
return nil, err
}
var header v2.DataSetHeader
ff := <-execResp.frameCh
switch v := ff.(type) {
case v2.DataSetHeader:
header = v
case frames.Error:
cancel()
return nil, v
}
iter, columnsReady := newRowIterator(ctx, cancel, execResp, header, errors.OpQuery)
var sm stateMachine
if header.IsProgressive {
sm = &progressiveSM{
op: errors.OpQuery,
iter: iter,
in: execResp.frameCh,
ctx: ctx,
wg: &sync.WaitGroup{},
}
} else {
sm = &nonProgressiveSM{
op: errors.OpQuery,
iter: iter,
in: execResp.frameCh,
ctx: ctx,
wg: &sync.WaitGroup{},
}
}
go runSM(sm)
<-columnsReady
return iter, nil
}
func (c *Client) QueryToJson(ctx context.Context, db string, query Stmt, options ...QueryOption) (string, error) {
ctx, cancel, err := contextSetup(ctx, false) // Note: cancel is called when *RowIterator has Stop() called.
if err != nil {
return "", err
}
opts, err := setQueryOptions(ctx, errors.OpQuery, query, options...)
if err != nil {
return "", err
}
conn, err := c.getConn(queryCall, connOptions{queryOptions: opts})
if err != nil {
return "", err
}
json, err := conn.queryToJson(ctx, db, query, opts)
if err != nil {
cancel()
return "", err
}
return json, nil
}
// Mgmt is used to do management queries to Kusto.
// Details can be found at: https://docs.microsoft.com/en-us/azure/kusto/management/
// Mgmt accepts a Stmt, but that Stmt cannot have any query parameters attached at this time.
// Note that the server has a timeout of 10 minutes for a management call by default unless the context deadline is set.
// There is a maximum of 1 hour.
func (c *Client) Mgmt(ctx context.Context, db string, query Stmt, options ...MgmtOption) (*RowIterator, error) {
if !query.params.IsZero() || !query.defs.IsZero() {
return nil, errors.ES(errors.OpMgmt, errors.KClientArgs, "a Mgmt() call cannot accept a Stmt object that has Definitions or Parameters attached")
}
ctx, cancel, err := contextSetup(ctx, true) // Note: cancel is called when *RowIterator has Stop() called.
if err != nil {
return nil, err
}
opts, err := setMgmtOptions(ctx, errors.OpMgmt, query, options...)
if err != nil {
return nil, err
}
conn, err := c.getConn(mgmtCall, connOptions{mgmtOptions: opts})
if err != nil {
return nil, err
}
execResp, err := conn.mgmt(ctx, db, query, opts)
if err != nil {
cancel()
return nil, err
}
iter, columnsReady := newRowIterator(ctx, cancel, execResp, v2.DataSetHeader{}, errors.OpMgmt)
sm := &v1SM{
op: errors.OpQuery,
iter: iter,
in: execResp.frameCh,
ctx: ctx,
wg: &sync.WaitGroup{},
}
go runSM(sm)
<-columnsReady
return iter, nil
}
func setQueryOptions(ctx context.Context, op errors.Op, query Stmt, options ...QueryOption) (*queryOptions, error) {
params, err := query.params.toParameters(query.defs)
if err != nil {
return nil, errors.ES(op, errors.KClientArgs, "QueryValues in the the Stmt were incorrect: %s", err).SetNoRetry()
}
// Match our server deadline to our context.Deadline. This should be set from withing kusto.Query() to always have a value.
deadline, ok := ctx.Deadline()
if ok {
options = append(
options,
queryServerTimeout(deadline.Sub(nower())),
)
}
opt := &queryOptions{
requestProperties: &requestProperties{
Options: map[string]interface{}{},
Parameters: params,
},
}
/*if op == errors.OpQuery {
// We want progressive frames by default for Query(), but not Mgmt() because it uses v1 framing and ingestion endpoints
// do not support it.
opt.requestProperties.Options["results_progressive_enabled"] = true
}*/
opt.requestProperties.Options["results_progressive_enabled"] = true
for _, o := range options {
if err := o(opt); err != nil {
return nil, errors.ES(op, errors.KClientArgs, "QueryValues in the the Stmt were incorrect: %s", err).SetNoRetry()
}
}
return opt, nil
}
func setMgmtOptions(ctx context.Context, op errors.Op, query Stmt, options ...MgmtOption) (*mgmtOptions, error) {
params, err := query.params.toParameters(query.defs)
if err != nil {
return nil, errors.ES(op, errors.KClientArgs, "QueryValues in the the Stmt were incorrect: %s", err).SetNoRetry()
}
// Match our server deadline to our context.Deadline. This should be set from withing kusto.Query() to always have a value.
deadline, ok := ctx.Deadline()
if ok {
options = append(
options,
mgmtServerTimeout(deadline.Sub(nower())),
)
}
opt := &mgmtOptions{
requestProperties: &requestProperties{
Options: map[string]interface{}{},
Parameters: params,
},
}
if op == errors.OpQuery {
// We want progressive frames by default for Query(), but not Mgmt() because it uses v1 framing and ingestion endpoints
// do not support it.
opt.requestProperties.Options["results_progressive_enabled"] = true
}
for _, o := range options {
if err := o(opt); err != nil {
return nil, errors.ES(op, errors.KClientArgs, "QueryValues in the the Stmt were incorrect: %s", err).SetNoRetry()
}
}
return opt, nil
}
func (c *Client) getConn(callType callType, options connOptions) (queryer, error) {
switch callType {
case queryCall:
return c.conn, nil
case mgmtCall:
delete(options.mgmtOptions.requestProperties.Options, "results_progressive_enabled")
if options.mgmtOptions.queryIngestion {
c.mgmtConnMu.Lock()
defer c.mgmtConnMu.Unlock()
if c.ingestConn != nil {
return c.ingestConn, nil
}
u, _ := url.Parse(c.endpoint) // Don't care about the error
u.Host = "ingest-" + u.Host
auth := c.auth
var details *ClientDetails
if innerConn, ok := c.conn.(*Conn); ok {
details = innerConn.clientDetails
}
iconn, err := NewConn(u.String(), auth, c.http, details)
if err != nil {
return nil, err
}
c.ingestConn = iconn
return iconn, nil
}
return c.conn, nil
default:
return nil, errors.ES(errors.OpServConn, errors.KInternal, "an unknown calltype was passed to getConn()")
}
}
var nower = time.Now
func contextSetup(ctx context.Context, mgmtCall bool) (context.Context, context.CancelFunc, error) {
t, ok := ctx.Deadline()
if ok {
d := t.Sub(nower())
if d > 1*time.Hour {
if mgmtCall {
return ctx, nil, errors.ES(errors.OpMgmt, errors.KClientArgs, "cannot set a deadline greater than 1 hour(%s)", d)
}
return ctx, nil, errors.ES(errors.OpQuery, errors.KClientArgs, "cannot set a deadline greater than 1 hour(%s)", d)
}
ctx, cancel := context.WithCancel(ctx)
return ctx, cancel, nil
}
if mgmtCall {
ctx, cancel := context.WithTimeout(ctx, 10*time.Minute)
return ctx, cancel, nil
}
ctx, cancel := context.WithTimeout(ctx, 4*time.Minute)
return ctx, cancel, nil
}
func (c *Client) HttpClient() *http.Client {
return c.http
}
func (c *Client) ClientDetails() *ClientDetails {
return c.clientDetails
}
func (c *Client) Close() error {
var err error
if c.conn != nil {
err = c.conn.Close()
}
if c.ingestConn != nil {
err2 := c.ingestConn.Close()
if err == nil {
err = err2
} else {
err = errors.GetCombinedError(err, err2)
}
}
return err
}