<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Querying</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<link rel="start" href="index.html" title="Redland RDF Application Framework Manual">
<link rel="up" href="pt02.html" title="Part II. Reference Manual">
<link rel="prev" href="redland-parser.html" title="Parsers">
<link rel="next" href="redland-query-results.html" title="Query results">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="redland.html" title="Redland Overview">
<link rel="chapter" href="introduction.html" title="Introduction">
<link rel="part" href="pt01.html" title="Part I. Tutorial">
<link rel="part" href="pt02.html" title="Part II. Reference Manual">
<link rel="chapter" href="objects.html" title="Objects in C">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="redland-parser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pt02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Redland RDF Application Framework Manual</th>
<td><a accesskey="n" href="redland-query-results.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2598322" class="shortcut">Top</a>
 | 
<a href="#id2619363" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="redland-query"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2598322"></a><span class="refentrytitle">Querying</span>
</h2>
<p>Querying — RDF query languages and execution.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
typedef <a href="redland-query.html#librdf-query">librdf_query</a>;
typedef <a href="redland-query.html#librdf-query-factory">librdf_query_factory</a>;
void <a href="redland-query.html#librdf-query-register-factory">librdf_query_register_factory</a> (<a href="redland-world.html#librdf-world">librdf_world</a> *world,
const char *name,
unsigned char *uri_string,
void (*factory) (librdf_query_factory*));
<a href="redland-query.html#librdf-query">librdf_query</a>* <a href="redland-query.html#librdf-new-query">librdf_new_query</a> (<a href="redland-world.html#librdf-world">librdf_world</a> *world,
const char *name,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *uri,
unsigned char *query_string,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *base_uri);
<a href="redland-query.html#librdf-query">librdf_query</a>* <a href="redland-query.html#librdf-new-query-from-query">librdf_new_query_from_query</a> (<a href="redland-query.html#librdf-query">librdf_query</a> *old_query);
<a href="redland-query.html#librdf-query">librdf_query</a>* <a href="redland-query.html#librdf-new-query-from-factory">librdf_new_query_from_factory</a> (<a href="redland-world.html#librdf-world">librdf_world</a> *world,
<a href="redland-query.html#librdf-query-factory">librdf_query_factory</a> *factory,
const char *name,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *uri,
unsigned char *query_string,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *base_uri);
void <a href="redland-query.html#librdf-free-query">librdf_free_query</a> (<a href="redland-query.html#librdf-query">librdf_query</a> *query);
<a href="redland-query-results.html#librdf-query-results">librdf_query_results</a>* <a href="redland-query.html#librdf-query-execute">librdf_query_execute</a> (<a href="redland-query.html#librdf-query">librdf_query</a> *query,
<a href="redland-model.html#librdf-model">librdf_model</a> *model);
int <a href="redland-query.html#librdf-query-get-limit">librdf_query_get_limit</a> (<a href="redland-query.html#librdf-query">librdf_query</a> *query);
int <a href="redland-query.html#librdf-query-set-limit">librdf_query_set_limit</a> (<a href="redland-query.html#librdf-query">librdf_query</a> *query,
int limit);
int <a href="redland-query.html#librdf-query-get-offset">librdf_query_get_offset</a> (<a href="redland-query.html#librdf-query">librdf_query</a> *query);
int <a href="redland-query.html#librdf-query-set-offset">librdf_query_set_offset</a> (<a href="redland-query.html#librdf-query">librdf_query</a> *query,
int offset);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2619363"></a><h2>Description</h2>
<p>
Provides classes to create query objects and to execute them over
an RDF graph (<a href="redland-model.html#librdf-model"><span class="type">librdf_model</span></a>) returning a <a href="redland-query-results.html#librdf-query-results"><span class="type">librdf_query_results</span></a>
Query result limits and offsets can be set.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2619394"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2623243"></a><h3>
<a name="librdf-query"></a>librdf_query</h3>
<a class="indexterm" name="id2623256"></a><pre class="programlisting">typedef struct librdf_query_s librdf_query;
</pre>
<p>
Redland query class.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623276"></a><h3>
<a name="librdf-query-factory"></a>librdf_query_factory</h3>
<a class="indexterm" name="id2623287"></a><pre class="programlisting">typedef struct librdf_query_factory_s librdf_query_factory;
</pre>
<p>
Redland query factory class.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623306"></a><h3>
<a name="librdf-query-register-factory"></a>librdf_query_register_factory ()</h3>
<a class="indexterm" name="id2623318"></a><pre class="programlisting">void librdf_query_register_factory (<a href="redland-world.html#librdf-world">librdf_world</a> *world,
const char *name,
unsigned char *uri_string,
void (*factory) (librdf_query_factory*));</pre>
<p>
Register a query factory.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>world</code></em> :</span></td>
<td> redland world object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the query language name
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>uri_string</code></em> :</span></td>
<td> the query language URI string (or NULL if none)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>factory</code></em> :</span></td>
<td> pointer to function to call to register the factory
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623430"></a><h3>
<a name="librdf-new-query"></a>librdf_new_query ()</h3>
<a class="indexterm" name="id2623443"></a><pre class="programlisting"><a href="redland-query.html#librdf-query">librdf_query</a>* librdf_new_query (<a href="redland-world.html#librdf-world">librdf_world</a> *world,
const char *name,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *uri,
unsigned char *query_string,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *base_uri);</pre>
<p>
Constructor - create a new <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>world</code></em> :</span></td>
<td> redland world object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name identifying the query language
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
<td> the URI identifying the query language (or NULL)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>query_string</code></em> :</span></td>
<td> the query string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></td>
<td> the base URI of the query string (or NULL)
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object or NULL on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617677"></a><h3>
<a name="librdf-new-query-from-query"></a>librdf_new_query_from_query ()</h3>
<a class="indexterm" name="id2617688"></a><pre class="programlisting"><a href="redland-query.html#librdf-query">librdf_query</a>* librdf_new_query_from_query (<a href="redland-query.html#librdf-query">librdf_query</a> *old_query);</pre>
<p>
Should create a new query in the same context as the existing one
as appropriate.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>old_query</code></em> :</span></td>
<td> the existing query <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> to use
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object or NULL on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617763"></a><h3>
<a name="librdf-new-query-from-factory"></a>librdf_new_query_from_factory ()</h3>
<a class="indexterm" name="id2617775"></a><pre class="programlisting"><a href="redland-query.html#librdf-query">librdf_query</a>* librdf_new_query_from_factory (<a href="redland-world.html#librdf-world">librdf_world</a> *world,
<a href="redland-query.html#librdf-query-factory">librdf_query_factory</a> *factory,
const char *name,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *uri,
unsigned char *query_string,
<a href="redland-uri.html#librdf-uri">librdf_uri</a> *base_uri);</pre>
<p>
Constructor - create a new <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>world</code></em> :</span></td>
<td> redland world object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>factory</code></em> :</span></td>
<td> the factory to use to construct the query
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> query language name
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
<td> query language URI (or NULL)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>query_string</code></em> :</span></td>
<td> the query string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></td>
<td> base URI of the query string (or NULL)
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object or NULL on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617954"></a><h3>
<a name="librdf-free-query"></a>librdf_free_query ()</h3>
<a class="indexterm" name="id2617967"></a><pre class="programlisting">void librdf_free_query (<a href="redland-query.html#librdf-query">librdf_query</a> *query);</pre>
<p>
Destructor - destroy a <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>query</code></em> :</span></td>
<td> <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618030"></a><h3>
<a name="librdf-query-execute"></a>librdf_query_execute ()</h3>
<a class="indexterm" name="id2618042"></a><pre class="programlisting"><a href="redland-query-results.html#librdf-query-results">librdf_query_results</a>* librdf_query_execute (<a href="redland-query.html#librdf-query">librdf_query</a> *query,
<a href="redland-model.html#librdf-model">librdf_model</a> *model);</pre>
<p>
Run the query on a model.
</p>
<p>
Runs the query against the (previously registered) model
and returns a <a href="redland-query-results.html#librdf-query-results"><span class="type">librdf_query_results</span></a> for the result objects.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>query</code></em> :</span></td>
<td> <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>model</code></em> :</span></td>
<td> model to operate query on
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a href="redland-query-results.html#librdf-query-results"><span class="type">librdf_query_results</span></a> or NULL on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618146"></a><h3>
<a name="librdf-query-get-limit"></a>librdf_query_get_limit ()</h3>
<a class="indexterm" name="id2618157"></a><pre class="programlisting">int librdf_query_get_limit (<a href="redland-query.html#librdf-query">librdf_query</a> *query);</pre>
<p>
Get the query-specified limit on results.
</p>
<p>
This is the limit given in the query on the number of results allowed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>query</code></em> :</span></td>
<td> <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> query object
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> integer >=0 if a limit is given, otherwise <0
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618451"></a><h3>
<a name="librdf-query-set-limit"></a>librdf_query_set_limit ()</h3>
<a class="indexterm" name="id2618462"></a><pre class="programlisting">int librdf_query_set_limit (<a href="redland-query.html#librdf-query">librdf_query</a> *query,
int limit);</pre>
<p>
Set the query-specified limit on results.
</p>
<p>
This is the limit given in the query on the number of results allowed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>query</code></em> :</span></td>
<td> <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> query object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>limit</code></em> :</span></td>
<td> the limit on results, >=0 to set a limit, <0 to have no limit
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> non-0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618557"></a><h3>
<a name="librdf-query-get-offset"></a>librdf_query_get_offset ()</h3>
<a class="indexterm" name="id2618568"></a><pre class="programlisting">int librdf_query_get_offset (<a href="redland-query.html#librdf-query">librdf_query</a> *query);</pre>
<p>
Get the query-specified offset on results.
</p>
<p>
This is the offset given in the query on the number of results allowed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>query</code></em> :</span></td>
<td> <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> query object
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> integer >=0 if a offset is given, otherwise <0
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618642"></a><h3>
<a name="librdf-query-set-offset"></a>librdf_query_set_offset ()</h3>
<a class="indexterm" name="id2618653"></a><pre class="programlisting">int librdf_query_set_offset (<a href="redland-query.html#librdf-query">librdf_query</a> *query,
int offset);</pre>
<p>
Set the query-specified offset on results.
</p>
<p>
This is the offset given in the query on the number of results allowed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>query</code></em> :</span></td>
<td> <a href="redland-query.html#librdf-query"><span class="type">librdf_query</span></a> query object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> offset for results, >=0 to set an offset, <0 to have no offset
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> non-0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>