model

Documentation

Index

• Constants
• func IsUUID(s string) bool
• func ResolveQueryParams(l logger.Logger, queryParams map[string]any) (*coresql.Options, int, error)
• func TruncateID(ID string) string
• type Model
  • func NewModel(c configurer.Configurer, l logger.Logger, s storer.Storer) (m *Model, err error)
  • func (m *Model) Commit() error
  • func (m *Model) Init(pRepo preparer.Repository, pQ preparer.Query, tx *sqlx.Tx) (err error)
  • func (m *Model) IsUUID(s string) bool
  • func (m *Model) NewQueriers(p preparer.Query, tx *sqlx.Tx) ([]querier.Querier, error)
  • func (m *Model) NewRepositories(p preparer.Repository, tx *sqlx.Tx) ([]repositor.Repositor, error)
  • func (m *Model) Rollback() error
  • func (m *Model) SetTxLockTimeout(timeoutSecs float64) error
  • func (m *Model) ValidateNullBoolField(field sql.NullBool, fieldName string) error
  • func (m *Model) ValidateNullStringField(field sql.NullString, fieldName string) error
  • func (m *Model) ValidateStringArrayField(field pq.StringArray, fieldName string) error
  • func (m *Model) ValidateStringField(field string, fieldName string) error

Constants

const (
	PageSize   = "page_size"
	PageNumber = "page_number"
	SortColumn = "sort_column"
)

const (
	DefaultPageSize              = "10"
	DefaultPageNumber            = "1"
	DefaultOrderDescendingColumn = "created_at"
)

Functions

func IsUUID

func IsUUID(s string) bool

IsUUID - tests whether provided string is a valid UUID

func ResolveQueryParams

func ResolveQueryParams(l logger.Logger, queryParams map[string]any) (*coresql.Options, int, error)

func TruncateID

func TruncateID(ID string) string

Types

type Model

type Model struct {
	Config       configurer.Configurer
	Log          logger.Logger
	Store        storer.Storer
	Repositories map[string]repositor.Repositor
	Queries      map[string]querier.Querier
	Tx           *sqlx.Tx
	Err          error

	// composable functions
	RepositoriesFunc func(p preparer.Repository, tx *sqlx.Tx) ([]repositor.Repositor, error)
	QueriesFunc      func(p preparer.Query, tx *sqlx.Tx) ([]querier.Querier, error)
}

Model -

func NewModel

func NewModel(c configurer.Configurer, l logger.Logger, s storer.Storer) (m *Model, err error)

NewModel - intended for testing only, maybe move into test files..

func (*Model) Commit

func (m *Model) Commit() error

Commit -

func (*Model) Init

func (m *Model) Init(pRepo preparer.Repository, pQ preparer.Query, tx *sqlx.Tx) (err error)

Init -

func (*Model) IsUUID

func (m *Model) IsUUID(s string) bool

This remains here until all references instead call the above package function

func (*Model) NewQueriers

func (m *Model) NewQueriers(p preparer.Query, tx *sqlx.Tx) ([]querier.Querier, error)

NewQueriers - default repositor.QueriesFunc, override this function for custom queriers

func (*Model) NewRepositories

func (m *Model) NewRepositories(p preparer.Repository, tx *sqlx.Tx) ([]repositor.Repositor, error)

NewRepositories - default repositor.RepositoriesFunc, override this function for custom repositories

func (*Model) Rollback

func (m *Model) Rollback() error

Rollback -

func (*Model) SetTxLockTimeout

func (m *Model) SetTxLockTimeout(timeoutSecs float64) error

SetTxLockTimeout -

func (*Model) ValidateNullBoolField

func (m *Model) ValidateNullBoolField(field sql.NullBool, fieldName string) error

func (*Model) ValidateNullStringField

func (m *Model) ValidateNullStringField(field sql.NullString, fieldName string) error

func (*Model) ValidateStringArrayField

func (m *Model) ValidateStringArrayField(field pq.StringArray, fieldName string) error

func (*Model) ValidateStringField

func (m *Model) ValidateStringField(field string, fieldName string) error