org.apache.drill.exec.record

Class AbstractRecordBatch<T extends PhysicalOperator>

java.lang.Object

org.apache.drill.exec.record.AbstractRecordBatch<T>

All Implemented Interfaces:

AutoCloseable, Iterable<VectorWrapper<?>>, CloseableRecordBatch, RecordBatch, VectorAccessible

Direct Known Subclasses:

AbstractBinaryRecordBatch, AbstractUnaryRecordBatch, ExternalSortBatch, HashAggBatch, MergingRecordBatch, OrderedPartitionRecordBatch, ProducerConsumerBatch, RowKeyJoinBatch, SortBatch, StatisticsWriterRecordBatch, StreamingAggBatch, TopNBatch, WindowFrameRecordBatch, WriterRecordBatch

public abstract class AbstractRecordBatch<T extends PhysicalOperator>
extends Object
implements CloseableRecordBatch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRecordBatch.BatchState

Nested classes/interfaces inherited from interface org.apache.drill.exec.record.RecordBatch

RecordBatch.IterOutcome

Field Summary

Fields

Modifier and Type	Field and Description
protected RecordBatchStats.RecordBatchStatsContext	batchStatsContext
protected VectorContainer	container
protected FragmentContext	context
protected OperatorContext	oContext
protected T	popConfig
protected AbstractRecordBatch.BatchState	state
protected OperatorStats	stats
protected boolean	unionTypeEnabled

Fields inherited from interface org.apache.drill.exec.record.RecordBatch

MAX_BATCH_ROW_COUNT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRecordBatch(T popConfig, FragmentContext context)
protected	AbstractRecordBatch(T popConfig, FragmentContext context, boolean buildSchema)
protected	AbstractRecordBatch(T popConfig, FragmentContext context, boolean buildSchema, OperatorContext oContext)

Method Summary

Modifier and Type	Method and Description
protected void	buildSchema()
void	cancel() Informs child operators that no more data is needed.
protected abstract void	cancelIncoming()
void	checkContinue() Checks if the query should continue.
void	close()
VectorContainer	getContainer() Return the internal vector container
FragmentContext	getContext() Gets the FragmentContext of the current query fragment.
VectorContainer	getOutgoingContainer()
T	getPopConfig()
RecordBatchStats.RecordBatchStatsContext	getRecordBatchStatsContext()
BatchSchema	getSchema() Gets the current schema of this record batch.
SelectionVector2	getSelectionVector2()
SelectionVector4	getSelectionVector4()
VectorWrapper<?>	getValueAccessorById(Class<?> clazz, int... ids)
TypedFieldId	getValueVectorId(SchemaPath path) Gets the value vector type and ID for the given schema path.
WritableBatch	getWritableBatch() Gets a writable version of this batch.
abstract RecordBatch.IterOutcome	innerNext()
boolean	isRecordBatchStatsLoggingEnabled()
Iterator<VectorWrapper<?>>	iterator()
RecordBatch.IterOutcome	next() Updates the data in each Field reading interface for the next range of records.
RecordBatch.IterOutcome	next(int inputIndex, RecordBatch b)
RecordBatch.IterOutcome	next(RecordBatch b)
protected UserException	schemaChangeException(SchemaChangeException e, org.slf4j.Logger logger)
static UserException	schemaChangeException(SchemaChangeException e, String operator, org.slf4j.Logger logger)

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.record.RecordBatch

dump

Methods inherited from interface org.apache.drill.exec.record.VectorAccessible

getRecordCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

container

protected final VectorContainer container

popConfig

protected final T extends PhysicalOperator popConfig

context

protected final FragmentContext context

oContext

protected final OperatorContext oContext

batchStatsContext

protected final RecordBatchStats.RecordBatchStatsContext batchStatsContext

stats

protected final OperatorStats stats

unionTypeEnabled

protected final boolean unionTypeEnabled

state

protected AbstractRecordBatch.BatchState state

Constructor Detail

AbstractRecordBatch

protected AbstractRecordBatch(T popConfig,
                              FragmentContext context)
                       throws OutOfMemoryException

Throws:

OutOfMemoryException

AbstractRecordBatch

protected AbstractRecordBatch(T popConfig,
                              FragmentContext context,
                              boolean buildSchema)
                       throws OutOfMemoryException

Throws:

OutOfMemoryException

AbstractRecordBatch

protected AbstractRecordBatch(T popConfig,
                              FragmentContext context,
                              boolean buildSchema,
                              OperatorContext oContext)

Method Detail

iterator

public Iterator<VectorWrapper<?>> iterator()

