Package org.apache.calcite.test

Class RelMetadataFixture

java.lang.Object

org.apache.calcite.test.RelMetadataFixture

public class RelMetadataFixture
extends Object

Parameters for a Metadata test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelMetadataFixture.MetadataConfig	A configuration that describes how metadata should be configured.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	convertAsCalc
static final RelMetadataFixture	DEFAULT	Default fixture.
final SqlTestFactory	factory
final RelMetadataFixture.MetadataConfig	metadataConfig
final org.apache.calcite.test.RelSupplier	relSupplier
final UnaryOperator<RelNode>	relTransform
final SqlTester	tester

Method Summary

Modifier and Type	Method	Description
RelMetadataFixture	assertColumnOriginDouble(String expectedTableName1, String expectedColumnName1, String expectedTableName2, String expectedColumnName2, boolean expectedDerived)	Checks that RelMetadataQuery.getColumnOrigins(RelNode, int) for column 0 returns two origins.
RelMetadataFixture	assertColumnOriginIsEmpty()	Checks that RelMetadataQuery.getColumnOrigins(RelNode, int) for column 0 returns no origins.
RelMetadataFixture	assertColumnOriginSingle(String expectedTableName, String expectedColumnName, boolean expectedDerived)	Checks that RelMetadataQuery.getColumnOrigins(RelNode, int) for column 0 returns one origin.
RelMetadataFixture	assertCpuCost(org.hamcrest.Matcher<Double> matcher, String reason)	Checks the CPU component of RelNode.computeSelfCost(RelOptPlanner, RelMetadataQuery).
RelMetadataFixture	assertPercentageOriginalRows(org.hamcrest.Matcher<Double> matcher)	Checks RelMetadataQuery.getPercentageOriginalRows(RelNode).
RelMetadataFixture	assertRowsUnique(boolean ignoreNulls, org.hamcrest.Matcher<Boolean> matcher, String reason)	Checks RelMetadataQuery.areRowsUnique(RelNode).
RelMetadataFixture	assertRowsUnique(org.hamcrest.Matcher<Boolean> matcher, String reason)	Checks RelMetadataQuery.areRowsUnique(RelNode) for all values of ignoreNulls.
RelMetadataFixture	assertThatAreColumnsUnique(Function<RelNode,ImmutableBitSet> columnsFn, UnaryOperator<RelNode> relFn, org.hamcrest.Matcher<Boolean> matcher)	Checks RelMetadataQuery.areColumnsUnique(RelNode, ImmutableBitSet), deriving parameters via functions.
RelMetadataFixture	assertThatAreColumnsUnique(ImmutableBitSet columns, org.hamcrest.Matcher<Boolean> matcher)	Checks RelMetadataQuery.areColumnsUnique(RelNode, ImmutableBitSet).
RelMetadataFixture	assertThatAreRowsUnique(org.hamcrest.Matcher<Boolean> matcher)	Checks RelMetadataQuery.areRowsUnique(RelNode).
RelMetadataFixture	assertThatDistinctRowCount(Function<RelNode,ImmutableBitSet> groupKeyFn, org.hamcrest.Matcher<Double> matcher)	Checks RelMetadataQuery.getDistinctRowCount(RelNode, ImmutableBitSet, RexNode) with a null predicate, deriving the group key from the RelNode.
RelMetadataFixture	assertThatDistinctRowCount(ImmutableBitSet groupKey, org.hamcrest.Matcher<Double> matcher)	Checks RelMetadataQuery.getDistinctRowCount(RelNode, ImmutableBitSet, RexNode) with a null predicate.
RelMetadataFixture	assertThatNodeTypeCount(org.hamcrest.Matcher<Map<Class<? extends RelNode>,Integer>> matcher)	Checks the number of each sub-class of RelNode, calling RelMetadataQuery.getNodeTypes(RelNode).
RelMetadataFixture	assertThatNodeTypeCountIs(Class<? extends RelNode> k0, Integer v0, Object... rest)	Shorthand for a call to assertThatNodeTypeCount(Matcher) with a constant map.
RelMetadataFixture	assertThatRel(org.hamcrest.Matcher<RelNode> matcher)	Checks the RelNode produced by toRel().
RelMetadataFixture	assertThatRowCount(org.hamcrest.Matcher<Number> rowCountMatcher, org.hamcrest.Matcher<Number> minRowCountMatcher, org.hamcrest.Matcher<Number> maxRowCountMatcher)	Checks RelMetadataQuery.getRowCount(RelNode), RelMetadataQuery.getMaxRowCount(RelNode), and RelMetadataQuery.getMinRowCount(RelNode).
RelMetadataFixture	assertThatSelectivity(org.hamcrest.Matcher<Double> matcher)	Checks RelMetadataQuery.getSelectivity(RelNode, RexNode).
RelMetadataFixture	assertThatUniqueKeys(org.hamcrest.Matcher<Iterable<ImmutableBitSet>> matcher)	Checks RelMetadataQuery.getUniqueKeys(RelNode).
RelMetadataFixture	assertThatUniqueKeysAre(ImmutableBitSet... expectedUniqueKeys)	Checks result of getting unique keys for SQL.
RelMetadataFixture	convertingProjectAsCalc()
RelNode	toRel()	Creates a RelNode from this fixture's supplier (see withSql(String) and withRelFn(Function)).
RelMetadataFixture	withCatalogReaderFactory(SqlTestFactory.CatalogReaderFactory catalogReaderFactory)
RelMetadataFixture	withCluster(UnaryOperator<RelOptCluster> factory)
RelMetadataFixture	withFactory(UnaryOperator<SqlTestFactory> transform)
RelMetadataFixture	withMetadataConfig(RelMetadataFixture.MetadataConfig metadataConfig)
RelMetadataFixture	withRelFn(Function<RelBuilder,RelNode> relFn)	Creates a copy of this fixture that uses a given function to create a RelNode.
RelMetadataFixture	withRelTransform(UnaryOperator<RelNode> relTransform)
RelMetadataFixture	withSql(String sql)	Creates a copy of this fixture that uses a given SQL query.
RelMetadataFixture	withTester(UnaryOperator<SqlTester> transform)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final RelMetadataFixture DEFAULT

