org.apache.drill.exec.ops

Class BaseFragmentContext

java.lang.Object

org.apache.drill.exec.ops.BaseFragmentContext

All Implemented Interfaces:

AutoCloseable, FragmentContext, UdfUtilities

Direct Known Subclasses:

FragmentContextImpl, OperatorFixture.MockFragmentContext

public abstract class BaseFragmentContext
extends Object
implements FragmentContext

Common implementation for both the test and production versions of the fragment context.

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
BaseFragmentContext(FunctionImplementationRegistry funcRegistry)

Method Summary

Modifier and Type	Method and Description
protected abstract BufferManager	getBufferManager()
FunctionImplementationRegistry	getFunctionRegistry() Returns the UDF registry.
<T> T	getImplementationClass(ClassGenerator<T> cg) Generates code for a class given a ClassGenerator, and returns a single instance of the generated class.
<T> List<T>	getImplementationClass(ClassGenerator<T> cg, int instanceCount) Generates code for a class given a ClassGenerator, and returns the specified number of instances of the generated class.
<T> T	getImplementationClass(CodeGenerator<T> cg) Generates code for a class given a CodeGenerator, and returns a single instance of the generated class.
<T> List<T>	getImplementationClass(CodeGenerator<T> cg, int instanceCount) Get this node's identity.
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.
DrillBuf	getManagedBuffer(int size)
BufferManager	getManagedBufferManager()
UserBitShared.QueryId	getQueryId()
String	getQueryIdString()
String	getQueryUserName()
QueryContext.SqlStatementType	getSQLStatementType() Returns the statement type (e.g.
DrillBuf	replace(DrillBuf old, int newSize)

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

addRuntimeFilter, close, getAliasRegistryProvider, getAllocator, getCompiler, getConfig, getExecutionControls, getExecutor, getExecutorState, getFragIdString, getFullRootSchema, getHandle, getMetastoreRegistry, getNewChildAllocator, getOptions, getRuntimeFilter, getRuntimeFilter, getScanDecodeExecutor, getScanExecutor, isImpersonationEnabled, newOperatorContext, newOperatorContext, requestMemory

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

getConstantValueHolder, getContextInformation, getPartitionExplorer

Constructor Detail

BaseFragmentContext

public BaseFragmentContext(FunctionImplementationRegistry funcRegistry)

Method Detail

getFunctionRegistry

public FunctionImplementationRegistry getFunctionRegistry()

Description copied from interface: FragmentContext

Returns the UDF registry.

Specified by:

getFunctionRegistry in interface FragmentContext

Returns:

the UDF registry

getImplementationClass

public <T> T getImplementationClass(ClassGenerator<T> cg)

Description copied from interface: FragmentContext

Generates code for a class given a ClassGenerator, and returns a single instance of the generated class. (Note that the name is a misnomer, it would be better called getImplementationInstance.)

Specified by:

getImplementationClass in interface FragmentContext

Parameters:

cg - the class generator

Returns:

an instance of the generated class

getImplementationClass

public <T> T getImplementationClass(CodeGenerator<T> cg)

Description copied from interface: FragmentContext

Generates code for a class given a CodeGenerator, and returns a single instance of the generated class. (Note that the name is a misnomer, it would be better called getImplementationInstance.)

Specified by:

getImplementationClass in interface FragmentContext

Parameters:

cg - the code generator

Returns:

an instance of the generated class

getImplementationClass

public <T> List<T> getImplementationClass(ClassGenerator<T> cg,
                                          int instanceCount)

Description copied from interface: FragmentContext

Generates code for a class given a ClassGenerator, and returns the specified number of instances of the generated class. (Note that the name is a misnomer, it would be better called getImplementationInstances.)

Specified by:

getImplementationClass in interface FragmentContext

Parameters:

cg - the class generator

Returns:

list of instances of the generated class

getImplementationClass

public <T> List<T> getImplementationClass(CodeGenerator<T> cg,
                                          int instanceCount)

Description copied from interface: FragmentContext

Get this node's identity.

Specified by:

getImplementationClass in interface FragmentContext

Returns:

A DrillbitEndpoint object.

getBufferManager

protected abstract BufferManager getBufferManager()

replace

public DrillBuf replace(DrillBuf old,
                        int newSize)

Specified by:

replace in interface FragmentContext

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 FragmentContext

Specified by:

getManagedBuffer in interface UdfUtilities

Returns:

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

getManagedBuffer

public DrillBuf getManagedBuffer(int size)

Specified by:

getManagedBuffer in interface FragmentContext

getQueryUserName

public String getQueryUserName()

Specified by:

getQueryUserName in interface FragmentContext

getQueryId

public UserBitShared.QueryId getQueryId()

Specified by:

getQueryId in interface FragmentContext

Returns:

ID UUID of the current query

getQueryIdString

public String getQueryIdString()

Specified by:

getQueryIdString in interface FragmentContext

Returns:

The string representation of the ID UUID of the current query

getSQLStatementType

public QueryContext.SqlStatementType getSQLStatementType()

Description copied from interface: FragmentContext

Returns the statement type (e.g. SELECT, CTAS, ANALYZE) from the query context.

Specified by:

getSQLStatementType in interface FragmentContext

Returns:

query statement type QueryContext.SqlStatementType, if known.

getManagedBufferManager

public BufferManager getManagedBufferManager()

Specified by:

getManagedBufferManager in interface FragmentContext