'\" t
.\"     Title: tinysparql-introspect
.\"    Author: The TinySPARQL developers
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/15/2026
.\"    Manual: TinySPARQL manual
.\"    Source: \ \& 3.11.1
.\"  Language: English
.\"
.TH "TINYSPARQL\-INTROSPE" "1" "04/15/2026" "\ \& 3\&.11\&.1" "TinySPARQL manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tinysparql-introspect \- Introspect SPARQL endpoints\&.
.SH "SYNOPSIS"
.sp
.nf
tinysparql introspect [(\-d |\-\-database) <file> | (\-b | \-\-dbus\-service) <busname> | (\-r | \-\-remote\-service) <url>]
    [(\-t | \-\-tree)] [(\-t | \-\-tree) <class>] [(\-s | \-\-search) <needle>]t
tinysparql introspect [(\-d |\-\-database) <file> | (\-b | \-\-dbus\-service) <busname> | (\-r | \-\-remote\-service) <url>]
    [(\-c | \-\-list\-classes)] [(\-p | \-\-list\-properties)] [(\-i | \-\-list\-indexes)] [(\-n | \-\-list\-notifies)] [(\-g | \-\-list\-graphs)]
.fi
.SH "DESCRIPTION"
.sp
This command allows probing of the current database schema (also known as ontology) and endpoint capabilities\&. If called with no additional arguments to the one specifying the database connection, all information is extracted\&.
.sp
In terms of the database ontology, it\(cqs 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\&.
.SH "OPTIONS"
.PP
\fB\-b, \-\-dbus\-service=<\fR\fB\fIservice_name\fR\fR\fB>\fR
.RS 4
Connects to a SPARQL endpoint at a D\-Bus name\&.
.RE
.PP
\fB\-d, \-\-database\-path=<\fR\fB\fIdatabase_path\fR\fR\fB>\fR
.RS 4
Connects to a database by location in the filesystem\&.
.RE
.PP
\fB\-r, \-\-remote\-service=<\fR\fB\fIurl\fR\fR\fB>\fR
.RS 4
Connects to a HTTP SPARQL endpoint\&.
.RE
.PP
\fB\-c, \-\-list\-classes\fR
.RS 4
Returns a list of classes which describe the ontology used for storing data\&. These classes are also used in queries\&. For example,
\fIhttp://www\&.w3\&.org/2000/01/rdf\-schema#Resource\fR
is one of many classes which should be returned here\&.
.RE
.PP
\fB\-x, \-\-list\-class\-prefixes\fR
.RS 4
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\&.
.RE
.PP
\fB\-p, \-\-list\-properties=[\fR\fB\fIclass\fR\fR\fB]\fR
.RS 4
Returns a list of properties which pertain to a
\fIclass\fR\&. You can use both formats here for the
\fIclass\fR, either the full name
\fIhttp://tracker\&.api\&.gnome\&.org/ontology/v3/nfo#Video\fR
or the shortened prefix name
\fInfo:Video\fR\&. See also
\fB\-\-tree\fR
and
\fB\-\-query\fR\&.
.RE
.PP
\fB\-n, \-\-list\-notifies=[\fR\fB\fIclass\fR\fR\fB]\fR
.RS 4
Returns a list of classes which are notified over D\-Bus about any changes that occur in the database\&. The
\fIclass\fR
does not have to be supplied here\&. This is optional and filters the results according to any argument supplied\&. With no
\fIclass\fR, all classes are listed\&.
.RE
.PP
\fB\-i, \-\-list\-indexes=[\fR\fB\fIproperty\fR\fR\fB]\fR
.RS 4
Returns a list of properties which are indexed in the database\&. Indexes improves query speed but also add an indexing penalty\&. The
\fIproperty\fR
does not have to be supplied here\&. This is optional and filters the results according to any argument supplied\&. With no
\fIproperty\fR, all properties are listed\&.
.RE
.PP
\fB\-g, \-\-list\-graphs\fR
.RS 4
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\&.
.RE
.PP
\fB\-t, \-\-tree=[\fR\fB\fIclass\fR\fR\fB]\fR
.RS 4
Prints a tree showing all parent classes of
\fIclass\fR
in the ontology\&. The
\fIclass\fR
can be provided in shorthand or longhand (see
\fB\-\-get\-shorthand\fR
and
\fB\-\-get\-longhand\fR
for details)\&.
.RE
.sp
If no \fIclass\fR is given, the entire tree is shown\&.
.sp
The \fB\-\-search\fR command line option can be used to highlight parts of the tree you\(cqre looking for\&. The search is case insensitive\&.
.sp
The \fB\-\-properties\fR command line option can be used to show properties for each class displayed
.PP
\fB\-s, \-\-search=<\fR\fB\fIneedle\fR\fR\fB>\fR
.RS 4
Returns a list of classes and properties which partially match
\fIneedle\fR
in the ontology\&. Search is case insensitive\&. See also
\fB\-\-tree\fR\&.
.RE
.SH "SEE ALSO"
.sp
\fBtinysparql\-endpoint\fR(1)\&.