Package io.substrait.dsl

Class SubstraitBuilder

java.lang.Object

io.substrait.dsl.SubstraitBuilder

public class SubstraitBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SubstraitBuilder.JoinInput

Constructor Summary

Constructors

Constructor	Description
SubstraitBuilder(SimpleExtension.ExtensionCollection extensions)

Method Summary

Modifier and Type	Method	Description
Expression.ScalarFunctionInvocation	add(Expression left, Expression right)
Aggregate	aggregate(Function<Rel,Aggregate.Grouping> groupingFn, Function<Rel,List<Aggregate.Measure>> measuresFn, Rel input)
Aggregate	aggregate(Function<Rel,Aggregate.Grouping> groupingFn, Function<Rel,List<Aggregate.Measure>> measuresFn, Rel.Remap remap, Rel input)
AggregateFunctionInvocation	aggregateFn(String urn, String key, Type outputType, Expression... args)
Expression.ScalarFunctionInvocation	and(Expression... args)
Aggregate.Measure	avg(Expression expr)
Aggregate.Measure	avg(Rel input, int field)
Expression.BoolLiteral	bool(boolean v)
Expression	cast(Expression input, Type type)
Aggregate.Measure	count(Rel input, int field)
Aggregate.Measure	countStar()	Returns a Aggregate.Measure representing the equivalent of a COUNT(*) SQL aggregation.
Cross	cross(Rel left, Rel right)
Cross	cross(Rel left, Rel right, Rel.Remap remap)
Expression.ScalarFunctionInvocation	divide(Expression left, Expression right)
VirtualTableScan	emptyVirtualTableScan()
Expression.ScalarFunctionInvocation	equal(Expression left, Expression right)
Expression	exists(Rel rel)
Expand	expand(Function<Rel,Iterable<? extends Expand.ExpandField>> fieldsFn, Rel input)
Expand	expand(Function<Rel,Iterable<? extends Expand.ExpandField>> fieldsFn, Rel.Remap remap, Rel input)
Fetch	fetch(long offset, long count, Rel input)
Fetch	fetch(long offset, long count, Rel.Remap remap, Rel input)
FieldReference	fieldReference(SubstraitBuilder.JoinInput inputs, int index)	Creates a field reference for a join operation by index across both left and right relations.
FieldReference	fieldReference(Rel input, int index)
FieldReference	fieldReference(List<Rel> inputs, int index)
List<FieldReference>	fieldReferences(SubstraitBuilder.JoinInput inputs, int... indexes)	Creates multiple field references for a join operation by indexes across both left and right relations.
List<FieldReference>	fieldReferences(Rel input, int... indexes)
List<FieldReference>	fieldReferences(List<Rel> inputs, int... indexes)
Filter	filter(Function<Rel,Expression> conditionFn, Rel input)
Filter	filter(Function<Rel,Expression> conditionFn, Rel.Remap remap, Rel input)
Expression.FP64Literal	fp64(double v)
Aggregate.Grouping	grouping(Expression... expressions)
Aggregate.Grouping	grouping(Rel input, int... indexes)
HashJoin	hashJoin(List<Integer> leftKeys, List<Integer> rightKeys, HashJoin.JoinType joinType, Rel left, Rel right)
HashJoin	hashJoin(List<Integer> leftKeys, List<Integer> rightKeys, HashJoin.JoinType joinType, Optional<Rel.Remap> remap, Rel left, Rel right)
Expression.I32Literal	i32(int v)
Expression.IfClause	ifClause(Expression condition, Expression then)
Expression.IfThen	ifThen(Iterable<? extends Expression.IfClause> ifClauses, Expression elseClause)
Join	innerJoin(Function<SubstraitBuilder.JoinInput,Expression> conditionFn, Rel.Remap remap, Rel left, Rel right)
Join	innerJoin(Function<SubstraitBuilder.JoinInput,Expression> conditionFn, Rel left, Rel right)
Expression.InPredicate	inPredicate(Rel haystack, Expression... needles)
Join	join(Function<SubstraitBuilder.JoinInput,Expression> conditionFn, Join.JoinType joinType, Rel.Remap remap, Rel left, Rel right)
Join	join(Function<SubstraitBuilder.JoinInput,Expression> conditionFn, Join.JoinType joinType, Rel left, Rel right)
Fetch	limit(long limit, Rel input)
Fetch	limit(long limit, Rel.Remap remap, Rel input)
Aggregate.Measure	max(Expression expr)
Aggregate.Measure	max(Rel input, int field)
Aggregate.Measure	measure(AggregateFunctionInvocation aggFn)
Aggregate.Measure	measure(AggregateFunctionInvocation aggFn, Expression preMeasureFilter)
MergeJoin	mergeJoin(List<Integer> leftKeys, List<Integer> rightKeys, MergeJoin.JoinType joinType, Rel left, Rel right)
MergeJoin	mergeJoin(List<Integer> leftKeys, List<Integer> rightKeys, MergeJoin.JoinType joinType, Optional<Rel.Remap> remap, Rel left, Rel right)
Aggregate.Measure	min(Expression expr)
Aggregate.Measure	min(Rel input, int field)
Expression.ScalarFunctionInvocation	multiply(Expression left, Expression right)
NamedScan	namedScan(Iterable<String> tableName, Iterable<String> columnNames, Iterable<Type> types)
NamedScan	namedScan(Iterable<String> tableName, Iterable<String> columnNames, Iterable<Type> types, Rel.Remap remap)
NamedUpdate	namedUpdate(Iterable<String> tableName, Iterable<String> columnNames, List<AbstractUpdate.TransformExpression> transformations, Expression condition, boolean nullable)
NamedUpdate	namedUpdate(Iterable<String> tableName, Iterable<String> columnNames, List<AbstractUpdate.TransformExpression> transformations, Expression condition, boolean nullable, Rel.Remap remap)
NamedWrite	namedWrite(Iterable<String> tableName, Iterable<String> columnNames, AbstractWriteRel.WriteOp op, AbstractWriteRel.CreateMode createMode, AbstractWriteRel.OutputMode outputMode, Rel input)
NamedWrite	namedWrite(Iterable<String> tableName, Iterable<String> columnNames, AbstractWriteRel.WriteOp op, AbstractWriteRel.CreateMode createMode, AbstractWriteRel.OutputMode outputMode, Rel input, Rel.Remap remap)
Expression.ScalarFunctionInvocation	negate(Expression expr)
NestedLoopJoin	nestedLoopJoin(Function<SubstraitBuilder.JoinInput,Expression> conditionFn, NestedLoopJoin.JoinType joinType, Rel left, Rel right)
Fetch	offset(long offset, Rel input)
Fetch	offset(long offset, Rel.Remap remap, Rel input)
Expression.ScalarFunctionInvocation	or(Expression... args)
Plan	plan(Plan.Root root)
Project	project(Function<Rel,Iterable<? extends Expression>> expressionsFn, Rel input)
Project	project(Function<Rel,Iterable<? extends Expression>> expressionsFn, Rel.Remap remap, Rel input)
Rel.Remap	remap(Integer... fields)
Plan.Root	root(Rel rel)
Expression.ScalarFunctionInvocation	scalarFn(String urn, String key, Type outputType, FunctionArg... args)
Expression	scalarSubquery(Rel input, Type type)
Set	set(Set.SetOp op, Rel... inputs)
Set	set(Set.SetOp op, Rel.Remap remap, Rel... inputs)
Expression	singleOrList(Expression condition, Expression... options)
Sort	sort(Function<Rel,Iterable<? extends Expression.SortField>> sortFieldFn, Rel input)
Sort	sort(Function<Rel,Iterable<? extends Expression.SortField>> sortFieldFn, Rel.Remap remap, Rel input)
Expression.SortField	sortField(Expression expression, Expression.SortDirection sortDirection)
List<Expression.SortField>	sortFields(Rel input, int... indexes)
Expression.StrLiteral	str(String s)
Expression.ScalarFunctionInvocation	subtract(Expression left, Expression right)
Aggregate.Measure	sum(Expression expr)
Aggregate.Measure	sum(Rel input, int field)
Aggregate.Measure	sum0(Expression expr)
Aggregate.Measure	sum0(Rel input, int field)
Expression.SwitchClause	switchClause(Expression.Literal condition, Expression then)
Expression.Switch	switchExpression(Expression match, Iterable<? extends Expression.SwitchClause> clauses, Expression defaultClause)
Type.UserDefined	userDefinedType(String urn, String typeName)
Expression.WindowFunctionInvocation	windowFn(String urn, String key, Type outputType, Expression.AggregationPhase aggregationPhase, Expression.AggregationInvocation invocation, Expression.WindowBoundsType boundsType, WindowBound lowerBound, WindowBound upperBound, Expression... args)

