mirror of https://github.com/VinGarcia/ksql.git
44 lines
1.5 KiB
Go
44 lines
1.5 KiB
Go
package kissorm
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
)
|
|
|
|
// ErrRecordNotFound ...
|
|
var ErrRecordNotFound error = fmt.Errorf("kissorm: the query returned no results")
|
|
|
|
// ErrAbortIteration ...
|
|
var ErrAbortIteration error = fmt.Errorf("kissorm: abort iteration, should only be used inside QueryChunks function")
|
|
|
|
// ORMProvider describes the public behavior of this ORM
|
|
type ORMProvider interface {
|
|
Insert(ctx context.Context, records ...interface{}) error
|
|
Delete(ctx context.Context, ids ...interface{}) error
|
|
Update(ctx context.Context, records ...interface{}) error
|
|
|
|
Query(ctx context.Context, records interface{}, query string, params ...interface{}) error
|
|
QueryOne(ctx context.Context, record interface{}, query string, params ...interface{}) error
|
|
QueryChunks(ctx context.Context, parser ChunkParser) error
|
|
}
|
|
|
|
// ChunkParser stores the arguments of the QueryChunks function
|
|
type ChunkParser struct {
|
|
// The Query and Params are used together to build a query with
|
|
// protection from injection, just like when using the Find function.
|
|
Query string
|
|
Params []interface{}
|
|
|
|
ChunkSize int
|
|
Chunk interface{} // Must be a pointer to a slice of structs
|
|
|
|
// The closure that will be called right after
|
|
// filling the Chunk with ChunkSize records
|
|
//
|
|
// Each chunk consecutively parsed will overwrite the
|
|
// same slice, so don't keep references to it, if you
|
|
// need some data to be preserved after all chunks are
|
|
// processed copy the records by value.
|
|
ForEachChunk func() error
|
|
}
|