public interface Query<T>
Object for executing a query against a Stardog database.
Usage:
SelectQuery q = c.select("select * where ...");
q.parameter("foo", 12);
q.parameter("bar", false);
q.parameter("subj", s);
q.offset(10);
q.limit(250);
// run it
TupleQueryResult r = q.execute();
while (r.hasNext()) {
// do awesome things...
r.next();
}
// always close your query result sets!
r.close();
It is recommended that in order to avoid most types of injection attacks via SPARQL, that any
parameterization of queries is handled through the usage of the various parameter methods as opposed to
using string concatenation of a query with user input. These methods will safely handle escaping and insertion
of the provided value into the query while also providing type safety.
For example the query:
String aName = // some value
String aStr = "select * where { ?s rdf:type foaf:Person. ?s foaf:name \""+aName+"\". }";
In the best case where the value of aName is valid, you will be fine. But if aName is pulled from
user input, it could be the case that the user provided the string:
John Doe". ?s private:ssn ?ssn . ?s private:bankAccountNum ?bn. # }
It would yield the query:
select * where { ?s rdf:type foaf:Person. ?s foaf:name "John Doe". ?s private:ssn ?ssn . ?s private:bankAccountNum ?bn. } #". }
Note here that everything after the # is commented out, thus giving the user the ability to select both
the person's SSN and bank account number. If the parameter(String, String) method was instead used by
invoking Query.parameter("n", aName), with the original query of
select * where { ?s rdf:type foaf:Person. ?s foaf:name ?n. }, and the malicious input, you'd end up with
the incorrect, and innocuous query:
select * where { ?s rdf:type foaf:Person. ?s foaf:name """John Doe". ?s private:ssn ?ssn . ?s private:bankAccountNum ?bn. } """^^xsd:string. }
| Modifier and Type | Field and Description |
|---|---|
static long |
NO_TIMEOUT
Constant value used to specify that a query has no timeout
|
| Modifier and Type | Method and Description |
|---|---|
default String |
baseURI() |
default Dataset |
dataset() |
Query<T> |
dataset(Dataset theDataset)
Specify the dataset this query will be executed against.
|
T |
execute()
Execute the query
|
String |
explain()
Return the explanation of this query, which is the plan that will get executed for this query.
|
boolean |
isReasoningEnabled()
Return whether this query is using reasoning
|
Query<T> |
parameter(String theName,
boolean theValue)
Set the parameter to the xsd:boolean value
|
Query<T> |
parameter(String theName,
byte theValue)
Set the parameter to the xsd:byte value
|
Query<T> |
parameter(String theName,
Date theValue)
Set the parameter to the xsd:date value
|
Query<T> |
parameter(String theName,
double theValue)
Set the parameter to the xsd:double value
|
Query<T> |
parameter(String theName,
float theValue)
Set the parameter to the xsd:float value
|
Query<T> |
parameter(String theName,
GregorianCalendar theValue)
Set the parameter to the xsd:dateTime value
|
Query<T> |
parameter(String theName,
int theValue)
Set the parameter to the xsd:int value
|
Query<T> |
parameter(String theName,
long theValue)
Set the parameter to the xsd:long value
|
Query<T> |
parameter(String theName,
Object theObj)
Set the parameter to the specified value.
|
Query<T> |
parameter(String theName,
short theValue)
Set the parameter to the xsd:short value
|
Query<T> |
parameter(String theName,
String theValue)
Set the parameter to the xsd:string value
|
Query<T> |
parameter(String theName,
URI theURI)
Set the parameter to the xsd:URI value
|
Query<T> |
parameter(String theName,
Value theValue)
Set the value of the parameter
|
default Map<String,Value> |
parameters() |
String |
queryString() |
Query<T> |
reasoning(boolean theReasoningFlag)
Specify whether you would like the query to be executed with reasoning.
|
default long |
timeout() |
Query<T> |
timeout(long theTimeout)
Set the timeout for query execution.
|
String |
toString()
Returns the current state of the parameterized SPARQL query for reference where parameters are appended as
comments.
|
static final long NO_TIMEOUT
T execute() throws StardogException
StardogException - if there is an error executing the queryQuery<T> parameter(String theName, Value theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, int theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, long theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, float theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, double theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, short theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, boolean theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, byte theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, String theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, Date theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, GregorianCalendar theValue)
theName - the parameter to settheValue - the value of the parameterQuery<T> parameter(String theName, URI theURI)
theName - the parameter to settheURI - the value of the parameterQuery<T> parameter(String theName, Object theObj)
theName - the parameter nametheObj - the param valueString explain() throws StardogException
StardogException - if there is an error explaining the queryQuery<T> dataset(Dataset theDataset)
Datasets.NO_DATASET remove the dataset.theDataset - the active graph datasetDatasetsdefault Dataset dataset()
Query<T> reasoning(boolean theReasoningFlag)
reasoning flag associated with the connection.theReasoningFlag - the reasoning flagIllegalStateException - if attempting to change the reasoning flag of the query inside
of a transactionboolean isReasoningEnabled()
default long timeout()
Query<T> timeout(long theTimeout)
theTimeout - the timeout in ms. A zero or negative value will be
interpreted as no timeoutString toString()
ReadQuery.limit(long),
ReadQuery.offset(long), or parameter(String, Value) functions then the result will be the original query
string. If the original query has been modified with one of these functions then the parameters will be appended
at the end of the query string as comments using an appropriate SPARQL keyword (LIMIT, OFFSET, or VALUES).String queryString()
default String baseURI()
Copyright © 2010-2016 Stardog Union. All Rights Reserved.