Methods inherited from class java.lang.Object

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

Constructor Details

SubstraitBuilder

public SubstraitBuilder(SimpleExtension.ExtensionCollection extensions)

Method Details

measure

public Aggregate.Measure measure(AggregateFunctionInvocation aggFn)

measure

public Aggregate.Measure measure(AggregateFunctionInvocation aggFn,
 Expression preMeasureFilter)

aggregate

public Aggregate aggregate(Function<Rel,Aggregate.Grouping> groupingFn,
 Function<Rel,List<Aggregate.Measure>> measuresFn,
 Rel input)

aggregate

public Aggregate aggregate(Function<Rel,Aggregate.Grouping> groupingFn,
 Function<Rel,List<Aggregate.Measure>> measuresFn,
 Rel.Remap remap,
 Rel input)

cross

public Cross cross(Rel left,
 Rel right)

cross

public Cross cross(Rel left,
 Rel right,
 Rel.Remap remap)

fetch

public Fetch fetch(long offset,
 long count,
 Rel input)

fetch

public Fetch fetch(long offset,
 long count,
 Rel.Remap remap,
 Rel input)

limit

public Fetch limit(long limit,
 Rel input)

limit

public Fetch limit(long limit,
 Rel.Remap remap,
 Rel input)

offset

public Fetch offset(long offset,
 Rel input)

