tracker3-sparql - Man Page

Use SparQL to query the Tracker databases.

Synopsis

tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>]
    [(-q | --query) <sparql> | (-f | --file) <file>] [(-u | --update)] [-a <parameter>:<value>]...
tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>]
    [(-t | --tree)] [(-t | --tree) <class>] [(-p | --list-properties)] [(-s | --search) <needle>]
tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>] [(-c | --list-classes)]
tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>] [(-p | --list-properties)]
tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>] [(-i | --list-indexes)]
tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>] [(-n | --list-notifies)]
tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>] [(-g | --list-graphs)]
tracker3 sparql [(-d |--database) <file> | (-b | --dbus-service) <busname> | (-r | --remote-service) <url>] [--get-longhand <class>] [--get-shorthand <class>]

Description

This command allows probing of the current database schema (also known as ontology) and running low level queries or updates on the data set. In terms of the database ontology, it’s easy to find out what properties are indexed for speed, or notified on changes, what classes are available and the properties belonging to those classes. There are also visual tools to display an ascii tree layout of the classes and their relationships to each other.

When the caller runs a query, the query is in RDF and SPARQL. This can be done two ways. Either by providing a file with the query or by providing a string with the sparql query.

The file argument can be either a local path or a URI. It also does not have to be an absolute path.

Options

-b,  --dbus-service=<service_name>

Connects to a SPARQL endpoint at a D-Bus name.

-d,  --database-path=<database_path>

Connects to a database by location in the filesystem.

-r,  --remote-service=<url>

Connects to a HTTP SPARQL endpoint.

-f,  --file=<file>

Use a file with SPARQL content to query or update.

-q,  --query=<sparql>

Use a sparql string to query the database with.

-u,  --update

This has to be used with --query. This tells "tracker3 sparql" to use the SPARQL update extensions so it knows it isn’t a regular data lookup request. So if your query is intended to change data in the database, this option is needed.

-a,  --arg=<parameter>:<value>

Provides an argument for a parameter declared in the SPARQL query string. This may be used with --file, --query or --update. Multiple arguments may be provided for multiple parameters. Argument values are provided as a colon separated string containing 3 values: name, type and value. The name is the same as used in the query string, the value is the desired value, and the type is a single-character string defining the type:

  • i: The value will describe an integer
  • d: The value will describe a floating point number
  • b: The value will describe a boolean
  • s: The value will describe a plain string
-c,  --list-classes

Returns a list of classes which describe the ontology used for storing data. These classes are also used in queries. For example, http://www.w3.org/2000/01/rdf-schema#Resource is one of many classes which should be returned here.

-x,  --list-class-prefixes

Returns a list of prefixes in shortened and long form. All RDF classes and properties have such a prefix that may be expressed in either form.

-p,  --list-properties=[class]

Returns a list of properties which pertain to a class. You can use both formats here for the class, either the full name http://tracker.api.gnome.org/ontology/v3/nfo#Video or the shortened prefix name nfo:Video. See also --tree and --query.

-n,  --list-notifies=[class]

Returns a list of classes which are notified over D-Bus about any changes that occur in the database. The class does not have to be supplied here. This is optional and filters the results according to any argument supplied. With no class, all classes are listed.

-i,  --list-indexes=[property]

Returns a list of properties which are indexed in the database. Indexes improves query speed but also add an indexing penalty. The property does not have to be supplied here. This is optional and filters the results according to any argument supplied. With no property, all properties are listed.

-g,  --list-graphs

List all the named graphs in the database. These are used by the filesystem miner to separate metadata so that apps can only see the information relevant to them.

-t,  --tree=[class]

Prints a tree showing all parent classes of class in the ontology. The class can be provided in shorthand or longhand (see --get-shorthand and --get-longhand for details).

If no class is given, the entire tree is shown.

The --search command line option can be used to highlight parts of the tree you’re looking for. The search is case insensitive.

The --properties command line option can be used to show properties for each class displayed

-s,  --search=<needle>

Returns a list of classes and properties which partially match needle in the ontology. Search is case insensitive. See also --tree.

--get-shorthand=<class>

Returns the shorthand for a class given by a URL.

--get-longhand=<class>

Returns the longhand for a class given in the form of CLASS:PROPERTY.

Examples

Querying a D-Bus endpoint

$ tracker3 sparql --dbus-service org.example.Endpoint -q "SELECT ('Hello World' AS ?str) {}"

Updating a database directly from a query in a file

$ tracker3 sparql --database /tmp/db/ --update --file ./update.rq

Using --arg to provide a arguments to query parameters

$ tracker3 sparql -b org.example.Endpoint \
    -q "SELECT (~name AS ?name) (~age AS ?age) (~available AS ?avail) { }" \
    -a name:s:"John" -a age:i:42 -a available:b:true

Introspecting details of a D-Bus endpoint

$ tracker3 sparql -b org.example.Endpoint -tree --list-properties

See Also

tracker3-endpoint(1).

https://gnome.pages.gitlab.gnome.org/tracker/tutorial.html.

Referenced By

tracker3-endpoint(1), tracker3-export(1), tracker3-extract(1), tracker3-import(1), tracker3-info(1), tracker3-sql(1), tracker3-status(1), tracker3-tag(1).

02/14/2024 3.7.beta Tracker manual