org.apache.calcite.jdbc

Class CachingCalciteSchema

java.lang.Object

org.apache.calcite.jdbc.CalciteSchema

org.apache.calcite.jdbc.CachingCalciteSchema

Direct Known Subclasses:

CalciteRootSchema

class CachingCalciteSchema
extends CalciteSchema

Concrete implementation of CalciteSchema that caches tables, functions and sub-schemas.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	CachingCalciteSchema.AbstractCached<T> Implementation of CachingCalciteSchema.Cached that drives from cache.
private static interface	CachingCalciteSchema.Cached<T> Strategy for caching the value of an object and re-creating it if its value is out of date as of a given timestamp.
private static class	CachingCalciteSchema.SubSchemaCache Information about the implicit sub-schemas of an CalciteSchema.

Nested classes/interfaces inherited from class org.apache.calcite.jdbc.CalciteSchema

CalciteSchema.Entry, CalciteSchema.FunctionEntry, CalciteSchema.FunctionEntryImpl, CalciteSchema.LatticeEntry, CalciteSchema.LatticeEntryImpl, CalciteSchema.TableEntry, CalciteSchema.TableEntryImpl

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	cache
private CachingCalciteSchema.Cached<NameSet>	implicitFunctionCache
private CachingCalciteSchema.Cached<CachingCalciteSchema.SubSchemaCache>	implicitSubSchemaCache
private CachingCalciteSchema.Cached<NameSet>	implicitTableCache

Fields inherited from class org.apache.calcite.jdbc.CalciteSchema

functionMap, functionNames, latticeMap, name, nullaryFunctionMap, schema, subSchemaMap, tableMap

Constructor Summary

Constructors

Modifier	Constructor and Description
(package private)	CachingCalciteSchema(CalciteSchema parent, Schema schema, String name) Creates a CachingCalciteSchema.
private	CachingCalciteSchema(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
CalciteSchema	add(String name, Schema schema) Adds a child schema of this schema.
protected void	addImplicitFuncNamesToBuilder(com.google.common.collect.ImmutableSortedSet.Builder<String> builder) Adds implicit function names to a builder.
protected void	addImplicitFunctionsToBuilder(com.google.common.collect.ImmutableList.Builder<Function> builder, String name, boolean caseSensitive) Adds implicit functions to a builder.
protected void	addImplicitSubSchemaToBuilder(com.google.common.collect.ImmutableSortedMap.Builder<String,CalciteSchema> builder) Adds implicit sub-schemas to a builder.
protected void	addImplicitTablesBasedOnNullaryFunctionsToBuilder(com.google.common.collect.ImmutableSortedMap.Builder<String,Table> builder) Adds implicit table functions to a builder.
protected void	addImplicitTableToBuilder(com.google.common.collect.ImmutableSortedSet.Builder<String> builder) Adds implicit tables to a builder.
protected 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 CalciteSchema.add(String, Schema)), or null.
protected 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 CalciteSchema.add(String, Table)), or null.
protected 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 CalciteSchema.add(String, Function)), or null.
protected boolean	isCacheEnabled()
boolean	removeFunction(String name)
boolean	removeTable(String name)
void	setCache(boolean cache)
protected CalciteSchema	snapshot(CalciteSchema parent, SchemaVersion version) Returns a snapshot representation of this CalciteSchema.

Methods inherited from class org.apache.calcite.jdbc.CalciteSchema

add, add, createRootSchema, createRootSchema, createRootSchema, createSnapshot, find, find, from, getFunctionNames, getFunctions, getLatticeMap, getName, getPath, getSubSchema, getSubSchemaMap, getTable, getTableBasedOnNullaryFunction, getTableBySql, getTableNames, getTablesBasedOnNullaryFunctions, isRoot, path, plus, removeSubSchema, root, tableEntry

Methods inherited from class java.lang.Object

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

Field Detail

implicitSubSchemaCache

private final CachingCalciteSchema.Cached<CachingCalciteSchema.SubSchemaCache> implicitSubSchemaCache

implicitTableCache

private final CachingCalciteSchema.Cached<NameSet> implicitTableCache

implicitFunctionCache

private final CachingCalciteSchema.Cached<NameSet> implicitFunctionCache

cache

private boolean cache

Constructor Detail

CachingCalciteSchema

CachingCalciteSchema(CalciteSchema parent,
                     Schema schema,
                     String name)

Creates a CachingCalciteSchema.

CachingCalciteSchema

private CachingCalciteSchema(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

setCache

public void setCache(boolean cache)

Specified by:

setCache in class CalciteSchema

isCacheEnabled

protected boolean isCacheEnabled()

Specified by:

isCacheEnabled in class CalciteSchema

getImplicitSubSchema

protected CalciteSchema getImplicitSubSchema(String schemaName,
                                             boolean caseSensitive)

Description copied from class: CalciteSchema

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 CalciteSchema.add(String, Schema)), or null.

Specified by:

getImplicitSubSchema in class CalciteSchema

add

public CalciteSchema add(String name,
                         Schema schema)

Adds a child schema of this schema.

Specified by:

add in class CalciteSchema

getImplicitTable

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

Description copied from class: CalciteSchema

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

Specified by:

getImplicitTable in class CalciteSchema

addImplicitSubSchemaToBuilder

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

Description copied from class: CalciteSchema

Adds implicit sub-schemas to a builder.

Specified by:

addImplicitSubSchemaToBuilder in class CalciteSchema

addImplicitTableToBuilder

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

Description copied from class: CalciteSchema

Adds implicit tables to a builder.

Specified by:

addImplicitTableToBuilder in class CalciteSchema

addImplicitFunctionsToBuilder

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

Description copied from class: CalciteSchema

Adds implicit functions to a builder.

Specified by:

addImplicitFunctionsToBuilder in class CalciteSchema

addImplicitFuncNamesToBuilder

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

Description copied from class: CalciteSchema

Adds implicit function names to a builder.

Specified by:

addImplicitFuncNamesToBuilder in class CalciteSchema

addImplicitTablesBasedOnNullaryFunctionsToBuilder

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

Description copied from class: CalciteSchema

Adds implicit table functions to a builder.

Specified by:

addImplicitTablesBasedOnNullaryFunctionsToBuilder in class CalciteSchema

getImplicitTableBasedOnNullaryFunction

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

Description copied from class: CalciteSchema

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 CalciteSchema.add(String, Function)), or null.

Specified by:

getImplicitTableBasedOnNullaryFunction in class CalciteSchema

snapshot

protected CalciteSchema snapshot(CalciteSchema parent,
                                 SchemaVersion version)

Description copied from class: CalciteSchema

Returns a snapshot representation of this CalciteSchema.

Specified by:

snapshot in class CalciteSchema

removeTable

public boolean removeTable(String name)

Overrides:

removeTable in class CalciteSchema

removeFunction

public boolean removeFunction(String name)

Overrides:

removeFunction in class CalciteSchema