offset

public Fetch offset(long offset,
 Rel.Remap remap,
 Rel input)

filter

public Filter filter(Function<Rel,Expression> conditionFn,
 Rel input)

filter

public Filter filter(Function<Rel,Expression> conditionFn,
 Rel.Remap remap,
 Rel input)

innerJoin

public Join innerJoin(Function<SubstraitBuilder.JoinInput,Expression> conditionFn,
 Rel left,
 Rel right)

innerJoin

public Join innerJoin(Function<SubstraitBuilder.JoinInput,Expression> conditionFn,
 Rel.Remap remap,
 Rel left,
 Rel right)

join

public Join join(Function<SubstraitBuilder.JoinInput,Expression> conditionFn,
 Join.JoinType joinType,
 Rel left,
 Rel right)

join

public Join join(Function<SubstraitBuilder.JoinInput,Expression> conditionFn,
 Join.JoinType joinType,
 Rel.Remap remap,
 Rel left,
 Rel right)

hashJoin

public HashJoin hashJoin(List<Integer> leftKeys,
 List<Integer> rightKeys,
 HashJoin.JoinType joinType,
 Rel left,
 Rel right)

hashJoin

public HashJoin hashJoin(List<Integer> leftKeys,
 List<Integer> rightKeys,
 HashJoin.JoinType joinType,
 Optional<Rel.Remap> remap,
 Rel left,
 Rel right)

mergeJoin

public MergeJoin mergeJoin(List<Integer> leftKeys,
 List<Integer> rightKeys,
 MergeJoin.JoinType joinType,
 Rel left,
 Rel right)

mergeJoin

