-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A Haskell client for <http://grakn.ai Grakn>
--   
--   A Haskell client for <a>Grakn</a>
@package grakn
@version 0.2.0

module Grakn

-- | A Graql <a>match</a> query that finds a pattern in the graph
data MatchQuery
data Graph
Graph :: BaseUrl -> String -> Graph
[url] :: Graph -> BaseUrl
[keyspace] :: Graph -> String
data GraknError

-- | A result of a match query, binding variables to concepts
data Result
MatchResult :: [Map Var Concept] -> Result
InsertResult :: [Text] -> Result
AskResult :: Bool -> Result
CountResult :: Integer -> Result
DeleteResult :: Result

-- | A variable name wildcard that will represent a concept in the results
data Var

-- | A name of something in the graph
data Name

-- | A value of a resource
data Value
ValueString :: Text -> Value
ValueNumber :: Scientific -> Value
ValueBool :: Bool -> Value

-- | The default Grakn URL, accessing localhost
defaultUrl :: BaseUrl

-- | The default Grakn keyspace
defaultKeyspace :: String
execute :: IsQuery q => Graph -> q -> IO (Either ServantError Result)

-- | Create a match query by providing a list of patterns
match :: Convert a Pattern => [a] -> MatchQuery

-- | Select variables from a match query, intended to be used infix
select :: [Var] -> MatchQuery -> MatchQuery

-- | Retrieve only distinct results from a match query
distinct :: MatchQuery -> MatchQuery

-- | Limit a match query, intended to be used infix
limit :: Integer -> MatchQuery -> MatchQuery

-- | Create a variable
var :: Text -> Var

-- | Create a name of something in the graph
name :: Text -> Name

-- | Specify a property has a particular type
isa :: (Convert p Pattern, Convert a VarOrName) => p -> a -> Pattern

-- | Specify a property has a particular type
(-:) :: (Convert p Pattern, Convert a VarOrName) => p -> a -> Pattern

-- | A casting in a relation between a role type and a role player
(.:) :: Convert a VarOrName => a -> Var -> RolePlayer

-- | A casting in a relation without a role type
rp :: Var -> RolePlayer

-- | Specify a property is a relation between other variables
(<:) :: (Convert p Pattern, Convert a RolePlayer) => p -> [a] -> Pattern

-- | Shorthand to define a relation
rel :: Convert a RolePlayer => [a] -> Pattern

-- | Specify a property has a resource
has :: (Convert p Pattern, Convert a (Either Value Var)) => p -> Name -> a -> Pattern

-- | Specify a property has a resource
hasText :: (Convert p Pattern) => p -> Name -> Text -> Pattern

-- | Create an anonymous variable
var_ :: Pattern