org.apache.calcite.jdbc

Class CalciteSchema

java.lang.Object

org.apache.calcite.jdbc.CalciteSchema

Direct Known Subclasses:

CachingCalciteSchema, SimpleCalciteSchema

public abstract class CalciteSchema
extends Object

Schema.

Wrapper around user-defined schema used internally.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalciteSchema.Entry Entry in a schema, such as a table or sub-schema.
static class	CalciteSchema.FunctionEntry Membership of a function in a schema.
static class	CalciteSchema.FunctionEntryImpl Implementation of CalciteSchema.FunctionEntry where all properties are held in fields.
static class	CalciteSchema.LatticeEntry Membership of a lattice in a schema.
static class	CalciteSchema.LatticeEntryImpl Implementation of CalciteSchema.LatticeEntry where all properties are held in fields.
private class	CalciteSchema.SchemaPlusImpl Implementation of SchemaPlus based on a CalciteSchema.
static class	CalciteSchema.TableEntry Membership of a table in a schema.
static class	CalciteSchema.TableEntryImpl Implementation of CalciteSchema.TableEntry where all properties are held in fields.

Field Summary

Fields

Modifier and Type	Field and Description
protected NameMultimap<CalciteSchema.FunctionEntry>	functionMap
protected NameSet	functionNames
protected NameMap<CalciteSchema.LatticeEntry>	latticeMap
String	name
protected NameMap<CalciteSchema.FunctionEntry>	nullaryFunctionMap
private CalciteSchema	parent
private List<? extends List<String>>	path
Schema	schema
protected NameMap<CalciteSchema>	subSchemaMap
protected NameMap<CalciteSchema.TableEntry>	tableMap Tables explicitly defined in this schema.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CalciteSchema(CalciteSchema parent, Schema schema, String name, NameMap<CalciteSchema> subSchemaMap, NameMap<CalciteSchema.TableEntry> tableMap, NameMap<CalciteSchema.LatticeEntry> latticeMap, NameMultimap<CalciteSchema.FunctionEntry> functionMap, NameSet functionNames, NameMap<CalciteSchema.FunctionEntry> nullaryFunctionMap, List<? extends List<String>> path)

Method Summary

