storage

type Query struct {
	// support for filter condition, e.g: {"name": "test"}
	Filter map[string]interface{}
	// support for pagination
	Page int
	// support for pagination size
	Size int
	// support sort condition, e.g: {"created_at": "desc"}
	Sort map[string]string
	// support for preloading
	Preload string
	// support for preload all associations
	AllPreload bool
	// support for association query
	AssociationKey string
}

type Storage interface {
	// returns the database client
	Client() interface{}
	// Create creates a new record
	Create(ctx context.Context, model interface{}) error
	// Get retrieves a single record by ID
	Get(ctx context.Context, id uint64, result interface{}) error
	// GetBy retrieves a single record by custom conditions
	GetBy(ctx context.Context, filter map[string]interface{}, result interface{}) error
	// Update updates a record by ID
	Update(ctx context.Context, id uint64, data interface{}) error
	// UpdateBy updates records that match the filter
	UpdateBy(ctx context.Context, filter map[string]interface{}, data interface{}) error
	// Delete deletes a record by ID
	Delete(ctx context.Context, id uint64, model interface{}) error
	// DeleteBy deletes records that match the filter
	DeleteBy(ctx context.Context, filter map[string]interface{}, model interface{}) error
	// List retrieves multiple records with pagination, support association query
	List(ctx context.Context, query *Query, mainModel, assModel interface{}) (total int64, err error)
}