query

Documentation

Index

• Variables
• type OrderBy
  • func (w *OrderBy) Add(key string, IsDESC bool)
  • func (w *OrderBy) AddClause(clause string)
  • func (w *OrderBy) Build() string
  • func (w *OrderBy) Debug()
  • func (w *OrderBy) Del(key string)
  • func (w *OrderBy) Get(key string) (bool, bool)
  • func (w *OrderBy) GetClause(key string) string
  • func (w *OrderBy) Length() int
  • func (w *OrderBy) Reset()
  • func (w *OrderBy) Set(key string, IsDESC bool)
• type OrderByOne
  • func (w *OrderByOne) Clause() string
  • func (w *OrderByOne) String() string
• type Query
  • func New(request *http.Request) Query
• type SetWhereOptions
• type Where
  • func (w *Where) Add(key string, value interface{}, opts ...*SetWhereOptions)
  • func (w *Where) Build() (query string, args []interface{}, err error)
  • func (w *Where) Debug()
  • func (w *Where) Del(key string)
  • func (w *Where) Get(key string) (interface{}, bool)
  • func (w *Where) Length() int
  • func (w *Where) Reset()
  • func (w *Where) Set(key string, value interface{}, opts ...*SetWhereOptions)
• type WhereOne

Variables

var ConstantsQueryAccessTokenKeys = []string{
	"access_token",
	"accessToken",
}

ConstantsQueryAccessTokenKeys is the keys that are used to identify the access token.

var ConstantsQueryIDKeys = []string{
	"id",
	"_id",
}

ConstantsQueryIDKeys is the keys that are used to identify the id.

var ConstantsQueryPageSizeKeys = []string{
	"page_size",
	"pageSize",
}

ConstantsQueryPageSizeKeys is the keys that are used to identify the page size.

var ConstantsWHereIgnoreKeys = []string{
	"page",
	"page_size",
	"pageSize",
	"order_by",
	"orderBy",
}

ConstantsWHereIgnoreKeys is the keys that are ignored.

Types

type OrderBy

type OrderBy []OrderByOne

OrderBy is a list of order bys.

func (*OrderBy) Add

func (w *OrderBy) Add(key string, IsDESC bool)

Add adds a order by.

func (*OrderBy) AddClause

func (w *OrderBy) AddClause(clause string)

AddClause adds a order by clause.

func (*OrderBy) Build

func (w *OrderBy) Build() string

Build builds the order bys.

func (*OrderBy) Debug

func (w *OrderBy) Debug()

Debug prints the order bys.

func (*OrderBy) Del

func (w *OrderBy) Del(key string)

Del deletes a order by.

func (*OrderBy) Get

func (w *OrderBy) Get(key string) (bool, bool)

Get gets a order by.

func (*OrderBy) GetClause

func (w *OrderBy) GetClause(key string) string

GetClause gets the order by clause.

func (*OrderBy) Length

func (w *OrderBy) Length() int

Length returns the length of the order bys.

func (*OrderBy) Reset

func (w *OrderBy) Reset()

Reset resets the order bys.

func (*OrderBy) Set

func (w *OrderBy) Set(key string, IsDESC bool)

Set sets a order by.

type OrderByOne

type OrderByOne struct {
	Key    string
	IsDESC bool
	// contains filtered or unexported fields
}

OrderByOne is a single order by.

func (*OrderByOne) Clause

func (w *OrderByOne) Clause() string

Clause returns the clause of the order by.

func (*OrderByOne) String

func (w *OrderByOne) String() string

String returns the string of the order by.

type Query

type Query interface {
	Get(key string, defaultValue ...string) strings.Value
	//
	Page(defaultValue ...uint) uint
	PageSize(defaultValue ...uint) uint
	Where() *Where
	OrderBy() *OrderBy
	//
	ID() (id strings.Value, err error)
	MustID() (id strings.Value)
	AccessToken() (accessToken string, err error)
	MustAccessToken() (accessToken string)
}

Query ...

func New

func New(request *http.Request) Query

New creates a query.

type SetWhereOptions

type SetWhereOptions struct {
	IsEqual              bool
	IsNotEqual           bool
	IsFuzzy              bool
	IsIn                 bool
	IsNotIn              bool
	IsPlain              bool
	IsFullTextSearch     bool
	FullTextSearchFields []string
}

SetWhereOptions is the options for SetWhere.

type Where

type Where struct {
	Items []WhereOne
	//
	FullTextSearchFields []string
}

Where is the where.

func (*Where) Add

func (w *Where) Add(key string, value interface{}, opts ...*SetWhereOptions)

Add adds a where, if exists, append.

func (*Where) Build

func (w *Where) Build() (query string, args []interface{}, err error)

Build builds the wheres.

func (*Where) Debug

func (w *Where) Debug()

Debug prints the wheres.

func (*Where) Del

func (w *Where) Del(key string)

Del deletes a where.

func (*Where) Get

func (w *Where) Get(key string) (interface{}, bool)

Get gets a where.

func (*Where) Length

func (w *Where) Length() int

Length returns the length of the wheres.

func (*Where) Reset

func (w *Where) Reset()

Reset resets the wheres.

func (*Where) Set

func (w *Where) Set(key string, value interface{}, opts ...*SetWhereOptions)

Set sets a where, if exists, update.

type WhereOne

type WhereOne struct {
	Key   string
	Value interface{}

	// IsEqual => =
	IsEqual bool
	// IsNotEqual => !=
	IsNotEqual bool

	// IsFuzzy => ILike
	IsFuzzy bool

	// IsIn => in (?)
	IsIn bool
	// IsNotIn => not in (?)
	IsNotIn bool

	// IsPlain => plain
	IsPlain bool

	// IsFullTextSearch => ILike (field1) OR ILike (field2) OR ...
	IsFullTextSearch     bool
	FullTextSearchFields []string
}

WhereOne is the where one.