| Tracker SPARQL Library Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
enum TrackerSparqlError; TrackerSparqlConnection; TrackerSparqlConnection* tracker_sparql_connection_get (GError **error); TrackerSparqlConnection* tracker_sparql_connection_get_direct (GError **error); TrackerSparqlCursor* tracker_sparql_connection_query (TrackerSparqlConnection *self,const char *sparql,GCancellable *cancellable,GError **error); void tracker_sparql_connection_query_async (TrackerSparqlConnection *self,const char *sparql,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_); TrackerSparqlCursor* tracker_sparql_connection_query_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error); void tracker_sparql_connection_update (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GError **error); void tracker_sparql_connection_update_async (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_); void tracker_sparql_connection_update_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error); GVariant* tracker_sparql_connection_update_blank (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GError **error); void tracker_sparql_connection_update_blank_async (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_); GVariant* tracker_sparql_connection_update_blank_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error); void tracker_sparql_connection_load (TrackerSparqlConnection *self,GFile *file,GCancellable *cancellable,GError **error); void tracker_sparql_connection_load_async (TrackerSparqlConnection *self,GFile *file,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_); void tracker_sparql_connection_load_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error); TrackerSparqlCursor* tracker_sparql_connection_statistics (TrackerSparqlConnection *self,GCancellable *cancellable,GError **error); void tracker_sparql_connection_statistics_async (TrackerSparqlConnection *self,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_); TrackerSparqlCursor* tracker_sparql_connection_statistics_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error);
typedef enum {
TRACKER_SPARQL_ERROR_PARSE,
TRACKER_SPARQL_ERROR_UNKNOWN_CLASS,
TRACKER_SPARQL_ERROR_UNKNOWN_PROPERTY,
TRACKER_SPARQL_ERROR_TYPE,
TRACKER_SPARQL_ERROR_CONSTRAINT,
TRACKER_SPARQL_ERROR_NO_SPACE,
TRACKER_SPARQL_ERROR_INTERNAL,
TRACKER_SPARQL_ERROR_UNSUPPORTED
} TrackerSparqlError;
typedef struct _TrackerSparqlConnection TrackerSparqlConnection;
The TrackerSparqlConnection object represents a connection with the Tracker Store.
TrackerSparqlConnection* tracker_sparql_connection_get (GError **error);
Returns a new TrackerSparqlConnection, which will use the best method available to connect to the Tracker Store (direct-access for Read-Only queries, and D-Bus otherwise).
|
GError for error reporting. |
Returns : |
a new TrackerSparqlConnection. Call g_object_unref() on the
object when no longer used.
|
TrackerSparqlConnection* tracker_sparql_connection_get_direct
(GError **error);
Returns a new TrackerSparqlConnection, which uses direct-access method to connect to the Tracker Store. Note that this connection will only be able to perform Read-Only queries in the store.
|
GError for error reporting. |
Returns : |
a new TrackerSparqlConnection. Call g_object_unref() on the
object when no longer used.
|
TrackerSparqlCursor* tracker_sparql_connection_query (TrackerSparqlConnection *self,const char *sparql,GCancellable *cancellable,GError **error);
Executes a SPARQL query on the store. The API call is completely synchronous, so it may block.
|
a TrackerSparqlConnection |
|
string containing the SPARQL query |
|
a GCancellable used to cancel the operation |
|
GError for error reporting. |
Returns : |
a TrackerSparqlCursor if results were found, NULL otherwise.
On error, NULL is returned and the error is set accordingly.
Call g_object_unref() on the returned cursor when no longer needed.
|
void tracker_sparql_connection_query_async (TrackerSparqlConnection *self,const char *sparql,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_);
Executes asynchronously a SPARQL query on the store.
|
a TrackerSparqlConnection |
|
string containing the SPARQL query |
|
a GCancellable used to cancel the operation |
|
user-defined GAsyncReadyCallback to be called when asynchronous operation is finished. |
|
user-defined data to be passed to _callback_
|
TrackerSparqlCursor* tracker_sparql_connection_query_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error);
|
|
|
|
|
|
Returns : |
void tracker_sparql_connection_update (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GError **error);
Executes a SPARQL update on the store. The API call is completely synchronous, so it may block.
|
a TrackerSparqlConnection |
|
string containing the SPARQL update query |
|
the priority for the operation |
|
a GCancellable used to cancel the operation |
|
GError for error reporting. |
void tracker_sparql_connection_update_async (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_);
Executes asynchronously a SPARQL update on the store.
|
a TrackerSparqlConnection |
|
string containing the SPARQL update query |
|
the priority for the asynchronous operation |
|
a GCancellable used to cancel the operation |
|
user-defined GAsyncReadyCallback to be called when asynchronous operation is finished. |
|
user-defined data to be passed to _callback_
|
void tracker_sparql_connection_update_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error);
Finishes the asynchronous SPARQL update operation.
|
a TrackerSparqlConnection |
|
a GAsyncResult with the result of the operation |
|
GError for error reporting. |
GVariant* tracker_sparql_connection_update_blank (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GError **error);
Executes a SPARQL update on the store, and returns the URNs of the generated nodes, if any. The API call is completely synchronous, so it may block.
|
a TrackerSparqlConnection |
|
string containing the SPARQL update query |
|
the priority for the operation |
|
a GCancellable used to cancel the operation |
|
GError for error reporting. |
Returns : |
a GVariant with the generated URNs, which should be freed with
g_variant_unref() when no longer used.
|
void tracker_sparql_connection_update_blank_async (TrackerSparqlConnection *self,const char *sparql,gint priority,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_);
Executes asynchronously a SPARQL update on the store.
|
a TrackerSparqlConnection |
|
string containing the SPARQL update query |
|
the priority for the asynchronous operation |
|
a GCancellable used to cancel the operation |
|
user-defined GAsyncReadyCallback to be called when asynchronous operation is finished. |
|
user-defined data to be passed to _callback_
|
GVariant* tracker_sparql_connection_update_blank_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error);
Finishes the asynchronous SPARQL update operation, and returns the URNs of the generated nodes, if any.
|
a TrackerSparqlConnection |
|
a GAsyncResult with the result of the operation |
|
GError for error reporting. |
Returns : |
a GVariant with the generated URNs, which should be freed with
g_variant_unref() when no longer used.
|
void tracker_sparql_connection_load (TrackerSparqlConnection *self,GFile *file,GCancellable *cancellable,GError **error);
Loads a Turtle file (TTL) into the store. The API call is completely synchronous, so it may block.
|
a TrackerSparqlConnection |
|
a GFile |
|
a GCancellable used to cancel the operation |
|
GError for error reporting. |
void tracker_sparql_connection_load_async (TrackerSparqlConnection *self,GFile *file,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_);
Loads, asynchronously, a Turtle file (TTL) into the store.
|
a TrackerSparqlConnection |
|
a GFile |
|
a GCancellable used to cancel the operation |
|
user-defined GAsyncReadyCallback to be called when asynchronous operation is finished. |
|
user-defined data to be passed to _callback_
|
void tracker_sparql_connection_load_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error);
Finishes the asynchronous load of the Turtle file.
|
a TrackerSparqlConnection |
|
a GAsyncResult with the result of the operation |
|
GError for error reporting. |
TrackerSparqlCursor* tracker_sparql_connection_statistics (TrackerSparqlConnection *self,GCancellable *cancellable,GError **error);
Retrieves the statistics from the Store. The API call is completely synchronous, so it may block.
|
a TrackerSparqlConnection |
|
a GCancellable used to cancel the operation |
|
GError for error reporting. |
Returns : |
a TrackerSparqlCursor to iterate the reply if successful, NULL
on error. Call g_object_unref() on the returned cursor when no longer
needed.
|
void tracker_sparql_connection_statistics_async (TrackerSparqlConnection *self,GCancellable *cancellable,GAsyncReadyCallback _callback_,gpointer _user_data_);
Retrieves, asynchronously, the statistics from the Store.
|
a TrackerSparqlConnection |
|
a GCancellable used to cancel the operation |
|
user-defined GAsyncReadyCallback to be called when asynchronous operation is finished. |
|
user-defined data to be passed to _callback_
|
TrackerSparqlCursor* tracker_sparql_connection_statistics_finish (TrackerSparqlConnection *self,GAsyncResult *_res_,GError **error);
Finishes the asynchronous retrieval of statistics from the Store.
|
a TrackerSparqlConnection |
|
a GAsyncResult with the result of the operation |
|
GError for error reporting. |
Returns : |
a TrackerSparqlCursor to iterate the reply if successful, NULL
on error. Call g_object_unref() on the returned cursor when no longer
needed.
|