query

package

v0.0.62 Latest Latest Go to latest Published: Feb 17, 2025 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gophab/gophrame

Links

Open Source Insights

Documentation ¶

Index ¶

func GetLimit(c *gin.Context) int
func GetPage(c *gin.Context) int
func GetSize(c *gin.Context) int
func Page(tx *gorm.DB, pageable Pageable) *gorm.DB
func PageWithDefaultOrder(tx *gorm.DB, pageable Pageable, defaultOrders ...string) *gorm.DB
func PageWithDefaultSort(tx *gorm.DB, pageable Pageable, defaultSorts ...Sort) *gorm.DB
func WithoutTotal(c *gin.Context) *bool
type Pageable
- func GetPageable(c *gin.Context) Pageable
type Pagination
type Query
type Sort
- func GetSort(c *gin.Context) []Sort
- func OrderBy(v string) Sort
- func (s Sort) For(v string) Sort
- func (s *Sort) String() string
type Sorts
- func (s Sorts) For(v string) Sorts

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetLimit ¶

func GetLimit(c *gin.Context) int

func GetPage ¶

func GetPage(c *gin.Context) int

func GetSize ¶

func GetSize(c *gin.Context) int

func Page ¶

func Page(tx *gorm.DB, pageable Pageable) *gorm.DB

func PageWithDefaultOrder ¶

func PageWithDefaultOrder(tx *gorm.DB, pageable Pageable, defaultOrders ...string) *gorm.DB

func PageWithDefaultSort ¶

func PageWithDefaultSort(tx *gorm.DB, pageable Pageable, defaultSorts ...Sort) *gorm.DB

func WithoutTotal ¶ added in v0.0.25

func WithoutTotal(c *gin.Context) *bool

Types ¶

type Pageable ¶

type Pageable interface {
	GetPage() int
	GetSize() int
	GetSort() []Sort
	GetLimit() int
	GetOffset() int
	NoSort() bool
	NoCount() bool
}

func GetPageable ¶

func GetPageable(c *gin.Context) Pageable

type Pagination struct {
	Total        int64  `json:"total"`
	Page         int    `json:"page"`
	Size         int    `json:"size"`
	Sort         []Sort `json:"sort"`
	WithoutTotal *bool  `json:"withoutTotal"`
}

func (p *Pagination) GetLimit() int

func (p *Pagination) GetOffset() (offset int)

func (p *Pagination) GetPage() int

func (p *Pagination) GetSize() int

func (p *Pagination) GetSort() []Sort

func (p *Pagination) GetTotal() int64

func (p *Pagination) NoCount() bool

func (p *Pagination) NoSort() bool

type Query ¶

type Query struct {
	*gorm.DB
	Pagination
}

func (*Query) Infinite ¶

func (p *Query) Infinite(pageable Pageable) *Query

func (*Query) InfiniteWithDefaultOrder ¶

func (p *Query) InfiniteWithDefaultOrder(pageable Pageable, defaultOrders ...string) *Query

func (*Query) InfiniteWithDefaultSort ¶

func (p *Query) InfiniteWithDefaultSort(pageable Pageable, defaultSorts ...Sort) *Query

func (*Query) Page ¶

func (p *Query) Page(pageable Pageable) *Query

func (*Query) PageWithDefaultOrders ¶

func (p *Query) PageWithDefaultOrders(pageable Pageable, defaultOrders ...string) *Query

func (*Query) PageWithDefaultSorts ¶

func (p *Query) PageWithDefaultSorts(pageable Pageable, defaultSorts ...Sort) *Query

type Sort ¶

type Sort struct {
	By        string
	Direction string
}

func GetSort ¶

func GetSort(c *gin.Context) []Sort

func OrderBy ¶ added in v0.0.58

func OrderBy(v string) Sort

func (Sort) For ¶

func (s Sort) For(v string) Sort

func (*Sort) String ¶

func (s *Sort) String() string

type Sorts ¶ added in v0.0.58

type Sorts []Sort

func (Sorts) For ¶ added in v0.0.58

func (s Sorts) For(v string) Sorts

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func GetLimit ¶

func GetPage ¶

func GetSize ¶

func Page ¶

func PageWithDefaultOrder ¶

func PageWithDefaultSort ¶

func WithoutTotal ¶ added in v0.0.25

Types ¶

type Pageable ¶

func GetPageable ¶

type Pagination ¶

func (*Pagination) GetLimit ¶

func (*Pagination) GetOffset ¶

func (*Pagination) GetPage ¶

func (*Pagination) GetSize ¶

func (*Pagination) GetSort ¶

func (*Pagination) GetTotal ¶

func (*Pagination) NoCount ¶ added in v0.0.15

func (*Pagination) NoSort ¶

type Query ¶

func (*Query) Infinite ¶

func (*Query) InfiniteWithDefaultOrder ¶

func (*Query) InfiniteWithDefaultSort ¶

func (*Query) Page ¶

func (*Query) PageWithDefaultOrders ¶

func (*Query) PageWithDefaultSorts ¶

type Sort ¶

func GetSort ¶

func OrderBy ¶ added in v0.0.58

func (Sort) For ¶

func (*Sort) String ¶

type Sorts ¶ added in v0.0.58

func (Sorts) For ¶ added in v0.0.58

Source Files ¶