models

Documentation

Index

• func OpenDBWithConfig(config *config.Config) (dbConn gorm.DB, err error)
• type Error
  • func NewError(statusCode int, err error) Error
• type User

Functions

func OpenDBWithConfig

func OpenDBWithConfig(config *config.Config) (dbConn gorm.DB, err error)

OpenDBWithConfig open a gorm.DB connection thanks to config.Database

Types

type Error

type Error struct {
	HTTPStatusCode int    `json:"status"`
	Message        string `json:"message"`
}

Error describes an error that occured in the API with a message and HTTP status code

func NewError

func NewError(statusCode int, err error) Error

NewError create a new Error struct that wrap error for JSON marshaling

type User

type User struct {
	ID        uint       `json:"id" gorm:"primary_key"`
	FirstName string     `json:"firstname" sql:"not null"`
	LastName  string     `json:"lastname" sql:"not null"`
	Email     string     `json:"email" sql:"not null;unique"`
	Password  string     `json:"-" sql:"not null"`
	CreatedAt time.Time  `json:"created_at"`
	UpdatedAt time.Time  `json:"updated_at"`
	DeletedAt *time.Time `json:"deleted_at" sql:"index"`
}

User holds user personal data