database

Documentation

Index

• Constants
• Variables
• func ErrClosingDatabaseConnection(err error) error
• func ErrDatabaseOpen(err error) error
• func ErrSQLMapMarshalValue(err error) error
• func ErrSQLMapUnmarshalJSON(err error) error
• func ErrSQLMapUnmarshalScanned(err error) error
• func ErrSQLMapUnmarshalText(err error) error
• type Handler
  • func New(opts Options) (Handler, error)
  • func (h *Handler) DBClose() error
• type Map
  • func (m Map) Interface() interface{}
  • func (m *Map) Scan(src interface{}) error
  • func (m *Map) UnmarshalJSON(b []byte) error
  • func (m Map) UnmarshalText(text []byte) error
  • func (m Map) Value() (driver.Value, error)
• type Model
• type Options

Constants

const (
	POSTGRES = "postgres"
	SQLITE   = "sqlite"
)

Variables

var (
	ErrNoneDatabaseCode              = "11010"
	ErrDatabaseOpenCode              = "11011"
	ErrSQLMapUnmarshalJSONCode       = "11012"
	ErrSQLMapUnmarshalTextCode       = "11013"
	ErrSQLMapMarshalValueCode        = "11014"
	ErrSQLMapUnmarshalScannedCode    = "11015"
	ErrSQLMapInvalidScanCode         = "11016"
	ErrClosingDatabaseConnectionCode = "11017"
	ErrNoneDatabase                  = errors.New(ErrNoneDatabaseCode, errors.Alert, []string{"No Database selected"}, []string{}, []string{"database name is empty"}, []string{"Input a name for the database"})
	ErrSQLMapInvalidScan             = errors.New(ErrSQLMapInvalidScanCode, errors.Alert, []string{"invalid data type: expected []byte"}, []string{}, []string{}, []string{})
)

Functions

func ErrClosingDatabaseConnection

func ErrClosingDatabaseConnection(err error) error

ErrClosingDatabaseConnection represents the error which will occur when the database connection fails to get closed

func ErrDatabaseOpen

func ErrDatabaseOpen(err error) error

func ErrSQLMapMarshalValue

func ErrSQLMapMarshalValue(err error) error

ErrSQLMapMarshalValue represents the error which will occur when the native SQL driver will fail to marshal the value

func ErrSQLMapUnmarshalJSON

func ErrSQLMapUnmarshalJSON(err error) error

ErrSQLMapUnmarshalJSON represents the error which will occur when the native SQL driver will fail to unmarshal the JSON

func ErrSQLMapUnmarshalScanned

func ErrSQLMapUnmarshalScanned(err error) error

ErrSQLMapUnmarshalScanned represents the error which will occur when the native SQL driver will fail to unmarshal the scanned data

func ErrSQLMapUnmarshalText

func ErrSQLMapUnmarshalText(err error) error

ErrSQLMapUnmarshalJSON represents the error which will occur when the native SQL driver will fail to unmarshal the text

Types

type Handler

type Handler struct {
	*gorm.DB
	*sync.Mutex
}

func New

func New(opts Options) (Handler, error)

func (*Handler) DBClose

func (h *Handler) DBClose() error

type Map

type Map map[string]interface{}

Map type is an alias for map[string]interface{}

It implements native SQL driver interfaces and hence can be used for SQL json or jsonb types as a drop in replacement of golang native maps

func (Map) Interface

func (m Map) Interface() interface{}

Interface implements the nulls.nullable interface.

func (*Map) Scan

func (m *Map) Scan(src interface{}) error

Scan implements the sql.Scanner interface. It allows to read the map from the database value.

func (*Map) UnmarshalJSON

func (m *Map) UnmarshalJSON(b []byte) error

UnmarshalJSON will unmarshall JSON value into the map representation of this value.

func (Map) UnmarshalText

func (m Map) UnmarshalText(text []byte) error

UnmarshalText will unmarshall text value into the map representation of this value.

func (Map) Value

func (m Map) Value() (driver.Value, error)

Value implements the driver.Valuer interface. It allows to convert the map to a driver.value.

type Model

type Model struct {
	ID        string `json:"id,omitempty" gorm:"primarykey"`
	CreatedAt string `json:"created_at,omitempty" gorm:"index"`
	UpdatedAt string `json:"updated_at,omitempty" gorm:"index"`
	DeletedAt string `json:"deleted_at,omitempty" gorm:"index"`
}

type Options

type Options struct {
	Username string `json:"username,omitempty"`
	Host     string `json:"host,omitempty"`
	Port     string `json:"port,omitempty"`
	Password string `json:"password,omitempty"`
	Filename string `json:"filename,omitempty"`
	Engine   string `json:"engine,omitempty"`
	Logger   logger.Handler
}