Default fixture.

Use this, or call the withXxx methods to make one with the properties you need. Fixtures are immutable, so whatever your test does to this fixture, it won't break other tests.

tester

public final SqlTester tester

factory

public final SqlTestFactory factory

metadataConfig

public final RelMetadataFixture.MetadataConfig metadataConfig

relSupplier

public final org.apache.calcite.test.RelSupplier relSupplier

convertAsCalc

public final boolean convertAsCalc

relTransform

public final UnaryOperator<RelNode> relTransform

Method Details

withSql

public RelMetadataFixture withSql(String sql)

Creates a copy of this fixture that uses a given SQL query.

withRelFn

public RelMetadataFixture withRelFn(Function<RelBuilder,RelNode> relFn)

Creates a copy of this fixture that uses a given function to create a RelNode.

withFactory

public RelMetadataFixture withFactory(UnaryOperator<SqlTestFactory> transform)

withTester

public RelMetadataFixture withTester(UnaryOperator<SqlTester> transform)

withMetadataConfig

public RelMetadataFixture withMetadataConfig(RelMetadataFixture.MetadataConfig metadataConfig)

convertingProjectAsCalc

public RelMetadataFixture convertingProjectAsCalc()

withCatalogReaderFactory

public RelMetadataFixture withCatalogReaderFactory(SqlTestFactory.CatalogReaderFactory catalogReaderFactory)

withCluster

public RelMetadataFixture withCluster(UnaryOperator<RelOptCluster> factory)

withRelTransform

public RelMetadataFixture withRelTransform(UnaryOperator<RelNode> relTransform)

toRel

public RelNode toRel()

Creates a RelNode from this fixture's supplier (see withSql(String) and withRelFn(Function)).

assertCpuCost

public RelMetadataFixture assertCpuCost(org.hamcrest.Matcher<Double> matcher,
 String reason)

Checks the CPU component of RelNode.computeSelfCost(RelOptPlanner, RelMetadataQuery).

assertRowsUnique

public RelMetadataFixture assertRowsUnique(org.hamcrest.Matcher<Boolean> matcher,
 String reason)

Checks RelMetadataQuery.areRowsUnique(RelNode) for all values of ignoreNulls.

assertRowsUnique

public RelMetadataFixture assertRowsUnique(boolean ignoreNulls,
 org.hamcrest.Matcher<Boolean> matcher,
 String reason)

Checks RelMetadataQuery.areRowsUnique(RelNode).

assertPercentageOriginalRows

