mystiq

Documentation

Index

• Constants
• Variables
• type Fields
• type Mystiq
  • func New() Mystiq
• type OrderParam
• type Param
  • func (p Param) Parse(c mirage.Ctx) Param
  • func (p Param) Use(q *quirk.Quirk)
• type Query
  • func CreateSelect(table, textColumn string, valueColumn ...string) Query
  • func (q Query) CanUse() bool

Constants

const (
	Offset   = "offset"
	Fulltext = "fulltext"
	Order    = "order"
	Limit    = "limit"
)

const (
	Asc  = "asc"
	Desc = "desc"
)

Variables

var (
	DefaultLimit = 20
)

var (
	ErrorSliceValue = errors.New("value must be a slice")
)

Types

type Fields

type Fields struct {
	Fulltext []string
	Order    map[string]string
}

type Mystiq

type Mystiq interface {
	DB(db *quirk.DB, query Query) Mystiq
	Data(data []map[string]any) Mystiq

	GetAllFunc(fn func(param Param, t any) error) Mystiq
	GetOneFunc(fn func(name string, v any, t any) error) Mystiq
	GetManyFunc(fn func(name string, v any, t any) error) Mystiq

	GetAll(param Param, t any) error
	GetOne(name string, v any, t any) error
	GetMany(name string, v any, t any) error

	MustGetAll(param Param, t any)
	MustGetOne(name string, v any, t any)
	MustGetMany(name string, v any, t any)
}

func New

func New() Mystiq

type OrderParam

type OrderParam struct {
	Field     string
	Direction string
}

type Param

type Param struct {
	Fulltext string
	Offset   int
	Limit    int
	Order    []string
	Fields   Fields
}

func (Param) Parse

func (p Param) Parse(c mirage.Ctx) Param

func (Param) Use

func (p Param) Use(q *quirk.Quirk)

type Query

type Query struct {
	Table  string
	Fields map[string]string
	Value  string
	Alias  string
}

func CreateSelect

func CreateSelect(table, textColumn string, valueColumn ...string) Query

func (Query) CanUse

func (q Query) CanUse() bool