Modifier and Type	Method and Description
private CalciteSchema.FunctionEntry	add(String name, Function function)
private CalciteSchema.LatticeEntry	add(String name, Lattice lattice)
abstract CalciteSchema	add(String name, Schema schema) Adds a child schema of this schema.
CalciteSchema.TableEntry	add(String tableName, Table table) Defines a table within this schema.
CalciteSchema.TableEntry	add(String tableName, Table table, com.google.common.collect.ImmutableList<String> sqls) Defines a table within this schema.
protected abstract void	addImplicitFuncNamesToBuilder(com.google.common.collect.ImmutableSortedSet.Builder<String> builder) Adds implicit function names to a builder.
protected abstract void	addImplicitFunctionsToBuilder(com.google.common.collect.ImmutableList.Builder<Function> builder, String name, boolean caseSensitive) Adds implicit functions to a builder.
protected abstract void	addImplicitSubSchemaToBuilder(com.google.common.collect.ImmutableSortedMap.Builder<String,CalciteSchema> builder) Adds implicit sub-schemas to a builder.
protected abstract void	addImplicitTablesBasedOnNullaryFunctionsToBuilder(com.google.common.collect.ImmutableSortedMap.Builder<String,Table> builder) Adds implicit table functions to a builder.
protected abstract void	addImplicitTableToBuilder(com.google.common.collect.ImmutableSortedSet.Builder<String> builder) Adds implicit tables to a builder.
static CalciteSchema	createRootSchema(boolean addMetadataSchema) Creates a root schema.
static CalciteSchema	createRootSchema(boolean addMetadataSchema, boolean cache) Creates a root schema.
static CalciteSchema	createRootSchema(boolean addMetadataSchema, boolean cache, String name) Creates a root schema.
CalciteSchema	createSnapshot(SchemaVersion version) Creates a snapshot of this CalciteSchema as of the specified time.
protected static <V> NavigableMap<String,V>	find(NavigableMap<String,V> map, String s) Returns a subset of a map whose keys match the given string case-insensitively.
protected static Iterable<String>	find(NavigableSet<String> set, String name) Returns a subset of a set whose values match the given string case-insensitively.
static CalciteSchema	from(SchemaPlus plus)
NavigableSet<String>	getFunctionNames() Returns the list of function names in this schema, both implicit and explicit, never null.
Collection<Function>	getFunctions(String name, boolean caseSensitive) Returns a collection of all functions, explicit and implicit, with a given name.
protected abstract CalciteSchema	getImplicitSubSchema(String schemaName, boolean caseSensitive) Returns a sub-schema with a given name that is defined implicitly (that is, by the underlying Schema object, not explicitly by a call to add(String, Schema)), or null.
protected abstract CalciteSchema.TableEntry	getImplicitTable(String tableName, boolean caseSensitive) Returns a table with a given name that is defined implicitly (that is, by the underlying Schema object, not explicitly by a call to add(String, Table)), or null.
protected abstract CalciteSchema.TableEntry	getImplicitTableBasedOnNullaryFunction(String tableName, boolean caseSensitive) Returns table function with a given name and zero arguments that is defined implicitly (that is, by the underlying Schema object, not explicitly by a call to add(String, Function)), or null.
NavigableMap<String,CalciteSchema.LatticeEntry>	getLatticeMap() Returns a collection of lattices.
String	getName()
List<? extends List<String>>	getPath() Returns the default path resolving functions from this schema.
CalciteSchema	getSubSchema(String schemaName, boolean caseSensitive)
NavigableMap<String,CalciteSchema>	getSubSchemaMap() Returns a collection of sub-schemas, both explicit (defined using add(String, org.apache.calcite.schema.Schema)) and implicit (defined using Schema.getSubSchemaNames() and Schema.getSubSchema(String)).
CalciteSchema.TableEntry	getTable(String tableName, boolean caseSensitive) Returns a table with the given name.
CalciteSchema.TableEntry	getTableBasedOnNullaryFunction(String tableName, boolean caseSensitive) Returns a tables derived from explicit and implicit functions that take zero parameters.
CalciteSchema.TableEntry	getTableBySql(String sql) Returns a table that materializes the given SQL statement.
NavigableSet<String>	getTableNames() Returns the set of all table names.
NavigableMap<String,Table>	getTablesBasedOnNullaryFunctions() Returns tables derived from explicit and implicit functions that take zero parameters.
protected abstract boolean	isCacheEnabled()
boolean	isRoot() Returns whether this is a root schema.
List<String>	path(String name) Returns the path of an object in this schema.
SchemaPlus	plus()
boolean	removeFunction(String name)
boolean	removeSubSchema(String name)
boolean	removeTable(String name)
CalciteSchema	root()
abstract void	setCache(boolean cache)
protected abstract CalciteSchema	snapshot(CalciteSchema parent, SchemaVersion version) Returns a snapshot representation of this CalciteSchema.
protected CalciteSchema.TableEntryImpl	tableEntry(String name, Table table) Creates a TableEntryImpl with no SQLs.

Methods inherited from class java.lang.Object

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

Field Detail

parent

private final CalciteSchema parent

schema

public final Schema schema

name

public final String name

tableMap

protected final NameMap<CalciteSchema.TableEntry> tableMap

Tables explicitly defined in this schema. Does not include tables in schema.

functionMap

protected final NameMultimap<CalciteSchema.FunctionEntry> functionMap

latticeMap

protected final NameMap<CalciteSchema.LatticeEntry> latticeMap

functionNames

protected final NameSet functionNames

nullaryFunctionMap

protected final NameMap<CalciteSchema.FunctionEntry> nullaryFunctionMap

subSchemaMap

protected final NameMap<CalciteSchema> subSchemaMap

path

private List<? extends List<String>> path

Constructor Detail

