Safe Haskell	None
Language	Haskell2010

Avers.Types

Synopsis

class Pk a where
- toPk :: a -> Text
newtype Path = Path {
- unPath :: Text
}
rootPath :: Path
newtype ObjId = ObjId {
- unObjId :: Text
}
rootObjId :: ObjId
newtype RevId = RevId {
- unRevId :: Int
}
zeroRevId :: RevId
data ObjectId
- = BaseObjectId !ObjId
- | ReleaseObjectId !ObjId !RevId
- | AuthorizationObjectId !ObjId
objectIdParser :: Parser ObjectId
parseObjectId :: Text -> Maybe ObjectId
objectIdBase :: ObjectId -> ObjId
data Operation
- = Set {
  - opPath :: !Path
  - opValue :: !(Maybe Value)
  }
- | Splice {
  - opPath :: !Path
  - opIndex :: !Int
  - opRemove :: !Int
  - opInsert :: ![Value]
  }
data PatchError = UnknownPatchError !Text
type PatchM a = Either PatchError a
data Object = Object {
- objectId :: !ObjId
- objectType :: !Text
- objectCreatedAt :: !UTCTime
- objectCreatedBy :: !ObjId
- objectDeleted :: !(Maybe Bool)
}
data Patch = Patch {
- patchObjectId :: !ObjectId
- patchRevisionId :: !RevId
- patchAuthorId :: !ObjId
- patchCreatedAt :: !UTCTime
- patchOperation :: !Operation
}
data Snapshot = Snapshot {
- snapshotObjectId :: !ObjectId
- snapshotRevisionId :: !RevId
- snapshotContent :: !Value
}
initialSnapshot :: ObjectId -> Snapshot
data Release = Release
newtype SecretId = SecretId {
- unSecretId :: Text
}
data Secret = Secret {
- secretId :: !SecretId
- secretValue :: !Text
}
newtype BlobId = BlobId {
- unBlobId :: Text
}
data Blob = Blob {
- blobId :: !BlobId
- blobSize :: !Int
- blobContentType :: !Text
}
newtype SessionId = SessionId {
- unSessionId :: Text
}
data Session = Session {
- sessionId :: !SessionId
- sessionObjId :: !ObjId
- sessionCreatedAt :: !UTCTime
- sessionLastAccessedAt :: !UTCTime
}
data AversError
- = InternalError !AversError
- | DatabaseError !Text
- | PatchError !PatchError
- | ParseError !Value !Text
- | UnknownObjectType !Text
- | ObjectNotFound !ObjId
- | DocumentNotFound !Text
- | AversError !Text
- | NotAuthorized
internalError :: AversError -> Avers a
internal :: Avers a -> Avers a
databaseError :: Text -> Avers a
patchError :: PatchError -> Avers a
parseError :: MonadError AversError m => Value -> Text -> m a
documentNotFound :: Text -> Avers a
strErr :: String -> Avers a
data ObjectType a = ObjectType {
- otType :: !Text
- otId :: Avers ObjId
- otViews :: [SomeView a]
}
data SomeObjectType where
- SomeObjectType :: (ToDatum a, FromDatum a, FromJSON a, ToJSON a) => ObjectType a -> SomeObjectType
parseValueAs :: FromJSON a => ObjectType a -> Value -> Either AversError a
data Config = Config {
- databaseURI :: !URI
- putBlob :: BlobId -> Text -> ByteString -> IO (Either AversError ())
- objectTypes :: ![SomeObjectType]
- emitMeasurement :: Measurement -> Double -> IO ()
}
data Change = CPatch !Patch
data Handle = Handle {
- hConfig :: !Config
- hDatabaseHandlePool :: !(Pool Handle)
- hRecentRevisionCache :: !(TVar (Map ObjectId RevId))
- hChanges :: !(TChan Change)
}
newtype Avers a = Avers {
- runAvers :: StateT Handle (ExceptT AversError IO) a
}
class Monad m => MonadAvers m where
- liftAvers :: Avers a -> m a
evalAvers :: Handle -> Avers a -> IO (Either AversError a)
data View obj a = View {
- viewName :: Text
- viewParser :: Datum -> Either AversError a
- viewObjectTransformer :: obj -> Avers (Maybe a)
- viewIndices :: [SomeIndex]
}
data SomeView obj where
- SomeView :: (ToDatum a, FromDatum a, FromJSON obj, ToJSON a) => View obj a -> SomeView obj

Documentation

class Pk a where Source #

Pk - Types which can be converted to a database primary key.

Methods

toPk :: a -> Text Source #

Instances

Instances details

