Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow query timeout hints on shard targeting #15898

Merged
merged 4 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions go/test/endtoend/vtgate/queries/timeout/timeout_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,33 @@ func TestQueryTimeoutWithTables(t *testing.T) {
assert.Contains(t, err.Error(), "context deadline exceeded")
assert.Contains(t, err.Error(), "(errno 1317) (sqlstate 70100)")
}

// TestQueryTimeoutWithShardTargeting tests the query timeout with shard targeting.
func TestQueryTimeoutWithShardTargeting(t *testing.T) {
utils.SkipIfBinaryIsBelowVersion(t, 20, "vtgate")

mcmp, closer := start(t)
defer closer()

// shard targeting to -80 shard.
utils.Exec(t, mcmp.VtConn, "use `ks_misc/-80`")

// insert some data
utils.Exec(t, mcmp.VtConn, "insert into t1(id1, id2) values (1,2),(3,4),(4,5),(5,6)")

// insert
_, err := utils.ExecAllowError(t, mcmp.VtConn, "insert /*vt+ QUERY_TIMEOUT_MS=1 */ into t1(id1, id2) values (6,sleep(5))")
assert.ErrorContains(t, err, "context deadline exceeded (errno 1317) (sqlstate 70100)")

// update
_, err = utils.ExecAllowError(t, mcmp.VtConn, "update /*vt+ QUERY_TIMEOUT_MS=1 */ t1 set id2 = sleep(5)")
assert.ErrorContains(t, err, "context deadline exceeded (errno 1317) (sqlstate 70100)")

// delete
_, err = utils.ExecAllowError(t, mcmp.VtConn, "delete /*vt+ QUERY_TIMEOUT_MS=1 */ from t1 where id2 = sleep(5)")
assert.ErrorContains(t, err, "context deadline exceeded (errno 1317) (sqlstate 70100)")

// select
_, err = utils.ExecAllowError(t, mcmp.VtConn, "select /*vt+ QUERY_TIMEOUT_MS=1 */ 1 from t1 where id2 = 5 and sleep(100)")
assert.ErrorContains(t, err, "context deadline exceeded (errno 1317) (sqlstate 70100)")
}
2 changes: 1 addition & 1 deletion go/vt/vtgate/engine/cached_size.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion go/vt/vtgate/engine/send.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ type Send struct {
MultishardAutocommit bool

ReservedConnectionNeeded bool

// QueryTimeout contains the optional timeout (in milliseconds) to apply to this query
QueryTimeout int
}

