writer

Jun 12, 2026

Changes in this version

type RowIteratorResult

+ func RunRowSeqDeferredMetadata(metadata func() *sppb.ResultSetMetadata, rows iter.Seq2[*spanner.Row, error], ...) (*RowIteratorResult, error)

Jun 11, 2026

Changes in this version

+ var ErrInvalidSQLInsertKind = errors.New("invalid SQLInsertKind")

Jun 11, 2026

Changes in this version

+ var ErrNilRowSeq = errors.New("nil row sequence")

+ func RowSeq(rows ...*spanner.Row) iter.Seq2[*spanner.Row, error]

type RowIteratorResult

+ func RunRowSeq(md *sppb.ResultSetMetadata, rows iter.Seq2[*spanner.Row, error], ...) (*RowIteratorResult, error)

+ func WriteRowSeq(md *sppb.ResultSetMetadata, rows iter.Seq2[*spanner.Row, error], ...) (*RowIteratorResult, error)

Jun 8, 2026

Changes in this version

type DelimitedOption

+ func WithFlushEachRow() DelimitedOption

Jun 2, 2026

Changes in this version

+ var ErrInvalidSQLInsertKindForDialect = errors.New("INSERT OR IGNORE/UPDATE not supported for PostgreSQL dialect")

+ var ErrTableNameChangedMidBatch = errors.New("table name changed mid-batch")

type DelimitedOption

+ func DelimitedGCVExportOptions(metadata *sppb.ResultSetMetadata, formatter *spanvalue.FormatConfig, ...) []DelimitedOption

type DelimitedWriter

+ func (w *DelimitedWriter) FormatConfig() *spanvalue.FormatConfig

type JSONLOption

+ func JSONLGCVExportOptions(metadata *sppb.ResultSetMetadata, formatter *spanvalue.FormatConfig, ...) []JSONLOption

type JSONLWriter

+ func (w *JSONLWriter) FormatConfig() *spanvalue.FormatConfig

type RowIteratorHooks

+ func AfterEachSuccessfulWriteRow(base RowIteratorHooks, after func() error) RowIteratorHooks

+ func NewRowIteratorHooks() RowIteratorHooks

+ func ObserveWriteRow(base RowIteratorHooks, observe func(rowNum int) error) RowIteratorHooks

+ func WithRowOrdinal(base RowIteratorHooks, ord *RowOrdinal) RowIteratorHooks

+ func (h RowIteratorHooks) MarkOmitRowsRead() RowIteratorHooks

+ func (h RowIteratorHooks) OnRunStart(fn func()) RowIteratorHooks

+ func (h RowIteratorHooks) WithFinish(fn func(*RowIteratorResult) error) RowIteratorHooks

+ func (h RowIteratorHooks) WithPrepareMetadata(fn func(*sppb.ResultSetMetadata) error) RowIteratorHooks

+ func (h RowIteratorHooks) WithWriteRow(fn func(*spanner.Row) error) RowIteratorHooks

type RowIteratorResult

+ RowsRead int

+ type RowOrdinal struct

+ Current int

type SQLInsertOption

+ func WithSQLBatchSize(n int) SQLInsertOption

+ func WithSQLDialect(dialect databasepb.DatabaseDialect) SQLInsertOption

type SQLInsertWriter

+ func (w *SQLInsertWriter) FormatConfig() *spanvalue.FormatConfig

+ func (w *SQLInsertWriter) TableName() string

May 30, 2026

Changes in this version

+ var ErrNilRowIterator = errors.New("nil row iterator")

+ var ErrNilWriter = errors.New("nil row iterator writer")

+ type RowIteratorHooks struct

+ Finish func(*RowIteratorResult) error

+ PrepareMetadata func(*sppb.ResultSetMetadata) error

+ WriteRow func(*spanner.Row) error

+ func RowIteratorHooksFromWriter(w RowIteratorWriter) RowIteratorHooks

+ type RowIteratorResult struct

+ Metadata *sppb.ResultSetMetadata

+ Stats RowIteratorStats

+ func RunRowIterator(iter *spanner.RowIterator, hooks RowIteratorHooks) (*RowIteratorResult, error)

+ func WriteRowIterator(iter *spanner.RowIterator, w RowIteratorWriter) (*RowIteratorResult, error)

+ type RowIteratorStats struct

+ QueryPlan *sppb.QueryPlan

+ QueryStats map[string]any

+ RowCount int64

+ type RowIteratorWriter interface

+ PrepareRowType func(*sppb.StructType) error

May 29, 2026

Changes in this version

+ var ErrMismatchedStructValueCount = errors.New("mismatched struct value count")

+ var ErrMissingFieldTypes = errors.New("missing field types schema")

type DelimitedWriter

+ func (w *DelimitedWriter) PrepareColumnNames(names []string) error

+ func (w *DelimitedWriter) PrepareRowType(rowType *sppb.StructType) error

+ func (w *DelimitedWriter) WriteStructValues(values []*structpb.Value) error

type JSONLWriter

+ func (w *JSONLWriter) PrepareColumnNames(names []string) error

+ func (w *JSONLWriter) PrepareRowType(rowType *sppb.StructType) error

+ func (w *JSONLWriter) WriteStructValues(values []*structpb.Value) error

type Option

+ func WithColumnNames(names []string) Option

+ func WithRowType(rowType *sppb.StructType) Option

type SQLInsertWriter

+ func (w *SQLInsertWriter) PrepareColumnNames(names []string) error

+ func (w *SQLInsertWriter) PrepareRowType(rowType *sppb.StructType) error

+ func (w *SQLInsertWriter) WriteStructValues(values []*structpb.Value) error

May 28, 2026

Changes in this version