CalciteSchema

protected CalciteSchema(CalciteSchema parent,
                        Schema schema,
                        String name,
                        NameMap<CalciteSchema> subSchemaMap,
                        NameMap<CalciteSchema.TableEntry> tableMap,
                        NameMap<CalciteSchema.LatticeEntry> latticeMap,
                        NameMultimap<CalciteSchema.FunctionEntry> functionMap,
                        NameSet functionNames,
                        NameMap<CalciteSchema.FunctionEntry> nullaryFunctionMap,
                        List<? extends List<String>> path)

Method Detail

getImplicitSubSchema

protected abstract CalciteSchema getImplicitSubSchema(String schemaName,
                                                      boolean caseSensitive)

Returns a sub-schema with a given name that is defined implicitly (that is, by the underlying Schema object, not explicitly by a call to add(String, Schema)), or null.

getImplicitTable

protected abstract CalciteSchema.TableEntry getImplicitTable(String tableName,
                                                             boolean caseSensitive)

Returns a table with a given name that is defined implicitly (that is, by the underlying Schema object, not explicitly by a call to add(String, Table)), or null.

getImplicitTableBasedOnNullaryFunction

protected abstract CalciteSchema.TableEntry getImplicitTableBasedOnNullaryFunction(String tableName,
                                                                                   boolean caseSensitive)

Returns table function with a given name and zero arguments that is defined implicitly (that is, by the underlying Schema object, not explicitly by a call to add(String, Function)), or null.

addImplicitSubSchemaToBuilder

protected abstract void addImplicitSubSchemaToBuilder(com.google.common.collect.ImmutableSortedMap.Builder<String,CalciteSchema> builder)

Adds implicit sub-schemas to a builder.

addImplicitTableToBuilder

protected abstract void addImplicitTableToBuilder(com.google.common.collect.ImmutableSortedSet.Builder<String> builder)

Adds implicit tables to a builder.

addImplicitFunctionsToBuilder

protected abstract void addImplicitFunctionsToBuilder(com.google.common.collect.ImmutableList.Builder<Function> builder,
                                                      String name,
                                                      boolean caseSensitive)

Adds implicit functions to a builder.

addImplicitFuncNamesToBuilder

protected abstract void addImplicitFuncNamesToBuilder(com.google.common.collect.ImmutableSortedSet.Builder<String> builder)

Adds implicit function names to a builder.

addImplicitTablesBasedOnNullaryFunctionsToBuilder

protected abstract void addImplicitTablesBasedOnNullaryFunctionsToBuilder(com.google.common.collect.ImmutableSortedMap.Builder<String,Table> builder)

Adds implicit table functions to a builder.

snapshot

protected abstract CalciteSchema snapshot(CalciteSchema parent,
                                          SchemaVersion version)

Returns a snapshot representation of this CalciteSchema.

isCacheEnabled

protected abstract boolean isCacheEnabled()

setCache

public abstract void setCache(boolean cache)

tableEntry

protected CalciteSchema.TableEntryImpl tableEntry(String name,
                                                  Table table)

Creates a TableEntryImpl with no SQLs.

add

public CalciteSchema.TableEntry add(String tableName,
                                    Table table)

Defines a table within this schema.

add

public CalciteSchema.TableEntry add(String tableName,
                                    Table table,
                                    com.google.common.collect.ImmutableList<String> sqls)

Defines a table within this schema.

add

private CalciteSchema.FunctionEntry add(String name,
                                        Function function)

add

private CalciteSchema.LatticeEntry add(String name,
                                       Lattice lattice)

root

public CalciteSchema root()

isRoot

public boolean isRoot()

Returns whether this is a root schema.

path

public List<String> path(String name)

Returns the path of an object in this schema.

getSubSchema

public final CalciteSchema getSubSchema(String schemaName,
                                        boolean caseSensitive)

add

public abstract CalciteSchema add(String name,
                                  Schema schema)

Adds a child schema of this schema.

getTableBySql

public final CalciteSchema.TableEntry getTableBySql(String sql)

