Rasqal RDF Query Library API Reference Manual

Dave Beckett

University of Bristol
Institute for Learning and Research Technology (ILRT)

Table of Contents
Introduction to Objects in C
Rasqal General
Rasqal General
rasqal_get_query_engine_factory --  Get a query factory by name
rasqal_languages_enumerate --  Get information on query languages
rasqal_escaped_name_to_utf8_string --  get a UTF-8 and/or \u-escaped name as UTF-8
Rasqal Query
RDF Query Class
rasqal_new_query --  Constructor - create a new rasqal_query object
rasqal_free_query --  destructor - destroy a rasqal_query object
rasqal_query_get_name --  Return the short name for the query
rasqal_query_get_label --  Return a readable label for the query
rasqal_query_set_fatal_error_handler --  Set the query error handling function
rasqal_query_set_error_handler --  Set the query error handling function
rasqal_query_set_warning_handler --  Set the query warning handling function
rasqal_query_set_feature --  Set various query features
rasqal_query_add_source --  Add a source URI to the query
rasqal_query_get_source_sequence --  Get the sequence of source URIs
rasqal_query_get_source --  Get a source URI in the sequence of sources
rasqal_query_add_variable --  Add a binding variable to the query
rasqal_query_get_variable_sequence --  Get the sequence of variables to bind in the query
rasqal_query_get_variable --  Get a variable in the sequence of variables to bind
rasqal_query_has_variable --  Find if the named variable is in the sequence of variables to bind
rasqal_query_set_variable --  Add a binding variable to the query
rasqal_query_add_triple --  Add a matching triple to the query
rasqal_query_get_triple_sequence --  Get the sequence of matching triples in the query
rasqal_query_get_triple --  Get a triple in the sequence of matching triples in the query
rasqal_query_add_constraint --  Add a constraint expression to the query
rasqal_query_get_constraint_sequence --  Get the sequence of constraints expressions in the query
rasqal_query_get_constraint --  Get a constraint in the sequence of constraint expressions in the query
rasqal_query_add_prefix --  Add a namespace prefix to the query
rasqal_query_get_prefix_sequence --  Get the sequence of namespace prefixes in the query
rasqal_query_get_prefix --  Get a prefix in the sequence of namespsace prefixes in the query
rasqal_query_prepare --  typically parse it
rasqal_query_execute --  Excute a query - run and return results
rasqal_query_print --  Print a query in a debug format
rasqal_free_query_results --  destructor - destroy a rasqal_query_results
rasqal_query_results_is_bindings --  test if rasqal_query_results is variable bindings format
rasqal_query_results_is_boolean --  test if rasqal_query_results is boolean format
rasqal_query_results_is_graph --  test if rasqal_query_results is RDF graph format
rasqal_query_results_get_count --  Get number of bindings so far
rasqal_query_results_next --  Move to the next result
rasqal_query_results_finished --  Find out if binding results are exhausted
rasqal_query_results_get_bindings --  Get all binding names, values for current result
rasqal_query_results_get_binding_value --  Get one binding value for the current result
rasqal_query_results_get_binding_name --  Get binding name for the current result
rasqal_query_results_get_binding_value_by_name --  Get one binding value for a given name in the current result
rasqal_query_results_get_bindings_count --  Get the number of bound variables in the result
rasqal_query_get_user_data --  Get query user data
rasqal_query_set_user_data --  Set the query user data
rasqal_query_results_write --  Write the query results to an iostream in a format
rasqal_query_results_get_triple --  Get the current triple in the result
rasqal_query_results_next_triple --  Move to the next triple result
rasqal_query_results_get_boolean --  Get boolean query result
Rasqal Literals, Variables, Triples, Prefixes
RDF Query Literals
rasqal_new_integer_literal --  Constructor - Create a new Rasqal integer literal
rasqal_new_floating_literal --  Constructor - Create a new Rasqal floating literal
rasqal_new_uri_literal --  Constructor - Create a new Rasqal URI literal from a raptor URI
rasqal_new_pattern_literal --  Constructor - Create a new Rasqal pattern literal
rasqal_new_string_literal --  Constructor - Create a new Rasqal string literal
rasqal_new_simple_literal --  Constructor - Create a new Rasqal simple literal
rasqal_new_boolean_literal --  Constructor - Create a new Rasqal boolean literal
rasqal_new_variable_literal --  Constructor - Create a new Rasqal variable literal
rasqal_new_literal_from_literal --  Copy Constructor - create a new rasqal_literal object from an existing rasqal_literal object
rasqal_free_literal --  Destructor - destroy an rasqal_literal object
rasqal_literal_print --  Print a Rasqal literal in a debug format
rasqal_literal_as_string --  Return the string format of a literal
rasqal_literal_as_variable --  Get the variable inside a literal
rasqal_literal_compare --  Compare two literals with type promotion
rasqal_literal_equals --  Compare two literals with no type promotion
rasqal_literal_as_node --  Turn a literal into a new RDF string, URI or blank literal
RDF Query Expression, Variable, Triple, Prefix Classes
rasqal_new_variable --  Constructor - Create a new Rasqal variable
rasqal_free_variable --  Destructor - Destroy a Rasqal variable object
rasqal_variable_print --  Print a Rasqal variable in a debug format
rasqal_variable_set_value --  Set the value of a Rasqal variable