Package org.apache.calcite.adapter.splunk

Class SplunkTableScan

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.core.TableScan

org.apache.calcite.adapter.splunk.SplunkTableScan

All Implemented Interfaces:

Cloneable, EnumerableRel, RelOptNode, Hintable, PhysicalNode, RelNode

public class SplunkTableScan
extends TableScan
implements EnumerableRel

Relational expression representing a scan of Splunk.

Splunk does not have tables, but it's easiest to imagine that a Splunk instance is one large table. This "table" does not have a fixed set of columns (Splunk calls them "fields") but each query specifies the fields that it wants. It also specifies a search expression, and optionally earliest and latest dates.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.adapter.enumerable.EnumerableRel

EnumerableRel.Prefer, EnumerableRel.Result

Nested classes/interfaces inherited from interface org.apache.calcite.rel.RelNode

RelNode.Context

Field Summary

Fields inherited from class org.apache.calcite.rel.core.TableScan

hints, table

Fields inherited from class org.apache.calcite.rel.AbstractRelNode

digest, id, rowType, traitSet

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SplunkTableScan(RelOptCluster cluster, RelOptTable table, org.apache.calcite.adapter.splunk.SplunkTable splunkTable, String search, String earliest, String latest, List<String> fieldList)

Method Summary

Modifier and Type	Method	Description
RelDataType	deriveRowType()
RelWriter	explainTerms(RelWriter pw)	Describes the inputs and attributes of this relational expression.
EnumerableRel.Result	implement(EnumerableRelImplementor implementor, EnumerableRel.Prefer pref)	Creates a plan for this expression according to a calling convention.
void	register(RelOptPlanner planner)	Registers any special rules specific to this kind of relational expression.

Methods inherited from class org.apache.calcite.rel.core.TableScan

accept, computeSelfCost, estimateRowCount, getHints, getTable, identity, identity, project

Methods inherited from class org.apache.calcite.rel.AbstractRelNode

accept, childrenAccept, collectVariablesSet, collectVariablesUsed, copy, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getInputs, getRelDigest, getRelTypeName, getRowType, getTraitSet, getVariablesSet, hashCode, isEnforcer, isValid, metadata, onRegister, recomputeDigest, replaceInput, sole, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.adapter.enumerable.EnumerableRel

deriveTraits, getDeriveMode, passThroughTraits

Methods inherited from interface org.apache.calcite.rel.hint.Hintable

attachHints, withHints

Methods inherited from interface org.apache.calcite.rel.PhysicalNode

derive, derive, passThrough

Methods inherited from interface org.apache.calcite.rel.RelNode

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeSelfCost, copy, deepEquals, deepHashCode, estimateRowCount, explain, explain, fieldIsNullable, getConvention, getCorrelVariable, getDigest, getExpectedInputRowType, getInput, getInputs, getRelDigest, getRelTypeName, getRowType, getTable, getVariablesSet, isEnforcer, isValid, metadata, onRegister, recomputeDigest, replaceInput, stripped

Methods inherited from interface org.apache.calcite.plan.RelOptNode

getCluster, getDescription, getId, getTraitSet

Constructor Details

SplunkTableScan

protected SplunkTableScan(RelOptCluster cluster,
 RelOptTable table,
 org.apache.calcite.adapter.splunk.SplunkTable splunkTable,
 String search,
 String earliest,
 String latest,
 List<String> fieldList)

Method Details

explainTerms

public RelWriter explainTerms(RelWriter pw)

Description copied from class: AbstractRelNode

Describes the inputs and attributes of this relational expression. Each node should call super.explainTerms, then call the RelWriter.input(String, RelNode) and RelWriter.item(String, Object) methods for each input and attribute.

Overrides:

explainTerms in class TableScan

Parameters:

pw - Plan writer

Returns:

Plan writer for fluent-explain pattern

register

public void register(RelOptPlanner planner)

Description copied from interface: RelNode

Registers any special rules specific to this kind of relational expression.

The planner calls this method this first time that it sees a relational expression of this class. The derived class should call RelOptPlanner.addRule(org.apache.calcite.plan.RelOptRule) for each rule, and then call super.register.

Specified by:

register in interface RelNode

Overrides:

register in class AbstractRelNode

Parameters:

planner - Planner to be used to register additional relational expressions

deriveRowType

public RelDataType deriveRowType()

Overrides:

deriveRowType in class TableScan

implement

public EnumerableRel.Result implement(EnumerableRelImplementor implementor,
 EnumerableRel.Prefer pref)

Description copied from interface: EnumerableRel

Creates a plan for this expression according to a calling convention.

Specified by:

implement in interface EnumerableRel

Parameters:

implementor - Implementor

pref - Preferred representation for rows in result expression

Returns:

Plan for this expression according to a calling convention