Package org.apache.drill.exec.store.jdbc

Class JdbcStoragePlugin

java.lang.Object

org.apache.drill.exec.store.AbstractStoragePlugin

org.apache.drill.exec.store.jdbc.JdbcStoragePlugin

All Implemented Interfaces:

AutoCloseable, SchemaFactory, StoragePlugin

public class JdbcStoragePlugin
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
JdbcStoragePlugin(JdbcStorageConfig jdbcStorageConfig, DrillbitContext context, String name)

Method Summary

Modifier and Type	Method	Description
void	close()
JdbcStorageConfig	getConfig()	Method returns a Jackson serializable object that extends a StoragePluginConfig.
DrillJdbcConvention	getConvention(org.apache.calcite.sql.SqlDialect dialect, UserBitShared.UserCredentials userCredentials)
Optional<DataSource>	getDataSource(UserBitShared.UserCredentials userCredentials)
org.apache.calcite.sql.SqlDialect	getDialect(UserBitShared.UserCredentials userCredentials)
JdbcDialect	getJdbcDialect(org.apache.calcite.sql.SqlDialect dialect)
Set<? extends org.apache.calcite.plan.RelOptRule>	getOptimizerRules(OptimizerRulesContext optimizerContext, PlannerPhase phase)	An implementation of this method will return one or more specialized rules that Drill query optimizer can leverage in physical space.
void	registerSchemas(SchemaConfig config, org.apache.calcite.schema.SchemaPlus parent)	Register the schemas provided by this SchemaFactory implementation under the given parent schema.
boolean	supportsInsert()	Indicates if Drill can insert to a table to this plugin.
boolean	supportsRead()	Indicates if Drill can read the table from this format.
boolean	supportsWrite()	Indicates if Drill can write a table to this format (e.g.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcStoragePlugin

public JdbcStoragePlugin(JdbcStorageConfig jdbcStorageConfig,
 DrillbitContext context,
 String name)

Method Details

registerSchemas

public void registerSchemas(SchemaConfig config,
 org.apache.calcite.schema.SchemaPlus parent)

Description copied from interface: SchemaFactory

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

Parameters:

config - Configuration for schema objects.

parent - Reference to parent schema.

getDataSource

public Optional<DataSource> getDataSource(UserBitShared.UserCredentials userCredentials)

getDialect

public org.apache.calcite.sql.SqlDialect getDialect(UserBitShared.UserCredentials userCredentials)

getJdbcDialect

public JdbcDialect getJdbcDialect(org.apache.calcite.sql.SqlDialect dialect)

getConvention

public DrillJdbcConvention getConvention(org.apache.calcite.sql.SqlDialect dialect,
 UserBitShared.UserCredentials userCredentials)

getConfig

public JdbcStorageConfig 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

supportsWrite

public boolean supportsWrite()

Description copied from interface: StoragePlugin

Indicates if Drill can write a table to this format (e.g. as JSON, csv, etc.).

Specified by:

supportsWrite in interface StoragePlugin

Overrides:

supportsWrite in class AbstractStoragePlugin

supportsInsert

public boolean supportsInsert()

Description copied from interface: StoragePlugin

Indicates if Drill can insert to a table to this plugin.

Specified by:

supportsInsert in interface StoragePlugin

Overrides:

supportsInsert in class AbstractStoragePlugin

getOptimizerRules

public Set<? extends org.apache.calcite.plan.RelOptRule> getOptimizerRules(OptimizerRulesContext optimizerContext,
 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.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractStoragePlugin

Throws:

Exception