-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
options.go
293 lines (258 loc) · 10.3 KB
/
options.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
// Copyright 2021 Google LLC
//
// 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
//
// https://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 managedwriter
import (
"github.com/googleapis/gax-go/v2"
"google.golang.org/api/option"
"google.golang.org/api/option/internaloption"
"google.golang.org/protobuf/types/descriptorpb"
"google.golang.org/protobuf/types/known/wrapperspb"
)
// encapsulates custom client-level config settings.
type writerClientConfig struct {
useMultiplex bool
maxMultiplexPoolSize int
defaultInflightRequests int
defaultInflightBytes int
defaultAppendRowsCallOptions []gax.CallOption
}
// newWriterClientConfig builds a client config based on package-specific custom ClientOptions.
func newWriterClientConfig(opts ...option.ClientOption) *writerClientConfig {
conf := &writerClientConfig{}
for _, opt := range opts {
if wOpt, ok := opt.(writerClientOption); ok {
wOpt.ApplyWriterOpt(conf)
}
}
// Normalize the config to ensure we're dealing with sane values.
if conf.useMultiplex {
if conf.maxMultiplexPoolSize < 1 {
conf.maxMultiplexPoolSize = 1
}
}
if conf.defaultInflightBytes < 0 {
conf.defaultInflightBytes = 0
}
if conf.defaultInflightRequests < 0 {
conf.defaultInflightRequests = 0
}
return conf
}
// writerClientOption allows us to extend ClientOptions for client-specific needs.
type writerClientOption interface {
option.ClientOption
ApplyWriterOpt(*writerClientConfig)
}
// WithMultiplexing is an EXPERIMENTAL option that controls connection sharing
// when instantiating the Client. Only writes to default streams can leverage the
// multiplex pool. Internally, the client maintains a pool of connections per BigQuery
// destination region, and will grow the pool to it's maximum allowed size if there's
// sufficient traffic on the shared connection(s).
//
// This ClientOption is EXPERIMENTAL and subject to change.
func WithMultiplexing() option.ClientOption {
return &enableMultiplexSetting{useMultiplex: true}
}
type enableMultiplexSetting struct {
internaloption.EmbeddableAdapter
useMultiplex bool
}
func (s *enableMultiplexSetting) ApplyWriterOpt(c *writerClientConfig) {
c.useMultiplex = s.useMultiplex
}
// WithMultiplexPoolLimit is an EXPERIMENTAL option that sets the maximum
// shared multiplex pool size when instantiating the Client. If multiplexing
// is not enabled, this setting is ignored. By default, the limit is a single
// shared connection. This limit is applied per destination region.
//
// This ClientOption is EXPERIMENTAL and subject to change.
func WithMultiplexPoolLimit(maxSize int) option.ClientOption {
return &maxMultiplexPoolSizeSetting{maxSize: maxSize}
}
type maxMultiplexPoolSizeSetting struct {
internaloption.EmbeddableAdapter
maxSize int
}
func (s *maxMultiplexPoolSizeSetting) ApplyWriterOpt(c *writerClientConfig) {
c.maxMultiplexPoolSize = s.maxSize
}
// WithDefaultInflightRequests is an EXPERIMENTAL ClientOption for controlling
// the default limit of how many individual AppendRows write requests can
// be in flight on a connection at a time. This limit is enforced on all connections
// created by the instantiated Client.
//
// Note: the WithMaxInflightRequests WriterOption can still be used to control
// the behavior for individual ManagedStream writers when not using multiplexing.
//
// This ClientOption is EXPERIMENTAL and subject to change.
func WithDefaultInflightRequests(n int) option.ClientOption {
return &defaultInflightRequestsSetting{maxRequests: n}
}
type defaultInflightRequestsSetting struct {
internaloption.EmbeddableAdapter
maxRequests int
}
func (s *defaultInflightRequestsSetting) ApplyWriterOpt(c *writerClientConfig) {
c.defaultInflightRequests = s.maxRequests
}
// WithDefaultInflightBytes is an EXPERIMENTAL ClientOption for controlling
// the default byte limit for how many individual AppendRows write requests can
// be in flight on a connection at a time. This limit is enforced on all connections
// created by the instantiated Client.
//
// Note: the WithMaxInflightBytes WriterOption can still be used to control
// the behavior for individual ManagedStream writers when not using multiplexing.
//
// This ClientOption is EXPERIMENTAL and subject to change.
func WithDefaultInflightBytes(n int) option.ClientOption {
return &defaultInflightBytesSetting{maxBytes: n}
}
type defaultInflightBytesSetting struct {
internaloption.EmbeddableAdapter
maxBytes int
}
func (s *defaultInflightBytesSetting) ApplyWriterOpt(c *writerClientConfig) {
c.defaultInflightBytes = s.maxBytes
}
// WithDefaultAppendRowsCallOption is an EXPERIMENTAL ClientOption for controlling
// the gax.CallOptions passed when opening the underlying AppendRows bidi
// stream connections used by this library to communicate with the BigQuery
// Storage service. This option is propagated to all
// connections created by the instantiated Client.
//
// Note: the WithAppendRowsCallOption WriterOption can still be used to control
// the behavior for individual ManagedStream writers that don't participate
// in multiplexing.
//
// This ClientOption is EXPERIMENTAL and subject to change.
func WithDefaultAppendRowsCallOption(o gax.CallOption) option.ClientOption {
return &defaultAppendRowsCallOptionSetting{opt: o}
}
type defaultAppendRowsCallOptionSetting struct {
internaloption.EmbeddableAdapter
opt gax.CallOption
}
func (s *defaultAppendRowsCallOptionSetting) ApplyWriterOpt(c *writerClientConfig) {
c.defaultAppendRowsCallOptions = append(c.defaultAppendRowsCallOptions, s.opt)
}
// WriterOption are variadic options used to configure a ManagedStream instance.
type WriterOption func(*ManagedStream)
// WithType sets the stream type for the managed stream.
func WithType(st StreamType) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.streamType = st
}
}
// WithStreamName allows users to set the stream name this writer will
// append to explicitly. By default, the managed client will create the
// stream when instantiated if necessary.
//
// Note: Supplying this option causes other options which affect stream construction
// such as WithStreamType and WithDestinationTable to be ignored.
func WithStreamName(name string) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.streamID = name
}
}
// WithDestinationTable specifies the destination table to which a created
// stream will append rows. Format of the table:
//
// projects/{projectid}/datasets/{dataset}/tables/{table}
func WithDestinationTable(destTable string) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.destinationTable = destTable
}
}
// WithMaxInflightRequests bounds the inflight appends on the write connection.
//
// Note: See the WithDefaultInflightRequests ClientOption for setting a default
// when instantiating a client, rather than setting this limit per-writer.
// This WriterOption is ignored for ManagedStreams that participate in multiplexing.
func WithMaxInflightRequests(n int) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.MaxInflightRequests = n
}
}
// WithMaxInflightBytes bounds the inflight append request bytes on the write connection.
//
// Note: See the WithDefaultInflightBytes ClientOption for setting a default
// when instantiating a client, rather than setting this limit per-writer.
// This WriterOption is ignored for ManagedStreams that participate in multiplexing.
func WithMaxInflightBytes(n int) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.MaxInflightBytes = n
}
}
// WithTraceID allows instruments requests to the service with a custom trace prefix.
// This is generally for diagnostic purposes only.
func WithTraceID(traceID string) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.TraceID = traceID
}
}
// WithSchemaDescriptor describes the format of the serialized data being sent by
// AppendRows calls on the stream.
func WithSchemaDescriptor(dp *descriptorpb.DescriptorProto) WriterOption {
return func(ms *ManagedStream) {
ms.curDescVersion = newDescriptorVersion(dp)
}
}
// WithDataOrigin is used to attach an origin context to the instrumentation metrics
// emitted by the library.
func WithDataOrigin(dataOrigin string) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.dataOrigin = dataOrigin
}
}
// WithAppendRowsCallOption is used to supply additional call options to the ManagedStream when
// it opens the underlying append stream.
//
// Note: See the DefaultAppendRowsCallOption ClientOption for setting defaults
// when instantiating a client, rather than setting this limit per-writer. This WriterOption
// is ignored for ManagedStream writers that participate in multiplexing.
func WithAppendRowsCallOption(o gax.CallOption) WriterOption {
return func(ms *ManagedStream) {
ms.streamSettings.appendCallOptions = append(ms.streamSettings.appendCallOptions, o)
}
}
// EnableWriteRetries enables ManagedStream to automatically retry failed appends.
//
// Enabling retries is best suited for cases where users want to achieve at-least-once
// append semantics. Use of automatic retries may complicate patterns where the user
// is designing for exactly-once append semantics.
func EnableWriteRetries(enable bool) WriterOption {
return func(ms *ManagedStream) {
if enable {
ms.retry = newStatelessRetryer()
}
}
}
// AppendOption are options that can be passed when appending data with a managed stream instance.
type AppendOption func(*pendingWrite)
// UpdateSchemaDescriptor is used to update the descriptor message schema associated
// with a given stream.
func UpdateSchemaDescriptor(schema *descriptorpb.DescriptorProto) AppendOption {
return func(pw *pendingWrite) {
// create a new descriptorVersion and attach it to the pending write.
pw.descVersion = newDescriptorVersion(schema)
}
}
// WithOffset sets an explicit offset value for this append request.
func WithOffset(offset int64) AppendOption {
return func(pw *pendingWrite) {
pw.req.Offset = &wrapperspb.Int64Value{
Value: offset,
}
}
}