dtegorm

Documentation

Index

• Variables
• type Date
  • func NewDate(s string) (Date, error)
  • func (Date) GormDBDataType(db *gorm.DB, _ *schema.Field) string
  • func (Date) GormDataType() string
  • func (d *Date) Scan(src interface{}) error
  • func (d Date) Value() (driver.Value, error)
• type Time
  • func NewTime(s string) (Time, error)
  • func (Time) GormDBDataType(db *gorm.DB, _ *schema.Field) string
  • func (Time) GormDataType() string
  • func (t *Time) Scan(src interface{}) error
  • func (t Time) Value() (driver.Value, error)

Examples

• Date
• Time

Variables

var (
	ErrNewDate             = errors.New("failed to create new date")
	ErrDateScan            = errors.New("failed to scan value into date struct")
	ErrDateScanInvalidType = errors.New("invalid type passed to scan")
)

var (
	ErrNewTime             = errors.New("failed to create new time")
	ErrTimeScan            = errors.New("failed to scan value into time struct")
	ErrTimeScanInvalidType = errors.New("invalid type passed to scan")
)

Types

type Date

type Date struct {
	dte.Date `example:"2006-01-02" format:"date"`
}

Example

dbName, dsn, db := Setup()
dsn = strings.ReplaceAll(dsn, "dbname="+dbName, "dbname=postgres")
defer Teardown(dbName, dsn, db)
// ^^^ Setup for the PG DB. This can be ignored

type DateExample struct {
	ID       uint `gorm:"primarykey"`
	OnlyDate dtegorm.Date
}

onlyDate, err := dtegorm.NewDate("2006-01-02")
if err != nil {
	return
}

example := DateExample{OnlyDate: onlyDate}

createResult := db.Create(&example)
if createResult.Error != nil {
	return
}

var exampleResult DateExample

getResult := db.First(&exampleResult, example.ID)
if getResult.Error != nil {
	return
}

fmt.Println(exampleResult.OnlyDate.String())

Output:

2006-01-02

func NewDate

func NewDate(s string) (Date, error)

func (Date) GormDBDataType

func (Date) GormDBDataType(db *gorm.DB, _ *schema.Field) string

GormDBDataType returns gorm DB data type based on the current using database.

func (Date) GormDataType

func (Date) GormDataType() string

GormDataType returns gorm common data type. This type is used for the field's column type.

func (*Date) Scan

func (d *Date) Scan(src interface{}) error

Scan implements sql.Scanner interface and scans value into Date,.

func (Date) Value

func (d Date) Value() (driver.Value, error)

Value implements driver.Valuer interface and returns string format of Date.

type Time

type Time struct {
	dte.Time `example:"15:04:05Z" format:"time"`
}

Example

dbName, dsn, db := Setup()
dsn = strings.ReplaceAll(dsn, "dbname="+dbName, "dbname=postgres")
defer Teardown(dbName, dsn, db)
// ^^^ Setup for the PG DB. This can be ignored

type TimeExample struct {
	ID       uint `gorm:"primarykey"`
	OnlyTime dtegorm.Time
}

onlyTime, err := dtegorm.NewTime("10:04:05-05:00")
if err != nil {
	return
}

example := TimeExample{OnlyTime: onlyTime}

createResult := db.Create(&example)
if createResult.Error != nil {
	return
}

var exampleResult TimeExample

getResult := db.First(&exampleResult, example.ID)
if getResult.Error != nil {
	return
}

fmt.Println(exampleResult.OnlyTime.String())

Output:

15:04:05Z

func NewTime

func NewTime(s string) (Time, error)

func (Time) GormDBDataType

func (Time) GormDBDataType(db *gorm.DB, _ *schema.Field) string

GormDBDataType returns gorm DB data type based on the current using database.

func (Time) GormDataType

func (Time) GormDataType() string

GormDataType returns gorm common data type. This type is used for the field's column type.

func (*Time) Scan

func (t *Time) Scan(src interface{}) error

Scan implements sql.Scanner interface and scans value into Time,.

func (Time) Value

func (t Time) Value() (driver.Value, error)

Value implements driver.Valuer interface and returns string format of Time.