entity

Documentation

Overview

Package entity Entity interface and base entity for all persistent model entities

Index

• func EntityIndex(entity Entity, tenantId string) string
• func GUID() string
• func ID() string
• func IDN() string
• func Marshal(v any) ([]byte, error)
• func NanoID() string
• func ShortID(delta ...int) string
• func ShortIDN(delta ...int) string
• func Unmarshal(data []byte, v any) error
• type BaseEntity
  • func (e BaseEntity) ID() string
  • func (e BaseEntity) KEY() string
  • func (e BaseEntity) NAME() string
  • func (e BaseEntity) TABLE() string
• type Entity
  • func NewBaseEntity() Entity
  • func NewSimpleEntity[T any]() Entity
• type EntityAction
• type EntityFactory
• type Json
• type JsonDoc
• type SimpleEntity
  • func (e SimpleEntity[T]) ID() string
  • func (e SimpleEntity[T]) KEY() string
  • func (e SimpleEntity[T]) NAME() string
  • func (e SimpleEntity[T]) TABLE() string
• type TimeDataPoint
  • func NewTimeDataPoint[V any](ts Timestamp, value V) TimeDataPoint[V]
  • func (tf *TimeDataPoint[V]) String(format string) string
• type TimeFrame
  • func GetTimeFrame(from Timestamp, duration time.Duration) TimeFrame
  • func NewTimeFrame(from, to Timestamp) TimeFrame
  • func (tf *TimeFrame) Duration() time.Duration
  • func (tf *TimeFrame) String(format string) string
• type Timestamp
  • func EpochNowMillis(delta int64) Timestamp
  • func Now() Timestamp
  • func (ts *Timestamp) Add(delta time.Duration) Timestamp
  • func (ts *Timestamp) LocalString(format string, tz string) string
  • func (ts *Timestamp) String(format string) string
  • func (ts *Timestamp) Time() (result time.Time)
• type Tuple

Functions

func EntityIndex

func EntityIndex(entity Entity, tenantId string) string

EntityIndex extract table or index name from entity.TABLE()

func GUID

func GUID() string

GUID generate new Global Unique Identifier

func ID

func ID() string

ID return a long string (alphanumeric) based on Epoch micro-seconds in base 36

func IDN

func IDN() string

IDN return a long string (digits only) based on Epoch micro-seconds

func Marshal

func Marshal(v any) ([]byte, error)

Marshal returns the JSON encoding of v

func NanoID

func NanoID() string

NanoID return a long string (6 characters) based on go-nanoid project (smaller and faster than GUID)

func ShortID

func ShortID(delta ...int) string

ShortID return a short string (6 characters alphanumeric) based on epoch seconds in base 36

func ShortIDN

func ShortIDN(delta ...int) string

ShortIDN return a short string (digits only) based on epoch seconds

func Unmarshal

func Unmarshal(data []byte, v any) error

Unmarshal returns the struct from JSON byte array

Types

type BaseEntity

type BaseEntity struct {
	Id        string    `json:"id"`        // Unique object Id
	CreatedOn Timestamp `json:"createdOn"` // When the object was created [Epoch milliseconds Timestamp]
	UpdatedOn Timestamp `json:"updatedOn"` // When the object was last updated [Epoch milliseconds Timestamp]
}

BaseEntity is a base structure for any concrete Entity

func (BaseEntity) ID

func (e BaseEntity) ID() string

func (BaseEntity) KEY

func (e BaseEntity) KEY() string

func (BaseEntity) NAME

func (e BaseEntity) NAME() string

func (BaseEntity) TABLE

func (e BaseEntity) TABLE() string

type Entity

type Entity interface {
	// ID return the entity unique Id
	ID() string

	// TABLE return the entity table name (for sharded entities, table name include the suffix of the tenant id)
	TABLE() string

	// NAME return the entity name
	NAME() string

	// KEY return the entity sharding key (tenant/account id) based on one of the entity's attributes
	KEY() string
}

Entity is a marker interface for all serialized domain model entities with identity

func NewBaseEntity

func NewBaseEntity() Entity

func NewSimpleEntity

func NewSimpleEntity[T any]() Entity

type EntityAction

type EntityAction int

const (
	AddEntity    EntityAction = 1
	UpdateEntity EntityAction = 2
	DeleteEntity EntityAction = 3
)

type EntityFactory

type EntityFactory func() Entity

EntityFactory is the factory method signature for Entity

type Json

type Json map[string]any

Json Represent arbitrary JSON fields collection

type JsonDoc

type JsonDoc struct {
	Id   string
	Data string
}

JsonDoc is a Json document to store in Document object store (Postgres, ElasticSearch, Couchbase ...)

type SimpleEntity

type SimpleEntity[T any] struct {
	Value T `json:"value"` // entity value
}

SimpleEntity is a primitive type expressed as an Entity

func (SimpleEntity[T]) ID

func (e SimpleEntity[T]) ID() string

func (SimpleEntity[T]) KEY

func (e SimpleEntity[T]) KEY() string

func (SimpleEntity[T]) NAME

func (e SimpleEntity[T]) NAME() string

func (SimpleEntity[T]) TABLE

func (e SimpleEntity[T]) TABLE() string

type TimeDataPoint

type TimeDataPoint[V any] struct {
	Timestamp Timestamp `json:"timestamp"` // Timestamp
	Value     V         `json:"value"`     // Generic value
}

TimeDataPoint model represents a generic datapoint in time

func NewTimeDataPoint

func NewTimeDataPoint[V any](ts Timestamp, value V) TimeDataPoint[V]

NewTimeDataPoint return new instance of the datapoint

func (*TimeDataPoint[V]) String

func (tf *TimeDataPoint[V]) String(format string) string

String convert Epoch milliseconds timestamp to readable string

type TimeFrame

type TimeFrame struct {
	From Timestamp `json:"from"` // From Timestamp
	To   Timestamp `json:"to"`   // To Timestamp
}

TimeFrame represents a slot in time

func GetTimeFrame

func GetTimeFrame(from Timestamp, duration time.Duration) TimeFrame

GetTimeFrame return new time slot using start and duration

func NewTimeFrame

func NewTimeFrame(from, to Timestamp) TimeFrame

NewTimeFrame return new time slot using start and end time

func (*TimeFrame) Duration

func (tf *TimeFrame) Duration() time.Duration

Duration of the timeframe

func (*TimeFrame) String

func (tf *TimeFrame) String(format string) string

String convert Epoch milliseconds timestamp to readable string

type Timestamp

type Timestamp int64

Timestamp represents Epoch milliseconds timestamp

func EpochNowMillis

func EpochNowMillis(delta int64) Timestamp

EpochNowMillis return current time as Epoch time milliseconds with delta in millis

func Now

func Now() Timestamp

Now return current time as Epoch time milliseconds with delta in millis

func (*Timestamp) Add

func (ts *Timestamp) Add(delta time.Duration) Timestamp

Add time and return a new timestamp

func (*Timestamp) LocalString

func (ts *Timestamp) LocalString(format string, tz string) string

LocalString convert Epoch milliseconds timestamp with timezone (IANA) to readable string

func (*Timestamp) String

func (ts *Timestamp) String(format string) string

String convert Epoch milliseconds timestamp to readable string

func (*Timestamp) Time

func (ts *Timestamp) Time() (result time.Time)

Time returns the Go primitive time.Time object

type Tuple

type Tuple[K, V any] struct {
	Key   K `json:"key"`   // Tuple key
	Value V `json:"value"` // Tuple value
}

Tuple model represents a generic key-value pair