BitemporalPostgres.jl

InfinityKey in order to ease integration with javascript we use javascript's MAXSAFEINTEGER 2^53 - 1

Component

an abstract component of a bitemporal entity i.e. a contract, a reference to a partner a component's history of states is represented by its revisions

ComponentRevision

a component of a bitemporal entity i.e. a contract, a reference to a partner a component's history of states is represented by its revisions

History

The root of an aggregate entity, which groups versions and entities

NoVersionFound showing component type, id and version id

Node

node of tree of mutations

Role

role of a relationship

SubComponent

an abstract subcomponent of a bitemporal entity i.e. product item of a contract

TestDummyComponent <: Component

a component of a bitemporal entity

TestDummyComponentRevision <: ComponentRevision

a revision of a contract component of a bitemporal entity

TestDummySubComponent <: Component a component of a bitemporal entity

TestDummySubComponentRevision <: ComponentRevision

a revision of a contract component of a bitemporal entity

TooManyVersionsFound showing component type, id and version id indicates an error in committing of versions

ValidityInterval

a 2-dimensional interval of validity of a version with respect to the state

• of the data base storage and
• of the world

See the theory page for background

Version

version number of the state of aggregate entity

VersionException

thrown on versioning errors

Workflow Holds application based transaction data.

• current version
• world validFrom date
• db validfrom date
• is_committed means: bitemporal transaction is
  • pending: 0
  • committed: 1
  • rolled back: 2

commitworkflow!(w::Workflow) commits the bitemporal transaction identified by refversion begun with the creation of w

• sets w's version's validityInterval to is_committed
• ends all overlapping intervals to tsdbinvalidfrom w.tsdbvalidfrom
• creates a new interval for the non_overlapping part of a partially interval if any

create_component!(c::Component, cr :: ComponentRevision, w:: Workflow)

creates a component and a componentRevision

create_entity!(w::Workflow)

• opens a bitemporal transaction identified by ref_version
• persists a history, version, validityInterval and a Workflow
• requires: w.tsw_validfrom is a valid date

create_subcomponent!(c::Component, sc::SubComponent, cr :: ComponentRevision, w:: Workflow) creates a subcomponent and a componentRevision

delete_component!(c::T, w::Workflow) where {T<:Component}

• deletes a component if it was created for the current version or
• mark its latest component revision as invalid

delete_component!(r::T, w::Workflow) where {T<:ComponentRevision}

• deletes a component if it was created for the current version or
• mark its latest component revision as invalid

findcomponentrevision(t::Type{T},refcomponent::DbId,refversion::DbId,)::Vector{T} where {T<:ComponentRevision} retrieves the version_id of a bitemporal history asof tsdb as per tsw

findversion(refhistory::DbId, tsdb::ZonedDateTime, tsw::ZonedDateTime, committed::Integer=1)::DbId retrieves the versionid of a bitemporal history asof tsdb as per tsw

get_revision(ctype::Type{CT}, rtype::Type{RT}, hid::DbId, vid::DbId) where {CT<:Component,RT<:ComponentRevision}

retrieves the revision of the unique component of type CT in history hid as of version vid 
the revision must exist

get_revision(rtype::Type{RT}, cid::DbId, vid::DbId) where {RT<:ComponentRevision}

retrieves the revision of component cid as of version vid 
the revision must exist

function get_revisionIfAny( ctype::Type{CT}, rtype::Type{RT}, hid::DbId, vid::DbId, )::Vector{RT} where {CT<:Component,RT<:ComponentRevision} retrieves the revision of the unique component of type CT in history hid if one exists as of version vid

An optional (unique) component may have a revision for a version later as vid. In such cases a component w/o valid revision is itself valid, just to be ignored for the current version.

function get_revisionIfAny(rtype::Type{RT}, hid::DbId, vid::DbId, )::Vector{RT} where {RT<:ComponentRevision} retrieves the revision of component cid if one exists as of version vid

An optional component may have a revision for a version later as vid. In such cases a component w/o valid revision is itself valid, just to be ignored for the current version.

gettypeofcomponent(revision::TestDummyComponentRevision) :: Type{TestDummyComponent}

gettypeofcomponent(component::T)::Type{R} where {T<:ComponentRevision,R<:Component} returns the actual subtype of Component that fits the actual type of ComponentRevision

gettypeofrevision(component::TestDummyComponent) :: Type{TestDummyComponentRevision}

gettypeofrevision(component::T)::Type{R} where {T<:Component,R<:ComponentRevision} returns the actual subtype of ComponentRevision that fits the actual type of Component

mkforest(hid::DbId)::Vector{Node}

builds a forest of version nodes where
* eventual child node vectors denote mutations which have been retrospectively corrected by their predecessor


see: Theory: Textual representation of mutation histories

function mktree(version::Integer, vidsDict::Dict{Integer,Integer}, treeDict::Dict{Integer,Vector{Integer}})::BitemporalPostgres.Node

builds a tree of versipon nodes with child node vectors denoting
mutations which have been retrospectively corrected by their parent = predecessor

see: Theory: Textual representation of mutation histories

revisionTypes(entity::Val{:TestDummyComponent}) defining the ComponentRevision types occurring in TestDummyComponents

revisionTypes(entity::Val{T})::Vector{T} where {T<:Symbol} list of subtypes of ComponentRevision that are subcomponents of

rollbackworkflow!(w::Workflow) rolls back the bitemporal transaction identified by refversion begun with the creation of w

update_component!(cr :: ComponentRevision, crNew :: ComponentRevision, w:: Workflow)

terminates a componentRevision and persists its successor

update_entity!(w::Workflow)

• opens a bitemporal transaction identified by ref_version
• persists a version, a validityInterval and a Workflow
• For retrospective transactions
  • preliminarily invalidates all insertions and mutations from shadowed versions
  • preliminarily revives all revisions invalidated by shadowed versions
• requires:
  • w.tsw_validfrom is a valid date
  • w.ref_history is a valid history id
  • w.refversion is a valid version of w.refhistory