db

Documentation

Overview

Package db for interacting with database

Index

• type ConnectionOption
  • func DefaultConnectionOption() *ConnectionOption
• type Option
  • func NewDatabaseOption(host string, port int, username, password, dbName string, ...) (*Option, error)
• type Options
  • func WithAppContext(ctx context.Context) Options
  • func WithConnectionOption(co *ConnectionOption) Options
  • func WithCredential(username, password string) Options
  • func WithDatabaseName(dbName string) Options
  • func WithHostURLAndPort(host string, port int) Options

Types

type ConnectionOption

type ConnectionOption struct {
	MaxIdle                int
	MaxLifetime            time.Duration
	MaxOpen                int
	ConnectTimeout         time.Duration
	KeepAliveCheckInterval time.Duration
}

ConnectionOption is db connection option.

func DefaultConnectionOption

func DefaultConnectionOption() *ConnectionOption

DefaultConnectionOption returns sensible conn setting.

type Option

type Option struct {
	Host         string
	Port         int
	Username     string
	Password     string
	DatabaseName string
	AppContext   context.Context
	*ConnectionOption
}

Option - database option.

func NewDatabaseOption

func NewDatabaseOption(host string, port int, username, password, dbName string, conn *ConnectionOption) (*Option, error)

NewDatabaseOption - default factory method.

type Options

type Options func(opt *Option)

Options is functional param for db.Option

func WithAppContext

func WithAppContext(ctx context.Context) Options

WithAppContext ...

func WithConnectionOption

func WithConnectionOption(co *ConnectionOption) Options

WithConnectionOption ...

func WithCredential

func WithCredential(username, password string) Options

WithCredential ...

func WithDatabaseName

func WithDatabaseName(dbName string) Options

WithDatabaseName ...

func WithHostURLAndPort

func WithHostURLAndPort(host string, port int) Options

WithHostURLAndPort ...