-
Notifications
You must be signed in to change notification settings - Fork 4
/
update.go
278 lines (243 loc) · 9.89 KB
/
update.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
/*
Copyright 2018 The Vitess Authors.
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
http://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 engine
import (
"encoding/json"
"fmt"
"time"
"gopkg.in/src-d/go-vitess.v1/jsonutil"
"gopkg.in/src-d/go-vitess.v1/sqltypes"
"gopkg.in/src-d/go-vitess.v1/vt/key"
"gopkg.in/src-d/go-vitess.v1/vt/sqlannotation"
"gopkg.in/src-d/go-vitess.v1/vt/srvtopo"
"gopkg.in/src-d/go-vitess.v1/vt/vterrors"
"gopkg.in/src-d/go-vitess.v1/vt/vtgate/vindexes"
querypb "gopkg.in/src-d/go-vitess.v1/vt/proto/query"
vtrpcpb "gopkg.in/src-d/go-vitess.v1/vt/proto/vtrpc"
)
var _ Primitive = (*Update)(nil)
// Update represents the instructions to perform an update.
type Update struct {
// Opcode is the execution opcode.
Opcode UpdateOpcode
// Keyspace specifies the keyspace to send the query to.
Keyspace *vindexes.Keyspace
// TargetDestination specifies the destination to send the query to.
TargetDestination key.Destination
// Query specifies the query to be executed.
Query string
// Vindex specifies the vindex to be used.
Vindex vindexes.Vindex
// Values specifies the vindex values to use for routing.
// For now, only one value is specified.
Values []sqltypes.PlanValue
// ChangedVindexValues contains values for updated Vindexes during an update statement.
ChangedVindexValues map[string][]sqltypes.PlanValue
// Table sepcifies the table for the update.
Table *vindexes.Table
// OwnedVindexQuery is used for updating changes in lookup vindexes.
OwnedVindexQuery string
// Option to override the standard behavior and allow a multi-shard update
// to use single round trip autocommit.
MultiShardAutocommit bool
// QueryTimeout contains the optional timeout (in milliseconds) to apply to this query
QueryTimeout int
}
// MarshalJSON serializes the Update into a JSON representation.
// It's used for testing and diagnostics.
func (upd *Update) MarshalJSON() ([]byte, error) {
var tname, vindexName string
if upd.Table != nil {
tname = upd.Table.Name.String()
}
if upd.Vindex != nil {
vindexName = upd.Vindex.String()
}
marshalUpdate := struct {
Opcode UpdateOpcode
Keyspace *vindexes.Keyspace `json:",omitempty"`
Query string `json:",omitempty"`
Vindex string `json:",omitempty"`
Values []sqltypes.PlanValue `json:",omitempty"`
ChangedVindexValues map[string][]sqltypes.PlanValue `json:",omitempty"`
Table string `json:",omitempty"`
OwnedVindexQuery string `json:",omitempty"`
MultiShardAutocommit bool `json:",omitempty"`
QueryTimeout int `json:",omitempty"`
}{
Opcode: upd.Opcode,
Keyspace: upd.Keyspace,
Query: upd.Query,
Vindex: vindexName,
Values: upd.Values,
ChangedVindexValues: upd.ChangedVindexValues,
Table: tname,
OwnedVindexQuery: upd.OwnedVindexQuery,
MultiShardAutocommit: upd.MultiShardAutocommit,
QueryTimeout: upd.QueryTimeout,
}
return jsonutil.MarshalNoEscape(marshalUpdate)
}
// UpdateOpcode is a number representing the opcode
// for the Update primitve.
type UpdateOpcode int
// This is the list of UpdateOpcode values.
const (
// UpdateUnsharded is for routing an update statement
// to an unsharded keyspace.
UpdateUnsharded = UpdateOpcode(iota)
// UpdateEqual is for routing an update statement
// to a single shard: Requires: A Vindex, and
// a single Value.
UpdateEqual
// UpdateScatter is for routing a scattered
// update statement.
UpdateScatter
// UpdateByDestination is to route explicitly to a given
// target destination. Is used when the query explicitly sets a target destination:
// in the clause:
// e.g: UPDATE `keyspace[-]`.x1 SET foo=1
UpdateByDestination
)
var updName = map[UpdateOpcode]string{
UpdateUnsharded: "UpdateUnsharded",
UpdateEqual: "UpdateEqual",
UpdateScatter: "UpdateScatter",
UpdateByDestination: "UpdateByDestination",
}
// MarshalJSON serializes the UpdateOpcode as a JSON string.
// It's used for testing and diagnostics.
func (code UpdateOpcode) MarshalJSON() ([]byte, error) {
return json.Marshal(updName[code])
}
// RouteType returns a description of the query routing type used by the primitive
func (upd *Update) RouteType() string {
return updName[upd.Opcode]
}
// Execute performs a non-streaming exec.
func (upd *Update) Execute(vcursor VCursor, bindVars map[string]*querypb.BindVariable, wantfields bool) (*sqltypes.Result, error) {
if upd.QueryTimeout != 0 {
cancel := vcursor.SetContextTimeout(time.Duration(upd.QueryTimeout) * time.Millisecond)
defer cancel()
}
switch upd.Opcode {
case UpdateUnsharded:
return upd.execUpdateUnsharded(vcursor, bindVars)
case UpdateEqual:
return upd.execUpdateEqual(vcursor, bindVars)
case UpdateScatter:
return upd.execUpdateByDestination(vcursor, bindVars, key.DestinationAllShards{})
case UpdateByDestination:
return upd.execUpdateByDestination(vcursor, bindVars, upd.TargetDestination)
default:
// Unreachable.
return nil, fmt.Errorf("unsupported opcode: %v", upd)
}
}
// StreamExecute performs a streaming exec.
func (upd *Update) StreamExecute(vcursor VCursor, bindVars map[string]*querypb.BindVariable, wantfields bool, callback func(*sqltypes.Result) error) error {
return fmt.Errorf("query %q cannot be used for streaming", upd.Query)
}
// GetFields fetches the field info.
func (upd *Update) GetFields(vcursor VCursor, bindVars map[string]*querypb.BindVariable) (*sqltypes.Result, error) {
return nil, fmt.Errorf("BUG: unreachable code for %q", upd.Query)
}
func (upd *Update) execUpdateUnsharded(vcursor VCursor, bindVars map[string]*querypb.BindVariable) (*sqltypes.Result, error) {
rss, _, err := vcursor.ResolveDestinations(upd.Keyspace.Name, nil, []key.Destination{key.DestinationAllShards{}})
if err != nil {
return nil, vterrors.Wrap(err, "execUpdateUnsharded")
}
if len(rss) != 1 {
return nil, vterrors.Errorf(vtrpcpb.Code_FAILED_PRECONDITION, "Keyspace does not have exactly one shard: %v", rss)
}
return execShard(vcursor, upd.Query, bindVars, rss[0], true, true /* canAutocommit */)
}
func (upd *Update) execUpdateEqual(vcursor VCursor, bindVars map[string]*querypb.BindVariable) (*sqltypes.Result, error) {
key, err := upd.Values[0].ResolveValue(bindVars)
if err != nil {
return nil, vterrors.Wrap(err, "execUpdateEqual")
}
rs, ksid, err := resolveSingleShard(vcursor, upd.Vindex, upd.Keyspace, key)
if err != nil {
return nil, vterrors.Wrap(err, "execUpdateEqual")
}
if len(ksid) == 0 {
return &sqltypes.Result{}, nil
}
if len(upd.ChangedVindexValues) != 0 {
if err := upd.updateVindexEntries(vcursor, upd.OwnedVindexQuery, bindVars, rs, ksid); err != nil {
return nil, vterrors.Wrap(err, "execUpdateEqual")
}
}
rewritten := sqlannotation.AddKeyspaceIDs(upd.Query, [][]byte{ksid}, "")
return execShard(vcursor, rewritten, bindVars, rs, true /* isDML */, true /* canAutocommit */)
}
// updateVindexEntries performs an update when a vindex is being modified
// by the statement.
// Note: the commit order may be different from the DML order because it's possible
// for DMLs to reuse existing transactions.
// Note 2: While changes are being committed, the changing row could be
// unreachable by either the new or old column values.
func (upd *Update) updateVindexEntries(vcursor VCursor, query string, bindVars map[string]*querypb.BindVariable, rs *srvtopo.ResolvedShard, ksid []byte) error {
subQueryResult, err := execShard(vcursor, upd.OwnedVindexQuery, bindVars, rs, false /* isDML */, false /* canAutocommit */)
if err != nil {
return err
}
if len(subQueryResult.Rows) == 0 {
return nil
}
if len(subQueryResult.Rows) > 1 {
return vterrors.Errorf(vtrpcpb.Code_UNIMPLEMENTED, "unsupported: update changes multiple rows in the vindex")
}
colnum := 0
for _, colVindex := range upd.Table.Owned {
// Fetch the column values. colnum must keep incrementing.
fromIds := make([]sqltypes.Value, 0, len(colVindex.Columns))
for range colVindex.Columns {
fromIds = append(fromIds, subQueryResult.Rows[0][colnum])
colnum++
}
// Update columns only if they're being changed.
if colValues, ok := upd.ChangedVindexValues[colVindex.Name]; ok {
vindexColumnKeys := make([]sqltypes.Value, 0, len(colValues))
for _, colValue := range colValues {
resolvedVal, err := colValue.ResolveValue(bindVars)
if err != nil {
return err
}
vindexColumnKeys = append(vindexColumnKeys, resolvedVal)
}
if err := colVindex.Vindex.(vindexes.Lookup).Update(vcursor, fromIds, ksid, vindexColumnKeys); err != nil {
return err
}
}
}
return nil
}
func (upd *Update) execUpdateByDestination(vcursor VCursor, bindVars map[string]*querypb.BindVariable, dest key.Destination) (*sqltypes.Result, error) {
rss, _, err := vcursor.ResolveDestinations(upd.Keyspace.Name, nil, []key.Destination{dest})
if err != nil {
return nil, vterrors.Wrap(err, "execUpdateByDestination")
}
queries := make([]*querypb.BoundQuery, len(rss))
sql := sqlannotation.AnnotateIfDML(upd.Query, nil)
for i := range rss {
queries[i] = &querypb.BoundQuery{
Sql: sql,
BindVariables: bindVars,
}
}
autocommit := (len(rss) == 1 || upd.MultiShardAutocommit) && vcursor.AutocommitApproval()
result, errs := vcursor.ExecuteMultiShard(rss, queries, true /* isDML */, autocommit)
return result, vterrors.Aggregate(errs)
}