Package org.apache.calcite.test

Class SqlValidatorFixture

java.lang.Object

org.apache.calcite.test.SqlValidatorFixture

public class SqlValidatorFixture
extends Object

A fixture for testing the SQL validator.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	expression
final SqlTestFactory	factory
final StringAndPos	sap
final SqlTester	tester
final boolean	whole

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SqlValidatorFixture(SqlTester tester, SqlTestFactory factory, StringAndPos sap, boolean expression, boolean whole)	Creates a SqlValidatorFixture.

Method Summary

Modifier and Type	Method	Description
SqlValidatorFixture	assertBindType(org.hamcrest.Matcher<String> matcher)
void	assertCharset(org.hamcrest.Matcher<Charset> charsetMatcher)
void	assertCollation(org.hamcrest.Matcher<String> collationMatcher, org.hamcrest.Matcher<SqlCollation.Coercibility> coercibilityMatcher)
SqlValidatorFixture	assertFieldOrigin(org.hamcrest.Matcher<String> matcher)	Tests that the list of the origins of each result field of the current query match expected.
void	assertInterval(org.hamcrest.Matcher<Long> matcher)	Checks if the interval value conversion to milliseconds is valid.
SqlValidatorFixture	assertMeasure(int column, org.hamcrest.Matcher<Boolean> matcher)	Checks that column column is or is not a measure.
SqlValidatorFixture	assertMonotonicity(org.hamcrest.Matcher<SqlMonotonicity> matcher)	Tests that the first column of the query has a given monotonicity.
SqlValidatorFixture	columnType(String expectedType)	Checks that a query returns a single column, and that the column has the expected type.
SqlConformance	conformance()
SqlValidatorFixture	fails(String expected)	Checks that a SQL expression gives a particular error.
SqlValidatorFixture	failsIf(boolean b, String expected)	Checks that a SQL expression fails, giving an expected error, if b is true, otherwise succeeds.
SqlValidatorFixture	isAggregate(org.hamcrest.Matcher<Boolean> matcher)
SqlValidatorFixture	ok()
SqlParser.Config	parserConfig()
SqlValidatorFixture	rewritesTo(String expected)
void	setFor(SqlOperator operator)
StringAndPos	toSql(boolean withCaret)
SqlValidatorFixture	type(String expectedType)	Checks that a query returns a row of the expected type.
SqlValidatorFixture	type(Consumer<RelDataType> check)	Passes the returned type of a query to a consumer.
SqlValidatorFixture	withCaseSensitive(boolean caseSensitive)
SqlValidatorFixture	withCatalogReader(SqlTestFactory.CatalogReaderFactory catalogReaderFactory)
SqlValidatorFixture	withConformance(SqlConformance conformance)
SqlValidatorFixture	withExpr(String sql)
SqlValidatorFixture	withExtendedCatalog()
SqlValidatorFixture	withFactory(UnaryOperator<SqlTestFactory> transform)
SqlValidatorFixture	withLenientOperatorLookup(boolean lenient)	Returns a tester that does not fail validation if it encounters an unknown function.
SqlValidatorFixture	withLex(Lex lex)
SqlValidatorFixture	withOperatorTable(SqlOperatorTable operatorTable)
SqlValidatorFixture	withParserConfig(UnaryOperator<SqlParser.Config> transform)
SqlValidatorFixture	withQuotedCasing(org.apache.calcite.avatica.util.Casing casing)
SqlValidatorFixture	withQuoting(org.apache.calcite.avatica.util.Quoting quoting)
SqlValidatorFixture	withSql(String sql)
SqlValidatorFixture	withTester(UnaryOperator<SqlTester> transform)
SqlValidatorFixture	withTypeCoercion(boolean typeCoercion)
SqlValidatorFixture	withUnquotedCasing(org.apache.calcite.avatica.util.Casing casing)
SqlValidatorFixture	withValidatorCallRewrite(boolean rewrite)
SqlValidatorFixture	withValidatorColumnReferenceExpansion(boolean expansion)
SqlValidatorFixture	withValidatorConfig(UnaryOperator<SqlValidator.Config> transform)
SqlValidatorFixture	withValidatorIdentifierExpansion(boolean expansion)
SqlValidatorFixture	withWhole(boolean whole)

Methods inherited from class java.lang.Object

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

Field Details

tester

public final SqlTester tester

factory

public final SqlTestFactory factory

sap

public final StringAndPos sap

expression

public final boolean expression

whole

public final boolean whole

Constructor Details

SqlValidatorFixture

protected SqlValidatorFixture(SqlTester tester,
 SqlTestFactory factory,
 StringAndPos sap,
 boolean expression,
 boolean whole)

Creates a SqlValidatorFixture.

Parameters:

tester - Tester

sap - SQL query or expression

expression - True if sql is an expression, false if it is a query

whole - Whether the failure location is the whole query or expression

Method Details

withTester

public SqlValidatorFixture withTester(UnaryOperator<SqlTester> transform)

