Please refer to theerrata for this document, which may include some normative corrections.
See alsotranslations.
Copyright © 2013W3C® (MIT,ERCIM,Keio,Beihang), All Rights Reserved. W3Cliability,trademark anddocument use rules apply.
RDF is a flexible, extensible way to represent information about World Wide Web resources. It is used to represent, among other things, personal information, social networks, metadata about digital artifacts like music and images, as well as provide a means of integration over disparate sources of information. A standardized query language for RDF data with multiple implementations offers developers and end users a way to write and to consume the results of queries across this wide range of information.
This document describes an XML format for the variable binding and boolean results formats provided by theSPARQL query language for RDF, developed by theW3C RDF Data Access Working Group (DAWG), part of theSemantic Web Activity as described in theactivity statement .
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in theW3C technical reports index at http://www.w3.org/TR/.
This document is one of eleven SPARQL 1.1 Recommendations produced by theSPARQL Working Group:
There have been no substantive changes to this document since theprevious version. Minor editorial changes, if any, are detailed in thechange log and visible in thecolor-coded diff.
Please send any comments topublic-rdf-dawg-comments@w3.org (public archive). Although work on this document by theSPARQL Working Group is complete, comments may be addressed in theerrata or in future revisions. Open discussion is welcome atpublic-sparql-dev@w3.org (public archive).
This document has been reviewed by W3C Members, by software developers, and by other W3C groups and interested parties, and is endorsed by the Director as a W3C Recommendation. It is a stable document and may be used as reference material or cited from another document. W3C's role in making the Recommendation is to draw attention to the specification and to promote its widespread deployment. This enhances the functionality and interoperability of the Web.
This document was produced by a group operating under the5 February 2004 W3C Patent Policy. W3C maintains apublic list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes containsEssential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
TheSPARQL Query Language for RDF[SPARQL-QUERY]defines severalQuery Result Forms(SPARQL Query section 10).This document defines aSPARQL Results Documentthat encodesthe variable binding query results fromSELECT
queries(SPARQL Query section 10.2)and boolean query results fromASK
queries(SPARQL Query section 10.5)inXML[XML].
There are two other results formats which follow a similar design but do not use XML:SPARQL 1.1 Query Results JSON Format [SRJ] andSPARQL 1.1 Query Results CSV and TSV Formats [SRC].
Definition:SPARQL Results Document
ASPARQL Results Document is an XML document that is valid with respect to either the RELAX NG XML Schema or the W3C XML Schema inSection 4.
TheSPARQL Results Documentbegins withsparql
document element in thehttp://www.w3.org/2005/sparql-results#
namespace,written as follows:
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#"> ...</sparql>
Inside thesparql
element are two sub-elements,head
and a results element (eitherresults
orboolean
)which must appear in that order.
Thehead
element is the first child element ofthesparql
element.
For a variable binding query result,head
must contain asequence of elements describing the set ofQuery Variablenames in theSolution Sequence(here called query results).
The order of the variable names in the sequence is the order ofthe variable names given to the argument of theSELECT
statement in the SPARQL query. IfSELECT *
is used, theorder of the names is undefined.
Inside thehead
element, the ordered sequence ofvariable names chosen are used to create empty child elementsvariable
with the variable name as the value of anattributename
giving a document like this:
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#"> <head> <variable name="x"/> <variable name="hpage"/> <variable name="name"/> <variable name="mbox"/> <variable name="blurb"/> </head>...</sparql>
For a boolean query result, no elements are required insidehead
andvariable
must not be present.
For any query result,head
may also containlink
child elements with anhref
attributecontaining a relative URI that provides a link to some additionalmetadata about the query results. The relative URI is resolvedagainst the in-scope base URI which is usually the query resultsformat document URI.link
elements must appear afteranyvariable
elements that are present.
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#"> <head> ... <link href="metadata.rdf"/> </head>...</sparql>
The second child-element ofsparql
must appear afterhead
and is eitherresults
orboolean
.It is written even if the query results are empty.
Theresults
element contains the complete sequence ofquery results.
For eachQuery Solutionin the query results, aresult
child-element ofresults
is added givinga document like:
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#"> ... head ... <results> <result>... </result> <result>... </result> ... </results></sparql>
Eachresult
element corresponds to oneQuerySolution in a result and contains child elements (in no particular order) for eachQueryVariable that appears in the solution. Itis used to record how the query variables bind toRDFTerms.
Each binding inside a solution is written as an elementbinding
as a child ofresult
with the queryvariable name as the value of thename
attribute. So for a result binding two variablesx andhpage it wouldlook like:
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#"> <head> <variable name="x"/> <variable name="hpage"/> </head> <results> <result> <binding name="x"> ... </binding> <binding name="hpage"> ... </binding> </result> <result> <binding name="x"> ... </binding> <binding name="hpage"> ... </binding> </result> ... </results></sparql>
The value of a query variable binding, which is anRDF Term, isincluded as the content of thebinding
as follows:
<binding><uri>
U</uri></binding>
<binding><literal>
S</literal></binding>
<binding><literalxml:lang="
L">
S</literal></binding>
<binding><literaldatatype="
D">
S</literal></binding>
<binding><bnode>
I</bnode></binding>
If, for a particular solution, a variable isunbound, nobinding
element for that variable is included in theresult
element.
Note: The blank node labelI is scopedto the result set XML document and need not have any association tothe blank node label for that RDF Term in the query graph.
An example of a query solution encoded in this format is as follows:
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#"> <head> <variable name="x"/> <variable name="hpage"/> <variable name="name"/> <variable name="age"/> <variable name="mbox"/> <variable name="friend"/> </head> <results> <result> <binding name="x"><bnode>r2</bnode> </binding> <binding name="hpage"><uri>http://work.example.org/bob/</uri> </binding> <binding name="name"><literal xml:lang="en">Bob</literal> </binding> <binding name="age"><literal datatype="http://www.w3.org/2001/XMLSchema#integer">30</literal> </binding> <binding name="mbox"><uri>mailto:bob@work.example.org</uri> </binding> </result> ... </results></sparql>
A boolean result is written as the element content of aboolean
child-element of thesparql
element directly after ahead
,containing eithertrue
orfalse
as follows:
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#"> ... head ... <boolean>true</boolean></sparql>
An exampleSELECT
SPARQL Query inexample.rq operating on query graph Turtle/N3 data indata.n3 providing ordered variable binding query results written in XML inoutput.srx.
This XML can be transformed into XHTML using the sample XML Query scriptresult-to-html.xq givingoutput-xquery.html or with XSLT sheetresult-to-html.xsl givingoutput-xslt.html
An exampleASK
SPARQL Query inexample2.rq operating on query graph Turtle/N3 data indata.n3 provides a boolean query result written in XML inoutput2.srx.
This XML can be transformed into XHTML using the sample XML Query scriptresult-to-html.xq givingoutput-xquery2.html or with XSLT sheetresult-to-html.xsl givingoutput-xslt2.html
There are normative XML schemas provided in the following formats:
If W3C XML Schema is used, anxsi:schemaLocation
attribute can be used pointing to the schema as follows:
<?xml version="1.0"?><sparql xmlns="http://www.w3.org/2005/sparql-results#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.w3.org/2007/SPARQL/result.xsd"> ...</sparql>
The Internet Media Type / MIME Type for the SPARQL Query Results XMLFormat is "application/sparql-results+xml".
It is recommended that result files have the extension ".srx" (alllowercase) on all platforms.
It is recommended that result files stored on Macintosh HFS filesystems be given a file type of "TEXT".
SPARQL query results uses URIs. See Section 7 of[RFC3986].
SPARQL query results uses IRIs. See Section 8 of[RFC3987].
As this media type uses the "+xml" convention, it shares the same security considerations as described in[RFC3023], section 10.
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media Types", RFC 3023, January 2001.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005.
[RFC3987] Duerst, M. and M. Suignard, "Internationalized Resource Identifiers (IRIs)", RFC 3987, January 2005.