gormutil

README

gormutil

Opinionated utilities for Gorm

Requirements

gormutil includes

• ModelBase
  • primary key named ID and is in uuid format
  • assumes each model has CreatedAt and UpdatedAt timestamps
• Logger
  • backed by zerolog
  • respects LOG_LEVEL environment variable
• Data Import/Export
  • Exports filterable tables into map[string]interface{}
  • Imports from map[string]interface{}
• Create/Update helpers with respect of validation rules

Install

go get github.com/avakarev/go-gormutil

License

go-testutil is licensed under MIT license. (see LICENSE)

Documentation

Overview

Package gormutil implements gorm helpers

Index

• Variables
• func Changeset(model interface{}, names []string) (map[string]interface{}, error)
• func FilterTables(tables []string, f *TableFilter) []string
• func Find[T any](tx *gorm.DB) []T
• func First[T any](tx *gorm.DB) *T
• func NewLogger(lvl logger.LogLevel) logger.Interface
• type DB
  • func Open(dialector gorm.Dialector) (*DB, error)
  • func (db *DB) Conn() *gorm.DB
  • func (db *DB) Count(model interface{}) int64
  • func (db *DB) CountBy(model interface{}, cond interface{}, args ...interface{}) int64
  • func (db *DB) Create(model interface{}) error
  • func (db *DB) ExistsBy(model interface{}, cond interface{}, args ...interface{}) bool
  • func (db *DB) ExistsByID(model interface{}, id string) bool
  • func (db *DB) Export(filter *TableFilter) (map[string]interface{}, error)
  • func (db *DB) ExportTable(table string) ([]map[string]interface{}, error)
  • func (db *DB) Import(data map[string]interface{}, filter *TableFilter) error
  • func (db *DB) ImportTable(table string, rows []interface{}) error
  • func (db *DB) Tables(filter *TableFilter) ([]string, error)
  • func (db *DB) Update(model interface{}, names ...string) error
• type ModelBase
  • func (base *ModelBase) GenerateID() error
• type TableFilter

Variables

var Logger logger.Interface

Logger is a zerolog-backed gorm logger

Functions

func Changeset

func Changeset(model interface{}, names []string) (map[string]interface{}, error)

Changeset extracts values of given field names from the model

func FilterTables

func FilterTables(tables []string, f *TableFilter) []string

FilterTables returns tables with respect of include/exclude filters

func Find

func Find[T any](tx *gorm.DB) []T

Find returns all rows models by the given query

func First

func First[T any](tx *gorm.DB) *T

First returns first row matching the given query

func NewLogger

func NewLogger(lvl logger.LogLevel) logger.Interface

NewLogger returns new logger value

Types

type DB

type DB struct {
	// contains filtered or unexported fields
}

DB defines db container

func Open

func Open(dialector gorm.Dialector) (*DB, error)

Open initialize db session based on dialector

func (*DB) Conn

func (db *DB) Conn() *gorm.DB

Conn returns gorm's connection

func (*DB) Count

func (db *DB) Count(model interface{}) int64

Count returns number of record in given table

func (*DB) CountBy

func (db *DB) CountBy(model interface{}, cond interface{}, args ...interface{}) int64

CountBy returns number of record in given table with given conditions

func (*DB) Create

func (db *DB) Create(model interface{}) error

Create validates and persists new record

func (*DB) ExistsBy

func (db *DB) ExistsBy(model interface{}, cond interface{}, args ...interface{}) bool

ExistsBy checks whether given model exists with given conditions

@TODO: try to optimize the query to something like SELECT EXISTS(SELECT 1 FROM vaults WHERE id="foobar" LIMIT 1);

func (*DB) ExistsByID

func (db *DB) ExistsByID(model interface{}, id string) bool

ExistsByID checks whether given model exists with given id

func (*DB) Export

func (db *DB) Export(filter *TableFilter) (map[string]interface{}, error)

Export returns map of all tables with their rows

func (*DB) ExportTable

func (db *DB) ExportTable(table string) ([]map[string]interface{}, error)

ExportTable returns all rows of given table as slice of maps

func (*DB) Import

func (db *DB) Import(data map[string]interface{}, filter *TableFilter) error

Import inserts given data into db

func (*DB) ImportTable

func (db *DB) ImportTable(table string, rows []interface{}) error

ImportTable inserts given rows into given table

func (*DB) Tables

func (db *DB) Tables(filter *TableFilter) ([]string, error)

Tables retuns list of existing db tables respecing the given filter

func (*DB) Update

func (db *DB) Update(model interface{}, names ...string) error

Update validates and persists existing record

type ModelBase

type ModelBase struct {
	ID        uuid.UUID `gorm:"type:uuid;primaryKey;uniqueIndex" json:"id" validate:"required"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
}

ModelBase contains common columns for all tables

func (*ModelBase) GenerateID

func (base *ModelBase) GenerateID() error

GenerateID generates and assigns new id value

type TableFilter

type TableFilter struct {
	IncludeTables []string `json:"includeTables"`
	ExcludeTables []string `json:"excludeTables"`
}

TableFilter defines table filtering options