package gorm

Import Path
	/pkg/history/gorm (on go.dev)

Dependency Relation
	imports 22 packages, and imported by 0 packages

Involved Source Files

	    gorm.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type Config (struct)

		Fields (total 13)
			BaseConfig amhist.BaseConfig
			BaseConfig.Called am.S
				Called is a list of mutation states (called ones) required to track a
				transition. See also CalledExclude. Optional.

			BaseConfig.CalledExclude bool
				CalledExclude flips Called to be a blocklist.

			BaseConfig.Changed am.S
				Changed is a list of transition states which had clock changes, required to
				track a transition. See also ChangedExclude. A state can be called, but not
				changed. Optional.

			BaseConfig.ChangedExclude bool
				ChangedExclude flips Changed to be a blocklist.

			BaseConfig.Log bool
			BaseConfig.MaxRecords int
				MaxRecords is the maximum number of records to keep in the history before
				a rotation begins.

			BaseConfig.StoreSchema bool
				TODO StoreSchema keeps the latest machine schema and state names within
				[MachineRecord]. Useful for dynamic machines.

			BaseConfig.StoreTransitions bool
				StoreTransitions is a flag to store TransitionRecord, in addition to
				TimeRecord, for each tracked transition.

			BaseConfig.TrackRejected bool
				TrackRejected is a flag to track rejected transitions.

			BaseConfig.TrackedStates am.S
				TrackedStates is a list of states to store clock values of.

			QueueBatch int32
				amount of records to save in bulk (default: 1000)

			SavePool int
				amount of goroutines doing bulk saving (default: 10)

		As Inputs Of (at least one exported)
			func NewMemory(ctx context.Context, db *gorm.DB, mach am.Api, cfg Config, onErr func(err error)) (*Memory, error)

	 type Machine (struct)
		Machine is a SQL version of [amhist.MachineRecord].

		Fields (total 13)
			FirstTracking time.Time
				first time the machine has been tracked

			ID uint32
			LastSync time.Time
				last time a sync has been performed

			LastTracking time.Time
				last time a tracking of this machine has started

			MTime datatypes.JSON
				current (total) machine time
				TODO optimize: collect in a separate query

			MTimeSum uint64
				sum of the current machine time

			MachId string
			MachTick uint32
				current machine start tick

			NextId uint64
				next ID for time records

			Schema datatypes.JSON
			StateNames datatypes.JSON
			States []State
			Times []Time
		As Outputs Of (at least one exported)
			func GetMachine(db *gorm.DB, id string, inclStates bool) (*Machine, error)

	 type MatcherFn (func)

		As Inputs Of (at least one exported)
			func (*Memory).Match(ctx context.Context, limit int, matcherFn MatcherFn) ([]*amhist.MemoryRecord, error)

	 type Memory (struct)

		Fields (total 9)
			BaseMemory *amhist.BaseMemory
			BaseMemory.Ctx context.Context
			BaseMemory.Mach am.Api
			Cfg *Config
			Db *gorm.DB
			SaveInProgress atomic.Bool
			SavePending atomic.Int32
			Saved atomic.Uint64
			SavedGc atomic.Uint64
				Value of Saved at the end of the last GC

		Methods (total 23)
			( Memory) ActivatedBetween(ctx context.Context, state string, start, end time.Time) bool
				ActivatedBetween returns true if the state was activated within the passed
				human time range.

			( Memory) ActiveBetween(ctx context.Context, state string, start, end time.Time) bool
				ActiveBetween returns true if the state was activated all the time within
				the passed human time range.

			(*Memory) Config() amhist.BaseConfig
				Config is [amhist.BaseMemory.Config].

			( Memory) Context() context.Context
			( Memory) DeactivatedBetween(ctx context.Context, state string, start, end time.Time) bool
			(*Memory) Dispose() error
				Dispose is [amhist.BaseMemory.Dispose]. TODO merge with ctx

			(*Memory) FindLatest(ctx context.Context, retTx bool, limit int, query amhist.Query) ([]*amhist.MemoryRecord, error)
				FindLatest is [amhist.BaseMemory.FindLatest].

			( Memory) InactiveBetween(ctx context.Context, state string, start, end time.Time) bool
			( Memory) Index(states am.S) []int
				Index returns the indexes of the given states in the history records, or -1
				if the state is not being tracked.

			( Memory) Index1(state string) int
				Index1 is [BaseMemory.Index] for a single state.

			( Memory) IsTracked(states am.S) bool
				IsTracked returns true if the given states are all being tracked by this
				memory instance.

			( Memory) IsTracked1(state string) bool
				IsTracked1 is IsTracked for a single state.

			(*Memory) JoinState(query *gorm.DB, name string) *gorm.DB
			(*Memory) JoinTransition(query *gorm.DB) *gorm.DB
			(*Memory) Machine() am.Api
				Machine is [amhist.BaseMemory.Machine].

			(*Memory) MachineRecord() *amhist.MachineRecord
				MachineRecord is [amhist.BaseMemory.MachineRecord].

			(*Memory) Match(ctx context.Context, limit int, matcherFn MatcherFn) ([]*amhist.MemoryRecord, error)
				Match returns the latest record that matches the given matcher function.

			(*Memory) Sync() error
				Sync is [amhist.BaseMemory.Sync].

			( Memory) ToMachineRecord(format any) (*history.MachineRecord, error)
			( Memory) ToMemoryRecord(format any) (*history.MemoryRecord, error)
			( Memory) ToTimeRecord(format any) (*history.TimeRecord, error)
			( Memory) ToTransitionRecord(format any) (*history.TransitionRecord, error)
			( Memory) ValidateQuery(query history.Query) error
		Implements (at least 2)
			*Memory : github.com/pancsta/asyncmachine-go/pkg/history.MemoryApi
			*Memory : github.com/polarsignals/frostdb.Sync
		As Outputs Of (at least one exported)
			func NewMemory(ctx context.Context, db *gorm.DB, mach am.Api, cfg Config, onErr func(err error)) (*Memory, error)

	 type State (struct)

		Fields (total 4)
			ID uint
			Index int
				Index is the state index in the machine (not the tracked states index).

			MachineID string
			Name string

	 type Tick (struct)

		Fields (total 8)
			Activated bool
				was the state activated in this transition?

			Active bool
				state is currently active

			Deactivated bool
				was the state deactivated in this transition?

			MachineID uint32
			State State
			StateID uint
			Tick uint64
			TimeID uint64

	 type Time (struct)
		Time is a SQL version of [amhist.TimeRecord].

		Fields (total 25)
			HTime time.Time
				HTime is a human time in UTC.

			ID uint64
			MTimeDiffSum uint64
				MTimeDiffSum is a machine time difference for this transition.

			MTimeRecordDiffSum uint64
				MTimeRecordDiffSum is a machine time difference since the previous
				[amhist.TimeRecord].

			MTimeSum uint64
				MTimeSum is a machine time sum after this transition.

			MTimeTracked datatypes.JSON
				MTime is a machine time for tracked states after this mutation.

			MTimeTrackedDiff datatypes.JSON
				MTimeTrackedDiff is a machine time diff compared to the previous mutation
				(not a record). TODO make optional? can be generated

			MTimeTrackedDiffSum uint64
				MTimeDiffSum is a machine time difference for this transition for tracked
				states only.

			MTimeTrackedSum uint64
				MTimeSum is a machine time sum after this transition for tracked states
				only.

			MachTick uint32
				TODO MTimeTrackedDiffCompact arpc-like clock encoding
				MachTick is the machine tick at the time of this transition.

			MachineID uint32
			MutType am.MutationType
				MutType is a mutation type.

			Ticks []Tick
			TxArguments *datatypes.JSON
			TxCalled datatypes.JSON
			TxExecutedAt *uint64
			TxId string
			TxIsAccepted bool
			TxIsAuto bool
			TxIsBroken bool
			TxIsCheck bool
			TxQueueLen uint16
			TxQueuedAt *uint64
			TxSourceMach *string
			TxSourceTx *string


Package-Level Functions (total 4)

	 func GetMachine(db *gorm.DB, id string, inclStates bool) (*Machine, error)
		GetMachine returns a machine record for a given machine id.

	 func ListMachines(db *gorm.DB) ([]*amhist.MachineRecord, error)
		ListMachines returns a list of all machines in a database. TODO

	 func NewDb(name string, debug bool) (*gorm.DB, *sql.DB, error)
		NewDb returns a new SQLite DB for GORM.

	 func NewMemory(ctx context.Context, db *gorm.DB, mach am.Api, cfg Config, onErr func(err error)) (*Memory, error)

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.