Safe Haskell	None
Language	GHC2024

Keiro.ReadModel.External

Description

Managed, versioned PostgreSQL functions for out-of-process read-model consumers. Callers receive execute-only functions in keiro_read; target tables and the private binding views remain inaccessible.

Synopsis

data ExternalReadReconciliationError
data ExternalReadRetirementError
- = ExternalReadRetirementUnknown !ExternalReadContractId !ExternalReadContractVersion
- | ExternalReadRetirementAlreadyRetired !ExternalReadContractId !ExternalReadContractVersion
data ExternalReadRetirementPreview = ExternalReadRetirementPreview {
- contractId :: !ExternalReadContractId
- contractVersion :: !ExternalReadContractVersion
- publicFunction :: !Text
- currentState :: !Text
- surfaceGeneration :: !Int
- dependentObjects :: ![Text]
- executeGrants :: ![Text]
}
reconcileExternalReadContracts :: forall (es :: [Effect]). Store :> es => ValidatedProjectionCatalog -> Eff es (Either ExternalReadReconciliationError ())
reconcileExternalReadContractsTx :: ValidatedProjectionCatalog -> Transaction (Either ExternalReadReconciliationError ())
reconcileExternalReadContractsForGroupsTx :: ValidatedProjectionCatalog -> Maybe (Set RebuildGroupId) -> Transaction (Either ExternalReadReconciliationError ())
previewExternalReadContractRetirement :: forall (es :: [Effect]). Store :> es => ExternalReadContractId -> ExternalReadContractVersion -> Eff es (Either ExternalReadRetirementError ExternalReadRetirementPreview)
retireExternalReadContract :: forall (es :: [Effect]). Store :> es => ExternalReadContractId -> ExternalReadContractVersion -> Eff es (Either ExternalReadRetirementError ExternalReadRetirementPreview)

Documentation

data ExternalReadReconciliationError Source #

Constructors

ExternalReadAllRowsRequiresSingleTarget !ExternalReadContractId !ExternalReadContractVersion
ExternalReadResultTypeMissing !QualifiedSqlType
ExternalReadResultTypeNotComposite !QualifiedSqlType
ExternalReadPrivateImplementationMissing !QualifiedFunction
ExternalReadPrivateImplementationResultMismatch !QualifiedFunction !QualifiedSqlType
ExternalReadImmutableSignatureConflict !ExternalReadContractId !ExternalReadContractVersion
ExternalReadDefinitionGenerationConflict !ExternalReadContractId !ExternalReadContractVersion !Int
ExternalReadSurfaceDowngrade !ExternalReadContractId !ExternalReadContractVersion !Int !Int
ExternalReadRetiredContractCannotReactivate !ExternalReadContractId !ExternalReadContractVersion
ExternalReadUnmanagedObjectCollision !Text !Text !Text
ExternalReadManagedObjectOwnershipConflict !Text !Text !Text

Instances

Instances details

Generic ExternalReadReconciliationError Source #

Instance details

Defined in Keiro.ReadModel.External

Associated Types

type Rep ExternalReadReconciliationError

Instance details

Defined in Keiro.ReadModel.External

Methods

from :: ExternalReadReconciliationError -> Rep ExternalReadReconciliationError x #

to :: Rep ExternalReadReconciliationError x -> ExternalReadReconciliationError #

Show ExternalReadReconciliationError Source #

Instance details

Defined in Keiro.ReadModel.External

Methods

showsPrec :: Int -> ExternalReadReconciliationError -> ShowS #

show :: ExternalReadReconciliationError -> String #

showList :: [ExternalReadReconciliationError] -> ShowS #

Eq ExternalReadReconciliationError Source #

Instance details

Defined in Keiro.ReadModel.External

Methods

(==) :: ExternalReadReconciliationError -> ExternalReadReconciliationError -> Bool #

(/=) :: ExternalReadReconciliationError -> ExternalReadReconciliationError -> Bool #

type Rep ExternalReadReconciliationError Source #

Instance details

Defined in Keiro.ReadModel.External

data ExternalReadRetirementError Source #

Constructors

ExternalReadRetirementUnknown !ExternalReadContractId !ExternalReadContractVersion
ExternalReadRetirementAlreadyRetired !ExternalReadContractId !ExternalReadContractVersion

Instances

Instances details

Generic ExternalReadRetirementError Source #

Instance details

Defined in Keiro.ReadModel.External

Associated Types

type Rep ExternalReadRetirementError

Instance details

Defined in Keiro.ReadModel.External

type Rep ExternalReadRetirementError = D1 ('MetaData "ExternalReadRetirementError" "Keiro.ReadModel.External" "keiro-0.12.0.0-inplace" 'False) (C1 ('MetaCons "ExternalReadRetirementUnknown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractVersion)) :+: C1 ('MetaCons "ExternalReadRetirementAlreadyRetired" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractVersion)))

Methods

from :: ExternalReadRetirementError -> Rep ExternalReadRetirementError x #

