chutils

type ChField struct {
	Base   ChType     // Base is base type of ClickHouse field.
	Length int        // Length is length of field (0 for String).
	Funcs  OuterFuncs // OuterFunc is the outer function applied to the field (e.g. LowCardinality(), Nullable())
	Format string     // Format for incoming dates from Input, or outgoing Floats
}

type ChType int

type Connect struct {
	Host     string // Host is host IP
	User     string // User is ClickHouse username
	Password string // Password is user's password

	*sql.DB // ClickHouse database connector
	// contains filtered or unexported fields
}

type ConnectOpt func(conn *Connect)

type EngineType int

type ErrType int

type FieldDef struct {
	Name        string       // Name of the field.
	ChSpec      ChField      // ChSpec is the Clickhouse specification of field.
	Description string       // Description is an optional description for CREATE TABLE statement.
	Legal       *LegalValues // Legal are optional bounds/list of legal values.
	Missing     interface{}  // Missing is the value used for a field if the value is illegal.
	Default     interface{}  // Default is the value used for a field if the field is empty
	Width       int          // Width of field (for flat files)
	Drop        bool         // Drop, if True, instructs Outputs to ignore this field
}

type Input interface {
	Read(nTarget int, validate bool) (data []Row, valid []Valid, err error) // Read from the Input, possibly with validation
	Reset() error                                                           // Reset to beginning of source
	CountLines() (numLines int, err error)                                  // CountLines returns # of lines in source
	Seek(lineNo int) error                                                  // Seek moves to lineNo in source
	Close() error                                                           // Close the source
	TableSpec() *TableDef                                                   // TableSpec returns the TableDef for the source
}

type LegalValues struct {
	LowLimit  interface{} // Minimum legal value for types Int, Float
	HighLimit interface{} // Maximum legal value for types Int, Float
	Levels    []string    // Legal values for types String, FixedString
}

type OuterFunc int

type OuterFuncs []OuterFunc

type Output interface {
	Write(b []byte) (n int, err error) // Write byte array, n is # of bytes written. Writes do not go to ClickHouse (see Insert)
	Name() string                      // Name of output (file, table)
	Insert() error                     // Inserts into ClickHouse
	Separator() rune                   // Separator returns the field separator
	EOL() rune                         // EOL returns the End-of-line character
	Text() string                      // Text is text qualifier for strings.  If it is found, Export doubles it. For CH, this is a single quote.
	Close() error                      // Close writer
}

type Row []interface{}

type Status int

type TableDef struct {
	Key       string            // Key is the key for the table.
	Engine    EngineType        // EngineType is the ClickHouse table engine.
	FieldDefs map[int]*FieldDef // Map of fields in the table. The int key is the column order in the table.
	// contains filtered or unexported fields
}

type Valid []Status