ucdb

Documentation

Index

• type BaseModel
  • func NewBase() BaseModel
  • func NewBaseWithID(id uuid.UUID) BaseModel
  • func (b BaseModel) Alive() bool
  • func (b BaseModel) GetCreated() time.Time
  • func (b BaseModel) GetDeleted() time.Time
  • func (b BaseModel) GetID() uuid.UUID
  • func (b BaseModel) GetUpdated() time.Time
  • func (b BaseModel) Validate() error
• type BaseModelable
• type UserBaseModel
  • func NewUserBase(userID uuid.UUID) UserBaseModel
  • func (u UserBaseModel) Validate() error
• type VersionBaseModel
  • func NewVersionBase() VersionBaseModel
  • func NewVersionBaseWithID(id uuid.UUID) VersionBaseModel

Types

type BaseModel

type BaseModel struct {
	ID uuid.UUID `db:"id" json:"id" yaml:"id"`

	Created time.Time `db:"created" json:"created" yaml:"created"`
	Updated time.Time `db:"updated" json:"updated" yaml:"updated"`

	Deleted time.Time `db:"deleted" json:"deleted" yaml:"deleted"`
}

BaseModel underlies (almost) all of our models

func NewBase

func NewBase() BaseModel

NewBase initializes a new UCBase

func NewBaseWithID

func NewBaseWithID(id uuid.UUID) BaseModel

NewBaseWithID initializes a new BaseModel with a specific ID

func (BaseModel) Alive

func (b BaseModel) Alive() bool

Alive returns true if the object is "alive" and false if it's been deleted

func (BaseModel) GetCreated

func (b BaseModel) GetCreated() time.Time

GetCreated is part of the BaseModelable interface

func (BaseModel) GetDeleted

func (b BaseModel) GetDeleted() time.Time

GetDeleted is part of the BaseModelable interface

func (BaseModel) GetID

func (b BaseModel) GetID() uuid.UUID

GetID is part of the BaseModelable interface

func (BaseModel) GetUpdated

func (b BaseModel) GetUpdated() time.Time

GetUpdated is part of the BaseModelable interface

func (BaseModel) Validate

func (b BaseModel) Validate() error

Validate implements Validateable

type BaseModelable

type BaseModelable interface {
	GetCreated() time.Time
	GetDeleted() time.Time
	GetID() uuid.UUID
	GetUpdated() time.Time
}

BaseModelable is an interface that all BaseModel instances and ancestors support Golang generics do not currently support accessing a struct field for a generic type within a method, so this interface was created to enable us to have generic methods that take any model object that is derived from the BaseModel struct, and be able to access any of the fields in BaseModel from within the generic method.

type UserBaseModel

type UserBaseModel struct {
	BaseModel

	UserID uuid.UUID `db:"user_id" json:"user_id" yaml:"user_id"`
}

UserBaseModel is a user-related underlying model for many of our models eg. in IDP

func NewUserBase

func NewUserBase(userID uuid.UUID) UserBaseModel

NewUserBase initializes a new user base model

func (UserBaseModel) Validate

func (u UserBaseModel) Validate() error

Validate implements Validateable

type VersionBaseModel

type VersionBaseModel struct {
	BaseModel

	// we use _version here to indicate that it's system-managed (as distinct from eg. versioned Access Policies)
	Version int `db:"_version" json:"version"`
}

VersionBaseModel supports safe concurrent updates with version checks (only save if you have extant version)

func NewVersionBase

func NewVersionBase() VersionBaseModel

NewVersionBase initializes a new VersionBaseModel

func NewVersionBaseWithID

func NewVersionBaseWithID(id uuid.UUID) VersionBaseModel

NewVersionBaseWithID initializes a new VersionBaseModel with a specific ID