common

type Builder interface {
	WriteParam(Param) Builder
	WriteTuples([]Tuple) Builder
	WriteString(string) Builder
	WriteRune(rune) Builder
	WriteSerializables(...Serializable) Builder
	WriteConditionSerializable(ConditionSerializable, CondInterpreter) Builder
	Build() (string, []Param)
}

type CondInterpreter interface {
	// TimeOffset appends NOW() - '10 seconds'
	TimeOffset(duration time.Duration, sb Builder)
	// InTuple creates the condition (field1, field2, ...) IN ((val1, val2, ...), (val3, val4, ...))
	InTuple(fields []Serializable, vals []Tuple, sb Builder)
}

type Condition ConditionSerializable

type ConditionSerializable interface {
	WriteString(CondInterpreter, Builder)
}

type Field Serializable

type FieldName string

type JoinType int

type JoinedTable interface {
	ConditionSerializable
	JoinAs(typ JoinType, other Table, ons ConditionSerializable) JoinedTable
	Join(Table, ConditionSerializable) JoinedTable
}

type ModifiableQuery interface {
	AddField(Field)
	AddWhere(Condition)
	AddOrderBy(OrderBy)
	// AddLimit is used to manage the LIMIT clause.
	// Any passed value larger than zero will trigger the inclusion of the clause.
	// If one wants to explicitly insert a clause as `LIMIT 0`, then oen should use the constant ZeroLimit
	AddLimit(int)
	AddOffset(int)
}

type OrderBy Serializable

type PagInterpreter interface {
	// PreProcess modifies the SQL query to add pagination support
	PreProcess(driver.Pagination, ModifiableQuery)
}

type Param = any

type Serializable interface {
	WriteString(Builder)
}

type Table interface {
	JoinedTable
	Field(name FieldName) Field
}

type TableAlias string

type TableName string

type Tuple = []Param