public MergeJoin mergeJoin(List<Integer> leftKeys,
 List<Integer> rightKeys,
 MergeJoin.JoinType joinType,
 Optional<Rel.Remap> remap,
 Rel left,
 Rel right)

nestedLoopJoin

public NestedLoopJoin nestedLoopJoin(Function<SubstraitBuilder.JoinInput,Expression> conditionFn,
 NestedLoopJoin.JoinType joinType,
 Rel left,
 Rel right)

namedScan

public NamedScan namedScan(Iterable<String> tableName,
 Iterable<String> columnNames,
 Iterable<Type> types)

namedScan

public NamedScan namedScan(Iterable<String> tableName,
 Iterable<String> columnNames,
 Iterable<Type> types,
 Rel.Remap remap)

emptyVirtualTableScan

public VirtualTableScan emptyVirtualTableScan()

namedWrite

public NamedWrite namedWrite(Iterable<String> tableName,
 Iterable<String> columnNames,
 AbstractWriteRel.WriteOp op,
 AbstractWriteRel.CreateMode createMode,
 AbstractWriteRel.OutputMode outputMode,
 Rel input)

namedWrite

public NamedWrite namedWrite(Iterable<String> tableName,
 Iterable<String> columnNames,
 AbstractWriteRel.WriteOp op,
 AbstractWriteRel.CreateMode createMode,
 AbstractWriteRel.OutputMode outputMode,
 Rel input,
 Rel.Remap remap)

namedUpdate

public NamedUpdate namedUpdate(Iterable<String> tableName,
 Iterable<String> columnNames,
 List<AbstractUpdate.TransformExpression> transformations,
 Expression condition,
 boolean nullable)

namedUpdate

public NamedUpdate namedUpdate(Iterable<String> tableName,
 Iterable<String> columnNames,
 List<AbstractUpdate.TransformExpression> transformations,
 Expression condition,
 boolean nullable,
 Rel.Remap remap)

project

public Project project(Function<Rel,Iterable<? extends Expression>> expressionsFn,
 Rel input)

project

public Project project(Function<Rel,Iterable<? extends Expression>> expressionsFn,
 Rel.Remap remap,
 Rel input)

expand

public Expand expand(Function<Rel,Iterable<? extends Expand.ExpandField>> fieldsFn,
 Rel input)

expand

public Expand expand(Function<Rel,Iterable<? extends Expand.ExpandField>> fieldsFn,
 Rel.Remap remap,
 Rel input)

set

public Set set(Set.SetOp op,
 Rel... inputs)

set

public Set set(Set.SetOp op,
 Rel.Remap remap,
 Rel... inputs)

sort

public Sort sort(Function<Rel,Iterable<? extends Expression.SortField>> sortFieldFn,
 Rel input)

sort

public Sort sort(Function<Rel,Iterable<? extends Expression.SortField>> sortFieldFn,
 Rel.Remap remap,
 Rel input)

bool

public Expression.BoolLiteral bool(boolean v)

i32

public Expression.I32Literal i32(int v)

fp64

public Expression.FP64Literal fp64(double v)

str

public Expression.StrLiteral str(String s)

cast

public Expression cast(Expression input,
 Type type)

fieldReference

public FieldReference fieldReference(Rel input,
 int index)

fieldReferences

public List<FieldReference> fieldReferences(Rel input,
 int... indexes)

fieldReference

public FieldReference fieldReference(SubstraitBuilder.JoinInput inputs,
 int index)

Creates a field reference for a join operation by index across both left and right relations. The index spans across the combined schema of both join inputs, where fields from the left relation come first, followed by fields from the right relation.

Parameters:

inputs - the join inputs containing both left and right relations

index - the zero-based field index across the combined schema of both relations

Returns:

a FieldReference pointing to the specified field in the join context

fieldReference

public FieldReference fieldReference(List<Rel> inputs,
 int index)

fieldReferences

public List<FieldReference> fieldReferences(SubstraitBuilder.JoinInput inputs,
 int... indexes)

