database

Documentation

Overview

Copyright 2023 PraserX

Copyright 2023 PraserX

Index

• func Close()
• func DepositMoney(uid uint, amount float32) error
• func Get() *gorm.DB
• func InsertBill(bill models.Bill) (int, error)
• func InsertPeriod(period models.Period) (int, error)
• func InsertSchema(schema models.Schema) (int, error)
• func InsertTransaction(transaction models.Transaction) (int, error)
• func InsertUser(user models.User) (int, error)
• func RunAutoMigration() error
• func SelectAllBills() (bills []models.Bill, err error)
• func SelectAllBillsForPeriod(pid uint) ([]models.Bill, error)
• func SelectAllBillsForUser(uid uint) ([]models.Bill, error)
• func SelectAllBillsForUserExceptSpecifiedPeriod(uid, pid uint) ([]models.Bill, error)
• func SelectAllPeriods() ([]models.Period, error)
• func SelectAllPeriodsExceptSpecifiedPeriod(pid uint) ([]models.Period, error)
• func SelectAllTransactions() ([]models.Transaction, error)
• func SelectAllTransactionsForUser(uid uint) ([]models.Transaction, error)
• func SelectAllUsers() (users []models.User, err error)
• func SelectBillByID(id uint) (bill models.Bill, err error)
• func SelectPeriodByID(id uint) (period models.Period, err error)
• func SelectUserByEID(eid string) (user models.User, err error)
• func SelectUserByEmail(email string) (user models.User, err error)
• func SelectUserByID(id uint) (user models.User, err error)
• func SelectVersion() (schema models.Schema, err error)
• func SetupDatabase(opts ...Option)
• func UpdateBillOnIssued(bid uint) error
• func UpdateBillOnPaid(bid uint) error
• func UpdateBillOnPaymentConfirmation(bid uint) error
• func UpdateBillOnPeriodClose(bid uint, amount, payment float32) error
• func UpdatePeriodOnClose(pid uint, totalQuantity int, unitPrice float32) error
• func UpdateUserName(uid uint, firstname, lastname string) error
• func UpdateVersion(version uint) error
• func WithdrawMoney(uid uint, amount float32) error
• type DatabaseOptions
• type Option
  • func WithPath(path string) Option

Functions

func Close

func Close()

Close gracefully end up connection to database.

func DepositMoney

func DepositMoney(uid uint, amount float32) error

func Get

func Get() *gorm.DB

Get returns database instance.

func InsertBill

func InsertBill(bill models.Bill) (int, error)

func InsertPeriod

func InsertPeriod(period models.Period) (int, error)

InsertUser inserts user into the database and returns ID of the inserted record and error if any occurs.

func InsertSchema

func InsertSchema(schema models.Schema) (int, error)

func InsertTransaction

func InsertTransaction(transaction models.Transaction) (int, error)

func InsertUser

func InsertUser(user models.User) (int, error)

InsertUser inserts user into the database and returns ID of the inserted record and error if any occurs.

func RunAutoMigration

func RunAutoMigration() error

RunAutoMigration creates all required tables in database.

func SelectAllBills

func SelectAllBills() (bills []models.Bill, err error)

func SelectAllBillsForPeriod

func SelectAllBillsForPeriod(pid uint) ([]models.Bill, error)

func SelectAllBillsForUser

func SelectAllBillsForUser(uid uint) ([]models.Bill, error)

func SelectAllBillsForUserExceptSpecifiedPeriod

func SelectAllBillsForUserExceptSpecifiedPeriod(uid, pid uint) ([]models.Bill, error)

func SelectAllPeriods

func SelectAllPeriods() ([]models.Period, error)

func SelectAllPeriodsExceptSpecifiedPeriod

func SelectAllPeriodsExceptSpecifiedPeriod(pid uint) ([]models.Period, error)

func SelectAllTransactions

func SelectAllTransactions() ([]models.Transaction, error)

func SelectAllTransactionsForUser

func SelectAllTransactionsForUser(uid uint) ([]models.Transaction, error)

func SelectAllUsers

func SelectAllUsers() (users []models.User, err error)

func SelectBillByID

func SelectBillByID(id uint) (bill models.Bill, err error)

func SelectPeriodByID

func SelectPeriodByID(id uint) (period models.Period, err error)

func SelectUserByEID

func SelectUserByEID(eid string) (user models.User, err error)

func SelectUserByEmail

func SelectUserByEmail(email string) (user models.User, err error)

func SelectUserByID

func SelectUserByID(id uint) (user models.User, err error)

func SelectVersion

func SelectVersion() (schema models.Schema, err error)

func SetupDatabase

func SetupDatabase(opts ...Option)

SetupDatabase set ups database with defined arguments and initialize global instance.

func UpdateBillOnIssued

func UpdateBillOnIssued(bid uint) error

func UpdateBillOnPaid

func UpdateBillOnPaid(bid uint) error

func UpdateBillOnPaymentConfirmation

func UpdateBillOnPaymentConfirmation(bid uint) error

func UpdateBillOnPeriodClose

func UpdateBillOnPeriodClose(bid uint, amount, payment float32) error

func UpdatePeriodOnClose

func UpdatePeriodOnClose(pid uint, totalQuantity int, unitPrice float32) error

func UpdateUserName

func UpdateUserName(uid uint, firstname, lastname string) error

func UpdateVersion

func UpdateVersion(version uint) error

func WithdrawMoney

func WithdrawMoney(uid uint, amount float32) error

Types

type DatabaseOptions

type DatabaseOptions struct {
	Path string
}

Options are used for Database construct function.

type Option

type Option func(*DatabaseOptions)

Option definition

func WithPath

func WithPath(path string) Option

WithPath option specification.