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


-- | Execute Graql queries on a Grakn graph
--   
--   A library for building and executing Graql queries on a Grakn
--   knowledge graph.
@package graql
@version 0.1.1

module Graql

-- | A Graql <a>match</a> query that finds a pattern in the graph
data MatchQuery

-- | 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

-- | Create a match query by providing a list of patterns
match :: IsPattern a => [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 :: (IsPattern p, IsVarOrName a) => p -> a -> Pattern

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

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

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

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

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

-- | Specify a property has a resource
has :: (IsPattern p, IsResource a) => p -> Name -> a -> Pattern

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

-- | Create an anonymous variable
var_ :: Pattern

module Graql.Shell

-- | A concept in the graph
data Concept

-- | A result of a match query, binding variables to concepts
type Result = Map Var Concept
cid :: Concept -> Text
ctype :: Concept -> Maybe Name
value :: Concept -> Maybe Value

-- | Run the given file path on the database, ignoring the output
runFile :: FilePath -> IO ()

-- | Run a match query on the graph
runMatch :: MatchQuery -> IO [Result]

-- | Run the CSV migrator using the given csv file, template file and
--   separator
migrateCsv :: FilePath -> FilePath -> String -> IO ()
instance GHC.Show.Show Graql.Shell.Concept
instance Data.Aeson.Types.FromJSON.FromJSON Graql.Shell.Concept