db

package

v0.0.1 Latest Latest Go to latest Published: Oct 28, 2020 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/syntaqx/pkg

Documentation ¶

Index ¶

Constants
Variables
type Pagination
- func NewPaginator(page, perPage uint) *Pagination
type SortDirection
- func (m SortDirection) String() string
type SortParameters
- func SortConverter(sorts []string) *SortParameters

Constants ¶

View Source

const (
	// DefaultPerPage defines the default value for pagination
	DefaultPerPage uint = 20
)

Variables ¶

View Source

var (
	ErrUnsupportedDriver = errors.New("unsupported driver")
	ErrRecordNotFound    = errors.New("record not found")
	ErrNotImplemented    = errors.New("not implemented")
	ErrInvalidField      = errors.New("invalid field")
	ErrEmptySlice        = errors.New("empty slice")
)

View Source

var (
	ErrNoResult       = errors.New("No result")
	ErrTooManyResults = errors.New("too many results returned")
	ErrNoModification = errors.New("No changes made")
)

Functions ¶

This section is empty.

Types ¶

type Pagination struct {
	Page    uint
	PerPage uint
	// contains filtered or unexported fields
}

Pagination is a pagination calcul handler for database request.

func NewPaginator ¶

func NewPaginator(page, perPage uint) *Pagination

NewPaginator returns a pagination holder

func (p *Pagination) CurrentPageCount() uint

CurrentPageCount returns the element count of the current page

func (p *Pagination) HasNext() bool

HasNext returns the status if current page has a next one

func (p *Pagination) HasOtherPages() bool

HasOtherPages returns the status of having previous or next pages

func (p *Pagination) HasPrev() bool

HasPrev returns the status if current page has a previous one

func (p *Pagination) NextPage() uint

NextPage returns the page number for the next page. won't go past the end

func (p *Pagination) NumPages() uint

NumPages returns the total number of pages

func (p *Pagination) Offset() uint

Offset returns the offset of first element

func (p *Pagination) PrevPage() uint

PrevPage returns the page number for the page before this bottoms out at the first page

func (p *Pagination) SetTotal(total uint)

SetTotal is used to defines the total count of paginated values.

func (p *Pagination) Total() uint

Total returns the total number of items

type SortDirection ¶

type SortDirection int

SortDirection is the enumeration for sort

const (
	Ascending SortDirection = iota + 1
	Descending
)

func (SortDirection) String ¶

func (m SortDirection) String() string

type SortParameters ¶

type SortParameters map[string]SortDirection

SortParameters contains a hashmap of field name with sort direction

func SortConverter ¶

func SortConverter(sorts []string) *SortParameters

SortConverter convert a list of string to a SortParameters instance

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
postgres
types

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

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type Pagination ¶

func NewPaginator ¶

func (*Pagination) CurrentPageCount ¶

func (*Pagination) HasNext ¶

func (*Pagination) HasOtherPages ¶

func (*Pagination) HasPrev ¶

func (*Pagination) NextPage ¶

func (*Pagination) NumPages ¶

func (*Pagination) Offset ¶

func (*Pagination) PrevPage ¶

func (*Pagination) SetTotal ¶

func (*Pagination) Total ¶

type SortDirection ¶

func (SortDirection) String ¶

type SortParameters ¶

func SortConverter ¶

Source Files ¶

Directories ¶