Pk Text Source #
Instance details Defined in Avers.Types Methods toPk :: Text -> Text Source #
Pk ObjectId Source #
Instance details Defined in Avers.Types Methods toPk :: ObjectId -> Text Source #
Pk RevId Source #
Instance details Defined in Avers.Types Methods toPk :: RevId -> Text Source #
Pk ObjId Source #
Instance details Defined in Avers.Types Methods toPk :: ObjId -> Text Source #
Pk Object Source #
Instance details Defined in Avers.Types Methods toPk :: Object -> Text Source #
Pk Patch Source #
Instance details Defined in Avers.Types Methods toPk :: Patch -> Text Source #
Pk Snapshot Source #
Instance details Defined in Avers.Types Methods toPk :: Snapshot -> Text Source #
Pk Secret Source #
Instance details Defined in Avers.Types Methods toPk :: Secret -> Text Source #
Pk SecretId Source #
Instance details Defined in Avers.Types Methods toPk :: SecretId -> Text Source #
Pk Blob Source #
Instance details Defined in Avers.Types Methods toPk :: Blob -> Text Source #
Pk BlobId Source #
Instance details Defined in Avers.Types Methods toPk :: BlobId -> Text Source #
Pk Session Source #
Instance details Defined in Avers.Types Methods toPk :: Session -> Text Source #
Pk SessionId Source #
Instance details Defined in Avers.Types Methods toPk :: SessionId -> Text Source #
Pk (Record a) Source #
Instance details Defined in Avers.Views Methods toPk :: Record a -> Text Source #

newtype Path Source #

Path

Constructors

Path
Fields unPath :: Text

Instances

Instances details

