Package org.apache.calcite.test

Class RelOptFixture

java.lang.Object

org.apache.calcite.test.RelOptFixture

public class RelOptFixture
extends Object

A fixture for testing planner rules.

It provides a fluent API so that you can write tests by chaining method calls.

A fixture is immutable. If you have two test cases that require a similar set up (for example, the same SQL expression and set of planner rules), it is safe to use the same fixture object as a starting point for both tests.

Method Summary

Modifier and Type	Method	Description
void	check()	Checks the plan for a SQL statement before/after executing a given rule, with an optional pre-program specified by withPre(HepProgram) to prepare the tree.
void	checkUnchanged()	Checks that the plan is the same before and after executing a given planner.
DiffRepository	diffRepos()	Returns the diff repository, checking that it is not null.
RelOptFixture	sql(String sql)
RelNode	toRel()
RelOptFixture	withAfter(BiFunction<RelOptFixture,RelNode,RelNode> transform)
RelOptFixture	withBefore(BiFunction<RelOptFixture,RelNode,RelNode> transform)
RelOptFixture	withCatalogReaderFactory(SqlTestFactory.CatalogReaderFactory factory)
RelOptFixture	withConfig(UnaryOperator<SqlToRelConverter.Config> transform)
RelOptFixture	withConformance(SqlConformance conformance)
RelOptFixture	withContext(UnaryOperator<Context> transform)
RelOptFixture	withDecorrelate(boolean decorrelate)
RelOptFixture	withDiffRepos(DiffRepository diffRepos)
RelOptFixture	withDynamicTable()
RelOptFixture	withExpand(boolean expand)
RelOptFixture	withFactory(UnaryOperator<SqlTestFactory> transform)
<T> RelOptFixture	withHook(Hook hook, Consumer<T> handler)	Adds a hook and a handler for that hook.
RelOptFixture	withInSubQueryThreshold(int inSubQueryThreshold)
RelOptFixture	withLateDecorrelate(boolean lateDecorrelate)
RelOptFixture	withPlanner(RelOptPlanner planner)
RelOptFixture	withPre(HepProgram preProgram)
RelOptFixture	withPreRule(RelOptRule... rules)
RelOptFixture	withProgram(HepProgram program)
<V> RelOptFixture	withProperty(Hook hook, V value)
RelOptFixture	withRelBuilderConfig(UnaryOperator<RelBuilder.Config> transform)
RelOptFixture	withRelBuilderSimplify(boolean simplify)
RelOptFixture	withRelSupplier(org.apache.calcite.test.RelSupplier relSupplier)
RelOptFixture	withRule(RelOptRule... rules)
RelOptFixture	withSubQueryRules()
RelOptFixture	withTrim(boolean trim)
RelOptFixture	withVolcanoPlanner(boolean topDown)
RelOptFixture	withVolcanoPlanner(boolean topDown, Consumer<VolcanoPlanner> init)

Methods inherited from class java.lang.Object

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

Method Details

withDiffRepos

public RelOptFixture withDiffRepos(DiffRepository diffRepos)

withRelSupplier

public RelOptFixture withRelSupplier(org.apache.calcite.test.RelSupplier relSupplier)

sql

public RelOptFixture sql(String sql)

withBefore

public RelOptFixture withBefore(BiFunction<RelOptFixture,RelNode,RelNode> transform)

withAfter

public RelOptFixture withAfter(BiFunction<RelOptFixture,RelNode,RelNode> transform)

withDynamicTable

public RelOptFixture withDynamicTable()

withFactory

public RelOptFixture withFactory(UnaryOperator<SqlTestFactory> transform)

withPre

public RelOptFixture withPre(HepProgram preProgram)

withPreRule

public RelOptFixture withPreRule(RelOptRule... rules)

withPlanner

public RelOptFixture withPlanner(RelOptPlanner planner)

withProgram

public RelOptFixture withProgram(HepProgram program)

withRule

public RelOptFixture withRule(RelOptRule... rules)

withHook

public <T> RelOptFixture withHook(Hook hook,
 Consumer<T> handler)

Adds a hook and a handler for that hook. Calcite will create a thread hook (by calling Hook.addThread(Consumer)) just before running the query, and remove the hook afterwards.

withProperty

public <V> RelOptFixture withProperty(Hook hook,
 V value)

withRelBuilderSimplify

public RelOptFixture withRelBuilderSimplify(boolean simplify)

withExpand

public RelOptFixture withExpand(boolean expand)

withInSubQueryThreshold

public RelOptFixture withInSubQueryThreshold(int inSubQueryThreshold)

withConfig

public RelOptFixture withConfig(UnaryOperator<SqlToRelConverter.Config> transform)

withRelBuilderConfig

public RelOptFixture withRelBuilderConfig(UnaryOperator<RelBuilder.Config> transform)

withLateDecorrelate

public RelOptFixture withLateDecorrelate(boolean lateDecorrelate)

withDecorrelate

public RelOptFixture withDecorrelate(boolean decorrelate)

withTrim

public RelOptFixture withTrim(boolean trim)

withCatalogReaderFactory

public RelOptFixture withCatalogReaderFactory(SqlTestFactory.CatalogReaderFactory factory)

withConformance

public RelOptFixture withConformance(SqlConformance conformance)

withContext

public RelOptFixture withContext(UnaryOperator<Context> transform)

toRel

public RelNode toRel()

check

public void check()

Checks the plan for a SQL statement before/after executing a given rule, with an optional pre-program specified by withPre(HepProgram) to prepare the tree.

checkUnchanged

public void checkUnchanged()

Checks that the plan is the same before and after executing a given planner. Useful for checking circumstances where rules should not fire.

withVolcanoPlanner

public RelOptFixture withVolcanoPlanner(boolean topDown)

withVolcanoPlanner

public RelOptFixture withVolcanoPlanner(boolean topDown,
 Consumer<VolcanoPlanner> init)

withSubQueryRules

public RelOptFixture withSubQueryRules()

diffRepos

public DiffRepository diffRepos()

Returns the diff repository, checking that it is not null. (It is allowed to be null because some tests that don't use a diff repository.)