Creates multiple field references for a join operation by indexes across both left and right relations. Each index spans across the combined schema of both join inputs, where fields from the left relation come first, followed by fields from the right relation.

Parameters:

inputs - the join inputs containing both left and right relations

indexes - the zero-based field indexes across the combined schema of both relations

Returns:

a list of FieldReference objects pointing to the specified fields in the join context

fieldReferences

public List<FieldReference> fieldReferences(List<Rel> inputs,
 int... indexes)

ifThen

public Expression.IfThen ifThen(Iterable<? extends Expression.IfClause> ifClauses,
 Expression elseClause)

ifClause

public Expression.IfClause ifClause(Expression condition,
 Expression then)

singleOrList

public Expression singleOrList(Expression condition,
 Expression... options)

inPredicate

public Expression.InPredicate inPredicate(Rel haystack,
 Expression... needles)

sortFields

public List<Expression.SortField> sortFields(Rel input,
 int... indexes)

sortField

public Expression.SortField sortField(Expression expression,
 Expression.SortDirection sortDirection)

switchClause

public Expression.SwitchClause switchClause(Expression.Literal condition,
 Expression then)

switchExpression

public Expression.Switch switchExpression(Expression match,
 Iterable<? extends Expression.SwitchClause> clauses,
 Expression defaultClause)

aggregateFn

public AggregateFunctionInvocation aggregateFn(String urn,
 String key,
 Type outputType,
 Expression... args)

grouping

public Aggregate.Grouping grouping(Rel input,
 int... indexes)

grouping

public Aggregate.Grouping grouping(Expression... expressions)

count

public Aggregate.Measure count(Rel input,
 int field)

countStar

public Aggregate.Measure countStar()

Returns a Aggregate.Measure representing the equivalent of a COUNT(*) SQL aggregation.

Returns:

the Aggregate.Measure representing COUNT(*)

min

public Aggregate.Measure min(Rel input,
 int field)

min

public Aggregate.Measure min(Expression expr)

max

public Aggregate.Measure max(Rel input,
 int field)

max

public Aggregate.Measure max(Expression expr)

avg

public Aggregate.Measure avg(Rel input,
 int field)

avg

public Aggregate.Measure avg(Expression expr)

sum

public Aggregate.Measure sum(Rel input,
 int field)

sum

public Aggregate.Measure sum(Expression expr)

sum0

public Aggregate.Measure sum0(Rel input,
 int field)

sum0

public Aggregate.Measure sum0(Expression expr)

negate

public Expression.ScalarFunctionInvocation negate(Expression expr)

add

public Expression.ScalarFunctionInvocation add(Expression left,
 Expression right)

subtract

public Expression.ScalarFunctionInvocation subtract(Expression left,
 Expression right)

multiply

public Expression.ScalarFunctionInvocation multiply(Expression left,
 Expression right)

divide

public Expression.ScalarFunctionInvocation divide(Expression left,
 Expression right)

equal

public Expression.ScalarFunctionInvocation equal(Expression left,
 Expression right)

and

public Expression.ScalarFunctionInvocation and(Expression... args)

or

public Expression.ScalarFunctionInvocation or(Expression... args)

scalarFn

public Expression.ScalarFunctionInvocation scalarFn(String urn,
 String key,
 Type outputType,
 FunctionArg... args)

windowFn

public Expression.WindowFunctionInvocation windowFn(String urn,
 String key,
 Type outputType,
 Expression.AggregationPhase aggregationPhase,
 Expression.AggregationInvocation invocation,
 Expression.WindowBoundsType boundsType,
 WindowBound lowerBound,
 WindowBound upperBound,
 Expression... args)

userDefinedType

public Type.UserDefined userDefinedType(String urn,
 String typeName)

root

public Plan.Root root(Rel rel)

plan

public Plan plan(Plan.Root root)

remap

public Rel.Remap remap(Integer... fields)

scalarSubquery

public Expression scalarSubquery(Rel input,
 Type type)

exists

public Expression exists(Rel rel)