org.apache.drill.exec.ops

Class QueryContext

java.lang.Object

org.apache.drill.exec.ops.QueryContext

All Implemented Interfaces:

AutoCloseable, OptimizerRulesContext, UdfUtilities, SchemaConfig.SchemaConfigInfoProvider

public class QueryContext
extends Object
implements AutoCloseable, OptimizerRulesContext, SchemaConfig.SchemaConfigInfoProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryContext.SqlStatementType

Field Summary

Fields inherited from interface org.apache.drill.exec.ops.UdfUtilities

INJECTABLE_GETTER_METHODS

Constructor Summary

Constructors

Constructor and Description
QueryContext(UserSession session, DrillbitContext drillbitContext, UserBitShared.QueryId queryId)

Method Summary

Modifier and Type	Method and Description
void	clearSQLStatementType() Clears the type QueryContext.SqlStatementType of the statement.
void	close()
Collection<CoordinationProtos.DrillbitEndpoint>	getActiveEndpoints()
AliasRegistryProvider	getAliasRegistryProvider()
BufferAllocator	getAllocator() Method returns the allocator
DrillConfig	getConfig()
ValueHolder	getConstantValueHolder(String value, TypeProtos.MinorType type, org.apache.drill.shaded.guava.com.google.common.base.Function<DrillBuf,ValueHolder> holderInitializer) Works with value holders cache which holds constant value and its wrapper by type.
ContextInformation	getContextInformation() Get the context information such as: - query start time - root fragment timezone - query userName - system userName - default schema name in current session at the time of query.
CoordinationProtos.DrillbitEndpoint	getCurrentEndpoint()
DrillOperatorTable	getDrillOperatorTable()
ExecutionControls	getExecutionControls()
FunctionImplementationRegistry	getFunctionRegistry() Method returns the function registry
LogicalPlanPersistence	getLpPersistence()
DrillBuf	getManagedBuffer() For UDFs to allocate general purpose intermediate buffers we provide the DrillBuf type as an injectable, which provides access to an off-heap buffer that can be tracked by Drill and re-allocated as needed.
MetastoreRegistry	getMetastoreRegistry()
org.apache.calcite.schema.SchemaPlus	getNewDefaultSchema() Return reference to default schema instance in a schema tree.
Collection<CoordinationProtos.DrillbitEndpoint>	getOnlineEndpoints()
OptionValue	getOption(String optionKey)
QueryOptionManager	getOptions()
PartitionExplorer	getPartitionExplorer() A partition explorer allows UDFs to view the sub-partitions below a particular partition.
PlannerSettings	getPlannerSettings() Method returns the planner options
QueryProfileStoreContext	getProfileStoreContext()
BitControl.QueryContextInformation	getQueryContextInfo()
UserBitShared.QueryId	getQueryId()
String	getQueryUserName() Get the user name of the user who issued the query that is managed by this QueryContext.
RemoteFunctionRegistry	getRemoteFunctionRegistry()
org.apache.calcite.schema.SchemaPlus	getRootSchema() Get root schema with schema owner as the user who issued the query that is managed by this QueryContext.
org.apache.calcite.schema.SchemaPlus	getRootSchema(SchemaConfig schemaConfig) Create and return a SchemaPlus with given schemaConfig but some schemas (from storage plugins) could be initialized later.
org.apache.calcite.schema.SchemaPlus	getRootSchema(String userName) Return root schema with schema owner as the given user.
UserSession	getSession()
QueryContext.SqlStatementType	getSQLStatementType()
StoragePluginRegistry	getStorage()
ViewExpansionContext	getViewExpansionContext()
boolean	isImpersonationEnabled()
boolean	isRuntimeFilterEnabled()
boolean	isSkipProfileWrite()
boolean	isUserAuthenticationEnabled()
void	reloadDrillOperatorTable() Re-creates drill operator table to refresh functions list from local function registry.
void	setSQLStatementType(QueryContext.SqlStatementType stmtType)
void	skipWritingProfile(boolean skipWriting) Skip writing profile

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryContext

public QueryContext(UserSession session,
                    DrillbitContext drillbitContext,
                    UserBitShared.QueryId queryId)

Method Detail

getPlannerSettings

public PlannerSettings getPlannerSettings()

Description copied from interface: OptimizerRulesContext

Method returns the planner options

Specified by:

getPlannerSettings in interface OptimizerRulesContext

Returns:

PlannerSettings

getSession

public UserSession getSession()

getAllocator

public BufferAllocator getAllocator()

Description copied from interface: OptimizerRulesContext

Method returns the allocator

Specified by:

getAllocator in interface OptimizerRulesContext

Returns:

BufferAllocator

getQueryId

public UserBitShared.QueryId getQueryId()

getNewDefaultSchema

public org.apache.calcite.schema.SchemaPlus getNewDefaultSchema()

Return reference to default schema instance in a schema tree. Each SchemaPlus instance can refer to its parent and its children. From the returned reference to default schema instance, clients can traverse the entire schema tree and know the default schema where to look up the tables first.

Returns:

Reference to default schema instance in a schema tree.

getRootSchema

public org.apache.calcite.schema.SchemaPlus getRootSchema()

Get root schema with schema owner as the user who issued the query that is managed by this QueryContext.

Returns:

Root of the schema tree.

getRootSchema

public org.apache.calcite.schema.SchemaPlus getRootSchema(String userName)

Return root schema with schema owner as the given user.

Specified by:

getRootSchema in interface SchemaConfig.SchemaConfigInfoProvider

Parameters:

userName - User who owns the schema tree.

