com.bigdata.bop.engine

Interface IRunningQuery

All Superinterfaces:

Future<Void>, IHaltable<Void>, IQueryContext

All Known Implementing Classes:

AbstractRunningQuery, ChunkedRunningQuery, FederatedRunningQuery, MockRunningQuery

public interface IRunningQuery
extends IHaltable<Void>, IQueryContext

Non-Remote interface exposing a limited set of the state of an executing query.

Version:

$Id$

Author:

Bryan Thompson

Method Summary

Methods

Modifier and Type	Method and Description
Map<Integer,BOp>	getBOpIndex() Return an unmodifiable index from BOp.Annotations#BOP_ID to BOp.
long	getDeadline() Return the query deadline in milliseconds (the time at which it will terminate regardless of its run state).
long	getDoneTime() The timestamp (ms) when the query was done and ZERO (0) if the query is not yet done.
long	getElapsed() The elapsed time (ms) for the query.
IBigdataFederation<?>	getFederation() The IBigdataFederation IFF the operator is being evaluated on an IBigdataFederation.
IIndexManager	getLocalIndexManager() The local IIndexManager.
BOp	getQuery() The query.
IQueryClient	getQueryController() The client coordinate the evaluation of this query (aka the query controller).
QueryEngine	getQueryEngine() The query engine class executing the query on this node.
UUID	getQueryId() The unique identifier for this query.
long	getStartTime() The timestamp (ms) when the query began execution.
StaticAnalysisStats	getStaticAnalysisStats() Return statistics associated with the static analysis phase of this query.
Map<Integer,BOpStats>	getStats() Return an unmodifiable map exposing the statistics for the operators in the query and null unless this is the query controller.
ICloseableIterator<IBindingSet[]>	iterator() Return an iterator which will drain the solutions from the query.
void	setStaticAnalysisStats(StaticAnalysisStats saStats) Set the static analysis stats associated with this query.

Methods inherited from interface com.bigdata.util.concurrent.IHaltable

getAsThrownCause, getCause, halt, halt

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface com.bigdata.bop.IQueryContext

getAttributes, getMemoryManager

Method Detail

getQuery

BOp getQuery()

The query.

getQueryId

UUID getQueryId()

The unique identifier for this query.

Specified by:

getQueryId in interface IQueryContext

getFederation

IBigdataFederation<?> getFederation()

The IBigdataFederation IFF the operator is being evaluated on an IBigdataFederation. When evaluating operations against an IBigdataFederation, this reference provides access to the scale-out view of the indices and to other bigdata services.

getLocalIndexManager

IIndexManager getLocalIndexManager()

The local IIndexManager. Query evaluation occurs against the local indices. In scale-out, query evaluation proceeds shard wise and this IIndexManager MUST be able to read on the ILocalBTreeView.

getQueryEngine

QueryEngine getQueryEngine()

The query engine class executing the query on this node.

getQueryController

IQueryClient getQueryController()

The client coordinate the evaluation of this query (aka the query controller). For a standalone database, this will be the QueryEngine.

For scale-out, this will be the RMI proxy for the QueryEngine instance to which the query was submitted for evaluation by the application. The proxy is primarily for light weight RMI messages used to coordinate the distributed query evaluation. Ideally, all large objects will be transfered among the nodes of the cluster using NIO buffers.

getBOpIndex

Map<Integer,BOp> getBOpIndex()

Return an unmodifiable index from BOp.Annotations#BOP_ID to BOp. This index may contain operators which are not part of the pipeline evaluation, such as IPredicates.

getStats

Map<Integer,BOpStats> getStats()

Return an unmodifiable map exposing the statistics for the operators in the query and null unless this is the query controller. There will be a single entry in the map for each distinct PipelineOp. Entries might not appear until that operator has either begun or completed at least one evaluation phase. This index only contains operators which are actually part of the pipeline evaluation.

setStaticAnalysisStats

void setStaticAnalysisStats(StaticAnalysisStats saStats)

Set the static analysis stats associated with this query.

getStaticAnalysisStats

StaticAnalysisStats getStaticAnalysisStats()

Return statistics associated with the static analysis phase of this query.

getDeadline

long getDeadline()

Return the query deadline in milliseconds (the time at which it will terminate regardless of its run state).

Returns:

The query deadline (milliseconds since the epoch) and Long.MAX_VALUE if no explicit deadline was specified.

getStartTime

long getStartTime()

The timestamp (ms) when the query began execution.

getDoneTime

long getDoneTime()

The timestamp (ms) when the query was done and ZERO (0) if the query is not yet done.

getElapsed

long getElapsed()

The elapsed time (ms) for the query. This will be updated for each call until the query is done executing.

iterator

ICloseableIterator<IBindingSet[]> iterator()

Return an iterator which will drain the solutions from the query. The query will be cancelled if the iterator is closed.

Throws:

UnsupportedOperationException - if this is not the query controller.