org.apache.lens.server.api.query

Class AbstractQueryContext

java.lang.Object

org.apache.lens.server.api.query.AbstractQueryContext

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExplainQueryContext, PreparedQueryContext, QueryContext

public abstract class AbstractQueryContext
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractQueryContext.DriverEstimateRunnable Runnable to wrap estimate computation for a driver.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearTransientStateAfterCompleted()
void	clearTransientStateAfterLaunch()
void	estimateCostForDrivers() Estimate cost for each driver and set in context
org.apache.hadoop.conf.Configuration	getConf() The merged Query conf.
String	getDatabase() Returns database set while launching query
org.apache.hadoop.conf.Configuration	getDriverConf(LensDriver driver) Get driver conf
DriverSelectorQueryContext	getDriverContext() The driver ctx
Map<LensDriver,AbstractQueryContext.DriverEstimateRunnable>	getDriverEstimateRunnables() Get runnables wrapping estimate computation, which could be processed offline
String	getDriverQuery(LensDriver driver) Get driver query
QueryCost	getDriverQueryCost(LensDriver driver) Get query cost for the driver
Exception	getDriverRewriteError(LensDriver driver) Get exception during rewrite.
DriverQueryPlan	getDriverRewriterPlan(LensDriver driver)
String	getFinalDriverQuery(LensDriver driver)
org.apache.hadoop.hive.conf.HiveConf	getHiveConf() Gets HiveConf corresponding to query conf.
LensConf	getLensConf() The query conf.
String	getLensSessionIdentifier() The lens session identifier.
abstract String	getLogHandle() Get handle of the query for logging purposes
String	getPhase1RewrittenQuery() The replaced user query.
String	getQueue()
LensDriver	getSelectedDriver() Wrapper method for convenience on driver context
org.apache.hadoop.conf.Configuration	getSelectedDriverConf() Wrapper method for convenience on driver context
String	getSelectedDriverQuery() Wrapper method for convenience on driver context
QueryCost	getSelectedDriverQueryCost() The selected Driver query cost
DriverQueryPlan	getSelectedDriverQueryPlan() Wrapper method for convenience on driver context
String	getSubmittedUser() The submitted user.
Map<String,Double>	getTableWeights(LensDriver driver)
String	getUserQuery() The user query.
void	initTransientState()
boolean	isDriverQueryExplicitlySet() Will be set to true when the driver queries are explicitly set This will help avoiding rewrites in case of system restarts.
boolean	isOlapQuery() Is olap cube query or not
void	setConf(org.apache.hadoop.conf.Configuration conf) The merged Query conf.
void	setDriverContext(DriverSelectorQueryContext driverContext) The driver ctx
void	setDriverCost(LensDriver driver, QueryCost cost)
void	setDriverQueries(Map<LensDriver,String> driverQueries) Set driver queries
void	setDriverQuery(LensDriver driver, String query) Set query for a given driver
void	setDriverRewriteError(LensDriver driver, Exception exp) Set exception during rewrite.
void	setFinalDriverQuery(LensDriver driver, String rewrittenQuery) Set final driver rewritten query for the driver.
void	setLensSessionIdentifier(String lensSessionIdentifier) The lens session identifier.
void	setOlapQuery(boolean olapQuery) Is olap cube query or not
void	setPhase1RewrittenQuery(String phase1RewrittenQuery) The replaced user query.
void	setSelectedDriver(LensDriver driver) Wrapper method for convenience on driver context
void	setSelectedDriverQuery(String driverQuery) Sets the selected driver query for persistence and also in the driver context
void	setSelectedDriverQueryCost(QueryCost selectedDriverQueryCost) The selected Driver query cost

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initTransientState

public void initTransientState()

setDriverQueries

public void setDriverQueries(Map<LensDriver,String> driverQueries)
                      throws LensException

Set driver queries

Parameters:

driverQueries - Map of LensDriver to driver's query

Throws:

LensException

estimateCostForDrivers

public void estimateCostForDrivers()
                            throws LensException

Estimate cost for each driver and set in context

Throws:

LensException

getDriverEstimateRunnables

public Map<LensDriver,AbstractQueryContext.DriverEstimateRunnable> getDriverEstimateRunnables()
                                                                                       throws LensException

Get runnables wrapping estimate computation, which could be processed offline

Throws:

LensException

getTableWeights

public Map<String,Double> getTableWeights(LensDriver driver)

getDriverRewriterPlan

public DriverQueryPlan getDriverRewriterPlan(LensDriver driver)

getQueue

public String getQueue()

getSelectedDriverQuery

public String getSelectedDriverQuery()

Wrapper method for convenience on driver context

Returns:

the selected driver's query

getDriverQuery

public String getDriverQuery(LensDriver driver)

Get driver query

Parameters:

driver -

Returns:

query

getFinalDriverQuery

public String getFinalDriverQuery(LensDriver driver)

getDriverConf

public org.apache.hadoop.conf.Configuration getDriverConf(LensDriver driver)

Get driver conf

Parameters:

driver -

Returns:

Configuration

getDriverQueryCost

public QueryCost getDriverQueryCost(LensDriver driver)

Get query cost for the driver

Parameters:

driver -

Returns:

QueryCostTO

getSelectedDriverConf

public org.apache.hadoop.conf.Configuration getSelectedDriverConf()

Wrapper method for convenience on driver context

Returns:

the selected driver's conf

setSelectedDriverQuery

public void setSelectedDriverQuery(String driverQuery)

Sets the selected driver query for persistence and also in the driver context

Parameters:

driverQuery -

setSelectedDriver

public void setSelectedDriver(LensDriver driver)

Wrapper method for convenience on driver context

Parameters:

driver - Lens driver

getSelectedDriver

public LensDriver getSelectedDriver()

Wrapper method for convenience on driver context

Returns:

the selected driver

getSelectedDriverQueryPlan

public DriverQueryPlan getSelectedDriverQueryPlan()
                                           throws LensException

Wrapper method for convenience on driver context

Returns:

the selected driver

Throws:

LensException

setDriverRewriteError

public void setDriverRewriteError(LensDriver driver,
                         Exception exp)

Set exception during rewrite.

Parameters:

driver -

exp -

getDriverRewriteError

public Exception getDriverRewriteError(LensDriver driver)

Get exception during rewrite.

Parameters:

driver -

Returns:

exp

getHiveConf

public org.apache.hadoop.hive.conf.HiveConf getHiveConf()

Gets HiveConf corresponding to query conf. Should be called judiciously, because constructing HiveConf from conf object is costly. The field is set to null after query completion. Should not be accessed after completion.

Returns:

setFinalDriverQuery

public void setFinalDriverQuery(LensDriver driver,
                       String rewrittenQuery)

Set final driver rewritten query for the driver.

Parameters:

driver -

rewrittenQuery -

setDriverQuery

public void setDriverQuery(LensDriver driver,
                  String query)

Set query for a given driver

Parameters:

driver - driver instance

query - query string

setDriverCost

public void setDriverCost(LensDriver driver,
                 QueryCost cost)

getLogHandle

public abstract String getLogHandle()

Get handle of the query for logging purposes

Returns:

getDatabase

public String getDatabase()

Returns database set while launching query

Returns:

clearTransientStateAfterLaunch

public void clearTransientStateAfterLaunch()

clearTransientStateAfterCompleted

public void clearTransientStateAfterCompleted()

getUserQuery

@Generated(value="lombok")
public String getUserQuery()

The user query.

getPhase1RewrittenQuery

@Generated(value="lombok")
public String getPhase1RewrittenQuery()

The replaced user query.

setPhase1RewrittenQuery

@Generated(value="lombok")
public void setPhase1RewrittenQuery(String phase1RewrittenQuery)

The replaced user query.

getConf

@Generated(value="lombok")
public org.apache.hadoop.conf.Configuration getConf()

The merged Query conf.

setConf

@Generated(value="lombok")
public void setConf(org.apache.hadoop.conf.Configuration conf)

The merged Query conf.

getLensConf

@Generated(value="lombok")
public LensConf getLensConf()

The query conf.

getDriverContext

@Generated(value="lombok")
public DriverSelectorQueryContext getDriverContext()

The driver ctx

setDriverContext

@Generated(value="lombok")
public void setDriverContext(DriverSelectorQueryContext driverContext)

The driver ctx

getSelectedDriverQueryCost

@Generated(value="lombok")
public QueryCost getSelectedDriverQueryCost()

The selected Driver query cost

setSelectedDriverQueryCost

@Generated(value="lombok")
public void setSelectedDriverQueryCost(QueryCost selectedDriverQueryCost)

The selected Driver query cost

getSubmittedUser

@Generated(value="lombok")
public String getSubmittedUser()

The submitted user.

getLensSessionIdentifier

@Generated(value="lombok")
public String getLensSessionIdentifier()

The lens session identifier.

setLensSessionIdentifier

@Generated(value="lombok")
public void setLensSessionIdentifier(String lensSessionIdentifier)

The lens session identifier.

isDriverQueryExplicitlySet

@Generated(value="lombok")
public boolean isDriverQueryExplicitlySet()

Will be set to true when the driver queries are explicitly set This will help avoiding rewrites in case of system restarts.

isOlapQuery

@Generated(value="lombok")
public boolean isOlapQuery()

Is olap cube query or not

setOlapQuery

@Generated(value="lombok")
public void setOlapQuery(boolean olapQuery)

Is olap cube query or not