common

Documentation

Index

• Constants
• func GetColumns(m ITableName) []string
• func GetPrimarykey(engine *xorm.Engine, m interface{}) *schemas.Column
• func JoinQuery(engine *xorm.Engine, native, foreign ITableName, fkey, pkey, joinOp string) *xorm.Session
• func LeftJoinQuery(engine *xorm.Engine, native, foreign ITableName, fkey string) *xorm.Session
• func MoveEdge(query *xorm.Session, base uint, offset string) error
• func NegativeOffset(offset, pagesize, total int) int
• func Paginate(query *xorm.Session, pageno, pagesize int) *xorm.Session
• func Qprintf(engine *xorm.Engine, format string, args ...interface{}) string
• func SessListJoin(data []string) string
• func SessListSplit(data string) []string
• type FilterFunc
• type ITableComment
• type ITableName
• type ModifyFunc
• type NestedMixin
  • func (n *NestedMixin) AddToParent(parent *NestedMixin, tbQuery *xorm.Session) error
  • func (n NestedMixin) AncestorsFilter(backward bool) FilterFunc
  • func (n NestedMixin) ChildrenFilter(rank uint8) FilterFunc
  • func (n NestedMixin) CountChildren() int
  • func (n NestedMixin) IsLeaf() bool
• type Session
  • func NewSession(reg *SessionRegistry, key string) *Session
  • func (sess *Session) AddFlash(messages ...string) (int, error)
  • func (sess *Session) BindRoles(uid string, roles []string, kick bool) (string, error)
  • func (sess *Session) GetFlashes(n int) ([]string, error)
  • func (sess *Session) GetKey() string
• type SessionRegistry
  • func InitCache(c config.ConnConfig, verbose bool) (*SessionRegistry, error)
  • func NewRegistry(w *redisw.RedisWrapper) *SessionRegistry
  • func (sr *SessionRegistry) DelSession(token string) bool
  • func (sr SessionRegistry) GetKey(token string) string
  • func (sr *SessionRegistry) GetSession(token string) *Session
• type TimeMixin

Constants

const (
	MAX_TIMEOUT     = 86400 * 30 // 接近无限时间
	SESS_ONLINE_KEY = "onlines"  // 在线用户
	SESS_TOKEN_KEY  = "_token_"
	SESS_PREFIX     = "sess" // 会话缓存前缀
	SESS_TIMEOUT    = 7200   // 会话缓存时间
	SESS_LIST_SEP   = ";"    // 角色名之间的分隔符
)

Functions

func GetColumns

func GetColumns(m ITableName) []string

获取Model的字段列表

func GetPrimarykey

func GetPrimarykey(engine *xorm.Engine, m interface{}) *schemas.Column

获取Model的字段列表

func JoinQuery

func JoinQuery(engine *xorm.Engine, native, foreign ITableName, fkey, pkey, joinOp string) *xorm.Session

联表查询

func LeftJoinQuery

func LeftJoinQuery(engine *xorm.Engine, native, foreign ITableName, fkey string) *xorm.Session

Left Join 联表查询

func MoveEdge

func MoveEdge(query *xorm.Session, base uint, offset string) error

左右边界整体移动

func NegativeOffset

func NegativeOffset(offset, pagesize, total int) int

调整从后往前翻页

func Paginate

func Paginate(query *xorm.Session, pageno, pagesize int) *xorm.Session

计算翻页

func Qprintf

func Qprintf(engine *xorm.Engine, format string, args ...interface{}) string

对参数先进行转义Quote

func SessListJoin

func SessListJoin(data []string) string

func SessListSplit

func SessListSplit(data string) []string

Types

type FilterFunc

type FilterFunc = func(query *xorm.Session) *xorm.Session

过滤查询

type ITableComment

type ITableComment interface {
	TableComment() string
}

*

• 数据表注释

type ITableName

type ITableName interface {
	TableName() string
}

*

• 数据表名

type ModifyFunc

type ModifyFunc = func(tx *xorm.Session) (int64, error)

修改操作，用于事务

type NestedMixin

type NestedMixin struct {
	Lft   int `json:"lft" xorm:"notnull default 0 comment('左边界') INT(10)"`           // 左边界
	Rgt   int `json:"rgt" xorm:"notnull default 0 comment('右边界') index INT(10)"`     // 右边界
	Depth int `json:"depth" xorm:"notnull default 1 comment('高度') index TINYINT(3)"` // 高度
}

嵌套集合树

func (*NestedMixin) AddToParent

func (n *NestedMixin) AddToParent(parent *NestedMixin, tbQuery *xorm.Session) error

添加到父节点最末，tbQuery一定要使用db.Table(...)

func (NestedMixin) AncestorsFilter

func (n NestedMixin) AncestorsFilter(backward bool) FilterFunc

找出所有直系祖先节点

func (NestedMixin) ChildrenFilter

func (n NestedMixin) ChildrenFilter(rank uint8) FilterFunc

找出所有子孙节点

func (NestedMixin) CountChildren

func (n NestedMixin) CountChildren() int

有多少个子孙节点

func (NestedMixin) IsLeaf

func (n NestedMixin) IsLeaf() bool

是否叶子节点

type Session

type Session struct {
	*redisw.RedisHash
	// contains filtered or unexported fields
}

func NewSession

func NewSession(reg *SessionRegistry, key string) *Session

func (*Session) AddFlash

func (sess *Session) AddFlash(messages ...string) (int, error)

func (*Session) BindRoles

func (sess *Session) BindRoles(uid string, roles []string, kick bool) (string, error)

绑定用户角色，返回旧的sid

func (*Session) GetFlashes

func (sess *Session) GetFlashes(n int) ([]string, error)

数量n为最大取出多少条消息，-1表示所有消息

func (*Session) GetKey

func (sess *Session) GetKey() string

type SessionRegistry

type SessionRegistry struct {
	Onlines *redisw.RedisHash
	*redisw.RedisWrapper
	// contains filtered or unexported fields
}

func InitCache

func InitCache(c config.ConnConfig, verbose bool) (*SessionRegistry, error)

func NewRegistry

func NewRegistry(w *redisw.RedisWrapper) *SessionRegistry

func (*SessionRegistry) DelSession

func (sr *SessionRegistry) DelSession(token string) bool

func (SessionRegistry) GetKey

func (sr SessionRegistry) GetKey(token string) string

func (*SessionRegistry) GetSession

func (sr *SessionRegistry) GetSession(token string) *Session

type TimeMixin

type TimeMixin struct {
	CreatedAt time.Time `json:"created_at" xorm:"created comment('创建时间') TIMESTAMP"`       // 创建时间
	UpdatedAt time.Time `json:"updated_at" xorm:"updated comment('更新时间') TIMESTAMP"`       // 更新时间
	DeletedAt time.Time `json:"deleted_at" xorm:"deleted comment('删除时间') index TIMESTAMP"` // 删除时间
}

*

• 时间相关的三个典型字段