Database.Bolt.Extras

Documentation

data Condition a

Conditional expressions over type a and its mappings. Supported operations:

• equality check :==
• disunction :&&
• conjunction :||

Typical usage:

Say we have variable var :: a, a function f :: a -> b and a value val :: b. Expression f :== val acts as f var == val.

Examples:

data D = D { fld1 :: Int
           , fld2 :: String
           , fld3 :: Double
           }

d = D 42 "noononno" 1.618
d `matches` (fld1 :== 12 :&& fld2 :== "abc")
False

d `matches` (fld1 :== 42 :|| fld3 == 1.0)
True

Constructors

forall b.Eq b => (a -> b) :== b infix 4

(Condition a) :&& (Condition a) infixr 3

(Condition a) :|| (Condition a) infixr 2

tautology :: Condition a

Matching tautology will always succeed.

whatever `matches` tautology == True

Match is lazy:

undefined `matches` tautology == True

matches :: a -> Condition a -> Bool

Check whether data satisfies conditions on it.

itself :: a -> a

Object itself instead of its mappings is matched with help of this alias.

42 `matches` (itself :== 42) == True
42 `matches` (itself :== 41) == False

type BoltId = Int

BoltId is alias for Bolt Node, Relationship and URelationship identities.

data Persisted a

Persisted is wrapper for some object that can be identified with BoltId.

Constructors

Persisted

Fields

• objectId :: BoltId
• objectValue :: a

Instances

Functor Persisted

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

fmap :: (a -> b) -> Persisted a -> Persisted b

(<$) :: a -> Persisted b -> Persisted a