Returns:

Root of the schema tree.

getRootSchema

public org.apache.calcite.schema.SchemaPlus getRootSchema(SchemaConfig schemaConfig)

Create and return a SchemaPlus with given schemaConfig but some schemas (from storage plugins) could be initialized later.

Parameters:

schemaConfig -

Returns:

A SchemaPlus with given schemaConfig.

getQueryUserName

public String getQueryUserName()

Get the user name of the user who issued the query that is managed by this QueryContext.

Specified by:

getQueryUserName in interface SchemaConfig.SchemaConfigInfoProvider

Returns:

The user name of the user who issued the query that is managed by this QueryContext.

getOptions

public QueryOptionManager getOptions()

getExecutionControls

public ExecutionControls getExecutionControls()

getCurrentEndpoint

public CoordinationProtos.DrillbitEndpoint getCurrentEndpoint()

getStorage

public StoragePluginRegistry getStorage()

getLpPersistence

public LogicalPlanPersistence getLpPersistence()

getActiveEndpoints

public Collection<CoordinationProtos.DrillbitEndpoint> getActiveEndpoints()

getOnlineEndpoints

public Collection<CoordinationProtos.DrillbitEndpoint> getOnlineEndpoints()

getConfig

public DrillConfig getConfig()

getProfileStoreContext

public QueryProfileStoreContext getProfileStoreContext()

getFunctionRegistry

public FunctionImplementationRegistry getFunctionRegistry()

Description copied from interface: OptimizerRulesContext

Method returns the function registry

Specified by:

getFunctionRegistry in interface OptimizerRulesContext

Returns:

FunctionImplementationRegistry

getViewExpansionContext

public ViewExpansionContext getViewExpansionContext()

Specified by:

getViewExpansionContext in interface SchemaConfig.SchemaConfigInfoProvider

getOption

public OptionValue getOption(String optionKey)

Specified by:

getOption in interface SchemaConfig.SchemaConfigInfoProvider

isImpersonationEnabled

public boolean isImpersonationEnabled()

isUserAuthenticationEnabled

public boolean isUserAuthenticationEnabled()

isRuntimeFilterEnabled

public boolean isRuntimeFilterEnabled()

getDrillOperatorTable

public DrillOperatorTable getDrillOperatorTable()

reloadDrillOperatorTable

public void reloadDrillOperatorTable()

Re-creates drill operator table to refresh functions list from local function registry.

getQueryContextInfo

public BitControl.QueryContextInformation getQueryContextInfo()

getRemoteFunctionRegistry

public RemoteFunctionRegistry getRemoteFunctionRegistry()

getContextInformation

public ContextInformation getContextInformation()

Description copied from interface: UdfUtilities

Get the context information such as: - query start time - root fragment timezone - query userName - system userName - default schema name in current session at the time of query.

Specified by:

getContextInformation in interface UdfUtilities

Returns:

- ContextInformation

getManagedBuffer

public DrillBuf getManagedBuffer()

Description copied from interface: UdfUtilities

For UDFs to allocate general purpose intermediate buffers we provide the DrillBuf type as an injectable, which provides access to an off-heap buffer that can be tracked by Drill and re-allocated as needed.

Specified by:

getManagedBuffer in interface UdfUtilities

Returns:

- a buffer managed by Drill, connected to the fragment allocator for memory management

getPartitionExplorer

public PartitionExplorer getPartitionExplorer()

Description copied from interface: UdfUtilities

A partition explorer allows UDFs to view the sub-partitions below a particular partition. This allows for the implementation of UDFs to query against the partition information, without having to read the actual data contained in the partition. This interface is designed for UDFs that take only constant inputs, as this interface will only be useful if we can evaluate the constant UDF at planning time. Any function defined to use this interface that is not evaluated at planning time by the constant folding rule will be querying the storage plugin for meta-data for each record processed. Be sure to check the query plans to see that this expression has already been evaluated during planning if you write UDFs against this interface. See DirectoryExplorers for example usages of this interface.

Specified by:

getPartitionExplorer in interface UdfUtilities

Returns:

- an object for exploring partitions of all available schemas

getConstantValueHolder

public ValueHolder getConstantValueHolder(String value,
                                          TypeProtos.MinorType type,
                                          org.apache.drill.shaded.guava.com.google.common.base.Function<DrillBuf,ValueHolder> holderInitializer)

Description copied from interface: UdfUtilities

Works with value holders cache which holds constant value and its wrapper by type. If value is absent uses holderInitializer to create holder and adds it to cache.

Specified by:

getConstantValueHolder in interface UdfUtilities

Returns:

- a wrapper object for an constant value.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

setSQLStatementType

public void setSQLStatementType(QueryContext.SqlStatementType stmtType)

Parameters:

stmtType - : Sets the type QueryContext.SqlStatementType of the statement e.g. CTAS, ANALYZE

clearSQLStatementType

public void clearSQLStatementType()

Clears the type QueryContext.SqlStatementType of the statement.

getSQLStatementType

public QueryContext.SqlStatementType getSQLStatementType()

Returns:

Get the type QueryContext.SqlStatementType of the statement e.g. CTAS, ANALYZE

skipWritingProfile

public void skipWritingProfile(boolean skipWriting)

Skip writing profile

Parameters:

skipWriting -

isSkipProfileWrite

public boolean isSkipProfileWrite()

Returns:

Check if to skip writing

getMetastoreRegistry

public MetastoreRegistry getMetastoreRegistry()

getAliasRegistryProvider

public AliasRegistryProvider getAliasRegistryProvider()