runtime

type Assignment struct {
	Column        string
	ColumnValue   interface{}
	OriginalValue interface{}
}

type Assignments []Assignment

type CreateParams struct {
	Table          string
	MarshaledTable string
	// IfNotExists determines to create the table only if it does not exists
	IfNotExists bool
	// AutoMigrate perform auto-migration of table scheme
	AutoMigrate bool
	// Ctx is a context parameter for the query
	// even though it is not recommended to store context in a struct, here the struct
	// actually represents an arguments list, passed to a function.
	Ctx context.Context
}

type DeleteParams struct {
	Table string
	Where Where
	// Ctx is a context parameter for the query
	// even though it is not recommended to store context in a struct, here the struct
	// actually represents an arguments list, passed to a function.
	Ctx context.Context
}

type DropParams struct {
	Table    string
	IfExists bool
	// Ctx is a context parameter for the query
	// even though it is not recommended to store context in a struct, here the struct
	// actually represents an arguments list, passed to a function.
	Ctx context.Context
}

type Group struct {
	Column string
}

type Groups []Group

type InsertParams struct {
	Table string
	// Assignments are values to store in the new row
	Assignments Assignments
	// Ctx is a context parameter for the query
	// even though it is not recommended to store context in a struct, here the struct
	// actually represents an arguments list, passed to a function.
	Ctx context.Context
}

type JoinParams struct {
	SelectParams
	Pairings []Pairing
}

type Order struct {
	Column string
	Dir    orm.OrderDir
}

type Orders []Order

type Page struct {
	Limit  int64
	Offset int64
}

type Pairing struct {
	// Column is the column in the current table for the JOIN statement
	Column string
	// JoinedColumn is the column in the referenced table for the JOIN statement
	JoinedColumn string
}

type SelectParams struct {
	Table string
	// Columns are the selected columns for the query
	Columns map[string]bool
	// Joins are recursive join arguments for the query
	Joins []JoinParams
	// Count indicates weather a COUNT(*) column should be added to the query
	Count bool
	// Where is the WHERE part of the query
	Where Where
	// Groups are is the GROUP BY conditions for the query
	Groups Groups
	// Orders are the ORDER BY conditions for the query
	Orders Orders
	// Page is for query pagination
	Page Page
	// OrderedColumns store all the columns of a table
	// they are defined in a specific order so the parsing of returned values from
	// the SQL query will be easy.
	OrderedColumns []string
	// Ctx is a context parameter for the query
	// even though it is not recommended to store context in a struct, here the struct
	// actually represents an arguments list, passed to a function.
	Ctx context.Context
}

type StatementArger interface {
	Statement(string) string
	Args() []interface{}
}

type TableNamer interface {
	TableName() string
}

type UpdateParams struct {
	Table       string
	Assignments Assignments
	Where       Where
	// Ctx is a context parameter for the query
	// even though it is not recommended to store context in a struct, here the struct
	// actually represents an arguments list, passed to a function.
	Ctx context.Context
}

type Where interface {
	StatementArger
	// Or applies OR condition with another Where statement
	Or(Where) Where
	// And applies AND condition with another Where statement
	And(Where) Where
}