csv

Documentation

Index

• func New(opts *Options) (format.Select, error)
• type Options

Functions

func New

func New(opts *Options) (format.Select, error)

New sets up a new Input, the first row is read when this is run. If there is a problem with reading the first row, the error is returned. Otherwise, the returned reader can be reliably consumed with Read(). until Read() return err.

Types

type Options

type Options struct {
	// HasHeader when true, will treat the first row as a header row.
	HasHeader bool

	// RecordDelimiter is the string that records are delimited by.
	RecordDelimiter string

	// FieldDelimiter is the string that fields are delimited by.
	FieldDelimiter string

	// Comments is the string the first character of a line of
	// text matches the comment character.
	Comments string

	// Name of the table that is used for querying
	Name string

	// ReadFrom is where the data will be read from.
	ReadFrom io.Reader

	// If true then we need to add gzip or bzip reader.
	// to extract the csv.
	Compressed string

	// SQL expression meant to be evaluated.
	Expression string

	// Output CSV will be delimited by.
	OutputFieldDelimiter string

	// Output CSV record will be delimited by.
	OutputRecordDelimiter string

	// Size of incoming object
	StreamSize int64

	// Whether Header is "USE" or another
	HeaderOpt bool

	// Progress enabled, enable/disable progress messages.
	Progress bool

	// Output format type, supported values are CSV and JSON
	OutputType format.Type
}

Options options are passed to the underlying encoding/csv reader.