summaryrefslogtreecommitdiff
path: root/docs/manpages/tracker3-endpoint.1.txt
blob: 6671ca8c4385afc12f8aaf887e7789a3c1610721 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
tracker3-endpoint(1)
====================

== NAME
tracker3-endpoint - Create a SPARQL endpoint

== SYNOPSIS

....
tracker3 endpoint [--dbus-service | -b] <service_name>
                  [--database-path | -d] <database_path>
                  [[--ontology | -o] <ontology_name> |
                   [--ontology-path | -p] <ontology_path>]
                  [--http-port] <port>
                  [--loopback]
                  [[--system | --session]]
....

== DESCRIPTION

This command allows creating SPARQL endpoints. The endpoint will be able
to handle SPARQL select and update queries, and notify about changes in
it.

The endpoint is exported via DBus, accessible through the given
_service_name_, either using it in a *SERVICE* clause, or by creating a
dedicated bus-based SPARQL connection.

When creating a database, the _ontology_name_ (or alternatively, a
_ontology_path_) must be provided in order to generate the database. If
_ontology_name_ is used, the ontology must exist in
_$datadir/tracker/ontologies_

The database itself will be stored according to _database_path_.

== OPTIONS

*-b, --dbus-service=<__service_name__>*::
  Service name to use on the endpoint.
*-d, --database-path=<__database_path__>*::
  The path where the database will be stored.
*-o, --ontology*::
  The name of an ontology in _$datadir/tracker/ontologies_ to use on the
  constructed database.
*-p, --ontology-path*::
  Full path to an ontology to use on the constructed database.
*--session*::
  Use the session bus. This is the default.
*--system*::
  Use the system bus.
*-l, --list*::
  List all SPARQL endpoints available in DBus
*--http-port*::
  Creates a HTTP endpoint that listens in the specified port
*--loopback*::
  Allows only HTTP connections in the loopback device. Only
  effective with HTTP endpoints.

== EXAMPLES

Export a Nepomuk endpoint with the _org.example.Example1_ bus name.

  $ tracker3 endpoint -b org.example.Example1 -o nepomuk -d /tmp/example1

Access this endpoint with the *tracker3-sparql(1)* subcommand.

  $ tracker3 sparql --dbus-service org.example.Example1 -q "
    SELECT ?s ?o
    WHERE {
      ?u a ?o
    }"

Export a Nepomuk endpoint via HTTP.

  $ tracker3 endpoint --http-port 8080 -o nepomuk --loopback

Access this endpoint via HTTP.

  $ tracker3 sparql --remote-service http://127.0.0.1:8080/sparql -q "
    SELECT ?u {
      ?u a rdfs:Resource
    }"

== SEE ALSO

*tracker3-sparql*(1),

<https://www.w3.org/TR/sparql11-query/>