to :: Rep ExternalReadRetirementError x -> ExternalReadRetirementError #

Show ExternalReadRetirementError Source #

Instance details

Defined in Keiro.ReadModel.External

Methods

showsPrec :: Int -> ExternalReadRetirementError -> ShowS #

show :: ExternalReadRetirementError -> String #

showList :: [ExternalReadRetirementError] -> ShowS #

Eq ExternalReadRetirementError Source #

Instance details

Defined in Keiro.ReadModel.External

Methods

(==) :: ExternalReadRetirementError -> ExternalReadRetirementError -> Bool #

(/=) :: ExternalReadRetirementError -> ExternalReadRetirementError -> Bool #

type Rep ExternalReadRetirementError Source #

Instance details

Defined in Keiro.ReadModel.External

type Rep ExternalReadRetirementError = D1 ('MetaData "ExternalReadRetirementError" "Keiro.ReadModel.External" "keiro-0.12.0.0-inplace" 'False) (C1 ('MetaCons "ExternalReadRetirementUnknown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractVersion)) :+: C1 ('MetaCons "ExternalReadRetirementAlreadyRetired" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractVersion)))

data ExternalReadRetirementPreview Source #

Constructors

ExternalReadRetirementPreview
Fields contractId :: !ExternalReadContractId contractVersion :: !ExternalReadContractVersion publicFunction :: !Text currentState :: !Text surfaceGeneration :: !Int dependentObjects :: ![Text] executeGrants :: ![Text]

Instances

Instances details

Generic ExternalReadRetirementPreview Source #

Instance details

Defined in Keiro.ReadModel.External

Associated Types

type Rep ExternalReadRetirementPreview

Instance details

Defined in Keiro.ReadModel.External

type Rep ExternalReadRetirementPreview = D1 ('MetaData "ExternalReadRetirementPreview" "Keiro.ReadModel.External" "keiro-0.12.0.0-inplace" 'False) (C1 ('MetaCons "ExternalReadRetirementPreview" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contractId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractId) :*: (S1 ('MetaSel ('Just "contractVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractVersion) :*: S1 ('MetaSel ('Just "publicFunction") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "currentState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "surfaceGeneration") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "dependentObjects") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "executeGrants") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text])))))

Methods

from :: ExternalReadRetirementPreview -> Rep ExternalReadRetirementPreview x #

to :: Rep ExternalReadRetirementPreview x -> ExternalReadRetirementPreview #

Show ExternalReadRetirementPreview Source #

Instance details

Defined in Keiro.ReadModel.External

Methods

showsPrec :: Int -> ExternalReadRetirementPreview -> ShowS #

show :: ExternalReadRetirementPreview -> String #

showList :: [ExternalReadRetirementPreview] -> ShowS #

Eq ExternalReadRetirementPreview Source #

Instance details

Defined in Keiro.ReadModel.External

Methods

(==) :: ExternalReadRetirementPreview -> ExternalReadRetirementPreview -> Bool #

(/=) :: ExternalReadRetirementPreview -> ExternalReadRetirementPreview -> Bool #

type Rep ExternalReadRetirementPreview Source #

Instance details

Defined in Keiro.ReadModel.External

type Rep ExternalReadRetirementPreview = D1 ('MetaData "ExternalReadRetirementPreview" "Keiro.ReadModel.External" "keiro-0.12.0.0-inplace" 'False) (C1 ('MetaCons "ExternalReadRetirementPreview" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contractId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractId) :*: (S1 ('MetaSel ('Just "contractVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExternalReadContractVersion) :*: S1 ('MetaSel ('Just "publicFunction") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "currentState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "surfaceGeneration") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "dependentObjects") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "executeGrants") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text])))))

reconcileExternalReadContracts :: forall (es :: [Effect]). Store :> es => ValidatedProjectionCatalog -> Eff es (Either ExternalReadReconciliationError ()) Source #

reconcileExternalReadContractsTx :: ValidatedProjectionCatalog -> Transaction (Either ExternalReadReconciliationError ()) Source #

Reconcile the complete catalog. Any refusal condemns the transaction, so partially-created functions, views, metadata, and revokes never escape.

reconcileExternalReadContractsForGroupsTx :: ValidatedProjectionCatalog -> Maybe (Set RebuildGroupId) -> Transaction (Either ExternalReadReconciliationError ()) Source #

Reconcile only contracts owned by the selected groups. Nothing means the complete catalog and also marks superseded absent contracts pending retirement. A selected adoption never mutates another group's surface.

previewExternalReadContractRetirement :: forall (es :: [Effect]). Store :> es => ExternalReadContractId -> ExternalReadContractVersion -> Eff es (Either ExternalReadRetirementError ExternalReadRetirementPreview) Source #

retireExternalReadContract :: forall (es :: [Effect]). Store :> es => ExternalReadContractId -> ExternalReadContractVersion -> Eff es (Either ExternalReadRetirementError ExternalReadRetirementPreview) Source #