-
Notifications
You must be signed in to change notification settings - Fork 122
/
connection.go
487 lines (442 loc) · 12.4 KB
/
connection.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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
// Copyright (c) 2017-2022 Snowflake Computing Inc. All rights reserved.
package gosnowflake
import (
"context"
"database/sql"
"database/sql/driver"
"encoding/json"
"net/http"
"net/url"
"os"
"regexp"
"strconv"
"strings"
"sync"
"sync/atomic"
)
const (
httpHeaderContentType = "Content-Type"
httpHeaderAccept = "accept"
httpHeaderUserAgent = "User-Agent"
httpHeaderServiceName = "X-Snowflake-Service"
httpHeaderContentLength = "Content-Length"
httpHeaderHost = "Host"
httpHeaderValueOctetStream = "application/octet-stream"
httpHeaderContentEncoding = "Content-Encoding"
)
const (
statementTypeIDMulti = int64(0x1000)
statementTypeIDDml = int64(0x3000)
statementTypeIDMultiTableInsert = statementTypeIDDml + int64(0x500)
)
const (
sessionClientSessionKeepAlive = "client_session_keep_alive"
sessionClientValidateDefaultParameters = "CLIENT_VALIDATE_DEFAULT_PARAMETERS"
sessionArrayBindStageThreshold = "client_stage_array_binding_threshold"
serviceName = "service_name"
)
type resultType string
const (
snowflakeResultType contextKey = "snowflakeResultType"
execResultType resultType = "exec"
queryResultType resultType = "query"
)
const privateLinkSuffix = "privatelink.snowflakecomputing.com"
type snowflakeConn struct {
ctx context.Context
cfg *Config
rest *snowflakeRestful
SequenceCounter uint64
QueryID string
SQLState string
telemetry *snowflakeTelemetry
internal InternalClient
}
var (
queryIDPattern = `[\w\-_]+`
queryIDRegexp = regexp.MustCompile(queryIDPattern)
)
func (sc *snowflakeConn) exec(
ctx context.Context,
query string,
noResult bool,
isInternal bool,
describeOnly bool,
bindings []driver.NamedValue) (
*execResponse, error) {
var err error
counter := atomic.AddUint64(&sc.SequenceCounter, 1) // query sequence counter
req := execRequest{
SQLText: query,
AsyncExec: noResult,
Parameters: map[string]interface{}{},
IsInternal: isInternal,
DescribeOnly: describeOnly,
SequenceID: counter,
}
if key := ctx.Value(multiStatementCount); key != nil {
req.Parameters[string(multiStatementCount)] = key
}
logger.WithContext(ctx).Infof("parameters: %v", req.Parameters)
// handle bindings, if required
requestID := getOrGenerateRequestIDFromContext(ctx)
if len(bindings) > 0 {
if err = sc.processBindings(ctx, bindings, describeOnly, requestID, &req); err != nil {
return nil, err
}
}
logger.WithContext(ctx).Infof("bindings: %v", req.Bindings)
// populate headers
headers := getHeaders()
if isFileTransfer(query) {
headers[httpHeaderAccept] = headerContentTypeApplicationJSON
}
if serviceName, ok := sc.cfg.Params[serviceName]; ok {
headers[httpHeaderServiceName] = *serviceName
}
jsonBody, err := json.Marshal(req)
if err != nil {
return nil, err
}
data, err := sc.rest.FuncPostQuery(ctx, sc.rest, &url.Values{}, headers,
jsonBody, sc.rest.RequestTimeout, requestID, sc.cfg)
if err != nil {
return data, err
}
code := -1
if data.Code != "" {
code, err = strconv.Atoi(data.Code)
if err != nil {
return data, err
}
}
logger.WithContext(ctx).Infof("Success: %v, Code: %v", data.Success, code)
if !data.Success {
return nil, (populateErrorFields(code, data)).exceptionTelemetry(sc)
}
// handle PUT/GET commands
if isFileTransfer(query) {
data, err = sc.processFileTransfer(ctx, data, query, isInternal)
if err != nil {
return nil, err
}
}
logger.WithContext(ctx).Info("Exec/Query SUCCESS")
sc.cfg.Database = data.Data.FinalDatabaseName
sc.cfg.Schema = data.Data.FinalSchemaName
sc.cfg.Role = data.Data.FinalRoleName
sc.cfg.Warehouse = data.Data.FinalWarehouseName
sc.QueryID = data.Data.QueryID
sc.SQLState = data.Data.SQLState
sc.populateSessionParameters(data.Data.Parameters)
return data, err
}
func (sc *snowflakeConn) Begin() (driver.Tx, error) {
return sc.BeginTx(sc.ctx, driver.TxOptions{})
}
func (sc *snowflakeConn) BeginTx(
ctx context.Context,
opts driver.TxOptions) (
driver.Tx, error) {
logger.WithContext(ctx).Info("BeginTx")
if opts.ReadOnly {
return nil, (&SnowflakeError{
Number: ErrNoReadOnlyTransaction,
SQLState: SQLStateFeatureNotSupported,
Message: errMsgNoReadOnlyTransaction,
}).exceptionTelemetry(sc)
}
if int(opts.Isolation) != int(sql.LevelDefault) {
return nil, (&SnowflakeError{
Number: ErrNoDefaultTransactionIsolationLevel,
SQLState: SQLStateFeatureNotSupported,
Message: errMsgNoDefaultTransactionIsolationLevel,
}).exceptionTelemetry(sc)
}
if sc.rest == nil {
return nil, driver.ErrBadConn
}
isDesc := isDescribeOnly(ctx)
if _, err := sc.exec(ctx, "BEGIN", false, /* noResult */
false /* isInternal */, isDesc, nil); err != nil {
return nil, err
}
return &snowflakeTx{sc}, nil
}
func (sc *snowflakeConn) cleanup() {
// must flush log buffer while the process is running.
sc.rest = nil
sc.cfg = nil
}
func (sc *snowflakeConn) Close() (err error) {
logger.WithContext(sc.ctx).Infoln("Close")
sc.telemetry.sendBatch()
sc.stopHeartBeat()
if !sc.cfg.KeepSessionAlive {
if err = sc.rest.FuncCloseSession(sc.ctx, sc.rest, sc.rest.RequestTimeout); err != nil {
logger.Error(err)
}
}
sc.cleanup()
return nil
}
func (sc *snowflakeConn) PrepareContext(
ctx context.Context,
query string) (
driver.Stmt, error) {
logger.WithContext(sc.ctx).Infoln("Prepare")
if sc.rest == nil {
return nil, driver.ErrBadConn
}
stmt := &snowflakeStmt{
sc: sc,
query: query,
}
return stmt, nil
}
func (sc *snowflakeConn) ExecContext(
ctx context.Context,
query string,
args []driver.NamedValue) (
driver.Result, error) {
logger.WithContext(ctx).Infof("Exec: %#v, %v", query, args)
if sc.rest == nil {
return nil, driver.ErrBadConn
}
noResult := isAsyncMode(ctx)
isDesc := isDescribeOnly(ctx)
// TODO handle isInternal
ctx = setResultType(ctx, execResultType)
data, err := sc.exec(ctx, query, noResult, false /* isInternal */, isDesc, args)
if err != nil {
logger.WithContext(ctx).Infof("error: %v", err)
if data != nil {
code, err := strconv.Atoi(data.Code)
if err != nil {
return nil, err
}
return nil, (&SnowflakeError{
Number: code,
SQLState: data.Data.SQLState,
Message: err.Error(),
QueryID: data.Data.QueryID,
}).exceptionTelemetry(sc)
}
return nil, err
}
// if async exec, return result object right away
if noResult {
return data.Data.AsyncResult, nil
}
if isDml(data.Data.StatementTypeID) {
// collects all values from the returned row sets
updatedRows, err := updateRows(data.Data)
if err != nil {
return nil, err
}
logger.WithContext(ctx).Debugf("number of updated rows: %#v", updatedRows)
return &snowflakeResult{
affectedRows: updatedRows,
insertID: -1,
queryID: sc.QueryID,
}, nil // last insert id is not supported by Snowflake
} else if isMultiStmt(&data.Data) {
return sc.handleMultiExec(ctx, data.Data)
}
logger.Debug("DDL")
return driver.ResultNoRows, nil
}
func (sc *snowflakeConn) QueryContext(
ctx context.Context,
query string,
args []driver.NamedValue) (
driver.Rows, error) {
qid, err := getResumeQueryID(ctx)
if err != nil {
return nil, err
}
if qid == "" {
return sc.queryContextInternal(ctx, query, args)
}
// check the query status to find out if there is a result to fetch
_, err = sc.checkQueryStatus(ctx, qid)
if err == nil || (err != nil && err.(*SnowflakeError).Number == ErrQueryIsRunning) {
// the query is running. Rows object will be returned from here.
return sc.buildRowsForRunningQuery(ctx, qid)
}
return nil, err
}
func (sc *snowflakeConn) queryContextInternal(
ctx context.Context,
query string,
args []driver.NamedValue) (
driver.Rows, error) {
logger.WithContext(ctx).Infof("Query: %#v, %v", query, args)
if sc.rest == nil {
return nil, driver.ErrBadConn
}
noResult := isAsyncMode(ctx)
isDesc := isDescribeOnly(ctx)
ctx = setResultType(ctx, queryResultType)
// TODO: handle isInternal
data, err := sc.exec(ctx, query, noResult, false /* isInternal */, isDesc, args)
if err != nil {
logger.WithContext(ctx).Errorf("error: %v", err)
if data != nil {
code, err := strconv.Atoi(data.Code)
if err != nil {
return nil, err
}
return nil, (&SnowflakeError{
Number: code,
SQLState: data.Data.SQLState,
Message: err.Error(),
QueryID: data.Data.QueryID,
}).exceptionTelemetry(sc)
}
return nil, err
}
// if async query, return row object right away
if noResult {
return data.Data.AsyncRows, nil
}
rows := new(snowflakeRows)
rows.sc = sc
rows.queryID = sc.QueryID
if isMultiStmt(&data.Data) {
// handleMultiQuery is responsible to fill rows with childResults
if err = sc.handleMultiQuery(ctx, data.Data, rows); err != nil {
return nil, err
}
} else {
rows.addDownloader(populateChunkDownloader(ctx, sc, data.Data))
}
rows.ChunkDownloader.start()
return rows, err
}
func (sc *snowflakeConn) Prepare(query string) (driver.Stmt, error) {
return sc.PrepareContext(sc.ctx, query)
}
func (sc *snowflakeConn) Exec(
query string,
args []driver.Value) (
driver.Result, error) {
return sc.ExecContext(sc.ctx, query, toNamedValues(args))
}
func (sc *snowflakeConn) Query(
query string,
args []driver.Value) (
driver.Rows, error) {
return sc.QueryContext(sc.ctx, query, toNamedValues(args))
}
func (sc *snowflakeConn) Ping(ctx context.Context) error {
logger.WithContext(ctx).Infoln("Ping")
if sc.rest == nil {
return driver.ErrBadConn
}
noResult := isAsyncMode(ctx)
isDesc := isDescribeOnly(ctx)
// TODO: handle isInternal
_, err := sc.exec(ctx, "SELECT 1", noResult, false, /* isInternal */
isDesc, []driver.NamedValue{})
return err
}
// CheckNamedValue determines which types are handled by this driver aside from
// the instances captured by driver.Value
func (sc *snowflakeConn) CheckNamedValue(nv *driver.NamedValue) error {
if supported := supportedArrayBind(nv); !supported {
return driver.ErrSkip
}
return nil
}
func (sc *snowflakeConn) GetQueryStatus(
ctx context.Context,
queryID string) (
*SnowflakeQueryStatus, error) {
queryRet, err := sc.checkQueryStatus(ctx, queryID)
if err != nil {
return nil, err
}
return &SnowflakeQueryStatus{
queryRet.SQLText,
queryRet.StartTime,
queryRet.EndTime,
queryRet.ErrorCode,
queryRet.ErrorMessage,
queryRet.Stats.ScanBytes,
queryRet.Stats.ProducedRows,
}, nil
}
func buildSnowflakeConn(ctx context.Context, config Config) (*snowflakeConn, error) {
sc := &snowflakeConn{
SequenceCounter: 0,
ctx: ctx,
cfg: &config,
}
var st http.RoundTripper = SnowflakeTransport
if sc.cfg.Transporter == nil {
if sc.cfg.InsecureMode {
// no revocation check with OCSP. Think twice when you want to enable this option.
st = snowflakeInsecureTransport
} else {
// set OCSP fail open mode
ocspResponseCacheLock.Lock()
atomic.StoreUint32((*uint32)(&ocspFailOpen), uint32(sc.cfg.OCSPFailOpen))
ocspResponseCacheLock.Unlock()
}
} else {
// use the custom transport
st = sc.cfg.Transporter
}
if strings.HasSuffix(sc.cfg.Host, privateLinkSuffix) {
if err := sc.setupOCSPPrivatelink(sc.cfg.Application, sc.cfg.Host); err != nil {
return nil, err
}
} else {
if _, set := os.LookupEnv(cacheServerURLEnv); set {
os.Unsetenv(cacheServerURLEnv)
}
}
var tokenAccessor TokenAccessor
if sc.cfg.TokenAccessor != nil {
tokenAccessor = sc.cfg.TokenAccessor
} else {
tokenAccessor = getSimpleTokenAccessor()
}
// authenticate
sc.rest = &snowflakeRestful{
Host: sc.cfg.Host,
Port: sc.cfg.Port,
Protocol: sc.cfg.Protocol,
Client: &http.Client{
// request timeout including reading response body
Timeout: sc.cfg.ClientTimeout,
Transport: st,
},
TokenAccessor: tokenAccessor,
LoginTimeout: sc.cfg.LoginTimeout,
RequestTimeout: sc.cfg.RequestTimeout,
FuncPost: postRestful,
FuncGet: getRestful,
FuncPostQuery: postRestfulQuery,
FuncPostQueryHelper: postRestfulQueryHelper,
FuncRenewSession: renewRestfulSession,
FuncPostAuth: postAuth,
FuncCloseSession: closeSession,
FuncCancelQuery: cancelQuery,
FuncPostAuthSAML: postAuthSAML,
FuncPostAuthOKTA: postAuthOKTA,
FuncGetSSO: getSSO,
}
if sc.cfg.DisableTelemetry {
sc.telemetry = &snowflakeTelemetry{enabled: false}
} else {
sc.telemetry = &snowflakeTelemetry{
flushSize: defaultFlushSize,
sr: sc.rest,
mutex: &sync.Mutex{},
enabled: true,
}
}
return sc, nil
}