Gjsify LogoGjsify Logo

The TrackerSparqlConnection object represents a SPARQL connection.

Hierarchy

Index

Constructors

  • Parameters

    Returns Tracker.SparqlConnection

  • Creates or opens a database.

    This method should only be used for databases owned by the current process. To connect to databases managed by other processes, use tracker_sparql_connection_bus_new().

    If store is %NULL, the database will be created in memory.

    The ontologies parameter must point to a location containing suitable .ontology files in Turtle format. These control the database schema that is used. You can use the default Nepomuk ontologies by calling tracker_sparql_get_ontology_nepomuk ().

    If you open an existing database using a different ontology to the one it was created with, Tracker will attempt to migrate the existing data to the new schema. This may raise an error. In particular, not all migrations are possible without causing data loss and Tracker will refuse to delete data during a migration.

    You can also pass %NULL for ontologies to mean "use the ontologies that the database was created with". This will fail if the database doesn't already exist.

    Parameters

    • flags: Tracker.SparqlConnectionFlags

      values from #TrackerSparqlConnectionFlags

    • store: Gio.File

      the directory that contains the database as a #GFile, or %NULL

    • ontology: Gio.File

      the directory that contains the database schemas as a #GFile, or %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns Tracker.SparqlConnection

Properties

gTypeInstance: TypeInstance
parentInstance: GObject.Object
name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • close(): void
  • Closes a SPARQL connection. No other API calls than g_object_unref() should happen after this call.

    This call is blocking. All pending updates will be flushed, and the store databases will be closed orderly. All ongoing SELECT queries will be cancelled. Notifiers will no longer emit events.

    Returns void

  • Closes a connection asynchronously. No other API calls than g_object_unref() should happen after this call. See tracker_sparql_connection_close() for more information.

    Parameters

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      user-defined #GAsyncReadyCallback to be called when asynchronous operation is finished.

    Returns void

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Creates a new batch to store and execute update commands. If the connection is readonly or cannot issue SPARQL updates, %NULL will be returned.

    Returns Tracker.Batch

  • Creates a new #TrackerNotifier to notify about changes in connection. See #TrackerNotifier documentation for information about how to use this object.

    Returns Tracker.Notifier

  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • isFloating(): boolean
  • Prepares a #TrackerSparqlStatement for the SPARQL query contained as a resource file at resource_path. SPARQL Query files typically have the .rq extension.

    Parameters

    • resourcePath: string

      the resource path of the file to parse.

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns Tracker.SparqlStatement

  • Maps service_connection so it is available as a "private:handle_name" URI in connection. This can be accessed via the SERVICE SPARQL syntax in queries from connection. E.g.:

    SELECT ?u {
    SERVICE <private:other-connection> {
    ?u a rdfs:Resource
    }
    }

    This is useful to interrelate data from multiple #TrackerSparqlConnection instances maintained by the same process, without creating a public endpoint for service_connection.

    connection may only be a #TrackerSparqlConnection created via tracker_sparql_connection_new() and tracker_sparql_connection_new_async().

    Parameters

    • handleName: string

      handle name for service_connection

    • serviceConnection: Tracker.SparqlConnection

      a #TrackerSparqlConnection to use from connection

    Returns void

  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Executes a SPARQL query on. The API call is completely synchronous, so it may block.

    The sparql query should be built with #TrackerResource, or its parts correctly escaped using tracker_sparql_escape_string(), otherwise SPARQL injection is possible.

    Parameters

    • sparql: string

      string containing the SPARQL query

    • cancellable: Gio.Cancellable

      a #GCancellable used to cancel the operation

    Returns Tracker.SparqlCursor

  • Executes asynchronously a SPARQL query.

    Parameters

    • sparql: string

      string containing the SPARQL query

    • cancellable: Gio.Cancellable

      a #GCancellable used to cancel the operation

    • callback: AsyncReadyCallback

      user-defined #GAsyncReadyCallback to be called when asynchronous operation is finished.

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Serializes data into the specified RDF format. query must be either a DESCRIBE or CONSTRUCT query. This is an asynchronous operation, callback will be invoked when the data is available for reading.

    The SPARQL endpoint may not support the specified format, in that case an error will be raised.

    The flags argument is reserved for future expansions, currently %TRACKER_SERIALIZE_FLAGS_NONE must be passed.

    Parameters

    Returns void

  • Finishes a tracker_sparql_connection_serialize_async() operation. In case of error, %NULL will be returned and error will be set.

    Parameters

    Returns Gio.InputStream

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • Executes a SPARQL update. The API call is completely synchronous, so it may block.

    The sparql query should be built with #TrackerResource, or its parts correctly escaped using tracker_sparql_escape_string(), otherwise SPARQL injection is possible.

    Parameters

    • sparql: string

      string containing the SPARQL update query

    • cancellable: Gio.Cancellable

      a #GCancellable used to cancel the operation

    Returns void

  • Executes asynchronously an array of SPARQL updates. All updates in the array are handled within a single transaction.

    Parameters

    • sparql: string

      an array of strings containing the SPARQL update queries

    • sparqlLength: number

      the amount of strings you pass as sparql

    • cancellable: Gio.Cancellable

      a #GCancellable used to cancel the operation

    • callback: AsyncReadyCallback

      user-defined #GAsyncReadyCallback to be called when asynchronous operation is finished.

    Returns void

  • Finishes the asynchronous SPARQL update_array operation.

    Parameters

    • res: AsyncResult

      a #GAsyncResult with the result of the operation

    Returns boolean

  • Executes asynchronously a SPARQL update.

    Parameters

    • sparql: string

      string containing the SPARQL update query

    • cancellable: Gio.Cancellable

      a #GCancellable used to cancel the operation

    • callback: AsyncReadyCallback

      user-defined #GAsyncReadyCallback to be called when asynchronous operation is finished.

    Returns void

  • Executes a SPARQL update and returns the URNs of the generated nodes, if any. The API call is completely synchronous, so it may block.

    The sparql query should be built with #TrackerResource, or its parts correctly escaped using tracker_sparql_escape_string(), otherwise SPARQL injection is possible.

    The format string of the GVariant is aaa{ss} (an array of an array of dictionaries). The first array represents each INSERT that may exist in the SPARQL string. The second array represents each new node for a given WHERE clause. The last array holds a string pair with the blank node name (e.g. foo for the blank node _:foo) and the URN that was generated for it. For most updates the first two outer arrays will only contain one item.

    Parameters

    • sparql: string

      string containing the SPARQL update query

    • cancellable: Gio.Cancellable

      a #GCancellable used to cancel the operation

    Returns GLib.Variant

  • Executes asynchronously a SPARQL update with blank nodes. See the tracker_sparql_connection_update_blank() documentation to see the differences with tracker_sparql_connection_update().

    Parameters

    • sparql: string

      string containing the SPARQL update query

    • cancellable: Gio.Cancellable

      a #GCancellable used to cancel the operation

    • callback: AsyncReadyCallback

      user-defined #GAsyncReadyCallback to be called when asynchronous operation is finished.

    Returns void

  • Finishes the asynchronous SPARQL update operation, and returns the URNs of the generated nodes, if any. See the tracker_sparql_connection_update_blank() documentation for the interpretation of the returned #GVariant.

    Parameters

    • res: AsyncResult

      a #GAsyncResult with the result of the operation

    Returns GLib.Variant

  • Finishes the asynchronous SPARQL update operation.

    Parameters

    • res: AsyncResult

      a #GAsyncResult with the result of the operation

    Returns void

  • Inserts a resource as described by resource, on the graph described by graph. This operation blocks until done.

    Parameters

    • graph: string

      RDF graph where the resource should be inserted/updated, or %NULL for the default graph

    • resource: Tracker.Resource

      a #TrackerResource

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns boolean

  • Inserts a resource as described by resource, on the graph described by graph. This operation is executed asynchronously, when finished callback will be executed.

    Parameters

    • graph: string

      RDF graph where the resource should be inserted/updated, or %NULL for the default graph

    • resource: Tracker.Resource

      a #TrackerResource

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      the #GAsyncReadyCallback called when the operation completes

    Returns void

  • Finishes a tracker_sparql_connection_update_resource_async() operation.

    Parameters

    • res: AsyncResult

      a #GAsyncResult with the result of the operation

    Returns boolean

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • Connects to a database owned by another process on the local machine.

    Parameters

    • serviceName: string

      The name of the D-Bus service to connect to.

    • objectPath: string

      The path to the object, or %NULL to use the default.

    • dbusConnection: DBusConnection

      The #GDBusConnection to use, or %NULL to use the session bus

    Returns Tracker.SparqlConnection

  • Connects to a database owned by another process on the local machine. This is an asynchronous operation.

    Parameters

    • serviceName: string

      The name of the D-Bus service to connect to.

    • objectPath: string

      The path to the object, or %NULL to use the default.

    • dbusConnection: DBusConnection

      The #GDBusConnection to use, or %NULL to use the session bus

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      the #GAsyncReadyCallback called when the operation completes

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates or opens a database.

    This method should only be used for databases owned by the current process. To connect to databases managed by other processes, use tracker_sparql_connection_bus_new().

    If store is %NULL, the database will be created in memory.

    The ontologies parameter must point to a location containing suitable .ontology files in Turtle format. These control the database schema that is used. You can use the default Nepomuk ontologies by calling tracker_sparql_get_ontology_nepomuk ().

    If you open an existing database using a different ontology to the one it was created with, Tracker will attempt to migrate the existing data to the new schema. This may raise an error. In particular, not all migrations are possible without causing data loss and Tracker will refuse to delete data during a migration.

    You can also pass %NULL for ontologies to mean "use the ontologies that the database was created with". This will fail if the database doesn't already exist.

    Parameters

    • flags: Tracker.SparqlConnectionFlags

      values from #TrackerSparqlConnectionFlags

    • store: Gio.File

      the directory that contains the database as a #GFile, or %NULL

    • ontology: Gio.File

      the directory that contains the database schemas as a #GFile, or %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    Returns Tracker.SparqlConnection

  • Asynchronous version of tracker_sparql_connection_new().

    Parameters

    • flags: Tracker.SparqlConnectionFlags

      values from #TrackerSparqlConnectionFlags

    • store: Gio.File

      the directory that contains the database as a #GFile, or %NULL

    • ontology: Gio.File

      the directory that contains the database schemas as a #GFile, or %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      the #GAsyncReadyCallback called when the operation completes

    Returns void

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • Connects to a remote SPARQL endpoint. The connection is made using the libsoup HTTP library. The connection will normally use the http:// or https:// protocol.

    Parameters

    • uriBase: string

      Base URI of the remote connection

    Returns Tracker.SparqlConnection

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method