Package org.apache.drill.exec.store.phoenix

Class PhoenixStoragePlugin

java.lang.Object

org.apache.drill.exec.store.AbstractStoragePlugin

org.apache.drill.exec.store.phoenix.PhoenixStoragePlugin

All Implemented Interfaces:

AutoCloseable, SchemaFactory, StoragePlugin

public class PhoenixStoragePlugin
extends AbstractStoragePlugin

Field Summary

Fields inherited from class org.apache.drill.exec.store.AbstractStoragePlugin

context

Fields inherited from interface org.apache.drill.exec.store.SchemaFactory

DEFAULT_WS_NAME

Constructor Summary

Constructors

Constructor	Description
PhoenixStoragePlugin(PhoenixStoragePluginConfig config, DrillbitContext context, String name)

Method Summary

Modifier and Type	Method	Description
void	close()
StoragePluginConfig	getConfig()	Method returns a Jackson serializable object that extends a StoragePluginConfig.
PhoenixConvention	getConvention()
PhoenixDataSource	getDataSource(String userName)
org.apache.calcite.sql.SqlDialect	getDialect()
Set<? extends org.apache.calcite.plan.RelOptRule>	getOptimizerRules(OptimizerRulesContext optimizerRulesContext, PlannerPhase phase)	An implementation of this method will return one or more specialized rules that Drill query optimizer can leverage in physical space.
AbstractGroupScan	getPhysicalScan(String userName, JSONOptions selection)	Get the physical scan operator for the particular GroupScan (read) node.
void	registerSchemas(SchemaConfig schemaConfig, org.apache.calcite.schema.SchemaPlus parent)	Register the schemas provided by this SchemaFactory implementation under the given parent schema.
boolean	supportsRead()	Indicates if Drill can read the table from this format.

Methods inherited from class org.apache.drill.exec.store.AbstractStoragePlugin

getContext, getFormatPlugin, getName, getPhysicalScan, getPhysicalScan, getPhysicalScan, getPhysicalScan, getPhysicalScan, onDisabled, onEnabled, start, supportsInsert, supportsWrite, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PhoenixStoragePlugin

public PhoenixStoragePlugin(PhoenixStoragePluginConfig config,
 DrillbitContext context,
 String name)

Method Details

getConfig

public StoragePluginConfig getConfig()

Description copied from interface: StoragePlugin

Method returns a Jackson serializable object that extends a StoragePluginConfig.

Returns:

an extension of StoragePluginConfig

supportsRead

public boolean supportsRead()

Description copied from interface: StoragePlugin

Indicates if Drill can read the table from this format.

Specified by:

supportsRead in interface StoragePlugin

Overrides:

supportsRead in class AbstractStoragePlugin

getOptimizerRules

public Set<? extends org.apache.calcite.plan.RelOptRule> getOptimizerRules(OptimizerRulesContext optimizerRulesContext,
 PlannerPhase phase)

Description copied from interface: StoragePlugin

An implementation of this method will return one or more specialized rules that Drill query optimizer can leverage in physical space. Otherwise, it should return an empty set.

Returns:

an empty set or a set of plugin specific physical optimizer rules.

registerSchemas

public void registerSchemas(SchemaConfig schemaConfig,
 org.apache.calcite.schema.SchemaPlus parent)
                     throws IOException

Description copied from interface: SchemaFactory

Register the schemas provided by this SchemaFactory implementation under the given parent schema.

Parameters:

schemaConfig - Configuration for schema objects.

parent - Reference to parent schema.

Throws:

IOException - in case of error during schema registration

getPhysicalScan

public AbstractGroupScan getPhysicalScan(String userName,
 JSONOptions selection)
                                  throws IOException

Description copied from interface: StoragePlugin

Get the physical scan operator for the particular GroupScan (read) node.

Specified by:

getPhysicalScan in interface StoragePlugin

Overrides:

getPhysicalScan in class AbstractStoragePlugin

Parameters:

userName - User whom to impersonate when when reading the contents as part of Scan.

selection - The configured storage engine specific selection.

Returns:

The physical scan operator for the particular GroupScan (read) node.

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractStoragePlugin

getDialect

public org.apache.calcite.sql.SqlDialect getDialect()

getConvention

public PhoenixConvention getConvention()

getDataSource

public PhoenixDataSource getDataSource(String userName)
                                throws SQLException

Throws:

SQLException