Skip to content

Commit c6bda23

Browse files
rahul2393rahul2393
authored
feat: add missing spanner config properties (#152)
* feat: add missing spanner config properties * incorporate requested changes * fix tests * re-trigger checks
1 parent 0ab6447 commit c6bda23

8 files changed

Lines changed: 325 additions & 1088 deletions

File tree

‎benchmarks/go.mod‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,41 @@ go 1.19
55
replace github.com/googleapis/go-sql-spanner => ../
66

77
require (
8-
cloud.google.com/go v0.110.0
9-
cloud.google.com/go/spanner v1.44.0
8+
cloud.google.com/go v0.110.2
9+
cloud.google.com/go/spanner v1.46.0
1010
github.com/google/uuid v1.3.0
11-
github.com/googleapis/go-sql-spanner v1.0.0
12-
google.golang.org/api v0.111.0
13-
google.golang.org/grpc v1.53.0
14-
google.golang.org/protobuf v1.28.1
11+
github.com/googleapis/go-sql-spanner v1.0.1
12+
google.golang.org/api v0.125.0
13+
google.golang.org/grpc v1.55.0
14+
google.golang.org/protobuf v1.30.0
1515
)
1616

1717
require (
18-
cloud.google.com/go/compute v1.18.0 // indirect
18+
cloud.google.com/go/compute v1.19.3 // indirect
1919
cloud.google.com/go/compute/metadata v0.2.3 // indirect
20-
cloud.google.com/go/iam v0.12.0 // indirect
21-
cloud.google.com/go/longrunning v0.4.1 // indirect
20+
cloud.google.com/go/iam v0.13.0 // indirect
21+
cloud.google.com/go/longrunning v0.5.0 // indirect
2222
github.com/census-instrumentation/opencensus-proto v0.4.1 // indirect
2323
github.com/cespare/xxhash/v2 v2.2.0 // indirect
2424
github.com/cncf/udpa/go v0.0.0-20220112060539-c52dc94e7fbe // indirect
25-
github.com/cncf/xds/go v0.0.0-20230105202645-06c439db220b // indirect
26-
github.com/envoyproxy/go-control-plane v0.10.3 // indirect
27-
github.com/envoyproxy/protoc-gen-validate v0.9.1 // indirect
25+
github.com/cncf/xds/go v0.0.0-20230310173818-32f1caf87195 // indirect
26+
github.com/envoyproxy/go-control-plane v0.11.0 // indirect
27+
github.com/envoyproxy/protoc-gen-validate v0.10.0 // indirect
2828
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
29-
github.com/golang/protobuf v1.5.2 // indirect
29+
github.com/golang/protobuf v1.5.3 // indirect
3030
github.com/google/go-cmp v0.5.9 // indirect
31+
github.com/google/s2a-go v0.1.4 // indirect
3132
github.com/googleapis/enterprise-certificate-proxy v0.2.3 // indirect
32-
github.com/googleapis/gax-go/v2 v2.7.0 // indirect
33+
github.com/googleapis/gax-go/v2 v2.10.0 // indirect
3334
go.opencensus.io v0.24.0 // indirect
34-
golang.org/x/net v0.7.0 // indirect
35-
golang.org/x/oauth2 v0.5.0 // indirect
36-
golang.org/x/sys v0.5.0 // indirect
37-
golang.org/x/text v0.7.0 // indirect
35+
golang.org/x/crypto v0.9.0 // indirect
36+
golang.org/x/net v0.10.0 // indirect
37+
golang.org/x/oauth2 v0.8.0 // indirect
38+
golang.org/x/sys v0.8.0 // indirect
39+
golang.org/x/text v0.9.0 // indirect
3840
golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
3941
google.golang.org/appengine v1.6.7 // indirect
40-
google.golang.org/genproto v0.0.0-20230303212802-e74f57abe488 // indirect
42+
google.golang.org/genproto v0.0.0-20230530153820-e85fd2cbaebc // indirect
43+
google.golang.org/genproto/googleapis/api v0.0.0-20230530153820-e85fd2cbaebc // indirect
44+
google.golang.org/genproto/googleapis/rpc v0.0.0-20230530153820-e85fd2cbaebc // indirect
4145
)

‎benchmarks/go.sum‎

Lines changed: 59 additions & 339 deletions
Large diffs are not rendered by default.

‎driver.go‎

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,14 @@ import (
3131
"cloud.google.com/go/spanner"
3232
adminapi "cloud.google.com/go/spanner/admin/database/apiv1"
3333
adminpb "cloud.google.com/go/spanner/admin/database/apiv1/databasepb"
34+
"cloud.google.com/go/spanner/apiv1/spannerpb"
3435
"google.golang.org/api/option"
3536
"google.golang.org/grpc"
3637
"google.golang.org/grpc/codes"
3738
"google.golang.org/grpc/status"
3839
)
3940

40-
const userAgent = "go-sql-spanner/1.0.1"
41+
const userAgent = "go-sql-spanner/1.0.2"
4142

4243
// dsnRegExpString describes the valid values for a dsn (connection name) for
4344
// Google Cloud Spanner. The string consists of the following parts:
@@ -51,8 +52,17 @@ const userAgent = "go-sql-spanner/1.0.1"
5152
// to true to connect to local mock servers that do not use SSL.
5253
// - retryAbortsInternally: Boolean that indicates whether the connection should automatically retry aborted errors.
5354
// The default is true.
55+
// - disableRouteToLeader: Boolean that indicates if all the requests of type read-write and PDML
56+
// need to be routed to the leader region.
57+
// The default is false
58+
// - minSessions: The minimum number of sessions in the backing session pool. The default is 100.
59+
// - maxSessions: The maximum number of sessions in the backing session pool. The default is 400.
60+
// - numChannels: The number of gRPC channels to use to communicate with Cloud Spanner. The default is 4.
61+
// - optimizerVersion: Sets the default query optimizer version to use for this connection.
62+
// - optimizerStatisticsPackage: Sets the default query optimizer statistic package to use for this connection.
63+
// - rpcPriority: Sets the priority for all RPC invocations from this connection (HIGH/MEDIUM/LOW). The default is HIGH.
5464
//
55-
// Example: `localhost:9010/projects/test-project/instances/test-instance/databases/test-database;usePlainText=true`
65+
// Example: `localhost:9010/projects/test-project/instances/test-instance/databases/test-database;usePlainText=true;disableRouteToLeader=true`
5666
var dsnRegExp = regexp.MustCompile("((?P<HOSTGROUP>[\\w.-]+(?:\\.[\\w\\.-]+)*[\\w\\-\\._~:/?#\\[\\]@!\\$&'\\(\\)\\*\\+,;=.]+)/)?projects/(?P<PROJECTGROUP>(([a-z]|[-.:]|[0-9])+|(DEFAULT_PROJECT_ID)))(/instances/(?P<INSTANCEGROUP>([a-z]|[-]|[0-9])+)(/databases/(?P<DATABASEGROUP>([a-z]|[-]|[_]|[0-9])+))?)?(([\\?|;])(?P<PARAMSGROUP>.*))?")
5767

5868
var _ driver.DriverContext = &Driver{}
@@ -206,9 +216,45 @@ func newConnector(d *Driver, dsn string) (*connector, error) {
206216
config.MaxOpened = val
207217
}
208218
}
209-
if strval, ok := connectorConfig.params["writesessions"]; ok {
210-
if val, err := strconv.ParseFloat(strval, 64); err == nil {
211-
config.WriteSessions = val
219+
if strval, ok := connectorConfig.params["numchannels"]; ok {
220+
if val, err := strconv.Atoi(strval); err == nil && val > 0 {
221+
config.NumChannels = val
222+
}
223+
}
224+
if strval, ok := connectorConfig.params["rpcpriority"]; ok {
225+
var priority spannerpb.RequestOptions_Priority
226+
switch strings.ToUpper(strval) {
227+
case "LOW":
228+
priority = spannerpb.RequestOptions_PRIORITY_LOW
229+
case "MEDIUM":
230+
priority = spannerpb.RequestOptions_PRIORITY_MEDIUM
231+
case "HIGH":
232+
priority = spannerpb.RequestOptions_PRIORITY_HIGH
233+
default:
234+
priority = spannerpb.RequestOptions_PRIORITY_UNSPECIFIED
235+
}
236+
config.ReadOptions.Priority = priority
237+
config.TransactionOptions.CommitPriority = priority
238+
config.QueryOptions.Priority = priority
239+
}
240+
if strval, ok := connectorConfig.params["optimizerversion"]; ok {
241+
if config.QueryOptions.Options == nil {
242+
config.QueryOptions.Options = &spannerpb.ExecuteSqlRequest_QueryOptions{}
243+
}
244+
config.QueryOptions.Options.OptimizerVersion = strval
245+
}
246+
if strval, ok := connectorConfig.params["optimizerstatisticspackage"]; ok {
247+
if config.QueryOptions.Options == nil {
248+
config.QueryOptions.Options = &spannerpb.ExecuteSqlRequest_QueryOptions{}
249+
}
250+
config.QueryOptions.Options.OptimizerStatisticsPackage = strval
251+
}
252+
if strval, ok := connectorConfig.params["databaserole"]; ok {
253+
config.DatabaseRole = strval
254+
}
255+
if strval, ok := connectorConfig.params["disableroutetoleader"]; ok {
256+
if val, err := strconv.ParseBool(strval); err == nil {
257+
config.DisableRouteToLeader = val
212258
}
213259
}
214260
config.UserAgent = userAgent

‎driver_test.go‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"time"
2222

2323
"cloud.google.com/go/spanner"
24+
"cloud.google.com/go/spanner/apiv1/spannerpb"
2425
"github.com/google/go-cmp/cmp"
2526
"github.com/google/go-cmp/cmp/cmpopts"
2627
"google.golang.org/grpc/codes"
@@ -153,30 +154,41 @@ func TestExtractDnsParts(t *testing.T) {
153154
},
154155
},
155156
{
156-
input: "spanner.googleapis.com/projects/p/instances/i/databases/d?minSessions=200;maxSessions=1000;writeSessions=0.5",
157+
input: "spanner.googleapis.com/projects/p/instances/i/databases/d?minSessions=200;maxSessions=1000;numChannels=10;disableRouteToLeader=true;rpcPriority=Medium;optimizerVersion=1;optimizerStatisticsPackage=latest;databaseRole=child",
157158
wantConnectorConfig: connectorConfig{
158159
host: "spanner.googleapis.com",
159160
project: "p",
160161
instance: "i",
161162
database: "d",
162163
params: map[string]string{
163-
"minsessions": "200",
164-
"maxsessions": "1000",
165-
"writesessions": "0.5",
164+
"minsessions": "200",
165+
"maxsessions": "1000",
166+
"numchannels": "10",
167+
"disableroutetoleader": "true",
168+
"rpcpriority": "Medium",
169+
"optimizerversion": "1",
170+
"optimizerstatisticspackage": "latest",
171+
"databaserole": "child",
166172
},
167173
},
168174
wantSpannerConfig: spanner.ClientConfig{
169175
SessionPoolConfig: spanner.SessionPoolConfig{
170176
MinOpened: 200,
171177
MaxOpened: 1000,
172-
WriteSessions: 0.5,
178+
WriteSessions: 0.2,
173179
HealthCheckInterval: spanner.DefaultSessionPoolConfig.HealthCheckInterval,
174180
HealthCheckWorkers: spanner.DefaultSessionPoolConfig.HealthCheckWorkers,
175181
MaxBurst: spanner.DefaultSessionPoolConfig.MaxBurst,
176182
MaxIdle: spanner.DefaultSessionPoolConfig.MaxIdle,
177183
TrackSessionHandles: spanner.DefaultSessionPoolConfig.TrackSessionHandles,
178184
},
179-
UserAgent: userAgent,
185+
NumChannels: 10,
186+
UserAgent: userAgent,
187+
DisableRouteToLeader: true,
188+
QueryOptions: spanner.QueryOptions{Priority: spannerpb.RequestOptions_PRIORITY_MEDIUM, Options: &spannerpb.ExecuteSqlRequest_QueryOptions{OptimizerVersion: "1", OptimizerStatisticsPackage: "latest"}},
189+
ReadOptions: spanner.ReadOptions{Priority: spannerpb.RequestOptions_PRIORITY_MEDIUM},
190+
TransactionOptions: spanner.TransactionOptions{CommitPriority: spannerpb.RequestOptions_PRIORITY_MEDIUM},
191+
DatabaseRole: "child",
180192
},
181193
},
182194
{
@@ -204,7 +216,7 @@ func TestExtractDnsParts(t *testing.T) {
204216
if err != nil {
205217
t.Errorf("failed to get connector for %q: %v", tc.input, err)
206218
}
207-
if !cmp.Equal(conn.spannerClientConfig, tc.wantSpannerConfig, cmpopts.IgnoreUnexported(spanner.ClientConfig{}, spanner.SessionPoolConfig{})) {
219+
if !cmp.Equal(conn.spannerClientConfig, tc.wantSpannerConfig, cmpopts.IgnoreUnexported(spanner.ClientConfig{}, spanner.SessionPoolConfig{}, spannerpb.ExecuteSqlRequest_QueryOptions{})) {
208220
t.Errorf("connector Spanner client config mismatch for %q\n Got: %v\nWant: %v", tc.input, conn.spannerClientConfig, tc.wantSpannerConfig)
209221
}
210222
}

‎examples/go.mod‎

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,53 @@ go 1.19
55
replace github.com/googleapis/go-sql-spanner => ../
66

77
require (
8-
cloud.google.com/go v0.110.0
9-
cloud.google.com/go/spanner v1.44.0
10-
github.com/docker/docker v23.0.1+incompatible
8+
cloud.google.com/go v0.110.2
9+
cloud.google.com/go/spanner v1.46.0
10+
github.com/docker/docker v24.0.2+incompatible
1111
github.com/docker/go-connections v0.4.0
12-
github.com/googleapis/go-sql-spanner v1.0.0
12+
github.com/googleapis/go-sql-spanner v1.0.1
1313
)
1414

1515
require (
16-
cloud.google.com/go/compute v1.18.0 // indirect
16+
cloud.google.com/go/compute v1.19.3 // indirect
1717
cloud.google.com/go/compute/metadata v0.2.3 // indirect
18-
cloud.google.com/go/iam v0.12.0 // indirect
19-
cloud.google.com/go/longrunning v0.4.1 // indirect
20-
github.com/Azure/go-ansiterm v0.0.0-20230124172434-306776ec8161 // indirect
18+
cloud.google.com/go/iam v0.13.0 // indirect
19+
cloud.google.com/go/longrunning v0.5.0 // indirect
2120
github.com/Microsoft/go-winio v0.5.2 // indirect
2221
github.com/census-instrumentation/opencensus-proto v0.4.1 // indirect
2322
github.com/cespare/xxhash/v2 v2.2.0 // indirect
2423
github.com/cncf/udpa/go v0.0.0-20220112060539-c52dc94e7fbe // indirect
25-
github.com/cncf/xds/go v0.0.0-20230105202645-06c439db220b // indirect
24+
github.com/cncf/xds/go v0.0.0-20230310173818-32f1caf87195 // indirect
2625
github.com/docker/distribution v2.8.1+incompatible // indirect
2726
github.com/docker/go-units v0.5.0 // indirect
28-
github.com/envoyproxy/go-control-plane v0.10.3 // indirect
29-
github.com/envoyproxy/protoc-gen-validate v0.9.1 // indirect
27+
github.com/envoyproxy/go-control-plane v0.11.0 // indirect
28+
github.com/envoyproxy/protoc-gen-validate v0.10.0 // indirect
3029
github.com/gogo/protobuf v1.3.2 // indirect
3130
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
32-
github.com/golang/protobuf v1.5.2 // indirect
31+
github.com/golang/protobuf v1.5.3 // indirect
3332
github.com/google/go-cmp v0.5.9 // indirect
33+
github.com/google/s2a-go v0.1.4 // indirect
3434
github.com/googleapis/enterprise-certificate-proxy v0.2.3 // indirect
35-
github.com/googleapis/gax-go/v2 v2.7.0 // indirect
36-
github.com/moby/term v0.0.0-20221205130635-1aeaba878587 // indirect
35+
github.com/googleapis/gax-go/v2 v2.10.0 // indirect
36+
github.com/moby/term v0.5.0 // indirect
3737
github.com/morikuni/aec v1.0.0 // indirect
3838
github.com/opencontainers/go-digest v1.0.0 // indirect
3939
github.com/opencontainers/image-spec v1.0.2 // indirect
4040
github.com/pkg/errors v0.9.1 // indirect
4141
go.opencensus.io v0.24.0 // indirect
42-
golang.org/x/net v0.7.0 // indirect
43-
golang.org/x/oauth2 v0.5.0 // indirect
44-
golang.org/x/sys v0.5.0 // indirect
45-
golang.org/x/text v0.7.0 // indirect
42+
golang.org/x/crypto v0.9.0 // indirect
43+
golang.org/x/net v0.10.0 // indirect
44+
golang.org/x/oauth2 v0.8.0 // indirect
45+
golang.org/x/sys v0.8.0 // indirect
46+
golang.org/x/text v0.9.0 // indirect
47+
golang.org/x/time v0.3.0 // indirect
4648
golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
47-
google.golang.org/api v0.111.0 // indirect
49+
google.golang.org/api v0.125.0 // indirect
4850
google.golang.org/appengine v1.6.7 // indirect
49-
google.golang.org/genproto v0.0.0-20230303212802-e74f57abe488 // indirect
50-
google.golang.org/grpc v1.53.0 // indirect
51-
google.golang.org/protobuf v1.28.1 // indirect
51+
google.golang.org/genproto v0.0.0-20230530153820-e85fd2cbaebc // indirect
52+
google.golang.org/genproto/googleapis/api v0.0.0-20230530153820-e85fd2cbaebc // indirect
53+
google.golang.org/genproto/googleapis/rpc v0.0.0-20230530153820-e85fd2cbaebc // indirect
54+
google.golang.org/grpc v1.55.0 // indirect
55+
google.golang.org/protobuf v1.30.0 // indirect
5256
gotest.tools/v3 v3.4.0 // indirect
5357
)

0 commit comments

Comments
 (0)