Safe Haskell	None
Language	GHC2024

Napkin.Run.Metadata.KVStore

Documentation

class (FromJSON payload, Ord key, ToJSON payload) => MetadataPayload key payload | key -> payload where #

Methods

keyText :: key -> Text #

Instances

Instances details

MetadataPayload SuccessfulTaskDuration SuccessfulTaskDurationInfo #
Instance details Defined in Napkin.Run.Metadata Methods keyText :: SuccessfulTaskDuration -> Text #
MetadataPayload TableLastRun LastRunInfo #
Instance details Defined in Napkin.Run.Metadata Methods keyText :: TableLastRun -> Text #
MetadataPayload TableLastSuccessfulRun LastSuccessfulRunInfo #
Instance details Defined in Napkin.Run.Metadata Methods keyText :: TableLastSuccessfulRun -> Text #

kvReadMany :: forall key payload m. (Katip m, MetadataPayload key payload, MonadIO m) => KVS -> [key] -> m (Map key payload) #

kvRead :: (Katip m, MetadataPayload key payload, MonadIO m) => KVS -> key -> m (Maybe payload) #

kvWrite :: (Katip m, MetadataPayload key payload, MonadIO m) => KVS -> key -> payload -> m () #

kvUpdate :: (Katip m, MetadataPayload key payload, MonadIO m) => KVS -> key -> (Maybe payload -> payload) -> m () #

data KVS #

Constructors

KVS
Fields read :: forall key payload. MetadataPayload key payload => [key] -> IO (Map key payload) write :: forall key payload. MetadataPayload key payload => key -> payload -> IO ()

newtype MetadataErrorInfo #

Constructors

MetadataErrorInfo Text

Instances

Instances details

Generic MetadataErrorInfo #

Instance details

Defined in Napkin.Run.Metadata.KVStore

Associated Types

type Rep MetadataErrorInfo
Instance details Defined in Napkin.Run.Metadata.KVStore type Rep MetadataErrorInfo = D1 ('MetaData "MetadataErrorInfo" "Napkin.Run.Metadata.KVStore" "napkin-runtime-2.0.0-Jnfp0IultB031hOPo9RyGD" 'True) (C1 ('MetaCons "MetadataErrorInfo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: MetadataErrorInfo -> Rep MetadataErrorInfo x #

to :: Rep MetadataErrorInfo x -> MetadataErrorInfo #

Show MetadataErrorInfo #

Instance details

Defined in Napkin.Run.Metadata.KVStore

Methods

showsPrec :: Int -> MetadataErrorInfo -> ShowS #

show :: MetadataErrorInfo -> String #

showList :: [MetadataErrorInfo] -> ShowS #

Eq MetadataErrorInfo #

Instance details

Defined in Napkin.Run.Metadata.KVStore

Methods

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

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

ToNapkinError MetadataErrorInfo #

Instance details

Defined in Napkin.Run.Metadata.KVStore

Methods

toNapkinError :: MetadataErrorInfo -> NapkinError #

type Rep MetadataErrorInfo #

Instance details

Defined in Napkin.Run.Metadata.KVStore

type Rep MetadataErrorInfo = D1 ('MetaData "MetadataErrorInfo" "Napkin.Run.Metadata.KVStore" "napkin-runtime-2.0.0-Jnfp0IultB031hOPo9RyGD" 'True) (C1 ('MetaCons "MetadataErrorInfo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type InitKVS (m :: Type -> k) = m (Either MetadataErrorInfo (KVS, IO ())) #

initKVFile :: MonadIO m => FilePath -> InitKVS m #

initKVSAwsS3 :: (Katip m, MonadIO m) => BucketName -> Text -> InitKVS m #

data KVSConnectionString #

Constructors

KVSFile
Fields directory :: FilePath
KVSS3
Fields bucket :: BucketName prefix :: Text
KVSDummy

Instances

Instances details

FromJSON KVSConnectionString #
Instance details Defined in Napkin.Run.Metadata.KVStore Methods parseJSON :: Value -> Parser KVSConnectionString # parseJSONList :: Value -> Parser [KVSConnectionString] # omittedField :: Maybe KVSConnectionString #
Show KVSConnectionString #
Instance details Defined in Napkin.Run.Metadata.KVStore Methods showsPrec :: Int -> KVSConnectionString -> ShowS # show :: KVSConnectionString -> String # showList :: [KVSConnectionString] -> ShowS #
Eq KVSConnectionString #
Instance details Defined in Napkin.Run.Metadata.KVStore Methods (==) :: KVSConnectionString -> KVSConnectionString -> Bool # (/=) :: KVSConnectionString -> KVSConnectionString -> Bool #

parseKVS :: Text -> Maybe KVSConnectionString #

initKV :: (Katip m, Monad m) => KVSConnectionString -> InitKVS m #

dummyKVS :: KVS #

withKVS :: (MonadIO m, MonadResource m) => InitKVS m -> (KVS -> m a) -> m (Either MetadataErrorInfo a) #