gotemporal

README

Golang Temporal Model with ORM

Goals

• Managing document versions with timestamps (in the case of bitemporal, two for valid time and two for system time).
• Organizing documents into collections so that they can be effectively sliced and diced.
• Support Uni-Temporal

Structure

├── LICENSE
├── README.md
├── bitemporal
│   ├── bi.go
│   ├── bi_gormer.go
│   └── collection.go
├── errors.go
├── example
├── go.mod
├── go.sum
├── gorm_callbacks.go
├── gotemporal.go
├── model.go
└── unitemporal
    ├── sys_uni_gormer.go
    └── uni.go

Models

• Bi-temporal
• Uni-temporal with system time
• Uni-temporal with valid time

ORM

• GORM
• XORM

Referrence

• A Deep Dive into Bitemporal
• What is bitemporal and why should the enterprise care?

Documentation

Index

• Variables
• func GenTID() string
• func SysToIsNull(table string) func(d *gorm.DB) *gorm.DB
• func ValidToIsNull(table string) func(d *gorm.DB) *gorm.DB
• func WithID(id IDer) func(d *gorm.DB) *gorm.DB
• func WithSysAt(sysAt time.Time) func(d *gorm.DB) *gorm.DB
• func WithTID(tid TIDer) func(d *gorm.DB) *gorm.DB
• func WithValidAt(validAt time.Time) func(d *gorm.DB) *gorm.DB
• type IDer
• type TIDer
• type Temporal
• type TemporalModel

Variables

var (
	ErrNotFound = errors.New("not found")
)

All errors for every gotemporal packages

Functions

func GenTID

func GenTID() string

func SysToIsNull

func SysToIsNull(table string) func(d *gorm.DB) *gorm.DB

SysToIsNull where code = <input value>

func ValidToIsNull

func ValidToIsNull(table string) func(d *gorm.DB) *gorm.DB

ValidToIsNull where the valid_to column is NULL

func WithID

func WithID(id IDer) func(d *gorm.DB) *gorm.DB

WithID where id = <input value>

func WithSysAt

func WithSysAt(sysAt time.Time) func(d *gorm.DB) *gorm.DB

WithSysAt where code = <input value>

func WithTID

func WithTID(tid TIDer) func(d *gorm.DB) *gorm.DB

WithTID where biid = <input value>

func WithValidAt

func WithValidAt(validAt time.Time) func(d *gorm.DB) *gorm.DB

WithValidAt where code = <input value>

Types

type IDer

type IDer interface {
	GetID() uint64
}

type TIDer

type TIDer interface {
	GetTID() string
	SetTID(string)
}

type Temporal

type Temporal interface {
	// contains filtered or unexported methods
}

type TemporalModel

type TemporalModel interface {
	IDer
	TIDer

	Clean()
}