database

Documentation

Index

• type Database
• type Engine
  • func (c Engine) String() string
• type Pagination
  • func NewPagination(opts ...PaginationOption) Pagination
  • func (p Pagination) Page() uint32
  • func (p Pagination) Size() uint32
• type PaginationOption
  • func Page(page uint32) PaginationOption
  • func Size(size uint32) PaginationOption

Types

type Database

type Database interface {
	// GetEngineType get the database type (e.g. postgres, memory, etc.).
	GetEngineType() string

	// Close the database connection.
	Close() error

	// IsReady - Check if database is ready
	IsReady(ctx context.Context) (bool, error)
}

Database - Db interface

type Engine

type Engine string

Engine - Type declaration of engine

const (
	POSTGRES Engine = "postgres"
	MEMORY   Engine = "memory"
)

func (Engine) String

func (c Engine) String() string

String - Convert to string

type Pagination

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

Pagination -

func NewPagination

func NewPagination(opts ...PaginationOption) Pagination

NewPagination -

func (Pagination) Page

func (p Pagination) Page() uint32

Page -

func (Pagination) Size

func (p Pagination) Size() uint32

Size -

type PaginationOption

type PaginationOption func(*Pagination)

PaginationOption - Option type

func Page

func Page(page uint32) PaginationOption

Page -

func Size

func Size(size uint32) PaginationOption

Size -