FromJSON a => FromJSON (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

parseJSON :: Value -> Parser (Persisted a)

parseJSONList :: Value -> Parser [Persisted a]

ToJSON a => ToJSON (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

toJSON :: Persisted a -> Value

toEncoding :: Persisted a -> Encoding

toJSONList :: [Persisted a] -> Value

toEncodingList :: [Persisted a] -> Encoding

Generic (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Associated Types

type Rep (Persisted a) :: Type -> Type

Methods

from :: Persisted a -> Rep (Persisted a) x

to :: Rep (Persisted a) x -> Persisted a

Read a => Read (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

readsPrec :: Int -> ReadS (Persisted a)

readList :: ReadS [Persisted a]

readPrec :: ReadPrec (Persisted a)

readListPrec :: ReadPrec [Persisted a]

Show a => Show (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

showsPrec :: Int -> Persisted a -> ShowS

show :: Persisted a -> String

showList :: [Persisted a] -> ShowS

Eq a => Eq (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

(==) :: Persisted a -> Persisted a -> Bool

(/=) :: Persisted a -> Persisted a -> Bool

Ord a => Ord (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

compare :: Persisted a -> Persisted a -> Ordering

(<) :: Persisted a -> Persisted a -> Bool

(<=) :: Persisted a -> Persisted a -> Bool

(>) :: Persisted a -> Persisted a -> Bool

(>=) :: Persisted a -> Persisted a -> Bool

max :: Persisted a -> Persisted a -> Persisted a

min :: Persisted a -> Persisted a -> Persisted a

GetBoltId (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

getBoltId :: Persisted a -> BoltId

type Rep (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

type Rep (Persisted a) = D1 ('MetaData "Persisted" "Database.Bolt.Extras.Internal.Persisted" "hasbolt-extras-0.0.2.0-LlsBPfU8Ggs1Zvm48yF6Qb" 'False) (C1 ('MetaCons "Persisted" 'PrefixI 'True) (S1 ('MetaSel ('Just "objectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BoltId) :*: S1 ('MetaSel ('Just "objectValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

class GetBoltId a where

Common class to get BoltId from the object.

Methods

getBoltId :: a -> BoltId

Instances

GetBoltId Node

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

getBoltId :: Node -> BoltId

GetBoltId Relationship

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

getBoltId :: Relationship -> BoltId

GetBoltId URelationship

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

getBoltId :: URelationship -> BoltId

GetBoltId NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

getBoltId :: NodeResult -> BoltId

GetBoltId RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

getBoltId :: RelResult -> BoltId

GetBoltId (Persisted a)

Defined in Database.Bolt.Extras.Internal.Persisted

Methods

getBoltId :: Persisted a -> BoltId

fromInt :: Int -> BoltId

This is just check that your BoltId is valid.

class ToCypher a where

The class for convertation into Cypher.

Methods

toCypher :: HasCallStack => a -> Text

Instances

ToCypher Value

Convertation for Value into Cypher.

Defined in Database.Bolt.Extras.Internal.Cypher

Methods

toCypher :: Value -> Text

ToCypher Cond

Defined in Database.Bolt.Extras.DSL.Internal.Instances

Methods

toCypher :: Cond -> Text

ToCypher Conds

Defined in Database.Bolt.Extras.DSL.Internal.Instances

Methods

toCypher :: Conds -> Text

ToCypher NodeSelector

Defined in Database.Bolt.Extras.DSL.Internal.Instances

Methods

toCypher :: NodeSelector -> Text

ToCypher PathSelector

Defined in Database.Bolt.Extras.DSL.Internal.Instances

Methods

toCypher :: PathSelector -> Text

ToCypher RelSelector

Defined in Database.Bolt.Extras.DSL.Internal.Instances

Methods

toCypher :: RelSelector -> Text

ToCypher Selector

Defined in Database.Bolt.Extras.DSL.Internal.Instances

Methods

toCypher :: Selector -> Text

ToCypher Selectors

Defined in Database.Bolt.Extras.DSL.Internal.Instances

Methods

toCypher :: Selectors -> Text

ToCypher Label

Label with name are formatted into :name

Defined in Database.Bolt.Extras.Internal.Cypher

Methods

toCypher :: Label -> Text

ToCypher Property

Converts property with name and value to name:value.

Defined in Database.Bolt.Extras.Internal.Cypher

Methods

toCypher :: Property -> Text

ToCypher [Label]

Several labels are formatted with concatenation.

Defined in Database.Bolt.Extras.Internal.Cypher

Methods

toCypher :: [Label] -> Text

ToCypher [Property]

Several properties are formatted with concatenation.

Defined in Database.Bolt.Extras.Internal.Cypher

Methods

toCypher :: [Property] -> Text

ToCypher [(Text, Text)]

Defined in Database.Bolt.Extras.Internal.Cypher

Methods

toCypher :: [(Text, Text)] -> Text

ToCypher (Text, Text)

Defined in Database.Bolt.Extras.Internal.Cypher

Methods

toCypher :: (Text, Text) -> Text

class FromValue a where

FromValue means that something can be converted from Bolt Value.

Methods

fromValue :: HasCallStack => Value -> a

Instances

FromValue Structure

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Structure

FromValue Value

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Value

FromValue Text

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Text

FromValue ()

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> ()

FromValue Bool

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Bool

FromValue Double

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Double

FromValue Float

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Float

FromValue Int

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Int

FromValue a => FromValue (NonEmpty a)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> NonEmpty a

FromValue a => FromValue (Maybe a)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Maybe a

FromValue a => FromValue [a]

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> [a]

FromValue (Map Text Value)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

fromValue :: Value -> Map Text Value

type Label = Text

Alias for Neo4j label.

class Labels a where

Labels means that labels can be obtained from entity.

Methods

getLabels :: HasCallStack => a -> [Label]

Instances

Labels Node

Defined in Database.Bolt.Extras.Internal.Types

Methods

getLabels :: Node -> [Label]

Labels URelationship

Defined in Database.Bolt.Extras.Internal.Types

Methods

getLabels :: URelationship -> [Label]

class NodeLike a where

NodeLike class represents convertable into and from Node.

Methods

toNode :: HasCallStack => a -> Node

fromNode :: HasCallStack => Node -> a

Instances

NodeLike Node

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toNode :: Node -> Node

fromNode :: Node -> Node

NodeLike NodeResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

toNode :: NodeResult -> Node

fromNode :: Node -> NodeResult

class Properties a where

Properties means that properties can be obtained from entity.

Methods

getProps :: HasCallStack => a -> Map Text Value

Instances

Properties Node

Defined in Database.Bolt.Extras.Internal.Types

Methods

getProps :: Node -> Map Text Value

Properties URelationship

Defined in Database.Bolt.Extras.Internal.Types

Methods

getProps :: URelationship -> Map Text Value

type Property = (Text, Value)

Alias for Neo4j property.

class ToValue a where

ToValue means that something can be converted into Bolt Value.

Methods

toValue :: HasCallStack => a -> Value

Instances

ToValue Structure

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Structure -> Value

ToValue Value

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Value -> Value

ToValue Text

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Text -> Value

ToValue ()

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: () -> Value

ToValue Bool

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Bool -> Value

ToValue Double

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Double -> Value

ToValue Float

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Float -> Value

ToValue Int

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Int -> Value

ToValue a => ToValue (NonEmpty a)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: NonEmpty a -> Value

ToValue a => ToValue (Maybe a)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Maybe a -> Value

ToValue a => ToValue [a]

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: [a] -> Value

ToValue (Map Text Value)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: Map Text Value -> Value

class URelationLike a where

URelationLike class represents convertable into and from URelationship.

Methods

toURelation :: HasCallStack => a -> URelationship

fromURelation :: HasCallStack => URelationship -> a

Instances

URelationLike RelResult

Defined in Database.Bolt.Extras.Graph.Internal.Get

Methods

toURelation :: RelResult -> URelationship

fromURelation :: URelationship -> RelResult

newtype ToIsValue a

ToIsValue provides IsValue instance given ToValue

Constructors

ToIsValue a

Instances

ToValue a => IsValue (ToIsValue a)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: ToIsValue a -> Value

toValueList :: [ToIsValue a] -> Value

newtype NodeLikeProps a

NodeLikeProps provides IsValue instance given NodeLike, in form of Map Text Value

Constructors

NodeLikeProps a

Instances

NodeLike a => IsValue (NodeLikeProps a)

Defined in Database.Bolt.Extras.Internal.Instances

Methods

toValue :: NodeLikeProps a -> Value

toValueList :: [NodeLikeProps a] -> Value