wehub-resource-sync
63 lines
1.9 KiB
Go
63 lines
1.9 KiB
Go
// Copyright 2020 Dolthub, 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 table
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/dolthub/go-mysql-server/sql"
|
|
|
|
"github.com/dolthub/dolt/go/libraries/doltcore/row"
|
|
"github.com/dolthub/dolt/go/libraries/doltcore/schema"
|
|
)
|
|
|
|
// Reader is an interface for reading rows from a table
|
|
type Reader interface {
|
|
// GetSchema gets the schema of the rows that this reader will return
|
|
GetSchema() schema.Schema
|
|
|
|
// ReadRow reads a row from a table. If there is a bad row the returned error will be non nil, and calling
|
|
// IsBadRow(err) will be return true. This is a potentially non-fatal error and callers can decide if they want to
|
|
// continue on a bad row, or fail.
|
|
ReadRow(ctx context.Context) (row.Row, error)
|
|
}
|
|
|
|
// Closer is an interface for a writer that can be closed to release resources
|
|
type Closer interface {
|
|
// Close should release resources being held
|
|
Close(ctx context.Context) error
|
|
}
|
|
|
|
// ReadCloser is an interface for reading rows from a table, that can be closed.
|
|
type ReadCloser interface {
|
|
Reader
|
|
Closer
|
|
}
|
|
|
|
type SqlRowReader interface {
|
|
ReadCloser
|
|
|
|
ReadSqlRow(ctx context.Context) (sql.Row, error)
|
|
}
|
|
|
|
// SqlTableReader is a Reader that can read rows as sql.Row.
|
|
type SqlTableReader interface {
|
|
// GetSchema gets the schema of the rows that this reader will return
|
|
GetSchema() schema.Schema
|
|
|
|
// ReadSqlRow reads a row from a table as go-mysql-server sql.Row.
|
|
ReadSqlRow(ctx context.Context) (sql.Row, error)
|
|
}
|