withFactory

public SqlValidatorFixture withFactory(UnaryOperator<SqlTestFactory> transform)

withParserConfig

public SqlValidatorFixture withParserConfig(UnaryOperator<SqlParser.Config> transform)

parserConfig

public SqlParser.Config parserConfig()

withSql

public SqlValidatorFixture withSql(String sql)

withExpr

public SqlValidatorFixture withExpr(String sql)

toSql

public StringAndPos toSql(boolean withCaret)

withExtendedCatalog

public SqlValidatorFixture withExtendedCatalog()

withCatalogReader

public SqlValidatorFixture withCatalogReader(SqlTestFactory.CatalogReaderFactory catalogReaderFactory)

withQuoting

public SqlValidatorFixture withQuoting(org.apache.calcite.avatica.util.Quoting quoting)

withLex

public SqlValidatorFixture withLex(Lex lex)

withConformance

public SqlValidatorFixture withConformance(SqlConformance conformance)

conformance

public SqlConformance conformance()

withTypeCoercion

public SqlValidatorFixture withTypeCoercion(boolean typeCoercion)

withLenientOperatorLookup

public SqlValidatorFixture withLenientOperatorLookup(boolean lenient)

Returns a tester that does not fail validation if it encounters an unknown function.

withWhole

public SqlValidatorFixture withWhole(boolean whole)

ok

public SqlValidatorFixture ok()

fails

public SqlValidatorFixture fails(String expected)

Checks that a SQL expression gives a particular error.

failsIf

public SqlValidatorFixture failsIf(boolean b,
 String expected)

Checks that a SQL expression fails, giving an expected error, if b is true, otherwise succeeds.

type

public SqlValidatorFixture type(String expectedType)

Checks that a query returns a row of the expected type. For example,

sql("select empno, name from emp")
.type("{EMPNO INTEGER NOT NULL, NAME VARCHAR(10) NOT NULL}");

Parameters:

expectedType - Expected row type

type

public SqlValidatorFixture type(Consumer<RelDataType> check)

Passes the returned type of a query to a consumer.

Parameters:

check - Consumer run on the specific data type.

Returns:

The fixture itself.

columnType

public SqlValidatorFixture columnType(String expectedType)

Checks that a query returns a single column, and that the column has the expected type. For example,

sql("SELECT empno FROM Emp").columnType("INTEGER NOT NULL");

Parameters:

expectedType - Expected type, including nullability

assertMeasure

public SqlValidatorFixture assertMeasure(int column,
 org.hamcrest.Matcher<Boolean> matcher)

Checks that column column is or is not a measure.

assertMonotonicity

public SqlValidatorFixture assertMonotonicity(org.hamcrest.Matcher<SqlMonotonicity> matcher)

Tests that the first column of the query has a given monotonicity.

Parameters:

matcher - Expected monotonicity

assertBindType

public SqlValidatorFixture assertBindType(org.hamcrest.Matcher<String> matcher)

assertCharset

public void assertCharset(org.hamcrest.Matcher<Charset> charsetMatcher)

assertCollation

public void assertCollation(org.hamcrest.Matcher<String> collationMatcher,
 org.hamcrest.Matcher<SqlCollation.Coercibility> coercibilityMatcher)

assertInterval

public void assertInterval(org.hamcrest.Matcher<Long> matcher)

Checks if the interval value conversion to milliseconds is valid. For example,

sql("VALUES (INTERVAL '1' Minute)").intervalConv("60000");

withCaseSensitive

public SqlValidatorFixture withCaseSensitive(boolean caseSensitive)

withOperatorTable

public SqlValidatorFixture withOperatorTable(SqlOperatorTable operatorTable)

withQuotedCasing

public SqlValidatorFixture withQuotedCasing(org.apache.calcite.avatica.util.Casing casing)

withUnquotedCasing

public SqlValidatorFixture withUnquotedCasing(org.apache.calcite.avatica.util.Casing casing)

withValidatorConfig

public SqlValidatorFixture withValidatorConfig(UnaryOperator<SqlValidator.Config> transform)

withValidatorIdentifierExpansion

public SqlValidatorFixture withValidatorIdentifierExpansion(boolean expansion)

withValidatorCallRewrite

public SqlValidatorFixture withValidatorCallRewrite(boolean rewrite)

withValidatorColumnReferenceExpansion

public SqlValidatorFixture withValidatorColumnReferenceExpansion(boolean expansion)

rewritesTo

public SqlValidatorFixture rewritesTo(String expected)

isAggregate

public SqlValidatorFixture isAggregate(org.hamcrest.Matcher<Boolean> matcher)

assertFieldOrigin

public SqlValidatorFixture assertFieldOrigin(org.hamcrest.Matcher<String> matcher)

Tests that the list of the origins of each result field of the current query match expected.

The field origin list looks like this: "{(CATALOG.SALES.EMP.EMPNO, null)}".

setFor

public void setFor(SqlOperator operator)