package rdf

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Error handling
Parsing and printing Sparql queries
Executing queries
Predefined functions

package rdf

rdf
- Rdf
  - Acl
    
    Open
    
    from
  - Activitystreams
    
    Open
    
    from
  - Bgp
    
    Make
    
    P
    
    P
    
    S
  - Config
  - Dc
    
    Open
    
    from
  - Doap
    
    Open
    
    from
  - Dot
  - Ds
  - Dt
    
    ValueOrdered
  - Earl
    
    Open
    
    from
  - Foaf
    
    Open
    
    from
  - Graph
    
    Graph
    
    BGP
    
    Make
    
    BGP
    
    S
    
    BGP
    
    Storage
    
    BGP
    
    Storage_BGP
  - Json
  - Lang
  - Ldp
    
    Open
    
    from
  - Loc
  - Log
  - Mem
    
    Mem
    
    BGP
  - Misc
  - Nq
  - Oa
    
    Open
    
    from
  - Owl
    
    Open
    
    from
  - Pim
    
    Open
    
    from
  - Prov
    
    Open
    
    from
  - Rdf_
    
    Open
  - Rdfs
    
    Open
  - Sedlex
  - Sioc
    
    Open
    
    from
  - Solid
    
    Open
    
    from
  - Sparql
  - Sparql_algebra
  - Sparql_eval
    
    GExprMap
    
    GExprOrdered
  - Sparql_expand
  - Sparql_http
    
    Make
    
    P
    
    P
    
    S
  - Sparql_lex
  - Sparql_map
  - Sparql_ms
    
    MuNOrdered
    
    MuOrdered
    
    MuSet
    
    Multimu
  - Sparql_parser
  - Sparql_print
  - Sparql_protocol
  - Sparql_types
    
    OrderedString
    
    VarSet
  - Sparql_vis
  - Stubs
  - Term
    
    Ordered_term
  - Test_manifest
    
    Open
    
    from
  - Time
    
    Open
    
    from
  - Ttl
  - Ttl_lex
  - Ttl_parser
  - Ttl_types
  - Types
    
    Ordered_char
    
    Ordered_string
  - Update
  - Utf8
  - Utils
  - Vcard
    
    Open
    
    from
  - Webacl
  - Xml
rdf.impls
- Impl_cryptokit
- Impl_pcre

Legend:
Library
Module
Module type
Parameter
Class
Class type

Sparql queries.

Error handling

type error =

| Parse_error of Loc.loc * string
| Value_error of Dt.error
| Eval_error of Sparql_eval.error
| Algebra_error of Sparql_algebra.error
| Not_select
| Not_ask
| Not_construct
| Not_describe
| Not_get
| Not_update
| Not_implemented of string

exception Error of error

val string_of_error : error -> string

Parsing and printing Sparql queries

type query = Sparql_types.query

val query_from_string : string -> query

val query_from_file : string -> query

val string_of_query : query -> string

Executing queries

Solutions

type solution

val get_term : solution -> string -> Term.term

get_term solution varname returns the Term.term bound to varname in the solution.

raises Not_found
if the variable is not bound.

val is_bound : solution -> string -> bool

is_bound solution varname returns whether the given variable name is bound in the solution.

val solution_fold : (string -> Term.term -> 'a -> 'a) -> solution -> 'a -> 'a

solution_fold f sol acc is f var1 term1 (f var2 term2 (...) acc), folding over the bindings of the solution.

val solution_iter : (string -> Term.term -> unit) -> solution -> unit

solution_iter f solution calls f on each pair (varname, term) of the solution.

Convenient functions to access solution bindings.

All these functions can raise Dt.Error exceptions in case the term bounded to the variable name is not compatible with the asked type.

The functions are just calls to Dt functions. For example, get_int retrieve the bounded term with get_term, then calls Dt.of_term to get a Dt.value, than calls Dt.int to retrieve an Int n value, then return n.

val get_string : solution -> string -> string

val get_iri : solution -> Iri.t -> string -> Iri.t

See comment of Dt.iri.

val get_int : solution -> string -> int

val get_float : solution -> string -> float

val get_bool : solution -> string -> bool

val get_datetime : solution -> string -> Term.datetime

val get_ltrl : solution -> string -> string * string option

Same as get_string but the associated language tag is kep, if any.

Querying

type query_result =

| Bool of bool
| Solutions of solution list
| Graph of Graph.graph

val execute : 
  ?graph:Graph.graph ->
  base:Iri.t ->
  Ds.dataset ->
  query ->
  query_result

execute ~base dataset q executes the sparql query q on dataset, using base as base iri. The form of the result depends on the kind of query:

Select queries return a Solution solutions
Ask queries return a Bool bool
Construct queries return Graph g.
Describe queries return a description graph.

For Construct and Describe queries, if a graph is provided, it is filled and the same graph is returned; else a new graph (in memory) is created, filled and returned. If the graph is created, it iri is the base iri provided.

Warning: Describe queries are not implemented yet.

raises Error
in case of error.

val execute_update : graph:Graph.graph -> query -> query_result

Convenient functions for querying

val select : base:Iri.t -> Ds.dataset -> query -> solution list

Execute the given SELECT query.

raises Not_select
is the query is not a SELECT.

val construct : 
  ?graph:Graph.graph ->
  base:Iri.t ->
  Ds.dataset ->
  query ->
  Graph.graph

Execute the given CONSTRUCT query.

raises Not_construct
is the query is not a CONSTRUCT.

val ask : base:Iri.t -> Ds.dataset -> query -> bool

Execute the given ASK query.

raises Not_ask
is the query is not a ASK.

val describe : 
  ?graph:Graph.graph ->
  base:Iri.t ->
  Ds.dataset ->
  query ->
  Graph.graph

Execute the given DESCRIBE query.

raises Not_describe
is the query is not a DESCRIBE.

Predefined functions

These are the functions named by an IRI, see details here.

type iri_fun = Dt.value list -> Dt.value

A function takes a list of values and returns a value.

val iri_funs : unit -> iri_fun Iri.Map.t

val add_iri_fun : Iri.t -> iri_fun -> unit