// ShardName as key for setting shard name in bind variables map
Expand Down Expand Up @@ -88,7 +91,7 @@ func (s *Send) GetTableName() string {

// TryExecute implements Primitive interface
func (s *Send) TryExecute(ctx context.Context, vcursor VCursor, bindVars map[string]*querypb.BindVariable, wantfields bool) (*sqltypes.Result, error) {
ctx, cancelFunc := addQueryTimeout(ctx, vcursor, 0)
ctx, cancelFunc := addQueryTimeout(ctx, vcursor, s.QueryTimeout)
defer cancelFunc()

rss, err := s.checkAndReturnShards(ctx, vcursor)
Expand Down Expand Up @@ -192,6 +195,7 @@ func (s *Send) description() PrimitiveDescription {
"ShardNameNeeded": s.ShardNameNeeded,
"MultishardAutocommit": s.MultishardAutocommit,
"ReservedConnectionNeeded": s.ReservedConnectionNeeded,
"QueryTimeout": s.QueryTimeout,
}
return PrimitiveDescription{
OperatorType: "Send",
Expand Down
10 changes: 9 additions & 1 deletion go/vt/vtgate/planbuilder/bypass.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,21 @@ func buildPlanForBypass(stmt sqlparser.Statement, _ *sqlparser.ReservedVars, vsc
}
}

hints := &queryHints{}
if comments, ok := stmt.(sqlparser.Commented); ok {
if qh := getHints(comments.GetParsedComments()); qh != nil {
hints = qh
}
}

send := &engine.Send{
Keyspace: keyspace,
TargetDestination: vschema.Destination(),
Query: sqlparser.String(stmt),
IsDML: sqlparser.IsDMLStatement(stmt),
SingleShardOnly: false,
MultishardAutocommit: sqlparser.MultiShardAutocommitDirective(stmt),
MultishardAutocommit: hints.multiShardAutocommit,
QueryTimeout: hints.queryTimeout,
}
return newPlanResult(send), nil
}
Expand Down
79 changes: 78 additions & 1 deletion go/vt/vtgate/planbuilder/testdata/bypass_shard_cases.json
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@
}
},
{
"comment": "load data from s3 'x.txt' into table x",
"query": "load data from s3 'x.txt' into table x",
"plan": {
"QueryType": "OTHER",
Expand All @@ -141,6 +142,7 @@
}
},
{
"comment": "load data from s3 'x.txt'",
"query": "load data from s3 'x.txt'",
"plan": {
"QueryType": "OTHER",
Expand Down Expand Up @@ -174,5 +176,80 @@
"Query": "create /* test */ table t1(id bigint, primary key(id)) /* comments */"
}
}
},
{
"comment": "select bypass with query timeout hint",
"query": "select /*vt+ QUERY_TIMEOUT_MS=100 */ count(*), col from user",
"plan": {
"QueryType": "SELECT",
"Original": "select /*vt+ QUERY_TIMEOUT_MS=100 */ count(*), col from user",
"Instructions": {
"OperatorType": "Send",
"Keyspace": {
"Name": "main",
"Sharded": false
},
"TargetDestination": "Shard(-80)",
"Query": "select /*vt+ QUERY_TIMEOUT_MS=100 */ count(*), col from `user`",
"QueryTimeout": 100
}
}
},
{
"comment": "update bypass with query timeout hint",
"query": "update /*vt+ QUERY_TIMEOUT_MS=100 */ user set val = 1 where id = 1",
"plan": {
"QueryType": "UPDATE",
"Original": "update /*vt+ QUERY_TIMEOUT_MS=100 */ user set val = 1 where id = 1",
"Instructions": {
"OperatorType": "Send",
"Keyspace": {
"Name": "main",
"Sharded": false
},
"TargetDestination": "Shard(-80)",
"IsDML": true,
"Query": "update /*vt+ QUERY_TIMEOUT_MS=100 */ `user` set val = 1 where id = 1",
"QueryTimeout": 100
}
}
},
{
"comment": "delete bypass with query timeout hint",
"query": "DELETE /*vt+ QUERY_TIMEOUT_MS=100 */ FROM USER WHERE ID = 42",
"plan": {
"QueryType": "DELETE",
"Original": "DELETE /*vt+ QUERY_TIMEOUT_MS=100 */ FROM USER WHERE ID = 42",
"Instructions": {
"OperatorType": "Send",
"Keyspace": {
"Name": "main",
"Sharded": false
},
"TargetDestination": "Shard(-80)",
"IsDML": true,
"Query": "delete /*vt+ QUERY_TIMEOUT_MS=100 */ from `USER` where ID = 42",
"QueryTimeout": 100
}
}
},
{
"comment": "insert bypass with query timeout hint",
"query": "INSERT /*vt+ QUERY_TIMEOUT_MS=100 */ INTO USER (ID, NAME) VALUES (42, 'ms X')",
"plan": {
"QueryType": "INSERT",
"Original": "INSERT /*vt+ QUERY_TIMEOUT_MS=100 */ INTO USER (ID, NAME) VALUES (42, 'ms X')",
"Instructions": {
"OperatorType": "Send",
"Keyspace": {
"Name": "main",
"Sharded": false
},
"TargetDestination": "Shard(-80)",
"IsDML": true,
"Query": "insert /*vt+ QUERY_TIMEOUT_MS=100 */ into `USER`(ID, `NAME`) values (42, 'ms X')",
"QueryTimeout": 100
}
}
}
]
]
Loading