+ type SQLInsertKind int

+ const SQLInsert

+ const SQLInsertOrIgnore

+ const SQLInsertOrUpdate

+ func (k SQLInsertKind) String() string

type SQLInsertOption

+ func WithSQLInsertKind(kind SQLInsertKind) SQLInsertOption

May 28, 2026

Changes in this version

+ const Comma

+ func FormatDelimitedRow(fc *spanvalue.FormatConfig, row *spanner.Row, delimiter rune) (string, error)

+ func FormatDelimitedValues(fc *spanvalue.FormatConfig, columnNames []string, ...) (string, error)

+ func FormatJSONLRow(fc *spanvalue.FormatConfig, row *spanner.Row, ...) (string, error)

+ func FormatJSONLValues(fc *spanvalue.FormatConfig, columnNames []string, ...) (string, error)

+ func RowData(row *spanner.Row) ([]string, []spanner.GenericColumnValue, error)

+ type DelimitedOption interface

+ func WithHeader(header bool) DelimitedOption

+ type DelimitedWriter struct

+ Comma rune

+ Formatter *spanvalue.FormatConfig

+ Header bool

+ UnnamedFieldNamer spanvalue.UnnamedFieldNamer

+ func NewDelimitedWriterWithOptions(out io.Writer, delimiter rune, options ...DelimitedOption) *DelimitedWriter

+ func (w *DelimitedWriter) Flush() error

+ func (w *DelimitedWriter) Prepare(metadata *sppb.ResultSetMetadata) error

+ func (w *DelimitedWriter) WriteGCVs(values []spanner.GenericColumnValue) error

+ func (w *DelimitedWriter) WriteHeader() error

+ func (w *DelimitedWriter) WriteRow(row *spanner.Row) error

+ func (w *DelimitedWriter) WriteValues(columnNames []string, values []spanner.GenericColumnValue) error

+ type FlushWriter interface

+ type JSONLOption interface

type JSONLWriter

+ func NewJSONLWriterWithOptions(out io.Writer, options ...JSONLOption) *JSONLWriter

+ func (w *JSONLWriter) Prepare(metadata *sppb.ResultSetMetadata) error

+ type NameOption interface

+ func WithUnnamedFieldNamer(namer spanvalue.UnnamedFieldNamer) NameOption

+ type Option interface

+ func WithFormatter(formatter *spanvalue.FormatConfig) Option

+ func WithMetadata(metadata *sppb.ResultSetMetadata) Option

+ type SQLInsertOption interface

type SQLInsertWriter

+ func NewSQLInsertWriterWithOptions(out io.Writer, table string, options ...SQLInsertOption) *SQLInsertWriter

+ func (w *SQLInsertWriter) Prepare(metadata *sppb.ResultSetMetadata) error

May 28, 2026

Changes in this version

+ var ErrDelimiterAfterWrite = errors.New("delimiter changed after writer initialization")

+ var ErrInvalidDelimiter = errors.New("invalid delimiter")

type CSVWriter

+ Comma rune

+ func NewDelimitedWriter(out io.Writer, delimiter rune, metadata ...*sppb.ResultSetMetadata) *CSVWriter

+ type Flusher interface

+ Flush func() error

type JSONLWriter

+ func (w *JSONLWriter) Flush() error

type SQLInsertWriter

+ func (w *SQLInsertWriter) Flush() error

Apr 28, 2026

Changes in this version

+ var ErrColumnNamesMismatch = errors.New("column names mismatch")

+ var ErrEmptyColumnName = errors.New("empty column name")

+ var ErrEmptyTableName = errors.New("empty table name")

+ var ErrHeaderAfterData = errors.New("header after data")

+ var ErrMissingColumnNames = errors.New("missing column names")

+ var ErrNilOutputWriter = errors.New("nil output writer")

+ var ErrNilRow = spanvalue.ErrNilRow

+ type CSVWriter struct

+ Formatter *spanvalue.FormatConfig

+ Header bool

+ UnnamedFieldNamer spanvalue.UnnamedFieldNamer

+ func NewCSVWriter(out io.Writer, metadata ...*sppb.ResultSetMetadata) *CSVWriter

+ func (w *CSVWriter) Flush() error

+ func (w *CSVWriter) WriteGCVs(values []spanner.GenericColumnValue) error

+ func (w *CSVWriter) WriteHeader() error

+ func (w *CSVWriter) WriteRow(row *spanner.Row) error

+ func (w *CSVWriter) WriteValues(columnNames []string, values []spanner.GenericColumnValue) error

+ type JSONLWriter struct

+ Formatter *spanvalue.FormatConfig

+ UnnamedFieldNamer spanvalue.UnnamedFieldNamer

+ func NewJSONLWriter(out io.Writer, metadata ...*sppb.ResultSetMetadata) *JSONLWriter

+ func (w *JSONLWriter) WriteGCVs(values []spanner.GenericColumnValue) error

+ func (w *JSONLWriter) WriteRow(row *spanner.Row) error

+ func (w *JSONLWriter) WriteValues(columnNames []string, values []spanner.GenericColumnValue) error

+ type SQLInsertWriter struct

+ Formatter *spanvalue.FormatConfig

+ Table string

+ func NewSQLInsertWriter(out io.Writer, table string, metadata ...*sppb.ResultSetMetadata) *SQLInsertWriter

+ func (w *SQLInsertWriter) WriteGCVs(values []spanner.GenericColumnValue) error

+ func (w *SQLInsertWriter) WriteRow(row *spanner.Row) error

+ func (w *SQLInsertWriter) WriteValues(columnNames []string, values []spanner.GenericColumnValue) error

+ type Writer interface

+ WriteRow func(row *spanner.Row) error