org.apache.drill.test

Class OperatorFixture.MockFragmentContext

java.lang.Object

org.apache.drill.exec.ops.BaseFragmentContext

org.apache.drill.test.OperatorFixture.MockFragmentContext

All Implemented Interfaces:

AutoCloseable, FragmentContext, UdfUtilities

Direct Known Subclasses:

PhysicalOpUnitTestBase.MockExecutorFragmentContext

Enclosing class:

OperatorFixture

public static class OperatorFixture.MockFragmentContext
extends BaseFragmentContext

Provide a simplified test-time code generation context that uses the same code generation mechanism as the full Drill, but provide test-specific versions of various other services.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.drill.exec.ops.FragmentContext

FragmentContext.ExecutorState

Field Summary

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

INJECTABLE_GETTER_METHODS

Constructor Summary

Constructors

Constructor and Description
MockFragmentContext(DrillConfig config, OptionManager options, BufferAllocator allocator, ExecutorService scanExecutorService, ExecutorService scanDecodeExecutorService)

Method Summary

Modifier and Type	Method and Description
void	addRuntimeFilter(RuntimeFilterWritable runtimeFilter) Add a RuntimeFilter when the RuntimeFilter receiver belongs to the same MinorFragment.
void	close()
AliasRegistryProvider	getAliasRegistryProvider() Get an instance of alias registry provider for obtaining aliases.
BufferAllocator	getAllocator()
protected BufferManager	getBufferManager()
CodeCompiler	getCompiler()
DrillConfig	getConfig() Returns the Drill configuration for this run.
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.
ExecutionControls	getExecutionControls() Return the set of execution controls used to inject faults into running code for testing.
ExecutorService	getExecutor()
FragmentContext.ExecutorState	getExecutorState()
String	getFragIdString()
org.apache.calcite.schema.SchemaPlus	getFullRootSchema()
ExecProtos.FragmentHandle	getHandle()
MetastoreRegistry	getMetastoreRegistry() Get instance of Metastore registry to obtain Metastore instance if needed.
BufferAllocator	getNewChildAllocator(String operatorName, int operatorId, long initialReservation, long maximumReservation)
OptionManager	getOptions() 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()
RuntimeFilterWritable	getRuntimeFilter(long rfIdentifier)
RuntimeFilterWritable	getRuntimeFilter(long rfIdentifier, long maxWaitTime, TimeUnit timeUnit) Get the RuntimeFilter with a blocking wait, if the waiting option is enabled.
ExecutorService	getScanDecodeExecutor()
ExecutorService	getScanExecutor()
boolean	isImpersonationEnabled()
OperatorContext	newOperatorContext(PhysicalOperator popConfig)
OperatorContext	newOperatorContext(PhysicalOperator popConfig, OperatorStats stats)
void	requestMemory(RecordBatch requestor) An operator is experiencing memory pressure.

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

getFunctionRegistry, getImplementationClass, getImplementationClass, getImplementationClass, getImplementationClass, getManagedBuffer, getManagedBuffer, getManagedBufferManager, getQueryId, getQueryIdString, getSQLStatementType, replace

Methods inherited from class java.lang.Object

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

Constructor Detail

MockFragmentContext

public MockFragmentContext(DrillConfig config,
                           OptionManager options,
                           BufferAllocator allocator,
                           ExecutorService scanExecutorService,
                           ExecutorService scanDecodeExecutorService)

Method Detail

getOptions

public OptionManager getOptions()

Description copied from interface: FragmentContext

Returns a read-only version of the session options.

Returns:

the session options

isImpersonationEnabled

public boolean isImpersonationEnabled()

getExecutionControls

public ExecutionControls getExecutionControls()

Description copied from interface: FragmentContext

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

Returns:

the execution controls

getConfig

public DrillConfig getConfig()

Description copied from interface: FragmentContext

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

Returns:

the Drill configuration

getScanDecodeExecutor

public ExecutorService getScanDecodeExecutor()

getScanExecutor

public ExecutorService getScanExecutor()

getExecutor

public ExecutorService getExecutor()

getExecutorState

public FragmentContext.ExecutorState getExecutorState()

getNewChildAllocator

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

getHandle

public ExecProtos.FragmentHandle getHandle()

getAllocator

public BufferAllocator getAllocator()

newOperatorContext

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

Throws:

OutOfMemoryException

newOperatorContext

public OperatorContext newOperatorContext(PhysicalOperator popConfig)
                                   throws OutOfMemoryException

Throws:

OutOfMemoryException

getQueryUserName

public String getQueryUserName()

Specified by:

getQueryUserName in interface FragmentContext

Overrides:

getQueryUserName in class BaseFragmentContext

getFullRootSchema

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

getFragIdString

public String getFragIdString()

getCompiler

public CodeCompiler getCompiler()

getBufferManager

protected BufferManager getBufferManager()

Specified by:

getBufferManager in class BaseFragmentContext

close

public void close()

addRuntimeFilter

public void addRuntimeFilter(RuntimeFilterWritable runtimeFilter)

Description copied from interface: FragmentContext

Add a RuntimeFilter when the RuntimeFilter receiver belongs to the same MinorFragment.

Parameters:

runtimeFilter - runtime filter

getRuntimeFilter

public RuntimeFilterWritable getRuntimeFilter(long rfIdentifier)

getRuntimeFilter

public RuntimeFilterWritable getRuntimeFilter(long rfIdentifier,
                                              long maxWaitTime,
                                              TimeUnit timeUnit)

Description copied from interface: FragmentContext

Get the RuntimeFilter with a blocking wait, if the waiting option is enabled.

Parameters:

rfIdentifier - runtime filter identifier

maxWaitTime - max wait time

timeUnit - time unit

Returns:

the RFW or null

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.

Returns:

- ContextInformation

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.

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.

Returns:

- a wrapper object for an constant value.

getMetastoreRegistry

public MetastoreRegistry getMetastoreRegistry()

Description copied from interface: FragmentContext

Get instance of Metastore registry to obtain Metastore instance if needed.

Returns:

Metastore registry

getAliasRegistryProvider

public AliasRegistryProvider getAliasRegistryProvider()

Description copied from interface: FragmentContext

Get an instance of alias registry provider for obtaining aliases.

Returns:

alias registry provider

requestMemory

public void requestMemory(RecordBatch requestor)

Description copied from interface: FragmentContext

An operator is experiencing memory pressure. Asks the fragment executor to poll all operators to release an optional memory (such as by spilling.) The request is advisory. The caller should again try to allocate memory, and if the second request fails, throw an OutOfMemoryException.