public RelMetadataFixture assertPercentageOriginalRows(org.hamcrest.Matcher<Double> matcher)

Checks RelMetadataQuery.getPercentageOriginalRows(RelNode).

assertColumnOriginIsEmpty

public RelMetadataFixture assertColumnOriginIsEmpty()

Checks that RelMetadataQuery.getColumnOrigins(RelNode, int) for column 0 returns no origins.

assertColumnOriginSingle

public RelMetadataFixture assertColumnOriginSingle(String expectedTableName,
 String expectedColumnName,
 boolean expectedDerived)

Checks that RelMetadataQuery.getColumnOrigins(RelNode, int) for column 0 returns one origin.

assertColumnOriginDouble

public RelMetadataFixture assertColumnOriginDouble(String expectedTableName1,
 String expectedColumnName1,
 String expectedTableName2,
 String expectedColumnName2,
 boolean expectedDerived)

Checks that RelMetadataQuery.getColumnOrigins(RelNode, int) for column 0 returns two origins.

assertThatUniqueKeysAre

public RelMetadataFixture assertThatUniqueKeysAre(ImmutableBitSet... expectedUniqueKeys)

Checks result of getting unique keys for SQL.

assertThatRowCount

public RelMetadataFixture assertThatRowCount(org.hamcrest.Matcher<Number> rowCountMatcher,
 org.hamcrest.Matcher<Number> minRowCountMatcher,
 org.hamcrest.Matcher<Number> maxRowCountMatcher)

Checks RelMetadataQuery.getRowCount(RelNode), RelMetadataQuery.getMaxRowCount(RelNode), and RelMetadataQuery.getMinRowCount(RelNode).

assertThatSelectivity

public RelMetadataFixture assertThatSelectivity(org.hamcrest.Matcher<Double> matcher)

Checks RelMetadataQuery.getSelectivity(RelNode, RexNode).

assertThatDistinctRowCount

public RelMetadataFixture assertThatDistinctRowCount(ImmutableBitSet groupKey,
 org.hamcrest.Matcher<Double> matcher)

Checks RelMetadataQuery.getDistinctRowCount(RelNode, ImmutableBitSet, RexNode) with a null predicate.

assertThatDistinctRowCount

public RelMetadataFixture assertThatDistinctRowCount(Function<RelNode,ImmutableBitSet> groupKeyFn,
 org.hamcrest.Matcher<Double> matcher)

Checks RelMetadataQuery.getDistinctRowCount(RelNode, ImmutableBitSet, RexNode) with a null predicate, deriving the group key from the RelNode.

assertThatRel

public RelMetadataFixture assertThatRel(org.hamcrest.Matcher<RelNode> matcher)

Checks the RelNode produced by toRel().

assertThatNodeTypeCountIs

public RelMetadataFixture assertThatNodeTypeCountIs(Class<? extends RelNode> k0,
 Integer v0,
 Object... rest)

Shorthand for a call to assertThatNodeTypeCount(Matcher) with a constant map.

assertThatNodeTypeCount

public RelMetadataFixture assertThatNodeTypeCount(org.hamcrest.Matcher<Map<Class<? extends RelNode>,Integer>> matcher)

Checks the number of each sub-class of RelNode, calling RelMetadataQuery.getNodeTypes(RelNode).

assertThatUniqueKeys

public RelMetadataFixture assertThatUniqueKeys(org.hamcrest.Matcher<Iterable<ImmutableBitSet>> matcher)

Checks RelMetadataQuery.getUniqueKeys(RelNode).

assertThatAreColumnsUnique

public RelMetadataFixture assertThatAreColumnsUnique(ImmutableBitSet columns,
 org.hamcrest.Matcher<Boolean> matcher)

Checks RelMetadataQuery.areColumnsUnique(RelNode, ImmutableBitSet).

assertThatAreColumnsUnique

public RelMetadataFixture assertThatAreColumnsUnique(Function<RelNode,ImmutableBitSet> columnsFn,
 UnaryOperator<RelNode> relFn,
 org.hamcrest.Matcher<Boolean> matcher)

Checks RelMetadataQuery.areColumnsUnique(RelNode, ImmutableBitSet), deriving parameters via functions.

assertThatAreRowsUnique

public RelMetadataFixture assertThatAreRowsUnique(org.hamcrest.Matcher<Boolean> matcher)

Checks RelMetadataQuery.areRowsUnique(RelNode).