Repository navigation
Expand file tree
/
Copy pathcontext.go
More file actions
377 lines (328 loc) · 10.3 KB
/
Copy pathcontext.go
File metadata and controls
377 lines (328 loc) · 10.3 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
package clickhouse
import (
"context"
"maps"
"slices"
"time"
"go.opentelemetry.io/otel/trace"
"github.com/ClickHouse/clickhouse-go/v2/ext"
)
var _contextOptionKey = &QueryOptions{
settings: Settings{
"_contextOption": struct{}{},
},
}
type Settings map[string]any
// CustomSetting is a helper struct to distinguish custom settings from important ones.
// For native protocol, is_important flag is set to value 0x02 (see https://github.com/ClickHouse/ClickHouse/blob/c873560fe7185f45eed56520ec7d033a7beb1551/src/Core/BaseSettings.h#L516-L521)
// Only string value is supported until formatting logic that exists in ClickHouse is implemented in clickhouse-go. (https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/Field.cpp#L312 and https://github.com/ClickHouse/clickhouse-go/issues/992)
type CustomSetting struct {
Value string
}
// ColumnNameAndType represents a column name and type
type ColumnNameAndType struct {
Name string
Type string
}
type Parameters map[string]string
type (
QueryOption func(*QueryOptions) error
AsyncOptions struct {
ok bool
wait bool
}
QueryOptions struct {
span trace.SpanContext
async AsyncOptions
queryID string
quotaKey string
jwt string
initialUser string
events struct {
logs func(*Log)
progress func(*Progress)
profileInfo func(*ProfileInfo)
profileEvents func([]ProfileEvent)
}
settings Settings
parameters Parameters
external []*ext.Table
blockBufferSize uint8
userLocation *time.Location
columnNamesAndTypes []ColumnNameAndType
clientInfo ClientInfo
}
)
func WithSpan(span trace.SpanContext) QueryOption {
return func(o *QueryOptions) error {
o.span = span
return nil
}
}
func WithQueryID(queryID string) QueryOption {
return func(o *QueryOptions) error {
o.queryID = queryID
return nil
}
}
func WithBlockBufferSize(size uint8) QueryOption {
return func(o *QueryOptions) error {
o.blockBufferSize = size
return nil
}
}
func WithQuotaKey(quotaKey string) QueryOption {
return func(o *QueryOptions) error {
o.quotaKey = quotaKey
return nil
}
}
// WithJWT overrides the existing authentication with the given JWT.
// This only applies for clients connected with HTTPS to ClickHouse Cloud.
func WithJWT(jwt string) QueryOption {
return func(o *QueryOptions) error {
o.jwt = jwt
return nil
}
}
// WithInitialUser sets the user for interserver-secret queries.
func WithInitialUser(user string) QueryOption {
return func(o *QueryOptions) error {
o.initialUser = user
return nil
}
}
// WithColumnNamesAndTypes supplies metadata for HTTP inserts.
func WithColumnNamesAndTypes(columnNamesAndTypes []ColumnNameAndType) QueryOption {
return func(o *QueryOptions) error {
o.columnNamesAndTypes = columnNamesAndTypes
return nil
}
}
// WithClientInfo appends client info data to the query, visible in the system.query_log table.
// This does not replace the client info provided in the connection options, it appends to it.
// Can be called multiple times to append more info.
func WithClientInfo(ci ClientInfo) QueryOption {
return func(o *QueryOptions) error {
o.clientInfo = o.clientInfo.Append(ci)
return nil
}
}
func WithSettings(settings Settings) QueryOption {
return func(o *QueryOptions) error {
o.settings = settings
return nil
}
}
func WithParameters(params Parameters) QueryOption {
return func(o *QueryOptions) error {
o.parameters = params
return nil
}
}
func WithLogs(fn func(*Log)) QueryOption {
return func(o *QueryOptions) error {
o.events.logs = fn
return nil
}
}
func WithProgress(fn func(*Progress)) QueryOption {
return func(o *QueryOptions) error {
o.events.progress = fn
return nil
}
}
func WithProfileInfo(fn func(*ProfileInfo)) QueryOption {
return func(o *QueryOptions) error {
o.events.profileInfo = fn
return nil
}
}
func WithProfileEvents(fn func([]ProfileEvent)) QueryOption {
return func(o *QueryOptions) error {
o.events.profileEvents = fn
return nil
}
}
func WithExternalTable(t ...*ext.Table) QueryOption {
return func(o *QueryOptions) error {
o.external = append(o.external, t...)
return nil
}
}
// WithAsync enables async inserts. It sets `async_insert` to 1. When wait is true,
// it sets `wait_for_async_insert` to 1, and the insert returns after the server
// writes the data. When wait is false, it sets `wait_for_async_insert` to 0, and the
// insert returns after the server receives the data.
//
// WithAsync applies to Exec and to batches from PrepareBatch, on the Native and HTTP
// protocols. It overrides the same settings from WithSettings.
//
// A batch uses only the context that you give to PrepareBatch. With database/sql, a
// batch uses only the context that you give to PrepareContext. The context that you
// give to Stmt.ExecContext has no effect on the batch.
//
// Deprecated: ClickHouse 26.2 and later enable async insert by default, so with the
// default server settings WithAsync(true) has no effect. WithAsync(false) does not
// disable async insert: it only stops the client from waiting for the server, so the
// client does not get insert errors. Use WithSettings instead:
//
// WithSettings(Settings{"async_insert": 0}) // disable async insert
// WithSettings(Settings{"async_insert": 1, "wait_for_async_insert": 1}) // WithAsync(true)
// WithSettings(Settings{"async_insert": 1, "wait_for_async_insert": 0}) // WithAsync(false)
//
// WithSettings replaces the settings of an earlier WithSettings. If you already use
// WithSettings, add the async insert settings to the same Settings map.
func WithAsync(wait bool) QueryOption {
return func(o *QueryOptions) error {
o.async.ok, o.async.wait = true, wait
return nil
}
}
// Deprecated: use WithSettings with `async_insert` and `wait_for_async_insert`
// instead. See WithAsync.
func WithStdAsync(wait bool) QueryOption {
return func(o *QueryOptions) error {
o.async.ok, o.async.wait = true, wait
return nil
}
}
func WithUserLocation(location *time.Location) QueryOption {
return func(o *QueryOptions) error {
o.userLocation = location
return nil
}
}
func ignoreExternalTables() QueryOption {
return func(o *QueryOptions) error {
o.external = nil
return nil
}
}
// Context returns a derived context with the given ClickHouse QueryOptions.
// Existing QueryOptions will be overwritten per option if present.
// The QueryOptions Settings map will be initialized if nil.
func Context(parent context.Context, options ...QueryOption) context.Context {
var opt QueryOptions
if ctxOpt, ok := parent.Value(_contextOptionKey).(QueryOptions); ok {
opt = ctxOpt
}
for _, f := range options {
f(&opt)
}
if opt.settings == nil {
opt.settings = make(Settings)
}
return context.WithValue(parent, _contextOptionKey, opt)
}
// queryOptions returns a mutable copy of the QueryOptions struct within the given context.
// If ClickHouse context was not provided, an empty struct with a valid Settings map is returned.
func queryOptions(ctx context.Context) QueryOptions {
if opt, ok := ctx.Value(_contextOptionKey).(QueryOptions); ok {
return opt.clone()
}
return QueryOptions{
settings: make(Settings),
}
}
// queryOptionsAsync returns the AsyncOptions struct within the given context's QueryOptions.
func queryOptionsAsync(ctx context.Context) AsyncOptions {
if opt, ok := ctx.Value(_contextOptionKey).(QueryOptions); ok {
return opt.async
}
return AsyncOptions{}
}
// applyAsyncInsertSettings adds the settings that make the server run an INSERT as an
// async insert. wait selects if the server replies only after the data is flushed.
func (q *QueryOptions) applyAsyncInsertSettings(wait bool) {
q.settings["async_insert"] = 1
q.settings["wait_for_async_insert"] = 0
if wait {
q.settings["wait_for_async_insert"] = 1
}
}
// applyBatchAsyncInsertSettings adds the async insert settings to a batch INSERT when
// the context asks for an async insert with WithAsync.
func (q *QueryOptions) applyBatchAsyncInsertSettings() {
if q.async.ok {
q.applyAsyncInsertSettings(q.async.wait)
}
}
// queryOptionsUserLocation returns the *time.Location within the given context's QueryOptions.
func queryOptionsUserLocation(ctx context.Context) *time.Location {
if opt, ok := ctx.Value(_contextOptionKey).(QueryOptions); ok {
return opt.userLocation
}
return nil
}
// WithoutProfileEvents instructs the server not to send profile events for this query.
// This is a performance optimization for servers >= 25.11 that support the send_profile_events setting.
// On older servers, the setting is unknown and the server will return an error.
func WithoutProfileEvents() QueryOption {
return func(o *QueryOptions) error {
if o.settings == nil {
o.settings = make(Settings)
}
o.settings["send_profile_events"] = 0
return nil
}
}
func (q *QueryOptions) onProcess() *onProcess {
onProcess := &onProcess{
logs: func(logs []Log) {
if q.events.logs != nil {
for _, l := range logs {
q.events.logs(&l)
}
}
},
progress: func(p *Progress) {
if q.events.progress != nil {
q.events.progress(p)
}
},
profileInfo: func(p *ProfileInfo) {
if q.events.profileInfo != nil {
q.events.profileInfo(p)
}
},
}
profileEventsHandler := q.events.profileEvents
if profileEventsHandler != nil {
onProcess.profileEvents = func(events []ProfileEvent) {
profileEventsHandler(events)
}
}
return onProcess
}
// clone returns a copy of QueryOptions where Settings and Parameters are safely mutable.
func (q *QueryOptions) clone() QueryOptions {
c := QueryOptions{
span: q.span,
async: q.async,
queryID: q.queryID,
quotaKey: q.quotaKey,
initialUser: q.initialUser,
jwt: q.jwt,
events: q.events,
settings: nil,
parameters: nil,
external: q.external,
blockBufferSize: q.blockBufferSize,
userLocation: q.userLocation,
columnNamesAndTypes: nil,
}
if q.settings != nil {
c.settings = maps.Clone(q.settings)
}
if q.parameters != nil {
c.parameters = maps.Clone(q.parameters)
}
if q.columnNamesAndTypes != nil {
c.columnNamesAndTypes = slices.Clone(q.columnNamesAndTypes)
}
if q.clientInfo.Products != nil || q.clientInfo.Comment != nil {
c.clientInfo = q.clientInfo.Append(ClientInfo{})
}
return c
}