Package org.apache.drill.exec.physical.impl.protocol

Class OperatorRecordBatch

java.lang.Object

org.apache.drill.exec.physical.impl.protocol.OperatorRecordBatch

All Implemented Interfaces:

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

public class OperatorRecordBatch
extends Object
implements CloseableRecordBatch

Modular implementation of the standard Drill record batch iterator protocol. The protocol has two parts: control of the operator and access to the record batch. Each is encapsulated in separate implementation classes to allow easier customization for each situation. The operator internals are, themselves, abstracted to yet another class with the steps represented as method calls rather than as internal states as in the record batch iterator protocol.

Note that downstream operators make an assumption that the same vectors will appear from one batch to the next. That is, not only must the schema be the same, but if column "a" appears in two batches, the same value vector must back "a" in both batches. The TransferPair abstraction fails if different vectors appear across batches.

Nested Class Summary

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

RecordBatch.IterOutcome

Field Summary

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

MAX_BATCH_ROW_COUNT

Constructor Summary

Constructors

Constructor	Description
OperatorRecordBatch(FragmentContext context, PhysicalOperator config, OperatorExec opExec, boolean enableSchemaBatch)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Informs child operators that no more data is needed.
void	close()
void	dump()	Perform dump of this batch's state to logs.
FragmentContext	fragmentContext()
VectorContainer	getContainer()	Return the internal vector container
FragmentContext	getContext()	Gets the FragmentContext of the current query fragment.
VectorContainer	getOutgoingContainer()
int	getRecordCount()	Get the number of records.
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.
Iterator<VectorWrapper<?>>	iterator()
RecordBatch.IterOutcome	next()	Updates the data in each Field reading interface for the next range of records.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

OperatorRecordBatch

public OperatorRecordBatch(FragmentContext context,
 PhysicalOperator config,
 OperatorExec opExec,
 boolean enableSchemaBatch)

Method Details

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

fragmentContext

public FragmentContext fragmentContext()

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

getRecordCount

public int getRecordCount()

Description copied from interface: VectorAccessible

Get the number of records.

Specified by:

getRecordCount in interface VectorAccessible

Returns:

number of records

getOutgoingContainer

public VectorContainer getOutgoingContainer()

Specified by:

getOutgoingContainer in interface RecordBatch

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

getSelectionVector2

public SelectionVector2 getSelectionVector2()

Specified by:

getSelectionVector2 in interface VectorAccessible

getSelectionVector4

public SelectionVector4 getSelectionVector4()

Specified by:

getSelectionVector4 in interface VectorAccessible

iterator

public Iterator<VectorWrapper<?>> iterator()

Specified by:

iterator in interface Iterable<VectorWrapper<?>>

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

next

public 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

invalid reference

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.

close

public void close()

Specified by:

close in interface AutoCloseable

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

dump

public void dump()

Description copied from interface: RecordBatch

Perform dump of this batch's state to logs.

Specified by:

dump in interface RecordBatch