query

Documentation

Index

• Constants
• func NewParam(column, value string) param
• type Dialect
  • func (d *Dialect) Apply(q *Query)
  • func (d *Dialect) NewQuery(mods ...queryMod) *Query
  • func (d *Dialect) ParseFilter(raw string, validateFunc ValidatorFunc) *filter
  • func (d *Dialect) ParsePagination(raw string) queryMod
  • func (d *Dialect) ParseParams(raw ...param) *params
  • func (d *Dialect) ParseRelation(raw string) *relation
  • func (d *Dialect) ParseSort(raw string, validateFunc ValidatorFunc) *sort
• type PaginationResponse
  • func Paginate[T any](q *Query, data []*T) ([]*T, *PaginationResponse)
• type ParamSlice
• type Query
  • func (q *Query) Mods(tn string) []qm.QueryMod
  • func (q *Query) SQL(tn string) (string, []any)
• type ValidatorFunc

Constants

const (
	MySQL driver = iota
	Postgres
)

const (
	PascalCase casing = iota // Represented as PascalCase
	CamelCase                // Represented as camelCase
	SnakeCase                // Represented as snake_case
)

const (
	OffsetPagination paginationType = iota
	CursorPagination
)

Functions

func NewParam

func NewParam(column, value string) param

Types

type Dialect

type Dialect struct {

	// Exported fields
	Driver             driver
	HasAutoIncrementID bool
	APICasing          casing
	DBCasing           casing
	PaginationType     paginationType
	MaxLimit           int
	// contains filtered or unexported fields
}

func (*Dialect) Apply

func (d *Dialect) Apply(q *Query)

func (*Dialect) NewQuery

func (d *Dialect) NewQuery(mods ...queryMod) *Query

func (*Dialect) ParseFilter

func (d *Dialect) ParseFilter(raw string, validateFunc ValidatorFunc) *filter

func (*Dialect) ParsePagination

func (d *Dialect) ParsePagination(raw string) queryMod

func (*Dialect) ParseParams

func (d *Dialect) ParseParams(raw ...param) *params

func (*Dialect) ParseRelation

func (d *Dialect) ParseRelation(raw string) *relation

func (*Dialect) ParseSort

func (d *Dialect) ParseSort(raw string, validateFunc ValidatorFunc) *sort

type PaginationResponse

type PaginationResponse = map[string]any

func Paginate

func Paginate[T any](q *Query, data []*T) ([]*T, *PaginationResponse)

type ParamSlice

type ParamSlice []param

type Query

type Query struct {
	Filter           *filter
	Params           *params
	Sort             *sort
	Relation         *relation
	OffsetPagination *offsetPagination
	// contains filtered or unexported fields
}

func (*Query) Mods

func (q *Query) Mods(tn string) []qm.QueryMod

func (*Query) SQL

func (q *Query) SQL(tn string) (string, []any)

type ValidatorFunc

type ValidatorFunc func(k string) bool