org.apache.drill.exec.physical.base

Interface PhysicalOperator

All Superinterfaces:

GraphValue<PhysicalOperator>, Iterable<PhysicalOperator>

All Known Subinterfaces:

DbGroupScan, DbSubScan, Exchange, FileGroupScan, FragmentLeaf, FragmentRoot, GroupScan, HasAffinity, IndexGroupScan, Leaf, Receiver, Root, Scan, Sender, Store, SubScan, Writer

All Known Implementing Classes:

AbstractBase, AbstractDbGroupScan, AbstractDbSubScan, AbstractDeMuxExchange, AbstractExchange, AbstractFileGroupScan, AbstractGroupScan, AbstractGroupScanWithMetadata, AbstractJoinPop, AbstractMultiple, AbstractMuxExchange, AbstractParquetGroupScan, AbstractParquetRowGroupScan, AbstractReceiver, AbstractSender, AbstractSingle, AbstractStore, AbstractSubScan, AbstractWriter, BaseTestScanLifecycle.DummySubScan, BinaryTableGroupScan, BroadcastExchange, BroadcastSender, ComplexToJson, DirectGroupScan, DirectSubScan, DruidGroupScan, DruidSubScan, EasyGroupScan, EasySubScan, EasyWriter, ExternalSort, Filter, FlattenPOP, HashAggregate, HashJoinPOP, HashPartitionSender, HashToMergeExchange, HashToRandomExchange, HBaseGroupScan, HBaseSubScan, HiveDrillNativeParquetRowGroupScan, HiveDrillNativeParquetScan, HiveScan, HiveSubScan, HttpGroupScan, HttpSubScan, InfoSchemaGroupScan, InfoSchemaSubScan, IteratorValidator, JdbcGroupScan, JdbcSubScan, JsonTableGroupScan, KafkaGroupScan, KafkaSubScan, KuduGroupScan, KuduSubScan, KuduWriter, LateralJoinPOP, Limit, MapRDBGroupScan, MapRDBSubScan, MergeJoinPOP, MergingReceiverPOP, MetadataControllerPOP, MetadataDirectGroupScan, MetadataHandlerPOP, MetadataHashAggPOP, MetadataStreamAggPOP, MockGroupScanPOP, MockStorePOP, MockSubScanPOP, MongoGroupScan, MongoSubScan, NestedLoopJoinPOP, OpenTSDBGroupScan, OpenTSDBSubScan, OperatorTestBuilderTest.MockPhysicalOperator, OrderedMuxExchange, OrderedPartitionExchange, OrderedPartitionSender, ParquetGroupScan, ParquetRowGroupScan, ParquetWriter, PartitionLimit, PhysicalOpUnitTestBase.MockPhysicalOperator, ProducerConsumer, Project, RangePartitionExchange, RangePartitionSender, RestrictedJsonTableGroupScan, RestrictedMapRDBSubScan, RowKeyJoinPOP, RuntimeFilterPOP, SchemalessScan, Screen, SelectionVectorRemover, SingleMergeExchange, SingleSender, Sort, StatisticsAggregate, StatisticsMerge, StreamingAggregate, SystemTableScan, TopN, Trace, UnionAll, UnionExchange, UnnestPOP, UnorderedDeMuxExchange, UnorderedMuxExchange, UnorderedReceiver, UnpivotMaps, Values, WindowPOP

public interface PhysicalOperator
extends GraphValue<PhysicalOperator>

Method Summary

Modifier and Type	Method and Description
<T,X,E extends Throwable> T	accept(PhysicalVisitor<T,X,E> physicalVisitor, X value) Provides capability to build a set of output based on traversing a query graph tree.
PrelCostEstimates	getCost()
long	getInitialAllocation()
long	getMaxAllocation()
PhysicalOperator	getNewWithChildren(List<PhysicalOperator> children) Regenerate with this node with a new set of children.
int	getOperatorId()
int	getOperatorType()
BatchSchema.SelectionVectorMode	getSVMode() Describes the SelectionVector Mode for the output steam from this physical op.
String	getUserName() Name of the user whom to impersonate while setting up the implementation (RecordBatch) of this PhysicalOperator.
boolean	isBufferedOperator(QueryContext queryContext)
boolean	isExecutable() Describes whether or not a particular physical operator can actually be executed.
void	setCost(PrelCostEstimates cost)
void	setMaxAllocation(long maxAllocation)
void	setOperatorId(int id)

Methods inherited from interface org.apache.drill.common.graph.GraphValue

accept

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isExecutable

boolean isExecutable()

Describes whether or not a particular physical operator can actually be executed. Most physical operators can be executed. However, Exchange nodes cannot be executed. In order to be executed, they must be converted into their Exec sub components.

getSVMode

BatchSchema.SelectionVectorMode getSVMode()

Describes the SelectionVector Mode for the output steam from this physical op. This property is used during physical plan creating using PhysicalPlanCreator.

accept

<T,X,E extends Throwable> T accept(PhysicalVisitor<T,X,E> physicalVisitor,
                                   X value)
                            throws E extends Throwable

Provides capability to build a set of output based on traversing a query graph tree.

Parameters:

physicalVisitor -

Throws:

E extends Throwable

getNewWithChildren

PhysicalOperator getNewWithChildren(List<PhysicalOperator> children)
                             throws ExecutionSetupException

Regenerate with this node with a new set of children. This is used in the case of materialization or optimization.

Parameters:

children -

Throws:

ExecutionSetupException

getInitialAllocation

long getInitialAllocation()

Returns:

The memory to preallocate for this operator

getMaxAllocation

long getMaxAllocation()

Returns:

The maximum memory this operator can allocate

setMaxAllocation

void setMaxAllocation(long maxAllocation)

Parameters:

maxAllocation - The max memory allocation to be set

isBufferedOperator

boolean isBufferedOperator(QueryContext queryContext)

Parameters:

queryContext -

Returns:

True iff this operator manages its memory (including disk spilling)

getOperatorId

int getOperatorId()

setOperatorId

void setOperatorId(int id)

setCost

void setCost(PrelCostEstimates cost)

getCost

PrelCostEstimates getCost()

getUserName

String getUserName()

Name of the user whom to impersonate while setting up the implementation (RecordBatch) of this PhysicalOperator. Default value is "null" in which case we impersonate as user who launched the query.

Returns:

getOperatorType

int getOperatorType()