hints

Documentation

Index

• Constants
• type Hint
  • func DefaultRelDepth() *Hint
  • func ForUpdate() *Hint
  • func ForceIndex(indexes ...string) *Hint
  • func IgnoreIndex(indexes ...string) *Hint
  • func Limit(d int64) *Hint
  • func NewHint(key interface{}, value interface{}) *Hint
  • func Offset(d int64) *Hint
  • func OrderBy(s string) *Hint
  • func RelDepth(d int) *Hint
  • func UseIndex(indexes ...string) *Hint
  • func (s *Hint) GetKey() interface{}
  • func (s *Hint) GetValue() interface{}

Constants

const (
	// query level
	KeyForceIndex = iota
	KeyUseIndex
	KeyIgnoreIndex
	KeyForUpdate
	KeyLimit
	KeyOffset
	KeyOrderBy
	KeyRelDepth
)

Types

type Hint

type Hint struct {
	// contains filtered or unexported fields
}

func DefaultRelDepth

func DefaultRelDepth() *Hint

DefaultRelDepth return a hint about DefaultRelDepth

func ForUpdate

func ForUpdate() *Hint

ForUpdate return a hint about ForUpdate

func ForceIndex

func ForceIndex(indexes ...string) *Hint

ForceIndex return a hint about ForceIndex

func IgnoreIndex

func IgnoreIndex(indexes ...string) *Hint

IgnoreIndex return a hint about IgnoreIndex

func Limit

func Limit(d int64) *Hint

Limit return a hint about Limit

func NewHint

func NewHint(key interface{}, value interface{}) *Hint

NewHint return a hint

func Offset

func Offset(d int64) *Hint

Offset return a hint about Offset

func OrderBy

func OrderBy(s string) *Hint

OrderBy return a hint about OrderBy

func RelDepth

func RelDepth(d int) *Hint

RelDepth return a hint about RelDepth

func UseIndex

func UseIndex(indexes ...string) *Hint

UseIndex return a hint about UseIndex

func (*Hint) GetKey

func (s *Hint) GetKey() interface{}

GetKey return key

func (*Hint) GetValue

func (s *Hint) GetValue() interface{}

GetValue return value