Eq Path Source #
Instance details Defined in Avers.Types Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Ord Path Source #
Instance details Defined in Avers.Types Methods compare :: Path -> Path -> Ordering # (<) :: Path -> Path -> Bool # (<=) :: Path -> Path -> Bool # (>) :: Path -> Path -> Bool # (>=) :: Path -> Path -> Bool # max :: Path -> Path -> Path # min :: Path -> Path -> Path #
Show Path Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
IsString Path Source #
Instance details Defined in Avers.Types Methods fromString :: String -> Path #
Generic Path Source #
Instance details Defined in Avers.Types Associated Types type Rep Path :: Type -> Type # Methods from :: Path -> Rep Path x # to :: Rep Path x -> Path #
ToJSON Path Source #
Instance details Defined in Avers.Types Methods toJSON :: Path -> Value # toEncoding :: Path -> Encoding # toJSONList :: [Path] -> Value # toEncodingList :: [Path] -> Encoding #
FromJSON Path Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Path # parseJSONList :: Value -> Parser [Path] #
ToDatum Path Source #
Instance details Defined in Avers.Types Methods toDatum :: Path -> Datum #
FromDatum Path Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Path #
type Rep Path Source #
Instance details Defined in Avers.Types type Rep Path = D1 ('MetaData "Path" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'True) (C1 ('MetaCons "Path" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

rootPath :: Path Source #

This path refers to the root of an object. It is only used in Set operations.

newtype ObjId Source #

ObjId

Constructors

ObjId
Fields unObjId :: Text

Instances

Instances details

Eq ObjId Source #
Instance details Defined in Avers.Types Methods (==) :: ObjId -> ObjId -> Bool # (/=) :: ObjId -> ObjId -> Bool #
Ord ObjId Source #
Instance details Defined in Avers.Types Methods compare :: ObjId -> ObjId -> Ordering # (<) :: ObjId -> ObjId -> Bool # (<=) :: ObjId -> ObjId -> Bool # (>) :: ObjId -> ObjId -> Bool # (>=) :: ObjId -> ObjId -> Bool # max :: ObjId -> ObjId -> ObjId # min :: ObjId -> ObjId -> ObjId #
Show ObjId Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> ObjId -> ShowS # show :: ObjId -> String # showList :: [ObjId] -> ShowS #
Generic ObjId Source #
Instance details Defined in Avers.Types Associated Types type Rep ObjId :: Type -> Type # Methods from :: ObjId -> Rep ObjId x # to :: Rep ObjId x -> ObjId #
ToJSON ObjId Source #
Instance details Defined in Avers.Types Methods toJSON :: ObjId -> Value # toEncoding :: ObjId -> Encoding # toJSONList :: [ObjId] -> Value # toEncodingList :: [ObjId] -> Encoding #
FromJSON ObjId Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser ObjId # parseJSONList :: Value -> Parser [ObjId] #
ToDatum ObjId Source #
Instance details Defined in Avers.Types Methods toDatum :: ObjId -> Datum #
FromDatum ObjId Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser ObjId #
Pk ObjId Source #
Instance details Defined in Avers.Types Methods toPk :: ObjId -> Text Source #
type Rep ObjId Source #
Instance details Defined in Avers.Types type Rep ObjId = D1 ('MetaData "ObjId" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'True) (C1 ('MetaCons "ObjId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unObjId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

rootObjId :: ObjId Source #

The root object id is used for object created internally or when there is no applicable creator.

newtype RevId Source #

RevId

Constructors

RevId
Fields unRevId :: Int

Instances

Instances details

Enum RevId Source #
Instance details Defined in Avers.Types Methods succ :: RevId -> RevId # pred :: RevId -> RevId # toEnum :: Int -> RevId # fromEnum :: RevId -> Int # enumFrom :: RevId -> [RevId] # enumFromThen :: RevId -> RevId -> [RevId] # enumFromTo :: RevId -> RevId -> [RevId] # enumFromThenTo :: RevId -> RevId -> RevId -> [RevId] #
Eq RevId Source #
Instance details Defined in Avers.Types Methods (==) :: RevId -> RevId -> Bool # (/=) :: RevId -> RevId -> Bool #
Ord RevId Source #
Instance details Defined in Avers.Types Methods compare :: RevId -> RevId -> Ordering # (<) :: RevId -> RevId -> Bool # (<=) :: RevId -> RevId -> Bool # (>) :: RevId -> RevId -> Bool # (>=) :: RevId -> RevId -> Bool # max :: RevId -> RevId -> RevId # min :: RevId -> RevId -> RevId #
Show RevId Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> RevId -> ShowS # show :: RevId -> String # showList :: [RevId] -> ShowS #
Generic RevId Source #
Instance details Defined in Avers.Types Associated Types type Rep RevId :: Type -> Type # Methods from :: RevId -> Rep RevId x # to :: Rep RevId x -> RevId #
ToJSON RevId Source #
Instance details Defined in Avers.Types Methods toJSON :: RevId -> Value # toEncoding :: RevId -> Encoding # toJSONList :: [RevId] -> Value # toEncodingList :: [RevId] -> Encoding #
FromJSON RevId Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser RevId # parseJSONList :: Value -> Parser [RevId] #
ToDatum RevId Source #
Instance details Defined in Avers.Types Methods toDatum :: RevId -> Datum #
FromDatum RevId Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser RevId #
Pk RevId Source #
Instance details Defined in Avers.Types Methods toPk :: RevId -> Text Source #
type Rep RevId Source #
Instance details Defined in Avers.Types type Rep RevId = D1 ('MetaData "RevId" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'True) (C1 ('MetaCons "RevId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRevId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

zeroRevId :: RevId Source #

The RevId which is used for the initial snapshot.

data ObjectId Source #

ObjectId

Constructors

BaseObjectId !ObjId	The base object whose snapshots contain the actual content.
ReleaseObjectId !ObjId !RevId	An object describing a particualar release of the base object.
AuthorizationObjectId !ObjId	Object which contains authorization rules.

Instances

Instances details

Eq ObjectId Source #
Instance details Defined in Avers.Types Methods (==) :: ObjectId -> ObjectId -> Bool # (/=) :: ObjectId -> ObjectId -> Bool #
Ord ObjectId Source #
Instance details Defined in Avers.Types Methods compare :: ObjectId -> ObjectId -> Ordering # (<) :: ObjectId -> ObjectId -> Bool # (<=) :: ObjectId -> ObjectId -> Bool # (>) :: ObjectId -> ObjectId -> Bool # (>=) :: ObjectId -> ObjectId -> Bool # max :: ObjectId -> ObjectId -> ObjectId # min :: ObjectId -> ObjectId -> ObjectId #
Show ObjectId Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> ObjectId -> ShowS # show :: ObjectId -> String # showList :: [ObjectId] -> ShowS #
Generic ObjectId Source #
Instance details Defined in Avers.Types Associated Types type Rep ObjectId :: Type -> Type # Methods from :: ObjectId -> Rep ObjectId x # to :: Rep ObjectId x -> ObjectId #
ToJSON ObjectId Source #
Instance details Defined in Avers.Types Methods toJSON :: ObjectId -> Value # toEncoding :: ObjectId -> Encoding # toJSONList :: [ObjectId] -> Value # toEncodingList :: [ObjectId] -> Encoding #
FromJSON ObjectId Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser ObjectId # parseJSONList :: Value -> Parser [ObjectId] #
ToDatum ObjectId Source #
Instance details Defined in Avers.Types Methods toDatum :: ObjectId -> Datum #
FromDatum ObjectId Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser ObjectId #
Pk ObjectId Source #
Instance details Defined in Avers.Types Methods toPk :: ObjectId -> Text Source #
type Rep ObjectId Source #
Instance details Defined in Avers.Types type Rep ObjectId = D1 ('MetaData "ObjectId" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "BaseObjectId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId)) :+: (C1 ('MetaCons "ReleaseObjectId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RevId)) :+: C1 ('MetaCons "AuthorizationObjectId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId))))

objectIdParser :: Parser ObjectId Source #

parseObjectId :: Text -> Maybe ObjectId Source #

objectIdBase :: ObjectId -> ObjId Source #

data Operation Source #

The operations that can be applied to JSON values.

Constructors

Set	Set is applied to `Object`s. It is used for adding, updating and deleting properties from the object.
Fields opPath :: !Path opValue :: !(Maybe Value)
Splice	Splice is used to manipulate `Array`s. It can remove and insert multiple elements in a single operation.
Fields opPath :: !Path opIndex :: !Int opRemove :: !Int opInsert :: ![Value]

Instances

Instances details

Eq Operation Source #
Instance details Defined in Avers.Types Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #
Show Operation Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #
Generic Operation Source #
Instance details Defined in Avers.Types Associated Types type Rep Operation :: Type -> Type # Methods from :: Operation -> Rep Operation x # to :: Rep Operation x -> Operation #
ToJSON Operation Source #
Instance details Defined in Avers.Types Methods toJSON :: Operation -> Value # toEncoding :: Operation -> Encoding # toJSONList :: [Operation] -> Value # toEncodingList :: [Operation] -> Encoding #
FromJSON Operation Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Operation # parseJSONList :: Value -> Parser [Operation] #
ToDatum Operation Source #
Instance details Defined in Avers.Types Methods toDatum :: Operation -> Datum #
FromDatum Operation Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Operation #
type Rep Operation Source #
Instance details Defined in Avers.Types type Rep Operation = D1 ('MetaData "Operation" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "Set" 'PrefixI 'True) (S1 ('MetaSel ('Just "opPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Path) :: S1 ('MetaSel ('Just "opValue") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Value))) :+: C1 ('MetaCons "Splice" 'PrefixI 'True) ((S1 ('MetaSel ('Just "opPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Path) :: S1 ('MetaSel ('Just "opIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "opRemove") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "opInsert") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Value]))))

data PatchError Source #

Constructors

UnknownPatchError !Text

Instances

Instances details

Show PatchError Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> PatchError -> ShowS # show :: PatchError -> String # showList :: [PatchError] -> ShowS #
Generic PatchError Source #
Instance details Defined in Avers.Types Associated Types type Rep PatchError :: Type -> Type # Methods from :: PatchError -> Rep PatchError x # to :: Rep PatchError x -> PatchError #
type Rep PatchError Source #
Instance details Defined in Avers.Types type Rep PatchError = D1 ('MetaData "PatchError" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "UnknownPatchError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

type PatchM a = Either PatchError a Source #

data Object Source #

Constructors

Object
Fields objectId :: !ObjId objectType :: !Text objectCreatedAt :: !UTCTime objectCreatedBy :: !ObjId objectDeleted :: !(Maybe Bool)

Instances

Instances details

Show Object Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> Object -> ShowS # show :: Object -> String # showList :: [Object] -> ShowS #
Generic Object Source #
Instance details Defined in Avers.Types Associated Types type Rep Object :: Type -> Type # Methods from :: Object -> Rep Object x # to :: Rep Object x -> Object #
ToJSON Object Source #
Instance details Defined in Avers.Types Methods toJSON :: Object -> Value # toEncoding :: Object -> Encoding # toJSONList :: [Object] -> Value # toEncodingList :: [Object] -> Encoding #
FromJSON Object Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Object # parseJSONList :: Value -> Parser [Object] #
ToDatum Object Source #
Instance details Defined in Avers.Types Methods toDatum :: Object -> Datum #
FromDatum Object Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Object #
Pk Object Source #
Instance details Defined in Avers.Types Methods toPk :: Object -> Text Source #
type Rep Object Source #
Instance details Defined in Avers.Types type Rep Object = D1 ('MetaData "Object" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "Object" 'PrefixI 'True) ((S1 ('MetaSel ('Just "objectId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId) :: S1 ('MetaSel ('Just "objectType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "objectCreatedAt") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :: (S1 ('MetaSel ('Just "objectCreatedBy") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId) :: S1 ('MetaSel ('Just "objectDeleted") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool))))))

data Patch Source #

Patch

Constructors

Patch
Fields patchObjectId :: !ObjectId patchRevisionId :: !RevId patchAuthorId :: !ObjId patchCreatedAt :: !UTCTime patchOperation :: !Operation

Instances

Instances details

Show Patch Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> Patch -> ShowS # show :: Patch -> String # showList :: [Patch] -> ShowS #
Generic Patch Source #
Instance details Defined in Avers.Types Associated Types type Rep Patch :: Type -> Type # Methods from :: Patch -> Rep Patch x # to :: Rep Patch x -> Patch #
ToJSON Patch Source #
Instance details Defined in Avers.Types Methods toJSON :: Patch -> Value # toEncoding :: Patch -> Encoding # toJSONList :: [Patch] -> Value # toEncodingList :: [Patch] -> Encoding #
FromJSON Patch Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Patch # parseJSONList :: Value -> Parser [Patch] #
ToDatum Patch Source #
Instance details Defined in Avers.Types Methods toDatum :: Patch -> Datum #
FromDatum Patch Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Patch #
Pk Patch Source #
Instance details Defined in Avers.Types Methods toPk :: Patch -> Text Source #
type Rep Patch Source #
Instance details Defined in Avers.Types type Rep Patch = D1 ('MetaData "Patch" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "Patch" 'PrefixI 'True) ((S1 ('MetaSel ('Just "patchObjectId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjectId) :: S1 ('MetaSel ('Just "patchRevisionId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RevId)) :: (S1 ('MetaSel ('Just "patchAuthorId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId) :: (S1 ('MetaSel ('Just "patchCreatedAt") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "patchOperation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Operation)))))

data Snapshot Source #

Snapshot

Constructors

Snapshot
Fields snapshotObjectId :: !ObjectId snapshotRevisionId :: !RevId snapshotContent :: !Value

Instances

Instances details

Show Snapshot Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> Snapshot -> ShowS # show :: Snapshot -> String # showList :: [Snapshot] -> ShowS #
Generic Snapshot Source #
Instance details Defined in Avers.Types Associated Types type Rep Snapshot :: Type -> Type # Methods from :: Snapshot -> Rep Snapshot x # to :: Rep Snapshot x -> Snapshot #
ToJSON Snapshot Source #
Instance details Defined in Avers.Types Methods toJSON :: Snapshot -> Value # toEncoding :: Snapshot -> Encoding # toJSONList :: [Snapshot] -> Value # toEncodingList :: [Snapshot] -> Encoding #
FromJSON Snapshot Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Snapshot # parseJSONList :: Value -> Parser [Snapshot] #
ToDatum Snapshot Source #
Instance details Defined in Avers.Types Methods toDatum :: Snapshot -> Datum #
FromDatum Snapshot Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Snapshot #
Pk Snapshot Source #
Instance details Defined in Avers.Types Methods toPk :: Snapshot -> Text Source #
type Rep Snapshot Source #
Instance details Defined in Avers.Types type Rep Snapshot = D1 ('MetaData "Snapshot" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "Snapshot" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshotObjectId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjectId) :: (S1 ('MetaSel ('Just "snapshotRevisionId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RevId) :: S1 ('MetaSel ('Just "snapshotContent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Value))))

initialSnapshot :: ObjectId -> Snapshot Source #

The initial snapshot on top of which all future patches are applied.

data Release Source #

Release

Constructors

Release

Instances

Instances details

ToJSON Release Source #
Instance details Defined in Avers.Types Methods toJSON :: Release -> Value # toEncoding :: Release -> Encoding # toJSONList :: [Release] -> Value # toEncodingList :: [Release] -> Encoding #
FromJSON Release Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Release # parseJSONList :: Value -> Parser [Release] #

(deriveJSONOptions "release") ''Release)

newtype SecretId Source #

SecretId

Constructors

SecretId
Fields unSecretId :: Text

Instances

Instances details

Show SecretId Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> SecretId -> ShowS # show :: SecretId -> String # showList :: [SecretId] -> ShowS #
Generic SecretId Source #
Instance details Defined in Avers.Types Associated Types type Rep SecretId :: Type -> Type # Methods from :: SecretId -> Rep SecretId x # to :: Rep SecretId x -> SecretId #
ToJSON SecretId Source #
Instance details Defined in Avers.Types Methods toJSON :: SecretId -> Value # toEncoding :: SecretId -> Encoding # toJSONList :: [SecretId] -> Value # toEncodingList :: [SecretId] -> Encoding #
FromJSON SecretId Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser SecretId # parseJSONList :: Value -> Parser [SecretId] #
ToDatum SecretId Source #
Instance details Defined in Avers.Types Methods toDatum :: SecretId -> Datum #
FromDatum SecretId Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser SecretId #
Pk SecretId Source #
Instance details Defined in Avers.Types Methods toPk :: SecretId -> Text Source #
type Rep SecretId Source #
Instance details Defined in Avers.Types type Rep SecretId = D1 ('MetaData "SecretId" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'True) (C1 ('MetaCons "SecretId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSecretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Secret Source #

Secret

A Secret is a password (encrypted with scrypt) that is attached to a SecretId (for example the ObjId of an account).

It is up to you to ensure that SecretIds are unique. If you use ObjIds then they by definition are.

Constructors

Secret
Fields secretId :: !SecretId secretValue :: !Text

Instances

Instances details

Generic Secret Source #
Instance details Defined in Avers.Types Associated Types type Rep Secret :: Type -> Type # Methods from :: Secret -> Rep Secret x # to :: Rep Secret x -> Secret #
ToJSON Secret Source #
Instance details Defined in Avers.Types Methods toJSON :: Secret -> Value # toEncoding :: Secret -> Encoding # toJSONList :: [Secret] -> Value # toEncodingList :: [Secret] -> Encoding #
FromJSON Secret Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Secret # parseJSONList :: Value -> Parser [Secret] #
ToDatum Secret Source #
Instance details Defined in Avers.Types Methods toDatum :: Secret -> Datum #
FromDatum Secret Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Secret #
Pk Secret Source #
Instance details Defined in Avers.Types Methods toPk :: Secret -> Text Source #
type Rep Secret Source #
Instance details Defined in Avers.Types type Rep Secret = D1 ('MetaData "Secret" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "Secret" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecretId) :*: S1 ('MetaSel ('Just "secretValue") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

newtype BlobId Source #

BlobId

Constructors

BlobId
Fields unBlobId :: Text

Instances

Instances details

Show BlobId Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> BlobId -> ShowS # show :: BlobId -> String # showList :: [BlobId] -> ShowS #
Generic BlobId Source #
Instance details Defined in Avers.Types Associated Types type Rep BlobId :: Type -> Type # Methods from :: BlobId -> Rep BlobId x # to :: Rep BlobId x -> BlobId #
ToJSON BlobId Source #
Instance details Defined in Avers.Types Methods toJSON :: BlobId -> Value # toEncoding :: BlobId -> Encoding # toJSONList :: [BlobId] -> Value # toEncodingList :: [BlobId] -> Encoding #
FromJSON BlobId Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser BlobId # parseJSONList :: Value -> Parser [BlobId] #
ToDatum BlobId Source #
Instance details Defined in Avers.Types Methods toDatum :: BlobId -> Datum #
FromDatum BlobId Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser BlobId #
Pk BlobId Source #
Instance details Defined in Avers.Types Methods toPk :: BlobId -> Text Source #
type Rep BlobId Source #
Instance details Defined in Avers.Types type Rep BlobId = D1 ('MetaData "BlobId" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'True) (C1 ('MetaCons "BlobId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Blob Source #

Blob

Constructors

Blob
Fields blobId :: !BlobId blobSize :: !Int blobContentType :: !Text

Instances

Instances details

Show Blob Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> Blob -> ShowS # show :: Blob -> String # showList :: [Blob] -> ShowS #
Generic Blob Source #
Instance details Defined in Avers.Types Associated Types type Rep Blob :: Type -> Type # Methods from :: Blob -> Rep Blob x # to :: Rep Blob x -> Blob #
ToJSON Blob Source #
Instance details Defined in Avers.Types Methods toJSON :: Blob -> Value # toEncoding :: Blob -> Encoding # toJSONList :: [Blob] -> Value # toEncodingList :: [Blob] -> Encoding #
FromJSON Blob Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Blob # parseJSONList :: Value -> Parser [Blob] #
ToDatum Blob Source #
Instance details Defined in Avers.Types Methods toDatum :: Blob -> Datum #
FromDatum Blob Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Blob #
Pk Blob Source #
Instance details Defined in Avers.Types Methods toPk :: Blob -> Text Source #
type Rep Blob Source #
Instance details Defined in Avers.Types type Rep Blob = D1 ('MetaData "Blob" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "Blob" 'PrefixI 'True) (S1 ('MetaSel ('Just "blobId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlobId) :: (S1 ('MetaSel ('Just "blobSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "blobContentType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

newtype SessionId Source #

SessionId

Constructors

SessionId
Fields unSessionId :: Text

Instances

Instances details

Generic SessionId Source #
Instance details Defined in Avers.Types Associated Types type Rep SessionId :: Type -> Type # Methods from :: SessionId -> Rep SessionId x # to :: Rep SessionId x -> SessionId #
ToJSON SessionId Source #
Instance details Defined in Avers.Types Methods toJSON :: SessionId -> Value # toEncoding :: SessionId -> Encoding # toJSONList :: [SessionId] -> Value # toEncodingList :: [SessionId] -> Encoding #
FromJSON SessionId Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser SessionId # parseJSONList :: Value -> Parser [SessionId] #
ToDatum SessionId Source #
Instance details Defined in Avers.Types Methods toDatum :: SessionId -> Datum #
FromDatum SessionId Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser SessionId #
Pk SessionId Source #
Instance details Defined in Avers.Types Methods toPk :: SessionId -> Text Source #
type Rep SessionId Source #
Instance details Defined in Avers.Types type Rep SessionId = D1 ('MetaData "SessionId" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'True) (C1 ('MetaCons "SessionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Session Source #

The session record that is stored in the database.

A session is a unique identifier attached to a particular object. It contains the creation date and when it was last accessed. If you need to store additional data for a session, we recommend to use cookies.

Constructors

Session
Fields sessionId :: !SessionId sessionObjId :: !ObjId sessionCreatedAt :: !UTCTime sessionLastAccessedAt :: !UTCTime

Instances

Instances details

Generic Session Source #
Instance details Defined in Avers.Types Associated Types type Rep Session :: Type -> Type # Methods from :: Session -> Rep Session x # to :: Rep Session x -> Session #
ToJSON Session Source #
Instance details Defined in Avers.Types Methods toJSON :: Session -> Value # toEncoding :: Session -> Encoding # toJSONList :: [Session] -> Value # toEncodingList :: [Session] -> Encoding #
FromJSON Session Source #
Instance details Defined in Avers.Types Methods parseJSON :: Value -> Parser Session # parseJSONList :: Value -> Parser [Session] #
ToDatum Session Source #
Instance details Defined in Avers.Types Methods toDatum :: Session -> Datum #
FromDatum Session Source #
Instance details Defined in Avers.Types Methods parseDatum :: Datum -> Parser Session #
Pk Session Source #
Instance details Defined in Avers.Types Methods toPk :: Session -> Text Source #
type Rep Session Source #
Instance details Defined in Avers.Types type Rep Session = D1 ('MetaData "Session" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "Session" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SessionId) :: S1 ('MetaSel ('Just "sessionObjId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId)) :: (S1 ('MetaSel ('Just "sessionCreatedAt") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "sessionLastAccessedAt") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime))))

data AversError Source #

Constructors

InternalError !AversError
DatabaseError !Text
PatchError !PatchError
ParseError !Value !Text
UnknownObjectType !Text
ObjectNotFound !ObjId
DocumentNotFound !Text
AversError !Text
NotAuthorized

Instances

Instances details

Show AversError Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> AversError -> ShowS # show :: AversError -> String # showList :: [AversError] -> ShowS #
Generic AversError Source #
Instance details Defined in Avers.Types Associated Types type Rep AversError :: Type -> Type # Methods from :: AversError -> Rep AversError x # to :: Rep AversError x -> AversError #
MonadError AversError Avers Source #
Instance details Defined in Avers.Types Methods throwError :: AversError -> Avers a # catchError :: Avers a -> (AversError -> Avers a) -> Avers a #
type Rep AversError Source #
Instance details Defined in Avers.Types type Rep AversError = D1 ('MetaData "AversError" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (((C1 ('MetaCons "InternalError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AversError)) :+: C1 ('MetaCons "DatabaseError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))) :+: (C1 ('MetaCons "PatchError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PatchError)) :+: C1 ('MetaCons "ParseError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Value) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))) :+: ((C1 ('MetaCons "UnknownObjectType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "ObjectNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjId))) :+: (C1 ('MetaCons "DocumentNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "AversError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "NotAuthorized" 'PrefixI 'False) (U1 :: Type -> Type)))))

internalError :: AversError -> Avers a Source #

internal :: Avers a -> Avers a Source #

databaseError :: Text -> Avers a Source #

patchError :: PatchError -> Avers a Source #

parseError :: MonadError AversError m => Value -> Text -> m a Source #

documentNotFound :: Text -> Avers a Source #

strErr :: String -> Avers a Source #

data ObjectType a Source #

An ObjectType describes a particular type of object that is managed by Avers.

Constructors

ObjectType
Fields otType :: !Text The value of the `type` field of the `Object`. otId :: Avers ObjId Action which generates a new id. This is so that object types can have different strategies how to generate ids. otViews :: [SomeView a]

data SomeObjectType where Source #

Constructors

SomeObjectType :: (ToDatum a, FromDatum a, FromJSON a, ToJSON a) => ObjectType a -> SomeObjectType

parseValueAs :: FromJSON a => ObjectType a -> Value -> Either AversError a Source #

data Config Source #

Configuration of the Avers monad.

Constructors

Config

Fields

databaseURI :: !URI
URI which describes the connection details to the RethinkDB database. The URI *MUST* include at least the hostname (uriRegName) and database name (uriPath without the leading slash). The port (uriPort) and credentials (uriUserInfo) *MAY* be left empty. in that case the default port will be used.
putBlob :: BlobId -> Text -> ByteString -> IO (Either AversError ())
Function which saves the given blob in the blob store. This can be the local filesystem or an external service such as Amazon S3.
objectTypes :: ![SomeObjectType]
All the object types which Avers knows about.
emitMeasurement :: Measurement -> Double -> IO ()
This is called when the internal instrumentation code creates a measurement.

data Change Source #

A change in the system, for example a new object, patch, release, blob etc.

Constructors

CPatch !Patch

A new patch was created.

Instances

Instances details

Show Change Source #
Instance details Defined in Avers.Types Methods showsPrec :: Int -> Change -> ShowS # show :: Change -> String # showList :: [Change] -> ShowS #
Generic Change Source #
Instance details Defined in Avers.Types Associated Types type Rep Change :: Type -> Type # Methods from :: Change -> Rep Change x # to :: Rep Change x -> Change #
ToJSON Change Source #
Instance details Defined in Avers.Types Methods toJSON :: Change -> Value # toEncoding :: Change -> Encoding # toJSONList :: [Change] -> Value # toEncodingList :: [Change] -> Encoding #
type Rep Change Source #
Instance details Defined in Avers.Types type Rep Change = D1 ('MetaData "Change" "Avers.Types" "avers-0.0.17.1-9kdjlsFObHd4VvDcbnYnDM" 'False) (C1 ('MetaCons "CPatch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Patch)))

data Handle Source #

Constructors

Handle

Fields

hConfig :: !Config
A reference to the config, just in case we need it.
hDatabaseHandlePool :: !(Pool Handle)
A pool of handles which are used to access the database.
hRecentRevisionCache :: !(TVar (Map ObjectId RevId))
Map from ObjectId to a recent RevId. It may be the latest or a few revisions behind.
hChanges :: !(TChan Change)
Changes in the system (new patches, objects, releases etc), even those created through other handles, are streamed into this channel. If you want to be informed of those changes, duplicate the channel and read from the copy.

Instances

Instances details

MonadState Handle Avers Source #
Instance details Defined in Avers.Types Methods get :: Avers Handle # put :: Handle -> Avers () # state :: (Handle -> (a, Handle)) -> Avers a #

newtype Avers a Source #

Constructors

Avers
Fields runAvers :: StateT Handle (ExceptT AversError IO) a

Instances

Instances details

Monad Avers Source #
Instance details Defined in Avers.Types Methods (>>=) :: Avers a -> (a -> Avers b) -> Avers b # (>>) :: Avers a -> Avers b -> Avers b # return :: a -> Avers a #
Functor Avers Source #
Instance details Defined in Avers.Types Methods fmap :: (a -> b) -> Avers a -> Avers b # (<$) :: a -> Avers b -> Avers a #
Applicative Avers Source #
Instance details Defined in Avers.Types Methods pure :: a -> Avers a # (<>) :: Avers (a -> b) -> Avers a -> Avers b # liftA2 :: (a -> b -> c) -> Avers a -> Avers b -> Avers c # (>) :: Avers a -> Avers b -> Avers b # (<*) :: Avers a -> Avers b -> Avers a #
MonadIO Avers Source #
Instance details Defined in Avers.Types Methods liftIO :: IO a -> Avers a #
MonadAvers Avers Source #
Instance details Defined in Avers.Types Methods liftAvers :: Avers a -> Avers a Source #
MonadState Handle Avers Source #
Instance details Defined in Avers.Types Methods get :: Avers Handle # put :: Handle -> Avers () # state :: (Handle -> (a, Handle)) -> Avers a #
MonadError AversError Avers Source #
Instance details Defined in Avers.Types Methods throwError :: AversError -> Avers a # catchError :: Avers a -> (AversError -> Avers a) -> Avers a #

class Monad m => MonadAvers m where Source #

Methods

liftAvers :: Avers a -> m a Source #

Instances

Instances details

MonadAvers Avers Source #
Instance details Defined in Avers.Types Methods liftAvers :: Avers a -> Avers a Source #
MonadAvers m => MonadAvers (StateT s m) Source #
Instance details Defined in Avers.Types Methods liftAvers :: Avers a -> StateT s m a Source #

evalAvers :: Handle -> Avers a -> IO (Either AversError a) Source #

data View obj a Source #

Constructors

View

Fields

viewName :: Text
The table name is derived from the view name. Therefore it should be unique amongst all views.
viewParser :: Datum -> Either AversError a
Function which parses objects stored in this view.
viewObjectTransformer :: obj -> Avers (Maybe a)
Function which transforms an Avers Object into a type stored in the view.
viewIndices :: [SomeIndex]
Secondary indices defined on the view.

data SomeView obj where Source #

Constructors

SomeView :: (ToDatum a, FromDatum a, FromJSON obj, ToJSON a) => View obj a -> SomeView obj