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


-- | A Haskell client for Grakn
--   
--   See README.md
@package grakn
@version 0.3.0

module Grakn

-- | A Graql <a>match</a> part that finds a pattern in the knowledge base
data Match
data GetQuery
data Client
Client :: BaseUrl -> String -> Client
[url] :: Client -> BaseUrl
[keyspace] :: Client -> String
data GraknError

-- | A result of a query
data Result
AnswersResult :: [Map Var Concept] -> Result
AnswerResult :: (Map Var Concept) -> Result
DeleteResult :: Result
AskResult :: Bool -> Result
CountResult :: Integer -> Result
data Options
Options :: Bool -> Options
[infer] :: Options -> Bool

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

-- | A label of something in the knowledge base
data Label

-- | 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 => Client -> q -> ExecuteResponse
execute_ :: IsQuery q => Options -> Client -> q -> ExecuteResponse

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

-- | Get variables from a match, intended to be used infix
get :: [Var] -> Match -> GetQuery

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

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

-- | Create a label of something in the knowledge base
label :: Text -> Label

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

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

-- | A casting in a relation between a role type and a role player
(.:) :: Convert a VarOrLabel => 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 -> Label -> a -> Pattern

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

-- | Create an anonymous variable
var_ :: Pattern