db

Documentation

Overview

Package db provide useful functions to manipulate mysql instance.

Index

• Constants
• func GetInstanceID(uid uint64, prefix string) string
• type DBBuilder
  • func NewDBBuilder() *DBBuilder
  • func (b *DBBuilder) Build() (*gorm.DB, error)
• type OffsetLimit
  • func NewOffsetLimit(offset *int, limit *int) *OffsetLimit

Constants

const (
	ConfigDBKey = "mysql"

	DefaultHost                  = "127.0.0.1:3306"
	DefaultMaxIdleConnections    = 100
	DefaultMaxOpenConnections    = 100
	DefaultMaxConnectionLifeTime = "10s"
)

const (
	DefaultOffset = 0
	DefaultLimit  = 1000
)

Functions

func GetInstanceID

func GetInstanceID(uid uint64, prefix string) string

GetInstanceID returns id format like: secret-2v69o5

Types

type DBBuilder

type DBBuilder struct {
	Host                  string
	Username              string
	Password              string
	Database              string
	MaxIdleConnections    int    `mapstructure:"max-idle-connections"`
	MaxOpenConnections    int    `mapstructure:"max-open-connections"`
	MaxConnectionLifeTime string `mapstructure:"max-connection-life-time"`
	// contains filtered or unexported fields
}

DBBuilder defines options for building a db instance.

func NewDBBuilder

func NewDBBuilder() *DBBuilder

NewDBBuilder is used to build a db instance.

func (*DBBuilder) Build

func (b *DBBuilder) Build() (*gorm.DB, error)

Build builds a gorm db instance.

type OffsetLimit

type OffsetLimit struct {
	Offset int
	Limit  int
}

OffsetLimit is used to retrieve the records in the db by page.

func NewOffsetLimit

func NewOffsetLimit(offset *int, limit *int) *OffsetLimit

NewOffsetLimit uses offset/DefaultOffset and limit/DefaultLimit to generate an OffsetLimit.