driver

type Capability int

type Conn interface {
	Query(m Model, q query.Q, sort []Sort, limit int, offset int) Iter
	Count(m Model, q query.Q, limit int, offset int) (uint64, error)
	Exists(m Model, q query.Q) (bool, error)
	Insert(m Model, data interface{}) (Result, error)
	Operate(m Model, q query.Q, ops []*operation.Operation) (Result, error)
	Update(m Model, q query.Q, data interface{}) (Result, error)
	Upsert(m Model, q query.Q, data interface{}) (Result, error)
	Delete(m Model, q query.Q) (Result, error)
	Connection() interface{}
}

type Driver interface {
	Conn
	Check() error
	Initialize(m []Model) error
	Begin() (Tx, error)
	Transaction(f func(Driver) error) error
	Close() error
	// True if the driver can perform upserts
	Upserts() bool
	// List of struct tags to be read, in decreasing order of priority.
	// The first non-empty tag is used.
	Tags() []string
	Capabilities() Capability
	HasFunc(fname string, retType reflect.Type) bool
}

type Fields struct {
	*structs.Struct
	// Quoted mangled names of the fields, including the table
	// name (e.g. "table"."field").
	QuotedNames []string
	// Fields which should be omitted when they are empty
	OmitEmpty []bool
	// Fields which should become null when they are empty
	NullEmpty []bool
	// The index of the primary (-1 if there's no pk)
	PrimaryKey int
	// True if the primary key is an integer type with auto_increment
	AutoincrementPk bool
	// The fields which make the composite primary key, if any
	CompositePrimaryKey []int
	// Model methods called by the ORM
	Methods *Methods
	// Other models referenced by this model. The key
	// is the field name in this model.
	References map[string]*Reference
	// Default values. Key is field index, value is the default
	// which might be a reflect.Func with no arguments and one
	// return value or simply a value assignable to the field.
	Defaults map[int]reflect.Value
}

type Iter interface {
	Next(out ...interface{}) bool
	Err() error
	Close() error
}

type Join interface {
	Model() Model
	Type() JoinType
	Query() query.Q
}

type JoinType int

type Methods struct {
	// The address for the Load method. 0 if there's no Load method
	LoadPointer unsafe.Pointer
	// Wheter Load returns an error
	LoadReturns bool
	// The address for the Save method. 0 if there's no Save method
	SavePointer unsafe.Pointer
	// Wheter Save returns an error
	SaveReturns bool
}

type Model interface {
	Type() reflect.Type
	Table() string
	Fields() *Fields
	Indexes() []*index.Index
	Map(qname string) (string, reflect.Type, error)
	Skip() bool
	Join() Join
}

type Opener func(url *config.URL) (Driver, error)

type Reference struct {
	Model Model
	Field string
}

type Result interface {
	LastInsertId() (int64, error)
	RowsAffected() (int64, error)
}

type Sort interface {
	Field() string
	Direction() SortDirection
}

type SortDirection int

type Tx interface {
	Conn
	Commit() error
	Rollback() error
}