Interface Query

All Superinterfaces:

Operation

All Known Subinterfaces:

BooleanQuery, GraphQuery, TupleQuery

All Known Implementing Classes:

AbstractHTTPQuery, AbstractParserQuery, AbstractParserQuery, AbstractQuery, DelegatingGraphQuery, DelegatingTupleQuery, FedXBooleanQuery, FedXGraphQuery, FedXTupleQuery, HTTPBooleanQuery, HTTPGraphQuery, HTTPTupleQuery, LoggingGraphQuery, LoggingTupleQuery, ResultCachingGraphQuery, ResultCachingTupleQuery, SailBooleanQuery, SailGraphQuery, SailQuery, SailTupleQuery, SPARQLBooleanQuery, SPARQLGraphQuery, SPARQLTupleQuery

public interface Query
extends Operation

A query on a repository that can be formulated in one of the supported query languages (for example SPARQL). It allows one to predefine bindings in the query to be able to reuse the same query with different bindings.

Author:

Arjohn Kampman, jeen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Query.QueryType	The different types of queries that RDF4J recognizes: boolean queries, graph queries, and tuple queries.

Method Summary

Modifier and Type	Method	Description
default Explanation	explain(Explanation.Level level)	Explain how the query will be (or has been) executed/evaluated by returning an explanation of the query plan.
int	getMaxQueryTime()	Deprecated. Use Operation.getMaxExecutionTime() instead.
void	setMaxQueryTime(int maxQueryTime)	Deprecated. Use Operation.setMaxExecutionTime(int) instead.

Methods inherited from interface Operation

clearBindings, getBindings, getDataset, getIncludeInferred, getMaxExecutionTime, removeBinding, setBinding, setDataset, setIncludeInferred, setMaxExecutionTime

Modifier and Type	Method	Description
void	clearBindings()	Removes all previously set bindings.
BindingSet	getBindings()	Retrieves the bindings that have been set on this operation.
Dataset	getDataset()	Gets the dataset that has been set using Operation.setDataset(Dataset), if any.
boolean	getIncludeInferred()	Returns whether or not this operation will return inferred statements (if any are present in the repository).
int	getMaxExecutionTime()	Returns the maximum operation execution time.
void	removeBinding(String name)	Removes a previously set binding on the supplied variable.
void	setBinding(String name, Value value)	Binds the specified variable to the supplied value.
void	setDataset(Dataset dataset)	Specifies the dataset against which to execute an operation, overriding any dataset that is specified in the operation itself.
void	setIncludeInferred(boolean includeInferred)	Determine whether evaluation results of this operation should include inferred statements (if any inferred statements are present in the repository).
void	setMaxExecutionTime(int maxExecutionTimeSeconds)	Specifies the maximum time that an operation is allowed to run.

Method Details

setMaxQueryTime

@Deprecated(since="2.0")
void setMaxQueryTime(int maxQueryTime)

Deprecated.

Use Operation.setMaxExecutionTime(int) instead.

Specifies the maximum time that a query is allowed to run. The query will be interrupted when it exceeds the time limit. Any consecutive requests to fetch query results will result in QueryInterruptedExceptions.

Parameters:

maxQueryTime - The maximum query time, measured in seconds. A negative or zero value indicates an unlimited query time (which is the default).

getMaxQueryTime

@Deprecated(since="2.0")
int getMaxQueryTime()

Deprecated.

Use Operation.getMaxExecutionTime() instead.

Returns the maximum query evaluation time.

Returns:

The maximum query evaluation time, measured in seconds.

See Also:

• setMaxQueryTime(int)

explain

@Experimental
default Explanation explain(Explanation.Level level)

Explain how the query will be (or has been) executed/evaluated by returning an explanation of the query plan.

This method is useful for understanding why a particular query is slow. The most useful level is Executed, but this takes as long as it takes to execute/evaluate the query.

When timing a query you should keep in mind that the query performance will vary based on how much the JIT compiler has compiled the code (C1 vs C2) and based on what is or isn't cached in memory. If Timed explanations are considerably slower than Executed explanations the overhead with timing the query may be large on your system and should not be trusted.

WARNING: This method is experimental and is subject to change or removal without warning. Same goes for the returned explanation. There is currently only partial support for this method in RDF4J and and UnsupportedOperationException where support is lacking.

Parameters:

level - The explanation level that should be used to create the explanation. Choose between: Unoptimized (as parsed without optimizations) , Optimized (as is actually going to be used), Executed (as was executed/evaluated with actual result sizes), Telemetry (as was executed/evaluated, including runtime telemetry metrics), Timed (as was executed/evaluated including timing for each plan node). Executed, Telemetry and Timed levels can potentially be slow.

Returns:

The explanation that we generated, which can be viewed in a human readable format with toString(), as JSON or as a simplified query plan object structure.