Package org.apache.calcite.test

Class CalciteAssert.AssertThat

java.lang.Object

org.apache.calcite.test.CalciteAssert.AssertThat

Enclosing class:

CalciteAssert

public static class CalciteAssert.AssertThat
extends Object

Result of calling CalciteAssert.that().

Method Summary

Modifier and Type	Method	Description
Connection	connect()	Use sparingly.
CalciteAssert.AssertThat	connectThrows(String message)	Asserts that there is an exception with the given message while creating a connection.
CalciteAssert.AssertThat	connectThrows(Consumer<Throwable> exceptionChecker)	Asserts that there is an exception that matches the given predicate while creating a connection.
final CalciteAssert.AssertThat	doWithConnection(Consumer<CalciteConnection> fn)	Creates a CalciteConnection and executes a callback that returns no result.
<T> CalciteAssert.AssertThat	doWithConnection(Function<CalciteConnection,T> fn)	Creates a CalciteConnection and executes a callback.
<T> CalciteAssert.AssertThat	doWithDataContext(Function<DataContext,T> fn)	Creates a DataContext and executes a callback.
CalciteAssert.AssertThat	enable(boolean enabled)
CalciteAssert.AssertMetaData	metaData(Function<Connection,ResultSet> function)
CalciteAssert.AssertThat	pooled()	Returns a version that uses a single connection, as opposed to creating a new one each time a test method is invoked.
CalciteAssert.AssertQuery	query(String sql)
CalciteAssert.AssertThat	with(String property, Object value)
final CalciteAssert.AssertThat	with(Map<String,String> map)
CalciteAssert.AssertThat	with(org.apache.calcite.avatica.ConnectionProperty property, Object value)
CalciteAssert.AssertThat	with(Lex lex)	Sets the Lex property.
CalciteAssert.AssertThat	with(CalciteAssert.Config config)
CalciteAssert.AssertThat	with(CalciteAssert.ConnectionPostProcessor postProcessor)
CalciteAssert.AssertThat	with(CalciteAssert.SchemaSpec... specs)	Creates a copy of this AssertThat, adding more schemas.
CalciteAssert.AssertThat	with(ConnectionFactory connectionFactory)	Creates a copy of this AssertThat, overriding the connection factory.
CalciteAssert.AssertThat	withDefaultSchema(String schema)	Sets the default schema of the connection.
<T> CalciteAssert.AssertThat	withHook(Hook hook, Consumer<T> handler)	Adds a hook and a handler for that hook.
final CalciteAssert.AssertThat	withMaterializations(String model, boolean existing, String... materializations)	Adds materializations to the schema.
final CalciteAssert.AssertThat	withMaterializations(String model, String... materializations)
final CalciteAssert.AssertThat	withMaterializations(String model, Function<JsonBuilder,List<Object>> materializations)	Adds materializations to the schema.
final CalciteAssert.AssertThat	withModel(String model)
final CalciteAssert.AssertThat	withModel(URL model)
CalciteAssert.AssertQuery	withRel(Function<RelBuilder,RelNode> relFn)	Adds a factory to create a RelNode query.
CalciteAssert.AssertThat	withSchema(String name, Schema schema)	Sets the default schema to a given schema.

Methods inherited from class java.lang.Object

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

Method Details

with

public CalciteAssert.AssertThat with(CalciteAssert.Config config)

with

public CalciteAssert.AssertThat with(CalciteAssert.SchemaSpec... specs)

Creates a copy of this AssertThat, adding more schemas.

with

public CalciteAssert.AssertThat with(ConnectionFactory connectionFactory)

Creates a copy of this AssertThat, overriding the connection factory.

withHook

public <T> CalciteAssert.AssertThat 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.

with

public final CalciteAssert.AssertThat with(Map<String,String> map)

with

public CalciteAssert.AssertThat with(String property,
 Object value)

with

public CalciteAssert.AssertThat with(org.apache.calcite.avatica.ConnectionProperty property,
 Object value)

with

public CalciteAssert.AssertThat with(Lex lex)

Sets the Lex property.

withSchema

public CalciteAssert.AssertThat withSchema(String name,
 Schema schema)

Sets the default schema to a given schema.

withDefaultSchema

public CalciteAssert.AssertThat withDefaultSchema(String schema)

Sets the default schema of the connection. Schema name may be null.

with

public CalciteAssert.AssertThat with(CalciteAssert.ConnectionPostProcessor postProcessor)

withModel

public final CalciteAssert.AssertThat withModel(String model)

withModel

public final CalciteAssert.AssertThat withModel(URL model)

withMaterializations

public final CalciteAssert.AssertThat withMaterializations(String model,
 String... materializations)

withMaterializations

public final CalciteAssert.AssertThat withMaterializations(String model,
 boolean existing,
 String... materializations)

Adds materializations to the schema.

withMaterializations

public final CalciteAssert.AssertThat withMaterializations(String model,
 Function<JsonBuilder,List<Object>> materializations)

Adds materializations to the schema.

query

public CalciteAssert.AssertQuery query(String sql)

withRel

public CalciteAssert.AssertQuery withRel(Function<RelBuilder,RelNode> relFn)

Adds a factory to create a RelNode query. This RelNode will be used instead of the SQL string.

Note: if you want to assert the optimized plan, consider using explainHook... methods such as CalciteAssert.AssertQuery.explainHookMatches(String)

Parameters:

relFn - a custom factory that creates a RelNode instead of regular sql to rel

Returns:

updated AssertQuery

See Also:

• CalciteAssert.AssertQuery.explainHookContains(String)
• CalciteAssert.AssertQuery.explainHookMatches(String)

connectThrows

public CalciteAssert.AssertThat connectThrows(String message)

Asserts that there is an exception with the given message while creating a connection.

connectThrows

public CalciteAssert.AssertThat connectThrows(Consumer<Throwable> exceptionChecker)

Asserts that there is an exception that matches the given predicate while creating a connection.

doWithConnection

public <T> CalciteAssert.AssertThat doWithConnection(Function<CalciteConnection,T> fn)
                                              throws Exception

Creates a CalciteConnection and executes a callback.

Throws:

Exception

doWithConnection

public final CalciteAssert.AssertThat doWithConnection(Consumer<CalciteConnection> fn)
                                                throws Exception

Creates a CalciteConnection and executes a callback that returns no result.

Throws:

Exception

doWithDataContext

public <T> CalciteAssert.AssertThat doWithDataContext(Function<DataContext,T> fn)
                                               throws Exception

Creates a DataContext and executes a callback.

Throws:

Exception

connect

public Connection connect()
                   throws SQLException

Use sparingly. Does not close the connection.

Throws:

SQLException

enable

public CalciteAssert.AssertThat enable(boolean enabled)

pooled

public CalciteAssert.AssertThat pooled()

Returns a version that uses a single connection, as opposed to creating a new one each time a test method is invoked.

metaData

public CalciteAssert.AssertMetaData metaData(Function<Connection,ResultSet> function)