Package org.apache.calcite.tools

Class Frameworks

java.lang.Object

org.apache.calcite.tools.Frameworks

public class Frameworks
extends Object

Tools for invoking Calcite functionality without initializing a container / server first.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Frameworks.BasePrepareAction<R>	Piece of code to be run in a context where a planner and statement are available.
static class	Frameworks.ConfigBuilder	A builder to help you build a FrameworkConfig using defaults where values aren't required.
static interface	Frameworks.PlannerAction<R>	Piece of code to be run in a context where a planner is available.
static class	Frameworks.PrepareAction<R>	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SchemaPlus	createRootSchema(boolean addMetadataSchema)	Creates a root schema.
static Planner	getPlanner(FrameworkConfig config)	Creates a planner.
static Frameworks.ConfigBuilder	newConfigBuilder()	Creates a config builder with each setting initialized to its default value.
static Frameworks.ConfigBuilder	newConfigBuilder(FrameworkConfig config)	Creates a config builder initializing each setting from an existing config.
static <R> R	withPlanner(Frameworks.PlannerAction<R> action)	Initializes a container then calls user-specified code with a planner.
static <R> R	withPlanner(Frameworks.PlannerAction<R> action, FrameworkConfig config)	Initializes a container then calls user-specified code with a planner.
static <R> R	withPrepare(FrameworkConfig config, Frameworks.BasePrepareAction<R> action)	Initializes a container then calls user-specified code with a planner and statement.
static <R> R	withPrepare(Frameworks.BasePrepareAction<R> action)	As withPrepare(FrameworkConfig, BasePrepareAction) but using a default configuration.
static <R> R	withPrepare(Frameworks.PrepareAction<R> action)	Deprecated.

Methods inherited from class java.lang.Object

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

Method Details

getPlanner

public static Planner getPlanner(FrameworkConfig config)

Creates a planner.

Parameters:

config - Planner configuration

Returns:

Planner

withPlanner

public static <R> R withPlanner(Frameworks.PlannerAction<R> action,
 FrameworkConfig config)

Initializes a container then calls user-specified code with a planner.

Parameters:

action - Callback containing user-specified code

config - FrameworkConfig to use for planner action.

Returns:

Return value from action

withPlanner

public static <R> R withPlanner(Frameworks.PlannerAction<R> action)

Initializes a container then calls user-specified code with a planner.

Parameters:

action - Callback containing user-specified code

Returns:

Return value from action

withPrepare

@Deprecated
public static <R> R withPrepare(Frameworks.PrepareAction<R> action)

Deprecated.

withPrepare

public static <R> R withPrepare(Frameworks.BasePrepareAction<R> action)

As withPrepare(FrameworkConfig, BasePrepareAction) but using a default configuration.

withPrepare

public static <R> R withPrepare(FrameworkConfig config,
 Frameworks.BasePrepareAction<R> action)

Initializes a container then calls user-specified code with a planner and statement.

Parameters:

action - Callback containing user-specified code

Returns:

Return value from action

createRootSchema

public static SchemaPlus createRootSchema(boolean addMetadataSchema)

Creates a root schema.

Parameters:

addMetadataSchema - Whether to add "metadata" schema containing definitions of tables, columns etc.

newConfigBuilder

public static Frameworks.ConfigBuilder newConfigBuilder()

Creates a config builder with each setting initialized to its default value.

newConfigBuilder

public static Frameworks.ConfigBuilder newConfigBuilder(FrameworkConfig config)

Creates a config builder initializing each setting from an existing config.

So, newConfigBuilder(config).build() will return a value equal to config.