models

package

v0.0.0-...-45d5ef5 Latest Latest Go to latest Published: Jul 5, 2021 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/d4l-data4life/charite-data-donation

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CloseDB()
func ConnectDB() error
func GetDB() *gorm.DB
func InitializeDB(quit chan struct{}, errors chan config.ErrorMessage)
func InitializeTestDB()
func MigrateDB(debug bool)
type BaseModel
- func (base *BaseModel) BeforeCreate(scope *gorm.Scope) error
type Donation
- func (donation *Donation) Create() error

Constants ¶

View Source

const (
	DonationCreationFailure = "failed creating donation in database"
	JSONMarshalFailure      = "failed marshalling JSON data"
)

define error messages

View Source

const (
	ConnectionError = "connection error"
)

define general error messages

Variables ¶

This section is empty.

Functions ¶

func CloseDB ¶

func CloseDB()

CloseDB closes the DB connecton

func ConnectDB ¶

func ConnectDB() error

ConnectDB reads environment variables for DB configuration and attempts to open the connection

func GetDB ¶

func GetDB() *gorm.DB

GetDB returns a handle to the DB object

func InitializeDB ¶

func InitializeDB(quit chan struct{}, errors chan config.ErrorMessage)

InitializeDB connects to the Database and migrates the schema

func InitializeTestDB ¶

func InitializeTestDB()

InitializeTestDB connects to an inmemory sqlite for testing

func MigrateDB ¶

func MigrateDB(debug bool)

MigrateDB Executes Migrations on the database

Types ¶

type BaseModel ¶

type BaseModel struct {
	ID        uuid.UUID `json:"id" gorm:"type:uuid;primary_key;"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
}

BaseModel defines the basic fields for each other model

func (*BaseModel) BeforeCreate ¶

func (base *BaseModel) BeforeCreate(scope *gorm.Scope) error

BeforeCreate will set a UUID rather than numeric ID.

type Donation ¶

type Donation struct {
	BaseModel
	Data json.RawMessage `sql:"json"`
}

Donation model

func (*Donation) Create ¶

func (donation *Donation) Create() error

Create creates Donation object in the Database

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL