forked from vitessio/vitess
-
Notifications
You must be signed in to change notification settings - Fork 2
/
result_reader.go
42 lines (34 loc) · 1.5 KB
/
result_reader.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
/*
Copyright 2017 Google Inc.
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 worker
import (
"github.com/xsec-lab/go/sqltypes"
querypb "github.com/xsec-lab/go/vt/proto/query"
)
// ResultReader is an advanced version of sqltypes.ResultStream.
// In addition to the streamed Result messages (which contain a set of rows),
// it will expose the Fields (columns information) of the result separately.
//
// Note that some code in the worker package checks if instances of ResultReader
// are equal. In consequence, any ResultReader implementation must always use
// pointer receivers. This way, implementations are always referred by their
// pointer type and the equal comparison of ResultReader instances behaves as
// expected.
type ResultReader interface {
// Fields returns the field information for the columns in the result.
Fields() []*querypb.Field
// Next is identical to sqltypes.ResultStream.Recv().
// It returns the next result on the stream.
// It will return io.EOF if the stream ended.
Next() (*sqltypes.Result, error)
}