Package org.apache.iotdb.db.mpp.execution.operator.schema

Class SchemaQueryScanOperator

java.lang.Object

org.apache.iotdb.db.mpp.execution.operator.schema.SchemaQueryScanOperator

All Implemented Interfaces:

java.lang.AutoCloseable, Operator, SourceOperator

Direct Known Subclasses:

DevicesSchemaScanOperator, PathsUsingTemplateScanOperator, TimeSeriesSchemaScanOperator

public abstract class SchemaQueryScanOperator
extends java.lang.Object
implements SourceOperator

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isFinished
protected boolean	isPrefixPath
protected int	limit
protected int	offset
protected OperatorContext	operatorContext
protected org.apache.iotdb.commons.path.PartialPath	partialPath
protected PlanNodeId	sourceId
protected org.apache.iotdb.tsfile.read.common.block.TsBlock	tsBlock

Fields inherited from interface org.apache.iotdb.db.mpp.execution.operator.Operator

NOT_BLOCKED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SchemaQueryScanOperator(PlanNodeId sourceId, OperatorContext operatorContext, int limit, int offset, org.apache.iotdb.commons.path.PartialPath partialPath, boolean isPrefixPath)

Method Summary

Modifier and Type	Method	Description
long	calculateMaxPeekMemory()	We should also consider the memory used by its children operator, so the calculation logic may be like: long estimatedOfCurrentOperator = XXXXX; return max(estimatedOfCurrentOperator, child1.calculateMaxPeekMemory(), child2.calculateMaxPeekMemory(), ....)
long	calculateMaxReturnSize()
long	calculateRetainedSizeAfterCallingNext()
protected abstract org.apache.iotdb.tsfile.read.common.block.TsBlock	createTsBlock()
int	getLimit()
int	getOffset()
OperatorContext	getOperatorContext()
org.apache.iotdb.commons.path.PartialPath	getPartialPath()
PlanNodeId	getSourceId()
boolean	hasNext()
boolean	isFinished()	Is this operator completely finished processing and no more output TsBlock will be produced.
boolean	isPrefixPath()
org.apache.iotdb.tsfile.read.common.block.TsBlock	next()	Gets next tsBlock from this operator.
void	setLimit(int limit)
void	setOffset(int offset)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iotdb.db.mpp.execution.operator.Operator

close, isBlocked

Field Detail

operatorContext

protected OperatorContext operatorContext

tsBlock

protected org.apache.iotdb.tsfile.read.common.block.TsBlock tsBlock

isFinished

protected boolean isFinished

limit

protected int limit

offset

protected int offset

partialPath

protected org.apache.iotdb.commons.path.PartialPath partialPath

isPrefixPath

protected boolean isPrefixPath

sourceId

protected PlanNodeId sourceId

Constructor Detail

SchemaQueryScanOperator

protected SchemaQueryScanOperator(PlanNodeId sourceId,
                                  OperatorContext operatorContext,
                                  int limit,
                                  int offset,
                                  org.apache.iotdb.commons.path.PartialPath partialPath,
                                  boolean isPrefixPath)

Method Detail

createTsBlock

protected abstract org.apache.iotdb.tsfile.read.common.block.TsBlock createTsBlock()

getPartialPath

public org.apache.iotdb.commons.path.PartialPath getPartialPath()

getLimit

public int getLimit()

getOffset

public int getOffset()

setLimit

public void setLimit(int limit)

setOffset

public void setOffset(int offset)

isPrefixPath

public boolean isPrefixPath()

getOperatorContext

public OperatorContext getOperatorContext()

Specified by:

getOperatorContext in interface Operator

next

public org.apache.iotdb.tsfile.read.common.block.TsBlock next()

Description copied from interface: Operator

Gets next tsBlock from this operator. If no data is currently available, return null.

Specified by:

next in interface Operator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Operator

Returns:

true if the operator has more data, otherwise false

isFinished

public boolean isFinished()

Description copied from interface: Operator

Is this operator completely finished processing and no more output TsBlock will be produced.

Specified by:

isFinished in interface Operator

getSourceId

public PlanNodeId getSourceId()

Specified by:

getSourceId in interface SourceOperator

calculateMaxPeekMemory

public long calculateMaxPeekMemory()

Description copied from interface: Operator

We should also consider the memory used by its children operator, so the calculation logic may be like: long estimatedOfCurrentOperator = XXXXX; return max(estimatedOfCurrentOperator, child1.calculateMaxPeekMemory(), child2.calculateMaxPeekMemory(), ....)

Each operator's MaxPeekMemory should also take retained size of each child operator into account.

Specified by:

calculateMaxPeekMemory in interface Operator

Returns:

estimated max memory footprint that the Operator Tree(rooted from this operator) will use while doing its own query processing

calculateMaxReturnSize

public long calculateMaxReturnSize()

Specified by:

calculateMaxReturnSize in interface Operator

Returns:

estimated max memory footprint for returned TsBlock when calling operator.next()

calculateRetainedSizeAfterCallingNext

public long calculateRetainedSizeAfterCallingNext()

Specified by:

calculateRetainedSizeAfterCallingNext in interface Operator

Returns:

each operator's retained size(including all its children's retained size) after calling its next() method