org.apache.drill.exec.ops

Class FragmentContext

java.lang.Object

org.apache.drill.exec.ops.BaseFragmentContext

org.apache.drill.exec.ops.FragmentContext

All Implemented Interfaces:

AutoCloseable, FragmentContextInterface, UdfUtilities

public class FragmentContext
extends BaseFragmentContext
implements AutoCloseable, UdfUtilities, FragmentContextInterface

Contextual objects required for execution of a particular fragment. This is the implementation; use FragmentContextInterface in code to allow tests to use test-time implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FragmentContext.ExecutorState

Field Summary

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

INJECTABLE_GETTER_METHODS

Constructor Summary

Constructors

Constructor and Description
FragmentContext(DrillbitContext dbContext, BitControl.PlanFragment fragment, FunctionImplementationRegistry funcRegistry) Create a FragmentContext instance for non-root fragment.
FragmentContext(DrillbitContext dbContext, BitControl.PlanFragment fragment, QueryContext queryContext, UserClientConnection connection, FunctionImplementationRegistry funcRegistry) Create a FragmentContext instance for root fragment.
FragmentContext(DrillbitContext dbContext, BitControl.PlanFragment fragment, UserClientConnection connection, FunctionImplementationRegistry funcRegistry) TODO: Remove this constructor when removing the SimpleRootExec (DRILL-2097).

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	fail(Throwable cause)
BufferAllocator	getAllocator() Deprecated.
protected BufferManager	getBufferManager()
IncomingBuffers	getBuffers()
protected CodeCompiler	getCompiler()
DrillConfig	getConfig() Returns the Drill configuration for this run.
ValueHolder	getConstantValueHolder(String value, TypeProtos.MinorType type, 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.
ControlTunnel	getControlTunnel(CoordinationProtos.DrillbitEndpoint endpoint)
AccountingDataTunnel	getDataTunnel(CoordinationProtos.DrillbitEndpoint endpoint)
DrillbitContext	getDrillbitContext() Drillbit context.
ExecutionControls	getExecutionControls() Return the set of execution controls used to inject faults into running code for testing.
Executor	getExecutor()
Throwable	getFailureCause() Deprecated.
CoordinationProtos.DrillbitEndpoint	getForemanEndpoint()
String	getFragIdString()
org.apache.calcite.schema.SchemaPlus	getFullRootSchema() This method is only used to construt InfoSchemaReader, it is for the reader to get full schema, so here we are going to return a fully initialized schema tree.
ExecProtos.FragmentHandle	getHandle() The FragmentHandle for this Fragment
CoordinationProtos.DrillbitEndpoint	getIdentity() Get this node's identity.
BufferAllocator	getNewChildAllocator(String operatorName, int operatorId, long initialReservation, long maximumReservation)
OptionManager	getOptions()
OptionSet	getOptionSet() Returns a read-only version of the session options.
PartitionExplorer	getPartitionExplorer() A partition explorer allows UDFs to view the sub-partitions below a particular partition.
String	getQueryUserName()
FragmentStats	getStats()
AccountingUserConnection	getUserDataTunnel()
WorkEventBus	getWorkEventbus()
boolean	isBuffersDone()
boolean	isFailed() Deprecated.
boolean	isImpersonationEnabled()
boolean	isOverMemoryLimit()
OperatorContext	newOperatorContext(PhysicalOperator popConfig)
OperatorContext	newOperatorContext(PhysicalOperator popConfig, OperatorStats stats)
void	setBuffers(IncomingBuffers buffers)
void	setExecutorState(FragmentContext.ExecutorState executorState)
void	setFragmentLimit(long limit)
boolean	shouldContinue() Tells individual operations whether they should continue.
void	waitForSendComplete() Wait for ack that all outgoing batches have been sent

Methods inherited from class org.apache.drill.exec.ops.BaseFragmentContext

getFunctionRegistry, getImplementationClass, getImplementationClass, getImplementationClass, getImplementationClass, getManagedBuffer, getManagedBuffer, replace

Methods inherited from class java.lang.Object

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

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

getManagedBuffer

Methods inherited from interface org.apache.drill.exec.ops.FragmentContextInterface

getFunctionRegistry, getImplementationClass, getImplementationClass, getImplementationClass, getImplementationClass, getManagedBuffer, getManagedBuffer, replace

Constructor Detail

FragmentContext

public FragmentContext(DrillbitContext dbContext,
               BitControl.PlanFragment fragment,
               FunctionImplementationRegistry funcRegistry)
                throws ExecutionSetupException

Create a FragmentContext instance for non-root fragment.

Parameters:

dbContext - DrillbitContext.

fragment - Fragment implementation.

funcRegistry - FunctionImplementationRegistry.

Throws:

ExecutionSetupException

FragmentContext

public FragmentContext(DrillbitContext dbContext,
               BitControl.PlanFragment fragment,
               QueryContext queryContext,
               UserClientConnection connection,
               FunctionImplementationRegistry funcRegistry)
                throws ExecutionSetupException

Create a FragmentContext instance for root fragment.

Parameters:

dbContext - DrillbitContext.

fragment - Fragment implementation.

queryContext - QueryContext.

connection - UserClientConnection.

funcRegistry - FunctionImplementationRegistry.

Throws:

ExecutionSetupException

FragmentContext

public FragmentContext(DrillbitContext dbContext,
               BitControl.PlanFragment fragment,
               UserClientConnection connection,
               FunctionImplementationRegistry funcRegistry)
                throws ExecutionSetupException

TODO: Remove this constructor when removing the SimpleRootExec (DRILL-2097). This is kept only to avoid modifying the long list of test files.

Throws:

ExecutionSetupException

Method Detail

getOptions

public OptionManager getOptions()

getOptionSet

public OptionSet getOptionSet()

Description copied from interface: FragmentContextInterface

Returns a read-only version of the session options.

Specified by:

getOptionSet in interface FragmentContextInterface

Returns:

the session options

setBuffers

public void setBuffers(IncomingBuffers buffers)

setExecutorState

public void setExecutorState(FragmentContext.ExecutorState executorState)

fail

public void fail(Throwable cause)

shouldContinue

public boolean shouldContinue()

Tells individual operations whether they should continue. In some cases, an external event (typically cancellation) will mean that the fragment should prematurely exit execution. Long running operations should check this every so often so that Drill is responsive to cancellation operations.

Specified by:

shouldContinue in interface FragmentContextInterface

Returns:

false if the action should terminate immediately, true if everything is okay.

getDrillbitContext

public DrillbitContext getDrillbitContext()

Description copied from interface: FragmentContextInterface

Drillbit context. Valid only in production; returns null in operator test environments.

Specified by:

getDrillbitContext in interface FragmentContextInterface

getFullRootSchema

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

This method is only used to construt InfoSchemaReader, it is for the reader to get full schema, so here we are going to return a fully initialized schema tree.

Returns:

root schema's plus

getIdentity

public CoordinationProtos.DrillbitEndpoint getIdentity()

Get this node's identity.

Returns:

A DrillbitEndpoint object.

getStats

public FragmentStats getStats()

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

getForemanEndpoint

public CoordinationProtos.DrillbitEndpoint getForemanEndpoint()

getHandle

public ExecProtos.FragmentHandle getHandle()

The FragmentHandle for this Fragment

Returns:

FragmentHandle

getFragIdString

public String getFragIdString()

getAllocator

@Deprecated
public BufferAllocator getAllocator()

Deprecated.

Get this fragment's allocator.

Returns:

the allocator

getNewChildAllocator

public BufferAllocator getNewChildAllocator(String operatorName,
                                   int operatorId,
                                   long initialReservation,
                                   long maximumReservation)
                                     throws OutOfMemoryException

Throws:

OutOfMemoryException

isOverMemoryLimit

public boolean isOverMemoryLimit()

getCompiler

protected CodeCompiler getCompiler()

Specified by:

getCompiler in class BaseFragmentContext

getUserDataTunnel

public AccountingUserConnection getUserDataTunnel()

getControlTunnel

public ControlTunnel getControlTunnel(CoordinationProtos.DrillbitEndpoint endpoint)

getDataTunnel

public AccountingDataTunnel getDataTunnel(CoordinationProtos.DrillbitEndpoint endpoint)

getBuffers

public IncomingBuffers getBuffers()

newOperatorContext

public OperatorContext newOperatorContext(PhysicalOperator popConfig,
                                 OperatorStats stats)
                                   throws OutOfMemoryException

Throws:

OutOfMemoryException

newOperatorContext

public OperatorContext newOperatorContext(PhysicalOperator popConfig)
                                   throws OutOfMemoryException

Throws:

OutOfMemoryException

getFailureCause

@Deprecated
public Throwable getFailureCause()

Deprecated.

isFailed

@Deprecated
public boolean isFailed()

Deprecated.

getConfig

public DrillConfig getConfig()

Description copied from interface: FragmentContextInterface

Returns the Drill configuration for this run. Note that the config is global and immutable.

Specified by:

getConfig in interface FragmentContextInterface

Returns:

the Drill configuration

setFragmentLimit

public void setFragmentLimit(long limit)

getExecutionControls

public ExecutionControls getExecutionControls()

Description copied from interface: FragmentContextInterface

Return the set of execution controls used to inject faults into running code for testing.

Specified by:

getExecutionControls in interface FragmentContextInterface

Returns:

the execution controls

getQueryUserName

public String getQueryUserName()

isImpersonationEnabled

public boolean isImpersonationEnabled()

close

public void close()

Specified by:

close in interface AutoCloseable

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,
                                 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.

getExecutor

public Executor getExecutor()

waitForSendComplete

public void waitForSendComplete()

Wait for ack that all outgoing batches have been sent

getWorkEventbus

public WorkEventBus getWorkEventbus()

isBuffersDone

public boolean isBuffersDone()

getBufferManager

protected BufferManager getBufferManager()

Specified by:

getBufferManager in class BaseFragmentContext