Specified by:

iterator in interface Iterable<VectorWrapper<?>>

getContext

public FragmentContext getContext()

Description copied from interface: RecordBatch

Gets the FragmentContext of the current query fragment. Useful for reporting failure information or other query-level information.

Specified by:

getContext in interface RecordBatch

getPopConfig

public T getPopConfig()

next

public final RecordBatch.IterOutcome next(RecordBatch b)

next

public final RecordBatch.IterOutcome next(int inputIndex,
                                          RecordBatch b)

next

public final RecordBatch.IterOutcome next()

Description copied from interface: RecordBatch

Updates the data in each Field reading interface for the next range of records.

Once a RecordBatch's next() has returned RecordBatch.IterOutcome.NONE or IterOutcome#STOP, the consumer should no longer call next(). Behavior at this point is undefined and likely to throw an exception.

See RecordBatch.IterOutcome for the protocol (possible sequences of return values).

Specified by:

next in interface RecordBatch

Returns:

An IterOutcome describing the result of the iteration.

innerNext

public abstract RecordBatch.IterOutcome innerNext()

getSchema

public BatchSchema getSchema()

Description copied from interface: RecordBatch

Gets the current schema of this record batch.

May be called only when the most recent call to RecordBatch.next(), if any, returned RecordBatch.IterOutcome.OK_NEW_SCHEMA or RecordBatch.IterOutcome.OK.

The schema changes when and only when RecordBatch.next() returns RecordBatch.IterOutcome.OK_NEW_SCHEMA.

Specified by:

getSchema in interface RecordBatch

Specified by:

getSchema in interface VectorAccessible

Returns:

schema of the current batch

buildSchema

protected void buildSchema()

cancel

public void cancel()

Description copied from interface: RecordBatch

Informs child operators that no more data is needed. Only called for "normal" cancellation to avoid unnecessary compute in any worker threads. For the error case, the fragment executor will call close() on each child automatically.

The operator which triggers the cancel MUST send a NONE status downstream, or throw an exception. It is not legal to call next() on an operator after calling its cancel() method.

Specified by:

cancel in interface RecordBatch

cancelIncoming

protected abstract void cancelIncoming()

close

public void close()

Specified by:

close in interface AutoCloseable

getSelectionVector2

public SelectionVector2 getSelectionVector2()

Specified by:

getSelectionVector2 in interface VectorAccessible

getSelectionVector4

public SelectionVector4 getSelectionVector4()

Specified by:

getSelectionVector4 in interface VectorAccessible

getValueVectorId

public TypedFieldId getValueVectorId(SchemaPath path)

Description copied from interface: RecordBatch

Gets the value vector type and ID for the given schema path. The TypedFieldId should store a fieldId which is the same as the ordinal position of the field within the Iterator provided this class's implementation of Iterable<ValueVector>.

Specified by:

getValueVectorId in interface RecordBatch

Specified by:

getValueVectorId in interface VectorAccessible

Parameters:

path - The path where the vector should be located.

Returns:

The local field id associated with this vector. If no field matches this path, this will return a null TypedFieldId

getValueAccessorById

public VectorWrapper<?> getValueAccessorById(Class<?> clazz,
                                             int... ids)

Specified by:

getValueAccessorById in interface RecordBatch

Specified by:

getValueAccessorById in interface VectorAccessible

getWritableBatch

public WritableBatch getWritableBatch()

Description copied from interface: RecordBatch

Gets a writable version of this batch. Takes over ownership of existing buffers.

Specified by:

getWritableBatch in interface RecordBatch

getOutgoingContainer

public VectorContainer getOutgoingContainer()

Specified by:

getOutgoingContainer in interface RecordBatch

getContainer

public VectorContainer getContainer()

Description copied from interface: RecordBatch

Return the internal vector container

Specified by:

getContainer in interface RecordBatch

Returns:

The internal vector container

getRecordBatchStatsContext

public RecordBatchStats.RecordBatchStatsContext getRecordBatchStatsContext()

isRecordBatchStatsLoggingEnabled

public boolean isRecordBatchStatsLoggingEnabled()

checkContinue

public void checkContinue()

Checks if the query should continue. Throws a UserException if not. Operators should call this periodically to detect cancellation requests. The operator need not catch the exception: it will bubble up the operator tree and be handled like any other fatal error.

schemaChangeException

protected UserException schemaChangeException(SchemaChangeException e,
                                              org.slf4j.Logger logger)

schemaChangeException

public static UserException schemaChangeException(SchemaChangeException e,
                                                  String operator,
                                                  org.slf4j.Logger logger)