org.apache.drill.exec.store

Class AbstractSchema

java.lang.Object

org.apache.drill.exec.store.AbstractSchema

All Implemented Interfaces:

AutoCloseable, org.apache.calcite.schema.Schema, SchemaPartitionExplorer

Direct Known Subclasses:

FileSystemSchemaFactory.FileSystemSchema, SubSchemaWrapper, WorkspaceSchemaFactory.WorkspaceSchema

public abstract class AbstractSchema
extends Object
implements org.apache.calcite.schema.Schema, SchemaPartitionExplorer, AutoCloseable

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.schema.Schema

org.apache.calcite.schema.Schema.TableType

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected List<String>	schemaPath

Constructor Summary

Constructors

Constructor and Description
AbstractSchema(List<String> parentSchemaPath, String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	contentsHaveChangedSince(long lastCheck, long now)
CreateTableEntry	createNewTable(String tableName, List<String> partitionColumns) Creates table entry using table name and list of partition columns if any.
CreateTableEntry	createNewTable(String tableName, List<String> partitionColumns, StorageStrategy storageStrategy) Creates table entry using table name, list of partition columns and storage strategy used to create table folder and files
boolean	createView(View view) Create a new view given definition.
void	dropTable(String tableName)
void	dropView(String viewName) Drop the view with given name.
org.apache.calcite.schema.Schema	getDefaultSchema() The schema can be a top level schema which doesn't have its own tables, but refers to one of the default sub schemas for table look up.
org.apache.calcite.linq4j.tree.Expression	getExpression(org.apache.calcite.schema.SchemaPlus parentSchema, String name)
String	getFullSchemaName()
Set<String>	getFunctionNames()
Collection<org.apache.calcite.schema.Function>	getFunctions(String name)
String	getName()
List<String>	getSchemaPath()
Iterable<String>	getSubPartitions(String table, List<String> partitionColumns, List<String> partitionValues) Get a list of sub-partitions of a particular table and the partitions specified by partition columns and values.
org.apache.calcite.schema.Schema	getSubSchema(String name)
Set<String>	getSubSchemaNames()
org.apache.calcite.schema.Table	getTable(String name)
Set<String>	getTableNames()
List<org.apache.commons.lang3.tuple.Pair<String,org.apache.calcite.schema.Schema.TableType>>	getTableNamesAndTypes(boolean bulkLoad, int bulkSize)
List<org.apache.commons.lang3.tuple.Pair<String,? extends org.apache.calcite.schema.Table>>	getTablesByNames(List<String> tableNames) Get the collection of Table tables specified in the tableNames.
List<org.apache.commons.lang3.tuple.Pair<String,? extends org.apache.calcite.schema.Table>>	getTablesByNamesByBulkLoad(List<String> tableNames, int bulkSize) Get the collection of Table tables specified in the tableNames with bulk-load (if the underlying storage plugin supports).
abstract String	getTypeName()
boolean	isMutable()
boolean	showInInformationSchema() Reports whether to show items from this schema in INFORMATION_SCHEMA tables.

Methods inherited from class java.lang.Object

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

Field Detail

schemaPath

protected final List<String> schemaPath

name

protected final String name

Constructor Detail

AbstractSchema

public AbstractSchema(List<String> parentSchemaPath,
              String name)

Method Detail

getSubPartitions

public Iterable<String> getSubPartitions(String table,
                                List<String> partitionColumns,
                                List<String> partitionValues)
                                  throws PartitionNotFoundException

Description copied from interface: SchemaPartitionExplorer

Get a list of sub-partitions of a particular table and the partitions specified by partition columns and values. Individual storage plugins will assign specific meaning to the parameters and return values. For more info see docs in PartitionExplorer.

Specified by:

getSubPartitions in interface SchemaPartitionExplorer

partitionColumns - a list of partitions to match

partitionValues - list of values of each partition (corresponding to the partition column list)

Returns:

list of sub-partitions, will be empty if a there is no further level of sub-partitioning below, i.e. hit a leaf partition

Throws:

PartitionNotFoundException - when the partition does not exist in the given workspace

getName

public String getName()

getSchemaPath

public List<String> getSchemaPath()

getFullSchemaName

public String getFullSchemaName()

getTypeName

public abstract String getTypeName()

getDefaultSchema

public org.apache.calcite.schema.Schema getDefaultSchema()

The schema can be a top level schema which doesn't have its own tables, but refers to one of the default sub schemas for table look up. Default implementation returns itself. Ex. "dfs" schema refers to the tables in "default" workspace when querying for tables in "dfs" schema.

Returns:

Return the default schema where tables are created or retrieved from.

createView

public boolean createView(View view)
                   throws IOException

Create a new view given definition.

Parameters:

view - View info including name, definition etc.

Returns:

Returns true if an existing view is replaced with the given view. False otherwise.

Throws:

IOException

dropView

public void dropView(String viewName)
              throws IOException

Drop the view with given name.

Parameters:

viewName -

Throws:

IOException

createNewTable

public CreateTableEntry createNewTable(String tableName,
                              List<String> partitionColumns,
                              StorageStrategy storageStrategy)

Creates table entry using table name, list of partition columns and storage strategy used to create table folder and files

Parameters:

tableName - : new table name.

partitionColumns - : list of partition columns. Empty list if there is no partition columns.

storageStrategy - : storage strategy used to create table folder and files

Returns:

create table entry

createNewTable

public CreateTableEntry createNewTable(String tableName,
                              List<String> partitionColumns)

Creates table entry using table name and list of partition columns if any. Table folder and files will be created using persistent storage strategy.

Parameters:

tableName - : new table name.

partitionColumns - : list of partition columns. Empty list if there is no partition columns.

Returns:

create table entry

showInInformationSchema

public boolean showInInformationSchema()

Reports whether to show items from this schema in INFORMATION_SCHEMA tables. (Controls ... TODO: Doc.: Mention what this typically controls or affects.)

This base implementation returns true.

getFunctions

public Collection<org.apache.calcite.schema.Function> getFunctions(String name)

Specified by:

getFunctions in interface org.apache.calcite.schema.Schema

getFunctionNames

public Set<String> getFunctionNames()

Specified by:

getFunctionNames in interface org.apache.calcite.schema.Schema

getSubSchema

public org.apache.calcite.schema.Schema getSubSchema(String name)

Specified by:

getSubSchema in interface org.apache.calcite.schema.Schema

getSubSchemaNames

public Set<String> getSubSchemaNames()

Specified by:

getSubSchemaNames in interface org.apache.calcite.schema.Schema

isMutable

public boolean isMutable()

Specified by:

isMutable in interface org.apache.calcite.schema.Schema

getTable

public org.apache.calcite.schema.Table getTable(String name)

Specified by:

getTable in interface org.apache.calcite.schema.Schema

getTableNames

public Set<String> getTableNames()

Specified by:

getTableNames in interface org.apache.calcite.schema.Schema

getExpression

public org.apache.calcite.linq4j.tree.Expression getExpression(org.apache.calcite.schema.SchemaPlus parentSchema,
                                                      String name)

Specified by:

getExpression in interface org.apache.calcite.schema.Schema

contentsHaveChangedSince

public boolean contentsHaveChangedSince(long lastCheck,
                               long now)

Specified by:

contentsHaveChangedSince in interface org.apache.calcite.schema.Schema

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

dropTable

public void dropTable(String tableName)

getTablesByNamesByBulkLoad

public List<org.apache.commons.lang3.tuple.Pair<String,? extends org.apache.calcite.schema.Table>> getTablesByNamesByBulkLoad(List<String> tableNames,
                                                                                                                     int bulkSize)

Get the collection of Table tables specified in the tableNames with bulk-load (if the underlying storage plugin supports). It is not guaranteed that the retrieved tables would have RowType and Statistic being fully populated. Specifically, calling Table.getRowType(RelDataTypeFactory) or Table.getStatistic() might incur UnsupportedOperationException being thrown.

Parameters:

tableNames - the requested tables, specified by the table names

Returns:

the collection of requested tables

getTablesByNames

public List<org.apache.commons.lang3.tuple.Pair<String,? extends org.apache.calcite.schema.Table>> getTablesByNames(List<String> tableNames)

Get the collection of Table tables specified in the tableNames.

Parameters:

tableNames - the requested tables, specified by the table names

Returns:

the collection of requested tables

getTableNamesAndTypes

public List<org.apache.commons.lang3.tuple.Pair<String,org.apache.calcite.schema.Schema.TableType>> getTableNamesAndTypes(boolean bulkLoad,
                                                                                                                 int bulkSize)