Returns a table that materializes the given SQL statement.

getTable

public final CalciteSchema.TableEntry getTable(String tableName,
                                               boolean caseSensitive)

Returns a table with the given name. Does not look for views.

getName

public String getName()

plus

public SchemaPlus plus()

from

public static CalciteSchema from(SchemaPlus plus)

getPath

public List<? extends List<String>> getPath()

Returns the default path resolving functions from this schema.

The path consists is a list of lists of strings. Each list of strings represents the path of a schema from the root schema. For example, [[], [foo], [foo, bar, baz]] represents three schemas: the root schema "/" (level 0), "/foo" (level 1) and "/foo/bar/baz" (level 3).

Returns:

Path of this schema; never null, may be empty

getSubSchemaMap

public final NavigableMap<String,CalciteSchema> getSubSchemaMap()

Returns a collection of sub-schemas, both explicit (defined using add(String, org.apache.calcite.schema.Schema)) and implicit (defined using Schema.getSubSchemaNames() and Schema.getSubSchema(String)).

getLatticeMap

public NavigableMap<String,CalciteSchema.LatticeEntry> getLatticeMap()

Returns a collection of lattices.

All are explicit (defined using add(String, Lattice)).

getTableNames

public final NavigableSet<String> getTableNames()

Returns the set of all table names. Includes implicit and explicit tables and functions with zero parameters.

getFunctions

public final Collection<Function> getFunctions(String name,
                                               boolean caseSensitive)

Returns a collection of all functions, explicit and implicit, with a given name. Never null.

getFunctionNames

public final NavigableSet<String> getFunctionNames()

Returns the list of function names in this schema, both implicit and explicit, never null.

getTablesBasedOnNullaryFunctions

public final NavigableMap<String,Table> getTablesBasedOnNullaryFunctions()

Returns tables derived from explicit and implicit functions that take zero parameters.

getTableBasedOnNullaryFunction

public final CalciteSchema.TableEntry getTableBasedOnNullaryFunction(String tableName,
                                                                     boolean caseSensitive)

Returns a tables derived from explicit and implicit functions that take zero parameters.

createSnapshot

public CalciteSchema createSnapshot(SchemaVersion version)

Creates a snapshot of this CalciteSchema as of the specified time. All explicit objects in this CalciteSchema will be copied into the snapshot CalciteSchema, while the contents of the snapshot of the underlying schema should not change as specified in Schema.snapshot(SchemaVersion). Snapshots of explicit sub schemas will be created and copied recursively.

Currently, to accommodate the requirement of creating tables on the fly for materializations, the snapshot will still use the same table map and lattice map as in the original CalciteSchema instead of making copies.

Parameters:

version - The current schema version

Returns:

the schema snapshot.

find

protected static <V> NavigableMap<String,V> find(NavigableMap<String,V> map,
                                                 String s)

Returns a subset of a map whose keys match the given string case-insensitively.

find

protected static Iterable<String> find(NavigableSet<String> set,
                                       String name)

Returns a subset of a set whose values match the given string case-insensitively.

createRootSchema

public static CalciteSchema createRootSchema(boolean addMetadataSchema)

Creates a root schema.

When addMetadataSchema argument is true adds a "metadata" schema containing definitions of tables, columns etc. to root schema. By default, creates a CachingCalciteSchema.

createRootSchema

public static CalciteSchema createRootSchema(boolean addMetadataSchema,
                                             boolean cache)

Creates a root schema.

Parameters:

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

cache - If true create CachingCalciteSchema; if false create SimpleCalciteSchema

createRootSchema

public static CalciteSchema createRootSchema(boolean addMetadataSchema,
                                             boolean cache,
                                             String name)

Creates a root schema.

Parameters:

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

cache - If true create CachingCalciteSchema; if false create SimpleCalciteSchema

name - Schema name

removeSubSchema

public boolean removeSubSchema(String name)

removeTable

public boolean removeTable(String name)

removeFunction

public boolean removeFunction(String name)